1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
#
# This file is a part of the Mailman PGP plugin.
#
# 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/>.
"""A combined PGP/MIME + inline PGP wrapper."""
import copy
from pgpy.errors import PGPError
from public import public
from mailman_pgp.pgp.inline import InlineWrapper
from mailman_pgp.pgp.mime import MIMEWrapper
from mailman_pgp.pgp.mime_multisig import MIMEMultiSigWrapper
from mailman_pgp.utils.pgp import verifies
@public
class PGPWrapper():
"""A combined PGP/MIME + inline PGP wrapper."""
def __init__(self, msg, default=MIMEWrapper):
"""
Wrap the given message.
:param msg: The message to wrap.
:type msg: mailman.email.message.Message
:param default:
:type default: MIMEWrapper|MIMEMultiSigWrapper|InlineWrapper
"""
self.msg = msg
self.mime = MIMEWrapper(msg)
self.inline = InlineWrapper(msg)
self.multisig = MIMEMultiSigWrapper(msg)
self.wrappers = (self.mime, self.inline, self.multisig)
if default is MIMEWrapper:
self.default = self.mime
elif default is MIMEMultiSigWrapper:
self.default = self.multisig
elif default is InlineWrapper:
self.default = self.inline
else:
raise ValueError('Default wrapper must be one of ' +
MIMEWrapper.__name__ + ' ' +
MIMEMultiSigWrapper.__name__ + ' ' +
InlineWrapper.__name__ + '.')
def get_payload(self):
return self.default.get_payload()
def is_signed(self):
"""
Whether this message is signed.
:return: If the message is signed.
:rtype: bool
"""
return any(wrapper.is_signed() for wrapper in self.wrappers)
def has_signature(self):
"""
Whether some parts of the message are signed.
:return: If some parts of the message are signed.
:rtype: bool
"""
return any(wrapper.has_signature() for wrapper in self.wrappers)
def get_signed(self):
"""
Get the signed content of the message.
:return: The signed contents of the message.
:rtype: typing.Generator[str]
"""
if self.mime.is_signed():
yield from self.mime.get_signed()
elif self.multisig.is_signed():
yield from self.multisig.get_signed()
elif self.inline.is_signed():
yield from self.inline.get_signed()
def get_signature(self):
"""
:return:
:rtype: typing.Generator[pgpy.PGPMessage|pgpy.PGPSignature|
pgpy.PGPDetachedSignature]
"""
if self.mime.is_signed():
yield from self.mime.get_signature()
elif self.multisig.is_signed():
yield from self.multisig.get_signature()
elif self.inline.is_signed():
yield from self.inline.get_signature()
def sign(self, key, **kwargs):
"""
Sign a message with key.
:param key: The key to sign with.
:type key: pgpy.PGPKey
:param hash:
:type hash: HashAlgorithm
:return: The signed message.
:rtype: mailman.email.message.Message
"""
return self.default.sign(key, **kwargs)
def verify(self, key):
"""
Verify the signatures of this message with key.
:param key: The key to verify with.
:type key: pgpy.PGPKey
:return: The verified signatures.
:rtype: typing.Generator[pgpy.types.SignatureVerification]
"""
if self.mime.is_signed():
yield from self.mime.verify(key)
elif self.multisig.is_signed():
yield from self.multisig.verify(key)
elif self.inline.is_signed():
yield from self.inline.verify(key)
def verifies(self, key):
return verifies(self.verify(key))
def is_encrypted(self):
"""
Whether the message is encrypted.
:return: If the message is encrypted.
:rtype: bool
"""
return any(wrapper.is_encrypted() for wrapper in self.wrappers)
def has_encryption(self):
"""
Whether some parts of the message are encrypted.
:return: If some parts of the message are encrypted.
:rtype: bool
"""
return any(wrapper.has_encryption() for wrapper in self.wrappers)
def get_encrypted(self):
"""
:return:
:rtype: typing.Generator[pgpy.PGPMessage]
"""
if self.mime.is_encrypted():
yield from self.mime.get_encrypted()
elif self.multisig.is_encrypted():
yield from self.mime.get_encrypted()
elif self.inline.is_encrypted():
yield from self.inline.get_encrypted()
def encrypt(self, *keys, **kwargs):
"""
Encrypt the message with key/s, using cipher.
:param keys: The key/s to encrypt with.
:type keys: pgpy.PGPKey
:param cipher: The symmetric cipher to use.
:type cipher: SymmetricKeyAlgorithm
:return: The encrypted message.
:rtype: mailman.email.message.Message
"""
return self.default.encrypt(*keys, **kwargs)
def decrypt(self, key):
"""
Decrypt this message with key.
:param key: The key to decrypt with.
:type key: pgpy.PGPKey
:return: The decrypted message.
:rtype: mailman.email.message.Message
"""
if self.mime.is_encrypted():
return self.mime.decrypt(key)
elif self.multisig.is_encrypted():
return self.multisig.decrypt(key)
elif self.inline.is_encrypted():
return self.inline.decrypt(key)
def try_decrypt(self, key):
"""
:param key:
:return:
:rtype: mailman.email.message.Message
"""
try:
return self.decrypt(key)
except PGPError:
return copy.deepcopy(self.msg)
def sign_encrypt(self, key, *keys, **kwargs):
"""
Sign and encrypt the message, in one go.
:param key: The key to sign with.
:type key: pgpy.PGPKey
:param keys: The key/s to encrypt with.
:type keys: pgpy.PGPKey
:param hash:
:type hash: pgpy.constants.HashAlgorithm
:param cipher:
:type cipher: pgpy.constants.SymmetricKeyAlgorithm
:return: The signed + encrypted message.
:rtype: mailman.email.message.Message
"""
return self.default.sign_encrypt(key, *keys, **kwargs)
def sign_then_encrypt(self, key, *keys, **kwargs):
"""
Sign then encrypt the message.
:param key: The key to sign with.
:type key: pgpy.PGPKey
:param keys: The key/s to encrypt with.
:type keys: pgpy.PGPKey
:param hash:
:type hash: pgpy.constants.HashAlgorithm
:param cipher:
:type cipher: pgpy.constants.SymmetricKeyAlgorithm
:return: The signed + encrypted message.
:rtype: mailman.email.message.Message
"""
return self.default.sign_then_encrypt(key, *keys, **kwargs)
def is_keys(self):
"""
Whether the message is all keys (all parts).
:return: If the message is keys.
:rtype: bool
"""
return any(wrapper.is_keys() for wrapper in self.wrappers)
def has_keys(self):
"""
Whether the message contains public or private keys.
:return: If the message contains keys.
:rtype: bool
"""
return any(wrapper.has_keys() for wrapper in self.wrappers)
def keys(self):
"""
Get the collection of keys in this message.
:return: A collection of keys.
:rtype: Generator[pgpy.PGPKey]
"""
if self.mime.has_keys():
yield from self.mime.keys()
elif self.multisig.has_keys():
yield from self.multisig.keys()
elif self.inline.has_keys():
yield from self.inline.keys()
|
