moat

README

Moat

Make your files safe before saving them to the cloud.

No passphrases to remember. Everything is generated for you.

In Development - POTENTIALLY UNSTABLE

$ moat -service="fixtures"
Moat path is: C:\Users\selfup\Moat
Service path is: fixtures\Moat

Label Key written to: C:\Users\selfup\Moat\moatlabel
Private Key written to: C:\Users\selfup\Moat\moatprivate
Public Key written to: fixtures\Moat\moatpublic
Encrypted AES Key written to: fixtures\Moat\moatkey

$ echo "wow this is going to be encrypted and saved to a cloud service directory" >> ~/Moat/wow.txt

$ moat -service="fixtures" -cmd=push
Moat path is: C:\Users\selfup\Moat
Service path is: fixtures\Moat

Encrypted: C:\Users\selfup\Moat\wow.txt - to: fixtures\Moat\wow.txt

$ moat -service="fixtures" -cmd=pull
Moat path is: C:\Users\selfup\Moat
Service path is: fixtures\Moat

Decrypted: fixtures\Moat\wow.txt - to: C:\Users\selfup\Moat\wow.txt

What does this do?

1. Encrypts files to other directories
2. Decrypts files from other directories back into your vault

By default $HOME/Moat or %USERPROFILE%\Moat are used for your Vault. This ensures any file written here will be encrypted to any service directory you want (Dropbox/Google Drive/A USB device/etc..).

Typically you would say something like: -service=$HOME/Dropbox

And when you run moat it will encrypt files from your Vault to $HOME/Dropbox/Moat.

You can also define your own Vault path, but we can talk about that later.

How is this safe?

1. Keys are randomly generated (passphrase, label)
2. RSA 4096 (Public/Private Auth - Encryption for passphrase)
3. AES 256 (Encrypts/Decrypts files)

In your Vault:

Private RSA key is stored. As well as a random 32 byte label.

In your service directory:

Public RSA key as well as an encrypted (using said public RSA key) randomly generated 32 byte passphrase.

Decryption/Encryption of files

All files are encrypted using a 32byte passphrase paired with a 32 byte label.

Your 32 byte passphrase is encrypted using the Public RSA key before being stored in your service directory.

The 32 byte passphrase is decrypted using the Private RSA key in your Vault.

All files are decrypted using the 32byte passphrase paired with the local 32 byte label.

Custom Paths (Vaults)

$ moat -home="archive" -service="fixtures"
Moat path is: archive\Moat
Service path is: fixtures\Moat

Label Key written to: archive\Moat\moatlabel
Private Key written to: archive\Moat\moatprivate
Public Key written to: fixtures\Moat\moatpublic
Encrypted AES Key written to: fixtures\Moat\moatkey

$ echo "wow this is going to be encrypted and saved to a cloud service directory" >> archive/Moat/wow.txt

$ moat -home="archive" -service="fixtures" -cmd=push
Moat path is: archive\Moat
Service path is: fixtures\Moat

Encrypted: archive\Moat\wow.txt - to: fixtures\Moat\wow.txt

$ moat -home="archive" -service="fixtures" -cmd=pull
Moat path is: archive\Moat
Service path is: fixtures\Moat

Decrypted: fixtures\Moat\wow.txt - to: archive\Moat\wow.txt

Help

$ moat -h
Usage of moat:
  -cmd string
        OPTIONAL
                main command
                push will encrypt Moat/filename.ext to Service/Moat/filename.ext
                pull will decrypt from Service/Moat/filename.ext to Moat/filename.ext
                if no command is passed initial setup will be attempted
                if Moat dir and Service/Moat dir exist nothing will be generated
  -home string
        OPTIONAL
                Home dir (here you want Moat to be created at) - defaults to $HOME or USERPROFILE
  -moat string
        OPTIONAL
                What you want Moat to be called - essentially Vault names
  -service string
        REQUIRED
                Directory of cloud service that will sync on update