From 518929fe2d16ef5fe5b3875e4575a8561a03751f Mon Sep 17 00:00:00 2001 From: SG Date: Mon, 1 May 2023 17:04:43 +0200 Subject: [PATCH] Readme --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c044c99..6f42356 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # Transphase This is a collection of tools to copy files or proxy connections via WebSockets protocol. It is done in a cryptographically safe(ish) way. -A rendevouz/relay server is used to help with data transfer. +A relay server is used to help with data transfer. **Transphase** - the relay server \ **Transmat** - tool to copy files/directories \ **Transplace** - HTTP proxy/exit point ### Copy files -Transphase server should be running and accessible by the parties. +Transphase relay server should be running and accessible by the parties. On the sending party: ``` transmat --send @@ -18,4 +18,9 @@ This will prepare the sender and output the command to run on the receiving part transmat --receive --password Space-Time-Continuum ``` +The sending party will wait for the receiving party to connect to the relay server, and then it will start the transfer. +With the exception of some service messages, all the data is encrypted. +Encryption and decryption is done only client-side, and the relay server has no useful knowledge of the data it relays. +Fernet module (AES128-CBC + HMAC-SHA256) is used to encrypt and authenticate the data. + See also ```transmat --help``` \ No newline at end of file