polistern
/
pboted_docs
mirror of https://github.com/polistern/pboted_docs
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: Update usage. Added new crypto types.

main
polistern 2021-12-07 08:52:08 +00:00
parent cb7cf9c3ab
commit 8cb99c9b29
Signed by: polistern
GPG Key ID: E131651B5A988EAC
2 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/docs/bote/v5/cryptography.md
View File

@ -2,14 +2,15 @@
## 7.1. Asymmetric encryption and signing
ToDo: Looks specific to Java app, remove from protocol description
Encryption and signature algorithms:
Supported encryption and signature algorithms:
* ALG=1: ElGamal-2048 / DSA-1024 / AES-256 / SHA-256
* ALG=2: ECDH-256 / ECDSA-256 / AES-256 / SHA-256
* ALG=3: ECDH-521 / ECDSA-521 / AES-256 / SHA-512
* ALG=4: NTRUEncrypt-1087 / GMSS-512 / AES-256 / SHA-512
| ID | Crypto | Signing | Symmetric | Hash | Supported |
|----|------------------|-------------|-----------|---------|-------------------|
| 1 | ElGamal-2048 | DSA-1024 | AES-256 | SHA-256 | Java-Bote |
| 2 | ECDH-256 | ECDSA-256 | AES-256 | SHA-256 | Java-Bote, pboted |
| 3 | ECDH-521 | ECDSA-521 | AES-256 | SHA-512 | Java-Bote, pboted (work in progress) |
| 4 | NTRUEncrypt-1087 | GMSS-512 | AES-256 | SHA-512 | Java-Bote |
| 5 | ECDH-X25519 | EDDSA-25519 | AES-256 | SHA-512 | pboted (work in progress) |
## 7.2. Password Encryption

17
docs/docs/user-guide/usage.md
View File

@ -1,6 +1,6 @@
# Usage
You may need the utilities from the `utils` directory to work with **pboted**.
You may need the utilities from the [pboted-tools](https://github.com/polistern/pboted-tools/) repository to work with **pboted**.
In the future, their list will grow.
There are plans to transfer all means for interaction into a separate CLI utility.
@ -9,10 +9,16 @@ You can only continue to use your Java I2P-Bote identities if:
- your address is created using the ECDH-256/ECDSA-256/AES-256/SHA-256 algorithm (others are not supported yet)
- identities file is not encrypted (encrypted files are not supported yet)
## Create Bote identity
See [create_identity](https://github.com/polistern/pboted-tools/tree/main/create_identity)
## Sending email
### SMTP
_tested with [Mozilla Thunderbird](https://www.thunderbird.net/en-US/)_
To be able to send email through SMTP you need to:
- Fill `[smtp]` section in configuration file with [parameters](configuration.md)
@ -22,7 +28,7 @@ To be able to send email through SMTP you need to:
### Via `outbox` directory
- Prepare plain test message
- Format it with `message_formatter`
- Format it with [message_formatter](https://github.com/polistern/pboted-tools/tree/main/message_formatter)
- Put result file to `outbox` directory in pboted working directory
- pboted will automatically check `outbox` and send email
- After sending email file will be moved to `sent` directory
@ -30,10 +36,15 @@ To be able to send email through SMTP you need to:
## Receiving email
After starting with a generated identity the application will begin its normal job of searching for mail.
If mail for identity are found, they will be placed in the `inbox` directory.
### Via `inbox` directory
If mail for identity are found, they will be placed in the `inbox` directory as a plain text file.
### POP3
_tested with [Mozilla Thunderbird](https://www.thunderbird.net/en-US/)_
To be able to receive email through POP3 you need to:
- Fill [pop3] section in configuration file with [parameters](configuration.md)