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
|
# Copyright (C) 2017 Jan Jancar
#
# 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/>.
""""""
import unittest
from contextlib import suppress
from unittest.mock import patch
from mailman.app.lifecycle import create_list
from mailman.interfaces.pending import IPendings
from mailman.interfaces.usermanager import IUserManager
from mailman.interfaces.workflows import IWorkflow
from mailman.testing.helpers import get_queue_messages
from mailman.workflows.common import SubscriptionBase
from public import public
from zope.component import getUtility
from zope.interface import implementer
from mailman_pgp.database import mm_transaction, transaction
from mailman_pgp.model.address import PGPAddress
from mailman_pgp.model.list import PGPMailingList
from mailman_pgp.pgp.tests.base import load_key
from mailman_pgp.pgp.wrapper import PGPWrapper
from mailman_pgp.testing.layers import PGPConfigLayer
from mailman_pgp.workflows.base import (PGPMixin)
from mailman_pgp.workflows.pubkey import (KEY_REQUEST, SetPubkeyMixin,
ConfirmPubkeyMixin)
class PubkeyMixinTestSetup():
def setUp(self):
with mm_transaction():
self.mlist = create_list('test@example.com',
style_name='pgp-default')
self.list_key = load_key('ecc_p256.priv.asc')
self.pgp_list = PGPMailingList.for_list(self.mlist)
self.pgp_list.key = self.list_key
self.um = getUtility(IUserManager)
self.sender_key = load_key('rsa_1024.priv.asc')
self.sender = self.um.create_address('rsa-1024b@example.org')
@implementer(IWorkflow)
class PGPTestWorkflow(SubscriptionBase, PGPMixin, SetPubkeyMixin,
ConfirmPubkeyMixin):
name = 'test-workflow'
description = ''
initial_state = 'prepare'
save_attributes = (
'pubkey_key',
'pubkey_confirmed',
'address_key',
'subscriber_key',
'user_key',
'token_owner_key'
)
def __init__(self, mlist, subscriber=None, *, pubkey=None,
pubkey_pre_confirmed=False):
SubscriptionBase.__init__(self, mlist, subscriber)
SetPubkeyMixin.__init__(self, pubkey=pubkey)
ConfirmPubkeyMixin.__init__(self, pre_confirmed=pubkey_pre_confirmed)
PGPMixin.__init__(self)
def _step_prepare(self):
self.push('do_subscription')
self.push('pubkey_confirmation')
self.push('pubkey_checks')
self.push('pgp_prepare')
self.push('sanity_checks')
@public
class TestPGPMixin(PubkeyMixinTestSetup, unittest.TestCase):
layer = PGPConfigLayer
def test_create_address(self):
workflow = PGPTestWorkflow(self.mlist, self.sender)
workflow.run_thru('pgp_prepare')
pgp_address = PGPAddress.for_address(self.sender)
self.assertIsNotNone(pgp_address)
def test_address_existing(self):
workflow = PGPTestWorkflow(self.mlist, self.sender)
with transaction() as t:
pgp_address = PGPAddress(self.sender)
t.add(pgp_address)
workflow.run_thru('pgp_prepare')
still = PGPAddress.for_address(self.sender)
self.assertIsNotNone(still)
@public
class TestSetPubkeyMixin(PubkeyMixinTestSetup, unittest.TestCase):
layer = PGPConfigLayer
def test_key_request_sent(self):
workflow = PGPTestWorkflow(self.mlist, self.sender)
list(workflow)
items = get_queue_messages('virgin', expected_count=1)
message = items[0].msg
token = workflow.token
self.assertEqual(message['Subject'], 'key set {}'.format(token))
self.assertEqual(message.get_payload(), KEY_REQUEST)
def test_receive_key(self):
workflow = PGPTestWorkflow(self.mlist, self.sender)
list(workflow)
with transaction():
pgp_address = PGPAddress.for_address(self.sender)
pgp_address.key = self.sender_key.pubkey
receive_workflow = PGPTestWorkflow(self.mlist)
receive_workflow.token = workflow.token
receive_workflow.restore()
receive_workflow.run_thru('receive_key')
def test_set_pubkey(self):
workflow = PGPTestWorkflow(self.mlist, self.sender,
pubkey=self.sender_key.pubkey)
workflow.run_thru('pubkey_checks')
pgp_address = PGPAddress.for_address(self.sender)
self.assertIsNotNone(pgp_address)
self.assertIsNotNone(pgp_address.key)
self.assertEqual(pgp_address.key_fingerprint,
self.sender_key.fingerprint)
def test_pubkey_set(self):
workflow = PGPTestWorkflow(self.mlist, self.sender)
with transaction() as t:
pgp_address = PGPAddress(self.sender)
pgp_address.key = self.sender_key.pubkey
t.add(pgp_address)
workflow.run_thru('pubkey_checks')
self.assertEqual(pgp_address.key_fingerprint,
self.sender_key.fingerprint)
@public
class TestConfirmPubkeyMixin(PubkeyMixinTestSetup, unittest.TestCase):
layer = PGPConfigLayer
def test_key_request_pubkey_set(self):
workflow = PGPTestWorkflow(self.mlist, self.sender,
pubkey=self.sender_key.pubkey,
pubkey_pre_confirmed=True)
workflow.run_thru('pubkey_confirmation')
with patch.object(workflow, '_step_do_subscription') as step:
next(workflow)
step.assert_called_once_with()
def test_send_key_confirm_request(self):
workflow = PGPTestWorkflow(self.mlist, self.sender,
pubkey=self.sender_key.pubkey,
pubkey_pre_confirmed=False)
list(workflow)
items = get_queue_messages('virgin', expected_count=1)
message = items[0].msg
token = workflow.token
self.assertEqual(message['Subject'], 'key confirm {}'.format(token))
wrapped = PGPWrapper(message)
self.assertTrue(wrapped.is_encrypted())
def test_receive_confirmation(self):
workflow = PGPTestWorkflow(self.mlist, self.sender,
pubkey=self.sender_key.pubkey,
pubkey_pre_confirmed=False)
list(workflow)
receive_workflow = PGPTestWorkflow(self.mlist)
receive_workflow.token = workflow.token
receive_workflow.restore()
receive_workflow.run_thru('receive_key_confirmation')
with patch.object(receive_workflow, '_step_do_subscription') as step:
next(receive_workflow)
step.assert_called_once_with()
@public
class TestBothPubkeyMixins(PubkeyMixinTestSetup, unittest.TestCase):
layer = PGPConfigLayer
def test_pended_data_key_request(self):
workflow = PGPTestWorkflow(self.mlist, self.sender)
with suppress(StopIteration):
workflow.run_thru('send_key_request')
self.assertIsNotNone(workflow.token)
pendable = getUtility(IPendings).confirm(workflow.token, expunge=False)
self.assertEqual(pendable['list_id'], 'test.example.com')
self.assertEqual(pendable['email'], 'rsa-1024b@example.org')
self.assertEqual(pendable['display_name'], '')
self.assertEqual(pendable['when'], '2005-08-01T07:49:23')
self.assertEqual(pendable['token_owner'], 'subscriber')
def test_pended_data_key_confirmation(self):
workflow = PGPTestWorkflow(self.mlist, self.sender,
pubkey=self.sender_key.pubkey)
with suppress(StopIteration):
workflow.run_thru('send_key_confirm_request')
self.assertIsNotNone(workflow.token)
pendable = getUtility(IPendings).confirm(workflow.token, expunge=False)
self.assertEqual(pendable['list_id'], 'test.example.com')
self.assertEqual(pendable['email'], 'rsa-1024b@example.org')
self.assertEqual(pendable['display_name'], '')
self.assertEqual(pendable['when'], '2005-08-01T07:49:23')
self.assertEqual(pendable['token_owner'], 'subscriber')
def test_exisitng_pgp_address(self):
workflow = PGPTestWorkflow(self.mlist, self.sender)
with transaction() as t:
pgp_address = PGPAddress(self.sender)
pgp_address.key = self.sender_key.pubkey
pgp_address.key_confirmed = True
t.add(pgp_address)
workflow.run_thru('pubkey_confirmation')
with patch.object(workflow, '_step_do_subscription') as step:
next(workflow)
step.assert_called_once_with()
def test_exisitng_pgp_address_not_confirmed(self):
workflow = PGPTestWorkflow(self.mlist, self.sender)
with transaction() as t:
pgp_address = PGPAddress(self.sender)
pgp_address.key = self.sender_key.pubkey
t.add(pgp_address)
workflow.run_thru('pubkey_confirmation')
with patch.object(workflow, '_step_send_key_confirm_request') as step:
next(workflow)
step.assert_called_once_with()
def test_exisitng_pgp_address_no_key(self):
workflow = PGPTestWorkflow(self.mlist, self.sender)
with transaction() as t:
pgp_address = PGPAddress(self.sender)
t.add(pgp_address)
workflow.run_thru('pubkey_checks')
with patch.object(workflow, '_step_send_key_request') as step:
next(workflow)
step.assert_called_once_with()
|
