84
88
except ImportError:
85
89
SO_BINDTODEVICE = None
92
stored_state_file = "clients.pickle"
90
94
logger = logging.getLogger()
91
stored_state_path = "/var/lib/mandos/clients.pickle"
93
95
syslogger = (logging.handlers.SysLogHandler
94
96
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
97
address = str("/dev/log")))
96
syslogger.setFormatter(logging.Formatter
97
('Mandos [%(process)d]: %(levelname)s:'
99
logger.addHandler(syslogger)
101
console = logging.StreamHandler()
102
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
106
logger.addHandler(console)
100
if_nametoindex = (ctypes.cdll.LoadLibrary
101
(ctypes.util.find_library("c"))
103
except (OSError, AttributeError):
104
def if_nametoindex(interface):
105
"Get an interface index the hard way, i.e. using fcntl()"
106
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
107
with contextlib.closing(socket.socket()) as s:
108
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
109
struct.pack(str("16s16x"),
111
interface_index = struct.unpack(str("I"),
113
return interface_index
116
def initlogger(debug, level=logging.WARNING):
117
"""init logger and add loglevel"""
119
syslogger.setFormatter(logging.Formatter
120
('Mandos [%(process)d]: %(levelname)s:'
122
logger.addHandler(syslogger)
125
console = logging.StreamHandler()
126
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
130
logger.addHandler(console)
131
logger.setLevel(level)
134
class PGPError(Exception):
135
"""Exception if encryption/decryption fails"""
139
class PGPEngine(object):
140
"""A simple class for OpenPGP symmetric encryption & decryption"""
142
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
143
self.gnupgargs = ['--batch',
144
'--home', self.tempdir,
152
def __exit__(self, exc_type, exc_value, traceback):
160
if self.tempdir is not None:
161
# Delete contents of tempdir
162
for root, dirs, files in os.walk(self.tempdir,
164
for filename in files:
165
os.remove(os.path.join(root, filename))
167
os.rmdir(os.path.join(root, dirname))
169
os.rmdir(self.tempdir)
172
def password_encode(self, password):
173
# Passphrase can not be empty and can not contain newlines or
174
# NUL bytes. So we prefix it and hex encode it.
175
encoded = b"mandos" + binascii.hexlify(password)
176
if len(encoded) > 2048:
177
# GnuPG can't handle long passwords, so encode differently
178
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
179
.replace(b"\n", b"\\n")
180
.replace(b"\0", b"\\x00"))
183
def encrypt(self, data, password):
184
passphrase = self.password_encode(password)
185
with tempfile.NamedTemporaryFile(dir=self.tempdir
187
passfile.write(passphrase)
189
proc = subprocess.Popen(['gpg', '--symmetric',
193
stdin = subprocess.PIPE,
194
stdout = subprocess.PIPE,
195
stderr = subprocess.PIPE)
196
ciphertext, err = proc.communicate(input = data)
197
if proc.returncode != 0:
201
def decrypt(self, data, password):
202
passphrase = self.password_encode(password)
203
with tempfile.NamedTemporaryFile(dir = self.tempdir
205
passfile.write(passphrase)
207
proc = subprocess.Popen(['gpg', '--decrypt',
211
stdin = subprocess.PIPE,
212
stdout = subprocess.PIPE,
213
stderr = subprocess.PIPE)
214
decrypted_plaintext, err = proc.communicate(input
216
if proc.returncode != 0:
218
return decrypted_plaintext
109
221
class AvahiError(Exception):
310
433
interval: datetime.timedelta(); How often to start a new checker
311
434
last_approval_request: datetime.datetime(); (UTC) or None
312
435
last_checked_ok: datetime.datetime(); (UTC) or None
313
last_checker_status: integer between 0 and 255 reflecting exit status
314
of last checker. -1 reflect crashed checker,
316
last_enabled: datetime.datetime(); (UTC)
436
last_checker_status: integer between 0 and 255 reflecting exit
437
status of last checker. -1 reflects crashed
438
checker, -2 means no checker completed yet.
439
last_enabled: datetime.datetime(); (UTC) or None
317
440
name: string; from the config file, used in log messages and
318
441
D-Bus identifiers
319
442
secret: bytestring; sent verbatim (over TLS) to client
320
443
timeout: datetime.timedelta(); How long from last_checked_ok
321
444
until this client is disabled
322
extended_timeout: extra long timeout when password has been sent
445
extended_timeout: extra long timeout when secret has been sent
323
446
runtime_expansions: Allowed attributes for runtime expansion.
324
447
expires: datetime.datetime(); time (UTC) when a client will be
325
448
disabled, or None
449
server_settings: The server_settings dict from main()
328
452
runtime_expansions = ("approval_delay", "approval_duration",
329
"created", "enabled", "fingerprint",
330
"host", "interval", "last_checked_ok",
453
"created", "enabled", "expires",
454
"fingerprint", "host", "interval",
455
"last_approval_request", "last_checked_ok",
331
456
"last_enabled", "name", "timeout")
457
client_defaults = { "timeout": "PT5M",
458
"extended_timeout": "PT15M",
460
"checker": "fping -q -- %%(host)s",
462
"approval_delay": "PT0S",
463
"approval_duration": "PT1S",
464
"approved_by_default": "True",
333
468
def timeout_milliseconds(self):
334
469
"Return the 'timeout' attribute in milliseconds"
335
return _timedelta_to_milliseconds(self.timeout)
470
return timedelta_to_milliseconds(self.timeout)
337
472
def extended_timeout_milliseconds(self):
338
473
"Return the 'extended_timeout' attribute in milliseconds"
339
return _timedelta_to_milliseconds(self.extended_timeout)
474
return timedelta_to_milliseconds(self.extended_timeout)
341
476
def interval_milliseconds(self):
342
477
"Return the 'interval' attribute in milliseconds"
343
return _timedelta_to_milliseconds(self.interval)
478
return timedelta_to_milliseconds(self.interval)
345
480
def approval_delay_milliseconds(self):
346
return _timedelta_to_milliseconds(self.approval_delay)
348
def __init__(self, name = None, config=None):
349
"""Note: the 'checker' key in 'config' sets the
350
'checker_command' attribute and *not* the 'checker'
481
return timedelta_to_milliseconds(self.approval_delay)
484
def config_parser(config):
485
"""Construct a new dict of client settings of this form:
486
{ client_name: {setting_name: value, ...}, ...}
487
with exceptions for any special settings as defined above.
488
NOTE: Must be a pure function. Must return the same result
489
value given the same arguments.
492
for client_name in config.sections():
493
section = dict(config.items(client_name))
494
client = settings[client_name] = {}
496
client["host"] = section["host"]
497
# Reformat values from string types to Python types
498
client["approved_by_default"] = config.getboolean(
499
client_name, "approved_by_default")
500
client["enabled"] = config.getboolean(client_name,
503
client["fingerprint"] = (section["fingerprint"].upper()
505
if "secret" in section:
506
client["secret"] = section["secret"].decode("base64")
507
elif "secfile" in section:
508
with open(os.path.expanduser(os.path.expandvars
509
(section["secfile"])),
511
client["secret"] = secfile.read()
513
raise TypeError("No secret or secfile for section {0}"
515
client["timeout"] = string_to_delta(section["timeout"])
516
client["extended_timeout"] = string_to_delta(
517
section["extended_timeout"])
518
client["interval"] = string_to_delta(section["interval"])
519
client["approval_delay"] = string_to_delta(
520
section["approval_delay"])
521
client["approval_duration"] = string_to_delta(
522
section["approval_duration"])
523
client["checker_command"] = section["checker"]
524
client["last_approval_request"] = None
525
client["last_checked_ok"] = None
526
client["last_checker_status"] = -2
530
def __init__(self, settings, name = None, server_settings=None):
532
if server_settings is None:
534
self.server_settings = server_settings
535
# adding all client settings
536
for setting, value in settings.iteritems():
537
setattr(self, setting, value)
540
if not hasattr(self, "last_enabled"):
541
self.last_enabled = datetime.datetime.utcnow()
542
if not hasattr(self, "expires"):
543
self.expires = (datetime.datetime.utcnow()
546
self.last_enabled = None
355
549
logger.debug("Creating client %r", self.name)
356
550
# Uppercase and remove spaces from fingerprint for later
357
551
# comparison purposes with return value from the fingerprint()
359
self.fingerprint = (config["fingerprint"].upper()
361
553
logger.debug(" Fingerprint: %s", self.fingerprint)
362
if "secret" in config:
363
self.secret = config["secret"].decode("base64")
364
elif "secfile" in config:
365
with open(os.path.expanduser(os.path.expandvars
366
(config["secfile"])),
368
self.secret = secfile.read()
370
raise TypeError("No secret or secfile for client %s"
372
self.host = config.get("host", "")
373
self.created = datetime.datetime.utcnow()
375
self.last_approval_request = None
376
self.last_enabled = datetime.datetime.utcnow()
377
self.last_checked_ok = None
378
self.last_checker_status = None
379
self.timeout = string_to_delta(config["timeout"])
380
self.extended_timeout = string_to_delta(config
381
["extended_timeout"])
382
self.interval = string_to_delta(config["interval"])
554
self.created = settings.get("created",
555
datetime.datetime.utcnow())
557
# attributes specific for this server instance
383
558
self.checker = None
384
559
self.checker_initiator_tag = None
385
560
self.disable_initiator_tag = None
386
self.expires = datetime.datetime.utcnow() + self.timeout
387
561
self.checker_callback_tag = None
388
self.checker_command = config["checker"]
389
562
self.current_checker_command = None
390
self._approved = None
391
self.approved_by_default = config.get("approved_by_default",
393
564
self.approvals_pending = 0
394
self.approval_delay = string_to_delta(
395
config["approval_delay"])
396
self.approval_duration = string_to_delta(
397
config["approval_duration"])
398
565
self.changedstate = (multiprocessing_manager
399
566
.Condition(multiprocessing_manager
401
self.client_structure = [attr for attr in self.__dict__.iterkeys() if not attr.startswith("_")]
568
self.client_structure = [attr for attr in
569
self.__dict__.iterkeys()
570
if not attr.startswith("_")]
402
571
self.client_structure.append("client_structure")
405
573
for name, t in inspect.getmembers(type(self),
406
lambda obj: isinstance(obj, property)):
407
577
if not name.startswith("_"):
408
578
self.client_structure.append(name)
417
587
if getattr(self, "enabled", False):
418
588
# Already enabled
420
self.send_changedstate()
421
590
self.expires = datetime.datetime.utcnow() + self.timeout
422
591
self.enabled = True
423
592
self.last_enabled = datetime.datetime.utcnow()
424
593
self.init_checker()
594
self.send_changedstate()
426
596
def disable(self, quiet=True):
427
597
"""Disable this client."""
428
598
if not getattr(self, "enabled", False):
431
self.send_changedstate()
433
601
logger.info("Disabling client %s", self.name)
434
if getattr(self, "disable_initiator_tag", False):
602
if getattr(self, "disable_initiator_tag", None) is not None:
435
603
gobject.source_remove(self.disable_initiator_tag)
436
604
self.disable_initiator_tag = None
437
605
self.expires = None
438
if getattr(self, "checker_initiator_tag", False):
606
if getattr(self, "checker_initiator_tag", None) is not None:
439
607
gobject.source_remove(self.checker_initiator_tag)
440
608
self.checker_initiator_tag = None
441
609
self.stop_checker()
442
610
self.enabled = False
612
self.send_changedstate()
443
613
# Do not run this again if called by a gobject.timeout_add
446
616
def __del__(self):
449
619
def init_checker(self):
450
620
# Schedule a new checker to be started an 'interval' from now,
451
621
# and every interval from then on.
622
if self.checker_initiator_tag is not None:
623
gobject.source_remove(self.checker_initiator_tag)
452
624
self.checker_initiator_tag = (gobject.timeout_add
453
625
(self.interval_milliseconds(),
454
626
self.start_checker))
455
627
# Schedule a disable() when 'timeout' has passed
628
if self.disable_initiator_tag is not None:
629
gobject.source_remove(self.disable_initiator_tag)
456
630
self.disable_initiator_tag = (gobject.timeout_add
457
631
(self.timeout_milliseconds(),
459
633
# Also start a new checker *right now*.
460
634
self.start_checker()
463
636
def checker_callback(self, pid, condition, command):
464
637
"""The checker has completed, so take appropriate actions."""
465
638
self.checker_callback_tag = None
466
639
self.checker = None
467
640
if os.WIFEXITED(condition):
468
self.last_checker_status = os.WEXITSTATUS(condition)
641
self.last_checker_status = os.WEXITSTATUS(condition)
469
642
if self.last_checker_status == 0:
470
643
logger.info("Checker for %(name)s succeeded",
554
722
# in normal mode, that is already done by daemon(),
555
723
# and in debug mode we don't want to. (Stdin is
556
724
# always replaced by /dev/null.)
725
# The exception is when not debugging but nevertheless
726
# running in the foreground; use the previously
729
if (not self.server_settings["debug"]
730
and self.server_settings["foreground"]):
731
popen_args.update({"stdout": wnull,
557
733
self.checker = subprocess.Popen(command,
560
self.checker_callback_tag = (gobject.child_watch_add
562
self.checker_callback,
564
# The checker may have completed before the gobject
565
# watch was added. Check for this.
737
except OSError as error:
738
logger.error("Failed to start subprocess",
741
self.checker_callback_tag = (gobject.child_watch_add
743
self.checker_callback,
745
# The checker may have completed before the gobject
746
# watch was added. Check for this.
566
748
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
568
gobject.source_remove(self.checker_callback_tag)
569
self.checker_callback(pid, status, command)
570
749
except OSError as error:
571
logger.error("Failed to start subprocess: %s",
750
if error.errno == errno.ECHILD:
751
# This should never happen
752
logger.error("Child process vanished",
757
gobject.source_remove(self.checker_callback_tag)
758
self.checker_callback(pid, status, command)
573
759
# Re-run this periodically if run by gobject.timeout_add
583
769
logger.debug("Stopping checker for %(name)s", vars(self))
585
os.kill(self.checker.pid, signal.SIGTERM)
771
self.checker.terminate()
587
773
#if self.checker.poll() is None:
588
# os.kill(self.checker.pid, signal.SIGKILL)
774
# self.checker.kill()
589
775
except OSError as error:
590
776
if error.errno != errno.ESRCH: # No such process
592
778
self.checker = None
594
# Encrypts a client secret and stores it in a varible encrypted_secret
595
def encrypt_secret(self, key):
596
# Encryption-key need to be of a specific size, so we hash inputed key
597
hasheng = hashlib.sha256()
599
encryptionkey = hasheng.digest()
601
# Create validation hash so we know at decryption if it was sucessful
602
hasheng = hashlib.sha256()
603
hasheng.update(self.secret)
604
validationhash = hasheng.digest()
607
iv = os.urandom(Crypto.Cipher.AES.block_size)
608
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
609
Crypto.Cipher.AES.MODE_CFB, iv)
610
ciphertext = ciphereng.encrypt(validationhash+self.secret)
611
self.encrypted_secret = (ciphertext, iv)
613
# Decrypt a encrypted client secret
614
def decrypt_secret(self, key):
615
# Decryption-key need to be of a specific size, so we hash inputed key
616
hasheng = hashlib.sha256()
618
encryptionkey = hasheng.digest()
620
# Decrypt encrypted secret
621
ciphertext, iv = self.encrypted_secret
622
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
623
Crypto.Cipher.AES.MODE_CFB, iv)
624
plain = ciphereng.decrypt(ciphertext)
626
# Validate decrypted secret to know if it was succesful
627
hasheng = hashlib.sha256()
628
validationhash = plain[:hasheng.digest_size]
629
secret = plain[hasheng.digest_size:]
630
hasheng.update(secret)
632
# if validation fails, we use key as new secret. Otherwhise, we use
633
# the decrypted secret
634
if hasheng.digest() == validationhash:
638
del self.encrypted_secret
641
781
def dbus_service_property(dbus_interface, signature="v",
642
782
access="readwrite", byte_arrays=False):
795
984
e.setAttribute("access", prop._dbus_access)
797
986
for if_tag in document.getElementsByTagName("interface"):
798
988
for tag in (make_tag(document, name, prop)
800
in self._get_all_dbus_properties()
990
in self._get_all_dbus_things("property")
801
991
if prop._dbus_interface
802
992
== if_tag.getAttribute("name")):
803
993
if_tag.appendChild(tag)
994
# Add annotation tags
995
for typ in ("method", "signal", "property"):
996
for tag in if_tag.getElementsByTagName(typ):
998
for name, prop in (self.
999
_get_all_dbus_things(typ)):
1000
if (name == tag.getAttribute("name")
1001
and prop._dbus_interface
1002
== if_tag.getAttribute("name")):
1003
annots.update(getattr
1005
"_dbus_annotations",
1007
for name, value in annots.iteritems():
1008
ann_tag = document.createElement(
1010
ann_tag.setAttribute("name", name)
1011
ann_tag.setAttribute("value", value)
1012
tag.appendChild(ann_tag)
1013
# Add interface annotation tags
1014
for annotation, value in dict(
1015
itertools.chain.from_iterable(
1016
annotations().iteritems()
1017
for name, annotations in
1018
self._get_all_dbus_things("interface")
1019
if name == if_tag.getAttribute("name")
1021
ann_tag = document.createElement("annotation")
1022
ann_tag.setAttribute("name", annotation)
1023
ann_tag.setAttribute("value", value)
1024
if_tag.appendChild(ann_tag)
804
1025
# Add the names to the return values for the
805
1026
# "org.freedesktop.DBus.Properties" methods
806
1027
if (if_tag.getAttribute("name")
821
1042
except (AttributeError, xml.dom.DOMException,
822
1043
xml.parsers.expat.ExpatError) as error:
823
1044
logger.error("Failed to override Introspection method",
825
1046
return xmlstring
828
def datetime_to_dbus (dt, variant_level=0):
1049
def datetime_to_dbus(dt, variant_level=0):
829
1050
"""Convert a UTC datetime.datetime() to a D-Bus type."""
831
1052
return dbus.String("", variant_level = variant_level)
832
1053
return dbus.String(dt.isoformat(),
833
1054
variant_level=variant_level)
835
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
837
"""Applied to an empty subclass of a D-Bus object, this metaclass
838
will add additional D-Bus attributes matching a certain pattern.
1057
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1058
"""A class decorator; applied to a subclass of
1059
dbus.service.Object, it will add alternate D-Bus attributes with
1060
interface names according to the "alt_interface_names" mapping.
1063
@alternate_dbus_interfaces({"org.example.Interface":
1064
"net.example.AlternateInterface"})
1065
class SampleDBusObject(dbus.service.Object):
1066
@dbus.service.method("org.example.Interface")
1067
def SampleDBusMethod():
1070
The above "SampleDBusMethod" on "SampleDBusObject" will be
1071
reachable via two interfaces: "org.example.Interface" and
1072
"net.example.AlternateInterface", the latter of which will have
1073
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1074
"true", unless "deprecate" is passed with a False value.
1076
This works for methods and signals, and also for D-Bus properties
1077
(from DBusObjectWithProperties) and interfaces (from the
1078
dbus_interface_annotations decorator).
840
def __new__(mcs, name, bases, attr):
841
# Go through all the base classes which could have D-Bus
842
# methods, signals, or properties in them
843
for base in (b for b in bases
844
if issubclass(b, dbus.service.Object)):
845
# Go though all attributes of the base class
846
for attrname, attribute in inspect.getmembers(base):
1081
for orig_interface_name, alt_interface_name in (
1082
alt_interface_names.iteritems()):
1084
interface_names = set()
1085
# Go though all attributes of the class
1086
for attrname, attribute in inspect.getmembers(cls):
847
1087
# Ignore non-D-Bus attributes, and D-Bus attributes
848
1088
# with the wrong interface name
849
1089
if (not hasattr(attribute, "_dbus_interface")
850
1090
or not attribute._dbus_interface
851
.startswith("se.recompile.Mandos")):
1091
.startswith(orig_interface_name)):
853
1093
# Create an alternate D-Bus interface name based on
854
1094
# the current name
855
1095
alt_interface = (attribute._dbus_interface
856
.replace("se.recompile.Mandos",
857
"se.bsnet.fukt.Mandos"))
1096
.replace(orig_interface_name,
1097
alt_interface_name))
1098
interface_names.add(alt_interface)
858
1099
# Is this a D-Bus signal?
859
1100
if getattr(attribute, "_dbus_is_signal", False):
860
# Extract the original non-method function by
1101
# Extract the original non-method undecorated
1102
# function by black magic
862
1103
nonmethod_func = (dict(
863
1104
zip(attribute.func_code.co_freevars,
864
1105
attribute.__closure__))["func"]
927
1180
attribute.func_name,
928
1181
attribute.func_defaults,
929
1182
attribute.func_closure)))
930
return type.__new__(mcs, name, bases, attr)
1183
# Copy annotations, if any
1185
attr[attrname]._dbus_annotations = (
1186
dict(attribute._dbus_annotations))
1187
except AttributeError:
1189
# Is this a D-Bus interface?
1190
elif getattr(attribute, "_dbus_is_interface", False):
1191
# Create a new, but exactly alike, function
1192
# object. Decorate it to be a new D-Bus interface
1193
# with the alternate D-Bus interface name. Add it
1195
attr[attrname] = (dbus_interface_annotations
1198
(attribute.func_code,
1199
attribute.func_globals,
1200
attribute.func_name,
1201
attribute.func_defaults,
1202
attribute.func_closure)))
1204
# Deprecate all alternate interfaces
1205
iname="_AlternateDBusNames_interface_annotation{0}"
1206
for interface_name in interface_names:
1207
@dbus_interface_annotations(interface_name)
1209
return { "org.freedesktop.DBus.Deprecated":
1211
# Find an unused name
1212
for aname in (iname.format(i)
1213
for i in itertools.count()):
1214
if aname not in attr:
1218
# Replace the class with a new subclass of it with
1219
# methods, signals, etc. as created above.
1220
cls = type(b"{0}Alternate".format(cls.__name__),
1226
@alternate_dbus_interfaces({"se.recompile.Mandos":
1227
"se.bsnet.fukt.Mandos"})
932
1228
class ClientDBus(Client, DBusObjectWithProperties):
933
1229
"""A Client class using D-Bus
998
1291
checker is not None)
999
1292
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1000
1293
"LastCheckedOK")
1294
last_checker_status = notifychangeproperty(dbus.Int16,
1295
"LastCheckerStatus")
1001
1296
last_approval_request = notifychangeproperty(
1002
1297
datetime_to_dbus, "LastApprovalRequest")
1003
1298
approved_by_default = notifychangeproperty(dbus.Boolean,
1004
1299
"ApprovedByDefault")
1005
approval_delay = notifychangeproperty(dbus.UInt16,
1300
approval_delay = notifychangeproperty(dbus.UInt64,
1006
1301
"ApprovalDelay",
1008
_timedelta_to_milliseconds)
1303
timedelta_to_milliseconds)
1009
1304
approval_duration = notifychangeproperty(
1010
dbus.UInt16, "ApprovalDuration",
1011
type_func = _timedelta_to_milliseconds)
1305
dbus.UInt64, "ApprovalDuration",
1306
type_func = timedelta_to_milliseconds)
1012
1307
host = notifychangeproperty(dbus.String, "Host")
1013
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1308
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1015
_timedelta_to_milliseconds)
1310
timedelta_to_milliseconds)
1016
1311
extended_timeout = notifychangeproperty(
1017
dbus.UInt16, "ExtendedTimeout",
1018
type_func = _timedelta_to_milliseconds)
1019
interval = notifychangeproperty(dbus.UInt16,
1312
dbus.UInt64, "ExtendedTimeout",
1313
type_func = timedelta_to_milliseconds)
1314
interval = notifychangeproperty(dbus.UInt64,
1022
_timedelta_to_milliseconds)
1317
timedelta_to_milliseconds)
1023
1318
checker_command = notifychangeproperty(dbus.String, "Checker")
1025
1320
del notifychangeproperty
1636
1929
use_ipv6: Boolean; to use IPv6 or not
1638
1931
def __init__(self, server_address, RequestHandlerClass,
1639
interface=None, use_ipv6=True):
1932
interface=None, use_ipv6=True, socketfd=None):
1933
"""If socketfd is set, use that file descriptor instead of
1934
creating a new one with socket.socket().
1640
1936
self.interface = interface
1642
1938
self.address_family = socket.AF_INET6
1939
if socketfd is not None:
1940
# Save the file descriptor
1941
self.socketfd = socketfd
1942
# Save the original socket.socket() function
1943
self.socket_socket = socket.socket
1944
# To implement --socket, we monkey patch socket.socket.
1946
# (When socketserver.TCPServer is a new-style class, we
1947
# could make self.socket into a property instead of monkey
1948
# patching socket.socket.)
1950
# Create a one-time-only replacement for socket.socket()
1951
@functools.wraps(socket.socket)
1952
def socket_wrapper(*args, **kwargs):
1953
# Restore original function so subsequent calls are
1955
socket.socket = self.socket_socket
1956
del self.socket_socket
1957
# This time only, return a new socket object from the
1958
# saved file descriptor.
1959
return socket.fromfd(self.socketfd, *args, **kwargs)
1960
# Replace socket.socket() function with wrapper
1961
socket.socket = socket_wrapper
1962
# The socketserver.TCPServer.__init__ will call
1963
# socket.socket(), which might be our replacement,
1964
# socket_wrapper(), if socketfd was set.
1643
1965
socketserver.TCPServer.__init__(self, server_address,
1644
1966
RequestHandlerClass)
1645
1968
def server_bind(self):
1646
1969
"""This overrides the normal server_bind() function
1647
1970
to bind to an interface if one was specified, and also NOT to
2123
def rfc3339_duration_to_delta(duration):
2124
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2126
>>> rfc3339_duration_to_delta("P7D")
2127
datetime.timedelta(7)
2128
>>> rfc3339_duration_to_delta("PT60S")
2129
datetime.timedelta(0, 60)
2130
>>> rfc3339_duration_to_delta("PT60M")
2131
datetime.timedelta(0, 3600)
2132
>>> rfc3339_duration_to_delta("PT24H")
2133
datetime.timedelta(1)
2134
>>> rfc3339_duration_to_delta("P1W")
2135
datetime.timedelta(7)
2136
>>> rfc3339_duration_to_delta("PT5M30S")
2137
datetime.timedelta(0, 330)
2138
>>> rfc3339_duration_to_delta("P1DT3M20S")
2139
datetime.timedelta(1, 200)
2142
# Parsing an RFC 3339 duration with regular expressions is not
2143
# possible - there would have to be multiple places for the same
2144
# values, like seconds. The current code, while more esoteric, is
2145
# cleaner without depending on a parsing library. If Python had a
2146
# built-in library for parsing we would use it, but we'd like to
2147
# avoid excessive use of external libraries.
2149
# New type for defining tokens, syntax, and semantics all-in-one
2150
Token = collections.namedtuple("Token",
2151
("regexp", # To match token; if
2152
# "value" is not None,
2153
# must have a "group"
2155
"value", # datetime.timedelta or
2157
"followers")) # Tokens valid after
2159
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2160
# the "duration" ABNF definition in RFC 3339, Appendix A.
2161
token_end = Token(re.compile(r"$"), None, frozenset())
2162
token_second = Token(re.compile(r"(\d+)S"),
2163
datetime.timedelta(seconds=1),
2164
frozenset((token_end,)))
2165
token_minute = Token(re.compile(r"(\d+)M"),
2166
datetime.timedelta(minutes=1),
2167
frozenset((token_second, token_end)))
2168
token_hour = Token(re.compile(r"(\d+)H"),
2169
datetime.timedelta(hours=1),
2170
frozenset((token_minute, token_end)))
2171
token_time = Token(re.compile(r"T"),
2173
frozenset((token_hour, token_minute,
2175
token_day = Token(re.compile(r"(\d+)D"),
2176
datetime.timedelta(days=1),
2177
frozenset((token_time, token_end)))
2178
token_month = Token(re.compile(r"(\d+)M"),
2179
datetime.timedelta(weeks=4),
2180
frozenset((token_day, token_end)))
2181
token_year = Token(re.compile(r"(\d+)Y"),
2182
datetime.timedelta(weeks=52),
2183
frozenset((token_month, token_end)))
2184
token_week = Token(re.compile(r"(\d+)W"),
2185
datetime.timedelta(weeks=1),
2186
frozenset((token_end,)))
2187
token_duration = Token(re.compile(r"P"), None,
2188
frozenset((token_year, token_month,
2189
token_day, token_time,
2191
# Define starting values
2192
value = datetime.timedelta() # Value so far
2194
followers = frozenset(token_duration,) # Following valid tokens
2195
s = duration # String left to parse
2196
# Loop until end token is found
2197
while found_token is not token_end:
2198
# Search for any currently valid tokens
2199
for token in followers:
2200
match = token.regexp.match(s)
2201
if match is not None:
2203
if token.value is not None:
2204
# Value found, parse digits
2205
factor = int(match.group(1), 10)
2206
# Add to value so far
2207
value += factor * token.value
2208
# Strip token from string
2209
s = token.regexp.sub("", s, 1)
2212
# Set valid next tokens
2213
followers = found_token.followers
2216
# No currently valid tokens were found
2217
raise ValueError("Invalid RFC 3339 duration")
1812
2222
def string_to_delta(interval):
1813
2223
"""Parse a string and return a datetime.timedelta
1964
2369
# Convert the SafeConfigParser object to a dict
1965
2370
server_settings = server_config.defaults()
1966
2371
# Use the appropriate methods on the non-string config options
1967
for option in ("debug", "use_dbus", "use_ipv6"):
2372
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1968
2373
server_settings[option] = server_config.getboolean("DEFAULT",
1970
2375
if server_settings["port"]:
1971
2376
server_settings["port"] = server_config.getint("DEFAULT",
2378
if server_settings["socket"]:
2379
server_settings["socket"] = server_config.getint("DEFAULT",
2381
# Later, stdin will, and stdout and stderr might, be dup'ed
2382
# over with an opened os.devnull. But we don't want this to
2383
# happen with a supplied network socket.
2384
if 0 <= server_settings["socket"] <= 2:
2385
server_settings["socket"] = os.dup(server_settings
1973
2387
del server_config
1975
2389
# Override the settings from the config file with command line
1976
2390
# options, if set.
1977
2391
for option in ("interface", "address", "port", "debug",
1978
2392
"priority", "servicename", "configdir",
1979
"use_dbus", "use_ipv6", "debuglevel", "restore"):
2393
"use_dbus", "use_ipv6", "debuglevel", "restore",
2394
"statedir", "socket", "foreground"):
1980
2395
value = getattr(options, option)
1981
2396
if value is not None:
1982
2397
server_settings[option] = value
2122
2546
client_class = Client
2124
client_class = functools.partial(ClientDBusTransitional,
2127
special_settings = {
2128
# Some settings need to be accessd by special methods;
2129
# booleans need .getboolean(), etc. Here is a list of them:
2130
"approved_by_default":
2132
client_config.getboolean(section, "approved_by_default"),
2134
# Construct a new dict of client settings of this form:
2135
# { client_name: {setting_name: value, ...}, ...}
2136
# with exceptions for any special settings as defined above
2137
client_settings = dict((clientname,
2139
(value if setting not in special_settings
2140
else special_settings[setting](clientname)))
2141
for setting, value in client_config.items(clientname)))
2142
for clientname in client_config.sections())
2548
client_class = functools.partial(ClientDBus, bus = bus)
2550
client_settings = Client.config_parser(client_config)
2144
2551
old_client_settings = {}
2147
# Get client data and settings from last running state.
2554
# This is used to redirect stdout and stderr for checker processes
2556
wnull = open(os.devnull, "w") # A writable /dev/null
2557
# Only used if server is running in foreground but not in debug
2559
if debug or not foreground:
2562
# Get client data and settings from last running state.
2148
2563
if server_settings["restore"]:
2150
2565
with open(stored_state_path, "rb") as stored_state:
2151
clients_data, old_client_settings = pickle.load(stored_state)
2566
clients_data, old_client_settings = (pickle.load
2152
2568
os.remove(stored_state_path)
2153
2569
except IOError as e:
2154
logger.warning("Could not load persistant state: {0}".format(e))
2155
if e.errno != errno.ENOENT:
2570
if e.errno == errno.ENOENT:
2571
logger.warning("Could not load persistent state: {0}"
2572
.format(os.strerror(e.errno)))
2574
logger.critical("Could not load persistent state:",
2158
for client in clients_data:
2159
client_name = client["name"]
2161
# Decide which value to use after restoring saved state.
2162
# We have three different values: Old config file,
2163
# new config file, and saved state.
2164
# New config value takes precedence if it differs from old
2165
# config value, otherwise use saved state.
2166
for name, value in client_settings[client_name].items():
2577
except EOFError as e:
2578
logger.warning("Could not load persistent state: "
2579
"EOFError:", exc_info=e)
2581
with PGPEngine() as pgp:
2582
for client_name, client in clients_data.iteritems():
2583
# Skip removed clients
2584
if client_name not in client_settings:
2587
# Decide which value to use after restoring saved state.
2588
# We have three different values: Old config file,
2589
# new config file, and saved state.
2590
# New config value takes precedence if it differs from old
2591
# config value, otherwise use saved state.
2592
for name, value in client_settings[client_name].items():
2594
# For each value in new config, check if it
2595
# differs from the old config value (Except for
2596
# the "secret" attribute)
2597
if (name != "secret" and
2598
value != old_client_settings[client_name]
2600
client[name] = value
2604
# Clients who has passed its expire date can still be
2605
# enabled if its last checker was successful. Clients
2606
# whose checker succeeded before we stored its state is
2607
# assumed to have successfully run all checkers during
2609
if client["enabled"]:
2610
if datetime.datetime.utcnow() >= client["expires"]:
2611
if not client["last_checked_ok"]:
2613
"disabling client {0} - Client never "
2614
"performed a successful checker"
2615
.format(client_name))
2616
client["enabled"] = False
2617
elif client["last_checker_status"] != 0:
2619
"disabling client {0} - Client "
2620
"last checker failed with error code {1}"
2621
.format(client_name,
2622
client["last_checker_status"]))
2623
client["enabled"] = False
2625
client["expires"] = (datetime.datetime
2627
+ client["timeout"])
2628
logger.debug("Last checker succeeded,"
2629
" keeping {0} enabled"
2630
.format(client_name))
2168
# For each value in new config, check if it differs
2169
# from the old config value (Except for the "secret"
2171
if name != "secret" and value != old_client_settings[client_name][name]:
2172
setattr(client, name, value)
2176
# Clients who has passed its expire date, can still be enabled if its
2177
# last checker was sucessful. Clients who checkers failed before we
2178
# stored it state is asumed to had failed checker during downtime.
2179
if client["enabled"] and client["last_checked_ok"]:
2180
if ((datetime.datetime.utcnow() - client["last_checked_ok"])
2181
> client["interval"]):
2182
if client["last_checker_status"] != 0:
2183
client["enabled"] = False
2185
client["expires"] = datetime.datetime.utcnow() + client["timeout"]
2187
client["changedstate"] = (multiprocessing_manager
2188
.Condition(multiprocessing_manager
2191
new_client = ClientDBusTransitional.__new__(ClientDBusTransitional)
2192
tcp_server.clients[client_name] = new_client
2193
new_client.bus = bus
2194
for name, value in client.iteritems():
2195
setattr(new_client, name, value)
2196
client_object_name = unicode(client_name).translate(
2197
{ord("."): ord("_"),
2198
ord("-"): ord("_")})
2199
new_client.dbus_object_path = (dbus.ObjectPath
2200
("/clients/" + client_object_name))
2201
DBusObjectWithProperties.__init__(new_client,
2203
new_client.dbus_object_path)
2205
tcp_server.clients[client_name] = Client.__new__(Client)
2206
for name, value in client.iteritems():
2207
setattr(tcp_server.clients[client_name], name, value)
2209
tcp_server.clients[client_name].decrypt_secret(
2210
client_settings[client_name]["secret"])
2212
# Create/remove clients based on new changes made to config
2213
for clientname in set(old_client_settings) - set(client_settings):
2214
del tcp_server.clients[clientname]
2215
for clientname in set(client_settings) - set(old_client_settings):
2216
tcp_server.clients[clientname] = (client_class(name = clientname,
2632
client["secret"] = (
2633
pgp.decrypt(client["encrypted_secret"],
2634
client_settings[client_name]
2637
# If decryption fails, we use secret from new settings
2638
logger.debug("Failed to decrypt {0} old secret"
2639
.format(client_name))
2640
client["secret"] = (
2641
client_settings[client_name]["secret"])
2643
# Add/remove clients based on new changes made to config
2644
for client_name in (set(old_client_settings)
2645
- set(client_settings)):
2646
del clients_data[client_name]
2647
for client_name in (set(client_settings)
2648
- set(old_client_settings)):
2649
clients_data[client_name] = client_settings[client_name]
2651
# Create all client objects
2652
for client_name, client in clients_data.iteritems():
2653
tcp_server.clients[client_name] = client_class(
2654
name = client_name, settings = client,
2655
server_settings = server_settings)
2222
2657
if not tcp_server.clients:
2223
2658
logger.warning("No clients defined")
2229
pidfile.write(str(pid) + "\n".encode("utf-8"))
2232
logger.error("Could not write to file %r with PID %d",
2235
# "pidfile" was never created
2661
if pidfile is not None:
2665
pidfile.write(str(pid) + "\n".encode("utf-8"))
2667
logger.error("Could not write to file %r with PID %d",
2237
2670
del pidfilename
2239
signal.signal(signal.SIGINT, signal.SIG_IGN)
2241
2672
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2242
2673
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2245
class MandosDBusService(dbus.service.Object):
2676
@alternate_dbus_interfaces({"se.recompile.Mandos":
2677
"se.bsnet.fukt.Mandos"})
2678
class MandosDBusService(DBusObjectWithProperties):
2246
2679
"""A D-Bus proxy object"""
2247
2680
def __init__(self):
2248
2681
dbus.service.Object.__init__(self, bus, "/")
2249
2682
_interface = "se.recompile.Mandos"
2684
@dbus_interface_annotations(_interface)
2686
return { "org.freedesktop.DBus.Property"
2687
".EmitsChangedSignal":
2251
2690
@dbus.service.signal(_interface, signature="o")
2252
2691
def ClientAdded(self, objpath):
2298
class MandosDBusServiceTransitional(MandosDBusService):
2299
__metaclass__ = AlternateDBusNamesMetaclass
2300
mandos_dbus_service = MandosDBusServiceTransitional()
2737
mandos_dbus_service = MandosDBusService()
2303
2740
"Cleanup function; run on exit"
2304
2741
service.cleanup()
2306
2743
multiprocessing.active_children()
2307
2745
if not (tcp_server.clients or client_settings):
2310
# Store client before exiting. Secrets are encrypted with key based
2311
# on what config file has. If config file is removed/edited, old
2312
# secret will thus be unrecovable.
2314
for client in tcp_server.clients.itervalues():
2315
client.encrypt_secret(client_settings[client.name]["secret"])
2319
# A list of attributes that will not be stored when shuting down.
2320
exclude = set(("bus", "changedstate", "secret"))
2321
for name, typ in inspect.getmembers(dbus.service.Object):
2324
client_dict["encrypted_secret"] = client.encrypted_secret
2325
for attr in client.client_structure:
2326
if attr not in exclude:
2327
client_dict[attr] = getattr(client, attr)
2329
clients.append(client_dict)
2330
del client_settings[client.name]["secret"]
2748
# Store client before exiting. Secrets are encrypted with key
2749
# based on what config file has. If config file is
2750
# removed/edited, old secret will thus be unrecovable.
2752
with PGPEngine() as pgp:
2753
for client in tcp_server.clients.itervalues():
2754
key = client_settings[client.name]["secret"]
2755
client.encrypted_secret = pgp.encrypt(client.secret,
2759
# A list of attributes that can not be pickled
2761
exclude = set(("bus", "changedstate", "secret",
2762
"checker", "server_settings"))
2763
for name, typ in (inspect.getmembers
2764
(dbus.service.Object)):
2767
client_dict["encrypted_secret"] = (client
2769
for attr in client.client_structure:
2770
if attr not in exclude:
2771
client_dict[attr] = getattr(client, attr)
2773
clients[client.name] = client_dict
2774
del client_settings[client.name]["secret"]
2333
with os.fdopen(os.open(stored_state_path, os.O_CREAT|os.O_WRONLY|os.O_TRUNC, 0600), "wb") as stored_state:
2777
with (tempfile.NamedTemporaryFile
2778
(mode='wb', suffix=".pickle", prefix='clients-',
2779
dir=os.path.dirname(stored_state_path),
2780
delete=False)) as stored_state:
2334
2781
pickle.dump((clients, client_settings), stored_state)
2335
except IOError as e:
2336
logger.warning("Could not save persistant state: {0}".format(e))
2337
if e.errno != errno.ENOENT:
2782
tempname=stored_state.name
2783
os.rename(tempname, stored_state_path)
2784
except (IOError, OSError) as e:
2790
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2791
logger.warning("Could not save persistent state: {0}"
2792
.format(os.strerror(e.errno)))
2794
logger.warning("Could not save persistent state:",
2340
2798
# Delete all clients, and settings from config
2341
2799
while tcp_server.clients:
2342
2800
name, client = tcp_server.clients.popitem()