Module: Mail::Gpg::MessagePatch

Defined in:
lib/mail/gpg/message_patch.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



9
10
11
12
13
14
 
# File 'lib/mail/gpg/message_patch.rb', line 9

def self.included(base)
  base.class_eval do
    attr_accessor :raise_encryption_errors
    include VerifyResultAttribute
  end
end

Instance Method Details

#decrypt(options = {}) ⇒ Object

returns the decrypted mail object.

pass verify: true to verify signatures as well. The gpgme verification result will be available via decrypted_mail.verify_result



65
66
67
68
69
70
71
72
73
 
# File 'lib/mail/gpg/message_patch.rb', line 65

def decrypt(options = {})
  import_missing_keys = options[:verify] && options.delete(:import_missing_keys)
  Mail::Gpg.decrypt(self, options).tap do |decrypted|
    if import_missing_keys && !decrypted.signature_valid?
      import_keys_for_signatures! decrypted.signatures
      return Mail::Gpg.decrypt(self, options)
    end
  end
end

#encrypted? ⇒ Boolean

true if this mail is encrypted

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/mail/gpg/message_patch.rb', line 57

def encrypted?
  Mail::Gpg.encrypted?(self)
end

#gpg(options = nil) ⇒ Object

turn on gpg encryption / set gpg options.

options are:

encrypt: encrypt the message. defaults to true sign: also sign the message. false by default sign_as: UIDs to sign the message with

See Mail::Gpg methods encrypt and sign for more possible options

mail.gpg encrypt: true mail.gpg encrypt: true, sign: true mail.gpg encrypt: true, sign_as: “[email protected]”

sign-only mode is also supported: mail.gpg sign: true mail.gpg sign_as: ‘[email protected]’

To turn off gpg encryption use: mail.gpg false



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/mail/gpg/message_patch.rb', line 38

def gpg(options = nil)
  case options
  when nil
    @gpg
  when false
    @gpg = nil
    if Mail::Gpg::DeliveryHandler == delivery_handler
      self.delivery_handler = nil
    end
    nil
  else
    self.raise_encryption_errors = true if raise_encryption_errors.nil?
    @gpg = options
    self.delivery_handler ||= Mail::Gpg::DeliveryHandler
    nil
  end
end

#import_keys_for_signatures!(signatures = []) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/mail/gpg/message_patch.rb', line 99

def import_keys_for_signatures!(signatures = [])
  hkp = Hkp.new raise_errors: false
  signatures.each do |sig|
    begin
      sig.key
    rescue EOFError # gpgme throws this for unknown keys :(
      hkp.fetch_and_import sig.fingerprint
    end
  end
end

#signed? ⇒ Boolean

true if this mail is signed (but not encrypted)

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/mail/gpg/message_patch.rb', line 76

def signed?
  Mail::Gpg.signed?(self)
end

#verify(options = {}) ⇒ Object

verify signatures. returns a new mail object with signatures removed and populated verify_result.

verified = signed_mail.verify() verified.signature_valid? signers = mail.signatures.map{|sig| sig.from}

use import_missing_keys: true in order to try to fetch and import unknown keys for signature validation



89
90
91
92
93
94
95
96
97
 
# File 'lib/mail/gpg/message_patch.rb', line 89

def verify(options = {})
  import_missing_keys = options.delete(:import_missing_keys)
  Mail::Gpg.verify(self, options).tap do |verified|
    if import_missing_keys && !verified.signature_valid?
      import_keys_for_signatures! verified.signatures
      return Mail::Gpg.verify(self, options)
    end
  end
end