From 59b2b69bc7346ec2f53dfaad6043760f720b90bc Mon Sep 17 00:00:00 2001 From: Arsen Musayelyan Date: Sat, 5 Dec 2020 16:58:19 -0800 Subject: [PATCH] Clarify README and add dir type to it --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 73a5860..5ffcd46 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,17 @@ #### Sender - Use `opensend -s -t -d ` -- `type` can either be `url` or `file` -- If `type` is `url`, `data` should be a URL -- If `type` is `file`, `data` should be a file path +- `type` can be + - `url` + - `file` + - `dir` +- `data` can be + - A website URL + - A file path + - A directory path - Example: `opensend -s -t url -d "https://google.com"` - Example: `opensend -s -t file -d ~/file.txt` +- Example: `opensend -s -t dir -d /home/user` ### Building - This project uses go modules, so building is easy @@ -40,9 +46,4 @@ Opensend can run on iOS using the [iSH app](https://apps.apple.com/us/app/ish-sh ### Ports to whitelist - TCP 9797 for key exchange -- TCP 9898 for file transfer - -### How does it work? -OpenSend uses a combination of 2048-bit RSA and AES GCM encryption. This is accomplished using golang's crypto/rsa and crypto/aes libraries. First, a shared AES key is generated. Then, an RSA keypair is generated. The RSA public key is then exchanged using TCP and golang's encoding/gob library. The AES key is encrypted using the RSA public key -of the receiver. This key is then saved to a file. Next, the shared AES key is used to encrypt all the files in `~/.opensend`. To send the encrypted AES key, the sender first needs to discover the receiver. This is accomplished using zeroconf. After that, the sender starts an HTTP server with some custom functions to send the file index and key. -The receiver gets the index, files, and encrypted key from this server. Once it gets all the files, it sends a stop signal to the server and decrypts the shared key using its RSA private key. The resulting AES key is then used to decrypt all files in `~/.opensend`. \ No newline at end of file +- TCP 9898 for file transfer \ No newline at end of file