diff --git a/README.md b/README.md index 3c1db1c..d11383b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,29 @@ -## GUI tool for secure file transfer +
+ + + + +

+ +## Cryptographic specifications + +The initial key exchange is performed with elliptic-curve Diffie-Hellman. General data exchange is encrypted with AES-GCM. During regular communication payloads are Base64 encoded before being encrypted to prevent delimiter conflicts. SHA-256 hashes of files are compared to ensure data integrity. + +## Cellular networks + +Most cellular ISP's tend to block port forwarding on CGNAT level, which makes it impossible to create inbound connections to such network without a VPN. Luckily many consumer VPNs and self-hosted solutions make port forwarding a trivial task. This is the main reason why the client must fetch information about the public IP from an external service (https://ipinfo.io/ip for IPV4 and https://ipv6.icanhazip.com for IPV6). + +## Usage + +Work in progress. Will be completed when the current release is finished. + +```shell +cargo build --release +./target/release/contego +``` diff --git a/docs/contego-dark.png b/docs/contego-dark.png new file mode 100644 index 0000000..d53b3f3 Binary files /dev/null and b/docs/contego-dark.png differ diff --git a/docs/contego-light.png b/docs/contego-light.png new file mode 100644 index 0000000..db88af9 Binary files /dev/null and b/docs/contego-light.png differ