schleuder 2.2.4 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c37622657ee9683d0d006af23a4fb74d53c1c697
-  data.tar.gz: 992426df30d2c0de1e97a9d9b611fc5dbc2d1557
+SHA256:
+  metadata.gz: edc9a5383dea2704c0ea9cfaa947e657221b89a83ff693cc221c5649026711f5
+  data.tar.gz: 8c4117d91098a20ccb9d4f12146524eb8e7d701f60d9a77ce0573510b1dbeb42
 SHA512:
-  metadata.gz: 8a4fa65cbe451d2880ef8f38201565c5672c8f41ebff22f8579f1e2ce3aef44f6aeb043e3d93610a55450e7296341ed8689bcf8bfc96dd40847b5d7ce1e987f5
-  data.tar.gz: 5238664faab3274a9803bc11a9ef0a91f0c46392a825c7cfe2e040efd0cfc1b3ea2d09fa2982ac8ef9419e3ba13a0ec2a6d81bed2f484fa5846a6a5cec7c666d
+  metadata.gz: 25adeec03329d06994b3ebada2d8b0dd9f9e50ee8c83e5349496decacf9877e8388f2122656f984516f3b1d8f3872748d8b91366131cd6f21b4c2eef5caa915f
+  data.tar.gz: 83b6170572c99168c6b49471d2a34823b49e878f6d1c03ea5f65f7c9a7d999f80996c92813892942e1940822615ba17c4b8da9c864cc59c46b88f8730d5ebfed

data/README.md

@@ -0,0 +1,138 @@
+Schleuder, version 3
+======================================
+
+Schleuder is a gpg-enabled mailing list manager with resending-capabilities. Subscribers can communicate encrypted (and pseudonymously) among themselves, receive emails from non-subscribers and send emails to non-subscribers via the list.
+
+Version 3 of schleuder is a complete rewrite, which aims to be more robust, flexible, and internationalized. It
+also provides an API for the optional web interface called [schleuder-web](https://0xacab.org/schleuder/schleuder-web).
+
+For more details see <https://schleuder.nadir.org/docs/>.
+
+Requirements
+------------
+* ruby >=2.1
+* gnupg 2.0.x, or >=2.1.16
+* gpgme
+* sqlite3
+* openssl
+
+*If you use Debian stretch or CentOS 7, please have a look at the [installation docs](https://schleuder.nadir.org/docs/#installation). We do provide packages for those platforms, which simplify the installation a lot.*
+
+*🛈 A note regarding Ubuntu: All released Ubuntu versions (including 17.10) don't meet the requirements with their packaged versions of gnupg! To run Schleuder on Ubuntu you currently have to install a more recent version of gnupg manually. A sufficient version of gnupg is included in "bionic-proposed", which might make 18.04 a usable Ubuntu release.*
+
+On systems that base on Debian 9 ("stretch"), install the dependencies via
+
+    apt-get install ruby-dev gnupg2 libgpgme-dev libsqlite3-dev libssl-dev build-essential
+
+
+We **recommend** to also run a random number generator like [haveged](http://www.issihosts.com/haveged/). This ensures Schleuder won't be blocked by lacking entropy, which otherwise might happen especially during key generation.
+
+On Debian based systems, install it via
+
+    apt-get install haveged
+
+
+Additionally these **rubygems** are required (will be installed automatically unless present):
+
+* rake
+* active_record
+* sqlite3
+* thor
+* thin
+* mail-gpg
+* sinatra
+* sinatra-contrib
+
+
+Installing Schleuder
+------------
+
+1. Download [the gem](https://schleuder.nadir.org/downloads/schleuder-3.2.2.gem) and [the OpenPGP-signature](https://schleuder.nadir.org/downloads/schleuder-3.2.2.gem.sig) and verify:
+   ```
+   gpg --recv-key 0xB3D190D5235C74E1907EACFE898F2C91E2E6E1F3
+   gpg --verify schleuder-3.2.2.gem.sig
+   ```
+
+2. If all went well install the gem:
+   ```
+   gem install schleuder-3.2.2.gem
+   ```
+
+3. Set up schleuder:
+  ```
+  schleuder install
+  ```
+  This creates neccessary directories, copies example configs, etc. If you see errors about missing write permissions please follow the advice given.
+
+
+For further information on setup and configuration please read <https://schleuder.nadir.org/docs/#setup>.
+
+
+Command line usage
+-----------------
+
+See `schleuder help`.
+
+E.g.:
+
+    Commands:
+      schleuder check_keys                    # Check all lists for unusable or expiring keys and send the results to the list-admins. (This is supposed...
+      schleuder help [COMMAND]                # Describe available commands or one specific command
+      schleuder install                       # Set up Schleuder initially. Create folders, copy files, fill the database, etc.
+      schleuder version                       # Show version of schleuder
+      schleuder work list@hostname < message  # Run a message through a list.
+
+List administration
+-------------------
+
+Please use
+[schleuder-cli](https://0xacab.org/schleuder/schleuder-cli) to create and
+manage lists from the command line.
+
+Optionally consider installing
+[schleuder-web](https://0xacab.org/schleuder/schleuder-web), the web
+interface for schleuder. It enables list-admins to manage their lists through
+the web instead of using [request-keywords](https://schleuder.nadir.org/docs/#subscription-and-key-management).
+
+
+
+Todo
+----
+
+See <https://0xacab.org/schleuder/schleuder/issues>.
+
+Testing
+-------
+We use rspec to test our code. To setup the test environment run:
+
+
+    SCHLEUDER_ENV=test SCHLEUDER_CONFIG=spec/schleuder.yml bundle exec rake db:init
+
+To execute the test suite run:
+
+    bundle exec rspec
+
+We are working on extendig the test coverage.
+
+Contributing
+------------
+
+Please see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+
+Code of Conduct
+---------------
+
+We adopted a code of conduct. Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
+
+
+License
+-------
+
+GNU GPL 3.0. Please see [LICENSE.txt](LICENSE.txt).
+
+
+Alternative Download
+--------------------
+
+Alternatively to the gem-files you can download the latest release as [a tarball](https://schleuder.nadir.org/downloads/schleuder-3.2.2.tar.gz) and [its OpenPGP-signature](https://schleuder.nadir.org/downloads/schleuder-3.2.2.tar.gz.sig).

data/Rakefile

@@ -0,0 +1,136 @@
+project = 'schleuder'
+require_relative "lib/#{project}.rb"
+
+@version = Schleuder::VERSION
+@tagname = "#{project}-#{@version}"
+@gpguid = 'schleuder@nadir.org'
+@filename_gem = "#{@tagname}.gem"
+@filename_tarball = "#{@tagname}.tar.gz"
+
+load "active_record/railties/databases.rake"
+
+# Configure ActiveRecord
+ActiveRecord::Tasks::DatabaseTasks.tap do |config|
+  config.root = File.dirname(__FILE__)
+  config.db_dir = 'db'
+  config.migrations_paths = ['db/migrate']
+  config.env = ENV['SCHLEUDER_ENV']
+  config.database_configuration = Schleuder::Conf.databases
+end
+
+# ActiveRecord requires this task to be present
+Rake::Task.define_task("db:environment")
+
+namespace :db do
+  # A shortcut.
+  task init: ['db:create', 'db:schema:load']
+end
+
+def edit_and_add_file(filename)
+  puts "Please edit #{filename} to refer to version #{@version}"
+  if system("gvim -f #{filename}.md")
+    `git add #{filename}.md`
+  else
+    exit 1
+  end
+end
+
+task :console do
+  exec "irb -r #{File.dirname(__FILE__)}/lib/schleuder.rb"
+end
+
+task :publish_gem => :website
+task :git_tag => :check_version
+
+desc "Build new version: git-tag and gem-file"
+task :new_version => [
+    :check_version,
+    :edit_readme, :edit_changelog,
+    :git_add_version,
+    :git_commit,
+    :build_gem,
+    :sign_gem,
+    :build_tarball,
+    :sign_tarball,
+    :git_tag
+  ] do
+end
+
+desc "Edit CHANGELOG.md"
+task :edit_changelog do
+  edit_and_add_file('CHANGELOG')
+end
+
+desc "Edit README"
+task :edit_readme do
+  edit_and_add_file('README')
+end
+
+desc 'git-tag HEAD as new version'
+task :git_tag do
+  `git tag -u #{@gpguid} -s -m "Version #{@version}" #{@tagname}`
+end
+
+desc "Add changed version to git-index"
+task :git_add_version do
+  `git add lib/#{project}/version.rb`
+end
+
+desc "Commit changes as new version"
+task :git_commit do
+  `git commit -m "Version #{@version} (README, gems, ...)"`
+end
+
+desc 'Build, sign and commit a gem-file.'
+task :build_gem do
+  `gem build #{project}.gemspec`
+end
+
+desc 'OpenPGP-sign gem and tarball'
+task :sign_tarball do
+  `gpg -u #{@gpguid} -b #{@filename_gem}`
+end
+
+desc 'OpenPGP-sign gem'
+task :sign_gem do
+  `gpg -u #{@gpguid} -b #{@filename_tarball}`
+end
+
+desc 'Publish gem-file to rubygems.org'
+task :publish_gem do
+  puts "Really push #{@filename_gem} to rubygems.org? [yN]"
+  if gets.match(/^y/i)
+    puts "Pushing..."
+    `gem push #{@filename_gem}`
+  else
+    puts "Not pushed."
+  end
+end
+
+desc 'Build and sign a tarball'
+task :build_tarball do
+  `git archive --format tar.gz --prefix "#{@tagname}/" -o #{@filename_tarball} master`
+end
+
+desc 'Describe manual release-tasks'
+task :website do
+  puts "Please update the website:
+  * Update changelog.
+  * Publish release-announcement.
+"
+end
+
+desc 'Check if version-tag already exists'
+task :check_version do
+  # Check if Schleuder::VERSION has been updated since last release
+  if `git tag`.match?(/^#{@tagname}$/)
+    $stderr.puts "Warning: Tag '#{@tagname}' already exists. Did you forget to update #{project}/version.rb?"
+    $stderr.print "Delete tag to continue? [yN] "
+    if $stdin.gets.match(/^y/i)
+      `git tag -d #{@tagname}`
+    else
+      exit 1
+    end
+  end
+end
+

data/bin/pinentry-clearpassphrase

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+# This file can be deleted once we cease to support gnupg 2.0.
+
+require 'fileutils'
+require 'cgi'
+require 'openssl'
+
+def respond(msg, flush=true)
+  $stdout.puts msg
+  if flush
+    $stdout.flush
+  end
+end
+
+def send_ok(flush=true)
+  respond 'OK', flush
+end
+
+def send_password
+  if File.exist?(OLDPWDSENTFILE)
+    pwd = ''
+    if File.exist?(EMPTYPWDSENTFILE1)
+      FileUtils.touch(EMPTYPWDSENTFILE2)
+    else
+      FileUtils.touch(EMPTYPWDSENTFILE1)
+    end
+  else
+    pwd = OLDPASSWD
+    FileUtils.touch(OLDPWDSENTFILE)
+  end
+  respond "D #{pwd}"
+end
+
+def do_exit
+  if File.exist?(EMPTYPWDSENTFILE2)
+    FileUtils.rm_rf(TMPDIR)
+  end
+  exit 0
+end
+
+OLDPASSWD = CGI.escape(ENV['PINENTRY_USER_DATA'].to_s)
+if OLDPASSWD.empty?
+  respond "Fatal error: passed PINENTRY_USER_DATA was empty, cannot continue"
+  exit 1
+end
+
+# We need a static directory name to maintain the state across invocations of
+# this file.
+TMPDIR = File.join(ENV['GNUPGHOME'], '.tmp-pinentry-clearpassphrase')
+OLDPWDSENTFILE = File.join(TMPDIR, '1')
+EMPTYPWDSENTFILE1 = File.join(TMPDIR, '2')
+EMPTYPWDSENTFILE2 = File.join(TMPDIR, '3')
+if ! Dir.exist?(TMPDIR)
+  Dir.mkdir(TMPDIR)
+end
+
+respond "OK - what's up?"
+
+while line = $stdin.gets do
+  case line
+  when /^GETPIN/
+    send_password
+    send_ok
+  when /^BYE/
+    send_ok false
+    do_exit
+  else
+    send_ok
+  end
+end
+

data/bin/schleuder

@@ -1,96 +1,16 @@
 #!/usr/bin/env ruby
 
-# Don't show warnings, $stdout is being watched by the MTA.
-$VERBOSE = nil
+# Don't emit any warnings, they would be sent back to the email-sender as an
+# error-message.
+$VERBOSE=nil
 
-# TODO: 
-# - make code comments rdoc-compatible.
-# - check sanity of listconfig-value like 'myaddr', 'default_mime' etc. 
-#   We need them to be properly set to process properly.
-# - primary setup-check / is there a valid list-config?/admin?/
-#   admin-key?
+trap("INT") { exit 1 }
 
-def usage
-  puts "Usage:
-#{File.basename($0)} [-c baseconfig] listname < email
-#{File.basename($0)} [-c baseconfig] -test [listname]"
-  exit 1
-end
-
-def process_test(arg)
-    usage unless STDIN.tty?
-    listname = ARGV.shift
-    if listname
-      Schleuder.log.debug "Calling Processor.test(#{listname})"
-      Schleuder::Processor.test listname
-    else
-      Schleuder.log.debug "Calling Processor.test"
-      Schleuder::Processor.test
-    end
-end
 
-def process_list(listname)
-  usage if STDIN.tty? or ! listname
-  Schleuder.log.debug "Running for list #{listname}"
-  Schleuder.log.debug 'Reading STDIN'
-  # TODO: check for valid IO
-  msg = STDIN.read
-  Schleuder.log.debug 'Handing over to Processor.run'
-  Schleuder::Processor.run listname, msg
-end
-
-$:.unshift File.dirname(__FILE__) + '/../lib'
-require 'schleuder'
-begin 
-  arg = ARGV.shift
-  if arg == '-c'
-    Schleuder.config(ARGV.shift)
-    arg = ARGV.shift
-  end
-  Schleuder.log.debug "I've been called, starting up..."
-  case arg
-  when '-test'
-    process_test(ARGV)
-  when /(-h|--help)/
-    usage
-  when /[A-Za-z0-9]+/
-    process_list(arg.gsub(/-(sendkey|bounces|request|owner)(@|$)/, '\2'))
-  else
-    usage
-  end
-rescue SystemExit => e
-  exit e.status
-rescue Errno::EACCES => e
-  msg = [e.message, e.backtrace].flatten.join("\n")
-  $stderr.puts "File permission error: %s" % msg
-  begin
-    Schleuder.log.fatal e
-  rescue
-    begin
-      Log4r::Logger['log4r'].error e
-    rescue
-    end
-  end
-  exit 1
-rescue Exception => e
-  begin
-    # Log4r mutes all outputters on first exception so if this rescues from a
-    # Log4r-error we can't expect the raise of a second exception here.
-    # Unfortunately there's no direct way to identify exceptions from Log4r
-    # because it throws StandardErrors and we're subclassing.
-    callerfile = e.backtrace.first.split(':').first.split('/').last rescue ''
-    if e.class == StandardError &&
-          ['listlogger.rb', 'schleuderlogger.rb'].include?(callerfile)
-      raise e
-    else
-      Schleuder.log.fatal e
-    end
-  rescue => f
-    msg1 = "Logger exception: #{f}\n#{f.backtrace.join("\n")}"
-    msg2 = "...while trying to log this exception: #{e}\n#{f.backtrace.join("\n")}"
-    Log4r::Logger['log4r'].error { "#{msg1}\n\n#{msg2}" }
-    $stderr.puts(f.message) if $stderr.tty?
-  end
-  $stderr.puts "A serious error occurred, please notify the administrators of this list or server!"
+begin
+  require_relative '../lib/schleuder/cli'
+  Schleuder::Cli.start
+rescue => exc
+  $stderr.puts "Technical Error: #{exc}\n#{exc.backtrace.first}"
   exit 1
 end