Commit 4b26de98 authored by georg's avatar georg

Merge branch 'schleuder-3.6.0' into 'master'

Schleuder version 3.6.0

See merge request !93
parents 8516e2d4 894594b9
Pipeline #53500 passed with stages
in 1 minute and 13 seconds
......@@ -16,7 +16,7 @@ build:
- 'if ! [ "$CI_COMMIT_REF_SLUG" == "master" ]; then
echo "baseurl: /$DEPLOY_SLUG" >> _config.yml;
fi'
- jekyll build
- jekyll build --verbose
- tar cfz site.tar.gz _site
stage: build
artifacts:
......
......@@ -4,6 +4,7 @@ email: team@schleuder.org
description: > # this means to ignore newlines until "url:"
Schleuder is a gpg-enabled mailinglist with remailing-capabilities.
url: "https://schleuder.org" # the base hostname & protocol for your site
future: true
exclude: [Rakefile, README.md, vendor]
defaults:
......
---
layout: post
title: "Schleuder 3.6.0 released"
date: "2021-02-07"
---
This release ships new features and bug fixes:
* The list options are enhanced, via:
* `set_reply_to_to_sender` sets the `Reply-To` header of emails sent to subscriptions to the value of the `Reply-To`- or the `From`-header of the incoming email,
* `munged_from` makes the `From`'s "display name" of emails sent to subscriptions to include the sender's email address of the incoming mail (e.g. `"me@example.org via list@example.net <list@example.net>`).
* The detection of bounce messages is massively improved.
* Mail addresses of subscriptions are properly validated.
Please see the [user-relevant changes]({{ "schleuder/docs/changes.html" | absolute_url }}) and the [changelog](https://0xacab.org/schleuder/schleuder/blob/master/CHANGELOG.md#360-2021-02-FIXME) for details.
---
title: Changes from Schleuder 3.4 to 3.5
title: Changes from Schleuder 3.5 to 3.6
---
{: .note}
This list describes changes that users or list-admins of Schleuder should be aware of. For a more technical changelog, please see the [repository](https://0xacab.org/schleuder/schleuder).
{% include docs-head.md version=3.5 %}
{% include docs-head.md version=3.6 %}
User-relevant changes in version 3.5 compared to version 3.4:
User-relevant changes in version 3.6 compared to version 3.5:
* The list options are enhanced, via:
* an option to include their public keys in the headers of outgoing emails (conforming with Autocrypt, [https://autocrypt.org/](https://autocrypt.org)),
* an option to control whether subscribers get a copy of mail they sent themselves.
* Pseudoheaders are wrapped at 78 characters.
* A visual separator is added to the end of the pseudoheaders block. This should help users of Apple Mail, which jams this block and the body together. Hopefully, this change makes it easier to dinstiguish both parts from each other.
* Messages sent by Jenkins or sudo are not recognized anymore as automated messages.
* The output of `x-resend` and friends is improved and more precise:
* Tell how many keys are in the keyring and how many are usable.
* Make it more clear what happens when resending an encrypted email fails (due to missing or too many matching keys), but falling back to unencrypted resend is allowed.
* Be more explicit that resending to other CC recipients has been aborted.
* Attaching the public key of a list works, if using `x-attach-listkey` via Thunderbird. Before the output was garbled and hardly usable.
* The detection of the encoding of incoming mails is improved. This should reduce the amount of mails which were problematic in this regard, and lead to errors.
* Incoming mails encrypted to an absent key, using symmetric encryption or containing PGP-garbage are handled in a more graceful manner: No exception is thrown, admins aren't notified (and annoyed), instead the sender is informed how to do better.
* Notification mails sent to admins contain a List-Id header. This should help with filtering such messages, which wasn't easy to do in a reliable way.
* `x-add-key` is able to handle mails with attached, quoted-printable encoded keys. Such mails might be produced by Thunderbird.
* `x-add-key` is able to handle inline key material, followed by non-key material, like a signature included in the body.
* `set_reply_to_to_sender` sets the `Reply-To` header of emails sent to subscriptions to the value of the `Reply-To`- or the `From`-header of the incoming email,
* `munged_from` makes the `From`'s "display name" of emails sent to subscriptions to include the sender's email address of the incoming mail (e.g. `"me@example.org via list@example.net <list@example.net>`).
* The detection of bounce messages is massively improved.
* Mail addresses of subscriptions are properly validated.
......@@ -2,7 +2,7 @@
title: Concept
---
{% include docs-head.md version=3.5 %}
{% include docs-head.md version=3.6 %}
Schleuder is an OpenPGP-enabled mailing list manager with resending capabilities. This document tries to explain what that means.
......
......@@ -2,7 +2,7 @@
title: Documentation for list-admins
---
{% include docs-head.md version=3.5 %}
{% include docs-head.md version=3.6 %}
{% include_relative _list_usage_basics.md %}
......
## Using a list
Everything you send to `foo@hostname` will be send to all subscribers, but they will see only certain headers and the body of your email. The selection of these headers can be configured for each list individually by the list-admins.
### Getting a list's public key
Each Schleuder-list replies with its public key to any email sent to `foo-sendkey@hostname`. E.g. to receive the key for our contact address write an email to `team-sendkey@schleuder.org`.
### Special keywords
Schleuder knows some special keywords that trigger different behaviour. You can e.g. subscribe someone, or resend an email to a non-subscriber using keywords. See a list of available keywords below.
Keywords require that:
* they start the line and begin with "x-",
* they are written into the beginning of the *first text-part* of the email (usually that's just the normal body of the email),
* possible arguments must be written *on the same line* as the keyword (exceptions are mentioned in the descriptions below),
* the email must be *encrypted and signed* by a list-member's key.
* the email must be formatted as a *plain text* message and not with HTML, RTF or similar formatting.
Keywords can be repeated within one email at will.
Letter case doesn't matter.
There are two types of keywords: those to enhance messages sent over the list ("list-keywords"), and those to request something from Schleuder ("request-keywords").
#### Security
To mitigate replay attacks of emails containing keywords, every email using a keyword **must** contain the special `x-list-name` keyword followed by the list's emailaddress. Example:
x-list-name: someone@example.org
: **You must always provide this keyword once per email.** Without it, no other keyword will be considered but you will receive an error message.
---
title: Changes from Schleuder 3.4 to 3.5
---
{: .note}
This list describes changes that users or list-admins of Schleuder should be aware of. For a more technical changelog, please see the [repository](https://0xacab.org/schleuder/schleuder).
{% include docs-head.md version=3.5 %}
User-relevant changes in version 3.5 compared to version 3.4:
* The list options are enhanced, via:
* an option to include their public keys in the headers of outgoing emails (conforming with Autocrypt, [https://autocrypt.org/](https://autocrypt.org)),
* an option to control whether subscribers get a copy of mail they sent themselves.
* Pseudoheaders are wrapped at 78 characters.
* A visual separator is added to the end of the pseudoheaders block. This should help users of Apple Mail, which jams this block and the body together. Hopefully, this change makes it easier to dinstiguish both parts from each other.
* Messages sent by Jenkins or sudo are not recognized anymore as automated messages.
* The output of `x-resend` and friends is improved and more precise:
* Tell how many keys are in the keyring and how many are usable.
* Make it more clear what happens when resending an encrypted email fails (due to missing or too many matching keys), but falling back to unencrypted resend is allowed.
* Be more explicit that resending to other CC recipients has been aborted.
* Attaching the public key of a list works, if using `x-attach-listkey` via Thunderbird. Before the output was garbled and hardly usable.
* The detection of the encoding of incoming mails is improved. This should reduce the amount of mails which were problematic in this regard, and lead to errors.
* Incoming mails encrypted to an absent key, using symmetric encryption or containing PGP-garbage are handled in a more graceful manner: No exception is thrown, admins aren't notified (and annoyed), instead the sender is informed how to do better.
* Notification mails sent to admins contain a List-Id header. This should help with filtering such messages, which wasn't easy to do in a reliable way.
* `x-add-key` is able to handle mails with attached, quoted-printable encoded keys. Such mails might be produced by Thunderbird.
* `x-add-key` is able to handle inline key material, followed by non-key material, like a signature included in the body.
---
title: Concept
---
{% include docs-head.md version=3.5 %}
Schleuder is an OpenPGP-enabled mailing list manager with resending capabilities. This document tries to explain what that means.
## An email hub for groups
Schleuder enables subscribers to communicate encryptedly and pseudonymously. It takes care of all de- and encryption, stripping of headers, formatting conversions, etc.
But Schleuder can also receive and send emails to non-subscribers, which makes it a useful email hub for groups.
Incoming emails from non-subscribers ("outside people") are (re)encrypted and distributed among the subscribers, which can communicate internally as well as answer to the outside person via the list.
The outside person only sees an email address with a public key, but has no information about who is behind it.
Here's a simple picture of a message that is sent to a non-subscriber ("Zacharias"). It illustrates how Alice, Bob, Claire and David are invisible to Zacharias (click image to enlarge it).
[![resent-schema](schleuder-schema-resend-small.png 'Click to enlarge')](schleuder-schema-resend.png)
Additionally, it is possible to combine a list being used as a helpdesk to be combined with a Gitlab issue tracker. To learn more about that, have a look at the [project description](../../schleuder-gitlab-ticketing/).
### A helpful bot
Additionally, Schleuder can send out its own public key upon request by email. Anyone sending a message to `listname-sendkey@hostname` will receive a reply that contains the public key of that list.
And Schleuder can receive administrative commands by email. E.g. it is possible by email to add an OpenPGP-key to a list in order to reply encryptedly to an outside person.
## Technical details
### A "wanted machine-in-the-middle"
Basically Schleuder is a "wanted machine-in-the-middle".
Each list has its own keypair. Schleuder decrypts every incoming email and verifies its signature with the keys from the list's keyring. Then Schleuder loops over the list of subscribers, creates for each a stripped down copy of the message, encrypts it with the subscriber's key and signs it with its own key, and sends it out.
Schleuder inserts some lines of metadata into the top of the email, containing a (configurable) copy of some of the original headers and the result of the decryption and verification of the incoming email. Here's an example:
From: Bob <bob@example.net>
To: team@schleuder.org
Date: Tue, 6 Apr 2010 17:28:46 +0200
Enc: encrypted
Sig: Good signature from 12345678DEADBEEF Bob <bob@example.net>
The consequence of this approach is that you need to *really trust* the provider that runs Schleuder: they could store and decrypt all emails that pass the lists, if they wanted.
### Internal workings
Schleuder behaves like an email-filter: it reads email from standard-input, and reports errors to standard-error. If all goes well Schleuder closes the initial connection to the Mail Transport Agent (MTA) only after it sent out all outgoing emails.
In case of an error the MTA includes Schleuder's error message into a bounce-email that is sent back to the sender.
The keyrings for each list are standard GnuPG keyrings and sit in the filesystem under `$lists_dir/$hostname/$listname/` ($lists_dir is read from `schleuder.yml`, see [Configuration](#configuration)). They can be used manually using gpg2. Please be careful to maintain proper file permissions if you touch the files.
In the list-directory there's also a list specific log-file (might be missing if the log-level is high and no error occurred yet).
Other logging is sent to syslog. Where that ends up depends on the operating system and the system administration.
All other list-related data is stored in the SQL-database. Most data is unserialized, only some values are JSON-encoded.
---
title: Documentation
---
### Schleuder for&hellip;
* [subscribers](subscribers.html)
* [list-admins](list-admins.html)
* [server-admins](server-admins.html)
### Changed behaviour
Changes to the previous version of Schleuder are summarized in [changes](changes.html).
---
title: Documentation for list-admins
---
{% include docs-head.md version=3.5 %}
{% include_relative _list_usage_basics.md %}
#### Subscription and key management
These keywords must be send to `foo-request@hostname`. They are used to get information about the list, its subscribers and keys, or to change that information.
**x-list-subscriptions**
: List all subscriptions.
**x-subscribe:** person@example.org 0x12345678DEADBEEF12345678DEADBEEF12345678
: Subscribe the given address and assign it the given OpenPGP-fingerprint.
**x-unsubscribe:** person@example.org
: Unsubscribe the given address. It is not possible to unsubscribe the last admin of a list.
**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 a fingerprint use `x-unset-fingerprint`.
**x-set-fingerprint:** person@example.org 0x12345678DEADBEEF12345678DEADBEEF12345678
: Assign the key with the given fingerprint to the given subscription. This variant of this command may only be used by list-admins. To unset a fingerprint use `x-unset-fingerprint`.
**x-unset-fingerprint:** person@example.org
: Remove the fingerprint associated with a given subscription.
**x-list-keys**
: Lists all public keys known to the list. To see only keys that match a given string, use `x-list-keys: something`.
**x-add-key:**
: Import the attachments or the rest of the email-body into the list's keyring. Only ascii-armored keys are supported.
**x-delete-key:** 0x12345678DEADBEEF12345678DEADBEEF12345678
: Delete the key with the given fingerprint from the list's keyring.
**x-get-key:** 0x12345678DEADBEEF12345678DEADBEEF12345678
: Export the key with the given fingerprint from the list's keyring.
**x-fetch-key:** 0x12345678DEADBEEF12345678DEADBEEF12345678
: Fetch the key with the given fingerprint from a keyserver and import it into the list's keyring. (This works only if a keyserver has been configured by the provider.)
This keyword must be send to the normal list-address: `foo@hostname`.
**x-attach-listkey:**
: Attachs the public key of the list. This might be useful for example after the setup of a new list, to distribute the public key of the list to all subscribers.
#### Other
These must also be sent to the request-address: <foo-request@hostname>.
**x-get-logfile:**
: Sends the logfile of the list.
**x-get-version:**
: Returns the version of schleuder.
**x-sign-this:**
: Sign the remaining contents of the email body or the attachments with the list's key. Use this e.g. to provide GnuPG-signatures for things you are publishing.
{% include participate.md %}
---
title: Projects and Plugins
---
These projects also belong to the schleuder-family:
* [schleuder-web]({{"/schleuder-web" | absolute_url}})
* [schleuder-cli]({{"/schleuder-cli" | absolute_url}})
* [schleuder-gitlab-ticketing]({{"/schleuder-gitlab-ticketing" | absolute_url}})
---
title: Documentation for server-admins
---
{% include docs-head.md version=3.5 %}
## Setup Schleuder
### Installation
You can install schleuder either from Linux distribution packages or rubygems. Currently there are supported distribution packages for Debian ("buster" and above) and CentOS 7. If you use one of the directly supported platforms, you should choose the packages over the gems.
{: .note}
Don't use the packages provided by Ubuntu in all releases up to and including 17.10, they are severely outdated. On Ubuntu 18.04 only use the package if it has at least version 3.2.2.
Besides schleuder you should also install at least one of [schleuder-cli](https://0xacab.org/schleuder/schleuder-cli) (the command line tool to manage Schleuder lists), and [schleuder-web](https://0xacab.org/schleuder/schleuder-web) (the web interface to manage and maintain Schleuder lists).
Additionally we recommend running an entropy source such as `haveged`. This ensures Schleuder won't be blocked by lacking entropy, which otherwise might happen e.g. during key generation.
#### Debian
{: .note}
The step needs root privileges
We maintain schleuder and schleuder-cli in "buster" and above. (For production usage we recommend Debian "buster".)
To install the packages
apt-get install schleuder schleuder-cli
Running `schleuder install` afterwards isn't necessary, the package takes care of it.
#### CentOS
For CentOS 7 there is a maintained [copr-repository](https://copr.fedorainfracloud.org/coprs/schleuder/schleuder/) using [Software Collections](https://www.softwarecollections.org/en/).
{: .note}
All steps need root privileges
Install the repository & the SCL repository
yum install centos-release-scl
curl -o /etc/yum.repos.d/schleuder-schleuder-epel-7.repo https://copr.fedorainfracloud.org/coprs/schleuder/schleuder/repo/epel-7/schleuder-schleuder-epel-7.repo
Now you are ready to install schleuder and schleuder-cli
yum install schleuder schleuder-cli
Afterwards run `schleuder install` to finalize the setup of Schleuder. This creates necessary directories, copies example configs, etc. If you see errors about missing write permissions please follow the advice given.
{: .note}
The copr-repository also provides you with a package for [schleuder-web](https://0xacab.org/schleuder/schleuder-web/). Please read the documentation of schleuder-web on how to get it up and running.
#### From Ruby-Gem
For instructions on how to install from rubygems please see the [README](https://0xacab.org/schleuder/schleuder/blob/master/README.md#installing-schleuder) of Schleuder.
#### Automation
To ease the installation and configuration of schleuder, schleuder-cli and schleuder-web, and to help with the creation and deletion of lists, you can rely either on...
* an [ansible role](https://github.com/systemli/ansible-role-schleuder), which works for Debian, or
* a [puppet module](https://0xacab.org/schleuder/puppet-schleuder). Currently it works for CentOS 7, but we would like to make it work for Debian as well - help would be highly appreciated.
### Configuration
Schleuder reads its **basic settings** from a file that it by default expects at `/etc/schleuder/schleuder.yml`. To make Schleuder read a different file set the environment variable `SCHLEUDER_CONFIG` to the path to your file when running schleuder. E.g.:
SCHLEUDER_CONFIG=/usr/local/etc/schleuder.yml /path/to/bin/schleuder ...
For explanations of the possible settings read the default config file (also [available in the repository](https://0xacab.org/schleuder/schleuder/blob/master/etc/schleuder.yml)).
The **default settings for new lists** are read from another config file. By default Schleuder looks at `/etc/schleuder/list-defaults.yml`. To make Schleuder read a different file set the environment variable `SCHLEUDER_LIST_DEFAULTS` analogous to above. The possible settings are explained in the default config file, which is [also available in the repository](https://0xacab.org/schleuder/schleuder/blob/master/etc/list-defaults.yml).
Once a list is created, it is not affected by these configuration files any more. Existing lists have their configuration stored in the database. The settings in the database can be shown and set via the schleuder API, available through schleuder-web or schleuder-cli. Run `schleuder-cli lists help` and `schleuder-cli lists list-options` for more information on the latter.
### Hook into Mail Transport Agent
In "work"-mode, Schleuder expects the list's email-address as second argument (first one is "work") and the incoming email on standard-input.
To enable Schleuder to receive emails, your Mail Transport Agent must be configured accordingly. How to do this with Postfix is documented in detail below.
#### Postfix
{: .note}
This section describes only those parts of a Postfix-setup that are relevant to Schleuder. We assume that you have a sensible and tested Postfix-setup already.
Firstly, to hook Schleuder into Postfix adapt these lines (path and maybe user) and add them to `master.cf`:
schleuder unix - n n - - pipe
flags=DRhu user=schleuder argv=/path/to/bin/schleuder work ${recipient}
Then you have to chose how postfix should decide if a message should be delivered to Schleuder. There are two options:
1. Configure it for each list individually. That's the way to go if you don't run many lists, or use the respective domain also for a varying number of email accounts or aliases.
2. Dedicate a whole domain to Schleuder. That's the way to go if you run more lists than email accounts or aliases on that domain.
**To configure each list individually,** add these lines to `main.cf`:
schleuder_destination_recipient_limit = 1
transport_maps = hash:/etc/postfix/transport_schleuder
Now adapt the following lines for each list and add them to `/etc/postfix/transport_schleuder`:
foo@example.org schleuder:
foo-request@example.org schleuder:
foo-owner@example.org schleuder:
foo-bounce@example.org schleuder:
foo-sendkey@example.org schleuder:
Afterwards run `postmap /etc/postfix/transport_schleuder` and restart postfix. Remember to repeat this also for newly created lists later.
Another way to tell postfix which domain and list can be piped to schleuder is to get that information out of the sqlite database. A requirement for that is the postfix-sqlite package, which isn't in the standard repositories of CentOS, but Debian.
**To dedicate a whole domain to Schleuder,** add these lines to `main.cf`:
schleuder_destination_recipient_limit = 1
virtual_mailbox_domains = sqlite:/etc/postfix/schleuder_domain_sqlite.cf
virtual_transport = schleuder
virtual_alias_maps = hash:/etc/postfix/virtual_aliases
virtual_mailbox_maps = sqlite:/etc/postfix/schleuder_list_sqlite.cf
Then adapt and add at least the following exceptions from the All-to-Schleuder-rule to `/etc/postfix/virtual_aliases`:
postmaster@lists.example.org root@anotherdomain
abuse@lists.example.org root@anotherdomain
MAILER-DAEMON@lists.example.org root@anotherdomain
root@lists.example.org root@anotherdomain
Afterwards run `postmap /etc/postfix/virtual_aliases`.
The file `schleuder_domain_sqlite.cf` can ask the schleuder sqlite database (this will delegate the whole domain to schleuder):
dbpath = /var/lib/schleuder/db.sqlite
query = select distinct substr(email, instr(email, '@') + 1) from lists
where email like '%%%s'
And the file `schleuder_list_sqlite.cf` can also get the information from the schleuder sqlite database:
dbpath = /var/lib/schleuder/db.sqlite
query = select 'present' from lists
where email = '%s'
or email = replace('%s', '-bounce@', '@')
or email = replace('%s', '-owner@', '@')
or email = replace('%s', '-request@', '@')
or email = replace('%s', '-sendkey@', '@')
From now on each Schleuder-list will instantly be reachable by email once it was created.
#### Exim
{: .note}
This section describes only those parts of a Exim-setup that are relevant to Schleuder. We assume that you have a sensible and tested Exim-setup already.
As with any exim email routing, we need to configure essentially a router that accepts and directs a mail to a transport, which knows how to hand-over an email to schleuder.
Within the `begin routers` section of your `exim.conf` you can add the following router:
mlschleuder:
driver = accept
condition = ${lookup {$local_part@$domain}lsearch{/etc/exim/schleuder-lists} {yes}{no}}
local_part_suffix_optional
local_part_suffix = +* : -bounce : -sendkey : -request : -owner
transport = mlschleuder_transport_local
no_more
`/etc/exim/schleuder-lists` is a simple textfile containing one list-address per line. You can for example create it by executing `schleuder-cli lists list > /etc/exim/schleuder-lists` after creating or deleting any lists. In more advanced setups you might have different conditions depending on how you manage the inventory of your schleuder lists and decide to accept a mail for a list.
Within the `begin transports` section of your `exim.conf` you then configure the transport:
mlschleuder_transport_local:
driver = pipe
user = schleuder
group = schleuder
# schleuders generates nice log messages for some of the problems
return_fail_output = true
home_directory = /var/lib/schleuder/lists/$domain/$local_part
command = "/usr/bin/schleuder work $local_part$local_part_suffix@$domain"
message_size_limit = 10M
Please note that we keep the `$local_part_suffix` when handing the mail over to schleuder, so schleuder can e.g. detect bounces or sendkey emails properly.
Restart exim and you have your working schleuder+exim setup.
Remember to repeat dumping the list of schleuder-lists to `/etc/exim/schleuder-lists` also for newly created lists later.
### Schleuder API
The Schleuder API is provided by `schleuder-api-daemon`. Configuration clients (schleuder-web, schleuder-cli) use it to access information about lists, subscriptions, and keys. As you probably want to at least use schleuder-cli from localhost, setting up schleuder-api-daemon is useful even without remote clients.
{: .note}
Schleuder does **not** use schleuder-api-daemon to process emails. You can stop schleuder-api-daemon at any time without breaking the email flow.
To run `schleuder-api-daemon`, depending on the type of operating system and the setup you are using, you can either start the systemd-unit-file:
systemctl start schleuder-api-daemon
Or you can run it manually in a shell:
schleuder-api-daemon
{: .note}
Please take care to run `schleuder-api-daemon` as the user that owns the directory of schleuder lists (by default `/var/lib/schleuder/lists`) to avoid running into file permission problems!
#### Transport encryption
schleuder-api-daemon uses transport encyrption (TLS) for all connections. The required TLS-certifcates should have been generated during the setup (`schleuder install`). You can generate new ones at any time by executing:
schleuder cert generate
If the file systems permissions allow it, Schleuder will write the certificate and the key directly into the correct files (paths are read from the configuration file). Otherwise you might have to move them. Please read the output of the above command for possible instructions.
In case you already have a suitable certificate you can use that, too. Its hostnames do not matter. Just copy it to the paths specified in the configuration file, or change those paths.
In order to verify the connection, each client needs to know the fingerprint of the API-certificate. The fingerprint will be shown when generating the certificates. Later you can always have it show again by executing this:
schleuder cert fingerprint
{: .note}
Use secure channels to transport this information!
#### Authentication
The Schleuder API uses API-keys to authenticate clients.
You can generate new API-keys by executing:
schleuder new_api_key
To enable the client to connect, their API-key must be added to the section `valid_api_keys` in Schleuder's configuration file.
{: .note}
Provide each client with their own API-key, and use secure channels to transport this information!
{: .note}
There is **no authorization of clients,** yet. Each client is allowed every action. So be wary who to give an API-key to. schleuder-web does its own authorization, but schleuder-cli does not!
## Managing a list
To create and manage lists you have two options: schleuder-web and schleuder-cli.
Both require a running `schleuder-api-daemon`. Please see [the previous section](#schleuder-api) on how to set that up.
### schleuder-web
To create lists with schleuder-web log in as `root@localhost`. Managing lists is allowed to each list-admin.
### schleuder-cli
To use schleuder-cli please see the output of
schleuder-cli help
## Maintenance
{: .note}
Please take care to have the following commands run by the user that owns the directory of schleuder lists (by default `/var/lib/schleuder/lists`) to avoid running into file permission problems!
Schleuder can **check all keys** that are present in the list's keyrings for (upcoming) expiration dates, revocation, or other reasons for not being usable.
Call this command weekly from cron to automate the check and have the results sent to the respective list-admins:
schleuder check_keys
Schleuder can also **refresh all keys** in the same manner. Each key of each list will be refreshed from a keyserver one by one. If you're using gpg 2.1, it's possible to configure a TOR onion service to be used as keyserver! See [the config](https://0xacab.org/schleuder/schleuder/blob/master/etc/schleuder.yml) for an example.
Call this command weekly from cron to automate the check and have the results sent to the respective list-admins:
schleuder refresh_keys
The available packages for Debian and CentOS both install a weekly cron job that check and refresh keys. Listadmins will be notified about issues with or changes to their keyring.
An additional maintenance command is available that allows you to pin subscriptions to their best matching key. If there is no key assigned, schleuder will try to select a key from the list's keyring that distinctly matches the subscription's email address.
This feature should be used with care. It's easy for a malicious (or inexperienced) person to inject additional user-IDs into the list's keyring. This can lead to situations in which people suddenly receive emails that are encrypted to a key they don't own.
You should better not run this command automatedly, and you should always examine the output closely to check for unintended consequences.
schleuder pin_keys
{% include participate.md %}
---
title: Documentation for subscribers
---
{% include docs-head.md version=3.5 %}
{% include_relative _list_usage_basics.md %}
#### Subscription and key management