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
|
# -*- coding: utf-8 -*-
# config.py
# Copyright (C) 2015 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/>.
"""
Configuration for a LEAP provider.
"""
import datetime
import json
import os
import sys
from collections import defaultdict
from urlparse import urlparse
from twisted.internet import defer, reactor
from twisted.internet.ssl import ClientContextFactory
from twisted.python import log
from twisted.web.client import Agent, downloadPage
from leap.bonafide._http import httpRequest
from leap.bonafide.provider import Discovery
from leap.common.check import leap_assert
from leap.common.config import get_path_prefix as common_get_path_prefix
from leap.common.files import mkdir_p
# check_and_fix_urw_only, get_mtime
APPNAME = "bonafide"
ENDPOINT = "ipc:///tmp/%s.sock" % APPNAME
def get_path_prefix(standalone=False):
return common_get_path_prefix(standalone)
_preffix = get_path_prefix()
def get_provider_path(domain, config='provider.json'):
"""
Returns relative path for provider configs.
:param domain: the domain to which this providerconfig belongs to.
:type domain: str
:returns: the path
:rtype: str
"""
# TODO sanitize domain
leap_assert(domain is not None, 'get_provider_path: We need a domain')
return os.path.join('providers', domain, config)
def get_ca_cert_path(domain):
# TODO sanitize domain
leap_assert(domain is not None, 'get_provider_path: We need a domain')
return os.path.join('providers', domain, 'keys', 'ca', 'cacert.pem')
def get_modification_ts(path):
"""
Gets modification time of a file.
:param path: the path to get ts from
:type path: str
:returns: modification time
:rtype: datetime object
"""
ts = os.path.getmtime(path)
return datetime.datetime.fromtimestamp(ts)
def update_modification_ts(path):
"""
Sets modification time of a file to current time.
:param path: the path to set ts to.
:type path: str
:returns: modification time
:rtype: datetime object
"""
os.utime(path, None)
return get_modification_ts(path)
def is_file(path):
"""
Returns True if the path exists and is a file.
"""
return os.path.isfile(path)
def is_empty_file(path):
"""
Returns True if the file at path is empty.
"""
return os.stat(path).st_size is 0
def make_address(user, provider):
"""
Return a full identifier for an user, as a email-like
identifier.
:param user: the username
:type user: basestring
:param provider: the provider domain
:type provider: basestring
"""
return '%s@%s' % (user, provider)
def get_username_and_provider(full_id):
return full_id.split('@')
class Provider(object):
# TODO add validation
SERVICES_MAP = {
'openvpn': ['eip'],
'mx': ['soledad', 'smtp']}
first_bootstrap = defaultdict(None)
ongoing_bootstrap = defaultdict(None)
stuck_bootstrap = defaultdict(None)
def __init__(self, domain, autoconf=True, basedir=None,
check_certificate=True):
if not basedir:
basedir = os.path.join(_preffix, 'leap')
self._basedir = os.path.expanduser(basedir)
self._domain = domain
self._disco = Discovery('https://%s' % domain)
self._provider_config = None
is_configured = self.is_configured()
if not is_configured:
check_certificate = False
if check_certificate:
self.contextFactory = None
else:
# XXX we should do this only for the FIRST provider download.
# For the rest, we should pass the ca cert to the agent.
# That means that RIGHT AFTER DOWNLOADING provider_info,
# we should instantiate a new Agent...
self.contextFactory = WebClientContextFactory()
self._agent = Agent(reactor, self.contextFactory)
self._load_provider_json()
if not is_configured and autoconf:
log.msg('provider %s not configured: downloading files...' %
domain)
self.bootstrap()
else:
log.msg('Provider already initialized')
self.first_bootstrap[self._domain] = defer.succeed(
'already_initialized')
self.ongoing_bootstrap[self._domain] = defer.succeed(
'already_initialized')
def is_configured(self):
provider_json = self._get_provider_json_path()
# XXX check if all the services are there
if not is_file(provider_json):
return False
if not is_file(self._get_ca_cert_path()):
return False
if not self.has_config_for_all_services():
return False
return True
def bootstrap(self):
domain = self._domain
log.msg("Bootstrapping provider %s" % domain)
ongoing = self.ongoing_bootstrap.get(domain)
if ongoing:
log.msg('already bootstrapping this provider...')
return
self.first_bootstrap[self._domain] = defer.Deferred()
def first_bootstrap_done(ignored):
try:
self.first_bootstrap[domain].callback('got config')
except defer.AlreadyCalledError:
pass
d = self.maybe_download_provider_info()
d.addCallback(self.maybe_download_ca_cert)
d.addCallback(self.validate_ca_cert)
d.addCallback(first_bootstrap_done)
d.addCallback(self.maybe_download_services_config)
self.ongoing_bootstrap[domain] = d
def callWhenMainConfigReady(self, cb, *args, **kw):
d = self.first_bootstrap[self._domain]
d.addCallback(lambda _: cb(*args, **kw))
d.addErrback(log.err)
return d
def callWhenReady(self, cb, *args, **kw):
d = self.ongoing_bootstrap[self._domain]
d.addCallback(lambda _: cb(*args, **kw))
d.addErrback(log.err)
return d
def has_valid_certificate(self):
pass
def maybe_download_provider_info(self, replace=False):
"""
Download the provider.json info from the main domain.
This SHOULD only be used once with the DOMAIN url.
"""
# TODO handle pre-seeded providers?
# or let client handle that? We could move them to bonafide.
provider_json = self._get_provider_json_path()
if is_file(provider_json) and not replace:
return defer.succeed('provider_info_already_exists')
folders, f = os.path.split(provider_json)
mkdir_p(folders)
uri = self._disco.get_provider_info_uri()
met = self._disco.get_provider_info_method()
d = downloadPage(uri, provider_json, method=met)
d.addCallback(lambda _: self._load_provider_json())
d.addErrback(log.err)
return d
def update_provider_info(self):
"""
Get more recent copy of provider.json from the api URL.
"""
pass
def maybe_download_ca_cert(self, ignored):
"""
:rtype: deferred
"""
path = self._get_ca_cert_path()
if is_file(path):
return defer.succeed('ca_cert_path_already_exists')
uri = self._get_ca_cert_uri()
mkdir_p(os.path.split(path)[0])
d = downloadPage(uri, path)
d.addErrback(log.err)
return d
def validate_ca_cert(self, ignored):
# TODO Need to verify fingerprint against the one in provider.json
expected = self._get_expected_ca_cert_fingerprint()
print "EXPECTED FINGERPRINT:", expected
def _get_expected_ca_cert_fingerprint(self):
try:
fgp = self._provider_config.ca_cert_fingerprint
except AttributeError:
fgp = None
return fgp
# Services config files
def has_fetched_services_config(self):
return os.path.isfile(self._get_configs_path())
def maybe_download_services_config(self, ignored):
# TODO --- currently, some providers (mail.bitmask.net) raise 401
# UNAUTHENTICATED if we try to get the services
# See: # https://leap.se/code/issues/7906
def further_bootstrap_needs_auth(ignored):
log.err('cannot download services config yet, need auth')
pending_deferred = defer.Deferred()
self.stuck_bootstrap[self._domain] = pending_deferred
return pending_deferred
uri, met, path = self._get_configs_download_params()
d = downloadPage(uri, path, method=met)
d.addCallback(lambda _: self._load_provider_json())
d.addCallback(
lambda _: self._get_config_for_all_services(session=None))
d.addErrback(further_bootstrap_needs_auth)
return d
def download_services_config_with_auth(self, session):
def verify_provider_configs(ignored):
self._load_provider_configs()
return True
def workaround_for_config_fetch(failure):
# FIXME --- configs.json raises 500, see #7914.
# This is a workaround until that's fixed.
log.err(failure)
log.msg(
"COULD NOT VERIFY CONFIGS.JSON, WORKAROUND: DIRECT DOWNLOAD")
if 'mx' in self._provider_config.services:
soledad_uri = '/1/config/soledad-service.json'
smtp_uri = '/1/config/smtp-service.json'
base = self._disco.api_uri
fetch = self._fetch_provider_configs_unauthenticated
get_path = self._get_service_config_path
d1 = fetch(
'https://' + str(base + soledad_uri), get_path('soledad'))
d2 = fetch(
'https://' + str(base + smtp_uri), get_path('smtp'))
d = defer.gatherResults([d1, d2])
d.addCallback(lambda _: finish_stuck_after_workaround())
return d
def finish_stuck_after_workaround():
stuck = self.stuck_bootstrap.get(self._domain, None)
if stuck:
stuck.callback('continue!')
def complete_bootstrapping(ignored):
stuck = self.stuck_bootstrap.get(self._domain, None)
if stuck:
d = self._get_config_for_all_services(session)
d.addCallback(lambda _: stuck.callback('continue!'))
d.addErrback(log.err)
return d
if not self.has_fetched_services_config():
self._load_provider_json()
uri, met, path = self._get_configs_download_params()
d = session.fetch_provider_configs(uri, path)
d.addCallback(verify_provider_configs)
d.addCallback(complete_bootstrapping)
d.addErrback(workaround_for_config_fetch)
return d
else:
d = defer.succeed('already downloaded')
d.addCallback(complete_bootstrapping)
return d
def _get_configs_download_params(self):
uri = self._disco.get_configs_uri()
met = self._disco.get_configs_method()
path = self._get_configs_path()
return uri, met, path
def offers_service(self, service):
if service not in self.SERVICES_MAP.keys():
raise RuntimeError('Unknown service: %s' % service)
return service in self._provider_config.services
def is_service_enabled(self, service):
# TODO implement on some config file
return True
def has_config_for_service(self, service):
has_file = os.path.isfile
path = self._get_service_config_path
smap = self.SERVICES_MAP
result = all([has_file(path(subservice)) for
subservice in smap[service]])
return result
def has_config_for_all_services(self):
self._load_provider_json()
if not self._provider_config:
return False
all_services = self._provider_config.services
has_all = all(
[self.has_config_for_service(service) for service in
all_services])
return has_all
def _get_provider_json_path(self):
domain = self._domain.encode(sys.getfilesystemencoding())
provider_json_path = os.path.join(
self._basedir, get_provider_path(domain, config='provider.json'))
return provider_json_path
def _get_configs_path(self):
domain = self._domain.encode(sys.getfilesystemencoding())
configs_path = os.path.join(
self._basedir, get_provider_path(domain, config='configs.json'))
return configs_path
def _get_service_config_path(self, service):
domain = self._domain.encode(sys.getfilesystemencoding())
configs_path = os.path.join(
self._basedir, get_provider_path(
domain, config='%s-service.json' % service))
return configs_path
def _get_ca_cert_path(self):
domain = self._domain.encode(sys.getfilesystemencoding())
cert_path = os.path.join(self._basedir, get_ca_cert_path(domain))
return cert_path
def _get_ca_cert_uri(self):
try:
uri = self._provider_config.ca_cert_uri
uri = str(uri)
except Exception:
uri = None
return uri
def _load_provider_json(self):
path = self._get_provider_json_path()
if not is_file(path):
log.msg("Cannot LOAD provider config path %s" % path)
return
with open(path, 'r') as config:
self._provider_config = Record(**json.load(config))
api_uri = self._provider_config.api_uri
if api_uri:
parsed = urlparse(api_uri)
self._disco.api_uri = parsed.netloc
def _get_config_for_all_services(self, session):
services_dict = self._load_provider_configs()
configs_path = self._get_configs_path()
with open(configs_path) as jsonf:
services_dict = Record(**json.load(jsonf)).services
pending = []
base = self._disco.get_base_uri()
for service in self._provider_config.services:
if service in self.SERVICES_MAP.keys():
for subservice in self.SERVICES_MAP[service]:
uri = base + str(services_dict[subservice])
path = self._get_service_config_path(subservice)
if session:
d = session.fetch_provider_configs(uri, path)
else:
d = self._fetch_provider_configs_unauthenticated(
uri, path)
pending.append(d)
return defer.gatherResults(pending)
def _load_provider_configs(self):
configs_path = self._get_configs_path()
with open(configs_path) as jsonf:
services_dict = Record(**json.load(jsonf)).services
return services_dict
def _fetch_provider_configs_unauthenticated(self, uri, path):
log.msg('Downloading config for %s...' % uri)
d = downloadPage(uri, path, method='GET')
return d
def _http_request(self, *args, **kw):
# XXX pass if-modified-since header
return httpRequest(self._agent, *args, **kw)
def _get_api_uri(self):
pass
class Record(object):
def __init__(self, **kw):
self.__dict__.update(kw)
class WebClientContextFactory(ClientContextFactory):
def getContext(self, hostname, port):
return ClientContextFactory.getContext(self)
if __name__ == '__main__':
def print_done():
print '>>> bootstrapping done!!!'
provider = Provider('cdev.bitmask.net')
provider.callWhenReady(print_done)
reactor.run()
|