cryptomator / sanitizer

Utility to find and fix problems within vaults
https://cryptomator.org/
GNU General Public License v3.0
33 stars 9 forks source link

Add extra params to encryptPath (cleartextPath, cleartextListFile, outputPath) #6

Closed jaeseopark closed 5 years ago

jaeseopark commented 5 years ago

Hi, I really enjoy using Cryptomator and thought I'd contribute to the project and help the community.

I added three optional parameters to the encryptPath command, mainly to support the batch use case.

I was personally evaluating how easy it would be to restore files in a vault (kinda similar to https://community.cryptomator.org/t/file-restore-from-backup-how-to-know-which-file/123) and thought this batch feature would make my life a lot easier.

Now to the technical details....

cleartextListFile

cleartextListFile is a line-separated text file that contains the paths you want to encrypt. Here is a sample:

file1-in-vault.jpg
file2-in-vault.txt

outputPath

outputPath , If specified, saves the resolved path(s) to a file, rather than printing them directly to the console. This helps when you are processing a large number of paths.

cleartextPath

cleartextPath is a little bonus param which allows you to specify a single path in the command itself. This does the same thing as providing a path during the runtime.

Other things...

Previously, if you encrypted a path, the output looked like this:

Resolved: ${ciphertext_path}

Now the new output looks like this:

${cleartext_path}: ${ciphertext_path}

Lastly, the code has been manually tested on a Mac. Please let me know if there are guidelines as to how the new code should be tested.

Thanks, Jaeseo

CLAassistant commented 5 years ago

CLA assistant check
All committers have signed the CLA.

overheadhunter commented 5 years ago

Thank you! :)