debian/0000755000000000000000000000000012142206463007166 5ustar debian/schleuder.manpages0000644000000000000000000000005012142206463012654 0ustar man/schleuder.8 man/schleuder-newlist.8 debian/schleuder.install0000644000000000000000000000036112142206463012534 0ustar bin/schleuder usr/bin bin/schleuder-newlist usr/bin bin/schleuder-migrate-v2.1-to-v2.2 usr/sbin ext/default-list.conf etc/schleuder ext/schleuder.conf etc/schleuder lib/* usr/lib/ruby/vendor_ruby/1.8 plugins/*.rb usr/share/schleuder/plugins debian/schleuder.postrm0000644000000000000000000000023712142206463012414 0ustar #!/bin/sh set -e case "$1" in purge) rm -rf /etc/schleuder/lists rm -rf /var/lib/schleuder rm -rf /var/log/schleuder ;; *) ;; esac #DEBHELPER# debian/rules0000755000000000000000000000041512142206463010246 0ustar #!/usr/bin/make -f %: dh $@ override_dh_install: dh_install cp contrib/check-expired-keys.rb debian/schleuder/usr/sbin/schleuder-check-expired-keys override_dh_installdocs: dh_installdocs cp plugins/README debian/schleuder/usr/share/doc/schleuder/README.plugins debian/control0000644000000000000000000000177212142206463010600 0ustar Source: schleuder Section: mail Priority: optional Maintainer: Jérémy Bobbio Build-Depends: debhelper (>= 7.0.50~) Standards-Version: 3.9.4 Homepage: http://schleuder.nadir.org/ Vcs-Git: git://git.debian.org/git/collab-maint/schleuder.git Vcs-Browser: http://git.debian.org/?p=collab-maint/schleuder.git Package: schleuder Architecture: all Depends: ${misc:Depends}, adduser, exim4 | mail-transport-agent, ruby1.8, ruby-tmail, ruby-gpgme, ruby-magic, ruby-log4r, ruby-highline Description: GnuPG enabled mailing list manager with remailer-capabilities 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, formatting conversions, etc. Schleuder can also send out its own public key upon request and process administrative commands by email. debian/NEWS0000644000000000000000000000547412142206463007677 0ustar schleuder (2.2.1-1) unstable; urgency=low Schleuder 2.2 introduces several major changes. Highlights: - New `-owner` suffix: the `list-owner@example.org` address will redirect (and encrypt) messages to the list administrators. - New `-request` suffix: administrative commands should now be sent to `list-request@example.org`. Communication commands (e.g. X-RESEND) - New list administration commands that are more "member" oriented: `X-ADD-MEMBER`, `X-DELETE-MEMBER`, `X-UNSUBSCRIBE`. Refer to schleuder(8) to know more about them. - Listnames are now full email addresses (to support multiple domains). - Archive support: list messages can now be stored. Please note that despite the fact that messages are stored encrypted, both private key and passphrase are stored right next to them. Archiving should not be done by Schleuder if privacy really matters. List configuration updates -------------------------- Upon package upgrade, the lists currently configured will be automatically updated upon upgarde to the new settings and moved to the new directory format. An UID for each new address have also been added to the list public key. For list that you wish to import from an older version, the same process can be repeated by calling `schleuder-migrate-v2.1-to-v2.2` manually. As the migration procedure updates the list public key, it is advised to re-export it to keyservers and list users. Changes required to the MTA configuration ----------------------------------------- *CAUTION*: The MTA configuration needs to be updated to support the new command line syntax and the new list suffixes: - the `schleuder` command now takes a full recipient address (e.g. `list@example.org` or `list-owner@example.org`), - the `-request` and `-owner` addresses should also use the `schleuder` as transport. If you are using Exim or Postfix, please compare your configuration with the one suggested in README.Debian. Updates to Schleuder configuration ---------------------------------- Please review the value of the `keywords_admin_only` setting in `/etc/schleuder/schleuder.conf`, otherwise you might enable list users to perform administrative duties. The new default set is: ['ADD-MEMBER', 'DELETE-MEMBER', 'DELETE-KEY', 'SAVE-MEMBERS', 'DEL-KEY'] The plugin API has changed. Please update any custom plugins. Weekly warnings of expired member keys -------------------------------------- Schleuder 2.2 adds a new script meant to warn list administrators of expired member keys. The Debian package will run it (through cron) each week for every known list. -- Jérémy Bobbio Sat, 16 Jun 2012 12:19:35 +0200 debian/docs0000644000000000000000000000000712142206463010036 0ustar README debian/schleuder.examples0000644000000000000000000000016212142206463012703 0ustar contrib/mutt-schleuder-colors.rc contrib/mutt-schleuder-resend.vim ext/list.conf.example ext/default-members.conf debian/compat0000644000000000000000000000000212142206463010364 0ustar 7 debian/schleuder.dirs0000644000000000000000000000011612142206463012025 0ustar var/log/schleuder var/lib/schleuder etc/schleuder/plugins etc/schleuder/lists debian/README.Debian0000644000000000000000000001217512142206463011235 0ustar Schleuder for Debian ==================== Setting up Schleuder -------------------- 1. Edit /etc/schleuder/schleuder.conf to suit the site configuration. Most defaults should be fine with most setups but you might want to adjust `superadminaddr`. 2. Create a new mailing list using schleuder-newlist(8). e.g. # schleuder-newlist list@example.org 3. Adjust list settings in /etc/schleuder/lists/DOMAIN/LISTNAME.conf More information on the various settings can be found in /etc/schleuder/default-list.conf. 4. Setup the MTA to pipe messages to Schleuder addresses See below for how it can be done with Exim 4 and Postfix. 5. Send an email to list-sendkey@example.org. If everything goes fine, you should get a reply containing the list public key. If it does not, check the various log files for any clues. 6. Add more members! The easiest way is to send an encrypted email to `list-request@example.org` having in the body: X-ADD-MEMBER: new.member@example.org mime -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v1.4.9 (GNU/Linux) mQGiBEjVO7oRBADQvT6wtD2IzzIiK0NbrcilCKCp4MWb8cYXTXguwPQI6y0Nerz4 dsK6J0X1Vgeo02tqA4xd3EDK8rdqL2yZfl/2egH8+85R3gDk+kqkfEp4pwCgp6VO [...] pNlF/qkaWwRb048h+iMrW21EkouLKTDPFkdFbapV2X5KJZIcfhO1zEbwc1ZKF3Ju =xTv3 -----END PGP PUBLIC KEY BLOCK----- Replace the KEY BLOCK with an ascii export of the new member's public key. 7. Enjoy! Using Schleuder with Exim 4 --------------------------- The file names presented here assume that you have opted for the split Exim configuration. In /etc/exim4/conf.d/router/550_schleuder, write: schleuder: debug_print = "R: schleuder for ${recipient}" driver = accept local_part_suffix_optional local_part_suffix = +* : -bounce : -sendkey : -request : -owner domains = +local_domains require_files = schleuder:/var/lib/schleuder/${domain}/${local_part}/ transport = schleuder_transport Then, in /etc/exim4/conf.d/transport/30_schleuder, write: schleuder_transport: debug_print = "T: schleuder_transport for ${recipient}" driver = pipe user = schleuder group = schleuder home_directory = "/var/lib/schleuder/${domain}/${local_part}" command = "/usr/bin/schleuder ${recipient}" Finally, regenerate a full configuration file: # update-exim4.conf New lists created in `/var/lib/schleuder` (default when using schleuder-newlist(8)) will automatically work when using this setup. For another advanced Exim setup, using an SQL database and multiple Unix accounts, please have a look at: http://schleuder.nadir.org/documentation/configurationeximplus.html Using Schleuder with Postfix ---------------------------- The proposed setup for Postfix is to use a dedicated "schleuder" transport. List addresses will be manually directed to use this specific transport using `transport_maps`, see transport(5) for details. 1. In `/etc/postfix/master.cf`, add: schleuder unix - n n - - pipe flags=DRhu user=schleuder argv=/usr/bin/schleuder ${recipient} 2. Then, in `/etc/postfix/main.cf`, add: schleuder_destination_recipient_limit = 1 transport_maps = hash:/etc/postfix/transports 3. a. If you want to have mailing lists managed by Schleuder with other addresses under the same domain you must list every mailing list in `/etc/postfix/transports`, like the following: LISTNAME@host.tld schleuder: LISTNAME-bounces@host.tld schleuder: LISTNAME-sendkey@host.tld schleuder: LISTNAME-request@host.tld schleuder: LISTNAME-owner@host.tld schleuder: b. Or, if you dedicate a specific domain-name to Schleuder lists, simply add the following line to `/etc/postfix/transports`: host.tld schleuder: 4. Refresh the transport map by doing: # postmap /etc/postfix/transports Other Schleuder setups ---------------------- If you manage to get a nice working setup with your favorite MTA, please send an email to `schleuder2@nadir.org`, add it to Schleuder wiki or submit a wishlist bug against the `schleuder` package in debian. Using `/etc/aliases` and `sudo` might be the best fallback if you can't figure it out. Logging ------- To respect Debian policy, Schleuder has been modified to keep list logs by default under `/var/log/schleuder/.log`. Logging can also be done using syslog(3) (under the `mail` facility) by specifying "syslog" for the `lists_logfile` and `logfile` parameters in `/etc/schleuder/schleuder.conf`. schleuder account ----------------- The Debian package for Schleuder creates a "schleuder" account on installation. The list creation program, schleuder-newlist(8), will default to use this account when creating new lists. If you wish to have schleuder(8) running with other account credentials, you will need to make those users members of the "schleuder" group to allow them to write to `/var/log/schleuder`. WebSchleuder ------------ The web management interface for Schleuder has not yet been packaged for Debian. Any help is highly welcome. -- Jérémy Bobbio Sat, 29 Aug 2009 23:21:23 +0200 debian/schleuder.logrotate0000644000000000000000000000022212142206463013062 0ustar /var/log/schleuder/*.log { daily missingok rotate 10 compress delaycompress notifempty create 640 schleuder schleuder su root schleuder } debian/schleuder.postinst0000644000000000000000000000176212142206463012757 0ustar #!/bin/sh set -e case "$1" in configure) if ! id schleuder >/dev/null 2>&1; then adduser --system --group --gecos "Schleuder mailing list" --no-create-home \ --home /var/lib/schleuder schleuder >/dev/null fi if ! dpkg-statoverride --list "/var/lib/schleuder"; then chown schleuder:schleuder /var/lib/schleuder chmod 771 /var/lib/schleuder fi if ! dpkg-statoverride --list "/var/log/schleuder"; then chown root:schleuder /var/log/schleuder chmod 770 /var/log/schleuder touch /var/log/schleuder/schleuder.log chmod 660 /var/log/schleuder/schleuder.log chown schleuder:schleuder /var/log/schleuder/schleuder.log fi if ! dpkg-statoverride --list "/etc/schleuder/lists"; then chown root:schleuder /etc/schleuder/lists chmod 750 /etc/schleuder/lists fi if dpkg --compare-versions "$2" lt 2.2.1 && [ -d /etc/schleuder/lists ]; then find /etc/schleuder/lists -maxdepth 1 -name '*.conf' -exec \ schleuder-migrate-v2.1-to-v2.2 '{}' ';' fi ;; *) ;; esac #DEBHELPER# debian/copyright0000644000000000000000000000364412142206463011130 0ustar Copyright-Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: Schleuder Source: http://schleuder.nadir.org/ Files: * Copyright: 2009-2010, paz, ng et al. License: GPL-2 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License. . This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. . You should have received a copy of the GNU General Public License along with this package; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA . On Debian systems, the full text of the GNU General Public License version 2 can be found in the file `/usr/share/common-licenses/GPL-2'. Files: debian/* Copyright: 2009-2012, Jérémy Bobbio License: GPL-2+ This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. . This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. . You should have received a copy of the GNU General Public License along with this package; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA . On Debian systems, the full text of the GNU General Public License version 2 can be found in the file `/usr/share/common-licenses/GPL-2'. debian/changelog0000644000000000000000000001475212142206463011051 0ustar schleuder (2.2.1-3) unstable; urgency=medium * Set urgency to medium as this version fixes 3 really annoying bugs. * Update feature-switch-to-gpgme-2.patch to fix -sendkey. (Closes: #705865) * Update patches to fix issues with plugin directories with the default configuration. (Closes: #705876) * Cherry-pick two upstream patches to fix member listing in 'manage members' plugin. (Closes: #705877) * Bump Standards-Version to 3.9.4, no changes required. -- Jérémy Bobbio Tue, 07 May 2013 16:06:46 +0200 schleuder (2.2.1-2) unstable; urgency=low * Support removed (but not purged) package in weekly cron. (Closes: #678487) * Ensure that /etc/schleuder/lists exists before migrating lists from older releases format. * Fix receiving unencrypted messages: transform one missed call to 'ruby-filemagic' in the 'magic' equivalent. * Warn for expiring keys for two weeks instead of more than three years in check-expired-keys. * Avoid stty calls in check-expired-keys cron avoid weekly error messages. * Restore the lost debian-no-rubygems.patch: the Debian package does not need rubygems to work. * Fix broken member file created by schleuder-newlist when used in interactive mode. * Fix spelling mistake in debian/NEWS. Thanks lintian for spotting that one. * Drop useless Build-Depends on pandoc. Upstream ships manpages since version 2.2. -- Jérémy Bobbio Mon, 15 Oct 2012 14:43:23 +0200 schleuder (2.2.1-1) unstable; urgency=low * Update README.source. * Drop the following patches: - 0004-Deactivate-log-file-rotation-by-default.patch: Upstream has removed support for log file rotation. - 0008-Suggest-to-install-highline-package-in-newlist.patch: highline is required by `bin/schleuder-migrate-v2.1-to-v2.2` and thus now a hard Depends. - 0011-Formal-workaround-for-ruby-gpgme-1.0.8-for-use-with-.patch: It was cherry-picked from upstream master branch. - 0012-Better-workaround-for-ruby-gpgme-1.0.8-for-use-with-.patch: It was cherry-picked from upstream master branch. - 0013-newlist-add-the-necessary-workaround-for-ruby-gpgme-.patch: It has been integrated upstream. - 0014-Don-t-echo-passphrase-to-terminal-when-asking-for-it.patch: It was cherry-picked from master. * Refresh the following patches: - 0001-Enable-logging-through-syslog.patch => feature-logging.patch - 0002-Allow-list-configuration-files-to-be-in-a-single-dir.patch => feature-list-conf-dir.patch - 0003-Add-support-for-multiple-plugins-directory.patch => feature-multiple-plugins-dir.patch - 0005-Adjust-other-default-configuration-settings.patch => debian-default-settings.patch - 0006-No-need-for-rubygems-we-have-Debian-packages.patch => debian-no-rubygems.patch - 0007-Explicitely-use-ruby1.8-in-executable-scripts.patch => debian-use-ruby1.8.patch - 0009-Mention-README.Debian-in-newlist.patch => debian-readme-debian-in-newlist.patch * New patches: - bugs-dead-configuration-in-example.patch: Remove removed setting from example configuration. - bugs-missing-admin-only-keywords.patch: Adjust default settings to example configuration. - bugs-fix-manpages-wrt-2.2.1.patch: Update manpages with recent changes and improve formatting. - debian-use-magic-instead-of-filemagic.patch: Use the 'magic' gem instead of 'ruby-filemagic', as the former is already in Debian. * Refresh Depends in debian/control for 2.2.1. * Install library according to the new Debian Ruby policy. * Use upstream manpages. * Install schleuder-newlist from its new location. * Update README.Debian for Schleuder 2.2. * Add new default-members.conf to examples. * Call migration scripts when upgrading from previous version. * Add weekly reminder for expired member keys. * Add debian/NEWS to help admins cope with the new version. * Ship README.plugins at its intended location * Remove schleuder-migrationhelper.pl from examples (removed upstream). * Update mutt-schleuder-resend.vim name in examples. * Do not ship TODO in docs (removed upstream). -- Jérémy Bobbio Tue, 19 Jun 2012 17:49:16 +0200 schleuder (2.1.1-3) unstable; urgency=low * Switch to source format 3.0 (quilt) * Set "su" directive in logrotate configuration file. (Closes: #657924) * Prevent schleuder-newlist from echoing passphrase on terminal. (Closes: #649403) * Update debian/copyright. * Update package names to new Ruby packaging practices. * Bump Standards-Version to 3.9.3, no changes required. -- Jérémy Bobbio Fri, 06 Apr 2012 18:59:45 +0200 schleuder (2.1.1-2) unstable; urgency=medium * Fix Schleuder website URL in schleuder(8) manpage. (Closes: #597737) * Fix compatibility issue in schleuder-newlist when used with recent libgpgme-ruby1.8. * Set urgency to medium, as the former bug breaks documented procedure on Squeeze. * Bump Standards-Version to 3.9.1, no changes required. -- Jérémy Bobbio Tue, 02 Nov 2010 22:04:52 +0100 schleuder (2.1.1-1) unstable; urgency=low * New upstream version. * Fix logfile rotation. (Closes: #559763) * Cherry-pick upstream d4480416 and eb50bdbb to fix compatibility with libgpgme-ruby (>= 1.0.8). * Set /var/lib/schleuder mode bits to 771 instead of mode 770 that prevented the sample Exim configuration to work. (Closes: #559965) * Remove UTF-8 characters from manpages as Pandoc is currently broken when no locales are configured. * Fix a spelling error in README.Debian found by Lintian. -- Jérémy Bobbio Sun, 09 May 2010 21:20:49 +0200 schleuder (2.1.0-1) unstable; urgency=low * New upstream version. * Ship list configuration example. * Ship upstream TODO list. * Update watch file. * Update URL to documentation in README.Debian. * Break long lines in schleuder-newlist(8). -- Jérémy Bobbio Sun, 15 Nov 2009 19:24:13 +0100 schleuder (2.0.0+git.20090824.745f0c6-2) unstable; urgency=low * Correct "notifempty" directive in logrotate configuration file. (Closes: #545033) * Remove logs, list configuration files and data directories on purge. -- Jérémy Bobbio Sat, 05 Sep 2009 00:22:13 +0200 schleuder (2.0.0+git.20090824.745f0c6-1) unstable; urgency=low * Initial release. (Closes: #544234) -- Jérémy Bobbio Wed, 02 Sep 2009 02:39:06 +0200 debian/source/0000755000000000000000000000000012142206463010466 5ustar debian/source/format0000644000000000000000000000001412142206463011674 0ustar 3.0 (quilt) debian/schleuder.cron.weekly0000755000000000000000000000067112142206463013335 0ustar #!/bin/sh set -e PATH=/sbin:/bin:/usr/sbin:/usr/bin test -x /usr/sbin/schleuder-check-expired-keys || exit 0 test -d /etc/schleuder/lists || exit 0 find /etc/schleuder/lists -mindepth 1 -maxdepth 2 -name '*.conf' | while read conf; do conf="${conf%.conf}" local_part="${conf##*/}" conf="${conf%*/${local_part}}" domain="${conf##*/}" su -s /bin/sh schleuder -c "/usr/sbin/schleuder-check-expired-keys '${local_part}@${domain}'" done debian/watch0000644000000000000000000000010712142206463010215 0ustar version=3 http://schleuder.nadir.org/ download/schleuder-(.+)\.tar\.gz debian/patches/0000755000000000000000000000000012142206463010615 5ustar debian/patches/bugs-dead-configuration-in-example.patch0000644000000000000000000000205012142206463020370 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Sat, 16 Jun 2012 16:24:18 +0200 Subject: [PATCH] bugs/dead-configuration-in-example MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit f523f54e619e07cc591dc4bd5b44d0dd72c70d2c Author: Jérémy Bobbio Date: Sat Jun 16 12:14:45 2012 +0200 Remove lists_logfile from example configuration This setting is useless since Schleuder uses Log4r (commit a48c4df88). --- ext/schleuder.conf | 4 ---- 1 files changed, 0 insertions(+), 4 deletions(-) diff --git a/ext/schleuder.conf b/ext/schleuder.conf index c056d10..7f11b43 100644 --- a/ext/schleuder.conf +++ b/ext/schleuder.conf @@ -26,10 +26,6 @@ # Name of the per list config file. #lists_configfile: list.conf # -# Per list logfile name. Will be written into the directory -# of the list. -#lists_logfile: list.log -# # Name of the per list file containing all members and their # options. #lists_memberfile: members.conf -- debian/patches/debian-use-schleuder-uid-in-newlist.patch0000644000000000000000000000223212142206463020473 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Sat, 16 Jun 2012 17:20:47 +0200 Subject: [PATCH] debian/use-schleuder-uid-in-newlist MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit 4dfb3362c9f66c6568645fffdf3841f29213a72b Author: Jérémy Bobbio Date: Wed Sep 2 00:14:54 2009 +0200 Use schleuder uid when newlist is run as root --- bin/schleuder-newlist | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-) diff --git a/bin/schleuder-newlist b/bin/schleuder-newlist index 34da443..91e4a06 100755 --- a/bin/schleuder-newlist +++ b/bin/schleuder-newlist @@ -100,8 +100,10 @@ class ListCreator list_privatekeyfile = args[:list_privatekeyfile] || 'none' list_publickeyfile = args[:list_publickeyfile] || 'none' list_passphrase = args[:list_passphrase] || 'none' - unless args[:mailuser].nil? + if ! args[:mailuser].nil? mailuser = Etc.getpwnam(args[:mailuser]).uid + elsif Process::Sys.getuid == 0 + mailuser = Etc.getpwnam('schleuder').uid else mailuser = Process::Sys.getuid end -- debian/patches/bugs-do-not-call-stty-in-check-expired.patch0000644000000000000000000000306412142206463021026 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Sun, 14 Oct 2012 22:06:10 +0200 Subject: [PATCH] bugs/do-not-call-stty-in-check-expired MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit a06df224d83e152b643d8016870272a4413487b2 Author: Jérémy Bobbio Date: Sun Oct 14 22:01:19 2012 +0200 Avoid stty calls in check-expired-keys cron Using String#fmt (defined in 'schleuder/utils') without any arguments will trigger calls to stty in order to guess the terminal size. Unfortunately, this is a pretty useless thing to do in a cron, as there is no tty. This triggers an error on stderr: stty: standard input: Invalid argument So, we give a fixed column size to String#fmt to always wrap the generated email at 72 chars and avoid the impossible guess. --- contrib/check-expired-keys.rb | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/contrib/check-expired-keys.rb b/contrib/check-expired-keys.rb index c87d842..4de5c90 100755 --- a/contrib/check-expired-keys.rb +++ b/contrib/check-expired-keys.rb @@ -53,7 +53,7 @@ unusable.each do |key,trust| end unless msg.empty? - prefix = "Checking the public keys present in the keyring of list #{listname} for usability gave the following result:".fmt + prefix = "Checking the public keys present in the keyring of list #{listname} for usability gave the following result:".fmt(72) Schleuder.log.notify_admin('keys', prefix + "\n\n" + msg) end -- debian/patches/debian-use-ruby1.8.patch0000644000000000000000000000377012142206463015067 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Sat, 16 Jun 2012 17:14:47 +0200 Subject: [PATCH] debian/use-ruby1.8 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit 167addde79240b01a8a436a5680be7f74afc4c36 Author: Jérémy Bobbio Date: Tue Sep 1 21:03:22 2009 +0200 Explicitely use ruby1.8 in executable scripts Let's stay on the safe side for now: we will migrate from 1.8 after Wheezy is released. --- bin/schleuder | 2 +- bin/schleuder-migrate-v2.1-to-v2.2 | 2 +- bin/schleuder-newlist | 2 +- contrib/check-expired-keys.rb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/bin/schleuder b/bin/schleuder index b91e514..c0b4cfb 100755 --- a/bin/schleuder +++ b/bin/schleuder @@ -1,4 +1,4 @@ -#!/usr/bin/env ruby +#!/usr/bin/env ruby1.8 # Don't show warnings, $stdout is being watched by the MTA. $VERBOSE = nil diff --git a/bin/schleuder-migrate-v2.1-to-v2.2 b/bin/schleuder-migrate-v2.1-to-v2.2 index 91f8d0d..a501de7 100755 --- a/bin/schleuder-migrate-v2.1-to-v2.2 +++ b/bin/schleuder-migrate-v2.1-to-v2.2 @@ -1,4 +1,4 @@ -#!/usr/bin/env ruby +#!/usr/bin/env ruby1.8 $:.unshift File.dirname(__FILE__) + '/../lib' require 'schleuder' diff --git a/bin/schleuder-newlist b/bin/schleuder-newlist index 08dbb17..9f756f0 100755 --- a/bin/schleuder-newlist +++ b/bin/schleuder-newlist @@ -1,4 +1,4 @@ -#!/usr/bin/env ruby +#!/usr/bin/env ruby1.8 $:.unshift File.dirname(__FILE__) + '/../lib' require 'schleuder' diff --git a/contrib/check-expired-keys.rb b/contrib/check-expired-keys.rb index 84e0bac..d9c0381 100755 --- a/contrib/check-expired-keys.rb +++ b/contrib/check-expired-keys.rb @@ -1,4 +1,4 @@ -#!/usr/bin/env ruby +#!/usr/bin/env ruby1.8 # # This script checks all public keys in the keyring of the given schleuder-list # for being expired (or otherwise unusable) and reports the output (if there -- debian/patches/debian-readme-debian-in-newlist.patch0000644000000000000000000000306612142206463017627 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Sat, 16 Jun 2012 17:20:35 +0200 Subject: [PATCH] debian/readme-debian-in-newlist MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit 3e36f9d8340f40771ba404a1005ca839f6892f22 Author: Jérémy Bobbio Date: Sat Jun 16 17:18:55 2012 +0200 Use the new output formater commit 1594775fefcacd813dd44e4a4a640ea21bc9bfb9 Author: Jérémy Bobbio Date: Tue Sep 1 21:42:55 2009 +0200 Mention README.Debian in newlist --- bin/schleuder-newlist | 5 ++++- 1 files changed, 4 insertions(+), 1 deletions(-) diff --git a/bin/schleuder-newlist b/bin/schleuder-newlist index 9f756f0..34da443 100755 --- a/bin/schleuder-newlist +++ b/bin/schleuder-newlist @@ -379,7 +379,10 @@ Passphrase: #{pass} def self.print_list_infos(list) puts "A new schleuder list called '#{list.config.myname}' has been created.".fmt puts - puts "To get a working list you have to tell your MTA to handle this list. For various examples have a look at ".fmt + puts "To get a working list you have to tell your MTA to handle this list.".fmt + puts "For various examples have a look at:".fmt + puts " * /usr/share/doc/schleuder/README.Debian".fmt + puts " * http://schleuder.nadir.org/documentation/creating_lists.html".fmt puts puts "Lists' key fingerprint:".fmt crypt = Schleuder::Crypt.new(list.config.gpg_password) -- debian/patches/bugs-fix-interactive-newlist.patch0000644000000000000000000000300012142206463017351 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Mon, 15 Oct 2012 12:31:16 +0200 Subject: [PATCH] bugs/fix-interactive-newlist MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit f6a396b3db19b5de1a12ac145c01cdb7b8ff4ac3 Author: Jérémy Bobbio Date: Mon Oct 15 12:25:50 2012 +0200 Fix broken member file created by interactive newlist HighLine's 'ask' function returns HighLine::String objects. Unfortunately, if such objects reach the YAML serializer, we then have trouble to unserialize them, as HighLine is not a required by the 'schleuder' executable. So let's transform all HighLine::String to plain String to avoid troubles. --- bin/schleuder-newlist | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/bin/schleuder-newlist b/bin/schleuder-newlist index cdaf373..6752c91 100755 --- a/bin/schleuder-newlist +++ b/bin/schleuder-newlist @@ -216,7 +216,7 @@ class ListCreator end end raise NewListError,"Missing mandatory variable: "+question if (var.nil? or var.empty?) - var + var.to_s end def self.verify_emailvar(var,interactive,question) @@ -234,7 +234,7 @@ class ListCreator var = ask("Filepath for "+question+": ") end raise NewListError,"Missing mandatory file: "+question if (not var.nil? and not File.exist?(var)) - var + var.to_s end def self.progfunc(hook, what, type, current, total) -- debian/patches/bugs-fix-member-listing.patch0000644000000000000000000000263112142206463016300 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Mon, 22 Apr 2013 17:47:36 +0200 Subject: [PATCH] bugs/fix-member-listing Squashed commit of the following: commit cae05ce0cdd6f5ebd7eb39647cdfca2475dda98c Author: ng Date: Fri Feb 15 20:01:22 2013 +0100 fix another issue whith displaying current members commit 4668c0f6dab7c82e37dfd3fabfddd4edfe8b6b03 Author: ng Date: Fri Feb 15 19:48:43 2013 +0100 fix display of list members --- plugins/manage_members_plugin.rb | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/manage_members_plugin.rb b/plugins/manage_members_plugin.rb index 5d8fa4e..4b19280 100644 --- a/plugins/manage_members_plugin.rb +++ b/plugins/manage_members_plugin.rb @@ -93,7 +93,7 @@ module Schleuder end msg << "\n" end - msg << "Updated members-list:\n\n#{_list_members(mail)}" + msg << "Updated members-list:\n\n#{_list_members(Schleuder.list.members)}" msg end @@ -110,7 +110,7 @@ module Schleuder msg = "Something failed. Please ask the maintainer of this list to figure out what\nhappened (e.g. by mailing to #{Schleuder.list.owner_addr}).\n" end end - msg << "\nUpdated members-list:\n\n#{_list_members(mail)}\n" + msg << "\nUpdated members-list:\n\n#{_list_members(Schleuder.list.members)}\n" msg end -- debian/patches/feature-switch-to-gpgme-2.patch0000644000000000000000000010063412142206463016450 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Sun, 21 Apr 2013 14:56:30 +0200 Subject: [PATCH] feature/switch-to-gpgme-2 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit f64749903ce065cfb90164d568058662da908937 Author: Jérémy Bobbio Date: Sun Apr 21 14:49:40 2013 +0200 Fix Crypt#export The previous use of #inspect to retrieve the content of the GPGME::Data actually relied on the #to_s method introduced in gpgme 2.0.1. In order to properly support gpgme 2.0.0 currently in Debian Wheezy, we properly perform rewind and read on the GPGME::Data needed by GPGME::Ctx#export_keys. commit 088dd56cc8f85a88c11bdcc211fb75ba8cf2b59e Author: Jérémy Bobbio Date: Fri Jun 15 16:25:47 2012 +0200 Migrate to gpgme 2 API commit baf4b700d12378dc79c28fb56d0a3cc296c34935 Author: Jérémy Bobbio Date: Fri Jun 15 17:22:48 2012 +0200 Add specs for Schleuder::Crypt commit aab374c07c2e040d459b2566c28eb36dfca76648 Author: Jérémy Bobbio Date: Fri Jun 15 17:43:17 2012 +0200 Fix wrong indentation --- bin/schleuder-newlist | 7 +- lib/schleuder.rb | 1 - lib/schleuder/crypt.rb | 47 ++-- lib/schleuder/mail.rb | 7 +- schleuder.gemspec | 3 +- spec/fixtures/jane@example.org-prv.asc | 44 ++++ spec/fixtures/jane@example.org-pub.asc | 27 ++ spec/fixtures/list@example.org-prv.asc | 44 ++++ spec/fixtures/list@example.org-pub.asc | 27 ++ spec/schleuder/crypt_spec.rb | 405 ++++++++++++++++++++++++++++++++ spec/spec_helper.rb | 6 + 11 files changed, 583 insertions(+), 33 deletions(-) create mode 100644 spec/fixtures/jane@example.org-prv.asc create mode 100644 spec/fixtures/jane@example.org-pub.asc create mode 100644 spec/fixtures/list@example.org-prv.asc create mode 100644 spec/fixtures/list@example.org-pub.asc create mode 100644 spec/schleuder/crypt_spec.rb create mode 100644 spec/spec_helper.rb diff --git a/bin/schleuder-newlist b/bin/schleuder-newlist index f42aa3f..1a4f3e0 100755 --- a/bin/schleuder-newlist +++ b/bin/schleuder-newlist @@ -255,10 +255,9 @@ class ListCreator if GPGME.respond_to? 'check_version' GPGME::check_version('0.0.0') end - GPGME::Ctx.new.genkey( - ListCreator::create_gnupg_params_template(_name,_email,_pass,_type,_length,_sub_type,_sub_length), - nil,nil - ) + GPGME::Ctx.new.generate_key( + ListCreator::create_gnupg_params_template(_name,_email,_pass,_type,_length,_sub_type,_sub_length) + ) # Add listname-request@hostname as UID. gpg_adduid = "gpg --no-tty --command-fd 0 --status-fd 1 --yes --edit-key #{_email} adduid" diff --git a/lib/schleuder.rb b/lib/schleuder.rb index 87b034a..3040829 100644 --- a/lib/schleuder.rb +++ b/lib/schleuder.rb @@ -19,7 +19,6 @@ else end end -gem 'gpgme', '=1.0.8' require 'gpgme' require 'net/smtp' diff --git a/lib/schleuder/crypt.rb b/lib/schleuder/crypt.rb index a532be2..9ace4a2 100644 --- a/lib/schleuder/crypt.rb +++ b/lib/schleuder/crypt.rb @@ -21,9 +21,10 @@ module Schleuder if GPGME.respond_to? 'check_version' GPGME::check_version('0.0.0') end - @ctx = GPGME::Ctx.new - # feed the passphrase into the Context - @ctx.set_passphrase_cb(method(:passfunc)) + # Access to GPGME high-level API + @crypto = GPGME::Crypto.new(:armor => true, :passphrase_callback => method(:passfunc)) + # Access to GPGME mid-level API + @ctx = GPGME::Ctx.new(:armor => true, :passphrase_callback => method(:passfunc)) end # Verify a gpg-signature. Use +signed_string+ if the signature is @@ -33,15 +34,14 @@ module Schleuder if signed_string.empty? # verify +sig+ as cleartext (aka pgp/inline) signature Schleuder.log.debug 'No extra signed_string, verifying cleartext signature' - output = GPGME.verify(sig) do |sig| + output = @crypto.verify(sig) do |sig| in_signed = sig end + output = output.read else # verify detached signature Schleuder.log.debug 'Verifying detached signature' - # Don't know why we need a GPGME::Data object this time but without gpgme throws exceptions - plain = GPGME::Data.new - GPGME.verify(sig, signed_string, plain) do |sig| + @crypto.verify(sig, :signed_text => signed_string) do |sig| in_signed = sig end output = signed_string @@ -66,7 +66,7 @@ module Schleuder # return input instead of empty String if not encrypted. # String#content_type is provided by filemagic/ext. unless str =~ /^-----BEGIN PGP MESSAGE-----/ || str.content_type.split('/').last.eql?('pgp') - output, in_signed = verify(str) + output, in_signed = verify(str) # match pgp-mime- and inline-pgp-signatures if str =~ /^-----BEGIN PGP SIG/ Schleuder.log.debug 'found signed, not encrypted message, verifying' @@ -78,11 +78,12 @@ module Schleuder else Schleuder.log.debug 'found pgp content, decrypting and verifying with gpgme' in_encrypted = true - output = GPGME.decrypt(str, :passphrase_callback => method(:passfunc)) do |sig| + output = @crypto.decrypt(str, :passphrase_callback => method(:passfunc)) do |sig| in_signed = sig end + output = output.read if output.empty? - Exception.new("Output from GPGME.decrypt was empty!") + Exception.new("Output from GPGME::Crypto#decrypt was empty!") end # TODO: return mailadresses or keys instead of signature-objects? end @@ -95,19 +96,17 @@ module Schleuder # encrypt and sign and return encrypted data as string # For some reason sometimes the last two characters of str are stolen # unless we append a blank or newline... Life is hard... - GPGME.encrypt([receiver.key], - "#{str} ", - {:passphrase_callback => method(:passfunc), - :armor => true, - :sign => true, - :always_trust => true - }) + @crypto.encrypt("#{str} ", + :recipients => [receiver.key], + :sign => true, + :always_trust => true + ).read end # Lists all public keys matching +pattern+. Returns an array of # GPGME::GpgKey's def list_keys(pattern='') - GPGME.list_keys(pattern) + @ctx.keys(pattern) end # Returns the GPGME::GpgKey matching +pattern+. Log an error if more than @@ -132,17 +131,20 @@ module Schleuder # Signs +string+ with the private key of the list (aka detached signature) def sign(string) - GPGME::detach_sign(string, {:armor => true, :passphrase_callback => method(:passfunc)}) + @crypto.detach_sign(string).read end # Clearsigns +string+ with the private key of the list def clearsign(string) - GPGME::clearsign(string, {:armor => true, :passphrase_callback => method(:passfunc)}) + @crypto.clearsign(string).read end # Exports the public key matching +keyid+ as ascii key block. def export(keyid) - GPGME.export(keyid, :armor=>:true) + data = GPGME::Data.new + @ctx.export_keys(keyid, data) + data.seek 0 + data.read end # Delete the public key matching +pattern+ from the public key ring of the @@ -163,7 +165,8 @@ module Schleuder # Import +keydata+ into public key ring of the list def add_key(keydata) - GPGME.import(keydata) + @ctx.import_keys(GPGME::Data.new(keydata)) + @ctx.import_result end def add_key_from_file(keyfile) diff --git a/lib/schleuder/mail.rb b/lib/schleuder/mail.rb index 10bda01..e96a0a6 100644 --- a/lib/schleuder/mail.rb +++ b/lib/schleuder/mail.rb @@ -130,11 +130,8 @@ module Schleuder Schleuder.log.info "Encrypting for #{receiver.inspect}" key, msg = receiver.key - if key == false - Schleuder.log.warn msg.capitalize - return [false, msg] - elsif key.nil? - Schleuder.log.warn "No public key found for '#{keystring}'" + unless key + Schleuder.log.warn "No public key found for '#{receiver.inspect}'" return [false, 'no public key found'] end diff --git a/schleuder.gemspec b/schleuder.gemspec index e58249d..20a196b 100644 --- a/schleuder.gemspec +++ b/schleuder.gemspec @@ -18,10 +18,11 @@ Gem::Specification.new do |s| s.rubyforge_project = '[none]' s.signing_key = '../schleuder-signingkey-gem-private_key.pem' s.cert_chain = ['gem-public_cert.pem'] - s.add_dependency('gpgme', '= 1.0.8') + s.add_dependency('gpgme', '>= 2.0.0') s.add_dependency('highline', '>= 1.6.1') s.add_dependency('log4r', '>= 1.1.9') s.add_dependency('ruby-filemagic', '>= 0.4.2') + s.add_development_dependency('rspec', '>= 2.8') s.post_install_message = " Note: There's still one dependency missing, which we can't install in diff --git a/spec/fixtures/jane@example.org-prv.asc b/spec/fixtures/jane@example.org-prv.asc new file mode 100644 index 0000000..c70596d --- /dev/null +++ b/spec/fixtures/jane@example.org-prv.asc @@ -0,0 +1,44 @@ +sec 1024R/B7D826C9 2012-06-15 +uid Jane Doe +ssb 1024R/745FEB98 2012-06-15 + +The passphrase is 'secret'. + +-----BEGIN PGP PRIVATE KEY BLOCK----- +Version: GnuPG v1.4.10 (GNU/Linux) + +lQH+BE/bbxUBBAD2RLZjRzGvfXjlyEoeDcmv4BVt9tFszMG4Qlp7i041b8GkxyTj +3UpIhhi7MlUXXKNloSxTc1e/E991eRTi1KjROvJ1u16zFbrE+mF2ivNlP54NfCN6 +WJAfeIzm7tX5Zaz+lHrYPnNW0rb6e5FbOgUz+MwIoFxh9hTBPfTBxNLjGQARAQAB +/gMDAntX5yXOpePDYDX92ZyX5c5hIhQYKGNquWlaYQXgtDrX4vL+rJ8M7fLBUxz5 +KAgYaKCeiWJxfl9KHY0JSh7wtnzgfqoTvoI2UVAvUYwR92olV5RLYzDEV62V4XFd +WNAdQMR+/rR6C/RIR/665kLZVzrdsoCIPTFoGqXmN6ukLFHUaICVbemvwHU6E1vj +6jB9Mu1vgAK7L/KWItlnUvmaFdWI39KNZPeG8/Vwt2OgZLayjAilyXB18Kk4yhmz +5+ZCcHOVfd5AIs5QEVG6/FE61HigkEa6vzx8vEsIoRX+6cWLMGA7W+5wdOV/bvHB +qyVO8NEnSjL/QvAIgboh7CXquujY0vYnV1HarOGYG3FEQoiYMaQAHCFKIGD11xq4 +7JhleZ3khKE2zfrcK7BTrwbDPZ3S8Ctpk9/rpK0hrsdtg54hekBsI1Tg7g22wxv6 +RrHPQFrfHrux98hlbcWyZ3mToPa1RDkw4vGZq7jgSIjttBtKYW5lIERvZSA8amFu +ZUBleGFtcGxlLm9yZz6IuAQTAQIAIgUCT9tvFQIbLwYLCQgHAwIGFQgCCQoLBBYC +AwECHgECF4AACgkQ8gI3fLfYJsmooQP/QMPaYvt4H6MlwQuseHOmXS1lHouK4KTC +zmwHu6HTcv5XEBzS3Z8pcla+43KXniAe36hN0hQzJtv6HxUEzDSpeTdmKr7kWi5y +rWg8LoArBX6981FC2SBRRZekfVZKQmvtWSC0NVWYTb16W4ICHsVT1s40XuMQrLRJ +pto9wKu+ayudAf4ET9tvFQEEAPMjSUlF7NRxfamUgmHhh1f3UUQcSCq1P+7oLSMC +X+8S3aYiKd2jQZHgOb7dbyAaq6Qzcb095NJ8C3L9z0OD1mJmn8I4aqU4KZTEZIQ/ +Gb2is397Tu/pFjRJTdQPvE3rZ8YvIaWGZjZgBZDm5hU3FRdva3FqzpaWSgvId++k +WtKvABEBAAH+AwMCe1fnJc6l48NgGkYCDhCP5Q13ImehGdL9IKkeRS8TQ7Qpbvlg +R9BSNZ/kEitJHIRvRC+DAWoEU0o+pyEqiqJXQxhH4LurxnNhMcLWjNceijL1NewT +8naL/lJibX1enVKgtHqfb9Xqy17SMpPJtvDobqmrJIwLrC7FpEOWH5ba5yH0H+c+ +Gme5qIftK9vdIWNSXtEJFogtoJa1VMUNmCobct6Oqw8ASLu+bE1Vqu5KEc+9VfZC +XQyw1DJzRWgXIYPxnoqmpFPdkGa7n4fHad2REiI8CTEi3MkwijSxqaxFVlAcae7P +NppEPuOMnqPBIiQ7Nb64lOJCkBmQXF4vvi8IJnOziv4GgpxmmpfkUCnZbyAIer0I +YwIhwkJ6QXdwxX2wz2Wvu5qezttPiluMobZ8Zu2nEQc7UhBOfGqtqBbH086rUP0Q +aYzFuYeNCQ9zh/OUJ8JnwugEaJf6fr0Xe3202GqpvWzM2UVZqFCOzmCJAT0EGAEC +AAkFAk/bbxUCGy4AqAkQ8gI3fLfYJsmdIAQZAQIABgUCT9tvFQAKCRCdAOPhdF/r +mCzpBADUHwBUeHB3TBlGocpKFX6OT6KxBI62DzjYq9HxWzeNCLqmabeAQLf97GlS +OOCwniqH314E3XiIMtrK7XEvGJ8yIgYVQekLxCtjCCaPniPrlrCKLzeJ7dc+bAb2 +bX7TnEN3XFVWSIlcwyYkcLQzixPNzFepSXA6XCcwsNUCNyQEFgPYA/0R6pY+cTit +8s4ZB38Lwsr57Bt7KC4EKRd34dktxfYp7NdLziChXNEZqE5VFiH5z83Q2GjzY/LD +wEoEEW+W5IeQ+hNltK/K5l+ywTl4NJUhDsDJu0hYhKFtpjpg+pjc64KWV1VX3BVF +We8PM/b681jD3LykIRU/v3UR1f1wr70eAw== +=0V++ +-----END PGP PRIVATE KEY BLOCK----- diff --git a/spec/fixtures/jane@example.org-pub.asc b/spec/fixtures/jane@example.org-pub.asc new file mode 100644 index 0000000..5a527eb --- /dev/null +++ b/spec/fixtures/jane@example.org-pub.asc @@ -0,0 +1,27 @@ +pub 1024R/B7D826C9 2012-06-15 +uid Jane Doe +sub 1024R/745FEB98 2012-06-15 + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.4.10 (GNU/Linux) + +mI0ET9tvFQEEAPZEtmNHMa99eOXISh4Nya/gFW320WzMwbhCWnuLTjVvwaTHJOPd +SkiGGLsyVRdco2WhLFNzV78T33V5FOLUqNE68nW7XrMVusT6YXaK82U/ng18I3pY +kB94jObu1fllrP6Uetg+c1bStvp7kVs6BTP4zAigXGH2FME99MHE0uMZABEBAAG0 +G0phbmUgRG9lIDxqYW5lQGV4YW1wbGUub3JnPoi4BBMBAgAiBQJP228VAhsvBgsJ +CAcDAgYVCAIJCgsEFgIDAQIeAQIXgAAKCRDyAjd8t9gmyaihA/9Aw9pi+3gfoyXB +C6x4c6ZdLWUei4rgpMLObAe7odNy/lcQHNLdnylyVr7jcpeeIB7fqE3SFDMm2/of +FQTMNKl5N2YqvuRaLnKtaDwugCsFfr3zUULZIFFFl6R9VkpCa+1ZILQ1VZhNvXpb +ggIexVPWzjRe4xCstEmm2j3Aq75rK7iNBE/bbxUBBADzI0lJRezUcX2plIJh4YdX +91FEHEgqtT/u6C0jAl/vEt2mIindo0GR4Dm+3W8gGqukM3G9PeTSfAty/c9Dg9Zi +Zp/COGqlOCmUxGSEPxm9orN/e07v6RY0SU3UD7xN62fGLyGlhmY2YAWQ5uYVNxUX +b2txas6WlkoLyHfvpFrSrwARAQABiQE9BBgBAgAJBQJP228VAhsuAKgJEPICN3y3 +2CbJnSAEGQECAAYFAk/bbxUACgkQnQDj4XRf65gs6QQA1B8AVHhwd0wZRqHKShV+ +jk+isQSOtg842KvR8Vs3jQi6pmm3gEC3/expUjjgsJ4qh99eBN14iDLayu1xLxif +MiIGFUHpC8QrYwgmj54j65awii83ie3XPmwG9m1+05xDd1xVVkiJXMMmJHC0M4sT +zcxXqUlwOlwnMLDVAjckBBYD2AP9EeqWPnE4rfLOGQd/C8LK+ewbeyguBCkXd+HZ +LcX2KezXS84goVzRGahOVRYh+c/N0Nho82Pyw8BKBBFvluSHkPoTZbSvyuZfssE5 +eDSVIQ7AybtIWIShbaY6YPqY3OuClldVV9wVRVnvDzP2+vNYw9y8pCEVP791EdX9 +cK+9HgM= +=g6+X +-----END PGP PUBLIC KEY BLOCK----- diff --git a/spec/fixtures/list@example.org-prv.asc b/spec/fixtures/list@example.org-prv.asc new file mode 100644 index 0000000..5fcebc3 --- /dev/null +++ b/spec/fixtures/list@example.org-prv.asc @@ -0,0 +1,44 @@ +sec 1024R/9A6B4502 2012-06-15 +uid Test List (schleuder list) +ssb 1024R/9751471A 2012-06-15 + +The passphrase is 'secret'. + +-----BEGIN PGP PRIVATE KEY BLOCK----- +Version: GnuPG v1.4.10 (GNU/Linux) + +lQH+BE/bSpIBBADg5lTfbyvsbMoB6htGGA4j/gKGvvytzlNbi70n2ZKpmpo4wH8b +sCCZnoYQn7D8OMyHF5oxaI3ycF8AOHFIU31x0y/FhTlucXC7GhecSQzW9EmI47aU +QYHdcfDw0IqwkYMA+A7lNzmLbEVD6kFj79ia5PnsWnKrMFkHErwD0CSE3QARAQAB +/gMDAmGI6uwt3oQnYN//5CqeBYEaSvPHVjsyQnRF19h40k7Sb6bDJKeNOFEW4NCj +UlMDJZZvWKETL5hd0dbMhD25gVKsnLfxSmapTtCF9ZosZKQCdNt8R/YqEPyMGaEN +gSRqtr7CLpJil542lT5WA+elrWtY8+IBQBODoxza9DpwMac7swcy5Nxqwh65TdOH +2k5286zN9wsqFgnCLA0z4wQAAXGykodgv/zDqp6tiM3f9VGQKTf83umlG8Ojm3t8 +4HTRDAJUyDtsC5oKANdEnGB5gz1JDrkdqtYNf+FDm4+o57DXqLaHjOxzVUwcpOqw +hipWTUh6iaCfCfPQsvSXUX259nQ8WsVb3xUJsUPXuYbkzGYXQZ1dgTskbzZ88fuU +mdhePij2y/yKZ4gwc3xvC5w5gHhT6SHzNnSxoCLJ37PnaLg97WGXdp4QKpqTXG9q +aE5BnWpWI8OSt9zpwJWJI0HO/ApGewUCyFXPGOD8XV2utC1UZXN0IExpc3QgKHNj +aGxldWRlciBsaXN0KSA8dGVzdEBleGFtcGxlLm9yZz6IuAQTAQIAIgUCT9tKkgIb +LwYLCQgHAwIGFQgCCQoLBBYCAwECHgECF4AACgkQtQKGIpprRQLCZwP8DeXmvyz9 +oXGPwEFBT9KGwVjX+TWE6sGrnwvc5whbYna8HL/9CRc8D+4jVC8SGTqHx6yaCDy/ +CiKP1L4i3EFATTvhZ+gTTpxn19Ib7mNHS74r+ADl3x2GI7fPdbNjwaBRsz7TCmti +hPoLj5uQ7W1Ynag6xZaugC8x9cQPNzJz/iqdAf4ET9tKkgEEAL3qx/Vvmtk+Zr1A +bI8/uUenyaW4dSh4zT3fQRjHoBouuVOd4KgVcaUdi2b6GObRwMQRkqoHbgX5v5Xf +czzM1f0JFHt8sysrp+YlYXT1woZl0aOAowNP+Wo1wuVToUuH5R+wsYv4KalcvUw5 +gpGFHsTTpyq3swSmEnlkh18TC4+rABEBAAH+AwMCYYjq7C3ehCdgmSr+R3m9RJzo +ynCAhYKESGZyN8veuB3Yvtr3+/k43WpU/h1NBW1bDVcbgvsz80Y5HnxJWHdk1PBt +ODkgifBGycPMfQVcLG9Ld4j9mYv5HcIEPyimUceVy3wCZsNCKWIC3wNSXSXFZmA/ +C54DcLwu6XeIaw/IXQ2NEjtugaceWwqB4Ue8YUzu0m1tZHKnAzziTKCDBLaErbPE +OAztaLhTPUSw059qiDwGp3qfdVETXCNGgdVEFBsRuUvfgsCKLFLx3vz78xFDrIqK +wc8vQz9Mbnu198zF4bTGQzrh/sNwNC0pqWkbRcNdt2t6whdcXzl9hBZaYJZNJSy2 +kJl3Me4RgNDi1rDRNmM2pzZMvhM9ZxjTrjhPEwXyGQgFqXRCTvQCLd8yQn+dKV/c +5XUGz+wHxbMmdFbPdY65kTE19NGnIcDxlfNotbicDYASuvkp0bx+b8yIKfCv600U +a9cpFpB03gVzv1iJAT0EGAECAAkFAk/bSpICGy4AqAkQtQKGIpprRQKdIAQZAQIA +BgUCT9tKkgAKCRBaeAN7l1FHGnrtA/4lrGNdJ5QCv/lQynWKGnkO2Dv6NrrmjErh +E/HpZdKlJHTHd37Ghmah0qSQrB9NHnsI51f7+p1bluxDc3sagz4WSeEa9GPX4VhA +hymw1XAnV6Xf1MaeVMVS65LIBNyF4ou5NL0sr8ztDGbIEd7p9qGjMxKTX0KeeIPA +ChOWwBurMXYzA/47qLogWRYYduj+xg9ndnLHsB8HqQYIXIYWWW3Z0YO2TH1Hwuhm +VO9X8gwy2TPlcG4shMh5MlWGlcM8BFguiJ3g6d5oyijpOoPOoA43teEE3txEVbm6 +NiHzJGxsLgBseJ8cL1x6P2ZsCJWEMe40j4r8Q/Fdc//KIHQgb51+1SJ7tQ== +=zX41 +-----END PGP PRIVATE KEY BLOCK----- diff --git a/spec/fixtures/list@example.org-pub.asc b/spec/fixtures/list@example.org-pub.asc new file mode 100644 index 0000000..a0ef6ad --- /dev/null +++ b/spec/fixtures/list@example.org-pub.asc @@ -0,0 +1,27 @@ +pub 1024R/9A6B4502 2012-06-15 +uid Test List (schleuder list) +sub 1024R/9751471A 2012-06-15 + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.4.10 (GNU/Linux) + +mI0ET9tKkgEEAODmVN9vK+xsygHqG0YYDiP+Aoa+/K3OU1uLvSfZkqmamjjAfxuw +IJmehhCfsPw4zIcXmjFojfJwXwA4cUhTfXHTL8WFOW5xcLsaF5xJDNb0SYjjtpRB +gd1x8PDQirCRgwD4DuU3OYtsRUPqQWPv2Jrk+exacqswWQcSvAPQJITdABEBAAG0 +LVRlc3QgTGlzdCAoc2NobGV1ZGVyIGxpc3QpIDx0ZXN0QGV4YW1wbGUub3JnPoi4 +BBMBAgAiBQJP20qSAhsvBgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgAAKCRC1AoYi +mmtFAsJnA/wN5ea/LP2hcY/AQUFP0obBWNf5NYTqwaufC9znCFtidrwcv/0JFzwP +7iNULxIZOofHrJoIPL8KIo/UviLcQUBNO+Fn6BNOnGfX0hvuY0dLviv4AOXfHYYj +t891s2PBoFGzPtMKa2KE+guPm5DtbVidqDrFlq6ALzH1xA83MnP+KriNBE/bSpIB +BAC96sf1b5rZPma9QGyPP7lHp8mluHUoeM0930EYx6AaLrlTneCoFXGlHYtm+hjm +0cDEEZKqB24F+b+V33M8zNX9CRR7fLMrK6fmJWF09cKGZdGjgKMDT/lqNcLlU6FL +h+UfsLGL+CmpXL1MOYKRhR7E06cqt7MEphJ5ZIdfEwuPqwARAQABiQE9BBgBAgAJ +BQJP20qSAhsuAKgJELUChiKaa0UCnSAEGQECAAYFAk/bSpIACgkQWngDe5dRRxp6 +7QP+JaxjXSeUAr/5UMp1ihp5Dtg7+ja65oxK4RPx6WXSpSR0x3d+xoZmodKkkKwf +TR57COdX+/qdW5bsQ3N7GoM+FknhGvRj1+FYQIcpsNVwJ1el39TGnlTFUuuSyATc +heKLuTS9LK/M7QxmyBHe6fahozMSk19CnniDwAoTlsAbqzF2MwP+O6i6IFkWGHbo +/sYPZ3Zyx7AfB6kGCFyGFllt2dGDtkx9R8LoZlTvV/IMMtkz5XBuLITIeTJVhpXD +PARYLoid4OneaMoo6TqDzqAON7XhBN7cRFW5ujYh8yRsbC4AbHifHC9cej9mbAiV +hDHuNI+K/EPxXXP/yiB0IG+dftUie7U= +=qEqD +-----END PGP PUBLIC KEY BLOCK----- diff --git a/spec/schleuder/crypt_spec.rb b/spec/schleuder/crypt_spec.rb new file mode 100644 index 0000000..f15c781 --- /dev/null +++ b/spec/schleuder/crypt_spec.rb @@ -0,0 +1,405 @@ +require 'spec_helper' + +require 'tmpdir' + +module Schleuder + describe Crypt do + before(:each) do + logger = Log4r::Logger.new('Schleuder::Crypt tests') + @logs = StringIO.new + logger.outputters = Log4r::IOOutputter.new('out', @logs) + Schleuder.stub(:log).and_return(logger) + end + + let(:list_fingerprint) { '286F21841195CE846C47FC3AB50286229A6B4502' } + let(:list_passphrase) { 'secret' } + let(:list_secret_key_path) { File.expand_path('../../fixtures/list@example.org-prv.asc', __FILE__) } + let(:list_public_key_path) { File.expand_path('../../fixtures/list@example.org-pub.asc', __FILE__) } + + let(:user_fingerprint) { 'A288AAE3D8FDADA8240A6F23F202377CB7D826C9' } + let(:user_public_key_path) { File.expand_path('../../fixtures/jane@example.org-pub.asc', __FILE__) } + + def feed_passphrase(hook, uid_hint, passphrase_info, prev_was_bad, fd) + io = IO.for_fd(fd, 'w') + io.puts list_passphrase + io.flush + end + + around(:each) do |example| + path = Dir.mktmpdir('schleuder-crypt') + begin + FileUtils.chmod 0700, path + old_home = ENV['GNUPGHOME'] + old_agent_info = ENV['GPG_AGENT_INFO'] + ENV['GNUPGHOME'] = path + ENV['GPG_AGENT_INFO'] = nil + GPGME::Key.import(File.read(list_secret_key_path)) + GPGME::Key.import(File.read(list_public_key_path)) + @crypt = Crypt.new(list_passphrase) + example.run + ENV['GPG_AGENT_INFO'] = old_agent_info + ENV['GNUPGHOME'] = old_home + ensure + FileUtils.remove_entry_secure path + end + end + + describe '#verify' do + context 'when given a valid clearsigned string' do + let(:sig) do + <<-'ARMORED_DATA'.gsub(/^ */, '') + -----BEGIN PGP SIGNED MESSAGE----- + Hash: SHA1 + + test + -----BEGIN PGP SIGNATURE----- + Version: GnuPG v1.4.10 (GNU/Linux) + + iJwEAQECAAYFAk/bTL0ACgkQWngDe5dRRxqYJwQAqB7W07WIRDVyZLUSCLAK1UjZ + 2hNGfd3aQI0zjNLMtSoYmd7x+WMuZKsq1V03AY6us2lJK2wnhN/uIwZ13zG8QW7M + E+Rn7OMDg1x1iRdO+pEUiAG7QmgZXGoyl+7WjT/naiBTsPxuz65BOHD+V3HPcAXX + WBAmq2t1tre6DZC1Zyc= + =29mx + -----END PGP SIGNATURE----- + ARMORED_DATA + end + before(:each) do + @output, @in_signed = @crypt.verify(sig) + end + it 'should get the signed text as output' do + @output.should == "test\n" + end + it 'should get signature data' do + @in_signed.should be_a(GPGME::Signature) + end + it 'should get a valid signature' do + @in_signed.to_s.should =~ /Good signature/ + end + end + context 'when given a clearsigned string with an invalid signature' do + let(:sig) do + <<-'ARMORED_DATA'.gsub(/^ */, '') + -----BEGIN PGP SIGNED MESSAGE----- + Hash: SHA1 + + test + -----BEGIN PGP SIGNATURE----- + Version: GnuPG v1.4.10 (GNU/Linux) + + iJwEAQECAAYFAk/bTL0ACgkQWngDe5dRRxqYJwQAqB7W07WIRDVyZLUSCLAK1UjZ + 2hNGfd3aQI0zjNLMtSoYmd7x+INVALID+V03AY6us2lJK2wnhN/uIwZ13zG8QW7M + E+Rn7OMDg1x1iRdO+pEUiAG7QmgZXGoyl+7WjT/naiBTsPxuz65BOHD+V3HPcAXX + WBAmq2t1tre6DZC1Zyc= + =29mx + -----END PGP SIGNATURE----- + ARMORED_DATA + end + before(:each) do + @output, @in_signed = @crypt.verify(sig) + end + it 'should get the signed text as output' do + @output.should == "test\n" + end + it 'should get an empty string as signature data' do + @in_signed.should be_empty + end + end + context 'when given a clearsigned string with mangled signed text' do + let(:sig) do + <<-'ARMORED_DATA'.gsub(/^ */, '') + -----BEGIN PGP SIGNED MESSAGE----- + Hash: SHA1 + + test foo + -----BEGIN PGP SIGNATURE----- + Version: GnuPG v1.4.10 (GNU/Linux) + + iJwEAQECAAYFAk/bTL0ACgkQWngDe5dRRxqYJwQAqB7W07WIRDVyZLUSCLAK1UjZ + 2hNGfd3aQI0zjNLMtSoYmd7x+WMuZKsq1V03AY6us2lJK2wnhN/uIwZ13zG8QW7M + E+Rn7OMDg1x1iRdO+pEUiAG7QmgZXGoyl+7WjT/naiBTsPxuz65BOHD+V3HPcAXX + WBAmq2t1tre6DZC1Zyc= + =29mx + -----END PGP SIGNATURE----- + ARMORED_DATA + end + before(:each) do + @output, @in_signed = @crypt.verify(sig) + end + it 'should get the signed text as output' do + @output.should == "test foo\n" + end + it 'should get a bad signature data' do + @in_signed.to_s.should =~ /Bad signature/ + end + end + context 'when given a valid detached signature' do + let(:clear_text) { "test" } + let(:sig) do + <<-'ARMORED_DATA'.gsub(/^ */, '') + -----BEGIN PGP SIGNATURE----- + Version: GnuPG v1.4.10 (GNU/Linux) + + iJwEAQECAAYFAk/bTL0ACgkQWngDe5dRRxqYJwQAqB7W07WIRDVyZLUSCLAK1UjZ + 2hNGfd3aQI0zjNLMtSoYmd7x+WMuZKsq1V03AY6us2lJK2wnhN/uIwZ13zG8QW7M + E+Rn7OMDg1x1iRdO+pEUiAG7QmgZXGoyl+7WjT/naiBTsPxuz65BOHD+V3HPcAXX + WBAmq2t1tre6DZC1Zyc= + =29mx + -----END PGP SIGNATURE----- + ARMORED_DATA + end + before(:each) do + @output, @in_signed = @crypt.verify(sig, clear_text) + end + it 'should get the signed text as output' do + @output.should == clear_text + end + it 'should get signature data' do + @in_signed.should be_a(GPGME::Signature) + end + it 'should get a valid signature' do + @in_signed.to_s.should =~ /Good signature/ + end + end + context 'when given a detached invalid signature' do + let(:clear_text) { "test\n" } + let(:sig) do + <<-'ARMORED_DATA'.gsub(/^ */, '') + -----BEGIN PGP SIGNATURE----- + Version: GnuPG v1.4.10 (GNU/Linux) + + iJwEAQECAAYFAk/bTL0ACgkQWngDe5dRRxqYJwQAqB7W07WIRDVyZLUSCLAK1UjZ + 2hNGfd3aQI0zjNLMtSoYmd7x+INVALID+V03AY6us2lJK2wnhN/uIwZ13zG8QW7M + E+Rn7OMDg1x1iRdO+pEUiAG7QmgZXGoyl+7WjT/naiBTsPxuz65BOHD+V3HPcAXX + WBAmq2t1tre6DZC1Zyc= + =29mx + -----END PGP SIGNATURE----- + ARMORED_DATA + end + it 'should raise NoData error' do + expect { + @crypt.verify(sig, clear_text) + }.to raise_error(GPGME::Error::NoData) + end + end + context 'when given a detched signature with mangled signed text' do + let(:clear_text) { "test foo\n" } + let(:sig) do + <<-'ARMORED_DATA'.gsub(/^ */, '') + -----BEGIN PGP SIGNATURE----- + Version: GnuPG v1.4.10 (GNU/Linux) + + iJwEAQECAAYFAk/bTL0ACgkQWngDe5dRRxqYJwQAqB7W07WIRDVyZLUSCLAK1UjZ + 2hNGfd3aQI0zjNLMtSoYmd7x+INVALID+V03AY6us2lJK2wnhN/uIwZ13zG8QW7M + E+Rn7OMDg1x1iRdO+pEUiAG7QmgZXGoyl+7WjT/naiBTsPxuz65BOHD+V3HPcAXX + WBAmq2t1tre6DZC1Zyc= + =29mx + -----END PGP SIGNATURE----- + ARMORED_DATA + end + it 'should raise NoData error' do + expect { + @crypt.verify(sig, clear_text) + }.to raise_error(GPGME::Error::NoData) + end + end + end + + describe '#decrypt' do + context 'given an encrypted+signed message in armored form' do + let(:plain_text) { "test\n" } + let(:cipher_text) do + <<-'ARMORED_DATA'.gsub(/^ */, '') + -----BEGIN PGP MESSAGE----- + Version: GnuPG v1.4.10 (GNU/Linux) + + hIwDWngDe5dRRxoBA/9vyX+JjMYyXylCAsAACrkl5t1ndayQJOdssopd+9iIIrOf + 7BjEz4udz4dOoJNGptJWTy4jmBKNzVv/mE9MijW9JBhTbSG1YS9XTp0c9ToZPMyq + i6dwybbPjPZ443bShScLAEpG3PIr/g7FA8BDKMbw25DwMIcJj0fhwFTa+8IMedLA + LQFQWzRcplw6aK2u95eH2kxf460xkbUsOgqjIMoXfafR8hG4YWlF3N+oBpDat2ot + S3TTOjmJMKvTYqk3ADP+kSIJSwOSBaIrd5IZwpPXQvm7O62PC6jkWsq5e1E7ZU6R + y9voGN2+9xxsy25L5+xFcLSQKkaxwn6jUQ7KdnCWKSfDJNMuJnJRiAwYBPCCB5y2 + f6IIBG01ZLaiNzq96NLsDuXCG9PoenP1fj+FB9lUsov3gq0JietRSShLM99mNJJR + uuf65804J22GE4COPn7/MkFTLPp8XrbmtwnTDlL4WMzBLp09t1933qA1JxP99g== + =xIzi + -----END PGP MESSAGE----- + ARMORED_DATA + end + before(:each) do + @output, @in_encrypted, @in_signed = @crypt.decrypt(cipher_text) + end + it 'should decrypt the message' do + @output.should == plain_text + end + it 'should notice that the message was encrypted' do + @in_encrypted.should be_true + end + it 'should return signature data' do + @in_signed.should be_a(GPGME::Signature) + end + it 'should get a valid signature' do + @in_signed.to_s.should =~ /Good signature/ + end + end + context 'given an encrypted (only) message in armored form' do + let(:plain_text) { "test\n" } + let(:cipher_text) do + <<-'ARMORED_DATA'.gsub(/^ */, '') + -----BEGIN PGP MESSAGE----- + Version: GnuPG v1.4.10 (GNU/Linux) + + hIwDWngDe5dRRxoBBAC4hUGJ0TcOCqmyRp+hN68/M8m5HzRi0CpsAf92zIqvr5NR + sanJ9FRz8cS3MBD+/+4KvI3KygLOV7At3ZvSOyKEsRkH+KjT61SNk0mbGDAEUdd/ + 2BRZ3Aaq9t7c/oBqc32HP5ORMncbZ+oOf8tNt+d10BgPkELjEFpxSLbehckeo9JA + AWnp1mpgnIEEWGjuhYvcaVuHOTiMIpI0ZvMwG/W6x08Br63h+CQJaKHP+ZhbPInF + gbkrQHaXW2+ImCuZylD+8Q== + =kBo8 + -----END PGP MESSAGE----- + ARMORED_DATA + end + before(:each) do + @output, @in_encrypted, @in_signed = @crypt.decrypt(cipher_text) + end + it 'should decrypt the message' do + @output.should == plain_text + end + it 'should notice that the message was encrypted' do + @in_encrypted.should be_true + end + it 'should return no signature data' do + @in_signed.should be_nil + end + end + context 'given a mangled encrypted message in armor form' do + let(:cipher_text) do + <<-'ARMORED_DATA'.gsub(/^ */, '') + -----BEGIN PGP MESSAGE----- + Version: GnuPG v1.4.10 (GNU/Linux) + + hIwDWngDe5dRRxoBBAC4hUGJ0TcOCqmyRp+hN68/M8m5HzRi0CpsAf92zIqvr5NR + sanJ9FRz8cS3MBD+/+4KvI3KygLOV7At3ZvSOyKEsRkH+KjT61SNk0mbGDAEUdd/ + 2BRZ3Aaq9t7c/o+INVALID+RMncbZ+oOf8tNt+d10BgPkELjEFpxSLbehckeo9JA + AWnp1mpgnIEEWGjuhYvcaVuHOTiMIpI0ZvMwG/W6x08Br63h+CQJaKHP+ZhbPInF + gbkrQHaXW2+ImCuZylD+8Q== + =kBo8 + -----END PGP MESSAGE----- + ARMORED_DATA + end + it 'should raise NoData error' do + expect { + @crypt.decrypt(cipher_text) + }.to raise_exception(GPGME::Error::NoData) + end + end + end + + describe '#encrypt_str' do + let(:plain_text) { "test\n" } + it 'should encrypt and sign the given string' do + receiver = double('Member', :key => list_fingerprint) + cipher_text = @crypt.encrypt_str(plain_text, receiver) + + signature = nil + crypto = GPGME::Crypto.new + output = crypto.decrypt(cipher_text, :passphrase_callback => method(:feed_passphrase)) do |sig| + signature = sig + end + # We get an extra space from `encrypt_str` + output.read.should == "#{plain_text} " + signature.to_s.should =~ /Good signature/ + end + end + + describe '#list_keys' do + context 'when given no pattern' do + before(:each) do + GPGME::Key.import(File.read(user_public_key_path)) + @keys = @crypt.list_keys + end + it 'should return all keys' do + @keys.should have(2).item + end + end + context 'when given the list fingerprint' do + before(:each) do + @keys = @crypt.list_keys(list_fingerprint) + end + it 'should return the list key' do + @keys.should have(1).item + @keys[0].subkeys[0].fingerprint.should == list_fingerprint + end + end + end + + describe '#sign' do + let(:clear_text) { "test\n" } + it 'should create a detached signature' do + signature = @crypt.sign(clear_text) + + result = nil + crypto = GPGME::Crypto.new + crypto.verify(signature, :signed_text => clear_text) do |sig| + result = sig + end + result.to_s.should =~ /Good signature/ + end + end + + describe '#clearsign' do + let(:clear_text) { "test\n" } + it 'should create a detached signature' do + signed_text = @crypt.clearsign(clear_text) + + result = nil + crypto = GPGME::Crypto.new + crypto.verify(signed_text) do |sig| + result = sig + end + result.to_s.should =~ /Good signature/ + end + end + + describe '#export' do + it 'should export the given key' do + public_key_block = File.read(list_public_key_path).match(/^-----BEGIN PGP PUBLIC KEY BLOCK-----$.*^-----END PGP PUBLIC KEY BLOCK-----$/m)[0] + @crypt.export(list_fingerprint).strip.should == public_key_block + end + end + + describe '#delete_key' do + before(:each) do + GPGME::Key.import(File.read(user_public_key_path)) + end + it 'should remove the given key' do + ctx = GPGME::Ctx.new + expect { + @crypt.delete_key(user_fingerprint) + }.to change { ctx.keys.count }.from(2).to(1) + ctx.keys(user_fingerprint).should be_empty + end + end + + describe '#add_key' do + it 'should add a new key' do + ctx = GPGME::Ctx.new + expect { + @crypt.add_key(File.read(user_public_key_path)) + }.to change { ctx.keys.count }.from(1).to(2) + ctx.keys(user_fingerprint).should have(1).item + end + + it 'should return the results' do + @crypt.add_key(File.read(user_public_key_path)).imports.first.fpr.should == user_fingerprint + end + end + + describe '#add_key_from_file' do + it 'should add a new key' do + ctx = GPGME::Ctx.new + expect { + @crypt.add_key_from_file(user_public_key_path) + }.to change { ctx.keys.count }.from(1).to(2) + ctx.keys(user_fingerprint).should have(1).item + end + end + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..7628f23 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,6 @@ +require 'rubygems' +require 'bundler' +Bundler.require(:default, :development) +Bundler.setup + +require 'schleuder' -- debian/patches/debian-default-settings.patch0000644000000000000000000001465012142206463016346 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Sat, 16 Jun 2012 16:44:25 +0200 Subject: [PATCH] debian/default-settings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit fae0be5af3b6be19094d62692542be0b3a149389 Merge: c99c9b8 17eb0d9 Author: Jérémy Bobbio Date: Mon Apr 22 17:17:16 2013 +0200 Merge branch 'feature/multiple-plugins-dir' into debian/default-settings commit c99c9b806df9e748447dc00b35874548eaaa5df2 Author: Jérémy Bobbio Date: Sun Apr 21 17:34:03 2013 +0200 Fix default path for system plugins commit ad5e3a4b2623174f1a9466f150676eec3dc66b33 Author: Jérémy Bobbio Date: Sat Jun 16 15:49:52 2012 +0200 Adjust other default configuration settings * Default key type: use 4096R/4096R as recommended by Debian trends. * List configuration files are stored as /etc/schleuder/lists/LISTADDRESS.conf * Main log file is in /var/log/schleuder/schleuder.log * List log files are stored as /var/log/schleuder/LISTADDRESS.log * List data directory are /var/lib/schleuder/DOMAIN/LISTNAME * Plugins are located in /usr/share/schleuder/plugins and /etc/schleuder/plugins. commit 9861d7044564206baae941c68b4b731c1738361a Merge: 9f75ae9 f247cbd Author: Jérémy Bobbio Date: Tue Jun 19 11:39:23 2012 +0200 Merge branch 'feature/multiple-plugins-dir' into debian/default-settings commit 9f75ae9117d7684eb82e220c94e1a53c480b9c44 Merge: e7a6f01 4264b32 Author: Jérémy Bobbio Date: Tue Jun 19 11:39:23 2012 +0200 Merge branch 'feature/list-conf-dir' into debian/default-settings commit e7a6f01e92e18c43ffbbf6e973b9308c06c03986 Merge: 82040d3 63c1554 Author: Jérémy Bobbio Date: Tue Jun 19 11:39:23 2012 +0200 Merge branch 'feature/logging' into debian/default-settings --- ext/default-list.conf | 2 +- ext/schleuder.conf | 20 ++++++++++---------- lib/schleuder/list_config.rb | 2 +- lib/schleuder/schleuder_config.rb | 10 +++++----- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/ext/default-list.conf b/ext/default-list.conf index e4ec7e2..ba9219a 100644 --- a/ext/default-list.conf +++ b/ext/default-list.conf @@ -90,7 +90,7 @@ # Log to a file? To enable specify a filename, optionally with full path. # If you specify a directory (ending with '/'), the file will be named # "$LISTNAME.log" in that directory. -#log_file: false +#log_file: /var/log/schleuder/ # # speaks for itself, no? #public_footer: diff --git a/ext/schleuder.conf b/ext/schleuder.conf index f03f916..aff0b29 100644 --- a/ext/schleuder.conf +++ b/ext/schleuder.conf @@ -13,7 +13,7 @@ #gpg_key_type: RSA # # Set the length of a key we might create for new lists. -#gpg_key_length: 2048 +#gpg_key_length: 4096 # # Set the type of the subkey of a key we might create # for new lists. @@ -21,25 +21,23 @@ # # Set the length of the subkey of a key we might create # for new lists. -#gpg_subkey_length: 2048 +#gpg_subkey_length: 4096 # # Name of the per list config file. Either: # - a file name that resides in the list data directory, # - a directory, ending with '/' holding list configs as # "$DOMAIN/$LISTNAME.conf". -#lists_configfile: list.conf +#lists_configfile: /etc/schleuder/lists/ # # Name of the per list file containing all members and their # options. #lists_memberfile: members.conf # # Where we find the global options for all lists. -# Note: the following notion isn't valid. You have -# to provide a fully qualified path. -#lists_default_conf: conf_dir + '/default-list.conf' +#lists_default_conf: /etc/schleuder/default-list.conf # # Location of the various schleuderlists' directory. -#lists_dir: /var/schleuderlists +#lists_dir: /var/lib/schleuder # # Location of the global logfile. Specify "syslog" to log through # the syslog(3) facility. @@ -50,9 +48,11 @@ # Possible values: ERROR || WARN || INFO || DEBUG #log_level: ERROR # -# Location of schleuder plugins. Note: the following notion -# isn't valid. You have to provide a fully qualified path. -#plugins_dir = schleuder_base + '/plugins' +# Location of schleuder plugins. +# Multiple plugins directory are supported. +#plugins_dir: +#- /usr/share/schleuder/plugins +#- /etc/schleuder/plugins # # The super administrator of this schleuder installation. This # address will receive all notices which can'tbe delivered to a certain list diff --git a/lib/schleuder/list_config.rb b/lib/schleuder/list_config.rb index fea513d..1730768 100644 --- a/lib/schleuder/list_config.rb +++ b/lib/schleuder/list_config.rb @@ -69,7 +69,7 @@ module Schleuder # Log to a file? If the path doesn't start with a slash the list-dir will # be prefixed. - schleuder_attr :log_file, 'list.log' + schleuder_attr :log_file, '/var/log/schleuder/' # Which headers from original mail to include into the internal meta data schleuder_attr :headers_to_meta, [:from, :to, :cc, :date] diff --git a/lib/schleuder/schleuder_config.rb b/lib/schleuder/schleuder_config.rb index 65abb8e..283aa6c 100644 --- a/lib/schleuder/schleuder_config.rb +++ b/lib/schleuder/schleuder_config.rb @@ -27,13 +27,13 @@ module Schleuder schleuder_attr :log_level, 'ERROR' # Directory which holds plugin-files - schleuder_attr :plugins_dir, File.join(File.expand_path(File.dirname(__FILE__) + '/../..'),'plugins') + schleuder_attr :plugins_dir, ['/usr/share/schleuder/plugins', '/etc/schleuder/plugins'] # Directory which holds one subdirectory for each list - schleuder_attr :lists_dir, '/var/schleuderlists' + schleuder_attr :lists_dir, '/var/lib/schleuder' # Name of the list-specific file that holds the list configuration (YAML-formatted) - schleuder_attr :lists_configfile, 'list.conf' + schleuder_attr :lists_configfile, '/etc/schleuder/lists/' # Name of the file that holds the members (YAML-formatted) schleuder_attr :lists_memberfile, 'members.conf' @@ -47,13 +47,13 @@ module Schleuder schleuder_attr :gpg_key_type, 'RSA' # GPG-Key length. - schleuder_attr :gpg_key_length, 2048 + schleuder_attr :gpg_key_length, 4096 # GPG-Sub-Key type. schleuder_attr :gpg_subkey_type, 'RSA' # GPG-Sub-Key length. - schleuder_attr :gpg_subkey_length, 2048 + schleuder_attr :gpg_subkey_length, 4096 ### END OF CONFIG OPTIONS -- debian/patches/debian-no-rubygems.patch0000644000000000000000000000155512142206463015333 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Mon, 15 Oct 2012 11:51:53 +0200 Subject: [PATCH] debian/no-rubygems MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit 50f78ad25f4108651aea52337d1179a48b034e76 Author: Jérémy Bobbio Date: Tue Sep 1 20:23:25 2009 +0200 No need for rubygems, we have Debian packages! --- lib/schleuder.rb | 1 - 1 files changed, 0 insertions(+), 1 deletions(-) diff --git a/lib/schleuder.rb b/lib/schleuder.rb index 05baff0..4907f06 100644 --- a/lib/schleuder.rb +++ b/lib/schleuder.rb @@ -2,7 +2,6 @@ errmsg = "For use with ruby v%s %s is required!\nPlease run schleuder-fix-gem-dependencies to fix this!" if RUBY_VERSION =~ /1.8/ - require 'rubygems' begin require 'tmail' rescue LoadError -- debian/patches/bugs-missing-admin-only-keywords.patch0000644000000000000000000000326012142206463020160 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Sat, 16 Jun 2012 16:25:42 +0200 Subject: [PATCH] bugs/missing-admin-only-keywords MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit 73abb4f7196e25d1ea34b5448a51876aa3901f3e Author: Jérémy Bobbio Date: Fri Jun 15 23:04:04 2012 +0200 Fix default keywords_admin_notify Keywords must not be listed with the `X-` prefix in keyword lists. commit cfa565d637c8517d87d6f1f47682ea2730be5f55 Author: Jérémy Bobbio Date: Fri Jun 15 23:02:56 2012 +0200 Properly update default list of restricted keywords The example configuration was updated in 1792256d, but missed to update common defaults. --- lib/schleuder/list_config.rb | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/schleuder/list_config.rb b/lib/schleuder/list_config.rb index c0613b3..57df524 100644 --- a/lib/schleuder/list_config.rb +++ b/lib/schleuder/list_config.rb @@ -75,10 +75,10 @@ module Schleuder schleuder_attr :headers_to_meta, [:from, :to, :cc, :date] # Restrict specific plugins to admin - schleuder_attr :keywords_admin_only, ['SAVE-MEMBERS', 'DEL-KEY'] + schleuder_attr :keywords_admin_only, ['ADD-MEMBER', 'DELETE-MEMBER', 'DELETE-KEY', 'SAVE-MEMBERS', 'DEL-KEY' ] # Notify admin if these keywords triggered commands. - schleuder_attr :keywords_admin_notify, [ 'X-ADD-KEY' ] + schleuder_attr :keywords_admin_notify, [ 'ADD-KEY' ] # Drop any bounces (incoming email not passing the receive_*_only-rules) schleuder_attr :bounces_drop_all, false -- debian/patches/series0000644000000000000000000000115112142206463012030 0ustar bugs-dead-configuration-in-example.patch bugs-missing-admin-only-keywords.patch bugs-fix-newlist.patch bugs-fix-interactive-newlist.patch bugs-fix-manpages-wrt-2.2.1.patch bugs-fix-check-expired-keys-warning-period.patch bugs-do-not-call-stty-in-check-expired.patch bugs-fix-member-listing.patch feature-logging.patch feature-list-conf-dir.patch feature-multiple-plugins-dir.patch feature-switch-to-gpgme-2.patch debian-use-magic-instead-of-filemagic.patch debian-default-settings.patch debian-no-rubygems.patch debian-use-ruby1.8.patch debian-readme-debian-in-newlist.patch debian-use-schleuder-uid-in-newlist.patch debian/patches/bugs-fix-newlist.patch0000644000000000000000000002600312142206463015046 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Mon, 18 Jun 2012 17:00:12 +0200 Subject: [PATCH] bugs/fix-newlist MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit 336b1f0604c9a36ee5b2763bbfa02d28c1695bff Author: Jérémy Bobbio Date: Tue Jun 19 15:39:26 2012 +0200 Ensure permissions of the list log file commit 34f5ae47a8ced7dcfe8dd1ecf70a43962b2a6ef5 Author: Jérémy Bobbio Date: Tue Jun 19 15:39:12 2012 +0200 Apply chmod on the intended file instead of nothing commit d5a23d3e6e069664fc3cfd972ad9cb8e1663f518 Author: Jérémy Bobbio Date: Tue Jun 19 14:53:56 2012 +0200 Ensure that domain directory has proper permissions commit 06cd701bdebf5e9b21d708d7010ef82a12985a5d Author: Jérémy Bobbio Date: Mon Jun 18 22:58:21 2012 +0200 Do not verify keyrings permissions for new keyrings When creating a new list from an existing keypair, we are going to initialize the keyring with this import. So we need to bypass the permissions check in that case. commit 066abe6cab11461e7d2e899706c162e9bc43405c Author: Jérémy Bobbio Date: Mon Jun 18 17:42:17 2012 +0200 Fix Storage#to_hash visibility List#config= calls ListConfig#to_hash, so Storage#to_hash can't be private. (Fix over aa448012). commit 9e77c25c69573ee6fc9f8a2d0a215584314f0d22 Author: Jérémy Bobbio Date: Mon Jun 18 16:55:17 2012 +0200 Fix the creation of new List Creating a new List object for a non-existent list is broken since aa448012. This actually breaks schleuder-newlist. As the issue is rooted in the fact that Storage#initialize interface became hard to grasp, let's just fix it. We remove the 'fromfile' parameter and we have an equivalent behaviour by passing 'nil' as input instead. --- bin/schleuder-newlist | 20 +++++++++++++----- lib/schleuder/crypt.rb | 20 ++++++++++-------- lib/schleuder/list.rb | 11 ++++----- lib/schleuder/list_config.rb | 4 +- lib/schleuder/member.rb | 4 +- lib/schleuder/schleuder_config.rb | 14 ++++++------ lib/schleuder/storage.rb | 38 ++++++++++++++++++------------------ 7 files changed, 60 insertions(+), 51 deletions(-) diff --git a/bin/schleuder-newlist b/bin/schleuder-newlist index 30ee231..cdaf373 100755 --- a/bin/schleuder-newlist +++ b/bin/schleuder-newlist @@ -183,7 +183,7 @@ class ListCreator Schleuder.log.debug "Store list config..." list.config = list.config Schleuder.log.debug "Changing ownership..." - ListCreator::filepermissions(listdir,mailuser) + ListCreator::filepermissions(list, mailuser) Schleuder.log.debug "List successfully created..." ListCreator::print_list_infos(list) if interactive end @@ -332,7 +332,7 @@ class ListCreator end def self.import_keypair(list,list_privatekeyfile,list_publickeyfile) - crypt = Schleuder::Crypt.new(list.config.gpg_password) + crypt = Schleuder::Crypt.new(list.config.gpg_password, :new_keyring => true) Schleuder.log.debug "Importing private key from #{list_privatekeyfile}" crypt.add_key_from_file(list_privatekeyfile) Schleuder.log.debug "Importing public key from #{list_publickeyfile}" @@ -353,15 +353,23 @@ Passphrase: #{pass} " end - def self.filepermissions(listdir, mailuser) - File.chown(mailuser,nil,listdir) - File.chmod(0700,listdir) + def self.filepermissions(list, mailuser) + listdir = list.listdir + dirs = [File.dirname(listdir), listdir] + FileUtils.chown mailuser, nil, dirs + FileUtils.chmod 0700, dirs Dir.new(listdir).each{ |f| unless f =~ /^\./ File.chown(mailuser,nil,listdir+"/"+f) - File.chmod(0600) + File.chmod(0600,listdir+"/"+f) end } + if list.config.log_file + log_file = list.config.log_file + log_file = File.join(listdir, log_file) unless log_file.start_with?('/') + FileUtils.chown mailuser, nil, log_file + FileUtils.chmod 0600, log_file + end end def self.print_list_infos(list) diff --git a/lib/schleuder/crypt.rb b/lib/schleuder/crypt.rb index cc7ed91..a532be2 100644 --- a/lib/schleuder/crypt.rb +++ b/lib/schleuder/crypt.rb @@ -3,15 +3,17 @@ module Schleuder # change but aliases will be set up then. class Crypt # Instantiates and stores password - def initialize(password) - # Check file permissions. ruby-gpgme unfortunately returns unspecific - # errors if it can't read files. - %w(pubring.gpg secring.gpg trustdb.gpg).each do |fn| - f = File.join(ENV['GNUPGHOME'], fn) - if ! File.readable?(f) - raise Errno::EACCES.new('%s is not readable' % f) - elsif ! File.writable?(f) - raise Errno::EACCES.new('%s is not writable' % f) + def initialize(password, options={}) + unless options[:new_keyring] + # Check file permissions. ruby-gpgme unfortunately returns unspecific + # errors if it can't read files. + %w(pubring.gpg secring.gpg trustdb.gpg).each do |fn| + f = File.join(ENV['GNUPGHOME'], fn) + if ! File.readable?(f) + raise Errno::EACCES.new('%s is not readable' % f) + elsif ! File.writable?(f) + raise Errno::EACCES.new('%s is not writable' % f) + end end end diff --git a/lib/schleuder/list.rb b/lib/schleuder/list.rb index 2853cbd..c14a4f7 100644 --- a/lib/schleuder/list.rb +++ b/lib/schleuder/list.rb @@ -8,7 +8,7 @@ module Schleuder # Prepare some variables, set up the SchleuderLogger and set GNUPGHOME def initialize(listname,newlist=false) @listname = listname - @config = _load_config(false) if newlist + @config = ListConfig.new if newlist @log = ListLogger.new listname, listdir, config # setting GNUPGHOME to list's home, to make use of the keys there @@ -22,7 +22,7 @@ module Schleuder unless @members Schleuder.log.debug("reading #{members_file}") @members = YAML::load_file(members_file).collect do |h| - h.kind_of?(Schleuder::Member) ? h : Schleuder::Member.new(h,false) + h.kind_of?(Schleuder::Member) ? h : Schleuder::Member.new(h) end end @members @@ -36,7 +36,7 @@ module Schleuder def members=(arr) Schleuder.log.debug 'writing members' Schleuder.log.info("writing #{members_file}") - @members = arr.collect { |m| m.kind_of?(Hash) ? Member.new(m,false) : m } + @members = arr.collect { |m| m.kind_of?(Hash) ? Member.new(m) : m } _write(YAML.dump(@members.collect { |m| m.to_hash }), members_file) @members end @@ -144,10 +144,9 @@ module Schleuder private # Loads the configuration - # fromfile = Whether to load the config from file. - def _load_config(fromfile=true) + def _load_config Schleuder.log.debug("reading list-config for: #{@listname}") unless Schleuder.log.nil? - @config = ListConfig.new(File.join(listdir, Schleuder.config.lists_configfile),fromfile) + @config = ListConfig.new(File.join(listdir, Schleuder.config.lists_configfile)) end def find_by_key(ary, key) diff --git a/lib/schleuder/list_config.rb b/lib/schleuder/list_config.rb index 57df524..fea513d 100644 --- a/lib/schleuder/list_config.rb +++ b/lib/schleuder/list_config.rb @@ -112,11 +112,11 @@ module Schleuder ### END OF CONFIG OPTIONS - def initialize(config_file, fromfile=true) + def initialize(config=nil) # First Overload with default-list.conf then load our config overload_from_file!(Schleuder.config.lists_default_conf) # overload with config_file - super(config_file, fromfile) + super(config) # load admins as members self.admins = self.admins diff --git a/lib/schleuder/member.rb b/lib/schleuder/member.rb index 94babf8..4224ddb 100644 --- a/lib/schleuder/member.rb +++ b/lib/schleuder/member.rb @@ -6,8 +6,8 @@ module Schleuder schleuder_attr :encrypted_only, false schleuder_attr :key_fingerprint, nil - def initialize(config_file, fromfile=true) - super(config_file, fromfile) + def initialize(config=nil) + super(config) # compress fingerprint self.key_fingerprint = self.key_fingerprint diff --git a/lib/schleuder/schleuder_config.rb b/lib/schleuder/schleuder_config.rb index aa94aa6..ff127b3 100644 --- a/lib/schleuder/schleuder_config.rb +++ b/lib/schleuder/schleuder_config.rb @@ -57,16 +57,16 @@ module Schleuder ### END OF CONFIG OPTIONS - def initialize(config_file=nil, fromfile=true) - if config_file && config_file.is_a?(String) - @conf_dir = File.dirname(config_file) - elsif config_file.nil? + def initialize(config=nil) + if config && config.is_a?(String) + @conf_dir = File.dirname(config) + elsif config.nil? @conf_dir = '/etc/schleuder' - config_file = File.join(@conf_dir,'schleuder.conf') + config = File.join(@conf_dir,'schleuder.conf') end - # overload with config_file - super(config_file, fromfile) + # overload with config + super(config) end end end diff --git a/lib/schleuder/storage.rb b/lib/schleuder/storage.rb index c1e92b5..1b472d3 100644 --- a/lib/schleuder/storage.rb +++ b/lib/schleuder/storage.rb @@ -33,18 +33,32 @@ module Schleuder @schleuder_attributes ||= {} end - # If +input+ is String or Hash it will be used to fill instance variables - # fromfile = whether to load the information from file - def initialize(input=nil, fromfile=true) + # If +input+ is String, we read the file at the given path. + # If +input+ is Hash, it will be used to fill instance variables. + def initialize(input=nil) if input.kind_of?(Hash) overload_from_hash!(input) - elsif input.kind_of?(String) && fromfile + elsif input.kind_of?(String) overload_from_file!(input) - else + elsif !input.nil? raise "Unknown input: #{input.class}" end end + def to_hash + self.class.default_schleuder_attributes.keys.inject({}) do |res, key| + val = send(key) + res[key] = if val.is_a?(Array) + val.collect { |e| e.respond_to?(:to_hash) ? e.to_hash : e } + elsif val.respond_to?(:to_hash) + val.to_hash + else + val + end + res + end + end + private # Load content from +filename+ and overwrite existing instance variables of @@ -66,19 +80,5 @@ module Schleuder end end end - - def to_hash - self.class.default_schleuder_attributes.keys.inject({}) do |res, key| - val = send(key) - res[key] = if val.is_a?(Array) - val.collect { |e| e.respond_to?(:to_hash) ? e.to_hash : e } - elsif val.respond_to?(:to_hash) - val.to_hash - else - val - end - res - end - end end end -- debian/patches/debian-use-magic-instead-of-filemagic.patch0000644000000000000000000000634012142206463020700 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Tue, 12 Jun 2012 14:55:38 +0200 Subject: [PATCH] debian/use-magic-instead-of-filemagic MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit a1577a1523ee41ce9da34b56ae2766458cf660c7 Author: Jérémy Bobbio Date: Sun Oct 14 12:01:23 2012 +0200 Also use 'magic' instead of 'ruby-filemagic' in _decrypt_pgp_inline commit 82a93b298c63057db726f88689508ff6a8c6ecb9 Author: Jérémy Bobbio Date: Tue Jun 12 14:23:35 2012 +0200 Use 'magic' gem instead of 'ruby-filemagic' The former is already packaged in Debian, and its use is limited enough that it is fairly easy to use another binding. --- lib/schleuder.rb | 2 +- lib/schleuder/crypt.rb | 3 +-- lib/schleuder/mail.rb | 2 +- schleuder.gemspec | 2 +- 4 files changed, 4 insertions(+), 5 deletions(-) diff --git a/lib/schleuder.rb b/lib/schleuder.rb index 3040829..05baff0 100644 --- a/lib/schleuder.rb +++ b/lib/schleuder.rb @@ -25,7 +25,7 @@ require 'net/smtp' require 'log4r' require 'log4r/outputter/emailoutputter' require 'log4r/outputter/fileoutputter' -require 'filemagic/ext' +require 'magic' # internal requires $:.unshift File.dirname(__FILE__) diff --git a/lib/schleuder/crypt.rb b/lib/schleuder/crypt.rb index 1eb552d..37a9f76 100644 --- a/lib/schleuder/crypt.rb +++ b/lib/schleuder/crypt.rb @@ -64,8 +64,7 @@ module Schleuder # the processor. # return input instead of empty String if not encrypted. - # String#content_type is provided by filemagic/ext. - unless str =~ /^-----BEGIN PGP MESSAGE-----/ || str.content_type.split('/').last.eql?('pgp') + unless str =~ /^-----BEGIN PGP MESSAGE-----/ || Magic.guess_string_mime_type(str).split('/').last.eql?('pgp') output, in_signed = verify(str) # match pgp-mime- and inline-pgp-signatures if str =~ /^-----BEGIN PGP SIG/ diff --git a/lib/schleuder/mail.rb b/lib/schleuder/mail.rb index e96a0a6..876d7c2 100644 --- a/lib/schleuder/mail.rb +++ b/lib/schleuder/mail.rb @@ -626,7 +626,7 @@ module Schleuder def _decrypt_pgp_inline(msg) if msg._content_type_stripped == 'text/html' Schleuder.log.debug "Content-type is text/html, can't handle that, skipping" - elsif msg.body =~ /^-----BEGIN PGP.*/ || msg.body.content_type.split('/').last.eql?('pgp') + elsif msg.body =~ /^-----BEGIN PGP.*/ || Magic.guess_string_mime_type(msg.body).split('/').last.eql?('pgp') Schleuder.log.debug 'found pgp-inline in input' # Look for charset-armor-header. In most cases useless but nobody shall say we didn't try. msg.body.each_line do |l| diff --git a/schleuder.gemspec b/schleuder.gemspec index 20a196b..4863866 100644 --- a/schleuder.gemspec +++ b/schleuder.gemspec @@ -21,7 +21,7 @@ Gem::Specification.new do |s| s.add_dependency('gpgme', '>= 2.0.0') s.add_dependency('highline', '>= 1.6.1') s.add_dependency('log4r', '>= 1.1.9') - s.add_dependency('ruby-filemagic', '>= 0.4.2') + s.add_dependency('magic', '>= 0.2.6') s.add_development_dependency('rspec', '>= 2.8') s.post_install_message = " -- debian/patches/feature-logging.patch0000644000000000000000000001425312142206463014722 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Sat, 16 Jun 2012 15:46:41 +0200 Subject: [PATCH] feature/logging MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit ce722181199fc126267aaa5c32157cfa40301d84 Author: Jérémy Bobbio Date: Tue Jun 19 15:42:12 2012 +0200 Properly set permissions in newlist when using common logging directory commit a0e6391d3c511bcd42e7603124074f5eabcfe968 Author: Jérémy Bobbio Date: Tue Jun 19 17:41:17 2012 +0200 Improve formatting of syslog output for lists commit eee58a273a8397847d53f188c7386664600dafba Merge: e72a0a9 336b1f0 Author: Jérémy Bobbio Date: Tue Jun 19 17:39:55 2012 +0200 Merge branch 'bugs/fix-newlist' into feature/logging commit e72a0a93b95eecd576a2ed4cf18a940075480b5a Merge: fce8431 82040d3 Author: Jérémy Bobbio Date: Sat Jun 16 12:11:17 2012 +0200 Merge commit 'upstream/2.2.1' into feature/logging What is left after the Log4r logging reorganisation: * Support a common log directory for all lists by supporting a directory in the `log_file` list configuration directive. * Support using syslog for general Schleuder logs. --- bin/schleuder-newlist | 1 + ext/default-list.conf | 2 ++ ext/schleuder.conf | 3 ++- lib/schleuder/log/listlogger.rb | 5 +++-- lib/schleuder/log/schleuderlogger.rb | 25 ++++++++++++++++++------- 5 files changed, 26 insertions(+), 10 deletions(-) diff --git a/bin/schleuder-newlist b/bin/schleuder-newlist index cdaf373..8d1905f 100755 --- a/bin/schleuder-newlist +++ b/bin/schleuder-newlist @@ -367,6 +367,7 @@ Passphrase: #{pass} if list.config.log_file log_file = list.config.log_file log_file = File.join(listdir, log_file) unless log_file.start_with?('/') + log_file = File.join(log_file, "#{list.listname}.log") if log_file.end_with?('/') FileUtils.chown mailuser, nil, log_file FileUtils.chmod 0600, log_file end diff --git a/ext/default-list.conf b/ext/default-list.conf index 7070535..e4ec7e2 100644 --- a/ext/default-list.conf +++ b/ext/default-list.conf @@ -88,6 +88,8 @@ #log_io: false # # Log to a file? To enable specify a filename, optionally with full path. +# If you specify a directory (ending with '/'), the file will be named +# "$LISTNAME.log" in that directory. #log_file: false # # speaks for itself, no? diff --git a/ext/schleuder.conf b/ext/schleuder.conf index 7f11b43..fdd6abd 100644 --- a/ext/schleuder.conf +++ b/ext/schleuder.conf @@ -38,7 +38,8 @@ # Location of the various schleuderlists' directory. #lists_dir: /var/schleuderlists # -# Location of the global logfile. +# Location of the global logfile. Specify "syslog" to log through +# the syslog(3) facility. #log_file: /var/log/schleuder/schleuder.log # # Global schleuder log level, might change after the list config diff --git a/lib/schleuder/log/listlogger.rb b/lib/schleuder/log/listlogger.rb index f937468..80e98be 100644 --- a/lib/schleuder/log/listlogger.rb +++ b/lib/schleuder/log/listlogger.rb @@ -18,6 +18,7 @@ module Schleuder require 'log4r/outputter/fileoutputter' filename = config.log_file filename = File.join(listdir, filename) unless filename[0..0].eql?('/') + filename = File.join(filename, "#{listname}.log") if filename.end_with?('/') add Log4r::FileOutputter.new("file", { :level => @level, :filename => filename, @@ -27,10 +28,10 @@ module Schleuder if config.log_syslog require 'log4r/outputter/syslogoutputter' - syslogfmtr = Log4r::PatternFormatter.new(:pattern => "#{listname}\t%M") + syslogfmtr = Log4r::PatternFormatter.new(:pattern => "#{listname}: %M") add Log4r::SyslogOutputter.new("syslog", { :level => @level, - :ident => 'Schleuder', + :ident => 'schleuder', :facility => "LOG_MAIL", :formatter => syslogfmtr } ) diff --git a/lib/schleuder/log/schleuderlogger.rb b/lib/schleuder/log/schleuderlogger.rb index d089985..d55ef20 100644 --- a/lib/schleuder/log/schleuderlogger.rb +++ b/lib/schleuder/log/schleuderlogger.rb @@ -8,13 +8,24 @@ module Schleuder super 'log4r' # The initial log_level is inherited by all outputters. @level = eval("Log4r::#{Schleuder.config.log_level.upcase}") - pattern = "%d Schleuder %l\t%M" - formatter = Log4r::PatternFormatter.new(:pattern => pattern) - add Log4r::FileOutputter.new('file', - { :level => @level, - :filename => Schleuder.config.log_file, - :formatter => formatter } - ) + if Schleuder.config.log_file == 'syslog' + formatter = Log4r::PatternFormatter.new(:pattern => "%M") + require 'log4r/outputter/syslogoutputter' + add Log4r::SyslogOutputter.new('syslog', + { :level => @level, + :ident => 'schleuder', + :facility => "LOG_MAIL", + :formatter => formatter } + ) + else + pattern = "%d Schleuder %l\t%M" + formatter = Log4r::PatternFormatter.new(:pattern => pattern) + add Log4r::FileOutputter.new('file', + { :level => @level, + :filename => Schleuder.config.log_file, + :formatter => formatter } + ) + end add MetaEmailOutputter.new('email', {:to => Schleuder.config.superadminaddr, :immediate_at => 'ERROR, FATAL'}) -- debian/patches/feature-list-conf-dir.patch0000644000000000000000000001451112142206463015743 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Fri, 6 Apr 2012 19:31:53 +0200 Subject: [PATCH] feature/list-conf-dir MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit 4264b32c42bd3cc45cc82c2de08bce6782f31d6b Author: Jérémy Bobbio Date: Tue Jun 19 11:16:31 2012 +0200 Add support for migrating list configs in a common directory for 2.2 commit 434da9457917c842cfcb9cbff81a40044ae769ba Merge: 97da93c 82040d3 Author: Jérémy Bobbio Date: Sat Jun 16 16:55:53 2012 +0200 Merge commit 'upstream/2.2.1' into feature/list-conf-dir Conflicts: lib/schleuder/list.rb --- bin/schleuder-migrate-v2.1-to-v2.2 | 34 +++++++++++++++++++++++++++------- bin/schleuder-newlist | 4 ++++ ext/schleuder.conf | 5 ++++- lib/schleuder/list.rb | 23 ++++++++++++++++++++--- 4 files changed, 55 insertions(+), 11 deletions(-) diff --git a/bin/schleuder-migrate-v2.1-to-v2.2 b/bin/schleuder-migrate-v2.1-to-v2.2 index ae26b5a..91f8d0d 100755 --- a/bin/schleuder-migrate-v2.1-to-v2.2 +++ b/bin/schleuder-migrate-v2.1-to-v2.2 @@ -50,7 +50,7 @@ def member_key(member) member end -def fix_list_conf(old_config,new_dir) +def fix_list_conf(old_config,new_dir,new_conf_path) if old_config.delete('logging').to_s == 'true' && !old_config['lists_logfile'].nil? old_config['log_file'] = old_config.delete('lists_logfile') end @@ -69,7 +69,7 @@ def fix_list_conf(old_config,new_dir) end old_config['key_fingerprint'] = Schleuder.list.key_fingerprint - File.open(File.join(new_dir, Schleuder.config.lists_configfile),'w') { |f| f << YAML::dump(old_config.to_hash) } + File.open(new_conf_path,'w') { |f| f << YAML::dump(old_config.to_hash) } # reload list config Schleuder.list = Schleuder::List.new(old_config['myaddr']) end @@ -161,11 +161,20 @@ end ## run - old_config = YAML.load_file(list_config) -old_config['myname']||=File.basename(File.dirname(list_config)) -Schleuder.list = Schleuder::List.new(File.basename(File.dirname(list_config))) -old_dir = File.dirname(list_config) + +if Schleuder.config.lists_configfile.end_with?('/') + # Common configuration for all lists + old_name = File.basename(list_config).gsub(/\.conf\Z/, '') + common_list_config_dir = true +else + # Configuration in list directory + old_name = File.basename(File.dirname(list_config)) +end + +old_config['myname'] ||= old_name +Schleuder.list = Schleuder::List.new(old_name) +old_dir = File.join(Schleuder.config.lists_dir, old_name) files = Dir["#{old_dir}/*"].inject({}) do |files, file| files[File.basename(file)] = [:uid, :gid, :mode].inject({}) do |hash, sym| @@ -178,8 +187,19 @@ end ENV['GNUPGHOME'] = new_dir = move_listdir(old_dir,old_config) ENV.delete('GPG_AGENT_INFO') # might interfer with changing uids +if common_list_config_dir + # Move list configuration file to its new location + local_part, domain = old_config['myaddr'].split('@') + domain_dir = File.join(Schleuder.config.lists_configfile, domain) + FileUtils.mkdir_p domain_dir + new_conf_path = "#{domain_dir}/#{local_part}.conf" + FileUtils.mv list_config, new_conf_path +else + new_conf_path = File.join(new_dir, Schleuder.config.lists_configfile) +end + change_pubkey(old_config) -fix_list_conf(old_config, new_dir) +fix_list_conf(old_config, new_dir, new_conf_path) harden_members # Fix owner/modes if changed diff --git a/bin/schleuder-newlist b/bin/schleuder-newlist index 8d1905f..9e421e5 100755 --- a/bin/schleuder-newlist +++ b/bin/schleuder-newlist @@ -181,6 +181,7 @@ class ListCreator # store the config Schleuder.log.debug "Store list config..." + FileUtils.mkdir_p File.dirname(list.configfile) list.config = list.config Schleuder.log.debug "Changing ownership..." ListCreator::filepermissions(list, mailuser) @@ -371,6 +372,9 @@ Passphrase: #{pass} FileUtils.chown mailuser, nil, log_file FileUtils.chmod 0600, log_file end + FileUtils.chown mailuser, nil, [list.configfile, File.dirname(list.configfile)] + FileUtils.chmod 0600, list.configfile + FileUtils.chmod 0700, File.dirname(list.configfile) end def self.print_list_infos(list) diff --git a/ext/schleuder.conf b/ext/schleuder.conf index fdd6abd..f03f916 100644 --- a/ext/schleuder.conf +++ b/ext/schleuder.conf @@ -23,7 +23,10 @@ # for new lists. #gpg_subkey_length: 2048 # -# Name of the per list config file. +# Name of the per list config file. Either: +# - a file name that resides in the list data directory, +# - a directory, ending with '/' holding list configs as +# "$DOMAIN/$LISTNAME.conf". #lists_configfile: list.conf # # Name of the per list file containing all members and their diff --git a/lib/schleuder/list.rb b/lib/schleuder/list.rb index c14a4f7..4453096 100644 --- a/lib/schleuder/list.rb +++ b/lib/schleuder/list.rb @@ -88,10 +88,27 @@ module Schleuder else @config = ListConfig.new(data) end - _write(YAML::dump(@config.to_hash), File.join(listdir, Schleuder.config.lists_configfile)) + _write(YAML::dump(@config.to_hash), configfile) @config end - + + # Returns path to the list configuration file + def configfile + # If `lists_configfile` ends with a '/', assume its pointing to a + # directory where configuration files are named "$DOMAIN/$LISTNAME.conf". + if Schleuder.config.lists_configfile.end_with?('/') + local_part, domain = listname.split('@') + if domain.nil? + # pre 2.2 style + File.join(Schleuder.config.lists_configfile, "#{local_part}.conf") + else + File.join(Schleuder.config.lists_configfile, domain, "#{local_part}.conf") + end + else + File.join(@listdir, Schleuder.config.lists_configfile) + end + end + # Builds the bounce-address for the list def bounce_addr @bounce_addr ||= self.config.myaddr.gsub(/^(.*)@(.*)$/, '\1-bounce@\2') @@ -146,7 +163,7 @@ module Schleuder # Loads the configuration def _load_config Schleuder.log.debug("reading list-config for: #{@listname}") unless Schleuder.log.nil? - @config = ListConfig.new(File.join(listdir, Schleuder.config.lists_configfile)) + @config = ListConfig.new(configfile) end def find_by_key(ary, key) -- debian/patches/bugs-fix-check-expired-keys-warning-period.patch0000644000000000000000000000205612142206463021772 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Sun, 14 Oct 2012 12:34:22 +0200 Subject: [PATCH] bugs/fix-check-expired-keys-warning-period MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit cdc00554cc89361ed71dd805a4c56c81489c46a4 Author: Jérémy Bobbio Date: Sun Oct 14 12:33:05 2012 +0200 Fix check-expired-keys warning period The comment said 'two weeks' but that was enough seconds for actually more than 3 years! --- contrib/check-expired-keys.rb | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/contrib/check-expired-keys.rb b/contrib/check-expired-keys.rb index 84e0bac..c87d842 100755 --- a/contrib/check-expired-keys.rb +++ b/contrib/check-expired-keys.rb @@ -23,7 +23,7 @@ listname = ARGV.first Schleuder.list = List.new(listname) now = Time.now -checkdate = now + 120960000 # two weeks +checkdate = now + (60 * 60 * 24 * 14) # two weeks crypt = Crypt.new('') msg = '' unusable = [] -- debian/patches/feature-multiple-plugins-dir.patch0000644000000000000000000002064212142206463017361 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Fri, 6 Apr 2012 19:37:06 +0200 Subject: [PATCH] feature/multiple-plugins-dir MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit 17eb0d944fd4cefe6547bfe2dfdd35688a852c70 Author: Jérémy Bobbio Date: Sun Apr 21 17:25:45 2013 +0200 Fix normalization of plugins_dir in SchleuderConfig#initialize commit 6888c77411c81076c0462bd9ffd68aaf30c1f7de Author: Jérémy Bobbio Date: Sun Apr 21 17:09:02 2013 +0200 Fix handling of plugins_dir config in Mail#process_plugins! We need to test the current path for non-existance instead of the whole config setting. commit 4d4d8e6845ad0faec8cca01981cff98bdb79a5dc Merge: 64ba30b 1514fe4 Author: Jérémy Bobbio Date: Mon Jun 11 18:08:21 2012 +0200 Merge commit 'upstream/2.2.0' into feature/multiple-plugins-dir Conflicts: lib/schleuder/mail.rb lib/schleuder/schleuder_config.rb commit 64ba30b5d666755a9df7de88a8ef88057f2ca964 Merge: 022a2ae dd5703d Author: Jérémy Bobbio Date: Sat Jan 2 18:07:32 2010 +0100 Merge commit 'upstream/2.1.1' into feature/multiple-plugins-dir commit 022a2aeaf841c0b4caf8335fc78af1aec75a6f8f Merge: 034c5a1 8b2e99b Author: Jérémy Bobbio Date: Sun Nov 15 18:17:00 2009 +0100 Merge branch 'upstream' into feature/multiple-plugins-dir commit 034c5a17a767d0d054f65e57dd272094bfc068f6 Author: Jérémy Bobbio Date: Tue Sep 1 19:33:35 2009 +0200 Add support for multiple plugins directory `plugins_dir` is now an Array and multiple directories are processed in order to find plugins. This allows custom plugins to be written more easily. `plugins_dir` in schleuder.conf is automatically turned into an Array if needed in order to smooth the transition. --- lib/schleuder/mail.rb | 108 +++++++++++++++++++------------------ lib/schleuder/schleuder_config.rb | 6 ++ 2 files changed, 61 insertions(+), 53 deletions(-) diff --git a/lib/schleuder/mail.rb b/lib/schleuder/mail.rb index d8bee7e..34bc868 100644 --- a/lib/schleuder/mail.rb +++ b/lib/schleuder/mail.rb @@ -417,15 +417,19 @@ module Schleuder def process_plugins! if self.keywords.empty? Schleuder.log.info 'No keywords present, skipping plugins' - elsif File.directory? Schleuder.config.plugins_dir - replymsg = "" - # We might want to replace the object later, which we can't do with self. - mail = self - plugins = {:request => [], :list => []} - ptype = (self.request? ? :request : :list) - used_keywords = [] - Plugin.signing_key(self) - Dir[Schleuder.config.plugins_dir + '/*_plugin.rb'].each do |plugfile| + return + end + replymsg = "" + # We might want to replace the object later, which we can't do with self. + mail = self + plugins = {:request => [], :list => []} + ptype = (self.request? ? :request : :list) + used_keywords = [] + Plugin.signing_key(self) + Schleuder.config.plugins_dir.each do |plugins_dir| + next unless File.directory?(plugins_dir) + + Dir[plugins_dir + '/*_plugin.rb'].each do |plugfile| Schleuder.log.debug "Instanciating #{plugfile} as plugin" require plugfile # interpreting class name from file name @@ -434,56 +438,54 @@ module Schleuder Schleuder.log.debug "Storing plugin in plugin-list '#{plugin.plugin_type}'" plugins[plugin.plugin_type] << plugin end - # This is neither elegant nor fast, but it's got to live only until the rewrite. - Schleuder.log.debug "Processing #{ptype}-plugins" - self.keywords.each do |kwhash| - keyword = kwhash.keys.first - value = kwhash.values.first - Schleuder.log.debug "Looping for keyword #{keyword}" - plugins[ptype].each do |plugin| - command = keyword.downcase.gsub(/-/, '_') - Schleuder.log.debug "Does #{plugin.class}.respond_to? '#{command}'" - if plugin.respond_to?(command) - Schleuder.log.debug "Yes it does, executing #{plugin.class}.#{command}" - used_keywords << keyword - foo = plugin.send(command, mail, value) - case foo - when String - Schleuder.log.debug "Method returned a string, saving it for reply to sender." - replymsg << foo << "\n\n\n" - when Mail - Schleuder.log.debug "Method returned a Mail-object, replacing myself by it." - mail = foo - else - Schleuder.log.debug "Method returned '#{foo.inspect}', don't know how to handle, skipping." - end - next - else - Schleuder.log.debug "No it doesn't." - end - end - # Generate error-message if no plugin was executed - unless used_keywords.include?(keyword) - msg = "No #{ptype}-plugin responded to keyword #{keyword}" - Schleuder.log.debug msg - if mail.request? - replymsg << "Error: #{msg}.\n\n" + end + # This is neither elegant nor fast, but it's got to live only until the rewrite. + Schleuder.log.debug "Processing #{ptype}-plugins" + self.keywords.each do |kwhash| + keyword = kwhash.keys.first + value = kwhash.values.first + Schleuder.log.debug "Looping for keyword #{keyword}" + plugins[ptype].each do |plugin| + command = keyword.downcase.gsub(/-/, '_') + Schleuder.log.debug "Does #{plugin.class}.respond_to? '#{command}'" + if plugin.respond_to?(command) + Schleuder.log.debug "Yes it does, executing #{plugin.class}.#{command}" + used_keywords << keyword + foo = plugin.send(command, mail, value) + case foo + when String + Schleuder.log.debug "Method returned a string, saving it for reply to sender." + replymsg << foo << "\n\n\n" + when Mail + Schleuder.log.debug "Method returned a Mail-object, replacing myself by it." + mail = foo else - mail.metadata[:error] << msg + Schleuder.log.debug "Method returned '#{foo.inspect}', don't know how to handle, skipping." end + next + else + Schleuder.log.debug "No it doesn't." end end - # Decide how to go on: reply or list? - if mail.request? - Schleuder.log.debug "Message is a request, sending plugins-output back to sender." - if replymsg.empty? - replymsg = 'The keywords you sent did not produce any output. If you feel this is an error please contact the adminisrators of this list.'.fmt + # Generate error-message if no plugin was executed + unless used_keywords.include?(keyword) + msg = "No #{ptype}-plugin responded to keyword #{keyword}" + Schleuder.log.debug msg + if mail.request? + replymsg << "Error: #{msg}.\n\n" + else + mail.metadata[:error] << msg end - # This exits. - Plugin.reply(mail, replymsg, used_keywords) end - else - Schleuder.log.error "#{Schleuder.config.plugins_dir} does not exist or is not readable!" + end + # Decide how to go on: reply or list? + if mail.request? + Schleuder.log.debug "Message is a request, sending plugins-output back to sender." + if replymsg.empty? + replymsg = 'The keywords you sent did not produce any output. If you feel this is an error please contact the adminisrators of this list.'.fmt + end + # This exits. + Plugin.reply(mail, replymsg, used_keywords) end end diff --git a/lib/schleuder/schleuder_config.rb b/lib/schleuder/schleuder_config.rb index ff127b3..65abb8e 100644 --- a/lib/schleuder/schleuder_config.rb +++ b/lib/schleuder/schleuder_config.rb @@ -67,6 +67,12 @@ module Schleuder # overload with config super(config) + + # turn plugins_dir into an array if needed + plugins_dir = schleuder_attributes[:plugins_dir] + if plugins_dir && !plugins_dir.is_a?(Array) + schleuder_attributes[:plugins_dir] = [plugins_dir] + end end end end -- debian/patches/bugs-fix-manpages-wrt-2.2.1.patch0000644000000000000000000021233012142206463016424 0ustar From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Bobbio?= Date: Sat, 16 Jun 2012 16:26:03 +0200 Subject: [PATCH] bugs/fix-manpages-wrt-2.2.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit 3d7850a6c69d8f8b574983dfb5bb75fa97209d54 Author: Jérémy Bobbio Date: Fri Jun 15 15:38:53 2012 +0200 manpages: Rebuild manpages in roff and HTML commit 5dab77056b25ac75e9588d02c15c33ea3ed1f652 Author: Jérémy Bobbio Date: Fri Jun 15 15:38:10 2012 +0200 manpages: Improve formatting commit e3a64e5d0e2e9333704bc8a7dc15641b77c49ab7 Author: Jérémy Bobbio Date: Fri Jun 15 23:07:37 2012 +0200 manpages: Document X-GET-VERSION commit 53c10fd2a903d3195d8d1846e1067dc14706054a Author: Jérémy Bobbio Date: Fri Jun 15 22:32:34 2012 +0200 manpages: document X-UNSUBSCRIBE command commit 88bab545cf20fed9cdfdf5fc29535ccb04833110 Author: Jérémy Bobbio Date: Tue Jun 12 15:56:47 2012 +0200 manpages: document -c flag for schleuder and schleuder-newlist commit 064d3c1364a69eec539ab41cc7e41a15dff6371a Author: Jérémy Bobbio Date: Tue Jun 12 15:55:00 2012 +0200 manpages: document -h flag for schleuder commit 7d4da79ff6c6b61704f2d87c0dbe4375ffb0df3c Author: Jérémy Bobbio Date: Tue Jun 12 15:54:25 2012 +0200 manpage: move schleuder options to a dedicated section --- man/schleuder-newlist.8 | 156 ++++++++---------- man/schleuder-newlist.8.html | 109 +++++------- man/schleuder-newlist.8.ron | 71 +++++---- man/schleuder.8 | 374 ++++++++++++++++++++++-------------------- man/schleuder.8.html | 336 ++++++++++++++++++++------------------ man/schleuder.8.ron | 266 ++++++++++++++++-------------- 6 files changed, 663 insertions(+), 649 deletions(-) diff --git a/man/schleuder-newlist.8 b/man/schleuder-newlist.8 index 20d5da3..52a2e81 100644 --- a/man/schleuder-newlist.8 +++ b/man/schleuder-newlist.8 @@ -7,31 +7,34 @@ \fBschleuder\-newlist\fR \- create new Schleuder mailing list . .SH "SYNOPSIS" -schleuder\-newlist \fILISTADDRESS\fR \e [\-realname \fI\e\'Foo\e List\e\'\fR] +\fBschleuder\-newlist\fR [\-c \fIbaseconfig\fR] \fInewlist@example\.net\fR . .br -\e [\-adminaddress \fIlistadmin@example\.net\fR] +\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~[\-realname "\fIFoo List\fR"] . .br -\e [\-initmember \fImember1@example\.net\fR +\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~[\-adminaddress \fIlistadmin@example\.net\fR] . .br -\e \e \-initmemberkey \fI/path/to/initmember_publickey\fR] +\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~[\-initmember \fImember1@example\.net\fR . .br -\e [\-privatekeyfile \fI/path/to/privatekey\fR +\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\-initmemberkey \fIpath\-to\-initmember\-publickey\fR] . .br -\e \e \-publickeyfile \fI/path/to/publickey\fR +\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~[\-privatekeyfile \fIpath\-to\-privatekey\fR . .br -\e \e \-passphrase \fIkey_passphrase\fR] +\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\-publickeyfile \fIpath\-to\-publickey\fR . .br -\e [\-mailuser mail] +\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\-passphrase "\fIkey passphrase\fR"] . .br -\e [\-nointeractive] +\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~[\-mailuser \fIschleuder\fR] +. +.br +\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~[\-nointeractive] . .SH "DESCRIPTION" \fBschleuder\-newlist\fR automates the creation of new Schleuder mailing lists\. For more information on Schleuder, please look at \fBschleuder\fR(8)\. @@ -47,34 +50,47 @@ If no \fB\-privatekeyfile\fR, \fB\-publickeyfile\fR and \fB\-passphrase\fR are p . .SH "OPTIONS" . -.IP "\(bu" 4 -\fB\-realname\fR \fI\'Foo List\'\fR: Specify the name of the mailing list\. +.TP +\fB\-c\fR \fIpath\-to\-schleuder\-configuration\fR: . -.IP "\(bu" 4 -\fB\-adminaddress\fR \fIlistadmin@example\.net\fR: Specify the email address of a list administrator\. This address will be notified of errors, and depending on configuration may also be allowed to send restricted email commands\. +.IP +Specify an alternate configuration directory than the default \fB/etc/schleuder\fR\. . -.IP "\(bu" 4 -\fB\-initmember\fR \fImember1@example\.net\fR: Specify the first subscribed list member address\. Can be the same as the administrator address\. This option must be accompanied by \fB\-initmemberkey\fR\. +.TP +\fB\-realname\fR "\fIFoo List\fR" +Specify the name of the mailing list\. . -.IP "\(bu" 4 -\fB\-initmemberkey\fR \fI/path/to/initmember_publickey\fR: Specify the path to first subscribed list member public key\. \fB\-initmember\fR must also be specified\. +.TP +\fB\-adminaddress\fR \fIlistadmin@example\.net\fR +Specify the email address of a list administrator\. This address will be notified of errors, and depending on configuration may also be allowed to send restricted email commands\. . -.IP "\(bu" 4 -\fB\-privatekeyfile\fR \fI/path/to/privatekey\fR: Specify the path to a previously\-generated private key for the list\. This option must be accompanied by \fB\-publickeyfile\fR and \fB\-passphrase\fR\. +.TP +\fB\-initmember\fR \fImember1@example\.net\fR +Specify the first subscribed list member address\. Can be the same as the administrator address\. This option must be accompanied by \fB\-initmemberkey\fR\. . -.IP "\(bu" 4 -\fB\-publickeyfile\fR \fI/path/to/publickey\fR Specify the path to a previously\-generated public key for the list\. This option must be accompanied by \fB\-privatekeyfile\fR and \fB\-passphrase\fR\. +.TP +\fB\-initmemberkey\fR \fIpath\-to\-initmember\-publickey\fR +Specify the path to first subscribed list member public key\. \fB\-initmember\fR must also be specified\. . -.IP "\(bu" 4 -\fB\-passphrase\fR \fI\'key passphrase\'\fR Specify the passphrase needed to access the private key specified in \fB\-privatekeyfile\fR\. This option must be accompanied by \fB\-publickeyfile\fR as well\. +.TP +\fB\-privatekeyfile\fR \fIpath\-to\-privatekey\fR +Specify the path to a previously\-generated private key for the list\. This option must be accompanied by \fB\-publickeyfile\fR and \fB\-passphrase\fR\. . -.IP "\(bu" 4 -\fB\-mailuser\fR \fIschleuder\fR Specify the system user account under which \fBschleuder\fR(8) will be executed\. (when run as root, this defaults to "schleuder") +.TP +\fB\-publickeyfile\fR \fIpath\-to\-publickey\fR +Specify the path to a previously\-generated public key for the list\. This option must be accompanied by \fB\-privatekeyfile\fR and \fB\-passphrase\fR\. . -.IP "\(bu" 4 -\fB\-nointeractive\fR When specified, no questions will be asked to complete missing information\. +.TP +\fB\-passphrase\fR "\fIkey passphrase\fR" +Specify the passphrase needed to access the private key specified in \fB\-privatekeyfile\fR\. This option must be accompanied by \fB\-publickeyfile\fR as well\. . -.IP "" 0 +.TP +\fB\-mailuser\fR \fIschleuder\fR +Specify the system user account under which \fBschleuder\fR(8) will be executed (when run as root, this defaults to \fBschleuder\fR)\. +. +.TP +\fB\-nointeractive\fR +When specified, no questions will be asked to complete missing information\. . .SH "EXAMPLES" This creates a new list called \fBtest1\fR with the initial member \fBfoo@bar\.ch\fR\. A new keypair will be generated for the list\. @@ -111,69 +127,26 @@ The list test2 will be created, a keypair from the following files with the pass .IP "" 0 . .SH "FILES" -/etc/schleuder/schleuder\.conf -. -.IP "" 4 -. -.nf - -Global Schleuder configuration -. -.fi . -.IP "" 0 -. -.P -/etc/schleuder/default\-list\.conf +.TP +\fB/etc/schleuder/schleuder\.conf\fR +global Schleuder configuration . -.IP "" 4 +.TP +\fB/etc/schleuder/default\-list\.conf\fR +default list settings . -.nf - -Default list settings +.TP +\fB/var/schleuderlists/\fR\fIHOSTNAME\fR\fB/\fR\fILISTNAME\fR +list internal data . -.fi +.TP +\fB/var/schleuderlists/\fR\fIHOSTNAME\fR\fB/\fR\fILISTNAME\fR\fB/list\.conf\fR +list settings . -.IP "" 0 -. -.P -/var/schleuderlists/HOSTNAME/LISTNAME -. -.IP "" 4 -. -.nf - -List internal data -. -.fi -. -.IP "" 0 -. -.P -/var/schleuderlists/HOSTNAME/LISTNAME/list\.conf -. -.IP "" 4 -. -.nf - -List settings -. -.fi -. -.IP "" 0 -. -.P -/var/schleuderlists/HOSTNAME/LISTNAME/members\.conf -. -.IP "" 4 -. -.nf - -List susbcribers\. -. -.fi -. -.IP "" 0 +.TP +\fB/var/schleuderlists/\fR\fIHOSTNAME\fR\fB/\fR\fILISTNAME\fR\fB/members\.conf\fR +list susbcribers . .P All configuration files are formatted as YAML\. See \fIhttp://www\.yaml\.org/\fR for more details\. @@ -184,8 +157,11 @@ Known bugs are listed on the Schleuder website\. .SH "SEE ALSO" \fBschleuder\fR(8), \fBaliases\fR(5), \fBgnupg\fR(7)\. . -.P -Schleuder website: \fIhttp://schleuder\.nadir\.org/\fR +.TP +Schleuder website +\fIhttp://schleuder\.nadir\.org/\fR . -.P -YAML website: \fIhttp://www\.yaml\.org/\fR +.TP +YAML website +\fIhttp://www\.yaml\.org/\fR + diff --git a/man/schleuder-newlist.8.html b/man/schleuder-newlist.8.html index fc15960..2991976 100644 --- a/man/schleuder-newlist.8.html +++ b/man/schleuder-newlist.8.html @@ -61,7 +61,7 @@ FILES BUGS SEE ALSO - +
  1. schleuder-newlist(8)
    2. @@ -76,16 +76,16 @@

    SYNOPSIS

    -

    schleuder-newlist LISTADDRESS -\ [-realname \'Foo\ List\']
    -\ [-adminaddress listadmin@example.net]
    -\ [-initmember member1@example.net
    -\ \ -initmemberkey /path/to/initmember_publickey]
    -\ [-privatekeyfile /path/to/privatekey
    -\ \ -publickeyfile /path/to/publickey
    -\ \ -passphrase key_passphrase]
    -\ [-mailuser mail]
    -\ [-nointeractive]

    +

    schleuder-newlist [-c baseconfig] newlist@example.net
    +                  [-realname "Foo List"]
    +                  [-adminaddress listadmin@example.net]
    +                  [-initmember member1@example.net
    +                   -initmemberkey path-to-initmember-publickey]
    +                  [-privatekeyfile path-to-privatekey
    +                   -publickeyfile path-to-publickey
    +                   -passphrase "key passphrase"]
    +                  [-mailuser schleuder]
    +                  [-nointeractive]

    DESCRIPTION

    @@ -107,37 +107,32 @@ the generated keypair is specified in /etc/schleuder/schleuder.conf

    OPTIONS

    -
      -

    • -realname 'Foo List': -Specify the name of the mailing list.

      • -

    • -adminaddress listadmin@example.net: -Specify the email address of a list administrator. This address will be +

      +
      -c path-to-schleuder-configuration:

      + +

      Specify an alternate configuration directory than the default +/etc/schleuder.

      +
      -realname "Foo List"

      Specify the name of the mailing list.

      +
      -adminaddress listadmin@example.net

      Specify the email address of a list administrator. This address will be notified of errors, and depending on configuration may also be allowed -to send restricted email commands.

      • -

    • -initmember member1@example.net: -Specify the first subscribed list member address. Can be the same as the +to send restricted email commands.

      +
      -initmember member1@example.net

      Specify the first subscribed list member address. Can be the same as the administrator address. This option must be accompanied by --initmemberkey.

      • -

    • -initmemberkey /path/to/initmember_publickey: -Specify the path to first subscribed list member public key. -initmember -must also be specified.

      • -

    • -privatekeyfile /path/to/privatekey: -Specify the path to a previously-generated private key for the list. -This option must be accompanied by -publickeyfile and -passphrase.

      • -

    • -publickeyfile /path/to/publickey -Specify the path to a previously-generated public key for the list. -This option must be accompanied by -privatekeyfile and -passphrase.

      • -

    • -passphrase 'key passphrase' -Specify the passphrase needed to access the private key specified in +-initmemberkey.

      +
      -initmemberkey path-to-initmember-publickey

      Specify the path to first subscribed list member public key. -initmember +must also be specified.

      +
      -privatekeyfile path-to-privatekey

      Specify the path to a previously-generated private key for the list. +This option must be accompanied by -publickeyfile and -passphrase.

      +
      -publickeyfile path-to-publickey

      Specify the path to a previously-generated public key for the list. +This option must be accompanied by -privatekeyfile and -passphrase.

      +
      -passphrase "key passphrase"

      Specify the passphrase needed to access the private key specified in -privatekeyfile. This option must be accompanied by -publickeyfile -as well.

      • -

    • -mailuser schleuder -Specify the system user account under which schleuder(8) will be -executed. (when run as root, this defaults to "schleuder")

      • -

    • -nointeractive -When specified, no questions will be asked to complete missing -information.

      • -
    +as well.

    +
    -mailuser schleuder

    Specify the system user account under which schleuder(8) will be +executed (when run as root, this defaults to schleuder).

    +
    -nointeractive

    When specified, no questions will be asked to complete missing +information.

    +

    EXAMPLES

    @@ -164,30 +159,14 @@ passphrase test will be imported.

    FILES

    -

    /etc/schleuder/schleuder.conf

    - -
    Global Schleuder configuration
-
    - -

    /etc/schleuder/default-list.conf

    - -
    Default list settings
-
    - -

    /var/schleuderlists/HOSTNAME/LISTNAME

    +
    +
    /etc/schleuder/schleuder.conf

    global Schleuder configuration

    +
    /etc/schleuder/default-list.conf

    default list settings

    +
    /var/schleuderlists/HOSTNAME/LISTNAME

    list internal data

    +
    /var/schleuderlists/HOSTNAME/LISTNAME/list.conf

    list settings

    +
    /var/schleuderlists/HOSTNAME/LISTNAME/members.conf

    list susbcribers

    +
    -
    List internal data
-
    - -

    /var/schleuderlists/HOSTNAME/LISTNAME/list.conf

    - -
    List settings
-
    - -

    /var/schleuderlists/HOSTNAME/LISTNAME/members.conf

    - -
    List susbcribers.
-

    All configuration files are formatted as YAML. See http://www.yaml.org/ for more details.

    @@ -202,9 +181,11 @@ more details.

    aliases(5), gnupg(7).

    -

    Schleuder website: http://schleuder.nadir.org/

    +
    +
    Schleuder website

    http://schleuder.nadir.org/

    +
    YAML website

    http://www.yaml.org/

    +
    -

    YAML website: http://www.yaml.org/

      diff --git a/man/schleuder-newlist.8.ron b/man/schleuder-newlist.8.ron index 9559353..c2da206 100644 --- a/man/schleuder-newlist.8.ron +++ b/man/schleuder-newlist.8.ron @@ -3,16 +3,16 @@ schleuder-newlist(8) -- create new Schleuder mailing list ## SYNOPSIS -schleuder-newlist *LISTADDRESS* -\ [-realname *\'Foo\ List\'*] -\ [-adminaddress *listadmin@example.net*] -\ [-initmember *member1@example.net* -\ \ -initmemberkey */path/to/initmember_publickey*] -\ [-privatekeyfile */path/to/privatekey* -\ \ -publickeyfile */path/to/publickey* -\ \ -passphrase *key_passphrase*] -\ [-mailuser mail] -\ [-nointeractive] +`schleuder-newlist` [-c ]
      +                  [-realname ""]
      +                  [-adminaddress ]
      +                  [-initmember
      +                   -initmemberkey ]
      +                  [-privatekeyfile
      +                   -publickeyfile
      +                   -passphrase ""]
      +                  [-mailuser ]
      +                  [-nointeractive] ## DESCRIPTION @@ -34,41 +34,46 @@ the generated keypair is specified in `/etc/schleuder/schleuder.conf`. ## OPTIONS - * `-realname` *'Foo List'*: + * `-c` : + + Specify an alternate configuration directory than the default + `/etc/schleuder`. + + * `-realname` "": Specify the name of the mailing list. - * `-adminaddress` *listadmin@example.net*: + * `-adminaddress` : Specify the email address of a list administrator. This address will be notified of errors, and depending on configuration may also be allowed to send restricted email commands. - * `-initmember` *member1@example.net*: + * `-initmember` : Specify the first subscribed list member address. Can be the same as the administrator address. This option must be accompanied by `-initmemberkey`. - * `-initmemberkey` */path/to/initmember_publickey*: + * `-initmemberkey` : Specify the path to first subscribed list member public key. `-initmember` must also be specified. - * `-privatekeyfile` */path/to/privatekey*: + * `-privatekeyfile` : Specify the path to a previously-generated private key for the list. This option must be accompanied by `-publickeyfile` and `-passphrase`. - * `-publickeyfile` */path/to/publickey* + * `-publickeyfile` : Specify the path to a previously-generated public key for the list. This option must be accompanied by `-privatekeyfile` and `-passphrase`. - * `-passphrase` *'key passphrase'* + * `-passphrase` "": Specify the passphrase needed to access the private key specified in `-privatekeyfile`. This option must be accompanied by `-publickeyfile` as well. - * `-mailuser` *schleuder* + * `-mailuser` : Specify the system user account under which `schleuder`(8) will be - executed. (when run as root, this defaults to "schleuder") + executed (when run as root, this defaults to `schleuder`). - * `-nointeractive` + * `-nointeractive`: When specified, no questions will be asked to complete missing information. @@ -94,20 +99,20 @@ passphrase `test` will be imported. ## FILES -/etc/schleuder/schleuder.conf - Global Schleuder configuration + * `/etc/schleuder/schleuder.conf`: + global Schleuder configuration -/etc/schleuder/default-list.conf - Default list settings + * `/etc/schleuder/default-list.conf`: + default list settings -/var/schleuderlists/HOSTNAME/LISTNAME - List internal data + * `/var/schleuderlists/``/`: + list internal data -/var/schleuderlists/HOSTNAME/LISTNAME/list.conf - List settings + * `/var/schleuderlists/``/``/list.conf`: + list settings -/var/schleuderlists/HOSTNAME/LISTNAME/members.conf - List susbcribers. + * `/var/schleuderlists/``/``/members.conf`: + list susbcribers All configuration files are formatted as YAML. See for more details. @@ -122,6 +127,8 @@ Known bugs are listed on the Schleuder website. `aliases`(5), `gnupg`(7). -Schleuder website: + * Schleuder website: + -YAML website: + * YAML website: + diff --git a/man/schleuder.8 b/man/schleuder.8 index 2a2e09e..665d6c9 100644 --- a/man/schleuder.8 +++ b/man/schleuder.8 @@ -4,13 +4,13 @@ .TH "SCHLEUDER" "8" "June 2012" "" "" . .SH "NAME" -\fBSchleuder\fR \- A groups email gateway\. +\fBschleuder\fR \- a groups email gateway . .SH "SYNOPSIS" -schleuder \fILISTADDRESS\fR < EMAIL +\fBschleuder\fR [\-c \fIbaseconfig\fR] \fIlistaddress\fR < \fIemail\fR . -.P -schleuder \-test [\fILISTADDRESS\fR] +.br +\fBschleuder\fR [\-c \fIbaseconfig\fR] \-test [\fIlistaddress\fR] . .SH "DESCRIPTION" Schleuder is a groups email gateway: subscribers can communicate encrypted (and pseudonymously) among themselves, receive emails from non\-subscribers and send emails to non\-subscribers via the list\. @@ -22,22 +22,19 @@ Schleuder takes care of all decryption and encryption, stripping of headers, for Email cryptography is handled by using GnuPG\. Schleuder understands all common encapsulation formats: \fBinline\fR, \fBmultipart/encrypted\fR and \fBmultipart/signed\fR\. . .P -\fBschleuder\fR(8) is usually called in delivery mode by a \fIMail Transport Agent\fR with an incoming email piped to its standard input\. For more informations on how to integrate Schleuder with your existing mail setup, please look at the Schleuder website: http://schleuder\.nadir\.org/ -. -.P -If run with the \fB\-test\fR option Schleuder checks that the setup and basic settings are in a workable state\. +schleuder(8) is usually called in delivery mode by a \fIMail Transport Agent\fR with an incoming email piped to its standard input\. For more informations on how to integrate Schleuder with your existing mail setup, please look at the Schleuder website: \fIhttp://schleuder\.nadir\.org/\fR . .P -\fBschleuder\-newlist\fR(8) automates the creation of new mailing lists\. +schleuder\-newlist(8) automates the creation of new mailing lists\. . .SH "AUTOMATIC SENDING OF LIST PUBLIC KEY" -To receive the public key of the mailing list anybody can send an email to the special list address which includes \-sendkey as a postfix +To receive the public key of the mailing list anybody can send an email to the special list address which includes \fB\-sendkey\fR as a postfix: . .IP "" 4 . .nf -listname\-sendkey@example\.com +listname\-sendkey@example\.org . .fi . @@ -47,354 +44,373 @@ listname\-sendkey@example\.com Schleuder will reply with the public key of the list without forwarding the request to the list\-members\. . .SH "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\-admin or —— if allowed by the list\'s configuration —— a list\-member\. -. -.P -Administrative commands (membership and key management) must be sent to the request\-address or the list, which includes \-request as a postfix: listname\-request@example\.org +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\-admin or \(em if allowed by the list\'s configuration \(em a list\-member\. . .P -Communicative commands (resending) must be sent to the normal list\-address\.Resending is a list\-command, that means it is only allowed in emails sent over the mailing list\. -. -.P -To receive the list of members send: +Administrative commands (membership and key management) must be sent to the request\-address or the list, which includes \fB\-request\fR as a postfix: . .IP "" 4 . .nf -X\-LIST\-MEMBERS - -You will receive a list of list\-admins and list\-members, and their public -keys (or the lack thereof)\. +listname\-request@example\.org . .fi . .IP "" 0 . .P -To see details on one list\-member, including his/her public key: +Communicative commands (resending) must be sent to the normal list\-address\. . -.P -X\-GET\-MEMBER: you@example\.net +.SS "Membership management" +Resending is a list\-command, that means it is only allowed in emails sent over the mailing list\. . -.P -To add a member: +.TP +To receive the list of members send: . .IP "" 4 . .nf - X\-ADD\-MEMBER: you@example\.net mime - \-\-\-\-\-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\-\-\-\-\- - -`mime` could also be `plain` (for receiving `inline`\-encapsulated messages) -or be skipped (then the list\'s default setting is used)\. - -The public key block is also optional\. +X\-LIST\-MEMBERS . .fi . .IP "" 0 . -.P -To delete a member from the list: +.IP +You will receive a list of list\-admins and list\-members, and their public keys (or the lack thereof)\. +. +.TP +To see details on one list\-member, including his/her public key: . .IP "" 4 . .nf - X\-DELETE\-MEMBER: you@example\.net - -Please note that this doesn\'t delete any public keys\. +X\-GET\-MEMBER: you@example\.net . .fi . .IP "" 0 -To receive the list of public keys known to the list + +. +.TP +To unsubscribe from the mailing\-list: . .IP "" 4 . .nf - X\-LIST\-KEYS +X\-UNSUBSCRIBE . .fi . .IP "" 0 . -.P -To receive a certain public key known to the list +.IP +This will remove the member associated with the sender\'s signing key\. +. +.TP +To add a member: . .IP "" 4 . .nf - X\-GET\-KEY: foobar@example\.com +X\-ADD\-MEMBER: you@example\.net mime +\-\-\-\-\-BEGIN PGP PUBLIC KEY BLOCK\-\-\-\-\- +Version: GnuPG v1\.4\.9 (GNU/Linux) - You can also specify a KeyID, or parts of it, as long as it identifies - the key distinctly\. +mQGiBEjVO7oRBADQvT6wtD2IzzIiK0NbrcilCKCp4MWb8cYXTXguwPQI6y0Nerz4 +dsK6J0X1Vgeo02tqA4xd3EDK8rdqL2yZfl/2egH8+85R3gDk+kqkfEp4pwCgp6VO +[\.\.\.] +pNlF/qkaWwRb048h+iMrW21EkouLKTDPFkdFbapV2X5KJZIcfhO1zEbwc1ZKF3Ju +Q9X5GRmY62hz9SCZnsC0jeYAni8OUQV9NXfXlS/vePBUnOL08NQB +=xTv3 +\-\-\-\-\-END PGP PUBLIC KEY BLOCK\-\-\-\-\- . .fi . .IP "" 0 . -.P -To add a public key to the list +.IP +\fBmime\fR could also be \fBplain\fR (for receiving \fBinline\fR\-encapsulated messages) or be skipped (then the list\'s default setting is used)\. +. +.IP +The public key block is also optional\. +. +.TP +To delete a member from the list: . .IP "" 4 . .nf - 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\-\-\-\-\- +X\-DELETE\-MEMBER: you@example\.net . .fi . .IP "" 0 . -.P -To delete a key from the list\'s keyring: +.IP +Please note that this doesn\'t delete any public keys\. +. +.SS "Key management" +. +.TP +To receive the list of public keys known to the list: . .IP "" 4 . .nf - X\-DELETE\-KEY: 0xDEADBEEF - - You can also specify an email address, as long as it identifies the key - distinctly\. +X\-LIST\-KEYS . .fi . .IP "" 0 -Resending is a list\-command, that means it is only allowed in emails sent over the mailing list\. + . -.P -To send out an email to an external recipient (encrypted if possible, otherwise in the clear) +.TP +To receive a certain public key known to the list: . .IP "" 4 . .nf - X\-RESEND: emailaddress@example\.net +X\-GET\-KEY: foobar@example\.com . .fi . .IP "" 0 . -.P -Or to send it only if encryption is available +.IP +You can also specify a KeyID, or parts of it, as long as it identifies the key distinctly\. +. +.TP +To add a public key to the list: . .IP "" 4 . .nf - X\-RESEND\-ENCRYPTED\-ONLY: emailaddress@example\.net +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\-\-\-\-\- . .fi . .IP "" 0 + . -.P -To specify multiple recipients separate the addresses with spaces or specify the command multiple times: +.TP +To delete a key from the list\'s keyring: . .IP "" 4 . .nf - X\-RESEND: you@example\.net me@example\.net - or - - X\-RESEND: you@example\.net - X\-RESEND: me@example\.net - - With the first format don\'t let your Mail User Agent break long lines! +X\-DELETE\-KEY: 0xDEADBEEF . .fi . .IP "" 0 . -.SH "EXIT STATUS" -0 +.IP +You can also specify an email address, as long as it identifies the key distinctly\. +. +.SS "Resending" +Resending is a list\-command, that means it is only allowed in emails sent over the mailing list\. +. +.TP +To send out an email to an external recipient (encrypted if possible, otherwise in the clear): . .IP "" 4 . .nf -Incoming email was processed without errors\. - -Configuration is correct in test mode\. +X\-RESEND: emailaddress@example\.net . .fi . .IP "" 0 + . -.P -1 +.TP +Or to send it only if encryption is available: . .IP "" 4 . .nf -Internal failure in incoming email processing\. - -Bad configuration in test mode\. +X\-RESEND\-ENCRYPTED\-ONLY: emailaddress@example\.net . .fi . .IP "" 0 + . -.P -100 +.TP +To specify multiple recipients separate the addresses with spaces or specify the command multiple times: . .IP "" 4 . .nf -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\. +X\-RESEND: you@example\.net me@example\.net . .fi . .IP "" 0 . -.SH "FILES" -/etc/schleuder/schleuder\.conf +.IP +or . .IP "" 4 . .nf -Global Schleuder configuration +X\-RESEND: you@example\.net +X\-RESEND: me@example\.net . .fi . .IP "" 0 . -.P -/etc/schleuder/default\-list\.conf +.IP +With the first format don\'t let your Mail User Agent break long lines! . -.IP "" 4 +.SS "Misc\." . -.nf - -Default list settings -. -.fi +.IP "\(bu" 4 +To know which version of Schleuder is installed: X\-GET\-VERSION . .IP "" 0 . -.P -/var/schleuderlists/LISTNAME/list\.conf +.SH "OPTIONS" . -.IP "" 4 +.TP +\fB\-c\fR \fIpath\-to\-schleuder\-configuration\fR +Specify an alternate configuration directory than the default \fB/etc/schleuder\fR\. . -.nf - -List settings +.TP +\fB\-test\fR +Instead of processing an incoming email, specifying this flag will make Schleuder verify that the setup and basic settings are in a workable state\. . -.fi +.TP +\fB\-h\fR +Display usage and exit\. . -.IP "" 0 +.SH "EXIT STATUS" . -.P -/var/schleuderlists/LISTNAME/members\.conf +.TP +0 +Incoming email was processed without errors\. . -.IP "" 4 +.IP +Configuration is correct in test mode\. . -.nf - -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\. - * 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 +.TP +1 +Internal failure in incoming email processing\. . -.fi +.IP +Bad configuration in test mode\. . -.IP "" 0 +.TP +100 +Unable to decrypt the received message\. . -.P -/var/schleuderlists/HOSTNAME/LISTNAME +.IP +Unable to verify the signature when configured to only accept signed messages\. . -.IP "" 4 +.IP +Message is cleartext when only encrypted messages are allowed\. . -.nf - -List internal data +.IP +Message is not authenticated as coming from a list\-member when authentication is required\. . -.fi +.SH "FILES" +. +.IP "\(bu" 4 +\fB/etc/schleuder/schleuder\.conf\fR: global Schleuder configuration +. +.IP "\(bu" 4 +\fB/etc/schleuder/default\-list\.conf\fR: default list settings +. +.IP "\(bu" 4 +\fB/var/schleuderlists/\fR\fILISTNAME\fR\fB/list\.conf\fR: list settings +. +.IP "\(bu" 4 +\fB/var/schleuderlists/\fR\fILISTNAME\fR\fB/members\.conf\fR: list susbcribers\. +. +.IP +Each member must have the email\-attribute set\. All other attributes are optional\. +. +.IP +The following attributes are available: +. +.IP "\(bu" 4 +\fBmime\fR: defines the \'pgp\-variant\' to send to the member, possible values are \fBMIME\fR (for pgp/mime\-formatted mail according to RFC 3156), and \fBPLAIN\fR (for inline\-pgp)\. The fallback\-default for this is defined in the \fBlist\.conf\fR\. +. +.IP "\(bu" 4 +\fBencrypted_only\fR: 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\. . .IP "" 0 . -.P -/var/log/schleuder +.IP +Example: . .IP "" 4 . .nf -Schleuder logs directory +\- email: you@example\.net +\- email: me@example\.org + mime: PLAIN +\- email: them@example\.com + encrypted_only: true . .fi . .IP "" 0 + +. +.IP "\(bu" 4 +\fB/var/schleuderlists/\fR\fIHOSTNAME\fR\fB/\fR\fILISTNAME\fR: list internal data +. +.IP "\(bu" 4 +\fB/var/log/schleuder\fR: Schleuder logs directory +. +.IP "" 0 . .P All configuration files are formatted as YAML\. See \fIhttp://www\.yaml\.org/\fR for more details\. . .SH "BUGS" -Known bugs are listed on the Schleuder bugtracker at https://git\.codecoop\.org/projects/schleuder\fBschleuder\-newlist\fR(8), \fBgnupg\fR(7)\. +Known bugs are listed on the Schleuder bugtracker at \fIhttps://git\.codecoop\.org/projects/schleuder\fR . -.P -Schleuder website: \fIhttp://schleuder\.nadir\.org/\fR +.SH "SEE ALSO" +\fBschleuder\-newlist\fR(8), \fBgnupg\fR(7)\. . -.P -Webschleuder website: \fIhttp://webschleuder\.nadir\.org/\fR (web interface to schleuder) +.TP +Schleuder website +\fIhttp://schleuder\.nadir\.org/\fR . -.P -YAML website: \fIhttp://www\.yaml\.org/\fR +.TP +Webschleuder website +\fIhttp://webschleuder\.nadir\.org/\fR (web interface to schleuder) +. +.TP +YAML website +\fIhttp://www\.yaml\.org/\fR + diff --git a/man/schleuder.8.html b/man/schleuder.8.html index 3c75436..8eef616 100644 --- a/man/schleuder.8.html +++ b/man/schleuder.8.html @@ -3,7 +3,7 @@ - Schleuder(8) - A groups email gateway. + schleuder(8) - a groups email gateway