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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
|
# -*- coding: utf-8 -*-
# test_keymanager.py
# Copyright (C) 2013 LEAP
#
# 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/>.
"""
Tests for the KeyManager.
"""
import json
import urllib
import tempfile
import pkg_resources
from datetime import datetime, date, timedelta
from twisted.internet import defer
from twisted.trial import unittest
from twisted.web._responses import NOT_FOUND
from twisted.web import client
import mock
from leap.common import ca_bundle
from leap.bitmask.keymanager import errors
from leap.bitmask.keymanager.keys import (
OpenPGPKey,
is_address,
build_key_from_dict,
)
from leap.bitmask.keymanager.validation import ValidationLevels
from leap.bitmask.keymanager.testing import KeyManagerWithSoledadTestCase
from common import (
ADDRESS,
ADDRESS_2,
KEY_FINGERPRINT,
PUBLIC_KEY,
PUBLIC_KEY_2,
PRIVATE_KEY,
PRIVATE_KEY_2,
ADDRESS_EXPIRING,
PRIVATE_EXPIRING_KEY,
NEW_PUB_KEY,
OLD_AND_NEW_KEY_ADDRESS,
DIFFERENT_PRIVATE_KEY,
DIFFERENT_KEY_FPR,
DIFFERENT_PUBLIC_KEY)
NICKSERVER_URI = "http://leap.se/"
REMOTE_KEY_URL = "http://site.domain/key"
INVALID_MAIL_ADDRESS = "notexistingemail@example.org"
class KeyManagerUtilTestCase(unittest.TestCase):
def test_is_address(self):
self.assertTrue(
is_address('user@leap.se'),
'Incorrect address detection.')
self.assertFalse(
is_address('userleap.se'),
'Incorrect address detection.')
self.assertFalse(
is_address('user@'),
'Incorrect address detection.')
self.assertFalse(
is_address('@leap.se'),
'Incorrect address detection.')
def test_build_key_from_dict(self):
kdict = {
'uids': [ADDRESS],
'fingerprint': KEY_FINGERPRINT,
'key_data': PUBLIC_KEY,
'private': False,
'length': 4096,
'expiry_date': 0,
'refreshed_at': 1311239602,
}
adict = {
'address': ADDRESS,
'private': False,
'last_audited_at': 0,
'validation': str(ValidationLevels.Weak_Chain),
'encr_used': False,
'sign_used': True,
}
key = build_key_from_dict(kdict, adict)
self.assertEqual(
kdict['uids'], key.uids,
'Wrong data in key.')
self.assertEqual(
kdict['fingerprint'], key.fingerprint,
'Wrong data in key.')
self.assertEqual(
kdict['key_data'], key.key_data,
'Wrong data in key.')
self.assertEqual(
kdict['private'], key.private,
'Wrong data in key.')
self.assertEqual(
kdict['length'], key.length,
'Wrong data in key.')
self.assertEqual(
None, key.expiry_date,
'Wrong data in key.')
self.assertEqual(
None, key.last_audited_at,
'Wrong data in key.')
self.assertEqual(
datetime.fromtimestamp(kdict['refreshed_at']), key.refreshed_at,
'Wrong data in key.')
self.assertEqual(
adict['address'], key.address,
'Wrong data in key.')
self.assertEqual(
ValidationLevels.get(adict['validation']), key.validation,
'Wrong data in key.')
self.assertEqual(
adict['encr_used'], key.encr_used,
'Wrong data in key.')
self.assertEqual(
adict['sign_used'], key.sign_used,
'Wrong data in key.')
class KeyManagerKeyManagementTestCase(KeyManagerWithSoledadTestCase):
@defer.inlineCallbacks
def _test_gen_key(self):
km = self._key_manager()
key = yield km.gen_key()
self.assertIsInstance(key, OpenPGPKey)
self.assertEqual(
'leap@leap.se', key.address, 'Wrong address bound to key.')
self.assertEqual(
4096, key.length, 'Wrong key length.')
@defer.inlineCallbacks
def test_get_all_keys_in_db(self):
km = self._key_manager()
yield km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
# get public keys
keys = yield km.get_all_keys(False)
self.assertEqual(len(keys), 1, 'Wrong number of keys')
self.assertTrue(ADDRESS in keys[0].uids)
self.assertFalse(keys[0].private)
# get private keys
keys = yield km.get_all_keys(True)
self.assertEqual(len(keys), 1, 'Wrong number of keys')
self.assertTrue(ADDRESS in keys[0].uids)
self.assertTrue(keys[0].private)
@defer.inlineCallbacks
def test_get_public_key(self):
km = self._key_manager()
yield km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
# get the key
key = yield km.get_key(ADDRESS, private=False, fetch_remote=False)
self.assertTrue(key is not None)
self.assertTrue(ADDRESS in key.uids)
self.assertEqual(
key.fingerprint.lower(), KEY_FINGERPRINT.lower())
self.assertFalse(key.private)
@defer.inlineCallbacks
def test_get_public_key_fetches_remotely_if_key_expired(self):
km = self._key_manager(user=ADDRESS_2)
km._nicknym.fetch_key_with_address = mock.Mock(
return_value=DIFFERENT_PUBLIC_KEY)
# put key
yield km._openpgp.put_raw_key(PUBLIC_KEY, ADDRESS)
# get the key
with mock.patch('leap.bitmask.keymanager.keys.OpenPGPKey.is_expired',
return_value=True):
key = yield km.get_key(ADDRESS, private=False,
fetch_remote=True)
km._nicknym.fetch_key_with_address.assert_called_once_with(ADDRESS)
self.assertTrue(key is not None)
self.assertEqual(
key.fingerprint.lower(), DIFFERENT_KEY_FPR.lower())
self.assertFalse(key.private)
@defer.inlineCallbacks
def test_get_expired_private_key_extends_expiration(self):
token = "mytoken"
km = self._key_manager(user=ADDRESS_EXPIRING, token=token)
km._nicknym.put_key = mock.Mock(return_value=defer.succeed(''))
yield km.put_raw_key(PRIVATE_EXPIRING_KEY, ADDRESS_EXPIRING)
key = yield km.get_key(ADDRESS_EXPIRING, private=True)
def assert_expiration_date(key):
expected = datetime.now() + timedelta(days=365)
self.assertTrue(expected - key.expiry_date < timedelta(days=1))
# check that the right key is returned with the expiration extended
self.assertTrue(key.private)
assert_expiration_date(key)
self.assertTrue(km._nicknym.put_key.called)
key_sent_data = km._nicknym.put_key.call_args[0][1]
key_sent_pub, key_sent_priv = km._openpgp.parse_key(key_sent_data)
self.assertTrue(key_sent_priv is None)
assert_expiration_date(key_sent_pub)
# check that the key in the keyring has the right expiration and
# a second get key doesn't try to extend the expiration again
km._nicknym.put_key = mock.Mock(return_value=defer.succeed(''))
pubkey = yield km.get_key(ADDRESS_EXPIRING)
privkey = yield km.get_key(ADDRESS_EXPIRING, private=True)
self.assertFalse(km._nicknym.put_key.called)
assert_expiration_date(privkey)
assert_expiration_date(pubkey)
@defer.inlineCallbacks
def test_get_public_key_with_binary_private_key(self):
km = self._key_manager()
yield km._openpgp.put_raw_key(self.get_private_binary_key(), ADDRESS)
# get the key
key = yield km.get_key(ADDRESS, private=False, fetch_remote=False)
self.assertTrue(key is not None)
self.assertTrue(ADDRESS in key.uids)
self.assertEqual(
key.fingerprint.lower(), KEY_FINGERPRINT.lower())
self.assertFalse(key.private)
@defer.inlineCallbacks
def test_get_private_key(self):
km = self._key_manager()
yield km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
# get the key
key = yield km.get_key(ADDRESS, private=True, fetch_remote=False)
self.assertTrue(key is not None)
self.assertTrue(ADDRESS in key.uids)
self.assertEqual(
key.fingerprint.lower(), KEY_FINGERPRINT.lower())
self.assertTrue(key.private)
@defer.inlineCallbacks
def test_get_inactive_private_key(self):
km = self._key_manager()
yield km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
yield km._openpgp.put_raw_key(DIFFERENT_PRIVATE_KEY, ADDRESS)
# get the key
inactive_keys = yield km._get_inactive_private_keys()
active_key = yield km.get_key(
ADDRESS, private=True, fetch_remote=False)
self.assertEqual(1, len(inactive_keys))
self.assertEqual(
inactive_keys[0].fingerprint.lower(), KEY_FINGERPRINT.lower())
self.assertEqual(
active_key.fingerprint.lower(), DIFFERENT_KEY_FPR.lower())
self.assertTrue(inactive_keys[0].private)
self.assertTrue(active_key.private)
self.assertFalse(inactive_keys[0].is_active())
self.assertTrue(active_key.is_active())
@defer.inlineCallbacks
def test_send_key(self):
"""
Test that request is well formed when sending keys to server.
"""
token = "mytoken"
km = self._key_manager(token=token)
yield km._openpgp.put_raw_key(PUBLIC_KEY, ADDRESS)
km._nicknym._async_client_pinned.request = \
mock.Mock(return_value=defer.succeed(''))
# the following data will be used on the send
km.ca_cert_path = 'capath'
km.session_id = 'sessionid'
km.uid = 'myuid'
km.api_uri = 'apiuri'
km.api_version = 'apiver'
yield km.send_key()
pubkey = yield km.get_key(ADDRESS, fetch_remote=False)
# setup expected args
data = urllib.urlencode({
km._nicknym.PUBKEY_KEY: pubkey.key_data,
})
headers = {'Authorization': [str('Token token=%s' % token)]}
headers['Content-Type'] = ['application/x-www-form-urlencoded']
url = '%s/%s/users/%s.json' % ('apiuri', 'apiver', 'myuid')
km._nicknym._async_client_pinned.request.assert_called_once_with(
str(url), 'PUT', body=str(data),
headers=headers
)
def test_fetch_keys_from_server(self):
"""
Test that the request is well formed when fetching keys from server
with address.
"""
km = self._key_manager(url=NICKSERVER_URI)
expected_url = NICKSERVER_URI + '?address=' + ADDRESS_2
def verify_the_call(_):
used_kwargs = km._nicknym._async_client_pinned.request.call_args[1]
km._nicknym._async_client_pinned.request.assert_called_once_with(
expected_url, 'GET', **used_kwargs)
d = self._fetch_key_with_address(km, ADDRESS_2, PUBLIC_KEY_2)
d.addCallback(verify_the_call)
return d
def test_fetch_keys_from_server_with_fingerprint(self):
"""
Test that the request is well formed when fetching keys from server
with fingerprint.
"""
km = self._key_manager(url=NICKSERVER_URI)
expected_url = NICKSERVER_URI + '?fingerprint=' + KEY_FINGERPRINT
def verify_the_call(_):
used_kwargs = km._nicknym._async_client_pinned.request.call_args[1]
km._nicknym._async_client_pinned.request.assert_called_once_with(
expected_url, 'GET', **used_kwargs)
d = self._fetch_key_with_fingerprint(km, KEY_FINGERPRINT, PUBLIC_KEY)
d.addCallback(verify_the_call)
return d
def test_key_not_found_is_raised_if_key_search_responds_404(self):
"""
Test if key search request comes back with a 404 response then
KeyNotFound is raised, with corresponding error message.
"""
km = self._key_manager(url=NICKSERVER_URI)
client.readBody = mock.Mock(return_value=defer.succeed(None))
km._nicknym._async_client_pinned.request = mock.Mock(
return_value=defer.succeed(None))
url = NICKSERVER_URI + '?address=' + INVALID_MAIL_ADDRESS
d = km._nicknym._fetch_and_handle_404_from_nicknym(url)
def check_key_not_found_is_raised_if_404(_):
used_kwargs = km._nicknym._async_client_pinned.request.call_args[1]
check_404_callback = used_kwargs['callback']
fake_response = mock.Mock()
fake_response.code = NOT_FOUND
with self.assertRaisesRegexp(errors.KeyNotFound,
'404: Key not found. Request: '
'%s' % url.replace('?', '\?')):
check_404_callback(fake_response)
d.addCallback(check_key_not_found_is_raised_if_404)
return d
def test_non_existing_key_from_nicknym_is_relayed(self):
"""
Test if key search requests throws KeyNotFound, the same error is
raised.
"""
km = self._key_manager(url=NICKSERVER_URI)
key_not_found_exception = errors.KeyNotFound('some message')
km._nicknym._async_client_pinned.request = mock.Mock(
side_effect=key_not_found_exception)
def assert_key_not_found_raised(error):
self.assertEqual(error.value, key_not_found_exception)
d = km._nicknym.fetch_key_with_address(INVALID_MAIL_ADDRESS)
d.addErrback(assert_key_not_found_raised)
@defer.inlineCallbacks
def test_get_key_fetches_from_server(self):
"""
Test that getting a key successfuly fetches from server.
"""
km = self._key_manager(user=ADDRESS_2, url=NICKSERVER_URI)
key = yield self._fetch_key_with_address(km, ADDRESS, PUBLIC_KEY)
self.assertIsInstance(key, OpenPGPKey)
self.assertTrue(ADDRESS in key.uids)
self.assertEqual(key.validation, ValidationLevels.Provider_Trust)
@defer.inlineCallbacks
def test_get_key_fetches_other_domain(self):
"""
Test that getting a key successfuly fetches from server.
"""
km = self._key_manager(url=NICKSERVER_URI)
key = yield self._fetch_key_with_address(km, ADDRESS_OTHER,
PUBLIC_KEY_OTHER)
self.assertIsInstance(key, OpenPGPKey)
self.assertTrue(ADDRESS_OTHER in key.uids)
self.assertEqual(key.validation, ValidationLevels.Weak_Chain)
def _fetch_key_with_address(self, km, address, key):
"""
:returns: a Deferred that will fire with the OpenPGPKey
"""
data = json.dumps({'address': address, 'openpgp': key})
client.readBody = mock.Mock(return_value=defer.succeed(data))
# mock the fetcher so it returns the key for ADDRESS_2
km._nicknym._async_client_pinned.request = mock.Mock(
return_value=defer.succeed(None))
km.ca_cert_path = 'cacertpath'
# try to key get without fetching from server
d_fail = km.get_key(address, fetch_remote=False)
d = self.assertFailure(d_fail, errors.KeyNotFound)
# try to get key fetching from server.
d.addCallback(lambda _: km.get_key(address))
return d
def _fetch_key_with_fingerprint(self, km, fingerprint, key):
"""
:returns: a Deferred that will fire with the OpenPGPKey
"""
data = json.dumps({'fingerprint': fingerprint, 'openpgp': key})
client.readBody = mock.Mock(return_value=defer.succeed(data))
# mock the fetcher so it returns the key for KEY_FINGERPRINT
km._nicknym._async_client_pinned.request = mock.Mock(
return_value=defer.succeed(None))
km.ca_cert_path = 'cacertpath'
key = km._nicknym.fetch_key_with_fingerprint(fingerprint)
return key
@defer.inlineCallbacks
def test_put_key_ascii(self):
"""
Test that putting ascii key works
"""
km = self._key_manager(user=ADDRESS_2, url=NICKSERVER_URI)
yield km.put_raw_key(PUBLIC_KEY, ADDRESS)
key = yield km.get_key(ADDRESS)
self.assertIsInstance(key, OpenPGPKey)
self.assertTrue(ADDRESS in key.uids)
@defer.inlineCallbacks
def test_put_key_binary(self):
"""
Test that putting binary key works
"""
km = self._key_manager(user=ADDRESS_2, url=NICKSERVER_URI)
yield km.put_raw_key(self.get_public_binary_key(), ADDRESS)
key = yield km.get_key(ADDRESS)
self.assertIsInstance(key, OpenPGPKey)
self.assertTrue(ADDRESS in key.uids)
@defer.inlineCallbacks
def test_fetch_uri_ascii_key(self):
"""
Test that fetch key downloads the ascii key and gets included in
the local storage
"""
km = self._key_manager()
km._async_client.request = \
mock.Mock(return_value=defer.succeed(PUBLIC_KEY))
yield km.fetch_key(ADDRESS, "http://site.domain/key")
key = yield km.get_key(ADDRESS)
self.assertEqual(KEY_FINGERPRINT, key.fingerprint)
@defer.inlineCallbacks
def test_fetch_uri_binary_key(self):
"""
Test that fetch key downloads the binary key and gets included in
the local storage
"""
km = self._key_manager()
km._async_client.request = mock.Mock(
return_value=defer.succeed(self.get_public_binary_key()))
yield km.fetch_key(ADDRESS, "http://site.domain/key")
key = yield km.get_key(ADDRESS)
self.assertEqual(KEY_FINGERPRINT, key.fingerprint)
def test_fetch_uri_empty_key(self):
"""
Test that fetch key raises KeyNotFound if no key in the url
"""
km = self._key_manager()
km._async_client.request = \
mock.Mock(return_value=defer.succeed(""))
d = km.fetch_key(ADDRESS, "http://site.domain/key")
return self.assertFailure(d, errors.KeyNotFound)
def test_fetch_uri_address_differ(self):
"""
Test that fetch key raises KeyAttributesDiffer if the address
don't match
"""
km = self._key_manager()
km._async_client.request = \
mock.Mock(return_value=defer.succeed(PUBLIC_KEY))
d = km.fetch_key(ADDRESS_2, "http://site.domain/key")
return self.assertFailure(d, errors.KeyAddressMismatch)
def _mock_get_response(self, km, body):
km._async_client.request = mock.MagicMock(
return_value=defer.succeed(body))
return km._async_client.request
@defer.inlineCallbacks
def test_fetch_key_uses_ca_bundle_if_none_specified(self):
ca_cert_path = None
km = self._key_manager(ca_cert_path=ca_cert_path)
get_mock = self._mock_get_response(km, PUBLIC_KEY_OTHER)
yield km.fetch_key(ADDRESS_OTHER, REMOTE_KEY_URL)
get_mock.assert_called_once_with(REMOTE_KEY_URL, 'GET')
@defer.inlineCallbacks
def test_fetch_key_uses_ca_bundle_if_empty_string_specified(self):
ca_cert_path = None
km = self._key_manager(ca_cert_path=ca_cert_path)
get_mock = self._mock_get_response(km, PUBLIC_KEY_OTHER)
yield km.fetch_key(ADDRESS_OTHER, REMOTE_KEY_URL)
get_mock.assert_called_once_with(REMOTE_KEY_URL, 'GET')
@defer.inlineCallbacks
def test_fetch_key_use_default_ca_bundle_if_set_as_ca_cert_path(self):
ca_cert_path = ca_bundle.where()
km = self._key_manager(ca_cert_path=ca_cert_path)
get_mock = self._mock_get_response(km, PUBLIC_KEY_OTHER)
yield km.fetch_key(ADDRESS_OTHER, REMOTE_KEY_URL)
get_mock.assert_called_once_with(REMOTE_KEY_URL, 'GET')
@defer.inlineCallbacks
def test_fetch_uses_combined_ca_bundle_otherwise(self):
with tempfile.NamedTemporaryFile() as tmp_input, \
tempfile.NamedTemporaryFile(delete=False) as tmp_output:
ca_content = pkg_resources.resource_string('leap.common.testing',
'cacert.pem')
ca_cert_path = tmp_input.name
self._dump_to_file(ca_cert_path, ca_content)
pth = 'leap.bitmask.keymanager.tempfile.NamedTemporaryFile'
with mock.patch(pth) as mocked:
mocked.return_value = tmp_output
km = self._key_manager(ca_cert_path=ca_cert_path)
get_mock = self._mock_get_response(km, PUBLIC_KEY_OTHER)
yield km.fetch_key(ADDRESS_OTHER, REMOTE_KEY_URL)
# assert that combined bundle file is passed to get call
get_mock.assert_called_once_with(REMOTE_KEY_URL, 'GET')
# assert that files got appended
expected = self._slurp_file(ca_bundle.where()) + ca_content
self.assertEqual(expected, self._slurp_file(tmp_output.name))
def _dump_to_file(self, filename, content):
with open(filename, 'w') as out:
out.write(content)
def _slurp_file(self, filename):
with open(filename) as f:
content = f.read()
return content
@defer.inlineCallbacks
def test_decrypt_updates_sign_used_for_signer(self):
# given
km = self._key_manager()
yield km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
yield km._openpgp.put_raw_key(PRIVATE_KEY_2, ADDRESS_2)
encdata = yield km.encrypt('data', ADDRESS, sign=ADDRESS_2,
fetch_remote=False)
yield km.decrypt(
encdata, ADDRESS, verify=ADDRESS_2, fetch_remote=False)
# when
key = yield km.get_key(ADDRESS_2, fetch_remote=False)
# then
self.assertEqual(True, key.sign_used)
@defer.inlineCallbacks
def test_decrypt_does_not_update_sign_used_for_recipient(self):
# given
km = self._key_manager()
yield km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
yield km._openpgp.put_raw_key(PRIVATE_KEY_2, ADDRESS_2)
encdata = yield km.encrypt('data', ADDRESS, sign=ADDRESS_2,
fetch_remote=False)
yield km.decrypt(
encdata, ADDRESS, verify=ADDRESS_2, fetch_remote=False)
# when
key = yield km.get_key(
ADDRESS, private=False, fetch_remote=False)
# then
self.assertEqual(False, key.sign_used)
def test_put_pubkey_address_fails(self):
km = self._key_manager()
d = km.put_raw_key(PUBLIC_KEY, ADDRESS)
return self.assertFailure(d, errors.KeyNotValidUpgrade)
@defer.inlineCallbacks
def test_put_privkey_address_sends(self):
km = self._key_manager()
km.send_key = mock.Mock()
yield km.put_raw_key(PRIVATE_KEY, ADDRESS)
km.send_key.assert_called_once_with()
class KeyManagerCryptoTestCase(KeyManagerWithSoledadTestCase):
RAW_DATA = 'data'
@defer.inlineCallbacks
def test_keymanager_openpgp_encrypt_decrypt(self):
km = self._key_manager()
# put raw private key
yield km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
yield km._openpgp.put_raw_key(PRIVATE_KEY_2, ADDRESS_2)
# encrypt
encdata = yield km.encrypt(self.RAW_DATA, ADDRESS, sign=ADDRESS_2,
fetch_remote=False)
self.assertNotEqual(self.RAW_DATA, encdata)
# decrypt
rawdata, signingkey = yield km.decrypt(
encdata, ADDRESS, verify=ADDRESS_2, fetch_remote=False)
self.assertEqual(self.RAW_DATA, rawdata)
key = yield km.get_key(ADDRESS_2, private=False, fetch_remote=False)
self.assertEqual(signingkey.fingerprint, key.fingerprint)
@defer.inlineCallbacks
def test_keymanager_decryption_tries_inactive_valid_key(self):
km = self._key_manager()
# put raw private key
yield km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
yield km._openpgp.put_raw_key(PRIVATE_KEY_2, ADDRESS_2)
# encrypt
encdata = yield km.encrypt(self.RAW_DATA, ADDRESS, sign=ADDRESS_2,
fetch_remote=False)
self.assertNotEqual(self.RAW_DATA, encdata)
# decrypt
rawdata, signingkey = yield km.decrypt(
encdata, ADDRESS, verify=ADDRESS_2, fetch_remote=False)
self.assertEqual(self.RAW_DATA, rawdata)
key = yield km.get_key(ADDRESS_2, private=False, fetch_remote=False)
self.assertEqual(signingkey.fingerprint, key.fingerprint)
@defer.inlineCallbacks
def test_decrypt_throws_error_when_all_keys_fails(self):
km = self._key_manager()
# put raw private key
yield km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
yield km._openpgp.put_raw_key(PRIVATE_KEY_2, ADDRESS_2)
# decrypt
with self.assertRaises(errors.DecryptError):
yield km.decrypt(ENCRYPTED_MESSAGE_FOR_DIFFERENT_KEY,
ADDRESS, verify=ADDRESS_2, fetch_remote=False)
@defer.inlineCallbacks
def test_keymanager_openpgp_encrypt_decrypt_wrong_sign(self):
km = self._key_manager()
# put raw keys
yield km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
yield km._openpgp.put_raw_key(PRIVATE_KEY_2, ADDRESS_2)
# encrypt
encdata = yield km.encrypt(self.RAW_DATA, ADDRESS, sign=ADDRESS_2,
fetch_remote=False)
self.assertNotEqual(self.RAW_DATA, encdata)
# verify
rawdata, signingkey = yield km.decrypt(
encdata, ADDRESS, verify=ADDRESS, fetch_remote=False)
self.assertEqual(self.RAW_DATA, rawdata)
self.assertTrue(isinstance(signingkey, errors.InvalidSignature))
@defer.inlineCallbacks
def test_keymanager_openpgp_sign_verify(self):
km = self._key_manager()
# put raw private keys
yield km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
signdata = yield km.sign(self.RAW_DATA, ADDRESS, detach=False)
self.assertNotEqual(self.RAW_DATA, signdata)
# verify
signingkey = yield km.verify(signdata, ADDRESS, fetch_remote=False)
key = yield km.get_key(ADDRESS, private=False, fetch_remote=False)
self.assertEqual(signingkey.fingerprint, key.fingerprint)
def test_keymanager_encrypt_key_not_found(self):
km = self._key_manager()
d = km._openpgp.put_raw_key(PRIVATE_KEY, ADDRESS)
d.addCallback(
lambda _: km.encrypt(self.RAW_DATA, ADDRESS_2, sign=ADDRESS,
fetch_remote=False))
return self.assertFailure(d, errors.KeyNotFound)
@defer.inlineCallbacks
def test_fetch_key_fingerprint(self):
km = self._key_manager(user=ADDRESS_2)
km._nicknym.fetch_key_with_fingerprint = mock.Mock(
return_value=defer.succeed(PUBLIC_KEY))
yield km.fetch_key_fingerprint(ADDRESS, KEY_FINGERPRINT)
key = yield km.get_key(ADDRESS, fetch_remote=False)
self.assertEqual(key.fingerprint, KEY_FINGERPRINT)
def test_fetch_key_fingerprint_wrong_fp(self):
km = self._key_manager(user=ADDRESS_2)
km._nicknym.fetch_key_with_fingerprint = mock.Mock(
return_value=defer.succeed(NEW_PUB_KEY))
d = km.fetch_key_fingerprint(OLD_AND_NEW_KEY_ADDRESS, KEY_FINGERPRINT)
return self.assertFailure(d, errors.KeyNotFound)
@defer.inlineCallbacks
def test_fetch_key_fingerprint_keep_usage(self):
km = self._key_manager(user=ADDRESS_2)
key, _ = km._openpgp.parse_key(PUBLIC_KEY, ADDRESS)
key.sign_used = True
yield km.put_key(key)
km._nicknym.fetch_key_with_fingerprint = mock.Mock(
return_value=defer.succeed(PUBLIC_KEY))
yield km.fetch_key_fingerprint(ADDRESS, KEY_FINGERPRINT)
key = yield km.get_key(ADDRESS, fetch_remote=False)
self.assertEqual(key.fingerprint, KEY_FINGERPRINT)
self.assertTrue(key.sign_used)
self.assertFalse(key.encr_used)
if __name__ == "__main__":
import unittest
unittest.main()
# key 0F91B402: someone@somedomain.org
# 9420 EC7B 6DCB 867F 5592 E6D1 7504 C974 0F91 B402
ADDRESS_OTHER = "someone@somedomain.org"
PUBLIC_KEY_OTHER = """
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v1
mQENBFUZFLwBCADRzTstykRAV3aWysLAV4O3DXdpXhV3Cww8Pfc6m1bVxAT2ifcL
kLWEaIkOB48SYIHbYzqOi1/h5abJf+5n4uhaIks+FsjsXYo1XOiYpVCNf7+xLnUM
jkmglKT5sASr61QDcFMqWfGTJ8iUTNVCJZ2k14QJ4Vss/ntnV9uB7Ef7wU7RZvxr
wINH/0LfKPsGE9l2qNpKUAAmg2bHn9YdsHj1sqlW7eZpwvefYrQej4KBaL2oq3vt
QQOdXGFqWYMe3cX+bQ1DAMG3ttTF6EGkY97BK7A18I/RJiLujWCEAkMzFr5SK9KU
AOMj6MpjfTOE+GfUKsu7/gGt42eMBFsIOvsZABEBAAG0IFNvbWVvbmUgPHNvbWVv
bmVAc29tZWRvbWFpbi5vcmc+iQE4BBMBAgAiBQJVGRS8AhsDBgsJCAcDAgYVCAIJ
CgsEFgIDAQIeAQIXgAAKCRB1BMl0D5G0AlFsCAC33LhxBRwO64T6DgTb4/39aLpi
9T3yAmXBAHC7Q+4f37IBX5fJBRKu4Lvfp6KherOl/I/Jj34yv8pm0j+kXeWktfxZ
cW+mv2vjBHQVopiUSyMVh7caFSq9sKm+oQdo6oIl9DHSARegbkCn2+0b4VxgJpyj
TZBMyUMD2AayivQU4QHOM3KCozhLNNDbpKy7LH0MSAUDmRaJsPk1zK15lQocK/7R
Z5yF4rdrdzDWrVucZJc09yntSqTGECue3W2GBCaBlb/O1c9xei4MTb4nSHS5Gp/7
hcjrvIrgPpehndk8ZRREN/Y8uk1W5fbWzx+5z8g31RCGWBQw4NAnG10NZ3oEuQEN
BFUZFLwBCADocYZmLu1iXIE6gKqniR6Z8UDC5XnqgK+BEJwi1abe9zWhjgKeW9Vv
u1i194wuCUiNkP/bMvwMBZLTslDzqxl32ETk9FvB3kWy80S8MDjQJ15IN4I622fq
MEWwtQ0WrRay9VV6M8H2mIf71/1d5T9ysWK4XRyv+N7eRhfg7T2uhrpNyKdCZzjq
2wlgpVkMY7gtxTqJseM+qS5UNiReGxtoOXFLzzmagFgbqK88eMeZJZt8yKf81xhP
SWLTxaVaeBEAlajvEkxZJrrDQuc+maTwtMxmNUe815wJnpcRF8VD91GUpSLAN6EC
1QuJUl6Lc2o2tcHeo6CGsDZ96o0J8pFhABEBAAGJAR8EGAECAAkFAlUZFLwCGwwA
CgkQdQTJdA+RtAKcdwgApzHPhwwaZ9TBjgOytke/hPE0ht/EJ5nRiIda2PucoPh6
DwnaI8nvmGXUfC4qFy6LM8/fJHof1BqLnMbx8MCLurnm5z30q8RhLE3YWM11zuMy
6wkHGmi/6S1G4okC+Uu8AA4K//HBo8bLcqGVWRnFAmCqy6VMAofsQvmM7vHbRj56
U919Bki/7I6kcxPEzO73Umh3o82VP/Hz3JMigRNBRfG3jPrX04RLJj3Ib5lhQIDw
XrO8VHz9foOpY+rJnWj+6QAozxorzZYShu6H0GR1nIuqWMwli1nrx6BeIJAVz5cg
QzEd9yAN+81fkIBaa6Y8LCBxV03JCc2J4eCUKXd1gg==
=gDzy
-----END PGP PUBLIC KEY BLOCK-----
"""
ENCRYPTED_MESSAGE_FOR_DIFFERENT_KEY = """
-----BEGIN PGP MESSAGE-----
hQEMAyIGRJSVjm17AQf/fyQrbcUKhy4Zv0UBsMFNdLj3h6YYkhkDecupmNeJzgSc
IeW8E5Un5thGpJRCF1iC3XirzybQxCEDCqVZdibXY/K0D5eQAE95m3Bc2euZN3sm
br4Ro/ybf/+0mt+cyPrvoaU/c/RKCWAXGDrTNCLe9f4UkwdiRj5tBpdC6WNEgsTD
SJfpZF5xP+NMc0cBRmSnUZHMgspbBK1OYmQurxn8vjyxDXwJuJ9sWl+FrWop3WMW
l/IMSSgyaJUjHvau6WNzRhKLujhuqyZKWo0WuJdBT0lPM0aQCJls4QVpDwE9mTZy
Vm2M4VnrxP9/IMqCrevwJXQTIKgIz9ANif+iZdHWYNLALAGgnH+45wXeguhFP1vD
x3SVIgOp8aAW7Plf5IO/bRQBs/LTvS1HWkD07WW14NJ29eMTPgoSR/lTGNMbHGYH
EgqRxJIsH93A+fN+CQoPboaEW/0hhQVf0WO/b8soxhVwZDDPMI3qGAQBwrBD3N9z
ksEUD5XNT+6mtMpTSpPr/0j0W7LjqR5QT+Bf2lUiFLH8XwekO0JK/vq5XkTydiAw
ZZBCPpoBxM/gH3cMuFafZNbqE6KDd7UziKxZCR17SrDFjrK/BLMrRKXRSnZOQNsb
WuLF0jIGxN6NiaduJ77gmrOieuBu0wKqv0iAvo8s
=G2sp
-----END PGP MESSAGE-----
"""
|