Hello! We are running our annual fundraising. Please consider making a donation if you value this freely available service or want to support people around the world working towards liberatory social change. https://riseup.net/donate.

subscribers.md 4.2 KB
Newer Older
1
2
3
4
---
title: Documentation for subscribers
---

paz's avatar
paz committed
5
{% include docs-head.md version=4.0 %}
6
7
8

{% include_relative _list_usage_basics.md %}

user's avatar
user committed
9
10
11
   


12
13
#### Subscription and key management

14
15
The following keywords must be send to the request address of the list: `foo-request@hostname`.  
Include `x-list-name: foo@hostname` with every command you send.
16

17
**x-add-key:**  
init void's avatar
init void committed
18
: Import the email's attachment(s) or the rest of the email-body into the list’s keyring. To paste your public key into the body of the mail, please export it in _"ASCII-armored"_ text format (e.g. `gpg --armor --export 0xAE0DBF5A92A5ADE49481AB6F8A3171EF366150CE`). If you send the key as an **attachment** of the email, **both** _"ASCII-armored"_ and binary format are supported. 
19

20

init void's avatar
init void committed
21
22
**x-set-fingerprint:** 0x12345678DEADBEEF12345678DEADBEEF12345678
: Assign the key with the given fingerprint to your subscription. It is not possible to set an empty fingerprint. To unset your fingerprint use `x-unset-fingerprint`.
23

init void's avatar
init void committed
24
25
**x-unset-fingerprint:** person@example.org
: Remove the fingerprint associated with your subscription.
26

user's avatar
user committed
27
28
29
30
   


#### Example: Updating your key for a list
31
32
33

All commands to switch to a **new** key must be signed with the current **old** key. 

user's avatar
user committed
34
##### 1. submit new key to lists keyring
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

```
x-list-name: foo@hostname
x-add-key

-----BEGIN PGP PUBLIC KEY BLOCK-----

ASak6ezpIZkSZ/ql7UOiOIxi7dAWg4YwFB+yrkN+aUi9Io+No1Y0Rjz+/pUIvGx7
KbyhUQjE6wvGJKDqWyLQVoyB+R0ZV3k6lQFqa7TETXCoGuU8CRM4XcynU7MNgGFQ
...
mDMEXuYDuxYJKwYBBAHaRw8BAQdAqP98Ao=
=32SG
-----END PGP PUBLIC KEY BLOCK-----
```

A successful answer should look something like this:
> This key was newly added:
init void's avatar
init void committed
52
> 0x12345678DEADBEEF12345678DEADBEEF12345678 youraccount@yourmail.net 2019-05-23 [expires: 2023-05-23] 
53

user's avatar
user committed
54
##### 2. verify that uploaded key made it into the keyring
55
56
57
58
59

```
x-list-name: foo@hostname
x-list-keys
```
user's avatar
user committed
60
61
The answer will be a list of all keys in the lists keyring.
Make sure, your **new** key is in the keyring now.
62

user's avatar
user committed
63
##### 3. change you subscription to use the new key
64
65
66

```
x-list-name: foo@hostname
67
x-set-fingerprint: 0x12345678DEADBEEF12345678DEADBEEF12345678
68
69
70
71
72
73
74
```

A successful answer should look something like this:
> Fingerprint for youraccount@yourmail.net set to 12345678DEADBEEF12345678DEADBEEF12345678.

From now on, all mails will be encrpyted to the **new** key
and all your mails must be signed with this key.
75

user's avatar
user committed
76
77
78
79
80
81
##### One caveat: disabled commands 
To further improve security and confidentiality, list-admins can manually **disable certain commands**
like `x-add-key` for mere subscribers of the list. With these commands disabled for you,
you have to rely on the list-admin for key management. 

   
82
83
84
85
86

#### Resending

The resending-keywords must be included in messages sent to the normal list-address: `foo@hostname`.

Nina's avatar
Nina committed
87
**x-attach-listkey:**
88
89
: Attachs the public key of the list. Probably most useful in combination with x-resend.

Nina's avatar
Nina committed
90
**x-resend:** someone@example.org
91
92
: Send the message to the given address, encrypted if possible, otherwise in the clear.

Nina's avatar
Nina committed
93
**x-resend-encrypted-only:** someone@example.org
94
95
: Send the message to the given address only if it could be encrypted. Can be abbreviated to `x-resend-enc`.

Nina's avatar
Nina committed
96
**x-resend-unencrypted:** someone@example.org
97
98
: Send the message to the given address without encrypting it. You can use this keyword to make schleuder skip looking for a matching key for this address and enforce sending the email out in the clear.

Nina's avatar
Nina committed
99
**x-resend-cc:** someone@example.org anotherperson@example.org
100
101
: Send one message to all of the given addresses in Cc, so they get to know of each other (encrypted if possible, otherwise in the clear).

Nina's avatar
Nina committed
102
**x-resend-cc-encrypted-only:** someone@example.org
103
104
: Send one message to all of the given addresses in Cc, so they get to know of each other, only if it could be encrypted to all of those addresses. Can be abbreviated to `x-resend-cc-enc.`

Nina's avatar
Nina committed
105
**x-resend-cc-unencrypted:** someone@example.org
106
107
108
109
110
111
112
113
: Send one unencrypted message to all of the given addresses in Cc, so they get to know of each other. We skip looking for any key and will just send out the email in the clear.


### Contact list-owner

Write to `foo-owner@hostname` to contact the list-owner(s) even if you don't know who they are. Use the list's key to encrypt the email!


Nina's avatar
Nina committed
114
{% include participate.md %}