Updated docs and examples

python-microservices · Mar 29, 2020 · 63b5248 · 63b5248
1 parent 7a295db
commit 63b5248
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 33 deletions.
diff --git a/docs/encrypt_decryt_configuration.md b/docs/encrypt_decryt_configuration.md
@@ -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:
 
@@ -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.
@@ -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:
 
@@ -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:
@@ -164,4 +142,6 @@ pyms:
     SECRET_KEY: "gjr39dkjn344_!67#"
     ENC_SQLALCHEMY_DATABASE_URI: "AQICAHiALhLQv4eW8jqUccFSnkyDkBAWLAm97Lr2qmdItkUCIAF+P4u/uqzu8KRT74PsnQXhAAAAoDCBnQYJKoZIhvcNAQcGoIGPMIGMAgEAMIGGBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDPo+k3ZxoI9XVKtHgQIBEIBZmp7UUVjNWd6qKrLVK8oBNczY0CfLH6iAZE3UK5Ofs4+nZFi0PL3SEW8M15VgTpQoC/b0YxDPHjF0V6NHUJcWirSAqKkP5Sz5eSTk91FTuiwDpvYQ2q9aY6w=
 "
-```
+```
+
+
diff --git a/examples/microservice_crypt_aws_kms/main.py b/examples/microservice_crypt_aws_kms/main.py
@@ -4,7 +4,7 @@
 
 from pyms.flask.app import Microservice
 
-ms = Microservice(path=__file__)
+ms = Microservice()
 app = ms.create_app()