Added Readme.md

This commit is contained in:
SG
2023-05-13 20:36:27 +02:00
parent f396eaa034
commit be7a22a25f

17
transmat/Readme.md Normal file
View File

@@ -0,0 +1,17 @@
### How to copy files using ```transmat```
Transphase relay server should be running and accessible by the parties.
On the sending party:
```
transmat --send <FILENAME>
```
This will prepare the sender and output the command to run on the receiving party, eg:
```
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```