Elara6331/opensend
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
This repository has been archived on 2021-07-08. You can view files and clone it, but cannot push or open issues or pull requests.
14 Commits 1 Branch 0 Tags 127 KiB
Go 99%
Makefile 1%
c9a01f0376
Go to file
Arsen Musayelyan c9a01f0376 Add macOS rule to makefile and add information to readme
2020-12-05 00:19:03 -08:00
.gitignore Add --skip-mdns to allow full bypassing of zeroconf. This allows operation within iOS 2020-12-04 02:12:32 -08:00
config.go Add FatalHook for graceful shutdown in case of Fatal log 2020-12-03 09:32:03 -08:00
deviceDiscovery.go Add FatalHook for graceful shutdown in case of Fatal log 2020-12-03 09:32:03 -08:00
fileCrypto.go Fix erroneous key reencryption 2020-12-04 23:51:15 -08:00
files.go Clean up code 2020-12-04 22:45:38 -08:00
go.mod Golang Rewrite 2020-12-03 02:12:43 -08:00
go.sum Golang Rewrite 2020-12-03 02:12:43 -08:00
keyCrypto.go Add FatalHook for graceful shutdown in case of Fatal log 2020-12-03 09:32:03 -08:00
keyExchange.go Clean up unnecessary code 2020-12-04 12:55:55 -08:00
logging.go Add FatalHook for graceful shutdown in case of Fatal log 2020-12-03 09:32:03 -08:00
main.go Add makefile and improve error message for no args 2020-12-04 23:44:19 -08:00
Makefile Add macOS rule to makefile and add information to readme 2020-12-05 00:19:03 -08:00
README.md Add macOS rule to makefile and add information to readme 2020-12-05 00:19:03 -08:00

README.md

OpenSend

Send files between systems quickly and securely

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 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 key, the sender first needs to discover the receiver. This is accomplished using mDNS. The key is then exchanged using a TCP socket and golang's encoding/gob library. 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 key is then used to decrypt all files in ~/.opensend.

Ports to whitelist

  • TCP 9797 for key exchange
  • TCP 9898 for file transfer

Usage

Receiver

  • Use opensend -r to start the receiver

Sender

  • Use opensend -s -t <type> -d <data>
  • type can either be url or file
  • If the type is url, data should be a URL
  • If the type is file, data should be a file path
  • Example: opensend -s -t url -d "https://google.com"

Building

  • This project uses go modules, so building is easy
  • First, go 1.14+ must be installed (use buster-backports on debian)
  • Then, run make inside the project's directory.
  • This will get the dependencies and compile all the files.

Installing

To install, simply follow the building instructions and then run

  • Linux: sudo make install
  • macOS: sudo make install-macos

Using on iOS

Opensend can run on iOS using the iSH app.

  • Install go using apk add go
  • Clone this repository
  • Run make
  • Use opensend as normal, but skip device discovery
    • Device discovery does not work properly in iSH due to Alpine Linux
    • When running receiver, add --skip-mdns
    • When running sender, add --send-to <IP>
    • This applies bidirectionally
  • Known issues
    • Opensend takes a while to become ready on iOS