63
import cPickle as pickle
69
import cPickle as pickle
64
72
import multiprocessing
70
81
import dbus.service
82
from gi.repository import GLib
73
83
from dbus.mainloop.glib import DBusGMainLoop
76
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:
81
93
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
82
94
except AttributeError:
96
# This is where SO_BINDTODEVICE was up to and including Python
84
98
from IN import SO_BINDTODEVICE
85
99
except ImportError:
86
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:
89
118
stored_state_file = "clients.pickle"
91
120
logger = logging.getLogger()
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
97
if_nametoindex = (ctypes.cdll.LoadLibrary
98
(ctypes.util.find_library("c"))
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
ctypes.util.find_library("c")).if_nametoindex
100
126
except (OSError, AttributeError):
101
128
def if_nametoindex(interface):
102
129
"Get an interface index the hard way, i.e. using fcntl()"
103
130
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
104
131
with contextlib.closing(socket.socket()) as s:
105
132
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
106
struct.pack(str("16s16x"),
108
interface_index = struct.unpack(str("I"),
133
struct.pack(b"16s16x", interface))
134
interface_index = struct.unpack("I", ifreq[16:20])[0]
110
135
return interface_index
113
def initlogger(level=logging.WARNING):
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
def initlogger(debug, level=logging.WARNING):
114
155
"""init logger and add loglevel"""
158
syslogger = (logging.handlers.SysLogHandler(
159
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
116
161
syslogger.setFormatter(logging.Formatter
117
162
('Mandos [%(process)d]: %(levelname)s:'
119
164
logger.addHandler(syslogger)
121
console = logging.StreamHandler()
122
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
126
logger.addHandler(console)
167
console = logging.StreamHandler()
168
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
172
logger.addHandler(console)
127
173
logger.setLevel(level)
166
225
os.rmdir(self.tempdir)
167
226
self.tempdir = None
169
228
def password_encode(self, password):
170
229
# Passphrase can not be empty and can not contain newlines or
171
230
# NUL bytes. So we prefix it and hex encode it.
172
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"))
174
239
def encrypt(self, data, password):
175
self.gnupg.passphrase = self.password_encode(password)
176
with open(os.devnull) as devnull:
178
proc = self.gnupg.run(['--symmetric'],
179
create_fhs=['stdin', 'stdout'],
180
attach_fhs={'stderr': devnull})
181
with contextlib.closing(proc.handles['stdin']) as f:
183
with contextlib.closing(proc.handles['stdout']) as f:
184
ciphertext = f.read()
188
self.gnupg.passphrase = None
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:
189
255
return ciphertext
191
257
def decrypt(self, data, password):
192
self.gnupg.passphrase = self.password_encode(password)
193
with open(os.devnull) as devnull:
195
proc = self.gnupg.run(['--decrypt'],
196
create_fhs=['stdin', 'stdout'],
197
attach_fhs={'stderr': devnull})
198
with contextlib.closing(proc.handles['stdin'] ) as f:
200
with contextlib.closing(proc.handles['stdout']) as f:
201
decrypted_plaintext = f.read()
205
self.gnupg.passphrase = None
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:
206
273
return decrypted_plaintext
276
# Pretend that we have an Avahi module
278
"""This isn't so much a class as it is a module-like namespace.
279
It is instantiated once, and simulates having an Avahi module."""
280
IF_UNSPEC = -1 # avahi-common/address.h
281
PROTO_UNSPEC = -1 # avahi-common/address.h
282
PROTO_INET = 0 # avahi-common/address.h
283
PROTO_INET6 = 1 # avahi-common/address.h
284
DBUS_NAME = "org.freedesktop.Avahi"
285
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
286
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
287
DBUS_PATH_SERVER = "/"
289
def string_array_to_txt_array(self, t):
290
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
291
for s in t), signature="ay")
292
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
293
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
294
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
295
SERVER_INVALID = 0 # avahi-common/defs.h
296
SERVER_REGISTERING = 1 # avahi-common/defs.h
297
SERVER_RUNNING = 2 # avahi-common/defs.h
298
SERVER_COLLISION = 3 # avahi-common/defs.h
299
SERVER_FAILURE = 4 # avahi-common/defs.h
210
303
class AvahiError(Exception):
211
304
def __init__(self, value, *args, **kwargs):
212
305
self.value = value
213
super(AvahiError, self).__init__(value, *args, **kwargs)
214
def __unicode__(self):
215
return unicode(repr(self.value))
306
return super(AvahiError, self).__init__(value, *args,
217
310
class AvahiServiceError(AvahiError):
220
314
class AvahiGroupError(AvahiError):
224
318
class AvahiService(object):
225
319
"""An Avahi (Zeroconf) service.
228
322
interface: integer; avahi.IF_UNSPEC or an interface index.
229
323
Used to optionally bind to the specified interface.
230
324
name: string; Example: 'Mandos'
231
325
type: string; Example: '_mandos._tcp'.
232
See <http://www.dns-sd.org/ServiceTypes.html>
326
See <https://www.iana.org/assignments/service-names-port-numbers>
233
327
port: integer; what port to announce
234
328
TXT: list of strings; TXT record for the service
235
329
domain: string; Domain to publish on, default to .local if empty.
364
488
follow_name_owner_changes=True),
365
489
avahi.DBUS_INTERFACE_SERVER)
366
490
self.server.connect_to_signal("StateChanged",
367
self.server_state_changed)
491
self.server_state_changed)
368
492
self.server_state_changed(self.server.GetState())
370
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
372
497
"""Add the new name to the syslog messages"""
373
ret = AvahiService.rename(self)
374
syslogger.setFormatter(logging.Formatter
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
498
ret = AvahiService.rename(self, *args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
380
def timedelta_to_milliseconds(td):
381
"Convert a datetime.timedelta() to milliseconds"
382
return ((td.days * 24 * 60 * 60 * 1000)
383
+ (td.seconds * 1000)
384
+ (td.microseconds // 1000))
505
# Pretend that we have a GnuTLS module
506
class GnuTLS(object):
507
"""This isn't so much a class as it is a module-like namespace.
508
It is instantiated once, and simulates having a GnuTLS module."""
510
library = ctypes.util.find_library("gnutls")
512
library = ctypes.util.find_library("gnutls-deb0")
513
_library = ctypes.cdll.LoadLibrary(library)
515
_need_version = b"3.3.0"
518
# Need to use "self" here, since this method is called before
519
# the assignment to the "gnutls" global variable happens.
520
if self.check_version(self._need_version) is None:
521
raise self.Error("Needs GnuTLS {} or later"
522
.format(self._need_version))
524
# Unless otherwise indicated, the constants and types below are
525
# all from the gnutls/gnutls.h C header file.
535
E_NO_CERTIFICATE_FOUND = -49
536
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
539
class session_int(ctypes.Structure):
541
session_t = ctypes.POINTER(session_int)
543
class certificate_credentials_st(ctypes.Structure):
545
certificate_credentials_t = ctypes.POINTER(
546
certificate_credentials_st)
547
certificate_type_t = ctypes.c_int
549
class datum_t(ctypes.Structure):
550
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
551
('size', ctypes.c_uint)]
553
class openpgp_crt_int(ctypes.Structure):
555
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
556
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
557
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
558
credentials_type_t = ctypes.c_int
559
transport_ptr_t = ctypes.c_void_p
560
close_request_t = ctypes.c_int
563
class Error(Exception):
564
# We need to use the class name "GnuTLS" here, since this
565
# exception might be raised from within GnuTLS.__init__,
566
# which is called before the assignment to the "gnutls"
567
# global variable has happened.
568
def __init__(self, message=None, code=None, args=()):
569
# Default usage is by a message string, but if a return
570
# code is passed, convert it to a string with
573
if message is None and code is not None:
574
message = GnuTLS.strerror(code)
575
return super(GnuTLS.Error, self).__init__(
578
class CertificateSecurityError(Error):
582
class Credentials(object):
584
self._c_object = gnutls.certificate_credentials_t()
585
gnutls.certificate_allocate_credentials(
586
ctypes.byref(self._c_object))
587
self.type = gnutls.CRD_CERTIFICATE
590
gnutls.certificate_free_credentials(self._c_object)
592
class ClientSession(object):
593
def __init__(self, socket, credentials=None):
594
self._c_object = gnutls.session_t()
595
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
596
gnutls.set_default_priority(self._c_object)
597
gnutls.transport_set_ptr(self._c_object, socket.fileno())
598
gnutls.handshake_set_private_extensions(self._c_object,
601
if credentials is None:
602
credentials = gnutls.Credentials()
603
gnutls.credentials_set(self._c_object, credentials.type,
604
ctypes.cast(credentials._c_object,
606
self.credentials = credentials
609
gnutls.deinit(self._c_object)
612
return gnutls.handshake(self._c_object)
614
def send(self, data):
618
data_len -= gnutls.record_send(self._c_object,
623
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
625
# Error handling functions
626
def _error_code(result):
627
"""A function to raise exceptions on errors, suitable
628
for the 'restype' attribute on ctypes functions"""
631
if result == gnutls.E_NO_CERTIFICATE_FOUND:
632
raise gnutls.CertificateSecurityError(code=result)
633
raise gnutls.Error(code=result)
635
def _retry_on_error(result, func, arguments):
636
"""A function to retry on some errors, suitable
637
for the 'errcheck' attribute on ctypes functions"""
639
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
640
return _error_code(result)
641
result = func(*arguments)
644
# Unless otherwise indicated, the function declarations below are
645
# all from the gnutls/gnutls.h C header file.
648
priority_set_direct = _library.gnutls_priority_set_direct
649
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
650
ctypes.POINTER(ctypes.c_char_p)]
651
priority_set_direct.restype = _error_code
653
init = _library.gnutls_init
654
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
655
init.restype = _error_code
657
set_default_priority = _library.gnutls_set_default_priority
658
set_default_priority.argtypes = [session_t]
659
set_default_priority.restype = _error_code
661
record_send = _library.gnutls_record_send
662
record_send.argtypes = [session_t, ctypes.c_void_p,
664
record_send.restype = ctypes.c_ssize_t
665
record_send.errcheck = _retry_on_error
667
certificate_allocate_credentials = (
668
_library.gnutls_certificate_allocate_credentials)
669
certificate_allocate_credentials.argtypes = [
670
ctypes.POINTER(certificate_credentials_t)]
671
certificate_allocate_credentials.restype = _error_code
673
certificate_free_credentials = (
674
_library.gnutls_certificate_free_credentials)
675
certificate_free_credentials.argtypes = [
676
certificate_credentials_t]
677
certificate_free_credentials.restype = None
679
handshake_set_private_extensions = (
680
_library.gnutls_handshake_set_private_extensions)
681
handshake_set_private_extensions.argtypes = [session_t,
683
handshake_set_private_extensions.restype = None
685
credentials_set = _library.gnutls_credentials_set
686
credentials_set.argtypes = [session_t, credentials_type_t,
688
credentials_set.restype = _error_code
690
strerror = _library.gnutls_strerror
691
strerror.argtypes = [ctypes.c_int]
692
strerror.restype = ctypes.c_char_p
694
certificate_type_get = _library.gnutls_certificate_type_get
695
certificate_type_get.argtypes = [session_t]
696
certificate_type_get.restype = _error_code
698
certificate_get_peers = _library.gnutls_certificate_get_peers
699
certificate_get_peers.argtypes = [session_t,
700
ctypes.POINTER(ctypes.c_uint)]
701
certificate_get_peers.restype = ctypes.POINTER(datum_t)
703
global_set_log_level = _library.gnutls_global_set_log_level
704
global_set_log_level.argtypes = [ctypes.c_int]
705
global_set_log_level.restype = None
707
global_set_log_function = _library.gnutls_global_set_log_function
708
global_set_log_function.argtypes = [log_func]
709
global_set_log_function.restype = None
711
deinit = _library.gnutls_deinit
712
deinit.argtypes = [session_t]
713
deinit.restype = None
715
handshake = _library.gnutls_handshake
716
handshake.argtypes = [session_t]
717
handshake.restype = _error_code
718
handshake.errcheck = _retry_on_error
720
transport_set_ptr = _library.gnutls_transport_set_ptr
721
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
722
transport_set_ptr.restype = None
724
bye = _library.gnutls_bye
725
bye.argtypes = [session_t, close_request_t]
726
bye.restype = _error_code
727
bye.errcheck = _retry_on_error
729
check_version = _library.gnutls_check_version
730
check_version.argtypes = [ctypes.c_char_p]
731
check_version.restype = ctypes.c_char_p
733
# All the function declarations below are from gnutls/openpgp.h
735
openpgp_crt_init = _library.gnutls_openpgp_crt_init
736
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
737
openpgp_crt_init.restype = _error_code
739
openpgp_crt_import = _library.gnutls_openpgp_crt_import
740
openpgp_crt_import.argtypes = [openpgp_crt_t,
741
ctypes.POINTER(datum_t),
743
openpgp_crt_import.restype = _error_code
745
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
746
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
747
ctypes.POINTER(ctypes.c_uint)]
748
openpgp_crt_verify_self.restype = _error_code
750
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
751
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
752
openpgp_crt_deinit.restype = None
754
openpgp_crt_get_fingerprint = (
755
_library.gnutls_openpgp_crt_get_fingerprint)
756
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
760
openpgp_crt_get_fingerprint.restype = _error_code
762
# Remove non-public functions
763
del _error_code, _retry_on_error
764
# Create the global "gnutls" object, simulating a module
768
def call_pipe(connection, # : multiprocessing.Connection
769
func, *args, **kwargs):
770
"""This function is meant to be called by multiprocessing.Process
772
This function runs func(*args, **kwargs), and writes the resulting
773
return value on the provided multiprocessing.Connection.
775
connection.send(func(*args, **kwargs))
386
779
class Client(object):
387
780
"""A representation of a client host served by this server.
390
783
approved: bool(); 'None' if not yet approved/disapproved
391
784
approval_delay: datetime.timedelta(); Time to wait for approval
413
806
last_checked_ok: datetime.datetime(); (UTC) or None
414
807
last_checker_status: integer between 0 and 255 reflecting exit
415
808
status of last checker. -1 reflects crashed
809
checker, -2 means no checker completed yet.
810
last_checker_signal: The signal which killed the last checker, if
811
last_checker_status is -1
417
812
last_enabled: datetime.datetime(); (UTC) or None
418
813
name: string; from the config file, used in log messages and
419
814
D-Bus identifiers
420
815
secret: bytestring; sent verbatim (over TLS) to client
421
816
timeout: datetime.timedelta(); How long from last_checked_ok
422
817
until this client is disabled
423
extended_timeout: extra long timeout when password has been sent
818
extended_timeout: extra long timeout when secret has been sent
424
819
runtime_expansions: Allowed attributes for runtime expansion.
425
820
expires: datetime.datetime(); time (UTC) when a client will be
426
821
disabled, or None
822
server_settings: The server_settings dict from main()
429
825
runtime_expansions = ("approval_delay", "approval_duration",
430
"created", "enabled", "fingerprint",
431
"host", "interval", "last_checked_ok",
826
"created", "enabled", "expires",
827
"fingerprint", "host", "interval",
828
"last_approval_request", "last_checked_ok",
432
829
"last_enabled", "name", "timeout")
433
client_defaults = { "timeout": "5m",
434
"extended_timeout": "15m",
436
"checker": "fping -q -- %%(host)s",
438
"approval_delay": "0s",
439
"approval_duration": "1s",
440
"approved_by_default": "True",
444
def timeout_milliseconds(self):
445
"Return the 'timeout' attribute in milliseconds"
446
return timedelta_to_milliseconds(self.timeout)
448
def extended_timeout_milliseconds(self):
449
"Return the 'extended_timeout' attribute in milliseconds"
450
return timedelta_to_milliseconds(self.extended_timeout)
452
def interval_milliseconds(self):
453
"Return the 'interval' attribute in milliseconds"
454
return timedelta_to_milliseconds(self.interval)
456
def approval_delay_milliseconds(self):
457
return timedelta_to_milliseconds(self.approval_delay)
832
"extended_timeout": "PT15M",
834
"checker": "fping -q -- %%(host)s",
836
"approval_delay": "PT0S",
837
"approval_duration": "PT1S",
838
"approved_by_default": "True",
460
843
def config_parser(config):
461
""" Construct a new dict of client settings of this form:
844
"""Construct a new dict of client settings of this form:
462
845
{ client_name: {setting_name: value, ...}, ...}
463
with exceptions for any special settings as defined above"""
846
with exceptions for any special settings as defined above.
847
NOTE: Must be a pure function. Must return the same result
848
value given the same arguments.
465
851
for client_name in config.sections():
466
852
section = dict(config.items(client_name))
467
853
client = settings[client_name] = {}
469
855
client["host"] = section["host"]
470
856
# Reformat values from string types to Python types
471
857
client["approved_by_default"] = config.getboolean(
472
858
client_name, "approved_by_default")
473
client["enabled"] = config.getboolean(client_name, "enabled")
859
client["enabled"] = config.getboolean(client_name,
862
# Uppercase and remove spaces from fingerprint for later
863
# comparison purposes with return value from the
864
# fingerprint() function
475
865
client["fingerprint"] = (section["fingerprint"].upper()
476
866
.replace(" ", ""))
477
867
if "secret" in section:
478
client["secret"] = section["secret"].decode("base64")
868
client["secret"] = codecs.decode(section["secret"]
479
871
elif "secfile" in section:
480
872
with open(os.path.expanduser(os.path.expandvars
481
873
(section["secfile"])),
482
874
"rb") as secfile:
483
875
client["secret"] = secfile.read()
485
raise TypeError("No secret or secfile for section %s"
877
raise TypeError("No secret or secfile for section {}"
487
879
client["timeout"] = string_to_delta(section["timeout"])
488
880
client["extended_timeout"] = string_to_delta(
489
881
section["extended_timeout"])
531
923
self.current_checker_command = None
532
924
self.approved = None
533
925
self.approvals_pending = 0
534
self.changedstate = (multiprocessing_manager
535
.Condition(multiprocessing_manager
537
self.client_structure = [attr for attr in
538
self.__dict__.iterkeys()
926
self.changedstate = multiprocessing_manager.Condition(
927
multiprocessing_manager.Lock())
928
self.client_structure = [attr
929
for attr in self.__dict__.keys()
539
930
if not attr.startswith("_")]
540
931
self.client_structure.append("client_structure")
542
for name, t in inspect.getmembers(type(self),
933
for name, t in inspect.getmembers(
934
type(self), lambda obj: isinstance(obj, property)):
546
935
if not name.startswith("_"):
547
936
self.client_structure.append(name)
549
938
# Send notice to process children that client state has changed
550
939
def send_changedstate(self):
551
940
with self.changedstate:
552
941
self.changedstate.notify_all()
554
943
def enable(self):
555
944
"""Start this client's checker and timeout hooks"""
556
945
if getattr(self, "enabled", False):
557
946
# Already enabled
559
self.send_changedstate()
560
948
self.expires = datetime.datetime.utcnow() + self.timeout
561
949
self.enabled = True
562
950
self.last_enabled = datetime.datetime.utcnow()
563
951
self.init_checker()
952
self.send_changedstate()
565
954
def disable(self, quiet=True):
566
955
"""Disable this client."""
567
956
if not getattr(self, "enabled", False):
570
self.send_changedstate()
572
959
logger.info("Disabling client %s", self.name)
573
if getattr(self, "disable_initiator_tag", False):
574
gobject.source_remove(self.disable_initiator_tag)
960
if getattr(self, "disable_initiator_tag", None) is not None:
961
GLib.source_remove(self.disable_initiator_tag)
575
962
self.disable_initiator_tag = None
576
963
self.expires = None
577
if getattr(self, "checker_initiator_tag", False):
578
gobject.source_remove(self.checker_initiator_tag)
964
if getattr(self, "checker_initiator_tag", None) is not None:
965
GLib.source_remove(self.checker_initiator_tag)
579
966
self.checker_initiator_tag = None
580
967
self.stop_checker()
581
968
self.enabled = False
582
# Do not run this again if called by a gobject.timeout_add
970
self.send_changedstate()
971
# Do not run this again if called by a GLib.timeout_add
585
974
def __del__(self):
588
977
def init_checker(self):
589
978
# Schedule a new checker to be started an 'interval' from now,
590
979
# and every interval from then on.
591
self.checker_initiator_tag = (gobject.timeout_add
592
(self.interval_milliseconds(),
980
if self.checker_initiator_tag is not None:
981
GLib.source_remove(self.checker_initiator_tag)
982
self.checker_initiator_tag = GLib.timeout_add(
983
int(self.interval.total_seconds() * 1000),
594
985
# Schedule a disable() when 'timeout' has passed
595
self.disable_initiator_tag = (gobject.timeout_add
596
(self.timeout_milliseconds(),
986
if self.disable_initiator_tag is not None:
987
GLib.source_remove(self.disable_initiator_tag)
988
self.disable_initiator_tag = GLib.timeout_add(
989
int(self.timeout.total_seconds() * 1000), self.disable)
598
990
# Also start a new checker *right now*.
599
991
self.start_checker()
601
def checker_callback(self, pid, condition, command):
993
def checker_callback(self, source, condition, connection,
602
995
"""The checker has completed, so take appropriate actions."""
603
996
self.checker_callback_tag = None
604
997
self.checker = None
605
if os.WIFEXITED(condition):
606
self.last_checker_status = os.WEXITSTATUS(condition)
998
# Read return code from connection (see call_pipe)
999
returncode = connection.recv()
1003
self.last_checker_status = returncode
1004
self.last_checker_signal = None
607
1005
if self.last_checker_status == 0:
608
1006
logger.info("Checker for %(name)s succeeded",
610
1008
self.checked_ok()
612
logger.info("Checker for %(name)s failed",
1010
logger.info("Checker for %(name)s failed", vars(self))
615
1012
self.last_checker_status = -1
1013
self.last_checker_signal = -returncode
616
1014
logger.warning("Checker for %(name)s crashed?",
619
def checked_ok(self, timeout=None):
620
"""Bump up the timeout for this client.
622
This should only be called when the client has been seen,
1018
def checked_ok(self):
1019
"""Assert that the client has been seen, alive and well."""
1020
self.last_checked_ok = datetime.datetime.utcnow()
1021
self.last_checker_status = 0
1022
self.last_checker_signal = None
1025
def bump_timeout(self, timeout=None):
1026
"""Bump up the timeout for this client."""
625
1027
if timeout is None:
626
1028
timeout = self.timeout
627
self.last_checked_ok = datetime.datetime.utcnow()
628
1029
if self.disable_initiator_tag is not None:
629
gobject.source_remove(self.disable_initiator_tag)
1030
GLib.source_remove(self.disable_initiator_tag)
1031
self.disable_initiator_tag = None
630
1032
if getattr(self, "enabled", False):
631
self.disable_initiator_tag = (gobject.timeout_add
632
(timedelta_to_milliseconds
633
(timeout), self.disable))
1033
self.disable_initiator_tag = GLib.timeout_add(
1034
int(timeout.total_seconds() * 1000), self.disable)
634
1035
self.expires = datetime.datetime.utcnow() + timeout
636
1037
def need_approval(self):
637
1038
self.last_approval_request = datetime.datetime.utcnow()
639
1040
def start_checker(self):
640
1041
"""Start a new checker subprocess if one is not running.
642
1043
If a checker already exists, leave it running and do
644
1045
# The reason for not killing a running checker is that if we
645
# did that, then if a checker (for some reason) started
646
# running slowly and taking more than 'interval' time, the
647
# client would inevitably timeout, since no checker would get
648
# a chance to run to completion. If we instead leave running
1046
# did that, and if a checker (for some reason) started running
1047
# slowly and taking more than 'interval' time, then the client
1048
# would inevitably timeout, since no checker would get a
1049
# chance to run to completion. If we instead leave running
649
1050
# checkers alone, the checker would have to take more time
650
1051
# than 'timeout' for the client to be disabled, which is as it
653
# If a checker exists, make sure it is not a zombie
655
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
656
except (AttributeError, OSError) as error:
657
if (isinstance(error, OSError)
658
and error.errno != errno.ECHILD):
662
logger.warning("Checker was a zombie")
663
gobject.source_remove(self.checker_callback_tag)
664
self.checker_callback(pid, status,
665
self.current_checker_command)
1054
if self.checker is not None and not self.checker.is_alive():
1055
logger.warning("Checker was not alive; joining")
666
1058
# Start a new checker if needed
667
1059
if self.checker is None:
1060
# Escape attributes for the shell
1062
attr: re.escape(str(getattr(self, attr)))
1063
for attr in self.runtime_expansions}
669
# In case checker_command has exactly one % operator
670
command = self.checker_command % self.host
672
# Escape attributes for the shell
673
escaped_attrs = dict(
675
re.escape(unicode(str(getattr(self, attr, "")),
679
self.runtime_expansions)
682
command = self.checker_command % escaped_attrs
683
except TypeError as error:
684
logger.error('Could not format string "%s":'
685
' %s', self.checker_command, error)
686
return True # Try again later
1065
command = self.checker_command % escaped_attrs
1066
except TypeError as error:
1067
logger.error('Could not format string "%s"',
1068
self.checker_command,
1070
return True # Try again later
687
1071
self.current_checker_command = command
689
logger.info("Starting checker %r for %s",
691
# We don't need to redirect stdout and stderr, since
692
# in normal mode, that is already done by daemon(),
693
# and in debug mode we don't want to. (Stdin is
694
# always replaced by /dev/null.)
695
self.checker = subprocess.Popen(command,
698
self.checker_callback_tag = (gobject.child_watch_add
700
self.checker_callback,
702
# The checker may have completed before the gobject
703
# watch was added. Check for this.
704
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
706
gobject.source_remove(self.checker_callback_tag)
707
self.checker_callback(pid, status, command)
708
except OSError as error:
709
logger.error("Failed to start subprocess: %s",
711
# Re-run this periodically if run by gobject.timeout_add
1072
logger.info("Starting checker %r for %s", command,
1074
# We don't need to redirect stdout and stderr, since
1075
# in normal mode, that is already done by daemon(),
1076
# and in debug mode we don't want to. (Stdin is
1077
# always replaced by /dev/null.)
1078
# The exception is when not debugging but nevertheless
1079
# running in the foreground; use the previously
1081
popen_args = {"close_fds": True,
1084
if (not self.server_settings["debug"]
1085
and self.server_settings["foreground"]):
1086
popen_args.update({"stdout": wnull,
1088
pipe = multiprocessing.Pipe(duplex=False)
1089
self.checker = multiprocessing.Process(
1091
args=(pipe[1], subprocess.call, command),
1093
self.checker.start()
1094
self.checker_callback_tag = GLib.io_add_watch(
1095
pipe[0].fileno(), GLib.IO_IN,
1096
self.checker_callback, pipe[0], command)
1097
# Re-run this periodically if run by GLib.timeout_add
714
1100
def stop_checker(self):
715
1101
"""Force the checker process, if any, to stop."""
716
1102
if self.checker_callback_tag:
717
gobject.source_remove(self.checker_callback_tag)
1103
GLib.source_remove(self.checker_callback_tag)
718
1104
self.checker_callback_tag = None
719
1105
if getattr(self, "checker", None) is None:
721
1107
logger.debug("Stopping checker for %(name)s", vars(self))
723
os.kill(self.checker.pid, signal.SIGTERM)
725
#if self.checker.poll() is None:
726
# os.kill(self.checker.pid, signal.SIGKILL)
727
except OSError as error:
728
if error.errno != errno.ESRCH: # No such process
1108
self.checker.terminate()
730
1109
self.checker = None
733
def dbus_service_property(dbus_interface, signature="v",
734
access="readwrite", byte_arrays=False):
1112
def dbus_service_property(dbus_interface,
735
1116
"""Decorators for marking methods of a DBusObjectWithProperties to
736
1117
become properties on the D-Bus.
738
1119
The decorated method will be called with no arguments by "Get"
739
1120
and with one argument by "Set".
741
1122
The parameters, where they are supported, are the same as
742
1123
dbus.service.method, except there is only "signature", since the
743
1124
type from Get() and the type sent to Set() is the same.
782
class DBusObjectWithProperties(dbus.service.Object):
1207
class DBusObjectWithAnnotations(dbus.service.Object):
1208
"""A D-Bus object with annotations.
1210
Classes inheriting from this can use the dbus_annotations
1211
decorator to add annotations to methods or signals.
1215
def _is_dbus_thing(thing):
1216
"""Returns a function testing if an attribute is a D-Bus thing
1218
If called like _is_dbus_thing("method") it returns a function
1219
suitable for use as predicate to inspect.getmembers().
1221
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1224
def _get_all_dbus_things(self, thing):
1225
"""Returns a generator of (name, attribute) pairs
1227
return ((getattr(athing.__get__(self), "_dbus_name", name),
1228
athing.__get__(self))
1229
for cls in self.__class__.__mro__
1231
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1233
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1235
path_keyword='object_path',
1236
connection_keyword='connection')
1237
def Introspect(self, object_path, connection):
1238
"""Overloading of standard D-Bus method.
1240
Inserts annotation tags on methods and signals.
1242
xmlstring = dbus.service.Object.Introspect(self, object_path,
1245
document = xml.dom.minidom.parseString(xmlstring)
1247
for if_tag in document.getElementsByTagName("interface"):
1248
# Add annotation tags
1249
for typ in ("method", "signal"):
1250
for tag in if_tag.getElementsByTagName(typ):
1252
for name, prop in (self.
1253
_get_all_dbus_things(typ)):
1254
if (name == tag.getAttribute("name")
1255
and prop._dbus_interface
1256
== if_tag.getAttribute("name")):
1257
annots.update(getattr(
1258
prop, "_dbus_annotations", {}))
1259
for name, value in annots.items():
1260
ann_tag = document.createElement(
1262
ann_tag.setAttribute("name", name)
1263
ann_tag.setAttribute("value", value)
1264
tag.appendChild(ann_tag)
1265
# Add interface annotation tags
1266
for annotation, value in dict(
1267
itertools.chain.from_iterable(
1268
annotations().items()
1269
for name, annotations
1270
in self._get_all_dbus_things("interface")
1271
if name == if_tag.getAttribute("name")
1273
ann_tag = document.createElement("annotation")
1274
ann_tag.setAttribute("name", annotation)
1275
ann_tag.setAttribute("value", value)
1276
if_tag.appendChild(ann_tag)
1277
# Fix argument name for the Introspect method itself
1278
if (if_tag.getAttribute("name")
1279
== dbus.INTROSPECTABLE_IFACE):
1280
for cn in if_tag.getElementsByTagName("method"):
1281
if cn.getAttribute("name") == "Introspect":
1282
for arg in cn.getElementsByTagName("arg"):
1283
if (arg.getAttribute("direction")
1285
arg.setAttribute("name",
1287
xmlstring = document.toxml("utf-8")
1289
except (AttributeError, xml.dom.DOMException,
1290
xml.parsers.expat.ExpatError) as error:
1291
logger.error("Failed to override Introspection method",
1296
class DBusObjectWithProperties(DBusObjectWithAnnotations):
783
1297
"""A D-Bus object with properties.
785
1299
Classes inheriting from this can use the dbus_service_property
786
1300
decorator to expose methods as D-Bus properties. It exposes the
787
1301
standard Get(), Set(), and GetAll() methods on the D-Bus.
791
def _is_dbus_property(obj):
792
return getattr(obj, "_dbus_is_property", False)
794
def _get_all_dbus_properties(self):
795
"""Returns a generator of (name, attribute) pairs
797
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
798
for cls in self.__class__.__mro__
800
inspect.getmembers(cls, self._is_dbus_property))
802
1304
def _get_dbus_property(self, interface_name, property_name):
803
1305
"""Returns a bound method if one exists which is a D-Bus
804
1306
property with the specified name and interface.
806
for cls in self.__class__.__mro__:
807
for name, value in (inspect.getmembers
808
(cls, self._is_dbus_property)):
1308
for cls in self.__class__.__mro__:
1309
for name, value in inspect.getmembers(
1310
cls, self._is_dbus_thing("property")):
809
1311
if (value._dbus_name == property_name
810
1312
and value._dbus_interface == interface_name):
811
1313
return value.__get__(self)
813
1315
# No such property
814
raise DBusPropertyNotFound(self.dbus_object_path + ":"
815
+ interface_name + "."
818
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1316
raise DBusPropertyNotFound("{}:{}.{}".format(
1317
self.dbus_object_path, interface_name, property_name))
1320
def _get_all_interface_names(cls):
1321
"""Get a sequence of all interfaces supported by an object"""
1322
return (name for name in set(getattr(getattr(x, attr),
1323
"_dbus_interface", None)
1324
for x in (inspect.getmro(cls))
1326
if name is not None)
1328
@dbus.service.method(dbus.PROPERTIES_IFACE,
819
1330
out_signature="v")
820
1331
def Get(self, interface_name, property_name):
821
1332
"""Standard D-Bus property Get() method, see D-Bus standard.
865
1379
if not hasattr(value, "variant_level"):
866
1380
properties[name] = value
868
properties[name] = type(value)(value, variant_level=
869
value.variant_level+1)
1382
properties[name] = type(value)(
1383
value, variant_level=value.variant_level + 1)
870
1384
return dbus.Dictionary(properties, signature="sv")
1386
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1387
def PropertiesChanged(self, interface_name, changed_properties,
1388
invalidated_properties):
1389
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
872
1394
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
873
1395
out_signature="s",
874
1396
path_keyword='object_path',
875
1397
connection_keyword='connection')
876
1398
def Introspect(self, object_path, connection):
877
"""Standard D-Bus method, overloaded to insert property tags.
1399
"""Overloading of standard D-Bus method.
1401
Inserts property tags and interface annotation tags.
879
xmlstring = dbus.service.Object.Introspect(self, object_path,
1403
xmlstring = DBusObjectWithAnnotations.Introspect(self,
882
1407
document = xml.dom.minidom.parseString(xmlstring)
883
1409
def make_tag(document, name, prop):
884
1410
e = document.createElement("property")
885
1411
e.setAttribute("name", name)
886
1412
e.setAttribute("type", prop._dbus_signature)
887
1413
e.setAttribute("access", prop._dbus_access)
889
1416
for if_tag in document.getElementsByTagName("interface"):
890
1418
for tag in (make_tag(document, name, prop)
892
in self._get_all_dbus_properties()
1420
in self._get_all_dbus_things("property")
893
1421
if prop._dbus_interface
894
1422
== if_tag.getAttribute("name")):
895
1423
if_tag.appendChild(tag)
1424
# Add annotation tags for properties
1425
for tag in if_tag.getElementsByTagName("property"):
1427
for name, prop in self._get_all_dbus_things(
1429
if (name == tag.getAttribute("name")
1430
and prop._dbus_interface
1431
== if_tag.getAttribute("name")):
1432
annots.update(getattr(
1433
prop, "_dbus_annotations", {}))
1434
for name, value in annots.items():
1435
ann_tag = document.createElement(
1437
ann_tag.setAttribute("name", name)
1438
ann_tag.setAttribute("value", value)
1439
tag.appendChild(ann_tag)
896
1440
# Add the names to the return values for the
897
1441
# "org.freedesktop.DBus.Properties" methods
898
1442
if (if_tag.getAttribute("name")
913
1457
except (AttributeError, xml.dom.DOMException,
914
1458
xml.parsers.expat.ExpatError) as error:
915
1459
logger.error("Failed to override Introspection method",
920
def datetime_to_dbus (dt, variant_level=0):
1465
dbus.OBJECT_MANAGER_IFACE
1466
except AttributeError:
1467
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1470
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1471
"""A D-Bus object with an ObjectManager.
1473
Classes inheriting from this exposes the standard
1474
GetManagedObjects call and the InterfacesAdded and
1475
InterfacesRemoved signals on the standard
1476
"org.freedesktop.DBus.ObjectManager" interface.
1478
Note: No signals are sent automatically; they must be sent
1481
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1482
out_signature="a{oa{sa{sv}}}")
1483
def GetManagedObjects(self):
1484
"""This function must be overridden"""
1485
raise NotImplementedError()
1487
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1488
signature="oa{sa{sv}}")
1489
def InterfacesAdded(self, object_path, interfaces_and_properties):
1492
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1493
def InterfacesRemoved(self, object_path, interfaces):
1496
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1498
path_keyword='object_path',
1499
connection_keyword='connection')
1500
def Introspect(self, object_path, connection):
1501
"""Overloading of standard D-Bus method.
1503
Override return argument name of GetManagedObjects to be
1504
"objpath_interfaces_and_properties"
1506
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1510
document = xml.dom.minidom.parseString(xmlstring)
1512
for if_tag in document.getElementsByTagName("interface"):
1513
# Fix argument name for the GetManagedObjects method
1514
if (if_tag.getAttribute("name")
1515
== dbus.OBJECT_MANAGER_IFACE):
1516
for cn in if_tag.getElementsByTagName("method"):
1517
if (cn.getAttribute("name")
1518
== "GetManagedObjects"):
1519
for arg in cn.getElementsByTagName("arg"):
1520
if (arg.getAttribute("direction")
1524
"objpath_interfaces"
1526
xmlstring = document.toxml("utf-8")
1528
except (AttributeError, xml.dom.DOMException,
1529
xml.parsers.expat.ExpatError) as error:
1530
logger.error("Failed to override Introspection method",
1535
def datetime_to_dbus(dt, variant_level=0):
921
1536
"""Convert a UTC datetime.datetime() to a D-Bus type."""
923
return dbus.String("", variant_level = variant_level)
924
return dbus.String(dt.isoformat(),
925
variant_level=variant_level)
928
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
930
"""Applied to an empty subclass of a D-Bus object, this metaclass
931
will add additional D-Bus attributes matching a certain pattern.
1538
return dbus.String("", variant_level=variant_level)
1539
return dbus.String(dt.isoformat(), variant_level=variant_level)
1542
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1543
"""A class decorator; applied to a subclass of
1544
dbus.service.Object, it will add alternate D-Bus attributes with
1545
interface names according to the "alt_interface_names" mapping.
1548
@alternate_dbus_interfaces({"org.example.Interface":
1549
"net.example.AlternateInterface"})
1550
class SampleDBusObject(dbus.service.Object):
1551
@dbus.service.method("org.example.Interface")
1552
def SampleDBusMethod():
1555
The above "SampleDBusMethod" on "SampleDBusObject" will be
1556
reachable via two interfaces: "org.example.Interface" and
1557
"net.example.AlternateInterface", the latter of which will have
1558
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1559
"true", unless "deprecate" is passed with a False value.
1561
This works for methods and signals, and also for D-Bus properties
1562
(from DBusObjectWithProperties) and interfaces (from the
1563
dbus_interface_annotations decorator).
933
def __new__(mcs, name, bases, attr):
934
# Go through all the base classes which could have D-Bus
935
# methods, signals, or properties in them
936
for base in (b for b in bases
937
if issubclass(b, dbus.service.Object)):
938
# Go though all attributes of the base class
939
for attrname, attribute in inspect.getmembers(base):
1567
for orig_interface_name, alt_interface_name in (
1568
alt_interface_names.items()):
1570
interface_names = set()
1571
# Go though all attributes of the class
1572
for attrname, attribute in inspect.getmembers(cls):
940
1573
# Ignore non-D-Bus attributes, and D-Bus attributes
941
1574
# with the wrong interface name
942
1575
if (not hasattr(attribute, "_dbus_interface")
943
or not attribute._dbus_interface
944
.startswith("se.recompile.Mandos")):
1576
or not attribute._dbus_interface.startswith(
1577
orig_interface_name)):
946
1579
# Create an alternate D-Bus interface name based on
947
1580
# the current name
948
alt_interface = (attribute._dbus_interface
949
.replace("se.recompile.Mandos",
950
"se.bsnet.fukt.Mandos"))
1581
alt_interface = attribute._dbus_interface.replace(
1582
orig_interface_name, alt_interface_name)
1583
interface_names.add(alt_interface)
951
1584
# Is this a D-Bus signal?
952
1585
if getattr(attribute, "_dbus_is_signal", False):
953
# Extract the original non-method function by
955
nonmethod_func = (dict(
1586
# Extract the original non-method undecorated
1587
# function by black magic
1588
if sys.version_info.major == 2:
1589
nonmethod_func = (dict(
956
1590
zip(attribute.func_code.co_freevars,
957
attribute.__closure__))["func"]
1591
attribute.__closure__))
1592
["func"].cell_contents)
1594
nonmethod_func = (dict(
1595
zip(attribute.__code__.co_freevars,
1596
attribute.__closure__))
1597
["func"].cell_contents)
959
1598
# Create a new, but exactly alike, function
960
1599
# object, and decorate it to be a new D-Bus signal
961
1600
# with the alternate D-Bus interface name
962
new_function = (dbus.service.signal
964
attribute._dbus_signature)
966
nonmethod_func.func_code,
967
nonmethod_func.func_globals,
968
nonmethod_func.func_name,
969
nonmethod_func.func_defaults,
970
nonmethod_func.func_closure)))
1601
new_function = copy_function(nonmethod_func)
1602
new_function = (dbus.service.signal(
1604
attribute._dbus_signature)(new_function))
1605
# Copy annotations, if any
1607
new_function._dbus_annotations = dict(
1608
attribute._dbus_annotations)
1609
except AttributeError:
971
1612
# Define a creator of a function to call both the
972
# old and new functions, so both the old and new
973
# signals gets sent when the function is called
1613
# original and alternate functions, so both the
1614
# original and alternate signals gets sent when
1615
# the function is called
974
1616
def fixscope(func1, func2):
975
1617
"""This function is a scope container to pass
976
1618
func1 and func2 to the "call_both" function
977
1619
outside of its arguments"""
1621
@functools.wraps(func2)
978
1622
def call_both(*args, **kwargs):
979
1623
"""This function will emit two D-Bus
980
1624
signals by calling func1 and func2"""
981
1625
func1(*args, **kwargs)
982
1626
func2(*args, **kwargs)
1627
# Make wrapper function look like a D-Bus
1629
for name, attr in inspect.getmembers(func2):
1630
if name.startswith("_dbus_"):
1631
setattr(call_both, name, attr)
983
1633
return call_both
984
1634
# Create the "call_both" function and add it to
986
attr[attrname] = fixscope(attribute,
1636
attr[attrname] = fixscope(attribute, new_function)
988
1637
# Is this a D-Bus method?
989
1638
elif getattr(attribute, "_dbus_is_method", False):
990
1639
# Create a new, but exactly alike, function
991
1640
# object. Decorate it to be a new D-Bus method
992
1641
# with the alternate D-Bus interface name. Add it
994
attr[attrname] = (dbus.service.method
996
attribute._dbus_in_signature,
997
attribute._dbus_out_signature)
999
(attribute.func_code,
1000
attribute.func_globals,
1001
attribute.func_name,
1002
attribute.func_defaults,
1003
attribute.func_closure)))
1644
dbus.service.method(
1646
attribute._dbus_in_signature,
1647
attribute._dbus_out_signature)
1648
(copy_function(attribute)))
1649
# Copy annotations, if any
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1653
except AttributeError:
1004
1655
# Is this a D-Bus property?
1005
1656
elif getattr(attribute, "_dbus_is_property", False):
1006
1657
# Create a new, but exactly alike, function
1007
1658
# object, and decorate it to be a new D-Bus
1008
1659
# property with the alternate D-Bus interface
1009
1660
# name. Add it to the class.
1010
attr[attrname] = (dbus_service_property
1012
attribute._dbus_signature,
1013
attribute._dbus_access,
1015
._dbus_get_args_options
1018
(attribute.func_code,
1019
attribute.func_globals,
1020
attribute.func_name,
1021
attribute.func_defaults,
1022
attribute.func_closure)))
1023
return type.__new__(mcs, name, bases, attr)
1661
attr[attrname] = (dbus_service_property(
1662
alt_interface, attribute._dbus_signature,
1663
attribute._dbus_access,
1664
attribute._dbus_get_args_options
1666
(copy_function(attribute)))
1667
# Copy annotations, if any
1669
attr[attrname]._dbus_annotations = dict(
1670
attribute._dbus_annotations)
1671
except AttributeError:
1673
# Is this a D-Bus interface?
1674
elif getattr(attribute, "_dbus_is_interface", False):
1675
# Create a new, but exactly alike, function
1676
# object. Decorate it to be a new D-Bus interface
1677
# with the alternate D-Bus interface name. Add it
1680
dbus_interface_annotations(alt_interface)
1681
(copy_function(attribute)))
1683
# Deprecate all alternate interfaces
1684
iname = "_AlternateDBusNames_interface_annotation{}"
1685
for interface_name in interface_names:
1687
@dbus_interface_annotations(interface_name)
1689
return {"org.freedesktop.DBus.Deprecated":
1691
# Find an unused name
1692
for aname in (iname.format(i)
1693
for i in itertools.count()):
1694
if aname not in attr:
1698
# Replace the class with a new subclass of it with
1699
# methods, signals, etc. as created above.
1700
if sys.version_info.major == 2:
1701
cls = type(b"{}Alternate".format(cls.__name__),
1704
cls = type("{}Alternate".format(cls.__name__),
1711
@alternate_dbus_interfaces({"se.recompile.Mandos":
1712
"se.bsnet.fukt.Mandos"})
1026
1713
class ClientDBus(Client, DBusObjectWithProperties):
1027
1714
"""A Client class using D-Bus
1030
1717
dbus_object_path: dbus.ObjectPath
1031
1718
bus: dbus.SystemBus()
1034
1721
runtime_expansions = (Client.runtime_expansions
1035
+ ("dbus_object_path",))
1722
+ ("dbus_object_path", ))
1724
_interface = "se.recompile.Mandos.Client"
1037
1726
# dbus.service.Object doesn't use super(), so we can't either.
1039
def __init__(self, bus = None, *args, **kwargs):
1728
def __init__(self, bus=None, *args, **kwargs):
1041
1730
Client.__init__(self, *args, **kwargs)
1042
self._approvals_pending = 0
1044
self._approvals_pending = 0
1045
1731
# Only now, when this client is initialized, can it show up on
1047
client_object_name = unicode(self.name).translate(
1733
client_object_name = str(self.name).translate(
1048
1734
{ord("."): ord("_"),
1049
1735
ord("-"): ord("_")})
1050
self.dbus_object_path = (dbus.ObjectPath
1051
("/clients/" + client_object_name))
1736
self.dbus_object_path = dbus.ObjectPath(
1737
"/clients/" + client_object_name)
1052
1738
DBusObjectWithProperties.__init__(self, self.bus,
1053
1739
self.dbus_object_path)
1055
def notifychangeproperty(transform_func,
1056
dbus_name, type_func=lambda x: x,
1741
def notifychangeproperty(transform_func, dbus_name,
1742
type_func=lambda x: x,
1744
invalidate_only=False,
1745
_interface=_interface):
1058
1746
""" Modify a variable so that it's a property which announces
1059
1747
its changes to DBus.
1061
1749
transform_fun: Function that takes a value and a variant_level
1062
1750
and transforms it to a D-Bus type.
1063
1751
dbus_name: D-Bus name of the variable
1065
1753
to the D-Bus. Default: no transform
1066
1754
variant_level: D-Bus variant level. Default: 1
1068
attrname = "_{0}".format(dbus_name)
1756
attrname = "_{}".format(dbus_name)
1069
1758
def setter(self, value):
1070
1759
if hasattr(self, "dbus_object_path"):
1071
1760
if (not hasattr(self, attrname) or
1072
1761
type_func(getattr(self, attrname, None))
1073
1762
!= type_func(value)):
1074
dbus_value = transform_func(type_func(value),
1077
self.PropertyChanged(dbus.String(dbus_name),
1764
self.PropertiesChanged(
1765
_interface, dbus.Dictionary(),
1766
dbus.Array((dbus_name, )))
1768
dbus_value = transform_func(
1770
variant_level=variant_level)
1771
self.PropertyChanged(dbus.String(dbus_name),
1773
self.PropertiesChanged(
1775
dbus.Dictionary({dbus.String(dbus_name):
1079
1778
setattr(self, attrname, value)
1081
1780
return property(lambda self: getattr(self, attrname), setter)
1084
1782
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1085
1783
approvals_pending = notifychangeproperty(dbus.Boolean,
1086
1784
"ApprovalPending",
1088
1786
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1089
1787
last_enabled = notifychangeproperty(datetime_to_dbus,
1091
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1092
type_func = lambda checker:
1093
checker is not None)
1789
checker = notifychangeproperty(
1790
dbus.Boolean, "CheckerRunning",
1791
type_func=lambda checker: checker is not None)
1094
1792
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1095
1793
"LastCheckedOK")
1794
last_checker_status = notifychangeproperty(dbus.Int16,
1795
"LastCheckerStatus")
1096
1796
last_approval_request = notifychangeproperty(
1097
1797
datetime_to_dbus, "LastApprovalRequest")
1098
1798
approved_by_default = notifychangeproperty(dbus.Boolean,
1099
1799
"ApprovedByDefault")
1100
approval_delay = notifychangeproperty(dbus.UInt64,
1103
timedelta_to_milliseconds)
1800
approval_delay = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDelay",
1802
type_func=lambda td: td.total_seconds() * 1000)
1104
1803
approval_duration = notifychangeproperty(
1105
1804
dbus.UInt64, "ApprovalDuration",
1106
type_func = timedelta_to_milliseconds)
1805
type_func=lambda td: td.total_seconds() * 1000)
1107
1806
host = notifychangeproperty(dbus.String, "Host")
1108
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1110
timedelta_to_milliseconds)
1807
timeout = notifychangeproperty(
1808
dbus.UInt64, "Timeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
1111
1810
extended_timeout = notifychangeproperty(
1112
1811
dbus.UInt64, "ExtendedTimeout",
1113
type_func = timedelta_to_milliseconds)
1114
interval = notifychangeproperty(dbus.UInt64,
1117
timedelta_to_milliseconds)
1812
type_func=lambda td: td.total_seconds() * 1000)
1813
interval = notifychangeproperty(
1814
dbus.UInt64, "Interval",
1815
type_func=lambda td: td.total_seconds() * 1000)
1118
1816
checker_command = notifychangeproperty(dbus.String, "Checker")
1817
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1818
invalidate_only=True)
1120
1820
del notifychangeproperty
1122
1822
def __del__(self, *args, **kwargs):
1124
1824
self.remove_from_connection()
1204
1903
server to mandos-client
1208
1907
# Rejected - signal
1209
1908
@dbus.service.signal(_interface, signature="s")
1210
1909
def Rejected(self, reason):
1214
1913
# NeedApproval - signal
1215
1914
@dbus.service.signal(_interface, signature="tb")
1216
1915
def NeedApproval(self, timeout, default):
1218
1917
return self.need_approval()
1220
# NeRwequest - signal
1221
@dbus.service.signal(_interface, signature="s")
1222
def NewRequest(self, ip):
1224
Is sent after a client request a password.
1230
1921
# Approve - method
1231
1922
@dbus.service.method(_interface, in_signature="b")
1232
1923
def Approve(self, value):
1233
1924
self.approve(value)
1235
1926
# CheckedOK - method
1236
1927
@dbus.service.method(_interface)
1237
1928
def CheckedOK(self):
1238
1929
self.checked_ok()
1240
1931
# Enable - method
1932
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1241
1933
@dbus.service.method(_interface)
1242
1934
def Enable(self):
1246
1938
# StartChecker - method
1939
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1247
1940
@dbus.service.method(_interface)
1248
1941
def StartChecker(self):
1250
1943
self.start_checker()
1252
1945
# Disable - method
1946
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1253
1947
@dbus.service.method(_interface)
1254
1948
def Disable(self):
1258
1952
# StopChecker - method
1953
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1259
1954
@dbus.service.method(_interface)
1260
1955
def StopChecker(self):
1261
1956
self.stop_checker()
1265
1960
# ApprovalPending - property
1266
1961
@dbus_service_property(_interface, signature="b", access="read")
1267
1962
def ApprovalPending_dbus_property(self):
1268
1963
return dbus.Boolean(bool(self.approvals_pending))
1270
1965
# ApprovedByDefault - property
1271
@dbus_service_property(_interface, signature="b",
1966
@dbus_service_property(_interface,
1272
1968
access="readwrite")
1273
1969
def ApprovedByDefault_dbus_property(self, value=None):
1274
1970
if value is None: # get
1275
1971
return dbus.Boolean(self.approved_by_default)
1276
1972
self.approved_by_default = bool(value)
1278
1974
# ApprovalDelay - property
1279
@dbus_service_property(_interface, signature="t",
1975
@dbus_service_property(_interface,
1280
1977
access="readwrite")
1281
1978
def ApprovalDelay_dbus_property(self, value=None):
1282
1979
if value is None: # get
1283
return dbus.UInt64(self.approval_delay_milliseconds())
1980
return dbus.UInt64(self.approval_delay.total_seconds()
1284
1982
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1286
1984
# ApprovalDuration - property
1287
@dbus_service_property(_interface, signature="t",
1985
@dbus_service_property(_interface,
1288
1987
access="readwrite")
1289
1988
def ApprovalDuration_dbus_property(self, value=None):
1290
1989
if value is None: # get
1291
return dbus.UInt64(timedelta_to_milliseconds(
1292
self.approval_duration))
1990
return dbus.UInt64(self.approval_duration.total_seconds()
1293
1992
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1295
1994
# Name - property
1996
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1296
1997
@dbus_service_property(_interface, signature="s", access="read")
1297
1998
def Name_dbus_property(self):
1298
1999
return dbus.String(self.name)
1300
2001
# Fingerprint - property
2003
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1301
2004
@dbus_service_property(_interface, signature="s", access="read")
1302
2005
def Fingerprint_dbus_property(self):
1303
2006
return dbus.String(self.fingerprint)
1305
2008
# Host - property
1306
@dbus_service_property(_interface, signature="s",
2009
@dbus_service_property(_interface,
1307
2011
access="readwrite")
1308
2012
def Host_dbus_property(self, value=None):
1309
2013
if value is None: # get
1310
2014
return dbus.String(self.host)
1311
self.host = unicode(value)
2015
self.host = str(value)
1313
2017
# Created - property
2019
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1314
2020
@dbus_service_property(_interface, signature="s", access="read")
1315
2021
def Created_dbus_property(self):
1316
2022
return datetime_to_dbus(self.created)
1318
2024
# LastEnabled - property
1319
2025
@dbus_service_property(_interface, signature="s", access="read")
1320
2026
def LastEnabled_dbus_property(self):
1321
2027
return datetime_to_dbus(self.last_enabled)
1323
2029
# Enabled - property
1324
@dbus_service_property(_interface, signature="b",
2030
@dbus_service_property(_interface,
1325
2032
access="readwrite")
1326
2033
def Enabled_dbus_property(self, value=None):
1327
2034
if value is None: # get
1334
2041
# LastCheckedOK - property
1335
@dbus_service_property(_interface, signature="s",
2042
@dbus_service_property(_interface,
1336
2044
access="readwrite")
1337
2045
def LastCheckedOK_dbus_property(self, value=None):
1338
2046
if value is not None:
1339
2047
self.checked_ok()
1341
2049
return datetime_to_dbus(self.last_checked_ok)
2051
# LastCheckerStatus - property
2052
@dbus_service_property(_interface, signature="n", access="read")
2053
def LastCheckerStatus_dbus_property(self):
2054
return dbus.Int16(self.last_checker_status)
1343
2056
# Expires - property
1344
2057
@dbus_service_property(_interface, signature="s", access="read")
1345
2058
def Expires_dbus_property(self):
1346
2059
return datetime_to_dbus(self.expires)
1348
2061
# LastApprovalRequest - property
1349
2062
@dbus_service_property(_interface, signature="s", access="read")
1350
2063
def LastApprovalRequest_dbus_property(self):
1351
2064
return datetime_to_dbus(self.last_approval_request)
1353
2066
# Timeout - property
1354
@dbus_service_property(_interface, signature="t",
2067
@dbus_service_property(_interface,
1355
2069
access="readwrite")
1356
2070
def Timeout_dbus_property(self, value=None):
1357
2071
if value is None: # get
1358
return dbus.UInt64(self.timeout_milliseconds())
2072
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2073
old_timeout = self.timeout
1359
2074
self.timeout = datetime.timedelta(0, 0, 0, value)
1360
if getattr(self, "disable_initiator_tag", None) is None:
1362
# Reschedule timeout
1363
gobject.source_remove(self.disable_initiator_tag)
1364
self.disable_initiator_tag = None
1366
time_to_die = timedelta_to_milliseconds((self
1371
if time_to_die <= 0:
1372
# The timeout has passed
1375
self.expires = (datetime.datetime.utcnow()
1376
+ datetime.timedelta(milliseconds =
1378
self.disable_initiator_tag = (gobject.timeout_add
1379
(time_to_die, self.disable))
2075
# Reschedule disabling
2077
now = datetime.datetime.utcnow()
2078
self.expires += self.timeout - old_timeout
2079
if self.expires <= now:
2080
# The timeout has passed
2083
if (getattr(self, "disable_initiator_tag", None)
2086
GLib.source_remove(self.disable_initiator_tag)
2087
self.disable_initiator_tag = GLib.timeout_add(
2088
int((self.expires - now).total_seconds() * 1000),
1381
2091
# ExtendedTimeout - property
1382
@dbus_service_property(_interface, signature="t",
2092
@dbus_service_property(_interface,
1383
2094
access="readwrite")
1384
2095
def ExtendedTimeout_dbus_property(self, value=None):
1385
2096
if value is None: # get
1386
return dbus.UInt64(self.extended_timeout_milliseconds())
2097
return dbus.UInt64(self.extended_timeout.total_seconds()
1387
2099
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1389
2101
# Interval - property
1390
@dbus_service_property(_interface, signature="t",
2102
@dbus_service_property(_interface,
1391
2104
access="readwrite")
1392
2105
def Interval_dbus_property(self, value=None):
1393
2106
if value is None: # get
1394
return dbus.UInt64(self.interval_milliseconds())
2107
return dbus.UInt64(self.interval.total_seconds() * 1000)
1395
2108
self.interval = datetime.timedelta(0, 0, 0, value)
1396
2109
if getattr(self, "checker_initiator_tag", None) is None:
1398
2111
if self.enabled:
1399
2112
# Reschedule checker run
1400
gobject.source_remove(self.checker_initiator_tag)
1401
self.checker_initiator_tag = (gobject.timeout_add
1402
(value, self.start_checker))
1403
self.start_checker() # Start one now, too
2113
GLib.source_remove(self.checker_initiator_tag)
2114
self.checker_initiator_tag = GLib.timeout_add(
2115
value, self.start_checker)
2116
self.start_checker() # Start one now, too
1405
2118
# Checker - property
1406
@dbus_service_property(_interface, signature="s",
2119
@dbus_service_property(_interface,
1407
2121
access="readwrite")
1408
2122
def Checker_dbus_property(self, value=None):
1409
2123
if value is None: # get
1410
2124
return dbus.String(self.checker_command)
1411
self.checker_command = unicode(value)
2125
self.checker_command = str(value)
1413
2127
# CheckerRunning - property
1414
@dbus_service_property(_interface, signature="b",
2128
@dbus_service_property(_interface,
1415
2130
access="readwrite")
1416
2131
def CheckerRunning_dbus_property(self, value=None):
1417
2132
if value is None: # get
1450
2173
if data[0] == 'data':
1452
2175
if data[0] == 'function':
1453
2177
def func(*args, **kwargs):
1454
2178
self._pipe.send(('funcall', name, args, kwargs))
1455
2179
return self._pipe.recv()[1]
1458
2183
def __setattr__(self, name, value):
1459
2184
if name == '_pipe':
1460
2185
return super(ProxyClient, self).__setattr__(name, value)
1461
2186
self._pipe.send(('setattr', name, value))
1464
class ClientDBusTransitional(ClientDBus):
1465
__metaclass__ = AlternateDBusNamesMetaclass
1468
2189
class ClientHandler(socketserver.BaseRequestHandler, object):
1469
2190
"""A class to handle client connections.
1471
2192
Instantiated once for each connection to handle it.
1472
2193
Note: This will run in its own forked process."""
1474
2195
def handle(self):
1475
2196
with contextlib.closing(self.server.child_pipe) as child_pipe:
1476
2197
logger.info("TCP connection from: %s",
1477
unicode(self.client_address))
2198
str(self.client_address))
1478
2199
logger.debug("Pipe FD: %d",
1479
2200
self.server.child_pipe.fileno())
1481
session = (gnutls.connection
1482
.ClientSession(self.request,
1484
.X509Credentials()))
1486
# Note: gnutls.connection.X509Credentials is really a
1487
# generic GnuTLS certificate credentials object so long as
1488
# no X.509 keys are added to it. Therefore, we can use it
1489
# here despite using OpenPGP certificates.
1491
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1492
# "+AES-256-CBC", "+SHA1",
1493
# "+COMP-NULL", "+CTYPE-OPENPGP",
2202
session = gnutls.ClientSession(self.request)
2204
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2205
# "+AES-256-CBC", "+SHA1",
2206
# "+COMP-NULL", "+CTYPE-OPENPGP",
1495
2208
# Use a fallback default, since this MUST be set.
1496
2209
priority = self.server.gnutls_priority
1497
2210
if priority is None:
1498
2211
priority = "NORMAL"
1499
(gnutls.library.functions
1500
.gnutls_priority_set_direct(session._c_object,
2212
gnutls.priority_set_direct(session._c_object,
2213
priority.encode("utf-8"),
1503
2216
# Start communication using the Mandos protocol
1504
2217
# Get protocol number
1505
2218
line = self.request.makefile().readline()
1506
2219
logger.debug("Protocol version: %r", line)
1508
2221
if int(line.strip().split()[0]) > 1:
2222
raise RuntimeError(line)
1510
2223
except (ValueError, IndexError, RuntimeError) as error:
1511
2224
logger.error("Unknown protocol version: %s", error)
1514
2227
# Start GnuTLS connection
1516
2229
session.handshake()
1517
except gnutls.errors.GNUTLSError as error:
2230
except gnutls.Error as error:
1518
2231
logger.warning("Handshake failed: %s", error)
1519
2232
# Do not run session.bye() here: the session is not
1520
2233
# established. Just abandon the request.
1522
2235
logger.debug("Handshake succeeded")
1524
2237
approval_required = False
1527
fpr = self.fingerprint(self.peer_certificate
1530
gnutls.errors.GNUTLSError) as error:
2240
fpr = self.fingerprint(
2241
self.peer_certificate(session))
2242
except (TypeError, gnutls.Error) as error:
1531
2243
logger.warning("Bad certificate: %s", error)
1533
2245
logger.debug("Fingerprint: %s", fpr)
1536
2248
client = ProxyClient(child_pipe, fpr,
1537
2249
self.client_address)
1538
2250
except KeyError:
1541
if self.server.use_dbus:
1543
client.NewRequest(str(self.client_address))
1545
2253
if client.approval_delay:
1546
2254
delay = client.approval_delay
1547
2255
client.approvals_pending += 1
1548
2256
approval_required = True
1551
2259
if not client.enabled:
1552
2260
logger.info("Client %s is disabled",
1554
2262
if self.server.use_dbus:
1555
2263
# Emit D-Bus signal
1556
2264
client.Rejected("Disabled")
1559
2267
if client.approved or not client.approval_delay:
1560
#We are approved or approval is disabled
2268
# We are approved or approval is disabled
1562
2270
elif client.approved is None:
1563
2271
logger.info("Client %s needs approval",
1598
2304
delay -= time2 - time
1601
while sent_size < len(client.secret):
1603
sent = session.send(client.secret[sent_size:])
1604
except gnutls.errors.GNUTLSError as error:
1605
logger.warning("gnutls send failed")
1607
logger.debug("Sent: %d, remaining: %d",
1608
sent, len(client.secret)
1609
- (sent_size + sent))
2307
session.send(client.secret)
2308
except gnutls.Error as error:
2309
logger.warning("gnutls send failed",
1612
2313
logger.info("Sending secret to %s", client.name)
1613
2314
# bump the timeout using extended_timeout
1614
client.checked_ok(client.extended_timeout)
2315
client.bump_timeout(client.extended_timeout)
1615
2316
if self.server.use_dbus:
1616
2317
# Emit D-Bus signal
1617
2318
client.GotSecret()
1620
2321
if approval_required:
1621
2322
client.approvals_pending -= 1
1624
except gnutls.errors.GNUTLSError as error:
1625
logger.warning("GnuTLS bye failed")
2325
except gnutls.Error as error:
2326
logger.warning("GnuTLS bye failed",
1628
2330
def peer_certificate(session):
1629
2331
"Return the peer's OpenPGP certificate as a bytestring"
1630
2332
# If not an OpenPGP certificate...
1631
if (gnutls.library.functions
1632
.gnutls_certificate_type_get(session._c_object)
1633
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1634
# ...do the normal thing
1635
return session.peer_certificate
2333
if (gnutls.certificate_type_get(session._c_object)
2334
!= gnutls.CRT_OPENPGP):
2335
# ...return invalid data
1636
2337
list_size = ctypes.c_uint(1)
1637
cert_list = (gnutls.library.functions
1638
.gnutls_certificate_get_peers
2338
cert_list = (gnutls.certificate_get_peers
1639
2339
(session._c_object, ctypes.byref(list_size)))
1640
2340
if not bool(cert_list) and list_size.value != 0:
1641
raise gnutls.errors.GNUTLSError("error getting peer"
2341
raise gnutls.Error("error getting peer certificate")
1643
2342
if list_size.value == 0:
1645
2344
cert = cert_list[0]
1646
2345
return ctypes.string_at(cert.data, cert.size)
1649
2348
def fingerprint(openpgp):
1650
2349
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1651
2350
# New GnuTLS "datum" with the OpenPGP public key
1652
datum = (gnutls.library.types
1653
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1656
ctypes.c_uint(len(openpgp))))
2351
datum = gnutls.datum_t(
2352
ctypes.cast(ctypes.c_char_p(openpgp),
2353
ctypes.POINTER(ctypes.c_ubyte)),
2354
ctypes.c_uint(len(openpgp)))
1657
2355
# New empty GnuTLS certificate
1658
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1659
(gnutls.library.functions
1660
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2356
crt = gnutls.openpgp_crt_t()
2357
gnutls.openpgp_crt_init(ctypes.byref(crt))
1661
2358
# Import the OpenPGP public key into the certificate
1662
(gnutls.library.functions
1663
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1664
gnutls.library.constants
1665
.GNUTLS_OPENPGP_FMT_RAW))
2359
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2360
gnutls.OPENPGP_FMT_RAW)
1666
2361
# Verify the self signature in the key
1667
2362
crtverify = ctypes.c_uint()
1668
(gnutls.library.functions
1669
.gnutls_openpgp_crt_verify_self(crt, 0,
1670
ctypes.byref(crtverify)))
2363
gnutls.openpgp_crt_verify_self(crt, 0,
2364
ctypes.byref(crtverify))
1671
2365
if crtverify.value != 0:
1672
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1673
raise (gnutls.errors.CertificateSecurityError
2366
gnutls.openpgp_crt_deinit(crt)
2367
raise gnutls.CertificateSecurityError("Verify failed")
1675
2368
# New buffer for the fingerprint
1676
2369
buf = ctypes.create_string_buffer(20)
1677
2370
buf_len = ctypes.c_size_t()
1678
2371
# Get the fingerprint from the certificate into the buffer
1679
(gnutls.library.functions
1680
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1681
ctypes.byref(buf_len)))
2372
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2373
ctypes.byref(buf_len))
1682
2374
# Deinit the certificate
1683
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2375
gnutls.openpgp_crt_deinit(crt)
1684
2376
# Convert the buffer to a Python bytestring
1685
2377
fpr = ctypes.string_at(buf, buf_len.value)
1686
2378
# Convert the bytestring to hexadecimal notation
1691
2383
class MultiprocessingMixIn(object):
1692
2384
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1693
2386
def sub_process_main(self, request, address):
1695
2388
self.finish_request(request, address)
1696
2389
except Exception:
1697
2390
self.handle_error(request, address)
1698
2391
self.close_request(request)
1700
2393
def process_request(self, request, address):
1701
2394
"""Start a new process to process the request."""
1702
proc = multiprocessing.Process(target = self.sub_process_main,
2395
proc = multiprocessing.Process(target=self.sub_process_main,
2396
args=(request, address))
1709
2401
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1710
2402
""" adds a pipe to the MixIn """
1711
2404
def process_request(self, request, client_address):
1712
2405
"""Overrides and wraps the original process_request().
1714
2407
This function creates a new pipe in self.pipe
1716
2409
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1718
2411
proc = MultiprocessingMixIn.process_request(self, request,
1719
2412
client_address)
1720
2413
self.child_pipe.close()
1721
2414
self.add_pipe(parent_pipe, proc)
1723
2416
def add_pipe(self, parent_pipe, proc):
1724
2417
"""Dummy function; override as necessary"""
1725
raise NotImplementedError
2418
raise NotImplementedError()
1728
2421
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1729
2422
socketserver.TCPServer, object):
1730
2423
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1733
2426
enabled: Boolean; whether this server is activated yet
1734
2427
interface: None or a network interface name (string)
1735
2428
use_ipv6: Boolean; to use IPv6 or not
1737
2431
def __init__(self, server_address, RequestHandlerClass,
1738
interface=None, use_ipv6=True):
2435
"""If socketfd is set, use that file descriptor instead of
2436
creating a new one with socket.socket().
1739
2438
self.interface = interface
1741
2440
self.address_family = socket.AF_INET6
2441
if socketfd is not None:
2442
# Save the file descriptor
2443
self.socketfd = socketfd
2444
# Save the original socket.socket() function
2445
self.socket_socket = socket.socket
2447
# To implement --socket, we monkey patch socket.socket.
2449
# (When socketserver.TCPServer is a new-style class, we
2450
# could make self.socket into a property instead of monkey
2451
# patching socket.socket.)
2453
# Create a one-time-only replacement for socket.socket()
2454
@functools.wraps(socket.socket)
2455
def socket_wrapper(*args, **kwargs):
2456
# Restore original function so subsequent calls are
2458
socket.socket = self.socket_socket
2459
del self.socket_socket
2460
# This time only, return a new socket object from the
2461
# saved file descriptor.
2462
return socket.fromfd(self.socketfd, *args, **kwargs)
2463
# Replace socket.socket() function with wrapper
2464
socket.socket = socket_wrapper
2465
# The socketserver.TCPServer.__init__ will call
2466
# socket.socket(), which might be our replacement,
2467
# socket_wrapper(), if socketfd was set.
1742
2468
socketserver.TCPServer.__init__(self, server_address,
1743
2469
RequestHandlerClass)
1744
2471
def server_bind(self):
1745
2472
"""This overrides the normal server_bind() function
1746
2473
to bind to an interface if one was specified, and also NOT to
1747
2474
bind to an address or port if they were not specified."""
2475
global SO_BINDTODEVICE
1748
2476
if self.interface is not None:
1749
2477
if SO_BINDTODEVICE is None:
1750
logger.error("SO_BINDTODEVICE does not exist;"
1751
" cannot bind to interface %s",
1755
self.socket.setsockopt(socket.SOL_SOCKET,
1759
except socket.error as error:
1760
if error[0] == errno.EPERM:
1761
logger.error("No permission to"
1762
" bind to interface %s",
1764
elif error[0] == errno.ENOPROTOOPT:
1765
logger.error("SO_BINDTODEVICE not available;"
1766
" cannot bind to interface %s",
2478
# Fall back to a hard-coded value which seems to be
2480
logger.warning("SO_BINDTODEVICE not found, trying 25")
2481
SO_BINDTODEVICE = 25
2483
self.socket.setsockopt(
2484
socket.SOL_SOCKET, SO_BINDTODEVICE,
2485
(self.interface + "\0").encode("utf-8"))
2486
except socket.error as error:
2487
if error.errno == errno.EPERM:
2488
logger.error("No permission to bind to"
2489
" interface %s", self.interface)
2490
elif error.errno == errno.ENOPROTOOPT:
2491
logger.error("SO_BINDTODEVICE not available;"
2492
" cannot bind to interface %s",
2494
elif error.errno == errno.ENODEV:
2495
logger.error("Interface %s does not exist,"
2496
" cannot bind", self.interface)
1770
2499
# Only bind(2) the socket if we really need to.
1771
2500
if self.server_address[0] or self.server_address[1]:
1772
2501
if not self.server_address[0]:
1773
2502
if self.address_family == socket.AF_INET6:
1774
any_address = "::" # in6addr_any
2503
any_address = "::" # in6addr_any
1776
any_address = socket.INADDR_ANY
2505
any_address = "0.0.0.0" # INADDR_ANY
1777
2506
self.server_address = (any_address,
1778
2507
self.server_address[1])
1779
2508
elif not self.server_address[1]:
1780
self.server_address = (self.server_address[0],
2509
self.server_address = (self.server_address[0], 0)
1782
2510
# if self.interface:
1783
2511
# self.server_address = (self.server_address[0],
1887
2609
funcname = request[1]
1888
2610
args = request[2]
1889
2611
kwargs = request[3]
1891
2613
parent_pipe.send(('data', getattr(client_object,
1892
2614
funcname)(*args,
1895
2617
if command == 'getattr':
1896
2618
attrname = request[1]
1897
if callable(client_object.__getattribute__(attrname)):
1898
parent_pipe.send(('function',))
2619
if isinstance(client_object.__getattribute__(attrname),
2620
collections.Callable):
2621
parent_pipe.send(('function', ))
1900
parent_pipe.send(('data', client_object
1901
.__getattribute__(attrname)))
2624
'data', client_object.__getattribute__(attrname)))
1903
2626
if command == 'setattr':
1904
2627
attrname = request[1]
1905
2628
value = request[2]
1906
2629
setattr(client_object, attrname, value)
2634
def rfc3339_duration_to_delta(duration):
2635
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2637
>>> rfc3339_duration_to_delta("P7D")
2638
datetime.timedelta(7)
2639
>>> rfc3339_duration_to_delta("PT60S")
2640
datetime.timedelta(0, 60)
2641
>>> rfc3339_duration_to_delta("PT60M")
2642
datetime.timedelta(0, 3600)
2643
>>> rfc3339_duration_to_delta("PT24H")
2644
datetime.timedelta(1)
2645
>>> rfc3339_duration_to_delta("P1W")
2646
datetime.timedelta(7)
2647
>>> rfc3339_duration_to_delta("PT5M30S")
2648
datetime.timedelta(0, 330)
2649
>>> rfc3339_duration_to_delta("P1DT3M20S")
2650
datetime.timedelta(1, 200)
2653
# Parsing an RFC 3339 duration with regular expressions is not
2654
# possible - there would have to be multiple places for the same
2655
# values, like seconds. The current code, while more esoteric, is
2656
# cleaner without depending on a parsing library. If Python had a
2657
# built-in library for parsing we would use it, but we'd like to
2658
# avoid excessive use of external libraries.
2660
# New type for defining tokens, syntax, and semantics all-in-one
2661
Token = collections.namedtuple("Token", (
2662
"regexp", # To match token; if "value" is not None, must have
2663
# a "group" containing digits
2664
"value", # datetime.timedelta or None
2665
"followers")) # Tokens valid after this token
2666
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2667
# the "duration" ABNF definition in RFC 3339, Appendix A.
2668
token_end = Token(re.compile(r"$"), None, frozenset())
2669
token_second = Token(re.compile(r"(\d+)S"),
2670
datetime.timedelta(seconds=1),
2671
frozenset((token_end, )))
2672
token_minute = Token(re.compile(r"(\d+)M"),
2673
datetime.timedelta(minutes=1),
2674
frozenset((token_second, token_end)))
2675
token_hour = Token(re.compile(r"(\d+)H"),
2676
datetime.timedelta(hours=1),
2677
frozenset((token_minute, token_end)))
2678
token_time = Token(re.compile(r"T"),
2680
frozenset((token_hour, token_minute,
2682
token_day = Token(re.compile(r"(\d+)D"),
2683
datetime.timedelta(days=1),
2684
frozenset((token_time, token_end)))
2685
token_month = Token(re.compile(r"(\d+)M"),
2686
datetime.timedelta(weeks=4),
2687
frozenset((token_day, token_end)))
2688
token_year = Token(re.compile(r"(\d+)Y"),
2689
datetime.timedelta(weeks=52),
2690
frozenset((token_month, token_end)))
2691
token_week = Token(re.compile(r"(\d+)W"),
2692
datetime.timedelta(weeks=1),
2693
frozenset((token_end, )))
2694
token_duration = Token(re.compile(r"P"), None,
2695
frozenset((token_year, token_month,
2696
token_day, token_time,
2698
# Define starting values:
2700
value = datetime.timedelta()
2702
# Following valid tokens
2703
followers = frozenset((token_duration, ))
2704
# String left to parse
2706
# Loop until end token is found
2707
while found_token is not token_end:
2708
# Search for any currently valid tokens
2709
for token in followers:
2710
match = token.regexp.match(s)
2711
if match is not None:
2713
if token.value is not None:
2714
# Value found, parse digits
2715
factor = int(match.group(1), 10)
2716
# Add to value so far
2717
value += factor * token.value
2718
# Strip token from string
2719
s = token.regexp.sub("", s, 1)
2722
# Set valid next tokens
2723
followers = found_token.followers
2726
# No currently valid tokens were found
2727
raise ValueError("Invalid RFC 3339 duration: {!r}"
1911
2733
def string_to_delta(interval):
1912
2734
"""Parse a string and return a datetime.timedelta
1914
2736
>>> string_to_delta('7d')
1915
2737
datetime.timedelta(7)
1916
2738
>>> string_to_delta('60s')
2005
2833
parser.add_argument("--no-dbus", action="store_false",
2006
2834
dest="use_dbus", help="Do not provide D-Bus"
2007
" system bus interface")
2835
" system bus interface", default=None)
2008
2836
parser.add_argument("--no-ipv6", action="store_false",
2009
dest="use_ipv6", help="Do not use IPv6")
2837
dest="use_ipv6", help="Do not use IPv6",
2010
2839
parser.add_argument("--no-restore", action="store_false",
2011
2840
dest="restore", help="Do not restore stored"
2841
" state", default=None)
2842
parser.add_argument("--socket", type=int,
2843
help="Specify a file descriptor to a network"
2844
" socket to use instead of creating one")
2013
2845
parser.add_argument("--statedir", metavar="DIR",
2014
2846
help="Directory to save/restore state in")
2847
parser.add_argument("--foreground", action="store_true",
2848
help="Run in foreground", default=None)
2849
parser.add_argument("--no-zeroconf", action="store_false",
2850
dest="zeroconf", help="Do not use Zeroconf",
2016
2853
options = parser.parse_args()
2018
2855
if options.check:
2857
fail_count, test_count = doctest.testmod()
2858
sys.exit(os.EX_OK if fail_count == 0 else 1)
2023
2860
# Default values for config file for server-global settings
2024
server_defaults = { "interface": "",
2029
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2030
"servicename": "Mandos",
2035
"statedir": "/var/lib/mandos"
2861
server_defaults = {"interface": "",
2866
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2867
":+SIGN-DSA-SHA256",
2868
"servicename": "Mandos",
2874
"statedir": "/var/lib/mandos",
2875
"foreground": "False",
2038
2879
# Parse config file for server-global settings
2039
2880
server_config = configparser.SafeConfigParser(server_defaults)
2040
2881
del server_defaults
2041
server_config.read(os.path.join(options.configdir,
2882
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2043
2883
# Convert the SafeConfigParser object to a dict
2044
2884
server_settings = server_config.defaults()
2045
2885
# Use the appropriate methods on the non-string config options
2046
for option in ("debug", "use_dbus", "use_ipv6"):
2886
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2887
"foreground", "zeroconf"):
2047
2888
server_settings[option] = server_config.getboolean("DEFAULT",
2049
2890
if server_settings["port"]:
2050
2891
server_settings["port"] = server_config.getint("DEFAULT",
2893
if server_settings["socket"]:
2894
server_settings["socket"] = server_config.getint("DEFAULT",
2896
# Later, stdin will, and stdout and stderr might, be dup'ed
2897
# over with an opened os.devnull. But we don't want this to
2898
# happen with a supplied network socket.
2899
if 0 <= server_settings["socket"] <= 2:
2900
server_settings["socket"] = os.dup(server_settings
2052
2902
del server_config
2054
2904
# Override the settings from the config file with command line
2055
2905
# options, if set.
2056
2906
for option in ("interface", "address", "port", "debug",
2057
"priority", "servicename", "configdir",
2058
"use_dbus", "use_ipv6", "debuglevel", "restore",
2907
"priority", "servicename", "configdir", "use_dbus",
2908
"use_ipv6", "debuglevel", "restore", "statedir",
2909
"socket", "foreground", "zeroconf"):
2060
2910
value = getattr(options, option)
2061
2911
if value is not None:
2062
2912
server_settings[option] = value
2064
2914
# Force all strings to be unicode
2065
2915
for option in server_settings.keys():
2066
if type(server_settings[option]) is str:
2067
server_settings[option] = unicode(server_settings[option])
2916
if isinstance(server_settings[option], bytes):
2917
server_settings[option] = (server_settings[option]
2919
# Force all boolean options to be boolean
2920
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2921
"foreground", "zeroconf"):
2922
server_settings[option] = bool(server_settings[option])
2923
# Debug implies foreground
2924
if server_settings["debug"]:
2925
server_settings["foreground"] = True
2068
2926
# Now we have our good server settings in "server_settings"
2070
2928
##################################################################
2930
if (not server_settings["zeroconf"]
2931
and not (server_settings["port"]
2932
or server_settings["socket"] != "")):
2933
parser.error("Needs port or socket to work without Zeroconf")
2072
2935
# For convenience
2073
2936
debug = server_settings["debug"]
2074
2937
debuglevel = server_settings["debuglevel"]
2076
2939
use_ipv6 = server_settings["use_ipv6"]
2077
2940
stored_state_path = os.path.join(server_settings["statedir"],
2078
2941
stored_state_file)
2942
foreground = server_settings["foreground"]
2943
zeroconf = server_settings["zeroconf"]
2081
initlogger(logging.DEBUG)
2946
initlogger(debug, logging.DEBUG)
2083
2948
if not debuglevel:
2086
2951
level = getattr(logging, debuglevel.upper())
2952
initlogger(debug, level)
2089
2954
if server_settings["servicename"] != "Mandos":
2090
syslogger.setFormatter(logging.Formatter
2091
('Mandos (%s) [%%(process)d]:'
2092
' %%(levelname)s: %%(message)s'
2093
% server_settings["servicename"]))
2955
syslogger.setFormatter(
2956
logging.Formatter('Mandos ({}) [%(process)d]:'
2957
' %(levelname)s: %(message)s'.format(
2958
server_settings["servicename"])))
2095
2960
# Parse config file with clients
2096
client_config = configparser.SafeConfigParser(Client.client_defaults)
2961
client_config = configparser.SafeConfigParser(Client
2097
2963
client_config.read(os.path.join(server_settings["configdir"],
2098
2964
"clients.conf"))
2100
2966
global mandos_dbus_service
2101
2967
mandos_dbus_service = None
2103
tcp_server = MandosServer((server_settings["address"],
2104
server_settings["port"]),
2106
interface=(server_settings["interface"]
2110
server_settings["priority"],
2113
pidfilename = "/var/run/mandos.pid"
2115
pidfile = open(pidfilename, "w")
2117
logger.error("Could not open file %r", pidfilename)
2120
uid = pwd.getpwnam("_mandos").pw_uid
2121
gid = pwd.getpwnam("_mandos").pw_gid
2124
uid = pwd.getpwnam("mandos").pw_uid
2125
gid = pwd.getpwnam("mandos").pw_gid
2970
if server_settings["socket"] != "":
2971
socketfd = server_settings["socket"]
2972
tcp_server = MandosServer(
2973
(server_settings["address"], server_settings["port"]),
2975
interface=(server_settings["interface"] or None),
2977
gnutls_priority=server_settings["priority"],
2981
pidfilename = "/run/mandos.pid"
2982
if not os.path.isdir("/run/."):
2983
pidfilename = "/var/run/mandos.pid"
2986
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2987
except IOError as e:
2988
logger.error("Could not open file %r", pidfilename,
2991
for name, group in (("_mandos", "_mandos"),
2992
("mandos", "mandos"),
2993
("nobody", "nogroup")):
2995
uid = pwd.getpwnam(name).pw_uid
2996
gid = pwd.getpwnam(group).pw_gid
2126
2998
except KeyError:
2128
uid = pwd.getpwnam("nobody").pw_uid
2129
gid = pwd.getpwnam("nobody").pw_gid
3007
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2136
3009
except OSError as error:
2137
if error[0] != errno.EPERM:
3010
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3011
.format(uid, gid, os.strerror(error.errno)))
3012
if error.errno != errno.EPERM:
2141
3016
# Enable all possible GnuTLS debugging
2143
3018
# "Use a log level over 10 to enable all debugging options."
2144
3019
# - GnuTLS manual
2145
gnutls.library.functions.gnutls_global_set_log_level(11)
2147
@gnutls.library.types.gnutls_log_func
3020
gnutls.global_set_log_level(11)
2148
3023
def debug_gnutls(level, string):
2149
3024
logger.debug("GnuTLS: %s", string[:-1])
2151
(gnutls.library.functions
2152
.gnutls_global_set_log_function(debug_gnutls))
3026
gnutls.global_set_log_function(debug_gnutls)
2154
3028
# Redirect stdin so all checkers get /dev/null
2155
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3029
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
3030
os.dup2(null, sys.stdin.fileno())
2160
# No console logging
2161
logger.removeHandler(console)
2163
3034
# Need to fork before connecting to D-Bus
2165
3036
# Close all input and output, do double fork, etc.
2168
gobject.threads_init()
3039
# multiprocessing will use threads, so before we use GLib we need
3040
# to inform GLib that threads will be used.
2170
3043
global main_loop
2171
3044
# From the Avahi example code
2172
DBusGMainLoop(set_as_default=True )
2173
main_loop = gobject.MainLoop()
3045
DBusGMainLoop(set_as_default=True)
3046
main_loop = GLib.MainLoop()
2174
3047
bus = dbus.SystemBus()
2175
3048
# End of Avahi example code
2178
3051
bus_name = dbus.service.BusName("se.recompile.Mandos",
2179
bus, do_not_queue=True)
2180
old_bus_name = (dbus.service.BusName
2181
("se.bsnet.fukt.Mandos", bus,
2183
except dbus.exceptions.NameExistsException as e:
2184
logger.error(unicode(e) + ", disabling D-Bus")
3054
old_bus_name = dbus.service.BusName(
3055
"se.bsnet.fukt.Mandos", bus,
3057
except dbus.exceptions.DBusException as e:
3058
logger.error("Disabling D-Bus:", exc_info=e)
2185
3059
use_dbus = False
2186
3060
server_settings["use_dbus"] = False
2187
3061
tcp_server.use_dbus = False
2188
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2189
service = AvahiServiceToSyslog(name =
2190
server_settings["servicename"],
2191
servicetype = "_mandos._tcp",
2192
protocol = protocol, bus = bus)
2193
if server_settings["interface"]:
2194
service.interface = (if_nametoindex
2195
(str(server_settings["interface"])))
3063
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3064
service = AvahiServiceToSyslog(
3065
name=server_settings["servicename"],
3066
servicetype="_mandos._tcp",
3069
if server_settings["interface"]:
3070
service.interface = if_nametoindex(
3071
server_settings["interface"].encode("utf-8"))
2197
3073
global multiprocessing_manager
2198
3074
multiprocessing_manager = multiprocessing.Manager()
2200
3076
client_class = Client
2202
client_class = functools.partial(ClientDBusTransitional,
3078
client_class = functools.partial(ClientDBus, bus=bus)
2205
3080
client_settings = Client.config_parser(client_config)
2206
3081
old_client_settings = {}
2207
3082
clients_data = {}
3084
# This is used to redirect stdout and stderr for checker processes
3086
wnull = open(os.devnull, "w") # A writable /dev/null
3087
# Only used if server is running in foreground but not in debug
3089
if debug or not foreground:
2209
3092
# Get client data and settings from last running state.
2210
3093
if server_settings["restore"]:
2212
3095
with open(stored_state_path, "rb") as stored_state:
2213
clients_data, old_client_settings = (pickle.load
3096
if sys.version_info.major == 2:
3097
clients_data, old_client_settings = pickle.load(
3100
bytes_clients_data, bytes_old_client_settings = (
3101
pickle.load(stored_state, encoding="bytes"))
3102
# Fix bytes to strings
3105
clients_data = {(key.decode("utf-8")
3106
if isinstance(key, bytes)
3109
bytes_clients_data.items()}
3110
del bytes_clients_data
3111
for key in clients_data:
3112
value = {(k.decode("utf-8")
3113
if isinstance(k, bytes) else k): v
3115
clients_data[key].items()}
3116
clients_data[key] = value
3118
value["client_structure"] = [
3120
if isinstance(s, bytes)
3122
value["client_structure"]]
3124
for k in ("name", "host"):
3125
if isinstance(value[k], bytes):
3126
value[k] = value[k].decode("utf-8")
3127
# old_client_settings
3129
old_client_settings = {
3130
(key.decode("utf-8")
3131
if isinstance(key, bytes)
3134
bytes_old_client_settings.items()}
3135
del bytes_old_client_settings
3137
for value in old_client_settings.values():
3138
if isinstance(value["host"], bytes):
3139
value["host"] = (value["host"]
2215
3141
os.remove(stored_state_path)
2216
3142
except IOError as e:
2217
logger.warning("Could not load persistent state: {0}"
2219
if e.errno != errno.ENOENT:
3143
if e.errno == errno.ENOENT:
3144
logger.warning("Could not load persistent state:"
3145
" {}".format(os.strerror(e.errno)))
3147
logger.critical("Could not load persistent state:",
3150
except EOFError as e:
3151
logger.warning("Could not load persistent state: "
2222
3155
with PGPEngine() as pgp:
2223
for client_name, client in clients_data.iteritems():
3156
for client_name, client in clients_data.items():
3157
# Skip removed clients
3158
if client_name not in client_settings:
2224
3161
# Decide which value to use after restoring saved state.
2225
3162
# We have three different values: Old config file,
2226
3163
# new config file, and saved state.
2231
3168
# For each value in new config, check if it
2232
3169
# differs from the old config value (Except for
2233
3170
# the "secret" attribute)
2234
if (name != "secret" and
2235
value != old_client_settings[client_name]
3171
if (name != "secret"
3173
old_client_settings[client_name][name])):
2237
3174
client[name] = value
2238
3175
except KeyError:
2241
3178
# Clients who has passed its expire date can still be
2242
# enabled if its last checker was successful. Clients
2243
# whose checker failed before we stored its state is
2244
# assumed to have failed all checkers during downtime.
3179
# enabled if its last checker was successful. A Client
3180
# whose checker succeeded before we stored its state is
3181
# assumed to have successfully run all checkers during
2245
3183
if client["enabled"]:
2246
3184
if datetime.datetime.utcnow() >= client["expires"]:
2247
3185
if not client["last_checked_ok"]:
2248
3186
logger.warning(
2249
"disabling client {0} - Client never "
2250
"performed a successfull checker"
2251
.format(client["name"]))
3187
"disabling client {} - Client never "
3188
"performed a successful checker".format(
2252
3190
client["enabled"] = False
2253
3191
elif client["last_checker_status"] != 0:
2254
3192
logger.warning(
2255
"disabling client {0} - Client "
2256
"last checker failed with error code {1}"
2257
.format(client["name"],
2258
client["last_checker_status"]))
3193
"disabling client {} - Client last"
3194
" checker failed with error code"
3197
client["last_checker_status"]))
2259
3198
client["enabled"] = False
2261
client["expires"] = (datetime.datetime
2263
+ client["timeout"])
3200
client["expires"] = (
3201
datetime.datetime.utcnow()
3202
+ client["timeout"])
3203
logger.debug("Last checker succeeded,"
3204
" keeping {} enabled".format(
2266
client["secret"] = (
2267
pgp.decrypt(client["encrypted_secret"],
2268
client_settings[client_name]
3207
client["secret"] = pgp.decrypt(
3208
client["encrypted_secret"],
3209
client_settings[client_name]["secret"])
2270
3210
except PGPError:
2271
3211
# If decryption fails, we use secret from new settings
2272
logger.debug("Failed to decrypt {0} old secret"
2273
.format(client_name))
2274
client["secret"] = (
2275
client_settings[client_name]["secret"])
3212
logger.debug("Failed to decrypt {} old secret".format(
3214
client["secret"] = (client_settings[client_name]
2278
3217
# Add/remove clients based on new changes made to config
2279
for client_name in set(old_client_settings) - set(client_settings):
3218
for client_name in (set(old_client_settings)
3219
- set(client_settings)):
2280
3220
del clients_data[client_name]
2281
for client_name in set(client_settings) - set(old_client_settings):
3221
for client_name in (set(client_settings)
3222
- set(old_client_settings)):
2282
3223
clients_data[client_name] = client_settings[client_name]
2284
# Create clients all clients
2285
for client_name, client in clients_data.iteritems():
3225
# Create all client objects
3226
for client_name, client in clients_data.items():
2286
3227
tcp_server.clients[client_name] = client_class(
2287
name = client_name, settings = client)
3230
server_settings=server_settings)
2289
3232
if not tcp_server.clients:
2290
3233
logger.warning("No clients defined")
2296
pidfile.write(str(pid) + "\n".encode("utf-8"))
2299
logger.error("Could not write to file %r with PID %d",
2302
# "pidfile" was never created
3236
if pidfile is not None:
3240
print(pid, file=pidfile)
3242
logger.error("Could not write to file %r with PID %d",
2304
3245
del pidfilename
2305
signal.signal(signal.SIGINT, signal.SIG_IGN)
2307
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2308
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3247
for termsig in (signal.SIGHUP, signal.SIGTERM):
3248
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3249
lambda: main_loop.quit() and False)
2311
class MandosDBusService(dbus.service.Object):
3253
@alternate_dbus_interfaces(
3254
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3255
class MandosDBusService(DBusObjectWithObjectManager):
2312
3256
"""A D-Bus proxy object"""
2313
3258
def __init__(self):
2314
3259
dbus.service.Object.__init__(self, bus, "/")
2315
3261
_interface = "se.recompile.Mandos"
2317
3263
@dbus.service.signal(_interface, signature="o")
2318
3264
def ClientAdded(self, objpath):
2322
3268
@dbus.service.signal(_interface, signature="ss")
2323
3269
def ClientNotFound(self, fingerprint, address):
3273
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2327
3275
@dbus.service.signal(_interface, signature="os")
2328
3276
def ClientRemoved(self, objpath, name):
3280
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2332
3282
@dbus.service.method(_interface, out_signature="ao")
2333
3283
def GetAllClients(self):
2335
return dbus.Array(c.dbus_object_path
2337
tcp_server.clients.itervalues())
3285
return dbus.Array(c.dbus_object_path for c in
3286
tcp_server.clients.values())
3288
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2339
3290
@dbus.service.method(_interface,
2340
3291
out_signature="a{oa{sv}}")
2341
3292
def GetAllClientsWithProperties(self):
2343
3294
return dbus.Dictionary(
2344
((c.dbus_object_path, c.GetAll(""))
2345
for c in tcp_server.clients.itervalues()),
3295
{c.dbus_object_path: c.GetAll(
3296
"se.recompile.Mandos.Client")
3297
for c in tcp_server.clients.values()},
2346
3298
signature="oa{sv}")
2348
3300
@dbus.service.method(_interface, in_signature="o")
2349
3301
def RemoveClient(self, object_path):
2351
for c in tcp_server.clients.itervalues():
3303
for c in tcp_server.clients.values():
2352
3304
if c.dbus_object_path == object_path:
2353
3305
del tcp_server.clients[c.name]
2354
3306
c.remove_from_connection()
2355
# Don't signal anything except ClientRemoved
3307
# Don't signal the disabling
2356
3308
c.disable(quiet=True)
2358
self.ClientRemoved(object_path, c.name)
3309
# Emit D-Bus signal for removal
3310
self.client_removed_signal(c)
2360
3312
raise KeyError(object_path)
2364
class MandosDBusServiceTransitional(MandosDBusService):
2365
__metaclass__ = AlternateDBusNamesMetaclass
2366
mandos_dbus_service = MandosDBusServiceTransitional()
3316
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3317
out_signature="a{oa{sa{sv}}}")
3318
def GetManagedObjects(self):
3320
return dbus.Dictionary(
3321
{client.dbus_object_path:
3323
{interface: client.GetAll(interface)
3325
client._get_all_interface_names()})
3326
for client in tcp_server.clients.values()})
3328
def client_added_signal(self, client):
3329
"""Send the new standard signal and the old signal"""
3331
# New standard signal
3332
self.InterfacesAdded(
3333
client.dbus_object_path,
3335
{interface: client.GetAll(interface)
3337
client._get_all_interface_names()}))
3339
self.ClientAdded(client.dbus_object_path)
3341
def client_removed_signal(self, client):
3342
"""Send the new standard signal and the old signal"""
3344
# New standard signal
3345
self.InterfacesRemoved(
3346
client.dbus_object_path,
3347
client._get_all_interface_names())
3349
self.ClientRemoved(client.dbus_object_path,
3352
mandos_dbus_service = MandosDBusService()
3354
# Save modules to variables to exempt the modules from being
3355
# unloaded before the function registered with atexit() is run.
3356
mp = multiprocessing
2369
3360
"Cleanup function; run on exit"
2372
multiprocessing.active_children()
3364
mp.active_children()
2373
3366
if not (tcp_server.clients or client_settings):
2376
3369
# Store client before exiting. Secrets are encrypted with key
2377
3370
# based on what config file has. If config file is
2378
3371
# removed/edited, old secret will thus be unrecovable.
2380
3373
with PGPEngine() as pgp:
2381
for client in tcp_server.clients.itervalues():
3374
for client in tcp_server.clients.values():
2382
3375
key = client_settings[client.name]["secret"]
2383
3376
client.encrypted_secret = pgp.encrypt(client.secret,
2385
3378
client_dict = {}
2387
3380
# A list of attributes that can not be pickled
2389
exclude = set(("bus", "changedstate", "secret",
2391
for name, typ in (inspect.getmembers
2392
(dbus.service.Object)):
3382
exclude = {"bus", "changedstate", "secret",
3383
"checker", "server_settings"}
3384
for name, typ in inspect.getmembers(dbus.service
2393
3386
exclude.add(name)
2395
3388
client_dict["encrypted_secret"] = (client
2396
3389
.encrypted_secret)
2397
3390
for attr in client.client_structure:
2398
3391
if attr not in exclude:
2399
3392
client_dict[attr] = getattr(client, attr)
2401
3394
clients[client.name] = client_dict
2402
3395
del client_settings[client.name]["secret"]
2405
with os.fdopen(os.open(stored_state_path,
2406
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2407
0600), "wb") as stored_state:
2408
pickle.dump((clients, client_settings), stored_state)
3398
with tempfile.NamedTemporaryFile(
3402
dir=os.path.dirname(stored_state_path),
3403
delete=False) as stored_state:
3404
pickle.dump((clients, client_settings), stored_state,
3406
tempname = stored_state.name
3407
os.rename(tempname, stored_state_path)
2409
3408
except (IOError, OSError) as e:
2410
logger.warning("Could not save persistent state: {0}"
2412
if e.errno not in (errno.ENOENT, errno.EACCES):
3414
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3415
logger.warning("Could not save persistent state: {}"
3416
.format(os.strerror(e.errno)))
3418
logger.warning("Could not save persistent state:",
2415
3422
# Delete all clients, and settings from config
2416
3423
while tcp_server.clients:
2417
3424
name, client = tcp_server.clients.popitem()
2419
3426
client.remove_from_connection()
2420
# Don't signal anything except ClientRemoved
3427
# Don't signal the disabling
2421
3428
client.disable(quiet=True)
3429
# Emit D-Bus signal for removal
2424
mandos_dbus_service.ClientRemoved(client
3431
mandos_dbus_service.client_removed_signal(client)
2427
3432
client_settings.clear()
2429
3434
atexit.register(cleanup)
2431
for client in tcp_server.clients.itervalues():
3436
for client in tcp_server.clients.values():
2434
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3438
# Emit D-Bus signal for adding
3439
mandos_dbus_service.client_added_signal(client)
2435
3440
# Need to initiate checking of clients
2436
3441
if client.enabled:
2437
3442
client.init_checker()
2439
3444
tcp_server.enable()
2440
3445
tcp_server.server_activate()
2442
3447
# Find out what port we got
2443
service.port = tcp_server.socket.getsockname()[1]
3449
service.port = tcp_server.socket.getsockname()[1]
2445
3451
logger.info("Now listening on address %r, port %d,"
2446
" flowinfo %d, scope_id %d"
2447
% tcp_server.socket.getsockname())
3452
" flowinfo %d, scope_id %d",
3453
*tcp_server.socket.getsockname())
2449
logger.info("Now listening on address %r, port %d"
2450
% tcp_server.socket.getsockname())
2452
#service.interface = tcp_server.socket.getsockname()[3]
3455
logger.info("Now listening on address %r, port %d",
3456
*tcp_server.socket.getsockname())
3458
# service.interface = tcp_server.socket.getsockname()[3]
2455
# From the Avahi example code
2458
except dbus.exceptions.DBusException as error:
2459
logger.critical("DBusException: %s", error)
2462
# End of Avahi example code
2464
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2465
lambda *args, **kwargs:
2466
(tcp_server.handle_request
2467
(*args[2:], **kwargs) or True))
3462
# From the Avahi example code
3465
except dbus.exceptions.DBusException as error:
3466
logger.critical("D-Bus Exception", exc_info=error)
3469
# End of Avahi example code
3471
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3472
lambda *args, **kwargs:
3473
(tcp_server.handle_request
3474
(*args[2:], **kwargs) or True))
2469
3476
logger.debug("Starting main loop")
2470
3477
main_loop.run()
2471
3478
except AvahiError as error:
2472
logger.critical("AvahiError: %s", error)
3479
logger.critical("Avahi Error", exc_info=error)
2475
3482
except KeyboardInterrupt: