To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 520
- compare with another revision
- download diff
- download tarball
- view history from revision 520
- Committer: Björn Påhlsson
- Date: 2011-11-09 17:16:03 UTC
- mfrom: (518.1.1 mandos-persistent)
- Revision ID: belorn@fukt.bsnet.se-20111109171603-srz21uoclpldp5ve
merge persistent state
- files removed:
- debian/mandos-client.examples
- debian/upstream
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos
1
#!/usr/bin/python2.7
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2015 Teddy Hogeborn
15
# Copyright © 2008-2015 Björn Påhlsson
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 Björn Påhlsson
16
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
unicode_literals)
36
36
37
from future_builtins import *
38
39
37
import SocketServer as socketserver
40
38
import socket
41
39
import argparse
65
63
import cPickle as pickle
66
64
import multiprocessing
67
65
import types
68
import binascii
69
import tempfile
70
import itertools
71
import collections
66
import hashlib
72
67
73
68
import dbus
74
69
import dbus.service
79
74
import ctypes.util
80
75
import xml.dom.minidom
81
76
import inspect
77
import Crypto.Cipher.AES
82
78
83
79
try:
84
80
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
84
except ImportError:
89
85
SO_BINDTODEVICE = None
90
86
91
if sys.version_info.major == 2:
92
str = unicode
93
87
94
version = "1.6.9"
95
stored_state_file = "clients.pickle"
88
version = "1.4.1"
96
89
97
90
logger = logging.getLogger()
98
syslogger = None
99
100
try:
101
if_nametoindex = ctypes.cdll.LoadLibrary(
102
ctypes.util.find_library("c")).if_nametoindex
103
except (OSError, AttributeError):
104
105
def if_nametoindex(interface):
106
"Get an interface index the hard way, i.e. using fcntl()"
107
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
108
with contextlib.closing(socket.socket()) as s:
109
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
110
struct.pack(b"16s16x", interface))
111
interface_index = struct.unpack("I", ifreq[16:20])[0]
112
return interface_index
113
114
115
def initlogger(debug, level=logging.WARNING):
116
"""init logger and add loglevel"""
117
118
global syslogger
119
syslogger = (logging.handlers.SysLogHandler(
120
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
121
address = "/dev/log"))
122
syslogger.setFormatter(logging.Formatter
123
('Mandos [%(process)d]: %(levelname)s:'
124
' %(message)s'))
125
logger.addHandler(syslogger)
126
127
if debug:
128
console = logging.StreamHandler()
129
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
130
' [%(process)d]:'
131
' %(levelname)s:'
132
' %(message)s'))
133
logger.addHandler(console)
134
logger.setLevel(level)
135
136
137
class PGPError(Exception):
138
"""Exception if encryption/decryption fails"""
139
pass
140
141
142
class PGPEngine(object):
143
"""A simple class for OpenPGP symmetric encryption & decryption"""
144
145
def __init__(self):
146
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
147
self.gnupgargs = ['--batch',
148
'--home', self.tempdir,
149
'--force-mdc',
150
'--quiet',
151
'--no-use-agent']
152
153
def __enter__(self):
154
return self
155
156
def __exit__(self, exc_type, exc_value, traceback):
157
self._cleanup()
158
return False
159
160
def __del__(self):
161
self._cleanup()
162
163
def _cleanup(self):
164
if self.tempdir is not None:
165
# Delete contents of tempdir
166
for root, dirs, files in os.walk(self.tempdir,
167
topdown = False):
168
for filename in files:
169
os.remove(os.path.join(root, filename))
170
for dirname in dirs:
171
os.rmdir(os.path.join(root, dirname))
172
# Remove tempdir
173
os.rmdir(self.tempdir)
174
self.tempdir = None
175
176
def password_encode(self, password):
177
# Passphrase can not be empty and can not contain newlines or
178
# NUL bytes. So we prefix it and hex encode it.
179
encoded = b"mandos" + binascii.hexlify(password)
180
if len(encoded) > 2048:
181
# GnuPG can't handle long passwords, so encode differently
182
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
183
.replace(b"\n", b"\\n")
184
.replace(b"\0", b"\\x00"))
185
return encoded
186
187
def encrypt(self, data, password):
188
passphrase = self.password_encode(password)
189
with tempfile.NamedTemporaryFile(
190
dir=self.tempdir) as passfile:
191
passfile.write(passphrase)
192
passfile.flush()
193
proc = subprocess.Popen(['gpg', '--symmetric',
194
'--passphrase-file',
195
passfile.name]
196
+ self.gnupgargs,
197
stdin = subprocess.PIPE,
198
stdout = subprocess.PIPE,
199
stderr = subprocess.PIPE)
200
ciphertext, err = proc.communicate(input = data)
201
if proc.returncode != 0:
202
raise PGPError(err)
203
return ciphertext
204
205
def decrypt(self, data, password):
206
passphrase = self.password_encode(password)
207
with tempfile.NamedTemporaryFile(
208
dir = self.tempdir) as passfile:
209
passfile.write(passphrase)
210
passfile.flush()
211
proc = subprocess.Popen(['gpg', '--decrypt',
212
'--passphrase-file',
213
passfile.name]
214
+ self.gnupgargs,
215
stdin = subprocess.PIPE,
216
stdout = subprocess.PIPE,
217
stderr = subprocess.PIPE)
218
decrypted_plaintext, err = proc.communicate(input = data)
219
if proc.returncode != 0:
220
raise PGPError(err)
221
return decrypted_plaintext
91
stored_state_path = "/var/lib/mandos/clients.pickle"
92
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
96
syslogger.setFormatter(logging.Formatter
97
('Mandos [%(process)d]: %(levelname)s:'
98
' %(message)s'))
99
logger.addHandler(syslogger)
100
101
console = logging.StreamHandler()
102
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
103
' [%(process)d]:'
104
' %(levelname)s:'
105
' %(message)s'))
106
logger.addHandler(console)
222
107
223
108
224
109
class AvahiError(Exception):
225
110
def __init__(self, value, *args, **kwargs):
226
111
self.value = value
227
return super(AvahiError, self).__init__(value, *args,
228
**kwargs)
229
112
super(AvahiError, self).__init__(value, *args, **kwargs)
113
def __unicode__(self):
114
return unicode(repr(self.value))
230
115
231
116
class AvahiServiceError(AvahiError):
232
117
pass
233
118
234
235
119
class AvahiGroupError(AvahiError):
236
120
pass
237
121
244
128
Used to optionally bind to the specified interface.
245
129
name: string; Example: 'Mandos'
246
130
type: string; Example: '_mandos._tcp'.
247
See <https://www.iana.org/assignments/service-names-port-numbers>
131
See <http://www.dns-sd.org/ServiceTypes.html>
248
132
port: integer; what port to announce
249
133
TXT: list of strings; TXT record for the service
250
134
domain: string; Domain to publish on, default to .local if empty.
256
140
server: D-Bus Server
257
141
bus: dbus.SystemBus()
258
142
"""
259
260
def __init__(self,
261
interface = avahi.IF_UNSPEC,
262
name = None,
263
servicetype = None,
264
port = None,
265
TXT = None,
266
domain = "",
267
host = "",
268
max_renames = 32768,
269
protocol = avahi.PROTO_UNSPEC,
270
bus = None):
143
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
144
servicetype = None, port = None, TXT = None,
145
domain = "", host = "", max_renames = 32768,
146
protocol = avahi.PROTO_UNSPEC, bus = None):
271
147
self.interface = interface
272
148
self.name = name
273
149
self.type = servicetype
282
158
self.server = None
283
159
self.bus = bus
284
160
self.entry_group_state_changed_match = None
285
286
def rename(self, remove=True):
161
def rename(self):
287
162
"""Derived from the Avahi example code"""
288
163
if self.rename_count >= self.max_renames:
289
164
logger.critical("No suitable Zeroconf service name found"
290
165
" after %i retries, exiting.",
291
166
self.rename_count)
292
167
raise AvahiServiceError("Too many renames")
293
self.name = str(
294
self.server.GetAlternativeServiceName(self.name))
295
self.rename_count += 1
168
self.name = unicode(self.server
169
.GetAlternativeServiceName(self.name))
296
170
logger.info("Changing Zeroconf service name to %r ...",
297
171
self.name)
298
if remove:
299
self.remove()
172
self.remove()
300
173
try:
301
174
self.add()
302
175
except dbus.exceptions.DBusException as error:
303
if (error.get_dbus_name()
304
== "org.freedesktop.Avahi.CollisionError"):
305
logger.info("Local Zeroconf service name collision.")
306
return self.rename(remove=False)
307
else:
308
logger.critical("D-Bus Exception", exc_info=error)
309
self.cleanup()
310
os._exit(1)
311
176
logger.critical("DBusException: %s", error)
177
self.cleanup()
178
os._exit(1)
179
self.rename_count += 1
312
180
def remove(self):
313
181
"""Derived from the Avahi example code"""
314
182
if self.entry_group_state_changed_match is not None:
316
184
self.entry_group_state_changed_match = None
317
185
if self.group is not None:
318
186
self.group.Reset()
319
320
187
def add(self):
321
188
"""Derived from the Avahi example code"""
322
189
self.remove()
339
206
dbus.UInt16(self.port),
340
207
avahi.string_array_to_txt_array(self.TXT))
341
208
self.group.Commit()
342
343
209
def entry_group_state_changed(self, state, error):
344
210
"""Derived from the Avahi example code"""
345
211
logger.debug("Avahi entry group state change: %i", state)
351
217
self.rename()
352
218
elif state == avahi.ENTRY_GROUP_FAILURE:
353
219
logger.critical("Avahi: Error in group state changed %s",
354
str(error))
355
raise AvahiGroupError("State changed: {!s}".format(error))
356
220
unicode(error))
221
raise AvahiGroupError("State changed: %s"
222
% unicode(error))
357
223
def cleanup(self):
358
224
"""Derived from the Avahi example code"""
359
225
if self.group is not None:
360
226
try:
361
227
self.group.Free()
362
228
except (dbus.exceptions.UnknownMethodException,
363
dbus.exceptions.DBusException):
229
dbus.exceptions.DBusException) as e:
364
230
pass
365
231
self.group = None
366
232
self.remove()
367
368
233
def server_state_changed(self, state, error=None):
369
234
"""Derived from the Avahi example code"""
370
235
logger.debug("Avahi server state change: %i", state)
371
bad_states = {
372
avahi.SERVER_INVALID: "Zeroconf server invalid",
373
avahi.SERVER_REGISTERING: None,
374
avahi.SERVER_COLLISION: "Zeroconf server name collision",
375
avahi.SERVER_FAILURE: "Zeroconf server failure",
376
}
236
bad_states = { avahi.SERVER_INVALID:
237
"Zeroconf server invalid",
238
avahi.SERVER_REGISTERING: None,
239
avahi.SERVER_COLLISION:
240
"Zeroconf server name collision",
241
avahi.SERVER_FAILURE:
242
"Zeroconf server failure" }
377
243
if state in bad_states:
378
244
if bad_states[state] is not None:
379
245
if error is None:
388
254
logger.debug("Unknown state: %r", state)
389
255
else:
390
256
logger.debug("Unknown state: %r: %r", state, error)
391
392
257
def activate(self):
393
258
"""Derived from the Avahi example code"""
394
259
if self.server is None:
398
263
follow_name_owner_changes=True),
399
264
avahi.DBUS_INTERFACE_SERVER)
400
265
self.server.connect_to_signal("StateChanged",
401
self.server_state_changed)
266
self.server_state_changed)
402
267
self.server_state_changed(self.server.GetState())
403
268
404
405
269
class AvahiServiceToSyslog(AvahiService):
406
def rename(self, *args, **kwargs):
270
def rename(self):
407
271
"""Add the new name to the syslog messages"""
408
ret = AvahiService.rename(self, *args, **kwargs)
409
syslogger.setFormatter(logging.Formatter(
410
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
411
.format(self.name)))
272
ret = AvahiService.rename(self)
273
syslogger.setFormatter(logging.Formatter
274
('Mandos (%s) [%%(process)d]:'
275
' %%(levelname)s: %%(message)s'
276
% self.name))
412
277
return ret
413
278
414
279
def _timedelta_to_milliseconds(td):
280
"Convert a datetime.timedelta() to milliseconds"
281
return ((td.days * 24 * 60 * 60 * 1000)
282
+ (td.seconds * 1000)
283
+ (td.microseconds // 1000))
284
415
285
class Client(object):
416
286
"""A representation of a client host served by this server.
417
287
418
288
Attributes:
419
approved: bool(); 'None' if not yet approved/disapproved
289
_approved: bool(); 'None' if not yet approved/disapproved
420
290
approval_delay: datetime.timedelta(); Time to wait for approval
421
291
approval_duration: datetime.timedelta(); Duration of one approval
422
292
checker: subprocess.Popen(); a running checker process used
440
310
interval: datetime.timedelta(); How often to start a new checker
441
311
last_approval_request: datetime.datetime(); (UTC) or None
442
312
last_checked_ok: datetime.datetime(); (UTC) or None
443
last_checker_status: integer between 0 and 255 reflecting exit
444
status of last checker. -1 reflects crashed
445
checker, -2 means no checker completed yet.
446
last_enabled: datetime.datetime(); (UTC) or None
313
last_checker_status: integer between 0 and 255 reflecting exit status
314
of last checker. -1 reflect crashed checker,
315
or None.
316
last_enabled: datetime.datetime(); (UTC)
447
317
name: string; from the config file, used in log messages and
448
318
D-Bus identifiers
449
319
secret: bytestring; sent verbatim (over TLS) to client
450
320
timeout: datetime.timedelta(); How long from last_checked_ok
451
321
until this client is disabled
452
extended_timeout: extra long timeout when secret has been sent
322
extended_timeout: extra long timeout when password has been sent
453
323
runtime_expansions: Allowed attributes for runtime expansion.
454
324
expires: datetime.datetime(); time (UTC) when a client will be
455
325
disabled, or None
456
server_settings: The server_settings dict from main()
457
326
"""
458
327
459
328
runtime_expansions = ("approval_delay", "approval_duration",
460
"created", "enabled", "expires",
461
"fingerprint", "host", "interval",
462
"last_approval_request", "last_checked_ok",
329
"created", "enabled", "fingerprint",
330
"host", "interval", "last_checked_ok",
463
331
"last_enabled", "name", "timeout")
464
client_defaults = {
465
"timeout": "PT5M",
466
"extended_timeout": "PT15M",
467
"interval": "PT2M",
468
"checker": "fping -q -- %%(host)s",
469
"host": "",
470
"approval_delay": "PT0S",
471
"approval_duration": "PT1S",
472
"approved_by_default": "True",
473
"enabled": "True",
474
}
475
476
@staticmethod
477
def config_parser(config):
478
"""Construct a new dict of client settings of this form:
479
{ client_name: {setting_name: value, ...}, ...}
480
with exceptions for any special settings as defined above.
481
NOTE: Must be a pure function. Must return the same result
482
value given the same arguments.
483
"""
484
settings = {}
485
for client_name in config.sections():
486
section = dict(config.items(client_name))
487
client = settings[client_name] = {}
488
489
client["host"] = section["host"]
490
# Reformat values from string types to Python types
491
client["approved_by_default"] = config.getboolean(
492
client_name, "approved_by_default")
493
client["enabled"] = config.getboolean(client_name,
494
"enabled")
495
496
# Uppercase and remove spaces from fingerprint for later
497
# comparison purposes with return value from the
498
# fingerprint() function
499
client["fingerprint"] = (section["fingerprint"].upper()
500
.replace(" ", ""))
501
if "secret" in section:
502
client["secret"] = section["secret"].decode("base64")
503
elif "secfile" in section:
504
with open(os.path.expanduser(os.path.expandvars
505
(section["secfile"])),
506
"rb") as secfile:
507
client["secret"] = secfile.read()
508
else:
509
raise TypeError("No secret or secfile for section {}"
510
.format(section))
511
client["timeout"] = string_to_delta(section["timeout"])
512
client["extended_timeout"] = string_to_delta(
513
section["extended_timeout"])
514
client["interval"] = string_to_delta(section["interval"])
515
client["approval_delay"] = string_to_delta(
516
section["approval_delay"])
517
client["approval_duration"] = string_to_delta(
518
section["approval_duration"])
519
client["checker_command"] = section["checker"]
520
client["last_approval_request"] = None
521
client["last_checked_ok"] = None
522
client["last_checker_status"] = -2
523
524
return settings
525
526
def __init__(self, settings, name = None, server_settings=None):
332
333
def timeout_milliseconds(self):
334
"Return the 'timeout' attribute in milliseconds"
335
return _timedelta_to_milliseconds(self.timeout)
336
337
def extended_timeout_milliseconds(self):
338
"Return the 'extended_timeout' attribute in milliseconds"
339
return _timedelta_to_milliseconds(self.extended_timeout)
340
341
def interval_milliseconds(self):
342
"Return the 'interval' attribute in milliseconds"
343
return _timedelta_to_milliseconds(self.interval)
344
345
def approval_delay_milliseconds(self):
346
return _timedelta_to_milliseconds(self.approval_delay)
347
348
def __init__(self, name = None, config=None):
349
"""Note: the 'checker' key in 'config' sets the
350
'checker_command' attribute and *not* the 'checker'
351
attribute."""
527
352
self.name = name
528
if server_settings is None:
529
server_settings = {}
530
self.server_settings = server_settings
531
# adding all client settings
532
for setting, value in settings.items():
533
setattr(self, setting, value)
534
535
if self.enabled:
536
if not hasattr(self, "last_enabled"):
537
self.last_enabled = datetime.datetime.utcnow()
538
if not hasattr(self, "expires"):
539
self.expires = (datetime.datetime.utcnow()
540
+ self.timeout)
541
else:
542
self.last_enabled = None
543
self.expires = None
544
353
if config is None:
354
config = {}
545
355
logger.debug("Creating client %r", self.name)
356
# Uppercase and remove spaces from fingerprint for later
357
# comparison purposes with return value from the fingerprint()
358
# function
359
self.fingerprint = (config["fingerprint"].upper()
360
.replace(" ", ""))
546
361
logger.debug(" Fingerprint: %s", self.fingerprint)
547
self.created = settings.get("created",
548
datetime.datetime.utcnow())
549
550
# attributes specific for this server instance
362
if "secret" in config:
363
self.secret = config["secret"].decode("base64")
364
elif "secfile" in config:
365
with open(os.path.expanduser(os.path.expandvars
366
(config["secfile"])),
367
"rb") as secfile:
368
self.secret = secfile.read()
369
else:
370
raise TypeError("No secret or secfile for client %s"
371
% self.name)
372
self.host = config.get("host", "")
373
self.created = datetime.datetime.utcnow()
374
self.enabled = True
375
self.last_approval_request = None
376
self.last_enabled = datetime.datetime.utcnow()
377
self.last_checked_ok = None
378
self.last_checker_status = None
379
self.timeout = string_to_delta(config["timeout"])
380
self.extended_timeout = string_to_delta(config
381
["extended_timeout"])
382
self.interval = string_to_delta(config["interval"])
551
383
self.checker = None
552
384
self.checker_initiator_tag = None
553
385
self.disable_initiator_tag = None
386
self.expires = datetime.datetime.utcnow() + self.timeout
554
387
self.checker_callback_tag = None
388
self.checker_command = config["checker"]
555
389
self.current_checker_command = None
556
self.approved = None
390
self._approved = None
391
self.approved_by_default = config.get("approved_by_default",
392
True)
557
393
self.approvals_pending = 0
558
self.changedstate = multiprocessing_manager.Condition(
559
multiprocessing_manager.Lock())
560
self.client_structure = [attr
561
for attr in self.__dict__.iterkeys()
562
if not attr.startswith("_")]
394
self.approval_delay = string_to_delta(
395
config["approval_delay"])
396
self.approval_duration = string_to_delta(
397
config["approval_duration"])
398
self.changedstate = (multiprocessing_manager
399
.Condition(multiprocessing_manager
400
.Lock()))
401
self.client_structure = [attr for attr in self.__dict__.iterkeys() if not attr.startswith("_")]
563
402
self.client_structure.append("client_structure")
564
565
for name, t in inspect.getmembers(
566
type(self), lambda obj: isinstance(obj, property)):
403
404
405
for name, t in inspect.getmembers(type(self),
406
lambda obj: isinstance(obj, property)):
567
407
if not name.startswith("_"):
568
408
self.client_structure.append(name)
569
409
577
417
if getattr(self, "enabled", False):
578
418
# Already enabled
579
419
return
420
self.send_changedstate()
580
421
self.expires = datetime.datetime.utcnow() + self.timeout
581
422
self.enabled = True
582
423
self.last_enabled = datetime.datetime.utcnow()
583
424
self.init_checker()
584
self.send_changedstate()
585
425
586
426
def disable(self, quiet=True):
587
427
"""Disable this client."""
588
428
if not getattr(self, "enabled", False):
589
429
return False
590
430
if not quiet:
431
self.send_changedstate()
432
if not quiet:
591
433
logger.info("Disabling client %s", self.name)
592
if getattr(self, "disable_initiator_tag", None) is not None:
434
if getattr(self, "disable_initiator_tag", False):
593
435
gobject.source_remove(self.disable_initiator_tag)
594
436
self.disable_initiator_tag = None
595
437
self.expires = None
596
if getattr(self, "checker_initiator_tag", None) is not None:
438
if getattr(self, "checker_initiator_tag", False):
597
439
gobject.source_remove(self.checker_initiator_tag)
598
440
self.checker_initiator_tag = None
599
441
self.stop_checker()
600
442
self.enabled = False
601
if not quiet:
602
self.send_changedstate()
603
443
# Do not run this again if called by a gobject.timeout_add
604
444
return False
605
445
606
446
def __del__(self):
607
447
self.disable()
608
448
609
449
def init_checker(self):
610
450
# Schedule a new checker to be started an 'interval' from now,
611
451
# and every interval from then on.
612
if self.checker_initiator_tag is not None:
613
gobject.source_remove(self.checker_initiator_tag)
614
self.checker_initiator_tag = gobject.timeout_add(
615
int(self.interval.total_seconds() * 1000),
616
self.start_checker)
452
self.checker_initiator_tag = (gobject.timeout_add
453
(self.interval_milliseconds(),
454
self.start_checker))
617
455
# Schedule a disable() when 'timeout' has passed
618
if self.disable_initiator_tag is not None:
619
gobject.source_remove(self.disable_initiator_tag)
620
self.disable_initiator_tag = gobject.timeout_add(
621
int(self.timeout.total_seconds() * 1000), self.disable)
456
self.disable_initiator_tag = (gobject.timeout_add
457
(self.timeout_milliseconds(),
458
self.disable))
622
459
# Also start a new checker *right now*.
623
460
self.start_checker()
624
461
462
625
463
def checker_callback(self, pid, condition, command):
626
464
"""The checker has completed, so take appropriate actions."""
627
465
self.checker_callback_tag = None
628
466
self.checker = None
629
467
if os.WIFEXITED(condition):
630
self.last_checker_status = os.WEXITSTATUS(condition)
468
self.last_checker_status = os.WEXITSTATUS(condition)
631
469
if self.last_checker_status == 0:
632
470
logger.info("Checker for %(name)s succeeded",
633
471
vars(self))
634
472
self.checked_ok()
635
473
else:
636
logger.info("Checker for %(name)s failed", vars(self))
474
logger.info("Checker for %(name)s failed",
475
vars(self))
637
476
else:
638
477
self.last_checker_status = -1
639
478
logger.warning("Checker for %(name)s crashed?",
640
479
vars(self))
641
480
642
def checked_ok(self):
643
"""Assert that the client has been seen, alive and well."""
644
self.last_checked_ok = datetime.datetime.utcnow()
645
self.last_checker_status = 0
646
self.bump_timeout()
647
648
def bump_timeout(self, timeout=None):
649
"""Bump up the timeout for this client."""
481
def checked_ok(self, timeout=None):
482
"""Bump up the timeout for this client.
483
484
This should only be called when the client has been seen,
485
alive and well.
486
"""
650
487
if timeout is None:
651
488
timeout = self.timeout
489
self.last_checked_ok = datetime.datetime.utcnow()
652
490
if self.disable_initiator_tag is not None:
653
491
gobject.source_remove(self.disable_initiator_tag)
654
self.disable_initiator_tag = None
655
492
if getattr(self, "enabled", False):
656
self.disable_initiator_tag = gobject.timeout_add(
657
int(timeout.total_seconds() * 1000), self.disable)
493
self.disable_initiator_tag = (gobject.timeout_add
494
(_timedelta_to_milliseconds
495
(timeout), self.disable))
658
496
self.expires = datetime.datetime.utcnow() + timeout
659
497
660
498
def need_approval(self):
666
504
If a checker already exists, leave it running and do
667
505
nothing."""
668
506
# The reason for not killing a running checker is that if we
669
# did that, and if a checker (for some reason) started running
670
# slowly and taking more than 'interval' time, then the client
671
# would inevitably timeout, since no checker would get a
672
# chance to run to completion. If we instead leave running
507
# did that, then if a checker (for some reason) started
508
# running slowly and taking more than 'interval' time, the
509
# client would inevitably timeout, since no checker would get
510
# a chance to run to completion. If we instead leave running
673
511
# checkers alone, the checker would have to take more time
674
512
# than 'timeout' for the client to be disabled, which is as it
675
513
# should be.
677
515
# If a checker exists, make sure it is not a zombie
678
516
try:
679
517
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
680
except AttributeError:
681
pass
682
except OSError as error:
683
if error.errno != errno.ECHILD:
684
raise
518
except (AttributeError, OSError) as error:
519
if (isinstance(error, OSError)
520
and error.errno != errno.ECHILD):
521
raise error
685
522
else:
686
523
if pid:
687
524
logger.warning("Checker was a zombie")
690
527
self.current_checker_command)
691
528
# Start a new checker if needed
692
529
if self.checker is None:
693
# Escape attributes for the shell
694
escaped_attrs = {
695
attr: re.escape(str(getattr(self, attr)))
696
for attr in self.runtime_expansions }
697
530
try:
698
command = self.checker_command % escaped_attrs
699
except TypeError as error:
700
logger.error('Could not format string "%s"',
701
self.checker_command,
702
exc_info=error)
703
return True # Try again later
531
# In case checker_command has exactly one % operator
532
command = self.checker_command % self.host
533
except TypeError:
534
# Escape attributes for the shell
535
escaped_attrs = dict(
536
(attr,
537
re.escape(unicode(str(getattr(self, attr, "")),
538
errors=
539
'replace')))
540
for attr in
541
self.runtime_expansions)
542
543
try:
544
command = self.checker_command % escaped_attrs
545
except TypeError as error:
546
logger.error('Could not format string "%s":'
547
' %s', self.checker_command, error)
548
return True # Try again later
704
549
self.current_checker_command = command
705
550
try:
706
logger.info("Starting checker %r for %s", command,
707
self.name)
551
logger.info("Starting checker %r for %s",
552
command, self.name)
708
553
# We don't need to redirect stdout and stderr, since
709
554
# in normal mode, that is already done by daemon(),
710
555
# and in debug mode we don't want to. (Stdin is
711
556
# always replaced by /dev/null.)
712
# The exception is when not debugging but nevertheless
713
# running in the foreground; use the previously
714
# created wnull.
715
popen_args = {}
716
if (not self.server_settings["debug"]
717
and self.server_settings["foreground"]):
718
popen_args.update({"stdout": wnull,
719
"stderr": wnull })
720
557
self.checker = subprocess.Popen(command,
721
558
close_fds=True,
722
shell=True,
723
cwd="/",
724
**popen_args)
725
except OSError as error:
726
logger.error("Failed to start subprocess",
727
exc_info=error)
728
return True
729
self.checker_callback_tag = gobject.child_watch_add(
730
self.checker.pid, self.checker_callback, data=command)
731
# The checker may have completed before the gobject
732
# watch was added. Check for this.
733
try:
559
shell=True, cwd="/")
560
self.checker_callback_tag = (gobject.child_watch_add
561
(self.checker.pid,
562
self.checker_callback,
563
data=command))
564
# The checker may have completed before the gobject
565
# watch was added. Check for this.
734
566
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
567
if pid:
568
gobject.source_remove(self.checker_callback_tag)
569
self.checker_callback(pid, status, command)
735
570
except OSError as error:
736
if error.errno == errno.ECHILD:
737
# This should never happen
738
logger.error("Child process vanished",
739
exc_info=error)
740
return True
741
raise
742
if pid:
743
gobject.source_remove(self.checker_callback_tag)
744
self.checker_callback(pid, status, command)
571
logger.error("Failed to start subprocess: %s",
572
error)
745
573
# Re-run this periodically if run by gobject.timeout_add
746
574
return True
747
575
754
582
return
755
583
logger.debug("Stopping checker for %(name)s", vars(self))
756
584
try:
757
self.checker.terminate()
585
os.kill(self.checker.pid, signal.SIGTERM)
758
586
#time.sleep(0.5)
759
587
#if self.checker.poll() is None:
760
# self.checker.kill()
588
# os.kill(self.checker.pid, signal.SIGKILL)
761
589
except OSError as error:
762
590
if error.errno != errno.ESRCH: # No such process
763
591
raise
764
592
self.checker = None
765
593
766
767
def dbus_service_property(dbus_interface,
768
signature="v",
769
access="readwrite",
770
byte_arrays=False):
594
# Encrypts a client secret and stores it in a varible encrypted_secret
595
def encrypt_secret(self, key):
596
# Encryption-key need to be of a specific size, so we hash inputed key
597
hasheng = hashlib.sha256()
598
hasheng.update(key)
599
encryptionkey = hasheng.digest()
600
601
# Create validation hash so we know at decryption if it was sucessful
602
hasheng = hashlib.sha256()
603
hasheng.update(self.secret)
604
validationhash = hasheng.digest()
605
606
# Encrypt secret
607
iv = os.urandom(Crypto.Cipher.AES.block_size)
608
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
609
Crypto.Cipher.AES.MODE_CFB, iv)
610
ciphertext = ciphereng.encrypt(validationhash+self.secret)
611
self.encrypted_secret = (ciphertext, iv)
612
613
# Decrypt a encrypted client secret
614
def decrypt_secret(self, key):
615
# Decryption-key need to be of a specific size, so we hash inputed key
616
hasheng = hashlib.sha256()
617
hasheng.update(key)
618
encryptionkey = hasheng.digest()
619
620
# Decrypt encrypted secret
621
ciphertext, iv = self.encrypted_secret
622
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
623
Crypto.Cipher.AES.MODE_CFB, iv)
624
plain = ciphereng.decrypt(ciphertext)
625
626
# Validate decrypted secret to know if it was succesful
627
hasheng = hashlib.sha256()
628
validationhash = plain[:hasheng.digest_size]
629
secret = plain[hasheng.digest_size:]
630
hasheng.update(secret)
631
632
# if validation fails, we use key as new secret. Otherwhise, we use
633
# the decrypted secret
634
if hasheng.digest() == validationhash:
635
self.secret = secret
636
else:
637
self.secret = key
638
del self.encrypted_secret
639
640
641
def dbus_service_property(dbus_interface, signature="v",
642
access="readwrite", byte_arrays=False):
771
643
"""Decorators for marking methods of a DBusObjectWithProperties to
772
644
become properties on the D-Bus.
773
645
782
654
# "Set" method, so we fail early here:
783
655
if byte_arrays and signature != "ay":
784
656
raise ValueError("Byte arrays not supported for non-'ay'"
785
" signature {!r}".format(signature))
786
657
" signature %r" % signature)
787
658
def decorator(func):
788
659
func._dbus_is_property = True
789
660
func._dbus_interface = dbus_interface
794
665
func._dbus_name = func._dbus_name[:-14]
795
666
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
796
667
return func
797
798
return decorator
799
800
801
def dbus_interface_annotations(dbus_interface):
802
"""Decorator for marking functions returning interface annotations
803
804
Usage:
805
806
@dbus_interface_annotations("org.example.Interface")
807
def _foo(self): # Function name does not matter
808
return {"org.freedesktop.DBus.Deprecated": "true",
809
"org.freedesktop.DBus.Property.EmitsChangedSignal":
810
"false"}
811
"""
812
813
def decorator(func):
814
func._dbus_is_interface = True
815
func._dbus_interface = dbus_interface
816
func._dbus_name = dbus_interface
817
return func
818
819
return decorator
820
821
822
def dbus_annotations(annotations):
823
"""Decorator to annotate D-Bus methods, signals or properties
824
Usage:
825
826
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
827
"org.freedesktop.DBus.Property."
828
"EmitsChangedSignal": "false"})
829
@dbus_service_property("org.example.Interface", signature="b",
830
access="r")
831
def Property_dbus_property(self):
832
return dbus.Boolean(False)
833
"""
834
835
def decorator(func):
836
func._dbus_annotations = annotations
837
return func
838
839
668
return decorator
840
669
841
670
842
671
class DBusPropertyException(dbus.exceptions.DBusException):
843
672
"""A base class for D-Bus property-related exceptions
844
673
"""
845
pass
674
def __unicode__(self):
675
return unicode(str(self))
846
676
847
677
848
678
class DBusPropertyAccessException(DBusPropertyException):
866
696
"""
867
697
868
698
@staticmethod
869
def _is_dbus_thing(thing):
870
"""Returns a function testing if an attribute is a D-Bus thing
871
872
If called like _is_dbus_thing("method") it returns a function
873
suitable for use as predicate to inspect.getmembers().
874
"""
875
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
876
False)
699
def _is_dbus_property(obj):
700
return getattr(obj, "_dbus_is_property", False)
877
701
878
def _get_all_dbus_things(self, thing):
702
def _get_all_dbus_properties(self):
879
703
"""Returns a generator of (name, attribute) pairs
880
704
"""
881
return ((getattr(athing.__get__(self), "_dbus_name", name),
882
athing.__get__(self))
705
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
883
706
for cls in self.__class__.__mro__
884
for name, athing in
885
inspect.getmembers(cls, self._is_dbus_thing(thing)))
707
for name, prop in
708
inspect.getmembers(cls, self._is_dbus_property))
886
709
887
710
def _get_dbus_property(self, interface_name, property_name):
888
711
"""Returns a bound method if one exists which is a D-Bus
889
712
property with the specified name and interface.
890
713
"""
891
for cls in self.__class__.__mro__:
892
for name, value in inspect.getmembers(
893
cls, self._is_dbus_thing("property")):
714
for cls in self.__class__.__mro__:
715
for name, value in (inspect.getmembers
716
(cls, self._is_dbus_property)):
894
717
if (value._dbus_name == property_name
895
718
and value._dbus_interface == interface_name):
896
719
return value.__get__(self)
897
720
898
721
# No such property
899
raise DBusPropertyNotFound("{}:{}.{}".format(
900
self.dbus_object_path, interface_name, property_name))
722
raise DBusPropertyNotFound(self.dbus_object_path + ":"
723
+ interface_name + "."
724
+ property_name)
901
725
902
@dbus.service.method(dbus.PROPERTIES_IFACE,
903
in_signature="ss",
726
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
904
727
out_signature="v")
905
728
def Get(self, interface_name, property_name):
906
729
"""Standard D-Bus property Get() method, see D-Bus standard.
924
747
# The byte_arrays option is not supported yet on
925
748
# signatures other than "ay".
926
749
if prop._dbus_signature != "ay":
927
raise ValueError("Byte arrays not supported for non-"
928
"'ay' signature {!r}"
929
.format(prop._dbus_signature))
930
value = dbus.ByteArray(b''.join(chr(byte)
931
for byte in value))
750
raise ValueError
751
value = dbus.ByteArray(''.join(unichr(byte)
752
for byte in value))
932
753
prop(value)
933
754
934
@dbus.service.method(dbus.PROPERTIES_IFACE,
935
in_signature="s",
755
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
936
756
out_signature="a{sv}")
937
757
def GetAll(self, interface_name):
938
758
"""Standard D-Bus property GetAll() method, see D-Bus
940
760
941
761
Note: Will not include properties with access="write".
942
762
"""
943
properties = {}
944
for name, prop in self._get_all_dbus_things("property"):
763
all = {}
764
for name, prop in self._get_all_dbus_properties():
945
765
if (interface_name
946
766
and interface_name != prop._dbus_interface):
947
767
# Interface non-empty but did not match
951
771
continue
952
772
value = prop()
953
773
if not hasattr(value, "variant_level"):
954
properties[name] = value
774
all[name] = value
955
775
continue
956
properties[name] = type(value)(
957
value, variant_level = value.variant_level + 1)
958
return dbus.Dictionary(properties, signature="sv")
959
960
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
961
def PropertiesChanged(self, interface_name, changed_properties,
962
invalidated_properties):
963
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
964
standard.
965
"""
966
pass
776
all[name] = type(value)(value, variant_level=
777
value.variant_level+1)
778
return dbus.Dictionary(all, signature="sv")
967
779
968
780
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
969
781
out_signature="s",
970
782
path_keyword='object_path',
971
783
connection_keyword='connection')
972
784
def Introspect(self, object_path, connection):
973
"""Overloading of standard D-Bus method.
974
975
Inserts property tags and interface annotation tags.
785
"""Standard D-Bus method, overloaded to insert property tags.
976
786
"""
977
787
xmlstring = dbus.service.Object.Introspect(self, object_path,
978
788
connection)
979
789
try:
980
790
document = xml.dom.minidom.parseString(xmlstring)
981
982
791
def make_tag(document, name, prop):
983
792
e = document.createElement("property")
984
793
e.setAttribute("name", name)
985
794
e.setAttribute("type", prop._dbus_signature)
986
795
e.setAttribute("access", prop._dbus_access)
987
796
return e
988
989
797
for if_tag in document.getElementsByTagName("interface"):
990
# Add property tags
991
798
for tag in (make_tag(document, name, prop)
992
799
for name, prop
993
in self._get_all_dbus_things("property")
800
in self._get_all_dbus_properties()
994
801
if prop._dbus_interface
995
802
== if_tag.getAttribute("name")):
996
803
if_tag.appendChild(tag)
997
# Add annotation tags
998
for typ in ("method", "signal", "property"):
999
for tag in if_tag.getElementsByTagName(typ):
1000
annots = dict()
1001
for name, prop in (self.
1002
_get_all_dbus_things(typ)):
1003
if (name == tag.getAttribute("name")
1004
and prop._dbus_interface
1005
== if_tag.getAttribute("name")):
1006
annots.update(getattr(
1007
prop, "_dbus_annotations", {}))
1008
for name, value in annots.items():
1009
ann_tag = document.createElement(
1010
"annotation")
1011
ann_tag.setAttribute("name", name)
1012
ann_tag.setAttribute("value", value)
1013
tag.appendChild(ann_tag)
1014
# Add interface annotation tags
1015
for annotation, value in dict(
1016
itertools.chain.from_iterable(
1017
annotations().items()
1018
for name, annotations
1019
in self._get_all_dbus_things("interface")
1020
if name == if_tag.getAttribute("name")
1021
)).items():
1022
ann_tag = document.createElement("annotation")
1023
ann_tag.setAttribute("name", annotation)
1024
ann_tag.setAttribute("value", value)
1025
if_tag.appendChild(ann_tag)
1026
804
# Add the names to the return values for the
1027
805
# "org.freedesktop.DBus.Properties" methods
1028
806
if (if_tag.getAttribute("name")
1043
821
except (AttributeError, xml.dom.DOMException,
1044
822
xml.parsers.expat.ExpatError) as error:
1045
823
logger.error("Failed to override Introspection method",
1046
exc_info=error)
824
error)
1047
825
return xmlstring
1048
826
1049
827
1050
def datetime_to_dbus(dt, variant_level=0):
828
def datetime_to_dbus (dt, variant_level=0):
1051
829
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1052
830
if dt is None:
1053
831
return dbus.String("", variant_level = variant_level)
1054
return dbus.String(dt.isoformat(), variant_level=variant_level)
1055
1056
1057
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1058
"""A class decorator; applied to a subclass of
1059
dbus.service.Object, it will add alternate D-Bus attributes with
1060
interface names according to the "alt_interface_names" mapping.
1061
Usage:
1062
1063
@alternate_dbus_interfaces({"org.example.Interface":
1064
"net.example.AlternateInterface"})
1065
class SampleDBusObject(dbus.service.Object):
1066
@dbus.service.method("org.example.Interface")
1067
def SampleDBusMethod():
1068
pass
1069
1070
The above "SampleDBusMethod" on "SampleDBusObject" will be
1071
reachable via two interfaces: "org.example.Interface" and
1072
"net.example.AlternateInterface", the latter of which will have
1073
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1074
"true", unless "deprecate" is passed with a False value.
1075
1076
This works for methods and signals, and also for D-Bus properties
1077
(from DBusObjectWithProperties) and interfaces (from the
1078
dbus_interface_annotations decorator).
832
return dbus.String(dt.isoformat(),
833
variant_level=variant_level)
834
835
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
836
.__metaclass__):
837
"""Applied to an empty subclass of a D-Bus object, this metaclass
838
will add additional D-Bus attributes matching a certain pattern.
1079
839
"""
1080
1081
def wrapper(cls):
1082
for orig_interface_name, alt_interface_name in (
1083
alt_interface_names.items()):
1084
attr = {}
1085
interface_names = set()
1086
# Go though all attributes of the class
1087
for attrname, attribute in inspect.getmembers(cls):
840
def __new__(mcs, name, bases, attr):
841
# Go through all the base classes which could have D-Bus
842
# methods, signals, or properties in them
843
for base in (b for b in bases
844
if issubclass(b, dbus.service.Object)):
845
# Go though all attributes of the base class
846
for attrname, attribute in inspect.getmembers(base):
1088
847
# Ignore non-D-Bus attributes, and D-Bus attributes
1089
848
# with the wrong interface name
1090
849
if (not hasattr(attribute, "_dbus_interface")
1091
or not attribute._dbus_interface.startswith(
1092
orig_interface_name)):
850
or not attribute._dbus_interface
851
.startswith("se.recompile.Mandos")):
1093
852
continue
1094
853
# Create an alternate D-Bus interface name based on
1095
854
# the current name
1096
alt_interface = attribute._dbus_interface.replace(
1097
orig_interface_name, alt_interface_name)
1098
interface_names.add(alt_interface)
855
alt_interface = (attribute._dbus_interface
856
.replace("se.recompile.Mandos",
857
"se.bsnet.fukt.Mandos"))
1099
858
# Is this a D-Bus signal?
1100
859
if getattr(attribute, "_dbus_is_signal", False):
1101
# Extract the original non-method undecorated
1102
# function by black magic
860
# Extract the original non-method function by
861
# black magic
1103
862
nonmethod_func = (dict(
1104
zip(attribute.func_code.co_freevars,
1105
attribute.__closure__))
1106
["func"].cell_contents)
863
zip(attribute.func_code.co_freevars,
864
attribute.__closure__))["func"]
865
.cell_contents)
1107
866
# Create a new, but exactly alike, function
1108
867
# object, and decorate it to be a new D-Bus signal
1109
868
# with the alternate D-Bus interface name
1110
new_function = (dbus.service.signal(
1111
alt_interface, attribute._dbus_signature)
869
new_function = (dbus.service.signal
870
(alt_interface,
871
attribute._dbus_signature)
1112
872
(types.FunctionType(
1113
nonmethod_func.func_code,
1114
nonmethod_func.func_globals,
1115
nonmethod_func.func_name,
1116
nonmethod_func.func_defaults,
1117
nonmethod_func.func_closure)))
1118
# Copy annotations, if any
1119
try:
1120
new_function._dbus_annotations = dict(
1121
attribute._dbus_annotations)
1122
except AttributeError:
1123
pass
873
nonmethod_func.func_code,
874
nonmethod_func.func_globals,
875
nonmethod_func.func_name,
876
nonmethod_func.func_defaults,
877
nonmethod_func.func_closure)))
1124
878
# Define a creator of a function to call both the
1125
# original and alternate functions, so both the
1126
# original and alternate signals gets sent when
1127
# the function is called
879
# old and new functions, so both the old and new
880
# signals gets sent when the function is called
1128
881
def fixscope(func1, func2):
1129
882
"""This function is a scope container to pass
1130
883
func1 and func2 to the "call_both" function
1131
884
outside of its arguments"""
1132
1133
885
def call_both(*args, **kwargs):
1134
886
"""This function will emit two D-Bus
1135
887
signals by calling func1 and func2"""
1136
888
func1(*args, **kwargs)
1137
889
func2(*args, **kwargs)
1138
1139
890
return call_both
1140
891
# Create the "call_both" function and add it to
1141
892
# the class
1142
attr[attrname] = fixscope(attribute, new_function)
893
attr[attrname] = fixscope(attribute,
894
new_function)
1143
895
# Is this a D-Bus method?
1144
896
elif getattr(attribute, "_dbus_is_method", False):
1145
897
# Create a new, but exactly alike, function
1146
898
# object. Decorate it to be a new D-Bus method
1147
899
# with the alternate D-Bus interface name. Add it
1148
900
# to the class.
1149
attr[attrname] = (
1150
dbus.service.method(
1151
alt_interface,
1152
attribute._dbus_in_signature,
1153
attribute._dbus_out_signature)
1154
(types.FunctionType(attribute.func_code,
1155
attribute.func_globals,
1156
attribute.func_name,
1157
attribute.func_defaults,
1158
attribute.func_closure)))
1159
# Copy annotations, if any
1160
try:
1161
attr[attrname]._dbus_annotations = dict(
1162
attribute._dbus_annotations)
1163
except AttributeError:
1164
pass
901
attr[attrname] = (dbus.service.method
902
(alt_interface,
903
attribute._dbus_in_signature,
904
attribute._dbus_out_signature)
905
(types.FunctionType
906
(attribute.func_code,
907
attribute.func_globals,
908
attribute.func_name,
909
attribute.func_defaults,
910
attribute.func_closure)))
1165
911
# Is this a D-Bus property?
1166
912
elif getattr(attribute, "_dbus_is_property", False):
1167
913
# Create a new, but exactly alike, function
1168
914
# object, and decorate it to be a new D-Bus
1169
915
# property with the alternate D-Bus interface
1170
916
# name. Add it to the class.
1171
attr[attrname] = (dbus_service_property(
1172
alt_interface, attribute._dbus_signature,
1173
attribute._dbus_access,
1174
attribute._dbus_get_args_options
1175
["byte_arrays"])
1176
(types.FunctionType(
1177
attribute.func_code,
1178
attribute.func_globals,
1179
attribute.func_name,
1180
attribute.func_defaults,
1181
attribute.func_closure)))
1182
# Copy annotations, if any
1183
try:
1184
attr[attrname]._dbus_annotations = dict(
1185
attribute._dbus_annotations)
1186
except AttributeError:
1187
pass
1188
# Is this a D-Bus interface?
1189
elif getattr(attribute, "_dbus_is_interface", False):
1190
# Create a new, but exactly alike, function
1191
# object. Decorate it to be a new D-Bus interface
1192
# with the alternate D-Bus interface name. Add it
1193
# to the class.
1194
attr[attrname] = (
1195
dbus_interface_annotations(alt_interface)
1196
(types.FunctionType(attribute.func_code,
1197
attribute.func_globals,
1198
attribute.func_name,
1199
attribute.func_defaults,
1200
attribute.func_closure)))
1201
if deprecate:
1202
# Deprecate all alternate interfaces
1203
iname="_AlternateDBusNames_interface_annotation{}"
1204
for interface_name in interface_names:
1205
1206
@dbus_interface_annotations(interface_name)
1207
def func(self):
1208
return { "org.freedesktop.DBus.Deprecated":
1209
"true" }
1210
# Find an unused name
1211
for aname in (iname.format(i)
1212
for i in itertools.count()):
1213
if aname not in attr:
1214
attr[aname] = func
1215
break
1216
if interface_names:
1217
# Replace the class with a new subclass of it with
1218
# methods, signals, etc. as created above.
1219
cls = type(b"{}Alternate".format(cls.__name__),
1220
(cls, ), attr)
1221
return cls
1222
1223
return wrapper
1224
1225
1226
@alternate_dbus_interfaces({"se.recompile.Mandos":
1227
"se.bsnet.fukt.Mandos"})
917
attr[attrname] = (dbus_service_property
918
(alt_interface,
919
attribute._dbus_signature,
920
attribute._dbus_access,
921
attribute
922
._dbus_get_args_options
923
["byte_arrays"])
924
(types.FunctionType
925
(attribute.func_code,
926
attribute.func_globals,
927
attribute.func_name,
928
attribute.func_defaults,
929
attribute.func_closure)))
930
return type.__new__(mcs, name, bases, attr)
931
1228
932
class ClientDBus(Client, DBusObjectWithProperties):
1229
933
"""A Client class using D-Bus
1230
934
1234
938
"""
1235
939
1236
940
runtime_expansions = (Client.runtime_expansions
1237
+ ("dbus_object_path", ))
1238
1239
_interface = "se.recompile.Mandos.Client"
941
+ ("dbus_object_path",))
1240
942
1241
943
# dbus.service.Object doesn't use super(), so we can't either.
1242
944
1243
945
def __init__(self, bus = None, *args, **kwargs):
1244
946
self.bus = bus
1245
947
Client.__init__(self, *args, **kwargs)
948
949
self._approvals_pending = 0
1246
950
# Only now, when this client is initialized, can it show up on
1247
951
# the D-Bus
1248
client_object_name = str(self.name).translate(
952
client_object_name = unicode(self.name).translate(
1249
953
{ord("."): ord("_"),
1250
954
ord("-"): ord("_")})
1251
self.dbus_object_path = dbus.ObjectPath(
1252
"/clients/" + client_object_name)
955
self.dbus_object_path = (dbus.ObjectPath
956
("/clients/" + client_object_name))
1253
957
DBusObjectWithProperties.__init__(self, self.bus,
1254
958
self.dbus_object_path)
1255
1256
def notifychangeproperty(transform_func, dbus_name,
1257
type_func=lambda x: x,
1258
variant_level=1,
1259
invalidate_only=False,
1260
_interface=_interface):
959
960
def notifychangeproperty(transform_func,
961
dbus_name, type_func=lambda x: x,
962
variant_level=1):
1261
963
""" Modify a variable so that it's a property which announces
1262
964
its changes to DBus.
1263
965
1264
966
transform_fun: Function that takes a value and a variant_level
1265
967
and transforms it to a D-Bus type.
1266
968
dbus_name: D-Bus name of the variable
1268
970
to the D-Bus. Default: no transform
1269
971
variant_level: D-Bus variant level. Default: 1
1270
972
"""
1271
attrname = "_{}".format(dbus_name)
1272
973
attrname = "_{0}".format(dbus_name)
1273
974
def setter(self, value):
1274
975
if hasattr(self, "dbus_object_path"):
1275
976
if (not hasattr(self, attrname) or
1276
977
type_func(getattr(self, attrname, None))
1277
978
!= type_func(value)):
1278
if invalidate_only:
1279
self.PropertiesChanged(
1280
_interface, dbus.Dictionary(),
1281
dbus.Array((dbus_name, )))
1282
else:
1283
dbus_value = transform_func(
1284
type_func(value),
1285
variant_level = variant_level)
1286
self.PropertyChanged(dbus.String(dbus_name),
1287
dbus_value)
1288
self.PropertiesChanged(
1289
_interface,
1290
dbus.Dictionary({ dbus.String(dbus_name):
1291
dbus_value }),
1292
dbus.Array())
979
dbus_value = transform_func(type_func(value),
980
variant_level
981
=variant_level)
982
self.PropertyChanged(dbus.String(dbus_name),
983
dbus_value)
1293
984
setattr(self, attrname, value)
1294
985
1295
986
return property(lambda self: getattr(self, attrname), setter)
1296
987
988
1297
989
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1298
990
approvals_pending = notifychangeproperty(dbus.Boolean,
1299
991
"ApprovalPending",
1301
993
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1302
994
last_enabled = notifychangeproperty(datetime_to_dbus,
1303
995
"LastEnabled")
1304
checker = notifychangeproperty(
1305
dbus.Boolean, "CheckerRunning",
1306
type_func = lambda checker: checker is not None)
996
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
997
type_func = lambda checker:
998
checker is not None)
1307
999
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1308
1000
"LastCheckedOK")
1309
last_checker_status = notifychangeproperty(dbus.Int16,
1310
"LastCheckerStatus")
1311
1001
last_approval_request = notifychangeproperty(
1312
1002
datetime_to_dbus, "LastApprovalRequest")
1313
1003
approved_by_default = notifychangeproperty(dbus.Boolean,
1314
1004
"ApprovedByDefault")
1315
approval_delay = notifychangeproperty(
1316
dbus.UInt64, "ApprovalDelay",
1317
type_func = lambda td: td.total_seconds() * 1000)
1005
approval_delay = notifychangeproperty(dbus.UInt16,
1006
"ApprovalDelay",
1007
type_func =
1008
_timedelta_to_milliseconds)
1318
1009
approval_duration = notifychangeproperty(
1319
dbus.UInt64, "ApprovalDuration",
1320
type_func = lambda td: td.total_seconds() * 1000)
1010
dbus.UInt16, "ApprovalDuration",
1011
type_func = _timedelta_to_milliseconds)
1321
1012
host = notifychangeproperty(dbus.String, "Host")
1322
timeout = notifychangeproperty(
1323
dbus.UInt64, "Timeout",
1324
type_func = lambda td: td.total_seconds() * 1000)
1013
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1014
type_func =
1015
_timedelta_to_milliseconds)
1325
1016
extended_timeout = notifychangeproperty(
1326
dbus.UInt64, "ExtendedTimeout",
1327
type_func = lambda td: td.total_seconds() * 1000)
1328
interval = notifychangeproperty(
1329
dbus.UInt64, "Interval",
1330
type_func = lambda td: td.total_seconds() * 1000)
1017
dbus.UInt16, "ExtendedTimeout",
1018
type_func = _timedelta_to_milliseconds)
1019
interval = notifychangeproperty(dbus.UInt16,
1020
"Interval",
1021
type_func =
1022
_timedelta_to_milliseconds)
1331
1023
checker_command = notifychangeproperty(dbus.String, "Checker")
1332
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1333
invalidate_only=True)
1334
1024
1335
1025
del notifychangeproperty
1336
1026
1363
1053
*args, **kwargs)
1364
1054
1365
1055
def start_checker(self, *args, **kwargs):
1366
old_checker_pid = getattr(self.checker, "pid", None)
1056
old_checker = self.checker
1057
if self.checker is not None:
1058
old_checker_pid = self.checker.pid
1059
else:
1060
old_checker_pid = None
1367
1061
r = Client.start_checker(self, *args, **kwargs)
1368
1062
# Only if new checker process was started
1369
1063
if (self.checker is not None
1373
1067
return r
1374
1068
1375
1069
def _reset_approved(self):
1376
self.approved = None
1070
self._approved = None
1377
1071
return False
1378
1072
1379
1073
def approve(self, value=True):
1380
self.approved = value
1381
gobject.timeout_add(int(self.approval_duration.total_seconds()
1382
* 1000), self._reset_approved)
1383
1074
self.send_changedstate()
1075
self._approved = value
1076
gobject.timeout_add(_timedelta_to_milliseconds
1077
(self.approval_duration),
1078
self._reset_approved)
1079
1384
1080
1385
1081
## D-Bus methods, signals & properties
1386
1387
## Interfaces
1082
_interface = "se.recompile.Mandos.Client"
1388
1083
1389
1084
## Signals
1390
1085
1401
1096
pass
1402
1097
1403
1098
# PropertyChanged - signal
1404
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1405
1099
@dbus.service.signal(_interface, signature="sv")
1406
1100
def PropertyChanged(self, property, value):
1407
1101
"D-Bus signal"
1471
1165
return dbus.Boolean(bool(self.approvals_pending))
1472
1166
1473
1167
# ApprovedByDefault - property
1474
@dbus_service_property(_interface,
1475
signature="b",
1168
@dbus_service_property(_interface, signature="b",
1476
1169
access="readwrite")
1477
1170
def ApprovedByDefault_dbus_property(self, value=None):
1478
1171
if value is None: # get
1480
1173
self.approved_by_default = bool(value)
1481
1174
1482
1175
# ApprovalDelay - property
1483
@dbus_service_property(_interface,
1484
signature="t",
1176
@dbus_service_property(_interface, signature="t",
1485
1177
access="readwrite")
1486
1178
def ApprovalDelay_dbus_property(self, value=None):
1487
1179
if value is None: # get
1488
return dbus.UInt64(self.approval_delay.total_seconds()
1489
* 1000)
1180
return dbus.UInt64(self.approval_delay_milliseconds())
1490
1181
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1491
1182
1492
1183
# ApprovalDuration - property
1493
@dbus_service_property(_interface,
1494
signature="t",
1184
@dbus_service_property(_interface, signature="t",
1495
1185
access="readwrite")
1496
1186
def ApprovalDuration_dbus_property(self, value=None):
1497
1187
if value is None: # get
1498
return dbus.UInt64(self.approval_duration.total_seconds()
1499
* 1000)
1188
return dbus.UInt64(_timedelta_to_milliseconds(
1189
self.approval_duration))
1500
1190
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1501
1191
1502
1192
# Name - property
1510
1200
return dbus.String(self.fingerprint)
1511
1201
1512
1202
# Host - property
1513
@dbus_service_property(_interface,
1514
signature="s",
1203
@dbus_service_property(_interface, signature="s",
1515
1204
access="readwrite")
1516
1205
def Host_dbus_property(self, value=None):
1517
1206
if value is None: # get
1518
1207
return dbus.String(self.host)
1519
self.host = str(value)
1208
self.host = value
1520
1209
1521
1210
# Created - property
1522
1211
@dbus_service_property(_interface, signature="s", access="read")
1523
1212
def Created_dbus_property(self):
1524
return datetime_to_dbus(self.created)
1213
return dbus.String(datetime_to_dbus(self.created))
1525
1214
1526
1215
# LastEnabled - property
1527
1216
@dbus_service_property(_interface, signature="s", access="read")
1529
1218
return datetime_to_dbus(self.last_enabled)
1530
1219
1531
1220
# Enabled - property
1532
@dbus_service_property(_interface,
1533
signature="b",
1221
@dbus_service_property(_interface, signature="b",
1534
1222
access="readwrite")
1535
1223
def Enabled_dbus_property(self, value=None):
1536
1224
if value is None: # get
1541
1229
self.disable()
1542
1230
1543
1231
# LastCheckedOK - property
1544
@dbus_service_property(_interface,
1545
signature="s",
1232
@dbus_service_property(_interface, signature="s",
1546
1233
access="readwrite")
1547
1234
def LastCheckedOK_dbus_property(self, value=None):
1548
1235
if value is not None:
1550
1237
return
1551
1238
return datetime_to_dbus(self.last_checked_ok)
1552
1239
1553
# LastCheckerStatus - property
1554
@dbus_service_property(_interface, signature="n", access="read")
1555
def LastCheckerStatus_dbus_property(self):
1556
return dbus.Int16(self.last_checker_status)
1557
1558
1240
# Expires - property
1559
1241
@dbus_service_property(_interface, signature="s", access="read")
1560
1242
def Expires_dbus_property(self):
1566
1248
return datetime_to_dbus(self.last_approval_request)
1567
1249
1568
1250
# Timeout - property
1569
@dbus_service_property(_interface,
1570
signature="t",
1251
@dbus_service_property(_interface, signature="t",
1571
1252
access="readwrite")
1572
1253
def Timeout_dbus_property(self, value=None):
1573
1254
if value is None: # get
1574
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1575
old_timeout = self.timeout
1255
return dbus.UInt64(self.timeout_milliseconds())
1576
1256
self.timeout = datetime.timedelta(0, 0, 0, value)
1577
# Reschedule disabling
1578
if self.enabled:
1579
now = datetime.datetime.utcnow()
1580
self.expires += self.timeout - old_timeout
1581
if self.expires <= now:
1582
# The timeout has passed
1583
self.disable()
1584
else:
1585
if (getattr(self, "disable_initiator_tag", None)
1586
is None):
1587
return
1588
gobject.source_remove(self.disable_initiator_tag)
1589
self.disable_initiator_tag = gobject.timeout_add(
1590
int((self.expires - now).total_seconds() * 1000),
1591
self.disable)
1257
if getattr(self, "disable_initiator_tag", None) is None:
1258
return
1259
# Reschedule timeout
1260
gobject.source_remove(self.disable_initiator_tag)
1261
self.disable_initiator_tag = None
1262
self.expires = None
1263
time_to_die = _timedelta_to_milliseconds((self
1264
.last_checked_ok
1265
+ self.timeout)
1266
- datetime.datetime
1267
.utcnow())
1268
if time_to_die <= 0:
1269
# The timeout has passed
1270
self.disable()
1271
else:
1272
self.expires = (datetime.datetime.utcnow()
1273
+ datetime.timedelta(milliseconds =
1274
time_to_die))
1275
self.disable_initiator_tag = (gobject.timeout_add
1276
(time_to_die, self.disable))
1592
1277
1593
1278
# ExtendedTimeout - property
1594
@dbus_service_property(_interface,
1595
signature="t",
1279
@dbus_service_property(_interface, signature="t",
1596
1280
access="readwrite")
1597
1281
def ExtendedTimeout_dbus_property(self, value=None):
1598
1282
if value is None: # get
1599
return dbus.UInt64(self.extended_timeout.total_seconds()
1600
* 1000)
1283
return dbus.UInt64(self.extended_timeout_milliseconds())
1601
1284
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1602
1285
1603
1286
# Interval - property
1604
@dbus_service_property(_interface,
1605
signature="t",
1287
@dbus_service_property(_interface, signature="t",
1606
1288
access="readwrite")
1607
1289
def Interval_dbus_property(self, value=None):
1608
1290
if value is None: # get
1609
return dbus.UInt64(self.interval.total_seconds() * 1000)
1291
return dbus.UInt64(self.interval_milliseconds())
1610
1292
self.interval = datetime.timedelta(0, 0, 0, value)
1611
1293
if getattr(self, "checker_initiator_tag", None) is None:
1612
1294
return
1613
if self.enabled:
1614
# Reschedule checker run
1615
gobject.source_remove(self.checker_initiator_tag)
1616
self.checker_initiator_tag = gobject.timeout_add(
1617
value, self.start_checker)
1618
self.start_checker() # Start one now, too
1295
# Reschedule checker run
1296
gobject.source_remove(self.checker_initiator_tag)
1297
self.checker_initiator_tag = (gobject.timeout_add
1298
(value, self.start_checker))
1299
self.start_checker() # Start one now, too
1619
1300
1620
1301
# Checker - property
1621
@dbus_service_property(_interface,
1622
signature="s",
1302
@dbus_service_property(_interface, signature="s",
1623
1303
access="readwrite")
1624
1304
def Checker_dbus_property(self, value=None):
1625
1305
if value is None: # get
1626
1306
return dbus.String(self.checker_command)
1627
self.checker_command = str(value)
1307
self.checker_command = value
1628
1308
1629
1309
# CheckerRunning - property
1630
@dbus_service_property(_interface,
1631
signature="b",
1310
@dbus_service_property(_interface, signature="b",
1632
1311
access="readwrite")
1633
1312
def CheckerRunning_dbus_property(self, value=None):
1634
1313
if value is None: # get
1644
1323
return self.dbus_object_path # is already a dbus.ObjectPath
1645
1324
1646
1325
# Secret = property
1647
@dbus_service_property(_interface,
1648
signature="ay",
1649
access="write",
1650
byte_arrays=True)
1326
@dbus_service_property(_interface, signature="ay",
1327
access="write", byte_arrays=True)
1651
1328
def Secret_dbus_property(self, value):
1652
self.secret = bytes(value)
1329
self.secret = str(value)
1653
1330
1654
1331
del _interface
1655
1332
1662
1339
raise KeyError()
1663
1340
1664
1341
def __getattribute__(self, name):
1665
if name == '_pipe':
1342
if(name == '_pipe'):
1666
1343
return super(ProxyClient, self).__getattribute__(name)
1667
1344
self._pipe.send(('getattr', name))
1668
1345
data = self._pipe.recv()
1669
1346
if data[0] == 'data':
1670
1347
return data[1]
1671
1348
if data[0] == 'function':
1672
1673
1349
def func(*args, **kwargs):
1674
1350
self._pipe.send(('funcall', name, args, kwargs))
1675
1351
return self._pipe.recv()[1]
1676
1677
1352
return func
1678
1353
1679
1354
def __setattr__(self, name, value):
1680
if name == '_pipe':
1355
if(name == '_pipe'):
1681
1356
return super(ProxyClient, self).__setattr__(name, value)
1682
1357
self._pipe.send(('setattr', name, value))
1683
1358
1359
class ClientDBusTransitional(ClientDBus):
1360
__metaclass__ = AlternateDBusNamesMetaclass
1684
1361
1685
1362
class ClientHandler(socketserver.BaseRequestHandler, object):
1686
1363
"""A class to handle client connections.
1691
1368
def handle(self):
1692
1369
with contextlib.closing(self.server.child_pipe) as child_pipe:
1693
1370
logger.info("TCP connection from: %s",
1694
str(self.client_address))
1371
unicode(self.client_address))
1695
1372
logger.debug("Pipe FD: %d",
1696
1373
self.server.child_pipe.fileno())
1697
1374
1698
session = gnutls.connection.ClientSession(
1699
self.request, gnutls.connection .X509Credentials())
1375
session = (gnutls.connection
1376
.ClientSession(self.request,
1377
gnutls.connection
1378
.X509Credentials()))
1700
1379
1701
1380
# Note: gnutls.connection.X509Credentials is really a
1702
1381
# generic GnuTLS certificate credentials object so long as
1711
1390
priority = self.server.gnutls_priority
1712
1391
if priority is None:
1713
1392
priority = "NORMAL"
1714
gnutls.library.functions.gnutls_priority_set_direct(
1715
session._c_object, priority, None)
1393
(gnutls.library.functions
1394
.gnutls_priority_set_direct(session._c_object,
1395
priority, None))
1716
1396
1717
1397
# Start communication using the Mandos protocol
1718
1398
# Get protocol number
1720
1400
logger.debug("Protocol version: %r", line)
1721
1401
try:
1722
1402
if int(line.strip().split()[0]) > 1:
1723
raise RuntimeError(line)
1403
raise RuntimeError
1724
1404
except (ValueError, IndexError, RuntimeError) as error:
1725
1405
logger.error("Unknown protocol version: %s", error)
1726
1406
return
1738
1418
approval_required = False
1739
1419
try:
1740
1420
try:
1741
fpr = self.fingerprint(
1742
self.peer_certificate(session))
1421
fpr = self.fingerprint(self.peer_certificate
1422
(session))
1743
1423
except (TypeError,
1744
1424
gnutls.errors.GNUTLSError) as error:
1745
1425
logger.warning("Bad certificate: %s", error)
1760
1440
while True:
1761
1441
if not client.enabled:
1762
1442
logger.info("Client %s is disabled",
1763
client.name)
1443
client.name)
1764
1444
if self.server.use_dbus:
1765
1445
# Emit D-Bus signal
1766
1446
client.Rejected("Disabled")
1767
1447
return
1768
1448
1769
if client.approved or not client.approval_delay:
1449
if client._approved or not client.approval_delay:
1770
1450
#We are approved or approval is disabled
1771
1451
break
1772
elif client.approved is None:
1452
elif client._approved is None:
1773
1453
logger.info("Client %s needs approval",
1774
1454
client.name)
1775
1455
if self.server.use_dbus:
1776
1456
# Emit D-Bus signal
1777
1457
client.NeedApproval(
1778
client.approval_delay.total_seconds()
1779
* 1000, client.approved_by_default)
1458
client.approval_delay_milliseconds(),
1459
client.approved_by_default)
1780
1460
else:
1781
1461
logger.warning("Client %s was not approved",
1782
1462
client.name)
1788
1468
#wait until timeout or approved
1789
1469
time = datetime.datetime.now()
1790
1470
client.changedstate.acquire()
1791
client.changedstate.wait(delay.total_seconds())
1471
(client.changedstate.wait
1472
(float(client._timedelta_to_milliseconds(delay)
1473
/ 1000)))
1792
1474
client.changedstate.release()
1793
1475
time2 = datetime.datetime.now()
1794
1476
if (time2 - time) >= delay:
1810
1492
try:
1811
1493
sent = session.send(client.secret[sent_size:])
1812
1494
except gnutls.errors.GNUTLSError as error:
1813
logger.warning("gnutls send failed",
1814
exc_info=error)
1495
logger.warning("gnutls send failed")
1815
1496
return
1816
logger.debug("Sent: %d, remaining: %d", sent,
1817
len(client.secret) - (sent_size
1818
+ sent))
1497
logger.debug("Sent: %d, remaining: %d",
1498
sent, len(client.secret)
1499
- (sent_size + sent))
1819
1500
sent_size += sent
1820
1501
1821
1502
logger.info("Sending secret to %s", client.name)
1822
1503
# bump the timeout using extended_timeout
1823
client.bump_timeout(client.extended_timeout)
1504
client.checked_ok(client.extended_timeout)
1824
1505
if self.server.use_dbus:
1825
1506
# Emit D-Bus signal
1826
1507
client.GotSecret()
1831
1512
try:
1832
1513
session.bye()
1833
1514
except gnutls.errors.GNUTLSError as error:
1834
logger.warning("GnuTLS bye failed",
1835
exc_info=error)
1515
logger.warning("GnuTLS bye failed")
1836
1516
1837
1517
@staticmethod
1838
1518
def peer_certificate(session):
1839
1519
"Return the peer's OpenPGP certificate as a bytestring"
1840
1520
# If not an OpenPGP certificate...
1841
if (gnutls.library.functions.gnutls_certificate_type_get(
1842
session._c_object)
1521
if (gnutls.library.functions
1522
.gnutls_certificate_type_get(session._c_object)
1843
1523
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1844
1524
# ...do the normal thing
1845
1525
return session.peer_certificate
1859
1539
def fingerprint(openpgp):
1860
1540
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1861
1541
# New GnuTLS "datum" with the OpenPGP public key
1862
datum = gnutls.library.types.gnutls_datum_t(
1863
ctypes.cast(ctypes.c_char_p(openpgp),
1864
ctypes.POINTER(ctypes.c_ubyte)),
1865
ctypes.c_uint(len(openpgp)))
1542
datum = (gnutls.library.types
1543
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1544
ctypes.POINTER
1545
(ctypes.c_ubyte)),
1546
ctypes.c_uint(len(openpgp))))
1866
1547
# New empty GnuTLS certificate
1867
1548
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1868
gnutls.library.functions.gnutls_openpgp_crt_init(
1869
ctypes.byref(crt))
1549
(gnutls.library.functions
1550
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1870
1551
# Import the OpenPGP public key into the certificate
1871
gnutls.library.functions.gnutls_openpgp_crt_import(
1872
crt, ctypes.byref(datum),
1873
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1552
(gnutls.library.functions
1553
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1554
gnutls.library.constants
1555
.GNUTLS_OPENPGP_FMT_RAW))
1874
1556
# Verify the self signature in the key
1875
1557
crtverify = ctypes.c_uint()
1876
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1877
crt, 0, ctypes.byref(crtverify))
1558
(gnutls.library.functions
1559
.gnutls_openpgp_crt_verify_self(crt, 0,
1560
ctypes.byref(crtverify)))
1878
1561
if crtverify.value != 0:
1879
1562
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1880
raise gnutls.errors.CertificateSecurityError(
1881
"Verify failed")
1563
raise (gnutls.errors.CertificateSecurityError
1564
("Verify failed"))
1882
1565
# New buffer for the fingerprint
1883
1566
buf = ctypes.create_string_buffer(20)
1884
1567
buf_len = ctypes.c_size_t()
1885
1568
# Get the fingerprint from the certificate into the buffer
1886
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1887
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1569
(gnutls.library.functions
1570
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1571
ctypes.byref(buf_len)))
1888
1572
# Deinit the certificate
1889
1573
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1890
1574
# Convert the buffer to a Python bytestring
1891
1575
fpr = ctypes.string_at(buf, buf_len.value)
1892
1576
# Convert the bytestring to hexadecimal notation
1893
hex_fpr = binascii.hexlify(fpr).upper()
1577
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1894
1578
return hex_fpr
1895
1579
1896
1580
1897
1581
class MultiprocessingMixIn(object):
1898
1582
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1899
1900
1583
def sub_process_main(self, request, address):
1901
1584
try:
1902
1585
self.finish_request(request, address)
1903
except Exception:
1586
except:
1904
1587
self.handle_error(request, address)
1905
1588
self.close_request(request)
1906
1589
1907
1590
def process_request(self, request, address):
1908
1591
"""Start a new process to process the request."""
1909
1592
proc = multiprocessing.Process(target = self.sub_process_main,
1910
args = (request, address))
1593
args = (request,
1594
address))
1911
1595
proc.start()
1912
1596
return proc
1913
1597
1914
1598
1915
1599
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1916
1600
""" adds a pipe to the MixIn """
1917
1918
1601
def process_request(self, request, client_address):
1919
1602
"""Overrides and wraps the original process_request().
1920
1603
1929
1612
1930
1613
def add_pipe(self, parent_pipe, proc):
1931
1614
"""Dummy function; override as necessary"""
1932
raise NotImplementedError()
1615
raise NotImplementedError
1933
1616
1934
1617
1935
1618
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1941
1624
interface: None or a network interface name (string)
1942
1625
use_ipv6: Boolean; to use IPv6 or not
1943
1626
"""
1944
1945
1627
def __init__(self, server_address, RequestHandlerClass,
1946
interface=None,
1947
use_ipv6=True,
1948
socketfd=None):
1949
"""If socketfd is set, use that file descriptor instead of
1950
creating a new one with socket.socket().
1951
"""
1628
interface=None, use_ipv6=True):
1952
1629
self.interface = interface
1953
1630
if use_ipv6:
1954
1631
self.address_family = socket.AF_INET6
1955
if socketfd is not None:
1956
# Save the file descriptor
1957
self.socketfd = socketfd
1958
# Save the original socket.socket() function
1959
self.socket_socket = socket.socket
1960
# To implement --socket, we monkey patch socket.socket.
1961
#
1962
# (When socketserver.TCPServer is a new-style class, we
1963
# could make self.socket into a property instead of monkey
1964
# patching socket.socket.)
1965
#
1966
# Create a one-time-only replacement for socket.socket()
1967
@functools.wraps(socket.socket)
1968
def socket_wrapper(*args, **kwargs):
1969
# Restore original function so subsequent calls are
1970
# not affected.
1971
socket.socket = self.socket_socket
1972
del self.socket_socket
1973
# This time only, return a new socket object from the
1974
# saved file descriptor.
1975
return socket.fromfd(self.socketfd, *args, **kwargs)
1976
# Replace socket.socket() function with wrapper
1977
socket.socket = socket_wrapper
1978
# The socketserver.TCPServer.__init__ will call
1979
# socket.socket(), which might be our replacement,
1980
# socket_wrapper(), if socketfd was set.
1981
1632
socketserver.TCPServer.__init__(self, server_address,
1982
1633
RequestHandlerClass)
1983
1984
1634
def server_bind(self):
1985
1635
"""This overrides the normal server_bind() function
1986
1636
to bind to an interface if one was specified, and also NOT to
1992
1642
self.interface)
1993
1643
else:
1994
1644
try:
1995
self.socket.setsockopt(
1996
socket.SOL_SOCKET, SO_BINDTODEVICE,
1997
(self.interface + "\0").encode("utf-8"))
1645
self.socket.setsockopt(socket.SOL_SOCKET,
1646
SO_BINDTODEVICE,
1647
str(self.interface
1648
+ '\0'))
1998
1649
except socket.error as error:
1999
if error.errno == errno.EPERM:
2000
logger.error("No permission to bind to"
2001
" interface %s", self.interface)
2002
elif error.errno == errno.ENOPROTOOPT:
1650
if error[0] == errno.EPERM:
1651
logger.error("No permission to"
1652
" bind to interface %s",
1653
self.interface)
1654
elif error[0] == errno.ENOPROTOOPT:
2003
1655
logger.error("SO_BINDTODEVICE not available;"
2004
1656
" cannot bind to interface %s",
2005
1657
self.interface)
2006
elif error.errno == errno.ENODEV:
2007
logger.error("Interface %s does not exist,"
2008
" cannot bind", self.interface)
2009
1658
else:
2010
1659
raise
2011
1660
# Only bind(2) the socket if we really need to.
2014
1663
if self.address_family == socket.AF_INET6:
2015
1664
any_address = "::" # in6addr_any
2016
1665
else:
2017
any_address = "0.0.0.0" # INADDR_ANY
1666
any_address = socket.INADDR_ANY
2018
1667
self.server_address = (any_address,
2019
1668
self.server_address[1])
2020
1669
elif not self.server_address[1]:
2021
self.server_address = (self.server_address[0], 0)
1670
self.server_address = (self.server_address[0],
1671
0)
2022
1672
# if self.interface:
2023
1673
# self.server_address = (self.server_address[0],
2024
1674
# 0, # port
2038
1688
2039
1689
Assumes a gobject.MainLoop event loop.
2040
1690
"""
2041
2042
1691
def __init__(self, server_address, RequestHandlerClass,
2043
interface=None,
2044
use_ipv6=True,
2045
clients=None,
2046
gnutls_priority=None,
2047
use_dbus=True,
2048
socketfd=None):
1692
interface=None, use_ipv6=True, clients=None,
1693
gnutls_priority=None, use_dbus=True):
2049
1694
self.enabled = False
2050
1695
self.clients = clients
2051
1696
if self.clients is None:
2055
1700
IPv6_TCPServer.__init__(self, server_address,
2056
1701
RequestHandlerClass,
2057
1702
interface = interface,
2058
use_ipv6 = use_ipv6,
2059
socketfd = socketfd)
2060
1703
use_ipv6 = use_ipv6)
2061
1704
def server_activate(self):
2062
1705
if self.enabled:
2063
1706
return socketserver.TCPServer.server_activate(self)
2067
1710
2068
1711
def add_pipe(self, parent_pipe, proc):
2069
1712
# Call "handle_ipc" for both data and EOF events
2070
gobject.io_add_watch(
2071
parent_pipe.fileno(),
2072
gobject.IO_IN | gobject.IO_HUP,
2073
functools.partial(self.handle_ipc,
2074
parent_pipe = parent_pipe,
2075
proc = proc))
1713
gobject.io_add_watch(parent_pipe.fileno(),
1714
gobject.IO_IN | gobject.IO_HUP,
1715
functools.partial(self.handle_ipc,
1716
parent_pipe =
1717
parent_pipe,
1718
proc = proc))
2076
1719
2077
def handle_ipc(self, source, condition,
2078
parent_pipe=None,
2079
proc = None,
2080
client_object=None):
1720
def handle_ipc(self, source, condition, parent_pipe=None,
1721
proc = None, client_object=None):
1722
condition_names = {
1723
gobject.IO_IN: "IN", # There is data to read.
1724
gobject.IO_OUT: "OUT", # Data can be written (without
1725
# blocking).
1726
gobject.IO_PRI: "PRI", # There is urgent data to read.
1727
gobject.IO_ERR: "ERR", # Error condition.
1728
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1729
# broken, usually for pipes and
1730
# sockets).
1731
}
1732
conditions_string = ' | '.join(name
1733
for cond, name in
1734
condition_names.iteritems()
1735
if cond & condition)
2081
1736
# error, or the other end of multiprocessing.Pipe has closed
2082
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1737
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2083
1738
# Wait for other process to exit
2084
1739
proc.join()
2085
1740
return False
2106
1761
parent_pipe.send(False)
2107
1762
return False
2108
1763
2109
gobject.io_add_watch(
2110
parent_pipe.fileno(),
2111
gobject.IO_IN | gobject.IO_HUP,
2112
functools.partial(self.handle_ipc,
2113
parent_pipe = parent_pipe,
2114
proc = proc,
2115
client_object = client))
1764
gobject.io_add_watch(parent_pipe.fileno(),
1765
gobject.IO_IN | gobject.IO_HUP,
1766
functools.partial(self.handle_ipc,
1767
parent_pipe =
1768
parent_pipe,
1769
proc = proc,
1770
client_object =
1771
client))
2116
1772
parent_pipe.send(True)
2117
1773
# remove the old hook in favor of the new above hook on
2118
1774
# same fileno
2124
1780
2125
1781
parent_pipe.send(('data', getattr(client_object,
2126
1782
funcname)(*args,
2127
**kwargs)))
1783
**kwargs)))
2128
1784
2129
1785
if command == 'getattr':
2130
1786
attrname = request[1]
2131
1787
if callable(client_object.__getattribute__(attrname)):
2132
parent_pipe.send(('function', ))
1788
parent_pipe.send(('function',))
2133
1789
else:
2134
parent_pipe.send((
2135
'data', client_object.__getattribute__(attrname)))
1790
parent_pipe.send(('data', client_object
1791
.__getattribute__(attrname)))
2136
1792
2137
1793
if command == 'setattr':
2138
1794
attrname = request[1]
2142
1798
return True
2143
1799
2144
1800
2145
def rfc3339_duration_to_delta(duration):
2146
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2147
2148
>>> rfc3339_duration_to_delta("P7D")
2149
datetime.timedelta(7)
2150
>>> rfc3339_duration_to_delta("PT60S")
2151
datetime.timedelta(0, 60)
2152
>>> rfc3339_duration_to_delta("PT60M")
2153
datetime.timedelta(0, 3600)
2154
>>> rfc3339_duration_to_delta("PT24H")
2155
datetime.timedelta(1)
2156
>>> rfc3339_duration_to_delta("P1W")
2157
datetime.timedelta(7)
2158
>>> rfc3339_duration_to_delta("PT5M30S")
2159
datetime.timedelta(0, 330)
2160
>>> rfc3339_duration_to_delta("P1DT3M20S")
2161
datetime.timedelta(1, 200)
2162
"""
2163
2164
# Parsing an RFC 3339 duration with regular expressions is not
2165
# possible - there would have to be multiple places for the same
2166
# values, like seconds. The current code, while more esoteric, is
2167
# cleaner without depending on a parsing library. If Python had a
2168
# built-in library for parsing we would use it, but we'd like to
2169
# avoid excessive use of external libraries.
2170
2171
# New type for defining tokens, syntax, and semantics all-in-one
2172
Token = collections.namedtuple("Token",
2173
("regexp", # To match token; if
2174
# "value" is not None,
2175
# must have a "group"
2176
# containing digits
2177
"value", # datetime.timedelta or
2178
# None
2179
"followers")) # Tokens valid after
2180
# this token
2181
Token = collections.namedtuple("Token", (
2182
"regexp", # To match token; if "value" is not None, must have
2183
# a "group" containing digits
2184
"value", # datetime.timedelta or None
2185
"followers")) # Tokens valid after this token
2186
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2187
# the "duration" ABNF definition in RFC 3339, Appendix A.
2188
token_end = Token(re.compile(r"$"), None, frozenset())
2189
token_second = Token(re.compile(r"(\d+)S"),
2190
datetime.timedelta(seconds=1),
2191
frozenset((token_end, )))
2192
token_minute = Token(re.compile(r"(\d+)M"),
2193
datetime.timedelta(minutes=1),
2194
frozenset((token_second, token_end)))
2195
token_hour = Token(re.compile(r"(\d+)H"),
2196
datetime.timedelta(hours=1),
2197
frozenset((token_minute, token_end)))
2198
token_time = Token(re.compile(r"T"),
2199
None,
2200
frozenset((token_hour, token_minute,
2201
token_second)))
2202
token_day = Token(re.compile(r"(\d+)D"),
2203
datetime.timedelta(days=1),
2204
frozenset((token_time, token_end)))
2205
token_month = Token(re.compile(r"(\d+)M"),
2206
datetime.timedelta(weeks=4),
2207
frozenset((token_day, token_end)))
2208
token_year = Token(re.compile(r"(\d+)Y"),
2209
datetime.timedelta(weeks=52),
2210
frozenset((token_month, token_end)))
2211
token_week = Token(re.compile(r"(\d+)W"),
2212
datetime.timedelta(weeks=1),
2213
frozenset((token_end, )))
2214
token_duration = Token(re.compile(r"P"), None,
2215
frozenset((token_year, token_month,
2216
token_day, token_time,
2217
token_week)))
2218
# Define starting values
2219
value = datetime.timedelta() # Value so far
2220
found_token = None
2221
followers = frozenset((token_duration,)) # Following valid tokens
2222
s = duration # String left to parse
2223
# Loop until end token is found
2224
while found_token is not token_end:
2225
# Search for any currently valid tokens
2226
for token in followers:
2227
match = token.regexp.match(s)
2228
if match is not None:
2229
# Token found
2230
if token.value is not None:
2231
# Value found, parse digits
2232
factor = int(match.group(1), 10)
2233
# Add to value so far
2234
value += factor * token.value
2235
# Strip token from string
2236
s = token.regexp.sub("", s, 1)
2237
# Go to found token
2238
found_token = token
2239
# Set valid next tokens
2240
followers = found_token.followers
2241
break
2242
else:
2243
# No currently valid tokens were found
2244
raise ValueError("Invalid RFC 3339 duration")
2245
# End token found
2246
return value
2247
2248
2249
1801
def string_to_delta(interval):
2250
1802
"""Parse a string and return a datetime.timedelta
2251
1803
2262
1814
>>> string_to_delta('5m 30s')
2263
1815
datetime.timedelta(0, 330)
2264
1816
"""
2265
2266
try:
2267
return rfc3339_duration_to_delta(interval)
2268
except ValueError:
2269
pass
2270
2271
1817
timevalue = datetime.timedelta(0)
2272
1818
for s in interval.split():
2273
1819
try:
2274
suffix = s[-1]
1820
suffix = unicode(s[-1])
2275
1821
value = int(s[:-1])
2276
1822
if suffix == "d":
2277
1823
delta = datetime.timedelta(value)
2284
1830
elif suffix == "w":
2285
1831
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2286
1832
else:
2287
raise ValueError("Unknown suffix {!r}".format(suffix))
2288
except IndexError as e:
1833
raise ValueError("Unknown suffix %r" % suffix)
1834
except (ValueError, IndexError) as e:
2289
1835
raise ValueError(*(e.args))
2290
1836
timevalue += delta
2291
1837
return timevalue
2292
1838
2293
1839
1840
def if_nametoindex(interface):
1841
"""Call the C function if_nametoindex(), or equivalent
1842
1843
Note: This function cannot accept a unicode string."""
1844
global if_nametoindex
1845
try:
1846
if_nametoindex = (ctypes.cdll.LoadLibrary
1847
(ctypes.util.find_library("c"))
1848
.if_nametoindex)
1849
except (OSError, AttributeError):
1850
logger.warning("Doing if_nametoindex the hard way")
1851
def if_nametoindex(interface):
1852
"Get an interface index the hard way, i.e. using fcntl()"
1853
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1854
with contextlib.closing(socket.socket()) as s:
1855
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1856
struct.pack(str("16s16x"),
1857
interface))
1858
interface_index = struct.unpack(str("I"),
1859
ifreq[16:20])[0]
1860
return interface_index
1861
return if_nametoindex(interface)
1862
1863
2294
1864
def daemon(nochdir = False, noclose = False):
2295
1865
"""See daemon(3). Standard BSD Unix function.
2296
1866
2304
1874
sys.exit()
2305
1875
if not noclose:
2306
1876
# Close all standard open file descriptors
2307
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1877
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2308
1878
if not stat.S_ISCHR(os.fstat(null).st_mode):
2309
1879
raise OSError(errno.ENODEV,
2310
"{} not a character device"
2311
.format(os.devnull))
1880
"%s not a character device"
1881
% os.path.devnull)
2312
1882
os.dup2(null, sys.stdin.fileno())
2313
1883
os.dup2(null, sys.stdout.fileno())
2314
1884
os.dup2(null, sys.stderr.fileno())
2323
1893
2324
1894
parser = argparse.ArgumentParser()
2325
1895
parser.add_argument("-v", "--version", action="version",
2326
version = "%(prog)s {}".format(version),
1896
version = "%%(prog)s %s" % version,
2327
1897
help="show version number and exit")
2328
1898
parser.add_argument("-i", "--interface", metavar="IF",
2329
1899
help="Bind to interface IF")
2335
1905
help="Run self-test")
2336
1906
parser.add_argument("--debug", action="store_true",
2337
1907
help="Debug mode; run in foreground and log"
2338
" to terminal", default=None)
1908
" to terminal")
2339
1909
parser.add_argument("--debuglevel", metavar="LEVEL",
2340
1910
help="Debug level for stdout output")
2341
1911
parser.add_argument("--priority", help="GnuTLS"
2348
1918
" files")
2349
1919
parser.add_argument("--no-dbus", action="store_false",
2350
1920
dest="use_dbus", help="Do not provide D-Bus"
2351
" system bus interface", default=None)
1921
" system bus interface")
2352
1922
parser.add_argument("--no-ipv6", action="store_false",
2353
dest="use_ipv6", help="Do not use IPv6",
2354
default=None)
1923
dest="use_ipv6", help="Do not use IPv6")
2355
1924
parser.add_argument("--no-restore", action="store_false",
2356
dest="restore", help="Do not restore stored"
2357
" state", default=None)
2358
parser.add_argument("--socket", type=int,
2359
help="Specify a file descriptor to a network"
2360
" socket to use instead of creating one")
2361
parser.add_argument("--statedir", metavar="DIR",
2362
help="Directory to save/restore state in")
2363
parser.add_argument("--foreground", action="store_true",
2364
help="Run in foreground", default=None)
2365
parser.add_argument("--no-zeroconf", action="store_false",
2366
dest="zeroconf", help="Do not use Zeroconf",
2367
default=None)
2368
1925
dest="restore", help="Do not restore stored state",
1926
default=True)
1927
2369
1928
options = parser.parse_args()
2370
1929
2371
1930
if options.check:
2372
1931
import doctest
2373
fail_count, test_count = doctest.testmod()
2374
sys.exit(os.EX_OK if fail_count == 0 else 1)
1932
doctest.testmod()
1933
sys.exit()
2375
1934
2376
1935
# Default values for config file for server-global settings
2377
1936
server_defaults = { "interface": "",
2379
1938
"port": "",
2380
1939
"debug": "False",
2381
1940
"priority":
2382
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2383
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1941
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2384
1942
"servicename": "Mandos",
2385
1943
"use_dbus": "True",
2386
1944
"use_ipv6": "True",
2387
1945
"debuglevel": "",
2388
"restore": "True",
2389
"socket": "",
2390
"statedir": "/var/lib/mandos",
2391
"foreground": "False",
2392
"zeroconf": "True",
2393
}
1946
}
2394
1947
2395
1948
# Parse config file for server-global settings
2396
1949
server_config = configparser.SafeConfigParser(server_defaults)
2397
1950
del server_defaults
2398
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1951
server_config.read(os.path.join(options.configdir,
1952
"mandos.conf"))
2399
1953
# Convert the SafeConfigParser object to a dict
2400
1954
server_settings = server_config.defaults()
2401
1955
# Use the appropriate methods on the non-string config options
2402
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1956
for option in ("debug", "use_dbus", "use_ipv6"):
2403
1957
server_settings[option] = server_config.getboolean("DEFAULT",
2404
1958
option)
2405
1959
if server_settings["port"]:
2406
1960
server_settings["port"] = server_config.getint("DEFAULT",
2407
1961
"port")
2408
if server_settings["socket"]:
2409
server_settings["socket"] = server_config.getint("DEFAULT",
2410
"socket")
2411
# Later, stdin will, and stdout and stderr might, be dup'ed
2412
# over with an opened os.devnull. But we don't want this to
2413
# happen with a supplied network socket.
2414
if 0 <= server_settings["socket"] <= 2:
2415
server_settings["socket"] = os.dup(server_settings
2416
["socket"])
2417
1962
del server_config
2418
1963
2419
1964
# Override the settings from the config file with command line
2420
1965
# options, if set.
2421
1966
for option in ("interface", "address", "port", "debug",
2422
"priority", "servicename", "configdir", "use_dbus",
2423
"use_ipv6", "debuglevel", "restore", "statedir",
2424
"socket", "foreground", "zeroconf"):
1967
"priority", "servicename", "configdir",
1968
"use_dbus", "use_ipv6", "debuglevel", "restore"):
2425
1969
value = getattr(options, option)
2426
1970
if value is not None:
2427
1971
server_settings[option] = value
2428
1972
del options
2429
1973
# Force all strings to be unicode
2430
1974
for option in server_settings.keys():
2431
if isinstance(server_settings[option], bytes):
2432
server_settings[option] = (server_settings[option]
2433
.decode("utf-8"))
2434
# Force all boolean options to be boolean
2435
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2436
"foreground", "zeroconf"):
2437
server_settings[option] = bool(server_settings[option])
2438
# Debug implies foreground
2439
if server_settings["debug"]:
2440
server_settings["foreground"] = True
1975
if type(server_settings[option]) is str:
1976
server_settings[option] = unicode(server_settings[option])
2441
1977
# Now we have our good server settings in "server_settings"
2442
1978
2443
1979
##################################################################
2444
1980
2445
if (not server_settings["zeroconf"]
2446
and not (server_settings["port"]
2447
or server_settings["socket"] != "")):
2448
parser.error("Needs port or socket to work without Zeroconf")
2449
2450
1981
# For convenience
2451
1982
debug = server_settings["debug"]
2452
1983
debuglevel = server_settings["debuglevel"]
2453
1984
use_dbus = server_settings["use_dbus"]
2454
1985
use_ipv6 = server_settings["use_ipv6"]
2455
stored_state_path = os.path.join(server_settings["statedir"],
2456
stored_state_file)
2457
foreground = server_settings["foreground"]
2458
zeroconf = server_settings["zeroconf"]
2459
2460
if debug:
2461
initlogger(debug, logging.DEBUG)
2462
else:
2463
if not debuglevel:
2464
initlogger(debug)
2465
else:
2466
level = getattr(logging, debuglevel.upper())
2467
initlogger(debug, level)
2468
1986
2469
1987
if server_settings["servicename"] != "Mandos":
2470
syslogger.setFormatter(
2471
logging.Formatter('Mandos ({}) [%(process)d]:'
2472
' %(levelname)s: %(message)s'.format(
2473
server_settings["servicename"])))
1988
syslogger.setFormatter(logging.Formatter
1989
('Mandos (%s) [%%(process)d]:'
1990
' %%(levelname)s: %%(message)s'
1991
% server_settings["servicename"]))
2474
1992
2475
1993
# Parse config file with clients
2476
client_config = configparser.SafeConfigParser(Client
2477
.client_defaults)
1994
client_defaults = { "timeout": "5m",
1995
"extended_timeout": "15m",
1996
"interval": "2m",
1997
"checker": "fping -q -- %%(host)s",
1998
"host": "",
1999
"approval_delay": "0s",
2000
"approval_duration": "1s",
2001
}
2002
client_config = configparser.SafeConfigParser(client_defaults)
2478
2003
client_config.read(os.path.join(server_settings["configdir"],
2479
2004
"clients.conf"))
2480
2005
2481
2006
global mandos_dbus_service
2482
2007
mandos_dbus_service = None
2483
2008
2484
socketfd = None
2485
if server_settings["socket"] != "":
2486
socketfd = server_settings["socket"]
2487
tcp_server = MandosServer(
2488
(server_settings["address"], server_settings["port"]),
2489
ClientHandler,
2490
interface=(server_settings["interface"] or None),
2491
use_ipv6=use_ipv6,
2492
gnutls_priority=server_settings["priority"],
2493
use_dbus=use_dbus,
2494
socketfd=socketfd)
2495
if not foreground:
2496
pidfilename = "/run/mandos.pid"
2497
if not os.path.isdir("/run/."):
2498
pidfilename = "/var/run/mandos.pid"
2499
pidfile = None
2009
tcp_server = MandosServer((server_settings["address"],
2010
server_settings["port"]),
2011
ClientHandler,
2012
interface=(server_settings["interface"]
2013
or None),
2014
use_ipv6=use_ipv6,
2015
gnutls_priority=
2016
server_settings["priority"],
2017
use_dbus=use_dbus)
2018
if not debug:
2019
pidfilename = "/var/run/mandos.pid"
2500
2020
try:
2501
2021
pidfile = open(pidfilename, "w")
2502
except IOError as e:
2503
logger.error("Could not open file %r", pidfilename,
2504
exc_info=e)
2022
except IOError:
2023
logger.error("Could not open file %r", pidfilename)
2505
2024
2506
for name in ("_mandos", "mandos", "nobody"):
2025
try:
2026
uid = pwd.getpwnam("_mandos").pw_uid
2027
gid = pwd.getpwnam("_mandos").pw_gid
2028
except KeyError:
2507
2029
try:
2508
uid = pwd.getpwnam(name).pw_uid
2509
gid = pwd.getpwnam(name).pw_gid
2510
break
2030
uid = pwd.getpwnam("mandos").pw_uid
2031
gid = pwd.getpwnam("mandos").pw_gid
2511
2032
except KeyError:
2512
continue
2513
else:
2514
uid = 65534
2515
gid = 65534
2033
try:
2034
uid = pwd.getpwnam("nobody").pw_uid
2035
gid = pwd.getpwnam("nobody").pw_gid
2036
except KeyError:
2037
uid = 65534
2038
gid = 65534
2516
2039
try:
2517
2040
os.setgid(gid)
2518
2041
os.setuid(uid)
2519
2042
except OSError as error:
2520
if error.errno != errno.EPERM:
2521
raise
2043
if error[0] != errno.EPERM:
2044
raise error
2045
2046
if not debug and not debuglevel:
2047
logger.setLevel(logging.WARNING)
2048
if debuglevel:
2049
level = getattr(logging, debuglevel.upper())
2050
logger.setLevel(level)
2522
2051
2523
2052
if debug:
2053
logger.setLevel(logging.DEBUG)
2524
2054
# Enable all possible GnuTLS debugging
2525
2055
2526
2056
# "Use a log level over 10 to enable all debugging options."
2531
2061
def debug_gnutls(level, string):
2532
2062
logger.debug("GnuTLS: %s", string[:-1])
2533
2063
2534
gnutls.library.functions.gnutls_global_set_log_function(
2535
debug_gnutls)
2064
(gnutls.library.functions
2065
.gnutls_global_set_log_function(debug_gnutls))
2536
2066
2537
2067
# Redirect stdin so all checkers get /dev/null
2538
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2068
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2539
2069
os.dup2(null, sys.stdin.fileno())
2540
2070
if null > 2:
2541
2071
os.close(null)
2072
else:
2073
# No console logging
2074
logger.removeHandler(console)
2542
2075
2543
2076
# Need to fork before connecting to D-Bus
2544
if not foreground:
2077
if not debug:
2545
2078
# Close all input and output, do double fork, etc.
2546
2079
daemon()
2547
2080
2548
# multiprocessing will use threads, so before we use gobject we
2549
# need to inform gobject that threads will be used.
2550
gobject.threads_init()
2551
2552
2081
global main_loop
2553
2082
# From the Avahi example code
2554
DBusGMainLoop(set_as_default=True)
2083
DBusGMainLoop(set_as_default=True )
2555
2084
main_loop = gobject.MainLoop()
2556
2085
bus = dbus.SystemBus()
2557
2086
# End of Avahi example code
2558
2087
if use_dbus:
2559
2088
try:
2560
2089
bus_name = dbus.service.BusName("se.recompile.Mandos",
2561
bus,
2562
do_not_queue=True)
2563
old_bus_name = dbus.service.BusName(
2564
"se.bsnet.fukt.Mandos", bus,
2565
do_not_queue=True)
2090
bus, do_not_queue=True)
2091
old_bus_name = (dbus.service.BusName
2092
("se.bsnet.fukt.Mandos", bus,
2093
do_not_queue=True))
2566
2094
except dbus.exceptions.NameExistsException as e:
2567
logger.error("Disabling D-Bus:", exc_info=e)
2095
logger.error(unicode(e) + ", disabling D-Bus")
2568
2096
use_dbus = False
2569
2097
server_settings["use_dbus"] = False
2570
2098
tcp_server.use_dbus = False
2571
if zeroconf:
2572
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2573
service = AvahiServiceToSyslog(
2574
name = server_settings["servicename"],
2575
servicetype = "_mandos._tcp",
2576
protocol = protocol,
2577
bus = bus)
2578
if server_settings["interface"]:
2579
service.interface = if_nametoindex(
2580
server_settings["interface"].encode("utf-8"))
2099
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2100
service = AvahiServiceToSyslog(name =
2101
server_settings["servicename"],
2102
servicetype = "_mandos._tcp",
2103
protocol = protocol, bus = bus)
2104
if server_settings["interface"]:
2105
service.interface = (if_nametoindex
2106
(str(server_settings["interface"])))
2581
2107
2582
2108
global multiprocessing_manager
2583
2109
multiprocessing_manager = multiprocessing.Manager()
2584
2110
2585
2111
client_class = Client
2586
2112
if use_dbus:
2587
client_class = functools.partial(ClientDBus, bus = bus)
2588
2589
client_settings = Client.config_parser(client_config)
2113
client_class = functools.partial(ClientDBusTransitional,
2114
bus = bus)
2115
2116
special_settings = {
2117
# Some settings need to be accessd by special methods;
2118
# booleans need .getboolean(), etc. Here is a list of them:
2119
"approved_by_default":
2120
lambda section:
2121
client_config.getboolean(section, "approved_by_default"),
2122
}
2123
# Construct a new dict of client settings of this form:
2124
# { client_name: {setting_name: value, ...}, ...}
2125
# with exceptions for any special settings as defined above
2126
client_settings = dict((clientname,
2127
dict((setting,
2128
(value if setting not in special_settings
2129
else special_settings[setting](clientname)))
2130
for setting, value in client_config.items(clientname)))
2131
for clientname in client_config.sections())
2132
2590
2133
old_client_settings = {}
2591
clients_data = {}
2592
2593
# This is used to redirect stdout and stderr for checker processes
2594
global wnull
2595
wnull = open(os.devnull, "w") # A writable /dev/null
2596
# Only used if server is running in foreground but not in debug
2597
# mode
2598
if debug or not foreground:
2599
wnull.close()
2600
2601
# Get client data and settings from last running state.
2134
clients_data = []
2135
2136
# Get client data and settings from last running state.
2602
2137
if server_settings["restore"]:
2603
2138
try:
2604
2139
with open(stored_state_path, "rb") as stored_state:
2605
clients_data, old_client_settings = pickle.load(
2606
stored_state)
2140
clients_data, old_client_settings = pickle.load(stored_state)
2607
2141
os.remove(stored_state_path)
2608
2142
except IOError as e:
2609
if e.errno == errno.ENOENT:
2610
logger.warning("Could not load persistent state:"
2611
" {}".format(os.strerror(e.errno)))
2612
else:
2613
logger.critical("Could not load persistent state:",
2614
exc_info=e)
2143
logger.warning("Could not load persistant state: {0}".format(e))
2144
if e.errno != errno.ENOENT:
2615
2145
raise
2616
except EOFError as e:
2617
logger.warning("Could not load persistent state: "
2618
"EOFError:",
2619
exc_info=e)
2620
2621
with PGPEngine() as pgp:
2622
for client_name, client in clients_data.items():
2623
# Skip removed clients
2624
if client_name not in client_settings:
2625
continue
2626
2627
# Decide which value to use after restoring saved state.
2628
# We have three different values: Old config file,
2629
# new config file, and saved state.
2630
# New config value takes precedence if it differs from old
2631
# config value, otherwise use saved state.
2632
for name, value in client_settings[client_name].items():
2633
try:
2634
# For each value in new config, check if it
2635
# differs from the old config value (Except for
2636
# the "secret" attribute)
2637
if (name != "secret"
2638
and (value !=
2639
old_client_settings[client_name][name])):
2640
client[name] = value
2641
except KeyError:
2642
pass
2643
2644
# Clients who has passed its expire date can still be
2645
# enabled if its last checker was successful. Clients
2646
# whose checker succeeded before we stored its state is
2647
# assumed to have successfully run all checkers during
2648
# downtime.
2649
if client["enabled"]:
2650
if datetime.datetime.utcnow() >= client["expires"]:
2651
if not client["last_checked_ok"]:
2652
logger.warning(
2653
"disabling client {} - Client never "
2654
"performed a successful checker".format(
2655
client_name))
2656
client["enabled"] = False
2657
elif client["last_checker_status"] != 0:
2658
logger.warning(
2659
"disabling client {} - Client last"
2660
" checker failed with error code"
2661
" {}".format(
2662
client_name,
2663
client["last_checker_status"]))
2664
client["enabled"] = False
2665
else:
2666
client["expires"] = (
2667
datetime.datetime.utcnow()
2668
+ client["timeout"])
2669
logger.debug("Last checker succeeded,"
2670
" keeping {} enabled".format(
2671
client_name))
2146
2147
for client in clients_data:
2148
client_name = client["name"]
2149
2150
# Decide which value to use after restoring saved state.
2151
# We have three different values: Old config file,
2152
# new config file, and saved state.
2153
# New config value takes precedence if it differs from old
2154
# config value, otherwise use saved state.
2155
for name, value in client_settings[client_name].items():
2672
2156
try:
2673
client["secret"] = pgp.decrypt(
2674
client["encrypted_secret"],
2675
client_settings[client_name]["secret"])
2676
except PGPError:
2677
# If decryption fails, we use secret from new settings
2678
logger.debug("Failed to decrypt {} old secret".format(
2679
client_name))
2680
client["secret"] = (client_settings[client_name]
2681
["secret"])
2682
2683
# Add/remove clients based on new changes made to config
2684
for client_name in (set(old_client_settings)
2685
- set(client_settings)):
2686
del clients_data[client_name]
2687
for client_name in (set(client_settings)
2688
- set(old_client_settings)):
2689
clients_data[client_name] = client_settings[client_name]
2690
2691
# Create all client objects
2692
for client_name, client in clients_data.items():
2693
tcp_server.clients[client_name] = client_class(
2694
name = client_name,
2695
settings = client,
2696
server_settings = server_settings)
2697
2157
# For each value in new config, check if it differs
2158
# from the old config value (Except for the "secret"
2159
# attribute)
2160
if name != "secret" and value != old_client_settings[client_name][name]:
2161
setattr(client, name, value)
2162
except KeyError:
2163
pass
2164
2165
# Clients who has passed its expire date, can still be enabled if its
2166
# last checker was sucessful. Clients who checkers failed before we
2167
# stored it state is asumed to had failed checker during downtime.
2168
if client["enabled"] and client["last_checked_ok"]:
2169
if ((datetime.datetime.utcnow() - client["last_checked_ok"])
2170
> client["interval"]):
2171
if client["last_checker_status"] != 0:
2172
client["enabled"] = False
2173
else:
2174
client["expires"] = datetime.datetime.utcnow() + client["timeout"]
2175
2176
client["changedstate"] = (multiprocessing_manager
2177
.Condition(multiprocessing_manager
2178
.Lock()))
2179
if use_dbus:
2180
new_client = ClientDBusTransitional.__new__(ClientDBusTransitional)
2181
tcp_server.clients[client_name] = new_client
2182
new_client.bus = bus
2183
for name, value in client.iteritems():
2184
setattr(new_client, name, value)
2185
client_object_name = unicode(client_name).translate(
2186
{ord("."): ord("_"),
2187
ord("-"): ord("_")})
2188
new_client.dbus_object_path = (dbus.ObjectPath
2189
("/clients/" + client_object_name))
2190
DBusObjectWithProperties.__init__(new_client,
2191
new_client.bus,
2192
new_client.dbus_object_path)
2193
else:
2194
tcp_server.clients[client_name] = Client.__new__(Client)
2195
for name, value in client.iteritems():
2196
setattr(tcp_server.clients[client_name], name, value)
2197
2198
tcp_server.clients[client_name].decrypt_secret(
2199
client_settings[client_name]["secret"])
2200
2201
# Create/remove clients based on new changes made to config
2202
for clientname in set(old_client_settings) - set(client_settings):
2203
del tcp_server.clients[clientname]
2204
for clientname in set(client_settings) - set(old_client_settings):
2205
tcp_server.clients[clientname] = (client_class(name = clientname,
2206
config =
2207
client_settings
2208
[clientname]))
2209
2210
2698
2211
if not tcp_server.clients:
2699
2212
logger.warning("No clients defined")
2700
2701
if not foreground:
2702
if pidfile is not None:
2703
try:
2704
with pidfile:
2705
pid = os.getpid()
2706
pidfile.write("{}\n".format(pid).encode("utf-8"))
2707
except IOError:
2708
logger.error("Could not write to file %r with PID %d",
2709
pidfilename, pid)
2710
del pidfile
2213
2214
if not debug:
2215
try:
2216
with pidfile:
2217
pid = os.getpid()
2218
pidfile.write(str(pid) + "\n".encode("utf-8"))
2219
del pidfile
2220
except IOError:
2221
logger.error("Could not write to file %r with PID %d",
2222
pidfilename, pid)
2223
except NameError:
2224
# "pidfile" was never created
2225
pass
2711
2226
del pidfilename
2227
2228
signal.signal(signal.SIGINT, signal.SIG_IGN)
2712
2229
2713
2230
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2714
2231
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2715
2232
2716
2233
if use_dbus:
2717
2718
@alternate_dbus_interfaces(
2719
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2720
class MandosDBusService(DBusObjectWithProperties):
2234
class MandosDBusService(dbus.service.Object):
2721
2235
"""A D-Bus proxy object"""
2722
2723
2236
def __init__(self):
2724
2237
dbus.service.Object.__init__(self, bus, "/")
2725
2726
2238
_interface = "se.recompile.Mandos"
2727
2239
2728
@dbus_interface_annotations(_interface)
2729
def _foo(self):
2730
return {
2731
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2732
"false" }
2733
2734
2240
@dbus.service.signal(_interface, signature="o")
2735
2241
def ClientAdded(self, objpath):
2736
2242
"D-Bus signal"
2749
2255
@dbus.service.method(_interface, out_signature="ao")
2750
2256
def GetAllClients(self):
2751
2257
"D-Bus method"
2752
return dbus.Array(c.dbus_object_path for c in
2258
return dbus.Array(c.dbus_object_path
2259
for c in
2753
2260
tcp_server.clients.itervalues())
2754
2261
2755
2262
@dbus.service.method(_interface,
2757
2264
def GetAllClientsWithProperties(self):
2758
2265
"D-Bus method"
2759
2266
return dbus.Dictionary(
2760
{ c.dbus_object_path: c.GetAll("")
2761
for c in tcp_server.clients.itervalues() },
2267
((c.dbus_object_path, c.GetAll(""))
2268
for c in tcp_server.clients.itervalues()),
2762
2269
signature="oa{sv}")
2763
2270
2764
2271
@dbus.service.method(_interface, in_signature="o")
2777
2284
2778
2285
del _interface
2779
2286
2780
mandos_dbus_service = MandosDBusService()
2287
class MandosDBusServiceTransitional(MandosDBusService):
2288
__metaclass__ = AlternateDBusNamesMetaclass
2289
mandos_dbus_service = MandosDBusServiceTransitional()
2781
2290
2782
2291
def cleanup():
2783
2292
"Cleanup function; run on exit"
2784
if zeroconf:
2785
service.cleanup()
2293
service.cleanup()
2786
2294
2787
2295
multiprocessing.active_children()
2788
wnull.close()
2789
2296
if not (tcp_server.clients or client_settings):
2790
2297
return
2791
2792
# Store client before exiting. Secrets are encrypted with key
2793
# based on what config file has. If config file is
2794
# removed/edited, old secret will thus be unrecovable.
2795
clients = {}
2796
with PGPEngine() as pgp:
2797
for client in tcp_server.clients.itervalues():
2798
key = client_settings[client.name]["secret"]
2799
client.encrypted_secret = pgp.encrypt(client.secret,
2800
key)
2801
client_dict = {}
2802
2803
# A list of attributes that can not be pickled
2804
# + secret.
2805
exclude = { "bus", "changedstate", "secret",
2806
"checker", "server_settings" }
2807
for name, typ in inspect.getmembers(dbus.service
2808
.Object):
2809
exclude.add(name)
2810
2811
client_dict["encrypted_secret"] = (client
2812
.encrypted_secret)
2813
for attr in client.client_structure:
2814
if attr not in exclude:
2815
client_dict[attr] = getattr(client, attr)
2816
2817
clients[client.name] = client_dict
2818
del client_settings[client.name]["secret"]
2819
2298
2299
# Store client before exiting. Secrets are encrypted with key based
2300
# on what config file has. If config file is removed/edited, old
2301
# secret will thus be unrecovable.
2302
clients = []
2303
for client in tcp_server.clients.itervalues():
2304
client.encrypt_secret(client_settings[client.name]["secret"])
2305
2306
client_dict = {}
2307
2308
# A list of attributes that will not be stored when shuting down.
2309
exclude = set(("bus", "changedstate", "secret"))
2310
for name, typ in inspect.getmembers(dbus.service.Object):
2311
exclude.add(name)
2312
2313
client_dict["encrypted_secret"] = client.encrypted_secret
2314
for attr in client.client_structure:
2315
if attr not in exclude:
2316
client_dict[attr] = getattr(client, attr)
2317
2318
clients.append(client_dict)
2319
del client_settings[client.name]["secret"]
2320
2820
2321
try:
2821
with tempfile.NamedTemporaryFile(
2822
mode='wb',
2823
suffix=".pickle",
2824
prefix='clients-',
2825
dir=os.path.dirname(stored_state_path),
2826
delete=False) as stored_state:
2322
with os.fdopen(os.open(stored_state_path, os.O_CREAT|os.O_WRONLY|os.O_TRUNC, 0600), "wb") as stored_state:
2827
2323
pickle.dump((clients, client_settings), stored_state)
2828
tempname = stored_state.name
2829
os.rename(tempname, stored_state_path)
2830
except (IOError, OSError) as e:
2831
if not debug:
2832
try:
2833
os.remove(tempname)
2834
except NameError:
2835
pass
2836
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2837
logger.warning("Could not save persistent state: {}"
2838
.format(os.strerror(e.errno)))
2839
else:
2840
logger.warning("Could not save persistent state:",
2841
exc_info=e)
2324
except IOError as e:
2325
logger.warning("Could not save persistant state: {0}".format(e))
2326
if e.errno != errno.ENOENT:
2842
2327
raise
2843
2328
2844
2329
# Delete all clients, and settings from config
2845
2330
while tcp_server.clients:
2846
2331
name, client = tcp_server.clients.popitem()
2850
2335
client.disable(quiet=True)
2851
2336
if use_dbus:
2852
2337
# Emit D-Bus signal
2853
mandos_dbus_service.ClientRemoved(
2854
client.dbus_object_path, client.name)
2338
mandos_dbus_service.ClientRemoved(client
2339
.dbus_object_path,
2340
client.name)
2855
2341
client_settings.clear()
2856
2342
2857
2343
atexit.register(cleanup)
2863
2349
# Need to initiate checking of clients
2864
2350
if client.enabled:
2865
2351
client.init_checker()
2352
2866
2353
2867
2354
tcp_server.enable()
2868
2355
tcp_server.server_activate()
2869
2356
2870
2357
# Find out what port we got
2871
if zeroconf:
2872
service.port = tcp_server.socket.getsockname()[1]
2358
service.port = tcp_server.socket.getsockname()[1]
2873
2359
if use_ipv6:
2874
2360
logger.info("Now listening on address %r, port %d,"
2875
" flowinfo %d, scope_id %d",
2876
*tcp_server.socket.getsockname())
2361
" flowinfo %d, scope_id %d"
2362
% tcp_server.socket.getsockname())
2877
2363
else: # IPv4
2878
logger.info("Now listening on address %r, port %d",
2879
*tcp_server.socket.getsockname())
2364
logger.info("Now listening on address %r, port %d"
2365
% tcp_server.socket.getsockname())
2880
2366
2881
2367
#service.interface = tcp_server.socket.getsockname()[3]
2882
2368
2883
2369
try:
2884
if zeroconf:
2885
# From the Avahi example code
2886
try:
2887
service.activate()
2888
except dbus.exceptions.DBusException as error:
2889
logger.critical("D-Bus Exception", exc_info=error)
2890
cleanup()
2891
sys.exit(1)
2892
# End of Avahi example code
2370
# From the Avahi example code
2371
try:
2372
service.activate()
2373
except dbus.exceptions.DBusException as error:
2374
logger.critical("DBusException: %s", error)
2375
cleanup()
2376
sys.exit(1)
2377
# End of Avahi example code
2893
2378
2894
2379
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2895
2380
lambda *args, **kwargs:
2899
2384
logger.debug("Starting main loop")
2900
2385
main_loop.run()
2901
2386
except AvahiError as error:
2902
logger.critical("Avahi Error", exc_info=error)
2387
logger.critical("AvahiError: %s", error)
2903
2388
cleanup()
2904
2389
sys.exit(1)
2905
2390
except KeyboardInterrupt:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0