267
124
self.rename_count = 0
268
125
self.max_renames = max_renames
269
self.protocol = protocol
270
self.group = None # our entry group
273
self.entry_group_state_changed_match = None
275
126
def rename(self):
276
127
"""Derived from the Avahi example code"""
277
128
if self.rename_count >= self.max_renames:
278
logger.critical("No suitable Zeroconf service name found"
279
" after %i retries, exiting.",
129
logger.critical(u"No suitable Zeroconf service name found"
130
u" after %i retries, exiting.",
280
131
self.rename_count)
281
132
raise AvahiServiceError("Too many renames")
282
self.name = unicode(self.server
283
.GetAlternativeServiceName(self.name))
284
logger.info("Changing Zeroconf service name to %r ...",
133
self.name = server.GetAlternativeServiceName(self.name)
134
logger.info(u"Changing Zeroconf service name to %r ...",
136
syslogger.setFormatter(logging.Formatter
137
('Mandos (%s): %%(levelname)s:'
138
' %%(message)s' % self.name))
289
except dbus.exceptions.DBusException as error:
290
logger.critical("D-Bus Exception", exc_info=error)
293
141
self.rename_count += 1
295
142
def remove(self):
296
143
"""Derived from the Avahi example code"""
297
if self.entry_group_state_changed_match is not None:
298
self.entry_group_state_changed_match.remove()
299
self.entry_group_state_changed_match = None
300
if self.group is not None:
144
if group is not None:
304
147
"""Derived from the Avahi example code"""
306
if self.group is None:
307
self.group = dbus.Interface(
308
self.bus.get_object(avahi.DBUS_NAME,
309
self.server.EntryGroupNew()),
310
avahi.DBUS_INTERFACE_ENTRY_GROUP)
311
self.entry_group_state_changed_match = (
312
self.group.connect_to_signal(
313
'StateChanged', self.entry_group_state_changed))
314
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
315
self.name, self.type)
316
self.group.AddService(
319
dbus.UInt32(0), # flags
320
self.name, self.type,
321
self.domain, self.host,
322
dbus.UInt16(self.port),
323
avahi.string_array_to_txt_array(self.TXT))
326
def entry_group_state_changed(self, state, error):
327
"""Derived from the Avahi example code"""
328
logger.debug("Avahi entry group state change: %i", state)
330
if state == avahi.ENTRY_GROUP_ESTABLISHED:
331
logger.debug("Zeroconf service established.")
332
elif state == avahi.ENTRY_GROUP_COLLISION:
333
logger.info("Zeroconf service name collision.")
335
elif state == avahi.ENTRY_GROUP_FAILURE:
336
logger.critical("Avahi: Error in group state changed %s",
338
raise AvahiGroupError("State changed: {0!s}"
342
"""Derived from the Avahi example code"""
343
if self.group is not None:
346
except (dbus.exceptions.UnknownMethodException,
347
dbus.exceptions.DBusException):
352
def server_state_changed(self, state, error=None):
353
"""Derived from the Avahi example code"""
354
logger.debug("Avahi server state change: %i", state)
355
bad_states = { avahi.SERVER_INVALID:
356
"Zeroconf server invalid",
357
avahi.SERVER_REGISTERING: None,
358
avahi.SERVER_COLLISION:
359
"Zeroconf server name collision",
360
avahi.SERVER_FAILURE:
361
"Zeroconf server failure" }
362
if state in bad_states:
363
if bad_states[state] is not None:
365
logger.error(bad_states[state])
367
logger.error(bad_states[state] + ": %r", error)
369
elif state == avahi.SERVER_RUNNING:
373
logger.debug("Unknown state: %r", state)
375
logger.debug("Unknown state: %r: %r", state, error)
378
"""Derived from the Avahi example code"""
379
if self.server is None:
380
self.server = dbus.Interface(
381
self.bus.get_object(avahi.DBUS_NAME,
382
avahi.DBUS_PATH_SERVER,
383
follow_name_owner_changes=True),
384
avahi.DBUS_INTERFACE_SERVER)
385
self.server.connect_to_signal("StateChanged",
386
self.server_state_changed)
387
self.server_state_changed(self.server.GetState())
390
class AvahiServiceToSyslog(AvahiService):
392
"""Add the new name to the syslog messages"""
393
ret = AvahiService.rename(self)
394
syslogger.setFormatter(logging.Formatter
395
('Mandos ({0}) [%(process)d]:'
396
' %(levelname)s: %(message)s'
401
def timedelta_to_milliseconds(td):
402
"Convert a datetime.timedelta() to milliseconds"
403
return ((td.days * 24 * 60 * 60 * 1000)
404
+ (td.seconds * 1000)
405
+ (td.microseconds // 1000))
408
class Client(object):
150
group = dbus.Interface(bus.get_object
152
server.EntryGroupNew()),
153
avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
group.connect_to_signal('StateChanged',
155
entry_group_state_changed)
156
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
157
service.name, service.type)
159
self.interface, # interface
160
avahi.PROTO_INET6, # protocol
161
dbus.UInt32(0), # flags
162
self.name, self.type,
163
self.domain, self.host,
164
dbus.UInt16(self.port),
165
avahi.string_array_to_txt_array(self.TXT))
168
# From the Avahi example code:
169
group = None # our entry group
170
# End of Avahi example code
173
def _datetime_to_dbus(dt, variant_level=0):
174
"""Convert a UTC datetime.datetime() to a D-Bus type."""
175
return dbus.String(dt.isoformat(), variant_level=variant_level)
178
class Client(dbus.service.Object):
409
179
"""A representation of a client host served by this server.
412
approved: bool(); 'None' if not yet approved/disapproved
413
approval_delay: datetime.timedelta(); Time to wait for approval
414
approval_duration: datetime.timedelta(); Duration of one approval
181
name: string; from the config file, used in log messages
182
fingerprint: string (40 or 32 hexadecimal digits); used to
183
uniquely identify the client
184
secret: bytestring; sent verbatim (over TLS) to client
185
host: string; available for use by the checker command
186
created: datetime.datetime(); (UTC) object creation
187
last_enabled: datetime.datetime(); (UTC)
189
last_checked_ok: datetime.datetime(); (UTC) or None
190
timeout: datetime.timedelta(); How long from last_checked_ok
191
until this client is invalid
192
interval: datetime.timedelta(); How often to start a new checker
193
disable_hook: If set, called by disable() as disable_hook(self)
415
194
checker: subprocess.Popen(); a running checker process used
416
195
to see if the client lives.
417
196
'None' if no process is running.
418
checker_callback_tag: a gobject event source tag, or None
419
checker_command: string; External command which is run to check
420
if client lives. %() expansions are done at
197
checker_initiator_tag: a gobject event source tag, or None
198
disable_initiator_tag: - '' -
199
checker_callback_tag: - '' -
200
checker_command: string; External command which is run to check if
201
client lives. %() expansions are done at
421
202
runtime with vars(self) as dict, so that for
422
203
instance %(name)s can be used in the command.
423
checker_initiator_tag: a gobject event source tag, or None
424
created: datetime.datetime(); (UTC) object creation
425
client_structure: Object describing what attributes a client has
426
and is used for storing the client at exit
427
current_checker_command: string; current running checker_command
428
disable_initiator_tag: a gobject event source tag, or None
430
fingerprint: string (40 or 32 hexadecimal digits); used to
431
uniquely identify the client
432
host: string; available for use by the checker command
433
interval: datetime.timedelta(); How often to start a new checker
434
last_approval_request: datetime.datetime(); (UTC) or None
435
last_checked_ok: datetime.datetime(); (UTC) or None
436
last_checker_status: integer between 0 and 255 reflecting exit
437
status of last checker. -1 reflects crashed
438
checker, -2 means no checker completed yet.
439
last_enabled: datetime.datetime(); (UTC) or None
440
name: string; from the config file, used in log messages and
442
secret: bytestring; sent verbatim (over TLS) to client
443
timeout: datetime.timedelta(); How long from last_checked_ok
444
until this client is disabled
445
extended_timeout: extra long timeout when secret has been sent
446
runtime_expansions: Allowed attributes for runtime expansion.
447
expires: datetime.datetime(); time (UTC) when a client will be
449
server_settings: The server_settings dict from main()
204
dbus_object_path: dbus.ObjectPath
206
_timeout: Real variable for 'timeout'
207
_interval: Real variable for 'interval'
208
_timeout_milliseconds: Used when calling gobject.timeout_add()
209
_interval_milliseconds: - '' -
452
runtime_expansions = ("approval_delay", "approval_duration",
453
"created", "enabled", "expires",
454
"fingerprint", "host", "interval",
455
"last_approval_request", "last_checked_ok",
456
"last_enabled", "name", "timeout")
457
client_defaults = { "timeout": "PT5M",
458
"extended_timeout": "PT15M",
460
"checker": "fping -q -- %%(host)s",
462
"approval_delay": "PT0S",
463
"approval_duration": "PT1S",
464
"approved_by_default": "True",
468
def timeout_milliseconds(self):
469
"Return the 'timeout' attribute in milliseconds"
470
return timedelta_to_milliseconds(self.timeout)
472
def extended_timeout_milliseconds(self):
473
"Return the 'extended_timeout' attribute in milliseconds"
474
return timedelta_to_milliseconds(self.extended_timeout)
476
def interval_milliseconds(self):
477
"Return the 'interval' attribute in milliseconds"
478
return timedelta_to_milliseconds(self.interval)
480
def approval_delay_milliseconds(self):
481
return timedelta_to_milliseconds(self.approval_delay)
484
def config_parser(config):
485
"""Construct a new dict of client settings of this form:
486
{ client_name: {setting_name: value, ...}, ...}
487
with exceptions for any special settings as defined above.
488
NOTE: Must be a pure function. Must return the same result
489
value given the same arguments.
492
for client_name in config.sections():
493
section = dict(config.items(client_name))
494
client = settings[client_name] = {}
496
client["host"] = section["host"]
497
# Reformat values from string types to Python types
498
client["approved_by_default"] = config.getboolean(
499
client_name, "approved_by_default")
500
client["enabled"] = config.getboolean(client_name,
503
client["fingerprint"] = (section["fingerprint"].upper()
505
if "secret" in section:
506
client["secret"] = section["secret"].decode("base64")
507
elif "secfile" in section:
508
with open(os.path.expanduser(os.path.expandvars
509
(section["secfile"])),
511
client["secret"] = secfile.read()
513
raise TypeError("No secret or secfile for section {0}"
515
client["timeout"] = string_to_delta(section["timeout"])
516
client["extended_timeout"] = string_to_delta(
517
section["extended_timeout"])
518
client["interval"] = string_to_delta(section["interval"])
519
client["approval_delay"] = string_to_delta(
520
section["approval_delay"])
521
client["approval_duration"] = string_to_delta(
522
section["approval_duration"])
523
client["checker_command"] = section["checker"]
524
client["last_approval_request"] = None
525
client["last_checked_ok"] = None
526
client["last_checker_status"] = -2
530
def __init__(self, settings, name = None, server_settings=None):
211
def _set_timeout(self, timeout):
212
"Setter function for the 'timeout' attribute"
213
self._timeout = timeout
214
self._timeout_milliseconds = ((self.timeout.days
215
* 24 * 60 * 60 * 1000)
216
+ (self.timeout.seconds * 1000)
217
+ (self.timeout.microseconds
220
self.PropertyChanged(dbus.String(u"timeout"),
221
(dbus.UInt64(self._timeout_milliseconds,
223
timeout = property(lambda self: self._timeout, _set_timeout)
226
def _set_interval(self, interval):
227
"Setter function for the 'interval' attribute"
228
self._interval = interval
229
self._interval_milliseconds = ((self.interval.days
230
* 24 * 60 * 60 * 1000)
231
+ (self.interval.seconds
233
+ (self.interval.microseconds
236
self.PropertyChanged(dbus.String(u"interval"),
237
(dbus.UInt64(self._interval_milliseconds,
239
interval = property(lambda self: self._interval, _set_interval)
242
def __init__(self, name = None, disable_hook=None, config=None):
243
"""Note: the 'checker' key in 'config' sets the
244
'checker_command' attribute and *not* the 'checker'
246
self.dbus_object_path = (dbus.ObjectPath
248
+ name.replace(".", "_")))
249
dbus.service.Object.__init__(self, bus,
250
self.dbus_object_path)
532
if server_settings is None:
534
self.server_settings = server_settings
535
# adding all client settings
536
for setting, value in settings.iteritems():
537
setattr(self, setting, value)
540
if not hasattr(self, "last_enabled"):
541
self.last_enabled = datetime.datetime.utcnow()
542
if not hasattr(self, "expires"):
543
self.expires = (datetime.datetime.utcnow()
546
self.last_enabled = None
549
logger.debug("Creating client %r", self.name)
254
logger.debug(u"Creating client %r", self.name)
550
255
# Uppercase and remove spaces from fingerprint for later
551
256
# comparison purposes with return value from the fingerprint()
553
logger.debug(" Fingerprint: %s", self.fingerprint)
554
self.created = settings.get("created",
555
datetime.datetime.utcnow())
557
# attributes specific for this server instance
258
self.fingerprint = (config["fingerprint"].upper()
260
logger.debug(u" Fingerprint: %s", self.fingerprint)
261
if "secret" in config:
262
self.secret = config["secret"].decode(u"base64")
263
elif "secfile" in config:
264
with closing(open(os.path.expanduser
266
(config["secfile"])))) as secfile:
267
self.secret = secfile.read()
269
raise TypeError(u"No secret or secfile for client %s"
271
self.host = config.get("host", "")
272
self.created = datetime.datetime.utcnow()
274
self.last_enabled = None
275
self.last_checked_ok = None
276
self.timeout = string_to_delta(config["timeout"])
277
self.interval = string_to_delta(config["interval"])
278
self.disable_hook = disable_hook
558
279
self.checker = None
559
280
self.checker_initiator_tag = None
560
281
self.disable_initiator_tag = None
561
282
self.checker_callback_tag = None
562
self.current_checker_command = None
564
self.approvals_pending = 0
565
self.changedstate = (multiprocessing_manager
566
.Condition(multiprocessing_manager
568
self.client_structure = [attr for attr in
569
self.__dict__.iterkeys()
570
if not attr.startswith("_")]
571
self.client_structure.append("client_structure")
573
for name, t in inspect.getmembers(type(self),
577
if not name.startswith("_"):
578
self.client_structure.append(name)
580
# Send notice to process children that client state has changed
581
def send_changedstate(self):
582
with self.changedstate:
583
self.changedstate.notify_all()
283
self.checker_command = config["checker"]
585
285
def enable(self):
586
286
"""Start this client's checker and timeout hooks"""
587
if getattr(self, "enabled", False):
590
self.expires = datetime.datetime.utcnow() + self.timeout
592
287
self.last_enabled = datetime.datetime.utcnow()
594
self.send_changedstate()
596
def disable(self, quiet=True):
597
"""Disable this client."""
598
if not getattr(self, "enabled", False):
601
logger.info("Disabling client %s", self.name)
602
if getattr(self, "disable_initiator_tag", None) is not None:
603
gobject.source_remove(self.disable_initiator_tag)
604
self.disable_initiator_tag = None
606
if getattr(self, "checker_initiator_tag", None) is not None:
607
gobject.source_remove(self.checker_initiator_tag)
608
self.checker_initiator_tag = None
612
self.send_changedstate()
613
# Do not run this again if called by a gobject.timeout_add
619
def init_checker(self):
620
288
# Schedule a new checker to be started an 'interval' from now,
621
289
# and every interval from then on.
622
if self.checker_initiator_tag is not None:
623
gobject.source_remove(self.checker_initiator_tag)
624
290
self.checker_initiator_tag = (gobject.timeout_add
625
(self.interval_milliseconds(),
291
(self._interval_milliseconds,
626
292
self.start_checker))
293
# Also start a new checker *right now*.
627
295
# Schedule a disable() when 'timeout' has passed
628
if self.disable_initiator_tag is not None:
629
gobject.source_remove(self.disable_initiator_tag)
630
296
self.disable_initiator_tag = (gobject.timeout_add
631
(self.timeout_milliseconds(),
297
(self._timeout_milliseconds,
633
# Also start a new checker *right now*.
301
self.PropertyChanged(dbus.String(u"enabled"),
302
dbus.Boolean(True, variant_level=1))
303
self.PropertyChanged(dbus.String(u"last_enabled"),
304
(_datetime_to_dbus(self.last_enabled,
308
"""Disable this client."""
309
if not getattr(self, "enabled", False):
311
logger.info(u"Disabling client %s", self.name)
312
if getattr(self, "disable_initiator_tag", False):
313
gobject.source_remove(self.disable_initiator_tag)
314
self.disable_initiator_tag = None
315
if getattr(self, "checker_initiator_tag", False):
316
gobject.source_remove(self.checker_initiator_tag)
317
self.checker_initiator_tag = None
319
if self.disable_hook:
320
self.disable_hook(self)
323
self.PropertyChanged(dbus.String(u"enabled"),
324
dbus.Boolean(False, variant_level=1))
325
# Do not run this again if called by a gobject.timeout_add
329
self.disable_hook = None
636
332
def checker_callback(self, pid, condition, command):
637
333
"""The checker has completed, so take appropriate actions."""
638
334
self.checker_callback_tag = None
639
335
self.checker = None
640
if os.WIFEXITED(condition):
641
self.last_checker_status = os.WEXITSTATUS(condition)
642
if self.last_checker_status == 0:
643
logger.info("Checker for %(name)s succeeded",
647
logger.info("Checker for %(name)s failed",
650
self.last_checker_status = -1
651
logger.warning("Checker for %(name)s crashed?",
337
self.PropertyChanged(dbus.String(u"checker_running"),
338
dbus.Boolean(False, variant_level=1))
339
if (os.WIFEXITED(condition)
340
and (os.WEXITSTATUS(condition) == 0)):
341
logger.info(u"Checker for %(name)s succeeded",
344
self.CheckerCompleted(dbus.Boolean(True),
345
dbus.UInt16(condition),
346
dbus.String(command))
348
elif not os.WIFEXITED(condition):
349
logger.warning(u"Checker for %(name)s crashed?",
352
self.CheckerCompleted(dbus.Boolean(False),
353
dbus.UInt16(condition),
354
dbus.String(command))
356
logger.info(u"Checker for %(name)s failed",
359
self.CheckerCompleted(dbus.Boolean(False),
360
dbus.UInt16(condition),
361
dbus.String(command))
654
def checked_ok(self):
655
"""Assert that the client has been seen, alive and well."""
363
def bump_timeout(self):
364
"""Bump up the timeout for this client.
365
This should only be called when the client has been seen,
656
368
self.last_checked_ok = datetime.datetime.utcnow()
657
self.last_checker_status = 0
660
def bump_timeout(self, timeout=None):
661
"""Bump up the timeout for this client."""
663
timeout = self.timeout
664
if self.disable_initiator_tag is not None:
665
gobject.source_remove(self.disable_initiator_tag)
666
self.disable_initiator_tag = None
667
if getattr(self, "enabled", False):
668
self.disable_initiator_tag = (gobject.timeout_add
669
(timedelta_to_milliseconds
670
(timeout), self.disable))
671
self.expires = datetime.datetime.utcnow() + timeout
673
def need_approval(self):
674
self.last_approval_request = datetime.datetime.utcnow()
369
gobject.source_remove(self.disable_initiator_tag)
370
self.disable_initiator_tag = (gobject.timeout_add
371
(self._timeout_milliseconds,
373
self.PropertyChanged(dbus.String(u"last_checked_ok"),
374
(_datetime_to_dbus(self.last_checked_ok,
676
377
def start_checker(self):
677
378
"""Start a new checker subprocess if one is not running.
679
379
If a checker already exists, leave it running and do
681
381
# The reason for not killing a running checker is that if we
682
# did that, and if a checker (for some reason) started running
683
# slowly and taking more than 'interval' time, then the client
684
# would inevitably timeout, since no checker would get a
685
# chance to run to completion. If we instead leave running
382
# did that, then if a checker (for some reason) started
383
# running slowly and taking more than 'interval' time, the
384
# client would inevitably timeout, since no checker would get
385
# a chance to run to completion. If we instead leave running
686
386
# checkers alone, the checker would have to take more time
687
# than 'timeout' for the client to be disabled, which is as it
690
# If a checker exists, make sure it is not a zombie
692
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
693
except AttributeError:
695
except OSError as error:
696
if error.errno != errno.ECHILD:
700
logger.warning("Checker was a zombie")
701
gobject.source_remove(self.checker_callback_tag)
702
self.checker_callback(pid, status,
703
self.current_checker_command)
704
# Start a new checker if needed
387
# than 'timeout' for the client to be declared invalid, which
388
# is as it should be.
705
389
if self.checker is None:
706
# Escape attributes for the shell
707
escaped_attrs = dict(
708
(attr, re.escape(unicode(getattr(self, attr))))
710
self.runtime_expansions)
712
command = self.checker_command % escaped_attrs
713
except TypeError as error:
714
logger.error('Could not format string "%s"',
715
self.checker_command, exc_info=error)
716
return True # Try again later
717
self.current_checker_command = command
719
logger.info("Starting checker %r for %s",
391
# In case checker_command has exactly one % operator
392
command = self.checker_command % self.host
394
# Escape attributes for the shell
395
escaped_attrs = dict((key, re.escape(str(val)))
397
vars(self).iteritems())
399
command = self.checker_command % escaped_attrs
400
except TypeError, error:
401
logger.error(u'Could not format string "%s":'
402
u' %s', self.checker_command, error)
403
return True # Try again later
405
logger.info(u"Starting checker %r for %s",
720
406
command, self.name)
721
407
# We don't need to redirect stdout and stderr, since
722
408
# in normal mode, that is already done by daemon(),
723
409
# and in debug mode we don't want to. (Stdin is
724
410
# always replaced by /dev/null.)
725
# The exception is when not debugging but nevertheless
726
# running in the foreground; use the previously
729
if (not self.server_settings["debug"]
730
and self.server_settings["foreground"]):
731
popen_args.update({"stdout": wnull,
733
411
self.checker = subprocess.Popen(command,
737
except OSError as error:
738
logger.error("Failed to start subprocess",
741
self.checker_callback_tag = (gobject.child_watch_add
743
self.checker_callback,
745
# The checker may have completed before the gobject
746
# watch was added. Check for this.
748
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
749
except OSError as error:
750
if error.errno == errno.ECHILD:
751
# This should never happen
752
logger.error("Child process vanished",
757
gobject.source_remove(self.checker_callback_tag)
758
self.checker_callback(pid, status, command)
415
self.CheckerStarted(command)
416
self.PropertyChanged(dbus.String("checker_running"),
417
dbus.Boolean(True, variant_level=1))
418
self.checker_callback_tag = (gobject.child_watch_add
420
self.checker_callback,
422
except OSError, error:
423
logger.error(u"Failed to start subprocess: %s",
759
425
# Re-run this periodically if run by gobject.timeout_add
766
432
self.checker_callback_tag = None
767
433
if getattr(self, "checker", None) is None:
769
logger.debug("Stopping checker for %(name)s", vars(self))
435
logger.debug(u"Stopping checker for %(name)s", vars(self))
771
self.checker.terminate()
437
os.kill(self.checker.pid, signal.SIGTERM)
773
439
#if self.checker.poll() is None:
774
# self.checker.kill()
775
except OSError as error:
440
# os.kill(self.checker.pid, signal.SIGKILL)
441
except OSError, error:
776
442
if error.errno != errno.ESRCH: # No such process
778
444
self.checker = None
781
def dbus_service_property(dbus_interface, signature="v",
782
access="readwrite", byte_arrays=False):
783
"""Decorators for marking methods of a DBusObjectWithProperties to
784
become properties on the D-Bus.
786
The decorated method will be called with no arguments by "Get"
787
and with one argument by "Set".
789
The parameters, where they are supported, are the same as
790
dbus.service.method, except there is only "signature", since the
791
type from Get() and the type sent to Set() is the same.
793
# Encoding deeply encoded byte arrays is not supported yet by the
794
# "Set" method, so we fail early here:
795
if byte_arrays and signature != "ay":
796
raise ValueError("Byte arrays not supported for non-'ay'"
797
" signature {0!r}".format(signature))
799
func._dbus_is_property = True
800
func._dbus_interface = dbus_interface
801
func._dbus_signature = signature
802
func._dbus_access = access
803
func._dbus_name = func.__name__
804
if func._dbus_name.endswith("_dbus_property"):
805
func._dbus_name = func._dbus_name[:-14]
806
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
811
def dbus_interface_annotations(dbus_interface):
812
"""Decorator for marking functions returning interface annotations
816
@dbus_interface_annotations("org.example.Interface")
817
def _foo(self): # Function name does not matter
818
return {"org.freedesktop.DBus.Deprecated": "true",
819
"org.freedesktop.DBus.Property.EmitsChangedSignal":
823
func._dbus_is_interface = True
824
func._dbus_interface = dbus_interface
825
func._dbus_name = dbus_interface
830
def dbus_annotations(annotations):
831
"""Decorator to annotate D-Bus methods, signals or properties
834
@dbus_service_property("org.example.Interface", signature="b",
836
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
837
"org.freedesktop.DBus.Property."
838
"EmitsChangedSignal": "false"})
839
def Property_dbus_property(self):
840
return dbus.Boolean(False)
843
func._dbus_annotations = annotations
848
class DBusPropertyException(dbus.exceptions.DBusException):
849
"""A base class for D-Bus property-related exceptions
851
def __unicode__(self):
852
return unicode(str(self))
855
class DBusPropertyAccessException(DBusPropertyException):
856
"""A property's access permissions disallows an operation.
861
class DBusPropertyNotFound(DBusPropertyException):
862
"""An attempt was made to access a non-existing property.
867
class DBusObjectWithProperties(dbus.service.Object):
868
"""A D-Bus object with properties.
870
Classes inheriting from this can use the dbus_service_property
871
decorator to expose methods as D-Bus properties. It exposes the
872
standard Get(), Set(), and GetAll() methods on the D-Bus.
876
def _is_dbus_thing(thing):
877
"""Returns a function testing if an attribute is a D-Bus thing
879
If called like _is_dbus_thing("method") it returns a function
880
suitable for use as predicate to inspect.getmembers().
882
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
885
def _get_all_dbus_things(self, thing):
886
"""Returns a generator of (name, attribute) pairs
888
return ((getattr(athing.__get__(self), "_dbus_name",
890
athing.__get__(self))
891
for cls in self.__class__.__mro__
893
inspect.getmembers(cls,
894
self._is_dbus_thing(thing)))
896
def _get_dbus_property(self, interface_name, property_name):
897
"""Returns a bound method if one exists which is a D-Bus
898
property with the specified name and interface.
900
for cls in self.__class__.__mro__:
901
for name, value in (inspect.getmembers
903
self._is_dbus_thing("property"))):
904
if (value._dbus_name == property_name
905
and value._dbus_interface == interface_name):
906
return value.__get__(self)
909
raise DBusPropertyNotFound(self.dbus_object_path + ":"
910
+ interface_name + "."
913
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
915
def Get(self, interface_name, property_name):
916
"""Standard D-Bus property Get() method, see D-Bus standard.
918
prop = self._get_dbus_property(interface_name, property_name)
919
if prop._dbus_access == "write":
920
raise DBusPropertyAccessException(property_name)
922
if not hasattr(value, "variant_level"):
924
return type(value)(value, variant_level=value.variant_level+1)
926
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
927
def Set(self, interface_name, property_name, value):
928
"""Standard D-Bus property Set() method, see D-Bus standard.
930
prop = self._get_dbus_property(interface_name, property_name)
931
if prop._dbus_access == "read":
932
raise DBusPropertyAccessException(property_name)
933
if prop._dbus_get_args_options["byte_arrays"]:
934
# The byte_arrays option is not supported yet on
935
# signatures other than "ay".
936
if prop._dbus_signature != "ay":
938
value = dbus.ByteArray(b''.join(chr(byte)
942
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
943
out_signature="a{sv}")
944
def GetAll(self, interface_name):
945
"""Standard D-Bus property GetAll() method, see D-Bus
948
Note: Will not include properties with access="write".
951
for name, prop in self._get_all_dbus_things("property"):
953
and interface_name != prop._dbus_interface):
954
# Interface non-empty but did not match
956
# Ignore write-only properties
957
if prop._dbus_access == "write":
960
if not hasattr(value, "variant_level"):
961
properties[name] = value
963
properties[name] = type(value)(value, variant_level=
964
value.variant_level+1)
965
return dbus.Dictionary(properties, signature="sv")
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)
980
def make_tag(document, name, prop):
981
e = document.createElement("property")
982
e.setAttribute("name", name)
983
e.setAttribute("type", prop._dbus_signature)
984
e.setAttribute("access", prop._dbus_access)
986
for if_tag in document.getElementsByTagName("interface"):
988
for tag in (make_tag(document, name, prop)
990
in self._get_all_dbus_things("property")
991
if prop._dbus_interface
992
== if_tag.getAttribute("name")):
993
if_tag.appendChild(tag)
994
# Add annotation tags
995
for typ in ("method", "signal", "property"):
996
for tag in if_tag.getElementsByTagName(typ):
998
for name, prop in (self.
999
_get_all_dbus_things(typ)):
1000
if (name == tag.getAttribute("name")
1001
and prop._dbus_interface
1002
== if_tag.getAttribute("name")):
1003
annots.update(getattr
1005
"_dbus_annotations",
1007
for name, value in annots.iteritems():
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().iteritems()
1017
for name, annotations in
1018
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(),
1054
variant_level=variant_level)
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.
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():
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.
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).
1081
for orig_interface_name, alt_interface_name in (
1082
alt_interface_names.iteritems()):
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
1091
.startswith(orig_interface_name)):
1093
# Create an alternate D-Bus interface name based on
1095
alt_interface = (attribute._dbus_interface
1096
.replace(orig_interface_name,
1097
alt_interface_name))
1098
interface_names.add(alt_interface)
1099
# Is this a D-Bus signal?
1100
if getattr(attribute, "_dbus_is_signal", False):
1101
# Extract the original non-method undecorated
1102
# function by black magic
1103
nonmethod_func = (dict(
1104
zip(attribute.func_code.co_freevars,
1105
attribute.__closure__))["func"]
1107
# Create a new, but exactly alike, function
1108
# object, and decorate it to be a new D-Bus signal
1109
# with the alternate D-Bus interface name
1110
new_function = (dbus.service.signal
1112
attribute._dbus_signature)
1113
(types.FunctionType(
1114
nonmethod_func.func_code,
1115
nonmethod_func.func_globals,
1116
nonmethod_func.func_name,
1117
nonmethod_func.func_defaults,
1118
nonmethod_func.func_closure)))
1119
# Copy annotations, if any
1121
new_function._dbus_annotations = (
1122
dict(attribute._dbus_annotations))
1123
except AttributeError:
1125
# Define a creator of a function to call both the
1126
# original and alternate functions, so both the
1127
# original and alternate signals gets sent when
1128
# the function is called
1129
def fixscope(func1, func2):
1130
"""This function is a scope container to pass
1131
func1 and func2 to the "call_both" function
1132
outside of its arguments"""
1133
def call_both(*args, **kwargs):
1134
"""This function will emit two D-Bus
1135
signals by calling func1 and func2"""
1136
func1(*args, **kwargs)
1137
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
1148
attr[attrname] = (dbus.service.method
1150
attribute._dbus_in_signature,
1151
attribute._dbus_out_signature)
1153
(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 = (
1161
dict(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
1172
attribute._dbus_signature,
1173
attribute._dbus_access,
1175
._dbus_get_args_options
1178
(attribute.func_code,
1179
attribute.func_globals,
1180
attribute.func_name,
1181
attribute.func_defaults,
1182
attribute.func_closure)))
1183
# Copy annotations, if any
1185
attr[attrname]._dbus_annotations = (
1186
dict(attribute._dbus_annotations))
1187
except AttributeError:
1189
# Is this a D-Bus interface?
1190
elif getattr(attribute, "_dbus_is_interface", False):
1191
# Create a new, but exactly alike, function
1192
# object. Decorate it to be a new D-Bus interface
1193
# with the alternate D-Bus interface name. Add it
1195
attr[attrname] = (dbus_interface_annotations
1198
(attribute.func_code,
1199
attribute.func_globals,
1200
attribute.func_name,
1201
attribute.func_defaults,
1202
attribute.func_closure)))
1204
# Deprecate all alternate interfaces
1205
iname="_AlternateDBusNames_interface_annotation{0}"
1206
for interface_name in interface_names:
1207
@dbus_interface_annotations(interface_name)
1209
return { "org.freedesktop.DBus.Deprecated":
1211
# Find an unused name
1212
for aname in (iname.format(i)
1213
for i in itertools.count()):
1214
if aname not in attr:
1218
# Replace the class with a new subclass of it with
1219
# methods, signals, etc. as created above.
1220
cls = type(b"{0}Alternate".format(cls.__name__),
1226
@alternate_dbus_interfaces({"se.recompile.Mandos":
1227
"se.bsnet.fukt.Mandos"})
1228
class ClientDBus(Client, DBusObjectWithProperties):
1229
"""A Client class using D-Bus
1232
dbus_object_path: dbus.ObjectPath
1233
bus: dbus.SystemBus()
1236
runtime_expansions = (Client.runtime_expansions
1237
+ ("dbus_object_path",))
1239
# dbus.service.Object doesn't use super(), so we can't either.
1241
def __init__(self, bus = None, *args, **kwargs):
1243
Client.__init__(self, *args, **kwargs)
1244
# Only now, when this client is initialized, can it show up on
1246
client_object_name = unicode(self.name).translate(
1247
{ord("."): ord("_"),
1248
ord("-"): ord("_")})
1249
self.dbus_object_path = (dbus.ObjectPath
1250
("/clients/" + client_object_name))
1251
DBusObjectWithProperties.__init__(self, self.bus,
1252
self.dbus_object_path)
1254
def notifychangeproperty(transform_func,
1255
dbus_name, type_func=lambda x: x,
1257
""" Modify a variable so that it's a property which announces
1258
its changes to DBus.
1260
transform_fun: Function that takes a value and a variant_level
1261
and transforms it to a D-Bus type.
1262
dbus_name: D-Bus name of the variable
1263
type_func: Function that transform the value before sending it
1264
to the D-Bus. Default: no transform
1265
variant_level: D-Bus variant level. Default: 1
1267
attrname = "_{0}".format(dbus_name)
1268
def setter(self, value):
1269
if hasattr(self, "dbus_object_path"):
1270
if (not hasattr(self, attrname) or
1271
type_func(getattr(self, attrname, None))
1272
!= type_func(value)):
1273
dbus_value = transform_func(type_func(value),
1276
self.PropertyChanged(dbus.String(dbus_name),
1278
setattr(self, attrname, value)
1280
return property(lambda self: getattr(self, attrname), setter)
1282
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1283
approvals_pending = notifychangeproperty(dbus.Boolean,
1286
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1287
last_enabled = notifychangeproperty(datetime_to_dbus,
1289
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1290
type_func = lambda checker:
1291
checker is not None)
1292
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1294
last_checker_status = notifychangeproperty(dbus.Int16,
1295
"LastCheckerStatus")
1296
last_approval_request = notifychangeproperty(
1297
datetime_to_dbus, "LastApprovalRequest")
1298
approved_by_default = notifychangeproperty(dbus.Boolean,
1299
"ApprovedByDefault")
1300
approval_delay = notifychangeproperty(dbus.UInt64,
1303
timedelta_to_milliseconds)
1304
approval_duration = notifychangeproperty(
1305
dbus.UInt64, "ApprovalDuration",
1306
type_func = timedelta_to_milliseconds)
1307
host = notifychangeproperty(dbus.String, "Host")
1308
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1310
timedelta_to_milliseconds)
1311
extended_timeout = notifychangeproperty(
1312
dbus.UInt64, "ExtendedTimeout",
1313
type_func = timedelta_to_milliseconds)
1314
interval = notifychangeproperty(dbus.UInt64,
1317
timedelta_to_milliseconds)
1318
checker_command = notifychangeproperty(dbus.String, "Checker")
1320
del notifychangeproperty
1322
def __del__(self, *args, **kwargs):
1324
self.remove_from_connection()
1327
if hasattr(DBusObjectWithProperties, "__del__"):
1328
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1329
Client.__del__(self, *args, **kwargs)
1331
def checker_callback(self, pid, condition, command,
1333
self.checker_callback_tag = None
1335
if os.WIFEXITED(condition):
1336
exitstatus = os.WEXITSTATUS(condition)
1338
self.CheckerCompleted(dbus.Int16(exitstatus),
1339
dbus.Int64(condition),
1340
dbus.String(command))
1343
self.CheckerCompleted(dbus.Int16(-1),
1344
dbus.Int64(condition),
1345
dbus.String(command))
1347
return Client.checker_callback(self, pid, condition, command,
1350
def start_checker(self, *args, **kwargs):
1351
old_checker = self.checker
1352
if self.checker is not None:
1353
old_checker_pid = self.checker.pid
1355
old_checker_pid = None
1356
r = Client.start_checker(self, *args, **kwargs)
1357
# Only if new checker process was started
1358
if (self.checker is not None
1359
and old_checker_pid != self.checker.pid):
1361
self.CheckerStarted(self.current_checker_command)
1364
def _reset_approved(self):
1365
self.approved = None
1368
def approve(self, value=True):
1369
self.approved = value
1370
gobject.timeout_add(timedelta_to_milliseconds
1371
(self.approval_duration),
1372
self._reset_approved)
1373
self.send_changedstate()
1375
## D-Bus methods, signals & properties
1376
_interface = "se.recompile.Mandos.Client"
1380
@dbus_interface_annotations(_interface)
1382
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
445
self.PropertyChanged(dbus.String(u"checker_running"),
446
dbus.Boolean(False, variant_level=1))
448
def still_valid(self):
449
"""Has the timeout not yet passed for this client?"""
450
if not getattr(self, "enabled", False):
452
now = datetime.datetime.utcnow()
453
if self.last_checked_ok is None:
454
return now < (self.created + self.timeout)
456
return now < (self.last_checked_ok + self.timeout)
458
## D-Bus methods & signals
459
_interface = u"org.mandos_system.Mandos.Client"
461
# BumpTimeout - method
462
BumpTimeout = dbus.service.method(_interface)(bump_timeout)
463
BumpTimeout.__name__ = "BumpTimeout"
1387
465
# CheckerCompleted - signal
1388
@dbus.service.signal(_interface, signature="nxs")
1389
def CheckerCompleted(self, exitcode, waitstatus, command):
466
@dbus.service.signal(_interface, signature="bqs")
467
def CheckerCompleted(self, success, condition, command):
1456
572
# StopChecker - method
1457
@dbus.service.method(_interface)
1458
def StopChecker(self):
1463
# ApprovalPending - property
1464
@dbus_service_property(_interface, signature="b", access="read")
1465
def ApprovalPending_dbus_property(self):
1466
return dbus.Boolean(bool(self.approvals_pending))
1468
# ApprovedByDefault - property
1469
@dbus_service_property(_interface, signature="b",
1471
def ApprovedByDefault_dbus_property(self, value=None):
1472
if value is None: # get
1473
return dbus.Boolean(self.approved_by_default)
1474
self.approved_by_default = bool(value)
1476
# ApprovalDelay - property
1477
@dbus_service_property(_interface, signature="t",
1479
def ApprovalDelay_dbus_property(self, value=None):
1480
if value is None: # get
1481
return dbus.UInt64(self.approval_delay_milliseconds())
1482
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1484
# ApprovalDuration - property
1485
@dbus_service_property(_interface, signature="t",
1487
def ApprovalDuration_dbus_property(self, value=None):
1488
if value is None: # get
1489
return dbus.UInt64(timedelta_to_milliseconds(
1490
self.approval_duration))
1491
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1494
@dbus_service_property(_interface, signature="s", access="read")
1495
def Name_dbus_property(self):
1496
return dbus.String(self.name)
1498
# Fingerprint - property
1499
@dbus_service_property(_interface, signature="s", access="read")
1500
def Fingerprint_dbus_property(self):
1501
return dbus.String(self.fingerprint)
1504
@dbus_service_property(_interface, signature="s",
1506
def Host_dbus_property(self, value=None):
1507
if value is None: # get
1508
return dbus.String(self.host)
1509
self.host = unicode(value)
1511
# Created - property
1512
@dbus_service_property(_interface, signature="s", access="read")
1513
def Created_dbus_property(self):
1514
return datetime_to_dbus(self.created)
1516
# LastEnabled - property
1517
@dbus_service_property(_interface, signature="s", access="read")
1518
def LastEnabled_dbus_property(self):
1519
return datetime_to_dbus(self.last_enabled)
1521
# Enabled - property
1522
@dbus_service_property(_interface, signature="b",
1524
def Enabled_dbus_property(self, value=None):
1525
if value is None: # get
1526
return dbus.Boolean(self.enabled)
1532
# LastCheckedOK - property
1533
@dbus_service_property(_interface, signature="s",
1535
def LastCheckedOK_dbus_property(self, value=None):
1536
if value is not None:
1539
return datetime_to_dbus(self.last_checked_ok)
1541
# LastCheckerStatus - property
1542
@dbus_service_property(_interface, signature="n",
1544
def LastCheckerStatus_dbus_property(self):
1545
return dbus.Int16(self.last_checker_status)
1547
# Expires - property
1548
@dbus_service_property(_interface, signature="s", access="read")
1549
def Expires_dbus_property(self):
1550
return datetime_to_dbus(self.expires)
1552
# LastApprovalRequest - property
1553
@dbus_service_property(_interface, signature="s", access="read")
1554
def LastApprovalRequest_dbus_property(self):
1555
return datetime_to_dbus(self.last_approval_request)
1557
# Timeout - property
1558
@dbus_service_property(_interface, signature="t",
1560
def Timeout_dbus_property(self, value=None):
1561
if value is None: # get
1562
return dbus.UInt64(self.timeout_milliseconds())
1563
old_timeout = self.timeout
1564
self.timeout = datetime.timedelta(0, 0, 0, value)
1565
# Reschedule disabling
1567
now = datetime.datetime.utcnow()
1568
self.expires += self.timeout - old_timeout
1569
if self.expires <= now:
1570
# The timeout has passed
1573
if (getattr(self, "disable_initiator_tag", None)
1576
gobject.source_remove(self.disable_initiator_tag)
1577
self.disable_initiator_tag = (
1578
gobject.timeout_add(
1579
timedelta_to_milliseconds(self.expires - now),
1582
# ExtendedTimeout - property
1583
@dbus_service_property(_interface, signature="t",
1585
def ExtendedTimeout_dbus_property(self, value=None):
1586
if value is None: # get
1587
return dbus.UInt64(self.extended_timeout_milliseconds())
1588
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1590
# Interval - property
1591
@dbus_service_property(_interface, signature="t",
1593
def Interval_dbus_property(self, value=None):
1594
if value is None: # get
1595
return dbus.UInt64(self.interval_milliseconds())
1596
self.interval = datetime.timedelta(0, 0, 0, value)
1597
if getattr(self, "checker_initiator_tag", None) is None:
1600
# Reschedule checker run
1601
gobject.source_remove(self.checker_initiator_tag)
1602
self.checker_initiator_tag = (gobject.timeout_add
1603
(value, self.start_checker))
1604
self.start_checker() # Start one now, too
1606
# Checker - property
1607
@dbus_service_property(_interface, signature="s",
1609
def Checker_dbus_property(self, value=None):
1610
if value is None: # get
1611
return dbus.String(self.checker_command)
1612
self.checker_command = unicode(value)
1614
# CheckerRunning - property
1615
@dbus_service_property(_interface, signature="b",
1617
def CheckerRunning_dbus_property(self, value=None):
1618
if value is None: # get
1619
return dbus.Boolean(self.checker is not None)
1621
self.start_checker()
1625
# ObjectPath - property
1626
@dbus_service_property(_interface, signature="o", access="read")
1627
def ObjectPath_dbus_property(self):
1628
return self.dbus_object_path # is already a dbus.ObjectPath
1631
@dbus_service_property(_interface, signature="ay",
1632
access="write", byte_arrays=True)
1633
def Secret_dbus_property(self, value):
1634
self.secret = str(value)
573
StopChecker = dbus.service.method(_interface)(stop_checker)
574
StopChecker.__name__ = "StopChecker"
1639
class ProxyClient(object):
1640
def __init__(self, child_pipe, fpr, address):
1641
self._pipe = child_pipe
1642
self._pipe.send(('init', fpr, address))
1643
if not self._pipe.recv():
1646
def __getattribute__(self, name):
1648
return super(ProxyClient, self).__getattribute__(name)
1649
self._pipe.send(('getattr', name))
1650
data = self._pipe.recv()
1651
if data[0] == 'data':
1653
if data[0] == 'function':
1654
def func(*args, **kwargs):
1655
self._pipe.send(('funcall', name, args, kwargs))
1656
return self._pipe.recv()[1]
1659
def __setattr__(self, name, value):
1661
return super(ProxyClient, self).__setattr__(name, value)
1662
self._pipe.send(('setattr', name, value))
1665
class ClientHandler(socketserver.BaseRequestHandler, object):
1666
"""A class to handle client connections.
1668
Instantiated once for each connection to handle it.
579
def peer_certificate(session):
580
"Return the peer's OpenPGP certificate as a bytestring"
581
# If not an OpenPGP certificate...
582
if (gnutls.library.functions
583
.gnutls_certificate_type_get(session._c_object)
584
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
585
# ...do the normal thing
586
return session.peer_certificate
587
list_size = ctypes.c_uint()
588
cert_list = (gnutls.library.functions
589
.gnutls_certificate_get_peers
590
(session._c_object, ctypes.byref(list_size)))
591
if list_size.value == 0:
594
return ctypes.string_at(cert.data, cert.size)
597
def fingerprint(openpgp):
598
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
599
# New GnuTLS "datum" with the OpenPGP public key
600
datum = (gnutls.library.types
601
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
604
ctypes.c_uint(len(openpgp))))
605
# New empty GnuTLS certificate
606
crt = gnutls.library.types.gnutls_openpgp_crt_t()
607
(gnutls.library.functions
608
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
609
# Import the OpenPGP public key into the certificate
610
(gnutls.library.functions
611
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
612
gnutls.library.constants
613
.GNUTLS_OPENPGP_FMT_RAW))
614
# Verify the self signature in the key
615
crtverify = ctypes.c_uint()
616
(gnutls.library.functions
617
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
618
if crtverify.value != 0:
619
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
620
raise gnutls.errors.CertificateSecurityError("Verify failed")
621
# New buffer for the fingerprint
622
buf = ctypes.create_string_buffer(20)
623
buf_len = ctypes.c_size_t()
624
# Get the fingerprint from the certificate into the buffer
625
(gnutls.library.functions
626
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
627
ctypes.byref(buf_len)))
628
# Deinit the certificate
629
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
630
# Convert the buffer to a Python bytestring
631
fpr = ctypes.string_at(buf, buf_len.value)
632
# Convert the bytestring to hexadecimal notation
633
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
637
class TCP_handler(SocketServer.BaseRequestHandler, object):
638
"""A TCP request handler class.
639
Instantiated by IPv6_TCPServer for each request to handle it.
1669
640
Note: This will run in its own forked process."""
1671
642
def handle(self):
1672
with contextlib.closing(self.server.child_pipe) as child_pipe:
1673
logger.info("TCP connection from: %s",
1674
unicode(self.client_address))
1675
logger.debug("Pipe FD: %d",
1676
self.server.child_pipe.fileno())
1678
session = (gnutls.connection
1679
.ClientSession(self.request,
1681
.X509Credentials()))
1683
# Note: gnutls.connection.X509Credentials is really a
1684
# generic GnuTLS certificate credentials object so long as
1685
# no X.509 keys are added to it. Therefore, we can use it
1686
# here despite using OpenPGP certificates.
1688
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1689
# "+AES-256-CBC", "+SHA1",
1690
# "+COMP-NULL", "+CTYPE-OPENPGP",
1692
# Use a fallback default, since this MUST be set.
1693
priority = self.server.gnutls_priority
1694
if priority is None:
1696
(gnutls.library.functions
1697
.gnutls_priority_set_direct(session._c_object,
1700
# Start communication using the Mandos protocol
1701
# Get protocol number
1702
line = self.request.makefile().readline()
1703
logger.debug("Protocol version: %r", line)
1705
if int(line.strip().split()[0]) > 1:
1706
raise RuntimeError(line)
1707
except (ValueError, IndexError, RuntimeError) as error:
1708
logger.error("Unknown protocol version: %s", error)
1711
# Start GnuTLS connection
1714
except gnutls.errors.GNUTLSError as error:
1715
logger.warning("Handshake failed: %s", error)
1716
# Do not run session.bye() here: the session is not
1717
# established. Just abandon the request.
1719
logger.debug("Handshake succeeded")
1721
approval_required = False
1724
fpr = self.fingerprint(self.peer_certificate
1727
gnutls.errors.GNUTLSError) as error:
1728
logger.warning("Bad certificate: %s", error)
1730
logger.debug("Fingerprint: %s", fpr)
1733
client = ProxyClient(child_pipe, fpr,
1734
self.client_address)
1738
if client.approval_delay:
1739
delay = client.approval_delay
1740
client.approvals_pending += 1
1741
approval_required = True
1744
if not client.enabled:
1745
logger.info("Client %s is disabled",
1747
if self.server.use_dbus:
1749
client.Rejected("Disabled")
1752
if client.approved or not client.approval_delay:
1753
#We are approved or approval is disabled
1755
elif client.approved is None:
1756
logger.info("Client %s needs approval",
1758
if self.server.use_dbus:
1760
client.NeedApproval(
1761
client.approval_delay_milliseconds(),
1762
client.approved_by_default)
1764
logger.warning("Client %s was not approved",
1766
if self.server.use_dbus:
1768
client.Rejected("Denied")
1771
#wait until timeout or approved
1772
time = datetime.datetime.now()
1773
client.changedstate.acquire()
1774
client.changedstate.wait(
1775
float(timedelta_to_milliseconds(delay)
1777
client.changedstate.release()
1778
time2 = datetime.datetime.now()
1779
if (time2 - time) >= delay:
1780
if not client.approved_by_default:
1781
logger.warning("Client %s timed out while"
1782
" waiting for approval",
1784
if self.server.use_dbus:
1786
client.Rejected("Approval timed out")
1791
delay -= time2 - time
1794
while sent_size < len(client.secret):
1796
sent = session.send(client.secret[sent_size:])
1797
except gnutls.errors.GNUTLSError as error:
1798
logger.warning("gnutls send failed",
1801
logger.debug("Sent: %d, remaining: %d",
1802
sent, len(client.secret)
1803
- (sent_size + sent))
1806
logger.info("Sending secret to %s", client.name)
1807
# bump the timeout using extended_timeout
1808
client.bump_timeout(client.extended_timeout)
1809
if self.server.use_dbus:
1814
if approval_required:
1815
client.approvals_pending -= 1
1818
except gnutls.errors.GNUTLSError as error:
1819
logger.warning("GnuTLS bye failed",
1823
def peer_certificate(session):
1824
"Return the peer's OpenPGP certificate as a bytestring"
1825
# If not an OpenPGP certificate...
1826
if (gnutls.library.functions
1827
.gnutls_certificate_type_get(session._c_object)
1828
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1829
# ...do the normal thing
1830
return session.peer_certificate
1831
list_size = ctypes.c_uint(1)
1832
cert_list = (gnutls.library.functions
1833
.gnutls_certificate_get_peers
1834
(session._c_object, ctypes.byref(list_size)))
1835
if not bool(cert_list) and list_size.value != 0:
1836
raise gnutls.errors.GNUTLSError("error getting peer"
1838
if list_size.value == 0:
1841
return ctypes.string_at(cert.data, cert.size)
1844
def fingerprint(openpgp):
1845
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1846
# New GnuTLS "datum" with the OpenPGP public key
1847
datum = (gnutls.library.types
1848
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1851
ctypes.c_uint(len(openpgp))))
1852
# New empty GnuTLS certificate
1853
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1854
(gnutls.library.functions
1855
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1856
# Import the OpenPGP public key into the certificate
1857
(gnutls.library.functions
1858
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1859
gnutls.library.constants
1860
.GNUTLS_OPENPGP_FMT_RAW))
1861
# Verify the self signature in the key
1862
crtverify = ctypes.c_uint()
1863
(gnutls.library.functions
1864
.gnutls_openpgp_crt_verify_self(crt, 0,
1865
ctypes.byref(crtverify)))
1866
if crtverify.value != 0:
1867
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1868
raise (gnutls.errors.CertificateSecurityError
1870
# New buffer for the fingerprint
1871
buf = ctypes.create_string_buffer(20)
1872
buf_len = ctypes.c_size_t()
1873
# Get the fingerprint from the certificate into the buffer
1874
(gnutls.library.functions
1875
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1876
ctypes.byref(buf_len)))
1877
# Deinit the certificate
1878
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1879
# Convert the buffer to a Python bytestring
1880
fpr = ctypes.string_at(buf, buf_len.value)
1881
# Convert the bytestring to hexadecimal notation
1882
hex_fpr = binascii.hexlify(fpr).upper()
1886
class MultiprocessingMixIn(object):
1887
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1888
def sub_process_main(self, request, address):
1890
self.finish_request(request, address)
1892
self.handle_error(request, address)
1893
self.close_request(request)
1895
def process_request(self, request, address):
1896
"""Start a new process to process the request."""
1897
proc = multiprocessing.Process(target = self.sub_process_main,
1898
args = (request, address))
1903
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1904
""" adds a pipe to the MixIn """
1905
def process_request(self, request, client_address):
1906
"""Overrides and wraps the original process_request().
1908
This function creates a new pipe in self.pipe
1910
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1912
proc = MultiprocessingMixIn.process_request(self, request,
1914
self.child_pipe.close()
1915
self.add_pipe(parent_pipe, proc)
1917
def add_pipe(self, parent_pipe, proc):
1918
"""Dummy function; override as necessary"""
1919
raise NotImplementedError()
1922
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1923
socketserver.TCPServer, object):
1924
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
643
logger.info(u"TCP connection from: %s",
644
unicode(self.client_address))
645
session = (gnutls.connection
646
.ClientSession(self.request,
650
line = self.request.makefile().readline()
651
logger.debug(u"Protocol version: %r", line)
653
if int(line.strip().split()[0]) > 1:
655
except (ValueError, IndexError, RuntimeError), error:
656
logger.error(u"Unknown protocol version: %s", error)
659
# Note: gnutls.connection.X509Credentials is really a generic
660
# GnuTLS certificate credentials object so long as no X.509
661
# keys are added to it. Therefore, we can use it here despite
662
# using OpenPGP certificates.
664
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
665
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
667
# Use a fallback default, since this MUST be set.
668
priority = self.server.settings.get("priority", "NORMAL")
669
(gnutls.library.functions
670
.gnutls_priority_set_direct(session._c_object,
675
except gnutls.errors.GNUTLSError, error:
676
logger.warning(u"Handshake failed: %s", error)
677
# Do not run session.bye() here: the session is not
678
# established. Just abandon the request.
681
fpr = fingerprint(peer_certificate(session))
682
except (TypeError, gnutls.errors.GNUTLSError), error:
683
logger.warning(u"Bad certificate: %s", error)
686
logger.debug(u"Fingerprint: %s", fpr)
687
for c in self.server.clients:
688
if c.fingerprint == fpr:
692
logger.warning(u"Client not found for fingerprint: %s",
696
# Have to check if client.still_valid(), since it is possible
697
# that the client timed out while establishing the GnuTLS
699
if not client.still_valid():
700
logger.warning(u"Client %(name)s is invalid",
704
## This won't work here, since we're in a fork.
705
# client.bump_timeout()
707
while sent_size < len(client.secret):
708
sent = session.send(client.secret[sent_size:])
709
logger.debug(u"Sent: %d, remaining: %d",
710
sent, len(client.secret)
711
- (sent_size + sent))
716
class IPv6_TCPServer(SocketServer.ForkingMixIn,
717
SocketServer.TCPServer, object):
718
"""IPv6 TCP server. Accepts 'None' as address and/or port.
720
settings: Server settings
721
clients: Set() of Client objects
1927
722
enabled: Boolean; whether this server is activated yet
1928
interface: None or a network interface name (string)
1929
use_ipv6: Boolean; to use IPv6 or not
1931
def __init__(self, server_address, RequestHandlerClass,
1932
interface=None, use_ipv6=True, socketfd=None):
1933
"""If socketfd is set, use that file descriptor instead of
1934
creating a new one with socket.socket().
1936
self.interface = interface
1938
self.address_family = socket.AF_INET6
1939
if socketfd is not None:
1940
# Save the file descriptor
1941
self.socketfd = socketfd
1942
# Save the original socket.socket() function
1943
self.socket_socket = socket.socket
1944
# To implement --socket, we monkey patch socket.socket.
1946
# (When socketserver.TCPServer is a new-style class, we
1947
# could make self.socket into a property instead of monkey
1948
# patching socket.socket.)
1950
# Create a one-time-only replacement for socket.socket()
1951
@functools.wraps(socket.socket)
1952
def socket_wrapper(*args, **kwargs):
1953
# Restore original function so subsequent calls are
1955
socket.socket = self.socket_socket
1956
del self.socket_socket
1957
# This time only, return a new socket object from the
1958
# saved file descriptor.
1959
return socket.fromfd(self.socketfd, *args, **kwargs)
1960
# Replace socket.socket() function with wrapper
1961
socket.socket = socket_wrapper
1962
# The socketserver.TCPServer.__init__ will call
1963
# socket.socket(), which might be our replacement,
1964
# socket_wrapper(), if socketfd was set.
1965
socketserver.TCPServer.__init__(self, server_address,
1966
RequestHandlerClass)
724
address_family = socket.AF_INET6
725
def __init__(self, *args, **kwargs):
726
if "settings" in kwargs:
727
self.settings = kwargs["settings"]
728
del kwargs["settings"]
729
if "clients" in kwargs:
730
self.clients = kwargs["clients"]
731
del kwargs["clients"]
733
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
1968
734
def server_bind(self):
1969
735
"""This overrides the normal server_bind() function
1970
736
to bind to an interface if one was specified, and also NOT to
1971
737
bind to an address or port if they were not specified."""
1972
if self.interface is not None:
1973
if SO_BINDTODEVICE is None:
1974
logger.error("SO_BINDTODEVICE does not exist;"
1975
" cannot bind to interface %s",
1979
self.socket.setsockopt(socket.SOL_SOCKET,
1981
str(self.interface + '\0'))
1982
except socket.error as error:
1983
if error.errno == errno.EPERM:
1984
logger.error("No permission to bind to"
1985
" interface %s", self.interface)
1986
elif error.errno == errno.ENOPROTOOPT:
1987
logger.error("SO_BINDTODEVICE not available;"
1988
" cannot bind to interface %s",
1990
elif error.errno == errno.ENODEV:
1991
logger.error("Interface %s does not exist,"
1992
" cannot bind", self.interface)
738
if self.settings["interface"]:
739
# 25 is from /usr/include/asm-i486/socket.h
740
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
742
self.socket.setsockopt(socket.SOL_SOCKET,
744
self.settings["interface"])
745
except socket.error, error:
746
if error[0] == errno.EPERM:
747
logger.error(u"No permission to"
748
u" bind to interface %s",
749
self.settings["interface"])
1995
752
# Only bind(2) the socket if we really need to.
1996
753
if self.server_address[0] or self.server_address[1]:
1997
754
if not self.server_address[0]:
1998
if self.address_family == socket.AF_INET6:
1999
any_address = "::" # in6addr_any
2001
any_address = "0.0.0.0" # INADDR_ANY
2002
self.server_address = (any_address,
756
self.server_address = (in6addr_any,
2003
757
self.server_address[1])
2004
758
elif not self.server_address[1]:
2005
759
self.server_address = (self.server_address[0],
2007
# if self.interface:
761
# if self.settings["interface"]:
2008
762
# self.server_address = (self.server_address[0],
2011
765
# if_nametoindex
2013
return socketserver.TCPServer.server_bind(self)
2016
class MandosServer(IPv6_TCPServer):
2020
clients: set of Client objects
2021
gnutls_priority GnuTLS priority string
2022
use_dbus: Boolean; to emit D-Bus signals or not
2024
Assumes a gobject.MainLoop event loop.
2026
def __init__(self, server_address, RequestHandlerClass,
2027
interface=None, use_ipv6=True, clients=None,
2028
gnutls_priority=None, use_dbus=True, socketfd=None):
2029
self.enabled = False
2030
self.clients = clients
2031
if self.clients is None:
2033
self.use_dbus = use_dbus
2034
self.gnutls_priority = gnutls_priority
2035
IPv6_TCPServer.__init__(self, server_address,
2036
RequestHandlerClass,
2037
interface = interface,
2038
use_ipv6 = use_ipv6,
2039
socketfd = socketfd)
768
return super(IPv6_TCPServer, self).server_bind()
2040
769
def server_activate(self):
2041
770
if self.enabled:
2042
return socketserver.TCPServer.server_activate(self)
771
return super(IPv6_TCPServer, self).server_activate()
2044
772
def enable(self):
2045
773
self.enabled = True
2047
def add_pipe(self, parent_pipe, proc):
2048
# Call "handle_ipc" for both data and EOF events
2049
gobject.io_add_watch(parent_pipe.fileno(),
2050
gobject.IO_IN | gobject.IO_HUP,
2051
functools.partial(self.handle_ipc,
2056
def handle_ipc(self, source, condition, parent_pipe=None,
2057
proc = None, client_object=None):
2058
# error, or the other end of multiprocessing.Pipe has closed
2059
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2060
# Wait for other process to exit
2064
# Read a request from the child
2065
request = parent_pipe.recv()
2066
command = request[0]
2068
if command == 'init':
2070
address = request[2]
2072
for c in self.clients.itervalues():
2073
if c.fingerprint == fpr:
2077
logger.info("Client not found for fingerprint: %s, ad"
2078
"dress: %s", fpr, address)
2081
mandos_dbus_service.ClientNotFound(fpr,
2083
parent_pipe.send(False)
2086
gobject.io_add_watch(parent_pipe.fileno(),
2087
gobject.IO_IN | gobject.IO_HUP,
2088
functools.partial(self.handle_ipc,
2094
parent_pipe.send(True)
2095
# remove the old hook in favor of the new above hook on
2098
if command == 'funcall':
2099
funcname = request[1]
2103
parent_pipe.send(('data', getattr(client_object,
2107
if command == 'getattr':
2108
attrname = request[1]
2109
if callable(client_object.__getattribute__(attrname)):
2110
parent_pipe.send(('function',))
2112
parent_pipe.send(('data', client_object
2113
.__getattribute__(attrname)))
2115
if command == 'setattr':
2116
attrname = request[1]
2118
setattr(client_object, attrname, value)
2123
def rfc3339_duration_to_delta(duration):
2124
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2126
>>> rfc3339_duration_to_delta("P7D")
2127
datetime.timedelta(7)
2128
>>> rfc3339_duration_to_delta("PT60S")
2129
datetime.timedelta(0, 60)
2130
>>> rfc3339_duration_to_delta("PT60M")
2131
datetime.timedelta(0, 3600)
2132
>>> rfc3339_duration_to_delta("PT24H")
2133
datetime.timedelta(1)
2134
>>> rfc3339_duration_to_delta("P1W")
2135
datetime.timedelta(7)
2136
>>> rfc3339_duration_to_delta("PT5M30S")
2137
datetime.timedelta(0, 330)
2138
>>> rfc3339_duration_to_delta("P1DT3M20S")
2139
datetime.timedelta(1, 200)
2142
# Parsing an RFC 3339 duration with regular expressions is not
2143
# possible - there would have to be multiple places for the same
2144
# values, like seconds. The current code, while more esoteric, is
2145
# cleaner without depending on a parsing library. If Python had a
2146
# built-in library for parsing we would use it, but we'd like to
2147
# avoid excessive use of external libraries.
2149
# New type for defining tokens, syntax, and semantics all-in-one
2150
Token = collections.namedtuple("Token",
2151
("regexp", # To match token; if
2152
# "value" is not None,
2153
# must have a "group"
2155
"value", # datetime.timedelta or
2157
"followers")) # Tokens valid after
2159
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2160
# the "duration" ABNF definition in RFC 3339, Appendix A.
2161
token_end = Token(re.compile(r"$"), None, frozenset())
2162
token_second = Token(re.compile(r"(\d+)S"),
2163
datetime.timedelta(seconds=1),
2164
frozenset((token_end,)))
2165
token_minute = Token(re.compile(r"(\d+)M"),
2166
datetime.timedelta(minutes=1),
2167
frozenset((token_second, token_end)))
2168
token_hour = Token(re.compile(r"(\d+)H"),
2169
datetime.timedelta(hours=1),
2170
frozenset((token_minute, token_end)))
2171
token_time = Token(re.compile(r"T"),
2173
frozenset((token_hour, token_minute,
2175
token_day = Token(re.compile(r"(\d+)D"),
2176
datetime.timedelta(days=1),
2177
frozenset((token_time, token_end)))
2178
token_month = Token(re.compile(r"(\d+)M"),
2179
datetime.timedelta(weeks=4),
2180
frozenset((token_day, token_end)))
2181
token_year = Token(re.compile(r"(\d+)Y"),
2182
datetime.timedelta(weeks=52),
2183
frozenset((token_month, token_end)))
2184
token_week = Token(re.compile(r"(\d+)W"),
2185
datetime.timedelta(weeks=1),
2186
frozenset((token_end,)))
2187
token_duration = Token(re.compile(r"P"), None,
2188
frozenset((token_year, token_month,
2189
token_day, token_time,
2191
# Define starting values
2192
value = datetime.timedelta() # Value so far
2194
followers = frozenset(token_duration,) # Following valid tokens
2195
s = duration # String left to parse
2196
# Loop until end token is found
2197
while found_token is not token_end:
2198
# Search for any currently valid tokens
2199
for token in followers:
2200
match = token.regexp.match(s)
2201
if match is not None:
2203
if token.value is not None:
2204
# Value found, parse digits
2205
factor = int(match.group(1), 10)
2206
# Add to value so far
2207
value += factor * token.value
2208
# Strip token from string
2209
s = token.regexp.sub("", s, 1)
2212
# Set valid next tokens
2213
followers = found_token.followers
2216
# No currently valid tokens were found
2217
raise ValueError("Invalid RFC 3339 duration")
2222
776
def string_to_delta(interval):
2223
777
"""Parse a string and return a datetime.timedelta
2225
779
>>> string_to_delta('7d')
2226
780
datetime.timedelta(7)
2227
781
>>> string_to_delta('60s')
2351
916
"debug": "False",
2353
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
918
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2354
919
"servicename": "Mandos",
2360
"statedir": "/var/lib/mandos",
2361
"foreground": "False",
2364
922
# Parse config file for server-global settings
2365
server_config = configparser.SafeConfigParser(server_defaults)
923
server_config = ConfigParser.SafeConfigParser(server_defaults)
2366
924
del server_defaults
2367
server_config.read(os.path.join(options.configdir,
925
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2369
926
# Convert the SafeConfigParser object to a dict
2370
927
server_settings = server_config.defaults()
2371
# Use the appropriate methods on the non-string config options
2372
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2373
server_settings[option] = server_config.getboolean("DEFAULT",
2375
if server_settings["port"]:
2376
server_settings["port"] = server_config.getint("DEFAULT",
2378
if server_settings["socket"]:
2379
server_settings["socket"] = server_config.getint("DEFAULT",
2381
# Later, stdin will, and stdout and stderr might, be dup'ed
2382
# over with an opened os.devnull. But we don't want this to
2383
# happen with a supplied network socket.
2384
if 0 <= server_settings["socket"] <= 2:
2385
server_settings["socket"] = os.dup(server_settings
928
# Use getboolean on the boolean config option
929
server_settings["debug"] = (server_config.getboolean
930
("DEFAULT", "debug"))
2387
931
del server_config
2389
933
# Override the settings from the config file with command line
2390
934
# options, if set.
2391
935
for option in ("interface", "address", "port", "debug",
2392
"priority", "servicename", "configdir",
2393
"use_dbus", "use_ipv6", "debuglevel", "restore",
2394
"statedir", "socket", "foreground"):
936
"priority", "servicename", "configdir"):
2395
937
value = getattr(options, option)
2396
938
if value is not None:
2397
939
server_settings[option] = value
2399
# Force all strings to be unicode
2400
for option in server_settings.keys():
2401
if type(server_settings[option]) is str:
2402
server_settings[option] = unicode(server_settings[option])
2403
# Force all boolean options to be boolean
2404
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2406
server_settings[option] = bool(server_settings[option])
2407
# Debug implies foreground
2408
if server_settings["debug"]:
2409
server_settings["foreground"] = True
2410
941
# Now we have our good server settings in "server_settings"
2412
##################################################################
2415
943
debug = server_settings["debug"]
2416
debuglevel = server_settings["debuglevel"]
2417
use_dbus = server_settings["use_dbus"]
2418
use_ipv6 = server_settings["use_ipv6"]
2419
stored_state_path = os.path.join(server_settings["statedir"],
2421
foreground = server_settings["foreground"]
2424
initlogger(debug, logging.DEBUG)
2429
level = getattr(logging, debuglevel.upper())
2430
initlogger(debug, level)
946
syslogger.setLevel(logging.WARNING)
947
console.setLevel(logging.WARNING)
2432
949
if server_settings["servicename"] != "Mandos":
2433
950
syslogger.setFormatter(logging.Formatter
2434
('Mandos ({0}) [%(process)d]:'
2435
' %(levelname)s: %(message)s'
2436
.format(server_settings
951
('Mandos (%s): %%(levelname)s:'
953
% server_settings["servicename"]))
2439
955
# Parse config file with clients
2440
client_config = configparser.SafeConfigParser(Client
956
client_defaults = { "timeout": "1h",
958
"checker": "fping -q -- %(host)s",
961
client_config = ConfigParser.SafeConfigParser(client_defaults)
2442
962
client_config.read(os.path.join(server_settings["configdir"],
2443
963
"clients.conf"))
2445
global mandos_dbus_service
2446
mandos_dbus_service = None
2448
tcp_server = MandosServer((server_settings["address"],
2449
server_settings["port"]),
2451
interface=(server_settings["interface"]
2455
server_settings["priority"],
2457
socketfd=(server_settings["socket"]
2460
pidfilename = "/run/mandos.pid"
2461
if not os.path.isdir("/run/."):
2462
pidfilename = "/var/run/mandos.pid"
2465
pidfile = open(pidfilename, "w")
2466
except IOError as e:
2467
logger.error("Could not open file %r", pidfilename,
2470
for name in ("_mandos", "mandos", "nobody"):
2472
uid = pwd.getpwnam(name).pw_uid
2473
gid = pwd.getpwnam(name).pw_gid
966
tcp_server = IPv6_TCPServer((server_settings["address"],
967
server_settings["port"]),
969
settings=server_settings,
971
pidfilename = "/var/run/mandos.pid"
973
pidfile = open(pidfilename, "w")
974
except IOError, error:
975
logger.error("Could not open file %r", pidfilename)
978
uid = pwd.getpwnam("_mandos").pw_uid
981
uid = pwd.getpwnam("mandos").pw_uid
984
uid = pwd.getpwnam("nobody").pw_uid
988
gid = pwd.getpwnam("_mandos").pw_gid
991
gid = pwd.getpwnam("mandos").pw_gid
994
gid = pwd.getpwnam("nogroup").pw_gid
2483
except OSError as error:
2484
if error.errno != errno.EPERM:
2488
# Enable all possible GnuTLS debugging
2490
# "Use a log level over 10 to enable all debugging options."
2492
gnutls.library.functions.gnutls_global_set_log_level(11)
2494
@gnutls.library.types.gnutls_log_func
2495
def debug_gnutls(level, string):
2496
logger.debug("GnuTLS: %s", string[:-1])
2498
(gnutls.library.functions
2499
.gnutls_global_set_log_function(debug_gnutls))
2501
# Redirect stdin so all checkers get /dev/null
2502
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2503
os.dup2(null, sys.stdin.fileno())
2507
# Need to fork before connecting to D-Bus
2509
# Close all input and output, do double fork, etc.
2512
# multiprocessing will use threads, so before we use gobject we
2513
# need to inform gobject that threads will be used.
2514
gobject.threads_init()
1000
except OSError, error:
1001
if error[0] != errno.EPERM:
1005
service = AvahiService(name = server_settings["servicename"],
1006
servicetype = "_mandos._tcp", )
1007
if server_settings["interface"]:
1008
service.interface = (if_nametoindex
1009
(server_settings["interface"]))
2516
1011
global main_loop
2517
1014
# From the Avahi example code
2518
DBusGMainLoop(set_as_default=True)
1015
DBusGMainLoop(set_as_default=True )
2519
1016
main_loop = gobject.MainLoop()
2520
1017
bus = dbus.SystemBus()
1018
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1019
avahi.DBUS_PATH_SERVER),
1020
avahi.DBUS_INTERFACE_SERVER)
2521
1021
# End of Avahi example code
2524
bus_name = dbus.service.BusName("se.recompile.Mandos",
2525
bus, do_not_queue=True)
2526
old_bus_name = (dbus.service.BusName
2527
("se.bsnet.fukt.Mandos", bus,
2529
except dbus.exceptions.NameExistsException as e:
2530
logger.error("Disabling D-Bus:", exc_info=e)
2532
server_settings["use_dbus"] = False
2533
tcp_server.use_dbus = False
2534
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2535
service = AvahiServiceToSyslog(name =
2536
server_settings["servicename"],
2537
servicetype = "_mandos._tcp",
2538
protocol = protocol, bus = bus)
2539
if server_settings["interface"]:
2540
service.interface = (if_nametoindex
2541
(str(server_settings["interface"])))
2543
global multiprocessing_manager
2544
multiprocessing_manager = multiprocessing.Manager()
2546
client_class = Client
2548
client_class = functools.partial(ClientDBus, bus = bus)
2550
client_settings = Client.config_parser(client_config)
2551
old_client_settings = {}
2554
# This is used to redirect stdout and stderr for checker processes
2556
wnull = open(os.devnull, "w") # A writable /dev/null
2557
# Only used if server is running in foreground but not in debug
2559
if debug or not foreground:
2562
# Get client data and settings from last running state.
2563
if server_settings["restore"]:
2565
with open(stored_state_path, "rb") as stored_state:
2566
clients_data, old_client_settings = (pickle.load
2568
os.remove(stored_state_path)
2569
except IOError as e:
2570
if e.errno == errno.ENOENT:
2571
logger.warning("Could not load persistent state: {0}"
2572
.format(os.strerror(e.errno)))
2574
logger.critical("Could not load persistent state:",
2577
except EOFError as e:
2578
logger.warning("Could not load persistent state: "
2579
"EOFError:", exc_info=e)
2581
with PGPEngine() as pgp:
2582
for client_name, client in clients_data.iteritems():
2583
# Skip removed clients
2584
if client_name not in client_settings:
2587
# Decide which value to use after restoring saved state.
2588
# We have three different values: Old config file,
2589
# new config file, and saved state.
2590
# New config value takes precedence if it differs from old
2591
# config value, otherwise use saved state.
2592
for name, value in client_settings[client_name].items():
2594
# For each value in new config, check if it
2595
# differs from the old config value (Except for
2596
# the "secret" attribute)
2597
if (name != "secret" and
2598
value != old_client_settings[client_name]
2600
client[name] = value
2604
# Clients who has passed its expire date can still be
2605
# enabled if its last checker was successful. Clients
2606
# whose checker succeeded before we stored its state is
2607
# assumed to have successfully run all checkers during
2609
if client["enabled"]:
2610
if datetime.datetime.utcnow() >= client["expires"]:
2611
if not client["last_checked_ok"]:
2613
"disabling client {0} - Client never "
2614
"performed a successful checker"
2615
.format(client_name))
2616
client["enabled"] = False
2617
elif client["last_checker_status"] != 0:
2619
"disabling client {0} - Client "
2620
"last checker failed with error code {1}"
2621
.format(client_name,
2622
client["last_checker_status"]))
2623
client["enabled"] = False
2625
client["expires"] = (datetime.datetime
2627
+ client["timeout"])
2628
logger.debug("Last checker succeeded,"
2629
" keeping {0} enabled"
2630
.format(client_name))
2632
client["secret"] = (
2633
pgp.decrypt(client["encrypted_secret"],
2634
client_settings[client_name]
2637
# If decryption fails, we use secret from new settings
2638
logger.debug("Failed to decrypt {0} old secret"
2639
.format(client_name))
2640
client["secret"] = (
2641
client_settings[client_name]["secret"])
2643
# Add/remove clients based on new changes made to config
2644
for client_name in (set(old_client_settings)
2645
- set(client_settings)):
2646
del clients_data[client_name]
2647
for client_name in (set(client_settings)
2648
- set(old_client_settings)):
2649
clients_data[client_name] = client_settings[client_name]
2651
# Create all client objects
2652
for client_name, client in clients_data.iteritems():
2653
tcp_server.clients[client_name] = client_class(
2654
name = client_name, settings = client,
2655
server_settings = server_settings)
2657
if not tcp_server.clients:
2658
logger.warning("No clients defined")
2661
if pidfile is not None:
2665
pidfile.write(str(pid) + "\n".encode("utf-8"))
2667
logger.error("Could not write to file %r with PID %d",
1022
bus_name = dbus.service.BusName(u"org.mandos-system.Mandos", bus)
1024
clients.update(Set(Client(name = section,
1026
= dict(client_config.items(section)))
1027
for section in client_config.sections()))
1029
logger.critical(u"No clients defined")
1033
# Redirect stdin so all checkers get /dev/null
1034
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1035
os.dup2(null, sys.stdin.fileno())
1039
# No console logging
1040
logger.removeHandler(console)
1041
# Close all input and output, do double fork, etc.
1046
pidfile.write(str(pid) + "\n")
2672
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2673
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2676
@alternate_dbus_interfaces({"se.recompile.Mandos":
2677
"se.bsnet.fukt.Mandos"})
2678
class MandosDBusService(DBusObjectWithProperties):
2679
"""A D-Bus proxy object"""
2681
dbus.service.Object.__init__(self, bus, "/")
2682
_interface = "se.recompile.Mandos"
2684
@dbus_interface_annotations(_interface)
2686
return { "org.freedesktop.DBus.Property"
2687
".EmitsChangedSignal":
2690
@dbus.service.signal(_interface, signature="o")
2691
def ClientAdded(self, objpath):
2695
@dbus.service.signal(_interface, signature="ss")
2696
def ClientNotFound(self, fingerprint, address):
2700
@dbus.service.signal(_interface, signature="os")
2701
def ClientRemoved(self, objpath, name):
2705
@dbus.service.method(_interface, out_signature="ao")
2706
def GetAllClients(self):
2708
return dbus.Array(c.dbus_object_path
2710
tcp_server.clients.itervalues())
2712
@dbus.service.method(_interface,
2713
out_signature="a{oa{sv}}")
2714
def GetAllClientsWithProperties(self):
2716
return dbus.Dictionary(
2717
((c.dbus_object_path, c.GetAll(""))
2718
for c in tcp_server.clients.itervalues()),
2721
@dbus.service.method(_interface, in_signature="o")
2722
def RemoveClient(self, object_path):
2724
for c in tcp_server.clients.itervalues():
2725
if c.dbus_object_path == object_path:
2726
del tcp_server.clients[c.name]
2727
c.remove_from_connection()
2728
# Don't signal anything except ClientRemoved
2729
c.disable(quiet=True)
2731
self.ClientRemoved(object_path, c.name)
2733
raise KeyError(object_path)
2737
mandos_dbus_service = MandosDBusService()
1050
logger.error(u"Could not write to file %r with PID %d",
1053
# "pidfile" was never created
2740
1058
"Cleanup function; run on exit"
2743
multiprocessing.active_children()
2745
if not (tcp_server.clients or client_settings):
2748
# Store client before exiting. Secrets are encrypted with key
2749
# based on what config file has. If config file is
2750
# removed/edited, old secret will thus be unrecovable.
2752
with PGPEngine() as pgp:
2753
for client in tcp_server.clients.itervalues():
2754
key = client_settings[client.name]["secret"]
2755
client.encrypted_secret = pgp.encrypt(client.secret,
2759
# A list of attributes that can not be pickled
2761
exclude = set(("bus", "changedstate", "secret",
2762
"checker", "server_settings"))
2763
for name, typ in (inspect.getmembers
2764
(dbus.service.Object)):
2767
client_dict["encrypted_secret"] = (client
2769
for attr in client.client_structure:
2770
if attr not in exclude:
2771
client_dict[attr] = getattr(client, attr)
2773
clients[client.name] = client_dict
2774
del client_settings[client.name]["secret"]
2777
with (tempfile.NamedTemporaryFile
2778
(mode='wb', suffix=".pickle", prefix='clients-',
2779
dir=os.path.dirname(stored_state_path),
2780
delete=False)) as stored_state:
2781
pickle.dump((clients, client_settings), stored_state)
2782
tempname=stored_state.name
2783
os.rename(tempname, stored_state_path)
2784
except (IOError, OSError) as e:
2790
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2791
logger.warning("Could not save persistent state: {0}"
2792
.format(os.strerror(e.errno)))
2794
logger.warning("Could not save persistent state:",
2798
# Delete all clients, and settings from config
2799
while tcp_server.clients:
2800
name, client = tcp_server.clients.popitem()
2802
client.remove_from_connection()
2803
# Don't signal anything except ClientRemoved
2804
client.disable(quiet=True)
2807
mandos_dbus_service.ClientRemoved(client
2810
client_settings.clear()
1060
# From the Avahi example code
1061
if not group is None:
1064
# End of Avahi example code
1067
client = clients.pop()
1068
client.disable_hook = None
2812
1071
atexit.register(cleanup)
2814
for client in tcp_server.clients.itervalues():
2817
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2818
# Need to initiate checking of clients
2820
client.init_checker()
1074
signal.signal(signal.SIGINT, signal.SIG_IGN)
1075
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1076
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1078
class MandosServer(dbus.service.Object):
1079
"""A D-Bus proxy object"""
1081
dbus.service.Object.__init__(self, bus,
1083
_interface = u"org.mandos_system.Mandos"
1085
@dbus.service.signal(_interface, signature="oa{sv}")
1086
def ClientAdded(self, objpath, properties):
1090
@dbus.service.signal(_interface, signature="o")
1091
def ClientRemoved(self, objpath):
1095
@dbus.service.method(_interface, out_signature="ao")
1096
def GetAllClients(self):
1097
return dbus.Array(c.dbus_object_path for c in clients)
1099
@dbus.service.method(_interface, out_signature="a{oa{sv}}")
1100
def GetAllClientsWithProperties(self):
1101
return dbus.Dictionary(
1102
((c.dbus_object_path, c.GetAllProperties())
1106
@dbus.service.method(_interface, in_signature="o")
1107
def RemoveClient(self, object_path):
1109
if c.dbus_object_path == object_path:
1117
mandos_server = MandosServer()
1119
for client in clients:
1121
mandos_server.ClientAdded(client.dbus_object_path,
1122
client.GetAllProperties())
2822
1125
tcp_server.enable()
2823
1126
tcp_server.server_activate()
2825
1128
# Find out what port we got
2826
1129
service.port = tcp_server.socket.getsockname()[1]
2828
logger.info("Now listening on address %r, port %d,"
2829
" flowinfo %d, scope_id %d",
2830
*tcp_server.socket.getsockname())
2832
logger.info("Now listening on address %r, port %d",
2833
*tcp_server.socket.getsockname())
1130
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
1131
u" scope_id %d" % tcp_server.socket.getsockname())
2835
1133
#service.interface = tcp_server.socket.getsockname()[3]
2838
1136
# From the Avahi example code
1137
server.connect_to_signal("StateChanged", server_state_changed)
2841
except dbus.exceptions.DBusException as error:
2842
logger.critical("D-Bus Exception", exc_info=error)
1139
server_state_changed(server.GetState())
1140
except dbus.exceptions.DBusException, error:
1141
logger.critical(u"DBusException: %s", error)
2845
1143
# End of Avahi example code