schleuder 2.2.4 → 3.2.2

data/bin/schleuder-api-daemon

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/schleuder-api-daemon'
+SchleuderApiDaemon.run!

data/db/migrate/20140501103532_create_lists.rb

@@ -0,0 +1,39 @@
+class CreateLists < ActiveRecord::Migration
+  def up
+    if ! table_exists?(:lists)
+      create_table :lists do |t|
+        t.timestamps
+        t.string  :email
+        t.string  :fingerprint
+        t.string  :gpg_passphrase
+        t.string  :log_level, default: 'warn'
+        t.string  :default_mime, default: 'mime'
+        t.string  :subject_prefix, default: ''
+        t.string  :subject_prefix_in, default: ''
+        t.string  :subject_prefix_out, default: ''
+        t.string  :openpgp_header_preference, default: 'signencrypt'
+        t.text    :public_footer, default: ''
+        t.text    :headers_to_meta, default: '["from","to","date",":cc"]'
+        t.text    :bounces_drop_on_headers, default: '{"x-spam-flag":"yes"}'
+        t.text    :keywords_admin_only, default: '["unsubscribe", "unsubscribe", "delete-key"]'
+        t.text    :keywords_admin_notify, default: '["add-key"]'
+        t.boolean :send_encrypted_only, default: false
+        t.boolean :receive_encrypted_only, default: false
+        t.boolean :receive_signed_only, default: false
+        t.boolean :receive_authenticated_only, default: false
+        t.boolean :receive_from_subscribed_emailaddresses_only, default: false
+        t.boolean :receive_admin_only, default: false
+        t.boolean :keep_msgid, default: true
+        t.boolean :bounces_drop_all, default: false
+        t.boolean :bounces_notify_admins, default: true
+        t.boolean :include_list_headers, default: true
+        t.boolean :include_openpgp_header, default: true
+        t.integer :max_message_size_kb, default: 10240
+      end
+    end
+
+    def down
+      drop_table(:lists)
+    end
+  end
+end

data/db/migrate/20140501112859_create_subscriptions.rb

@@ -0,0 +1,21 @@
+class CreateSubscriptions < ActiveRecord::Migration
+  def up
+    if ! table_exists?(:subscriptions)
+      create_table :subscriptions do |t|
+        t.integer :list_id
+        t.string  :email
+        t.string  :fingerprint
+        t.boolean :admin, default: false
+        t.boolean :delivery_disabled, default: false
+        t.timestamps
+      end
+
+      add_index :subscriptions, :list_id
+      add_index :subscriptions, [:email, :list_id], unique: true
+    end
+  end
+
+  def down
+    drop_table(:subscriptions)
+  end
+end

data/db/migrate/201508092100_add_language_to_lists.rb

@@ -0,0 +1,11 @@
+class AddLanguageToLists < ActiveRecord::Migration
+  def up
+    if ! column_exists?(:lists, :language)
+      add_column :lists, :language, :string, default: 'en'
+    end
+  end
+
+  def down
+    remove_column(:lists, :language)
+  end
+end

data/db/migrate/20150812165700_change_keywords_admin_only_defaults.rb

@@ -0,0 +1,8 @@
+class ChangeKeywordsAdminOnlyDefaults < ActiveRecord::Migration
+  def up
+    change_column_default :lists, :keywords_admin_only, "[\"subscribe\", \"unsubscribe\", \"delete-key\"]"
+  end
+  def down
+    change_column_default :lists, :keywords_admin_only, "[\"unsubscribe\", \"unsubscribe\", \"delete-key\"]"
+  end
+end

data/db/migrate/20150813235800_add_forward_all_incoming_to_admins.rb

@@ -0,0 +1,11 @@
+class AddForwardAllIncomingToAdmins < ActiveRecord::Migration
+  def up
+    if ! column_exists?(:lists, :forward_all_incoming_to_admins)
+      add_column :lists, :forward_all_incoming_to_admins, :boolean, default: false
+    end
+  end
+
+  def down
+    remove_column(:lists, :forward_all_incoming_to_admins)
+  end
+end

data/db/migrate/201508141727_change_send_encrypted_only_default.rb

@@ -0,0 +1,8 @@
+class ChangeSendEncryptedOnlyDefault < ActiveRecord::Migration
+  def up
+    change_column_default :lists, :send_encrypted_only, true
+  end
+  def down
+    change_column_default :lists, :send_encrypted_only, false
+  end
+end

data/db/migrate/201508222143_add_logfiles_to_keep_to_lists.rb

@@ -0,0 +1,11 @@
+class AddLogfilesToKeepToLists < ActiveRecord::Migration
+  def up
+    if ! column_exists?(:lists, :logfiles_to_keep)
+      add_column :lists, :logfiles_to_keep, :integer, default: 2
+    end
+  end
+
+  def down
+    remove_column(:lists, :logfiles_to_keep)
+  end
+end

data/db/migrate/201508261723_rename_delivery_disabled_to_delivery_enabled_and_change_default.rb

@@ -0,0 +1,14 @@
+class RenameDeliveryDisabledToDeliveryEnabledAndChangeDefault < ActiveRecord::Migration
+  def up
+    if column_exists?(:subscriptions, :delivery_disabled)
+      rename_column :subscriptions, :delivery_disabled, :delivery_enabled
+      change_column_default :subscriptions, :delivery_enabled, true
+    end
+  end
+
+  def down
+    rename_column :subscriptions, :delivery_enabled, :delivery_disabled
+    change_column_default :subscriptions, :delivery_disabled, false
+  end
+end
+

data/db/migrate/201508261815_strip_gpg_passphrase.rb

@@ -0,0 +1,11 @@
+class StripGpgPassphrase < ActiveRecord::Migration
+  def up
+    if column_exists?(:lists, :gpg_passphrase)
+      remove_column :lists, :gpg_passphrase
+    end
+  end
+
+  def down
+    add_column :lists, :gpg_passphrase, :string
+  end
+end

data/db/migrate/201508261827_remove_default_mime.rb

@@ -0,0 +1,9 @@
+class RemoveDefaultMime < ActiveRecord::Migration
+  def up
+    remove_column :lists, :default_mime
+  end
+
+  def down
+    add_column :lists, :default_mime, :string, default: 'mime'
+  end
+end

data/db/migrate/20160501172700_fix_headers_to_meta_defaults.rb

@@ -0,0 +1,8 @@
+class FixHeadersToMetaDefaults < ActiveRecord::Migration
+  def up
+    change_column_default :lists, :headers_to_meta, '["from", "to", "date", "cc"]'
+  end
+
+  def down
+  end
+end

data/db/migrate/20170713215059_add_internal_footer_to_list.rb

@@ -0,0 +1,11 @@
+class AddInternalFooterToList < ActiveRecord::Migration
+  def up
+    if ! column_exists?(:lists, :internal_footer)
+      add_column :lists, :internal_footer, :text, default: ''
+    end
+  end
+
+  def down
+    remove_column(:lists, :internal_footer)
+  end
+end

data/db/schema.rb

@@ -0,0 +1,62 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20170713215059) do
+
+  create_table "lists", force: :cascade do |t|
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "email",                                       limit: 255
+    t.string   "fingerprint",                                 limit: 255
+    t.string   "log_level",                                   limit: 255, default: "warn"
+    t.string   "subject_prefix",                              limit: 255, default: ""
+    t.string   "subject_prefix_in",                           limit: 255, default: ""
+    t.string   "subject_prefix_out",                          limit: 255, default: ""
+    t.string   "openpgp_header_preference",                   limit: 255, default: "signencrypt"
+    t.text     "public_footer",                                           default: ""
+    t.text     "headers_to_meta",                                         default: "[\"from\", \"to\", \"date\", \"cc\"]"
+    t.text     "bounces_drop_on_headers",                                 default: "{\"x-spam-flag\":\"yes\"}"
+    t.text     "keywords_admin_only",                                     default: "[\"subscribe\", \"unsubscribe\", \"delete-key\"]"
+    t.text     "keywords_admin_notify",                                   default: "[\"add-key\"]"
+    t.boolean  "send_encrypted_only",                                     default: true
+    t.boolean  "receive_encrypted_only",                                  default: false
+    t.boolean  "receive_signed_only",                                     default: false
+    t.boolean  "receive_authenticated_only",                              default: false
+    t.boolean  "receive_from_subscribed_emailaddresses_only",             default: false
+    t.boolean  "receive_admin_only",                                      default: false
+    t.boolean  "keep_msgid",                                              default: true
+    t.boolean  "bounces_drop_all",                                        default: false
+    t.boolean  "bounces_notify_admins",                                   default: true
+    t.boolean  "include_list_headers",                                    default: true
+    t.boolean  "include_openpgp_header",                                  default: true
+    t.integer  "max_message_size_kb",                                     default: 10240
+    t.string   "language",                                    limit: 255, default: "en"
+    t.boolean  "forward_all_incoming_to_admins",                          default: false
+    t.integer  "logfiles_to_keep",                                        default: 2
+    t.text     "internal_footer",                                         default: ""
+  end
+
+  create_table "subscriptions", force: :cascade do |t|
+    t.integer  "list_id"
+    t.string   "email",            limit: 255
+    t.string   "fingerprint",      limit: 255
+    t.boolean  "admin",                        default: false
+    t.boolean  "delivery_enabled",             default: true
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "subscriptions", ["email", "list_id"], name: "index_subscriptions_on_email_and_list_id", unique: true
+  add_index "subscriptions", ["list_id"], name: "index_subscriptions_on_list_id"
+
+end

data/etc/init.d/schleuder-api-daemon

@@ -0,0 +1,87 @@
+#!/bin/sh
+
+### BEGIN INIT INFO
+# Provides:          schleuder-api-daemon
+# Required-Start:    $local_fs $remote_fs $network $syslog
+# Required-Stop:     $local_fs $remote_fs $network $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Schleuder API daemon
+# Description:       Schleuder API daemon — provides access for schleuder-cli and schleuder-web
+### END INIT INFO
+
+PATH=/sbin:/usr/sbin:/bin:/usr/bin
+
+. /lib/init/vars.sh
+
+. /lib/lsb/init-functions
+
+NAME=schleuder-api-daemon
+DAEMON=/usr/local/bin/schleuder-api-daemon
+DESC="Schleuder API daemon"
+PIDFILE=/var/run/$NAME.pid
+USER=schleuder
+GROUP=schleuder
+
+test -x $DAEMON || exit 5
+
+start_schleuder_api_daemon() {
+    if [ -f "$PIDFILE" ]; then
+        echo ""
+        log_failure_msg "$DESC is running already, please stop it first"
+        exit 1
+    fi
+    
+    if ! id $USER >/dev/null 2>&1; then
+        log_failure_msg "User \"$USER\" does not exist"
+        exit 1
+    fi
+    
+    if ! getent group $GROUP >/dev/null 2>&1; then
+        log_failure_msg "Group \"$GROUP\" does not exist"
+        exit 1
+    fi
+    
+    start-stop-daemon --chuid "$USER":"$GROUP" --start --pidfile $PIDFILE  --make-pidfile --background --startas $DAEMON -- $NAME
+}
+
+stop_schleuder_api_daemon() {
+    if [ -f "$PIDFILE" ]; then
+        start-stop-daemon --stop --retry TERM/10/KILL/5 --pidfile $PIDFILE --quiet --oknodo --pidfile "$PIDFILE"
+        rm -f $PIDFILE
+    fi
+}
+
+status_schleuder_api_daemon() {
+    if [ ! -e $PIDFILE ]; then
+        status_of_proc "${DAEMON}" "${DESC}"
+    else
+        status_of_proc -p "${PIDFILE}" "${DAEMON}" "${DESC}"
+    fi
+}
+
+case "$1" in
+    start)
+        log_begin_msg "Starting $DESC"
+        start_schleuder_api_daemon
+        log_end_msg $?
+        ;;
+    stop)
+        log_begin_msg "Stopping $DESC"
+        stop_schleuder_api_daemon
+        log_end_msg $?
+        ;;
+    status)
+        status_schleuder_api_daemon
+        ;;
+    restart|reload|force-reload)
+        log_begin_msg "Restarting $DESC"
+        stop_schleuder_api_daemon
+        start_schleuder_api_daemon
+        log_end_msg $?
+        ;;
+    *)
+        echo "Usage: $0 {start|stop|status|restart|reload|force-reload}"
+        exit 1
+        ;;
+esac

data/etc/list-defaults.yml

@@ -0,0 +1,123 @@
+# Setting default values for newly generated lists. Once a list is created it
+# is not affected by these settings but has its own set of options in the
+# database.
+#
+# The configuration format is yaml (http://www.yaml.org).
+#
+# Options are listed with the behaviour encoded in the database schema.
+
+# Only send out enrypted emails to subscriptions?
+# (This setting does not affect resend-messages.)
+send_encrypted_only: true
+
+# Allow only encrypted emails? If true, any other email will be bounced.
+receive_encrypted_only: false
+
+# Allow only emails that are validly signed? If true, any other email will be
+# bounced.
+receive_signed_only: false
+
+# Allow only emails that are validly signed by a subscriber's key?  If true,
+# any other email will be bounced.
+receive_authenticated_only: false
+
+# Allow only emails being sent from subscribed addresses? If true, any other
+# email will be bounced.
+# NOTE: This is a very weak restriction mechanism on which you should not rely,
+#       as sending addresses can easily be faked! We recommend you to rather
+#       rely on the `receive_authenticated_only` option. Setting the
+#       `receive_authenticated_only` option to true, will authenticated senders
+#       based on the signature on the mail, which is the strongest
+#       authentication mechanism you can get.
+#       This option could be useful, if you would like to have a closed
+#       mailinglist, but could not yet get all subscribers to properly use GPG.
+receive_from_subscribed_emailaddresses_only: false
+
+# Allow only emails that are validly signed by a list-admin's key.
+# This is useful for newsletters, announce or notification lists
+receive_admin_only: false
+
+# Which headers to include from the original mail.
+headers_to_meta:
+- from
+- to
+- cc
+- date
+
+# Preserve the Message-IDs (In-Reply-To, References) from the incoming email.
+# This setting can lead to information leakage, as replies are connectable
+# and a thread of (encrypted) messages can be built by an eavesdropper.
+keep_msgid: true
+
+# Which keywords ("email-commands") should be restricted to list-admins?
+keywords_admin_only:
+- subscribe
+- unsubscribe
+- delete-key
+
+# For which keywords should the list-admins receive a notice whenever it
+# triggers a command.
+keywords_admin_notify: 
+- add-key
+
+# Footer to append to each email that is sent to a subscribed address. Will not
+# be included in messages to non-subscribed addresses.
+internal_footer:
+
+# Footer to append to each email that is sent to non-subscribed addresses. Will
+# not be included in messages to subscribed addresses.
+public_footer:
+
+# Prefix to be inserted into the subject of every email that is validly signed
+# by a subscribed address.
+subject_prefix:
+
+# Prefix to be inserted into the subject of every email that is *not* validly
+# signed by a subscribed address.
+subject_prefix_in:
+
+# Prefix to be inserted into the subject of every email that has been
+# resent to a non-subscribed address.
+subject_prefix_out:
+
+# Drop any bounces (incoming emails not passing the receive_*_only-rules)?
+bounces_drop_all: false
+
+# Drop bounces if they match one of these headers. Must be a hash, keys
+# and values are case insensitive.
+bounces_drop_on_headers: 
+  x-spam-flag: yes
+
+# Send a notice to the list-admins whenever an email is bounced or dropped?
+bounces_notify_admins: true
+
+# Include RFC-compliant List-* Headers into emails?
+include_list_headers: true
+
+# Include OpenPGP-Header into emails?
+include_openpgp_header: true
+
+# Prefered way to receive emails to note in OpenPGP-Header
+# ('sign'|'encrypt'|'signencrypt'|'unprotected'|'none')
+openpgp_header_preference: signencrypt
+
+# Maximum size of emails allowed on the list, in kilobyte. All others will be
+# bounced.
+max_message_size_kb: 10240
+
+# How verbose to log on the list-level (Notifications will be sent to
+# list-admins)? Error, warn, info, or debug.
+log_level: warn
+
+# How many logfiles to keep, including the current one.
+# Logfiles are rotated daily, so 2 means: delete logfiles older than
+# yesterday.  Values lower than 1 are ignored.
+logfiles_to_keep: 2
+
+# Which language to use for automated replies, error-messages, etc.
+# Available: en, de.
+language: en
+
+# Forward a raw copy of all incoming emails to the list-admins?
+# Mainly useful for debugging.
+forward_all_incoming_to_admins: false