101
85
except ImportError:
102
86
SO_BINDTODEVICE = None
104
if sys.version_info.major == 2:
108
90
stored_state_file = "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):
422
364
follow_name_owner_changes=True),
423
365
avahi.DBUS_INTERFACE_SERVER)
424
366
self.server.connect_to_signal("StateChanged",
425
self.server_state_changed)
367
self.server_state_changed)
426
368
self.server_state_changed(self.server.GetState())
429
370
class AvahiServiceToSyslog(AvahiService):
430
def rename(self, *args, **kwargs):
431
372
"""Add the new name to the syslog messages"""
432
ret = AvahiService.rename(self, *args, **kwargs)
433
syslogger.setFormatter(logging.Formatter(
434
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
373
ret = AvahiService.rename(self)
374
syslogger.setFormatter(logging.Formatter
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
438
def call_pipe(connection, # : multiprocessing.Connection
439
func, *args, **kwargs):
440
"""This function is meant to be called by multiprocessing.Process
442
This function runs func(*args, **kwargs), and writes the resulting
443
return value on the provided multiprocessing.Connection.
445
connection.send(func(*args, **kwargs))
380
def _timedelta_to_milliseconds(td):
381
"Convert a datetime.timedelta() to milliseconds"
382
return ((td.days * 24 * 60 * 60 * 1000)
383
+ (td.seconds * 1000)
384
+ (td.microseconds // 1000))
448
386
class Client(object):
449
387
"""A representation of a client host served by this server.
452
approved: bool(); 'None' if not yet approved/disapproved
390
_approved: bool(); 'None' if not yet approved/disapproved
453
391
approval_delay: datetime.timedelta(); Time to wait for approval
454
392
approval_duration: datetime.timedelta(); Duration of one approval
455
393
checker: subprocess.Popen(); a running checker process used
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
418
last_enabled: datetime.datetime(); (UTC) or None
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()
476
self.enabled = config.get("enabled", True)
477
self.last_approval_request = None
479
self.last_enabled = datetime.datetime.utcnow()
481
self.last_enabled = None
482
self.last_checked_ok = None
483
self.last_checker_status = None
484
self.timeout = string_to_delta(config["timeout"])
485
self.extended_timeout = string_to_delta(config
486
["extended_timeout"])
487
self.interval = string_to_delta(config["interval"])
586
488
self.checker = None
587
489
self.checker_initiator_tag = None
588
490
self.disable_initiator_tag = None
492
self.expires = datetime.datetime.utcnow() + self.timeout
589
495
self.checker_callback_tag = None
496
self.checker_command = config["checker"]
590
497
self.current_checker_command = None
498
self._approved = None
499
self.approved_by_default = config.get("approved_by_default",
592
501
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()
502
self.approval_delay = string_to_delta(
503
config["approval_delay"])
504
self.approval_duration = string_to_delta(
505
config["approval_duration"])
506
self.changedstate = (multiprocessing_manager
507
.Condition(multiprocessing_manager
509
self.client_structure = [attr for attr in
510
self.__dict__.iterkeys()
597
511
if not attr.startswith("_")]
598
512
self.client_structure.append("client_structure")
600
for name, t in inspect.getmembers(
601
type(self), lambda obj: isinstance(obj, property)):
514
for name, t in inspect.getmembers(type(self),
602
518
if not name.startswith("_"):
603
519
self.client_structure.append(name)
644
560
def init_checker(self):
645
561
# Schedule a new checker to be started an 'interval' from now,
646
562
# 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),
563
self.checker_initiator_tag = (gobject.timeout_add
564
(self.interval_milliseconds(),
652
566
# 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)
567
self.disable_initiator_tag = (gobject.timeout_add
568
(self.timeout_milliseconds(),
657
570
# Also start a new checker *right now*.
658
571
self.start_checker()
660
def checker_callback(self, source, condition, connection,
573
def checker_callback(self, pid, condition, command):
662
574
"""The checker has completed, so take appropriate actions."""
663
575
self.checker_callback_tag = None
664
576
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
577
if os.WIFEXITED(condition):
578
self.last_checker_status = os.WEXITSTATUS(condition)
672
579
if self.last_checker_status == 0:
673
580
logger.info("Checker for %(name)s succeeded",
675
582
self.checked_ok()
677
logger.info("Checker for %(name)s failed", vars(self))
584
logger.info("Checker for %(name)s failed",
679
587
self.last_checker_status = -1
680
self.last_checker_signal = -returncode
681
588
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."""
591
def checked_ok(self, timeout=None):
592
"""Bump up the timeout for this client.
594
This should only be called when the client has been seen,
694
597
if timeout is None:
695
598
timeout = self.timeout
599
self.last_checked_ok = datetime.datetime.utcnow()
696
600
if self.disable_initiator_tag is not None:
697
601
gobject.source_remove(self.disable_initiator_tag)
698
self.disable_initiator_tag = None
699
602
if getattr(self, "enabled", False):
700
self.disable_initiator_tag = gobject.timeout_add(
701
int(timeout.total_seconds() * 1000), self.disable)
603
self.disable_initiator_tag = (gobject.timeout_add
604
(_timedelta_to_milliseconds
605
(timeout), self.disable))
702
606
self.expires = datetime.datetime.utcnow() + timeout
704
608
def need_approval(self):
710
614
If a checker already exists, leave it running and do
712
616
# 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
617
# did that, then if a checker (for some reason) started
618
# running slowly and taking more than 'interval' time, the
619
# client would inevitably timeout, since no checker would get
620
# a chance to run to completion. If we instead leave running
717
621
# checkers alone, the checker would have to take more time
718
622
# 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")
625
# If a checker exists, make sure it is not a zombie
627
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
628
except (AttributeError, OSError) as error:
629
if (isinstance(error, OSError)
630
and error.errno != errno.ECHILD):
634
logger.warning("Checker was a zombie")
635
gobject.source_remove(self.checker_callback_tag)
636
self.checker_callback(pid, status,
637
self.current_checker_command)
725
638
# Start a new checker if needed
726
639
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
641
# In case checker_command has exactly one % operator
642
command = self.checker_command % self.host
644
# Escape attributes for the shell
645
escaped_attrs = dict(
647
re.escape(unicode(str(getattr(self, attr, "")),
651
self.runtime_expansions)
654
command = self.checker_command % escaped_attrs
655
except TypeError as error:
656
logger.error('Could not format string "%s":'
657
' %s', self.checker_command, error)
658
return True # Try again later
738
659
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)
661
logger.info("Starting checker %r for %s",
663
# We don't need to redirect stdout and stderr, since
664
# in normal mode, that is already done by daemon(),
665
# and in debug mode we don't want to. (Stdin is
666
# always replaced by /dev/null.)
667
self.checker = subprocess.Popen(command,
670
self.checker_callback_tag = (gobject.child_watch_add
672
self.checker_callback,
674
# The checker may have completed before the gobject
675
# watch was added. Check for this.
676
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
678
gobject.source_remove(self.checker_callback_tag)
679
self.checker_callback(pid, status, command)
680
except OSError as error:
681
logger.error("Failed to start subprocess: %s",
764
683
# 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):
754
class DBusObjectWithProperties(dbus.service.Object):
964
755
"""A D-Bus object with properties.
966
757
Classes inheriting from this can use the dbus_service_property
968
759
standard Get(), Set(), and GetAll() methods on the D-Bus.
763
def _is_dbus_property(obj):
764
return getattr(obj, "_dbus_is_property", False)
766
def _get_all_dbus_properties(self):
767
"""Returns a generator of (name, attribute) pairs
769
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
770
for cls in self.__class__.__mro__
772
inspect.getmembers(cls, self._is_dbus_property))
971
774
def _get_dbus_property(self, interface_name, property_name):
972
775
"""Returns a bound method if one exists which is a D-Bus
973
776
property with the specified name and interface.
975
for cls in self.__class__.__mro__:
976
for name, value in inspect.getmembers(
977
cls, self._is_dbus_thing("property")):
778
for cls in self.__class__.__mro__:
779
for name, value in (inspect.getmembers
780
(cls, self._is_dbus_property)):
978
781
if (value._dbus_name == property_name
979
782
and value._dbus_interface == interface_name):
980
783
return value.__get__(self)
982
785
# No such property
983
raise DBusPropertyNotFound("{}:{}.{}".format(
984
self.dbus_object_path, interface_name, property_name))
786
raise DBusPropertyNotFound(self.dbus_object_path + ":"
787
+ interface_name + "."
986
@dbus.service.method(dbus.PROPERTIES_IFACE,
790
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
988
791
out_signature="v")
989
792
def Get(self, interface_name, property_name):
990
793
"""Standard D-Bus property Get() method, see D-Bus standard.
1037
837
if not hasattr(value, "variant_level"):
1038
838
properties[name] = value
1040
properties[name] = type(value)(
1041
value, variant_level = value.variant_level + 1)
840
properties[name] = type(value)(value, variant_level=
841
value.variant_level+1)
1042
842
return dbus.Dictionary(properties, signature="sv")
1044
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1045
def PropertiesChanged(self, interface_name, changed_properties,
1046
invalidated_properties):
1047
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1052
844
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1053
845
out_signature="s",
1054
846
path_keyword='object_path',
1055
847
connection_keyword='connection')
1056
848
def Introspect(self, object_path, connection):
1057
"""Overloading of standard D-Bus method.
1059
Inserts property tags and interface annotation tags.
849
"""Standard D-Bus method, overloaded to insert property tags.
1061
xmlstring = DBusObjectWithAnnotations.Introspect(self,
851
xmlstring = dbus.service.Object.Introspect(self, object_path,
1065
854
document = xml.dom.minidom.parseString(xmlstring)
1067
855
def make_tag(document, name, prop):
1068
856
e = document.createElement("property")
1069
857
e.setAttribute("name", name)
1070
858
e.setAttribute("type", prop._dbus_signature)
1071
859
e.setAttribute("access", prop._dbus_access)
1074
861
for if_tag in document.getElementsByTagName("interface"):
1076
862
for tag in (make_tag(document, name, prop)
1078
in self._get_all_dbus_things("property")
864
in self._get_all_dbus_properties()
1079
865
if prop._dbus_interface
1080
866
== if_tag.getAttribute("name")):
1081
867
if_tag.appendChild(tag)
1082
# Add annotation tags for properties
1083
for tag in if_tag.getElementsByTagName("property"):
1085
for name, prop in self._get_all_dbus_things(
1087
if (name == tag.getAttribute("name")
1088
and prop._dbus_interface
1089
== if_tag.getAttribute("name")):
1090
annots.update(getattr(
1091
prop, "_dbus_annotations", {}))
1092
for name, value in annots.items():
1093
ann_tag = document.createElement(
1095
ann_tag.setAttribute("name", name)
1096
ann_tag.setAttribute("value", value)
1097
tag.appendChild(ann_tag)
1098
868
# Add the names to the return values for the
1099
869
# "org.freedesktop.DBus.Properties" methods
1100
870
if (if_tag.getAttribute("name")
1115
885
except (AttributeError, xml.dom.DOMException,
1116
886
xml.parsers.expat.ExpatError) as error:
1117
887
logger.error("Failed to override Introspection method",
1119
889
return xmlstring
1122
def datetime_to_dbus(dt, variant_level=0):
892
def datetime_to_dbus (dt, variant_level=0):
1123
893
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1125
895
return dbus.String("", variant_level = variant_level)
1126
return dbus.String(dt.isoformat(), variant_level=variant_level)
1129
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1130
"""A class decorator; applied to a subclass of
1131
dbus.service.Object, it will add alternate D-Bus attributes with
1132
interface names according to the "alt_interface_names" mapping.
1135
@alternate_dbus_interfaces({"org.example.Interface":
1136
"net.example.AlternateInterface"})
1137
class SampleDBusObject(dbus.service.Object):
1138
@dbus.service.method("org.example.Interface")
1139
def SampleDBusMethod():
1142
The above "SampleDBusMethod" on "SampleDBusObject" will be
1143
reachable via two interfaces: "org.example.Interface" and
1144
"net.example.AlternateInterface", the latter of which will have
1145
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1146
"true", unless "deprecate" is passed with a False value.
1148
This works for methods and signals, and also for D-Bus properties
1149
(from DBusObjectWithProperties) and interfaces (from the
1150
dbus_interface_annotations decorator).
896
return dbus.String(dt.isoformat(),
897
variant_level=variant_level)
900
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
902
"""Applied to an empty subclass of a D-Bus object, this metaclass
903
will add additional D-Bus attributes matching a certain pattern.
1154
for orig_interface_name, alt_interface_name in (
1155
alt_interface_names.items()):
1157
interface_names = set()
1158
# Go though all attributes of the class
1159
for attrname, attribute in inspect.getmembers(cls):
905
def __new__(mcs, name, bases, attr):
906
# Go through all the base classes which could have D-Bus
907
# methods, signals, or properties in them
908
for base in (b for b in bases
909
if issubclass(b, dbus.service.Object)):
910
# Go though all attributes of the base class
911
for attrname, attribute in inspect.getmembers(base):
1160
912
# Ignore non-D-Bus attributes, and D-Bus attributes
1161
913
# with the wrong interface name
1162
914
if (not hasattr(attribute, "_dbus_interface")
1163
or not attribute._dbus_interface.startswith(
1164
orig_interface_name)):
915
or not attribute._dbus_interface
916
.startswith("se.recompile.Mandos")):
1166
918
# Create an alternate D-Bus interface name based on
1167
919
# the current name
1168
alt_interface = attribute._dbus_interface.replace(
1169
orig_interface_name, alt_interface_name)
1170
interface_names.add(alt_interface)
920
alt_interface = (attribute._dbus_interface
921
.replace("se.recompile.Mandos",
922
"se.bsnet.fukt.Mandos"))
1171
923
# Is this a D-Bus signal?
1172
924
if getattr(attribute, "_dbus_is_signal", False):
1173
if sys.version_info.major == 2:
1174
# Extract the original non-method undecorated
1175
# function by black magic
1176
nonmethod_func = (dict(
925
# Extract the original non-method function by
927
nonmethod_func = (dict(
1177
928
zip(attribute.func_code.co_freevars,
1178
attribute.__closure__))
1179
["func"].cell_contents)
1181
nonmethod_func = attribute
929
attribute.__closure__))["func"]
1182
931
# Create a new, but exactly alike, function
1183
932
# object, and decorate it to be a new D-Bus signal
1184
933
# with the alternate D-Bus interface name
1185
if sys.version_info.major == 2:
1186
new_function = types.FunctionType(
1187
nonmethod_func.func_code,
1188
nonmethod_func.func_globals,
1189
nonmethod_func.func_name,
1190
nonmethod_func.func_defaults,
1191
nonmethod_func.func_closure)
1193
new_function = types.FunctionType(
1194
nonmethod_func.__code__,
1195
nonmethod_func.__globals__,
1196
nonmethod_func.__name__,
1197
nonmethod_func.__defaults__,
1198
nonmethod_func.__closure__)
1199
new_function = (dbus.service.signal(
1201
attribute._dbus_signature)(new_function))
1202
# Copy annotations, if any
1204
new_function._dbus_annotations = dict(
1205
attribute._dbus_annotations)
1206
except AttributeError:
934
new_function = (dbus.service.signal
936
attribute._dbus_signature)
938
nonmethod_func.func_code,
939
nonmethod_func.func_globals,
940
nonmethod_func.func_name,
941
nonmethod_func.func_defaults,
942
nonmethod_func.func_closure)))
1208
943
# Define a creator of a function to call both the
1209
# original and alternate functions, so both the
1210
# original and alternate signals gets sent when
1211
# the function is called
944
# old and new functions, so both the old and new
945
# signals gets sent when the function is called
1212
946
def fixscope(func1, func2):
1213
947
"""This function is a scope container to pass
1214
948
func1 and func2 to the "call_both" function
1215
949
outside of its arguments"""
1217
950
def call_both(*args, **kwargs):
1218
951
"""This function will emit two D-Bus
1219
952
signals by calling func1 and func2"""
1220
953
func1(*args, **kwargs)
1221
954
func2(*args, **kwargs)
1223
955
return call_both
1224
956
# Create the "call_both" function and add it to
1226
attr[attrname] = fixscope(attribute, new_function)
958
attr[attrname] = fixscope(attribute,
1227
960
# Is this a D-Bus method?
1228
961
elif getattr(attribute, "_dbus_is_method", False):
1229
962
# Create a new, but exactly alike, function
1230
963
# object. Decorate it to be a new D-Bus method
1231
964
# with the alternate D-Bus interface name. Add it
1234
dbus.service.method(
1236
attribute._dbus_in_signature,
1237
attribute._dbus_out_signature)
1238
(types.FunctionType(attribute.func_code,
1239
attribute.func_globals,
1240
attribute.func_name,
1241
attribute.func_defaults,
1242
attribute.func_closure)))
1243
# Copy annotations, if any
1245
attr[attrname]._dbus_annotations = dict(
1246
attribute._dbus_annotations)
1247
except AttributeError:
966
attr[attrname] = (dbus.service.method
968
attribute._dbus_in_signature,
969
attribute._dbus_out_signature)
971
(attribute.func_code,
972
attribute.func_globals,
974
attribute.func_defaults,
975
attribute.func_closure)))
1249
976
# Is this a D-Bus property?
1250
977
elif getattr(attribute, "_dbus_is_property", False):
1251
978
# Create a new, but exactly alike, function
1252
979
# object, and decorate it to be a new D-Bus
1253
980
# property with the alternate D-Bus interface
1254
981
# name. Add it to the class.
1255
attr[attrname] = (dbus_service_property(
1256
alt_interface, attribute._dbus_signature,
1257
attribute._dbus_access,
1258
attribute._dbus_get_args_options
1260
(types.FunctionType(
1261
attribute.func_code,
1262
attribute.func_globals,
1263
attribute.func_name,
1264
attribute.func_defaults,
1265
attribute.func_closure)))
1266
# Copy annotations, if any
1268
attr[attrname]._dbus_annotations = dict(
1269
attribute._dbus_annotations)
1270
except AttributeError:
1272
# Is this a D-Bus interface?
1273
elif getattr(attribute, "_dbus_is_interface", False):
1274
# Create a new, but exactly alike, function
1275
# object. Decorate it to be a new D-Bus interface
1276
# with the alternate D-Bus interface name. Add it
1279
dbus_interface_annotations(alt_interface)
1280
(types.FunctionType(attribute.func_code,
1281
attribute.func_globals,
1282
attribute.func_name,
1283
attribute.func_defaults,
1284
attribute.func_closure)))
1286
# Deprecate all alternate interfaces
1287
iname="_AlternateDBusNames_interface_annotation{}"
1288
for interface_name in interface_names:
1290
@dbus_interface_annotations(interface_name)
1292
return { "org.freedesktop.DBus.Deprecated":
1294
# Find an unused name
1295
for aname in (iname.format(i)
1296
for i in itertools.count()):
1297
if aname not in attr:
1301
# Replace the class with a new subclass of it with
1302
# methods, signals, etc. as created above.
1303
cls = type(b"{}Alternate".format(cls.__name__),
1310
@alternate_dbus_interfaces({"se.recompile.Mandos":
1311
"se.bsnet.fukt.Mandos"})
982
attr[attrname] = (dbus_service_property
984
attribute._dbus_signature,
985
attribute._dbus_access,
987
._dbus_get_args_options
990
(attribute.func_code,
991
attribute.func_globals,
993
attribute.func_defaults,
994
attribute.func_closure)))
995
return type.__new__(mcs, name, bases, attr)
1312
998
class ClientDBus(Client, DBusObjectWithProperties):
1313
999
"""A Client class using D-Bus
1385
1059
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1386
1060
last_enabled = notifychangeproperty(datetime_to_dbus,
1388
checker = notifychangeproperty(
1389
dbus.Boolean, "CheckerRunning",
1390
type_func = lambda checker: checker is not None)
1062
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1063
type_func = lambda checker:
1064
checker is not None)
1391
1065
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1392
1066
"LastCheckedOK")
1393
last_checker_status = notifychangeproperty(dbus.Int16,
1394
"LastCheckerStatus")
1395
1067
last_approval_request = notifychangeproperty(
1396
1068
datetime_to_dbus, "LastApprovalRequest")
1397
1069
approved_by_default = notifychangeproperty(dbus.Boolean,
1398
1070
"ApprovedByDefault")
1399
approval_delay = notifychangeproperty(
1400
dbus.UInt64, "ApprovalDelay",
1401
type_func = lambda td: td.total_seconds() * 1000)
1071
approval_delay = notifychangeproperty(dbus.UInt16,
1074
_timedelta_to_milliseconds)
1402
1075
approval_duration = notifychangeproperty(
1403
dbus.UInt64, "ApprovalDuration",
1404
type_func = lambda td: td.total_seconds() * 1000)
1076
dbus.UInt16, "ApprovalDuration",
1077
type_func = _timedelta_to_milliseconds)
1405
1078
host = notifychangeproperty(dbus.String, "Host")
1406
timeout = notifychangeproperty(
1407
dbus.UInt64, "Timeout",
1408
type_func = lambda td: td.total_seconds() * 1000)
1079
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1081
_timedelta_to_milliseconds)
1409
1082
extended_timeout = notifychangeproperty(
1410
dbus.UInt64, "ExtendedTimeout",
1411
type_func = lambda td: td.total_seconds() * 1000)
1412
interval = notifychangeproperty(
1413
dbus.UInt64, "Interval",
1414
type_func = lambda td: td.total_seconds() * 1000)
1083
dbus.UInt16, "ExtendedTimeout",
1084
type_func = _timedelta_to_milliseconds)
1085
interval = notifychangeproperty(dbus.UInt16,
1088
_timedelta_to_milliseconds)
1415
1089
checker_command = notifychangeproperty(dbus.String, "Checker")
1416
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1417
invalidate_only=True)
1419
1091
del notifychangeproperty
1427
1099
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1428
1100
Client.__del__(self, *args, **kwargs)
1430
def checker_callback(self, source, condition,
1431
connection, command, *args, **kwargs):
1432
ret = Client.checker_callback(self, source, condition,
1433
connection, command, *args,
1435
exitstatus = self.last_checker_status
1102
def checker_callback(self, pid, condition, command,
1104
self.checker_callback_tag = None
1106
if os.WIFEXITED(condition):
1107
exitstatus = os.WEXITSTATUS(condition)
1437
1108
# Emit D-Bus signal
1438
1109
self.CheckerCompleted(dbus.Int16(exitstatus),
1439
# This is specific to GNU libC
1440
dbus.Int64(exitstatus << 8),
1110
dbus.Int64(condition),
1441
1111
dbus.String(command))
1443
1113
# Emit D-Bus signal
1444
1114
self.CheckerCompleted(dbus.Int16(-1),
1446
# This is specific to GNU libC
1448
| self.last_checker_signal),
1115
dbus.Int64(condition),
1449
1116
dbus.String(command))
1118
return Client.checker_callback(self, pid, condition, command,
1452
1121
def start_checker(self, *args, **kwargs):
1453
old_checker_pid = getattr(self.checker, "pid", None)
1122
old_checker = self.checker
1123
if self.checker is not None:
1124
old_checker_pid = self.checker.pid
1126
old_checker_pid = None
1454
1127
r = Client.start_checker(self, *args, **kwargs)
1455
1128
# Only if new checker process was started
1456
1129
if (self.checker is not None
1571
1247
self.approved_by_default = bool(value)
1573
1249
# ApprovalDelay - property
1574
@dbus_service_property(_interface,
1250
@dbus_service_property(_interface, signature="t",
1576
1251
access="readwrite")
1577
1252
def ApprovalDelay_dbus_property(self, value=None):
1578
1253
if value is None: # get
1579
return dbus.UInt64(self.approval_delay.total_seconds()
1254
return dbus.UInt64(self.approval_delay_milliseconds())
1581
1255
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1583
1257
# ApprovalDuration - property
1584
@dbus_service_property(_interface,
1258
@dbus_service_property(_interface, signature="t",
1586
1259
access="readwrite")
1587
1260
def ApprovalDuration_dbus_property(self, value=None):
1588
1261
if value is None: # get
1589
return dbus.UInt64(self.approval_duration.total_seconds()
1262
return dbus.UInt64(_timedelta_to_milliseconds(
1263
self.approval_duration))
1591
1264
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1593
1266
# Name - property
1595
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1596
1267
@dbus_service_property(_interface, signature="s", access="read")
1597
1268
def Name_dbus_property(self):
1598
1269
return dbus.String(self.name)
1600
1271
# Fingerprint - property
1602
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1603
1272
@dbus_service_property(_interface, signature="s", access="read")
1604
1273
def Fingerprint_dbus_property(self):
1605
1274
return dbus.String(self.fingerprint)
1607
1276
# Host - property
1608
@dbus_service_property(_interface,
1277
@dbus_service_property(_interface, signature="s",
1610
1278
access="readwrite")
1611
1279
def Host_dbus_property(self, value=None):
1612
1280
if value is None: # get
1613
1281
return dbus.String(self.host)
1614
self.host = str(value)
1616
1284
# Created - property
1618
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1619
1285
@dbus_service_property(_interface, signature="s", access="read")
1620
1286
def Created_dbus_property(self):
1621
1287
return datetime_to_dbus(self.created)
1663
1322
return datetime_to_dbus(self.last_approval_request)
1665
1324
# Timeout - property
1666
@dbus_service_property(_interface,
1325
@dbus_service_property(_interface, signature="t",
1668
1326
access="readwrite")
1669
1327
def Timeout_dbus_property(self, value=None):
1670
1328
if value is None: # get
1671
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1672
old_timeout = self.timeout
1329
return dbus.UInt64(self.timeout_milliseconds())
1673
1330
self.timeout = datetime.timedelta(0, 0, 0, value)
1674
# Reschedule disabling
1676
now = datetime.datetime.utcnow()
1677
self.expires += self.timeout - old_timeout
1678
if self.expires <= now:
1679
# The timeout has passed
1682
if (getattr(self, "disable_initiator_tag", None)
1685
gobject.source_remove(self.disable_initiator_tag)
1686
self.disable_initiator_tag = gobject.timeout_add(
1687
int((self.expires - now).total_seconds() * 1000),
1331
if getattr(self, "disable_initiator_tag", None) is None:
1333
# Reschedule timeout
1334
gobject.source_remove(self.disable_initiator_tag)
1335
self.disable_initiator_tag = None
1337
time_to_die = _timedelta_to_milliseconds((self
1342
if time_to_die <= 0:
1343
# The timeout has passed
1346
self.expires = (datetime.datetime.utcnow()
1347
+ datetime.timedelta(milliseconds =
1349
self.disable_initiator_tag = (gobject.timeout_add
1350
(time_to_die, self.disable))
1690
1352
# ExtendedTimeout - property
1691
@dbus_service_property(_interface,
1353
@dbus_service_property(_interface, signature="t",
1693
1354
access="readwrite")
1694
1355
def ExtendedTimeout_dbus_property(self, value=None):
1695
1356
if value is None: # get
1696
return dbus.UInt64(self.extended_timeout.total_seconds()
1357
return dbus.UInt64(self.extended_timeout_milliseconds())
1698
1358
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1700
1360
# Interval - property
1701
@dbus_service_property(_interface,
1361
@dbus_service_property(_interface, signature="t",
1703
1362
access="readwrite")
1704
1363
def Interval_dbus_property(self, value=None):
1705
1364
if value is None: # get
1706
return dbus.UInt64(self.interval.total_seconds() * 1000)
1365
return dbus.UInt64(self.interval_milliseconds())
1707
1366
self.interval = datetime.timedelta(0, 0, 0, value)
1708
1367
if getattr(self, "checker_initiator_tag", None) is None:
1710
1369
if self.enabled:
1711
1370
# Reschedule checker run
1712
1371
gobject.source_remove(self.checker_initiator_tag)
1713
self.checker_initiator_tag = gobject.timeout_add(
1714
value, self.start_checker)
1715
self.start_checker() # Start one now, too
1372
self.checker_initiator_tag = (gobject.timeout_add
1373
(value, self.start_checker))
1374
self.start_checker() # Start one now, too
1717
1376
# Checker - property
1718
@dbus_service_property(_interface,
1377
@dbus_service_property(_interface, signature="s",
1720
1378
access="readwrite")
1721
1379
def Checker_dbus_property(self, value=None):
1722
1380
if value is None: # get
1723
1381
return dbus.String(self.checker_command)
1724
self.checker_command = str(value)
1382
self.checker_command = value
1726
1384
# CheckerRunning - property
1727
@dbus_service_property(_interface,
1385
@dbus_service_property(_interface, signature="b",
1729
1386
access="readwrite")
1730
1387
def CheckerRunning_dbus_property(self, value=None):
1731
1388
if value is None: # get
1962
1619
def fingerprint(openpgp):
1963
1620
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1964
1621
# New GnuTLS "datum" with the OpenPGP public key
1965
datum = gnutls.library.types.gnutls_datum_t(
1966
ctypes.cast(ctypes.c_char_p(openpgp),
1967
ctypes.POINTER(ctypes.c_ubyte)),
1968
ctypes.c_uint(len(openpgp)))
1622
datum = (gnutls.library.types
1623
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1626
ctypes.c_uint(len(openpgp))))
1969
1627
# New empty GnuTLS certificate
1970
1628
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1971
gnutls.library.functions.gnutls_openpgp_crt_init(
1629
(gnutls.library.functions
1630
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1973
1631
# Import the OpenPGP public key into the certificate
1974
gnutls.library.functions.gnutls_openpgp_crt_import(
1975
crt, ctypes.byref(datum),
1976
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1632
(gnutls.library.functions
1633
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1634
gnutls.library.constants
1635
.GNUTLS_OPENPGP_FMT_RAW))
1977
1636
# Verify the self signature in the key
1978
1637
crtverify = ctypes.c_uint()
1979
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1980
crt, 0, ctypes.byref(crtverify))
1638
(gnutls.library.functions
1639
.gnutls_openpgp_crt_verify_self(crt, 0,
1640
ctypes.byref(crtverify)))
1981
1641
if crtverify.value != 0:
1982
1642
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1983
raise gnutls.errors.CertificateSecurityError(
1643
raise (gnutls.errors.CertificateSecurityError
1985
1645
# New buffer for the fingerprint
1986
1646
buf = ctypes.create_string_buffer(20)
1987
1647
buf_len = ctypes.c_size_t()
1988
1648
# Get the fingerprint from the certificate into the buffer
1989
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1990
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1649
(gnutls.library.functions
1650
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1651
ctypes.byref(buf_len)))
1991
1652
# Deinit the certificate
1992
1653
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1993
1654
# Convert the buffer to a Python bytestring
2044
1704
interface: None or a network interface name (string)
2045
1705
use_ipv6: Boolean; to use IPv6 or not
2048
1707
def __init__(self, server_address, RequestHandlerClass,
2052
"""If socketfd is set, use that file descriptor instead of
2053
creating a new one with socket.socket().
1708
interface=None, use_ipv6=True):
2055
1709
self.interface = interface
2057
1711
self.address_family = socket.AF_INET6
2058
if socketfd is not None:
2059
# Save the file descriptor
2060
self.socketfd = socketfd
2061
# Save the original socket.socket() function
2062
self.socket_socket = socket.socket
2063
# To implement --socket, we monkey patch socket.socket.
2065
# (When socketserver.TCPServer is a new-style class, we
2066
# could make self.socket into a property instead of monkey
2067
# patching socket.socket.)
2069
# Create a one-time-only replacement for socket.socket()
2070
@functools.wraps(socket.socket)
2071
def socket_wrapper(*args, **kwargs):
2072
# Restore original function so subsequent calls are
2074
socket.socket = self.socket_socket
2075
del self.socket_socket
2076
# This time only, return a new socket object from the
2077
# saved file descriptor.
2078
return socket.fromfd(self.socketfd, *args, **kwargs)
2079
# Replace socket.socket() function with wrapper
2080
socket.socket = socket_wrapper
2081
# The socketserver.TCPServer.__init__ will call
2082
# socket.socket(), which might be our replacement,
2083
# socket_wrapper(), if socketfd was set.
2084
1712
socketserver.TCPServer.__init__(self, server_address,
2085
1713
RequestHandlerClass)
2087
1714
def server_bind(self):
2088
1715
"""This overrides the normal server_bind() function
2089
1716
to bind to an interface if one was specified, and also NOT to
2249
def rfc3339_duration_to_delta(duration):
2250
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2252
>>> rfc3339_duration_to_delta("P7D")
2253
datetime.timedelta(7)
2254
>>> rfc3339_duration_to_delta("PT60S")
2255
datetime.timedelta(0, 60)
2256
>>> rfc3339_duration_to_delta("PT60M")
2257
datetime.timedelta(0, 3600)
2258
>>> rfc3339_duration_to_delta("PT24H")
2259
datetime.timedelta(1)
2260
>>> rfc3339_duration_to_delta("P1W")
2261
datetime.timedelta(7)
2262
>>> rfc3339_duration_to_delta("PT5M30S")
2263
datetime.timedelta(0, 330)
2264
>>> rfc3339_duration_to_delta("P1DT3M20S")
2265
datetime.timedelta(1, 200)
2268
# Parsing an RFC 3339 duration with regular expressions is not
2269
# possible - there would have to be multiple places for the same
2270
# values, like seconds. The current code, while more esoteric, is
2271
# cleaner without depending on a parsing library. If Python had a
2272
# built-in library for parsing we would use it, but we'd like to
2273
# avoid excessive use of external libraries.
2275
# New type for defining tokens, syntax, and semantics all-in-one
2276
Token = collections.namedtuple("Token", (
2277
"regexp", # To match token; if "value" is not None, must have
2278
# a "group" containing digits
2279
"value", # datetime.timedelta or None
2280
"followers")) # Tokens valid after this token
2281
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2282
# the "duration" ABNF definition in RFC 3339, Appendix A.
2283
token_end = Token(re.compile(r"$"), None, frozenset())
2284
token_second = Token(re.compile(r"(\d+)S"),
2285
datetime.timedelta(seconds=1),
2286
frozenset((token_end, )))
2287
token_minute = Token(re.compile(r"(\d+)M"),
2288
datetime.timedelta(minutes=1),
2289
frozenset((token_second, token_end)))
2290
token_hour = Token(re.compile(r"(\d+)H"),
2291
datetime.timedelta(hours=1),
2292
frozenset((token_minute, token_end)))
2293
token_time = Token(re.compile(r"T"),
2295
frozenset((token_hour, token_minute,
2297
token_day = Token(re.compile(r"(\d+)D"),
2298
datetime.timedelta(days=1),
2299
frozenset((token_time, token_end)))
2300
token_month = Token(re.compile(r"(\d+)M"),
2301
datetime.timedelta(weeks=4),
2302
frozenset((token_day, token_end)))
2303
token_year = Token(re.compile(r"(\d+)Y"),
2304
datetime.timedelta(weeks=52),
2305
frozenset((token_month, token_end)))
2306
token_week = Token(re.compile(r"(\d+)W"),
2307
datetime.timedelta(weeks=1),
2308
frozenset((token_end, )))
2309
token_duration = Token(re.compile(r"P"), None,
2310
frozenset((token_year, token_month,
2311
token_day, token_time,
2313
# Define starting values
2314
value = datetime.timedelta() # Value so far
2316
followers = frozenset((token_duration, )) # Following valid tokens
2317
s = duration # String left to parse
2318
# Loop until end token is found
2319
while found_token is not token_end:
2320
# Search for any currently valid tokens
2321
for token in followers:
2322
match = token.regexp.match(s)
2323
if match is not None:
2325
if token.value is not None:
2326
# Value found, parse digits
2327
factor = int(match.group(1), 10)
2328
# Add to value so far
2329
value += factor * token.value
2330
# Strip token from string
2331
s = token.regexp.sub("", s, 1)
2334
# Set valid next tokens
2335
followers = found_token.followers
2338
# No currently valid tokens were found
2339
raise ValueError("Invalid RFC 3339 duration: {!r}"
2345
1881
def string_to_delta(interval):
2346
1882
"""Parse a string and return a datetime.timedelta
2476
1997
"debug": "False",
2478
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2479
":+SIGN-DSA-SHA256",
1999
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2480
2000
"servicename": "Mandos",
2481
2001
"use_dbus": "True",
2482
2002
"use_ipv6": "True",
2483
2003
"debuglevel": "",
2484
2004
"restore": "True",
2486
"statedir": "/var/lib/mandos",
2487
"foreground": "False",
2005
"statedir": "/var/lib/mandos"
2491
2008
# Parse config file for server-global settings
2492
2009
server_config = configparser.SafeConfigParser(server_defaults)
2493
2010
del server_defaults
2494
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2011
server_config.read(os.path.join(options.configdir,
2495
2013
# Convert the SafeConfigParser object to a dict
2496
2014
server_settings = server_config.defaults()
2497
2015
# Use the appropriate methods on the non-string config options
2498
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2016
for option in ("debug", "use_dbus", "use_ipv6"):
2499
2017
server_settings[option] = server_config.getboolean("DEFAULT",
2501
2019
if server_settings["port"]:
2502
2020
server_settings["port"] = server_config.getint("DEFAULT",
2504
if server_settings["socket"]:
2505
server_settings["socket"] = server_config.getint("DEFAULT",
2507
# Later, stdin will, and stdout and stderr might, be dup'ed
2508
# over with an opened os.devnull. But we don't want this to
2509
# happen with a supplied network socket.
2510
if 0 <= server_settings["socket"] <= 2:
2511
server_settings["socket"] = os.dup(server_settings
2513
2022
del server_config
2515
2024
# Override the settings from the config file with command line
2516
2025
# options, if set.
2517
2026
for option in ("interface", "address", "port", "debug",
2518
"priority", "servicename", "configdir", "use_dbus",
2519
"use_ipv6", "debuglevel", "restore", "statedir",
2520
"socket", "foreground", "zeroconf"):
2027
"priority", "servicename", "configdir",
2028
"use_dbus", "use_ipv6", "debuglevel", "restore",
2521
2030
value = getattr(options, option)
2522
2031
if value is not None:
2523
2032
server_settings[option] = value
2525
2034
# Force all strings to be unicode
2526
2035
for option in server_settings.keys():
2527
if isinstance(server_settings[option], bytes):
2528
server_settings[option] = (server_settings[option]
2530
# Force all boolean options to be boolean
2531
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2532
"foreground", "zeroconf"):
2533
server_settings[option] = bool(server_settings[option])
2534
# Debug implies foreground
2535
if server_settings["debug"]:
2536
server_settings["foreground"] = True
2036
if type(server_settings[option]) is str:
2037
server_settings[option] = unicode(server_settings[option])
2537
2038
# Now we have our good server settings in "server_settings"
2539
2040
##################################################################
2541
if (not server_settings["zeroconf"]
2542
and not (server_settings["port"]
2543
or server_settings["socket"] != "")):
2544
parser.error("Needs port or socket to work without Zeroconf")
2546
2042
# For convenience
2547
2043
debug = server_settings["debug"]
2548
2044
debuglevel = server_settings["debuglevel"]
2550
2046
use_ipv6 = server_settings["use_ipv6"]
2551
2047
stored_state_path = os.path.join(server_settings["statedir"],
2552
2048
stored_state_file)
2553
foreground = server_settings["foreground"]
2554
zeroconf = server_settings["zeroconf"]
2557
initlogger(debug, logging.DEBUG)
2051
initlogger(logging.DEBUG)
2559
2053
if not debuglevel:
2562
2056
level = getattr(logging, debuglevel.upper())
2563
initlogger(debug, level)
2565
2059
if server_settings["servicename"] != "Mandos":
2566
syslogger.setFormatter(
2567
logging.Formatter('Mandos ({}) [%(process)d]:'
2568
' %(levelname)s: %(message)s'.format(
2569
server_settings["servicename"])))
2060
syslogger.setFormatter(logging.Formatter
2061
('Mandos (%s) [%%(process)d]:'
2062
' %%(levelname)s: %%(message)s'
2063
% server_settings["servicename"]))
2571
2065
# Parse config file with clients
2572
client_config = configparser.SafeConfigParser(Client
2066
client_defaults = { "timeout": "5m",
2067
"extended_timeout": "15m",
2069
"checker": "fping -q -- %%(host)s",
2071
"approval_delay": "0s",
2072
"approval_duration": "1s",
2074
client_config = configparser.SafeConfigParser(client_defaults)
2574
2075
client_config.read(os.path.join(server_settings["configdir"],
2575
2076
"clients.conf"))
2577
2078
global mandos_dbus_service
2578
2079
mandos_dbus_service = None
2581
if server_settings["socket"] != "":
2582
socketfd = server_settings["socket"]
2583
tcp_server = MandosServer(
2584
(server_settings["address"], server_settings["port"]),
2586
interface=(server_settings["interface"] or None),
2588
gnutls_priority=server_settings["priority"],
2592
pidfilename = "/run/mandos.pid"
2593
if not os.path.isdir("/run/."):
2594
pidfilename = "/var/run/mandos.pid"
2081
tcp_server = MandosServer((server_settings["address"],
2082
server_settings["port"]),
2084
interface=(server_settings["interface"]
2088
server_settings["priority"],
2091
pidfilename = "/var/run/mandos.pid"
2597
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2598
except IOError as e:
2599
logger.error("Could not open file %r", pidfilename,
2093
pidfile = open(pidfilename, "w")
2095
logger.error("Could not open file %r", pidfilename)
2602
for name in ("_mandos", "mandos", "nobody"):
2098
uid = pwd.getpwnam("_mandos").pw_uid
2099
gid = pwd.getpwnam("_mandos").pw_gid
2604
uid = pwd.getpwnam(name).pw_uid
2605
gid = pwd.getpwnam(name).pw_gid
2102
uid = pwd.getpwnam("mandos").pw_uid
2103
gid = pwd.getpwnam("mandos").pw_gid
2607
2104
except KeyError:
2106
uid = pwd.getpwnam("nobody").pw_uid
2107
gid = pwd.getpwnam("nobody").pw_gid
2615
2114
except OSError as error:
2616
if error.errno != errno.EPERM:
2115
if error[0] != errno.EPERM:
2620
2119
# Enable all possible GnuTLS debugging
2627
2126
def debug_gnutls(level, string):
2628
2127
logger.debug("GnuTLS: %s", string[:-1])
2630
gnutls.library.functions.gnutls_global_set_log_function(
2129
(gnutls.library.functions
2130
.gnutls_global_set_log_function(debug_gnutls))
2633
2132
# Redirect stdin so all checkers get /dev/null
2634
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2133
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2635
2134
os.dup2(null, sys.stdin.fileno())
2138
# No console logging
2139
logger.removeHandler(console)
2639
2141
# Need to fork before connecting to D-Bus
2641
2143
# Close all input and output, do double fork, etc.
2644
# multiprocessing will use threads, so before we use gobject we
2645
# need to inform gobject that threads will be used.
2646
gobject.threads_init()
2648
2146
global main_loop
2649
2147
# From the Avahi example code
2650
DBusGMainLoop(set_as_default=True)
2148
DBusGMainLoop(set_as_default=True )
2651
2149
main_loop = gobject.MainLoop()
2652
2150
bus = dbus.SystemBus()
2653
2151
# End of Avahi example code
2656
2154
bus_name = dbus.service.BusName("se.recompile.Mandos",
2659
old_bus_name = dbus.service.BusName(
2660
"se.bsnet.fukt.Mandos", bus,
2662
except dbus.exceptions.DBusException as e:
2663
logger.error("Disabling D-Bus:", exc_info=e)
2155
bus, do_not_queue=True)
2156
old_bus_name = (dbus.service.BusName
2157
("se.bsnet.fukt.Mandos", bus,
2159
except dbus.exceptions.NameExistsException as e:
2160
logger.error(unicode(e) + ", disabling D-Bus")
2664
2161
use_dbus = False
2665
2162
server_settings["use_dbus"] = False
2666
2163
tcp_server.use_dbus = False
2668
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2669
service = AvahiServiceToSyslog(
2670
name = server_settings["servicename"],
2671
servicetype = "_mandos._tcp",
2672
protocol = protocol,
2674
if server_settings["interface"]:
2675
service.interface = if_nametoindex(
2676
server_settings["interface"].encode("utf-8"))
2164
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2165
service = AvahiServiceToSyslog(name =
2166
server_settings["servicename"],
2167
servicetype = "_mandos._tcp",
2168
protocol = protocol, bus = bus)
2169
if server_settings["interface"]:
2170
service.interface = (if_nametoindex
2171
(str(server_settings["interface"])))
2678
2173
global multiprocessing_manager
2679
2174
multiprocessing_manager = multiprocessing.Manager()
2681
2176
client_class = Client
2683
client_class = functools.partial(ClientDBus, bus = bus)
2685
client_settings = Client.config_parser(client_config)
2178
client_class = functools.partial(ClientDBusTransitional,
2181
special_settings = {
2182
# Some settings need to be accessd by special methods;
2183
# booleans need .getboolean(), etc. Here is a list of them:
2184
"approved_by_default":
2186
client_config.getboolean(section, "approved_by_default"),
2189
client_config.getboolean(section, "enabled"),
2191
# Construct a new dict of client settings of this form:
2192
# { client_name: {setting_name: value, ...}, ...}
2193
# with exceptions for any special settings as defined above
2194
client_settings = dict((clientname,
2197
if setting not in special_settings
2198
else special_settings[setting]
2200
for setting, value in
2201
client_config.items(clientname)))
2202
for clientname in client_config.sections())
2686
2204
old_client_settings = {}
2689
# This is used to redirect stdout and stderr for checker processes
2691
wnull = open(os.devnull, "w") # A writable /dev/null
2692
# Only used if server is running in foreground but not in debug
2694
if debug or not foreground:
2697
2207
# Get client data and settings from last running state.
2698
2208
if server_settings["restore"]:
2700
2210
with open(stored_state_path, "rb") as stored_state:
2701
clients_data, old_client_settings = pickle.load(
2211
clients_data, old_client_settings = (pickle.load
2703
2213
os.remove(stored_state_path)
2704
2214
except IOError as e:
2705
if e.errno == errno.ENOENT:
2706
logger.warning("Could not load persistent state:"
2707
" {}".format(os.strerror(e.errno)))
2709
logger.critical("Could not load persistent state:",
2215
logger.warning("Could not load persistent state: {0}"
2217
if e.errno != errno.ENOENT:
2712
except EOFError as e:
2713
logger.warning("Could not load persistent state: "
2717
with PGPEngine() as pgp:
2718
for client_name, client in clients_data.items():
2719
# Skip removed clients
2720
if client_name not in client_settings:
2220
with Crypto() as crypt:
2221
for client in clients_data:
2222
client_name = client["name"]
2723
2224
# Decide which value to use after restoring saved state.
2724
2225
# We have three different values: Old config file,
2730
2231
# For each value in new config, check if it
2731
2232
# differs from the old config value (Except for
2732
2233
# the "secret" attribute)
2733
if (name != "secret"
2735
old_client_settings[client_name][name])):
2736
client[name] = value
2234
if (name != "secret" and
2235
value != old_client_settings[client_name]
2237
setattr(client, name, value)
2737
2238
except KeyError:
2740
2241
# Clients who has passed its expire date can still be
2741
# enabled if its last checker was successful. A Client
2742
# whose checker succeeded before we stored its state is
2743
# assumed to have successfully run all checkers during
2745
if client["enabled"]:
2746
if datetime.datetime.utcnow() >= client["expires"]:
2747
if not client["last_checked_ok"]:
2749
"disabling client {} - Client never "
2750
"performed a successful checker".format(
2752
client["enabled"] = False
2753
elif client["last_checker_status"] != 0:
2755
"disabling client {} - Client last"
2756
" checker failed with error code"
2759
client["last_checker_status"]))
2242
# enabled if its last checker was sucessful. Clients
2243
# whose checker failed before we stored its state is
2244
# assumed to have failed all checkers during downtime.
2245
if client["enabled"] and client["last_checked_ok"]:
2246
if ((datetime.datetime.utcnow()
2247
- client["last_checked_ok"])
2248
> client["interval"]):
2249
if client["last_checker_status"] != 0:
2760
2250
client["enabled"] = False
2762
client["expires"] = (
2763
datetime.datetime.utcnow()
2764
+ client["timeout"])
2765
logger.debug("Last checker succeeded,"
2766
" keeping {} enabled".format(
2252
client["expires"] = (datetime.datetime
2254
+ client["timeout"])
2256
client["changedstate"] = (multiprocessing_manager
2258
(multiprocessing_manager
2261
new_client = (ClientDBusTransitional.__new__
2262
(ClientDBusTransitional))
2263
tcp_server.clients[client_name] = new_client
2264
new_client.bus = bus
2265
for name, value in client.iteritems():
2266
setattr(new_client, name, value)
2267
client_object_name = unicode(client_name).translate(
2268
{ord("."): ord("_"),
2269
ord("-"): ord("_")})
2270
new_client.dbus_object_path = (dbus.ObjectPath
2272
+ client_object_name))
2273
DBusObjectWithProperties.__init__(new_client,
2278
tcp_server.clients[client_name] = (Client.__new__
2280
for name, value in client.iteritems():
2281
setattr(tcp_server.clients[client_name],
2769
client["secret"] = pgp.decrypt(
2770
client["encrypted_secret"],
2285
tcp_server.clients[client_name].secret = (
2286
crypt.decrypt(tcp_server.clients[client_name]
2288
client_settings[client_name]
2291
# If decryption fails, we use secret from new settings
2292
tcp_server.clients[client_name].secret = (
2771
2293
client_settings[client_name]["secret"])
2773
# If decryption fails, we use secret from new settings
2774
logger.debug("Failed to decrypt {} old secret".format(
2776
client["secret"] = (client_settings[client_name]
2779
# Add/remove clients based on new changes made to config
2780
for client_name in (set(old_client_settings)
2781
- set(client_settings)):
2782
del clients_data[client_name]
2783
for client_name in (set(client_settings)
2784
- set(old_client_settings)):
2785
clients_data[client_name] = client_settings[client_name]
2787
# Create all client objects
2788
for client_name, client in clients_data.items():
2789
tcp_server.clients[client_name] = client_class(
2792
server_settings = server_settings)
2295
# Create/remove clients based on new changes made to config
2296
for clientname in set(old_client_settings) - set(client_settings):
2297
del tcp_server.clients[clientname]
2298
for clientname in set(client_settings) - set(old_client_settings):
2299
tcp_server.clients[clientname] = (client_class(name
2794
2305
if not tcp_server.clients:
2795
2306
logger.warning("No clients defined")
2798
if pidfile is not None:
2802
print(pid, file=pidfile)
2804
logger.error("Could not write to file %r with PID %d",
2312
pidfile.write(str(pid) + "\n".encode("utf-8"))
2315
logger.error("Could not write to file %r with PID %d",
2318
# "pidfile" was never created
2807
2320
del pidfilename
2322
signal.signal(signal.SIGINT, signal.SIG_IGN)
2809
2324
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2810
2325
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2814
@alternate_dbus_interfaces(
2815
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2816
class MandosDBusService(DBusObjectWithAnnotations):
2328
class MandosDBusService(dbus.service.Object):
2817
2329
"""A D-Bus proxy object"""
2819
2330
def __init__(self):
2820
2331
dbus.service.Object.__init__(self, bus, "/")
2822
2332
_interface = "se.recompile.Mandos"
2824
2334
@dbus.service.signal(_interface, signature="o")