root/lib/cyborghood/mail.rb @ 979a7aaa
| d32ee48a | Marc Dequenes | #--
|
|
# CyborgHood, a distributed system management software.
|
|||
| e7315259 | Marc Dequènes (Duck) | # Copyright (c) 2009-2010 Marc Dequènes (Duck) <Duck@DuckCorp.org>
|
|
| d32ee48a | Marc Dequenes | #
|
|
# 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 3 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 program. If not, see <http://www.gnu.org/licenses/>.
|
|||
#++
|
|||
| 30406d66 | Marc Dequenes | ||
| bc4894ce | Marc Dequenes | require 'delegate'
|
|
| 1879aa76 | Marc Dequènes (Duck) | require 'mail'
|
|
require 'mail/gpg'
|
|||
require 'cyborghood/objects'
|
|||
| c7904e2c | Marc Dequenes | require 'fileutils'
|
|
require 'digest/md5'
|
|||
| 4672e230 | Marc Dequènes (Duck) | require 'active_support/core_ext/hash/keys'
|
|
| c7904e2c | Marc Dequenes | ||
| bc4894ce | Marc Dequenes | ||
| cb0d68fd | Marc Dequènes (Duck) | # This class handles RFC3156 signed/encrypted messages, validates them, and extract content properly.
|
|
# It also implements a protection against replay attacks.
|
|||
| c427bfc7 | Marc Dequenes | module CyborgHood
|
|
| cb0d68fd | Marc Dequènes (Duck) | class MailReport
|
|
attr_reader :error, :warn_sender, :user, :message
|
|||
| f0a75e9c | Marc Dequènes (Duck) | ||
| cb0d68fd | Marc Dequènes (Duck) | def initialize(params = {})
|
|
@error = params[:error]
|
|||
@warn_sender = params[:warn_sender]
|
|||
@user = params[:user]
|
|||
@message = params[:message]
|
|||
| f0a75e9c | Marc Dequènes (Duck) | ||
| cb0d68fd | Marc Dequènes (Duck) | @warn_sender = false
|
|
| f0a75e9c | Marc Dequènes (Duck) | end
|
|
| 5425b3f0 | Marc Dequènes (Duck) | ||
| cb0d68fd | Marc Dequènes (Duck) | def ok?
|
|
| 1879aa76 | Marc Dequènes (Duck) | !!(@error.nil? and @user and @message)
|
|
| 5425b3f0 | Marc Dequènes (Duck) | end
|
|
def warn_sender
|
|||
# send reply message if user is identified or in selected situations
|
|||
# (@warn_sender acts as an override)
|
|||
@warn_sender || @user
|
|||
end
|
|||
end
|
|||
| c427bfc7 | Marc Dequenes | class Mail < Delegator
|
|
| ed09e1e5 | Marc Dequènes (Duck) | include I18nTranslation
|
|
| 30406d66 | Marc Dequenes | ||
| 41310a41 | Marc Dequènes (Duck) | # class variable SUX
|
|
class << self; attr_accessor :delivery_initialized; end
|
|||
| ebccdcc4 | Marc Dequènes (Duck) | attr_accessor :user, :signature_timestamp
|
|
| 5425b3f0 | Marc Dequènes (Duck) | ||
| 30406d66 | Marc Dequenes | def initialize(msg = nil)
|
|
| 275e20ec | Marc Dequenes | @config = Config.instance
|
|
| 979a7aaa | Marc Dequènes (Duck) | # needs to be initialized before _any_ ::Mail object is created
|
|
unless self.class.delivery_initialized
|
|||
params = @config.mail.smtp.nil? ? {} : @config.mail.smtp.to_h.symbolize_keys
|
|||
::Mail.defaults do
|
|||
delivery_method :smtp, params
|
|||
end
|
|||
self.class.delivery_initialized = true
|
|||
end
|
|||
| 30406d66 | Marc Dequenes | if msg.nil?
|
|
| 1879aa76 | Marc Dequènes (Duck) | @mail = ::Mail.new
|
|
| 7193ea94 | Marc Dequenes | set_custom_headers
|
|
| 1879aa76 | Marc Dequènes (Duck) | elsif msg.is_a? ::Mail::Message
|
|
| ebccdcc4 | Marc Dequènes (Duck) | @mail = msg
|
|
| 30406d66 | Marc Dequenes | else
|
|
| 1879aa76 | Marc Dequènes (Duck) | @mail = ::Mail.new(msg)
|
|
| 30406d66 | Marc Dequenes | end
|
|
| c427bfc7 | Marc Dequenes | end
|
|
| 8ddd43db | Marc Dequènes (Duck) | def self.blank
|
|
m = self.new
|
|||
m.clear
|
|||
m
|
|||
end
|
|||
| 1879aa76 | Marc Dequènes (Duck) | def self.read(path)
|
|
self.new(::Mail.read(path))
|
|||
end
|
|||
| c427bfc7 | Marc Dequenes | def __getobj__
|
|
@mail
|
|||
end
|
|||
| cb0d68fd | Marc Dequènes (Duck) | def process
|
|
| c7904e2c | Marc Dequenes | if is_marked?
|
|
| b0da6fb3 | Marc Dequènes (Duck) | if @config.debug.flags.include?('ignorereplay')
|
|
| ed931f4d | Marc Dequènes (Duck) | logger.warn "Debug: ignoring replay"
|
|
else
|
|||
return MailReport.new(:error => _("Replay detected."))
|
|||
end
|
|||
| c7904e2c | Marc Dequenes | end
|
|
| cb0d68fd | Marc Dequènes (Duck) | return process_signed() if is_pgp_signed?
|
|
return process_encrypted() if is_pgp_encrypted?
|
|||
| 5425b3f0 | Marc Dequènes (Duck) | ||
| eb6e0359 | Marc Dequènes (Duck) | MailReport.new(:error => _("Mail not RFC3156 compliant."))
|
|
| 960c259e | Marc Dequenes | end
|
|
| 1879aa76 | Marc Dequènes (Duck) | def reply
|
|
mail_reply = self.class.new(@mail.reply)
|
|||
mail_reply.from = @config.mail.from_address if @config.mail.from_address
|
|||
mail_reply.set_custom_headers
|
|||
mail_reply.user = @user
|
|||
mail_reply
|
|||
| 09b32d70 | Marc Dequenes | end
|
|
| 4311d63d | Marc Dequènes (Duck) | def create_simple_reject_reply(msg)
|
|
| 1879aa76 | Marc Dequènes (Duck) | mail_reply = reply()
|
|
mail_reply.charset = "utf-8"
|
|||
mail_reply.body = msg + self.default_body_signature
|
|||
mail_reply.sign
|
|||
mail_reply.crypt(mail_reply.user.keyFingerPrint) unless mail_reply.user.nil?
|
|||
mail_reply
|
|||
| 56947466 | Marc Dequènes (Duck) | end
|
|
| 09b32d70 | Marc Dequenes | def set_custom_headers
|
|
@mail['Organization'] = @config.mail.organization
|
|||
end
|
|||
| 6ed10f49 | Marc Dequènes (Duck) | def default_body_signature
|
|
s = "\n" +
|
|||
"-- \n" +
|
|||
"#{CyborgHood::PRODUCT} v#{CyborgHood::VERSION}\n"
|
|||
s += _("Contact eMail:").to_s + " \"#{@config.contact.name}\" <#{@config.contact.email}>\n" if @config.contact.email
|
|||
s += _("Contact URL:").to_s + " #{@config.contact.url}\n" if @config.contact.url
|
|||
s
|
|||
end
|
|||
| 09b32d70 | Marc Dequenes | def to_s
|
|
@mail.to_s
|
|||
end
|
|||
| 958e72a0 | Marc Dequènes (Duck) | def crypt(fingerprint = nil)
|
|
@mail = @mail.create_encrypted(fingerprint || @user.keyFingerPrint)
|
|||
| 09b32d70 | Marc Dequenes | end
|
|
def sign
|
|||
| e77281ff | Marc Dequènes (Duck) | # we don't check the uid, as there is only one signer
|
|
| c0979b3e | Marc Dequenes | @mail = @mail.create_signed(@config.mail.key_id) do |uid_hint, passphrase_info, prev_was_bad|
|
|
| 09b32d70 | Marc Dequenes | @config.mail.key_passphrase
|
|
end
|
|||
end
|
|||
| 958e72a0 | Marc Dequènes (Duck) | def sign_and_crypt(fingerprint = nil)
|
|
| c0979b3e | Marc Dequenes | # not using sign_and_crypt(), to avoid repeating code
|
|
| 1879aa76 | Marc Dequènes (Duck) | sign
|
|
| 958e72a0 | Marc Dequènes (Duck) | crypt(fingerprint || @user.keyFingerPrint)
|
|
| 09b32d70 | Marc Dequenes | end
|
|
private
|
|||
| cb0d68fd | Marc Dequènes (Duck) | def process_signed
|
|
| 09b32d70 | Marc Dequenes | sigs_check = verify_pgp_signature()
|
|
| eb6e0359 | Marc Dequènes (Duck) | return MailReport.new(:error => _("Mail not formatted correctly (signed part).")) if sigs_check.nil? or sigs_check.size != 1
|
|
| 09b32d70 | Marc Dequenes | ||
| 1879aa76 | Marc Dequènes (Duck) | sig = sigs_check.first
|
|
return MailReport.new(:error => _("Mail content tampered or badly signed: %{sig_err}", :sig_err => sig.to_s)) if sig.bad?
|
|||
| 5425b3f0 | Marc Dequènes (Duck) | ||
| 1879aa76 | Marc Dequènes (Duck) | logger.info "Mail content was properly signed by key #{sig.fingerprint}"
|
|
begin
|
|||
user = Person.find_by_fingerprint(sig.key.fingerprint)
|
|||
rescue EOFError => error
|
|||
return MailReport.new(:error => _("Could not get public key for '%{fpr}'", :fpr => check.fingerprint))
|
|||
end
|
|||
| eb6e0359 | Marc Dequènes (Duck) | return MailReport.new(:error => _("Mail is from an unknown person."), :warn_sender => true) if user.nil?
|
|
| 5425b3f0 | Marc Dequènes (Duck) | ||
logger.info "Mail is from user #{user.uid} (#{user.cn})"
|
|||
| 958e72a0 | Marc Dequènes (Duck) | @user = user
|
|
| 5425b3f0 | Marc Dequènes (Duck) | ||
| 1879aa76 | Marc Dequènes (Duck) | drift = Time.new.to_i - sig.timestamp.to_i
|
|
| 5425b3f0 | Marc Dequènes (Duck) | logger.debug "Signature drift time: #{drift}"
|
|
| 2f1c6b5b | Marc Dequènes (Duck) | unless drift.abs < @config.mail.max_drift_time
|
|
| 5425b3f0 | Marc Dequènes (Duck) | if drift > 0
|
|
| eb6e0359 | Marc Dequènes (Duck) | return MailReport.new(:error => _("The signature was made too long ago (check your system clock). Rejected message to avoid replay attacks."), :user => user)
|
|
| c427bfc7 | Marc Dequenes | else
|
|
| 5425b3f0 | Marc Dequènes (Duck) | # mark message to prevent later replay of the message
|
|
| 1879aa76 | Marc Dequènes (Duck) | mark_processed(sig.timestamp)
|
|
| eb6e0359 | Marc Dequènes (Duck) | return MailReport.new(:error => _("The signature was made in the future (check your system clock). Rejected message to avoid replay attacks."), :user => user)
|
|
| c427bfc7 | Marc Dequenes | end
|
|
end
|
|||
| cb0d68fd | Marc Dequènes (Duck) | logger.debug "Mail OK"
|
|
mark_processed(self.signature_timestamp)
|
|||
| 5425b3f0 | Marc Dequènes (Duck) | signed_content = pgp_signed_part()
|
|
# create a fake mail and chain parsing operations
|
|||
| 1879aa76 | Marc Dequènes (Duck) | plain_mail = self.class.new(signed_content.encoded)
|
|
| 958e72a0 | Marc Dequènes (Duck) | plain_mail.user = @user
|
|
| 1879aa76 | Marc Dequènes (Duck) | plain_mail.signature_timestamp = sig.timestamp
|
|
| 5425b3f0 | Marc Dequènes (Duck) | # propagate message_id to be able to mark messages (replay protection)
|
|
| ebccdcc4 | Marc Dequènes (Duck) | plain_mail.message_id = @mail.message_id
|
|
| cb0d68fd | Marc Dequènes (Duck) | ||
MailReport.new(:user => user, :message => plain_mail)
|
|||
| c427bfc7 | Marc Dequenes | end
|
|
| 275e20ec | Marc Dequenes | ||
| cb0d68fd | Marc Dequènes (Duck) | def process_encrypted
|
|
| 960c259e | Marc Dequenes | catch :notforme do
|
|
begin
|
|||
# block is not passed to delegate (limitation ?)
|
|||
| 09b32d70 | Marc Dequenes | clear_message = @mail.pgp_decrypt do |uid_hint, passphrase_info, prev_was_bad|
|
|
| 960c259e | Marc Dequenes | logger.info "Mail crypted for #{uid_hint}"
|
|
# check if requesting passphrase for the expected key
|
|||
key_id = passphrase_info.split(" ")[1]
|
|||
throw :notforme if key_id != @config.mail.key_id[-(key_id.size)..-1]
|
|||
# sending key
|
|||
@config.mail.key_passphrase
|
|||
end
|
|||
# create a fake mail and chain parsing operations
|
|||
clear_mail = self.class.new(clear_message)
|
|||
| 958e72a0 | Marc Dequènes (Duck) | clear_mail.user = @user
|
|
| c7904e2c | Marc Dequenes | # propagate message_id to be able to mark messages (replay protection)
|
|
clear_mail.message_id = @mail.message_id
|
|||
| 91d7d237 | Marc Dequènes (Duck) | decrypted_mail = clear_mail.process
|
|
# reverse propagate user information (convenience)
|
|||
@user = decrypted_mail.user
|
|||
return decrypted_mail
|
|||
| a6c766ec | Marc Dequènes (Duck) | rescue GPGME::Error::DecryptFailed
|
|
# encrypted with an unknown key
|
|||
| 960c259e | Marc Dequenes | rescue GPGME::Error, NotImplementedError => e
|
|
raise CyberError.new(:unrecoverable, "protocol/mail", e.message)
|
|||
end
|
|||
end
|
|||
| a6c766ec | Marc Dequènes (Duck) | MailReport.new(:error => _("Mail not formatted correctly (encrypted part), or not encrypted with the correct key."))
|
|
| 960c259e | Marc Dequenes | end
|
|
| c7904e2c | Marc Dequenes | ||
def mark_dir
|
|||
| d4b5798a | Marc Dequènes (Duck) | File.join(Config::VAR_DIR, "marks")
|
|
| c7904e2c | Marc Dequenes | end
|
|
def mark_filename
|
|||
File.join(mark_dir(), Digest::MD5.hexdigest(self.message_id))
|
|||
end
|
|||
def mark_processed(time)
|
|||
FileUtils.mkdir_p(mark_dir())
|
|||
File.open(mark_filename(), "w") do |fp|
|
|||
fp.write self.message_id
|
|||
end
|
|||
File.utime(Time.now.to_i, time.to_i, mark_filename())
|
|||
end
|
|||
def is_marked?
|
|||
File.exists?(mark_filename())
|
|||
end
|
|||
| c427bfc7 | Marc Dequenes | end
|
|
end
|