Project

General

Profile

Download (8.5 KB) Statistics
| Branch: | Tag: | Revision:

root/lib/cyborghood-postman/mail.rb @ 2eaae89a

d32ee48a Marc Dequenes
#--
# CyborgHood, a distributed system management software.
364e4a96 Marc Dequènes (Duck)
# Copyright (c) 2009-2011 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'
require 'tmail'
861ef12d Marc Dequenes
require 'tmail_gpg'
bd9c8c28 Marc Dequènes (Duck)
require 'tmail_extra'
275e20ec Marc Dequenes
require 'net/smtp'
c7904e2c Marc Dequenes
require 'fileutils'
require 'digest/md5'

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?
@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
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

30406d66 Marc Dequenes
if msg.nil?
@mail = TMail::Mail.new
7193ea94 Marc Dequenes
set_custom_headers
ebccdcc4 Marc Dequènes (Duck)
elsif msg.is_a? TMail::Mail
@mail = msg
30406d66 Marc Dequenes
else
2520cf92 Marc Dequènes (Duck)
@mail = TMail::Mail.parse(msg)
30406d66 Marc Dequenes
end
c427bfc7 Marc Dequenes
end

8ddd43db Marc Dequènes (Duck)
def self.blank
m = self.new
m.clear
m
end

c427bfc7 Marc Dequenes
def __getobj__
@mail
end

cb0d68fd Marc Dequènes (Duck)
def process
c7904e2c Marc Dequenes
if is_marked?
2f1c6b5b Marc Dequènes (Duck)
if @config.debug.flags.include?('debug_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

09b32d70 Marc Dequenes
def create_reply
tmail_reply = @mail.create_reply
tmail_reply.from_addrs = TMail::Address.parse(@config.mail.from_address || self.to.first)
29da2972 Marc Dequènes (Duck)
tmail_reply.to_addrs = (@mail.reply_to_addrs_pretty || @mail.from_addrs_pretty).collect do |a|
TMail::Address.parse(@mail.class.header_value_smtp(a))
2520cf92 Marc Dequènes (Duck)
end
09b32d70 Marc Dequenes
reply = self.class.new(tmail_reply.to_s)
reply.set_custom_headers
958e72a0 Marc Dequènes (Duck)
reply.user = @user
09b32d70 Marc Dequenes
reply
end

4311d63d Marc Dequènes (Duck)
def create_simple_reject_reply(msg)
reply = create_reply()
reply.set_content_type("text", "plain", {'charset' => "utf-8"})
ebccdcc4 Marc Dequènes (Duck)
reply.set_disposition("inline")
6ed10f49 Marc Dequènes (Duck)
reply.quoted_printable_body = msg + self.default_body_signature
4311d63d Marc Dequènes (Duck)
reply.sign
5425b3f0 Marc Dequènes (Duck)
reply.crypt(reply.user.keyFingerPrint) unless reply.user.nil?
4311d63d Marc Dequènes (Duck)
reply
end

56947466 Marc Dequènes (Duck)
def to_multipart!
self.set_content_type("multipart", "mixed", {'boundary' => TMail.new_boundary})
self.transfer_encoding = "7bit"
self.quoted_body = "This mail is in MIME format.\n"
self.parts.clear
end

09b32d70 Marc Dequenes
def set_custom_headers
@mail['Organization'] = @config.mail.organization
end

def check_headers
@mail.header.keys.each do |h|
29da2972 Marc Dequènes (Duck)
@mail[h] = @mail.class.quote_address_if_necessary(@mail[h].to_s, "utf-8")
09b32d70 Marc Dequenes
end
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 deliver
check_headers

2f1c6b5b Marc Dequènes (Duck)
smtp_server = @config.mail.smtp_server
smtp_port = @config.mail.smtp_port
09b32d70 Marc Dequenes
smtp_from = @mail.from_addrs.collect{|a| a.address}.join(", ")
smtp_to = @mail.to_addrs.collect{|a| a.address}
Net::SMTP.start(smtp_server, smtp_port) do |smtp|
smtp.send_message(@mail.to_s, smtp_from, smtp_to)
end
end

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
09b32d70 Marc Dequenes
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
sig_check = sigs_check.first
eb6e0359 Marc Dequènes (Duck)
return MailReport.new(:error => _("Mail content tampered or badly signed: %{sig_err}", :sig_err => sig_check.to_s)) unless sig_check.status == 0
5425b3f0 Marc Dequènes (Duck)
logger.info "Mail content was properly signed by key #{sig_check.fingerprint}"
user = Person.find_by_fingerprint(sig_check.fingerprint)
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)
drift = Time.new.to_i - sig_check.timestamp.to_i
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
mark_processed(sig_check.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
plain_mail = self.class.new(signed_content)
958e72a0 Marc Dequènes (Duck)
plain_mail.user = @user
ebccdcc4 Marc Dequènes (Duck)
plain_mail.signature_timestamp = sig_check.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
960c259e Marc Dequenes
rescue GPGME::Error, NotImplementedError => e
raise CyberError.new(:unrecoverable, "protocol/mail", e.message)
end
end

eb6e0359 Marc Dequènes (Duck)
MailReport.new(:error => _("Mail not formatted correctly (encrypted part)."))
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