101
85
except ImportError:
102
86
SO_BINDTODEVICE = None
104
if sys.version_info.major == 2:
108
stored_state_file = "clients.pickle"
90
stored_state_path = "/var/lib/mandos/clients.pickle"
110
92
logger = logging.getLogger()
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
114
if_nametoindex = ctypes.cdll.LoadLibrary(
115
ctypes.util.find_library("c")).if_nametoindex
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
116
101
except (OSError, AttributeError):
118
102
def if_nametoindex(interface):
119
103
"Get an interface index the hard way, i.e. using fcntl()"
120
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
121
105
with contextlib.closing(socket.socket()) as s:
122
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
123
struct.pack(b"16s16x", interface))
124
interface_index = struct.unpack("I", ifreq[16:20])[0]
107
struct.pack(str("16s16x"),
109
interface_index = struct.unpack(str("I"),
125
111
return interface_index
128
def initlogger(debug, level=logging.WARNING):
114
def initlogger(level=logging.WARNING):
129
115
"""init logger and add loglevel"""
132
syslogger = (logging.handlers.SysLogHandler(
133
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
134
address = "/dev/log"))
135
117
syslogger.setFormatter(logging.Formatter
136
118
('Mandos [%(process)d]: %(levelname)s:'
138
120
logger.addHandler(syslogger)
141
console = logging.StreamHandler()
142
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
146
logger.addHandler(console)
122
console = logging.StreamHandler()
123
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
127
logger.addHandler(console)
147
128
logger.setLevel(level)
150
class PGPError(Exception):
151
"""Exception if encryption/decryption fails"""
131
class CryptoError(Exception):
155
class PGPEngine(object):
135
class Crypto(object):
156
136
"""A simple class for OpenPGP symmetric encryption & decryption"""
158
137
def __init__(self):
138
self.gnupg = GnuPGInterface.GnuPG()
159
139
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
160
self.gnupgargs = ['--batch',
161
'--home', self.tempdir,
140
self.gnupg = GnuPGInterface.GnuPG()
141
self.gnupg.options.meta_interactive = False
142
self.gnupg.options.homedir = self.tempdir
143
self.gnupg.options.extra_args.extend(['--force-mdc',
166
146
def __enter__(self):
169
def __exit__(self, exc_type, exc_value, traceback):
149
def __exit__ (self, exc_type, exc_value, traceback):
189
169
def password_encode(self, password):
190
170
# Passphrase can not be empty and can not contain newlines or
191
171
# NUL bytes. So we prefix it and hex encode it.
192
encoded = b"mandos" + binascii.hexlify(password)
193
if len(encoded) > 2048:
194
# GnuPG can't handle long passwords, so encode differently
195
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
196
.replace(b"\n", b"\\n")
197
.replace(b"\0", b"\\x00"))
172
return b"mandos" + binascii.hexlify(password)
200
174
def encrypt(self, data, password):
201
passphrase = self.password_encode(password)
202
with tempfile.NamedTemporaryFile(
203
dir=self.tempdir) as passfile:
204
passfile.write(passphrase)
206
proc = subprocess.Popen(['gpg', '--symmetric',
210
stdin = subprocess.PIPE,
211
stdout = subprocess.PIPE,
212
stderr = subprocess.PIPE)
213
ciphertext, err = proc.communicate(input = data)
214
if proc.returncode != 0:
175
self.gnupg.passphrase = self.password_encode(password)
176
with open(os.devnull) as devnull:
178
proc = self.gnupg.run(['--symmetric'],
179
create_fhs=['stdin', 'stdout'],
180
attach_fhs={'stderr': devnull})
181
with contextlib.closing(proc.handles['stdin']) as f:
183
with contextlib.closing(proc.handles['stdout']) as f:
184
ciphertext = f.read()
188
self.gnupg.passphrase = None
216
189
return ciphertext
218
191
def decrypt(self, data, password):
219
passphrase = self.password_encode(password)
220
with tempfile.NamedTemporaryFile(
221
dir = self.tempdir) as passfile:
222
passfile.write(passphrase)
224
proc = subprocess.Popen(['gpg', '--decrypt',
228
stdin = subprocess.PIPE,
229
stdout = subprocess.PIPE,
230
stderr = subprocess.PIPE)
231
decrypted_plaintext, err = proc.communicate(input = data)
232
if proc.returncode != 0:
192
self.gnupg.passphrase = self.password_encode(password)
193
with open(os.devnull) as devnull:
195
proc = self.gnupg.run(['--decrypt'],
196
create_fhs=['stdin', 'stdout'],
197
attach_fhs={'stderr': devnull})
198
with contextlib.closing(proc.handles['stdin'] ) as f:
200
with contextlib.closing(proc.handles['stdout']) as f:
201
decrypted_plaintext = f.read()
205
self.gnupg.passphrase = None
234
206
return decrypted_plaintext
237
210
class AvahiError(Exception):
238
211
def __init__(self, value, *args, **kwargs):
239
212
self.value = value
240
return super(AvahiError, self).__init__(value, *args,
213
super(AvahiError, self).__init__(value, *args, **kwargs)
214
def __unicode__(self):
215
return unicode(repr(self.value))
244
217
class AvahiServiceError(AvahiError):
248
220
class AvahiGroupError(AvahiError):
473
411
interval: datetime.timedelta(); How often to start a new checker
474
412
last_approval_request: datetime.datetime(); (UTC) or None
475
413
last_checked_ok: datetime.datetime(); (UTC) or None
476
415
last_checker_status: integer between 0 and 255 reflecting exit
477
416
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
418
last_enabled: datetime.datetime(); (UTC)
482
419
name: string; from the config file, used in log messages and
483
420
D-Bus identifiers
484
421
secret: bytestring; sent verbatim (over TLS) to client
485
422
timeout: datetime.timedelta(); How long from last_checked_ok
486
423
until this client is disabled
487
extended_timeout: extra long timeout when secret has been sent
424
extended_timeout: extra long timeout when password has been sent
488
425
runtime_expansions: Allowed attributes for runtime expansion.
489
426
expires: datetime.datetime(); time (UTC) when a client will be
490
427
disabled, or None
491
server_settings: The server_settings dict from main()
494
430
runtime_expansions = ("approval_delay", "approval_duration",
495
"created", "enabled", "expires",
496
"fingerprint", "host", "interval",
497
"last_approval_request", "last_checked_ok",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
498
433
"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):
435
def timeout_milliseconds(self):
436
"Return the 'timeout' attribute in milliseconds"
437
return _timedelta_to_milliseconds(self.timeout)
439
def extended_timeout_milliseconds(self):
440
"Return the 'extended_timeout' attribute in milliseconds"
441
return _timedelta_to_milliseconds(self.extended_timeout)
443
def interval_milliseconds(self):
444
"Return the 'interval' attribute in milliseconds"
445
return _timedelta_to_milliseconds(self.interval)
447
def approval_delay_milliseconds(self):
448
return _timedelta_to_milliseconds(self.approval_delay)
450
def __init__(self, name = None, config=None):
451
"""Note: the 'checker' key in 'config' sets the
452
'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()
577
self.last_enabled = None
580
457
logger.debug("Creating client %r", self.name)
458
# Uppercase and remove spaces from fingerprint for later
459
# comparison purposes with return value from the fingerprint()
461
self.fingerprint = (config["fingerprint"].upper()
581
463
logger.debug(" Fingerprint: %s", self.fingerprint)
582
self.created = settings.get("created",
583
datetime.datetime.utcnow())
585
# attributes specific for this server instance
464
if "secret" in config:
465
self.secret = config["secret"].decode("base64")
466
elif "secfile" in config:
467
with open(os.path.expanduser(os.path.expandvars
468
(config["secfile"])),
470
self.secret = secfile.read()
472
raise TypeError("No secret or secfile for client %s"
474
self.host = config.get("host", "")
475
self.created = datetime.datetime.utcnow()
477
self.last_approval_request = None
478
self.last_enabled = datetime.datetime.utcnow()
479
self.last_checked_ok = None
480
self.last_checker_status = None
481
self.timeout = string_to_delta(config["timeout"])
482
self.extended_timeout = string_to_delta(config
483
["extended_timeout"])
484
self.interval = string_to_delta(config["interval"])
586
485
self.checker = None
587
486
self.checker_initiator_tag = None
588
487
self.disable_initiator_tag = None
488
self.expires = datetime.datetime.utcnow() + self.timeout
589
489
self.checker_callback_tag = None
490
self.checker_command = config["checker"]
590
491
self.current_checker_command = None
492
self._approved = None
493
self.approved_by_default = config.get("approved_by_default",
592
495
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()
496
self.approval_delay = string_to_delta(
497
config["approval_delay"])
498
self.approval_duration = string_to_delta(
499
config["approval_duration"])
500
self.changedstate = (multiprocessing_manager
501
.Condition(multiprocessing_manager
503
self.client_structure = [attr for attr in
504
self.__dict__.iterkeys()
597
505
if not attr.startswith("_")]
598
506
self.client_structure.append("client_structure")
600
for name, t in inspect.getmembers(
601
type(self), lambda obj: isinstance(obj, property)):
508
for name, t in inspect.getmembers(type(self),
602
512
if not name.startswith("_"):
603
513
self.client_structure.append(name)
644
554
def init_checker(self):
645
555
# Schedule a new checker to be started an 'interval' from now,
646
556
# 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),
557
self.checker_initiator_tag = (gobject.timeout_add
558
(self.interval_milliseconds(),
652
560
# 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)
561
self.disable_initiator_tag = (gobject.timeout_add
562
(self.timeout_milliseconds(),
657
564
# Also start a new checker *right now*.
658
565
self.start_checker()
660
def checker_callback(self, source, condition, connection,
567
def checker_callback(self, pid, condition, command):
662
568
"""The checker has completed, so take appropriate actions."""
663
569
self.checker_callback_tag = None
664
570
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
571
if os.WIFEXITED(condition):
572
self.last_checker_status = os.WEXITSTATUS(condition)
672
573
if self.last_checker_status == 0:
673
574
logger.info("Checker for %(name)s succeeded",
675
576
self.checked_ok()
677
logger.info("Checker for %(name)s failed", vars(self))
578
logger.info("Checker for %(name)s failed",
679
581
self.last_checker_status = -1
680
self.last_checker_signal = -returncode
681
582
logger.warning("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."""
585
def checked_ok(self, timeout=None):
586
"""Bump up the timeout for this client.
588
This should only be called when the client has been seen,
694
591
if timeout is None:
695
592
timeout = self.timeout
593
self.last_checked_ok = datetime.datetime.utcnow()
696
594
if self.disable_initiator_tag is not None:
697
595
gobject.source_remove(self.disable_initiator_tag)
698
self.disable_initiator_tag = None
699
596
if getattr(self, "enabled", False):
700
self.disable_initiator_tag = gobject.timeout_add(
701
int(timeout.total_seconds() * 1000), self.disable)
597
self.disable_initiator_tag = (gobject.timeout_add
598
(_timedelta_to_milliseconds
599
(timeout), self.disable))
702
600
self.expires = datetime.datetime.utcnow() + timeout
704
602
def need_approval(self):
710
608
If a checker already exists, leave it running and do
712
610
# 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
611
# did that, then if a checker (for some reason) started
612
# running slowly and taking more than 'interval' time, the
613
# client would inevitably timeout, since no checker would get
614
# a chance to run to completion. If we instead leave running
717
615
# checkers alone, the checker would have to take more time
718
616
# 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")
619
# If a checker exists, make sure it is not a zombie
621
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
622
except (AttributeError, OSError) as error:
623
if (isinstance(error, OSError)
624
and error.errno != errno.ECHILD):
628
logger.warning("Checker was a zombie")
629
gobject.source_remove(self.checker_callback_tag)
630
self.checker_callback(pid, status,
631
self.current_checker_command)
725
632
# Start a new checker if needed
726
633
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
635
# In case checker_command has exactly one % operator
636
command = self.checker_command % self.host
638
# Escape attributes for the shell
639
escaped_attrs = dict(
641
re.escape(unicode(str(getattr(self, attr, "")),
645
self.runtime_expansions)
648
command = self.checker_command % escaped_attrs
649
except TypeError as error:
650
logger.error('Could not format string "%s":'
651
' %s', self.checker_command, error)
652
return True # Try again later
738
653
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)
655
logger.info("Starting checker %r for %s",
657
# We don't need to redirect stdout and stderr, since
658
# in normal mode, that is already done by daemon(),
659
# and in debug mode we don't want to. (Stdin is
660
# always replaced by /dev/null.)
661
self.checker = subprocess.Popen(command,
664
self.checker_callback_tag = (gobject.child_watch_add
666
self.checker_callback,
668
# The checker may have completed before the gobject
669
# watch was added. Check for this.
670
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
672
gobject.source_remove(self.checker_callback_tag)
673
self.checker_callback(pid, status, command)
674
except OSError as error:
675
logger.error("Failed to start subprocess: %s",
764
677
# Re-run this periodically if run by gobject.timeout_add
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):
748
class DBusObjectWithProperties(dbus.service.Object):
964
749
"""A D-Bus object with properties.
966
751
Classes inheriting from this can use the dbus_service_property
1046
831
if not hasattr(value, "variant_level"):
1047
832
properties[name] = value
1049
properties[name] = type(value)(
1050
value, variant_level = value.variant_level + 1)
834
properties[name] = type(value)(value, variant_level=
835
value.variant_level+1)
1051
836
return dbus.Dictionary(properties, signature="sv")
1053
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1054
def PropertiesChanged(self, interface_name, changed_properties,
1055
invalidated_properties):
1056
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1061
838
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1062
839
out_signature="s",
1063
840
path_keyword='object_path',
1064
841
connection_keyword='connection')
1065
842
def Introspect(self, object_path, connection):
1066
"""Overloading of standard D-Bus method.
1068
Inserts property tags and interface annotation tags.
843
"""Standard D-Bus method, overloaded to insert property tags.
1070
xmlstring = DBusObjectWithAnnotations.Introspect(self,
845
xmlstring = dbus.service.Object.Introspect(self, object_path,
1074
848
document = xml.dom.minidom.parseString(xmlstring)
1076
849
def make_tag(document, name, prop):
1077
850
e = document.createElement("property")
1078
851
e.setAttribute("name", name)
1079
852
e.setAttribute("type", prop._dbus_signature)
1080
853
e.setAttribute("access", prop._dbus_access)
1083
855
for if_tag in document.getElementsByTagName("interface"):
1085
856
for tag in (make_tag(document, name, prop)
1087
in self._get_all_dbus_things("property")
858
in self._get_all_dbus_properties()
1088
859
if prop._dbus_interface
1089
860
== if_tag.getAttribute("name")):
1090
861
if_tag.appendChild(tag)
1091
# Add annotation tags for properties
1092
for tag in if_tag.getElementsByTagName("property"):
1094
for name, prop in self._get_all_dbus_things(
1096
if (name == tag.getAttribute("name")
1097
and prop._dbus_interface
1098
== if_tag.getAttribute("name")):
1099
annots.update(getattr(
1100
prop, "_dbus_annotations", {}))
1101
for name, value in annots.items():
1102
ann_tag = document.createElement(
1104
ann_tag.setAttribute("name", name)
1105
ann_tag.setAttribute("value", value)
1106
tag.appendChild(ann_tag)
1107
862
# Add the names to the return values for the
1108
863
# "org.freedesktop.DBus.Properties" methods
1109
864
if (if_tag.getAttribute("name")
1124
879
except (AttributeError, xml.dom.DOMException,
1125
880
xml.parsers.expat.ExpatError) as error:
1126
881
logger.error("Failed to override Introspection method",
1131
dbus.OBJECT_MANAGER_IFACE
1132
except AttributeError:
1133
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1135
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1136
"""A D-Bus object with an ObjectManager.
1138
Classes inheriting from this exposes the standard
1139
GetManagedObjects call and the InterfacesAdded and
1140
InterfacesRemoved signals on the standard
1141
"org.freedesktop.DBus.ObjectManager" interface.
1143
Note: No signals are sent automatically; they must be sent
1146
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1147
out_signature = "a{oa{sa{sv}}}")
1148
def GetManagedObjects(self):
1149
"""This function must be overridden"""
1150
raise NotImplementedError()
1152
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1153
signature = "oa{sa{sv}}")
1154
def InterfacesAdded(self, object_path, interfaces_and_properties):
1157
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1158
def InterfacesRemoved(self, object_path, interfaces):
1161
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1162
out_signature = "s",
1163
path_keyword = 'object_path',
1164
connection_keyword = 'connection')
1165
def Introspect(self, object_path, connection):
1166
"""Overloading of standard D-Bus method.
1168
Override return argument name of GetManagedObjects to be
1169
"objpath_interfaces_and_properties"
1171
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1175
document = xml.dom.minidom.parseString(xmlstring)
1177
for if_tag in document.getElementsByTagName("interface"):
1178
# Fix argument name for the GetManagedObjects method
1179
if (if_tag.getAttribute("name")
1180
== dbus.OBJECT_MANAGER_IFACE):
1181
for cn in if_tag.getElementsByTagName("method"):
1182
if (cn.getAttribute("name")
1183
== "GetManagedObjects"):
1184
for arg in cn.getElementsByTagName("arg"):
1185
if (arg.getAttribute("direction")
1189
"objpath_interfaces"
1191
xmlstring = document.toxml("utf-8")
1193
except (AttributeError, xml.dom.DOMException,
1194
xml.parsers.expat.ExpatError) as error:
1195
logger.error("Failed to override Introspection method",
1199
def datetime_to_dbus(dt, variant_level=0):
886
def datetime_to_dbus (dt, variant_level=0):
1200
887
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1202
889
return dbus.String("", variant_level = variant_level)
1203
return dbus.String(dt.isoformat(), variant_level=variant_level)
1206
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1207
"""A class decorator; applied to a subclass of
1208
dbus.service.Object, it will add alternate D-Bus attributes with
1209
interface names according to the "alt_interface_names" mapping.
1212
@alternate_dbus_interfaces({"org.example.Interface":
1213
"net.example.AlternateInterface"})
1214
class SampleDBusObject(dbus.service.Object):
1215
@dbus.service.method("org.example.Interface")
1216
def SampleDBusMethod():
1219
The above "SampleDBusMethod" on "SampleDBusObject" will be
1220
reachable via two interfaces: "org.example.Interface" and
1221
"net.example.AlternateInterface", the latter of which will have
1222
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1223
"true", unless "deprecate" is passed with a False value.
1225
This works for methods and signals, and also for D-Bus properties
1226
(from DBusObjectWithProperties) and interfaces (from the
1227
dbus_interface_annotations decorator).
890
return dbus.String(dt.isoformat(),
891
variant_level=variant_level)
894
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
896
"""Applied to an empty subclass of a D-Bus object, this metaclass
897
will add additional D-Bus attributes matching a certain pattern.
1231
for orig_interface_name, alt_interface_name in (
1232
alt_interface_names.items()):
1234
interface_names = set()
1235
# Go though all attributes of the class
1236
for attrname, attribute in inspect.getmembers(cls):
899
def __new__(mcs, name, bases, attr):
900
# Go through all the base classes which could have D-Bus
901
# methods, signals, or properties in them
902
for base in (b for b in bases
903
if issubclass(b, dbus.service.Object)):
904
# Go though all attributes of the base class
905
for attrname, attribute in inspect.getmembers(base):
1237
906
# Ignore non-D-Bus attributes, and D-Bus attributes
1238
907
# with the wrong interface name
1239
908
if (not hasattr(attribute, "_dbus_interface")
1240
or not attribute._dbus_interface.startswith(
1241
orig_interface_name)):
909
or not attribute._dbus_interface
910
.startswith("se.recompile.Mandos")):
1243
912
# Create an alternate D-Bus interface name based on
1244
913
# the current name
1245
alt_interface = attribute._dbus_interface.replace(
1246
orig_interface_name, alt_interface_name)
1247
interface_names.add(alt_interface)
914
alt_interface = (attribute._dbus_interface
915
.replace("se.recompile.Mandos",
916
"se.bsnet.fukt.Mandos"))
1248
917
# Is this a D-Bus signal?
1249
918
if getattr(attribute, "_dbus_is_signal", False):
1250
if sys.version_info.major == 2:
1251
# Extract the original non-method undecorated
1252
# function by black magic
1253
nonmethod_func = (dict(
919
# Extract the original non-method function by
921
nonmethod_func = (dict(
1254
922
zip(attribute.func_code.co_freevars,
1255
attribute.__closure__))
1256
["func"].cell_contents)
1258
nonmethod_func = attribute
923
attribute.__closure__))["func"]
1259
925
# Create a new, but exactly alike, function
1260
926
# object, and decorate it to be a new D-Bus signal
1261
927
# with the alternate D-Bus interface name
1262
if sys.version_info.major == 2:
1263
new_function = types.FunctionType(
1264
nonmethod_func.func_code,
1265
nonmethod_func.func_globals,
1266
nonmethod_func.func_name,
1267
nonmethod_func.func_defaults,
1268
nonmethod_func.func_closure)
1270
new_function = types.FunctionType(
1271
nonmethod_func.__code__,
1272
nonmethod_func.__globals__,
1273
nonmethod_func.__name__,
1274
nonmethod_func.__defaults__,
1275
nonmethod_func.__closure__)
1276
new_function = (dbus.service.signal(
1278
attribute._dbus_signature)(new_function))
1279
# Copy annotations, if any
1281
new_function._dbus_annotations = dict(
1282
attribute._dbus_annotations)
1283
except AttributeError:
928
new_function = (dbus.service.signal
930
attribute._dbus_signature)
932
nonmethod_func.func_code,
933
nonmethod_func.func_globals,
934
nonmethod_func.func_name,
935
nonmethod_func.func_defaults,
936
nonmethod_func.func_closure)))
1285
937
# Define a creator of a function to call both the
1286
# original and alternate functions, so both the
1287
# original and alternate signals gets sent when
1288
# the function is called
938
# old and new functions, so both the old and new
939
# signals gets sent when the function is called
1289
940
def fixscope(func1, func2):
1290
941
"""This function is a scope container to pass
1291
942
func1 and func2 to the "call_both" function
1292
943
outside of its arguments"""
1294
@functools.wraps(func2)
1295
944
def call_both(*args, **kwargs):
1296
945
"""This function will emit two D-Bus
1297
946
signals by calling func1 and func2"""
1298
947
func1(*args, **kwargs)
1299
948
func2(*args, **kwargs)
1300
# Make wrapper function look like a D-Bus signal
1301
for name, attr in inspect.getmembers(func2):
1302
if name.startswith("_dbus_"):
1303
setattr(call_both, name, attr)
1305
949
return call_both
1306
950
# Create the "call_both" function and add it to
1308
attr[attrname] = fixscope(attribute, new_function)
952
attr[attrname] = fixscope(attribute,
1309
954
# Is this a D-Bus method?
1310
955
elif getattr(attribute, "_dbus_is_method", False):
1311
956
# Create a new, but exactly alike, function
1312
957
# object. Decorate it to be a new D-Bus method
1313
958
# with the alternate D-Bus interface name. Add it
1316
dbus.service.method(
1318
attribute._dbus_in_signature,
1319
attribute._dbus_out_signature)
1320
(types.FunctionType(attribute.func_code,
1321
attribute.func_globals,
1322
attribute.func_name,
1323
attribute.func_defaults,
1324
attribute.func_closure)))
1325
# Copy annotations, if any
1327
attr[attrname]._dbus_annotations = dict(
1328
attribute._dbus_annotations)
1329
except AttributeError:
960
attr[attrname] = (dbus.service.method
962
attribute._dbus_in_signature,
963
attribute._dbus_out_signature)
965
(attribute.func_code,
966
attribute.func_globals,
968
attribute.func_defaults,
969
attribute.func_closure)))
1331
970
# Is this a D-Bus property?
1332
971
elif getattr(attribute, "_dbus_is_property", False):
1333
972
# Create a new, but exactly alike, function
1334
973
# object, and decorate it to be a new D-Bus
1335
974
# property with the alternate D-Bus interface
1336
975
# name. Add it to the class.
1337
attr[attrname] = (dbus_service_property(
1338
alt_interface, attribute._dbus_signature,
1339
attribute._dbus_access,
1340
attribute._dbus_get_args_options
1342
(types.FunctionType(
1343
attribute.func_code,
1344
attribute.func_globals,
1345
attribute.func_name,
1346
attribute.func_defaults,
1347
attribute.func_closure)))
1348
# Copy annotations, if any
1350
attr[attrname]._dbus_annotations = dict(
1351
attribute._dbus_annotations)
1352
except AttributeError:
1354
# Is this a D-Bus interface?
1355
elif getattr(attribute, "_dbus_is_interface", False):
1356
# Create a new, but exactly alike, function
1357
# object. Decorate it to be a new D-Bus interface
1358
# with the alternate D-Bus interface name. Add it
1361
dbus_interface_annotations(alt_interface)
1362
(types.FunctionType(attribute.func_code,
1363
attribute.func_globals,
1364
attribute.func_name,
1365
attribute.func_defaults,
1366
attribute.func_closure)))
1368
# Deprecate all alternate interfaces
1369
iname="_AlternateDBusNames_interface_annotation{}"
1370
for interface_name in interface_names:
1372
@dbus_interface_annotations(interface_name)
1374
return { "org.freedesktop.DBus.Deprecated":
1376
# Find an unused name
1377
for aname in (iname.format(i)
1378
for i in itertools.count()):
1379
if aname not in attr:
1383
# Replace the class with a new subclass of it with
1384
# methods, signals, etc. as created above.
1385
cls = type(b"{}Alternate".format(cls.__name__),
1392
@alternate_dbus_interfaces({"se.recompile.Mandos":
1393
"se.bsnet.fukt.Mandos"})
976
attr[attrname] = (dbus_service_property
978
attribute._dbus_signature,
979
attribute._dbus_access,
981
._dbus_get_args_options
984
(attribute.func_code,
985
attribute.func_globals,
987
attribute.func_defaults,
988
attribute.func_closure)))
989
return type.__new__(mcs, name, bases, attr)
1394
992
class ClientDBus(Client, DBusObjectWithProperties):
1395
993
"""A Client class using D-Bus
1467
1053
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1468
1054
last_enabled = notifychangeproperty(datetime_to_dbus,
1470
checker = notifychangeproperty(
1471
dbus.Boolean, "CheckerRunning",
1472
type_func = lambda checker: checker is not None)
1056
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1057
type_func = lambda checker:
1058
checker is not None)
1473
1059
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1474
1060
"LastCheckedOK")
1475
last_checker_status = notifychangeproperty(dbus.Int16,
1476
"LastCheckerStatus")
1477
1061
last_approval_request = notifychangeproperty(
1478
1062
datetime_to_dbus, "LastApprovalRequest")
1479
1063
approved_by_default = notifychangeproperty(dbus.Boolean,
1480
1064
"ApprovedByDefault")
1481
approval_delay = notifychangeproperty(
1482
dbus.UInt64, "ApprovalDelay",
1483
type_func = lambda td: td.total_seconds() * 1000)
1065
approval_delay = notifychangeproperty(dbus.UInt16,
1068
_timedelta_to_milliseconds)
1484
1069
approval_duration = notifychangeproperty(
1485
dbus.UInt64, "ApprovalDuration",
1486
type_func = lambda td: td.total_seconds() * 1000)
1070
dbus.UInt16, "ApprovalDuration",
1071
type_func = _timedelta_to_milliseconds)
1487
1072
host = notifychangeproperty(dbus.String, "Host")
1488
timeout = notifychangeproperty(
1489
dbus.UInt64, "Timeout",
1490
type_func = lambda td: td.total_seconds() * 1000)
1073
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1075
_timedelta_to_milliseconds)
1491
1076
extended_timeout = notifychangeproperty(
1492
dbus.UInt64, "ExtendedTimeout",
1493
type_func = lambda td: td.total_seconds() * 1000)
1494
interval = notifychangeproperty(
1495
dbus.UInt64, "Interval",
1496
type_func = lambda td: td.total_seconds() * 1000)
1077
dbus.UInt16, "ExtendedTimeout",
1078
type_func = _timedelta_to_milliseconds)
1079
interval = notifychangeproperty(dbus.UInt16,
1082
_timedelta_to_milliseconds)
1497
1083
checker_command = notifychangeproperty(dbus.String, "Checker")
1498
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1499
invalidate_only=True)
1501
1085
del notifychangeproperty
1745
1316
return datetime_to_dbus(self.last_approval_request)
1747
1318
# Timeout - property
1748
@dbus_service_property(_interface,
1319
@dbus_service_property(_interface, signature="t",
1750
1320
access="readwrite")
1751
1321
def Timeout_dbus_property(self, value=None):
1752
1322
if value is None: # get
1753
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1754
old_timeout = self.timeout
1323
return dbus.UInt64(self.timeout_milliseconds())
1755
1324
self.timeout = datetime.timedelta(0, 0, 0, value)
1756
# Reschedule disabling
1758
now = datetime.datetime.utcnow()
1759
self.expires += self.timeout - old_timeout
1760
if self.expires <= now:
1761
# The timeout has passed
1764
if (getattr(self, "disable_initiator_tag", None)
1767
gobject.source_remove(self.disable_initiator_tag)
1768
self.disable_initiator_tag = gobject.timeout_add(
1769
int((self.expires - now).total_seconds() * 1000),
1325
if getattr(self, "disable_initiator_tag", None) is None:
1327
# Reschedule timeout
1328
gobject.source_remove(self.disable_initiator_tag)
1329
self.disable_initiator_tag = None
1331
time_to_die = _timedelta_to_milliseconds((self
1336
if time_to_die <= 0:
1337
# The timeout has passed
1340
self.expires = (datetime.datetime.utcnow()
1341
+ datetime.timedelta(milliseconds =
1343
self.disable_initiator_tag = (gobject.timeout_add
1344
(time_to_die, self.disable))
1772
1346
# ExtendedTimeout - property
1773
@dbus_service_property(_interface,
1347
@dbus_service_property(_interface, signature="t",
1775
1348
access="readwrite")
1776
1349
def ExtendedTimeout_dbus_property(self, value=None):
1777
1350
if value is None: # get
1778
return dbus.UInt64(self.extended_timeout.total_seconds()
1351
return dbus.UInt64(self.extended_timeout_milliseconds())
1780
1352
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1782
1354
# Interval - property
1783
@dbus_service_property(_interface,
1355
@dbus_service_property(_interface, signature="t",
1785
1356
access="readwrite")
1786
1357
def Interval_dbus_property(self, value=None):
1787
1358
if value is None: # get
1788
return dbus.UInt64(self.interval.total_seconds() * 1000)
1359
return dbus.UInt64(self.interval_milliseconds())
1789
1360
self.interval = datetime.timedelta(0, 0, 0, value)
1790
1361
if getattr(self, "checker_initiator_tag", None) is None:
1793
# Reschedule checker run
1794
gobject.source_remove(self.checker_initiator_tag)
1795
self.checker_initiator_tag = gobject.timeout_add(
1796
value, self.start_checker)
1797
self.start_checker() # Start one now, too
1363
# Reschedule checker run
1364
gobject.source_remove(self.checker_initiator_tag)
1365
self.checker_initiator_tag = (gobject.timeout_add
1366
(value, self.start_checker))
1367
self.start_checker() # Start one now, too
1799
1369
# Checker - property
1800
@dbus_service_property(_interface,
1370
@dbus_service_property(_interface, signature="s",
1802
1371
access="readwrite")
1803
1372
def Checker_dbus_property(self, value=None):
1804
1373
if value is None: # get
1805
1374
return dbus.String(self.checker_command)
1806
self.checker_command = str(value)
1375
self.checker_command = value
1808
1377
# CheckerRunning - property
1809
@dbus_service_property(_interface,
1378
@dbus_service_property(_interface, signature="b",
1811
1379
access="readwrite")
1812
1380
def CheckerRunning_dbus_property(self, value=None):
1813
1381
if value is None: # get
2044
1612
def fingerprint(openpgp):
2045
1613
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2046
1614
# New GnuTLS "datum" with the OpenPGP public key
2047
datum = gnutls.library.types.gnutls_datum_t(
2048
ctypes.cast(ctypes.c_char_p(openpgp),
2049
ctypes.POINTER(ctypes.c_ubyte)),
2050
ctypes.c_uint(len(openpgp)))
1615
datum = (gnutls.library.types
1616
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1619
ctypes.c_uint(len(openpgp))))
2051
1620
# New empty GnuTLS certificate
2052
1621
crt = gnutls.library.types.gnutls_openpgp_crt_t()
2053
gnutls.library.functions.gnutls_openpgp_crt_init(
1622
(gnutls.library.functions
1623
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2055
1624
# Import the OpenPGP public key into the certificate
2056
gnutls.library.functions.gnutls_openpgp_crt_import(
2057
crt, ctypes.byref(datum),
2058
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1625
(gnutls.library.functions
1626
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1627
gnutls.library.constants
1628
.GNUTLS_OPENPGP_FMT_RAW))
2059
1629
# Verify the self signature in the key
2060
1630
crtverify = ctypes.c_uint()
2061
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
2062
crt, 0, ctypes.byref(crtverify))
1631
(gnutls.library.functions
1632
.gnutls_openpgp_crt_verify_self(crt, 0,
1633
ctypes.byref(crtverify)))
2063
1634
if crtverify.value != 0:
2064
1635
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2065
raise gnutls.errors.CertificateSecurityError(
1636
raise (gnutls.errors.CertificateSecurityError
2067
1638
# New buffer for the fingerprint
2068
1639
buf = ctypes.create_string_buffer(20)
2069
1640
buf_len = ctypes.c_size_t()
2070
1641
# Get the fingerprint from the certificate into the buffer
2071
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
2072
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1642
(gnutls.library.functions
1643
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1644
ctypes.byref(buf_len)))
2073
1645
# Deinit the certificate
2074
1646
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2075
1647
# Convert the buffer to a Python bytestring
2331
def rfc3339_duration_to_delta(duration):
2332
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2334
>>> rfc3339_duration_to_delta("P7D")
2335
datetime.timedelta(7)
2336
>>> rfc3339_duration_to_delta("PT60S")
2337
datetime.timedelta(0, 60)
2338
>>> rfc3339_duration_to_delta("PT60M")
2339
datetime.timedelta(0, 3600)
2340
>>> rfc3339_duration_to_delta("PT24H")
2341
datetime.timedelta(1)
2342
>>> rfc3339_duration_to_delta("P1W")
2343
datetime.timedelta(7)
2344
>>> rfc3339_duration_to_delta("PT5M30S")
2345
datetime.timedelta(0, 330)
2346
>>> rfc3339_duration_to_delta("P1DT3M20S")
2347
datetime.timedelta(1, 200)
2350
# Parsing an RFC 3339 duration with regular expressions is not
2351
# possible - there would have to be multiple places for the same
2352
# values, like seconds. The current code, while more esoteric, is
2353
# cleaner without depending on a parsing library. If Python had a
2354
# built-in library for parsing we would use it, but we'd like to
2355
# avoid excessive use of external libraries.
2357
# New type for defining tokens, syntax, and semantics all-in-one
2358
Token = collections.namedtuple("Token", (
2359
"regexp", # To match token; if "value" is not None, must have
2360
# a "group" containing digits
2361
"value", # datetime.timedelta or None
2362
"followers")) # Tokens valid after this token
2363
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2364
# the "duration" ABNF definition in RFC 3339, Appendix A.
2365
token_end = Token(re.compile(r"$"), None, frozenset())
2366
token_second = Token(re.compile(r"(\d+)S"),
2367
datetime.timedelta(seconds=1),
2368
frozenset((token_end, )))
2369
token_minute = Token(re.compile(r"(\d+)M"),
2370
datetime.timedelta(minutes=1),
2371
frozenset((token_second, token_end)))
2372
token_hour = Token(re.compile(r"(\d+)H"),
2373
datetime.timedelta(hours=1),
2374
frozenset((token_minute, token_end)))
2375
token_time = Token(re.compile(r"T"),
2377
frozenset((token_hour, token_minute,
2379
token_day = Token(re.compile(r"(\d+)D"),
2380
datetime.timedelta(days=1),
2381
frozenset((token_time, token_end)))
2382
token_month = Token(re.compile(r"(\d+)M"),
2383
datetime.timedelta(weeks=4),
2384
frozenset((token_day, token_end)))
2385
token_year = Token(re.compile(r"(\d+)Y"),
2386
datetime.timedelta(weeks=52),
2387
frozenset((token_month, token_end)))
2388
token_week = Token(re.compile(r"(\d+)W"),
2389
datetime.timedelta(weeks=1),
2390
frozenset((token_end, )))
2391
token_duration = Token(re.compile(r"P"), None,
2392
frozenset((token_year, token_month,
2393
token_day, token_time,
2395
# Define starting values
2396
value = datetime.timedelta() # Value so far
2398
followers = frozenset((token_duration, )) # Following valid tokens
2399
s = duration # String left to parse
2400
# Loop until end token is found
2401
while found_token is not token_end:
2402
# Search for any currently valid tokens
2403
for token in followers:
2404
match = token.regexp.match(s)
2405
if match is not None:
2407
if token.value is not None:
2408
# Value found, parse digits
2409
factor = int(match.group(1), 10)
2410
# Add to value so far
2411
value += factor * token.value
2412
# Strip token from string
2413
s = token.regexp.sub("", s, 1)
2416
# Set valid next tokens
2417
followers = found_token.followers
2420
# No currently valid tokens were found
2421
raise ValueError("Invalid RFC 3339 duration: {!r}"
2427
1874
def string_to_delta(interval):
2428
1875
"""Parse a string and return a datetime.timedelta
2558
1988
"debug": "False",
2560
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2561
":+SIGN-DSA-SHA256",
1990
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2562
1991
"servicename": "Mandos",
2563
1992
"use_dbus": "True",
2564
1993
"use_ipv6": "True",
2565
1994
"debuglevel": "",
2568
"statedir": "/var/lib/mandos",
2569
"foreground": "False",
2573
1997
# Parse config file for server-global settings
2574
1998
server_config = configparser.SafeConfigParser(server_defaults)
2575
1999
del server_defaults
2576
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2000
server_config.read(os.path.join(options.configdir,
2577
2002
# Convert the SafeConfigParser object to a dict
2578
2003
server_settings = server_config.defaults()
2579
2004
# Use the appropriate methods on the non-string config options
2580
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2005
for option in ("debug", "use_dbus", "use_ipv6"):
2581
2006
server_settings[option] = server_config.getboolean("DEFAULT",
2583
2008
if server_settings["port"]:
2584
2009
server_settings["port"] = server_config.getint("DEFAULT",
2586
if server_settings["socket"]:
2587
server_settings["socket"] = server_config.getint("DEFAULT",
2589
# Later, stdin will, and stdout and stderr might, be dup'ed
2590
# over with an opened os.devnull. But we don't want this to
2591
# happen with a supplied network socket.
2592
if 0 <= server_settings["socket"] <= 2:
2593
server_settings["socket"] = os.dup(server_settings
2595
2011
del server_config
2597
2013
# Override the settings from the config file with command line
2598
2014
# options, if set.
2599
2015
for option in ("interface", "address", "port", "debug",
2600
"priority", "servicename", "configdir", "use_dbus",
2601
"use_ipv6", "debuglevel", "restore", "statedir",
2602
"socket", "foreground", "zeroconf"):
2016
"priority", "servicename", "configdir",
2017
"use_dbus", "use_ipv6", "debuglevel", "restore"):
2603
2018
value = getattr(options, option)
2604
2019
if value is not None:
2605
2020
server_settings[option] = value
2607
2022
# Force all strings to be unicode
2608
2023
for option in server_settings.keys():
2609
if isinstance(server_settings[option], bytes):
2610
server_settings[option] = (server_settings[option]
2612
# Force all boolean options to be boolean
2613
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2614
"foreground", "zeroconf"):
2615
server_settings[option] = bool(server_settings[option])
2616
# Debug implies foreground
2617
if server_settings["debug"]:
2618
server_settings["foreground"] = True
2024
if type(server_settings[option]) is str:
2025
server_settings[option] = unicode(server_settings[option])
2619
2026
# Now we have our good server settings in "server_settings"
2621
2028
##################################################################
2623
if (not server_settings["zeroconf"]
2624
and not (server_settings["port"]
2625
or server_settings["socket"] != "")):
2626
parser.error("Needs port or socket to work without Zeroconf")
2628
2030
# For convenience
2629
2031
debug = server_settings["debug"]
2630
2032
debuglevel = server_settings["debuglevel"]
2631
2033
use_dbus = server_settings["use_dbus"]
2632
2034
use_ipv6 = server_settings["use_ipv6"]
2633
stored_state_path = os.path.join(server_settings["statedir"],
2635
foreground = server_settings["foreground"]
2636
zeroconf = server_settings["zeroconf"]
2639
initlogger(debug, logging.DEBUG)
2037
initlogger(logging.DEBUG)
2641
2039
if not debuglevel:
2644
2042
level = getattr(logging, debuglevel.upper())
2645
initlogger(debug, level)
2647
2045
if server_settings["servicename"] != "Mandos":
2648
syslogger.setFormatter(
2649
logging.Formatter('Mandos ({}) [%(process)d]:'
2650
' %(levelname)s: %(message)s'.format(
2651
server_settings["servicename"])))
2046
syslogger.setFormatter(logging.Formatter
2047
('Mandos (%s) [%%(process)d]:'
2048
' %%(levelname)s: %%(message)s'
2049
% server_settings["servicename"]))
2653
2051
# Parse config file with clients
2654
client_config = configparser.SafeConfigParser(Client
2052
client_defaults = { "timeout": "5m",
2053
"extended_timeout": "15m",
2055
"checker": "fping -q -- %%(host)s",
2057
"approval_delay": "0s",
2058
"approval_duration": "1s",
2060
client_config = configparser.SafeConfigParser(client_defaults)
2656
2061
client_config.read(os.path.join(server_settings["configdir"],
2657
2062
"clients.conf"))
2659
2064
global mandos_dbus_service
2660
2065
mandos_dbus_service = None
2663
if server_settings["socket"] != "":
2664
socketfd = server_settings["socket"]
2665
tcp_server = MandosServer(
2666
(server_settings["address"], server_settings["port"]),
2668
interface=(server_settings["interface"] or None),
2670
gnutls_priority=server_settings["priority"],
2674
pidfilename = "/run/mandos.pid"
2675
if not os.path.isdir("/run/."):
2676
pidfilename = "/var/run/mandos.pid"
2067
tcp_server = MandosServer((server_settings["address"],
2068
server_settings["port"]),
2070
interface=(server_settings["interface"]
2074
server_settings["priority"],
2077
pidfilename = "/var/run/mandos.pid"
2679
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2680
except IOError as e:
2681
logger.error("Could not open file %r", pidfilename,
2079
pidfile = open(pidfilename, "w")
2081
logger.error("Could not open file %r", pidfilename)
2684
for name in ("_mandos", "mandos", "nobody"):
2084
uid = pwd.getpwnam("_mandos").pw_uid
2085
gid = pwd.getpwnam("_mandos").pw_gid
2686
uid = pwd.getpwnam(name).pw_uid
2687
gid = pwd.getpwnam(name).pw_gid
2088
uid = pwd.getpwnam("mandos").pw_uid
2089
gid = pwd.getpwnam("mandos").pw_gid
2689
2090
except KeyError:
2092
uid = pwd.getpwnam("nobody").pw_uid
2093
gid = pwd.getpwnam("nobody").pw_gid
2697
2100
except OSError as error:
2698
if error.errno != errno.EPERM:
2101
if error[0] != errno.EPERM:
2702
2105
# Enable all possible GnuTLS debugging
2709
2112
def debug_gnutls(level, string):
2710
2113
logger.debug("GnuTLS: %s", string[:-1])
2712
gnutls.library.functions.gnutls_global_set_log_function(
2115
(gnutls.library.functions
2116
.gnutls_global_set_log_function(debug_gnutls))
2715
2118
# Redirect stdin so all checkers get /dev/null
2716
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2119
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2717
2120
os.dup2(null, sys.stdin.fileno())
2124
# No console logging
2125
logger.removeHandler(console)
2721
2127
# Need to fork before connecting to D-Bus
2723
2129
# Close all input and output, do double fork, etc.
2726
# multiprocessing will use threads, so before we use gobject we
2727
# need to inform gobject that threads will be used.
2728
gobject.threads_init()
2730
2132
global main_loop
2731
2133
# From the Avahi example code
2732
DBusGMainLoop(set_as_default=True)
2134
DBusGMainLoop(set_as_default=True )
2733
2135
main_loop = gobject.MainLoop()
2734
2136
bus = dbus.SystemBus()
2735
2137
# End of Avahi example code
2738
2140
bus_name = dbus.service.BusName("se.recompile.Mandos",
2741
old_bus_name = dbus.service.BusName(
2742
"se.bsnet.fukt.Mandos", bus,
2744
except dbus.exceptions.DBusException as e:
2745
logger.error("Disabling D-Bus:", exc_info=e)
2141
bus, do_not_queue=True)
2142
old_bus_name = (dbus.service.BusName
2143
("se.bsnet.fukt.Mandos", bus,
2145
except dbus.exceptions.NameExistsException as e:
2146
logger.error(unicode(e) + ", disabling D-Bus")
2746
2147
use_dbus = False
2747
2148
server_settings["use_dbus"] = False
2748
2149
tcp_server.use_dbus = False
2750
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2751
service = AvahiServiceToSyslog(
2752
name = server_settings["servicename"],
2753
servicetype = "_mandos._tcp",
2754
protocol = protocol,
2756
if server_settings["interface"]:
2757
service.interface = if_nametoindex(
2758
server_settings["interface"].encode("utf-8"))
2150
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2151
service = AvahiServiceToSyslog(name =
2152
server_settings["servicename"],
2153
servicetype = "_mandos._tcp",
2154
protocol = protocol, bus = bus)
2155
if server_settings["interface"]:
2156
service.interface = (if_nametoindex
2157
(str(server_settings["interface"])))
2760
2159
global multiprocessing_manager
2761
2160
multiprocessing_manager = multiprocessing.Manager()
2763
2162
client_class = Client
2765
client_class = functools.partial(ClientDBus, bus = bus)
2767
client_settings = Client.config_parser(client_config)
2164
client_class = functools.partial(ClientDBusTransitional,
2167
special_settings = {
2168
# Some settings need to be accessd by special methods;
2169
# booleans need .getboolean(), etc. Here is a list of them:
2170
"approved_by_default":
2172
client_config.getboolean(section, "approved_by_default"),
2174
# Construct a new dict of client settings of this form:
2175
# { client_name: {setting_name: value, ...}, ...}
2176
# with exceptions for any special settings as defined above
2177
client_settings = dict((clientname,
2180
if setting not in special_settings
2181
else special_settings[setting]
2183
for setting, value in
2184
client_config.items(clientname)))
2185
for clientname in client_config.sections())
2768
2187
old_client_settings = {}
2771
# This is used to redirect stdout and stderr for checker processes
2773
wnull = open(os.devnull, "w") # A writable /dev/null
2774
# Only used if server is running in foreground but not in debug
2776
if debug or not foreground:
2779
2190
# Get client data and settings from last running state.
2780
2191
if server_settings["restore"]:
2782
2193
with open(stored_state_path, "rb") as stored_state:
2783
clients_data, old_client_settings = pickle.load(
2194
clients_data, old_client_settings = (pickle.load
2785
2196
os.remove(stored_state_path)
2786
2197
except IOError as e:
2787
if e.errno == errno.ENOENT:
2788
logger.warning("Could not load persistent state:"
2789
" {}".format(os.strerror(e.errno)))
2791
logger.critical("Could not load persistent state:",
2198
logger.warning("Could not load persistent state: {0}"
2200
if e.errno != errno.ENOENT:
2794
except EOFError as e:
2795
logger.warning("Could not load persistent state: "
2799
with PGPEngine() as pgp:
2800
for client_name, client in clients_data.items():
2801
# Skip removed clients
2802
if client_name not in client_settings:
2203
with Crypto() as crypt:
2204
for client in clients_data:
2205
client_name = client["name"]
2805
2207
# Decide which value to use after restoring saved state.
2806
2208
# We have three different values: Old config file,
2812
2214
# For each value in new config, check if it
2813
2215
# differs from the old config value (Except for
2814
2216
# the "secret" attribute)
2815
if (name != "secret"
2817
old_client_settings[client_name][name])):
2818
client[name] = value
2217
if (name != "secret" and
2218
value != old_client_settings[client_name]
2220
setattr(client, name, value)
2819
2221
except KeyError:
2822
2224
# Clients who has passed its expire date can still be
2823
# enabled if its last checker was successful. A Client
2824
# whose checker succeeded before we stored its state is
2825
# assumed to have successfully run all checkers during
2827
if client["enabled"]:
2828
if datetime.datetime.utcnow() >= client["expires"]:
2829
if not client["last_checked_ok"]:
2831
"disabling client {} - Client never "
2832
"performed a successful checker".format(
2834
client["enabled"] = False
2835
elif client["last_checker_status"] != 0:
2837
"disabling client {} - Client last"
2838
" checker failed with error code"
2841
client["last_checker_status"]))
2225
# enabled if its last checker was sucessful. Clients
2226
# whose checker failed before we stored its state is
2227
# assumed to have failed all checkers during downtime.
2228
if client["enabled"] and client["last_checked_ok"]:
2229
if ((datetime.datetime.utcnow()
2230
- client["last_checked_ok"])
2231
> client["interval"]):
2232
if client["last_checker_status"] != 0:
2842
2233
client["enabled"] = False
2844
client["expires"] = (
2845
datetime.datetime.utcnow()
2846
+ client["timeout"])
2847
logger.debug("Last checker succeeded,"
2848
" keeping {} enabled".format(
2235
client["expires"] = (datetime.datetime
2237
+ client["timeout"])
2239
client["changedstate"] = (multiprocessing_manager
2241
(multiprocessing_manager
2244
new_client = (ClientDBusTransitional.__new__
2245
(ClientDBusTransitional))
2246
tcp_server.clients[client_name] = new_client
2247
new_client.bus = bus
2248
for name, value in client.iteritems():
2249
setattr(new_client, name, value)
2250
client_object_name = unicode(client_name).translate(
2251
{ord("."): ord("_"),
2252
ord("-"): ord("_")})
2253
new_client.dbus_object_path = (dbus.ObjectPath
2255
+ client_object_name))
2256
DBusObjectWithProperties.__init__(new_client,
2261
tcp_server.clients[client_name] = (Client.__new__
2263
for name, value in client.iteritems():
2264
setattr(tcp_server.clients[client_name],
2851
client["secret"] = pgp.decrypt(
2852
client["encrypted_secret"],
2268
tcp_server.clients[client_name].secret = (
2269
crypt.decrypt(tcp_server.clients[client_name]
2271
client_settings[client_name]
2274
# If decryption fails, we use secret from new settings
2275
tcp_server.clients[client_name].secret = (
2853
2276
client_settings[client_name]["secret"])
2855
# If decryption fails, we use secret from new settings
2856
logger.debug("Failed to decrypt {} old secret".format(
2858
client["secret"] = (client_settings[client_name]
2861
# Add/remove clients based on new changes made to config
2862
for client_name in (set(old_client_settings)
2863
- set(client_settings)):
2864
del clients_data[client_name]
2865
for client_name in (set(client_settings)
2866
- set(old_client_settings)):
2867
clients_data[client_name] = client_settings[client_name]
2869
# Create all client objects
2870
for client_name, client in clients_data.items():
2871
tcp_server.clients[client_name] = client_class(
2874
server_settings = server_settings)
2278
# Create/remove clients based on new changes made to config
2279
for clientname in set(old_client_settings) - set(client_settings):
2280
del tcp_server.clients[clientname]
2281
for clientname in set(client_settings) - set(old_client_settings):
2282
tcp_server.clients[clientname] = (client_class(name
2876
2288
if not tcp_server.clients:
2877
2289
logger.warning("No clients defined")
2880
if pidfile is not None:
2884
print(pid, file=pidfile)
2886
logger.error("Could not write to file %r with PID %d",
2295
pidfile.write(str(pid) + "\n".encode("utf-8"))
2298
logger.error("Could not write to file %r with PID %d",
2301
# "pidfile" was never created
2889
2303
del pidfilename
2305
signal.signal(signal.SIGINT, signal.SIG_IGN)
2891
2307
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2892
2308
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2896
@alternate_dbus_interfaces(
2897
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2898
class MandosDBusService(DBusObjectWithObjectManager):
2311
class MandosDBusService(dbus.service.Object):
2899
2312
"""A D-Bus proxy object"""
2901
2313
def __init__(self):
2902
2314
dbus.service.Object.__init__(self, bus, "/")
2904
2315
_interface = "se.recompile.Mandos"
2906
2317
@dbus.service.signal(_interface, signature="o")
2947
2352
if c.dbus_object_path == object_path:
2948
2353
del tcp_server.clients[c.name]
2949
2354
c.remove_from_connection()
2950
# Don't signal the disabling
2355
# Don't signal anything except ClientRemoved
2951
2356
c.disable(quiet=True)
2952
# Emit D-Bus signal for removal
2953
self.client_removed_signal(c)
2358
self.ClientRemoved(object_path, c.name)
2955
2360
raise KeyError(object_path)
2959
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
2960
out_signature = "a{oa{sa{sv}}}")
2961
def GetManagedObjects(self):
2963
return dbus.Dictionary(
2964
{ client.dbus_object_path:
2966
{ interface: client.GetAll(interface)
2968
client._get_all_interface_names()})
2969
for client in tcp_server.clients.values()})
2971
def client_added_signal(self, client):
2972
"""Send the new standard signal and the old signal"""
2974
# New standard signal
2975
self.InterfacesAdded(
2976
client.dbus_object_path,
2978
{ interface: client.GetAll(interface)
2980
client._get_all_interface_names()}))
2982
self.ClientAdded(client.dbus_object_path)
2984
def client_removed_signal(self, client):
2985
"""Send the new standard signal and the old signal"""
2987
# New standard signal
2988
self.InterfacesRemoved(
2989
client.dbus_object_path,
2990
client._get_all_interface_names())
2992
self.ClientRemoved(client.dbus_object_path,
2995
mandos_dbus_service = MandosDBusService()
2364
class MandosDBusServiceTransitional(MandosDBusService):
2365
__metaclass__ = AlternateDBusNamesMetaclass
2366
mandos_dbus_service = MandosDBusServiceTransitional()
2998
2369
"Cleanup function; run on exit"
3002
2372
multiprocessing.active_children()
3004
2373
if not (tcp_server.clients or client_settings):
3007
2376
# Store client before exiting. Secrets are encrypted with key
3008
2377
# based on what config file has. If config file is
3009
2378
# removed/edited, old secret will thus be unrecovable.
3011
with PGPEngine() as pgp:
2380
with Crypto() as crypt:
3012
2381
for client in tcp_server.clients.itervalues():
3013
2382
key = client_settings[client.name]["secret"]
3014
client.encrypted_secret = pgp.encrypt(client.secret,
2383
client.encrypted_secret = crypt.encrypt(client.secret,
3016
2385
client_dict = {}
3018
# A list of attributes that can not be pickled
3020
exclude = { "bus", "changedstate", "secret",
3021
"checker", "server_settings" }
3022
for name, typ in inspect.getmembers(dbus.service
2387
# A list of attributes that will not be stored when
2389
exclude = set(("bus", "changedstate", "secret"))
2390
for name, typ in (inspect.getmembers
2391
(dbus.service.Object)):
3024
2392
exclude.add(name)
3026
2394
client_dict["encrypted_secret"] = (client