265
104
max_renames: integer; maximum number of renames
266
105
rename_count: integer; counter so we only rename after collisions
267
106
a sensible number of times
268
group: D-Bus Entry Group
270
bus: dbus.SystemBus()
274
interface = avahi.IF_UNSPEC,
282
protocol = avahi.PROTO_UNSPEC,
108
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
109
type = None, port = None, TXT = None, domain = "",
110
host = "", max_renames = 32768):
284
111
self.interface = interface
286
self.type = servicetype
288
self.TXT = TXT if TXT is not None else []
289
119
self.domain = domain
291
121
self.rename_count = 0
292
122
self.max_renames = max_renames
293
self.protocol = protocol
294
self.group = None # our entry group
297
self.entry_group_state_changed_match = None
299
def rename(self, remove=True):
300
124
"""Derived from the Avahi example code"""
301
125
if self.rename_count >= self.max_renames:
302
logger.critical("No suitable Zeroconf service name found"
303
" after %i retries, exiting.",
126
logger.critical(u"No suitable service name found after %i"
127
u" retries, exiting.", rename_count)
305
128
raise AvahiServiceError("Too many renames")
307
self.server.GetAlternativeServiceName(self.name))
129
self.name = server.GetAlternativeServiceName(self.name)
130
logger.info(u"Changing name to %r ...", str(self.name))
131
syslogger.setFormatter(logging.Formatter\
132
('Mandos (%s): %%(levelname)s:'
133
' %%(message)s' % self.name))
308
136
self.rename_count += 1
309
logger.info("Changing Zeroconf service name to %r ...",
315
except dbus.exceptions.DBusException as error:
316
if (error.get_dbus_name()
317
== "org.freedesktop.Avahi.CollisionError"):
318
logger.info("Local Zeroconf service name collision.")
319
return self.rename(remove=False)
321
logger.critical("D-Bus Exception", exc_info=error)
325
137
def remove(self):
326
138
"""Derived from the Avahi example code"""
327
if self.entry_group_state_changed_match is not None:
328
self.entry_group_state_changed_match.remove()
329
self.entry_group_state_changed_match = None
330
if self.group is not None:
139
if group is not None:
334
142
"""Derived from the Avahi example code"""
336
if self.group is None:
337
self.group = dbus.Interface(
338
self.bus.get_object(avahi.DBUS_NAME,
339
self.server.EntryGroupNew()),
340
avahi.DBUS_INTERFACE_ENTRY_GROUP)
341
self.entry_group_state_changed_match = (
342
self.group.connect_to_signal(
343
'StateChanged', self.entry_group_state_changed))
344
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
345
self.name, self.type)
346
self.group.AddService(
349
dbus.UInt32(0), # flags
350
self.name, self.type,
351
self.domain, self.host,
352
dbus.UInt16(self.port),
353
avahi.string_array_to_txt_array(self.TXT))
356
def entry_group_state_changed(self, state, error):
357
"""Derived from the Avahi example code"""
358
logger.debug("Avahi entry group state change: %i", state)
360
if state == avahi.ENTRY_GROUP_ESTABLISHED:
361
logger.debug("Zeroconf service established.")
362
elif state == avahi.ENTRY_GROUP_COLLISION:
363
logger.info("Zeroconf service name collision.")
365
elif state == avahi.ENTRY_GROUP_FAILURE:
366
logger.critical("Avahi: Error in group state changed %s",
368
raise AvahiGroupError("State changed: {!s}".format(error))
371
"""Derived from the Avahi example code"""
372
if self.group is not None:
375
except (dbus.exceptions.UnknownMethodException,
376
dbus.exceptions.DBusException):
381
def server_state_changed(self, state, error=None):
382
"""Derived from the Avahi example code"""
383
logger.debug("Avahi server state change: %i", state)
385
avahi.SERVER_INVALID: "Zeroconf server invalid",
386
avahi.SERVER_REGISTERING: None,
387
avahi.SERVER_COLLISION: "Zeroconf server name collision",
388
avahi.SERVER_FAILURE: "Zeroconf server failure",
390
if state in bad_states:
391
if bad_states[state] is not None:
393
logger.error(bad_states[state])
395
logger.error(bad_states[state] + ": %r", error)
397
elif state == avahi.SERVER_RUNNING:
400
except dbus.exceptions.DBusException as error:
401
if (error.get_dbus_name()
402
== "org.freedesktop.Avahi.CollisionError"):
403
logger.info("Local Zeroconf service name"
405
return self.rename(remove=False)
407
logger.critical("D-Bus Exception", exc_info=error)
412
logger.debug("Unknown state: %r", state)
414
logger.debug("Unknown state: %r: %r", state, error)
417
"""Derived from the Avahi example code"""
418
if self.server is None:
419
self.server = dbus.Interface(
420
self.bus.get_object(avahi.DBUS_NAME,
421
avahi.DBUS_PATH_SERVER,
422
follow_name_owner_changes=True),
423
avahi.DBUS_INTERFACE_SERVER)
424
self.server.connect_to_signal("StateChanged",
425
self.server_state_changed)
426
self.server_state_changed(self.server.GetState())
429
class AvahiServiceToSyslog(AvahiService):
430
def rename(self, *args, **kwargs):
431
"""Add the new name to the syslog messages"""
432
ret = AvahiService.rename(self, *args, **kwargs)
433
syslogger.setFormatter(logging.Formatter(
434
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
438
def call_pipe(connection, # : multiprocessing.Connection
439
func, *args, **kwargs):
440
"""This function is meant to be called by multiprocessing.Process
442
This function runs func(*args, **kwargs), and writes the resulting
443
return value on the provided multiprocessing.Connection.
445
connection.send(func(*args, **kwargs))
145
group = dbus.Interface\
146
(bus.get_object(avahi.DBUS_NAME,
147
server.EntryGroupNew()),
148
avahi.DBUS_INTERFACE_ENTRY_GROUP)
149
group.connect_to_signal('StateChanged',
150
entry_group_state_changed)
151
logger.debug(u"Adding service '%s' of type '%s' ...",
152
service.name, service.type)
154
self.interface, # interface
155
avahi.PROTO_INET6, # protocol
156
dbus.UInt32(0), # flags
157
self.name, self.type,
158
self.domain, self.host,
159
dbus.UInt16(self.port),
160
avahi.string_array_to_txt_array(self.TXT))
163
# From the Avahi example code:
164
group = None # our entry group
165
# End of Avahi example code
448
168
class Client(object):
449
169
"""A representation of a client host served by this server.
452
approved: bool(); 'None' if not yet approved/disapproved
453
approval_delay: datetime.timedelta(); Time to wait for approval
454
approval_duration: datetime.timedelta(); Duration of one approval
455
checker: subprocess.Popen(); a running checker process used
456
to see if the client lives.
457
'None' if no process is running.
458
checker_callback_tag: a gobject event source tag, or None
459
checker_command: string; External command which is run to check
460
if client lives. %() expansions are done at
171
name: string; from the config file, used in log messages
172
fingerprint: string (40 or 32 hexadecimal digits); used to
173
uniquely identify the client
174
secret: bytestring; sent verbatim (over TLS) to client
175
host: string; available for use by the checker command
176
created: datetime.datetime(); object creation, not client host
177
last_checked_ok: datetime.datetime() or None if not yet checked OK
178
timeout: datetime.timedelta(); How long from last_checked_ok
179
until this client is invalid
180
interval: datetime.timedelta(); How often to start a new checker
181
stop_hook: If set, called by stop() as stop_hook(self)
182
checker: subprocess.Popen(); a running checker process used
183
to see if the client lives.
184
'None' if no process is running.
185
checker_initiator_tag: a gobject event source tag, or None
186
stop_initiator_tag: - '' -
187
checker_callback_tag: - '' -
188
checker_command: string; External command which is run to check if
189
client lives. %() expansions are done at
461
190
runtime with vars(self) as dict, so that for
462
191
instance %(name)s can be used in the command.
463
checker_initiator_tag: a gobject event source tag, or None
464
created: datetime.datetime(); (UTC) object creation
465
client_structure: Object describing what attributes a client has
466
and is used for storing the client at exit
467
current_checker_command: string; current running checker_command
468
disable_initiator_tag: a gobject event source tag, or None
470
fingerprint: string (40 or 32 hexadecimal digits); used to
471
uniquely identify the client
472
host: string; available for use by the checker command
473
interval: datetime.timedelta(); How often to start a new checker
474
last_approval_request: datetime.datetime(); (UTC) or None
475
last_checked_ok: datetime.datetime(); (UTC) or None
476
last_checker_status: integer between 0 and 255 reflecting exit
477
status of last checker. -1 reflects crashed
478
checker, -2 means no checker completed yet.
479
last_checker_signal: The signal which killed the last checker, if
480
last_checker_status is -1
481
last_enabled: datetime.datetime(); (UTC) or None
482
name: string; from the config file, used in log messages and
484
secret: bytestring; sent verbatim (over TLS) to client
485
timeout: datetime.timedelta(); How long from last_checked_ok
486
until this client is disabled
487
extended_timeout: extra long timeout when secret has been sent
488
runtime_expansions: Allowed attributes for runtime expansion.
489
expires: datetime.datetime(); time (UTC) when a client will be
491
server_settings: The server_settings dict from main()
193
_timeout: Real variable for 'timeout'
194
_interval: Real variable for 'interval'
195
_timeout_milliseconds: Used when calling gobject.timeout_add()
196
_interval_milliseconds: - '' -
494
runtime_expansions = ("approval_delay", "approval_duration",
495
"created", "enabled", "expires",
496
"fingerprint", "host", "interval",
497
"last_approval_request", "last_checked_ok",
498
"last_enabled", "name", "timeout")
501
"extended_timeout": "PT15M",
503
"checker": "fping -q -- %%(host)s",
505
"approval_delay": "PT0S",
506
"approval_duration": "PT1S",
507
"approved_by_default": "True",
512
def config_parser(config):
513
"""Construct a new dict of client settings of this form:
514
{ client_name: {setting_name: value, ...}, ...}
515
with exceptions for any special settings as defined above.
516
NOTE: Must be a pure function. Must return the same result
517
value given the same arguments.
520
for client_name in config.sections():
521
section = dict(config.items(client_name))
522
client = settings[client_name] = {}
524
client["host"] = section["host"]
525
# Reformat values from string types to Python types
526
client["approved_by_default"] = config.getboolean(
527
client_name, "approved_by_default")
528
client["enabled"] = config.getboolean(client_name,
531
# Uppercase and remove spaces from fingerprint for later
532
# comparison purposes with return value from the
533
# fingerprint() function
534
client["fingerprint"] = (section["fingerprint"].upper()
536
if "secret" in section:
537
client["secret"] = section["secret"].decode("base64")
538
elif "secfile" in section:
539
with open(os.path.expanduser(os.path.expandvars
540
(section["secfile"])),
542
client["secret"] = secfile.read()
544
raise TypeError("No secret or secfile for section {}"
546
client["timeout"] = string_to_delta(section["timeout"])
547
client["extended_timeout"] = string_to_delta(
548
section["extended_timeout"])
549
client["interval"] = string_to_delta(section["interval"])
550
client["approval_delay"] = string_to_delta(
551
section["approval_delay"])
552
client["approval_duration"] = string_to_delta(
553
section["approval_duration"])
554
client["checker_command"] = section["checker"]
555
client["last_approval_request"] = None
556
client["last_checked_ok"] = None
557
client["last_checker_status"] = -2
561
def __init__(self, settings, name = None, server_settings=None):
198
def _set_timeout(self, timeout):
199
"Setter function for 'timeout' attribute"
200
self._timeout = timeout
201
self._timeout_milliseconds = ((self.timeout.days
202
* 24 * 60 * 60 * 1000)
203
+ (self.timeout.seconds * 1000)
204
+ (self.timeout.microseconds
206
timeout = property(lambda self: self._timeout,
209
def _set_interval(self, interval):
210
"Setter function for 'interval' attribute"
211
self._interval = interval
212
self._interval_milliseconds = ((self.interval.days
213
* 24 * 60 * 60 * 1000)
214
+ (self.interval.seconds
216
+ (self.interval.microseconds
218
interval = property(lambda self: self._interval,
221
def __init__(self, name = None, stop_hook=None, config={}):
222
"""Note: the 'checker' key in 'config' sets the
223
'checker_command' attribute and *not* the 'checker'
563
if server_settings is None:
565
self.server_settings = server_settings
566
# adding all client settings
567
for setting, value in settings.items():
568
setattr(self, setting, value)
571
if not hasattr(self, "last_enabled"):
572
self.last_enabled = datetime.datetime.utcnow()
573
if not hasattr(self, "expires"):
574
self.expires = (datetime.datetime.utcnow()
226
logger.debug(u"Creating client %r", self.name)
227
# Uppercase and remove spaces from fingerprint for later
228
# comparison purposes with return value from the fingerprint()
230
self.fingerprint = config["fingerprint"].upper()\
232
logger.debug(u" Fingerprint: %s", self.fingerprint)
233
if "secret" in config:
234
self.secret = config["secret"].decode(u"base64")
235
elif "secfile" in config:
236
sf = open(config["secfile"])
237
self.secret = sf.read()
577
self.last_enabled = None
580
logger.debug("Creating client %r", self.name)
581
logger.debug(" Fingerprint: %s", self.fingerprint)
582
self.created = settings.get("created",
583
datetime.datetime.utcnow())
585
# attributes specific for this server instance
240
raise TypeError(u"No secret or secfile for client %s"
242
self.host = config.get("host", "")
243
self.created = datetime.datetime.now()
244
self.last_checked_ok = None
245
self.timeout = string_to_delta(config["timeout"])
246
self.interval = string_to_delta(config["interval"])
247
self.stop_hook = stop_hook
586
248
self.checker = None
587
249
self.checker_initiator_tag = None
588
self.disable_initiator_tag = None
250
self.stop_initiator_tag = None
589
251
self.checker_callback_tag = None
590
self.current_checker_command = None
592
self.approvals_pending = 0
593
self.changedstate = multiprocessing_manager.Condition(
594
multiprocessing_manager.Lock())
595
self.client_structure = [attr
596
for attr in self.__dict__.iterkeys()
597
if not attr.startswith("_")]
598
self.client_structure.append("client_structure")
600
for name, t in inspect.getmembers(
601
type(self), lambda obj: isinstance(obj, property)):
602
if not name.startswith("_"):
603
self.client_structure.append(name)
605
# Send notice to process children that client state has changed
606
def send_changedstate(self):
607
with self.changedstate:
608
self.changedstate.notify_all()
252
self.check_command = config["checker"]
611
254
"""Start this client's checker and timeout hooks"""
612
if getattr(self, "enabled", False):
615
self.expires = datetime.datetime.utcnow() + self.timeout
617
self.last_enabled = datetime.datetime.utcnow()
619
self.send_changedstate()
621
def disable(self, quiet=True):
622
"""Disable this client."""
623
if not getattr(self, "enabled", False):
626
logger.info("Disabling client %s", self.name)
627
if getattr(self, "disable_initiator_tag", None) is not None:
628
gobject.source_remove(self.disable_initiator_tag)
629
self.disable_initiator_tag = None
631
if getattr(self, "checker_initiator_tag", None) is not None:
632
gobject.source_remove(self.checker_initiator_tag)
633
self.checker_initiator_tag = None
637
self.send_changedstate()
638
# Do not run this again if called by a gobject.timeout_add
644
def init_checker(self):
645
255
# Schedule a new checker to be started an 'interval' from now,
646
256
# and every interval from then on.
647
if self.checker_initiator_tag is not None:
648
gobject.source_remove(self.checker_initiator_tag)
649
self.checker_initiator_tag = gobject.timeout_add(
650
int(self.interval.total_seconds() * 1000),
652
# Schedule a disable() when 'timeout' has passed
653
if self.disable_initiator_tag is not None:
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = gobject.timeout_add(
656
int(self.timeout.total_seconds() * 1000), self.disable)
257
self.checker_initiator_tag = gobject.timeout_add\
258
(self._interval_milliseconds,
657
260
# Also start a new checker *right now*.
658
261
self.start_checker()
660
def checker_callback(self, source, condition, connection,
262
# Schedule a stop() when 'timeout' has passed
263
self.stop_initiator_tag = gobject.timeout_add\
264
(self._timeout_milliseconds,
268
The possibility that a client might be restarted is left open,
269
but not currently used."""
270
# If this client doesn't have a secret, it is already stopped.
271
if hasattr(self, "secret") and self.secret:
272
logger.info(u"Stopping client %s", self.name)
276
if getattr(self, "stop_initiator_tag", False):
277
gobject.source_remove(self.stop_initiator_tag)
278
self.stop_initiator_tag = None
279
if getattr(self, "checker_initiator_tag", False):
280
gobject.source_remove(self.checker_initiator_tag)
281
self.checker_initiator_tag = None
285
# Do not run this again if called by a gobject.timeout_add
288
self.stop_hook = None
290
def checker_callback(self, pid, condition):
662
291
"""The checker has completed, so take appropriate actions."""
292
now = datetime.datetime.now()
663
293
self.checker_callback_tag = None
664
294
self.checker = None
665
# Read return code from connection (see call_pipe)
666
returncode = connection.recv()
670
self.last_checker_status = returncode
671
self.last_checker_signal = None
672
if self.last_checker_status == 0:
673
logger.info("Checker for %(name)s succeeded",
677
logger.info("Checker for %(name)s failed", vars(self))
679
self.last_checker_status = -1
680
self.last_checker_signal = -returncode
681
logger.warning("Checker for %(name)s crashed?",
295
if os.WIFEXITED(condition) \
296
and (os.WEXITSTATUS(condition) == 0):
297
logger.info(u"Checker for %(name)s succeeded",
299
self.last_checked_ok = now
300
gobject.source_remove(self.stop_initiator_tag)
301
self.stop_initiator_tag = gobject.timeout_add\
302
(self._timeout_milliseconds,
304
elif not os.WIFEXITED(condition):
305
logger.warning(u"Checker for %(name)s crashed?",
685
def checked_ok(self):
686
"""Assert that the client has been seen, alive and well."""
687
self.last_checked_ok = datetime.datetime.utcnow()
688
self.last_checker_status = 0
689
self.last_checker_signal = None
692
def bump_timeout(self, timeout=None):
693
"""Bump up the timeout for this client."""
695
timeout = self.timeout
696
if self.disable_initiator_tag is not None:
697
gobject.source_remove(self.disable_initiator_tag)
698
self.disable_initiator_tag = None
699
if getattr(self, "enabled", False):
700
self.disable_initiator_tag = gobject.timeout_add(
701
int(timeout.total_seconds() * 1000), self.disable)
702
self.expires = datetime.datetime.utcnow() + timeout
704
def need_approval(self):
705
self.last_approval_request = datetime.datetime.utcnow()
308
logger.info(u"Checker for %(name)s failed",
707
310
def start_checker(self):
708
311
"""Start a new checker subprocess if one is not running.
710
312
If a checker already exists, leave it running and do
712
314
# The reason for not killing a running checker is that if we
713
# did that, and if a checker (for some reason) started running
714
# slowly and taking more than 'interval' time, then the client
715
# would inevitably timeout, since no checker would get a
716
# chance to run to completion. If we instead leave running
315
# did that, then if a checker (for some reason) started
316
# running slowly and taking more than 'interval' time, the
317
# client would inevitably timeout, since no checker would get
318
# a chance to run to completion. If we instead leave running
717
319
# checkers alone, the checker would have to take more time
718
# than 'timeout' for the client to be disabled, which is as it
721
if self.checker is not None and not self.checker.is_alive():
722
logger.warning("Checker was not alive; joining")
725
# Start a new checker if needed
320
# than 'timeout' for the client to be declared invalid, which
321
# is as it should be.
726
322
if self.checker is None:
727
# Escape attributes for the shell
729
attr: re.escape(str(getattr(self, attr)))
730
for attr in self.runtime_expansions }
732
command = self.checker_command % escaped_attrs
733
except TypeError as error:
734
logger.error('Could not format string "%s"',
735
self.checker_command,
737
return True # Try again later
738
self.current_checker_command = command
739
logger.info("Starting checker %r for %s", command,
741
# We don't need to redirect stdout and stderr, since
742
# in normal mode, that is already done by daemon(),
743
# and in debug mode we don't want to. (Stdin is
744
# always replaced by /dev/null.)
745
# The exception is when not debugging but nevertheless
746
# running in the foreground; use the previously
748
popen_args = { "close_fds": True,
751
if (not self.server_settings["debug"]
752
and self.server_settings["foreground"]):
753
popen_args.update({"stdout": wnull,
755
pipe = multiprocessing.Pipe(duplex = False)
756
self.checker = multiprocessing.Process(
758
args = (pipe[1], subprocess.call, command),
761
self.checker_callback_tag = gobject.io_add_watch(
762
pipe[0].fileno(), gobject.IO_IN,
763
self.checker_callback, pipe[0], command)
324
# In case check_command has exactly one % operator
325
command = self.check_command % self.host
327
# Escape attributes for the shell
328
escaped_attrs = dict((key, re.escape(str(val)))
330
vars(self).iteritems())
332
command = self.check_command % escaped_attrs
333
except TypeError, error:
334
logger.error(u'Could not format string "%s":'
335
u' %s', self.check_command, error)
336
return True # Try again later
338
logger.info(u"Starting checker %r for %s",
340
# We don't need to redirect stdout and stderr, since
341
# in normal mode, that is already done by daemon(),
342
# and in debug mode we don't want to. (Stdin is
343
# always replaced by /dev/null.)
344
self.checker = subprocess.Popen(command,
347
self.checker_callback_tag = gobject.child_watch_add\
349
self.checker_callback)
350
except OSError, error:
351
logger.error(u"Failed to start subprocess: %s",
764
353
# Re-run this periodically if run by gobject.timeout_add
767
355
def stop_checker(self):
768
356
"""Force the checker process, if any, to stop."""
769
357
if self.checker_callback_tag:
771
359
self.checker_callback_tag = None
772
360
if getattr(self, "checker", None) is None:
774
logger.debug("Stopping checker for %(name)s", vars(self))
775
self.checker.terminate()
362
logger.debug(u"Stopping checker for %(name)s", vars(self))
364
os.kill(self.checker.pid, signal.SIGTERM)
366
#if self.checker.poll() is None:
367
# os.kill(self.checker.pid, signal.SIGKILL)
368
except OSError, error:
369
if error.errno != errno.ESRCH: # No such process
776
371
self.checker = None
779
def dbus_service_property(dbus_interface,
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 {!r}".format(signature))
800
func._dbus_is_property = True
801
func._dbus_interface = dbus_interface
802
func._dbus_signature = signature
803
func._dbus_access = access
804
func._dbus_name = func.__name__
805
if func._dbus_name.endswith("_dbus_property"):
806
func._dbus_name = func._dbus_name[:-14]
807
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
813
def dbus_interface_annotations(dbus_interface):
814
"""Decorator for marking functions returning interface annotations
818
@dbus_interface_annotations("org.example.Interface")
819
def _foo(self): # Function name does not matter
820
return {"org.freedesktop.DBus.Deprecated": "true",
821
"org.freedesktop.DBus.Property.EmitsChangedSignal":
826
func._dbus_is_interface = True
827
func._dbus_interface = dbus_interface
828
func._dbus_name = dbus_interface
834
def dbus_annotations(annotations):
835
"""Decorator to annotate D-Bus methods, signals or properties
838
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
839
"org.freedesktop.DBus.Property."
840
"EmitsChangedSignal": "false"})
841
@dbus_service_property("org.example.Interface", signature="b",
843
def Property_dbus_property(self):
844
return dbus.Boolean(False)
846
See also the DBusObjectWithAnnotations class.
850
func._dbus_annotations = annotations
856
class DBusPropertyException(dbus.exceptions.DBusException):
857
"""A base class for D-Bus property-related exceptions
862
class DBusPropertyAccessException(DBusPropertyException):
863
"""A property's access permissions disallows an operation.
868
class DBusPropertyNotFound(DBusPropertyException):
869
"""An attempt was made to access a non-existing property.
874
class DBusObjectWithAnnotations(dbus.service.Object):
875
"""A D-Bus object with annotations.
877
Classes inheriting from this can use the dbus_annotations
878
decorator to add annotations to methods or signals.
882
def _is_dbus_thing(thing):
883
"""Returns a function testing if an attribute is a D-Bus thing
885
If called like _is_dbus_thing("method") it returns a function
886
suitable for use as predicate to inspect.getmembers().
888
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
891
def _get_all_dbus_things(self, thing):
892
"""Returns a generator of (name, attribute) pairs
894
return ((getattr(athing.__get__(self), "_dbus_name", name),
895
athing.__get__(self))
896
for cls in self.__class__.__mro__
898
inspect.getmembers(cls, self._is_dbus_thing(thing)))
900
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
902
path_keyword = 'object_path',
903
connection_keyword = 'connection')
904
def Introspect(self, object_path, connection):
905
"""Overloading of standard D-Bus method.
907
Inserts annotation tags on methods and signals.
909
xmlstring = dbus.service.Object.Introspect(self, object_path,
912
document = xml.dom.minidom.parseString(xmlstring)
914
for if_tag in document.getElementsByTagName("interface"):
915
# Add annotation tags
916
for typ in ("method", "signal"):
917
for tag in if_tag.getElementsByTagName(typ):
919
for name, prop in (self.
920
_get_all_dbus_things(typ)):
921
if (name == tag.getAttribute("name")
922
and prop._dbus_interface
923
== if_tag.getAttribute("name")):
924
annots.update(getattr(
925
prop, "_dbus_annotations", {}))
926
for name, value in annots.items():
927
ann_tag = document.createElement(
929
ann_tag.setAttribute("name", name)
930
ann_tag.setAttribute("value", value)
931
tag.appendChild(ann_tag)
932
# Add interface annotation tags
933
for annotation, value in dict(
934
itertools.chain.from_iterable(
935
annotations().items()
936
for name, annotations
937
in self._get_all_dbus_things("interface")
938
if name == if_tag.getAttribute("name")
940
ann_tag = document.createElement("annotation")
941
ann_tag.setAttribute("name", annotation)
942
ann_tag.setAttribute("value", value)
943
if_tag.appendChild(ann_tag)
944
# Fix argument name for the Introspect method itself
945
if (if_tag.getAttribute("name")
946
== dbus.INTROSPECTABLE_IFACE):
947
for cn in if_tag.getElementsByTagName("method"):
948
if cn.getAttribute("name") == "Introspect":
949
for arg in cn.getElementsByTagName("arg"):
950
if (arg.getAttribute("direction")
952
arg.setAttribute("name",
954
xmlstring = document.toxml("utf-8")
956
except (AttributeError, xml.dom.DOMException,
957
xml.parsers.expat.ExpatError) as error:
958
logger.error("Failed to override Introspection method",
963
class DBusObjectWithProperties(DBusObjectWithAnnotations):
964
"""A D-Bus object with properties.
966
Classes inheriting from this can use the dbus_service_property
967
decorator to expose methods as D-Bus properties. It exposes the
968
standard Get(), Set(), and GetAll() methods on the D-Bus.
971
def _get_dbus_property(self, interface_name, property_name):
972
"""Returns a bound method if one exists which is a D-Bus
973
property with the specified name and interface.
975
for cls in self.__class__.__mro__:
976
for name, value in inspect.getmembers(
977
cls, self._is_dbus_thing("property")):
978
if (value._dbus_name == property_name
979
and value._dbus_interface == interface_name):
980
return value.__get__(self)
983
raise DBusPropertyNotFound("{}:{}.{}".format(
984
self.dbus_object_path, interface_name, property_name))
986
@dbus.service.method(dbus.PROPERTIES_IFACE,
989
def Get(self, interface_name, property_name):
990
"""Standard D-Bus property Get() method, see D-Bus standard.
992
prop = self._get_dbus_property(interface_name, property_name)
993
if prop._dbus_access == "write":
994
raise DBusPropertyAccessException(property_name)
996
if not hasattr(value, "variant_level"):
998
return type(value)(value, variant_level=value.variant_level+1)
1000
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1001
def Set(self, interface_name, property_name, value):
1002
"""Standard D-Bus property Set() method, see D-Bus standard.
1004
prop = self._get_dbus_property(interface_name, property_name)
1005
if prop._dbus_access == "read":
1006
raise DBusPropertyAccessException(property_name)
1007
if prop._dbus_get_args_options["byte_arrays"]:
1008
# The byte_arrays option is not supported yet on
1009
# signatures other than "ay".
1010
if prop._dbus_signature != "ay":
1011
raise ValueError("Byte arrays not supported for non-"
1012
"'ay' signature {!r}"
1013
.format(prop._dbus_signature))
1014
value = dbus.ByteArray(b''.join(chr(byte)
1018
@dbus.service.method(dbus.PROPERTIES_IFACE,
1020
out_signature="a{sv}")
1021
def GetAll(self, interface_name):
1022
"""Standard D-Bus property GetAll() method, see D-Bus
1025
Note: Will not include properties with access="write".
1028
for name, prop in self._get_all_dbus_things("property"):
1030
and interface_name != prop._dbus_interface):
1031
# Interface non-empty but did not match
1033
# Ignore write-only properties
1034
if prop._dbus_access == "write":
1037
if not hasattr(value, "variant_level"):
1038
properties[name] = value
1040
properties[name] = type(value)(
1041
value, variant_level = value.variant_level + 1)
1042
return dbus.Dictionary(properties, signature="sv")
1044
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1045
def PropertiesChanged(self, interface_name, changed_properties,
1046
invalidated_properties):
1047
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1052
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1054
path_keyword='object_path',
1055
connection_keyword='connection')
1056
def Introspect(self, object_path, connection):
1057
"""Overloading of standard D-Bus method.
1059
Inserts property tags and interface annotation tags.
1061
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1065
document = xml.dom.minidom.parseString(xmlstring)
1067
def make_tag(document, name, prop):
1068
e = document.createElement("property")
1069
e.setAttribute("name", name)
1070
e.setAttribute("type", prop._dbus_signature)
1071
e.setAttribute("access", prop._dbus_access)
1074
for if_tag in document.getElementsByTagName("interface"):
1076
for tag in (make_tag(document, name, prop)
1078
in self._get_all_dbus_things("property")
1079
if prop._dbus_interface
1080
== if_tag.getAttribute("name")):
1081
if_tag.appendChild(tag)
1082
# Add annotation tags for properties
1083
for tag in if_tag.getElementsByTagName("property"):
1085
for name, prop in self._get_all_dbus_things(
1087
if (name == tag.getAttribute("name")
1088
and prop._dbus_interface
1089
== if_tag.getAttribute("name")):
1090
annots.update(getattr(
1091
prop, "_dbus_annotations", {}))
1092
for name, value in annots.items():
1093
ann_tag = document.createElement(
1095
ann_tag.setAttribute("name", name)
1096
ann_tag.setAttribute("value", value)
1097
tag.appendChild(ann_tag)
1098
# Add the names to the return values for the
1099
# "org.freedesktop.DBus.Properties" methods
1100
if (if_tag.getAttribute("name")
1101
== "org.freedesktop.DBus.Properties"):
1102
for cn in if_tag.getElementsByTagName("method"):
1103
if cn.getAttribute("name") == "Get":
1104
for arg in cn.getElementsByTagName("arg"):
1105
if (arg.getAttribute("direction")
1107
arg.setAttribute("name", "value")
1108
elif cn.getAttribute("name") == "GetAll":
1109
for arg in cn.getElementsByTagName("arg"):
1110
if (arg.getAttribute("direction")
1112
arg.setAttribute("name", "props")
1113
xmlstring = document.toxml("utf-8")
1115
except (AttributeError, xml.dom.DOMException,
1116
xml.parsers.expat.ExpatError) as error:
1117
logger.error("Failed to override Introspection method",
1122
def datetime_to_dbus(dt, variant_level=0):
1123
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1125
return dbus.String("", variant_level = variant_level)
1126
return dbus.String(dt.isoformat(), variant_level=variant_level)
1129
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1130
"""A class decorator; applied to a subclass of
1131
dbus.service.Object, it will add alternate D-Bus attributes with
1132
interface names according to the "alt_interface_names" mapping.
1135
@alternate_dbus_interfaces({"org.example.Interface":
1136
"net.example.AlternateInterface"})
1137
class SampleDBusObject(dbus.service.Object):
1138
@dbus.service.method("org.example.Interface")
1139
def SampleDBusMethod():
1142
The above "SampleDBusMethod" on "SampleDBusObject" will be
1143
reachable via two interfaces: "org.example.Interface" and
1144
"net.example.AlternateInterface", the latter of which will have
1145
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1146
"true", unless "deprecate" is passed with a False value.
1148
This works for methods and signals, and also for D-Bus properties
1149
(from DBusObjectWithProperties) and interfaces (from the
1150
dbus_interface_annotations decorator).
1154
for orig_interface_name, alt_interface_name in (
1155
alt_interface_names.items()):
1157
interface_names = set()
1158
# Go though all attributes of the class
1159
for attrname, attribute in inspect.getmembers(cls):
1160
# Ignore non-D-Bus attributes, and D-Bus attributes
1161
# with the wrong interface name
1162
if (not hasattr(attribute, "_dbus_interface")
1163
or not attribute._dbus_interface.startswith(
1164
orig_interface_name)):
1166
# Create an alternate D-Bus interface name based on
1168
alt_interface = attribute._dbus_interface.replace(
1169
orig_interface_name, alt_interface_name)
1170
interface_names.add(alt_interface)
1171
# Is this a D-Bus signal?
1172
if getattr(attribute, "_dbus_is_signal", False):
1173
if sys.version_info.major == 2:
1174
# Extract the original non-method undecorated
1175
# function by black magic
1176
nonmethod_func = (dict(
1177
zip(attribute.func_code.co_freevars,
1178
attribute.__closure__))
1179
["func"].cell_contents)
1181
nonmethod_func = attribute
1182
# Create a new, but exactly alike, function
1183
# object, and decorate it to be a new D-Bus signal
1184
# with the alternate D-Bus interface name
1185
if sys.version_info.major == 2:
1186
new_function = types.FunctionType(
1187
nonmethod_func.func_code,
1188
nonmethod_func.func_globals,
1189
nonmethod_func.func_name,
1190
nonmethod_func.func_defaults,
1191
nonmethod_func.func_closure)
1193
new_function = types.FunctionType(
1194
nonmethod_func.__code__,
1195
nonmethod_func.__globals__,
1196
nonmethod_func.__name__,
1197
nonmethod_func.__defaults__,
1198
nonmethod_func.__closure__)
1199
new_function = (dbus.service.signal(
1201
attribute._dbus_signature)(new_function))
1202
# Copy annotations, if any
1204
new_function._dbus_annotations = dict(
1205
attribute._dbus_annotations)
1206
except AttributeError:
1208
# Define a creator of a function to call both the
1209
# original and alternate functions, so both the
1210
# original and alternate signals gets sent when
1211
# the function is called
1212
def fixscope(func1, func2):
1213
"""This function is a scope container to pass
1214
func1 and func2 to the "call_both" function
1215
outside of its arguments"""
1217
def call_both(*args, **kwargs):
1218
"""This function will emit two D-Bus
1219
signals by calling func1 and func2"""
1220
func1(*args, **kwargs)
1221
func2(*args, **kwargs)
1224
# Create the "call_both" function and add it to
1226
attr[attrname] = fixscope(attribute, new_function)
1227
# Is this a D-Bus method?
1228
elif getattr(attribute, "_dbus_is_method", False):
1229
# Create a new, but exactly alike, function
1230
# object. Decorate it to be a new D-Bus method
1231
# with the alternate D-Bus interface name. Add it
1234
dbus.service.method(
1236
attribute._dbus_in_signature,
1237
attribute._dbus_out_signature)
1238
(types.FunctionType(attribute.func_code,
1239
attribute.func_globals,
1240
attribute.func_name,
1241
attribute.func_defaults,
1242
attribute.func_closure)))
1243
# Copy annotations, if any
1245
attr[attrname]._dbus_annotations = dict(
1246
attribute._dbus_annotations)
1247
except AttributeError:
1249
# Is this a D-Bus property?
1250
elif getattr(attribute, "_dbus_is_property", False):
1251
# Create a new, but exactly alike, function
1252
# object, and decorate it to be a new D-Bus
1253
# property with the alternate D-Bus interface
1254
# name. Add it to the class.
1255
attr[attrname] = (dbus_service_property(
1256
alt_interface, attribute._dbus_signature,
1257
attribute._dbus_access,
1258
attribute._dbus_get_args_options
1260
(types.FunctionType(
1261
attribute.func_code,
1262
attribute.func_globals,
1263
attribute.func_name,
1264
attribute.func_defaults,
1265
attribute.func_closure)))
1266
# Copy annotations, if any
1268
attr[attrname]._dbus_annotations = dict(
1269
attribute._dbus_annotations)
1270
except AttributeError:
1272
# Is this a D-Bus interface?
1273
elif getattr(attribute, "_dbus_is_interface", False):
1274
# Create a new, but exactly alike, function
1275
# object. Decorate it to be a new D-Bus interface
1276
# with the alternate D-Bus interface name. Add it
1279
dbus_interface_annotations(alt_interface)
1280
(types.FunctionType(attribute.func_code,
1281
attribute.func_globals,
1282
attribute.func_name,
1283
attribute.func_defaults,
1284
attribute.func_closure)))
1286
# Deprecate all alternate interfaces
1287
iname="_AlternateDBusNames_interface_annotation{}"
1288
for interface_name in interface_names:
1290
@dbus_interface_annotations(interface_name)
1292
return { "org.freedesktop.DBus.Deprecated":
1294
# Find an unused name
1295
for aname in (iname.format(i)
1296
for i in itertools.count()):
1297
if aname not in attr:
1301
# Replace the class with a new subclass of it with
1302
# methods, signals, etc. as created above.
1303
cls = type(b"{}Alternate".format(cls.__name__),
1310
@alternate_dbus_interfaces({"se.recompile.Mandos":
1311
"se.bsnet.fukt.Mandos"})
1312
class ClientDBus(Client, DBusObjectWithProperties):
1313
"""A Client class using D-Bus
1316
dbus_object_path: dbus.ObjectPath
1317
bus: dbus.SystemBus()
1320
runtime_expansions = (Client.runtime_expansions
1321
+ ("dbus_object_path", ))
1323
_interface = "se.recompile.Mandos.Client"
1325
# dbus.service.Object doesn't use super(), so we can't either.
1327
def __init__(self, bus = None, *args, **kwargs):
1329
Client.__init__(self, *args, **kwargs)
1330
# Only now, when this client is initialized, can it show up on
1332
client_object_name = str(self.name).translate(
1333
{ord("."): ord("_"),
1334
ord("-"): ord("_")})
1335
self.dbus_object_path = dbus.ObjectPath(
1336
"/clients/" + client_object_name)
1337
DBusObjectWithProperties.__init__(self, self.bus,
1338
self.dbus_object_path)
1340
def notifychangeproperty(transform_func, dbus_name,
1341
type_func=lambda x: x,
1343
invalidate_only=False,
1344
_interface=_interface):
1345
""" Modify a variable so that it's a property which announces
1346
its changes to DBus.
1348
transform_fun: Function that takes a value and a variant_level
1349
and transforms it to a D-Bus type.
1350
dbus_name: D-Bus name of the variable
1351
type_func: Function that transform the value before sending it
1352
to the D-Bus. Default: no transform
1353
variant_level: D-Bus variant level. Default: 1
1355
attrname = "_{}".format(dbus_name)
1357
def setter(self, value):
1358
if hasattr(self, "dbus_object_path"):
1359
if (not hasattr(self, attrname) or
1360
type_func(getattr(self, attrname, None))
1361
!= type_func(value)):
1363
self.PropertiesChanged(
1364
_interface, dbus.Dictionary(),
1365
dbus.Array((dbus_name, )))
1367
dbus_value = transform_func(
1369
variant_level = variant_level)
1370
self.PropertyChanged(dbus.String(dbus_name),
1372
self.PropertiesChanged(
1374
dbus.Dictionary({ dbus.String(dbus_name):
1377
setattr(self, attrname, value)
1379
return property(lambda self: getattr(self, attrname), setter)
1381
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1382
approvals_pending = notifychangeproperty(dbus.Boolean,
1385
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1386
last_enabled = notifychangeproperty(datetime_to_dbus,
1388
checker = notifychangeproperty(
1389
dbus.Boolean, "CheckerRunning",
1390
type_func = lambda checker: checker is not None)
1391
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1393
last_checker_status = notifychangeproperty(dbus.Int16,
1394
"LastCheckerStatus")
1395
last_approval_request = notifychangeproperty(
1396
datetime_to_dbus, "LastApprovalRequest")
1397
approved_by_default = notifychangeproperty(dbus.Boolean,
1398
"ApprovedByDefault")
1399
approval_delay = notifychangeproperty(
1400
dbus.UInt64, "ApprovalDelay",
1401
type_func = lambda td: td.total_seconds() * 1000)
1402
approval_duration = notifychangeproperty(
1403
dbus.UInt64, "ApprovalDuration",
1404
type_func = lambda td: td.total_seconds() * 1000)
1405
host = notifychangeproperty(dbus.String, "Host")
1406
timeout = notifychangeproperty(
1407
dbus.UInt64, "Timeout",
1408
type_func = lambda td: td.total_seconds() * 1000)
1409
extended_timeout = notifychangeproperty(
1410
dbus.UInt64, "ExtendedTimeout",
1411
type_func = lambda td: td.total_seconds() * 1000)
1412
interval = notifychangeproperty(
1413
dbus.UInt64, "Interval",
1414
type_func = lambda td: td.total_seconds() * 1000)
1415
checker_command = notifychangeproperty(dbus.String, "Checker")
1416
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1417
invalidate_only=True)
1419
del notifychangeproperty
1421
def __del__(self, *args, **kwargs):
1423
self.remove_from_connection()
1426
if hasattr(DBusObjectWithProperties, "__del__"):
1427
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1428
Client.__del__(self, *args, **kwargs)
1430
def checker_callback(self, source, condition,
1431
connection, command, *args, **kwargs):
1432
ret = Client.checker_callback(self, source, condition,
1433
connection, command, *args,
1435
exitstatus = self.last_checker_status
1438
self.CheckerCompleted(dbus.Int16(exitstatus),
1439
# This is specific to GNU libC
1440
dbus.Int64(exitstatus << 8),
1441
dbus.String(command))
1444
self.CheckerCompleted(dbus.Int16(-1),
1446
# This is specific to GNU libC
1448
| self.last_checker_signal),
1449
dbus.String(command))
1452
def start_checker(self, *args, **kwargs):
1453
old_checker_pid = getattr(self.checker, "pid", None)
1454
r = Client.start_checker(self, *args, **kwargs)
1455
# Only if new checker process was started
1456
if (self.checker is not None
1457
and old_checker_pid != self.checker.pid):
1459
self.CheckerStarted(self.current_checker_command)
1462
def _reset_approved(self):
1463
self.approved = None
1466
def approve(self, value=True):
1467
self.approved = value
1468
gobject.timeout_add(int(self.approval_duration.total_seconds()
1469
* 1000), self._reset_approved)
1470
self.send_changedstate()
1472
## D-Bus methods, signals & properties
1478
# CheckerCompleted - signal
1479
@dbus.service.signal(_interface, signature="nxs")
1480
def CheckerCompleted(self, exitcode, waitstatus, command):
1484
# CheckerStarted - signal
1485
@dbus.service.signal(_interface, signature="s")
1486
def CheckerStarted(self, command):
1490
# PropertyChanged - signal
1491
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1492
@dbus.service.signal(_interface, signature="sv")
1493
def PropertyChanged(self, property, value):
1497
# GotSecret - signal
1498
@dbus.service.signal(_interface)
1499
def GotSecret(self):
1501
Is sent after a successful transfer of secret from the Mandos
1502
server to mandos-client
1507
@dbus.service.signal(_interface, signature="s")
1508
def Rejected(self, reason):
1512
# NeedApproval - signal
1513
@dbus.service.signal(_interface, signature="tb")
1514
def NeedApproval(self, timeout, default):
1516
return self.need_approval()
1521
@dbus.service.method(_interface, in_signature="b")
1522
def Approve(self, value):
1525
# CheckedOK - method
1526
@dbus.service.method(_interface)
1527
def CheckedOK(self):
1531
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1532
@dbus.service.method(_interface)
1537
# StartChecker - method
1538
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1539
@dbus.service.method(_interface)
1540
def StartChecker(self):
1542
self.start_checker()
1545
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1546
@dbus.service.method(_interface)
1551
# StopChecker - method
1552
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1553
@dbus.service.method(_interface)
1554
def StopChecker(self):
1559
# ApprovalPending - property
1560
@dbus_service_property(_interface, signature="b", access="read")
1561
def ApprovalPending_dbus_property(self):
1562
return dbus.Boolean(bool(self.approvals_pending))
1564
# ApprovedByDefault - property
1565
@dbus_service_property(_interface,
1568
def ApprovedByDefault_dbus_property(self, value=None):
1569
if value is None: # get
1570
return dbus.Boolean(self.approved_by_default)
1571
self.approved_by_default = bool(value)
1573
# ApprovalDelay - property
1574
@dbus_service_property(_interface,
1577
def ApprovalDelay_dbus_property(self, value=None):
1578
if value is None: # get
1579
return dbus.UInt64(self.approval_delay.total_seconds()
1581
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1583
# ApprovalDuration - property
1584
@dbus_service_property(_interface,
1587
def ApprovalDuration_dbus_property(self, value=None):
1588
if value is None: # get
1589
return dbus.UInt64(self.approval_duration.total_seconds()
1591
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1595
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1596
@dbus_service_property(_interface, signature="s", access="read")
1597
def Name_dbus_property(self):
1598
return dbus.String(self.name)
1600
# Fingerprint - property
1602
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1603
@dbus_service_property(_interface, signature="s", access="read")
1604
def Fingerprint_dbus_property(self):
1605
return dbus.String(self.fingerprint)
1608
@dbus_service_property(_interface,
1611
def Host_dbus_property(self, value=None):
1612
if value is None: # get
1613
return dbus.String(self.host)
1614
self.host = str(value)
1616
# Created - property
1618
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1619
@dbus_service_property(_interface, signature="s", access="read")
1620
def Created_dbus_property(self):
1621
return datetime_to_dbus(self.created)
1623
# LastEnabled - property
1624
@dbus_service_property(_interface, signature="s", access="read")
1625
def LastEnabled_dbus_property(self):
1626
return datetime_to_dbus(self.last_enabled)
1628
# Enabled - property
1629
@dbus_service_property(_interface,
1632
def Enabled_dbus_property(self, value=None):
1633
if value is None: # get
1634
return dbus.Boolean(self.enabled)
1640
# LastCheckedOK - property
1641
@dbus_service_property(_interface,
1644
def LastCheckedOK_dbus_property(self, value=None):
1645
if value is not None:
1648
return datetime_to_dbus(self.last_checked_ok)
1650
# LastCheckerStatus - property
1651
@dbus_service_property(_interface, signature="n", access="read")
1652
def LastCheckerStatus_dbus_property(self):
1653
return dbus.Int16(self.last_checker_status)
1655
# Expires - property
1656
@dbus_service_property(_interface, signature="s", access="read")
1657
def Expires_dbus_property(self):
1658
return datetime_to_dbus(self.expires)
1660
# LastApprovalRequest - property
1661
@dbus_service_property(_interface, signature="s", access="read")
1662
def LastApprovalRequest_dbus_property(self):
1663
return datetime_to_dbus(self.last_approval_request)
1665
# Timeout - property
1666
@dbus_service_property(_interface,
1669
def Timeout_dbus_property(self, value=None):
1670
if value is None: # get
1671
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1672
old_timeout = self.timeout
1673
self.timeout = datetime.timedelta(0, 0, 0, value)
1674
# Reschedule disabling
1676
now = datetime.datetime.utcnow()
1677
self.expires += self.timeout - old_timeout
1678
if self.expires <= now:
1679
# The timeout has passed
1682
if (getattr(self, "disable_initiator_tag", None)
1685
gobject.source_remove(self.disable_initiator_tag)
1686
self.disable_initiator_tag = gobject.timeout_add(
1687
int((self.expires - now).total_seconds() * 1000),
1690
# ExtendedTimeout - property
1691
@dbus_service_property(_interface,
1694
def ExtendedTimeout_dbus_property(self, value=None):
1695
if value is None: # get
1696
return dbus.UInt64(self.extended_timeout.total_seconds()
1698
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1700
# Interval - property
1701
@dbus_service_property(_interface,
1704
def Interval_dbus_property(self, value=None):
1705
if value is None: # get
1706
return dbus.UInt64(self.interval.total_seconds() * 1000)
1707
self.interval = datetime.timedelta(0, 0, 0, value)
1708
if getattr(self, "checker_initiator_tag", None) is None:
1711
# Reschedule checker run
1712
gobject.source_remove(self.checker_initiator_tag)
1713
self.checker_initiator_tag = gobject.timeout_add(
1714
value, self.start_checker)
1715
self.start_checker() # Start one now, too
1717
# Checker - property
1718
@dbus_service_property(_interface,
1721
def Checker_dbus_property(self, value=None):
1722
if value is None: # get
1723
return dbus.String(self.checker_command)
1724
self.checker_command = str(value)
1726
# CheckerRunning - property
1727
@dbus_service_property(_interface,
1730
def CheckerRunning_dbus_property(self, value=None):
1731
if value is None: # get
1732
return dbus.Boolean(self.checker is not None)
1734
self.start_checker()
1738
# ObjectPath - property
1740
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
1741
"org.freedesktop.DBus.Deprecated": "true"})
1742
@dbus_service_property(_interface, signature="o", access="read")
1743
def ObjectPath_dbus_property(self):
1744
return self.dbus_object_path # is already a dbus.ObjectPath
1748
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
1750
@dbus_service_property(_interface,
1754
def Secret_dbus_property(self, value):
1755
self.secret = bytes(value)
1760
class ProxyClient(object):
1761
def __init__(self, child_pipe, fpr, address):
1762
self._pipe = child_pipe
1763
self._pipe.send(('init', fpr, address))
1764
if not self._pipe.recv():
1767
def __getattribute__(self, name):
1769
return super(ProxyClient, self).__getattribute__(name)
1770
self._pipe.send(('getattr', name))
1771
data = self._pipe.recv()
1772
if data[0] == 'data':
1774
if data[0] == 'function':
1776
def func(*args, **kwargs):
1777
self._pipe.send(('funcall', name, args, kwargs))
1778
return self._pipe.recv()[1]
1782
def __setattr__(self, name, value):
1784
return super(ProxyClient, self).__setattr__(name, value)
1785
self._pipe.send(('setattr', name, value))
1788
class ClientHandler(socketserver.BaseRequestHandler, object):
1789
"""A class to handle client connections.
1791
Instantiated once for each connection to handle it.
372
def still_valid(self):
373
"""Has the timeout not yet passed for this client?"""
374
now = datetime.datetime.now()
375
if self.last_checked_ok is None:
376
return now < (self.created + self.timeout)
378
return now < (self.last_checked_ok + self.timeout)
381
def peer_certificate(session):
382
"Return the peer's OpenPGP certificate as a bytestring"
383
# If not an OpenPGP certificate...
384
if gnutls.library.functions.gnutls_certificate_type_get\
385
(session._c_object) \
386
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
387
# ...do the normal thing
388
return session.peer_certificate
389
list_size = ctypes.c_uint()
390
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
391
(session._c_object, ctypes.byref(list_size))
392
if list_size.value == 0:
395
return ctypes.string_at(cert.data, cert.size)
398
def fingerprint(openpgp):
399
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
400
# New GnuTLS "datum" with the OpenPGP public key
401
datum = gnutls.library.types.gnutls_datum_t\
402
(ctypes.cast(ctypes.c_char_p(openpgp),
403
ctypes.POINTER(ctypes.c_ubyte)),
404
ctypes.c_uint(len(openpgp)))
405
# New empty GnuTLS certificate
406
crt = gnutls.library.types.gnutls_openpgp_crt_t()
407
gnutls.library.functions.gnutls_openpgp_crt_init\
409
# Import the OpenPGP public key into the certificate
410
gnutls.library.functions.gnutls_openpgp_crt_import\
411
(crt, ctypes.byref(datum),
412
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
# New buffer for the fingerprint
414
buffer = ctypes.create_string_buffer(20)
415
buffer_length = ctypes.c_size_t()
416
# Get the fingerprint from the certificate into the buffer
417
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
418
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
419
# Deinit the certificate
420
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
421
# Convert the buffer to a Python bytestring
422
fpr = ctypes.string_at(buffer, buffer_length.value)
423
# Convert the bytestring to hexadecimal notation
424
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
428
class tcp_handler(SocketServer.BaseRequestHandler, object):
429
"""A TCP request handler class.
430
Instantiated by IPv6_TCPServer for each request to handle it.
1792
431
Note: This will run in its own forked process."""
1794
433
def handle(self):
1795
with contextlib.closing(self.server.child_pipe) as child_pipe:
1796
logger.info("TCP connection from: %s",
1797
str(self.client_address))
1798
logger.debug("Pipe FD: %d",
1799
self.server.child_pipe.fileno())
1801
session = gnutls.connection.ClientSession(
1802
self.request, gnutls.connection .X509Credentials())
1804
# Note: gnutls.connection.X509Credentials is really a
1805
# generic GnuTLS certificate credentials object so long as
1806
# no X.509 keys are added to it. Therefore, we can use it
1807
# here despite using OpenPGP certificates.
1809
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1810
# "+AES-256-CBC", "+SHA1",
1811
# "+COMP-NULL", "+CTYPE-OPENPGP",
1813
# Use a fallback default, since this MUST be set.
1814
priority = self.server.gnutls_priority
1815
if priority is None:
1817
gnutls.library.functions.gnutls_priority_set_direct(
1818
session._c_object, priority, None)
1820
# Start communication using the Mandos protocol
1821
# Get protocol number
1822
line = self.request.makefile().readline()
1823
logger.debug("Protocol version: %r", line)
1825
if int(line.strip().split()[0]) > 1:
1826
raise RuntimeError(line)
1827
except (ValueError, IndexError, RuntimeError) as error:
1828
logger.error("Unknown protocol version: %s", error)
1831
# Start GnuTLS connection
1834
except gnutls.errors.GNUTLSError as error:
1835
logger.warning("Handshake failed: %s", error)
1836
# Do not run session.bye() here: the session is not
1837
# established. Just abandon the request.
1839
logger.debug("Handshake succeeded")
1841
approval_required = False
1844
fpr = self.fingerprint(
1845
self.peer_certificate(session))
1847
gnutls.errors.GNUTLSError) as error:
1848
logger.warning("Bad certificate: %s", error)
1850
logger.debug("Fingerprint: %s", fpr)
1853
client = ProxyClient(child_pipe, fpr,
1854
self.client_address)
1858
if client.approval_delay:
1859
delay = client.approval_delay
1860
client.approvals_pending += 1
1861
approval_required = True
1864
if not client.enabled:
1865
logger.info("Client %s is disabled",
1867
if self.server.use_dbus:
1869
client.Rejected("Disabled")
1872
if client.approved or not client.approval_delay:
1873
#We are approved or approval is disabled
1875
elif client.approved is None:
1876
logger.info("Client %s needs approval",
1878
if self.server.use_dbus:
1880
client.NeedApproval(
1881
client.approval_delay.total_seconds()
1882
* 1000, client.approved_by_default)
1884
logger.warning("Client %s was not approved",
1886
if self.server.use_dbus:
1888
client.Rejected("Denied")
1891
#wait until timeout or approved
1892
time = datetime.datetime.now()
1893
client.changedstate.acquire()
1894
client.changedstate.wait(delay.total_seconds())
1895
client.changedstate.release()
1896
time2 = datetime.datetime.now()
1897
if (time2 - time) >= delay:
1898
if not client.approved_by_default:
1899
logger.warning("Client %s timed out while"
1900
" waiting for approval",
1902
if self.server.use_dbus:
1904
client.Rejected("Approval timed out")
1909
delay -= time2 - time
1912
while sent_size < len(client.secret):
1914
sent = session.send(client.secret[sent_size:])
1915
except gnutls.errors.GNUTLSError as error:
1916
logger.warning("gnutls send failed",
1919
logger.debug("Sent: %d, remaining: %d", sent,
1920
len(client.secret) - (sent_size
1924
logger.info("Sending secret to %s", client.name)
1925
# bump the timeout using extended_timeout
1926
client.bump_timeout(client.extended_timeout)
1927
if self.server.use_dbus:
1932
if approval_required:
1933
client.approvals_pending -= 1
1936
except gnutls.errors.GNUTLSError as error:
1937
logger.warning("GnuTLS bye failed",
1941
def peer_certificate(session):
1942
"Return the peer's OpenPGP certificate as a bytestring"
1943
# If not an OpenPGP certificate...
1944
if (gnutls.library.functions.gnutls_certificate_type_get(
1946
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1947
# ...do the normal thing
1948
return session.peer_certificate
1949
list_size = ctypes.c_uint(1)
1950
cert_list = (gnutls.library.functions
1951
.gnutls_certificate_get_peers
1952
(session._c_object, ctypes.byref(list_size)))
1953
if not bool(cert_list) and list_size.value != 0:
1954
raise gnutls.errors.GNUTLSError("error getting peer"
1956
if list_size.value == 0:
1959
return ctypes.string_at(cert.data, cert.size)
1962
def fingerprint(openpgp):
1963
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1964
# New GnuTLS "datum" with the OpenPGP public key
1965
datum = gnutls.library.types.gnutls_datum_t(
1966
ctypes.cast(ctypes.c_char_p(openpgp),
1967
ctypes.POINTER(ctypes.c_ubyte)),
1968
ctypes.c_uint(len(openpgp)))
1969
# New empty GnuTLS certificate
1970
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1971
gnutls.library.functions.gnutls_openpgp_crt_init(
1973
# Import the OpenPGP public key into the certificate
1974
gnutls.library.functions.gnutls_openpgp_crt_import(
1975
crt, ctypes.byref(datum),
1976
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1977
# Verify the self signature in the key
1978
crtverify = ctypes.c_uint()
1979
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1980
crt, 0, ctypes.byref(crtverify))
1981
if crtverify.value != 0:
1982
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1983
raise gnutls.errors.CertificateSecurityError(
1985
# New buffer for the fingerprint
1986
buf = ctypes.create_string_buffer(20)
1987
buf_len = ctypes.c_size_t()
1988
# Get the fingerprint from the certificate into the buffer
1989
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1990
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1991
# Deinit the certificate
1992
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1993
# Convert the buffer to a Python bytestring
1994
fpr = ctypes.string_at(buf, buf_len.value)
1995
# Convert the bytestring to hexadecimal notation
1996
hex_fpr = binascii.hexlify(fpr).upper()
2000
class MultiprocessingMixIn(object):
2001
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2003
def sub_process_main(self, request, address):
2005
self.finish_request(request, address)
2007
self.handle_error(request, address)
2008
self.close_request(request)
2010
def process_request(self, request, address):
2011
"""Start a new process to process the request."""
2012
proc = multiprocessing.Process(target = self.sub_process_main,
2013
args = (request, address))
2018
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2019
""" adds a pipe to the MixIn """
2021
def process_request(self, request, client_address):
2022
"""Overrides and wraps the original process_request().
2024
This function creates a new pipe in self.pipe
2026
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2028
proc = MultiprocessingMixIn.process_request(self, request,
2030
self.child_pipe.close()
2031
self.add_pipe(parent_pipe, proc)
2033
def add_pipe(self, parent_pipe, proc):
2034
"""Dummy function; override as necessary"""
2035
raise NotImplementedError()
2038
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2039
socketserver.TCPServer, object):
2040
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
434
logger.info(u"TCP connection from: %s",
435
unicode(self.client_address))
436
session = gnutls.connection.ClientSession\
437
(self.request, gnutls.connection.X509Credentials())
439
line = self.request.makefile().readline()
440
logger.debug(u"Protocol version: %r", line)
442
if int(line.strip().split()[0]) > 1:
444
except (ValueError, IndexError, RuntimeError), error:
445
logger.error(u"Unknown protocol version: %s", error)
448
# Note: gnutls.connection.X509Credentials is really a generic
449
# GnuTLS certificate credentials object so long as no X.509
450
# keys are added to it. Therefore, we can use it here despite
451
# using OpenPGP certificates.
453
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
454
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
456
priority = "NORMAL" # Fallback default, since this
458
if self.server.settings["priority"]:
459
priority = self.server.settings["priority"]
460
gnutls.library.functions.gnutls_priority_set_direct\
461
(session._c_object, priority, None);
465
except gnutls.errors.GNUTLSError, error:
466
logger.warning(u"Handshake failed: %s", error)
467
# Do not run session.bye() here: the session is not
468
# established. Just abandon the request.
471
fpr = fingerprint(peer_certificate(session))
472
except (TypeError, gnutls.errors.GNUTLSError), error:
473
logger.warning(u"Bad certificate: %s", error)
476
logger.debug(u"Fingerprint: %s", fpr)
478
for c in self.server.clients:
479
if c.fingerprint == fpr:
483
logger.warning(u"Client not found for fingerprint: %s",
487
# Have to check if client.still_valid(), since it is possible
488
# that the client timed out while establishing the GnuTLS
490
if not client.still_valid():
491
logger.warning(u"Client %(name)s is invalid",
496
while sent_size < len(client.secret):
497
sent = session.send(client.secret[sent_size:])
498
logger.debug(u"Sent: %d, remaining: %d",
499
sent, len(client.secret)
500
- (sent_size + sent))
505
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
506
"""IPv6 TCP server. Accepts 'None' as address and/or port.
2043
enabled: Boolean; whether this server is activated yet
2044
interface: None or a network interface name (string)
2045
use_ipv6: Boolean; to use IPv6 or not
508
settings: Server settings
509
clients: Set() of Client objects
2048
def __init__(self, server_address, RequestHandlerClass,
2052
"""If socketfd is set, use that file descriptor instead of
2053
creating a new one with socket.socket().
2055
self.interface = interface
2057
self.address_family = socket.AF_INET6
2058
if socketfd is not None:
2059
# Save the file descriptor
2060
self.socketfd = socketfd
2061
# Save the original socket.socket() function
2062
self.socket_socket = socket.socket
2063
# To implement --socket, we monkey patch socket.socket.
2065
# (When socketserver.TCPServer is a new-style class, we
2066
# could make self.socket into a property instead of monkey
2067
# patching socket.socket.)
2069
# Create a one-time-only replacement for socket.socket()
2070
@functools.wraps(socket.socket)
2071
def socket_wrapper(*args, **kwargs):
2072
# Restore original function so subsequent calls are
2074
socket.socket = self.socket_socket
2075
del self.socket_socket
2076
# This time only, return a new socket object from the
2077
# saved file descriptor.
2078
return socket.fromfd(self.socketfd, *args, **kwargs)
2079
# Replace socket.socket() function with wrapper
2080
socket.socket = socket_wrapper
2081
# The socketserver.TCPServer.__init__ will call
2082
# socket.socket(), which might be our replacement,
2083
# socket_wrapper(), if socketfd was set.
2084
socketserver.TCPServer.__init__(self, server_address,
2085
RequestHandlerClass)
511
address_family = socket.AF_INET6
512
def __init__(self, *args, **kwargs):
513
if "settings" in kwargs:
514
self.settings = kwargs["settings"]
515
del kwargs["settings"]
516
if "clients" in kwargs:
517
self.clients = kwargs["clients"]
518
del kwargs["clients"]
519
return super(type(self), self).__init__(*args, **kwargs)
2087
520
def server_bind(self):
2088
521
"""This overrides the normal server_bind() function
2089
522
to bind to an interface if one was specified, and also NOT to
2090
523
bind to an address or port if they were not specified."""
2091
if self.interface is not None:
2092
if SO_BINDTODEVICE is None:
2093
logger.error("SO_BINDTODEVICE does not exist;"
2094
" cannot bind to interface %s",
2098
self.socket.setsockopt(
2099
socket.SOL_SOCKET, SO_BINDTODEVICE,
2100
(self.interface + "\0").encode("utf-8"))
2101
except socket.error as error:
2102
if error.errno == errno.EPERM:
2103
logger.error("No permission to bind to"
2104
" interface %s", self.interface)
2105
elif error.errno == errno.ENOPROTOOPT:
2106
logger.error("SO_BINDTODEVICE not available;"
2107
" cannot bind to interface %s",
2109
elif error.errno == errno.ENODEV:
2110
logger.error("Interface %s does not exist,"
2111
" cannot bind", self.interface)
524
if self.settings["interface"]:
525
# 25 is from /usr/include/asm-i486/socket.h
526
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
528
self.socket.setsockopt(socket.SOL_SOCKET,
530
self.settings["interface"])
531
except socket.error, error:
532
if error[0] == errno.EPERM:
533
logger.error(u"No permission to"
534
u" bind to interface %s",
535
self.settings["interface"])
2114
538
# Only bind(2) the socket if we really need to.
2115
539
if self.server_address[0] or self.server_address[1]:
2116
540
if not self.server_address[0]:
2117
if self.address_family == socket.AF_INET6:
2118
any_address = "::" # in6addr_any
2120
any_address = "0.0.0.0" # INADDR_ANY
2121
self.server_address = (any_address,
542
self.server_address = (in6addr_any,
2122
543
self.server_address[1])
2123
544
elif not self.server_address[1]:
2124
self.server_address = (self.server_address[0], 0)
2125
# if self.interface:
545
self.server_address = (self.server_address[0],
547
# if self.settings["interface"]:
2126
548
# self.server_address = (self.server_address[0],
2129
551
# if_nametoindex
2131
return socketserver.TCPServer.server_bind(self)
2134
class MandosServer(IPv6_TCPServer):
2138
clients: set of Client objects
2139
gnutls_priority GnuTLS priority string
2140
use_dbus: Boolean; to emit D-Bus signals or not
2142
Assumes a gobject.MainLoop event loop.
2145
def __init__(self, server_address, RequestHandlerClass,
2149
gnutls_priority=None,
2152
self.enabled = False
2153
self.clients = clients
2154
if self.clients is None:
2156
self.use_dbus = use_dbus
2157
self.gnutls_priority = gnutls_priority
2158
IPv6_TCPServer.__init__(self, server_address,
2159
RequestHandlerClass,
2160
interface = interface,
2161
use_ipv6 = use_ipv6,
2162
socketfd = socketfd)
2164
def server_activate(self):
2166
return socketserver.TCPServer.server_activate(self)
2171
def add_pipe(self, parent_pipe, proc):
2172
# Call "handle_ipc" for both data and EOF events
2173
gobject.io_add_watch(
2174
parent_pipe.fileno(),
2175
gobject.IO_IN | gobject.IO_HUP,
2176
functools.partial(self.handle_ipc,
2177
parent_pipe = parent_pipe,
2180
def handle_ipc(self, source, condition,
2183
client_object=None):
2184
# error, or the other end of multiprocessing.Pipe has closed
2185
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2186
# Wait for other process to exit
2190
# Read a request from the child
2191
request = parent_pipe.recv()
2192
command = request[0]
2194
if command == 'init':
2196
address = request[2]
2198
for c in self.clients.itervalues():
2199
if c.fingerprint == fpr:
2203
logger.info("Client not found for fingerprint: %s, ad"
2204
"dress: %s", fpr, address)
2207
mandos_dbus_service.ClientNotFound(fpr,
2209
parent_pipe.send(False)
2212
gobject.io_add_watch(
2213
parent_pipe.fileno(),
2214
gobject.IO_IN | gobject.IO_HUP,
2215
functools.partial(self.handle_ipc,
2216
parent_pipe = parent_pipe,
2218
client_object = client))
2219
parent_pipe.send(True)
2220
# remove the old hook in favor of the new above hook on
2223
if command == 'funcall':
2224
funcname = request[1]
2228
parent_pipe.send(('data', getattr(client_object,
2232
if command == 'getattr':
2233
attrname = request[1]
2234
if isinstance(client_object.__getattribute__(attrname),
2235
collections.Callable):
2236
parent_pipe.send(('function', ))
2239
'data', client_object.__getattribute__(attrname)))
2241
if command == 'setattr':
2242
attrname = request[1]
2244
setattr(client_object, attrname, value)
2249
def rfc3339_duration_to_delta(duration):
2250
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2252
>>> rfc3339_duration_to_delta("P7D")
2253
datetime.timedelta(7)
2254
>>> rfc3339_duration_to_delta("PT60S")
2255
datetime.timedelta(0, 60)
2256
>>> rfc3339_duration_to_delta("PT60M")
2257
datetime.timedelta(0, 3600)
2258
>>> rfc3339_duration_to_delta("PT24H")
2259
datetime.timedelta(1)
2260
>>> rfc3339_duration_to_delta("P1W")
2261
datetime.timedelta(7)
2262
>>> rfc3339_duration_to_delta("PT5M30S")
2263
datetime.timedelta(0, 330)
2264
>>> rfc3339_duration_to_delta("P1DT3M20S")
2265
datetime.timedelta(1, 200)
2268
# Parsing an RFC 3339 duration with regular expressions is not
2269
# possible - there would have to be multiple places for the same
2270
# values, like seconds. The current code, while more esoteric, is
2271
# cleaner without depending on a parsing library. If Python had a
2272
# built-in library for parsing we would use it, but we'd like to
2273
# avoid excessive use of external libraries.
2275
# New type for defining tokens, syntax, and semantics all-in-one
2276
Token = collections.namedtuple("Token", (
2277
"regexp", # To match token; if "value" is not None, must have
2278
# a "group" containing digits
2279
"value", # datetime.timedelta or None
2280
"followers")) # Tokens valid after this token
2281
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2282
# the "duration" ABNF definition in RFC 3339, Appendix A.
2283
token_end = Token(re.compile(r"$"), None, frozenset())
2284
token_second = Token(re.compile(r"(\d+)S"),
2285
datetime.timedelta(seconds=1),
2286
frozenset((token_end, )))
2287
token_minute = Token(re.compile(r"(\d+)M"),
2288
datetime.timedelta(minutes=1),
2289
frozenset((token_second, token_end)))
2290
token_hour = Token(re.compile(r"(\d+)H"),
2291
datetime.timedelta(hours=1),
2292
frozenset((token_minute, token_end)))
2293
token_time = Token(re.compile(r"T"),
2295
frozenset((token_hour, token_minute,
2297
token_day = Token(re.compile(r"(\d+)D"),
2298
datetime.timedelta(days=1),
2299
frozenset((token_time, token_end)))
2300
token_month = Token(re.compile(r"(\d+)M"),
2301
datetime.timedelta(weeks=4),
2302
frozenset((token_day, token_end)))
2303
token_year = Token(re.compile(r"(\d+)Y"),
2304
datetime.timedelta(weeks=52),
2305
frozenset((token_month, token_end)))
2306
token_week = Token(re.compile(r"(\d+)W"),
2307
datetime.timedelta(weeks=1),
2308
frozenset((token_end, )))
2309
token_duration = Token(re.compile(r"P"), None,
2310
frozenset((token_year, token_month,
2311
token_day, token_time,
2313
# Define starting values
2314
value = datetime.timedelta() # Value so far
2316
followers = frozenset((token_duration, )) # Following valid tokens
2317
s = duration # String left to parse
2318
# Loop until end token is found
2319
while found_token is not token_end:
2320
# Search for any currently valid tokens
2321
for token in followers:
2322
match = token.regexp.match(s)
2323
if match is not None:
2325
if token.value is not None:
2326
# Value found, parse digits
2327
factor = int(match.group(1), 10)
2328
# Add to value so far
2329
value += factor * token.value
2330
# Strip token from string
2331
s = token.regexp.sub("", s, 1)
2334
# Set valid next tokens
2335
followers = found_token.followers
2338
# No currently valid tokens were found
2339
raise ValueError("Invalid RFC 3339 duration: {!r}"
554
return super(type(self), self).server_bind()
2345
557
def string_to_delta(interval):
2346
558
"""Parse a string and return a datetime.timedelta
2348
560
>>> string_to_delta('7d')
2349
561
datetime.timedelta(7)
2350
562
>>> string_to_delta('60s')
2476
702
"debug": "False",
2478
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2479
":+SIGN-DSA-SHA256",
704
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2480
705
"servicename": "Mandos",
2486
"statedir": "/var/lib/mandos",
2487
"foreground": "False",
2491
708
# Parse config file for server-global settings
2492
server_config = configparser.SafeConfigParser(server_defaults)
709
server_config = ConfigParser.SafeConfigParser(server_defaults)
2493
710
del server_defaults
2494
711
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2495
712
# Convert the SafeConfigParser object to a dict
2496
713
server_settings = server_config.defaults()
2497
# Use the appropriate methods on the non-string config options
2498
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2499
server_settings[option] = server_config.getboolean("DEFAULT",
2501
if server_settings["port"]:
2502
server_settings["port"] = server_config.getint("DEFAULT",
2504
if server_settings["socket"]:
2505
server_settings["socket"] = server_config.getint("DEFAULT",
2507
# Later, stdin will, and stdout and stderr might, be dup'ed
2508
# over with an opened os.devnull. But we don't want this to
2509
# happen with a supplied network socket.
2510
if 0 <= server_settings["socket"] <= 2:
2511
server_settings["socket"] = os.dup(server_settings
714
# Use getboolean on the boolean config option
715
server_settings["debug"] = server_config.getboolean\
2513
717
del server_config
2515
719
# Override the settings from the config file with command line
2516
720
# options, if set.
2517
721
for option in ("interface", "address", "port", "debug",
2518
"priority", "servicename", "configdir", "use_dbus",
2519
"use_ipv6", "debuglevel", "restore", "statedir",
2520
"socket", "foreground", "zeroconf"):
722
"priority", "servicename", "configdir"):
2521
723
value = getattr(options, option)
2522
724
if value is not None:
2523
725
server_settings[option] = value
2525
# Force all strings to be unicode
2526
for option in server_settings.keys():
2527
if isinstance(server_settings[option], bytes):
2528
server_settings[option] = (server_settings[option]
2530
# Force all boolean options to be boolean
2531
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2532
"foreground", "zeroconf"):
2533
server_settings[option] = bool(server_settings[option])
2534
# Debug implies foreground
2535
if server_settings["debug"]:
2536
server_settings["foreground"] = True
2537
727
# Now we have our good server settings in "server_settings"
2539
##################################################################
2541
if (not server_settings["zeroconf"]
2542
and not (server_settings["port"]
2543
or server_settings["socket"] != "")):
2544
parser.error("Needs port or socket to work without Zeroconf")
2547
729
debug = server_settings["debug"]
2548
debuglevel = server_settings["debuglevel"]
2549
use_dbus = server_settings["use_dbus"]
2550
use_ipv6 = server_settings["use_ipv6"]
2551
stored_state_path = os.path.join(server_settings["statedir"],
2553
foreground = server_settings["foreground"]
2554
zeroconf = server_settings["zeroconf"]
2557
initlogger(debug, logging.DEBUG)
2562
level = getattr(logging, debuglevel.upper())
2563
initlogger(debug, level)
732
syslogger.setLevel(logging.WARNING)
733
console.setLevel(logging.WARNING)
2565
735
if server_settings["servicename"] != "Mandos":
2566
syslogger.setFormatter(
2567
logging.Formatter('Mandos ({}) [%(process)d]:'
2568
' %(levelname)s: %(message)s'.format(
2569
server_settings["servicename"])))
736
syslogger.setFormatter(logging.Formatter\
737
('Mandos (%s): %%(levelname)s:'
739
% server_settings["servicename"]))
2571
741
# Parse config file with clients
2572
client_config = configparser.SafeConfigParser(Client
742
client_defaults = { "timeout": "1h",
744
"checker": "fping -q -- %(host)s",
747
client_config = ConfigParser.SafeConfigParser(client_defaults)
2574
748
client_config.read(os.path.join(server_settings["configdir"],
2575
749
"clients.conf"))
2577
global mandos_dbus_service
2578
mandos_dbus_service = None
2581
if server_settings["socket"] != "":
2582
socketfd = server_settings["socket"]
2583
tcp_server = MandosServer(
2584
(server_settings["address"], server_settings["port"]),
2586
interface=(server_settings["interface"] or None),
2588
gnutls_priority=server_settings["priority"],
2592
pidfilename = "/run/mandos.pid"
2593
if not os.path.isdir("/run/."):
2594
pidfilename = "/var/run/mandos.pid"
2597
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2598
except IOError as e:
2599
logger.error("Could not open file %r", pidfilename,
2602
for name in ("_mandos", "mandos", "nobody"):
2604
uid = pwd.getpwnam(name).pw_uid
2605
gid = pwd.getpwnam(name).pw_gid
2615
except OSError as error:
2616
if error.errno != errno.EPERM:
2620
# Enable all possible GnuTLS debugging
2622
# "Use a log level over 10 to enable all debugging options."
2624
gnutls.library.functions.gnutls_global_set_log_level(11)
2626
@gnutls.library.types.gnutls_log_func
2627
def debug_gnutls(level, string):
2628
logger.debug("GnuTLS: %s", string[:-1])
2630
gnutls.library.functions.gnutls_global_set_log_function(
2633
# Redirect stdin so all checkers get /dev/null
2634
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2635
os.dup2(null, sys.stdin.fileno())
2639
# Need to fork before connecting to D-Bus
2641
# Close all input and output, do double fork, etc.
2644
# multiprocessing will use threads, so before we use gobject we
2645
# need to inform gobject that threads will be used.
2646
gobject.threads_init()
752
service = AvahiService(name = server_settings["servicename"],
753
type = "_mandos._tcp", );
754
if server_settings["interface"]:
755
service.interface = if_nametoindex(server_settings["interface"])
2648
757
global main_loop
2649
760
# From the Avahi example code
2650
DBusGMainLoop(set_as_default=True)
761
DBusGMainLoop(set_as_default=True )
2651
762
main_loop = gobject.MainLoop()
2652
763
bus = dbus.SystemBus()
764
server = dbus.Interface(
765
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
766
avahi.DBUS_INTERFACE_SERVER )
2653
767
# End of Avahi example code
2656
bus_name = dbus.service.BusName("se.recompile.Mandos",
2659
old_bus_name = dbus.service.BusName(
2660
"se.bsnet.fukt.Mandos", bus,
2662
except dbus.exceptions.DBusException as e:
2663
logger.error("Disabling D-Bus:", exc_info=e)
2665
server_settings["use_dbus"] = False
2666
tcp_server.use_dbus = False
2668
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2669
service = AvahiServiceToSyslog(
2670
name = server_settings["servicename"],
2671
servicetype = "_mandos._tcp",
2672
protocol = protocol,
2674
if server_settings["interface"]:
2675
service.interface = if_nametoindex(
2676
server_settings["interface"].encode("utf-8"))
2678
global multiprocessing_manager
2679
multiprocessing_manager = multiprocessing.Manager()
2681
client_class = Client
2683
client_class = functools.partial(ClientDBus, bus = bus)
2685
client_settings = Client.config_parser(client_config)
2686
old_client_settings = {}
2689
# This is used to redirect stdout and stderr for checker processes
2691
wnull = open(os.devnull, "w") # A writable /dev/null
2692
# Only used if server is running in foreground but not in debug
2694
if debug or not foreground:
2697
# Get client data and settings from last running state.
2698
if server_settings["restore"]:
2700
with open(stored_state_path, "rb") as stored_state:
2701
clients_data, old_client_settings = pickle.load(
2703
os.remove(stored_state_path)
2704
except IOError as e:
2705
if e.errno == errno.ENOENT:
2706
logger.warning("Could not load persistent state:"
2707
" {}".format(os.strerror(e.errno)))
2709
logger.critical("Could not load persistent state:",
2712
except EOFError as e:
2713
logger.warning("Could not load persistent state: "
2717
with PGPEngine() as pgp:
2718
for client_name, client in clients_data.items():
2719
# Skip removed clients
2720
if client_name not in client_settings:
2723
# Decide which value to use after restoring saved state.
2724
# We have three different values: Old config file,
2725
# new config file, and saved state.
2726
# New config value takes precedence if it differs from old
2727
# config value, otherwise use saved state.
2728
for name, value in client_settings[client_name].items():
2730
# For each value in new config, check if it
2731
# differs from the old config value (Except for
2732
# the "secret" attribute)
2733
if (name != "secret"
2735
old_client_settings[client_name][name])):
2736
client[name] = value
2740
# Clients who has passed its expire date can still be
2741
# enabled if its last checker was successful. A Client
2742
# whose checker succeeded before we stored its state is
2743
# assumed to have successfully run all checkers during
2745
if client["enabled"]:
2746
if datetime.datetime.utcnow() >= client["expires"]:
2747
if not client["last_checked_ok"]:
2749
"disabling client {} - Client never "
2750
"performed a successful checker".format(
2752
client["enabled"] = False
2753
elif client["last_checker_status"] != 0:
2755
"disabling client {} - Client last"
2756
" checker failed with error code"
2759
client["last_checker_status"]))
2760
client["enabled"] = False
2762
client["expires"] = (
2763
datetime.datetime.utcnow()
2764
+ client["timeout"])
2765
logger.debug("Last checker succeeded,"
2766
" keeping {} enabled".format(
2769
client["secret"] = pgp.decrypt(
2770
client["encrypted_secret"],
2771
client_settings[client_name]["secret"])
2773
# If decryption fails, we use secret from new settings
2774
logger.debug("Failed to decrypt {} old secret".format(
2776
client["secret"] = (client_settings[client_name]
2779
# Add/remove clients based on new changes made to config
2780
for client_name in (set(old_client_settings)
2781
- set(client_settings)):
2782
del clients_data[client_name]
2783
for client_name in (set(client_settings)
2784
- set(old_client_settings)):
2785
clients_data[client_name] = client_settings[client_name]
2787
# Create all client objects
2788
for client_name, client in clients_data.items():
2789
tcp_server.clients[client_name] = client_class(
2792
server_settings = server_settings)
2794
if not tcp_server.clients:
2795
logger.warning("No clients defined")
2798
if pidfile is not None:
2802
print(pid, file=pidfile)
2804
logger.error("Could not write to file %r with PID %d",
770
def remove_from_clients(client):
771
clients.remove(client)
773
logger.critical(u"No clients left, exiting")
776
clients.update(Set(Client(name = section,
777
stop_hook = remove_from_clients,
779
= dict(client_config.items(section)))
780
for section in client_config.sections()))
782
logger.critical(u"No clients defined")
786
# Redirect stdin so all checkers get /dev/null
787
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
788
os.dup2(null, sys.stdin.fileno())
793
logger.removeHandler(console)
794
# Close all input and output, do double fork, etc.
797
pidfilename = "/var/run/mandos/mandos.pid"
800
pidfile = open(pidfilename, "w")
801
pidfile.write(str(pid) + "\n")
2809
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2810
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2814
@alternate_dbus_interfaces(
2815
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2816
class MandosDBusService(DBusObjectWithAnnotations):
2817
"""A D-Bus proxy object"""
2820
dbus.service.Object.__init__(self, bus, "/")
2822
_interface = "se.recompile.Mandos"
2824
@dbus.service.signal(_interface, signature="o")
2825
def ClientAdded(self, objpath):
2829
@dbus.service.signal(_interface, signature="ss")
2830
def ClientNotFound(self, fingerprint, address):
2834
@dbus.service.signal(_interface, signature="os")
2835
def ClientRemoved(self, objpath, name):
2839
@dbus.service.method(_interface, out_signature="ao")
2840
def GetAllClients(self):
2842
return dbus.Array(c.dbus_object_path for c in
2843
tcp_server.clients.itervalues())
2845
@dbus.service.method(_interface,
2846
out_signature="a{oa{sv}}")
2847
def GetAllClientsWithProperties(self):
2849
return dbus.Dictionary(
2850
{ c.dbus_object_path: c.GetAll("")
2851
for c in tcp_server.clients.itervalues() },
2854
@dbus.service.method(_interface, in_signature="o")
2855
def RemoveClient(self, object_path):
2857
for c in tcp_server.clients.itervalues():
2858
if c.dbus_object_path == object_path:
2859
del tcp_server.clients[c.name]
2860
c.remove_from_connection()
2861
# Don't signal anything except ClientRemoved
2862
c.disable(quiet=True)
2864
self.ClientRemoved(object_path, c.name)
2866
raise KeyError(object_path)
2870
mandos_dbus_service = MandosDBusService()
805
logger.error(u"Could not write %s file with PID %d",
806
pidfilename, os.getpid())
2873
809
"Cleanup function; run on exit"
2877
multiprocessing.active_children()
2879
if not (tcp_server.clients or client_settings):
2882
# Store client before exiting. Secrets are encrypted with key
2883
# based on what config file has. If config file is
2884
# removed/edited, old secret will thus be unrecovable.
2886
with PGPEngine() as pgp:
2887
for client in tcp_server.clients.itervalues():
2888
key = client_settings[client.name]["secret"]
2889
client.encrypted_secret = pgp.encrypt(client.secret,
2893
# A list of attributes that can not be pickled
2895
exclude = { "bus", "changedstate", "secret",
2896
"checker", "server_settings" }
2897
for name, typ in inspect.getmembers(dbus.service
2901
client_dict["encrypted_secret"] = (client
2903
for attr in client.client_structure:
2904
if attr not in exclude:
2905
client_dict[attr] = getattr(client, attr)
2907
clients[client.name] = client_dict
2908
del client_settings[client.name]["secret"]
2911
with tempfile.NamedTemporaryFile(
2915
dir=os.path.dirname(stored_state_path),
2916
delete=False) as stored_state:
2917
pickle.dump((clients, client_settings), stored_state)
2918
tempname = stored_state.name
2919
os.rename(tempname, stored_state_path)
2920
except (IOError, OSError) as e:
2926
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2927
logger.warning("Could not save persistent state: {}"
2928
.format(os.strerror(e.errno)))
2930
logger.warning("Could not save persistent state:",
2934
# Delete all clients, and settings from config
2935
while tcp_server.clients:
2936
name, client = tcp_server.clients.popitem()
2938
client.remove_from_connection()
2939
# Don't signal anything except ClientRemoved
2940
client.disable(quiet=True)
2943
mandos_dbus_service.ClientRemoved(
2944
client.dbus_object_path, client.name)
2945
client_settings.clear()
811
# From the Avahi example code
812
if not group is None:
815
# End of Avahi example code
818
client = clients.pop()
819
client.stop_hook = None
2947
822
atexit.register(cleanup)
2949
for client in tcp_server.clients.itervalues():
2952
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2953
# Need to initiate checking of clients
2955
client.init_checker()
2958
tcp_server.server_activate()
825
signal.signal(signal.SIGINT, signal.SIG_IGN)
826
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
827
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
829
for client in clients:
832
tcp_server = IPv6_TCPServer((server_settings["address"],
833
server_settings["port"]),
835
settings=server_settings,
2960
837
# Find out what port we got
2962
service.port = tcp_server.socket.getsockname()[1]
2964
logger.info("Now listening on address %r, port %d,"
2965
" flowinfo %d, scope_id %d",
2966
*tcp_server.socket.getsockname())
2968
logger.info("Now listening on address %r, port %d",
2969
*tcp_server.socket.getsockname())
838
service.port = tcp_server.socket.getsockname()[1]
839
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
840
u" scope_id %d" % tcp_server.socket.getsockname())
2971
842
#service.interface = tcp_server.socket.getsockname()[3]
2975
# From the Avahi example code
2978
except dbus.exceptions.DBusException as error:
2979
logger.critical("D-Bus Exception", exc_info=error)
2982
# End of Avahi example code
845
# From the Avahi example code
846
server.connect_to_signal("StateChanged", server_state_changed)
848
server_state_changed(server.GetState())
849
except dbus.exceptions.DBusException, error:
850
logger.critical(u"DBusException: %s", error)
852
# End of Avahi example code
2984
854
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2985
855
lambda *args, **kwargs:
2986
(tcp_server.handle_request
2987
(*args[2:], **kwargs) or True))
856
tcp_server.handle_request\
857
(*args[2:], **kwargs) or True)
2989
logger.debug("Starting main loop")
859
logger.debug(u"Starting main loop")
860
main_loop_started = True
2991
except AvahiError as error:
2992
logger.critical("Avahi Error", exc_info=error)
862
except AvahiError, error:
863
logger.critical(u"AvahiError: %s" + unicode(error))
2995
865
except KeyboardInterrupt:
2997
print("", file=sys.stderr)
2998
logger.debug("Server received KeyboardInterrupt")
2999
logger.debug("Server exiting")
3000
# Must run before the D-Bus bus name gets deregistered
3004
869
if __name__ == '__main__':