69
import cPickle as pickle
63
import cPickle as pickle
72
64
import multiprocessing
81
70
import dbus.service
82
from gi.repository import GLib
83
73
from dbus.mainloop.glib import DBusGMainLoop
86
76
import xml.dom.minidom
89
# Try to find the value of SO_BINDTODEVICE:
91
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
92
# newer, and it is also the most natural place for it:
93
81
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
94
82
except AttributeError:
96
# This is where SO_BINDTODEVICE was up to and including Python
98
84
from IN import SO_BINDTODEVICE
99
85
except ImportError:
100
# In Python 2.7 it seems to have been removed entirely.
101
# Try running the C preprocessor:
103
cc = subprocess.Popen(["cc", "--language=c", "-E",
105
stdin=subprocess.PIPE,
106
stdout=subprocess.PIPE)
107
stdout = cc.communicate(
108
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
109
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
110
except (OSError, ValueError, IndexError):
112
SO_BINDTODEVICE = None
114
if sys.version_info.major == 2:
86
SO_BINDTODEVICE = None
118
89
stored_state_file = "clients.pickle"
120
91
logger = logging.getLogger()
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
ctypes.util.find_library("c")).if_nametoindex
97
if_nametoindex = (ctypes.cdll.LoadLibrary
98
(ctypes.util.find_library("c"))
126
100
except (OSError, AttributeError):
128
101
def if_nametoindex(interface):
129
102
"Get an interface index the hard way, i.e. using fcntl()"
130
103
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
131
104
with contextlib.closing(socket.socket()) as s:
132
105
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
133
struct.pack(b"16s16x", interface))
134
interface_index = struct.unpack("I", ifreq[16:20])[0]
106
struct.pack(str("16s16x"),
108
interface_index = struct.unpack(str("I"),
135
110
return interface_index
138
def copy_function(func):
139
"""Make a copy of a function"""
140
if sys.version_info.major == 2:
141
return types.FunctionType(func.func_code,
147
return types.FunctionType(func.__code__,
154
113
def initlogger(debug, level=logging.WARNING):
155
114
"""init logger and add loglevel"""
158
syslogger = (logging.handlers.SysLogHandler(
159
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
160
address = "/dev/log"))
161
116
syslogger.setFormatter(logging.Formatter
162
117
('Mandos [%(process)d]: %(levelname)s:'
228
171
def password_encode(self, password):
229
172
# Passphrase can not be empty and can not contain newlines or
230
173
# NUL bytes. So we prefix it and hex encode it.
231
encoded = b"mandos" + binascii.hexlify(password)
232
if len(encoded) > 2048:
233
# GnuPG can't handle long passwords, so encode differently
234
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
235
.replace(b"\n", b"\\n")
236
.replace(b"\0", b"\\x00"))
174
return b"mandos" + binascii.hexlify(password)
239
176
def encrypt(self, data, password):
240
passphrase = self.password_encode(password)
241
with tempfile.NamedTemporaryFile(
242
dir=self.tempdir) as passfile:
243
passfile.write(passphrase)
245
proc = subprocess.Popen([self.gpg, '--symmetric',
249
stdin = subprocess.PIPE,
250
stdout = subprocess.PIPE,
251
stderr = subprocess.PIPE)
252
ciphertext, err = proc.communicate(input = data)
253
if proc.returncode != 0:
177
self.gnupg.passphrase = self.password_encode(password)
178
with open(os.devnull) as devnull:
180
proc = self.gnupg.run(['--symmetric'],
181
create_fhs=['stdin', 'stdout'],
182
attach_fhs={'stderr': devnull})
183
with contextlib.closing(proc.handles['stdin']) as f:
185
with contextlib.closing(proc.handles['stdout']) as f:
186
ciphertext = f.read()
190
self.gnupg.passphrase = None
255
191
return ciphertext
257
193
def decrypt(self, data, password):
258
passphrase = self.password_encode(password)
259
with tempfile.NamedTemporaryFile(
260
dir = self.tempdir) as passfile:
261
passfile.write(passphrase)
263
proc = subprocess.Popen([self.gpg, '--decrypt',
267
stdin = subprocess.PIPE,
268
stdout = subprocess.PIPE,
269
stderr = subprocess.PIPE)
270
decrypted_plaintext, err = proc.communicate(input = data)
271
if proc.returncode != 0:
194
self.gnupg.passphrase = self.password_encode(password)
195
with open(os.devnull) as devnull:
197
proc = self.gnupg.run(['--decrypt'],
198
create_fhs=['stdin', 'stdout'],
199
attach_fhs={'stderr': devnull})
200
with contextlib.closing(proc.handles['stdin'] ) as f:
202
with contextlib.closing(proc.handles['stdout']) as f:
203
decrypted_plaintext = f.read()
207
self.gnupg.passphrase = None
273
208
return decrypted_plaintext
275
# Pretend that we have an Avahi module
277
"""This isn't so much a class as it is a module-like namespace.
278
It is instantiated once, and simulates having an Avahi module."""
279
IF_UNSPEC = -1 # avahi-common/address.h
280
PROTO_UNSPEC = -1 # avahi-common/address.h
281
PROTO_INET = 0 # avahi-common/address.h
282
PROTO_INET6 = 1 # avahi-common/address.h
283
DBUS_NAME = "org.freedesktop.Avahi"
284
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
285
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
286
DBUS_PATH_SERVER = "/"
287
def string_array_to_txt_array(self, t):
288
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
289
for s in t), signature="ay")
290
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
291
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
292
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
293
SERVER_INVALID = 0 # avahi-common/defs.h
294
SERVER_REGISTERING = 1 # avahi-common/defs.h
295
SERVER_RUNNING = 2 # avahi-common/defs.h
296
SERVER_COLLISION = 3 # avahi-common/defs.h
297
SERVER_FAILURE = 4 # avahi-common/defs.h
300
212
class AvahiError(Exception):
301
213
def __init__(self, value, *args, **kwargs):
302
214
self.value = value
303
return super(AvahiError, self).__init__(value, *args,
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
307
219
class AvahiServiceError(AvahiError):
311
222
class AvahiGroupError(AvahiError):
485
366
follow_name_owner_changes=True),
486
367
avahi.DBUS_INTERFACE_SERVER)
487
368
self.server.connect_to_signal("StateChanged",
488
self.server_state_changed)
369
self.server_state_changed)
489
370
self.server_state_changed(self.server.GetState())
492
372
class AvahiServiceToSyslog(AvahiService):
493
def rename(self, *args, **kwargs):
494
374
"""Add the new name to the syslog messages"""
495
ret = AvahiService.rename(self, *args, **kwargs)
496
syslogger.setFormatter(logging.Formatter(
497
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
375
ret = AvahiService.rename(self)
376
syslogger.setFormatter(logging.Formatter
377
('Mandos (%s) [%%(process)d]:'
378
' %%(levelname)s: %%(message)s'
501
# Pretend that we have a GnuTLS module
502
class GnuTLS(object):
503
"""This isn't so much a class as it is a module-like namespace.
504
It is instantiated once, and simulates having a GnuTLS module."""
506
_library = ctypes.cdll.LoadLibrary(
507
ctypes.util.find_library("gnutls"))
508
_need_version = b"3.3.0"
510
# Need to use class name "GnuTLS" here, since this method is
511
# called before the assignment to the "gnutls" global variable
513
if GnuTLS.check_version(self._need_version) is None:
514
raise GnuTLS.Error("Needs GnuTLS {} or later"
515
.format(self._need_version))
517
# Unless otherwise indicated, the constants and types below are
518
# all from the gnutls/gnutls.h C header file.
528
E_NO_CERTIFICATE_FOUND = -49
529
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
532
class session_int(ctypes.Structure):
534
session_t = ctypes.POINTER(session_int)
535
class certificate_credentials_st(ctypes.Structure):
537
certificate_credentials_t = ctypes.POINTER(
538
certificate_credentials_st)
539
certificate_type_t = ctypes.c_int
540
class datum_t(ctypes.Structure):
541
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
542
('size', ctypes.c_uint)]
543
class openpgp_crt_int(ctypes.Structure):
545
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
546
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
547
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
548
credentials_type_t = ctypes.c_int
549
transport_ptr_t = ctypes.c_void_p
550
close_request_t = ctypes.c_int
553
class Error(Exception):
554
# We need to use the class name "GnuTLS" here, since this
555
# exception might be raised from within GnuTLS.__init__,
556
# which is called before the assignment to the "gnutls"
557
# global variable has happened.
558
def __init__(self, message = None, code = None, args=()):
559
# Default usage is by a message string, but if a return
560
# code is passed, convert it to a string with
563
if message is None and code is not None:
564
message = GnuTLS.strerror(code)
565
return super(GnuTLS.Error, self).__init__(
568
class CertificateSecurityError(Error):
572
class Credentials(object):
574
self._c_object = gnutls.certificate_credentials_t()
575
gnutls.certificate_allocate_credentials(
576
ctypes.byref(self._c_object))
577
self.type = gnutls.CRD_CERTIFICATE
580
gnutls.certificate_free_credentials(self._c_object)
582
class ClientSession(object):
583
def __init__(self, socket, credentials = None):
584
self._c_object = gnutls.session_t()
585
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
586
gnutls.set_default_priority(self._c_object)
587
gnutls.transport_set_ptr(self._c_object, socket.fileno())
588
gnutls.handshake_set_private_extensions(self._c_object,
591
if credentials is None:
592
credentials = gnutls.Credentials()
593
gnutls.credentials_set(self._c_object, credentials.type,
594
ctypes.cast(credentials._c_object,
596
self.credentials = credentials
599
gnutls.deinit(self._c_object)
602
return gnutls.handshake(self._c_object)
604
def send(self, data):
608
data_len -= gnutls.record_send(self._c_object,
613
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
615
# Error handling functions
616
def _error_code(result):
617
"""A function to raise exceptions on errors, suitable
618
for the 'restype' attribute on ctypes functions"""
621
if result == gnutls.E_NO_CERTIFICATE_FOUND:
622
raise gnutls.CertificateSecurityError(code = result)
623
raise gnutls.Error(code = result)
625
def _retry_on_error(result, func, arguments):
626
"""A function to retry on some errors, suitable
627
for the 'errcheck' attribute on ctypes functions"""
629
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
630
return _error_code(result)
631
result = func(*arguments)
634
# Unless otherwise indicated, the function declarations below are
635
# all from the gnutls/gnutls.h C header file.
638
priority_set_direct = _library.gnutls_priority_set_direct
639
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
640
ctypes.POINTER(ctypes.c_char_p)]
641
priority_set_direct.restype = _error_code
643
init = _library.gnutls_init
644
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
645
init.restype = _error_code
647
set_default_priority = _library.gnutls_set_default_priority
648
set_default_priority.argtypes = [session_t]
649
set_default_priority.restype = _error_code
651
record_send = _library.gnutls_record_send
652
record_send.argtypes = [session_t, ctypes.c_void_p,
654
record_send.restype = ctypes.c_ssize_t
655
record_send.errcheck = _retry_on_error
657
certificate_allocate_credentials = (
658
_library.gnutls_certificate_allocate_credentials)
659
certificate_allocate_credentials.argtypes = [
660
ctypes.POINTER(certificate_credentials_t)]
661
certificate_allocate_credentials.restype = _error_code
663
certificate_free_credentials = (
664
_library.gnutls_certificate_free_credentials)
665
certificate_free_credentials.argtypes = [certificate_credentials_t]
666
certificate_free_credentials.restype = None
668
handshake_set_private_extensions = (
669
_library.gnutls_handshake_set_private_extensions)
670
handshake_set_private_extensions.argtypes = [session_t,
672
handshake_set_private_extensions.restype = None
674
credentials_set = _library.gnutls_credentials_set
675
credentials_set.argtypes = [session_t, credentials_type_t,
677
credentials_set.restype = _error_code
679
strerror = _library.gnutls_strerror
680
strerror.argtypes = [ctypes.c_int]
681
strerror.restype = ctypes.c_char_p
683
certificate_type_get = _library.gnutls_certificate_type_get
684
certificate_type_get.argtypes = [session_t]
685
certificate_type_get.restype = _error_code
687
certificate_get_peers = _library.gnutls_certificate_get_peers
688
certificate_get_peers.argtypes = [session_t,
689
ctypes.POINTER(ctypes.c_uint)]
690
certificate_get_peers.restype = ctypes.POINTER(datum_t)
692
global_set_log_level = _library.gnutls_global_set_log_level
693
global_set_log_level.argtypes = [ctypes.c_int]
694
global_set_log_level.restype = None
696
global_set_log_function = _library.gnutls_global_set_log_function
697
global_set_log_function.argtypes = [log_func]
698
global_set_log_function.restype = None
700
deinit = _library.gnutls_deinit
701
deinit.argtypes = [session_t]
702
deinit.restype = None
704
handshake = _library.gnutls_handshake
705
handshake.argtypes = [session_t]
706
handshake.restype = _error_code
707
handshake.errcheck = _retry_on_error
709
transport_set_ptr = _library.gnutls_transport_set_ptr
710
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
711
transport_set_ptr.restype = None
713
bye = _library.gnutls_bye
714
bye.argtypes = [session_t, close_request_t]
715
bye.restype = _error_code
716
bye.errcheck = _retry_on_error
718
check_version = _library.gnutls_check_version
719
check_version.argtypes = [ctypes.c_char_p]
720
check_version.restype = ctypes.c_char_p
722
# All the function declarations below are from gnutls/openpgp.h
724
openpgp_crt_init = _library.gnutls_openpgp_crt_init
725
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
726
openpgp_crt_init.restype = _error_code
728
openpgp_crt_import = _library.gnutls_openpgp_crt_import
729
openpgp_crt_import.argtypes = [openpgp_crt_t,
730
ctypes.POINTER(datum_t),
732
openpgp_crt_import.restype = _error_code
734
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
735
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
736
ctypes.POINTER(ctypes.c_uint)]
737
openpgp_crt_verify_self.restype = _error_code
739
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
740
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
741
openpgp_crt_deinit.restype = None
743
openpgp_crt_get_fingerprint = (
744
_library.gnutls_openpgp_crt_get_fingerprint)
745
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
749
openpgp_crt_get_fingerprint.restype = _error_code
751
# Remove non-public functions
752
del _error_code, _retry_on_error
753
# Create the global "gnutls" object, simulating a module
756
def call_pipe(connection, # : multiprocessing.Connection
757
func, *args, **kwargs):
758
"""This function is meant to be called by multiprocessing.Process
760
This function runs func(*args, **kwargs), and writes the resulting
761
return value on the provided multiprocessing.Connection.
763
connection.send(func(*args, **kwargs))
382
def timedelta_to_milliseconds(td):
383
"Convert a datetime.timedelta() to milliseconds"
384
return ((td.days * 24 * 60 * 60 * 1000)
385
+ (td.seconds * 1000)
386
+ (td.microseconds // 1000))
766
388
class Client(object):
767
389
"""A representation of a client host served by this server.
806
426
runtime_expansions: Allowed attributes for runtime expansion.
807
427
expires: datetime.datetime(); time (UTC) when a client will be
808
428
disabled, or None
809
server_settings: The server_settings dict from main()
812
431
runtime_expansions = ("approval_delay", "approval_duration",
813
"created", "enabled", "expires",
814
"fingerprint", "host", "interval",
815
"last_approval_request", "last_checked_ok",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
816
434
"last_enabled", "name", "timeout")
819
"extended_timeout": "PT15M",
821
"checker": "fping -q -- %%(host)s",
823
"approval_delay": "PT0S",
824
"approval_duration": "PT1S",
825
"approved_by_default": "True",
435
client_defaults = { "timeout": "5m",
436
"extended_timeout": "15m",
438
"checker": "fping -q -- %%(host)s",
440
"approval_delay": "0s",
441
"approval_duration": "1s",
442
"approved_by_default": "True",
446
def timeout_milliseconds(self):
447
"Return the 'timeout' attribute in milliseconds"
448
return timedelta_to_milliseconds(self.timeout)
450
def extended_timeout_milliseconds(self):
451
"Return the 'extended_timeout' attribute in milliseconds"
452
return timedelta_to_milliseconds(self.extended_timeout)
454
def interval_milliseconds(self):
455
"Return the 'interval' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.interval)
458
def approval_delay_milliseconds(self):
459
return timedelta_to_milliseconds(self.approval_delay)
830
462
def config_parser(config):
831
463
"""Construct a new dict of client settings of this form:
964
598
def init_checker(self):
965
599
# Schedule a new checker to be started an 'interval' from now,
966
600
# and every interval from then on.
967
if self.checker_initiator_tag is not None:
968
GLib.source_remove(self.checker_initiator_tag)
969
self.checker_initiator_tag = GLib.timeout_add(
970
int(self.interval.total_seconds() * 1000),
601
self.checker_initiator_tag = (gobject.timeout_add
602
(self.interval_milliseconds(),
972
604
# Schedule a disable() when 'timeout' has passed
973
if self.disable_initiator_tag is not None:
974
GLib.source_remove(self.disable_initiator_tag)
975
self.disable_initiator_tag = GLib.timeout_add(
976
int(self.timeout.total_seconds() * 1000), self.disable)
605
self.disable_initiator_tag = (gobject.timeout_add
606
(self.timeout_milliseconds(),
977
608
# Also start a new checker *right now*.
978
609
self.start_checker()
980
def checker_callback(self, source, condition, connection,
611
def checker_callback(self, pid, condition, command):
982
612
"""The checker has completed, so take appropriate actions."""
983
613
self.checker_callback_tag = None
984
614
self.checker = None
985
# Read return code from connection (see call_pipe)
986
returncode = connection.recv()
990
self.last_checker_status = returncode
991
self.last_checker_signal = None
615
if os.WIFEXITED(condition):
616
self.last_checker_status = os.WEXITSTATUS(condition)
992
617
if self.last_checker_status == 0:
993
618
logger.info("Checker for %(name)s succeeded",
995
620
self.checked_ok()
997
logger.info("Checker for %(name)s failed", vars(self))
622
logger.info("Checker for %(name)s failed",
999
625
self.last_checker_status = -1
1000
self.last_checker_signal = -returncode
1001
626
logger.warning("Checker for %(name)s crashed?",
1005
629
def checked_ok(self):
1006
630
"""Assert that the client has been seen, alive and well."""
1007
631
self.last_checked_ok = datetime.datetime.utcnow()
1008
632
self.last_checker_status = 0
1009
self.last_checker_signal = None
1010
633
self.bump_timeout()
1012
635
def bump_timeout(self, timeout=None):
1030
653
If a checker already exists, leave it running and do
1032
655
# The reason for not killing a running checker is that if we
1033
# did that, and if a checker (for some reason) started running
1034
# slowly and taking more than 'interval' time, then the client
1035
# would inevitably timeout, since no checker would get a
1036
# chance to run to completion. If we instead leave running
656
# did that, then if a checker (for some reason) started
657
# running slowly and taking more than 'interval' time, the
658
# client would inevitably timeout, since no checker would get
659
# a chance to run to completion. If we instead leave running
1037
660
# checkers alone, the checker would have to take more time
1038
661
# than 'timeout' for the client to be disabled, which is as it
1041
if self.checker is not None and not self.checker.is_alive():
1042
logger.warning("Checker was not alive; joining")
664
# If a checker exists, make sure it is not a zombie
666
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
667
except (AttributeError, OSError) as error:
668
if (isinstance(error, OSError)
669
and error.errno != errno.ECHILD):
673
logger.warning("Checker was a zombie")
674
gobject.source_remove(self.checker_callback_tag)
675
self.checker_callback(pid, status,
676
self.current_checker_command)
1045
677
# Start a new checker if needed
1046
678
if self.checker is None:
1047
# Escape attributes for the shell
1049
attr: re.escape(str(getattr(self, attr)))
1050
for attr in self.runtime_expansions }
1052
command = self.checker_command % escaped_attrs
1053
except TypeError as error:
1054
logger.error('Could not format string "%s"',
1055
self.checker_command,
1057
return True # Try again later
680
# In case checker_command has exactly one % operator
681
command = self.checker_command % self.host
683
# Escape attributes for the shell
684
escaped_attrs = dict(
686
re.escape(unicode(str(getattr(self, attr, "")),
690
self.runtime_expansions)
693
command = self.checker_command % escaped_attrs
694
except TypeError as error:
695
logger.error('Could not format string "%s":'
696
' %s', self.checker_command, error)
697
return True # Try again later
1058
698
self.current_checker_command = command
1059
logger.info("Starting checker %r for %s", command,
1061
# We don't need to redirect stdout and stderr, since
1062
# in normal mode, that is already done by daemon(),
1063
# and in debug mode we don't want to. (Stdin is
1064
# always replaced by /dev/null.)
1065
# The exception is when not debugging but nevertheless
1066
# running in the foreground; use the previously
1068
popen_args = { "close_fds": True,
1071
if (not self.server_settings["debug"]
1072
and self.server_settings["foreground"]):
1073
popen_args.update({"stdout": wnull,
1075
pipe = multiprocessing.Pipe(duplex = False)
1076
self.checker = multiprocessing.Process(
1078
args = (pipe[1], subprocess.call, command),
1079
kwargs = popen_args)
1080
self.checker.start()
1081
self.checker_callback_tag = GLib.io_add_watch(
1082
pipe[0].fileno(), GLib.IO_IN,
1083
self.checker_callback, pipe[0], command)
1084
# Re-run this periodically if run by GLib.timeout_add
700
logger.info("Starting checker %r for %s",
702
# We don't need to redirect stdout and stderr, since
703
# in normal mode, that is already done by daemon(),
704
# and in debug mode we don't want to. (Stdin is
705
# always replaced by /dev/null.)
706
self.checker = subprocess.Popen(command,
709
self.checker_callback_tag = (gobject.child_watch_add
711
self.checker_callback,
713
# The checker may have completed before the gobject
714
# watch was added. Check for this.
715
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
717
gobject.source_remove(self.checker_callback_tag)
718
self.checker_callback(pid, status, command)
719
except OSError as error:
720
logger.error("Failed to start subprocess: %s",
722
# Re-run this periodically if run by gobject.timeout_add
1087
725
def stop_checker(self):
1088
726
"""Force the checker process, if any, to stop."""
1089
727
if self.checker_callback_tag:
1090
GLib.source_remove(self.checker_callback_tag)
728
gobject.source_remove(self.checker_callback_tag)
1091
729
self.checker_callback_tag = None
1092
730
if getattr(self, "checker", None) is None:
1094
732
logger.debug("Stopping checker for %(name)s", vars(self))
1095
self.checker.terminate()
734
os.kill(self.checker.pid, signal.SIGTERM)
736
#if self.checker.poll() is None:
737
# os.kill(self.checker.pid, signal.SIGKILL)
738
except OSError as error:
739
if error.errno != errno.ESRCH: # No such process
1096
741
self.checker = None
1099
def dbus_service_property(dbus_interface,
744
def dbus_service_property(dbus_interface, signature="v",
745
access="readwrite", byte_arrays=False):
1103
746
"""Decorators for marking methods of a DBusObjectWithProperties to
1104
747
become properties on the D-Bus.
1194
class DBusObjectWithAnnotations(dbus.service.Object):
1195
"""A D-Bus object with annotations.
1197
Classes inheriting from this can use the dbus_annotations
1198
decorator to add annotations to methods or signals.
1202
def _is_dbus_thing(thing):
1203
"""Returns a function testing if an attribute is a D-Bus thing
1205
If called like _is_dbus_thing("method") it returns a function
1206
suitable for use as predicate to inspect.getmembers().
1208
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1211
def _get_all_dbus_things(self, thing):
1212
"""Returns a generator of (name, attribute) pairs
1214
return ((getattr(athing.__get__(self), "_dbus_name", name),
1215
athing.__get__(self))
1216
for cls in self.__class__.__mro__
1218
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1220
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1221
out_signature = "s",
1222
path_keyword = 'object_path',
1223
connection_keyword = 'connection')
1224
def Introspect(self, object_path, connection):
1225
"""Overloading of standard D-Bus method.
1227
Inserts annotation tags on methods and signals.
1229
xmlstring = dbus.service.Object.Introspect(self, object_path,
1232
document = xml.dom.minidom.parseString(xmlstring)
1234
for if_tag in document.getElementsByTagName("interface"):
1235
# Add annotation tags
1236
for typ in ("method", "signal"):
1237
for tag in if_tag.getElementsByTagName(typ):
1239
for name, prop in (self.
1240
_get_all_dbus_things(typ)):
1241
if (name == tag.getAttribute("name")
1242
and prop._dbus_interface
1243
== if_tag.getAttribute("name")):
1244
annots.update(getattr(
1245
prop, "_dbus_annotations", {}))
1246
for name, value in annots.items():
1247
ann_tag = document.createElement(
1249
ann_tag.setAttribute("name", name)
1250
ann_tag.setAttribute("value", value)
1251
tag.appendChild(ann_tag)
1252
# Add interface annotation tags
1253
for annotation, value in dict(
1254
itertools.chain.from_iterable(
1255
annotations().items()
1256
for name, annotations
1257
in self._get_all_dbus_things("interface")
1258
if name == if_tag.getAttribute("name")
1260
ann_tag = document.createElement("annotation")
1261
ann_tag.setAttribute("name", annotation)
1262
ann_tag.setAttribute("value", value)
1263
if_tag.appendChild(ann_tag)
1264
# Fix argument name for the Introspect method itself
1265
if (if_tag.getAttribute("name")
1266
== dbus.INTROSPECTABLE_IFACE):
1267
for cn in if_tag.getElementsByTagName("method"):
1268
if cn.getAttribute("name") == "Introspect":
1269
for arg in cn.getElementsByTagName("arg"):
1270
if (arg.getAttribute("direction")
1272
arg.setAttribute("name",
1274
xmlstring = document.toxml("utf-8")
1276
except (AttributeError, xml.dom.DOMException,
1277
xml.parsers.expat.ExpatError) as error:
1278
logger.error("Failed to override Introspection method",
1283
class DBusObjectWithProperties(DBusObjectWithAnnotations):
793
class DBusObjectWithProperties(dbus.service.Object):
1284
794
"""A D-Bus object with properties.
1286
796
Classes inheriting from this can use the dbus_service_property
1366
876
if not hasattr(value, "variant_level"):
1367
877
properties[name] = value
1369
properties[name] = type(value)(
1370
value, variant_level = value.variant_level + 1)
879
properties[name] = type(value)(value, variant_level=
880
value.variant_level+1)
1371
881
return dbus.Dictionary(properties, signature="sv")
1373
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1374
def PropertiesChanged(self, interface_name, changed_properties,
1375
invalidated_properties):
1376
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1381
883
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1382
884
out_signature="s",
1383
885
path_keyword='object_path',
1384
886
connection_keyword='connection')
1385
887
def Introspect(self, object_path, connection):
1386
"""Overloading of standard D-Bus method.
1388
Inserts property tags and interface annotation tags.
888
"""Standard D-Bus method, overloaded to insert property tags.
1390
xmlstring = DBusObjectWithAnnotations.Introspect(self,
890
xmlstring = dbus.service.Object.Introspect(self, object_path,
1394
893
document = xml.dom.minidom.parseString(xmlstring)
1396
894
def make_tag(document, name, prop):
1397
895
e = document.createElement("property")
1398
896
e.setAttribute("name", name)
1399
897
e.setAttribute("type", prop._dbus_signature)
1400
898
e.setAttribute("access", prop._dbus_access)
1403
900
for if_tag in document.getElementsByTagName("interface"):
1405
901
for tag in (make_tag(document, name, prop)
1407
in self._get_all_dbus_things("property")
903
in self._get_all_dbus_properties()
1408
904
if prop._dbus_interface
1409
905
== if_tag.getAttribute("name")):
1410
906
if_tag.appendChild(tag)
1411
# Add annotation tags for properties
1412
for tag in if_tag.getElementsByTagName("property"):
1414
for name, prop in self._get_all_dbus_things(
1416
if (name == tag.getAttribute("name")
1417
and prop._dbus_interface
1418
== if_tag.getAttribute("name")):
1419
annots.update(getattr(
1420
prop, "_dbus_annotations", {}))
1421
for name, value in annots.items():
1422
ann_tag = document.createElement(
1424
ann_tag.setAttribute("name", name)
1425
ann_tag.setAttribute("value", value)
1426
tag.appendChild(ann_tag)
1427
907
# Add the names to the return values for the
1428
908
# "org.freedesktop.DBus.Properties" methods
1429
909
if (if_tag.getAttribute("name")
1444
924
except (AttributeError, xml.dom.DOMException,
1445
925
xml.parsers.expat.ExpatError) as error:
1446
926
logger.error("Failed to override Introspection method",
1451
dbus.OBJECT_MANAGER_IFACE
1452
except AttributeError:
1453
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1455
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1456
"""A D-Bus object with an ObjectManager.
1458
Classes inheriting from this exposes the standard
1459
GetManagedObjects call and the InterfacesAdded and
1460
InterfacesRemoved signals on the standard
1461
"org.freedesktop.DBus.ObjectManager" interface.
1463
Note: No signals are sent automatically; they must be sent
1466
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1467
out_signature = "a{oa{sa{sv}}}")
1468
def GetManagedObjects(self):
1469
"""This function must be overridden"""
1470
raise NotImplementedError()
1472
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1473
signature = "oa{sa{sv}}")
1474
def InterfacesAdded(self, object_path, interfaces_and_properties):
1477
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1478
def InterfacesRemoved(self, object_path, interfaces):
1481
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1482
out_signature = "s",
1483
path_keyword = 'object_path',
1484
connection_keyword = 'connection')
1485
def Introspect(self, object_path, connection):
1486
"""Overloading of standard D-Bus method.
1488
Override return argument name of GetManagedObjects to be
1489
"objpath_interfaces_and_properties"
1491
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1495
document = xml.dom.minidom.parseString(xmlstring)
1497
for if_tag in document.getElementsByTagName("interface"):
1498
# Fix argument name for the GetManagedObjects method
1499
if (if_tag.getAttribute("name")
1500
== dbus.OBJECT_MANAGER_IFACE):
1501
for cn in if_tag.getElementsByTagName("method"):
1502
if (cn.getAttribute("name")
1503
== "GetManagedObjects"):
1504
for arg in cn.getElementsByTagName("arg"):
1505
if (arg.getAttribute("direction")
1509
"objpath_interfaces"
1511
xmlstring = document.toxml("utf-8")
1513
except (AttributeError, xml.dom.DOMException,
1514
xml.parsers.expat.ExpatError) as error:
1515
logger.error("Failed to override Introspection method",
1519
def datetime_to_dbus(dt, variant_level=0):
931
def datetime_to_dbus (dt, variant_level=0):
1520
932
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1522
934
return dbus.String("", variant_level = variant_level)
1523
return dbus.String(dt.isoformat(), variant_level=variant_level)
1526
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1527
"""A class decorator; applied to a subclass of
1528
dbus.service.Object, it will add alternate D-Bus attributes with
1529
interface names according to the "alt_interface_names" mapping.
1532
@alternate_dbus_interfaces({"org.example.Interface":
1533
"net.example.AlternateInterface"})
1534
class SampleDBusObject(dbus.service.Object):
1535
@dbus.service.method("org.example.Interface")
1536
def SampleDBusMethod():
1539
The above "SampleDBusMethod" on "SampleDBusObject" will be
1540
reachable via two interfaces: "org.example.Interface" and
1541
"net.example.AlternateInterface", the latter of which will have
1542
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1543
"true", unless "deprecate" is passed with a False value.
1545
This works for methods and signals, and also for D-Bus properties
1546
(from DBusObjectWithProperties) and interfaces (from the
1547
dbus_interface_annotations decorator).
935
return dbus.String(dt.isoformat(),
936
variant_level=variant_level)
939
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
941
"""Applied to an empty subclass of a D-Bus object, this metaclass
942
will add additional D-Bus attributes matching a certain pattern.
1551
for orig_interface_name, alt_interface_name in (
1552
alt_interface_names.items()):
1554
interface_names = set()
1555
# Go though all attributes of the class
1556
for attrname, attribute in inspect.getmembers(cls):
944
def __new__(mcs, name, bases, attr):
945
# Go through all the base classes which could have D-Bus
946
# methods, signals, or properties in them
947
for base in (b for b in bases
948
if issubclass(b, dbus.service.Object)):
949
# Go though all attributes of the base class
950
for attrname, attribute in inspect.getmembers(base):
1557
951
# Ignore non-D-Bus attributes, and D-Bus attributes
1558
952
# with the wrong interface name
1559
953
if (not hasattr(attribute, "_dbus_interface")
1560
or not attribute._dbus_interface.startswith(
1561
orig_interface_name)):
954
or not attribute._dbus_interface
955
.startswith("se.recompile.Mandos")):
1563
957
# Create an alternate D-Bus interface name based on
1564
958
# the current name
1565
alt_interface = attribute._dbus_interface.replace(
1566
orig_interface_name, alt_interface_name)
1567
interface_names.add(alt_interface)
959
alt_interface = (attribute._dbus_interface
960
.replace("se.recompile.Mandos",
961
"se.bsnet.fukt.Mandos"))
1568
962
# Is this a D-Bus signal?
1569
963
if getattr(attribute, "_dbus_is_signal", False):
1570
# Extract the original non-method undecorated
1571
# function by black magic
1572
if sys.version_info.major == 2:
1573
nonmethod_func = (dict(
964
# Extract the original non-method function by
966
nonmethod_func = (dict(
1574
967
zip(attribute.func_code.co_freevars,
1575
attribute.__closure__))
1576
["func"].cell_contents)
1578
nonmethod_func = (dict(
1579
zip(attribute.__code__.co_freevars,
1580
attribute.__closure__))
1581
["func"].cell_contents)
968
attribute.__closure__))["func"]
1582
970
# Create a new, but exactly alike, function
1583
971
# object, and decorate it to be a new D-Bus signal
1584
972
# with the alternate D-Bus interface name
1585
new_function = copy_function(nonmethod_func)
1586
new_function = (dbus.service.signal(
1588
attribute._dbus_signature)(new_function))
1589
# Copy annotations, if any
1591
new_function._dbus_annotations = dict(
1592
attribute._dbus_annotations)
1593
except AttributeError:
973
new_function = (dbus.service.signal
975
attribute._dbus_signature)
977
nonmethod_func.func_code,
978
nonmethod_func.func_globals,
979
nonmethod_func.func_name,
980
nonmethod_func.func_defaults,
981
nonmethod_func.func_closure)))
1595
982
# Define a creator of a function to call both the
1596
# original and alternate functions, so both the
1597
# original and alternate signals gets sent when
1598
# the function is called
983
# old and new functions, so both the old and new
984
# signals gets sent when the function is called
1599
985
def fixscope(func1, func2):
1600
986
"""This function is a scope container to pass
1601
987
func1 and func2 to the "call_both" function
1602
988
outside of its arguments"""
1604
@functools.wraps(func2)
1605
989
def call_both(*args, **kwargs):
1606
990
"""This function will emit two D-Bus
1607
991
signals by calling func1 and func2"""
1608
992
func1(*args, **kwargs)
1609
993
func2(*args, **kwargs)
1610
# Make wrapper function look like a D-Bus signal
1611
for name, attr in inspect.getmembers(func2):
1612
if name.startswith("_dbus_"):
1613
setattr(call_both, name, attr)
1615
994
return call_both
1616
995
# Create the "call_both" function and add it to
1618
attr[attrname] = fixscope(attribute, new_function)
997
attr[attrname] = fixscope(attribute,
1619
999
# Is this a D-Bus method?
1620
1000
elif getattr(attribute, "_dbus_is_method", False):
1621
1001
# Create a new, but exactly alike, function
1622
1002
# object. Decorate it to be a new D-Bus method
1623
1003
# with the alternate D-Bus interface name. Add it
1624
1004
# to the class.
1626
dbus.service.method(
1628
attribute._dbus_in_signature,
1629
attribute._dbus_out_signature)
1630
(copy_function(attribute)))
1631
# Copy annotations, if any
1633
attr[attrname]._dbus_annotations = dict(
1634
attribute._dbus_annotations)
1635
except AttributeError:
1005
attr[attrname] = (dbus.service.method
1007
attribute._dbus_in_signature,
1008
attribute._dbus_out_signature)
1010
(attribute.func_code,
1011
attribute.func_globals,
1012
attribute.func_name,
1013
attribute.func_defaults,
1014
attribute.func_closure)))
1637
1015
# Is this a D-Bus property?
1638
1016
elif getattr(attribute, "_dbus_is_property", False):
1639
1017
# Create a new, but exactly alike, function
1640
1018
# object, and decorate it to be a new D-Bus
1641
1019
# property with the alternate D-Bus interface
1642
1020
# name. Add it to the class.
1643
attr[attrname] = (dbus_service_property(
1644
alt_interface, attribute._dbus_signature,
1645
attribute._dbus_access,
1646
attribute._dbus_get_args_options
1648
(copy_function(attribute)))
1649
# Copy annotations, if any
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1653
except AttributeError:
1655
# Is this a D-Bus interface?
1656
elif getattr(attribute, "_dbus_is_interface", False):
1657
# Create a new, but exactly alike, function
1658
# object. Decorate it to be a new D-Bus interface
1659
# with the alternate D-Bus interface name. Add it
1662
dbus_interface_annotations(alt_interface)
1663
(copy_function(attribute)))
1665
# Deprecate all alternate interfaces
1666
iname="_AlternateDBusNames_interface_annotation{}"
1667
for interface_name in interface_names:
1669
@dbus_interface_annotations(interface_name)
1671
return { "org.freedesktop.DBus.Deprecated":
1673
# Find an unused name
1674
for aname in (iname.format(i)
1675
for i in itertools.count()):
1676
if aname not in attr:
1680
# Replace the class with a new subclass of it with
1681
# methods, signals, etc. as created above.
1682
if sys.version_info.major == 2:
1683
cls = type(b"{}Alternate".format(cls.__name__),
1686
cls = type("{}Alternate".format(cls.__name__),
1693
@alternate_dbus_interfaces({"se.recompile.Mandos":
1694
"se.bsnet.fukt.Mandos"})
1021
attr[attrname] = (dbus_service_property
1023
attribute._dbus_signature,
1024
attribute._dbus_access,
1026
._dbus_get_args_options
1029
(attribute.func_code,
1030
attribute.func_globals,
1031
attribute.func_name,
1032
attribute.func_defaults,
1033
attribute.func_closure)))
1034
return type.__new__(mcs, name, bases, attr)
1695
1037
class ClientDBus(Client, DBusObjectWithProperties):
1696
1038
"""A Client class using D-Bus
1954
1278
self.approved_by_default = bool(value)
1956
1280
# ApprovalDelay - property
1957
@dbus_service_property(_interface,
1281
@dbus_service_property(_interface, signature="t",
1959
1282
access="readwrite")
1960
1283
def ApprovalDelay_dbus_property(self, value=None):
1961
1284
if value is None: # get
1962
return dbus.UInt64(self.approval_delay.total_seconds()
1285
return dbus.UInt64(self.approval_delay_milliseconds())
1964
1286
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1966
1288
# ApprovalDuration - property
1967
@dbus_service_property(_interface,
1289
@dbus_service_property(_interface, signature="t",
1969
1290
access="readwrite")
1970
1291
def ApprovalDuration_dbus_property(self, value=None):
1971
1292
if value is None: # get
1972
return dbus.UInt64(self.approval_duration.total_seconds()
1293
return dbus.UInt64(timedelta_to_milliseconds(
1294
self.approval_duration))
1974
1295
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1976
1297
# Name - property
1978
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1979
1298
@dbus_service_property(_interface, signature="s", access="read")
1980
1299
def Name_dbus_property(self):
1981
1300
return dbus.String(self.name)
1983
1302
# Fingerprint - property
1985
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1986
1303
@dbus_service_property(_interface, signature="s", access="read")
1987
1304
def Fingerprint_dbus_property(self):
1988
1305
return dbus.String(self.fingerprint)
1990
1307
# Host - property
1991
@dbus_service_property(_interface,
1308
@dbus_service_property(_interface, signature="s",
1993
1309
access="readwrite")
1994
1310
def Host_dbus_property(self, value=None):
1995
1311
if value is None: # get
1996
1312
return dbus.String(self.host)
1997
self.host = str(value)
1313
self.host = unicode(value)
1999
1315
# Created - property
2001
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2002
1316
@dbus_service_property(_interface, signature="s", access="read")
2003
1317
def Created_dbus_property(self):
2004
1318
return datetime_to_dbus(self.created)
2046
1359
return datetime_to_dbus(self.last_approval_request)
2048
1361
# Timeout - property
2049
@dbus_service_property(_interface,
1362
@dbus_service_property(_interface, signature="t",
2051
1363
access="readwrite")
2052
1364
def Timeout_dbus_property(self, value=None):
2053
1365
if value is None: # get
2054
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2055
old_timeout = self.timeout
1366
return dbus.UInt64(self.timeout_milliseconds())
2056
1367
self.timeout = datetime.timedelta(0, 0, 0, value)
2057
# Reschedule disabling
1368
# Reschedule timeout
2058
1369
if self.enabled:
2059
1370
now = datetime.datetime.utcnow()
2060
self.expires += self.timeout - old_timeout
2061
if self.expires <= now:
1371
time_to_die = timedelta_to_milliseconds(
1372
(self.last_checked_ok + self.timeout) - now)
1373
if time_to_die <= 0:
2062
1374
# The timeout has passed
1377
self.expires = (now +
1378
datetime.timedelta(milliseconds =
2065
1380
if (getattr(self, "disable_initiator_tag", None)
2068
GLib.source_remove(self.disable_initiator_tag)
2069
self.disable_initiator_tag = GLib.timeout_add(
2070
int((self.expires - now).total_seconds() * 1000),
1383
gobject.source_remove(self.disable_initiator_tag)
1384
self.disable_initiator_tag = (gobject.timeout_add
2073
1388
# ExtendedTimeout - property
2074
@dbus_service_property(_interface,
1389
@dbus_service_property(_interface, signature="t",
2076
1390
access="readwrite")
2077
1391
def ExtendedTimeout_dbus_property(self, value=None):
2078
1392
if value is None: # get
2079
return dbus.UInt64(self.extended_timeout.total_seconds()
1393
return dbus.UInt64(self.extended_timeout_milliseconds())
2081
1394
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2083
1396
# Interval - property
2084
@dbus_service_property(_interface,
1397
@dbus_service_property(_interface, signature="t",
2086
1398
access="readwrite")
2087
1399
def Interval_dbus_property(self, value=None):
2088
1400
if value is None: # get
2089
return dbus.UInt64(self.interval.total_seconds() * 1000)
1401
return dbus.UInt64(self.interval_milliseconds())
2090
1402
self.interval = datetime.timedelta(0, 0, 0, value)
2091
1403
if getattr(self, "checker_initiator_tag", None) is None:
2093
1405
if self.enabled:
2094
1406
# Reschedule checker run
2095
GLib.source_remove(self.checker_initiator_tag)
2096
self.checker_initiator_tag = GLib.timeout_add(
2097
value, self.start_checker)
2098
self.start_checker() # Start one now, too
1407
gobject.source_remove(self.checker_initiator_tag)
1408
self.checker_initiator_tag = (gobject.timeout_add
1409
(value, self.start_checker))
1410
self.start_checker() # Start one now, too
2100
1412
# Checker - property
2101
@dbus_service_property(_interface,
1413
@dbus_service_property(_interface, signature="s",
2103
1414
access="readwrite")
2104
1415
def Checker_dbus_property(self, value=None):
2105
1416
if value is None: # get
2106
1417
return dbus.String(self.checker_command)
2107
self.checker_command = str(value)
1418
self.checker_command = unicode(value)
2109
1420
# CheckerRunning - property
2110
@dbus_service_property(_interface,
1421
@dbus_service_property(_interface, signature="b",
2112
1422
access="readwrite")
2113
1423
def CheckerRunning_dbus_property(self, value=None):
2114
1424
if value is None: # get
2330
1652
def fingerprint(openpgp):
2331
1653
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2332
1654
# New GnuTLS "datum" with the OpenPGP public key
2333
datum = gnutls.datum_t(
2334
ctypes.cast(ctypes.c_char_p(openpgp),
2335
ctypes.POINTER(ctypes.c_ubyte)),
2336
ctypes.c_uint(len(openpgp)))
1655
datum = (gnutls.library.types
1656
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1659
ctypes.c_uint(len(openpgp))))
2337
1660
# New empty GnuTLS certificate
2338
crt = gnutls.openpgp_crt_t()
2339
gnutls.openpgp_crt_init(ctypes.byref(crt))
1661
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1662
(gnutls.library.functions
1663
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2340
1664
# Import the OpenPGP public key into the certificate
2341
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2342
gnutls.OPENPGP_FMT_RAW)
1665
(gnutls.library.functions
1666
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1667
gnutls.library.constants
1668
.GNUTLS_OPENPGP_FMT_RAW))
2343
1669
# Verify the self signature in the key
2344
1670
crtverify = ctypes.c_uint()
2345
gnutls.openpgp_crt_verify_self(crt, 0,
2346
ctypes.byref(crtverify))
1671
(gnutls.library.functions
1672
.gnutls_openpgp_crt_verify_self(crt, 0,
1673
ctypes.byref(crtverify)))
2347
1674
if crtverify.value != 0:
2348
gnutls.openpgp_crt_deinit(crt)
2349
raise gnutls.CertificateSecurityError("Verify failed")
1675
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1676
raise (gnutls.errors.CertificateSecurityError
2350
1678
# New buffer for the fingerprint
2351
1679
buf = ctypes.create_string_buffer(20)
2352
1680
buf_len = ctypes.c_size_t()
2353
1681
# Get the fingerprint from the certificate into the buffer
2354
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2355
ctypes.byref(buf_len))
1682
(gnutls.library.functions
1683
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1684
ctypes.byref(buf_len)))
2356
1685
# Deinit the certificate
2357
gnutls.openpgp_crt_deinit(crt)
1686
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2358
1687
# Convert the buffer to a Python bytestring
2359
1688
fpr = ctypes.string_at(buf, buf_len.value)
2360
1689
# Convert the bytestring to hexadecimal notation
2409
1737
interface: None or a network interface name (string)
2410
1738
use_ipv6: Boolean; to use IPv6 or not
2413
1740
def __init__(self, server_address, RequestHandlerClass,
2417
"""If socketfd is set, use that file descriptor instead of
2418
creating a new one with socket.socket().
1741
interface=None, use_ipv6=True):
2420
1742
self.interface = interface
2422
1744
self.address_family = socket.AF_INET6
2423
if socketfd is not None:
2424
# Save the file descriptor
2425
self.socketfd = socketfd
2426
# Save the original socket.socket() function
2427
self.socket_socket = socket.socket
2428
# To implement --socket, we monkey patch socket.socket.
2430
# (When socketserver.TCPServer is a new-style class, we
2431
# could make self.socket into a property instead of monkey
2432
# patching socket.socket.)
2434
# Create a one-time-only replacement for socket.socket()
2435
@functools.wraps(socket.socket)
2436
def socket_wrapper(*args, **kwargs):
2437
# Restore original function so subsequent calls are
2439
socket.socket = self.socket_socket
2440
del self.socket_socket
2441
# This time only, return a new socket object from the
2442
# saved file descriptor.
2443
return socket.fromfd(self.socketfd, *args, **kwargs)
2444
# Replace socket.socket() function with wrapper
2445
socket.socket = socket_wrapper
2446
# The socketserver.TCPServer.__init__ will call
2447
# socket.socket(), which might be our replacement,
2448
# socket_wrapper(), if socketfd was set.
2449
1745
socketserver.TCPServer.__init__(self, server_address,
2450
1746
RequestHandlerClass)
2452
1747
def server_bind(self):
2453
1748
"""This overrides the normal server_bind() function
2454
1749
to bind to an interface if one was specified, and also NOT to
2455
1750
bind to an address or port if they were not specified."""
2456
global SO_BINDTODEVICE
2457
1751
if self.interface is not None:
2458
1752
if SO_BINDTODEVICE is None:
2459
# Fall back to a hard-coded value which seems to be
2461
logger.warning("SO_BINDTODEVICE not found, trying 25")
2462
SO_BINDTODEVICE = 25
2464
self.socket.setsockopt(
2465
socket.SOL_SOCKET, SO_BINDTODEVICE,
2466
(self.interface + "\0").encode("utf-8"))
2467
except socket.error as error:
2468
if error.errno == errno.EPERM:
2469
logger.error("No permission to bind to"
2470
" interface %s", self.interface)
2471
elif error.errno == errno.ENOPROTOOPT:
2472
logger.error("SO_BINDTODEVICE not available;"
2473
" cannot bind to interface %s",
2475
elif error.errno == errno.ENODEV:
2476
logger.error("Interface %s does not exist,"
2477
" cannot bind", self.interface)
1753
logger.error("SO_BINDTODEVICE does not exist;"
1754
" cannot bind to interface %s",
1758
self.socket.setsockopt(socket.SOL_SOCKET,
1762
except socket.error as error:
1763
if error[0] == errno.EPERM:
1764
logger.error("No permission to"
1765
" bind to interface %s",
1767
elif error[0] == errno.ENOPROTOOPT:
1768
logger.error("SO_BINDTODEVICE not available;"
1769
" cannot bind to interface %s",
2480
1773
# Only bind(2) the socket if we really need to.
2481
1774
if self.server_address[0] or self.server_address[1]:
2482
1775
if not self.server_address[0]:
2483
1776
if self.address_family == socket.AF_INET6:
2484
1777
any_address = "::" # in6addr_any
2486
any_address = "0.0.0.0" # INADDR_ANY
1779
any_address = socket.INADDR_ANY
2487
1780
self.server_address = (any_address,
2488
1781
self.server_address[1])
2489
1782
elif not self.server_address[1]:
2490
self.server_address = (self.server_address[0], 0)
1783
self.server_address = (self.server_address[0],
2491
1785
# if self.interface:
2492
1786
# self.server_address = (self.server_address[0],
2615
def rfc3339_duration_to_delta(duration):
2616
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2618
>>> rfc3339_duration_to_delta("P7D")
2619
datetime.timedelta(7)
2620
>>> rfc3339_duration_to_delta("PT60S")
2621
datetime.timedelta(0, 60)
2622
>>> rfc3339_duration_to_delta("PT60M")
2623
datetime.timedelta(0, 3600)
2624
>>> rfc3339_duration_to_delta("PT24H")
2625
datetime.timedelta(1)
2626
>>> rfc3339_duration_to_delta("P1W")
2627
datetime.timedelta(7)
2628
>>> rfc3339_duration_to_delta("PT5M30S")
2629
datetime.timedelta(0, 330)
2630
>>> rfc3339_duration_to_delta("P1DT3M20S")
2631
datetime.timedelta(1, 200)
2634
# Parsing an RFC 3339 duration with regular expressions is not
2635
# possible - there would have to be multiple places for the same
2636
# values, like seconds. The current code, while more esoteric, is
2637
# cleaner without depending on a parsing library. If Python had a
2638
# built-in library for parsing we would use it, but we'd like to
2639
# avoid excessive use of external libraries.
2641
# New type for defining tokens, syntax, and semantics all-in-one
2642
Token = collections.namedtuple("Token", (
2643
"regexp", # To match token; if "value" is not None, must have
2644
# a "group" containing digits
2645
"value", # datetime.timedelta or None
2646
"followers")) # Tokens valid after this token
2647
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2648
# the "duration" ABNF definition in RFC 3339, Appendix A.
2649
token_end = Token(re.compile(r"$"), None, frozenset())
2650
token_second = Token(re.compile(r"(\d+)S"),
2651
datetime.timedelta(seconds=1),
2652
frozenset((token_end, )))
2653
token_minute = Token(re.compile(r"(\d+)M"),
2654
datetime.timedelta(minutes=1),
2655
frozenset((token_second, token_end)))
2656
token_hour = Token(re.compile(r"(\d+)H"),
2657
datetime.timedelta(hours=1),
2658
frozenset((token_minute, token_end)))
2659
token_time = Token(re.compile(r"T"),
2661
frozenset((token_hour, token_minute,
2663
token_day = Token(re.compile(r"(\d+)D"),
2664
datetime.timedelta(days=1),
2665
frozenset((token_time, token_end)))
2666
token_month = Token(re.compile(r"(\d+)M"),
2667
datetime.timedelta(weeks=4),
2668
frozenset((token_day, token_end)))
2669
token_year = Token(re.compile(r"(\d+)Y"),
2670
datetime.timedelta(weeks=52),
2671
frozenset((token_month, token_end)))
2672
token_week = Token(re.compile(r"(\d+)W"),
2673
datetime.timedelta(weeks=1),
2674
frozenset((token_end, )))
2675
token_duration = Token(re.compile(r"P"), None,
2676
frozenset((token_year, token_month,
2677
token_day, token_time,
2679
# Define starting values
2680
value = datetime.timedelta() # Value so far
2682
followers = frozenset((token_duration, )) # Following valid tokens
2683
s = duration # String left to parse
2684
# Loop until end token is found
2685
while found_token is not token_end:
2686
# Search for any currently valid tokens
2687
for token in followers:
2688
match = token.regexp.match(s)
2689
if match is not None:
2691
if token.value is not None:
2692
# Value found, parse digits
2693
factor = int(match.group(1), 10)
2694
# Add to value so far
2695
value += factor * token.value
2696
# Strip token from string
2697
s = token.regexp.sub("", s, 1)
2700
# Set valid next tokens
2701
followers = found_token.followers
2704
# No currently valid tokens were found
2705
raise ValueError("Invalid RFC 3339 duration: {!r}"
2711
1914
def string_to_delta(interval):
2712
1915
"""Parse a string and return a datetime.timedelta
2842
2030
"debug": "False",
2844
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2845
":+SIGN-DSA-SHA256",
2032
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2846
2033
"servicename": "Mandos",
2847
2034
"use_dbus": "True",
2848
2035
"use_ipv6": "True",
2849
2036
"debuglevel": "",
2850
2037
"restore": "True",
2852
"statedir": "/var/lib/mandos",
2853
"foreground": "False",
2038
"statedir": "/var/lib/mandos"
2857
2041
# Parse config file for server-global settings
2858
2042
server_config = configparser.SafeConfigParser(server_defaults)
2859
2043
del server_defaults
2860
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2044
server_config.read(os.path.join(options.configdir,
2861
2046
# Convert the SafeConfigParser object to a dict
2862
2047
server_settings = server_config.defaults()
2863
2048
# Use the appropriate methods on the non-string config options
2864
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2049
for option in ("debug", "use_dbus", "use_ipv6"):
2865
2050
server_settings[option] = server_config.getboolean("DEFAULT",
2867
2052
if server_settings["port"]:
2868
2053
server_settings["port"] = server_config.getint("DEFAULT",
2870
if server_settings["socket"]:
2871
server_settings["socket"] = server_config.getint("DEFAULT",
2873
# Later, stdin will, and stdout and stderr might, be dup'ed
2874
# over with an opened os.devnull. But we don't want this to
2875
# happen with a supplied network socket.
2876
if 0 <= server_settings["socket"] <= 2:
2877
server_settings["socket"] = os.dup(server_settings
2879
2055
del server_config
2881
2057
# Override the settings from the config file with command line
2882
2058
# options, if set.
2883
2059
for option in ("interface", "address", "port", "debug",
2884
"priority", "servicename", "configdir", "use_dbus",
2885
"use_ipv6", "debuglevel", "restore", "statedir",
2886
"socket", "foreground", "zeroconf"):
2060
"priority", "servicename", "configdir",
2061
"use_dbus", "use_ipv6", "debuglevel", "restore",
2887
2063
value = getattr(options, option)
2888
2064
if value is not None:
2889
2065
server_settings[option] = value
2891
2067
# Force all strings to be unicode
2892
2068
for option in server_settings.keys():
2893
if isinstance(server_settings[option], bytes):
2894
server_settings[option] = (server_settings[option]
2896
# Force all boolean options to be boolean
2897
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2898
"foreground", "zeroconf"):
2899
server_settings[option] = bool(server_settings[option])
2900
# Debug implies foreground
2901
if server_settings["debug"]:
2902
server_settings["foreground"] = True
2069
if type(server_settings[option]) is str:
2070
server_settings[option] = unicode(server_settings[option])
2903
2071
# Now we have our good server settings in "server_settings"
2905
2073
##################################################################
2907
if (not server_settings["zeroconf"]
2908
and not (server_settings["port"]
2909
or server_settings["socket"] != "")):
2910
parser.error("Needs port or socket to work without Zeroconf")
2912
2075
# For convenience
2913
2076
debug = server_settings["debug"]
2914
2077
debuglevel = server_settings["debuglevel"]
2943
2104
global mandos_dbus_service
2944
2105
mandos_dbus_service = None
2947
if server_settings["socket"] != "":
2948
socketfd = server_settings["socket"]
2949
tcp_server = MandosServer(
2950
(server_settings["address"], server_settings["port"]),
2952
interface=(server_settings["interface"] or None),
2954
gnutls_priority=server_settings["priority"],
2958
pidfilename = "/run/mandos.pid"
2959
if not os.path.isdir("/run/."):
2960
pidfilename = "/var/run/mandos.pid"
2107
tcp_server = MandosServer((server_settings["address"],
2108
server_settings["port"]),
2110
interface=(server_settings["interface"]
2114
server_settings["priority"],
2117
pidfilename = "/var/run/mandos.pid"
2963
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2964
except IOError as e:
2965
logger.error("Could not open file %r", pidfilename,
2119
pidfile = open(pidfilename, "w")
2121
logger.error("Could not open file %r", pidfilename)
2968
for name, group in (("_mandos", "_mandos"),
2969
("mandos", "mandos"),
2970
("nobody", "nogroup")):
2124
uid = pwd.getpwnam("_mandos").pw_uid
2125
gid = pwd.getpwnam("_mandos").pw_gid
2972
uid = pwd.getpwnam(name).pw_uid
2973
gid = pwd.getpwnam(group).pw_gid
2128
uid = pwd.getpwnam("mandos").pw_uid
2129
gid = pwd.getpwnam("mandos").pw_gid
2975
2130
except KeyError:
2132
uid = pwd.getpwnam("nobody").pw_uid
2133
gid = pwd.getpwnam("nobody").pw_gid
2984
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2986
2140
except OSError as error:
2987
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2988
.format(uid, gid, os.strerror(error.errno)))
2989
if error.errno != errno.EPERM:
2141
if error[0] != errno.EPERM:
2993
2145
# Enable all possible GnuTLS debugging
2995
2147
# "Use a log level over 10 to enable all debugging options."
2996
2148
# - GnuTLS manual
2997
gnutls.global_set_log_level(11)
2149
gnutls.library.functions.gnutls_global_set_log_level(11)
2151
@gnutls.library.types.gnutls_log_func
3000
2152
def debug_gnutls(level, string):
3001
2153
logger.debug("GnuTLS: %s", string[:-1])
3003
gnutls.global_set_log_function(debug_gnutls)
2155
(gnutls.library.functions
2156
.gnutls_global_set_log_function(debug_gnutls))
3005
2158
# Redirect stdin so all checkers get /dev/null
3006
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2159
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3007
2160
os.dup2(null, sys.stdin.fileno())
3011
2164
# Need to fork before connecting to D-Bus
3013
2166
# Close all input and output, do double fork, etc.
3016
# multiprocessing will use threads, so before we use GLib we need
3017
# to inform GLib that threads will be used.
2169
gobject.threads_init()
3020
2171
global main_loop
3021
2172
# From the Avahi example code
3022
DBusGMainLoop(set_as_default=True)
3023
main_loop = GLib.MainLoop()
2173
DBusGMainLoop(set_as_default=True )
2174
main_loop = gobject.MainLoop()
3024
2175
bus = dbus.SystemBus()
3025
2176
# End of Avahi example code
3028
2179
bus_name = dbus.service.BusName("se.recompile.Mandos",
3031
old_bus_name = dbus.service.BusName(
3032
"se.bsnet.fukt.Mandos", bus,
3034
except dbus.exceptions.DBusException as e:
3035
logger.error("Disabling D-Bus:", exc_info=e)
2180
bus, do_not_queue=True)
2181
old_bus_name = (dbus.service.BusName
2182
("se.bsnet.fukt.Mandos", bus,
2184
except dbus.exceptions.NameExistsException as e:
2185
logger.error(unicode(e) + ", disabling D-Bus")
3036
2186
use_dbus = False
3037
2187
server_settings["use_dbus"] = False
3038
2188
tcp_server.use_dbus = False
3040
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3041
service = AvahiServiceToSyslog(
3042
name = server_settings["servicename"],
3043
servicetype = "_mandos._tcp",
3044
protocol = protocol,
3046
if server_settings["interface"]:
3047
service.interface = if_nametoindex(
3048
server_settings["interface"].encode("utf-8"))
2189
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2190
service = AvahiServiceToSyslog(name =
2191
server_settings["servicename"],
2192
servicetype = "_mandos._tcp",
2193
protocol = protocol, bus = bus)
2194
if server_settings["interface"]:
2195
service.interface = (if_nametoindex
2196
(str(server_settings["interface"])))
3050
2198
global multiprocessing_manager
3051
2199
multiprocessing_manager = multiprocessing.Manager()
3053
2201
client_class = Client
3055
client_class = functools.partial(ClientDBus, bus = bus)
2203
client_class = functools.partial(ClientDBusTransitional,
3057
2206
client_settings = Client.config_parser(client_config)
3058
2207
old_client_settings = {}
3059
2208
clients_data = {}
3061
# This is used to redirect stdout and stderr for checker processes
3063
wnull = open(os.devnull, "w") # A writable /dev/null
3064
# Only used if server is running in foreground but not in debug
3066
if debug or not foreground:
3069
2210
# Get client data and settings from last running state.
3070
2211
if server_settings["restore"]:
3072
2213
with open(stored_state_path, "rb") as stored_state:
3073
if sys.version_info.major == 2:
3074
clients_data, old_client_settings = pickle.load(
3077
bytes_clients_data, bytes_old_client_settings = (
3078
pickle.load(stored_state, encoding = "bytes"))
3079
### Fix bytes to strings
3082
clients_data = { (key.decode("utf-8")
3083
if isinstance(key, bytes)
3086
bytes_clients_data.items() }
3087
del bytes_clients_data
3088
for key in clients_data:
3089
value = { (k.decode("utf-8")
3090
if isinstance(k, bytes) else k): v
3092
clients_data[key].items() }
3093
clients_data[key] = value
3095
value["client_structure"] = [
3097
if isinstance(s, bytes)
3099
value["client_structure"] ]
3101
for k in ("name", "host"):
3102
if isinstance(value[k], bytes):
3103
value[k] = value[k].decode("utf-8")
3104
## old_client_settings
3106
old_client_settings = {
3107
(key.decode("utf-8")
3108
if isinstance(key, bytes)
3111
bytes_old_client_settings.items() }
3112
del bytes_old_client_settings
3114
for value in old_client_settings.values():
3115
if isinstance(value["host"], bytes):
3116
value["host"] = (value["host"]
2214
clients_data, old_client_settings = (pickle.load
3118
2216
os.remove(stored_state_path)
3119
2217
except IOError as e:
3120
if e.errno == errno.ENOENT:
3121
logger.warning("Could not load persistent state:"
3122
" {}".format(os.strerror(e.errno)))
3124
logger.critical("Could not load persistent state:",
2218
logger.warning("Could not load persistent state: {0}"
2220
if e.errno != errno.ENOENT:
3127
2222
except EOFError as e:
3128
2223
logger.warning("Could not load persistent state: "
2224
"EOFError: {0}".format(e))
3132
2226
with PGPEngine() as pgp:
3133
for client_name, client in clients_data.items():
3134
# Skip removed clients
3135
if client_name not in client_settings:
2227
for client_name, client in clients_data.iteritems():
3138
2228
# Decide which value to use after restoring saved state.
3139
2229
# We have three different values: Old config file,
3140
2230
# new config file, and saved state.
3250
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3252
2336
@dbus.service.signal(_interface, signature="os")
3253
2337
def ClientRemoved(self, objpath, name):
3257
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3259
2341
@dbus.service.method(_interface, out_signature="ao")
3260
2342
def GetAllClients(self):
3262
return dbus.Array(c.dbus_object_path for c in
3263
tcp_server.clients.values())
2344
return dbus.Array(c.dbus_object_path
2346
tcp_server.clients.itervalues())
3265
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3267
2348
@dbus.service.method(_interface,
3268
2349
out_signature="a{oa{sv}}")
3269
2350
def GetAllClientsWithProperties(self):
3271
2352
return dbus.Dictionary(
3272
{ c.dbus_object_path: c.GetAll(
3273
"se.recompile.Mandos.Client")
3274
for c in tcp_server.clients.values() },
2353
((c.dbus_object_path, c.GetAll(""))
2354
for c in tcp_server.clients.itervalues()),
3275
2355
signature="oa{sv}")
3277
2357
@dbus.service.method(_interface, in_signature="o")
3278
2358
def RemoveClient(self, object_path):
3280
for c in tcp_server.clients.values():
2360
for c in tcp_server.clients.itervalues():
3281
2361
if c.dbus_object_path == object_path:
3282
2362
del tcp_server.clients[c.name]
3283
2363
c.remove_from_connection()
3284
# Don't signal the disabling
2364
# Don't signal anything except ClientRemoved
3285
2365
c.disable(quiet=True)
3286
# Emit D-Bus signal for removal
3287
self.client_removed_signal(c)
2367
self.ClientRemoved(object_path, c.name)
3289
2369
raise KeyError(object_path)
3293
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3294
out_signature = "a{oa{sa{sv}}}")
3295
def GetManagedObjects(self):
3297
return dbus.Dictionary(
3298
{ client.dbus_object_path:
3300
{ interface: client.GetAll(interface)
3302
client._get_all_interface_names()})
3303
for client in tcp_server.clients.values()})
3305
def client_added_signal(self, client):
3306
"""Send the new standard signal and the old signal"""
3308
# New standard signal
3309
self.InterfacesAdded(
3310
client.dbus_object_path,
3312
{ interface: client.GetAll(interface)
3314
client._get_all_interface_names()}))
3316
self.ClientAdded(client.dbus_object_path)
3318
def client_removed_signal(self, client):
3319
"""Send the new standard signal and the old signal"""
3321
# New standard signal
3322
self.InterfacesRemoved(
3323
client.dbus_object_path,
3324
client._get_all_interface_names())
3326
self.ClientRemoved(client.dbus_object_path,
3329
mandos_dbus_service = MandosDBusService()
2373
class MandosDBusServiceTransitional(MandosDBusService):
2374
__metaclass__ = AlternateDBusNamesMetaclass
2375
mandos_dbus_service = MandosDBusServiceTransitional()
3331
# Save modules to variables to exempt the modules from being
3332
# unloaded before the function registered with atexit() is run.
3333
mp = multiprocessing
3336
2378
"Cleanup function; run on exit"
3340
mp.active_children()
2381
multiprocessing.active_children()
3342
2382
if not (tcp_server.clients or client_settings):