schleuder 2.2.0

data/plugins/README

@@ -0,0 +1,20 @@
+Writing Plugins for Schleuder
+----------------------------
+
+There are a few rules which any Plugin must follow to work (correctly):
+
+- Name the file: <your_name>_plugin.rb (use underscores!)
+- Name the class: YourNamePlugin 
+- module Schleuder
+- Inherit from Plugin
+- Implement two instance-methods: 
+  - match(mail) 
+    Is executed to determine whether process() should be executed. Needs to
+    take one argument (a Schleuder::Mail-object) and to return true or false. 
+  - process(mail)
+    Is executed if match() returned true. Manipulate the taken
+    Schleuder::Mail-object here. 
+- use reply(origmail, your_message) to send a message to the sending
+  list-member and prevent normal distribution.
+
+For examples see other Plugins.

data/plugins/manage_keys_plugin.rb

@@ -0,0 +1,113 @@
+module Schleuder
+  class ManageKeysPlugin < Plugin
+    def initialize
+      @plugin_type = :request
+    end
+
+    def list_keys(mail, value)
+      Schleuder.log.debug 'LIST-KEY requested'
+      listkeys(mail)
+    end
+
+    def add_key(mail, value)
+      Schleuder.log.debug 'ADD-KEY requested'
+      addkey(mail, mail.body)
+    end
+
+    def del_key(mail, value)
+      Schleuder.log.debug 'DEL-KEY requested'
+      # TODO: implement callback to sender with Hash to prevent replay
+      # attacks.
+      # Split at slash to work around some people's habit to include the
+      # bitlength and key-type ("2048R/DEADBEEF"). If there's no slash this
+      # won't do no harm. We need to force the string'iness to avoid nil's,
+      # though.
+      val = value.split('/').last.to_s
+      msg = "The DEL-KEY-keyword is deprecated and will be removed some day in the future. Please use DELETE-KEY instead.".fmt
+      msg << delkey(mail, val)
+      msg
+    end
+
+    def delete_key(mail, value)
+      Schleuder.log.debug 'DELETE-KEY requested'
+      delkey(mail, value.split('/').last)
+    end
+
+    def send_key(mail, value)
+      Schleuder.log.debug 'SEND-KEY requested'
+      val = value.split('/').last
+      msg = "The SEND-KEY-keyword is deprecated and will be removed some day in the future. Please use GET-KEY instead.".fmt
+      msg << getkey(mail, val)
+      msg
+    end
+
+    def get_key(mail, value)
+      Schleuder.log.debug 'GET-KEY requested'
+      val = value.split('/').last
+      getkey(mail, val)
+    end
+
+    private
+
+    def listkeys(mail)
+      m = ""
+      mail.crypt.list_keys.each do |k|
+        if not (trust = [:revoked, :expired, :disabled, :invalid].grep(k.trust)).empty?
+          m << "*Warning*: Key is #{trust.join(' and ')}!\n"
+        end
+        m << "#{k.to_s}"
+        if (exp = k.subkeys.first.expires) > Time.utc(1971, 1, 1, 1)
+          if exp < Time.now
+            m << "Expired at #{exp}.\n"
+          else
+            m << "Expires at #{exp}.\n"
+          end
+        end
+        m << "\n"
+      end
+      m
+    end
+
+    def addkey(mail, key)
+      m = ""
+      res = mail.crypt.add_key(key)
+      res.imports.each do |i|
+        if i.status == 1
+          action = "imported"
+        else
+          action = "not imported"
+        end
+        m << "#{mail.crypt.get_key(i.fpr).to_s}\n--> #{action}\n\n"
+      end
+      m << "\nImportResult.inspect:\n=> #{res.inspect}"
+      m
+    end
+
+    def delkey(mail, req)
+      unless (key = mail.crypt.get_key(req)).first
+        msg = "Failed to lookup key (#{req}) that should be deleted. Reason: #{key[1].capitalize}."
+        Schleuder.log.debug msg
+        return "--> #{msg}\n\n"
+      end
+      Schleuder.log.debug "Key to be deleted: #{key.inspect}"
+      res = mail.crypt.delete_key(key.first)
+      if res == true
+        action = "Key deleted."
+      else
+        action = "Key not deleted.\nException: #{res.to_s}"
+      end
+      "#{key.to_s}\n--> #{action}\n\n"
+    end
+
+    def getkey(mail, req)
+      keyblock = mail.crypt.export(req)
+      if keyblock.empty?
+        "#{req}\n\n--> No matching key present.\n"
+      else
+        "#{mail.crypt.list_keys(req).to_s.gsub(/^pub /, "\npub ")}\n\n#{keyblock}\n"
+      end
+    end
+
+  end
+end
+

data/plugins/manage_members_plugin.rb

@@ -0,0 +1,152 @@
+module Schleuder
+  class ManageMembersPlugin < Plugin
+    def initialize
+      @plugin_type = :request
+    end
+
+    def get_members(mail, value)
+      # TODO: deprecation-notice
+      Schleuder.log.debug 'GET-MEMBERS requested'
+      get_membersfile
+    end
+
+    def save_members(mail, value)
+      # TODO: deprecation-notice
+      Schleuder.log.debug 'SAVE-MEMBERS requested'
+      if mail.body.strip.empty?
+        "Error, empty input. You need to write the members list yaml-formatted into the body."
+      else
+        Schleuder.list.members = YAML.load(mail.body)
+        "Saving was successful.\n\nCurrent members.conf:\n\n#{get_membersfile}\n"
+      end
+    end
+
+    def add_member(mail, value)
+      Schleuder.log.debug 'ADD-MEMBER requested'
+      addmember(mail, value, mail.body)
+    end
+
+    def delete_member(mail, value)
+      Schleuder.log.debug 'DELETE-MEMBER requested'
+      deletemember(mail, value)
+    end
+
+    def list_members(mail, value)
+      Schleuder.log.debug 'LIST-MEMBERS requested'
+      listmembers(mail)
+    end
+
+    def get_member(mail, value)
+      Schleuder.log.debug 'GET-MEMBER requested'
+      getmember(mail, value)
+    end
+
+    def listmembers(mail)
+      msg = ''
+      msg << "Default mime-setting for this list: #{Schleuder.list.config.default_mime.downcase}.\n"
+      msg << "\nAdmins for this list:\n\n#{_list_members(Schleuder.list.config.admins)}"
+      msg << "\n\nMembers:\n\n#{_list_members(Schleuder.list.members)}"
+      msg
+    end
+
+    def _list_members(members)
+      members.collect { |member|
+        res = member.email.dup
+        res << " (mime: #{member.mime.downcase})" if member.mime && !member.mime.downcase.eql?(Schleuder.list.config.default_mime.downcase)
+        res << " :: #{_list_keys(member)}\n\n"
+      }.join('')
+    end
+
+    def _list_keys(member)
+      result = ''
+      key, msg = member.key(false) # also get a potentially expired key -> will
+                                   # also inform about multiple keys on the list
+                                   # that might not me the case otherwise
+      if key
+        if key.trust.eql?(:expired)
+          result << "*Warning*: Key expired! "
+        elsif key.trust.eql?(:revoked)
+          result << "*Warning*: Key revoked! "
+        end
+        result << member.key_descr
+      else
+        result << "*Warning*: #{msg}"
+      end
+      result
+    end
+
+    def addmember(mail, string, key)
+      email, mime = string.split(' ')
+      mem = Member.new({:email => email})
+      mem.mime = mime if mime
+      # TODO: test if address already subscribed
+      Schleuder.list.members = Schleuder.list.members << mem
+      msg = "#{mem}\n--> Member saved.\n\n"
+      if key
+        mail.crypt.add_key(key).imports.each do |i|
+          msg << "#{mail.crypt.key_descr(mail.crypt.get_key(i.fpr))}\n"
+          if i.status.eql? 1
+            msg << "--> Key imported.\n\n"
+          else
+            msg << "--> Key *not* imported (no error, maybe already present?).\n\n"
+          end
+        end
+        msg << "\n"
+      end
+      msg << "Updated members-list:\n\n#{_list_members(mail)}"
+      msg
+    end
+
+    def deletemember(mail, string)
+      msg = ''
+      members = Schleuder.list.members.dup
+      members.delete_if {|mem| mem.email.eql?(string)}
+      if members.eql? Schleuder.list.members
+        msg << "Member #{string} not found"
+      else
+        if Schleuder.list.members = members
+          msg << "Member #{string} deleted.\n"
+        else
+          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
+    end
+
+    def getmember(mail, string)
+      Schleuder.log.debug "string: #{string.inspect}"
+      msg = ''
+      member = Schleuder.list.find_member_by_email string
+      unless member
+        return "Member #{string} not found.\n"
+      end
+      msg << "Email: #{member.email}\nMime: "
+      if member.mime
+        msg << member.mime.downcase
+      else
+        msg << "#{Schleuder.list.config.default_mime.downcase} (list-default)"
+      end
+      msg << "\n\n"
+      keys = mail.crypt.list_keys(member.email)
+      if keys.empty?
+        msg << "*Warning*: No key!\n\n"
+      else
+        if keys.size > 1
+          msg << "*Warning*: Multiple keys!\n\n"
+        end
+        msg << "Key(s):\n\n"
+        keys.each do |key|
+          msg << "#{key.to_s}Fingerprint: #{key.subkeys.first.fpr}\n\n"
+        end
+      end
+      msg
+    end
+
+    private
+    def get_membersfile
+        File.read(Schleuder.list.members_file)
+    end
+  end
+end
+

data/plugins/manage_self_plugin.rb

@@ -0,0 +1,26 @@
+module Schleuder
+  class ManageSelfPlugin < Plugin
+    def initialize
+      @plugin_type = :request
+    end
+
+    def unsubscribe(mail, foo)
+      Schleuder.log.debug 'UNSUBSCRIBE requested'
+      msg = ''
+
+      key = Plugin.signing_key(mail)
+      member = Schleuder.list.find_member_by_key(key) || Schleuder.list.find_admin_by_key(key)
+
+      members = Schleuder.list.members.dup
+      members.delete_if {|mem| mem.email.eql?(member.email)}
+
+      if Schleuder.list.members = members
+        msg << "Your address #{member.email} hast been unsubscribed.\n"
+      else
+        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
+      msg
+    end
+
+  end
+end

data/plugins/resend_plugin.rb

@@ -0,0 +1,35 @@
+module Schleuder
+  class ResendPlugin < Plugin
+    def initialize
+      @plugin_type = :list
+    end
+
+    def resend(mail, value)
+      store_address(mail, value, false)
+    end
+
+    def resend_encrypted_only(mail, value)
+      store_address(mail, value, true)
+    end
+
+    def store_address(mail, value, encrypted_only)
+      if mail.to.to_a.include? Schleuder.list.request_addr
+        msg = "The resend-command may only be used in message sent over the list, not messages sent to the request-address."
+        Schleuder.log.warn msg
+        return msg.fmt
+      end
+      if Utils.emailaddress? value
+        m = Member.new({'email' => value})
+        if encrypted_only
+          m.encrypted_only = true
+        end
+        mail.resend_to << m
+      else
+        Schleuder.log.warn "Skipping invalid email address given with resend-keyword: #{value}"
+        mail.metadata[:error] << "Invalid address given: '#{value}'."
+      end
+      mail
+    end
+
+  end
+end

data/plugins/version_plugin.rb

@@ -0,0 +1,12 @@
+module Schleuder
+  class VersionPlugin < Plugin
+    def initialize
+      @plugin_type = :request
+    end
+
+    def get_version(mail, value)
+      require 'schleuder/version'
+      "This list runs on schleuder v#{Schleuder::VERSION}.\n\nFor documentation see <http://schleuder.nadir.org/documentation.html>"
+    end
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: schleuder
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+  prerelease: 
+platform: ruby
+authors:
+- paz
+- ng
+autorequire: 
+bindir: bin
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUROakNDQWg2Z0F3SUJB
+  Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREJCTVJNd0VRWURWUVFEREFwelky
+  aHMKWlhWa1pYSXlNUlV3RXdZS0NaSW1pWlB5TEdRQkdSWUZibUZrYVhJeEV6
+  QVJCZ29Ka2lhSmsvSXNaQUVaRmdOdgpjbWN3SGhjTk1USXdOakEyTVRreE5E
+  STBXaGNOTVRNd05qQTJNVGt4TkRJMFdqQkJNUk13RVFZRFZRUUREQXB6Clky
+  aHNaWFZrWlhJeU1SVXdFd1lLQ1pJbWlaUHlMR1FCR1JZRmJtRmthWEl4RXpB
+  UkJnb0praWFKay9Jc1pBRVoKRmdOdmNtY3dnZ0VpTUEwR0NTcUdTSWIzRFFF
+  QkFRVUFBNElCRHdBd2dnRUtBb0lCQVFDaEdydW9ObnEzSXI3ZApGZCtrdEcw
+  dE1abG0yWlNPa3VITzVRUnJnWUxnYkJocFRFZjhpNkFqem9WTDBBSUMrdU1N
+  Vlk5aUU2ZnphS1VECkI3U3ZOdGNjSHNrWDZ6SFVWVnRTcUY5VnBiUW9tV3Bj
+  azBpQnF3UUl3NHZFTGUyaVorL1pVTEtJSkkvQlk0M3kKdFg3T3JhOGl6U3lQ
+  R2N1NkUxZnI1UEpJNmlnRm5sRWdzL2pDalAvSllIZi9mNDlmbkl6QUpnTzBR
+  N1lOTkpWcgpSMFpxbTFIYllFMnQrUnRvbVQyamdDakJ0RjQyaFg4K2dCNHlW
+  NW5lZGZIS3laZkQ2emQ3ZG9QRS9wZHRwbjgwCkJyUlFiSFhsRVBEQ2FkSEgw
+  MTNqN29MN0I1ZkpsSGVqWDZQRmZQdGVwcTNhZERRL08zbEZ2emZIdUpVR2pF
+  TzUKUVhwN2w1K2ZBZ01CQUFHak9UQTNNQWtHQTFVZEV3UUNNQUF3SFFZRFZS
+  ME9CQllFRklHMUc1UHhBMWxOL0JVWQprb212bHRzT1dDVGVNQXNHQTFVZER3
+  UUVBd0lFc0RBTkJna3Foa2lHOXcwQkFRVUZBQU9DQVFFQWtrTDRWWVhPCmlI
+  YzQ5bHFrMU9FL2IzWFZYWGdiQlZ1aHhvTkpYZC9oSjRlTmVxbVpydWMrZDlX
+  bEJIYTlVVFRGZ3JmUkxOcmsKSkRaSnc5Y3E5NmI0TmxsaG54Q2xpZ21SZXQ0
+  RkpmYWVtYS9naTZZN0lWRmZMUG5nVVhDUGN1SUNGOXBKd05HcwpLSUVndEE1
+  TmNVMitJZFpLekowRnBoV3pIRlRpVytMd1Uyb0lTTEhwTXhXZVhZSXNLTW9x
+  MjM4U3k3Y1l3emQ3CnZhZEhrZHMzNTRsbU4vajNhYW1kTXJyeHUyOTlvdTh1
+  am9IbGcxK3IxNjlsa2J1VHdXbEI2RlVXT1J3emhvMWIKOFlJWWRpT29jUHdm
+  Zi9BZ3l3UVdGZDRGV2VNV0xQeXRkK1VndzZCSmZSSXY2VC9OTVJKWWRIUDJW
+  M1RTUVJyTApSYXNUTTVlUzIrK3EwQT09Ci0tLS0tRU5EIENFUlRJRklDQVRF
+  LS0tLS0K
+date: 2012-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gpgme
+  requirement: &9959680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *9959680
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: &9957020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *9957020
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: &9955820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: *9955820
+- !ruby/object:Gem::Dependency
+  name: ruby-filemagic
+  requirement: &10014620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *10014620
+description: ! 'Schleuder is designed as a tool for group communication: subscribers
+  can communicate encrypted (and pseudonymously) among themselves, receive emails
+  from non-subscribers and send emails to non-subscribers via the list.
+
+
+  Schleuder takes care of all decryption and encryption, stripping of headers, formatting
+  conversions, etc. Schleuder can also send out its own public key upon request and
+  process administrative commands by email.'
+email: schleuder2@nadir.org
+executables:
+- schleuder
+- schleuder-newlist
+- schleuder-fix-gem-dependencies
+- schleuder-init-setup
+- schleuder-migrate-v2.1-to-v2.2
+extensions: []
+extra_rdoc_files: []
+files:
+- contrib/check-expired-keys.rb
+- contrib/mutt-schleuder-colors.rc
+- contrib/mutt-schleuder-resend.vim
+- contrib/smtpserver.rb
+- ext/default-list.conf
+- ext/default-members.conf
+- ext/list.conf.example
+- ext/schleuder.conf
+- lib/schleuder.rb
+- lib/schleuder/archiver.rb
+- lib/schleuder/crypt.rb
+- lib/schleuder/errors.rb
+- lib/schleuder/list.rb
+- lib/schleuder/list_config.rb
+- lib/schleuder/log/listlogger.rb
+- lib/schleuder/log/outputter/emailoutputter.rb
+- lib/schleuder/log/outputter/metaemailoutputter.rb
+- lib/schleuder/log/schleuderlogger.rb
+- lib/schleuder/mail.rb
+- lib/schleuder/mailer.rb
+- lib/schleuder/member.rb
+- lib/schleuder/plugin.rb
+- lib/schleuder/processor.rb
+- lib/schleuder/schleuder_config.rb
+- lib/schleuder/storage.rb
+- lib/schleuder/utils.rb
+- lib/schleuder/version.rb
+- plugins/README
+- plugins/manage_keys_plugin.rb
+- plugins/manage_members_plugin.rb
+- plugins/manage_self_plugin.rb
+- plugins/resend_plugin.rb
+- plugins/version_plugin.rb
+- README
+- LICENSE
+- man/schleuder.8
+- man/schleuder-newlist.8
+- !binary |-
+  YmluL3NjaGxldWRlcg==
+- !binary |-
+  YmluL3NjaGxldWRlci1uZXdsaXN0
+- !binary |-
+  YmluL3NjaGxldWRlci1maXgtZ2VtLWRlcGVuZGVuY2llcw==
+- !binary |-
+  YmluL3NjaGxldWRlci1pbml0LXNldHVw
+- !binary |-
+  YmluL3NjaGxldWRlci1taWdyYXRlLXYyLjEtdG8tdjIuMg==
+homepage: http://schleuder2.nadir.org
+licenses: []
+post_install_message: ! "\n\n    Note: There's still one dependency missing, which
+  we can't install in\n    this run of rubygems.  Please execute schleuder-fix-gem-dependencies
+  to\n    complete the installation!\n\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ! '[none]'
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Schleuder is a gpg-enabled mailinglist with remailer-capabilities.
+test_files: []