To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 237.14.5
- compare with another revision
- download diff
- download tarball
- view history from revision 237.14.5
- Committer: Teddy Hogeborn
- Date: 2011-11-27 19:52:18 UTC
- mfrom: (237.12.9 mandos-persistent)
- mto: (237.12.11 mandos-persistent)
- mto: This revision was merged to the branch mainline in revision 290.
- Revision ID: teddy@recompile.se-20111127195218-l9ebhccxqwdlfy08
Merge
- 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
67
65
import types
68
66
import binascii
69
67
import tempfile
70
import itertools
71
import collections
72
68
73
69
import dbus
74
70
import dbus.service
79
75
import ctypes.util
80
76
import xml.dom.minidom
81
77
import inspect
78
import GnuPGInterface
82
79
83
80
try:
84
81
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
85
except ImportError:
89
86
SO_BINDTODEVICE = None
90
87
91
if sys.version_info.major == 2:
92
str = unicode
93
88
94
version = "1.6.9"
89
version = "1.4.1"
95
90
stored_state_file = "clients.pickle"
96
91
97
92
logger = logging.getLogger()
98
syslogger = None
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
99
96
100
97
try:
101
if_nametoindex = ctypes.cdll.LoadLibrary(
102
ctypes.util.find_library("c")).if_nametoindex
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
100
.if_nametoindex)
103
101
except (OSError, AttributeError):
104
105
102
def if_nametoindex(interface):
106
103
"Get an interface index the hard way, i.e. using fcntl()"
107
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
108
105
with contextlib.closing(socket.socket()) as s:
109
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
110
struct.pack(b"16s16x", interface))
111
interface_index = struct.unpack("I", ifreq[16:20])[0]
107
struct.pack(str("16s16x"),
108
interface))
109
interface_index = struct.unpack(str("I"),
110
ifreq[16:20])[0]
112
111
return interface_index
113
112
114
113
115
def initlogger(debug, level=logging.WARNING):
114
def initlogger(level=logging.WARNING):
116
115
"""init logger and add loglevel"""
117
116
118
global syslogger
119
syslogger = (logging.handlers.SysLogHandler(
120
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
121
address = "/dev/log"))
122
117
syslogger.setFormatter(logging.Formatter
123
118
('Mandos [%(process)d]: %(levelname)s:'
124
119
' %(message)s'))
125
120
logger.addHandler(syslogger)
126
121
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)
122
console = logging.StreamHandler()
123
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
124
' [%(process)d]:'
125
' %(levelname)s:'
126
' %(message)s'))
127
logger.addHandler(console)
134
128
logger.setLevel(level)
135
129
136
130
141
135
142
136
class PGPEngine(object):
143
137
"""A simple class for OpenPGP symmetric encryption & decryption"""
144
145
138
def __init__(self):
139
self.gnupg = GnuPGInterface.GnuPG()
146
140
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
147
self.gnupgargs = ['--batch',
148
'--home', self.tempdir,
149
'--force-mdc',
150
'--quiet',
151
'--no-use-agent']
141
self.gnupg = GnuPGInterface.GnuPG()
142
self.gnupg.options.meta_interactive = False
143
self.gnupg.options.homedir = self.tempdir
144
self.gnupg.options.extra_args.extend(['--force-mdc',
145
'--quiet'])
152
146
153
147
def __enter__(self):
154
148
return self
155
149
156
def __exit__(self, exc_type, exc_value, traceback):
150
def __exit__ (self, exc_type, exc_value, traceback):
157
151
self._cleanup()
158
152
return False
159
153
176
170
def password_encode(self, password):
177
171
# Passphrase can not be empty and can not contain newlines or
178
172
# 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
173
return b"mandos" + binascii.hexlify(password)
186
174
187
175
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)
176
self.gnupg.passphrase = self.password_encode(password)
177
with open(os.devnull) as devnull:
178
try:
179
proc = self.gnupg.run(['--symmetric'],
180
create_fhs=['stdin', 'stdout'],
181
attach_fhs={'stderr': devnull})
182
with contextlib.closing(proc.handles['stdin']) as f:
183
f.write(data)
184
with contextlib.closing(proc.handles['stdout']) as f:
185
ciphertext = f.read()
186
proc.wait()
187
except IOError as e:
188
raise PGPError(e)
189
self.gnupg.passphrase = None
203
190
return ciphertext
204
191
205
192
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)
193
self.gnupg.passphrase = self.password_encode(password)
194
with open(os.devnull) as devnull:
195
try:
196
proc = self.gnupg.run(['--decrypt'],
197
create_fhs=['stdin', 'stdout'],
198
attach_fhs={'stderr': devnull})
199
with contextlib.closing(proc.handles['stdin'] ) as f:
200
f.write(data)
201
with contextlib.closing(proc.handles['stdout']) as f:
202
decrypted_plaintext = f.read()
203
proc.wait()
204
except IOError as e:
205
raise PGPError(e)
206
self.gnupg.passphrase = None
221
207
return decrypted_plaintext
222
208
223
209
210
224
211
class AvahiError(Exception):
225
212
def __init__(self, value, *args, **kwargs):
226
213
self.value = value
227
return super(AvahiError, self).__init__(value, *args,
228
**kwargs)
229
214
super(AvahiError, self).__init__(value, *args, **kwargs)
215
def __unicode__(self):
216
return unicode(repr(self.value))
230
217
231
218
class AvahiServiceError(AvahiError):
232
219
pass
233
220
234
235
221
class AvahiGroupError(AvahiError):
236
222
pass
237
223
244
230
Used to optionally bind to the specified interface.
245
231
name: string; Example: 'Mandos'
246
232
type: string; Example: '_mandos._tcp'.
247
See <https://www.iana.org/assignments/service-names-port-numbers>
233
See <http://www.dns-sd.org/ServiceTypes.html>
248
234
port: integer; what port to announce
249
235
TXT: list of strings; TXT record for the service
250
236
domain: string; Domain to publish on, default to .local if empty.
256
242
server: D-Bus Server
257
243
bus: dbus.SystemBus()
258
244
"""
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):
245
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
246
servicetype = None, port = None, TXT = None,
247
domain = "", host = "", max_renames = 32768,
248
protocol = avahi.PROTO_UNSPEC, bus = None):
271
249
self.interface = interface
272
250
self.name = name
273
251
self.type = servicetype
282
260
self.server = None
283
261
self.bus = bus
284
262
self.entry_group_state_changed_match = None
285
286
def rename(self, remove=True):
263
def rename(self):
287
264
"""Derived from the Avahi example code"""
288
265
if self.rename_count >= self.max_renames:
289
266
logger.critical("No suitable Zeroconf service name found"
290
267
" after %i retries, exiting.",
291
268
self.rename_count)
292
269
raise AvahiServiceError("Too many renames")
293
self.name = str(
294
self.server.GetAlternativeServiceName(self.name))
295
self.rename_count += 1
270
self.name = unicode(self.server
271
.GetAlternativeServiceName(self.name))
296
272
logger.info("Changing Zeroconf service name to %r ...",
297
273
self.name)
298
if remove:
299
self.remove()
274
self.remove()
300
275
try:
301
276
self.add()
302
277
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
278
logger.critical("DBusException: %s", error)
279
self.cleanup()
280
os._exit(1)
281
self.rename_count += 1
312
282
def remove(self):
313
283
"""Derived from the Avahi example code"""
314
284
if self.entry_group_state_changed_match is not None:
316
286
self.entry_group_state_changed_match = None
317
287
if self.group is not None:
318
288
self.group.Reset()
319
320
289
def add(self):
321
290
"""Derived from the Avahi example code"""
322
291
self.remove()
339
308
dbus.UInt16(self.port),
340
309
avahi.string_array_to_txt_array(self.TXT))
341
310
self.group.Commit()
342
343
311
def entry_group_state_changed(self, state, error):
344
312
"""Derived from the Avahi example code"""
345
313
logger.debug("Avahi entry group state change: %i", state)
351
319
self.rename()
352
320
elif state == avahi.ENTRY_GROUP_FAILURE:
353
321
logger.critical("Avahi: Error in group state changed %s",
354
str(error))
355
raise AvahiGroupError("State changed: {!s}".format(error))
356
322
unicode(error))
323
raise AvahiGroupError("State changed: %s"
324
% unicode(error))
357
325
def cleanup(self):
358
326
"""Derived from the Avahi example code"""
359
327
if self.group is not None:
364
332
pass
365
333
self.group = None
366
334
self.remove()
367
368
335
def server_state_changed(self, state, error=None):
369
336
"""Derived from the Avahi example code"""
370
337
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
}
338
bad_states = { avahi.SERVER_INVALID:
339
"Zeroconf server invalid",
340
avahi.SERVER_REGISTERING: None,
341
avahi.SERVER_COLLISION:
342
"Zeroconf server name collision",
343
avahi.SERVER_FAILURE:
344
"Zeroconf server failure" }
377
345
if state in bad_states:
378
346
if bad_states[state] is not None:
379
347
if error is None:
388
356
logger.debug("Unknown state: %r", state)
389
357
else:
390
358
logger.debug("Unknown state: %r: %r", state, error)
391
392
359
def activate(self):
393
360
"""Derived from the Avahi example code"""
394
361
if self.server is None:
398
365
follow_name_owner_changes=True),
399
366
avahi.DBUS_INTERFACE_SERVER)
400
367
self.server.connect_to_signal("StateChanged",
401
self.server_state_changed)
368
self.server_state_changed)
402
369
self.server_state_changed(self.server.GetState())
403
370
404
405
371
class AvahiServiceToSyslog(AvahiService):
406
def rename(self, *args, **kwargs):
372
def rename(self):
407
373
"""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)))
374
ret = AvahiService.rename(self)
375
syslogger.setFormatter(logging.Formatter
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
378
% self.name))
412
379
return ret
413
380
414
381
def timedelta_to_milliseconds(td):
382
"Convert a datetime.timedelta() to milliseconds"
383
return ((td.days * 24 * 60 * 60 * 1000)
384
+ (td.seconds * 1000)
385
+ (td.microseconds // 1000))
386
415
387
class Client(object):
416
388
"""A representation of a client host served by this server.
417
389
440
412
interval: datetime.timedelta(); How often to start a new checker
441
413
last_approval_request: datetime.datetime(); (UTC) or None
442
414
last_checked_ok: datetime.datetime(); (UTC) or None
415
443
416
last_checker_status: integer between 0 and 255 reflecting exit
444
417
status of last checker. -1 reflects crashed
445
checker, -2 means no checker completed yet.
418
checker, or None.
446
419
last_enabled: datetime.datetime(); (UTC) or None
447
420
name: string; from the config file, used in log messages and
448
421
D-Bus identifiers
449
422
secret: bytestring; sent verbatim (over TLS) to client
450
423
timeout: datetime.timedelta(); How long from last_checked_ok
451
424
until this client is disabled
452
extended_timeout: extra long timeout when secret has been sent
425
extended_timeout: extra long timeout when password has been sent
453
426
runtime_expansions: Allowed attributes for runtime expansion.
454
427
expires: datetime.datetime(); time (UTC) when a client will be
455
428
disabled, or None
456
server_settings: The server_settings dict from main()
457
429
"""
458
430
459
431
runtime_expansions = ("approval_delay", "approval_duration",
460
"created", "enabled", "expires",
461
"fingerprint", "host", "interval",
462
"last_approval_request", "last_checked_ok",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
463
434
"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):
435
436
def timeout_milliseconds(self):
437
"Return the 'timeout' attribute in milliseconds"
438
return timedelta_to_milliseconds(self.timeout)
439
440
def extended_timeout_milliseconds(self):
441
"Return the 'extended_timeout' attribute in milliseconds"
442
return timedelta_to_milliseconds(self.extended_timeout)
443
444
def interval_milliseconds(self):
445
"Return the 'interval' attribute in milliseconds"
446
return timedelta_to_milliseconds(self.interval)
447
448
def approval_delay_milliseconds(self):
449
return timedelta_to_milliseconds(self.approval_delay)
450
451
def __init__(self, name = None, config=None):
452
"""Note: the 'checker' key in 'config' sets the
453
'checker_command' attribute and *not* the 'checker'
454
attribute."""
527
455
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
456
if config is None:
457
config = {}
545
458
logger.debug("Creating client %r", self.name)
459
# Uppercase and remove spaces from fingerprint for later
460
# comparison purposes with return value from the fingerprint()
461
# function
462
self.fingerprint = (config["fingerprint"].upper()
463
.replace(" ", ""))
546
464
logger.debug(" Fingerprint: %s", self.fingerprint)
547
self.created = settings.get("created",
548
datetime.datetime.utcnow())
549
550
# attributes specific for this server instance
465
if "secret" in config:
466
self.secret = config["secret"].decode("base64")
467
elif "secfile" in config:
468
with open(os.path.expanduser(os.path.expandvars
469
(config["secfile"])),
470
"rb") as secfile:
471
self.secret = secfile.read()
472
else:
473
raise TypeError("No secret or secfile for client %s"
474
% self.name)
475
self.host = config.get("host", "")
476
self.created = datetime.datetime.utcnow()
477
self.enabled = config.get("enabled", True)
478
self.last_approval_request = None
479
if self.enabled:
480
self.last_enabled = datetime.datetime.utcnow()
481
else:
482
self.last_enabled = None
483
self.last_checked_ok = None
484
self.last_checker_status = None
485
self.timeout = string_to_delta(config["timeout"])
486
self.extended_timeout = string_to_delta(config
487
["extended_timeout"])
488
self.interval = string_to_delta(config["interval"])
551
489
self.checker = None
552
490
self.checker_initiator_tag = None
553
491
self.disable_initiator_tag = None
492
if self.enabled:
493
self.expires = datetime.datetime.utcnow() + self.timeout
494
else:
495
self.expires = None
554
496
self.checker_callback_tag = None
497
self.checker_command = config["checker"]
555
498
self.current_checker_command = None
556
499
self.approved = None
500
self.approved_by_default = config.get("approved_by_default",
501
True)
557
502
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()
503
self.approval_delay = string_to_delta(
504
config["approval_delay"])
505
self.approval_duration = string_to_delta(
506
config["approval_duration"])
507
self.changedstate = (multiprocessing_manager
508
.Condition(multiprocessing_manager
509
.Lock()))
510
self.client_structure = [attr for attr in
511
self.__dict__.iterkeys()
562
512
if not attr.startswith("_")]
563
513
self.client_structure.append("client_structure")
564
514
565
for name, t in inspect.getmembers(
566
type(self), lambda obj: isinstance(obj, property)):
515
for name, t in inspect.getmembers(type(self),
516
lambda obj:
517
isinstance(obj,
518
property)):
567
519
if not name.startswith("_"):
568
520
self.client_structure.append(name)
569
521
577
529
if getattr(self, "enabled", False):
578
530
# Already enabled
579
531
return
532
self.send_changedstate()
580
533
self.expires = datetime.datetime.utcnow() + self.timeout
581
534
self.enabled = True
582
535
self.last_enabled = datetime.datetime.utcnow()
583
536
self.init_checker()
584
self.send_changedstate()
585
537
586
538
def disable(self, quiet=True):
587
539
"""Disable this client."""
588
540
if not getattr(self, "enabled", False):
589
541
return False
590
542
if not quiet:
543
self.send_changedstate()
544
if not quiet:
591
545
logger.info("Disabling client %s", self.name)
592
if getattr(self, "disable_initiator_tag", None) is not None:
546
if getattr(self, "disable_initiator_tag", False):
593
547
gobject.source_remove(self.disable_initiator_tag)
594
548
self.disable_initiator_tag = None
595
549
self.expires = None
596
if getattr(self, "checker_initiator_tag", None) is not None:
550
if getattr(self, "checker_initiator_tag", False):
597
551
gobject.source_remove(self.checker_initiator_tag)
598
552
self.checker_initiator_tag = None
599
553
self.stop_checker()
600
554
self.enabled = False
601
if not quiet:
602
self.send_changedstate()
603
555
# Do not run this again if called by a gobject.timeout_add
604
556
return False
605
557
609
561
def init_checker(self):
610
562
# Schedule a new checker to be started an 'interval' from now,
611
563
# 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)
564
self.checker_initiator_tag = (gobject.timeout_add
565
(self.interval_milliseconds(),
566
self.start_checker))
617
567
# 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)
568
self.disable_initiator_tag = (gobject.timeout_add
569
(self.timeout_milliseconds(),
570
self.disable))
622
571
# Also start a new checker *right now*.
623
572
self.start_checker()
624
573
627
576
self.checker_callback_tag = None
628
577
self.checker = None
629
578
if os.WIFEXITED(condition):
630
self.last_checker_status = os.WEXITSTATUS(condition)
579
self.last_checker_status = os.WEXITSTATUS(condition)
631
580
if self.last_checker_status == 0:
632
581
logger.info("Checker for %(name)s succeeded",
633
582
vars(self))
634
583
self.checked_ok()
635
584
else:
636
logger.info("Checker for %(name)s failed", vars(self))
585
logger.info("Checker for %(name)s failed",
586
vars(self))
637
587
else:
638
588
self.last_checker_status = -1
639
589
logger.warning("Checker for %(name)s crashed?",
640
590
vars(self))
641
591
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."""
592
def checked_ok(self, timeout=None):
593
"""Bump up the timeout for this client.
594
595
This should only be called when the client has been seen,
596
alive and well.
597
"""
650
598
if timeout is None:
651
599
timeout = self.timeout
600
self.last_checked_ok = datetime.datetime.utcnow()
652
601
if self.disable_initiator_tag is not None:
653
602
gobject.source_remove(self.disable_initiator_tag)
654
self.disable_initiator_tag = None
655
603
if getattr(self, "enabled", False):
656
self.disable_initiator_tag = gobject.timeout_add(
657
int(timeout.total_seconds() * 1000), self.disable)
604
self.disable_initiator_tag = (gobject.timeout_add
605
(timedelta_to_milliseconds
606
(timeout), self.disable))
658
607
self.expires = datetime.datetime.utcnow() + timeout
659
608
660
609
def need_approval(self):
666
615
If a checker already exists, leave it running and do
667
616
nothing."""
668
617
# 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
618
# did that, then if a checker (for some reason) started
619
# running slowly and taking more than 'interval' time, the
620
# client would inevitably timeout, since no checker would get
621
# a chance to run to completion. If we instead leave running
673
622
# checkers alone, the checker would have to take more time
674
623
# than 'timeout' for the client to be disabled, which is as it
675
624
# should be.
677
626
# If a checker exists, make sure it is not a zombie
678
627
try:
679
628
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
629
except (AttributeError, OSError) as error:
630
if (isinstance(error, OSError)
631
and error.errno != errno.ECHILD):
632
raise error
685
633
else:
686
634
if pid:
687
635
logger.warning("Checker was a zombie")
690
638
self.current_checker_command)
691
639
# Start a new checker if needed
692
640
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
641
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
642
# In case checker_command has exactly one % operator
643
command = self.checker_command % self.host
644
except TypeError:
645
# Escape attributes for the shell
646
escaped_attrs = dict(
647
(attr,
648
re.escape(unicode(str(getattr(self, attr, "")),
649
errors=
650
'replace')))
651
for attr in
652
self.runtime_expansions)
653
654
try:
655
command = self.checker_command % escaped_attrs
656
except TypeError as error:
657
logger.error('Could not format string "%s":'
658
' %s', self.checker_command, error)
659
return True # Try again later
704
660
self.current_checker_command = command
705
661
try:
706
logger.info("Starting checker %r for %s", command,
707
self.name)
662
logger.info("Starting checker %r for %s",
663
command, self.name)
708
664
# We don't need to redirect stdout and stderr, since
709
665
# in normal mode, that is already done by daemon(),
710
666
# and in debug mode we don't want to. (Stdin is
711
667
# 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
668
self.checker = subprocess.Popen(command,
721
669
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:
670
shell=True, cwd="/")
671
self.checker_callback_tag = (gobject.child_watch_add
672
(self.checker.pid,
673
self.checker_callback,
674
data=command))
675
# The checker may have completed before the gobject
676
# watch was added. Check for this.
734
677
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
678
if pid:
679
gobject.source_remove(self.checker_callback_tag)
680
self.checker_callback(pid, status, command)
735
681
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)
682
logger.error("Failed to start subprocess: %s",
683
error)
745
684
# Re-run this periodically if run by gobject.timeout_add
746
685
return True
747
686
754
693
return
755
694
logger.debug("Stopping checker for %(name)s", vars(self))
756
695
try:
757
self.checker.terminate()
696
os.kill(self.checker.pid, signal.SIGTERM)
758
697
#time.sleep(0.5)
759
698
#if self.checker.poll() is None:
760
# self.checker.kill()
699
# os.kill(self.checker.pid, signal.SIGKILL)
761
700
except OSError as error:
762
701
if error.errno != errno.ESRCH: # No such process
763
702
raise
764
703
self.checker = None
765
704
766
705
767
def dbus_service_property(dbus_interface,
768
signature="v",
769
access="readwrite",
770
byte_arrays=False):
706
def dbus_service_property(dbus_interface, signature="v",
707
access="readwrite", byte_arrays=False):
771
708
"""Decorators for marking methods of a DBusObjectWithProperties to
772
709
become properties on the D-Bus.
773
710
782
719
# "Set" method, so we fail early here:
783
720
if byte_arrays and signature != "ay":
784
721
raise ValueError("Byte arrays not supported for non-'ay'"
785
" signature {!r}".format(signature))
786
722
" signature %r" % signature)
787
723
def decorator(func):
788
724
func._dbus_is_property = True
789
725
func._dbus_interface = dbus_interface
794
730
func._dbus_name = func._dbus_name[:-14]
795
731
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
796
732
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
733
return decorator
840
734
841
735
842
736
class DBusPropertyException(dbus.exceptions.DBusException):
843
737
"""A base class for D-Bus property-related exceptions
844
738
"""
845
pass
739
def __unicode__(self):
740
return unicode(str(self))
846
741
847
742
848
743
class DBusPropertyAccessException(DBusPropertyException):
866
761
"""
867
762
868
763
@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)
764
def _is_dbus_property(obj):
765
return getattr(obj, "_dbus_is_property", False)
877
766
878
def _get_all_dbus_things(self, thing):
767
def _get_all_dbus_properties(self):
879
768
"""Returns a generator of (name, attribute) pairs
880
769
"""
881
return ((getattr(athing.__get__(self), "_dbus_name", name),
882
athing.__get__(self))
770
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
883
771
for cls in self.__class__.__mro__
884
for name, athing in
885
inspect.getmembers(cls, self._is_dbus_thing(thing)))
772
for name, prop in
773
inspect.getmembers(cls, self._is_dbus_property))
886
774
887
775
def _get_dbus_property(self, interface_name, property_name):
888
776
"""Returns a bound method if one exists which is a D-Bus
889
777
property with the specified name and interface.
890
778
"""
891
for cls in self.__class__.__mro__:
892
for name, value in inspect.getmembers(
893
cls, self._is_dbus_thing("property")):
779
for cls in self.__class__.__mro__:
780
for name, value in (inspect.getmembers
781
(cls, self._is_dbus_property)):
894
782
if (value._dbus_name == property_name
895
783
and value._dbus_interface == interface_name):
896
784
return value.__get__(self)
897
785
898
786
# No such property
899
raise DBusPropertyNotFound("{}:{}.{}".format(
900
self.dbus_object_path, interface_name, property_name))
787
raise DBusPropertyNotFound(self.dbus_object_path + ":"
788
+ interface_name + "."
789
+ property_name)
901
790
902
@dbus.service.method(dbus.PROPERTIES_IFACE,
903
in_signature="ss",
791
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
904
792
out_signature="v")
905
793
def Get(self, interface_name, property_name):
906
794
"""Standard D-Bus property Get() method, see D-Bus standard.
924
812
# The byte_arrays option is not supported yet on
925
813
# signatures other than "ay".
926
814
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))
815
raise ValueError
816
value = dbus.ByteArray(''.join(unichr(byte)
817
for byte in value))
932
818
prop(value)
933
819
934
@dbus.service.method(dbus.PROPERTIES_IFACE,
935
in_signature="s",
820
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
936
821
out_signature="a{sv}")
937
822
def GetAll(self, interface_name):
938
823
"""Standard D-Bus property GetAll() method, see D-Bus
941
826
Note: Will not include properties with access="write".
942
827
"""
943
828
properties = {}
944
for name, prop in self._get_all_dbus_things("property"):
829
for name, prop in self._get_all_dbus_properties():
945
830
if (interface_name
946
831
and interface_name != prop._dbus_interface):
947
832
# Interface non-empty but did not match
953
838
if not hasattr(value, "variant_level"):
954
839
properties[name] = value
955
840
continue
956
properties[name] = type(value)(
957
value, variant_level = value.variant_level + 1)
841
properties[name] = type(value)(value, variant_level=
842
value.variant_level+1)
958
843
return dbus.Dictionary(properties, signature="sv")
959
844
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
967
968
845
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
969
846
out_signature="s",
970
847
path_keyword='object_path',
971
848
connection_keyword='connection')
972
849
def Introspect(self, object_path, connection):
973
"""Overloading of standard D-Bus method.
974
975
Inserts property tags and interface annotation tags.
850
"""Standard D-Bus method, overloaded to insert property tags.
976
851
"""
977
852
xmlstring = dbus.service.Object.Introspect(self, object_path,
978
853
connection)
979
854
try:
980
855
document = xml.dom.minidom.parseString(xmlstring)
981
982
856
def make_tag(document, name, prop):
983
857
e = document.createElement("property")
984
858
e.setAttribute("name", name)
985
859
e.setAttribute("type", prop._dbus_signature)
986
860
e.setAttribute("access", prop._dbus_access)
987
861
return e
988
989
862
for if_tag in document.getElementsByTagName("interface"):
990
# Add property tags
991
863
for tag in (make_tag(document, name, prop)
992
864
for name, prop
993
in self._get_all_dbus_things("property")
865
in self._get_all_dbus_properties()
994
866
if prop._dbus_interface
995
867
== if_tag.getAttribute("name")):
996
868
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
869
# Add the names to the return values for the
1027
870
# "org.freedesktop.DBus.Properties" methods
1028
871
if (if_tag.getAttribute("name")
1043
886
except (AttributeError, xml.dom.DOMException,
1044
887
xml.parsers.expat.ExpatError) as error:
1045
888
logger.error("Failed to override Introspection method",
1046
exc_info=error)
889
error)
1047
890
return xmlstring
1048
891
1049
892
1050
def datetime_to_dbus(dt, variant_level=0):
893
def datetime_to_dbus (dt, variant_level=0):
1051
894
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1052
895
if dt is None:
1053
896
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).
897
return dbus.String(dt.isoformat(),
898
variant_level=variant_level)
899
900
901
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
902
.__metaclass__):
903
"""Applied to an empty subclass of a D-Bus object, this metaclass
904
will add additional D-Bus attributes matching a certain pattern.
1079
905
"""
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):
906
def __new__(mcs, name, bases, attr):
907
# Go through all the base classes which could have D-Bus
908
# methods, signals, or properties in them
909
for base in (b for b in bases
910
if issubclass(b, dbus.service.Object)):
911
# Go though all attributes of the base class
912
for attrname, attribute in inspect.getmembers(base):
1088
913
# Ignore non-D-Bus attributes, and D-Bus attributes
1089
914
# with the wrong interface name
1090
915
if (not hasattr(attribute, "_dbus_interface")
1091
or not attribute._dbus_interface.startswith(
1092
orig_interface_name)):
916
or not attribute._dbus_interface
917
.startswith("se.recompile.Mandos")):
1093
918
continue
1094
919
# Create an alternate D-Bus interface name based on
1095
920
# the current name
1096
alt_interface = attribute._dbus_interface.replace(
1097
orig_interface_name, alt_interface_name)
1098
interface_names.add(alt_interface)
921
alt_interface = (attribute._dbus_interface
922
.replace("se.recompile.Mandos",
923
"se.bsnet.fukt.Mandos"))
1099
924
# Is this a D-Bus signal?
1100
925
if getattr(attribute, "_dbus_is_signal", False):
1101
# Extract the original non-method undecorated
1102
# function by black magic
926
# Extract the original non-method function by
927
# black magic
1103
928
nonmethod_func = (dict(
1104
zip(attribute.func_code.co_freevars,
1105
attribute.__closure__))
1106
["func"].cell_contents)
929
zip(attribute.func_code.co_freevars,
930
attribute.__closure__))["func"]
931
.cell_contents)
1107
932
# Create a new, but exactly alike, function
1108
933
# object, and decorate it to be a new D-Bus signal
1109
934
# with the alternate D-Bus interface name
1110
new_function = (dbus.service.signal(
1111
alt_interface, attribute._dbus_signature)
935
new_function = (dbus.service.signal
936
(alt_interface,
937
attribute._dbus_signature)
1112
938
(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
939
nonmethod_func.func_code,
940
nonmethod_func.func_globals,
941
nonmethod_func.func_name,
942
nonmethod_func.func_defaults,
943
nonmethod_func.func_closure)))
1124
944
# 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
945
# old and new functions, so both the old and new
946
# signals gets sent when the function is called
1128
947
def fixscope(func1, func2):
1129
948
"""This function is a scope container to pass
1130
949
func1 and func2 to the "call_both" function
1131
950
outside of its arguments"""
1132
1133
951
def call_both(*args, **kwargs):
1134
952
"""This function will emit two D-Bus
1135
953
signals by calling func1 and func2"""
1136
954
func1(*args, **kwargs)
1137
955
func2(*args, **kwargs)
1138
1139
956
return call_both
1140
957
# Create the "call_both" function and add it to
1141
958
# the class
1142
attr[attrname] = fixscope(attribute, new_function)
959
attr[attrname] = fixscope(attribute,
960
new_function)
1143
961
# Is this a D-Bus method?
1144
962
elif getattr(attribute, "_dbus_is_method", False):
1145
963
# Create a new, but exactly alike, function
1146
964
# object. Decorate it to be a new D-Bus method
1147
965
# with the alternate D-Bus interface name. Add it
1148
966
# 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
967
attr[attrname] = (dbus.service.method
968
(alt_interface,
969
attribute._dbus_in_signature,
970
attribute._dbus_out_signature)
971
(types.FunctionType
972
(attribute.func_code,
973
attribute.func_globals,
974
attribute.func_name,
975
attribute.func_defaults,
976
attribute.func_closure)))
1165
977
# Is this a D-Bus property?
1166
978
elif getattr(attribute, "_dbus_is_property", False):
1167
979
# Create a new, but exactly alike, function
1168
980
# object, and decorate it to be a new D-Bus
1169
981
# property with the alternate D-Bus interface
1170
982
# 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"})
983
attr[attrname] = (dbus_service_property
984
(alt_interface,
985
attribute._dbus_signature,
986
attribute._dbus_access,
987
attribute
988
._dbus_get_args_options
989
["byte_arrays"])
990
(types.FunctionType
991
(attribute.func_code,
992
attribute.func_globals,
993
attribute.func_name,
994
attribute.func_defaults,
995
attribute.func_closure)))
996
return type.__new__(mcs, name, bases, attr)
997
998
1228
999
class ClientDBus(Client, DBusObjectWithProperties):
1229
1000
"""A Client class using D-Bus
1230
1001
1234
1005
"""
1235
1006
1236
1007
runtime_expansions = (Client.runtime_expansions
1237
+ ("dbus_object_path", ))
1238
1239
_interface = "se.recompile.Mandos.Client"
1008
+ ("dbus_object_path",))
1240
1009
1241
1010
# dbus.service.Object doesn't use super(), so we can't either.
1242
1011
1243
1012
def __init__(self, bus = None, *args, **kwargs):
1244
1013
self.bus = bus
1245
1014
Client.__init__(self, *args, **kwargs)
1015
1016
self._approvals_pending = 0
1246
1017
# Only now, when this client is initialized, can it show up on
1247
1018
# the D-Bus
1248
client_object_name = str(self.name).translate(
1019
client_object_name = unicode(self.name).translate(
1249
1020
{ord("."): ord("_"),
1250
1021
ord("-"): ord("_")})
1251
self.dbus_object_path = dbus.ObjectPath(
1252
"/clients/" + client_object_name)
1022
self.dbus_object_path = (dbus.ObjectPath
1023
("/clients/" + client_object_name))
1253
1024
DBusObjectWithProperties.__init__(self, self.bus,
1254
1025
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):
1026
1027
def notifychangeproperty(transform_func,
1028
dbus_name, type_func=lambda x: x,
1029
variant_level=1):
1261
1030
""" Modify a variable so that it's a property which announces
1262
1031
its changes to DBus.
1263
1032
1268
1037
to the D-Bus. Default: no transform
1269
1038
variant_level: D-Bus variant level. Default: 1
1270
1039
"""
1271
attrname = "_{}".format(dbus_name)
1272
1040
attrname = "_{0}".format(dbus_name)
1273
1041
def setter(self, value):
1274
1042
if hasattr(self, "dbus_object_path"):
1275
1043
if (not hasattr(self, attrname) or
1276
1044
type_func(getattr(self, attrname, None))
1277
1045
!= 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())
1046
dbus_value = transform_func(type_func(value),
1047
variant_level
1048
=variant_level)
1049
self.PropertyChanged(dbus.String(dbus_name),
1050
dbus_value)
1293
1051
setattr(self, attrname, value)
1294
1052
1295
1053
return property(lambda self: getattr(self, attrname), setter)
1296
1054
1055
1297
1056
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1298
1057
approvals_pending = notifychangeproperty(dbus.Boolean,
1299
1058
"ApprovalPending",
1301
1060
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1302
1061
last_enabled = notifychangeproperty(datetime_to_dbus,
1303
1062
"LastEnabled")
1304
checker = notifychangeproperty(
1305
dbus.Boolean, "CheckerRunning",
1306
type_func = lambda checker: checker is not None)
1063
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1064
type_func = lambda checker:
1065
checker is not None)
1307
1066
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1308
1067
"LastCheckedOK")
1309
last_checker_status = notifychangeproperty(dbus.Int16,
1310
"LastCheckerStatus")
1311
1068
last_approval_request = notifychangeproperty(
1312
1069
datetime_to_dbus, "LastApprovalRequest")
1313
1070
approved_by_default = notifychangeproperty(dbus.Boolean,
1314
1071
"ApprovedByDefault")
1315
approval_delay = notifychangeproperty(
1316
dbus.UInt64, "ApprovalDelay",
1317
type_func = lambda td: td.total_seconds() * 1000)
1072
approval_delay = notifychangeproperty(dbus.UInt16,
1073
"ApprovalDelay",
1074
type_func =
1075
timedelta_to_milliseconds)
1318
1076
approval_duration = notifychangeproperty(
1319
dbus.UInt64, "ApprovalDuration",
1320
type_func = lambda td: td.total_seconds() * 1000)
1077
dbus.UInt16, "ApprovalDuration",
1078
type_func = timedelta_to_milliseconds)
1321
1079
host = notifychangeproperty(dbus.String, "Host")
1322
timeout = notifychangeproperty(
1323
dbus.UInt64, "Timeout",
1324
type_func = lambda td: td.total_seconds() * 1000)
1080
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1081
type_func =
1082
timedelta_to_milliseconds)
1325
1083
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)
1084
dbus.UInt16, "ExtendedTimeout",
1085
type_func = timedelta_to_milliseconds)
1086
interval = notifychangeproperty(dbus.UInt16,
1087
"Interval",
1088
type_func =
1089
timedelta_to_milliseconds)
1331
1090
checker_command = notifychangeproperty(dbus.String, "Checker")
1332
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1333
invalidate_only=True)
1334
1091
1335
1092
del notifychangeproperty
1336
1093
1363
1120
*args, **kwargs)
1364
1121
1365
1122
def start_checker(self, *args, **kwargs):
1366
old_checker_pid = getattr(self.checker, "pid", None)
1123
old_checker = self.checker
1124
if self.checker is not None:
1125
old_checker_pid = self.checker.pid
1126
else:
1127
old_checker_pid = None
1367
1128
r = Client.start_checker(self, *args, **kwargs)
1368
1129
# Only if new checker process was started
1369
1130
if (self.checker is not None
1377
1138
return False
1378
1139
1379
1140
def approve(self, value=True):
1141
self.send_changedstate()
1380
1142
self.approved = value
1381
gobject.timeout_add(int(self.approval_duration.total_seconds()
1382
* 1000), self._reset_approved)
1383
self.send_changedstate()
1143
gobject.timeout_add(timedelta_to_milliseconds
1144
(self.approval_duration),
1145
self._reset_approved)
1146
1384
1147
1385
1148
## D-Bus methods, signals & properties
1386
1387
## Interfaces
1149
_interface = "se.recompile.Mandos.Client"
1388
1150
1389
1151
## Signals
1390
1152
1401
1163
pass
1402
1164
1403
1165
# PropertyChanged - signal
1404
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1405
1166
@dbus.service.signal(_interface, signature="sv")
1406
1167
def PropertyChanged(self, property, value):
1407
1168
"D-Bus signal"
1428
1189
"D-Bus signal"
1429
1190
return self.need_approval()
1430
1191
1192
# NeRwequest - signal
1193
@dbus.service.signal(_interface, signature="s")
1194
def NewRequest(self, ip):
1195
"""D-Bus signal
1196
Is sent after a client request a password.
1197
"""
1198
pass
1199
1431
1200
## Methods
1432
1201
1433
1202
# Approve - method
1471
1240
return dbus.Boolean(bool(self.approvals_pending))
1472
1241
1473
1242
# ApprovedByDefault - property
1474
@dbus_service_property(_interface,
1475
signature="b",
1243
@dbus_service_property(_interface, signature="b",
1476
1244
access="readwrite")
1477
1245
def ApprovedByDefault_dbus_property(self, value=None):
1478
1246
if value is None: # get
1480
1248
self.approved_by_default = bool(value)
1481
1249
1482
1250
# ApprovalDelay - property
1483
@dbus_service_property(_interface,
1484
signature="t",
1251
@dbus_service_property(_interface, signature="t",
1485
1252
access="readwrite")
1486
1253
def ApprovalDelay_dbus_property(self, value=None):
1487
1254
if value is None: # get
1488
return dbus.UInt64(self.approval_delay.total_seconds()
1489
* 1000)
1255
return dbus.UInt64(self.approval_delay_milliseconds())
1490
1256
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1491
1257
1492
1258
# ApprovalDuration - property
1493
@dbus_service_property(_interface,
1494
signature="t",
1259
@dbus_service_property(_interface, signature="t",
1495
1260
access="readwrite")
1496
1261
def ApprovalDuration_dbus_property(self, value=None):
1497
1262
if value is None: # get
1498
return dbus.UInt64(self.approval_duration.total_seconds()
1499
* 1000)
1263
return dbus.UInt64(timedelta_to_milliseconds(
1264
self.approval_duration))
1500
1265
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1501
1266
1502
1267
# Name - property
1510
1275
return dbus.String(self.fingerprint)
1511
1276
1512
1277
# Host - property
1513
@dbus_service_property(_interface,
1514
signature="s",
1278
@dbus_service_property(_interface, signature="s",
1515
1279
access="readwrite")
1516
1280
def Host_dbus_property(self, value=None):
1517
1281
if value is None: # get
1518
1282
return dbus.String(self.host)
1519
self.host = str(value)
1283
self.host = value
1520
1284
1521
1285
# Created - property
1522
1286
@dbus_service_property(_interface, signature="s", access="read")
1529
1293
return datetime_to_dbus(self.last_enabled)
1530
1294
1531
1295
# Enabled - property
1532
@dbus_service_property(_interface,
1533
signature="b",
1296
@dbus_service_property(_interface, signature="b",
1534
1297
access="readwrite")
1535
1298
def Enabled_dbus_property(self, value=None):
1536
1299
if value is None: # get
1541
1304
self.disable()
1542
1305
1543
1306
# LastCheckedOK - property
1544
@dbus_service_property(_interface,
1545
signature="s",
1307
@dbus_service_property(_interface, signature="s",
1546
1308
access="readwrite")
1547
1309
def LastCheckedOK_dbus_property(self, value=None):
1548
1310
if value is not None:
1550
1312
return
1551
1313
return datetime_to_dbus(self.last_checked_ok)
1552
1314
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
1315
# Expires - property
1559
1316
@dbus_service_property(_interface, signature="s", access="read")
1560
1317
def Expires_dbus_property(self):
1566
1323
return datetime_to_dbus(self.last_approval_request)
1567
1324
1568
1325
# Timeout - property
1569
@dbus_service_property(_interface,
1570
signature="t",
1326
@dbus_service_property(_interface, signature="t",
1571
1327
access="readwrite")
1572
1328
def Timeout_dbus_property(self, value=None):
1573
1329
if value is None: # get
1574
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1575
old_timeout = self.timeout
1330
return dbus.UInt64(self.timeout_milliseconds())
1576
1331
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)
1332
if getattr(self, "disable_initiator_tag", None) is None:
1333
return
1334
# Reschedule timeout
1335
gobject.source_remove(self.disable_initiator_tag)
1336
self.disable_initiator_tag = None
1337
self.expires = None
1338
time_to_die = timedelta_to_milliseconds((self
1339
.last_checked_ok
1340
+ self.timeout)
1341
- datetime.datetime
1342
.utcnow())
1343
if time_to_die <= 0:
1344
# The timeout has passed
1345
self.disable()
1346
else:
1347
self.expires = (datetime.datetime.utcnow()
1348
+ datetime.timedelta(milliseconds =
1349
time_to_die))
1350
self.disable_initiator_tag = (gobject.timeout_add
1351
(time_to_die, self.disable))
1592
1352
1593
1353
# ExtendedTimeout - property
1594
@dbus_service_property(_interface,
1595
signature="t",
1354
@dbus_service_property(_interface, signature="t",
1596
1355
access="readwrite")
1597
1356
def ExtendedTimeout_dbus_property(self, value=None):
1598
1357
if value is None: # get
1599
return dbus.UInt64(self.extended_timeout.total_seconds()
1600
* 1000)
1358
return dbus.UInt64(self.extended_timeout_milliseconds())
1601
1359
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1602
1360
1603
1361
# Interval - property
1604
@dbus_service_property(_interface,
1605
signature="t",
1362
@dbus_service_property(_interface, signature="t",
1606
1363
access="readwrite")
1607
1364
def Interval_dbus_property(self, value=None):
1608
1365
if value is None: # get
1609
return dbus.UInt64(self.interval.total_seconds() * 1000)
1366
return dbus.UInt64(self.interval_milliseconds())
1610
1367
self.interval = datetime.timedelta(0, 0, 0, value)
1611
1368
if getattr(self, "checker_initiator_tag", None) is None:
1612
1369
return
1613
1370
if self.enabled:
1614
1371
# Reschedule checker run
1615
1372
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
1373
self.checker_initiator_tag = (gobject.timeout_add
1374
(value, self.start_checker))
1375
self.start_checker() # Start one now, too
1619
1376
1620
1377
# Checker - property
1621
@dbus_service_property(_interface,
1622
signature="s",
1378
@dbus_service_property(_interface, signature="s",
1623
1379
access="readwrite")
1624
1380
def Checker_dbus_property(self, value=None):
1625
1381
if value is None: # get
1626
1382
return dbus.String(self.checker_command)
1627
self.checker_command = str(value)
1383
self.checker_command = value
1628
1384
1629
1385
# CheckerRunning - property
1630
@dbus_service_property(_interface,
1631
signature="b",
1386
@dbus_service_property(_interface, signature="b",
1632
1387
access="readwrite")
1633
1388
def CheckerRunning_dbus_property(self, value=None):
1634
1389
if value is None: # get
1644
1399
return self.dbus_object_path # is already a dbus.ObjectPath
1645
1400
1646
1401
# Secret = property
1647
@dbus_service_property(_interface,
1648
signature="ay",
1649
access="write",
1650
byte_arrays=True)
1402
@dbus_service_property(_interface, signature="ay",
1403
access="write", byte_arrays=True)
1651
1404
def Secret_dbus_property(self, value):
1652
self.secret = bytes(value)
1405
self.secret = str(value)
1653
1406
1654
1407
del _interface
1655
1408
1669
1422
if data[0] == 'data':
1670
1423
return data[1]
1671
1424
if data[0] == 'function':
1672
1673
1425
def func(*args, **kwargs):
1674
1426
self._pipe.send(('funcall', name, args, kwargs))
1675
1427
return self._pipe.recv()[1]
1676
1677
1428
return func
1678
1429
1679
1430
def __setattr__(self, name, value):
1682
1433
self._pipe.send(('setattr', name, value))
1683
1434
1684
1435
1436
class ClientDBusTransitional(ClientDBus):
1437
__metaclass__ = AlternateDBusNamesMetaclass
1438
1439
1685
1440
class ClientHandler(socketserver.BaseRequestHandler, object):
1686
1441
"""A class to handle client connections.
1687
1442
1691
1446
def handle(self):
1692
1447
with contextlib.closing(self.server.child_pipe) as child_pipe:
1693
1448
logger.info("TCP connection from: %s",
1694
str(self.client_address))
1449
unicode(self.client_address))
1695
1450
logger.debug("Pipe FD: %d",
1696
1451
self.server.child_pipe.fileno())
1697
1452
1698
session = gnutls.connection.ClientSession(
1699
self.request, gnutls.connection .X509Credentials())
1453
session = (gnutls.connection
1454
.ClientSession(self.request,
1455
gnutls.connection
1456
.X509Credentials()))
1700
1457
1701
1458
# Note: gnutls.connection.X509Credentials is really a
1702
1459
# generic GnuTLS certificate credentials object so long as
1711
1468
priority = self.server.gnutls_priority
1712
1469
if priority is None:
1713
1470
priority = "NORMAL"
1714
gnutls.library.functions.gnutls_priority_set_direct(
1715
session._c_object, priority, None)
1471
(gnutls.library.functions
1472
.gnutls_priority_set_direct(session._c_object,
1473
priority, None))
1716
1474
1717
1475
# Start communication using the Mandos protocol
1718
1476
# Get protocol number
1720
1478
logger.debug("Protocol version: %r", line)
1721
1479
try:
1722
1480
if int(line.strip().split()[0]) > 1:
1723
raise RuntimeError(line)
1481
raise RuntimeError
1724
1482
except (ValueError, IndexError, RuntimeError) as error:
1725
1483
logger.error("Unknown protocol version: %s", error)
1726
1484
return
1738
1496
approval_required = False
1739
1497
try:
1740
1498
try:
1741
fpr = self.fingerprint(
1742
self.peer_certificate(session))
1499
fpr = self.fingerprint(self.peer_certificate
1500
(session))
1743
1501
except (TypeError,
1744
1502
gnutls.errors.GNUTLSError) as error:
1745
1503
logger.warning("Bad certificate: %s", error)
1752
1510
except KeyError:
1753
1511
return
1754
1512
1513
if self.server.use_dbus:
1514
# Emit D-Bus signal
1515
client.NewRequest(str(self.client_address))
1516
1755
1517
if client.approval_delay:
1756
1518
delay = client.approval_delay
1757
1519
client.approvals_pending += 1
1760
1522
while True:
1761
1523
if not client.enabled:
1762
1524
logger.info("Client %s is disabled",
1763
client.name)
1525
client.name)
1764
1526
if self.server.use_dbus:
1765
1527
# Emit D-Bus signal
1766
1528
client.Rejected("Disabled")
1775
1537
if self.server.use_dbus:
1776
1538
# Emit D-Bus signal
1777
1539
client.NeedApproval(
1778
client.approval_delay.total_seconds()
1779
* 1000, client.approved_by_default)
1540
client.approval_delay_milliseconds(),
1541
client.approved_by_default)
1780
1542
else:
1781
1543
logger.warning("Client %s was not approved",
1782
1544
client.name)
1788
1550
#wait until timeout or approved
1789
1551
time = datetime.datetime.now()
1790
1552
client.changedstate.acquire()
1791
client.changedstate.wait(delay.total_seconds())
1553
(client.changedstate.wait
1554
(float(client.timedelta_to_milliseconds(delay)
1555
/ 1000)))
1792
1556
client.changedstate.release()
1793
1557
time2 = datetime.datetime.now()
1794
1558
if (time2 - time) >= delay:
1810
1574
try:
1811
1575
sent = session.send(client.secret[sent_size:])
1812
1576
except gnutls.errors.GNUTLSError as error:
1813
logger.warning("gnutls send failed",
1814
exc_info=error)
1577
logger.warning("gnutls send failed")
1815
1578
return
1816
logger.debug("Sent: %d, remaining: %d", sent,
1817
len(client.secret) - (sent_size
1818
+ sent))
1579
logger.debug("Sent: %d, remaining: %d",
1580
sent, len(client.secret)
1581
- (sent_size + sent))
1819
1582
sent_size += sent
1820
1583
1821
1584
logger.info("Sending secret to %s", client.name)
1822
1585
# bump the timeout using extended_timeout
1823
client.bump_timeout(client.extended_timeout)
1586
client.checked_ok(client.extended_timeout)
1824
1587
if self.server.use_dbus:
1825
1588
# Emit D-Bus signal
1826
1589
client.GotSecret()
1831
1594
try:
1832
1595
session.bye()
1833
1596
except gnutls.errors.GNUTLSError as error:
1834
logger.warning("GnuTLS bye failed",
1835
exc_info=error)
1597
logger.warning("GnuTLS bye failed")
1836
1598
1837
1599
@staticmethod
1838
1600
def peer_certificate(session):
1839
1601
"Return the peer's OpenPGP certificate as a bytestring"
1840
1602
# If not an OpenPGP certificate...
1841
if (gnutls.library.functions.gnutls_certificate_type_get(
1842
session._c_object)
1603
if (gnutls.library.functions
1604
.gnutls_certificate_type_get(session._c_object)
1843
1605
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1844
1606
# ...do the normal thing
1845
1607
return session.peer_certificate
1859
1621
def fingerprint(openpgp):
1860
1622
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1861
1623
# 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)))
1624
datum = (gnutls.library.types
1625
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1626
ctypes.POINTER
1627
(ctypes.c_ubyte)),
1628
ctypes.c_uint(len(openpgp))))
1866
1629
# New empty GnuTLS certificate
1867
1630
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1868
gnutls.library.functions.gnutls_openpgp_crt_init(
1869
ctypes.byref(crt))
1631
(gnutls.library.functions
1632
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1870
1633
# 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)
1634
(gnutls.library.functions
1635
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1636
gnutls.library.constants
1637
.GNUTLS_OPENPGP_FMT_RAW))
1874
1638
# Verify the self signature in the key
1875
1639
crtverify = ctypes.c_uint()
1876
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1877
crt, 0, ctypes.byref(crtverify))
1640
(gnutls.library.functions
1641
.gnutls_openpgp_crt_verify_self(crt, 0,
1642
ctypes.byref(crtverify)))
1878
1643
if crtverify.value != 0:
1879
1644
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1880
raise gnutls.errors.CertificateSecurityError(
1881
"Verify failed")
1645
raise (gnutls.errors.CertificateSecurityError
1646
("Verify failed"))
1882
1647
# New buffer for the fingerprint
1883
1648
buf = ctypes.create_string_buffer(20)
1884
1649
buf_len = ctypes.c_size_t()
1885
1650
# 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))
1651
(gnutls.library.functions
1652
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1653
ctypes.byref(buf_len)))
1888
1654
# Deinit the certificate
1889
1655
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1890
1656
# Convert the buffer to a Python bytestring
1896
1662
1897
1663
class MultiprocessingMixIn(object):
1898
1664
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1899
1900
1665
def sub_process_main(self, request, address):
1901
1666
try:
1902
1667
self.finish_request(request, address)
1903
except Exception:
1668
except:
1904
1669
self.handle_error(request, address)
1905
1670
self.close_request(request)
1906
1671
1907
1672
def process_request(self, request, address):
1908
1673
"""Start a new process to process the request."""
1909
1674
proc = multiprocessing.Process(target = self.sub_process_main,
1910
args = (request, address))
1675
args = (request,
1676
address))
1911
1677
proc.start()
1912
1678
return proc
1913
1679
1914
1680
1915
1681
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1916
1682
""" adds a pipe to the MixIn """
1917
1918
1683
def process_request(self, request, client_address):
1919
1684
"""Overrides and wraps the original process_request().
1920
1685
1929
1694
1930
1695
def add_pipe(self, parent_pipe, proc):
1931
1696
"""Dummy function; override as necessary"""
1932
raise NotImplementedError()
1697
raise NotImplementedError
1933
1698
1934
1699
1935
1700
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1941
1706
interface: None or a network interface name (string)
1942
1707
use_ipv6: Boolean; to use IPv6 or not
1943
1708
"""
1944
1945
1709
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
"""
1710
interface=None, use_ipv6=True):
1952
1711
self.interface = interface
1953
1712
if use_ipv6:
1954
1713
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
1714
socketserver.TCPServer.__init__(self, server_address,
1982
1715
RequestHandlerClass)
1983
1984
1716
def server_bind(self):
1985
1717
"""This overrides the normal server_bind() function
1986
1718
to bind to an interface if one was specified, and also NOT to
1992
1724
self.interface)
1993
1725
else:
1994
1726
try:
1995
self.socket.setsockopt(
1996
socket.SOL_SOCKET, SO_BINDTODEVICE,
1997
(self.interface + "\0").encode("utf-8"))
1727
self.socket.setsockopt(socket.SOL_SOCKET,
1728
SO_BINDTODEVICE,
1729
str(self.interface
1730
+ '\0'))
1998
1731
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:
1732
if error[0] == errno.EPERM:
1733
logger.error("No permission to"
1734
" bind to interface %s",
1735
self.interface)
1736
elif error[0] == errno.ENOPROTOOPT:
2003
1737
logger.error("SO_BINDTODEVICE not available;"
2004
1738
" cannot bind to interface %s",
2005
1739
self.interface)
2006
elif error.errno == errno.ENODEV:
2007
logger.error("Interface %s does not exist,"
2008
" cannot bind", self.interface)
2009
1740
else:
2010
1741
raise
2011
1742
# Only bind(2) the socket if we really need to.
2014
1745
if self.address_family == socket.AF_INET6:
2015
1746
any_address = "::" # in6addr_any
2016
1747
else:
2017
any_address = "0.0.0.0" # INADDR_ANY
1748
any_address = socket.INADDR_ANY
2018
1749
self.server_address = (any_address,
2019
1750
self.server_address[1])
2020
1751
elif not self.server_address[1]:
2021
self.server_address = (self.server_address[0], 0)
1752
self.server_address = (self.server_address[0],
1753
0)
2022
1754
# if self.interface:
2023
1755
# self.server_address = (self.server_address[0],
2024
1756
# 0, # port
2038
1770
2039
1771
Assumes a gobject.MainLoop event loop.
2040
1772
"""
2041
2042
1773
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):
1774
interface=None, use_ipv6=True, clients=None,
1775
gnutls_priority=None, use_dbus=True):
2049
1776
self.enabled = False
2050
1777
self.clients = clients
2051
1778
if self.clients is None:
2055
1782
IPv6_TCPServer.__init__(self, server_address,
2056
1783
RequestHandlerClass,
2057
1784
interface = interface,
2058
use_ipv6 = use_ipv6,
2059
socketfd = socketfd)
2060
1785
use_ipv6 = use_ipv6)
2061
1786
def server_activate(self):
2062
1787
if self.enabled:
2063
1788
return socketserver.TCPServer.server_activate(self)
2067
1792
2068
1793
def add_pipe(self, parent_pipe, proc):
2069
1794
# 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))
1795
gobject.io_add_watch(parent_pipe.fileno(),
1796
gobject.IO_IN | gobject.IO_HUP,
1797
functools.partial(self.handle_ipc,
1798
parent_pipe =
1799
parent_pipe,
1800
proc = proc))
2076
1801
2077
def handle_ipc(self, source, condition,
2078
parent_pipe=None,
2079
proc = None,
2080
client_object=None):
1802
def handle_ipc(self, source, condition, parent_pipe=None,
1803
proc = None, client_object=None):
1804
condition_names = {
1805
gobject.IO_IN: "IN", # There is data to read.
1806
gobject.IO_OUT: "OUT", # Data can be written (without
1807
# blocking).
1808
gobject.IO_PRI: "PRI", # There is urgent data to read.
1809
gobject.IO_ERR: "ERR", # Error condition.
1810
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1811
# broken, usually for pipes and
1812
# sockets).
1813
}
1814
conditions_string = ' | '.join(name
1815
for cond, name in
1816
condition_names.iteritems()
1817
if cond & condition)
2081
1818
# error, or the other end of multiprocessing.Pipe has closed
2082
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1819
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2083
1820
# Wait for other process to exit
2084
1821
proc.join()
2085
1822
return False
2106
1843
parent_pipe.send(False)
2107
1844
return False
2108
1845
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))
1846
gobject.io_add_watch(parent_pipe.fileno(),
1847
gobject.IO_IN | gobject.IO_HUP,
1848
functools.partial(self.handle_ipc,
1849
parent_pipe =
1850
parent_pipe,
1851
proc = proc,
1852
client_object =
1853
client))
2116
1854
parent_pipe.send(True)
2117
1855
# remove the old hook in favor of the new above hook on
2118
1856
# same fileno
2124
1862
2125
1863
parent_pipe.send(('data', getattr(client_object,
2126
1864
funcname)(*args,
2127
**kwargs)))
1865
**kwargs)))
2128
1866
2129
1867
if command == 'getattr':
2130
1868
attrname = request[1]
2131
1869
if callable(client_object.__getattribute__(attrname)):
2132
parent_pipe.send(('function', ))
1870
parent_pipe.send(('function',))
2133
1871
else:
2134
parent_pipe.send((
2135
'data', client_object.__getattribute__(attrname)))
1872
parent_pipe.send(('data', client_object
1873
.__getattribute__(attrname)))
2136
1874
2137
1875
if command == 'setattr':
2138
1876
attrname = request[1]
2142
1880
return True
2143
1881
2144
1882
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
1883
def string_to_delta(interval):
2250
1884
"""Parse a string and return a datetime.timedelta
2251
1885
2262
1896
>>> string_to_delta('5m 30s')
2263
1897
datetime.timedelta(0, 330)
2264
1898
"""
2265
2266
try:
2267
return rfc3339_duration_to_delta(interval)
2268
except ValueError:
2269
pass
2270
2271
1899
timevalue = datetime.timedelta(0)
2272
1900
for s in interval.split():
2273
1901
try:
2274
suffix = s[-1]
1902
suffix = unicode(s[-1])
2275
1903
value = int(s[:-1])
2276
1904
if suffix == "d":
2277
1905
delta = datetime.timedelta(value)
2284
1912
elif suffix == "w":
2285
1913
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2286
1914
else:
2287
raise ValueError("Unknown suffix {!r}".format(suffix))
2288
except IndexError as e:
1915
raise ValueError("Unknown suffix %r" % suffix)
1916
except (ValueError, IndexError) as e:
2289
1917
raise ValueError(*(e.args))
2290
1918
timevalue += delta
2291
1919
return timevalue
2304
1932
sys.exit()
2305
1933
if not noclose:
2306
1934
# Close all standard open file descriptors
2307
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1935
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2308
1936
if not stat.S_ISCHR(os.fstat(null).st_mode):
2309
1937
raise OSError(errno.ENODEV,
2310
"{} not a character device"
2311
.format(os.devnull))
1938
"%s not a character device"
1939
% os.path.devnull)
2312
1940
os.dup2(null, sys.stdin.fileno())
2313
1941
os.dup2(null, sys.stdout.fileno())
2314
1942
os.dup2(null, sys.stderr.fileno())
2323
1951
2324
1952
parser = argparse.ArgumentParser()
2325
1953
parser.add_argument("-v", "--version", action="version",
2326
version = "%(prog)s {}".format(version),
1954
version = "%%(prog)s %s" % version,
2327
1955
help="show version number and exit")
2328
1956
parser.add_argument("-i", "--interface", metavar="IF",
2329
1957
help="Bind to interface IF")
2335
1963
help="Run self-test")
2336
1964
parser.add_argument("--debug", action="store_true",
2337
1965
help="Debug mode; run in foreground and log"
2338
" to terminal", default=None)
1966
" to terminal")
2339
1967
parser.add_argument("--debuglevel", metavar="LEVEL",
2340
1968
help="Debug level for stdout output")
2341
1969
parser.add_argument("--priority", help="GnuTLS"
2348
1976
" files")
2349
1977
parser.add_argument("--no-dbus", action="store_false",
2350
1978
dest="use_dbus", help="Do not provide D-Bus"
2351
" system bus interface", default=None)
1979
" system bus interface")
2352
1980
parser.add_argument("--no-ipv6", action="store_false",
2353
dest="use_ipv6", help="Do not use IPv6",
2354
default=None)
1981
dest="use_ipv6", help="Do not use IPv6")
2355
1982
parser.add_argument("--no-restore", action="store_false",
2356
1983
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")
1984
" state")
2361
1985
parser.add_argument("--statedir", metavar="DIR",
2362
1986
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
1987
2369
1988
options = parser.parse_args()
2370
1989
2371
1990
if options.check:
2372
1991
import doctest
2373
fail_count, test_count = doctest.testmod()
2374
sys.exit(os.EX_OK if fail_count == 0 else 1)
1992
doctest.testmod()
1993
sys.exit()
2375
1994
2376
1995
# Default values for config file for server-global settings
2377
1996
server_defaults = { "interface": "",
2379
1998
"port": "",
2380
1999
"debug": "False",
2381
2000
"priority":
2382
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2383
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2001
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2384
2002
"servicename": "Mandos",
2385
2003
"use_dbus": "True",
2386
2004
"use_ipv6": "True",
2387
2005
"debuglevel": "",
2388
2006
"restore": "True",
2389
"socket": "",
2390
"statedir": "/var/lib/mandos",
2391
"foreground": "False",
2392
"zeroconf": "True",
2393
}
2007
"statedir": "/var/lib/mandos"
2008
}
2394
2009
2395
2010
# Parse config file for server-global settings
2396
2011
server_config = configparser.SafeConfigParser(server_defaults)
2397
2012
del server_defaults
2398
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2013
server_config.read(os.path.join(options.configdir,
2014
"mandos.conf"))
2399
2015
# Convert the SafeConfigParser object to a dict
2400
2016
server_settings = server_config.defaults()
2401
2017
# Use the appropriate methods on the non-string config options
2402
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2018
for option in ("debug", "use_dbus", "use_ipv6"):
2403
2019
server_settings[option] = server_config.getboolean("DEFAULT",
2404
2020
option)
2405
2021
if server_settings["port"]:
2406
2022
server_settings["port"] = server_config.getint("DEFAULT",
2407
2023
"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
2024
del server_config
2418
2025
2419
2026
# Override the settings from the config file with command line
2420
2027
# options, if set.
2421
2028
for option in ("interface", "address", "port", "debug",
2422
"priority", "servicename", "configdir", "use_dbus",
2423
"use_ipv6", "debuglevel", "restore", "statedir",
2424
"socket", "foreground", "zeroconf"):
2029
"priority", "servicename", "configdir",
2030
"use_dbus", "use_ipv6", "debuglevel", "restore",
2031
"statedir"):
2425
2032
value = getattr(options, option)
2426
2033
if value is not None:
2427
2034
server_settings[option] = value
2428
2035
del options
2429
2036
# Force all strings to be unicode
2430
2037
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
2038
if type(server_settings[option]) is str:
2039
server_settings[option] = unicode(server_settings[option])
2441
2040
# Now we have our good server settings in "server_settings"
2442
2041
2443
2042
##################################################################
2444
2043
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
2044
# For convenience
2451
2045
debug = server_settings["debug"]
2452
2046
debuglevel = server_settings["debuglevel"]
2454
2048
use_ipv6 = server_settings["use_ipv6"]
2455
2049
stored_state_path = os.path.join(server_settings["statedir"],
2456
2050
stored_state_file)
2457
foreground = server_settings["foreground"]
2458
zeroconf = server_settings["zeroconf"]
2459
2051
2460
2052
if debug:
2461
initlogger(debug, logging.DEBUG)
2053
initlogger(logging.DEBUG)
2462
2054
else:
2463
2055
if not debuglevel:
2464
initlogger(debug)
2056
initlogger()
2465
2057
else:
2466
2058
level = getattr(logging, debuglevel.upper())
2467
initlogger(debug, level)
2059
initlogger(level)
2468
2060
2469
2061
if server_settings["servicename"] != "Mandos":
2470
syslogger.setFormatter(
2471
logging.Formatter('Mandos ({}) [%(process)d]:'
2472
' %(levelname)s: %(message)s'.format(
2473
server_settings["servicename"])))
2062
syslogger.setFormatter(logging.Formatter
2063
('Mandos (%s) [%%(process)d]:'
2064
' %%(levelname)s: %%(message)s'
2065
% server_settings["servicename"]))
2474
2066
2475
2067
# Parse config file with clients
2476
client_config = configparser.SafeConfigParser(Client
2477
.client_defaults)
2068
client_defaults = { "timeout": "5m",
2069
"extended_timeout": "15m",
2070
"interval": "2m",
2071
"checker": "fping -q -- %%(host)s",
2072
"host": "",
2073
"approval_delay": "0s",
2074
"approval_duration": "1s",
2075
}
2076
client_config = configparser.SafeConfigParser(client_defaults)
2478
2077
client_config.read(os.path.join(server_settings["configdir"],
2479
2078
"clients.conf"))
2480
2079
2481
2080
global mandos_dbus_service
2482
2081
mandos_dbus_service = None
2483
2082
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
2083
tcp_server = MandosServer((server_settings["address"],
2084
server_settings["port"]),
2085
ClientHandler,
2086
interface=(server_settings["interface"]
2087
or None),
2088
use_ipv6=use_ipv6,
2089
gnutls_priority=
2090
server_settings["priority"],
2091
use_dbus=use_dbus)
2092
if not debug:
2093
pidfilename = "/var/run/mandos.pid"
2500
2094
try:
2501
2095
pidfile = open(pidfilename, "w")
2502
except IOError as e:
2503
logger.error("Could not open file %r", pidfilename,
2504
exc_info=e)
2096
except IOError:
2097
logger.error("Could not open file %r", pidfilename)
2505
2098
2506
for name in ("_mandos", "mandos", "nobody"):
2099
try:
2100
uid = pwd.getpwnam("_mandos").pw_uid
2101
gid = pwd.getpwnam("_mandos").pw_gid
2102
except KeyError:
2507
2103
try:
2508
uid = pwd.getpwnam(name).pw_uid
2509
gid = pwd.getpwnam(name).pw_gid
2510
break
2104
uid = pwd.getpwnam("mandos").pw_uid
2105
gid = pwd.getpwnam("mandos").pw_gid
2511
2106
except KeyError:
2512
continue
2513
else:
2514
uid = 65534
2515
gid = 65534
2107
try:
2108
uid = pwd.getpwnam("nobody").pw_uid
2109
gid = pwd.getpwnam("nobody").pw_gid
2110
except KeyError:
2111
uid = 65534
2112
gid = 65534
2516
2113
try:
2517
2114
os.setgid(gid)
2518
2115
os.setuid(uid)
2519
2116
except OSError as error:
2520
if error.errno != errno.EPERM:
2521
raise
2117
if error[0] != errno.EPERM:
2118
raise error
2522
2119
2523
2120
if debug:
2524
2121
# Enable all possible GnuTLS debugging
2531
2128
def debug_gnutls(level, string):
2532
2129
logger.debug("GnuTLS: %s", string[:-1])
2533
2130
2534
gnutls.library.functions.gnutls_global_set_log_function(
2535
debug_gnutls)
2131
(gnutls.library.functions
2132
.gnutls_global_set_log_function(debug_gnutls))
2536
2133
2537
2134
# Redirect stdin so all checkers get /dev/null
2538
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2135
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2539
2136
os.dup2(null, sys.stdin.fileno())
2540
2137
if null > 2:
2541
2138
os.close(null)
2139
else:
2140
# No console logging
2141
logger.removeHandler(console)
2542
2142
2543
2143
# Need to fork before connecting to D-Bus
2544
if not foreground:
2144
if not debug:
2545
2145
# Close all input and output, do double fork, etc.
2546
2146
daemon()
2547
2147
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
2148
global main_loop
2553
2149
# From the Avahi example code
2554
DBusGMainLoop(set_as_default=True)
2150
DBusGMainLoop(set_as_default=True )
2555
2151
main_loop = gobject.MainLoop()
2556
2152
bus = dbus.SystemBus()
2557
2153
# End of Avahi example code
2558
2154
if use_dbus:
2559
2155
try:
2560
2156
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)
2157
bus, do_not_queue=True)
2158
old_bus_name = (dbus.service.BusName
2159
("se.bsnet.fukt.Mandos", bus,
2160
do_not_queue=True))
2566
2161
except dbus.exceptions.NameExistsException as e:
2567
logger.error("Disabling D-Bus:", exc_info=e)
2162
logger.error(unicode(e) + ", disabling D-Bus")
2568
2163
use_dbus = False
2569
2164
server_settings["use_dbus"] = False
2570
2165
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"))
2166
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2167
service = AvahiServiceToSyslog(name =
2168
server_settings["servicename"],
2169
servicetype = "_mandos._tcp",
2170
protocol = protocol, bus = bus)
2171
if server_settings["interface"]:
2172
service.interface = (if_nametoindex
2173
(str(server_settings["interface"])))
2581
2174
2582
2175
global multiprocessing_manager
2583
2176
multiprocessing_manager = multiprocessing.Manager()
2584
2177
2585
2178
client_class = Client
2586
2179
if use_dbus:
2587
client_class = functools.partial(ClientDBus, bus = bus)
2588
2589
client_settings = Client.config_parser(client_config)
2180
client_class = functools.partial(ClientDBusTransitional,
2181
bus = bus)
2182
2183
special_settings = {
2184
# Some settings need to be accessd by special methods;
2185
# booleans need .getboolean(), etc. Here is a list of them:
2186
"approved_by_default":
2187
lambda section:
2188
client_config.getboolean(section, "approved_by_default"),
2189
"enabled":
2190
lambda section:
2191
client_config.getboolean(section, "enabled"),
2192
}
2193
# Construct a new dict of client settings of this form:
2194
# { client_name: {setting_name: value, ...}, ...}
2195
# with exceptions for any special settings as defined above
2196
client_settings = dict((clientname,
2197
dict((setting,
2198
(value
2199
if setting not in special_settings
2200
else special_settings[setting]
2201
(clientname)))
2202
for setting, value in
2203
client_config.items(clientname)))
2204
for clientname in client_config.sections())
2205
2590
2206
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()
2207
clients_data = []
2600
2208
2601
2209
# Get client data and settings from last running state.
2602
2210
if server_settings["restore"]:
2603
2211
try:
2604
2212
with open(stored_state_path, "rb") as stored_state:
2605
clients_data, old_client_settings = pickle.load(
2606
stored_state)
2213
clients_data, old_client_settings = (pickle.load
2214
(stored_state))
2607
2215
os.remove(stored_state_path)
2608
2216
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)
2217
logger.warning("Could not load persistent state: {0}"
2218
.format(e))
2219
if e.errno != errno.ENOENT:
2615
2220
raise
2616
except EOFError as e:
2617
logger.warning("Could not load persistent state: "
2618
"EOFError:",
2619
exc_info=e)
2620
2221
2621
2222
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
2223
for client in clients_data:
2224
client_name = client["name"]
2626
2225
2627
2226
# Decide which value to use after restoring saved state.
2628
2227
# We have three different values: Old config file,
2634
2233
# For each value in new config, check if it
2635
2234
# differs from the old config value (Except for
2636
2235
# the "secret" attribute)
2637
if (name != "secret"
2638
and (value !=
2639
old_client_settings[client_name][name])):
2640
client[name] = value
2236
if (name != "secret" and
2237
value != old_client_settings[client_name]
2238
[name]):
2239
setattr(client, name, value)
2641
2240
except KeyError:
2642
2241
pass
2643
2242
2644
2243
# 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"]))
2244
# enabled if its last checker was sucessful. Clients
2245
# whose checker failed before we stored its state is
2246
# assumed to have failed all checkers during downtime.
2247
if client["enabled"] and client["last_checked_ok"]:
2248
if ((datetime.datetime.utcnow()
2249
- client["last_checked_ok"])
2250
> client["interval"]):
2251
if client["last_checker_status"] != 0:
2664
2252
client["enabled"] = False
2665
2253
else:
2666
client["expires"] = (
2667
datetime.datetime.utcnow()
2668
+ client["timeout"])
2669
logger.debug("Last checker succeeded,"
2670
" keeping {} enabled".format(
2671
client_name))
2254
client["expires"] = (datetime.datetime
2255
.utcnow()
2256
+ client["timeout"])
2257
2258
client["changedstate"] = (multiprocessing_manager
2259
.Condition
2260
(multiprocessing_manager
2261
.Lock()))
2262
if use_dbus:
2263
new_client = (ClientDBusTransitional.__new__
2264
(ClientDBusTransitional))
2265
tcp_server.clients[client_name] = new_client
2266
new_client.bus = bus
2267
for name, value in client.iteritems():
2268
setattr(new_client, name, value)
2269
client_object_name = unicode(client_name).translate(
2270
{ord("."): ord("_"),
2271
ord("-"): ord("_")})
2272
new_client.dbus_object_path = (dbus.ObjectPath
2273
("/clients/"
2274
+ client_object_name))
2275
DBusObjectWithProperties.__init__(new_client,
2276
new_client.bus,
2277
new_client
2278
.dbus_object_path)
2279
else:
2280
tcp_server.clients[client_name] = (Client.__new__
2281
(Client))
2282
for name, value in client.iteritems():
2283
setattr(tcp_server.clients[client_name],
2284
name, value)
2285
2672
2286
try:
2673
client["secret"] = pgp.decrypt(
2674
client["encrypted_secret"],
2675
client_settings[client_name]["secret"])
2287
tcp_server.clients[client_name].secret = (
2288
pgp.decrypt(tcp_server.clients[client_name]
2289
.encrypted_secret,
2290
client_settings[client_name]
2291
["secret"]))
2676
2292
except PGPError:
2677
2293
# 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)
2294
tcp_server.clients[client_name].secret = (
2295
client_settings[client_name]["secret"])
2296
2297
# Create/remove clients based on new changes made to config
2298
for clientname in set(old_client_settings) - set(client_settings):
2299
del tcp_server.clients[clientname]
2300
for clientname in set(client_settings) - set(old_client_settings):
2301
tcp_server.clients[clientname] = (client_class(name
2302
= clientname,
2303
config =
2304
client_settings
2305
[clientname]))
2697
2306
2698
2307
if not tcp_server.clients:
2699
2308
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
2309
2310
if not debug:
2311
try:
2312
with pidfile:
2313
pid = os.getpid()
2314
pidfile.write(str(pid) + "\n".encode("utf-8"))
2315
del pidfile
2316
except IOError:
2317
logger.error("Could not write to file %r with PID %d",
2318
pidfilename, pid)
2319
except NameError:
2320
# "pidfile" was never created
2321
pass
2711
2322
del pidfilename
2323
2324
signal.signal(signal.SIGINT, signal.SIG_IGN)
2712
2325
2713
2326
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2714
2327
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2715
2328
2716
2329
if use_dbus:
2717
2718
@alternate_dbus_interfaces(
2719
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2720
class MandosDBusService(DBusObjectWithProperties):
2330
class MandosDBusService(dbus.service.Object):
2721
2331
"""A D-Bus proxy object"""
2722
2723
2332
def __init__(self):
2724
2333
dbus.service.Object.__init__(self, bus, "/")
2725
2726
2334
_interface = "se.recompile.Mandos"
2727
2335
2728
@dbus_interface_annotations(_interface)
2729
def _foo(self):
2730
return {
2731
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2732
"false" }
2733
2734
2336
@dbus.service.signal(_interface, signature="o")
2735
2337
def ClientAdded(self, objpath):
2736
2338
"D-Bus signal"
2749
2351
@dbus.service.method(_interface, out_signature="ao")
2750
2352
def GetAllClients(self):
2751
2353
"D-Bus method"
2752
return dbus.Array(c.dbus_object_path for c in
2354
return dbus.Array(c.dbus_object_path
2355
for c in
2753
2356
tcp_server.clients.itervalues())
2754
2357
2755
2358
@dbus.service.method(_interface,
2757
2360
def GetAllClientsWithProperties(self):
2758
2361
"D-Bus method"
2759
2362
return dbus.Dictionary(
2760
{ c.dbus_object_path: c.GetAll("")
2761
for c in tcp_server.clients.itervalues() },
2363
((c.dbus_object_path, c.GetAll(""))
2364
for c in tcp_server.clients.itervalues()),
2762
2365
signature="oa{sv}")
2763
2366
2764
2367
@dbus.service.method(_interface, in_signature="o")
2777
2380
2778
2381
del _interface
2779
2382
2780
mandos_dbus_service = MandosDBusService()
2383
class MandosDBusServiceTransitional(MandosDBusService):
2384
__metaclass__ = AlternateDBusNamesMetaclass
2385
mandos_dbus_service = MandosDBusServiceTransitional()
2781
2386
2782
2387
def cleanup():
2783
2388
"Cleanup function; run on exit"
2784
if zeroconf:
2785
service.cleanup()
2389
service.cleanup()
2786
2390
2787
2391
multiprocessing.active_children()
2788
wnull.close()
2789
2392
if not (tcp_server.clients or client_settings):
2790
2393
return
2791
2394
2792
2395
# Store client before exiting. Secrets are encrypted with key
2793
2396
# based on what config file has. If config file is
2794
2397
# removed/edited, old secret will thus be unrecovable.
2795
clients = {}
2398
clients = []
2796
2399
with PGPEngine() as pgp:
2797
2400
for client in tcp_server.clients.itervalues():
2798
2401
key = client_settings[client.name]["secret"]
2800
2403
key)
2801
2404
client_dict = {}
2802
2405
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):
2406
# A list of attributes that will not be stored when
2407
# shutting down.
2408
exclude = set(("bus", "changedstate", "secret"))
2409
for name, typ in (inspect.getmembers
2410
(dbus.service.Object)):
2809
2411
exclude.add(name)
2810
2412
2811
2413
client_dict["encrypted_secret"] = (client
2814
2416
if attr not in exclude:
2815
2417
client_dict[attr] = getattr(client, attr)
2816
2418
2817
clients[client.name] = client_dict
2419
clients.append(client_dict)
2818
2420
del client_settings[client.name]["secret"]
2819
2421
2820
2422
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:
2423
with os.fdopen(os.open(stored_state_path,
2424
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2425
0600), "wb") as stored_state:
2827
2426
pickle.dump((clients, client_settings), stored_state)
2828
tempname = stored_state.name
2829
os.rename(tempname, stored_state_path)
2830
2427
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)
2428
logger.warning("Could not save persistent state: {0}"
2429
.format(e))
2430
if e.errno not in (errno.ENOENT, errno.EACCES):
2842
2431
raise
2843
2432
2844
2433
# Delete all clients, and settings from config
2850
2439
client.disable(quiet=True)
2851
2440
if use_dbus:
2852
2441
# Emit D-Bus signal
2853
mandos_dbus_service.ClientRemoved(
2854
client.dbus_object_path, client.name)
2442
mandos_dbus_service.ClientRemoved(client
2443
.dbus_object_path,
2444
client.name)
2855
2445
client_settings.clear()
2856
2446
2857
2447
atexit.register(cleanup)
2868
2458
tcp_server.server_activate()
2869
2459
2870
2460
# Find out what port we got
2871
if zeroconf:
2872
service.port = tcp_server.socket.getsockname()[1]
2461
service.port = tcp_server.socket.getsockname()[1]
2873
2462
if use_ipv6:
2874
2463
logger.info("Now listening on address %r, port %d,"
2875
" flowinfo %d, scope_id %d",
2876
*tcp_server.socket.getsockname())
2464
" flowinfo %d, scope_id %d"
2465
% tcp_server.socket.getsockname())
2877
2466
else: # IPv4
2878
logger.info("Now listening on address %r, port %d",
2879
*tcp_server.socket.getsockname())
2467
logger.info("Now listening on address %r, port %d"
2468
% tcp_server.socket.getsockname())
2880
2469
2881
2470
#service.interface = tcp_server.socket.getsockname()[3]
2882
2471
2883
2472
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
2473
# From the Avahi example code
2474
try:
2475
service.activate()
2476
except dbus.exceptions.DBusException as error:
2477
logger.critical("DBusException: %s", error)
2478
cleanup()
2479
sys.exit(1)
2480
# End of Avahi example code
2893
2481
2894
2482
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2895
2483
lambda *args, **kwargs:
2899
2487
logger.debug("Starting main loop")
2900
2488
main_loop.run()
2901
2489
except AvahiError as error:
2902
logger.critical("Avahi Error", exc_info=error)
2490
logger.critical("AvahiError: %s", error)
2903
2491
cleanup()
2904
2492
sys.exit(1)
2905
2493
except KeyboardInterrupt:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0