88
84
except ImportError:
89
85
SO_BINDTODEVICE = None
92
stored_state_file = "clients.pickle"
94
90
logger = logging.getLogger()
91
stored_state_path = "/var/lib/mandos/clients.pickle"
95
93
syslogger = (logging.handlers.SysLogHandler
96
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
95
address = str("/dev/log")))
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
return b"mandos" + binascii.hexlify(password)
177
def encrypt(self, data, password):
178
passphrase = self.password_encode(password)
179
with tempfile.NamedTemporaryFile(dir=self.tempdir
181
passfile.write(passphrase)
183
proc = subprocess.Popen(['gpg', '--symmetric',
187
stdin = subprocess.PIPE,
188
stdout = subprocess.PIPE,
189
stderr = subprocess.PIPE)
190
ciphertext, err = proc.communicate(input = data)
191
if proc.returncode != 0:
195
def decrypt(self, data, password):
196
passphrase = self.password_encode(password)
197
with tempfile.NamedTemporaryFile(dir = self.tempdir
199
passfile.write(passphrase)
201
proc = subprocess.Popen(['gpg', '--decrypt',
205
stdin = subprocess.PIPE,
206
stdout = subprocess.PIPE,
207
stderr = subprocess.PIPE)
208
decrypted_plaintext, err = proc.communicate(input
210
if proc.returncode != 0:
212
return decrypted_plaintext
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)
215
109
class AvahiError(Exception):
427
310
interval: datetime.timedelta(); How often to start a new checker
428
311
last_approval_request: datetime.datetime(); (UTC) or None
429
312
last_checked_ok: datetime.datetime(); (UTC) or None
430
last_checker_status: integer between 0 and 255 reflecting exit
431
status of last checker. -1 reflects crashed
432
checker, -2 means no checker completed yet.
433
last_enabled: 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)
434
317
name: string; from the config file, used in log messages and
435
318
D-Bus identifiers
436
319
secret: bytestring; sent verbatim (over TLS) to client
437
320
timeout: datetime.timedelta(); How long from last_checked_ok
438
321
until this client is disabled
439
extended_timeout: extra long timeout when secret has been sent
322
extended_timeout: extra long timeout when password has been sent
440
323
runtime_expansions: Allowed attributes for runtime expansion.
441
324
expires: datetime.datetime(); time (UTC) when a client will be
442
325
disabled, or None
443
server_settings: The server_settings dict from main()
446
328
runtime_expansions = ("approval_delay", "approval_duration",
447
"created", "enabled", "expires",
448
"fingerprint", "host", "interval",
449
"last_approval_request", "last_checked_ok",
329
"created", "enabled", "fingerprint",
330
"host", "interval", "last_checked_ok",
450
331
"last_enabled", "name", "timeout")
451
client_defaults = { "timeout": "PT5M",
452
"extended_timeout": "PT15M",
454
"checker": "fping -q -- %%(host)s",
456
"approval_delay": "PT0S",
457
"approval_duration": "PT1S",
458
"approved_by_default": "True",
462
333
def timeout_milliseconds(self):
463
334
"Return the 'timeout' attribute in milliseconds"
464
return timedelta_to_milliseconds(self.timeout)
335
return _timedelta_to_milliseconds(self.timeout)
466
337
def extended_timeout_milliseconds(self):
467
338
"Return the 'extended_timeout' attribute in milliseconds"
468
return timedelta_to_milliseconds(self.extended_timeout)
339
return _timedelta_to_milliseconds(self.extended_timeout)
470
341
def interval_milliseconds(self):
471
342
"Return the 'interval' attribute in milliseconds"
472
return timedelta_to_milliseconds(self.interval)
343
return _timedelta_to_milliseconds(self.interval)
474
345
def approval_delay_milliseconds(self):
475
return timedelta_to_milliseconds(self.approval_delay)
478
def config_parser(config):
479
"""Construct a new dict of client settings of this form:
480
{ client_name: {setting_name: value, ...}, ...}
481
with exceptions for any special settings as defined above.
482
NOTE: Must be a pure function. Must return the same result
483
value given the same arguments.
486
for client_name in config.sections():
487
section = dict(config.items(client_name))
488
client = settings[client_name] = {}
490
client["host"] = section["host"]
491
# Reformat values from string types to Python types
492
client["approved_by_default"] = config.getboolean(
493
client_name, "approved_by_default")
494
client["enabled"] = config.getboolean(client_name,
497
client["fingerprint"] = (section["fingerprint"].upper()
499
if "secret" in section:
500
client["secret"] = section["secret"].decode("base64")
501
elif "secfile" in section:
502
with open(os.path.expanduser(os.path.expandvars
503
(section["secfile"])),
505
client["secret"] = secfile.read()
507
raise TypeError("No secret or secfile for section {0}"
509
client["timeout"] = string_to_delta(section["timeout"])
510
client["extended_timeout"] = string_to_delta(
511
section["extended_timeout"])
512
client["interval"] = string_to_delta(section["interval"])
513
client["approval_delay"] = string_to_delta(
514
section["approval_delay"])
515
client["approval_duration"] = string_to_delta(
516
section["approval_duration"])
517
client["checker_command"] = section["checker"]
518
client["last_approval_request"] = None
519
client["last_checked_ok"] = None
520
client["last_checker_status"] = -2
524
def __init__(self, settings, name = None, server_settings=None):
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'
526
if server_settings is None:
528
self.server_settings = server_settings
529
# adding all client settings
530
for setting, value in settings.iteritems():
531
setattr(self, setting, value)
534
if not hasattr(self, "last_enabled"):
535
self.last_enabled = datetime.datetime.utcnow()
536
if not hasattr(self, "expires"):
537
self.expires = (datetime.datetime.utcnow()
540
self.last_enabled = None
543
355
logger.debug("Creating client %r", self.name)
544
356
# Uppercase and remove spaces from fingerprint for later
545
357
# comparison purposes with return value from the fingerprint()
359
self.fingerprint = (config["fingerprint"].upper()
547
361
logger.debug(" Fingerprint: %s", self.fingerprint)
548
self.created = settings.get("created",
549
datetime.datetime.utcnow())
551
# attributes specific for this server instance
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"])
552
383
self.checker = None
553
384
self.checker_initiator_tag = None
554
385
self.disable_initiator_tag = None
386
self.expires = datetime.datetime.utcnow() + self.timeout
555
387
self.checker_callback_tag = None
388
self.checker_command = config["checker"]
556
389
self.current_checker_command = None
390
self._approved = None
391
self.approved_by_default = config.get("approved_by_default",
558
393
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"])
559
398
self.changedstate = (multiprocessing_manager
560
399
.Condition(multiprocessing_manager
562
self.client_structure = [attr for attr in
563
self.__dict__.iterkeys()
564
if not attr.startswith("_")]
401
self.client_structure = [attr for attr in self.__dict__.iterkeys() if not attr.startswith("_")]
565
402
self.client_structure.append("client_structure")
567
405
for name, t in inspect.getmembers(type(self),
406
lambda obj: isinstance(obj, property)):
571
407
if not name.startswith("_"):
572
408
self.client_structure.append(name)
581
417
if getattr(self, "enabled", False):
582
418
# Already enabled
420
self.send_changedstate()
584
421
self.expires = datetime.datetime.utcnow() + self.timeout
585
422
self.enabled = True
586
423
self.last_enabled = datetime.datetime.utcnow()
587
424
self.init_checker()
588
self.send_changedstate()
590
426
def disable(self, quiet=True):
591
427
"""Disable this client."""
592
428
if not getattr(self, "enabled", False):
431
self.send_changedstate()
595
433
logger.info("Disabling client %s", self.name)
596
if getattr(self, "disable_initiator_tag", None) is not None:
434
if getattr(self, "disable_initiator_tag", False):
597
435
gobject.source_remove(self.disable_initiator_tag)
598
436
self.disable_initiator_tag = None
599
437
self.expires = None
600
if getattr(self, "checker_initiator_tag", None) is not None:
438
if getattr(self, "checker_initiator_tag", False):
601
439
gobject.source_remove(self.checker_initiator_tag)
602
440
self.checker_initiator_tag = None
603
441
self.stop_checker()
604
442
self.enabled = False
606
self.send_changedstate()
607
443
# Do not run this again if called by a gobject.timeout_add
610
446
def __del__(self):
613
449
def init_checker(self):
614
450
# Schedule a new checker to be started an 'interval' from now,
615
451
# and every interval from then on.
616
if self.checker_initiator_tag is not None:
617
gobject.source_remove(self.checker_initiator_tag)
618
452
self.checker_initiator_tag = (gobject.timeout_add
619
453
(self.interval_milliseconds(),
620
454
self.start_checker))
621
455
# Schedule a disable() when 'timeout' has passed
622
if self.disable_initiator_tag is not None:
623
gobject.source_remove(self.disable_initiator_tag)
624
456
self.disable_initiator_tag = (gobject.timeout_add
625
457
(self.timeout_milliseconds(),
627
459
# Also start a new checker *right now*.
628
460
self.start_checker()
630
463
def checker_callback(self, pid, condition, command):
631
464
"""The checker has completed, so take appropriate actions."""
632
465
self.checker_callback_tag = None
633
466
self.checker = None
634
467
if os.WIFEXITED(condition):
635
self.last_checker_status = os.WEXITSTATUS(condition)
468
self.last_checker_status = os.WEXITSTATUS(condition)
636
469
if self.last_checker_status == 0:
637
470
logger.info("Checker for %(name)s succeeded",
715
554
# in normal mode, that is already done by daemon(),
716
555
# and in debug mode we don't want to. (Stdin is
717
556
# always replaced by /dev/null.)
718
# The exception is when not debugging but nevertheless
719
# running in the foreground; use the previously
722
if (not self.server_settings["debug"]
723
and self.server_settings["foreground"]):
724
popen_args.update({"stdout": wnull,
726
557
self.checker = subprocess.Popen(command,
730
except OSError as error:
731
logger.error("Failed to start subprocess",
734
self.checker_callback_tag = (gobject.child_watch_add
736
self.checker_callback,
738
# The checker may have completed before the gobject
739
# watch was added. Check for this.
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.
741
566
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
568
gobject.source_remove(self.checker_callback_tag)
569
self.checker_callback(pid, status, command)
742
570
except OSError as error:
743
if error.errno == errno.ECHILD:
744
# This should never happen
745
logger.error("Child process vanished",
750
gobject.source_remove(self.checker_callback_tag)
751
self.checker_callback(pid, status, command)
571
logger.error("Failed to start subprocess: %s",
752
573
# Re-run this periodically if run by gobject.timeout_add
762
583
logger.debug("Stopping checker for %(name)s", vars(self))
764
self.checker.terminate()
585
os.kill(self.checker.pid, signal.SIGTERM)
766
587
#if self.checker.poll() is None:
767
# self.checker.kill()
588
# os.kill(self.checker.pid, signal.SIGKILL)
768
589
except OSError as error:
769
590
if error.errno != errno.ESRCH: # No such process
771
592
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
774
641
def dbus_service_property(dbus_interface, signature="v",
775
642
access="readwrite", byte_arrays=False):
977
795
e.setAttribute("access", prop._dbus_access)
979
797
for if_tag in document.getElementsByTagName("interface"):
981
798
for tag in (make_tag(document, name, prop)
983
in self._get_all_dbus_things("property")
800
in self._get_all_dbus_properties()
984
801
if prop._dbus_interface
985
802
== if_tag.getAttribute("name")):
986
803
if_tag.appendChild(tag)
987
# Add annotation tags
988
for typ in ("method", "signal", "property"):
989
for tag in if_tag.getElementsByTagName(typ):
991
for name, prop in (self.
992
_get_all_dbus_things(typ)):
993
if (name == tag.getAttribute("name")
994
and prop._dbus_interface
995
== if_tag.getAttribute("name")):
996
annots.update(getattr
1000
for name, value in annots.iteritems():
1001
ann_tag = document.createElement(
1003
ann_tag.setAttribute("name", name)
1004
ann_tag.setAttribute("value", value)
1005
tag.appendChild(ann_tag)
1006
# Add interface annotation tags
1007
for annotation, value in dict(
1008
itertools.chain.from_iterable(
1009
annotations().iteritems()
1010
for name, annotations in
1011
self._get_all_dbus_things("interface")
1012
if name == if_tag.getAttribute("name")
1014
ann_tag = document.createElement("annotation")
1015
ann_tag.setAttribute("name", annotation)
1016
ann_tag.setAttribute("value", value)
1017
if_tag.appendChild(ann_tag)
1018
804
# Add the names to the return values for the
1019
805
# "org.freedesktop.DBus.Properties" methods
1020
806
if (if_tag.getAttribute("name")
1035
821
except (AttributeError, xml.dom.DOMException,
1036
822
xml.parsers.expat.ExpatError) as error:
1037
823
logger.error("Failed to override Introspection method",
1039
825
return xmlstring
1042
def datetime_to_dbus(dt, variant_level=0):
828
def datetime_to_dbus (dt, variant_level=0):
1043
829
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1045
831
return dbus.String("", variant_level = variant_level)
1046
832
return dbus.String(dt.isoformat(),
1047
833
variant_level=variant_level)
1050
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1051
"""A class decorator; applied to a subclass of
1052
dbus.service.Object, it will add alternate D-Bus attributes with
1053
interface names according to the "alt_interface_names" mapping.
1056
@alternate_dbus_interfaces({"org.example.Interface":
1057
"net.example.AlternateInterface"})
1058
class SampleDBusObject(dbus.service.Object):
1059
@dbus.service.method("org.example.Interface")
1060
def SampleDBusMethod():
1063
The above "SampleDBusMethod" on "SampleDBusObject" will be
1064
reachable via two interfaces: "org.example.Interface" and
1065
"net.example.AlternateInterface", the latter of which will have
1066
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1067
"true", unless "deprecate" is passed with a False value.
1069
This works for methods and signals, and also for D-Bus properties
1070
(from DBusObjectWithProperties) and interfaces (from the
1071
dbus_interface_annotations decorator).
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.
1074
for orig_interface_name, alt_interface_name in (
1075
alt_interface_names.iteritems()):
1077
interface_names = set()
1078
# Go though all attributes of the class
1079
for attrname, attribute in inspect.getmembers(cls):
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):
1080
847
# Ignore non-D-Bus attributes, and D-Bus attributes
1081
848
# with the wrong interface name
1082
849
if (not hasattr(attribute, "_dbus_interface")
1083
850
or not attribute._dbus_interface
1084
.startswith(orig_interface_name)):
851
.startswith("se.recompile.Mandos")):
1086
853
# Create an alternate D-Bus interface name based on
1087
854
# the current name
1088
855
alt_interface = (attribute._dbus_interface
1089
.replace(orig_interface_name,
1090
alt_interface_name))
1091
interface_names.add(alt_interface)
856
.replace("se.recompile.Mandos",
857
"se.bsnet.fukt.Mandos"))
1092
858
# Is this a D-Bus signal?
1093
859
if getattr(attribute, "_dbus_is_signal", False):
1094
# Extract the original non-method undecorated
1095
# function by black magic
860
# Extract the original non-method function by
1096
862
nonmethod_func = (dict(
1097
863
zip(attribute.func_code.co_freevars,
1098
864
attribute.__closure__))["func"]
1173
927
attribute.func_name,
1174
928
attribute.func_defaults,
1175
929
attribute.func_closure)))
1176
# Copy annotations, if any
1178
attr[attrname]._dbus_annotations = (
1179
dict(attribute._dbus_annotations))
1180
except AttributeError:
1182
# Is this a D-Bus interface?
1183
elif getattr(attribute, "_dbus_is_interface", False):
1184
# Create a new, but exactly alike, function
1185
# object. Decorate it to be a new D-Bus interface
1186
# with the alternate D-Bus interface name. Add it
1188
attr[attrname] = (dbus_interface_annotations
1191
(attribute.func_code,
1192
attribute.func_globals,
1193
attribute.func_name,
1194
attribute.func_defaults,
1195
attribute.func_closure)))
1197
# Deprecate all alternate interfaces
1198
iname="_AlternateDBusNames_interface_annotation{0}"
1199
for interface_name in interface_names:
1200
@dbus_interface_annotations(interface_name)
1202
return { "org.freedesktop.DBus.Deprecated":
1204
# Find an unused name
1205
for aname in (iname.format(i)
1206
for i in itertools.count()):
1207
if aname not in attr:
1211
# Replace the class with a new subclass of it with
1212
# methods, signals, etc. as created above.
1213
cls = type(b"{0}Alternate".format(cls.__name__),
1219
@alternate_dbus_interfaces({"se.recompile.Mandos":
1220
"se.bsnet.fukt.Mandos"})
930
return type.__new__(mcs, name, bases, attr)
1221
932
class ClientDBus(Client, DBusObjectWithProperties):
1222
933
"""A Client class using D-Bus
1284
998
checker is not None)
1285
999
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1286
1000
"LastCheckedOK")
1287
last_checker_status = notifychangeproperty(dbus.Int16,
1288
"LastCheckerStatus")
1289
1001
last_approval_request = notifychangeproperty(
1290
1002
datetime_to_dbus, "LastApprovalRequest")
1291
1003
approved_by_default = notifychangeproperty(dbus.Boolean,
1292
1004
"ApprovedByDefault")
1293
approval_delay = notifychangeproperty(dbus.UInt64,
1005
approval_delay = notifychangeproperty(dbus.UInt16,
1294
1006
"ApprovalDelay",
1296
timedelta_to_milliseconds)
1008
_timedelta_to_milliseconds)
1297
1009
approval_duration = notifychangeproperty(
1298
dbus.UInt64, "ApprovalDuration",
1299
type_func = timedelta_to_milliseconds)
1010
dbus.UInt16, "ApprovalDuration",
1011
type_func = _timedelta_to_milliseconds)
1300
1012
host = notifychangeproperty(dbus.String, "Host")
1301
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1013
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1303
timedelta_to_milliseconds)
1015
_timedelta_to_milliseconds)
1304
1016
extended_timeout = notifychangeproperty(
1305
dbus.UInt64, "ExtendedTimeout",
1306
type_func = timedelta_to_milliseconds)
1307
interval = notifychangeproperty(dbus.UInt64,
1017
dbus.UInt16, "ExtendedTimeout",
1018
type_func = _timedelta_to_milliseconds)
1019
interval = notifychangeproperty(dbus.UInt16,
1310
timedelta_to_milliseconds)
1022
_timedelta_to_milliseconds)
1311
1023
checker_command = notifychangeproperty(dbus.String, "Checker")
1313
1025
del notifychangeproperty
1922
1636
use_ipv6: Boolean; to use IPv6 or not
1924
1638
def __init__(self, server_address, RequestHandlerClass,
1925
interface=None, use_ipv6=True, socketfd=None):
1926
"""If socketfd is set, use that file descriptor instead of
1927
creating a new one with socket.socket().
1639
interface=None, use_ipv6=True):
1929
1640
self.interface = interface
1931
1642
self.address_family = socket.AF_INET6
1932
if socketfd is not None:
1933
# Save the file descriptor
1934
self.socketfd = socketfd
1935
# Save the original socket.socket() function
1936
self.socket_socket = socket.socket
1937
# To implement --socket, we monkey patch socket.socket.
1939
# (When socketserver.TCPServer is a new-style class, we
1940
# could make self.socket into a property instead of monkey
1941
# patching socket.socket.)
1943
# Create a one-time-only replacement for socket.socket()
1944
@functools.wraps(socket.socket)
1945
def socket_wrapper(*args, **kwargs):
1946
# Restore original function so subsequent calls are
1948
socket.socket = self.socket_socket
1949
del self.socket_socket
1950
# This time only, return a new socket object from the
1951
# saved file descriptor.
1952
return socket.fromfd(self.socketfd, *args, **kwargs)
1953
# Replace socket.socket() function with wrapper
1954
socket.socket = socket_wrapper
1955
# The socketserver.TCPServer.__init__ will call
1956
# socket.socket(), which might be our replacement,
1957
# socket_wrapper(), if socketfd was set.
1958
1643
socketserver.TCPServer.__init__(self, server_address,
1959
1644
RequestHandlerClass)
1961
1645
def server_bind(self):
1962
1646
"""This overrides the normal server_bind() function
1963
1647
to bind to an interface if one was specified, and also NOT to
2116
def rfc3339_duration_to_delta(duration):
2117
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2119
>>> rfc3339_duration_to_delta("P7D")
2120
datetime.timedelta(7)
2121
>>> rfc3339_duration_to_delta("PT60S")
2122
datetime.timedelta(0, 60)
2123
>>> rfc3339_duration_to_delta("PT60M")
2124
datetime.timedelta(0, 3600)
2125
>>> rfc3339_duration_to_delta("PT24H")
2126
datetime.timedelta(1)
2127
>>> rfc3339_duration_to_delta("P1W")
2128
datetime.timedelta(7)
2129
>>> rfc3339_duration_to_delta("PT5M30S")
2130
datetime.timedelta(0, 330)
2131
>>> rfc3339_duration_to_delta("P1DT3M20S")
2132
datetime.timedelta(1, 200)
2135
# Parsing an RFC 3339 duration with regular expressions is not
2136
# possible - there would have to be multiple places for the same
2137
# values, like seconds. The current code, while more esoteric, is
2138
# cleaner without depending on a parsing library. If Python had a
2139
# built-in library for parsing we would use it, but we'd like to
2140
# avoid excessive use of external libraries.
2142
# New type for defining tokens, syntax, and semantics all-in-one
2143
Token = collections.namedtuple("Token",
2144
("regexp", # To match token; if
2145
# "value" is not None,
2146
# must have a "group"
2148
"value", # datetime.timedelta or
2150
"followers")) # Tokens valid after
2152
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2153
# the "duration" ABNF definition in RFC 3339, Appendix A.
2154
token_end = Token(re.compile(r"$"), None, frozenset())
2155
token_second = Token(re.compile(r"(\d+)S"),
2156
datetime.timedelta(seconds=1),
2157
frozenset((token_end,)))
2158
token_minute = Token(re.compile(r"(\d+)M"),
2159
datetime.timedelta(minutes=1),
2160
frozenset((token_second, token_end)))
2161
token_hour = Token(re.compile(r"(\d+)H"),
2162
datetime.timedelta(hours=1),
2163
frozenset((token_minute, token_end)))
2164
token_time = Token(re.compile(r"T"),
2166
frozenset((token_hour, token_minute,
2168
token_day = Token(re.compile(r"(\d+)D"),
2169
datetime.timedelta(days=1),
2170
frozenset((token_time, token_end)))
2171
token_month = Token(re.compile(r"(\d+)M"),
2172
datetime.timedelta(weeks=4),
2173
frozenset((token_day, token_end)))
2174
token_year = Token(re.compile(r"(\d+)Y"),
2175
datetime.timedelta(weeks=52),
2176
frozenset((token_month, token_end)))
2177
token_week = Token(re.compile(r"(\d+)W"),
2178
datetime.timedelta(weeks=1),
2179
frozenset((token_end,)))
2180
token_duration = Token(re.compile(r"P"), None,
2181
frozenset((token_year, token_month,
2182
token_day, token_time,
2184
# Define starting values
2185
value = datetime.timedelta() # Value so far
2187
followers = frozenset(token_duration,) # Following valid tokens
2188
s = duration # String left to parse
2189
# Loop until end token is found
2190
while found_token is not token_end:
2191
# Search for any currently valid tokens
2192
for token in followers:
2193
match = token.regexp.match(s)
2194
if match is not None:
2196
if token.value is not None:
2197
# Value found, parse digits
2198
factor = int(match.group(1), 10)
2199
# Add to value so far
2200
value += factor * token.value
2201
# Strip token from string
2202
s = token.regexp.sub("", s, 1)
2205
# Set valid next tokens
2206
followers = found_token.followers
2209
# No currently valid tokens were found
2210
raise ValueError("Invalid RFC 3339 duration")
2215
1812
def string_to_delta(interval):
2216
1813
"""Parse a string and return a datetime.timedelta
2362
1964
# Convert the SafeConfigParser object to a dict
2363
1965
server_settings = server_config.defaults()
2364
1966
# Use the appropriate methods on the non-string config options
2365
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1967
for option in ("debug", "use_dbus", "use_ipv6"):
2366
1968
server_settings[option] = server_config.getboolean("DEFAULT",
2368
1970
if server_settings["port"]:
2369
1971
server_settings["port"] = server_config.getint("DEFAULT",
2371
if server_settings["socket"]:
2372
server_settings["socket"] = server_config.getint("DEFAULT",
2374
# Later, stdin will, and stdout and stderr might, be dup'ed
2375
# over with an opened os.devnull. But we don't want this to
2376
# happen with a supplied network socket.
2377
if 0 <= server_settings["socket"] <= 2:
2378
server_settings["socket"] = os.dup(server_settings
2380
1973
del server_config
2382
1975
# Override the settings from the config file with command line
2383
1976
# options, if set.
2384
1977
for option in ("interface", "address", "port", "debug",
2385
1978
"priority", "servicename", "configdir",
2386
"use_dbus", "use_ipv6", "debuglevel", "restore",
2387
"statedir", "socket", "foreground"):
1979
"use_dbus", "use_ipv6", "debuglevel", "restore"):
2388
1980
value = getattr(options, option)
2389
1981
if value is not None:
2390
1982
server_settings[option] = value
2537
2122
client_class = Client
2539
client_class = functools.partial(ClientDBus, bus = bus)
2541
client_settings = Client.config_parser(client_config)
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())
2542
2144
old_client_settings = {}
2545
# This is used to redirect stdout and stderr for checker processes
2547
wnull = open(os.devnull, "w") # A writable /dev/null
2548
# Only used if server is running in foreground but not in debug
2550
if debug or not foreground:
2553
# Get client data and settings from last running state.
2147
# Get client data and settings from last running state.
2554
2148
if server_settings["restore"]:
2556
2150
with open(stored_state_path, "rb") as stored_state:
2557
clients_data, old_client_settings = (pickle.load
2151
clients_data, old_client_settings = pickle.load(stored_state)
2559
2152
os.remove(stored_state_path)
2560
2153
except IOError as e:
2561
if e.errno == errno.ENOENT:
2562
logger.warning("Could not load persistent state: {0}"
2563
.format(os.strerror(e.errno)))
2565
logger.critical("Could not load persistent state:",
2154
logger.warning("Could not load persistant state: {0}".format(e))
2155
if e.errno != errno.ENOENT:
2568
except EOFError as e:
2569
logger.warning("Could not load persistent state: "
2570
"EOFError:", exc_info=e)
2572
with PGPEngine() as pgp:
2573
for client_name, client in clients_data.iteritems():
2574
# Skip removed clients
2575
if client_name not in client_settings:
2578
# Decide which value to use after restoring saved state.
2579
# We have three different values: Old config file,
2580
# new config file, and saved state.
2581
# New config value takes precedence if it differs from old
2582
# config value, otherwise use saved state.
2583
for name, value in client_settings[client_name].items():
2585
# For each value in new config, check if it
2586
# differs from the old config value (Except for
2587
# the "secret" attribute)
2588
if (name != "secret" and
2589
value != old_client_settings[client_name]
2591
client[name] = value
2595
# Clients who has passed its expire date can still be
2596
# enabled if its last checker was successful. Clients
2597
# whose checker succeeded before we stored its state is
2598
# assumed to have successfully run all checkers during
2600
if client["enabled"]:
2601
if datetime.datetime.utcnow() >= client["expires"]:
2602
if not client["last_checked_ok"]:
2604
"disabling client {0} - Client never "
2605
"performed a successful checker"
2606
.format(client_name))
2607
client["enabled"] = False
2608
elif client["last_checker_status"] != 0:
2610
"disabling client {0} - Client "
2611
"last checker failed with error code {1}"
2612
.format(client_name,
2613
client["last_checker_status"]))
2614
client["enabled"] = False
2616
client["expires"] = (datetime.datetime
2618
+ client["timeout"])
2619
logger.debug("Last checker succeeded,"
2620
" keeping {0} enabled"
2621
.format(client_name))
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():
2623
client["secret"] = (
2624
pgp.decrypt(client["encrypted_secret"],
2625
client_settings[client_name]
2628
# If decryption fails, we use secret from new settings
2629
logger.debug("Failed to decrypt {0} old secret"
2630
.format(client_name))
2631
client["secret"] = (
2632
client_settings[client_name]["secret"])
2634
# Add/remove clients based on new changes made to config
2635
for client_name in (set(old_client_settings)
2636
- set(client_settings)):
2637
del clients_data[client_name]
2638
for client_name in (set(client_settings)
2639
- set(old_client_settings)):
2640
clients_data[client_name] = client_settings[client_name]
2642
# Create all client objects
2643
for client_name, client in clients_data.iteritems():
2644
tcp_server.clients[client_name] = client_class(
2645
name = client_name, settings = client,
2646
server_settings = server_settings)
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,
2648
2222
if not tcp_server.clients:
2649
2223
logger.warning("No clients defined")
2652
if pidfile is not None:
2656
pidfile.write(str(pid) + "\n".encode("utf-8"))
2658
logger.error("Could not write to file %r with PID %d",
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
2237
del pidfilename
2239
signal.signal(signal.SIGINT, signal.SIG_IGN)
2663
2241
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2664
2242
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2667
@alternate_dbus_interfaces({"se.recompile.Mandos":
2668
"se.bsnet.fukt.Mandos"})
2669
class MandosDBusService(DBusObjectWithProperties):
2245
class MandosDBusService(dbus.service.Object):
2670
2246
"""A D-Bus proxy object"""
2671
2247
def __init__(self):
2672
2248
dbus.service.Object.__init__(self, bus, "/")
2673
2249
_interface = "se.recompile.Mandos"
2675
@dbus_interface_annotations(_interface)
2677
return { "org.freedesktop.DBus.Property"
2678
".EmitsChangedSignal":
2681
2251
@dbus.service.signal(_interface, signature="o")
2682
2252
def ClientAdded(self, objpath):
2728
mandos_dbus_service = MandosDBusService()
2298
class MandosDBusServiceTransitional(MandosDBusService):
2299
__metaclass__ = AlternateDBusNamesMetaclass
2300
mandos_dbus_service = MandosDBusServiceTransitional()
2731
2303
"Cleanup function; run on exit"
2732
2304
service.cleanup()
2734
2306
multiprocessing.active_children()
2736
2307
if not (tcp_server.clients or client_settings):
2739
# Store client before exiting. Secrets are encrypted with key
2740
# based on what config file has. If config file is
2741
# removed/edited, old secret will thus be unrecovable.
2743
with PGPEngine() as pgp:
2744
for client in tcp_server.clients.itervalues():
2745
key = client_settings[client.name]["secret"]
2746
client.encrypted_secret = pgp.encrypt(client.secret,
2750
# A list of attributes that can not be pickled
2752
exclude = set(("bus", "changedstate", "secret",
2753
"checker", "server_settings"))
2754
for name, typ in (inspect.getmembers
2755
(dbus.service.Object)):
2758
client_dict["encrypted_secret"] = (client
2760
for attr in client.client_structure:
2761
if attr not in exclude:
2762
client_dict[attr] = getattr(client, attr)
2764
clients[client.name] = client_dict
2765
del client_settings[client.name]["secret"]
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"]
2768
with (tempfile.NamedTemporaryFile
2769
(mode='wb', suffix=".pickle", prefix='clients-',
2770
dir=os.path.dirname(stored_state_path),
2771
delete=False)) as stored_state:
2333
with os.fdopen(os.open(stored_state_path, os.O_CREAT|os.O_WRONLY|os.O_TRUNC, 0600), "wb") as stored_state:
2772
2334
pickle.dump((clients, client_settings), stored_state)
2773
tempname=stored_state.name
2774
os.rename(tempname, stored_state_path)
2775
except (IOError, OSError) as e:
2781
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2782
logger.warning("Could not save persistent state: {0}"
2783
.format(os.strerror(e.errno)))
2785
logger.warning("Could not save persistent state:",
2335
except IOError as e:
2336
logger.warning("Could not save persistant state: {0}".format(e))
2337
if e.errno != errno.ENOENT:
2789
2340
# Delete all clients, and settings from config
2790
2341
while tcp_server.clients:
2791
2342
name, client = tcp_server.clients.popitem()