63
import cPickle as pickle
69
import cPickle as pickle
64
72
import multiprocessing
71
81
import dbus.service
82
from gi.repository import GLib
74
83
from dbus.mainloop.glib import DBusGMainLoop
77
86
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:
82
93
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
83
94
except AttributeError:
96
# This is where SO_BINDTODEVICE was up to and including Python
85
98
from IN import SO_BINDTODEVICE
86
99
except ImportError:
87
SO_BINDTODEVICE = None
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:
90
118
stored_state_file = "clients.pickle"
92
120
logger = logging.getLogger()
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
ctypes.util.find_library("c")).if_nametoindex
101
126
except (OSError, AttributeError):
102
128
def if_nametoindex(interface):
103
129
"Get an interface index the hard way, i.e. using fcntl()"
104
130
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
131
with contextlib.closing(socket.socket()) as s:
106
132
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
109
interface_index = struct.unpack(str("I"),
133
struct.pack(b"16s16x", interface))
134
interface_index = struct.unpack("I", ifreq[16:20])[0]
111
135
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__,
114
154
def initlogger(debug, level=logging.WARNING):
115
155
"""init logger and add loglevel"""
158
syslogger = (logging.handlers.SysLogHandler(
159
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
160
address = "/dev/log"))
117
161
syslogger.setFormatter(logging.Formatter
118
162
('Mandos [%(process)d]: %(levelname)s:'
172
228
def password_encode(self, password):
173
229
# Passphrase can not be empty and can not contain newlines or
174
230
# NUL bytes. So we prefix it and hex encode it.
175
return b"mandos" + binascii.hexlify(password)
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"))
177
239
def encrypt(self, data, password):
178
self.gnupg.passphrase = self.password_encode(password)
179
with open(os.devnull, "w") as devnull:
181
proc = self.gnupg.run(['--symmetric'],
182
create_fhs=['stdin', 'stdout'],
183
attach_fhs={'stderr': devnull})
184
with contextlib.closing(proc.handles['stdin']) as f:
186
with contextlib.closing(proc.handles['stdout']) as f:
187
ciphertext = f.read()
191
self.gnupg.passphrase = None
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:
192
255
return ciphertext
194
257
def decrypt(self, data, password):
195
self.gnupg.passphrase = self.password_encode(password)
196
with open(os.devnull, "w") as devnull:
198
proc = self.gnupg.run(['--decrypt'],
199
create_fhs=['stdin', 'stdout'],
200
attach_fhs={'stderr': devnull})
201
with contextlib.closing(proc.handles['stdin']) as f:
203
with contextlib.closing(proc.handles['stdout']) as f:
204
decrypted_plaintext = f.read()
208
self.gnupg.passphrase = None
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:
209
273
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
213
300
class AvahiError(Exception):
214
301
def __init__(self, value, *args, **kwargs):
215
302
self.value = value
216
super(AvahiError, self).__init__(value, *args, **kwargs)
217
def __unicode__(self):
218
return unicode(repr(self.value))
303
return super(AvahiError, self).__init__(value, *args,
220
307
class AvahiServiceError(AvahiError):
223
311
class AvahiGroupError(AvahiError):
367
485
follow_name_owner_changes=True),
368
486
avahi.DBUS_INTERFACE_SERVER)
369
487
self.server.connect_to_signal("StateChanged",
370
self.server_state_changed)
488
self.server_state_changed)
371
489
self.server_state_changed(self.server.GetState())
373
492
class AvahiServiceToSyslog(AvahiService):
493
def rename(self, *args, **kwargs):
375
494
"""Add the new name to the syslog messages"""
376
ret = AvahiService.rename(self)
377
syslogger.setFormatter(logging.Formatter
378
('Mandos ({0}) [%(process)d]:'
379
' %(levelname)s: %(message)s'
495
ret = AvahiService.rename(self, *args, **kwargs)
496
syslogger.setFormatter(logging.Formatter(
497
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
383
def timedelta_to_milliseconds(td):
384
"Convert a datetime.timedelta() to milliseconds"
385
return ((td.days * 24 * 60 * 60 * 1000)
386
+ (td.seconds * 1000)
387
+ (td.microseconds // 1000))
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))
389
766
class Client(object):
390
767
"""A representation of a client host served by this server.
427
806
runtime_expansions: Allowed attributes for runtime expansion.
428
807
expires: datetime.datetime(); time (UTC) when a client will be
429
808
disabled, or None
809
server_settings: The server_settings dict from main()
432
812
runtime_expansions = ("approval_delay", "approval_duration",
433
"created", "enabled", "fingerprint",
434
"host", "interval", "last_checked_ok",
813
"created", "enabled", "expires",
814
"fingerprint", "host", "interval",
815
"last_approval_request", "last_checked_ok",
435
816
"last_enabled", "name", "timeout")
436
client_defaults = { "timeout": "5m",
437
"extended_timeout": "15m",
439
"checker": "fping -q -- %%(host)s",
441
"approval_delay": "0s",
442
"approval_duration": "1s",
443
"approved_by_default": "True",
447
def timeout_milliseconds(self):
448
"Return the 'timeout' attribute in milliseconds"
449
return timedelta_to_milliseconds(self.timeout)
451
def extended_timeout_milliseconds(self):
452
"Return the 'extended_timeout' attribute in milliseconds"
453
return timedelta_to_milliseconds(self.extended_timeout)
455
def interval_milliseconds(self):
456
"Return the 'interval' attribute in milliseconds"
457
return timedelta_to_milliseconds(self.interval)
459
def approval_delay_milliseconds(self):
460
return timedelta_to_milliseconds(self.approval_delay)
819
"extended_timeout": "PT15M",
821
"checker": "fping -q -- %%(host)s",
823
"approval_delay": "PT0S",
824
"approval_duration": "PT1S",
825
"approved_by_default": "True",
463
830
def config_parser(config):
464
831
"""Construct a new dict of client settings of this form:
599
964
def init_checker(self):
600
965
# Schedule a new checker to be started an 'interval' from now,
601
966
# and every interval from then on.
602
self.checker_initiator_tag = (gobject.timeout_add
603
(self.interval_milliseconds(),
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),
605
972
# Schedule a disable() when 'timeout' has passed
606
self.disable_initiator_tag = (gobject.timeout_add
607
(self.timeout_milliseconds(),
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)
609
977
# Also start a new checker *right now*.
610
978
self.start_checker()
612
def checker_callback(self, pid, condition, command):
980
def checker_callback(self, source, condition, connection,
613
982
"""The checker has completed, so take appropriate actions."""
614
983
self.checker_callback_tag = None
615
984
self.checker = None
616
if os.WIFEXITED(condition):
617
self.last_checker_status = os.WEXITSTATUS(condition)
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
618
992
if self.last_checker_status == 0:
619
993
logger.info("Checker for %(name)s succeeded",
621
995
self.checked_ok()
623
logger.info("Checker for %(name)s failed",
997
logger.info("Checker for %(name)s failed", vars(self))
626
999
self.last_checker_status = -1
1000
self.last_checker_signal = -returncode
627
1001
logger.warning("Checker for %(name)s crashed?",
630
1005
def checked_ok(self):
631
1006
"""Assert that the client has been seen, alive and well."""
632
1007
self.last_checked_ok = datetime.datetime.utcnow()
633
1008
self.last_checker_status = 0
1009
self.last_checker_signal = None
634
1010
self.bump_timeout()
636
1012
def bump_timeout(self, timeout=None):
654
1030
If a checker already exists, leave it running and do
656
1032
# The reason for not killing a running checker is that if we
657
# did that, then if a checker (for some reason) started
658
# running slowly and taking more than 'interval' time, the
659
# client would inevitably timeout, since no checker would get
660
# a chance to run to completion. If we instead leave running
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
661
1037
# checkers alone, the checker would have to take more time
662
1038
# than 'timeout' for the client to be disabled, which is as it
665
# If a checker exists, make sure it is not a zombie
667
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
668
except (AttributeError, OSError) as error:
669
if (isinstance(error, OSError)
670
and error.errno != errno.ECHILD):
674
logger.warning("Checker was a zombie")
675
gobject.source_remove(self.checker_callback_tag)
676
self.checker_callback(pid, status,
677
self.current_checker_command)
1041
if self.checker is not None and not self.checker.is_alive():
1042
logger.warning("Checker was not alive; joining")
678
1045
# Start a new checker if needed
679
1046
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 }
681
# In case checker_command has exactly one % operator
682
command = self.checker_command % self.host
684
# Escape attributes for the shell
685
escaped_attrs = dict(
687
re.escape(unicode(str(getattr(self, attr, "")),
691
self.runtime_expansions)
694
command = self.checker_command % escaped_attrs
695
except TypeError as error:
696
logger.error('Could not format string "%s"',
697
self.checker_command, exc_info=error)
698
return True # Try again later
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
699
1058
self.current_checker_command = command
701
logger.info("Starting checker %r for %s",
703
# We don't need to redirect stdout and stderr, since
704
# in normal mode, that is already done by daemon(),
705
# and in debug mode we don't want to. (Stdin is
706
# always replaced by /dev/null.)
707
self.checker = subprocess.Popen(command,
710
self.checker_callback_tag = (gobject.child_watch_add
712
self.checker_callback,
714
# The checker may have completed before the gobject
715
# watch was added. Check for this.
716
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
718
gobject.source_remove(self.checker_callback_tag)
719
self.checker_callback(pid, status, command)
720
except OSError as error:
721
logger.error("Failed to start subprocess",
723
# Re-run this periodically if run by gobject.timeout_add
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
726
1087
def stop_checker(self):
727
1088
"""Force the checker process, if any, to stop."""
728
1089
if self.checker_callback_tag:
729
gobject.source_remove(self.checker_callback_tag)
1090
GLib.source_remove(self.checker_callback_tag)
730
1091
self.checker_callback_tag = None
731
1092
if getattr(self, "checker", None) is None:
733
1094
logger.debug("Stopping checker for %(name)s", vars(self))
735
self.checker.terminate()
737
#if self.checker.poll() is None:
738
# self.checker.kill()
739
except OSError as error:
740
if error.errno != errno.ESRCH: # No such process
1095
self.checker.terminate()
742
1096
self.checker = None
745
def dbus_service_property(dbus_interface, signature="v",
746
access="readwrite", byte_arrays=False):
1099
def dbus_service_property(dbus_interface,
747
1103
"""Decorators for marking methods of a DBusObjectWithProperties to
748
1104
become properties on the D-Bus.
843
1205
If called like _is_dbus_thing("method") it returns a function
844
1206
suitable for use as predicate to inspect.getmembers().
846
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1208
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
849
1211
def _get_all_dbus_things(self, thing):
850
1212
"""Returns a generator of (name, attribute) pairs
852
return ((getattr(athing.__get__(self), "_dbus_name",
1214
return ((getattr(athing.__get__(self), "_dbus_name", name),
854
1215
athing.__get__(self))
855
1216
for cls in self.__class__.__mro__
856
1217
for name, athing in
857
inspect.getmembers(cls,
858
self._is_dbus_thing(thing)))
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):
1284
"""A D-Bus object with properties.
1286
Classes inheriting from this can use the dbus_service_property
1287
decorator to expose methods as D-Bus properties. It exposes the
1288
standard Get(), Set(), and GetAll() methods on the D-Bus.
860
1291
def _get_dbus_property(self, interface_name, property_name):
861
1292
"""Returns a bound method if one exists which is a D-Bus
862
1293
property with the specified name and interface.
864
for cls in self.__class__.__mro__:
865
for name, value in (inspect.getmembers
867
self._is_dbus_thing("property"))):
1295
for cls in self.__class__.__mro__:
1296
for name, value in inspect.getmembers(
1297
cls, self._is_dbus_thing("property")):
868
1298
if (value._dbus_name == property_name
869
1299
and value._dbus_interface == interface_name):
870
1300
return value.__get__(self)
872
1302
# No such property
873
raise DBusPropertyNotFound(self.dbus_object_path + ":"
874
+ interface_name + "."
877
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1303
raise DBusPropertyNotFound("{}:{}.{}".format(
1304
self.dbus_object_path, interface_name, property_name))
1307
def _get_all_interface_names(cls):
1308
"""Get a sequence of all interfaces supported by an object"""
1309
return (name for name in set(getattr(getattr(x, attr),
1310
"_dbus_interface", None)
1311
for x in (inspect.getmro(cls))
1313
if name is not None)
1315
@dbus.service.method(dbus.PROPERTIES_IFACE,
878
1317
out_signature="v")
879
1318
def Get(self, interface_name, property_name):
880
1319
"""Standard D-Bus property Get() method, see D-Bus standard.
1009
1447
exc_info=error)
1010
1448
return xmlstring
1013
def datetime_to_dbus (dt, variant_level=0):
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):
1014
1520
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1016
1522
return dbus.String("", variant_level = variant_level)
1017
return dbus.String(dt.isoformat(),
1018
variant_level=variant_level)
1021
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
1023
"""Applied to an empty subclass of a D-Bus object, this metaclass
1024
will add additional D-Bus attributes matching a certain pattern.
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).
1026
def __new__(mcs, name, bases, attr):
1027
# Go through all the base classes which could have D-Bus
1028
# methods, signals, or properties in them
1029
old_interface_names = []
1030
for base in (b for b in bases
1031
if issubclass(b, dbus.service.Object)):
1032
# Go though all attributes of the base class
1033
for attrname, attribute in inspect.getmembers(base):
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):
1034
1557
# Ignore non-D-Bus attributes, and D-Bus attributes
1035
1558
# with the wrong interface name
1036
1559
if (not hasattr(attribute, "_dbus_interface")
1037
or not attribute._dbus_interface
1038
.startswith("se.recompile.Mandos")):
1560
or not attribute._dbus_interface.startswith(
1561
orig_interface_name)):
1040
1563
# Create an alternate D-Bus interface name based on
1041
1564
# the current name
1042
alt_interface = (attribute._dbus_interface
1043
.replace("se.recompile.Mandos",
1044
"se.bsnet.fukt.Mandos"))
1045
if alt_interface != attribute._dbus_interface:
1046
old_interface_names.append(alt_interface)
1565
alt_interface = attribute._dbus_interface.replace(
1566
orig_interface_name, alt_interface_name)
1567
interface_names.add(alt_interface)
1047
1568
# Is this a D-Bus signal?
1048
1569
if getattr(attribute, "_dbus_is_signal", False):
1049
# Extract the original non-method function by
1051
nonmethod_func = (dict(
1570
# Extract the original non-method undecorated
1571
# function by black magic
1572
if sys.version_info.major == 2:
1573
nonmethod_func = (dict(
1052
1574
zip(attribute.func_code.co_freevars,
1053
attribute.__closure__))["func"]
1575
attribute.__closure__))
1576
["func"].cell_contents)
1578
nonmethod_func = (dict(
1579
zip(attribute.__code__.co_freevars,
1580
attribute.__closure__))
1581
["func"].cell_contents)
1055
1582
# Create a new, but exactly alike, function
1056
1583
# object, and decorate it to be a new D-Bus signal
1057
1584
# with the alternate D-Bus interface name
1058
new_function = (dbus.service.signal
1060
attribute._dbus_signature)
1061
(types.FunctionType(
1062
nonmethod_func.func_code,
1063
nonmethod_func.func_globals,
1064
nonmethod_func.func_name,
1065
nonmethod_func.func_defaults,
1066
nonmethod_func.func_closure)))
1585
new_function = copy_function(nonmethod_func)
1586
new_function = (dbus.service.signal(
1588
attribute._dbus_signature)(new_function))
1067
1589
# Copy annotations, if any
1069
new_function._dbus_annotations = (
1070
dict(attribute._dbus_annotations))
1591
new_function._dbus_annotations = dict(
1592
attribute._dbus_annotations)
1071
1593
except AttributeError:
1073
1595
# Define a creator of a function to call both the
1074
# old and new functions, so both the old and new
1075
# signals gets sent when the function is called
1596
# original and alternate functions, so both the
1597
# original and alternate signals gets sent when
1598
# the function is called
1076
1599
def fixscope(func1, func2):
1077
1600
"""This function is a scope container to pass
1078
1601
func1 and func2 to the "call_both" function
1079
1602
outside of its arguments"""
1604
@functools.wraps(func2)
1080
1605
def call_both(*args, **kwargs):
1081
1606
"""This function will emit two D-Bus
1082
1607
signals by calling func1 and func2"""
1083
1608
func1(*args, **kwargs)
1084
1609
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)
1085
1615
return call_both
1086
1616
# Create the "call_both" function and add it to
1088
attr[attrname] = fixscope(attribute,
1618
attr[attrname] = fixscope(attribute, new_function)
1090
1619
# Is this a D-Bus method?
1091
1620
elif getattr(attribute, "_dbus_is_method", False):
1092
1621
# Create a new, but exactly alike, function
1093
1622
# object. Decorate it to be a new D-Bus method
1094
1623
# with the alternate D-Bus interface name. Add it
1095
1624
# to the class.
1096
attr[attrname] = (dbus.service.method
1098
attribute._dbus_in_signature,
1099
attribute._dbus_out_signature)
1101
(attribute.func_code,
1102
attribute.func_globals,
1103
attribute.func_name,
1104
attribute.func_defaults,
1105
attribute.func_closure)))
1626
dbus.service.method(
1628
attribute._dbus_in_signature,
1629
attribute._dbus_out_signature)
1630
(copy_function(attribute)))
1106
1631
# Copy annotations, if any
1108
attr[attrname]._dbus_annotations = (
1109
dict(attribute._dbus_annotations))
1633
attr[attrname]._dbus_annotations = dict(
1634
attribute._dbus_annotations)
1110
1635
except AttributeError:
1112
1637
# Is this a D-Bus property?
1267
1810
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1268
1811
Client.__del__(self, *args, **kwargs)
1270
def checker_callback(self, pid, condition, command,
1272
self.checker_callback_tag = None
1274
if os.WIFEXITED(condition):
1275
exitstatus = os.WEXITSTATUS(condition)
1813
def checker_callback(self, source, condition,
1814
connection, command, *args, **kwargs):
1815
ret = Client.checker_callback(self, source, condition,
1816
connection, command, *args,
1818
exitstatus = self.last_checker_status
1276
1820
# Emit D-Bus signal
1277
1821
self.CheckerCompleted(dbus.Int16(exitstatus),
1278
dbus.Int64(condition),
1822
# This is specific to GNU libC
1823
dbus.Int64(exitstatus << 8),
1279
1824
dbus.String(command))
1281
1826
# Emit D-Bus signal
1282
1827
self.CheckerCompleted(dbus.Int16(-1),
1283
dbus.Int64(condition),
1829
# This is specific to GNU libC
1831
| self.last_checker_signal),
1284
1832
dbus.String(command))
1286
return Client.checker_callback(self, pid, condition, command,
1289
1835
def start_checker(self, *args, **kwargs):
1290
old_checker = self.checker
1291
if self.checker is not None:
1292
old_checker_pid = self.checker.pid
1294
old_checker_pid = None
1836
old_checker_pid = getattr(self.checker, "pid", None)
1295
1837
r = Client.start_checker(self, *args, **kwargs)
1296
1838
# Only if new checker process was started
1297
1839
if (self.checker is not None
1414
1954
self.approved_by_default = bool(value)
1416
1956
# ApprovalDelay - property
1417
@dbus_service_property(_interface, signature="t",
1957
@dbus_service_property(_interface,
1418
1959
access="readwrite")
1419
1960
def ApprovalDelay_dbus_property(self, value=None):
1420
1961
if value is None: # get
1421
return dbus.UInt64(self.approval_delay_milliseconds())
1962
return dbus.UInt64(self.approval_delay.total_seconds()
1422
1964
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1424
1966
# ApprovalDuration - property
1425
@dbus_service_property(_interface, signature="t",
1967
@dbus_service_property(_interface,
1426
1969
access="readwrite")
1427
1970
def ApprovalDuration_dbus_property(self, value=None):
1428
1971
if value is None: # get
1429
return dbus.UInt64(timedelta_to_milliseconds(
1430
self.approval_duration))
1972
return dbus.UInt64(self.approval_duration.total_seconds()
1431
1974
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1433
1976
# Name - property
1978
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1434
1979
@dbus_service_property(_interface, signature="s", access="read")
1435
1980
def Name_dbus_property(self):
1436
1981
return dbus.String(self.name)
1438
1983
# Fingerprint - property
1985
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1439
1986
@dbus_service_property(_interface, signature="s", access="read")
1440
1987
def Fingerprint_dbus_property(self):
1441
1988
return dbus.String(self.fingerprint)
1443
1990
# Host - property
1444
@dbus_service_property(_interface, signature="s",
1991
@dbus_service_property(_interface,
1445
1993
access="readwrite")
1446
1994
def Host_dbus_property(self, value=None):
1447
1995
if value is None: # get
1448
1996
return dbus.String(self.host)
1449
self.host = unicode(value)
1997
self.host = str(value)
1451
1999
# Created - property
2001
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1452
2002
@dbus_service_property(_interface, signature="s", access="read")
1453
2003
def Created_dbus_property(self):
1454
2004
return datetime_to_dbus(self.created)
1495
2046
return datetime_to_dbus(self.last_approval_request)
1497
2048
# Timeout - property
1498
@dbus_service_property(_interface, signature="t",
2049
@dbus_service_property(_interface,
1499
2051
access="readwrite")
1500
2052
def Timeout_dbus_property(self, value=None):
1501
2053
if value is None: # get
1502
return dbus.UInt64(self.timeout_milliseconds())
2054
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2055
old_timeout = self.timeout
1503
2056
self.timeout = datetime.timedelta(0, 0, 0, value)
1504
# Reschedule timeout
2057
# Reschedule disabling
1505
2058
if self.enabled:
1506
2059
now = datetime.datetime.utcnow()
1507
time_to_die = timedelta_to_milliseconds(
1508
(self.last_checked_ok + self.timeout) - now)
1509
if time_to_die <= 0:
2060
self.expires += self.timeout - old_timeout
2061
if self.expires <= now:
1510
2062
# The timeout has passed
1513
self.expires = (now +
1514
datetime.timedelta(milliseconds =
1516
2065
if (getattr(self, "disable_initiator_tag", None)
1519
gobject.source_remove(self.disable_initiator_tag)
1520
self.disable_initiator_tag = (gobject.timeout_add
2068
GLib.source_remove(self.disable_initiator_tag)
2069
self.disable_initiator_tag = GLib.timeout_add(
2070
int((self.expires - now).total_seconds() * 1000),
1524
2073
# ExtendedTimeout - property
1525
@dbus_service_property(_interface, signature="t",
2074
@dbus_service_property(_interface,
1526
2076
access="readwrite")
1527
2077
def ExtendedTimeout_dbus_property(self, value=None):
1528
2078
if value is None: # get
1529
return dbus.UInt64(self.extended_timeout_milliseconds())
2079
return dbus.UInt64(self.extended_timeout.total_seconds()
1530
2081
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1532
2083
# Interval - property
1533
@dbus_service_property(_interface, signature="t",
2084
@dbus_service_property(_interface,
1534
2086
access="readwrite")
1535
2087
def Interval_dbus_property(self, value=None):
1536
2088
if value is None: # get
1537
return dbus.UInt64(self.interval_milliseconds())
2089
return dbus.UInt64(self.interval.total_seconds() * 1000)
1538
2090
self.interval = datetime.timedelta(0, 0, 0, value)
1539
2091
if getattr(self, "checker_initiator_tag", None) is None:
1541
2093
if self.enabled:
1542
2094
# Reschedule checker run
1543
gobject.source_remove(self.checker_initiator_tag)
1544
self.checker_initiator_tag = (gobject.timeout_add
1545
(value, self.start_checker))
1546
self.start_checker() # Start one now, too
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
1548
2100
# Checker - property
1549
@dbus_service_property(_interface, signature="s",
2101
@dbus_service_property(_interface,
1550
2103
access="readwrite")
1551
2104
def Checker_dbus_property(self, value=None):
1552
2105
if value is None: # get
1553
2106
return dbus.String(self.checker_command)
1554
self.checker_command = unicode(value)
2107
self.checker_command = str(value)
1556
2109
# CheckerRunning - property
1557
@dbus_service_property(_interface, signature="b",
2110
@dbus_service_property(_interface,
1558
2112
access="readwrite")
1559
2113
def CheckerRunning_dbus_property(self, value=None):
1560
2114
if value is None: # get
1788
2330
def fingerprint(openpgp):
1789
2331
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1790
2332
# New GnuTLS "datum" with the OpenPGP public key
1791
datum = (gnutls.library.types
1792
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1795
ctypes.c_uint(len(openpgp))))
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)))
1796
2337
# New empty GnuTLS certificate
1797
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1798
(gnutls.library.functions
1799
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2338
crt = gnutls.openpgp_crt_t()
2339
gnutls.openpgp_crt_init(ctypes.byref(crt))
1800
2340
# Import the OpenPGP public key into the certificate
1801
(gnutls.library.functions
1802
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1803
gnutls.library.constants
1804
.GNUTLS_OPENPGP_FMT_RAW))
2341
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2342
gnutls.OPENPGP_FMT_RAW)
1805
2343
# Verify the self signature in the key
1806
2344
crtverify = ctypes.c_uint()
1807
(gnutls.library.functions
1808
.gnutls_openpgp_crt_verify_self(crt, 0,
1809
ctypes.byref(crtverify)))
2345
gnutls.openpgp_crt_verify_self(crt, 0,
2346
ctypes.byref(crtverify))
1810
2347
if crtverify.value != 0:
1811
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1812
raise (gnutls.errors.CertificateSecurityError
2348
gnutls.openpgp_crt_deinit(crt)
2349
raise gnutls.CertificateSecurityError("Verify failed")
1814
2350
# New buffer for the fingerprint
1815
2351
buf = ctypes.create_string_buffer(20)
1816
2352
buf_len = ctypes.c_size_t()
1817
2353
# Get the fingerprint from the certificate into the buffer
1818
(gnutls.library.functions
1819
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1820
ctypes.byref(buf_len)))
2354
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2355
ctypes.byref(buf_len))
1821
2356
# Deinit the certificate
1822
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2357
gnutls.openpgp_crt_deinit(crt)
1823
2358
# Convert the buffer to a Python bytestring
1824
2359
fpr = ctypes.string_at(buf, buf_len.value)
1825
2360
# Convert the bytestring to hexadecimal notation
1873
2409
interface: None or a network interface name (string)
1874
2410
use_ipv6: Boolean; to use IPv6 or not
1876
2413
def __init__(self, server_address, RequestHandlerClass,
1877
interface=None, use_ipv6=True):
2417
"""If socketfd is set, use that file descriptor instead of
2418
creating a new one with socket.socket().
1878
2420
self.interface = interface
1880
2422
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.
1881
2449
socketserver.TCPServer.__init__(self, server_address,
1882
2450
RequestHandlerClass)
1883
2452
def server_bind(self):
1884
2453
"""This overrides the normal server_bind() function
1885
2454
to bind to an interface if one was specified, and also NOT to
1886
2455
bind to an address or port if they were not specified."""
2456
global SO_BINDTODEVICE
1887
2457
if self.interface is not None:
1888
2458
if SO_BINDTODEVICE is None:
1889
logger.error("SO_BINDTODEVICE does not exist;"
1890
" cannot bind to interface %s",
1894
self.socket.setsockopt(socket.SOL_SOCKET,
1898
except socket.error as error:
1899
if error[0] == errno.EPERM:
1900
logger.error("No permission to"
1901
" bind to interface %s",
1903
elif error[0] == errno.ENOPROTOOPT:
1904
logger.error("SO_BINDTODEVICE not available;"
1905
" cannot bind to interface %s",
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)
1909
2480
# Only bind(2) the socket if we really need to.
1910
2481
if self.server_address[0] or self.server_address[1]:
1911
2482
if not self.server_address[0]:
1912
2483
if self.address_family == socket.AF_INET6:
1913
2484
any_address = "::" # in6addr_any
1915
any_address = socket.INADDR_ANY
2486
any_address = "0.0.0.0" # INADDR_ANY
1916
2487
self.server_address = (any_address,
1917
2488
self.server_address[1])
1918
2489
elif not self.server_address[1]:
1919
self.server_address = (self.server_address[0],
2490
self.server_address = (self.server_address[0], 0)
1921
2491
# if self.interface:
1922
2492
# 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}"
2050
2711
def string_to_delta(interval):
2051
2712
"""Parse a string and return a datetime.timedelta
2167
2842
"debug": "False",
2169
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2844
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2845
":+SIGN-DSA-SHA256",
2170
2846
"servicename": "Mandos",
2171
2847
"use_dbus": "True",
2172
2848
"use_ipv6": "True",
2173
2849
"debuglevel": "",
2174
2850
"restore": "True",
2175
"statedir": "/var/lib/mandos"
2852
"statedir": "/var/lib/mandos",
2853
"foreground": "False",
2178
2857
# Parse config file for server-global settings
2179
2858
server_config = configparser.SafeConfigParser(server_defaults)
2180
2859
del server_defaults
2181
server_config.read(os.path.join(options.configdir,
2860
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2183
2861
# Convert the SafeConfigParser object to a dict
2184
2862
server_settings = server_config.defaults()
2185
2863
# Use the appropriate methods on the non-string config options
2186
for option in ("debug", "use_dbus", "use_ipv6"):
2864
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2187
2865
server_settings[option] = server_config.getboolean("DEFAULT",
2189
2867
if server_settings["port"]:
2190
2868
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
2192
2879
del server_config
2194
2881
# Override the settings from the config file with command line
2195
2882
# options, if set.
2196
2883
for option in ("interface", "address", "port", "debug",
2197
"priority", "servicename", "configdir",
2198
"use_dbus", "use_ipv6", "debuglevel", "restore",
2884
"priority", "servicename", "configdir", "use_dbus",
2885
"use_ipv6", "debuglevel", "restore", "statedir",
2886
"socket", "foreground", "zeroconf"):
2200
2887
value = getattr(options, option)
2201
2888
if value is not None:
2202
2889
server_settings[option] = value
2204
2891
# Force all strings to be unicode
2205
2892
for option in server_settings.keys():
2206
if type(server_settings[option]) is str:
2207
server_settings[option] = unicode(server_settings[option])
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
2208
2903
# Now we have our good server settings in "server_settings"
2210
2905
##################################################################
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")
2212
2912
# For convenience
2213
2913
debug = server_settings["debug"]
2214
2914
debuglevel = server_settings["debuglevel"]
2298
3011
# Need to fork before connecting to D-Bus
2300
3013
# Close all input and output, do double fork, etc.
2303
gobject.threads_init()
3016
# multiprocessing will use threads, so before we use GLib we need
3017
# to inform GLib that threads will be used.
2305
3020
global main_loop
2306
3021
# From the Avahi example code
2307
3022
DBusGMainLoop(set_as_default=True)
2308
main_loop = gobject.MainLoop()
3023
main_loop = GLib.MainLoop()
2309
3024
bus = dbus.SystemBus()
2310
3025
# End of Avahi example code
2313
3028
bus_name = dbus.service.BusName("se.recompile.Mandos",
2314
bus, do_not_queue=True)
2315
old_bus_name = (dbus.service.BusName
2316
("se.bsnet.fukt.Mandos", bus,
2318
except dbus.exceptions.NameExistsException as e:
2319
logger.error(unicode(e) + ", disabling D-Bus")
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)
2320
3036
use_dbus = False
2321
3037
server_settings["use_dbus"] = False
2322
3038
tcp_server.use_dbus = False
2323
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2324
service = AvahiServiceToSyslog(name =
2325
server_settings["servicename"],
2326
servicetype = "_mandos._tcp",
2327
protocol = protocol, bus = bus)
2328
if server_settings["interface"]:
2329
service.interface = (if_nametoindex
2330
(str(server_settings["interface"])))
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"))
2332
3050
global multiprocessing_manager
2333
3051
multiprocessing_manager = multiprocessing.Manager()
2335
3053
client_class = Client
2337
client_class = functools.partial(ClientDBusTransitional,
3055
client_class = functools.partial(ClientDBus, bus = bus)
2340
3057
client_settings = Client.config_parser(client_config)
2341
3058
old_client_settings = {}
2342
3059
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:
2344
3069
# Get client data and settings from last running state.
2345
3070
if server_settings["restore"]:
2347
3072
with open(stored_state_path, "rb") as stored_state:
2348
clients_data, old_client_settings = (pickle.load
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"]
2350
3118
os.remove(stored_state_path)
2351
3119
except IOError as e:
2352
logger.warning("Could not load persistent state: {0}"
2354
if e.errno != errno.ENOENT:
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:",
2356
3127
except EOFError as e:
2357
3128
logger.warning("Could not load persistent state: "
2358
"EOFError: {0}".format(e))
2360
3132
with PGPEngine() as pgp:
2361
for client_name, client in clients_data.iteritems():
3133
for client_name, client in clients_data.items():
3134
# Skip removed clients
3135
if client_name not in client_settings:
2362
3138
# Decide which value to use after restoring saved state.
2363
3139
# We have three different values: Old config file,
2364
3140
# new config file, and saved state.
2423
3198
for client_name in (set(client_settings)
2424
3199
- set(old_client_settings)):
2425
3200
clients_data[client_name] = client_settings[client_name]
2427
3202
# Create all client objects
2428
for client_name, client in clients_data.iteritems():
3203
for client_name, client in clients_data.items():
2429
3204
tcp_server.clients[client_name] = client_class(
2430
name = client_name, settings = client)
3207
server_settings = server_settings)
2432
3209
if not tcp_server.clients:
2433
3210
logger.warning("No clients defined")
2439
pidfile.write(str(pid) + "\n".encode("utf-8"))
2442
logger.error("Could not write to file %r with PID %d",
2445
# "pidfile" was never created
3213
if pidfile is not None:
3217
print(pid, file=pidfile)
3219
logger.error("Could not write to file %r with PID %d",
2447
3222
del pidfilename
2448
signal.signal(signal.SIGINT, signal.SIG_IGN)
2450
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2451
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3224
for termsig in (signal.SIGHUP, signal.SIGTERM):
3225
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3226
lambda: main_loop.quit() and False)
2454
class MandosDBusService(DBusObjectWithProperties):
3230
@alternate_dbus_interfaces(
3231
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3232
class MandosDBusService(DBusObjectWithObjectManager):
2455
3233
"""A D-Bus proxy object"""
2456
3235
def __init__(self):
2457
3236
dbus.service.Object.__init__(self, bus, "/")
2458
3238
_interface = "se.recompile.Mandos"
2460
@dbus_interface_annotations(_interface)
2462
return { "org.freedesktop.DBus.Property"
2463
".EmitsChangedSignal":
2466
3240
@dbus.service.signal(_interface, signature="o")
2467
3241
def ClientAdded(self, objpath):
3250
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2476
3252
@dbus.service.signal(_interface, signature="os")
2477
3253
def ClientRemoved(self, objpath, name):
3257
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2481
3259
@dbus.service.method(_interface, out_signature="ao")
2482
3260
def GetAllClients(self):
2484
return dbus.Array(c.dbus_object_path
2486
tcp_server.clients.itervalues())
3262
return dbus.Array(c.dbus_object_path for c in
3263
tcp_server.clients.values())
3265
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2488
3267
@dbus.service.method(_interface,
2489
3268
out_signature="a{oa{sv}}")
2490
3269
def GetAllClientsWithProperties(self):
2492
3271
return dbus.Dictionary(
2493
((c.dbus_object_path, c.GetAll(""))
2494
for c in tcp_server.clients.itervalues()),
3272
{ c.dbus_object_path: c.GetAll(
3273
"se.recompile.Mandos.Client")
3274
for c in tcp_server.clients.values() },
2495
3275
signature="oa{sv}")
2497
3277
@dbus.service.method(_interface, in_signature="o")
2498
3278
def RemoveClient(self, object_path):
2500
for c in tcp_server.clients.itervalues():
3280
for c in tcp_server.clients.values():
2501
3281
if c.dbus_object_path == object_path:
2502
3282
del tcp_server.clients[c.name]
2503
3283
c.remove_from_connection()
2504
# Don't signal anything except ClientRemoved
3284
# Don't signal the disabling
2505
3285
c.disable(quiet=True)
2507
self.ClientRemoved(object_path, c.name)
3286
# Emit D-Bus signal for removal
3287
self.client_removed_signal(c)
2509
3289
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,
2513
class MandosDBusServiceTransitional(MandosDBusService):
2514
__metaclass__ = AlternateDBusNamesMetaclass
2515
mandos_dbus_service = MandosDBusServiceTransitional()
3329
mandos_dbus_service = MandosDBusService()
3331
# Save modules to variables to exempt the modules from being
3332
# unloaded before the function registered with atexit() is run.
3333
mp = multiprocessing
2518
3336
"Cleanup function; run on exit"
2521
multiprocessing.active_children()
3340
mp.active_children()
2522
3342
if not (tcp_server.clients or client_settings):
2551
3371
del client_settings[client.name]["secret"]
2554
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2557
(stored_state_path))
2558
with os.fdopen(tempfd, "wb") as stored_state:
2559
pickle.dump((clients, client_settings), stored_state)
3374
with tempfile.NamedTemporaryFile(
3378
dir=os.path.dirname(stored_state_path),
3379
delete=False) as stored_state:
3380
pickle.dump((clients, client_settings), stored_state,
3382
tempname = stored_state.name
2560
3383
os.rename(tempname, stored_state_path)
2561
3384
except (IOError, OSError) as e:
2562
logger.warning("Could not save persistent state: {0}"
2566
3387
os.remove(tempname)
2567
3388
except NameError:
2569
if e.errno not in set((errno.ENOENT, errno.EACCES,
3390
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3391
logger.warning("Could not save persistent state: {}"
3392
.format(os.strerror(e.errno)))
3394
logger.warning("Could not save persistent state:",
2573
3398
# Delete all clients, and settings from config
2574
3399
while tcp_server.clients:
2575
3400
name, client = tcp_server.clients.popitem()
2577
3402
client.remove_from_connection()
2578
# Don't signal anything except ClientRemoved
3403
# Don't signal the disabling
2579
3404
client.disable(quiet=True)
3405
# Emit D-Bus signal for removal
2582
mandos_dbus_service.ClientRemoved(client
3407
mandos_dbus_service.client_removed_signal(client)
2585
3408
client_settings.clear()
2587
3410
atexit.register(cleanup)
2589
for client in tcp_server.clients.itervalues():
3412
for client in tcp_server.clients.values():
2592
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3414
# Emit D-Bus signal for adding
3415
mandos_dbus_service.client_added_signal(client)
2593
3416
# Need to initiate checking of clients
2594
3417
if client.enabled:
2595
3418
client.init_checker()