Commit e0f29954 authored by lucas.tieman's avatar lucas.tieman
Browse files

clarification on README.md

parent df6c1ac7
......@@ -3,17 +3,19 @@ MAPP Encryption Tool
Any Questions Please Reach Out To Member Data Support!
Basic Setup Instructions:
# Basic Setup Instructions:
* This Tool Has Been Tested using Python 3.7 and 3.8 and Python 2.7 on MacOS and Python 3.8 on Windows
* Install Requirements using pip like so "pip install -r requirements.txt"
* Install Requirements using pip like so:
> pip install -r requirements.txt
* Modify the .env file in this folder with the Encryption Secret Provided By MAPP Support and the File Naming Convention agreed on with them as well
* Place the file you want to encrypt in the "in" folder in this project
* Use the Command "python encrypt.py encrypt"
* Use the Command
> python encrypt.py encrypt
* Your Encrypted File is now in the Out Folder
......@@ -21,20 +23,55 @@ Check Encryption:
* Place your Successfully Encrypted File In the 'in' folder in this project
* Use the command "python encrypt.py decrypt"
* Use the command:
> python encrypt.py decrypt
Advanced:
# Advanced:
The encrypt.py file also accepts optional relative and absolute paths to tell the script where to look for the file to encrypt
Full usage matches this pattern: python encrypt.py [encrypt,decrypt] [existing path (default in) ] [new path (default out)]
Full usage matches this pattern:
> python encrypt.py [encrypt,decrypt] [existing path (default in) ] [new path (default out)]
For instance the command:
python encrypt.py encrypt && python encrypt.py decrypt out in
> python encrypt.py encrypt && python encrypt.py decrypt out in
Will encrypt the file in the in folder, place it in the out folder, and then the second command will take the encrypted file from the out folder and decrypt it into the in folder. Doing quite a bit, but apparently doing nothing.
Additionally, in this project, there are two methods that can be used in existing python projects to encrypt and decrypt files.
The encrypt_file and decrypt_file methods requires a path to the file and the encryption key to be handed to it. They also have an optional parameter to provide a path for the new file. If one is not given, it will just add a '1' to the end of the current file name. It will not overwrite, as it needs to read the existing file as it goes through its process.
\ No newline at end of file
The encrypt_file and decrypt_file methods requires a path to the file and the encryption key to be handed to it. They also have an optional parameter to provide a path for the new file. If one is not given, it will just add a '1' to the end of the current file name. It will not overwrite, as it needs to read the existing file as it goes through its process.
# MAPP Instructions
* Provide MAPP Support with a Naming Convention that Includes Your Local Name and an email that will receive notifications.
* MAPP support will send back a one-time secret including your Encryption Key
* Download the Encryption Tool
* Use the Encryption Tool to Encrypt your File Using Instructions in the README.md (also available on that page)
* Upload Your File As Before. Your file will be decrypted and moved to another location on the server, and then will be available for upload via the MAPP API. This may take a couple of minutes. And as long as your file meets the naming convention, you will receive either a success or failure email.
*Trigger the processing of the file via API.
# FAQ:
What if I upload a file that does not match my naming convention?
*The file will be deleted and an email will be generated and sent to Member Data Support. Logs will be checked and MAPP Support will figure out who uploaded the file and address the issue.*
What if I upload a file that is not encrypted but matches my naming convention?
*The file will be deleted and you will receive an email telling you decryption failed. We now require encryption on all SFTP uploads.*
What if I upload a file that is not encrypted correctly?
*The file will be deleted and you will receive an email telling you that decryption failed, please reach out to Member Data and MAPP support for help getting encryption correctly set up.*
What if I have my encryption set up correctly and everything is validating on my side, and my file name meets the agreed on Naming Convention?
*Reach out to MAPP Support at memberdata.support@seiu.org. You should also get an error email on uploading the file if this is an issue. We have added a lot of logging and should be able to figure out what is going on.*
I have an existing process and I’d like to do the encryption inside that process.
*The Git Repository has python methods which can be imported into other scripts to allow for use inside other python scripts. The logic is also fairly straightforward and using standard encryption tools which should be able to be replicated in other languages. This is documented in the project. For additional information, please reach out to memberdata.support@seiu.org*
Please send all other questions to memberdata.support@seiu.org
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment