126
290
self.rename_count = 0
127
291
self.max_renames = max_renames
128
292
self.protocol = protocol
293
self.group = None # our entry group
296
self.entry_group_state_changed_match = None
298
def rename(self, remove=True):
130
299
"""Derived from the Avahi example code"""
131
300
if self.rename_count >= self.max_renames:
132
logger.critical(u"No suitable Zeroconf service name found"
133
u" after %i retries, exiting.",
301
logger.critical("No suitable Zeroconf service name found"
302
" after %i retries, exiting.",
134
303
self.rename_count)
135
raise AvahiServiceError(u"Too many renames")
136
self.name = server.GetAlternativeServiceName(self.name)
137
logger.info(u"Changing Zeroconf service name to %r ...",
139
syslogger.setFormatter(logging.Formatter
140
('Mandos (%s): %%(levelname)s:'
141
' %%(message)s' % self.name))
304
raise AvahiServiceError("Too many renames")
306
self.server.GetAlternativeServiceName(self.name))
144
307
self.rename_count += 1
308
logger.info("Changing Zeroconf service name to %r ...",
314
except dbus.exceptions.DBusException as error:
315
if (error.get_dbus_name()
316
== "org.freedesktop.Avahi.CollisionError"):
317
logger.info("Local Zeroconf service name collision.")
318
return self.rename(remove=False)
320
logger.critical("D-Bus Exception", exc_info=error)
145
324
def remove(self):
146
325
"""Derived from the Avahi example code"""
147
if group is not None:
326
if self.entry_group_state_changed_match is not None:
327
self.entry_group_state_changed_match.remove()
328
self.entry_group_state_changed_match = None
329
if self.group is not None:
150
333
"""Derived from the Avahi example code"""
153
group = dbus.Interface(bus.get_object
155
server.EntryGroupNew()),
156
avahi.DBUS_INTERFACE_ENTRY_GROUP)
157
group.connect_to_signal('StateChanged',
158
entry_group_state_changed)
159
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
160
service.name, service.type)
162
self.interface, # interface
163
self.protocol, # protocol
164
dbus.UInt32(0), # flags
165
self.name, self.type,
166
self.domain, self.host,
167
dbus.UInt16(self.port),
168
avahi.string_array_to_txt_array(self.TXT))
171
# From the Avahi example code:
172
group = None # our entry group
173
# End of Avahi example code
176
def _datetime_to_dbus(dt, variant_level=0):
177
"""Convert a UTC datetime.datetime() to a D-Bus type."""
178
return dbus.String(dt.isoformat(), variant_level=variant_level)
181
class Client(dbus.service.Object):
335
if self.group is None:
336
self.group = dbus.Interface(
337
self.bus.get_object(avahi.DBUS_NAME,
338
self.server.EntryGroupNew()),
339
avahi.DBUS_INTERFACE_ENTRY_GROUP)
340
self.entry_group_state_changed_match = (
341
self.group.connect_to_signal(
342
'StateChanged', self.entry_group_state_changed))
343
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
344
self.name, self.type)
345
self.group.AddService(
348
dbus.UInt32(0), # flags
349
self.name, self.type,
350
self.domain, self.host,
351
dbus.UInt16(self.port),
352
avahi.string_array_to_txt_array(self.TXT))
355
def entry_group_state_changed(self, state, error):
356
"""Derived from the Avahi example code"""
357
logger.debug("Avahi entry group state change: %i", state)
359
if state == avahi.ENTRY_GROUP_ESTABLISHED:
360
logger.debug("Zeroconf service established.")
361
elif state == avahi.ENTRY_GROUP_COLLISION:
362
logger.info("Zeroconf service name collision.")
364
elif state == avahi.ENTRY_GROUP_FAILURE:
365
logger.critical("Avahi: Error in group state changed %s",
367
raise AvahiGroupError("State changed: {!s}".format(error))
370
"""Derived from the Avahi example code"""
371
if self.group is not None:
374
except (dbus.exceptions.UnknownMethodException,
375
dbus.exceptions.DBusException):
380
def server_state_changed(self, state, error=None):
381
"""Derived from the Avahi example code"""
382
logger.debug("Avahi server state change: %i", state)
384
avahi.SERVER_INVALID: "Zeroconf server invalid",
385
avahi.SERVER_REGISTERING: None,
386
avahi.SERVER_COLLISION: "Zeroconf server name collision",
387
avahi.SERVER_FAILURE: "Zeroconf server failure",
389
if state in bad_states:
390
if bad_states[state] is not None:
392
logger.error(bad_states[state])
394
logger.error(bad_states[state] + ": %r", error)
396
elif state == avahi.SERVER_RUNNING:
400
logger.debug("Unknown state: %r", state)
402
logger.debug("Unknown state: %r: %r", state, error)
405
"""Derived from the Avahi example code"""
406
if self.server is None:
407
self.server = dbus.Interface(
408
self.bus.get_object(avahi.DBUS_NAME,
409
avahi.DBUS_PATH_SERVER,
410
follow_name_owner_changes=True),
411
avahi.DBUS_INTERFACE_SERVER)
412
self.server.connect_to_signal("StateChanged",
413
self.server_state_changed)
414
self.server_state_changed(self.server.GetState())
417
class AvahiServiceToSyslog(AvahiService):
418
def rename(self, *args, **kwargs):
419
"""Add the new name to the syslog messages"""
420
ret = AvahiService.rename(self, *args, **kwargs)
421
syslogger.setFormatter(logging.Formatter(
422
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
426
def subprocess_call_pipe(connection, # : multiprocessing.Connection
428
"""This function is meant to be called by multiprocessing.Process
430
This function runs a synchronous subprocess.call(), and writes the
431
resulting return code on the provided multiprocessing.Connection.
433
connection.send(subprocess.call(*args, **kwargs))
436
class Client(object):
182
437
"""A representation of a client host served by this server.
184
name: string; from the config file, used in log messages and
186
fingerprint: string (40 or 32 hexadecimal digits); used to
187
uniquely identify the client
188
secret: bytestring; sent verbatim (over TLS) to client
189
host: string; available for use by the checker command
190
created: datetime.datetime(); (UTC) object creation
191
last_enabled: datetime.datetime(); (UTC)
193
last_checked_ok: datetime.datetime(); (UTC) or None
194
timeout: datetime.timedelta(); How long from last_checked_ok
195
until this client is invalid
196
interval: datetime.timedelta(); How often to start a new checker
197
disable_hook: If set, called by disable() as disable_hook(self)
440
approved: bool(); 'None' if not yet approved/disapproved
441
approval_delay: datetime.timedelta(); Time to wait for approval
442
approval_duration: datetime.timedelta(); Duration of one approval
198
443
checker: subprocess.Popen(); a running checker process used
199
444
to see if the client lives.
200
445
'None' if no process is running.
201
checker_initiator_tag: a gobject event source tag, or None
202
disable_initiator_tag: - '' -
203
checker_callback_tag: - '' -
204
checker_command: string; External command which is run to check if
205
client lives. %() expansions are done at
446
checker_callback_tag: a gobject event source tag, or None
447
checker_command: string; External command which is run to check
448
if client lives. %() expansions are done at
206
449
runtime with vars(self) as dict, so that for
207
450
instance %(name)s can be used in the command.
451
checker_initiator_tag: a gobject event source tag, or None
452
created: datetime.datetime(); (UTC) object creation
453
client_structure: Object describing what attributes a client has
454
and is used for storing the client at exit
208
455
current_checker_command: string; current running checker_command
209
use_dbus: bool(); Whether to provide D-Bus interface and signals
210
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
456
disable_initiator_tag: a gobject event source tag, or None
458
fingerprint: string (40 or 32 hexadecimal digits); used to
459
uniquely identify the client
460
host: string; available for use by the checker command
461
interval: datetime.timedelta(); How often to start a new checker
462
last_approval_request: datetime.datetime(); (UTC) or None
463
last_checked_ok: datetime.datetime(); (UTC) or None
464
last_checker_status: integer between 0 and 255 reflecting exit
465
status of last checker. -1 reflects crashed
466
checker, -2 means no checker completed yet.
467
last_checker_signal: The signal which killed the last checker, if
468
last_checker_status is -1
469
last_enabled: datetime.datetime(); (UTC) or None
470
name: string; from the config file, used in log messages and
472
secret: bytestring; sent verbatim (over TLS) to client
473
timeout: datetime.timedelta(); How long from last_checked_ok
474
until this client is disabled
475
extended_timeout: extra long timeout when secret has been sent
476
runtime_expansions: Allowed attributes for runtime expansion.
477
expires: datetime.datetime(); time (UTC) when a client will be
479
server_settings: The server_settings dict from main()
212
def timeout_milliseconds(self):
213
"Return the 'timeout' attribute in milliseconds"
214
return ((self.timeout.days * 24 * 60 * 60 * 1000)
215
+ (self.timeout.seconds * 1000)
216
+ (self.timeout.microseconds // 1000))
218
def interval_milliseconds(self):
219
"Return the 'interval' attribute in milliseconds"
220
return ((self.interval.days * 24 * 60 * 60 * 1000)
221
+ (self.interval.seconds * 1000)
222
+ (self.interval.microseconds // 1000))
224
def __init__(self, name = None, disable_hook=None, config=None,
226
"""Note: the 'checker' key in 'config' sets the
227
'checker_command' attribute and *not* the 'checker'
482
runtime_expansions = ("approval_delay", "approval_duration",
483
"created", "enabled", "expires",
484
"fingerprint", "host", "interval",
485
"last_approval_request", "last_checked_ok",
486
"last_enabled", "name", "timeout")
489
"extended_timeout": "PT15M",
491
"checker": "fping -q -- %%(host)s",
493
"approval_delay": "PT0S",
494
"approval_duration": "PT1S",
495
"approved_by_default": "True",
500
def config_parser(config):
501
"""Construct a new dict of client settings of this form:
502
{ client_name: {setting_name: value, ...}, ...}
503
with exceptions for any special settings as defined above.
504
NOTE: Must be a pure function. Must return the same result
505
value given the same arguments.
508
for client_name in config.sections():
509
section = dict(config.items(client_name))
510
client = settings[client_name] = {}
512
client["host"] = section["host"]
513
# Reformat values from string types to Python types
514
client["approved_by_default"] = config.getboolean(
515
client_name, "approved_by_default")
516
client["enabled"] = config.getboolean(client_name,
519
# Uppercase and remove spaces from fingerprint for later
520
# comparison purposes with return value from the
521
# fingerprint() function
522
client["fingerprint"] = (section["fingerprint"].upper()
524
if "secret" in section:
525
client["secret"] = section["secret"].decode("base64")
526
elif "secfile" in section:
527
with open(os.path.expanduser(os.path.expandvars
528
(section["secfile"])),
530
client["secret"] = secfile.read()
532
raise TypeError("No secret or secfile for section {}"
534
client["timeout"] = string_to_delta(section["timeout"])
535
client["extended_timeout"] = string_to_delta(
536
section["extended_timeout"])
537
client["interval"] = string_to_delta(section["interval"])
538
client["approval_delay"] = string_to_delta(
539
section["approval_delay"])
540
client["approval_duration"] = string_to_delta(
541
section["approval_duration"])
542
client["checker_command"] = section["checker"]
543
client["last_approval_request"] = None
544
client["last_checked_ok"] = None
545
client["last_checker_status"] = -2
549
def __init__(self, settings, name = None, server_settings=None):
232
logger.debug(u"Creating client %r", self.name)
233
self.use_dbus = False # During __init__
234
# Uppercase and remove spaces from fingerprint for later
235
# comparison purposes with return value from the fingerprint()
237
self.fingerprint = (config["fingerprint"].upper()
239
logger.debug(u" Fingerprint: %s", self.fingerprint)
240
if "secret" in config:
241
self.secret = config["secret"].decode(u"base64")
242
elif "secfile" in config:
243
with closing(open(os.path.expanduser
245
(config["secfile"])))) as secfile:
246
self.secret = secfile.read()
551
if server_settings is None:
553
self.server_settings = server_settings
554
# adding all client settings
555
for setting, value in settings.items():
556
setattr(self, setting, value)
559
if not hasattr(self, "last_enabled"):
560
self.last_enabled = datetime.datetime.utcnow()
561
if not hasattr(self, "expires"):
562
self.expires = (datetime.datetime.utcnow()
248
raise TypeError(u"No secret or secfile for client %s"
250
self.host = config.get("host", "")
251
self.created = datetime.datetime.utcnow()
253
self.last_enabled = None
254
self.last_checked_ok = None
255
self.timeout = string_to_delta(config["timeout"])
256
self.interval = string_to_delta(config["interval"])
257
self.disable_hook = disable_hook
565
self.last_enabled = None
568
logger.debug("Creating client %r", self.name)
569
logger.debug(" Fingerprint: %s", self.fingerprint)
570
self.created = settings.get("created",
571
datetime.datetime.utcnow())
573
# attributes specific for this server instance
258
574
self.checker = None
259
575
self.checker_initiator_tag = None
260
576
self.disable_initiator_tag = None
261
577
self.checker_callback_tag = None
262
self.checker_command = config["checker"]
263
578
self.current_checker_command = None
264
self.last_connect = None
265
# Only now, when this client is initialized, can it show up on
267
self.use_dbus = use_dbus
269
self.dbus_object_path = (dbus.ObjectPath
271
+ self.name.replace(".", "_")))
272
dbus.service.Object.__init__(self, bus,
273
self.dbus_object_path)
580
self.approvals_pending = 0
581
self.changedstate = multiprocessing_manager.Condition(
582
multiprocessing_manager.Lock())
583
self.client_structure = [attr
584
for attr in self.__dict__.iterkeys()
585
if not attr.startswith("_")]
586
self.client_structure.append("client_structure")
588
for name, t in inspect.getmembers(
589
type(self), lambda obj: isinstance(obj, property)):
590
if not name.startswith("_"):
591
self.client_structure.append(name)
593
# Send notice to process children that client state has changed
594
def send_changedstate(self):
595
with self.changedstate:
596
self.changedstate.notify_all()
275
598
def enable(self):
276
599
"""Start this client's checker and timeout hooks"""
600
if getattr(self, "enabled", False):
603
self.expires = datetime.datetime.utcnow() + self.timeout
277
605
self.last_enabled = datetime.datetime.utcnow()
607
self.send_changedstate()
609
def disable(self, quiet=True):
610
"""Disable this client."""
611
if not getattr(self, "enabled", False):
614
logger.info("Disabling client %s", self.name)
615
if getattr(self, "disable_initiator_tag", None) is not None:
616
gobject.source_remove(self.disable_initiator_tag)
617
self.disable_initiator_tag = None
619
if getattr(self, "checker_initiator_tag", None) is not None:
620
gobject.source_remove(self.checker_initiator_tag)
621
self.checker_initiator_tag = None
625
self.send_changedstate()
626
# Do not run this again if called by a gobject.timeout_add
632
def init_checker(self):
278
633
# Schedule a new checker to be started an 'interval' from now,
279
634
# and every interval from then on.
280
self.checker_initiator_tag = (gobject.timeout_add
281
(self.interval_milliseconds(),
635
if self.checker_initiator_tag is not None:
636
gobject.source_remove(self.checker_initiator_tag)
637
self.checker_initiator_tag = gobject.timeout_add(
638
int(self.interval.total_seconds() * 1000),
640
# Schedule a disable() when 'timeout' has passed
641
if self.disable_initiator_tag is not None:
642
gobject.source_remove(self.disable_initiator_tag)
643
self.disable_initiator_tag = gobject.timeout_add(
644
int(self.timeout.total_seconds() * 1000), self.disable)
283
645
# Also start a new checker *right now*.
284
646
self.start_checker()
285
# Schedule a disable() when 'timeout' has passed
286
self.disable_initiator_tag = (gobject.timeout_add
287
(self.timeout_milliseconds(),
292
self.PropertyChanged(dbus.String(u"enabled"),
293
dbus.Boolean(True, variant_level=1))
294
self.PropertyChanged(dbus.String(u"last_enabled"),
295
(_datetime_to_dbus(self.last_enabled,
299
"""Disable this client."""
300
if not getattr(self, "enabled", False):
302
logger.info(u"Disabling client %s", self.name)
303
if getattr(self, "disable_initiator_tag", False):
304
gobject.source_remove(self.disable_initiator_tag)
305
self.disable_initiator_tag = None
306
if getattr(self, "checker_initiator_tag", False):
307
gobject.source_remove(self.checker_initiator_tag)
308
self.checker_initiator_tag = None
310
if self.disable_hook:
311
self.disable_hook(self)
315
self.PropertyChanged(dbus.String(u"enabled"),
316
dbus.Boolean(False, variant_level=1))
317
# Do not run this again if called by a gobject.timeout_add
321
self.disable_hook = None
324
def checker_callback(self, pid, condition, command):
648
def checker_callback(self, source, condition,
649
(connection, command)):
325
650
"""The checker has completed, so take appropriate actions."""
326
651
self.checker_callback_tag = None
327
652
self.checker = None
330
self.PropertyChanged(dbus.String(u"checker_running"),
331
dbus.Boolean(False, variant_level=1))
332
if os.WIFEXITED(condition):
333
exitstatus = os.WEXITSTATUS(condition)
335
logger.info(u"Checker for %(name)s succeeded",
653
# Read return code from connection (see subprocess_call_pipe)
654
returncode = connection.recv()
658
self.last_checker_status = returncode
659
self.last_checker_signal = None
660
if self.last_checker_status == 0:
661
logger.info("Checker for %(name)s succeeded",
337
663
self.checked_ok()
339
logger.info(u"Checker for %(name)s failed",
343
self.CheckerCompleted(dbus.Int16(exitstatus),
344
dbus.Int64(condition),
345
dbus.String(command))
665
logger.info("Checker for %(name)s failed", vars(self))
347
logger.warning(u"Checker for %(name)s crashed?",
667
self.last_checker_status = -1
668
self.last_checker_signal = -returncode
669
logger.warning("Checker for %(name)s crashed?",
351
self.CheckerCompleted(dbus.Int16(-1),
352
dbus.Int64(condition),
353
dbus.String(command))
355
673
def checked_ok(self):
356
"""Bump up the timeout for this client.
357
This should only be called when the client has been seen,
674
"""Assert that the client has been seen, alive and well."""
360
675
self.last_checked_ok = datetime.datetime.utcnow()
361
gobject.source_remove(self.disable_initiator_tag)
362
self.disable_initiator_tag = (gobject.timeout_add
363
(self.timeout_milliseconds(),
367
self.PropertyChanged(
368
dbus.String(u"last_checked_ok"),
369
(_datetime_to_dbus(self.last_checked_ok,
676
self.last_checker_status = 0
677
self.last_checker_signal = None
680
def bump_timeout(self, timeout=None):
681
"""Bump up the timeout for this client."""
683
timeout = self.timeout
684
if self.disable_initiator_tag is not None:
685
gobject.source_remove(self.disable_initiator_tag)
686
self.disable_initiator_tag = None
687
if getattr(self, "enabled", False):
688
self.disable_initiator_tag = gobject.timeout_add(
689
int(timeout.total_seconds() * 1000), self.disable)
690
self.expires = datetime.datetime.utcnow() + timeout
692
def need_approval(self):
693
self.last_approval_request = datetime.datetime.utcnow()
372
695
def start_checker(self):
373
696
"""Start a new checker subprocess if one is not running.
374
698
If a checker already exists, leave it running and do
376
700
# The reason for not killing a running checker is that if we
377
# did that, then if a checker (for some reason) started
378
# running slowly and taking more than 'interval' time, the
379
# client would inevitably timeout, since no checker would get
380
# a chance to run to completion. If we instead leave running
701
# did that, and if a checker (for some reason) started running
702
# slowly and taking more than 'interval' time, then the client
703
# would inevitably timeout, since no checker would get a
704
# chance to run to completion. If we instead leave running
381
705
# checkers alone, the checker would have to take more time
382
# than 'timeout' for the client to be declared invalid, which
383
# is as it should be.
706
# than 'timeout' for the client to be disabled, which is as it
385
# If a checker exists, make sure it is not a zombie
386
if self.checker is not None:
387
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
389
logger.warning("Checker was a zombie")
390
gobject.source_remove(self.checker_callback_tag)
391
self.checker_callback(pid, status,
392
self.current_checker_command)
709
if self.checker is not None and not self.checker.is_alive():
710
logger.warning("Checker was not alive; joining")
393
713
# Start a new checker if needed
394
714
if self.checker is None:
396
# In case checker_command has exactly one % operator
397
command = self.checker_command % self.host
399
# Escape attributes for the shell
400
escaped_attrs = dict((key, re.escape(str(val)))
402
vars(self).iteritems())
404
command = self.checker_command % escaped_attrs
405
except TypeError, error:
406
logger.error(u'Could not format string "%s":'
407
u' %s', self.checker_command, error)
408
return True # Try again later
409
self.current_checker_command = command
411
logger.info(u"Starting checker %r for %s",
413
# We don't need to redirect stdout and stderr, since
414
# in normal mode, that is already done by daemon(),
415
# and in debug mode we don't want to. (Stdin is
416
# always replaced by /dev/null.)
417
self.checker = subprocess.Popen(command,
422
self.CheckerStarted(command)
423
self.PropertyChanged(
424
dbus.String("checker_running"),
425
dbus.Boolean(True, variant_level=1))
426
self.checker_callback_tag = (gobject.child_watch_add
428
self.checker_callback,
430
# The checker may have completed before the gobject
431
# watch was added. Check for this.
432
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
434
gobject.source_remove(self.checker_callback_tag)
435
self.checker_callback(pid, status, command)
436
except OSError, error:
437
logger.error(u"Failed to start subprocess: %s",
715
# Escape attributes for the shell
717
attr: re.escape(str(getattr(self, attr)))
718
for attr in self.runtime_expansions }
720
command = self.checker_command % escaped_attrs
721
except TypeError as error:
722
logger.error('Could not format string "%s"',
723
self.checker_command,
725
return True # Try again later
726
self.current_checker_command = command
727
logger.info("Starting checker %r for %s", command,
729
# We don't need to redirect stdout and stderr, since
730
# in normal mode, that is already done by daemon(),
731
# and in debug mode we don't want to. (Stdin is
732
# always replaced by /dev/null.)
733
# The exception is when not debugging but nevertheless
734
# running in the foreground; use the previously
736
popen_args = { "close_fds": True,
739
if (not self.server_settings["debug"]
740
and self.server_settings["foreground"]):
741
popen_args.update({"stdout": wnull,
743
pipe = multiprocessing.Pipe(duplex=False)
744
self.checker = multiprocessing.Process(
745
target=subprocess_call_pipe, args=(pipe[1], command),
748
self.checker_callback_tag = gobject.io_add_watch(
749
pipe[0].fileno(), gobject.IO_IN,
750
self.checker_callback, (pipe[0], command))
439
751
# Re-run this periodically if run by gobject.timeout_add
446
758
self.checker_callback_tag = None
447
759
if getattr(self, "checker", None) is None:
449
logger.debug(u"Stopping checker for %(name)s", vars(self))
451
os.kill(self.checker.pid, signal.SIGTERM)
453
#if self.checker.poll() is None:
454
# os.kill(self.checker.pid, signal.SIGKILL)
455
except OSError, error:
456
if error.errno != errno.ESRCH: # No such process
761
logger.debug("Stopping checker for %(name)s", vars(self))
762
self.checker.terminate()
458
763
self.checker = None
460
self.PropertyChanged(dbus.String(u"checker_running"),
461
dbus.Boolean(False, variant_level=1))
463
def still_valid(self):
464
"""Has the timeout not yet passed for this client?"""
465
if not getattr(self, "enabled", False):
467
now = datetime.datetime.utcnow()
468
if self.last_checked_ok is None:
469
return now < (self.created + self.timeout)
766
def dbus_service_property(dbus_interface,
770
"""Decorators for marking methods of a DBusObjectWithProperties to
771
become properties on the D-Bus.
773
The decorated method will be called with no arguments by "Get"
774
and with one argument by "Set".
776
The parameters, where they are supported, are the same as
777
dbus.service.method, except there is only "signature", since the
778
type from Get() and the type sent to Set() is the same.
780
# Encoding deeply encoded byte arrays is not supported yet by the
781
# "Set" method, so we fail early here:
782
if byte_arrays and signature != "ay":
783
raise ValueError("Byte arrays not supported for non-'ay'"
784
" signature {!r}".format(signature))
787
func._dbus_is_property = True
788
func._dbus_interface = dbus_interface
789
func._dbus_signature = signature
790
func._dbus_access = access
791
func._dbus_name = func.__name__
792
if func._dbus_name.endswith("_dbus_property"):
793
func._dbus_name = func._dbus_name[:-14]
794
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
800
def dbus_interface_annotations(dbus_interface):
801
"""Decorator for marking functions returning interface annotations
805
@dbus_interface_annotations("org.example.Interface")
806
def _foo(self): # Function name does not matter
807
return {"org.freedesktop.DBus.Deprecated": "true",
808
"org.freedesktop.DBus.Property.EmitsChangedSignal":
813
func._dbus_is_interface = True
814
func._dbus_interface = dbus_interface
815
func._dbus_name = dbus_interface
821
def dbus_annotations(annotations):
822
"""Decorator to annotate D-Bus methods, signals or properties
825
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
826
"org.freedesktop.DBus.Property."
827
"EmitsChangedSignal": "false"})
828
@dbus_service_property("org.example.Interface", signature="b",
830
def Property_dbus_property(self):
831
return dbus.Boolean(False)
835
func._dbus_annotations = annotations
841
class DBusPropertyException(dbus.exceptions.DBusException):
842
"""A base class for D-Bus property-related exceptions
847
class DBusPropertyAccessException(DBusPropertyException):
848
"""A property's access permissions disallows an operation.
853
class DBusPropertyNotFound(DBusPropertyException):
854
"""An attempt was made to access a non-existing property.
859
class DBusObjectWithProperties(dbus.service.Object):
860
"""A D-Bus object with properties.
862
Classes inheriting from this can use the dbus_service_property
863
decorator to expose methods as D-Bus properties. It exposes the
864
standard Get(), Set(), and GetAll() methods on the D-Bus.
868
def _is_dbus_thing(thing):
869
"""Returns a function testing if an attribute is a D-Bus thing
871
If called like _is_dbus_thing("method") it returns a function
872
suitable for use as predicate to inspect.getmembers().
874
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
877
def _get_all_dbus_things(self, thing):
878
"""Returns a generator of (name, attribute) pairs
880
return ((getattr(athing.__get__(self), "_dbus_name", name),
881
athing.__get__(self))
882
for cls in self.__class__.__mro__
884
inspect.getmembers(cls, self._is_dbus_thing(thing)))
886
def _get_dbus_property(self, interface_name, property_name):
887
"""Returns a bound method if one exists which is a D-Bus
888
property with the specified name and interface.
890
for cls in self.__class__.__mro__:
891
for name, value in inspect.getmembers(
892
cls, self._is_dbus_thing("property")):
893
if (value._dbus_name == property_name
894
and value._dbus_interface == interface_name):
895
return value.__get__(self)
898
raise DBusPropertyNotFound("{}:{}.{}".format(
899
self.dbus_object_path, interface_name, property_name))
901
@dbus.service.method(dbus.PROPERTIES_IFACE,
904
def Get(self, interface_name, property_name):
905
"""Standard D-Bus property Get() method, see D-Bus standard.
907
prop = self._get_dbus_property(interface_name, property_name)
908
if prop._dbus_access == "write":
909
raise DBusPropertyAccessException(property_name)
911
if not hasattr(value, "variant_level"):
913
return type(value)(value, variant_level=value.variant_level+1)
915
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
916
def Set(self, interface_name, property_name, value):
917
"""Standard D-Bus property Set() method, see D-Bus standard.
919
prop = self._get_dbus_property(interface_name, property_name)
920
if prop._dbus_access == "read":
921
raise DBusPropertyAccessException(property_name)
922
if prop._dbus_get_args_options["byte_arrays"]:
923
# The byte_arrays option is not supported yet on
924
# signatures other than "ay".
925
if prop._dbus_signature != "ay":
926
raise ValueError("Byte arrays not supported for non-"
927
"'ay' signature {!r}"
928
.format(prop._dbus_signature))
929
value = dbus.ByteArray(b''.join(chr(byte)
933
@dbus.service.method(dbus.PROPERTIES_IFACE,
935
out_signature="a{sv}")
936
def GetAll(self, interface_name):
937
"""Standard D-Bus property GetAll() method, see D-Bus
940
Note: Will not include properties with access="write".
943
for name, prop in self._get_all_dbus_things("property"):
945
and interface_name != prop._dbus_interface):
946
# Interface non-empty but did not match
948
# Ignore write-only properties
949
if prop._dbus_access == "write":
952
if not hasattr(value, "variant_level"):
953
properties[name] = value
955
properties[name] = type(value)(
956
value, variant_level = value.variant_level + 1)
957
return dbus.Dictionary(properties, signature="sv")
959
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
960
def PropertiesChanged(self, interface_name, changed_properties,
961
invalidated_properties):
962
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
967
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
969
path_keyword='object_path',
970
connection_keyword='connection')
971
def Introspect(self, object_path, connection):
972
"""Overloading of standard D-Bus method.
974
Inserts property tags and interface annotation tags.
976
xmlstring = dbus.service.Object.Introspect(self, object_path,
979
document = xml.dom.minidom.parseString(xmlstring)
981
def make_tag(document, name, prop):
982
e = document.createElement("property")
983
e.setAttribute("name", name)
984
e.setAttribute("type", prop._dbus_signature)
985
e.setAttribute("access", prop._dbus_access)
988
for if_tag in document.getElementsByTagName("interface"):
990
for tag in (make_tag(document, name, prop)
992
in self._get_all_dbus_things("property")
993
if prop._dbus_interface
994
== if_tag.getAttribute("name")):
995
if_tag.appendChild(tag)
996
# Add annotation tags
997
for typ in ("method", "signal", "property"):
998
for tag in if_tag.getElementsByTagName(typ):
1000
for name, prop in (self.
1001
_get_all_dbus_things(typ)):
1002
if (name == tag.getAttribute("name")
1003
and prop._dbus_interface
1004
== if_tag.getAttribute("name")):
1005
annots.update(getattr(
1006
prop, "_dbus_annotations", {}))
1007
for name, value in annots.items():
1008
ann_tag = document.createElement(
1010
ann_tag.setAttribute("name", name)
1011
ann_tag.setAttribute("value", value)
1012
tag.appendChild(ann_tag)
1013
# Add interface annotation tags
1014
for annotation, value in dict(
1015
itertools.chain.from_iterable(
1016
annotations().items()
1017
for name, annotations
1018
in self._get_all_dbus_things("interface")
1019
if name == if_tag.getAttribute("name")
1021
ann_tag = document.createElement("annotation")
1022
ann_tag.setAttribute("name", annotation)
1023
ann_tag.setAttribute("value", value)
1024
if_tag.appendChild(ann_tag)
1025
# Add the names to the return values for the
1026
# "org.freedesktop.DBus.Properties" methods
1027
if (if_tag.getAttribute("name")
1028
== "org.freedesktop.DBus.Properties"):
1029
for cn in if_tag.getElementsByTagName("method"):
1030
if cn.getAttribute("name") == "Get":
1031
for arg in cn.getElementsByTagName("arg"):
1032
if (arg.getAttribute("direction")
1034
arg.setAttribute("name", "value")
1035
elif cn.getAttribute("name") == "GetAll":
1036
for arg in cn.getElementsByTagName("arg"):
1037
if (arg.getAttribute("direction")
1039
arg.setAttribute("name", "props")
1040
xmlstring = document.toxml("utf-8")
1042
except (AttributeError, xml.dom.DOMException,
1043
xml.parsers.expat.ExpatError) as error:
1044
logger.error("Failed to override Introspection method",
1049
def datetime_to_dbus(dt, variant_level=0):
1050
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1052
return dbus.String("", variant_level = variant_level)
1053
return dbus.String(dt.isoformat(), variant_level=variant_level)
1056
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1057
"""A class decorator; applied to a subclass of
1058
dbus.service.Object, it will add alternate D-Bus attributes with
1059
interface names according to the "alt_interface_names" mapping.
1062
@alternate_dbus_interfaces({"org.example.Interface":
1063
"net.example.AlternateInterface"})
1064
class SampleDBusObject(dbus.service.Object):
1065
@dbus.service.method("org.example.Interface")
1066
def SampleDBusMethod():
1069
The above "SampleDBusMethod" on "SampleDBusObject" will be
1070
reachable via two interfaces: "org.example.Interface" and
1071
"net.example.AlternateInterface", the latter of which will have
1072
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1073
"true", unless "deprecate" is passed with a False value.
1075
This works for methods and signals, and also for D-Bus properties
1076
(from DBusObjectWithProperties) and interfaces (from the
1077
dbus_interface_annotations decorator).
1081
for orig_interface_name, alt_interface_name in (
1082
alt_interface_names.items()):
1084
interface_names = set()
1085
# Go though all attributes of the class
1086
for attrname, attribute in inspect.getmembers(cls):
1087
# Ignore non-D-Bus attributes, and D-Bus attributes
1088
# with the wrong interface name
1089
if (not hasattr(attribute, "_dbus_interface")
1090
or not attribute._dbus_interface.startswith(
1091
orig_interface_name)):
1093
# Create an alternate D-Bus interface name based on
1095
alt_interface = attribute._dbus_interface.replace(
1096
orig_interface_name, alt_interface_name)
1097
interface_names.add(alt_interface)
1098
# Is this a D-Bus signal?
1099
if getattr(attribute, "_dbus_is_signal", False):
1100
# Extract the original non-method undecorated
1101
# function by black magic
1102
nonmethod_func = (dict(
1103
zip(attribute.func_code.co_freevars,
1104
attribute.__closure__))
1105
["func"].cell_contents)
1106
# Create a new, but exactly alike, function
1107
# object, and decorate it to be a new D-Bus signal
1108
# with the alternate D-Bus interface name
1109
new_function = (dbus.service.signal(
1110
alt_interface, attribute._dbus_signature)
1111
(types.FunctionType(
1112
nonmethod_func.func_code,
1113
nonmethod_func.func_globals,
1114
nonmethod_func.func_name,
1115
nonmethod_func.func_defaults,
1116
nonmethod_func.func_closure)))
1117
# Copy annotations, if any
1119
new_function._dbus_annotations = dict(
1120
attribute._dbus_annotations)
1121
except AttributeError:
1123
# Define a creator of a function to call both the
1124
# original and alternate functions, so both the
1125
# original and alternate signals gets sent when
1126
# the function is called
1127
def fixscope(func1, func2):
1128
"""This function is a scope container to pass
1129
func1 and func2 to the "call_both" function
1130
outside of its arguments"""
1132
def call_both(*args, **kwargs):
1133
"""This function will emit two D-Bus
1134
signals by calling func1 and func2"""
1135
func1(*args, **kwargs)
1136
func2(*args, **kwargs)
1139
# Create the "call_both" function and add it to
1141
attr[attrname] = fixscope(attribute, new_function)
1142
# Is this a D-Bus method?
1143
elif getattr(attribute, "_dbus_is_method", False):
1144
# Create a new, but exactly alike, function
1145
# object. Decorate it to be a new D-Bus method
1146
# with the alternate D-Bus interface name. Add it
1149
dbus.service.method(
1151
attribute._dbus_in_signature,
1152
attribute._dbus_out_signature)
1153
(types.FunctionType(attribute.func_code,
1154
attribute.func_globals,
1155
attribute.func_name,
1156
attribute.func_defaults,
1157
attribute.func_closure)))
1158
# Copy annotations, if any
1160
attr[attrname]._dbus_annotations = dict(
1161
attribute._dbus_annotations)
1162
except AttributeError:
1164
# Is this a D-Bus property?
1165
elif getattr(attribute, "_dbus_is_property", False):
1166
# Create a new, but exactly alike, function
1167
# object, and decorate it to be a new D-Bus
1168
# property with the alternate D-Bus interface
1169
# name. Add it to the class.
1170
attr[attrname] = (dbus_service_property(
1171
alt_interface, attribute._dbus_signature,
1172
attribute._dbus_access,
1173
attribute._dbus_get_args_options
1175
(types.FunctionType(
1176
attribute.func_code,
1177
attribute.func_globals,
1178
attribute.func_name,
1179
attribute.func_defaults,
1180
attribute.func_closure)))
1181
# Copy annotations, if any
1183
attr[attrname]._dbus_annotations = dict(
1184
attribute._dbus_annotations)
1185
except AttributeError:
1187
# Is this a D-Bus interface?
1188
elif getattr(attribute, "_dbus_is_interface", False):
1189
# Create a new, but exactly alike, function
1190
# object. Decorate it to be a new D-Bus interface
1191
# with the alternate D-Bus interface name. Add it
1194
dbus_interface_annotations(alt_interface)
1195
(types.FunctionType(attribute.func_code,
1196
attribute.func_globals,
1197
attribute.func_name,
1198
attribute.func_defaults,
1199
attribute.func_closure)))
1201
# Deprecate all alternate interfaces
1202
iname="_AlternateDBusNames_interface_annotation{}"
1203
for interface_name in interface_names:
1205
@dbus_interface_annotations(interface_name)
1207
return { "org.freedesktop.DBus.Deprecated":
1209
# Find an unused name
1210
for aname in (iname.format(i)
1211
for i in itertools.count()):
1212
if aname not in attr:
1216
# Replace the class with a new subclass of it with
1217
# methods, signals, etc. as created above.
1218
cls = type(b"{}Alternate".format(cls.__name__),
1225
@alternate_dbus_interfaces({"se.recompile.Mandos":
1226
"se.bsnet.fukt.Mandos"})
1227
class ClientDBus(Client, DBusObjectWithProperties):
1228
"""A Client class using D-Bus
1231
dbus_object_path: dbus.ObjectPath
1232
bus: dbus.SystemBus()
1235
runtime_expansions = (Client.runtime_expansions
1236
+ ("dbus_object_path", ))
1238
_interface = "se.recompile.Mandos.Client"
1240
# dbus.service.Object doesn't use super(), so we can't either.
1242
def __init__(self, bus = None, *args, **kwargs):
1244
Client.__init__(self, *args, **kwargs)
1245
# Only now, when this client is initialized, can it show up on
1247
client_object_name = str(self.name).translate(
1248
{ord("."): ord("_"),
1249
ord("-"): ord("_")})
1250
self.dbus_object_path = dbus.ObjectPath(
1251
"/clients/" + client_object_name)
1252
DBusObjectWithProperties.__init__(self, self.bus,
1253
self.dbus_object_path)
1255
def notifychangeproperty(transform_func, dbus_name,
1256
type_func=lambda x: x,
1258
invalidate_only=False,
1259
_interface=_interface):
1260
""" Modify a variable so that it's a property which announces
1261
its changes to DBus.
1263
transform_fun: Function that takes a value and a variant_level
1264
and transforms it to a D-Bus type.
1265
dbus_name: D-Bus name of the variable
1266
type_func: Function that transform the value before sending it
1267
to the D-Bus. Default: no transform
1268
variant_level: D-Bus variant level. Default: 1
1270
attrname = "_{}".format(dbus_name)
1272
def setter(self, value):
1273
if hasattr(self, "dbus_object_path"):
1274
if (not hasattr(self, attrname) or
1275
type_func(getattr(self, attrname, None))
1276
!= type_func(value)):
1278
self.PropertiesChanged(
1279
_interface, dbus.Dictionary(),
1280
dbus.Array((dbus_name, )))
1282
dbus_value = transform_func(
1284
variant_level = variant_level)
1285
self.PropertyChanged(dbus.String(dbus_name),
1287
self.PropertiesChanged(
1289
dbus.Dictionary({ dbus.String(dbus_name):
1292
setattr(self, attrname, value)
1294
return property(lambda self: getattr(self, attrname), setter)
1296
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1297
approvals_pending = notifychangeproperty(dbus.Boolean,
1300
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1301
last_enabled = notifychangeproperty(datetime_to_dbus,
1303
checker = notifychangeproperty(
1304
dbus.Boolean, "CheckerRunning",
1305
type_func = lambda checker: checker is not None)
1306
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1308
last_checker_status = notifychangeproperty(dbus.Int16,
1309
"LastCheckerStatus")
1310
last_approval_request = notifychangeproperty(
1311
datetime_to_dbus, "LastApprovalRequest")
1312
approved_by_default = notifychangeproperty(dbus.Boolean,
1313
"ApprovedByDefault")
1314
approval_delay = notifychangeproperty(
1315
dbus.UInt64, "ApprovalDelay",
1316
type_func = lambda td: td.total_seconds() * 1000)
1317
approval_duration = notifychangeproperty(
1318
dbus.UInt64, "ApprovalDuration",
1319
type_func = lambda td: td.total_seconds() * 1000)
1320
host = notifychangeproperty(dbus.String, "Host")
1321
timeout = notifychangeproperty(
1322
dbus.UInt64, "Timeout",
1323
type_func = lambda td: td.total_seconds() * 1000)
1324
extended_timeout = notifychangeproperty(
1325
dbus.UInt64, "ExtendedTimeout",
1326
type_func = lambda td: td.total_seconds() * 1000)
1327
interval = notifychangeproperty(
1328
dbus.UInt64, "Interval",
1329
type_func = lambda td: td.total_seconds() * 1000)
1330
checker_command = notifychangeproperty(dbus.String, "Checker")
1331
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1332
invalidate_only=True)
1334
del notifychangeproperty
1336
def __del__(self, *args, **kwargs):
1338
self.remove_from_connection()
1341
if hasattr(DBusObjectWithProperties, "__del__"):
1342
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1343
Client.__del__(self, *args, **kwargs)
1345
def checker_callback(self, source, condition,
1346
(connection, command), *args, **kwargs):
1347
ret = Client.checker_callback(self, source, condition,
1348
(connection, command), *args,
1350
exitstatus = self.last_checker_status
1353
self.CheckerCompleted(dbus.Int16(exitstatus),
1355
dbus.String(command))
471
return now < (self.last_checked_ok + self.timeout)
473
## D-Bus methods & signals
474
_interface = u"se.bsnet.fukt.Mandos.Client"
477
CheckedOK = dbus.service.method(_interface)(checked_ok)
478
CheckedOK.__name__ = "CheckedOK"
1358
self.CheckerCompleted(dbus.Int16(-1),
1360
self.last_checker_signal),
1361
dbus.String(command))
1364
def start_checker(self, *args, **kwargs):
1365
old_checker_pid = getattr(self.checker, "pid", None)
1366
r = Client.start_checker(self, *args, **kwargs)
1367
# Only if new checker process was started
1368
if (self.checker is not None
1369
and old_checker_pid != self.checker.pid):
1371
self.CheckerStarted(self.current_checker_command)
1374
def _reset_approved(self):
1375
self.approved = None
1378
def approve(self, value=True):
1379
self.approved = value
1380
gobject.timeout_add(int(self.approval_duration.total_seconds()
1381
* 1000), self._reset_approved)
1382
self.send_changedstate()
1384
## D-Bus methods, signals & properties
480
1390
# CheckerCompleted - signal
481
1391
@dbus.service.signal(_interface, signature="nxs")
605
1460
# StopChecker - method
606
StopChecker = dbus.service.method(_interface)(stop_checker)
607
StopChecker.__name__ = "StopChecker"
1461
@dbus.service.method(_interface)
1462
def StopChecker(self):
1467
# ApprovalPending - property
1468
@dbus_service_property(_interface, signature="b", access="read")
1469
def ApprovalPending_dbus_property(self):
1470
return dbus.Boolean(bool(self.approvals_pending))
1472
# ApprovedByDefault - property
1473
@dbus_service_property(_interface,
1476
def ApprovedByDefault_dbus_property(self, value=None):
1477
if value is None: # get
1478
return dbus.Boolean(self.approved_by_default)
1479
self.approved_by_default = bool(value)
1481
# ApprovalDelay - property
1482
@dbus_service_property(_interface,
1485
def ApprovalDelay_dbus_property(self, value=None):
1486
if value is None: # get
1487
return dbus.UInt64(self.approval_delay.total_seconds()
1489
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1491
# ApprovalDuration - property
1492
@dbus_service_property(_interface,
1495
def ApprovalDuration_dbus_property(self, value=None):
1496
if value is None: # get
1497
return dbus.UInt64(self.approval_duration.total_seconds()
1499
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1502
@dbus_service_property(_interface, signature="s", access="read")
1503
def Name_dbus_property(self):
1504
return dbus.String(self.name)
1506
# Fingerprint - property
1507
@dbus_service_property(_interface, signature="s", access="read")
1508
def Fingerprint_dbus_property(self):
1509
return dbus.String(self.fingerprint)
1512
@dbus_service_property(_interface,
1515
def Host_dbus_property(self, value=None):
1516
if value is None: # get
1517
return dbus.String(self.host)
1518
self.host = str(value)
1520
# Created - property
1521
@dbus_service_property(_interface, signature="s", access="read")
1522
def Created_dbus_property(self):
1523
return datetime_to_dbus(self.created)
1525
# LastEnabled - property
1526
@dbus_service_property(_interface, signature="s", access="read")
1527
def LastEnabled_dbus_property(self):
1528
return datetime_to_dbus(self.last_enabled)
1530
# Enabled - property
1531
@dbus_service_property(_interface,
1534
def Enabled_dbus_property(self, value=None):
1535
if value is None: # get
1536
return dbus.Boolean(self.enabled)
1542
# LastCheckedOK - property
1543
@dbus_service_property(_interface,
1546
def LastCheckedOK_dbus_property(self, value=None):
1547
if value is not None:
1550
return datetime_to_dbus(self.last_checked_ok)
1552
# LastCheckerStatus - property
1553
@dbus_service_property(_interface, signature="n", access="read")
1554
def LastCheckerStatus_dbus_property(self):
1555
return dbus.Int16(self.last_checker_status)
1557
# Expires - property
1558
@dbus_service_property(_interface, signature="s", access="read")
1559
def Expires_dbus_property(self):
1560
return datetime_to_dbus(self.expires)
1562
# LastApprovalRequest - property
1563
@dbus_service_property(_interface, signature="s", access="read")
1564
def LastApprovalRequest_dbus_property(self):
1565
return datetime_to_dbus(self.last_approval_request)
1567
# Timeout - property
1568
@dbus_service_property(_interface,
1571
def Timeout_dbus_property(self, value=None):
1572
if value is None: # get
1573
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1574
old_timeout = self.timeout
1575
self.timeout = datetime.timedelta(0, 0, 0, value)
1576
# Reschedule disabling
1578
now = datetime.datetime.utcnow()
1579
self.expires += self.timeout - old_timeout
1580
if self.expires <= now:
1581
# The timeout has passed
1584
if (getattr(self, "disable_initiator_tag", None)
1587
gobject.source_remove(self.disable_initiator_tag)
1588
self.disable_initiator_tag = gobject.timeout_add(
1589
int((self.expires - now).total_seconds() * 1000),
1592
# ExtendedTimeout - property
1593
@dbus_service_property(_interface,
1596
def ExtendedTimeout_dbus_property(self, value=None):
1597
if value is None: # get
1598
return dbus.UInt64(self.extended_timeout.total_seconds()
1600
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1602
# Interval - property
1603
@dbus_service_property(_interface,
1606
def Interval_dbus_property(self, value=None):
1607
if value is None: # get
1608
return dbus.UInt64(self.interval.total_seconds() * 1000)
1609
self.interval = datetime.timedelta(0, 0, 0, value)
1610
if getattr(self, "checker_initiator_tag", None) is None:
1613
# Reschedule checker run
1614
gobject.source_remove(self.checker_initiator_tag)
1615
self.checker_initiator_tag = gobject.timeout_add(
1616
value, self.start_checker)
1617
self.start_checker() # Start one now, too
1619
# Checker - property
1620
@dbus_service_property(_interface,
1623
def Checker_dbus_property(self, value=None):
1624
if value is None: # get
1625
return dbus.String(self.checker_command)
1626
self.checker_command = str(value)
1628
# CheckerRunning - property
1629
@dbus_service_property(_interface,
1632
def CheckerRunning_dbus_property(self, value=None):
1633
if value is None: # get
1634
return dbus.Boolean(self.checker is not None)
1636
self.start_checker()
1640
# ObjectPath - property
1641
@dbus_service_property(_interface, signature="o", access="read")
1642
def ObjectPath_dbus_property(self):
1643
return self.dbus_object_path # is already a dbus.ObjectPath
1646
@dbus_service_property(_interface,
1650
def Secret_dbus_property(self, value):
1651
self.secret = bytes(value)
612
def peer_certificate(session):
613
"Return the peer's OpenPGP certificate as a bytestring"
614
# If not an OpenPGP certificate...
615
if (gnutls.library.functions
616
.gnutls_certificate_type_get(session._c_object)
617
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
618
# ...do the normal thing
619
return session.peer_certificate
620
list_size = ctypes.c_uint(1)
621
cert_list = (gnutls.library.functions
622
.gnutls_certificate_get_peers
623
(session._c_object, ctypes.byref(list_size)))
624
if not bool(cert_list) and list_size.value != 0:
625
raise gnutls.errors.GNUTLSError("error getting peer"
627
if list_size.value == 0:
630
return ctypes.string_at(cert.data, cert.size)
633
def fingerprint(openpgp):
634
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
635
# New GnuTLS "datum" with the OpenPGP public key
636
datum = (gnutls.library.types
637
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
640
ctypes.c_uint(len(openpgp))))
641
# New empty GnuTLS certificate
642
crt = gnutls.library.types.gnutls_openpgp_crt_t()
643
(gnutls.library.functions
644
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
645
# Import the OpenPGP public key into the certificate
646
(gnutls.library.functions
647
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
648
gnutls.library.constants
649
.GNUTLS_OPENPGP_FMT_RAW))
650
# Verify the self signature in the key
651
crtverify = ctypes.c_uint()
652
(gnutls.library.functions
653
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
654
if crtverify.value != 0:
655
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
656
raise gnutls.errors.CertificateSecurityError("Verify failed")
657
# New buffer for the fingerprint
658
buf = ctypes.create_string_buffer(20)
659
buf_len = ctypes.c_size_t()
660
# Get the fingerprint from the certificate into the buffer
661
(gnutls.library.functions
662
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
663
ctypes.byref(buf_len)))
664
# Deinit the certificate
665
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
666
# Convert the buffer to a Python bytestring
667
fpr = ctypes.string_at(buf, buf_len.value)
668
# Convert the bytestring to hexadecimal notation
669
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
673
class TCP_handler(SocketServer.BaseRequestHandler, object):
674
"""A TCP request handler class.
675
Instantiated by IPv6_TCPServer for each request to handle it.
1656
class ProxyClient(object):
1657
def __init__(self, child_pipe, fpr, address):
1658
self._pipe = child_pipe
1659
self._pipe.send(('init', fpr, address))
1660
if not self._pipe.recv():
1663
def __getattribute__(self, name):
1665
return super(ProxyClient, self).__getattribute__(name)
1666
self._pipe.send(('getattr', name))
1667
data = self._pipe.recv()
1668
if data[0] == 'data':
1670
if data[0] == 'function':
1672
def func(*args, **kwargs):
1673
self._pipe.send(('funcall', name, args, kwargs))
1674
return self._pipe.recv()[1]
1678
def __setattr__(self, name, value):
1680
return super(ProxyClient, self).__setattr__(name, value)
1681
self._pipe.send(('setattr', name, value))
1684
class ClientHandler(socketserver.BaseRequestHandler, object):
1685
"""A class to handle client connections.
1687
Instantiated once for each connection to handle it.
676
1688
Note: This will run in its own forked process."""
678
1690
def handle(self):
679
logger.info(u"TCP connection from: %s",
680
unicode(self.client_address))
681
session = (gnutls.connection
682
.ClientSession(self.request,
686
line = self.request.makefile().readline()
687
logger.debug(u"Protocol version: %r", line)
689
if int(line.strip().split()[0]) > 1:
691
except (ValueError, IndexError, RuntimeError), error:
692
logger.error(u"Unknown protocol version: %s", error)
695
# Note: gnutls.connection.X509Credentials is really a generic
696
# GnuTLS certificate credentials object so long as no X.509
697
# keys are added to it. Therefore, we can use it here despite
698
# using OpenPGP certificates.
700
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
701
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
703
# Use a fallback default, since this MUST be set.
704
priority = self.server.settings.get("priority", "NORMAL")
705
(gnutls.library.functions
706
.gnutls_priority_set_direct(session._c_object,
711
except gnutls.errors.GNUTLSError, error:
712
logger.warning(u"Handshake failed: %s", error)
713
# Do not run session.bye() here: the session is not
714
# established. Just abandon the request.
716
logger.debug(u"Handshake succeeded")
718
fpr = fingerprint(peer_certificate(session))
719
except (TypeError, gnutls.errors.GNUTLSError), error:
720
logger.warning(u"Bad certificate: %s", error)
723
logger.debug(u"Fingerprint: %s", fpr)
725
for c in self.server.clients:
726
if c.fingerprint == fpr:
730
logger.warning(u"Client not found for fingerprint: %s",
734
# Have to check if client.still_valid(), since it is possible
735
# that the client timed out while establishing the GnuTLS
737
if not client.still_valid():
738
logger.warning(u"Client %(name)s is invalid",
742
## This won't work here, since we're in a fork.
743
# client.checked_ok()
745
while sent_size < len(client.secret):
746
sent = session.send(client.secret[sent_size:])
747
logger.debug(u"Sent: %d, remaining: %d",
748
sent, len(client.secret)
749
- (sent_size + sent))
754
class IPv6_TCPServer(SocketServer.ForkingMixIn,
755
SocketServer.TCPServer, object):
1691
with contextlib.closing(self.server.child_pipe) as child_pipe:
1692
logger.info("TCP connection from: %s",
1693
str(self.client_address))
1694
logger.debug("Pipe FD: %d",
1695
self.server.child_pipe.fileno())
1697
session = gnutls.connection.ClientSession(
1698
self.request, gnutls.connection .X509Credentials())
1700
# Note: gnutls.connection.X509Credentials is really a
1701
# generic GnuTLS certificate credentials object so long as
1702
# no X.509 keys are added to it. Therefore, we can use it
1703
# here despite using OpenPGP certificates.
1705
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1706
# "+AES-256-CBC", "+SHA1",
1707
# "+COMP-NULL", "+CTYPE-OPENPGP",
1709
# Use a fallback default, since this MUST be set.
1710
priority = self.server.gnutls_priority
1711
if priority is None:
1713
gnutls.library.functions.gnutls_priority_set_direct(
1714
session._c_object, priority, None)
1716
# Start communication using the Mandos protocol
1717
# Get protocol number
1718
line = self.request.makefile().readline()
1719
logger.debug("Protocol version: %r", line)
1721
if int(line.strip().split()[0]) > 1:
1722
raise RuntimeError(line)
1723
except (ValueError, IndexError, RuntimeError) as error:
1724
logger.error("Unknown protocol version: %s", error)
1727
# Start GnuTLS connection
1730
except gnutls.errors.GNUTLSError as error:
1731
logger.warning("Handshake failed: %s", error)
1732
# Do not run session.bye() here: the session is not
1733
# established. Just abandon the request.
1735
logger.debug("Handshake succeeded")
1737
approval_required = False
1740
fpr = self.fingerprint(
1741
self.peer_certificate(session))
1743
gnutls.errors.GNUTLSError) as error:
1744
logger.warning("Bad certificate: %s", error)
1746
logger.debug("Fingerprint: %s", fpr)
1749
client = ProxyClient(child_pipe, fpr,
1750
self.client_address)
1754
if client.approval_delay:
1755
delay = client.approval_delay
1756
client.approvals_pending += 1
1757
approval_required = True
1760
if not client.enabled:
1761
logger.info("Client %s is disabled",
1763
if self.server.use_dbus:
1765
client.Rejected("Disabled")
1768
if client.approved or not client.approval_delay:
1769
#We are approved or approval is disabled
1771
elif client.approved is None:
1772
logger.info("Client %s needs approval",
1774
if self.server.use_dbus:
1776
client.NeedApproval(
1777
client.approval_delay.total_seconds()
1778
* 1000, client.approved_by_default)
1780
logger.warning("Client %s was not approved",
1782
if self.server.use_dbus:
1784
client.Rejected("Denied")
1787
#wait until timeout or approved
1788
time = datetime.datetime.now()
1789
client.changedstate.acquire()
1790
client.changedstate.wait(delay.total_seconds())
1791
client.changedstate.release()
1792
time2 = datetime.datetime.now()
1793
if (time2 - time) >= delay:
1794
if not client.approved_by_default:
1795
logger.warning("Client %s timed out while"
1796
" waiting for approval",
1798
if self.server.use_dbus:
1800
client.Rejected("Approval timed out")
1805
delay -= time2 - time
1808
while sent_size < len(client.secret):
1810
sent = session.send(client.secret[sent_size:])
1811
except gnutls.errors.GNUTLSError as error:
1812
logger.warning("gnutls send failed",
1815
logger.debug("Sent: %d, remaining: %d", sent,
1816
len(client.secret) - (sent_size
1820
logger.info("Sending secret to %s", client.name)
1821
# bump the timeout using extended_timeout
1822
client.bump_timeout(client.extended_timeout)
1823
if self.server.use_dbus:
1828
if approval_required:
1829
client.approvals_pending -= 1
1832
except gnutls.errors.GNUTLSError as error:
1833
logger.warning("GnuTLS bye failed",
1837
def peer_certificate(session):
1838
"Return the peer's OpenPGP certificate as a bytestring"
1839
# If not an OpenPGP certificate...
1840
if (gnutls.library.functions.gnutls_certificate_type_get(
1842
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1843
# ...do the normal thing
1844
return session.peer_certificate
1845
list_size = ctypes.c_uint(1)
1846
cert_list = (gnutls.library.functions
1847
.gnutls_certificate_get_peers
1848
(session._c_object, ctypes.byref(list_size)))
1849
if not bool(cert_list) and list_size.value != 0:
1850
raise gnutls.errors.GNUTLSError("error getting peer"
1852
if list_size.value == 0:
1855
return ctypes.string_at(cert.data, cert.size)
1858
def fingerprint(openpgp):
1859
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1860
# New GnuTLS "datum" with the OpenPGP public key
1861
datum = gnutls.library.types.gnutls_datum_t(
1862
ctypes.cast(ctypes.c_char_p(openpgp),
1863
ctypes.POINTER(ctypes.c_ubyte)),
1864
ctypes.c_uint(len(openpgp)))
1865
# New empty GnuTLS certificate
1866
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1867
gnutls.library.functions.gnutls_openpgp_crt_init(
1869
# Import the OpenPGP public key into the certificate
1870
gnutls.library.functions.gnutls_openpgp_crt_import(
1871
crt, ctypes.byref(datum),
1872
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1873
# Verify the self signature in the key
1874
crtverify = ctypes.c_uint()
1875
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1876
crt, 0, ctypes.byref(crtverify))
1877
if crtverify.value != 0:
1878
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1879
raise gnutls.errors.CertificateSecurityError(
1881
# New buffer for the fingerprint
1882
buf = ctypes.create_string_buffer(20)
1883
buf_len = ctypes.c_size_t()
1884
# Get the fingerprint from the certificate into the buffer
1885
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1886
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1887
# Deinit the certificate
1888
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1889
# Convert the buffer to a Python bytestring
1890
fpr = ctypes.string_at(buf, buf_len.value)
1891
# Convert the bytestring to hexadecimal notation
1892
hex_fpr = binascii.hexlify(fpr).upper()
1896
class MultiprocessingMixIn(object):
1897
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1899
def sub_process_main(self, request, address):
1901
self.finish_request(request, address)
1903
self.handle_error(request, address)
1904
self.close_request(request)
1906
def process_request(self, request, address):
1907
"""Start a new process to process the request."""
1908
proc = multiprocessing.Process(target = self.sub_process_main,
1909
args = (request, address))
1914
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1915
""" adds a pipe to the MixIn """
1917
def process_request(self, request, client_address):
1918
"""Overrides and wraps the original process_request().
1920
This function creates a new pipe in self.pipe
1922
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1924
proc = MultiprocessingMixIn.process_request(self, request,
1926
self.child_pipe.close()
1927
self.add_pipe(parent_pipe, proc)
1929
def add_pipe(self, parent_pipe, proc):
1930
"""Dummy function; override as necessary"""
1931
raise NotImplementedError()
1934
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1935
socketserver.TCPServer, object):
756
1936
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
758
settings: Server settings
759
clients: Set() of Client objects
760
1939
enabled: Boolean; whether this server is activated yet
1940
interface: None or a network interface name (string)
1941
use_ipv6: Boolean; to use IPv6 or not
762
address_family = socket.AF_INET6
763
def __init__(self, *args, **kwargs):
764
if "settings" in kwargs:
765
self.settings = kwargs["settings"]
766
del kwargs["settings"]
767
if "clients" in kwargs:
768
self.clients = kwargs["clients"]
769
del kwargs["clients"]
770
if "use_ipv6" in kwargs:
771
if not kwargs["use_ipv6"]:
772
self.address_family = socket.AF_INET
773
del kwargs["use_ipv6"]
775
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
1944
def __init__(self, server_address, RequestHandlerClass,
1948
"""If socketfd is set, use that file descriptor instead of
1949
creating a new one with socket.socket().
1951
self.interface = interface
1953
self.address_family = socket.AF_INET6
1954
if socketfd is not None:
1955
# Save the file descriptor
1956
self.socketfd = socketfd
1957
# Save the original socket.socket() function
1958
self.socket_socket = socket.socket
1959
# To implement --socket, we monkey patch socket.socket.
1961
# (When socketserver.TCPServer is a new-style class, we
1962
# could make self.socket into a property instead of monkey
1963
# patching socket.socket.)
1965
# Create a one-time-only replacement for socket.socket()
1966
@functools.wraps(socket.socket)
1967
def socket_wrapper(*args, **kwargs):
1968
# Restore original function so subsequent calls are
1970
socket.socket = self.socket_socket
1971
del self.socket_socket
1972
# This time only, return a new socket object from the
1973
# saved file descriptor.
1974
return socket.fromfd(self.socketfd, *args, **kwargs)
1975
# Replace socket.socket() function with wrapper
1976
socket.socket = socket_wrapper
1977
# The socketserver.TCPServer.__init__ will call
1978
# socket.socket(), which might be our replacement,
1979
# socket_wrapper(), if socketfd was set.
1980
socketserver.TCPServer.__init__(self, server_address,
1981
RequestHandlerClass)
776
1983
def server_bind(self):
777
1984
"""This overrides the normal server_bind() function
778
1985
to bind to an interface if one was specified, and also NOT to
779
1986
bind to an address or port if they were not specified."""
780
if self.settings["interface"]:
781
# 25 is from /usr/include/asm-i486/socket.h
782
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
784
self.socket.setsockopt(socket.SOL_SOCKET,
786
self.settings["interface"])
787
except socket.error, error:
788
if error[0] == errno.EPERM:
789
logger.error(u"No permission to"
790
u" bind to interface %s",
791
self.settings["interface"])
1987
if self.interface is not None:
1988
if SO_BINDTODEVICE is None:
1989
logger.error("SO_BINDTODEVICE does not exist;"
1990
" cannot bind to interface %s",
1994
self.socket.setsockopt(
1995
socket.SOL_SOCKET, SO_BINDTODEVICE,
1996
(self.interface + "\0").encode("utf-8"))
1997
except socket.error as error:
1998
if error.errno == errno.EPERM:
1999
logger.error("No permission to bind to"
2000
" interface %s", self.interface)
2001
elif error.errno == errno.ENOPROTOOPT:
2002
logger.error("SO_BINDTODEVICE not available;"
2003
" cannot bind to interface %s",
2005
elif error.errno == errno.ENODEV:
2006
logger.error("Interface %s does not exist,"
2007
" cannot bind", self.interface)
794
2010
# Only bind(2) the socket if we really need to.
795
2011
if self.server_address[0] or self.server_address[1]:
796
2012
if not self.server_address[0]:
797
2013
if self.address_family == socket.AF_INET6:
798
2014
any_address = "::" # in6addr_any
800
any_address = socket.INADDR_ANY
2016
any_address = "0.0.0.0" # INADDR_ANY
801
2017
self.server_address = (any_address,
802
2018
self.server_address[1])
803
2019
elif not self.server_address[1]:
804
self.server_address = (self.server_address[0],
806
# if self.settings["interface"]:
2020
self.server_address = (self.server_address[0], 0)
2021
# if self.interface:
807
2022
# self.server_address = (self.server_address[0],
810
2025
# if_nametoindex
813
return super(IPv6_TCPServer, self).server_bind()
2027
return socketserver.TCPServer.server_bind(self)
2030
class MandosServer(IPv6_TCPServer):
2034
clients: set of Client objects
2035
gnutls_priority GnuTLS priority string
2036
use_dbus: Boolean; to emit D-Bus signals or not
2038
Assumes a gobject.MainLoop event loop.
2041
def __init__(self, server_address, RequestHandlerClass,
2045
gnutls_priority=None,
2048
self.enabled = False
2049
self.clients = clients
2050
if self.clients is None:
2052
self.use_dbus = use_dbus
2053
self.gnutls_priority = gnutls_priority
2054
IPv6_TCPServer.__init__(self, server_address,
2055
RequestHandlerClass,
2056
interface = interface,
2057
use_ipv6 = use_ipv6,
2058
socketfd = socketfd)
814
2060
def server_activate(self):
815
2061
if self.enabled:
816
return super(IPv6_TCPServer, self).server_activate()
2062
return socketserver.TCPServer.server_activate(self)
817
2064
def enable(self):
818
2065
self.enabled = True
2067
def add_pipe(self, parent_pipe, proc):
2068
# Call "handle_ipc" for both data and EOF events
2069
gobject.io_add_watch(
2070
parent_pipe.fileno(),
2071
gobject.IO_IN | gobject.IO_HUP,
2072
functools.partial(self.handle_ipc,
2073
parent_pipe = parent_pipe,
2076
def handle_ipc(self, source, condition,
2079
client_object=None):
2080
# error, or the other end of multiprocessing.Pipe has closed
2081
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2082
# Wait for other process to exit
2086
# Read a request from the child
2087
request = parent_pipe.recv()
2088
command = request[0]
2090
if command == 'init':
2092
address = request[2]
2094
for c in self.clients.itervalues():
2095
if c.fingerprint == fpr:
2099
logger.info("Client not found for fingerprint: %s, ad"
2100
"dress: %s", fpr, address)
2103
mandos_dbus_service.ClientNotFound(fpr,
2105
parent_pipe.send(False)
2108
gobject.io_add_watch(
2109
parent_pipe.fileno(),
2110
gobject.IO_IN | gobject.IO_HUP,
2111
functools.partial(self.handle_ipc,
2112
parent_pipe = parent_pipe,
2114
client_object = client))
2115
parent_pipe.send(True)
2116
# remove the old hook in favor of the new above hook on
2119
if command == 'funcall':
2120
funcname = request[1]
2124
parent_pipe.send(('data', getattr(client_object,
2128
if command == 'getattr':
2129
attrname = request[1]
2130
if callable(client_object.__getattribute__(attrname)):
2131
parent_pipe.send(('function', ))
2134
'data', client_object.__getattribute__(attrname)))
2136
if command == 'setattr':
2137
attrname = request[1]
2139
setattr(client_object, attrname, value)
2144
def rfc3339_duration_to_delta(duration):
2145
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2147
>>> rfc3339_duration_to_delta("P7D")
2148
datetime.timedelta(7)
2149
>>> rfc3339_duration_to_delta("PT60S")
2150
datetime.timedelta(0, 60)
2151
>>> rfc3339_duration_to_delta("PT60M")
2152
datetime.timedelta(0, 3600)
2153
>>> rfc3339_duration_to_delta("PT24H")
2154
datetime.timedelta(1)
2155
>>> rfc3339_duration_to_delta("P1W")
2156
datetime.timedelta(7)
2157
>>> rfc3339_duration_to_delta("PT5M30S")
2158
datetime.timedelta(0, 330)
2159
>>> rfc3339_duration_to_delta("P1DT3M20S")
2160
datetime.timedelta(1, 200)
2163
# Parsing an RFC 3339 duration with regular expressions is not
2164
# possible - there would have to be multiple places for the same
2165
# values, like seconds. The current code, while more esoteric, is
2166
# cleaner without depending on a parsing library. If Python had a
2167
# built-in library for parsing we would use it, but we'd like to
2168
# avoid excessive use of external libraries.
2170
# New type for defining tokens, syntax, and semantics all-in-one
2171
Token = collections.namedtuple("Token",
2172
("regexp", # To match token; if
2173
# "value" is not None,
2174
# must have a "group"
2176
"value", # datetime.timedelta or
2178
"followers")) # Tokens valid after
2180
Token = collections.namedtuple("Token", (
2181
"regexp", # To match token; if "value" is not None, must have
2182
# a "group" containing digits
2183
"value", # datetime.timedelta or None
2184
"followers")) # Tokens valid after this token
2185
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2186
# the "duration" ABNF definition in RFC 3339, Appendix A.
2187
token_end = Token(re.compile(r"$"), None, frozenset())
2188
token_second = Token(re.compile(r"(\d+)S"),
2189
datetime.timedelta(seconds=1),
2190
frozenset((token_end, )))
2191
token_minute = Token(re.compile(r"(\d+)M"),
2192
datetime.timedelta(minutes=1),
2193
frozenset((token_second, token_end)))
2194
token_hour = Token(re.compile(r"(\d+)H"),
2195
datetime.timedelta(hours=1),
2196
frozenset((token_minute, token_end)))
2197
token_time = Token(re.compile(r"T"),
2199
frozenset((token_hour, token_minute,
2201
token_day = Token(re.compile(r"(\d+)D"),
2202
datetime.timedelta(days=1),
2203
frozenset((token_time, token_end)))
2204
token_month = Token(re.compile(r"(\d+)M"),
2205
datetime.timedelta(weeks=4),
2206
frozenset((token_day, token_end)))
2207
token_year = Token(re.compile(r"(\d+)Y"),
2208
datetime.timedelta(weeks=52),
2209
frozenset((token_month, token_end)))
2210
token_week = Token(re.compile(r"(\d+)W"),
2211
datetime.timedelta(weeks=1),
2212
frozenset((token_end, )))
2213
token_duration = Token(re.compile(r"P"), None,
2214
frozenset((token_year, token_month,
2215
token_day, token_time,
2217
# Define starting values
2218
value = datetime.timedelta() # Value so far
2220
followers = frozenset((token_duration,)) # Following valid tokens
2221
s = duration # String left to parse
2222
# Loop until end token is found
2223
while found_token is not token_end:
2224
# Search for any currently valid tokens
2225
for token in followers:
2226
match = token.regexp.match(s)
2227
if match is not None:
2229
if token.value is not None:
2230
# Value found, parse digits
2231
factor = int(match.group(1), 10)
2232
# Add to value so far
2233
value += factor * token.value
2234
# Strip token from string
2235
s = token.regexp.sub("", s, 1)
2238
# Set valid next tokens
2239
followers = found_token.followers
2242
# No currently valid tokens were found
2243
raise ValueError("Invalid RFC 3339 duration")
821
2248
def string_to_delta(interval):
966
2379
"debug": "False",
968
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2381
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2382
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
969
2383
"servicename": "Mandos",
970
2384
"use_dbus": "True",
971
2385
"use_ipv6": "True",
2389
"statedir": "/var/lib/mandos",
2390
"foreground": "False",
974
2394
# Parse config file for server-global settings
975
server_config = ConfigParser.SafeConfigParser(server_defaults)
2395
server_config = configparser.SafeConfigParser(server_defaults)
976
2396
del server_defaults
977
2397
server_config.read(os.path.join(options.configdir, "mandos.conf"))
978
2398
# Convert the SafeConfigParser object to a dict
979
2399
server_settings = server_config.defaults()
980
2400
# Use the appropriate methods on the non-string config options
981
server_settings["debug"] = server_config.getboolean("DEFAULT",
983
server_settings["use_dbus"] = server_config.getboolean("DEFAULT",
985
server_settings["use_ipv6"] = server_config.getboolean("DEFAULT",
2401
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2402
server_settings[option] = server_config.getboolean("DEFAULT",
987
2404
if server_settings["port"]:
988
2405
server_settings["port"] = server_config.getint("DEFAULT",
2407
if server_settings["socket"]:
2408
server_settings["socket"] = server_config.getint("DEFAULT",
2410
# Later, stdin will, and stdout and stderr might, be dup'ed
2411
# over with an opened os.devnull. But we don't want this to
2412
# happen with a supplied network socket.
2413
if 0 <= server_settings["socket"] <= 2:
2414
server_settings["socket"] = os.dup(server_settings
990
2416
del server_config
992
2418
# Override the settings from the config file with command line
993
2419
# options, if set.
994
2420
for option in ("interface", "address", "port", "debug",
995
"priority", "servicename", "configdir",
996
"use_dbus", "use_ipv6"):
2421
"priority", "servicename", "configdir", "use_dbus",
2422
"use_ipv6", "debuglevel", "restore", "statedir",
2423
"socket", "foreground", "zeroconf"):
997
2424
value = getattr(options, option)
998
2425
if value is not None:
999
2426
server_settings[option] = value
2428
# Force all strings to be unicode
2429
for option in server_settings.keys():
2430
if isinstance(server_settings[option], bytes):
2431
server_settings[option] = (server_settings[option]
2433
# Force all boolean options to be boolean
2434
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2435
"foreground", "zeroconf"):
2436
server_settings[option] = bool(server_settings[option])
2437
# Debug implies foreground
2438
if server_settings["debug"]:
2439
server_settings["foreground"] = True
1001
2440
# Now we have our good server settings in "server_settings"
2442
##################################################################
2444
if (not server_settings["zeroconf"]
2445
and not (server_settings["port"]
2446
or server_settings["socket"] != "")):
2447
parser.error("Needs port or socket to work without Zeroconf")
1003
2449
# For convenience
1004
2450
debug = server_settings["debug"]
2451
debuglevel = server_settings["debuglevel"]
1005
2452
use_dbus = server_settings["use_dbus"]
1006
use_dbus = False # XXX: Not done yet
1007
2453
use_ipv6 = server_settings["use_ipv6"]
2454
stored_state_path = os.path.join(server_settings["statedir"],
2456
foreground = server_settings["foreground"]
2457
zeroconf = server_settings["zeroconf"]
1010
syslogger.setLevel(logging.WARNING)
1011
console.setLevel(logging.WARNING)
2460
initlogger(debug, logging.DEBUG)
2465
level = getattr(logging, debuglevel.upper())
2466
initlogger(debug, level)
1013
2468
if server_settings["servicename"] != "Mandos":
1014
syslogger.setFormatter(logging.Formatter
1015
('Mandos (%s): %%(levelname)s:'
1017
% server_settings["servicename"]))
2469
syslogger.setFormatter(
2470
logging.Formatter('Mandos ({}) [%(process)d]:'
2471
' %(levelname)s: %(message)s'.format(
2472
server_settings["servicename"])))
1019
2474
# Parse config file with clients
1020
client_defaults = { "timeout": "1h",
1022
"checker": "fping -q -- %%(host)s",
1025
client_config = ConfigParser.SafeConfigParser(client_defaults)
2475
client_config = configparser.SafeConfigParser(Client
1026
2477
client_config.read(os.path.join(server_settings["configdir"],
1027
2478
"clients.conf"))
1030
tcp_server = IPv6_TCPServer((server_settings["address"],
1031
server_settings["port"]),
1033
settings=server_settings,
1034
clients=clients, use_ipv6=use_ipv6)
1035
pidfilename = "/var/run/mandos.pid"
1037
pidfile = open(pidfilename, "w")
1039
logger.error("Could not open file %r", pidfilename)
1042
uid = pwd.getpwnam("_mandos").pw_uid
1043
gid = pwd.getpwnam("_mandos").pw_gid
1046
uid = pwd.getpwnam("mandos").pw_uid
1047
gid = pwd.getpwnam("mandos").pw_gid
2480
global mandos_dbus_service
2481
mandos_dbus_service = None
2484
if server_settings["socket"] != "":
2485
socketfd = server_settings["socket"]
2486
tcp_server = MandosServer(
2487
(server_settings["address"], server_settings["port"]),
2489
interface=(server_settings["interface"] or None),
2491
gnutls_priority=server_settings["priority"],
2495
pidfilename = "/run/mandos.pid"
2496
if not os.path.isdir("/run/."):
2497
pidfilename = "/var/run/mandos.pid"
2500
pidfile = open(pidfilename, "w")
2501
except IOError as e:
2502
logger.error("Could not open file %r", pidfilename,
2505
for name in ("_mandos", "mandos", "nobody"):
2507
uid = pwd.getpwnam(name).pw_uid
2508
gid = pwd.getpwnam(name).pw_gid
1048
2510
except KeyError:
1050
uid = pwd.getpwnam("nobody").pw_uid
1051
gid = pwd.getpwnam("nogroup").pw_gid
1058
except OSError, error:
1059
if error[0] != errno.EPERM:
2518
except OSError as error:
2519
if error.errno != errno.EPERM:
1062
# Enable all possible GnuTLS debugging
2523
# Enable all possible GnuTLS debugging
1064
2525
# "Use a log level over 10 to enable all debugging options."
1065
2526
# - GnuTLS manual
1066
2527
gnutls.library.functions.gnutls_global_set_log_level(11)
1069
2530
def debug_gnutls(level, string):
1070
2531
logger.debug("GnuTLS: %s", string[:-1])
1072
(gnutls.library.functions
1073
.gnutls_global_set_log_function(debug_gnutls))
1076
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1077
service = AvahiService(name = server_settings["servicename"],
1078
servicetype = "_mandos._tcp",
1079
protocol = protocol)
1080
if server_settings["interface"]:
1081
service.interface = (if_nametoindex
1082
(server_settings["interface"]))
2533
gnutls.library.functions.gnutls_global_set_log_function(
2536
# Redirect stdin so all checkers get /dev/null
2537
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2538
os.dup2(null, sys.stdin.fileno())
2542
# Need to fork before connecting to D-Bus
2544
# Close all input and output, do double fork, etc.
2547
# multiprocessing will use threads, so before we use gobject we
2548
# need to inform gobject that threads will be used.
2549
gobject.threads_init()
1084
2551
global main_loop
1087
2552
# From the Avahi example code
1088
DBusGMainLoop(set_as_default=True )
2553
DBusGMainLoop(set_as_default=True)
1089
2554
main_loop = gobject.MainLoop()
1090
2555
bus = dbus.SystemBus()
1091
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1092
avahi.DBUS_PATH_SERVER),
1093
avahi.DBUS_INTERFACE_SERVER)
1094
2556
# End of Avahi example code
1096
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1098
clients.update(Set(Client(name = section,
1100
= dict(client_config.items(section)),
1101
use_dbus = use_dbus)
1102
for section in client_config.sections()))
1104
logger.warning(u"No clients defined")
1107
# Redirect stdin so all checkers get /dev/null
1108
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1109
os.dup2(null, sys.stdin.fileno())
1113
# No console logging
1114
logger.removeHandler(console)
1115
# Close all input and output, do double fork, etc.
1120
pidfile.write(str(pid) + "\n")
2559
bus_name = dbus.service.BusName("se.recompile.Mandos",
2562
old_bus_name = dbus.service.BusName(
2563
"se.bsnet.fukt.Mandos", bus,
2565
except dbus.exceptions.NameExistsException as e:
2566
logger.error("Disabling D-Bus:", exc_info=e)
2568
server_settings["use_dbus"] = False
2569
tcp_server.use_dbus = False
2571
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2572
service = AvahiServiceToSyslog(
2573
name = server_settings["servicename"],
2574
servicetype = "_mandos._tcp",
2575
protocol = protocol,
2577
if server_settings["interface"]:
2578
service.interface = if_nametoindex(
2579
server_settings["interface"].encode("utf-8"))
2581
global multiprocessing_manager
2582
multiprocessing_manager = multiprocessing.Manager()
2584
client_class = Client
2586
client_class = functools.partial(ClientDBus, bus = bus)
2588
client_settings = Client.config_parser(client_config)
2589
old_client_settings = {}
2592
# This is used to redirect stdout and stderr for checker processes
2594
wnull = open(os.devnull, "w") # A writable /dev/null
2595
# Only used if server is running in foreground but not in debug
2597
if debug or not foreground:
2600
# Get client data and settings from last running state.
2601
if server_settings["restore"]:
2603
with open(stored_state_path, "rb") as stored_state:
2604
clients_data, old_client_settings = pickle.load(
2606
os.remove(stored_state_path)
2607
except IOError as e:
2608
if e.errno == errno.ENOENT:
2609
logger.warning("Could not load persistent state:"
2610
" {}".format(os.strerror(e.errno)))
2612
logger.critical("Could not load persistent state:",
2615
except EOFError as e:
2616
logger.warning("Could not load persistent state: "
2620
with PGPEngine() as pgp:
2621
for client_name, client in clients_data.items():
2622
# Skip removed clients
2623
if client_name not in client_settings:
2626
# Decide which value to use after restoring saved state.
2627
# We have three different values: Old config file,
2628
# new config file, and saved state.
2629
# New config value takes precedence if it differs from old
2630
# config value, otherwise use saved state.
2631
for name, value in client_settings[client_name].items():
2633
# For each value in new config, check if it
2634
# differs from the old config value (Except for
2635
# the "secret" attribute)
2636
if (name != "secret"
2638
old_client_settings[client_name][name])):
2639
client[name] = value
2643
# Clients who has passed its expire date can still be
2644
# enabled if its last checker was successful. A Client
2645
# whose checker succeeded before we stored its state is
2646
# assumed to have successfully run all checkers during
2648
if client["enabled"]:
2649
if datetime.datetime.utcnow() >= client["expires"]:
2650
if not client["last_checked_ok"]:
2652
"disabling client {} - Client never "
2653
"performed a successful checker".format(
2655
client["enabled"] = False
2656
elif client["last_checker_status"] != 0:
2658
"disabling client {} - Client last"
2659
" checker failed with error code"
2662
client["last_checker_status"]))
2663
client["enabled"] = False
2665
client["expires"] = (
2666
datetime.datetime.utcnow()
2667
+ client["timeout"])
2668
logger.debug("Last checker succeeded,"
2669
" keeping {} enabled".format(
2672
client["secret"] = pgp.decrypt(
2673
client["encrypted_secret"],
2674
client_settings[client_name]["secret"])
2676
# If decryption fails, we use secret from new settings
2677
logger.debug("Failed to decrypt {} old secret".format(
2679
client["secret"] = (client_settings[client_name]
2682
# Add/remove clients based on new changes made to config
2683
for client_name in (set(old_client_settings)
2684
- set(client_settings)):
2685
del clients_data[client_name]
2686
for client_name in (set(client_settings)
2687
- set(old_client_settings)):
2688
clients_data[client_name] = client_settings[client_name]
2690
# Create all client objects
2691
for client_name, client in clients_data.items():
2692
tcp_server.clients[client_name] = client_class(
2695
server_settings = server_settings)
2697
if not tcp_server.clients:
2698
logger.warning("No clients defined")
2701
if pidfile is not None:
2705
pidfile.write("{}\n".format(pid).encode("utf-8"))
2707
logger.error("Could not write to file %r with PID %d",
1124
logger.error(u"Could not write to file %r with PID %d",
1127
# "pidfile" was never created
1132
"Cleanup function; run on exit"
1134
# From the Avahi example code
1135
if not group is None:
1138
# End of Avahi example code
1141
client = clients.pop()
1142
client.disable_hook = None
1145
atexit.register(cleanup)
1148
signal.signal(signal.SIGINT, signal.SIG_IGN)
1149
2712
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1150
2713
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1153
class MandosServer(dbus.service.Object):
2717
@alternate_dbus_interfaces(
2718
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2719
class MandosDBusService(DBusObjectWithProperties):
1154
2720
"""A D-Bus proxy object"""
1155
2722
def __init__(self):
1156
2723
dbus.service.Object.__init__(self, bus, "/")
1157
_interface = u"se.bsnet.fukt.Mandos"
1159
@dbus.service.signal(_interface, signature="oa{sv}")
1160
def ClientAdded(self, objpath, properties):
2725
_interface = "se.recompile.Mandos"
2727
@dbus_interface_annotations(_interface)
2730
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2733
@dbus.service.signal(_interface, signature="o")
2734
def ClientAdded(self, objpath):
2738
@dbus.service.signal(_interface, signature="ss")
2739
def ClientNotFound(self, fingerprint, address):