Skip to content

Added AWS kms support #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
avara1986 merged 18 commits into from
Mar 30, 2020
Merged

Added AWS kms support #105

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
382ba9b
Refactor
avara1986 Mar 24, 2020
ad18008
Refactor 2
avara1986 Mar 24, 2020
d7f0f12
Fix pylint
avara1986 Mar 24, 2020
2613091
Fix pylint
avara1986 Mar 24, 2020
6459ddf
Updated conf with encryption
avara1986 Mar 25, 2020
9fd8c29
Fix singleton service initialization
avara1986 Mar 25, 2020
444f767
Added AWS KMS support
avara1986 Mar 26, 2020
487d4ca
Updated tests
avara1986 Mar 26, 2020
388c8e7
mock Init boto
avara1986 Mar 26, 2020
7666788
Dynamic import not working with moto
avara1986 Mar 27, 2020
458f26f
Removed base64
avara1986 Mar 27, 2020
13f5752
Updated docs
avara1986 Mar 27, 2020
9dc3d39
Updated tests
avara1986 Mar 28, 2020
b97b301
Updated tests
avara1986 Mar 28, 2020
263a459
Added encrypt method
avara1986 Mar 28, 2020
1126037
Removed optional 64
avara1986 Mar 28, 2020
7a295db
Updated docs
avara1986 Mar 28, 2020
63b5248
Updated docs and examples
avara1986 Mar 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Updated docs and examples
  • Loading branch information
@avara1986
avara1986 committed Mar 29, 2020
commit 63b5248833092eea8b269c76e515d4ebf9975919
44 changes: 12 additions & 32 deletions docs/encrypt_decryt_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

## Configuration

# Method 1: Encrypt and decrypt with key file and Fernet


When you work in multiple environments: local, dev, testing, production... you must set critical configuration in your
variables, like:

Expand Down Expand Up @@ -101,7 +104,9 @@ SQLALCHEMY_DATABASE_URI: mysql+mysqlconnector://user_of_db:user_of_db@localhost/

And you can access to this var with `current_app.config["SQLALCHEMY_DATABASE_URI"]`

## 1. Encrypt your information with AWS KMS and base64
# Method 2: Encrypt and decrypt with AWS KMS

## 1. Configure AWS

Pyms knows if a variable is encrypted if this var start with the prefix `enc_` or `ENC_`. PyMS uses boto3 and
aws cli to decrypt this value and store it in the same variable without the `enc_` prefix.
Expand All @@ -112,36 +117,7 @@ First, configure aws your aws account credentials:
aws configure
```

Cypher a string with this command:

```bash
aws kms encrypt --key-id alias/your-kms-key --plaintext "mysql+mysqlconnector://important_user:****@localhost/my_schema" --query CiphertextBlob --output text | base64 -d | base64
>> AQICAHiALhLQv4eW8jqUccFSnkyDkBAWLAm97Lr2qmdItkUCIAGBuPtu9v1N8oy2fhZ605VuAAAA
oDCBnQYJKoZIhvcNAQcGoIGPMIGMAgEAMIGGBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDL60
NbDqbBIOJUHCQQIBEIBZALpJXqZwqQb++8BxGTN1/gkAp4WQv6w34t07S/6lcfCYrBNtdkTX2th9
cGJcIvg4+lLnyFzirOrhovVUsS7O5v5wofSqlUevX5BIowGZKWK9TqaXqZ/CS18=

```

And put this string in your `config_pro.yml`:
```yaml
pyms:
crypt:
method: "aws_kms"
key_id: "alias/your-kms-key"
config:
DEBUG: true
TESTING: true
APPLICATION_ROOT : ""
SECRET_KEY: "gjr39dkjn344_!67#"
ENC_SQLALCHEMY_DATABASE_URI: "AQICAHiALhLQv4eW8jqUccFSnkyDkBAWLAm97Lr2qmdItkUCIAGBuPtu9v1N8oy2fhZ605VuAAAA
oDCBnQYJKoZIhvcNAQcGoIGPMIGMAgEAMIGGBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDL60
NbDqbBIOJUHCQQIBEIBZALpJXqZwqQb++8BxGTN1/gkAp4WQv6w34t07S/6lcfCYrBNtdkTX2th9
cGJcIvg4+lLnyFzirOrhovVUsS7O5v5wofSqlUevX5BIowGZKWK9TqaXqZ/CS18=
"
```

## 2. Encrypt your information with AWS KMS without base64
## 2. Encrypt with KMS

Cypher a string with this command:

Expand All @@ -151,6 +127,8 @@ aws kms encrypt --key-id alias/prueba-avara --plaintext "mysql+mysqlconnector://

```

## 3. Decrypt from your config file

And put this string in your `config_pro.yml`:
```yaml
pyms:
Expand All @@ -164,4 +142,6 @@ pyms:
SECRET_KEY: "gjr39dkjn344_!67#"
ENC_SQLALCHEMY_DATABASE_URI: "AQICAHiALhLQv4eW8jqUccFSnkyDkBAWLAm97Lr2qmdItkUCIAF+P4u/uqzu8KRT74PsnQXhAAAAoDCBnQYJKoZIhvcNAQcGoIGPMIGMAgEAMIGGBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDPo+k3ZxoI9XVKtHgQIBEIBZmp7UUVjNWd6qKrLVK8oBNczY0CfLH6iAZE3UK5Ofs4+nZFi0PL3SEW8M15VgTpQoC/b0YxDPHjF0V6NHUJcWirSAqKkP5Sz5eSTk91FTuiwDpvYQ2q9aY6w=
"
```
```


2 changes: 1 addition & 1 deletion examples/microservice_crypt_aws_kms/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from pyms.flask.app import Microservice

ms = Microservice(path=__file__)
ms = Microservice()
app = ms.create_app()


Expand Down