100
80
except ImportError:
101
81
SO_BINDTODEVICE = None
103
if sys.version_info.major == 2:
107
stored_state_file = "clients.pickle"
109
logger = logging.getLogger()
113
if_nametoindex = ctypes.cdll.LoadLibrary(
114
ctypes.util.find_library("c")).if_nametoindex
115
except (OSError, AttributeError):
117
def if_nametoindex(interface):
118
"Get an interface index the hard way, i.e. using fcntl()"
119
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
120
with contextlib.closing(socket.socket()) as s:
121
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
122
struct.pack(b"16s16x", interface))
123
interface_index = struct.unpack("I", ifreq[16:20])[0]
124
return interface_index
127
def initlogger(debug, level=logging.WARNING):
128
"""init logger and add loglevel"""
131
syslogger = (logging.handlers.SysLogHandler(
132
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
133
address = "/dev/log"))
134
syslogger.setFormatter(logging.Formatter
135
('Mandos [%(process)d]: %(levelname)s:'
137
logger.addHandler(syslogger)
140
console = logging.StreamHandler()
141
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
145
logger.addHandler(console)
146
logger.setLevel(level)
149
class PGPError(Exception):
150
"""Exception if encryption/decryption fails"""
154
class PGPEngine(object):
155
"""A simple class for OpenPGP symmetric encryption & decryption"""
158
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
159
self.gnupgargs = ['--batch',
160
'--home', self.tempdir,
168
def __exit__(self, exc_type, exc_value, traceback):
176
if self.tempdir is not None:
177
# Delete contents of tempdir
178
for root, dirs, files in os.walk(self.tempdir,
180
for filename in files:
181
os.remove(os.path.join(root, filename))
183
os.rmdir(os.path.join(root, dirname))
185
os.rmdir(self.tempdir)
188
def password_encode(self, password):
189
# Passphrase can not be empty and can not contain newlines or
190
# NUL bytes. So we prefix it and hex encode it.
191
encoded = b"mandos" + binascii.hexlify(password)
192
if len(encoded) > 2048:
193
# GnuPG can't handle long passwords, so encode differently
194
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
195
.replace(b"\n", b"\\n")
196
.replace(b"\0", b"\\x00"))
199
def encrypt(self, data, password):
200
passphrase = self.password_encode(password)
201
with tempfile.NamedTemporaryFile(
202
dir=self.tempdir) as passfile:
203
passfile.write(passphrase)
205
proc = subprocess.Popen(['gpg', '--symmetric',
209
stdin = subprocess.PIPE,
210
stdout = subprocess.PIPE,
211
stderr = subprocess.PIPE)
212
ciphertext, err = proc.communicate(input = data)
213
if proc.returncode != 0:
217
def decrypt(self, data, password):
218
passphrase = self.password_encode(password)
219
with tempfile.NamedTemporaryFile(
220
dir = self.tempdir) as passfile:
221
passfile.write(passphrase)
223
proc = subprocess.Popen(['gpg', '--decrypt',
227
stdin = subprocess.PIPE,
228
stdout = subprocess.PIPE,
229
stderr = subprocess.PIPE)
230
decrypted_plaintext, err = proc.communicate(input = data)
231
if proc.returncode != 0:
233
return decrypted_plaintext
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
88
syslogger = (logging.handlers.SysLogHandler
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
94
logger.addHandler(syslogger)
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
100
logger.addHandler(console)
236
102
class AvahiError(Exception):
237
103
def __init__(self, value, *args, **kwargs):
238
104
self.value = value
239
return super(AvahiError, self).__init__(value, *args,
105
super(AvahiError, self).__init__(value, *args, **kwargs)
106
def __unicode__(self):
107
return unicode(repr(self.value))
243
109
class AvahiServiceError(AvahiError):
247
112
class AvahiGroupError(AvahiError):
472
263
interval: datetime.timedelta(); How often to start a new checker
473
264
last_approval_request: datetime.datetime(); (UTC) or None
474
265
last_checked_ok: datetime.datetime(); (UTC) or None
475
last_checker_status: integer between 0 and 255 reflecting exit
476
status of last checker. -1 reflects crashed
477
checker, -2 means no checker completed yet.
478
last_checker_signal: The signal which killed the last checker, if
479
last_checker_status is -1
480
last_enabled: datetime.datetime(); (UTC) or None
266
last_enabled: datetime.datetime(); (UTC)
481
267
name: string; from the config file, used in log messages and
482
268
D-Bus identifiers
483
269
secret: bytestring; sent verbatim (over TLS) to client
484
270
timeout: datetime.timedelta(); How long from last_checked_ok
485
271
until this client is disabled
486
extended_timeout: extra long timeout when secret has been sent
487
272
runtime_expansions: Allowed attributes for runtime expansion.
488
expires: datetime.datetime(); time (UTC) when a client will be
490
server_settings: The server_settings dict from main()
493
runtime_expansions = ("approval_delay", "approval_duration",
494
"created", "enabled", "expires",
495
"fingerprint", "host", "interval",
496
"last_approval_request", "last_checked_ok",
497
"last_enabled", "name", "timeout")
500
"extended_timeout": "PT15M",
502
"checker": "fping -q -- %%(host)s",
504
"approval_delay": "PT0S",
505
"approval_duration": "PT1S",
506
"approved_by_default": "True",
275
runtime_expansions = (u"approval_delay", u"approval_duration",
276
u"created", u"enabled", u"fingerprint",
277
u"host", u"interval", u"last_checked_ok",
278
u"last_enabled", u"name", u"timeout")
511
def config_parser(config):
512
"""Construct a new dict of client settings of this form:
513
{ client_name: {setting_name: value, ...}, ...}
514
with exceptions for any special settings as defined above.
515
NOTE: Must be a pure function. Must return the same result
516
value given the same arguments.
519
for client_name in config.sections():
520
section = dict(config.items(client_name))
521
client = settings[client_name] = {}
523
client["host"] = section["host"]
524
# Reformat values from string types to Python types
525
client["approved_by_default"] = config.getboolean(
526
client_name, "approved_by_default")
527
client["enabled"] = config.getboolean(client_name,
530
# Uppercase and remove spaces from fingerprint for later
531
# comparison purposes with return value from the
532
# fingerprint() function
533
client["fingerprint"] = (section["fingerprint"].upper()
535
if "secret" in section:
536
client["secret"] = section["secret"].decode("base64")
537
elif "secfile" in section:
538
with open(os.path.expanduser(os.path.expandvars
539
(section["secfile"])),
541
client["secret"] = secfile.read()
543
raise TypeError("No secret or secfile for section {}"
545
client["timeout"] = string_to_delta(section["timeout"])
546
client["extended_timeout"] = string_to_delta(
547
section["extended_timeout"])
548
client["interval"] = string_to_delta(section["interval"])
549
client["approval_delay"] = string_to_delta(
550
section["approval_delay"])
551
client["approval_duration"] = string_to_delta(
552
section["approval_duration"])
553
client["checker_command"] = section["checker"]
554
client["last_approval_request"] = None
555
client["last_checked_ok"] = None
556
client["last_checker_status"] = -2
560
def __init__(self, settings, name = None, server_settings=None):
281
def _timedelta_to_milliseconds(td):
282
"Convert a datetime.timedelta() to milliseconds"
283
return ((td.days * 24 * 60 * 60 * 1000)
284
+ (td.seconds * 1000)
285
+ (td.microseconds // 1000))
287
def timeout_milliseconds(self):
288
"Return the 'timeout' attribute in milliseconds"
289
return self._timedelta_to_milliseconds(self.timeout)
291
def interval_milliseconds(self):
292
"Return the 'interval' attribute in milliseconds"
293
return self._timedelta_to_milliseconds(self.interval)
295
def approval_delay_milliseconds(self):
296
return self._timedelta_to_milliseconds(self.approval_delay)
298
def __init__(self, name = None, disable_hook=None, config=None):
299
"""Note: the 'checker' key in 'config' sets the
300
'checker_command' attribute and *not* the 'checker'
562
if server_settings is None:
564
self.server_settings = server_settings
565
# adding all client settings
566
for setting, value in settings.items():
567
setattr(self, setting, value)
570
if not hasattr(self, "last_enabled"):
571
self.last_enabled = datetime.datetime.utcnow()
572
if not hasattr(self, "expires"):
573
self.expires = (datetime.datetime.utcnow()
305
logger.debug(u"Creating client %r", self.name)
306
# Uppercase and remove spaces from fingerprint for later
307
# comparison purposes with return value from the fingerprint()
309
self.fingerprint = (config[u"fingerprint"].upper()
311
logger.debug(u" Fingerprint: %s", self.fingerprint)
312
if u"secret" in config:
313
self.secret = config[u"secret"].decode(u"base64")
314
elif u"secfile" in config:
315
with open(os.path.expanduser(os.path.expandvars
316
(config[u"secfile"])),
318
self.secret = secfile.read()
576
self.last_enabled = None
579
logger.debug("Creating client %r", self.name)
580
logger.debug(" Fingerprint: %s", self.fingerprint)
581
self.created = settings.get("created",
582
datetime.datetime.utcnow())
584
# attributes specific for this server instance
320
raise TypeError(u"No secret or secfile for client %s"
322
self.host = config.get(u"host", u"")
323
self.created = datetime.datetime.utcnow()
325
self.last_approval_request = None
326
self.last_enabled = None
327
self.last_checked_ok = None
328
self.timeout = string_to_delta(config[u"timeout"])
329
self.interval = string_to_delta(config[u"interval"])
330
self.disable_hook = disable_hook
585
331
self.checker = None
586
332
self.checker_initiator_tag = None
587
333
self.disable_initiator_tag = None
588
334
self.checker_callback_tag = None
335
self.checker_command = config[u"checker"]
589
336
self.current_checker_command = None
337
self.last_connect = None
338
self._approved = None
339
self.approved_by_default = config.get(u"approved_by_default",
591
341
self.approvals_pending = 0
592
self.changedstate = multiprocessing_manager.Condition(
593
multiprocessing_manager.Lock())
594
self.client_structure = [attr
595
for attr in self.__dict__.iterkeys()
596
if not attr.startswith("_")]
597
self.client_structure.append("client_structure")
599
for name, t in inspect.getmembers(
600
type(self), lambda obj: isinstance(obj, property)):
601
if not name.startswith("_"):
602
self.client_structure.append(name)
342
self.approval_delay = string_to_delta(
343
config[u"approval_delay"])
344
self.approval_duration = string_to_delta(
345
config[u"approval_duration"])
346
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
604
# Send notice to process children that client state has changed
605
348
def send_changedstate(self):
606
with self.changedstate:
607
self.changedstate.notify_all()
349
self.changedstate.acquire()
350
self.changedstate.notify_all()
351
self.changedstate.release()
609
353
def enable(self):
610
354
"""Start this client's checker and timeout hooks"""
611
if getattr(self, "enabled", False):
355
if getattr(self, u"enabled", False):
612
356
# Already enabled
614
self.expires = datetime.datetime.utcnow() + self.timeout
358
self.send_changedstate()
616
359
self.last_enabled = datetime.datetime.utcnow()
618
self.send_changedstate()
360
# Schedule a new checker to be started an 'interval' from now,
361
# and every interval from then on.
362
self.checker_initiator_tag = (gobject.timeout_add
363
(self.interval_milliseconds(),
365
# Schedule a disable() when 'timeout' has passed
366
self.disable_initiator_tag = (gobject.timeout_add
367
(self.timeout_milliseconds(),
370
# Also start a new checker *right now*.
620
373
def disable(self, quiet=True):
621
374
"""Disable this client."""
622
375
if not getattr(self, "enabled", False):
625
logger.info("Disabling client %s", self.name)
626
if getattr(self, "disable_initiator_tag", None) is not None:
378
self.send_changedstate()
380
logger.info(u"Disabling client %s", self.name)
381
if getattr(self, u"disable_initiator_tag", False):
627
382
gobject.source_remove(self.disable_initiator_tag)
628
383
self.disable_initiator_tag = None
630
if getattr(self, "checker_initiator_tag", None) is not None:
384
if getattr(self, u"checker_initiator_tag", False):
631
385
gobject.source_remove(self.checker_initiator_tag)
632
386
self.checker_initiator_tag = None
633
387
self.stop_checker()
388
if self.disable_hook:
389
self.disable_hook(self)
634
390
self.enabled = False
636
self.send_changedstate()
637
391
# Do not run this again if called by a gobject.timeout_add
640
394
def __del__(self):
395
self.disable_hook = None
643
def init_checker(self):
644
# Schedule a new checker to be started an 'interval' from now,
645
# and every interval from then on.
646
if self.checker_initiator_tag is not None:
647
gobject.source_remove(self.checker_initiator_tag)
648
self.checker_initiator_tag = gobject.timeout_add(
649
int(self.interval.total_seconds() * 1000),
651
# Schedule a disable() when 'timeout' has passed
652
if self.disable_initiator_tag is not None:
653
gobject.source_remove(self.disable_initiator_tag)
654
self.disable_initiator_tag = gobject.timeout_add(
655
int(self.timeout.total_seconds() * 1000), self.disable)
656
# Also start a new checker *right now*.
659
def checker_callback(self, source, condition, connection,
398
def checker_callback(self, pid, condition, command):
661
399
"""The checker has completed, so take appropriate actions."""
662
400
self.checker_callback_tag = None
663
401
self.checker = None
664
# Read return code from connection (see call_pipe)
665
returncode = connection.recv()
669
self.last_checker_status = returncode
670
self.last_checker_signal = None
671
if self.last_checker_status == 0:
672
logger.info("Checker for %(name)s succeeded",
402
if os.WIFEXITED(condition):
403
exitstatus = os.WEXITSTATUS(condition)
405
logger.info(u"Checker for %(name)s succeeded",
674
407
self.checked_ok()
676
logger.info("Checker for %(name)s failed", vars(self))
409
logger.info(u"Checker for %(name)s failed",
678
self.last_checker_status = -1
679
self.last_checker_signal = -returncode
680
logger.warning("Checker for %(name)s crashed?",
412
logger.warning(u"Checker for %(name)s crashed?",
684
415
def checked_ok(self):
685
"""Assert that the client has been seen, alive and well."""
416
"""Bump up the timeout for this client.
418
This should only be called when the client has been seen,
686
421
self.last_checked_ok = datetime.datetime.utcnow()
687
self.last_checker_status = 0
688
self.last_checker_signal = None
691
def bump_timeout(self, timeout=None):
692
"""Bump up the timeout for this client."""
694
timeout = self.timeout
695
if self.disable_initiator_tag is not None:
696
gobject.source_remove(self.disable_initiator_tag)
697
self.disable_initiator_tag = None
698
if getattr(self, "enabled", False):
699
self.disable_initiator_tag = gobject.timeout_add(
700
int(timeout.total_seconds() * 1000), self.disable)
701
self.expires = datetime.datetime.utcnow() + timeout
422
gobject.source_remove(self.disable_initiator_tag)
423
self.disable_initiator_tag = (gobject.timeout_add
424
(self.timeout_milliseconds(),
703
427
def need_approval(self):
704
428
self.last_approval_request = datetime.datetime.utcnow()
709
433
If a checker already exists, leave it running and do
711
435
# The reason for not killing a running checker is that if we
712
# did that, and if a checker (for some reason) started running
713
# slowly and taking more than 'interval' time, then the client
714
# would inevitably timeout, since no checker would get a
715
# chance to run to completion. If we instead leave running
436
# did that, then if a checker (for some reason) started
437
# running slowly and taking more than 'interval' time, the
438
# client would inevitably timeout, since no checker would get
439
# a chance to run to completion. If we instead leave running
716
440
# checkers alone, the checker would have to take more time
717
441
# than 'timeout' for the client to be disabled, which is as it
720
if self.checker is not None and not self.checker.is_alive():
721
logger.warning("Checker was not alive; joining")
444
# If a checker exists, make sure it is not a zombie
446
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
447
except (AttributeError, OSError), error:
448
if (isinstance(error, OSError)
449
and error.errno != errno.ECHILD):
453
logger.warning(u"Checker was a zombie")
454
gobject.source_remove(self.checker_callback_tag)
455
self.checker_callback(pid, status,
456
self.current_checker_command)
724
457
# Start a new checker if needed
725
458
if self.checker is None:
726
# Escape attributes for the shell
728
attr: re.escape(str(getattr(self, attr)))
729
for attr in self.runtime_expansions }
731
command = self.checker_command % escaped_attrs
732
except TypeError as error:
733
logger.error('Could not format string "%s"',
734
self.checker_command,
736
return True # Try again later
460
# In case checker_command has exactly one % operator
461
command = self.checker_command % self.host
463
# Escape attributes for the shell
464
escaped_attrs = dict(
466
re.escape(unicode(str(getattr(self, attr, u"")),
470
self.runtime_expansions)
473
command = self.checker_command % escaped_attrs
474
except TypeError, error:
475
logger.error(u'Could not format string "%s":'
476
u' %s', self.checker_command, error)
477
return True # Try again later
737
478
self.current_checker_command = command
738
logger.info("Starting checker %r for %s", command,
740
# We don't need to redirect stdout and stderr, since
741
# in normal mode, that is already done by daemon(),
742
# and in debug mode we don't want to. (Stdin is
743
# always replaced by /dev/null.)
744
# The exception is when not debugging but nevertheless
745
# running in the foreground; use the previously
747
popen_args = { "close_fds": True,
750
if (not self.server_settings["debug"]
751
and self.server_settings["foreground"]):
752
popen_args.update({"stdout": wnull,
754
pipe = multiprocessing.Pipe(duplex = False)
755
self.checker = multiprocessing.Process(
757
args = (pipe[1], subprocess.call, command),
760
self.checker_callback_tag = gobject.io_add_watch(
761
pipe[0].fileno(), gobject.IO_IN,
762
self.checker_callback, pipe[0], command)
480
logger.info(u"Starting checker %r for %s",
482
# We don't need to redirect stdout and stderr, since
483
# in normal mode, that is already done by daemon(),
484
# and in debug mode we don't want to. (Stdin is
485
# always replaced by /dev/null.)
486
self.checker = subprocess.Popen(command,
488
shell=True, cwd=u"/")
489
self.checker_callback_tag = (gobject.child_watch_add
491
self.checker_callback,
493
# The checker may have completed before the gobject
494
# watch was added. Check for this.
495
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
497
gobject.source_remove(self.checker_callback_tag)
498
self.checker_callback(pid, status, command)
499
except OSError, error:
500
logger.error(u"Failed to start subprocess: %s",
763
502
# Re-run this periodically if run by gobject.timeout_add
873
class DBusObjectWithAnnotations(dbus.service.Object):
874
"""A D-Bus object with annotations.
876
Classes inheriting from this can use the dbus_annotations
877
decorator to add annotations to methods or signals.
881
def _is_dbus_thing(thing):
882
"""Returns a function testing if an attribute is a D-Bus thing
884
If called like _is_dbus_thing("method") it returns a function
885
suitable for use as predicate to inspect.getmembers().
887
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
890
def _get_all_dbus_things(self, thing):
891
"""Returns a generator of (name, attribute) pairs
893
return ((getattr(athing.__get__(self), "_dbus_name", name),
894
athing.__get__(self))
895
for cls in self.__class__.__mro__
897
inspect.getmembers(cls, self._is_dbus_thing(thing)))
899
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
901
path_keyword = 'object_path',
902
connection_keyword = 'connection')
903
def Introspect(self, object_path, connection):
904
"""Overloading of standard D-Bus method.
906
Inserts annotation tags on methods and signals.
908
xmlstring = dbus.service.Object.Introspect(self, object_path,
911
document = xml.dom.minidom.parseString(xmlstring)
913
for if_tag in document.getElementsByTagName("interface"):
914
# Add annotation tags
915
for typ in ("method", "signal"):
916
for tag in if_tag.getElementsByTagName(typ):
918
for name, prop in (self.
919
_get_all_dbus_things(typ)):
920
if (name == tag.getAttribute("name")
921
and prop._dbus_interface
922
== if_tag.getAttribute("name")):
923
annots.update(getattr(
924
prop, "_dbus_annotations", {}))
925
for name, value in annots.items():
926
ann_tag = document.createElement(
928
ann_tag.setAttribute("name", name)
929
ann_tag.setAttribute("value", value)
930
tag.appendChild(ann_tag)
931
# Add interface annotation tags
932
for annotation, value in dict(
933
itertools.chain.from_iterable(
934
annotations().items()
935
for name, annotations
936
in self._get_all_dbus_things("interface")
937
if name == if_tag.getAttribute("name")
939
ann_tag = document.createElement("annotation")
940
ann_tag.setAttribute("name", annotation)
941
ann_tag.setAttribute("value", value)
942
if_tag.appendChild(ann_tag)
943
# Fix argument name for the Introspect method itself
944
if (if_tag.getAttribute("name")
945
== dbus.INTROSPECTABLE_IFACE):
946
for cn in if_tag.getElementsByTagName("method"):
947
if cn.getAttribute("name") == "Introspect":
948
for arg in cn.getElementsByTagName("arg"):
949
if (arg.getAttribute("direction")
951
arg.setAttribute("name",
953
xmlstring = document.toxml("utf-8")
955
except (AttributeError, xml.dom.DOMException,
956
xml.parsers.expat.ExpatError) as error:
957
logger.error("Failed to override Introspection method",
962
class DBusObjectWithProperties(DBusObjectWithAnnotations):
572
class DBusObjectWithProperties(dbus.service.Object):
963
573
"""A D-Bus object with properties.
965
575
Classes inheriting from this can use the dbus_service_property
966
576
decorator to expose methods as D-Bus properties. It exposes the
967
577
standard Get(), Set(), and GetAll() methods on the D-Bus.
581
def _is_dbus_property(obj):
582
return getattr(obj, u"_dbus_is_property", False)
584
def _get_all_dbus_properties(self):
585
"""Returns a generator of (name, attribute) pairs
587
return ((prop._dbus_name, prop)
589
inspect.getmembers(self, self._is_dbus_property))
970
591
def _get_dbus_property(self, interface_name, property_name):
971
592
"""Returns a bound method if one exists which is a D-Bus
972
593
property with the specified name and interface.
974
for cls in self.__class__.__mro__:
975
for name, value in inspect.getmembers(
976
cls, self._is_dbus_thing("property")):
977
if (value._dbus_name == property_name
978
and value._dbus_interface == interface_name):
979
return value.__get__(self)
595
for name in (property_name,
596
property_name + u"_dbus_property"):
597
prop = getattr(self, name, None)
599
or not self._is_dbus_property(prop)
600
or prop._dbus_name != property_name
601
or (interface_name and prop._dbus_interface
602
and interface_name != prop._dbus_interface)):
981
605
# No such property
982
raise DBusPropertyNotFound("{}:{}.{}".format(
983
self.dbus_object_path, interface_name, property_name))
986
def _get_all_interface_names(cls):
987
"""Get a sequence of all interfaces supported by an object"""
988
return (name for name in set(getattr(getattr(x, attr),
989
"_dbus_interface", None)
990
for x in (inspect.getmro(cls))
994
@dbus.service.method(dbus.PROPERTIES_IFACE,
606
raise DBusPropertyNotFound(self.dbus_object_path + u":"
607
+ interface_name + u"."
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
997
612
def Get(self, interface_name, property_name):
998
613
"""Standard D-Bus property Get() method, see D-Bus standard.
1000
615
prop = self._get_dbus_property(interface_name, property_name)
1001
if prop._dbus_access == "write":
616
if prop._dbus_access == u"write":
1002
617
raise DBusPropertyAccessException(property_name)
1004
if not hasattr(value, "variant_level"):
619
if not hasattr(value, u"variant_level"):
1006
621
return type(value)(value, variant_level=value.variant_level+1)
1008
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
623
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1009
624
def Set(self, interface_name, property_name, value):
1010
625
"""Standard D-Bus property Set() method, see D-Bus standard.
1012
627
prop = self._get_dbus_property(interface_name, property_name)
1013
if prop._dbus_access == "read":
628
if prop._dbus_access == u"read":
1014
629
raise DBusPropertyAccessException(property_name)
1015
if prop._dbus_get_args_options["byte_arrays"]:
630
if prop._dbus_get_args_options[u"byte_arrays"]:
1016
631
# The byte_arrays option is not supported yet on
1017
632
# signatures other than "ay".
1018
if prop._dbus_signature != "ay":
1019
raise ValueError("Byte arrays not supported for non-"
1020
"'ay' signature {!r}"
1021
.format(prop._dbus_signature))
1022
value = dbus.ByteArray(b''.join(chr(byte)
633
if prop._dbus_signature != u"ay":
635
value = dbus.ByteArray(''.join(unichr(byte)
1026
@dbus.service.method(dbus.PROPERTIES_IFACE,
1028
out_signature="a{sv}")
639
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
640
out_signature=u"a{sv}")
1029
641
def GetAll(self, interface_name):
1030
642
"""Standard D-Bus property GetAll() method, see D-Bus
1033
645
Note: Will not include properties with access="write".
1036
for name, prop in self._get_all_dbus_things("property"):
648
for name, prop in self._get_all_dbus_properties():
1037
649
if (interface_name
1038
650
and interface_name != prop._dbus_interface):
1039
651
# Interface non-empty but did not match
1041
653
# Ignore write-only properties
1042
if prop._dbus_access == "write":
654
if prop._dbus_access == u"write":
1045
if not hasattr(value, "variant_level"):
1046
properties[name] = value
657
if not hasattr(value, u"variant_level"):
1048
properties[name] = type(value)(
1049
value, variant_level = value.variant_level + 1)
1050
return dbus.Dictionary(properties, signature="sv")
1052
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1053
def PropertiesChanged(self, interface_name, changed_properties,
1054
invalidated_properties):
1055
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
660
all[name] = type(value)(value, variant_level=
661
value.variant_level+1)
662
return dbus.Dictionary(all, signature=u"sv")
1060
664
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1062
666
path_keyword='object_path',
1063
667
connection_keyword='connection')
1064
668
def Introspect(self, object_path, connection):
1065
"""Overloading of standard D-Bus method.
1067
Inserts property tags and interface annotation tags.
669
"""Standard D-Bus method, overloaded to insert property tags.
1069
xmlstring = DBusObjectWithAnnotations.Introspect(self,
671
xmlstring = dbus.service.Object.Introspect(self, object_path,
1073
674
document = xml.dom.minidom.parseString(xmlstring)
1075
675
def make_tag(document, name, prop):
1076
e = document.createElement("property")
1077
e.setAttribute("name", name)
1078
e.setAttribute("type", prop._dbus_signature)
1079
e.setAttribute("access", prop._dbus_access)
676
e = document.createElement(u"property")
677
e.setAttribute(u"name", name)
678
e.setAttribute(u"type", prop._dbus_signature)
679
e.setAttribute(u"access", prop._dbus_access)
1082
for if_tag in document.getElementsByTagName("interface"):
681
for if_tag in document.getElementsByTagName(u"interface"):
1084
682
for tag in (make_tag(document, name, prop)
1086
in self._get_all_dbus_things("property")
684
in self._get_all_dbus_properties()
1087
685
if prop._dbus_interface
1088
== if_tag.getAttribute("name")):
686
== if_tag.getAttribute(u"name")):
1089
687
if_tag.appendChild(tag)
1090
# Add annotation tags for properties
1091
for tag in if_tag.getElementsByTagName("property"):
1093
for name, prop in self._get_all_dbus_things(
1095
if (name == tag.getAttribute("name")
1096
and prop._dbus_interface
1097
== if_tag.getAttribute("name")):
1098
annots.update(getattr(
1099
prop, "_dbus_annotations", {}))
1100
for name, value in annots.items():
1101
ann_tag = document.createElement(
1103
ann_tag.setAttribute("name", name)
1104
ann_tag.setAttribute("value", value)
1105
tag.appendChild(ann_tag)
1106
688
# Add the names to the return values for the
1107
689
# "org.freedesktop.DBus.Properties" methods
1108
if (if_tag.getAttribute("name")
1109
== "org.freedesktop.DBus.Properties"):
1110
for cn in if_tag.getElementsByTagName("method"):
1111
if cn.getAttribute("name") == "Get":
1112
for arg in cn.getElementsByTagName("arg"):
1113
if (arg.getAttribute("direction")
1115
arg.setAttribute("name", "value")
1116
elif cn.getAttribute("name") == "GetAll":
1117
for arg in cn.getElementsByTagName("arg"):
1118
if (arg.getAttribute("direction")
1120
arg.setAttribute("name", "props")
1121
xmlstring = document.toxml("utf-8")
1123
except (AttributeError, xml.dom.DOMException,
1124
xml.parsers.expat.ExpatError) as error:
1125
logger.error("Failed to override Introspection method",
1130
dbus.OBJECT_MANAGER_IFACE
1131
except AttributeError:
1132
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1134
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1135
"""A D-Bus object with an ObjectManager.
1137
Classes inheriting from this exposes the standard
1138
GetManagedObjects call and the InterfacesAdded and
1139
InterfacesRemoved signals on the standard
1140
"org.freedesktop.DBus.ObjectManager" interface.
1142
Note: No signals are sent automatically; they must be sent
1145
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1146
out_signature = "a{oa{sa{sv}}}")
1147
def GetManagedObjects(self):
1148
"""This function must be overridden"""
1149
raise NotImplementedError()
1151
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1152
signature = "oa{sa{sv}}")
1153
def InterfacesAdded(self, object_path, interfaces_and_properties):
1156
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1157
def InterfacesRemoved(self, object_path, interfaces):
1160
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1161
out_signature = "s",
1162
path_keyword = 'object_path',
1163
connection_keyword = 'connection')
1164
def Introspect(self, object_path, connection):
1165
"""Overloading of standard D-Bus method.
1167
Override return argument name of GetManagedObjects to be
1168
"objpath_interfaces_and_properties"
1170
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1174
document = xml.dom.minidom.parseString(xmlstring)
1176
for if_tag in document.getElementsByTagName("interface"):
1177
# Fix argument name for the GetManagedObjects method
1178
if (if_tag.getAttribute("name")
1179
== dbus.OBJECT_MANAGER_IFACE):
1180
for cn in if_tag.getElementsByTagName("method"):
1181
if (cn.getAttribute("name")
1182
== "GetManagedObjects"):
1183
for arg in cn.getElementsByTagName("arg"):
1184
if (arg.getAttribute("direction")
1188
"objpath_interfaces"
1190
xmlstring = document.toxml("utf-8")
1192
except (AttributeError, xml.dom.DOMException,
1193
xml.parsers.expat.ExpatError) as error:
1194
logger.error("Failed to override Introspection method",
1198
def datetime_to_dbus(dt, variant_level=0):
1199
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1201
return dbus.String("", variant_level = variant_level)
1202
return dbus.String(dt.isoformat(), variant_level=variant_level)
1205
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1206
"""A class decorator; applied to a subclass of
1207
dbus.service.Object, it will add alternate D-Bus attributes with
1208
interface names according to the "alt_interface_names" mapping.
1211
@alternate_dbus_interfaces({"org.example.Interface":
1212
"net.example.AlternateInterface"})
1213
class SampleDBusObject(dbus.service.Object):
1214
@dbus.service.method("org.example.Interface")
1215
def SampleDBusMethod():
1218
The above "SampleDBusMethod" on "SampleDBusObject" will be
1219
reachable via two interfaces: "org.example.Interface" and
1220
"net.example.AlternateInterface", the latter of which will have
1221
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1222
"true", unless "deprecate" is passed with a False value.
1224
This works for methods and signals, and also for D-Bus properties
1225
(from DBusObjectWithProperties) and interfaces (from the
1226
dbus_interface_annotations decorator).
1230
for orig_interface_name, alt_interface_name in (
1231
alt_interface_names.items()):
1233
interface_names = set()
1234
# Go though all attributes of the class
1235
for attrname, attribute in inspect.getmembers(cls):
1236
# Ignore non-D-Bus attributes, and D-Bus attributes
1237
# with the wrong interface name
1238
if (not hasattr(attribute, "_dbus_interface")
1239
or not attribute._dbus_interface.startswith(
1240
orig_interface_name)):
1242
# Create an alternate D-Bus interface name based on
1244
alt_interface = attribute._dbus_interface.replace(
1245
orig_interface_name, alt_interface_name)
1246
interface_names.add(alt_interface)
1247
# Is this a D-Bus signal?
1248
if getattr(attribute, "_dbus_is_signal", False):
1249
if sys.version_info.major == 2:
1250
# Extract the original non-method undecorated
1251
# function by black magic
1252
nonmethod_func = (dict(
1253
zip(attribute.func_code.co_freevars,
1254
attribute.__closure__))
1255
["func"].cell_contents)
1257
nonmethod_func = attribute
1258
# Create a new, but exactly alike, function
1259
# object, and decorate it to be a new D-Bus signal
1260
# with the alternate D-Bus interface name
1261
if sys.version_info.major == 2:
1262
new_function = types.FunctionType(
1263
nonmethod_func.func_code,
1264
nonmethod_func.func_globals,
1265
nonmethod_func.func_name,
1266
nonmethod_func.func_defaults,
1267
nonmethod_func.func_closure)
1269
new_function = types.FunctionType(
1270
nonmethod_func.__code__,
1271
nonmethod_func.__globals__,
1272
nonmethod_func.__name__,
1273
nonmethod_func.__defaults__,
1274
nonmethod_func.__closure__)
1275
new_function = (dbus.service.signal(
1277
attribute._dbus_signature)(new_function))
1278
# Copy annotations, if any
1280
new_function._dbus_annotations = dict(
1281
attribute._dbus_annotations)
1282
except AttributeError:
1284
# Define a creator of a function to call both the
1285
# original and alternate functions, so both the
1286
# original and alternate signals gets sent when
1287
# the function is called
1288
def fixscope(func1, func2):
1289
"""This function is a scope container to pass
1290
func1 and func2 to the "call_both" function
1291
outside of its arguments"""
1293
@functools.wraps(func2)
1294
def call_both(*args, **kwargs):
1295
"""This function will emit two D-Bus
1296
signals by calling func1 and func2"""
1297
func1(*args, **kwargs)
1298
func2(*args, **kwargs)
1299
# Make wrapper function look like a D-Bus signal
1300
for name, attr in inspect.getmembers(func2):
1301
if name.startswith("_dbus_"):
1302
setattr(call_both, name, attr)
1305
# Create the "call_both" function and add it to
1307
attr[attrname] = fixscope(attribute, new_function)
1308
# Is this a D-Bus method?
1309
elif getattr(attribute, "_dbus_is_method", False):
1310
# Create a new, but exactly alike, function
1311
# object. Decorate it to be a new D-Bus method
1312
# with the alternate D-Bus interface name. Add it
1315
dbus.service.method(
1317
attribute._dbus_in_signature,
1318
attribute._dbus_out_signature)
1319
(types.FunctionType(attribute.func_code,
1320
attribute.func_globals,
1321
attribute.func_name,
1322
attribute.func_defaults,
1323
attribute.func_closure)))
1324
# Copy annotations, if any
1326
attr[attrname]._dbus_annotations = dict(
1327
attribute._dbus_annotations)
1328
except AttributeError:
1330
# Is this a D-Bus property?
1331
elif getattr(attribute, "_dbus_is_property", False):
1332
# Create a new, but exactly alike, function
1333
# object, and decorate it to be a new D-Bus
1334
# property with the alternate D-Bus interface
1335
# name. Add it to the class.
1336
attr[attrname] = (dbus_service_property(
1337
alt_interface, attribute._dbus_signature,
1338
attribute._dbus_access,
1339
attribute._dbus_get_args_options
1341
(types.FunctionType(
1342
attribute.func_code,
1343
attribute.func_globals,
1344
attribute.func_name,
1345
attribute.func_defaults,
1346
attribute.func_closure)))
1347
# Copy annotations, if any
1349
attr[attrname]._dbus_annotations = dict(
1350
attribute._dbus_annotations)
1351
except AttributeError:
1353
# Is this a D-Bus interface?
1354
elif getattr(attribute, "_dbus_is_interface", False):
1355
# Create a new, but exactly alike, function
1356
# object. Decorate it to be a new D-Bus interface
1357
# with the alternate D-Bus interface name. Add it
1360
dbus_interface_annotations(alt_interface)
1361
(types.FunctionType(attribute.func_code,
1362
attribute.func_globals,
1363
attribute.func_name,
1364
attribute.func_defaults,
1365
attribute.func_closure)))
1367
# Deprecate all alternate interfaces
1368
iname="_AlternateDBusNames_interface_annotation{}"
1369
for interface_name in interface_names:
1371
@dbus_interface_annotations(interface_name)
1373
return { "org.freedesktop.DBus.Deprecated":
1375
# Find an unused name
1376
for aname in (iname.format(i)
1377
for i in itertools.count()):
1378
if aname not in attr:
1382
# Replace the class with a new subclass of it with
1383
# methods, signals, etc. as created above.
1384
cls = type(b"{}Alternate".format(cls.__name__),
1391
@alternate_dbus_interfaces({"se.recompile.Mandos":
1392
"se.bsnet.fukt.Mandos"})
690
if (if_tag.getAttribute(u"name")
691
== u"org.freedesktop.DBus.Properties"):
692
for cn in if_tag.getElementsByTagName(u"method"):
693
if cn.getAttribute(u"name") == u"Get":
694
for arg in cn.getElementsByTagName(u"arg"):
695
if (arg.getAttribute(u"direction")
697
arg.setAttribute(u"name", u"value")
698
elif cn.getAttribute(u"name") == u"GetAll":
699
for arg in cn.getElementsByTagName(u"arg"):
700
if (arg.getAttribute(u"direction")
702
arg.setAttribute(u"name", u"props")
703
xmlstring = document.toxml(u"utf-8")
705
except (AttributeError, xml.dom.DOMException,
706
xml.parsers.expat.ExpatError), error:
707
logger.error(u"Failed to override Introspection method",
1393
712
class ClientDBus(Client, DBusObjectWithProperties):
1394
713
"""A Client class using D-Bus
1401
720
runtime_expansions = (Client.runtime_expansions
1402
+ ("dbus_object_path", ))
1404
_interface = "se.recompile.Mandos.Client"
721
+ (u"dbus_object_path",))
1406
723
# dbus.service.Object doesn't use super(), so we can't either.
1408
725
def __init__(self, bus = None, *args, **kwargs):
726
self._approvals_pending = 0
1410
728
Client.__init__(self, *args, **kwargs)
1411
729
# Only now, when this client is initialized, can it show up on
1413
client_object_name = str(self.name).translate(
1414
{ord("."): ord("_"),
1415
ord("-"): ord("_")})
1416
self.dbus_object_path = dbus.ObjectPath(
1417
"/clients/" + client_object_name)
731
client_object_name = unicode(self.name).translate(
732
{ord(u"."): ord(u"_"),
733
ord(u"-"): ord(u"_")})
734
self.dbus_object_path = (dbus.ObjectPath
735
(u"/clients/" + client_object_name))
1418
736
DBusObjectWithProperties.__init__(self, self.bus,
1419
737
self.dbus_object_path)
1421
def notifychangeproperty(transform_func, dbus_name,
1422
type_func=lambda x: x,
1424
invalidate_only=False,
1425
_interface=_interface):
1426
""" Modify a variable so that it's a property which announces
1427
its changes to DBus.
1429
transform_fun: Function that takes a value and a variant_level
1430
and transforms it to a D-Bus type.
1431
dbus_name: D-Bus name of the variable
1432
type_func: Function that transform the value before sending it
1433
to the D-Bus. Default: no transform
1434
variant_level: D-Bus variant level. Default: 1
1436
attrname = "_{}".format(dbus_name)
1438
def setter(self, value):
1439
if hasattr(self, "dbus_object_path"):
1440
if (not hasattr(self, attrname) or
1441
type_func(getattr(self, attrname, None))
1442
!= type_func(value)):
1444
self.PropertiesChanged(
1445
_interface, dbus.Dictionary(),
1446
dbus.Array((dbus_name, )))
1448
dbus_value = transform_func(
1450
variant_level = variant_level)
1451
self.PropertyChanged(dbus.String(dbus_name),
1453
self.PropertiesChanged(
1455
dbus.Dictionary({ dbus.String(dbus_name):
1458
setattr(self, attrname, value)
1460
return property(lambda self: getattr(self, attrname), setter)
1462
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1463
approvals_pending = notifychangeproperty(dbus.Boolean,
1466
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1467
last_enabled = notifychangeproperty(datetime_to_dbus,
1469
checker = notifychangeproperty(
1470
dbus.Boolean, "CheckerRunning",
1471
type_func = lambda checker: checker is not None)
1472
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1474
last_checker_status = notifychangeproperty(dbus.Int16,
1475
"LastCheckerStatus")
1476
last_approval_request = notifychangeproperty(
1477
datetime_to_dbus, "LastApprovalRequest")
1478
approved_by_default = notifychangeproperty(dbus.Boolean,
1479
"ApprovedByDefault")
1480
approval_delay = notifychangeproperty(
1481
dbus.UInt64, "ApprovalDelay",
1482
type_func = lambda td: td.total_seconds() * 1000)
1483
approval_duration = notifychangeproperty(
1484
dbus.UInt64, "ApprovalDuration",
1485
type_func = lambda td: td.total_seconds() * 1000)
1486
host = notifychangeproperty(dbus.String, "Host")
1487
timeout = notifychangeproperty(
1488
dbus.UInt64, "Timeout",
1489
type_func = lambda td: td.total_seconds() * 1000)
1490
extended_timeout = notifychangeproperty(
1491
dbus.UInt64, "ExtendedTimeout",
1492
type_func = lambda td: td.total_seconds() * 1000)
1493
interval = notifychangeproperty(
1494
dbus.UInt64, "Interval",
1495
type_func = lambda td: td.total_seconds() * 1000)
1496
checker_command = notifychangeproperty(dbus.String, "Checker")
1497
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1498
invalidate_only=True)
1500
del notifychangeproperty
739
def _get_approvals_pending(self):
740
return self._approvals_pending
741
def _set_approvals_pending(self, value):
742
old_value = self._approvals_pending
743
self._approvals_pending = value
745
if (hasattr(self, "dbus_object_path")
746
and bval is not bool(old_value)):
747
dbus_bool = dbus.Boolean(bval, variant_level=1)
748
self.PropertyChanged(dbus.String(u"ApprovalPending"),
751
approvals_pending = property(_get_approvals_pending,
752
_set_approvals_pending)
753
del _get_approvals_pending, _set_approvals_pending
756
def _datetime_to_dbus(dt, variant_level=0):
757
"""Convert a UTC datetime.datetime() to a D-Bus type."""
758
return dbus.String(dt.isoformat(),
759
variant_level=variant_level)
762
oldstate = getattr(self, u"enabled", False)
763
r = Client.enable(self)
764
if oldstate != self.enabled:
766
self.PropertyChanged(dbus.String(u"Enabled"),
767
dbus.Boolean(True, variant_level=1))
768
self.PropertyChanged(
769
dbus.String(u"LastEnabled"),
770
self._datetime_to_dbus(self.last_enabled,
774
def disable(self, quiet = False):
775
oldstate = getattr(self, u"enabled", False)
776
r = Client.disable(self, quiet=quiet)
777
if not quiet and oldstate != self.enabled:
779
self.PropertyChanged(dbus.String(u"Enabled"),
780
dbus.Boolean(False, variant_level=1))
1502
783
def __del__(self, *args, **kwargs):
1504
785
self.remove_from_connection()
1505
786
except LookupError:
1507
if hasattr(DBusObjectWithProperties, "__del__"):
788
if hasattr(DBusObjectWithProperties, u"__del__"):
1508
789
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1509
790
Client.__del__(self, *args, **kwargs)
1511
def checker_callback(self, source, condition,
1512
connection, command, *args, **kwargs):
1513
ret = Client.checker_callback(self, source, condition,
1514
connection, command, *args,
1516
exitstatus = self.last_checker_status
792
def checker_callback(self, pid, condition, command,
794
self.checker_callback_tag = None
797
self.PropertyChanged(dbus.String(u"CheckerRunning"),
798
dbus.Boolean(False, variant_level=1))
799
if os.WIFEXITED(condition):
800
exitstatus = os.WEXITSTATUS(condition)
1518
801
# Emit D-Bus signal
1519
802
self.CheckerCompleted(dbus.Int16(exitstatus),
1520
# This is specific to GNU libC
1521
dbus.Int64(exitstatus << 8),
803
dbus.Int64(condition),
1522
804
dbus.String(command))
1524
806
# Emit D-Bus signal
1525
807
self.CheckerCompleted(dbus.Int16(-1),
1527
# This is specific to GNU libC
1529
| self.last_checker_signal),
808
dbus.Int64(condition),
1530
809
dbus.String(command))
811
return Client.checker_callback(self, pid, condition, command,
814
def checked_ok(self, *args, **kwargs):
815
r = Client.checked_ok(self, *args, **kwargs)
817
self.PropertyChanged(
818
dbus.String(u"LastCheckedOK"),
819
(self._datetime_to_dbus(self.last_checked_ok,
823
def need_approval(self, *args, **kwargs):
824
r = Client.need_approval(self, *args, **kwargs)
826
self.PropertyChanged(
827
dbus.String(u"LastApprovalRequest"),
828
(self._datetime_to_dbus(self.last_approval_request,
1533
832
def start_checker(self, *args, **kwargs):
1534
old_checker_pid = getattr(self.checker, "pid", None)
833
old_checker = self.checker
834
if self.checker is not None:
835
old_checker_pid = self.checker.pid
837
old_checker_pid = None
1535
838
r = Client.start_checker(self, *args, **kwargs)
1536
839
# Only if new checker process was started
1537
840
if (self.checker is not None
1538
841
and old_checker_pid != self.checker.pid):
1539
842
# Emit D-Bus signal
1540
843
self.CheckerStarted(self.current_checker_command)
844
self.PropertyChanged(
845
dbus.String(u"CheckerRunning"),
846
dbus.Boolean(True, variant_level=1))
849
def stop_checker(self, *args, **kwargs):
850
old_checker = getattr(self, u"checker", None)
851
r = Client.stop_checker(self, *args, **kwargs)
852
if (old_checker is not None
853
and getattr(self, u"checker", None) is None):
854
self.PropertyChanged(dbus.String(u"CheckerRunning"),
855
dbus.Boolean(False, variant_level=1))
1543
858
def _reset_approved(self):
1544
self.approved = None
859
self._approved = None
1547
862
def approve(self, value=True):
1548
self.approved = value
1549
gobject.timeout_add(int(self.approval_duration.total_seconds()
1550
* 1000), self._reset_approved)
1551
863
self.send_changedstate()
864
self._approved = value
865
gobject.timeout_add(self._timedelta_to_milliseconds
866
(self.approval_duration),
867
self._reset_approved)
1553
870
## D-Bus methods, signals & properties
871
_interface = u"se.bsnet.fukt.Mandos.Client"
1559
875
# CheckerCompleted - signal
1560
@dbus.service.signal(_interface, signature="nxs")
876
@dbus.service.signal(_interface, signature=u"nxs")
1561
877
def CheckerCompleted(self, exitcode, waitstatus, command):
1565
881
# CheckerStarted - signal
1566
@dbus.service.signal(_interface, signature="s")
882
@dbus.service.signal(_interface, signature=u"s")
1567
883
def CheckerStarted(self, command):
1571
887
# PropertyChanged - signal
1572
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1573
@dbus.service.signal(_interface, signature="sv")
888
@dbus.service.signal(_interface, signature=u"sv")
1574
889
def PropertyChanged(self, property, value):
1640
951
# ApprovalPending - property
1641
@dbus_service_property(_interface, signature="b", access="read")
952
@dbus_service_property(_interface, signature=u"b", access=u"read")
1642
953
def ApprovalPending_dbus_property(self):
1643
954
return dbus.Boolean(bool(self.approvals_pending))
1645
956
# ApprovedByDefault - property
1646
@dbus_service_property(_interface,
957
@dbus_service_property(_interface, signature=u"b",
1649
959
def ApprovedByDefault_dbus_property(self, value=None):
1650
960
if value is None: # get
1651
961
return dbus.Boolean(self.approved_by_default)
1652
962
self.approved_by_default = bool(value)
964
self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
965
dbus.Boolean(value, variant_level=1))
1654
967
# ApprovalDelay - property
1655
@dbus_service_property(_interface,
968
@dbus_service_property(_interface, signature=u"t",
1658
970
def ApprovalDelay_dbus_property(self, value=None):
1659
971
if value is None: # get
1660
return dbus.UInt64(self.approval_delay.total_seconds()
972
return dbus.UInt64(self.approval_delay_milliseconds())
1662
973
self.approval_delay = datetime.timedelta(0, 0, 0, value)
975
self.PropertyChanged(dbus.String(u"ApprovalDelay"),
976
dbus.UInt64(value, variant_level=1))
1664
978
# ApprovalDuration - property
1665
@dbus_service_property(_interface,
979
@dbus_service_property(_interface, signature=u"t",
1668
981
def ApprovalDuration_dbus_property(self, value=None):
1669
982
if value is None: # get
1670
return dbus.UInt64(self.approval_duration.total_seconds()
983
return dbus.UInt64(self._timedelta_to_milliseconds(
984
self.approval_duration))
1672
985
self.approval_duration = datetime.timedelta(0, 0, 0, value)
987
self.PropertyChanged(dbus.String(u"ApprovalDuration"),
988
dbus.UInt64(value, variant_level=1))
1674
990
# Name - property
1676
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1677
@dbus_service_property(_interface, signature="s", access="read")
991
@dbus_service_property(_interface, signature=u"s", access=u"read")
1678
992
def Name_dbus_property(self):
1679
993
return dbus.String(self.name)
1681
995
# Fingerprint - property
1683
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1684
@dbus_service_property(_interface, signature="s", access="read")
996
@dbus_service_property(_interface, signature=u"s", access=u"read")
1685
997
def Fingerprint_dbus_property(self):
1686
998
return dbus.String(self.fingerprint)
1688
1000
# Host - property
1689
@dbus_service_property(_interface,
1001
@dbus_service_property(_interface, signature=u"s",
1002
access=u"readwrite")
1692
1003
def Host_dbus_property(self, value=None):
1693
1004
if value is None: # get
1694
1005
return dbus.String(self.host)
1695
self.host = str(value)
1008
self.PropertyChanged(dbus.String(u"Host"),
1009
dbus.String(value, variant_level=1))
1697
1011
# Created - property
1699
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1700
@dbus_service_property(_interface, signature="s", access="read")
1012
@dbus_service_property(_interface, signature=u"s", access=u"read")
1701
1013
def Created_dbus_property(self):
1702
return datetime_to_dbus(self.created)
1014
return dbus.String(self._datetime_to_dbus(self.created))
1704
1016
# LastEnabled - property
1705
@dbus_service_property(_interface, signature="s", access="read")
1017
@dbus_service_property(_interface, signature=u"s", access=u"read")
1706
1018
def LastEnabled_dbus_property(self):
1707
return datetime_to_dbus(self.last_enabled)
1019
if self.last_enabled is None:
1020
return dbus.String(u"")
1021
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1709
1023
# Enabled - property
1710
@dbus_service_property(_interface,
1024
@dbus_service_property(_interface, signature=u"b",
1025
access=u"readwrite")
1713
1026
def Enabled_dbus_property(self, value=None):
1714
1027
if value is None: # get
1715
1028
return dbus.Boolean(self.enabled)
1721
1034
# LastCheckedOK - property
1722
@dbus_service_property(_interface,
1035
@dbus_service_property(_interface, signature=u"s",
1036
access=u"readwrite")
1725
1037
def LastCheckedOK_dbus_property(self, value=None):
1726
1038
if value is not None:
1727
1039
self.checked_ok()
1729
return datetime_to_dbus(self.last_checked_ok)
1731
# LastCheckerStatus - property
1732
@dbus_service_property(_interface, signature="n", access="read")
1733
def LastCheckerStatus_dbus_property(self):
1734
return dbus.Int16(self.last_checker_status)
1736
# Expires - property
1737
@dbus_service_property(_interface, signature="s", access="read")
1738
def Expires_dbus_property(self):
1739
return datetime_to_dbus(self.expires)
1041
if self.last_checked_ok is None:
1042
return dbus.String(u"")
1043
return dbus.String(self._datetime_to_dbus(self
1741
1046
# LastApprovalRequest - property
1742
@dbus_service_property(_interface, signature="s", access="read")
1047
@dbus_service_property(_interface, signature=u"s", access=u"read")
1743
1048
def LastApprovalRequest_dbus_property(self):
1744
return datetime_to_dbus(self.last_approval_request)
1049
if self.last_approval_request is None:
1050
return dbus.String(u"")
1051
return dbus.String(self.
1052
_datetime_to_dbus(self
1053
.last_approval_request))
1746
1055
# Timeout - property
1747
@dbus_service_property(_interface,
1056
@dbus_service_property(_interface, signature=u"t",
1057
access=u"readwrite")
1750
1058
def Timeout_dbus_property(self, value=None):
1751
1059
if value is None: # get
1752
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1753
old_timeout = self.timeout
1060
return dbus.UInt64(self.timeout_milliseconds())
1754
1061
self.timeout = datetime.timedelta(0, 0, 0, value)
1755
# Reschedule disabling
1757
now = datetime.datetime.utcnow()
1758
self.expires += self.timeout - old_timeout
1759
if self.expires <= now:
1760
# The timeout has passed
1763
if (getattr(self, "disable_initiator_tag", None)
1766
gobject.source_remove(self.disable_initiator_tag)
1767
self.disable_initiator_tag = gobject.timeout_add(
1768
int((self.expires - now).total_seconds() * 1000),
1771
# ExtendedTimeout - property
1772
@dbus_service_property(_interface,
1775
def ExtendedTimeout_dbus_property(self, value=None):
1776
if value is None: # get
1777
return dbus.UInt64(self.extended_timeout.total_seconds()
1779
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1063
self.PropertyChanged(dbus.String(u"Timeout"),
1064
dbus.UInt64(value, variant_level=1))
1065
if getattr(self, u"disable_initiator_tag", None) is None:
1067
# Reschedule timeout
1068
gobject.source_remove(self.disable_initiator_tag)
1069
self.disable_initiator_tag = None
1070
time_to_die = (self.
1071
_timedelta_to_milliseconds((self
1076
if time_to_die <= 0:
1077
# The timeout has passed
1080
self.disable_initiator_tag = (gobject.timeout_add
1081
(time_to_die, self.disable))
1781
1083
# Interval - property
1782
@dbus_service_property(_interface,
1084
@dbus_service_property(_interface, signature=u"t",
1085
access=u"readwrite")
1785
1086
def Interval_dbus_property(self, value=None):
1786
1087
if value is None: # get
1787
return dbus.UInt64(self.interval.total_seconds() * 1000)
1088
return dbus.UInt64(self.interval_milliseconds())
1788
1089
self.interval = datetime.timedelta(0, 0, 0, value)
1789
if getattr(self, "checker_initiator_tag", None) is None:
1091
self.PropertyChanged(dbus.String(u"Interval"),
1092
dbus.UInt64(value, variant_level=1))
1093
if getattr(self, u"checker_initiator_tag", None) is None:
1792
# Reschedule checker run
1793
gobject.source_remove(self.checker_initiator_tag)
1794
self.checker_initiator_tag = gobject.timeout_add(
1795
value, self.start_checker)
1796
self.start_checker() # Start one now, too
1095
# Reschedule checker run
1096
gobject.source_remove(self.checker_initiator_tag)
1097
self.checker_initiator_tag = (gobject.timeout_add
1098
(value, self.start_checker))
1099
self.start_checker() # Start one now, too
1798
1101
# Checker - property
1799
@dbus_service_property(_interface,
1102
@dbus_service_property(_interface, signature=u"s",
1103
access=u"readwrite")
1802
1104
def Checker_dbus_property(self, value=None):
1803
1105
if value is None: # get
1804
1106
return dbus.String(self.checker_command)
1805
self.checker_command = str(value)
1107
self.checker_command = value
1109
self.PropertyChanged(dbus.String(u"Checker"),
1110
dbus.String(self.checker_command,
1807
1113
# CheckerRunning - property
1808
@dbus_service_property(_interface,
1114
@dbus_service_property(_interface, signature=u"b",
1115
access=u"readwrite")
1811
1116
def CheckerRunning_dbus_property(self, value=None):
1812
1117
if value is None: # get
1813
1118
return dbus.Boolean(self.checker is not None)
2043
1339
def fingerprint(openpgp):
2044
1340
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2045
1341
# New GnuTLS "datum" with the OpenPGP public key
2046
datum = gnutls.library.types.gnutls_datum_t(
2047
ctypes.cast(ctypes.c_char_p(openpgp),
2048
ctypes.POINTER(ctypes.c_ubyte)),
2049
ctypes.c_uint(len(openpgp)))
1342
datum = (gnutls.library.types
1343
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1346
ctypes.c_uint(len(openpgp))))
2050
1347
# New empty GnuTLS certificate
2051
1348
crt = gnutls.library.types.gnutls_openpgp_crt_t()
2052
gnutls.library.functions.gnutls_openpgp_crt_init(
1349
(gnutls.library.functions
1350
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2054
1351
# Import the OpenPGP public key into the certificate
2055
gnutls.library.functions.gnutls_openpgp_crt_import(
2056
crt, ctypes.byref(datum),
2057
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1352
(gnutls.library.functions
1353
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1354
gnutls.library.constants
1355
.GNUTLS_OPENPGP_FMT_RAW))
2058
1356
# Verify the self signature in the key
2059
1357
crtverify = ctypes.c_uint()
2060
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
2061
crt, 0, ctypes.byref(crtverify))
1358
(gnutls.library.functions
1359
.gnutls_openpgp_crt_verify_self(crt, 0,
1360
ctypes.byref(crtverify)))
2062
1361
if crtverify.value != 0:
2063
1362
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2064
raise gnutls.errors.CertificateSecurityError(
1363
raise (gnutls.errors.CertificateSecurityError
2066
1365
# New buffer for the fingerprint
2067
1366
buf = ctypes.create_string_buffer(20)
2068
1367
buf_len = ctypes.c_size_t()
2069
1368
# Get the fingerprint from the certificate into the buffer
2070
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
2071
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1369
(gnutls.library.functions
1370
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1371
ctypes.byref(buf_len)))
2072
1372
# Deinit the certificate
2073
1373
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2074
1374
# Convert the buffer to a Python bytestring
2075
1375
fpr = ctypes.string_at(buf, buf_len.value)
2076
1376
# Convert the bytestring to hexadecimal notation
2077
hex_fpr = binascii.hexlify(fpr).upper()
1377
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2081
1381
class MultiprocessingMixIn(object):
2082
1382
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2084
1383
def sub_process_main(self, request, address):
2086
1385
self.finish_request(request, address)
2088
1387
self.handle_error(request, address)
2089
1388
self.close_request(request)
2091
1390
def process_request(self, request, address):
2092
1391
"""Start a new process to process the request."""
2093
proc = multiprocessing.Process(target = self.sub_process_main,
2094
args = (request, address))
1392
multiprocessing.Process(target = self.sub_process_main,
1393
args = (request, address)).start()
2099
1395
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2100
1396
""" adds a pipe to the MixIn """
2102
1397
def process_request(self, request, client_address):
2103
1398
"""Overrides and wraps the original process_request().
2105
1400
This function creates a new pipe in self.pipe
2107
1402
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2109
proc = MultiprocessingMixIn.process_request(self, request,
1404
super(MultiprocessingMixInWithPipe,
1405
self).process_request(request, client_address)
2111
1406
self.child_pipe.close()
2112
self.add_pipe(parent_pipe, proc)
2114
def add_pipe(self, parent_pipe, proc):
1407
self.add_pipe(parent_pipe)
1409
def add_pipe(self, parent_pipe):
2115
1410
"""Dummy function; override as necessary"""
2116
raise NotImplementedError()
2119
1413
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2120
1414
socketserver.TCPServer, object):
2276
1536
fpr = request[1]
2277
1537
address = request[2]
2279
for c in self.clients.itervalues():
1539
for c in self.clients:
2280
1540
if c.fingerprint == fpr:
2284
logger.info("Client not found for fingerprint: %s, ad"
2285
"dress: %s", fpr, address)
1544
logger.warning(u"Client not found for fingerprint: %s, ad"
1545
u"dress: %s", fpr, address)
2286
1546
if self.use_dbus:
2287
1547
# Emit D-Bus signal
2288
mandos_dbus_service.ClientNotFound(fpr,
1548
mandos_dbus_service.ClientNotFound(fpr, address[0])
2290
1549
parent_pipe.send(False)
2293
gobject.io_add_watch(
2294
parent_pipe.fileno(),
2295
gobject.IO_IN | gobject.IO_HUP,
2296
functools.partial(self.handle_ipc,
2297
parent_pipe = parent_pipe,
2299
client_object = client))
1552
gobject.io_add_watch(parent_pipe.fileno(),
1553
gobject.IO_IN | gobject.IO_HUP,
1554
functools.partial(self.handle_ipc,
1555
parent_pipe = parent_pipe,
1556
client_object = client))
2300
1557
parent_pipe.send(True)
2301
# remove the old hook in favor of the new above hook on
1558
# remove the old hook in favor of the new above hook on same fileno
2304
1560
if command == 'funcall':
2305
1561
funcname = request[1]
2306
1562
args = request[2]
2307
1563
kwargs = request[3]
2309
parent_pipe.send(('data', getattr(client_object,
1565
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2313
1567
if command == 'getattr':
2314
1568
attrname = request[1]
2315
if isinstance(client_object.__getattribute__(attrname),
2316
collections.Callable):
2317
parent_pipe.send(('function', ))
1569
if callable(client_object.__getattribute__(attrname)):
1570
parent_pipe.send(('function',))
2320
'data', client_object.__getattribute__(attrname)))
1572
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2322
1574
if command == 'setattr':
2323
1575
attrname = request[1]
2324
1576
value = request[2]
2325
1577
setattr(client_object, attrname, value)
2330
def rfc3339_duration_to_delta(duration):
2331
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2333
>>> rfc3339_duration_to_delta("P7D")
2334
datetime.timedelta(7)
2335
>>> rfc3339_duration_to_delta("PT60S")
2336
datetime.timedelta(0, 60)
2337
>>> rfc3339_duration_to_delta("PT60M")
2338
datetime.timedelta(0, 3600)
2339
>>> rfc3339_duration_to_delta("PT24H")
2340
datetime.timedelta(1)
2341
>>> rfc3339_duration_to_delta("P1W")
2342
datetime.timedelta(7)
2343
>>> rfc3339_duration_to_delta("PT5M30S")
2344
datetime.timedelta(0, 330)
2345
>>> rfc3339_duration_to_delta("P1DT3M20S")
2346
datetime.timedelta(1, 200)
2349
# Parsing an RFC 3339 duration with regular expressions is not
2350
# possible - there would have to be multiple places for the same
2351
# values, like seconds. The current code, while more esoteric, is
2352
# cleaner without depending on a parsing library. If Python had a
2353
# built-in library for parsing we would use it, but we'd like to
2354
# avoid excessive use of external libraries.
2356
# New type for defining tokens, syntax, and semantics all-in-one
2357
Token = collections.namedtuple("Token", (
2358
"regexp", # To match token; if "value" is not None, must have
2359
# a "group" containing digits
2360
"value", # datetime.timedelta or None
2361
"followers")) # Tokens valid after this token
2362
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2363
# the "duration" ABNF definition in RFC 3339, Appendix A.
2364
token_end = Token(re.compile(r"$"), None, frozenset())
2365
token_second = Token(re.compile(r"(\d+)S"),
2366
datetime.timedelta(seconds=1),
2367
frozenset((token_end, )))
2368
token_minute = Token(re.compile(r"(\d+)M"),
2369
datetime.timedelta(minutes=1),
2370
frozenset((token_second, token_end)))
2371
token_hour = Token(re.compile(r"(\d+)H"),
2372
datetime.timedelta(hours=1),
2373
frozenset((token_minute, token_end)))
2374
token_time = Token(re.compile(r"T"),
2376
frozenset((token_hour, token_minute,
2378
token_day = Token(re.compile(r"(\d+)D"),
2379
datetime.timedelta(days=1),
2380
frozenset((token_time, token_end)))
2381
token_month = Token(re.compile(r"(\d+)M"),
2382
datetime.timedelta(weeks=4),
2383
frozenset((token_day, token_end)))
2384
token_year = Token(re.compile(r"(\d+)Y"),
2385
datetime.timedelta(weeks=52),
2386
frozenset((token_month, token_end)))
2387
token_week = Token(re.compile(r"(\d+)W"),
2388
datetime.timedelta(weeks=1),
2389
frozenset((token_end, )))
2390
token_duration = Token(re.compile(r"P"), None,
2391
frozenset((token_year, token_month,
2392
token_day, token_time,
2394
# Define starting values
2395
value = datetime.timedelta() # Value so far
2397
followers = frozenset((token_duration, )) # Following valid tokens
2398
s = duration # String left to parse
2399
# Loop until end token is found
2400
while found_token is not token_end:
2401
# Search for any currently valid tokens
2402
for token in followers:
2403
match = token.regexp.match(s)
2404
if match is not None:
2406
if token.value is not None:
2407
# Value found, parse digits
2408
factor = int(match.group(1), 10)
2409
# Add to value so far
2410
value += factor * token.value
2411
# Strip token from string
2412
s = token.regexp.sub("", s, 1)
2415
# Set valid next tokens
2416
followers = found_token.followers
2419
# No currently valid tokens were found
2420
raise ValueError("Invalid RFC 3339 duration: {!r}"
2426
1582
def string_to_delta(interval):
2427
1583
"""Parse a string and return a datetime.timedelta
2429
>>> string_to_delta('7d')
1585
>>> string_to_delta(u'7d')
2430
1586
datetime.timedelta(7)
2431
>>> string_to_delta('60s')
1587
>>> string_to_delta(u'60s')
2432
1588
datetime.timedelta(0, 60)
2433
>>> string_to_delta('60m')
1589
>>> string_to_delta(u'60m')
2434
1590
datetime.timedelta(0, 3600)
2435
>>> string_to_delta('24h')
1591
>>> string_to_delta(u'24h')
2436
1592
datetime.timedelta(1)
2437
>>> string_to_delta('1w')
1593
>>> string_to_delta(u'1w')
2438
1594
datetime.timedelta(7)
2439
>>> string_to_delta('5m 30s')
1595
>>> string_to_delta(u'5m 30s')
2440
1596
datetime.timedelta(0, 330)
2444
return rfc3339_duration_to_delta(interval)
2448
1598
timevalue = datetime.timedelta(0)
2449
1599
for s in interval.split():
1601
suffix = unicode(s[-1])
2452
1602
value = int(s[:-1])
2454
1604
delta = datetime.timedelta(value)
1605
elif suffix == u"s":
2456
1606
delta = datetime.timedelta(0, value)
1607
elif suffix == u"m":
2458
1608
delta = datetime.timedelta(0, 0, 0, 0, value)
1609
elif suffix == u"h":
2460
1610
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1611
elif suffix == u"w":
2462
1612
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2464
raise ValueError("Unknown suffix {!r}".format(suffix))
2465
except IndexError as e:
2466
raise ValueError(*(e.args))
1614
raise ValueError(u"Unknown suffix %r" % suffix)
1615
except (ValueError, IndexError), e:
1616
raise ValueError(e.message)
2467
1617
timevalue += delta
2468
1618
return timevalue
1621
def if_nametoindex(interface):
1622
"""Call the C function if_nametoindex(), or equivalent
1624
Note: This function cannot accept a unicode string."""
1625
global if_nametoindex
1627
if_nametoindex = (ctypes.cdll.LoadLibrary
1628
(ctypes.util.find_library(u"c"))
1630
except (OSError, AttributeError):
1631
logger.warning(u"Doing if_nametoindex the hard way")
1632
def if_nametoindex(interface):
1633
"Get an interface index the hard way, i.e. using fcntl()"
1634
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1635
with contextlib.closing(socket.socket()) as s:
1636
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1637
struct.pack(str(u"16s16x"),
1639
interface_index = struct.unpack(str(u"I"),
1641
return interface_index
1642
return if_nametoindex(interface)
2471
1645
def daemon(nochdir = False, noclose = False):
2472
1646
"""See daemon(3). Standard BSD Unix function.
2498
1672
##################################################################
2499
1673
# Parsing of options, both command line and config file
2501
parser = argparse.ArgumentParser()
2502
parser.add_argument("-v", "--version", action="version",
2503
version = "%(prog)s {}".format(version),
2504
help="show version number and exit")
2505
parser.add_argument("-i", "--interface", metavar="IF",
2506
help="Bind to interface IF")
2507
parser.add_argument("-a", "--address",
2508
help="Address to listen for requests on")
2509
parser.add_argument("-p", "--port", type=int,
2510
help="Port number to receive requests on")
2511
parser.add_argument("--check", action="store_true",
2512
help="Run self-test")
2513
parser.add_argument("--debug", action="store_true",
2514
help="Debug mode; run in foreground and log"
2515
" to terminal", default=None)
2516
parser.add_argument("--debuglevel", metavar="LEVEL",
2517
help="Debug level for stdout output")
2518
parser.add_argument("--priority", help="GnuTLS"
2519
" priority string (see GnuTLS documentation)")
2520
parser.add_argument("--servicename",
2521
metavar="NAME", help="Zeroconf service name")
2522
parser.add_argument("--configdir",
2523
default="/etc/mandos", metavar="DIR",
2524
help="Directory to search for configuration"
2526
parser.add_argument("--no-dbus", action="store_false",
2527
dest="use_dbus", help="Do not provide D-Bus"
2528
" system bus interface", default=None)
2529
parser.add_argument("--no-ipv6", action="store_false",
2530
dest="use_ipv6", help="Do not use IPv6",
2532
parser.add_argument("--no-restore", action="store_false",
2533
dest="restore", help="Do not restore stored"
2534
" state", default=None)
2535
parser.add_argument("--socket", type=int,
2536
help="Specify a file descriptor to a network"
2537
" socket to use instead of creating one")
2538
parser.add_argument("--statedir", metavar="DIR",
2539
help="Directory to save/restore state in")
2540
parser.add_argument("--foreground", action="store_true",
2541
help="Run in foreground", default=None)
2542
parser.add_argument("--no-zeroconf", action="store_false",
2543
dest="zeroconf", help="Do not use Zeroconf",
2546
options = parser.parse_args()
1675
parser = optparse.OptionParser(version = "%%prog %s" % version)
1676
parser.add_option("-i", u"--interface", type=u"string",
1677
metavar="IF", help=u"Bind to interface IF")
1678
parser.add_option("-a", u"--address", type=u"string",
1679
help=u"Address to listen for requests on")
1680
parser.add_option("-p", u"--port", type=u"int",
1681
help=u"Port number to receive requests on")
1682
parser.add_option("--check", action=u"store_true",
1683
help=u"Run self-test")
1684
parser.add_option("--debug", action=u"store_true",
1685
help=u"Debug mode; run in foreground and log to"
1687
parser.add_option("--debuglevel", type=u"string", metavar="LEVEL",
1688
help=u"Debug level for stdout output")
1689
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1690
u" priority string (see GnuTLS documentation)")
1691
parser.add_option("--servicename", type=u"string",
1692
metavar=u"NAME", help=u"Zeroconf service name")
1693
parser.add_option("--configdir", type=u"string",
1694
default=u"/etc/mandos", metavar=u"DIR",
1695
help=u"Directory to search for configuration"
1697
parser.add_option("--no-dbus", action=u"store_false",
1698
dest=u"use_dbus", help=u"Do not provide D-Bus"
1699
u" system bus interface")
1700
parser.add_option("--no-ipv6", action=u"store_false",
1701
dest=u"use_ipv6", help=u"Do not use IPv6")
1702
options = parser.parse_args()[0]
2548
1704
if options.check:
2550
fail_count, test_count = doctest.testmod()
2551
sys.exit(os.EX_OK if fail_count == 0 else 1)
2553
1709
# Default values for config file for server-global settings
2554
server_defaults = { "interface": "",
2559
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2560
":+SIGN-DSA-SHA256",
2561
"servicename": "Mandos",
2567
"statedir": "/var/lib/mandos",
2568
"foreground": "False",
1710
server_defaults = { u"interface": u"",
1715
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1716
u"servicename": u"Mandos",
1717
u"use_dbus": u"True",
1718
u"use_ipv6": u"True",
2572
1722
# Parse config file for server-global settings
2573
1723
server_config = configparser.SafeConfigParser(server_defaults)
2574
1724
del server_defaults
2575
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1725
server_config.read(os.path.join(options.configdir,
2576
1727
# Convert the SafeConfigParser object to a dict
2577
1728
server_settings = server_config.defaults()
2578
1729
# Use the appropriate methods on the non-string config options
2579
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2580
server_settings[option] = server_config.getboolean("DEFAULT",
1730
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1731
server_settings[option] = server_config.getboolean(u"DEFAULT",
2582
1733
if server_settings["port"]:
2583
server_settings["port"] = server_config.getint("DEFAULT",
2585
if server_settings["socket"]:
2586
server_settings["socket"] = server_config.getint("DEFAULT",
2588
# Later, stdin will, and stdout and stderr might, be dup'ed
2589
# over with an opened os.devnull. But we don't want this to
2590
# happen with a supplied network socket.
2591
if 0 <= server_settings["socket"] <= 2:
2592
server_settings["socket"] = os.dup(server_settings
1734
server_settings["port"] = server_config.getint(u"DEFAULT",
2594
1736
del server_config
2596
1738
# Override the settings from the config file with command line
2597
1739
# options, if set.
2598
for option in ("interface", "address", "port", "debug",
2599
"priority", "servicename", "configdir", "use_dbus",
2600
"use_ipv6", "debuglevel", "restore", "statedir",
2601
"socket", "foreground", "zeroconf"):
1740
for option in (u"interface", u"address", u"port", u"debug",
1741
u"priority", u"servicename", u"configdir",
1742
u"use_dbus", u"use_ipv6", u"debuglevel"):
2602
1743
value = getattr(options, option)
2603
1744
if value is not None:
2604
1745
server_settings[option] = value
2606
1747
# Force all strings to be unicode
2607
1748
for option in server_settings.keys():
2608
if isinstance(server_settings[option], bytes):
2609
server_settings[option] = (server_settings[option]
2611
# Force all boolean options to be boolean
2612
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2613
"foreground", "zeroconf"):
2614
server_settings[option] = bool(server_settings[option])
2615
# Debug implies foreground
2616
if server_settings["debug"]:
2617
server_settings["foreground"] = True
1749
if type(server_settings[option]) is str:
1750
server_settings[option] = unicode(server_settings[option])
2618
1751
# Now we have our good server settings in "server_settings"
2620
1753
##################################################################
2622
if (not server_settings["zeroconf"]
2623
and not (server_settings["port"]
2624
or server_settings["socket"] != "")):
2625
parser.error("Needs port or socket to work without Zeroconf")
2627
1755
# For convenience
2628
debug = server_settings["debug"]
2629
debuglevel = server_settings["debuglevel"]
2630
use_dbus = server_settings["use_dbus"]
2631
use_ipv6 = server_settings["use_ipv6"]
2632
stored_state_path = os.path.join(server_settings["statedir"],
2634
foreground = server_settings["foreground"]
2635
zeroconf = server_settings["zeroconf"]
2638
initlogger(debug, logging.DEBUG)
2643
level = getattr(logging, debuglevel.upper())
2644
initlogger(debug, level)
2646
if server_settings["servicename"] != "Mandos":
2647
syslogger.setFormatter(
2648
logging.Formatter('Mandos ({}) [%(process)d]:'
2649
' %(levelname)s: %(message)s'.format(
2650
server_settings["servicename"])))
1756
debug = server_settings[u"debug"]
1757
debuglevel = server_settings[u"debuglevel"]
1758
use_dbus = server_settings[u"use_dbus"]
1759
use_ipv6 = server_settings[u"use_ipv6"]
1761
if server_settings[u"servicename"] != u"Mandos":
1762
syslogger.setFormatter(logging.Formatter
1763
(u'Mandos (%s) [%%(process)d]:'
1764
u' %%(levelname)s: %%(message)s'
1765
% server_settings[u"servicename"]))
2652
1767
# Parse config file with clients
2653
client_config = configparser.SafeConfigParser(Client
2655
client_config.read(os.path.join(server_settings["configdir"],
1768
client_defaults = { u"timeout": u"1h",
1770
u"checker": u"fping -q -- %%(host)s",
1772
u"approval_delay": u"0s",
1773
u"approval_duration": u"1s",
1775
client_config = configparser.SafeConfigParser(client_defaults)
1776
client_config.read(os.path.join(server_settings[u"configdir"],
2658
1779
global mandos_dbus_service
2659
1780
mandos_dbus_service = None
2662
if server_settings["socket"] != "":
2663
socketfd = server_settings["socket"]
2664
tcp_server = MandosServer(
2665
(server_settings["address"], server_settings["port"]),
2667
interface=(server_settings["interface"] or None),
2669
gnutls_priority=server_settings["priority"],
2673
pidfilename = "/run/mandos.pid"
2674
if not os.path.isdir("/run/."):
2675
pidfilename = "/var/run/mandos.pid"
1782
tcp_server = MandosServer((server_settings[u"address"],
1783
server_settings[u"port"]),
1785
interface=(server_settings[u"interface"]
1789
server_settings[u"priority"],
1792
pidfilename = u"/var/run/mandos.pid"
2678
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2679
except IOError as e:
2680
logger.error("Could not open file %r", pidfilename,
1794
pidfile = open(pidfilename, u"w")
1796
logger.error(u"Could not open file %r", pidfilename)
2683
for name in ("_mandos", "mandos", "nobody"):
1799
uid = pwd.getpwnam(u"_mandos").pw_uid
1800
gid = pwd.getpwnam(u"_mandos").pw_gid
2685
uid = pwd.getpwnam(name).pw_uid
2686
gid = pwd.getpwnam(name).pw_gid
1803
uid = pwd.getpwnam(u"mandos").pw_uid
1804
gid = pwd.getpwnam(u"mandos").pw_gid
2688
1805
except KeyError:
1807
uid = pwd.getpwnam(u"nobody").pw_uid
1808
gid = pwd.getpwnam(u"nobody").pw_gid
2696
except OSError as error:
2697
if error.errno != errno.EPERM:
1815
except OSError, error:
1816
if error[0] != errno.EPERM:
1819
if not debug and not debuglevel:
1820
syslogger.setLevel(logging.WARNING)
1821
console.setLevel(logging.WARNING)
1823
level = getattr(logging, debuglevel.upper())
1824
syslogger.setLevel(level)
1825
console.setLevel(level)
2701
1828
# Enable all possible GnuTLS debugging
2762
1881
client_class = Client
2764
1883
client_class = functools.partial(ClientDBus, bus = bus)
2766
client_settings = Client.config_parser(client_config)
2767
old_client_settings = {}
2770
# This is used to redirect stdout and stderr for checker processes
2772
wnull = open(os.devnull, "w") # A writable /dev/null
2773
# Only used if server is running in foreground but not in debug
2775
if debug or not foreground:
2778
# Get client data and settings from last running state.
2779
if server_settings["restore"]:
2781
with open(stored_state_path, "rb") as stored_state:
2782
clients_data, old_client_settings = pickle.load(
2784
os.remove(stored_state_path)
2785
except IOError as e:
2786
if e.errno == errno.ENOENT:
2787
logger.warning("Could not load persistent state:"
2788
" {}".format(os.strerror(e.errno)))
2790
logger.critical("Could not load persistent state:",
2793
except EOFError as e:
2794
logger.warning("Could not load persistent state: "
2798
with PGPEngine() as pgp:
2799
for client_name, client in clients_data.items():
2800
# Skip removed clients
2801
if client_name not in client_settings:
2804
# Decide which value to use after restoring saved state.
2805
# We have three different values: Old config file,
2806
# new config file, and saved state.
2807
# New config value takes precedence if it differs from old
2808
# config value, otherwise use saved state.
2809
for name, value in client_settings[client_name].items():
2811
# For each value in new config, check if it
2812
# differs from the old config value (Except for
2813
# the "secret" attribute)
2814
if (name != "secret"
2816
old_client_settings[client_name][name])):
2817
client[name] = value
2821
# Clients who has passed its expire date can still be
2822
# enabled if its last checker was successful. A Client
2823
# whose checker succeeded before we stored its state is
2824
# assumed to have successfully run all checkers during
2826
if client["enabled"]:
2827
if datetime.datetime.utcnow() >= client["expires"]:
2828
if not client["last_checked_ok"]:
2830
"disabling client {} - Client never "
2831
"performed a successful checker".format(
2833
client["enabled"] = False
2834
elif client["last_checker_status"] != 0:
2836
"disabling client {} - Client last"
2837
" checker failed with error code"
2840
client["last_checker_status"]))
2841
client["enabled"] = False
2843
client["expires"] = (
2844
datetime.datetime.utcnow()
2845
+ client["timeout"])
2846
logger.debug("Last checker succeeded,"
2847
" keeping {} enabled".format(
1884
def client_config_items(config, section):
1885
special_settings = {
1886
"approved_by_default":
1887
lambda: config.getboolean(section,
1888
"approved_by_default"),
1890
for name, value in config.items(section):
2850
client["secret"] = pgp.decrypt(
2851
client["encrypted_secret"],
2852
client_settings[client_name]["secret"])
2854
# If decryption fails, we use secret from new settings
2855
logger.debug("Failed to decrypt {} old secret".format(
2857
client["secret"] = (client_settings[client_name]
2860
# Add/remove clients based on new changes made to config
2861
for client_name in (set(old_client_settings)
2862
- set(client_settings)):
2863
del clients_data[client_name]
2864
for client_name in (set(client_settings)
2865
- set(old_client_settings)):
2866
clients_data[client_name] = client_settings[client_name]
2868
# Create all client objects
2869
for client_name, client in clients_data.items():
2870
tcp_server.clients[client_name] = client_class(
2873
server_settings = server_settings)
1892
yield (name, special_settings[name]())
1896
tcp_server.clients.update(set(
1897
client_class(name = section,
1898
config= dict(client_config_items(
1899
client_config, section)))
1900
for section in client_config.sections()))
2875
1901
if not tcp_server.clients:
2876
logger.warning("No clients defined")
2879
if pidfile is not None:
2883
print(pid, file=pidfile)
2885
logger.error("Could not write to file %r with PID %d",
1902
logger.warning(u"No clients defined")
1908
pidfile.write(str(pid) + "\n")
1911
logger.error(u"Could not write to file %r with PID %d",
1914
# "pidfile" was never created
2888
1916
del pidfilename
1918
signal.signal(signal.SIGINT, signal.SIG_IGN)
2890
1920
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2891
1921
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2895
@alternate_dbus_interfaces(
2896
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2897
class MandosDBusService(DBusObjectWithObjectManager):
1924
class MandosDBusService(dbus.service.Object):
2898
1925
"""A D-Bus proxy object"""
2900
1926
def __init__(self):
2901
dbus.service.Object.__init__(self, bus, "/")
2903
_interface = "se.recompile.Mandos"
2905
@dbus.service.signal(_interface, signature="o")
1927
dbus.service.Object.__init__(self, bus, u"/")
1928
_interface = u"se.bsnet.fukt.Mandos"
1930
@dbus.service.signal(_interface, signature=u"o")
2906
1931
def ClientAdded(self, objpath):
2910
@dbus.service.signal(_interface, signature="ss")
1935
@dbus.service.signal(_interface, signature=u"ss")
2911
1936
def ClientNotFound(self, fingerprint, address):
2915
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2917
@dbus.service.signal(_interface, signature="os")
1940
@dbus.service.signal(_interface, signature=u"os")
2918
1941
def ClientRemoved(self, objpath, name):
2922
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2924
@dbus.service.method(_interface, out_signature="ao")
1945
@dbus.service.method(_interface, out_signature=u"ao")
2925
1946
def GetAllClients(self):
2927
return dbus.Array(c.dbus_object_path for c in
2928
tcp_server.clients.itervalues())
1948
return dbus.Array(c.dbus_object_path
1949
for c in tcp_server.clients)
2930
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2932
1951
@dbus.service.method(_interface,
2933
out_signature="a{oa{sv}}")
1952
out_signature=u"a{oa{sv}}")
2934
1953
def GetAllClientsWithProperties(self):
2936
1955
return dbus.Dictionary(
2937
{ c.dbus_object_path: c.GetAll(
2938
"se.recompile.Mandos.Client")
2939
for c in tcp_server.clients.itervalues() },
1956
((c.dbus_object_path, c.GetAll(u""))
1957
for c in tcp_server.clients),
1958
signature=u"oa{sv}")
2942
@dbus.service.method(_interface, in_signature="o")
1960
@dbus.service.method(_interface, in_signature=u"o")
2943
1961
def RemoveClient(self, object_path):
2945
for c in tcp_server.clients.itervalues():
1963
for c in tcp_server.clients:
2946
1964
if c.dbus_object_path == object_path:
2947
del tcp_server.clients[c.name]
1965
tcp_server.clients.remove(c)
2948
1966
c.remove_from_connection()
2949
# Don't signal the disabling
1967
# Don't signal anything except ClientRemoved
2950
1968
c.disable(quiet=True)
2951
# Emit D-Bus signal for removal
2952
self.client_removed_signal(c)
1970
self.ClientRemoved(object_path, c.name)
2954
1972
raise KeyError(object_path)
2958
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
2959
out_signature = "a{oa{sa{sv}}}")
2960
def GetManagedObjects(self):
2962
return dbus.Dictionary(
2963
{ client.dbus_object_path:
2965
{ interface: client.GetAll(interface)
2967
client._get_all_interface_names()})
2968
for client in tcp_server.clients.values()})
2970
def client_added_signal(self, client):
2971
"""Send the new standard signal and the old signal"""
2973
# New standard signal
2974
self.InterfacesAdded(
2975
client.dbus_object_path,
2977
{ interface: client.GetAll(interface)
2979
client._get_all_interface_names()}))
2981
self.ClientAdded(client.dbus_object_path)
2983
def client_removed_signal(self, client):
2984
"""Send the new standard signal and the old signal"""
2986
# New standard signal
2987
self.InterfacesRemoved(
2988
client.dbus_object_path,
2989
client._get_all_interface_names())
2991
self.ClientRemoved(client.dbus_object_path,
2994
1976
mandos_dbus_service = MandosDBusService()
2997
1979
"Cleanup function; run on exit"
3001
multiprocessing.active_children()
3003
if not (tcp_server.clients or client_settings):
3006
# Store client before exiting. Secrets are encrypted with key
3007
# based on what config file has. If config file is
3008
# removed/edited, old secret will thus be unrecovable.
3010
with PGPEngine() as pgp:
3011
for client in tcp_server.clients.itervalues():
3012
key = client_settings[client.name]["secret"]
3013
client.encrypted_secret = pgp.encrypt(client.secret,
3017
# A list of attributes that can not be pickled
3019
exclude = { "bus", "changedstate", "secret",
3020
"checker", "server_settings" }
3021
for name, typ in inspect.getmembers(dbus.service
3025
client_dict["encrypted_secret"] = (client
3027
for attr in client.client_structure:
3028
if attr not in exclude:
3029
client_dict[attr] = getattr(client, attr)
3031
clients[client.name] = client_dict
3032
del client_settings[client.name]["secret"]
3035
with tempfile.NamedTemporaryFile(
3039
dir=os.path.dirname(stored_state_path),
3040
delete=False) as stored_state:
3041
pickle.dump((clients, client_settings), stored_state)
3042
tempname = stored_state.name
3043
os.rename(tempname, stored_state_path)
3044
except (IOError, OSError) as e:
3050
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3051
logger.warning("Could not save persistent state: {}"
3052
.format(os.strerror(e.errno)))
3054
logger.warning("Could not save persistent state:",
3058
# Delete all clients, and settings from config
3059
1982
while tcp_server.clients:
3060
name, client = tcp_server.clients.popitem()
1983
client = tcp_server.clients.pop()
3062
1985
client.remove_from_connection()
3063
# Don't signal the disabling
1986
client.disable_hook = None
1987
# Don't signal anything except ClientRemoved
3064
1988
client.disable(quiet=True)
3065
# Emit D-Bus signal for removal
3067
mandos_dbus_service.client_removed_signal(client)
3068
client_settings.clear()
1991
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3070
1994
atexit.register(cleanup)
3072
for client in tcp_server.clients.itervalues():
1996
for client in tcp_server.clients:
3074
# Emit D-Bus signal for adding
3075
mandos_dbus_service.client_added_signal(client)
3076
# Need to initiate checking of clients
3078
client.init_checker()
1999
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3080
2002
tcp_server.enable()
3081
2003
tcp_server.server_activate()
3083
2005
# Find out what port we got
3085
service.port = tcp_server.socket.getsockname()[1]
2006
service.port = tcp_server.socket.getsockname()[1]
3087
logger.info("Now listening on address %r, port %d,"
3088
" flowinfo %d, scope_id %d",
3089
*tcp_server.socket.getsockname())
2008
logger.info(u"Now listening on address %r, port %d,"
2009
" flowinfo %d, scope_id %d"
2010
% tcp_server.socket.getsockname())
3091
logger.info("Now listening on address %r, port %d",
3092
*tcp_server.socket.getsockname())
2012
logger.info(u"Now listening on address %r, port %d"
2013
% tcp_server.socket.getsockname())
3094
2015
#service.interface = tcp_server.socket.getsockname()[3]
3098
# From the Avahi example code
3101
except dbus.exceptions.DBusException as error:
3102
logger.critical("D-Bus Exception", exc_info=error)
3105
# End of Avahi example code
2018
# From the Avahi example code
2021
except dbus.exceptions.DBusException, error:
2022
logger.critical(u"DBusException: %s", error)
2025
# End of Avahi example code
3107
2027
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3108
2028
lambda *args, **kwargs:
3109
2029
(tcp_server.handle_request
3110
2030
(*args[2:], **kwargs) or True))
3112
logger.debug("Starting main loop")
2032
logger.debug(u"Starting main loop")
3113
2033
main_loop.run()
3114
except AvahiError as error:
3115
logger.critical("Avahi Error", exc_info=error)
2034
except AvahiError, error:
2035
logger.critical(u"AvahiError: %s", error)
3118
2038
except KeyboardInterrupt:
3120
print("", file=sys.stderr)
3121
logger.debug("Server received KeyboardInterrupt")
3122
logger.debug("Server exiting")
2041
logger.debug(u"Server received KeyboardInterrupt")
2042
logger.debug(u"Server exiting")
3123
2043
# Must run before the D-Bus bus name gets deregistered
3127
2046
if __name__ == '__main__':