NAME
schleuder - GnuPG enabled mailing list manager with remailer-
capabilities
SYNOPSIS
schleuder LISTNAME < EMAIL
schleuder -test [LISTNAME]
DESCRIPTION
Schleuder is designed as a tool for group communication: subscribers
can communicate encrypted (and pseudonymously) among themselves,
receive emails from non-subscribers and send emails to non-subscribers
via the list.
Schleuder takes care of all decryption and encryption, stripping of
headers, format conversions, etc. Schleuder can also send out its own
public key upon request and process administrative commands received by
email.
Email cryptography is handled by using GnuPG. Schleuder understands
all common encapsulation formats: inline, multipart/encrypted and
multipart/signed.
schleuder(8) is usually called in delivery mode by a Mail Transport
Agent with an incoming email piped to its standard input. For more
informations on how to integrate Schleuder with your existing mail
setup, please look in /usr/share/doc/schleuder/README.Debian.
The -test option checks that basic settings are correct.
schleuder-newlist(8) automates the creation of new mailing lists.
AUTOMATIC SENDING OF LIST PUBLIC KEY
To receive the public key of the mailing list anybody can send an email
to the list with send key! as the subject:
Subject: send key!
The body of the email must be left blank. Schleuder will reply with
the public key of the list without forwarding the request to the list
members.
EMAIL COMMANDS
Schleuder provides some special commands for advanced features to be
used by list members. Generally they are called by keywords written
into the first non-blank line of an email. Schleuder scans for those
keywords in every incoming email that is encrypted and validly signed
by a list member.
Please note that depending on the list configuration, some commands
might only be accessible to the administrators of the list.
To receive the list of members:
X-GET-MEMBERS
You will receive the raw content of the members.conf file. For details
on that file and its formatting see FILES.
To store the (changed) list of members:
X-SAVE-MEMBERS:
- email: you@example.net
- email: me@example.net
mime: PLAIN
Please take care of correct YAML-formatting. You can break the list
with wrongly formatted data. (see <http://www.yaml.org/> if you are
unsure)
To receive the list of public keys known to the list
X-LIST-KEYS
To receive a certain public key known to the list
X-SEND-KEY: foobar@example.com
To add a public key to the list
X-ADD-KEY:
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v1.4.9 (GNU/Linux)
mQGiBEjVO7oRBADQvT6wtD2IzzIiK0NbrcilCKCp4MWb8cYXTXguwPQI6y0Nerz4
dsK6J0X1Vgeo02tqA4xd3EDK8rdqL2yZfl/2egH8+85R3gDk+kqkfEp4pwCgp6VO
[...]
pNlF/qkaWwRb048h+iMrW21EkouLKTDPFkdFbapV2X5KJZIcfhO1zEbwc1ZKF3Ju
Q9X5GRmY62hz9SCZnsC0jeYAni8OUQV9NXfXlS/vePBUnOL08NQB
=xTv3
-----END PGP PUBLIC KEY BLOCK-----
To send out an email to an external recipient (encrypted if possible,
otherwise in the clear)
X-RESEND: emailaddress@example.net
Or to send it only if encryption is available
X-RESEND-ENCRYPTED-ONLY: emailaddress@example.net
EXIT STATUS
0 Incoming email was processed without errors.
Configuration is correct in test mode.
1 Internal failure in incoming email processing.
Bad configuration in test mode.
100 Unable to decrypt the received message.
Unable to verify the signature when configured to only accept signed
messages.
Message is cleartext when only encrypted messages are allowed.
Message is not authenticated as coming from a list member when
authentication is required.
FILES
/etc/schleuder/schleuder.conf
Global Schleuder configuration
/etc/schleuder/default-list.conf
Default list settings
/etc/schleuder/LISTNAME/list.conf
List settings
/etc/schleuder/LISTNAME/members.conf
List susbcribers.
Each member must have the email-attribute set. All other attributes
are optional.
The following attributes are available:
· mime: defines the ‘pgp-variant’ to send to the member, possible
values are MIME (for pgp/mime-formatted mail according to RFC 3156),
and PLAIN (for inline-pgp). The fallback-default for this is defined
in the list.conf.
· key: defines a specific key to use for the member. Normally public
keys are found via the email-attribute matching some key-id. If no
such key or multiple of them exist you may want to use this setting.
· encrypted_only: schleuder tries to encrypt every outgoing email. If
that is not possible under some conditions it sends the email
unecrypted. If this attribute is set the member will never receive
unencrypted emails; the member will be skipped if encrypting is not
possible.
Example:
- email: you@example.net
- email: me@example.org
mime: PLAIN
- email: them@example.com
encrypted_only: true
/var/lib/schleuder/LISTNAME
List internal data
/var/log/schleuder
Schleuder logs directory
All configuration files are formatted as YAML. See
<http://www.yaml.org/> for more details.
BUGS
Known bugs are listed on the Schleuder website.
SEE ALSO
schleuder-newlist(8), /usr/share/doc/schleuder/README.Debian, gnupg(7).
Schleuder website: <http://nadir.schleuder.org/>
YAML website: <http://www.yaml.org/>
AUTHORS
schleuder2@nadir.org.