summaryrefslogtreecommitdiffstats
path: root/nym/README.md
blob: 0cd4f1059c86a1a90eda41d1301c31e35a131e66 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# YAMN Nym sender

This binary sends an already encrypted YAMN envelope through the Nym mixnet
using the Rust SDK. It is intentionally send-only: it does not receive
messages, expose replies, fetch remailer data, or perform YAMN encoding.

Configuration is supplied through the environment:

- `YAMN_NYM_RECIPIENT`: fixed Nym address of the YAMN ingress service.
- `YAMN_ENTRY_ADDRESS`: exact allowlisted YAMN entry address used by the ingress.
- `YAMN_NYM_STORAGE`: persistent client storage directory. Defaults to
  `/var/lib/yamnweb/nym-client`.

The request is one JSON object on standard input:

```json
{"entry_address":"yamn@example.org","payload":"<raw encrypted YAMN SMTP envelope>"}
```

The binary never logs the request or its contents. The Nym recipient must be
an ingress service that knows how to hand the envelope to YAMN. A normal SMTP
address is not a valid replacement for `YAMN_NYM_RECIPIENT`.