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
|
# -*- coding: utf-8 -*-
# test_soledad.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 general Soledad functionality.
"""
import os
from mock import Mock
from leap.common.events import catalog
from leap.soledad.common.tests.util import (
BaseSoledadTest,
ADDRESS,
)
from leap import soledad
from leap.soledad.common.document import SoledadDocument
from leap.soledad.common.crypto import WrongMacError
from leap.soledad.client import Soledad
from leap.soledad.client.adbapi import U1DBConnectionPool
from leap.soledad.client.secrets import PassphraseTooShort
from leap.soledad.client.shared_db import SoledadSharedDatabase
class AuxMethodsTestCase(BaseSoledadTest):
def test__init_dirs(self):
sol = self._soledad_instance(prefix='_init_dirs')
local_db_dir = os.path.dirname(sol.local_db_path)
secrets_path = os.path.dirname(sol.secrets.secrets_path)
self.assertTrue(os.path.isdir(local_db_dir))
self.assertTrue(os.path.isdir(secrets_path))
def _close_soledad(results):
sol.close()
d = sol.create_doc({})
d.addCallback(_close_soledad)
return d
def test__init_u1db_sqlcipher_backend(self):
sol = self._soledad_instance(prefix='_init_db')
self.assertIsInstance(sol._dbpool, U1DBConnectionPool)
self.assertTrue(os.path.isfile(sol.local_db_path))
sol.close()
def test__init_config_with_defaults(self):
"""
Test if configuration defaults point to the correct place.
"""
class SoledadMock(Soledad):
def __init__(self):
pass
# instantiate without initializing so we just test
# _init_config_with_defaults()
sol = SoledadMock()
sol._passphrase = u''
sol._server_url = ''
sol._init_config_with_defaults()
# assert value of local_db_path
self.assertEquals(
os.path.join(sol.default_prefix, 'soledad.u1db'),
sol.local_db_path)
def test__init_config_from_params(self):
"""
Test if configuration is correctly read from file.
"""
sol = self._soledad_instance(
'leap@leap.se',
passphrase=u'123',
secrets_path='value_3',
local_db_path='value_2',
server_url='value_1',
cert_file=None)
self.assertEqual(
os.path.join(self.tempdir, 'value_3'),
sol.secrets.secrets_path)
self.assertEqual(
os.path.join(self.tempdir, 'value_2'),
sol.local_db_path)
self.assertEqual('value_1', sol._server_url)
sol.close()
def test_change_passphrase(self):
"""
Test if passphrase can be changed.
"""
prefix = '_change_passphrase'
sol = self._soledad_instance(
'leap@leap.se',
passphrase=u'123',
prefix=prefix,
)
def _change_passphrase(doc1):
self._doc1 = doc1
sol.change_passphrase(u'654321')
sol.close()
def _assert_wrong_password_raises(results):
self.assertRaises(
WrongMacError,
self._soledad_instance, 'leap@leap.se',
passphrase=u'123',
prefix=prefix)
def _instantiate_with_new_passphrase(results):
sol2 = self._soledad_instance(
'leap@leap.se',
passphrase=u'654321',
prefix=prefix)
self._sol2 = sol2
return sol2.get_doc(self._doc1.doc_id)
def _assert_docs_are_equal(doc2):
self.assertEqual(self._doc1, doc2)
self._sol2.close()
d = sol.create_doc({'simple': 'doc'})
d.addCallback(_change_passphrase)
d.addCallback(_assert_wrong_password_raises)
d.addCallback(_instantiate_with_new_passphrase)
d.addCallback(_assert_docs_are_equal)
d.addCallback(lambda _: sol.close())
return d
def test_change_passphrase_with_short_passphrase_raises(self):
"""
Test if attempt to change passphrase passing a short passphrase
raises.
"""
sol = self._soledad_instance(
'leap@leap.se',
passphrase=u'123')
# check that soledad complains about new passphrase length
self.assertRaises(
PassphraseTooShort,
sol.change_passphrase, u'54321')
sol.close()
def test_get_passphrase(self):
"""
Assert passphrase getter works fine.
"""
sol = self._soledad_instance()
self.assertEqual('123', sol._passphrase)
sol.close()
class SoledadSharedDBTestCase(BaseSoledadTest):
"""
These tests ensure the functionalities of the shared recovery database.
"""
def setUp(self):
BaseSoledadTest.setUp(self)
self._shared_db = SoledadSharedDatabase(
'https://provider/', ADDRESS, document_factory=SoledadDocument,
creds=None)
def tearDown(self):
BaseSoledadTest.tearDown(self)
def test__get_secrets_from_shared_db(self):
"""
Ensure the shared db is queried with the correct doc_id.
"""
doc_id = self._soledad.secrets._shared_db_doc_id()
self._soledad.secrets._get_secrets_from_shared_db()
self.assertTrue(
self._soledad.shared_db.get_doc.assert_called_with(
doc_id) is None,
'Wrong doc_id when fetching recovery document.')
def test__put_secrets_in_shared_db(self):
"""
Ensure recovery document is put into shared recover db.
"""
doc_id = self._soledad.secrets._shared_db_doc_id()
self._soledad.secrets._put_secrets_in_shared_db()
self.assertTrue(
self._soledad.shared_db.get_doc.assert_called_with(
doc_id) is None,
'Wrong doc_id when fetching recovery document.')
self.assertTrue(
self._soledad.shared_db.put_doc.assert_called_with(
self._doc_put) is None,
'Wrong document when putting recovery document.')
self.assertTrue(
self._doc_put.doc_id == doc_id,
'Wrong doc_id when putting recovery document.')
class SoledadSignalingTestCase(BaseSoledadTest):
"""
These tests ensure signals are correctly emmited by Soledad.
"""
EVENTS_SERVER_PORT = 8090
def setUp(self):
# mock signaling
soledad.client.signal = Mock()
soledad.client.secrets.events.emit = Mock()
# run parent's setUp
BaseSoledadTest.setUp(self)
def tearDown(self):
BaseSoledadTest.tearDown(self)
def _pop_mock_call(self, mocked):
mocked.call_args_list.pop()
mocked.mock_calls.pop()
mocked.call_args = mocked.call_args_list[-1]
def test_stage3_bootstrap_signals(self):
"""
Test that a fresh soledad emits all bootstrap signals.
Signals are:
- downloading keys / done downloading keys.
- creating keys / done creating keys.
- downloading keys / done downloading keys.
- uploading keys / done uploading keys.
"""
soledad.client.secrets.events.emit.reset_mock()
# get a fresh instance so it emits all bootstrap signals
sol = self._soledad_instance(
secrets_path='alternative_stage3.json',
local_db_path='alternative_stage3.u1db')
# reverse call order so we can verify in the order the signals were
# expected
soledad.client.secrets.events.emit.mock_calls.reverse()
soledad.client.secrets.events.emit.call_args = \
soledad.client.secrets.events.emit.call_args_list[0]
soledad.client.secrets.events.emit.call_args_list.reverse()
# downloading keys signals
soledad.client.secrets.events.emit.assert_called_with(
catalog.SOLEDAD_DOWNLOADING_KEYS,
ADDRESS,
)
self._pop_mock_call(soledad.client.secrets.events.emit)
soledad.client.secrets.events.emit.assert_called_with(
catalog.SOLEDAD_DONE_DOWNLOADING_KEYS,
ADDRESS,
)
# creating keys signals
self._pop_mock_call(soledad.client.secrets.events.emit)
soledad.client.secrets.events.emit.assert_called_with(
catalog.SOLEDAD_CREATING_KEYS,
ADDRESS,
)
self._pop_mock_call(soledad.client.secrets.events.emit)
soledad.client.secrets.events.emit.assert_called_with(
catalog.SOLEDAD_DONE_CREATING_KEYS,
ADDRESS,
)
# downloading once more (inside _put_keys_in_shared_db)
self._pop_mock_call(soledad.client.secrets.events.emit)
soledad.client.secrets.events.emit.assert_called_with(
catalog.SOLEDAD_DOWNLOADING_KEYS,
ADDRESS,
)
self._pop_mock_call(soledad.client.secrets.events.emit)
soledad.client.secrets.events.emit.assert_called_with(
catalog.SOLEDAD_DONE_DOWNLOADING_KEYS,
ADDRESS,
)
# uploading keys signals
self._pop_mock_call(soledad.client.secrets.events.emit)
soledad.client.secrets.events.emit.assert_called_with(
catalog.SOLEDAD_UPLOADING_KEYS,
ADDRESS,
)
self._pop_mock_call(soledad.client.secrets.events.emit)
soledad.client.secrets.events.emit.assert_called_with(
catalog.SOLEDAD_DONE_UPLOADING_KEYS,
ADDRESS,
)
# assert db was locked and unlocked
sol.shared_db.lock.assert_called_with()
sol.shared_db.unlock.assert_called_with('atoken')
sol.close()
def test_stage2_bootstrap_signals(self):
"""
Test that if there are keys in server, soledad will download them and
emit corresponding signals.
"""
# get existing instance so we have access to keys
sol = self._soledad_instance()
# create a document with secrets
doc = SoledadDocument(doc_id=sol.secrets._shared_db_doc_id())
doc.content = sol.secrets._export_recovery_document()
sol.close()
# reset mock
soledad.client.secrets.events.emit.reset_mock()
# get a fresh instance so it emits all bootstrap signals
shared_db = self.get_default_shared_mock(get_doc_return_value=doc)
sol = self._soledad_instance(
secrets_path='alternative_stage2.json',
local_db_path='alternative_stage2.u1db',
shared_db_class=shared_db)
# reverse call order so we can verify in the order the signals were
# expected
soledad.client.secrets.events.emit.mock_calls.reverse()
soledad.client.secrets.events.emit.call_args = \
soledad.client.secrets.events.emit.call_args_list[0]
soledad.client.secrets.events.emit.call_args_list.reverse()
# assert download keys signals
soledad.client.secrets.events.emit.assert_called_with(
catalog.SOLEDAD_DOWNLOADING_KEYS,
ADDRESS,
)
self._pop_mock_call(soledad.client.secrets.events.emit)
soledad.client.secrets.events.emit.assert_called_with(
catalog.SOLEDAD_DONE_DOWNLOADING_KEYS,
ADDRESS,
)
sol.close()
def test_stage1_bootstrap_signals(self):
"""
Test that if soledad already has a local secret, it emits no signals.
"""
soledad.client.signal.reset_mock()
# get an existent instance so it emits only some of bootstrap signals
sol = self._soledad_instance()
self.assertEqual([], soledad.client.signal.mock_calls)
sol.close()
def test_sync_signals(self):
"""
Test Soledad emits SOLEDAD_CREATING_KEYS signal.
"""
soledad.client.signal.reset_mock()
# get a fresh instance so it emits all bootstrap signals
sol = self._soledad_instance()
# mock the actual db sync so soledad does not try to connect to the
# server
sol._dbsyncer.sync = Mock()
def _assert_done_data_sync_signal_emitted(results):
# assert the signal has been emitted
soledad.client.events.emit.assert_called_with(
catalog.SOLEDAD_DONE_DATA_SYNC,
ADDRESS,
)
sol.close()
# do the sync and assert signal was emitted
d = sol.sync()
d.addCallback(_assert_done_data_sync_signal_emitted)
return d
|