95
81
except ImportError:
96
82
SO_BINDTODEVICE = None
98
if sys.version_info.major == 2:
102
stored_state_file = "clients.pickle"
104
logger = logging.getLogger()
108
if_nametoindex = ctypes.cdll.LoadLibrary(
109
ctypes.util.find_library("c")).if_nametoindex
110
except (OSError, AttributeError):
112
def if_nametoindex(interface):
113
"Get an interface index the hard way, i.e. using fcntl()"
114
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
115
with contextlib.closing(socket.socket()) as s:
116
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
117
struct.pack(b"16s16x", interface))
118
interface_index = struct.unpack("I", ifreq[16:20])[0]
119
return interface_index
122
def initlogger(debug, level=logging.WARNING):
123
"""init logger and add loglevel"""
126
syslogger = (logging.handlers.SysLogHandler(
127
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
128
address = "/dev/log"))
129
syslogger.setFormatter(logging.Formatter
130
('Mandos [%(process)d]: %(levelname)s:'
132
logger.addHandler(syslogger)
135
console = logging.StreamHandler()
136
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
140
logger.addHandler(console)
141
logger.setLevel(level)
144
class PGPError(Exception):
145
"""Exception if encryption/decryption fails"""
149
class PGPEngine(object):
150
"""A simple class for OpenPGP symmetric encryption & decryption"""
153
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
156
output = subprocess.check_output(["gpgconf"])
157
for line in output.splitlines():
158
name, text, path = line.split(":")
163
if e.errno != errno.ENOENT:
165
self.gnupgargs = ['--batch',
166
'--homedir', self.tempdir,
174
def __exit__(self, exc_type, exc_value, traceback):
182
if self.tempdir is not None:
183
# Delete contents of tempdir
184
for root, dirs, files in os.walk(self.tempdir,
186
for filename in files:
187
os.remove(os.path.join(root, filename))
189
os.rmdir(os.path.join(root, dirname))
191
os.rmdir(self.tempdir)
194
def password_encode(self, password):
195
# Passphrase can not be empty and can not contain newlines or
196
# NUL bytes. So we prefix it and hex encode it.
197
encoded = b"mandos" + binascii.hexlify(password)
198
if len(encoded) > 2048:
199
# GnuPG can't handle long passwords, so encode differently
200
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
201
.replace(b"\n", b"\\n")
202
.replace(b"\0", b"\\x00"))
205
def encrypt(self, data, password):
206
passphrase = self.password_encode(password)
207
with tempfile.NamedTemporaryFile(
208
dir=self.tempdir) as passfile:
209
passfile.write(passphrase)
211
proc = subprocess.Popen([self.gpg, '--symmetric',
215
stdin = subprocess.PIPE,
216
stdout = subprocess.PIPE,
217
stderr = subprocess.PIPE)
218
ciphertext, err = proc.communicate(input = data)
219
if proc.returncode != 0:
223
def decrypt(self, data, password):
224
passphrase = self.password_encode(password)
225
with tempfile.NamedTemporaryFile(
226
dir = self.tempdir) as passfile:
227
passfile.write(passphrase)
229
proc = subprocess.Popen([self.gpg, '--decrypt',
233
stdin = subprocess.PIPE,
234
stdout = subprocess.PIPE,
235
stderr = subprocess.PIPE)
236
decrypted_plaintext, err = proc.communicate(input = data)
237
if proc.returncode != 0:
239
return decrypted_plaintext
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
89
syslogger = (logging.handlers.SysLogHandler
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
address = str("/dev/log")))
92
syslogger.setFormatter(logging.Formatter
93
('Mandos [%(process)d]: %(levelname)s:'
95
logger.addHandler(syslogger)
97
console = logging.StreamHandler()
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
101
logger.addHandler(console)
242
103
class AvahiError(Exception):
243
104
def __init__(self, value, *args, **kwargs):
244
105
self.value = value
245
return super(AvahiError, self).__init__(value, *args,
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
249
110
class AvahiServiceError(AvahiError):
253
113
class AvahiGroupError(AvahiError):
427
260
follow_name_owner_changes=True),
428
261
avahi.DBUS_INTERFACE_SERVER)
429
262
self.server.connect_to_signal("StateChanged",
430
self.server_state_changed)
263
self.server_state_changed)
431
264
self.server_state_changed(self.server.GetState())
434
class AvahiServiceToSyslog(AvahiService):
435
def rename(self, *args, **kwargs):
436
"""Add the new name to the syslog messages"""
437
ret = AvahiService.rename(self, *args, **kwargs)
438
syslogger.setFormatter(logging.Formatter(
439
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
443
# Pretend that we have a GnuTLS module
444
class GnuTLS(object):
445
"""This isn't so much a class as it is a module-like namespace.
446
It is instantiated once, and simulates having a GnuTLS module."""
448
_library = ctypes.cdll.LoadLibrary(
449
ctypes.util.find_library("gnutls"))
450
_need_version = "3.3.0"
452
# Need to use class name "GnuTLS" here, since this method is
453
# called before the assignment to the "gnutls" global variable
455
if GnuTLS.check_version(self._need_version) is None:
456
raise GnuTLS.Error("Needs GnuTLS {} or later"
457
.format(self._need_version))
459
# Unless otherwise indicated, the constants and types below are
460
# all from the gnutls/gnutls.h C header file.
470
E_NO_CERTIFICATE_FOUND = -49
471
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
474
class session_int(ctypes.Structure):
476
session_t = ctypes.POINTER(session_int)
477
class certificate_credentials_st(ctypes.Structure):
479
certificate_credentials_t = ctypes.POINTER(
480
certificate_credentials_st)
481
certificate_type_t = ctypes.c_int
482
class datum_t(ctypes.Structure):
483
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
484
('size', ctypes.c_uint)]
485
class openpgp_crt_int(ctypes.Structure):
487
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
488
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
489
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
490
credentials_type_t = ctypes.c_int #
491
transport_ptr_t = ctypes.c_void_p
492
close_request_t = ctypes.c_int
495
class Error(Exception):
496
# We need to use the class name "GnuTLS" here, since this
497
# exception might be raised from within GnuTLS.__init__,
498
# which is called before the assignment to the "gnutls"
499
# global variable has happened.
500
def __init__(self, message = None, code = None, args=()):
501
# Default usage is by a message string, but if a return
502
# code is passed, convert it to a string with
505
if message is None and code is not None:
506
message = GnuTLS.strerror(code)
507
return super(GnuTLS.Error, self).__init__(
510
class CertificateSecurityError(Error):
514
class Credentials(object):
516
self._c_object = gnutls.certificate_credentials_t()
517
gnutls.certificate_allocate_credentials(
518
ctypes.byref(self._c_object))
519
self.type = gnutls.CRD_CERTIFICATE
522
gnutls.certificate_free_credentials(self._c_object)
524
class ClientSession(object):
525
def __init__(self, socket, credentials = None):
526
self._c_object = gnutls.session_t()
527
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
528
gnutls.set_default_priority(self._c_object)
529
gnutls.transport_set_ptr(self._c_object, socket.fileno())
530
gnutls.handshake_set_private_extensions(self._c_object,
533
if credentials is None:
534
credentials = gnutls.Credentials()
535
gnutls.credentials_set(self._c_object, credentials.type,
536
ctypes.cast(credentials._c_object,
538
self.credentials = credentials
541
gnutls.deinit(self._c_object)
544
return gnutls.handshake(self._c_object)
546
def send(self, data):
550
data_len -= gnutls.record_send(self._c_object,
555
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
557
# Error handling functions
558
def _error_code(result):
559
"""A function to raise exceptions on errors, suitable
560
for the 'restype' attribute on ctypes functions"""
563
if result == gnutls.E_NO_CERTIFICATE_FOUND:
564
raise gnutls.CertificateSecurityError(code = result)
565
raise gnutls.Error(code = result)
567
def _retry_on_error(result, func, arguments):
568
"""A function to retry on some errors, suitable
569
for the 'errcheck' attribute on ctypes functions"""
571
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
572
return _error_code(result)
573
result = func(*arguments)
576
# Unless otherwise indicated, the function declarations below are
577
# all from the gnutls/gnutls.h C header file.
580
priority_set_direct = _library.gnutls_priority_set_direct
581
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
582
ctypes.POINTER(ctypes.c_char_p)]
583
priority_set_direct.restype = _error_code
585
init = _library.gnutls_init
586
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
587
init.restype = _error_code
589
set_default_priority = _library.gnutls_set_default_priority
590
set_default_priority.argtypes = [session_t]
591
set_default_priority.restype = _error_code
593
record_send = _library.gnutls_record_send
594
record_send.argtypes = [session_t, ctypes.c_void_p,
596
record_send.restype = ctypes.c_ssize_t
597
record_send.errcheck = _retry_on_error
599
certificate_allocate_credentials = (
600
_library.gnutls_certificate_allocate_credentials)
601
certificate_allocate_credentials.argtypes = [
602
ctypes.POINTER(certificate_credentials_t)]
603
certificate_allocate_credentials.restype = _error_code
605
certificate_free_credentials = (
606
_library.gnutls_certificate_free_credentials)
607
certificate_free_credentials.argtypes = [certificate_credentials_t]
608
certificate_free_credentials.restype = None
610
handshake_set_private_extensions = (
611
_library.gnutls_handshake_set_private_extensions)
612
handshake_set_private_extensions.argtypes = [session_t,
614
handshake_set_private_extensions.restype = None
616
credentials_set = _library.gnutls_credentials_set
617
credentials_set.argtypes = [session_t, credentials_type_t,
619
credentials_set.restype = _error_code
621
strerror = _library.gnutls_strerror
622
strerror.argtypes = [ctypes.c_int]
623
strerror.restype = ctypes.c_char_p
625
certificate_type_get = _library.gnutls_certificate_type_get
626
certificate_type_get.argtypes = [session_t]
627
certificate_type_get.restype = _error_code
629
certificate_get_peers = _library.gnutls_certificate_get_peers
630
certificate_get_peers.argtypes = [session_t,
631
ctypes.POINTER(ctypes.c_uint)]
632
certificate_get_peers.restype = ctypes.POINTER(datum_t)
634
global_set_log_level = _library.gnutls_global_set_log_level
635
global_set_log_level.argtypes = [ctypes.c_int]
636
global_set_log_level.restype = None
638
global_set_log_function = _library.gnutls_global_set_log_function
639
global_set_log_function.argtypes = [log_func]
640
global_set_log_function.restype = None
642
deinit = _library.gnutls_deinit
643
deinit.argtypes = [session_t]
644
deinit.restype = None
646
handshake = _library.gnutls_handshake
647
handshake.argtypes = [session_t]
648
handshake.restype = _error_code
649
handshake.errcheck = _retry_on_error
651
transport_set_ptr = _library.gnutls_transport_set_ptr
652
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
653
transport_set_ptr.restype = None
655
bye = _library.gnutls_bye
656
bye.argtypes = [session_t, close_request_t]
657
bye.restype = _error_code
658
bye.errcheck = _retry_on_error
660
check_version = _library.gnutls_check_version
661
check_version.argtypes = [ctypes.c_char_p]
662
check_version.restype = ctypes.c_char_p
664
# All the function declarations below are from gnutls/openpgp.h
666
openpgp_crt_init = _library.gnutls_openpgp_crt_init
667
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
668
openpgp_crt_init.restype = _error_code
670
openpgp_crt_import = _library.gnutls_openpgp_crt_import
671
openpgp_crt_import.argtypes = [openpgp_crt_t,
672
ctypes.POINTER(datum_t),
674
openpgp_crt_import.restype = _error_code
676
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
677
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
678
ctypes.POINTER(ctypes.c_uint)]
679
openpgp_crt_verify_self.restype = _error_code
681
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
682
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
683
openpgp_crt_deinit.restype = None
685
openpgp_crt_get_fingerprint = (
686
_library.gnutls_openpgp_crt_get_fingerprint)
687
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
691
openpgp_crt_get_fingerprint.restype = _error_code
693
# Remove non-public functions
694
del _error_code, _retry_on_error
695
# Create the global "gnutls" object, simulating a module
698
def call_pipe(connection, # : multiprocessing.Connection
699
func, *args, **kwargs):
700
"""This function is meant to be called by multiprocessing.Process
702
This function runs func(*args, **kwargs), and writes the resulting
703
return value on the provided multiprocessing.Connection.
705
connection.send(func(*args, **kwargs))
708
267
class Client(object):
709
268
"""A representation of a client host served by this server.
712
approved: bool(); 'None' if not yet approved/disapproved
271
_approved: bool(); 'None' if not yet approved/disapproved
713
272
approval_delay: datetime.timedelta(); Time to wait for approval
714
273
approval_duration: datetime.timedelta(); Duration of one approval
715
274
checker: subprocess.Popen(); a running checker process used
733
291
interval: datetime.timedelta(); How often to start a new checker
734
292
last_approval_request: datetime.datetime(); (UTC) or None
735
293
last_checked_ok: datetime.datetime(); (UTC) or None
736
last_checker_status: integer between 0 and 255 reflecting exit
737
status of last checker. -1 reflects crashed
738
checker, -2 means no checker completed yet.
739
last_checker_signal: The signal which killed the last checker, if
740
last_checker_status is -1
741
last_enabled: datetime.datetime(); (UTC) or None
294
last_enabled: datetime.datetime(); (UTC)
742
295
name: string; from the config file, used in log messages and
743
296
D-Bus identifiers
744
297
secret: bytestring; sent verbatim (over TLS) to client
745
298
timeout: datetime.timedelta(); How long from last_checked_ok
746
299
until this client is disabled
747
extended_timeout: extra long timeout when secret has been sent
300
extended_timeout: extra long timeout when password has been sent
748
301
runtime_expansions: Allowed attributes for runtime expansion.
749
302
expires: datetime.datetime(); time (UTC) when a client will be
750
303
disabled, or None
751
server_settings: The server_settings dict from main()
754
306
runtime_expansions = ("approval_delay", "approval_duration",
755
"created", "enabled", "expires",
756
"fingerprint", "host", "interval",
757
"last_approval_request", "last_checked_ok",
307
"created", "enabled", "fingerprint",
308
"host", "interval", "last_checked_ok",
758
309
"last_enabled", "name", "timeout")
761
"extended_timeout": "PT15M",
763
"checker": "fping -q -- %%(host)s",
765
"approval_delay": "PT0S",
766
"approval_duration": "PT1S",
767
"approved_by_default": "True",
772
def config_parser(config):
773
"""Construct a new dict of client settings of this form:
774
{ client_name: {setting_name: value, ...}, ...}
775
with exceptions for any special settings as defined above.
776
NOTE: Must be a pure function. Must return the same result
777
value given the same arguments.
780
for client_name in config.sections():
781
section = dict(config.items(client_name))
782
client = settings[client_name] = {}
784
client["host"] = section["host"]
785
# Reformat values from string types to Python types
786
client["approved_by_default"] = config.getboolean(
787
client_name, "approved_by_default")
788
client["enabled"] = config.getboolean(client_name,
791
# Uppercase and remove spaces from fingerprint for later
792
# comparison purposes with return value from the
793
# fingerprint() function
794
client["fingerprint"] = (section["fingerprint"].upper()
796
if "secret" in section:
797
client["secret"] = section["secret"].decode("base64")
798
elif "secfile" in section:
799
with open(os.path.expanduser(os.path.expandvars
800
(section["secfile"])),
802
client["secret"] = secfile.read()
804
raise TypeError("No secret or secfile for section {}"
806
client["timeout"] = string_to_delta(section["timeout"])
807
client["extended_timeout"] = string_to_delta(
808
section["extended_timeout"])
809
client["interval"] = string_to_delta(section["interval"])
810
client["approval_delay"] = string_to_delta(
811
section["approval_delay"])
812
client["approval_duration"] = string_to_delta(
813
section["approval_duration"])
814
client["checker_command"] = section["checker"]
815
client["last_approval_request"] = None
816
client["last_checked_ok"] = None
817
client["last_checker_status"] = -2
821
def __init__(self, settings, name = None, server_settings=None):
312
def _timedelta_to_milliseconds(td):
313
"Convert a datetime.timedelta() to milliseconds"
314
return ((td.days * 24 * 60 * 60 * 1000)
315
+ (td.seconds * 1000)
316
+ (td.microseconds // 1000))
318
def timeout_milliseconds(self):
319
"Return the 'timeout' attribute in milliseconds"
320
return self._timedelta_to_milliseconds(self.timeout)
322
def extended_timeout_milliseconds(self):
323
"Return the 'extended_timeout' attribute in milliseconds"
324
return self._timedelta_to_milliseconds(self.extended_timeout)
326
def interval_milliseconds(self):
327
"Return the 'interval' attribute in milliseconds"
328
return self._timedelta_to_milliseconds(self.interval)
330
def approval_delay_milliseconds(self):
331
return self._timedelta_to_milliseconds(self.approval_delay)
333
def __init__(self, name = None, disable_hook=None, config=None):
334
"""Note: the 'checker' key in 'config' sets the
335
'checker_command' attribute and *not* the 'checker'
823
if server_settings is None:
825
self.server_settings = server_settings
826
# adding all client settings
827
for setting, value in settings.items():
828
setattr(self, setting, value)
831
if not hasattr(self, "last_enabled"):
832
self.last_enabled = datetime.datetime.utcnow()
833
if not hasattr(self, "expires"):
834
self.expires = (datetime.datetime.utcnow()
837
self.last_enabled = None
840
340
logger.debug("Creating client %r", self.name)
341
# Uppercase and remove spaces from fingerprint for later
342
# comparison purposes with return value from the fingerprint()
344
self.fingerprint = (config["fingerprint"].upper()
841
346
logger.debug(" Fingerprint: %s", self.fingerprint)
842
self.created = settings.get("created",
843
datetime.datetime.utcnow())
845
# attributes specific for this server instance
347
if "secret" in config:
348
self.secret = config["secret"].decode("base64")
349
elif "secfile" in config:
350
with open(os.path.expanduser(os.path.expandvars
351
(config["secfile"])),
353
self.secret = secfile.read()
355
raise TypeError("No secret or secfile for client %s"
357
self.host = config.get("host", "")
358
self.created = datetime.datetime.utcnow()
360
self.last_approval_request = None
361
self.last_enabled = None
362
self.last_checked_ok = None
363
self.timeout = string_to_delta(config["timeout"])
364
self.extended_timeout = string_to_delta(config["extended_timeout"])
365
self.interval = string_to_delta(config["interval"])
366
self.disable_hook = disable_hook
846
367
self.checker = None
847
368
self.checker_initiator_tag = None
848
369
self.disable_initiator_tag = None
849
371
self.checker_callback_tag = None
372
self.checker_command = config["checker"]
850
373
self.current_checker_command = None
374
self.last_connect = None
375
self._approved = None
376
self.approved_by_default = config.get("approved_by_default",
852
378
self.approvals_pending = 0
853
self.changedstate = multiprocessing_manager.Condition(
854
multiprocessing_manager.Lock())
855
self.client_structure = [attr
856
for attr in self.__dict__.iterkeys()
857
if not attr.startswith("_")]
858
self.client_structure.append("client_structure")
860
for name, t in inspect.getmembers(
861
type(self), lambda obj: isinstance(obj, property)):
862
if not name.startswith("_"):
863
self.client_structure.append(name)
379
self.approval_delay = string_to_delta(
380
config["approval_delay"])
381
self.approval_duration = string_to_delta(
382
config["approval_duration"])
383
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
865
# Send notice to process children that client state has changed
866
385
def send_changedstate(self):
867
with self.changedstate:
868
self.changedstate.notify_all()
386
self.changedstate.acquire()
387
self.changedstate.notify_all()
388
self.changedstate.release()
870
390
def enable(self):
871
391
"""Start this client's checker and timeout hooks"""
872
392
if getattr(self, "enabled", False):
873
393
# Already enabled
395
self.send_changedstate()
396
self.last_enabled = datetime.datetime.utcnow()
397
# Schedule a new checker to be started an 'interval' from now,
398
# and every interval from then on.
399
self.checker_initiator_tag = (gobject.timeout_add
400
(self.interval_milliseconds(),
402
# Schedule a disable() when 'timeout' has passed
875
403
self.expires = datetime.datetime.utcnow() + self.timeout
404
self.disable_initiator_tag = (gobject.timeout_add
405
(self.timeout_milliseconds(),
876
407
self.enabled = True
877
self.last_enabled = datetime.datetime.utcnow()
879
self.send_changedstate()
408
# Also start a new checker *right now*.
881
411
def disable(self, quiet=True):
882
412
"""Disable this client."""
883
413
if not getattr(self, "enabled", False):
416
self.send_changedstate()
886
418
logger.info("Disabling client %s", self.name)
887
if getattr(self, "disable_initiator_tag", None) is not None:
419
if getattr(self, "disable_initiator_tag", False):
888
420
gobject.source_remove(self.disable_initiator_tag)
889
421
self.disable_initiator_tag = None
890
422
self.expires = None
891
if getattr(self, "checker_initiator_tag", None) is not None:
423
if getattr(self, "checker_initiator_tag", False):
892
424
gobject.source_remove(self.checker_initiator_tag)
893
425
self.checker_initiator_tag = None
894
426
self.stop_checker()
427
if self.disable_hook:
428
self.disable_hook(self)
895
429
self.enabled = False
897
self.send_changedstate()
898
430
# Do not run this again if called by a gobject.timeout_add
901
433
def __del__(self):
434
self.disable_hook = None
904
def init_checker(self):
905
# Schedule a new checker to be started an 'interval' from now,
906
# and every interval from then on.
907
if self.checker_initiator_tag is not None:
908
gobject.source_remove(self.checker_initiator_tag)
909
self.checker_initiator_tag = gobject.timeout_add(
910
int(self.interval.total_seconds() * 1000),
912
# Schedule a disable() when 'timeout' has passed
913
if self.disable_initiator_tag is not None:
914
gobject.source_remove(self.disable_initiator_tag)
915
self.disable_initiator_tag = gobject.timeout_add(
916
int(self.timeout.total_seconds() * 1000), self.disable)
917
# Also start a new checker *right now*.
920
def checker_callback(self, source, condition, connection,
437
def checker_callback(self, pid, condition, command):
922
438
"""The checker has completed, so take appropriate actions."""
923
439
self.checker_callback_tag = None
924
440
self.checker = None
925
# Read return code from connection (see call_pipe)
926
returncode = connection.recv()
930
self.last_checker_status = returncode
931
self.last_checker_signal = None
932
if self.last_checker_status == 0:
441
if os.WIFEXITED(condition):
442
exitstatus = os.WEXITSTATUS(condition)
933
444
logger.info("Checker for %(name)s succeeded",
935
446
self.checked_ok()
937
logger.info("Checker for %(name)s failed", vars(self))
448
logger.info("Checker for %(name)s failed",
939
self.last_checker_status = -1
940
self.last_checker_signal = -returncode
941
451
logger.warning("Checker for %(name)s crashed?",
945
def checked_ok(self):
946
"""Assert that the client has been seen, alive and well."""
947
self.last_checked_ok = datetime.datetime.utcnow()
948
self.last_checker_status = 0
949
self.last_checker_signal = None
952
def bump_timeout(self, timeout=None):
953
"""Bump up the timeout for this client."""
454
def checked_ok(self, timeout=None):
455
"""Bump up the timeout for this client.
457
This should only be called when the client has been seen,
954
460
if timeout is None:
955
461
timeout = self.timeout
956
if self.disable_initiator_tag is not None:
957
gobject.source_remove(self.disable_initiator_tag)
958
self.disable_initiator_tag = None
959
if getattr(self, "enabled", False):
960
self.disable_initiator_tag = gobject.timeout_add(
961
int(timeout.total_seconds() * 1000), self.disable)
962
self.expires = datetime.datetime.utcnow() + timeout
462
self.last_checked_ok = datetime.datetime.utcnow()
463
gobject.source_remove(self.disable_initiator_tag)
464
self.expires = datetime.datetime.utcnow() + timeout
465
self.disable_initiator_tag = (gobject.timeout_add
466
(self._timedelta_to_milliseconds(timeout),
964
469
def need_approval(self):
965
470
self.last_approval_request = datetime.datetime.utcnow()
970
475
If a checker already exists, leave it running and do
972
477
# The reason for not killing a running checker is that if we
973
# did that, and if a checker (for some reason) started running
974
# slowly and taking more than 'interval' time, then the client
975
# would inevitably timeout, since no checker would get a
976
# chance to run to completion. If we instead leave running
478
# did that, then if a checker (for some reason) started
479
# running slowly and taking more than 'interval' time, the
480
# client would inevitably timeout, since no checker would get
481
# a chance to run to completion. If we instead leave running
977
482
# checkers alone, the checker would have to take more time
978
483
# than 'timeout' for the client to be disabled, which is as it
981
if self.checker is not None and not self.checker.is_alive():
982
logger.warning("Checker was not alive; joining")
486
# If a checker exists, make sure it is not a zombie
488
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
489
except (AttributeError, OSError) as error:
490
if (isinstance(error, OSError)
491
and error.errno != errno.ECHILD):
495
logger.warning("Checker was a zombie")
496
gobject.source_remove(self.checker_callback_tag)
497
self.checker_callback(pid, status,
498
self.current_checker_command)
985
499
# Start a new checker if needed
986
500
if self.checker is None:
987
# Escape attributes for the shell
989
attr: re.escape(str(getattr(self, attr)))
990
for attr in self.runtime_expansions }
992
command = self.checker_command % escaped_attrs
993
except TypeError as error:
994
logger.error('Could not format string "%s"',
995
self.checker_command,
997
return True # Try again later
502
# In case checker_command has exactly one % operator
503
command = self.checker_command % self.host
505
# Escape attributes for the shell
506
escaped_attrs = dict(
508
re.escape(unicode(str(getattr(self, attr, "")),
512
self.runtime_expansions)
515
command = self.checker_command % escaped_attrs
516
except TypeError as error:
517
logger.error('Could not format string "%s":'
518
' %s', self.checker_command, error)
519
return True # Try again later
998
520
self.current_checker_command = command
999
logger.info("Starting checker %r for %s", command,
1001
# We don't need to redirect stdout and stderr, since
1002
# in normal mode, that is already done by daemon(),
1003
# and in debug mode we don't want to. (Stdin is
1004
# always replaced by /dev/null.)
1005
# The exception is when not debugging but nevertheless
1006
# running in the foreground; use the previously
1008
popen_args = { "close_fds": True,
1011
if (not self.server_settings["debug"]
1012
and self.server_settings["foreground"]):
1013
popen_args.update({"stdout": wnull,
1015
pipe = multiprocessing.Pipe(duplex = False)
1016
self.checker = multiprocessing.Process(
1018
args = (pipe[1], subprocess.call, command),
1019
kwargs = popen_args)
1020
self.checker.start()
1021
self.checker_callback_tag = gobject.io_add_watch(
1022
pipe[0].fileno(), gobject.IO_IN,
1023
self.checker_callback, pipe[0], command)
522
logger.info("Starting checker %r for %s",
524
# We don't need to redirect stdout and stderr, since
525
# in normal mode, that is already done by daemon(),
526
# and in debug mode we don't want to. (Stdin is
527
# always replaced by /dev/null.)
528
self.checker = subprocess.Popen(command,
531
self.checker_callback_tag = (gobject.child_watch_add
533
self.checker_callback,
535
# The checker may have completed before the gobject
536
# watch was added. Check for this.
537
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
539
gobject.source_remove(self.checker_callback_tag)
540
self.checker_callback(pid, status, command)
541
except OSError as error:
542
logger.error("Failed to start subprocess: %s",
1024
544
# Re-run this periodically if run by gobject.timeout_add
1134
class DBusObjectWithAnnotations(dbus.service.Object):
1135
"""A D-Bus object with annotations.
1137
Classes inheriting from this can use the dbus_annotations
1138
decorator to add annotations to methods or signals.
1142
def _is_dbus_thing(thing):
1143
"""Returns a function testing if an attribute is a D-Bus thing
1145
If called like _is_dbus_thing("method") it returns a function
1146
suitable for use as predicate to inspect.getmembers().
1148
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1151
def _get_all_dbus_things(self, thing):
1152
"""Returns a generator of (name, attribute) pairs
1154
return ((getattr(athing.__get__(self), "_dbus_name", name),
1155
athing.__get__(self))
1156
for cls in self.__class__.__mro__
1158
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1160
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1161
out_signature = "s",
1162
path_keyword = 'object_path',
1163
connection_keyword = 'connection')
1164
def Introspect(self, object_path, connection):
1165
"""Overloading of standard D-Bus method.
1167
Inserts annotation tags on methods and signals.
1169
xmlstring = dbus.service.Object.Introspect(self, object_path,
1172
document = xml.dom.minidom.parseString(xmlstring)
1174
for if_tag in document.getElementsByTagName("interface"):
1175
# Add annotation tags
1176
for typ in ("method", "signal"):
1177
for tag in if_tag.getElementsByTagName(typ):
1179
for name, prop in (self.
1180
_get_all_dbus_things(typ)):
1181
if (name == tag.getAttribute("name")
1182
and prop._dbus_interface
1183
== if_tag.getAttribute("name")):
1184
annots.update(getattr(
1185
prop, "_dbus_annotations", {}))
1186
for name, value in annots.items():
1187
ann_tag = document.createElement(
1189
ann_tag.setAttribute("name", name)
1190
ann_tag.setAttribute("value", value)
1191
tag.appendChild(ann_tag)
1192
# Add interface annotation tags
1193
for annotation, value in dict(
1194
itertools.chain.from_iterable(
1195
annotations().items()
1196
for name, annotations
1197
in self._get_all_dbus_things("interface")
1198
if name == if_tag.getAttribute("name")
1200
ann_tag = document.createElement("annotation")
1201
ann_tag.setAttribute("name", annotation)
1202
ann_tag.setAttribute("value", value)
1203
if_tag.appendChild(ann_tag)
1204
# Fix argument name for the Introspect method itself
1205
if (if_tag.getAttribute("name")
1206
== dbus.INTROSPECTABLE_IFACE):
1207
for cn in if_tag.getElementsByTagName("method"):
1208
if cn.getAttribute("name") == "Introspect":
1209
for arg in cn.getElementsByTagName("arg"):
1210
if (arg.getAttribute("direction")
1212
arg.setAttribute("name",
1214
xmlstring = document.toxml("utf-8")
1216
except (AttributeError, xml.dom.DOMException,
1217
xml.parsers.expat.ExpatError) as error:
1218
logger.error("Failed to override Introspection method",
1223
class DBusObjectWithProperties(DBusObjectWithAnnotations):
614
class DBusObjectWithProperties(dbus.service.Object):
1224
615
"""A D-Bus object with properties.
1226
617
Classes inheriting from this can use the dbus_service_property
1227
618
decorator to expose methods as D-Bus properties. It exposes the
1228
619
standard Get(), Set(), and GetAll() methods on the D-Bus.
623
def _is_dbus_property(obj):
624
return getattr(obj, "_dbus_is_property", False)
626
def _get_all_dbus_properties(self):
627
"""Returns a generator of (name, attribute) pairs
629
return ((prop._dbus_name, prop)
631
inspect.getmembers(self, self._is_dbus_property))
1231
633
def _get_dbus_property(self, interface_name, property_name):
1232
634
"""Returns a bound method if one exists which is a D-Bus
1233
635
property with the specified name and interface.
1235
for cls in self.__class__.__mro__:
1236
for name, value in inspect.getmembers(
1237
cls, self._is_dbus_thing("property")):
1238
if (value._dbus_name == property_name
1239
and value._dbus_interface == interface_name):
1240
return value.__get__(self)
637
for name in (property_name,
638
property_name + "_dbus_property"):
639
prop = getattr(self, name, None)
641
or not self._is_dbus_property(prop)
642
or prop._dbus_name != property_name
643
or (interface_name and prop._dbus_interface
644
and interface_name != prop._dbus_interface)):
1242
647
# No such property
1243
raise DBusPropertyNotFound("{}:{}.{}".format(
1244
self.dbus_object_path, interface_name, property_name))
1247
def _get_all_interface_names(cls):
1248
"""Get a sequence of all interfaces supported by an object"""
1249
return (name for name in set(getattr(getattr(x, attr),
1250
"_dbus_interface", None)
1251
for x in (inspect.getmro(cls))
1253
if name is not None)
1255
@dbus.service.method(dbus.PROPERTIES_IFACE,
648
raise DBusPropertyNotFound(self.dbus_object_path + ":"
649
+ interface_name + "."
652
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1257
653
out_signature="v")
1258
654
def Get(self, interface_name, property_name):
1259
655
"""Standard D-Bus property Get() method, see D-Bus standard.
1306
699
if not hasattr(value, "variant_level"):
1307
properties[name] = value
1309
properties[name] = type(value)(
1310
value, variant_level = value.variant_level + 1)
1311
return dbus.Dictionary(properties, signature="sv")
1313
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1314
def PropertiesChanged(self, interface_name, changed_properties,
1315
invalidated_properties):
1316
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
702
all[name] = type(value)(value, variant_level=
703
value.variant_level+1)
704
return dbus.Dictionary(all, signature="sv")
1321
706
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1322
707
out_signature="s",
1323
708
path_keyword='object_path',
1324
709
connection_keyword='connection')
1325
710
def Introspect(self, object_path, connection):
1326
"""Overloading of standard D-Bus method.
1328
Inserts property tags and interface annotation tags.
711
"""Standard D-Bus method, overloaded to insert property tags.
1330
xmlstring = DBusObjectWithAnnotations.Introspect(self,
713
xmlstring = dbus.service.Object.Introspect(self, object_path,
1334
716
document = xml.dom.minidom.parseString(xmlstring)
1336
717
def make_tag(document, name, prop):
1337
718
e = document.createElement("property")
1338
719
e.setAttribute("name", name)
1339
720
e.setAttribute("type", prop._dbus_signature)
1340
721
e.setAttribute("access", prop._dbus_access)
1343
723
for if_tag in document.getElementsByTagName("interface"):
1345
724
for tag in (make_tag(document, name, prop)
1347
in self._get_all_dbus_things("property")
726
in self._get_all_dbus_properties()
1348
727
if prop._dbus_interface
1349
728
== if_tag.getAttribute("name")):
1350
729
if_tag.appendChild(tag)
1351
# Add annotation tags for properties
1352
for tag in if_tag.getElementsByTagName("property"):
1354
for name, prop in self._get_all_dbus_things(
1356
if (name == tag.getAttribute("name")
1357
and prop._dbus_interface
1358
== if_tag.getAttribute("name")):
1359
annots.update(getattr(
1360
prop, "_dbus_annotations", {}))
1361
for name, value in annots.items():
1362
ann_tag = document.createElement(
1364
ann_tag.setAttribute("name", name)
1365
ann_tag.setAttribute("value", value)
1366
tag.appendChild(ann_tag)
1367
730
# Add the names to the return values for the
1368
731
# "org.freedesktop.DBus.Properties" methods
1369
732
if (if_tag.getAttribute("name")
1384
747
except (AttributeError, xml.dom.DOMException,
1385
748
xml.parsers.expat.ExpatError) as error:
1386
749
logger.error("Failed to override Introspection method",
1391
dbus.OBJECT_MANAGER_IFACE
1392
except AttributeError:
1393
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1395
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1396
"""A D-Bus object with an ObjectManager.
1398
Classes inheriting from this exposes the standard
1399
GetManagedObjects call and the InterfacesAdded and
1400
InterfacesRemoved signals on the standard
1401
"org.freedesktop.DBus.ObjectManager" interface.
1403
Note: No signals are sent automatically; they must be sent
1406
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1407
out_signature = "a{oa{sa{sv}}}")
1408
def GetManagedObjects(self):
1409
"""This function must be overridden"""
1410
raise NotImplementedError()
1412
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1413
signature = "oa{sa{sv}}")
1414
def InterfacesAdded(self, object_path, interfaces_and_properties):
1417
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1418
def InterfacesRemoved(self, object_path, interfaces):
1421
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1422
out_signature = "s",
1423
path_keyword = 'object_path',
1424
connection_keyword = 'connection')
1425
def Introspect(self, object_path, connection):
1426
"""Overloading of standard D-Bus method.
1428
Override return argument name of GetManagedObjects to be
1429
"objpath_interfaces_and_properties"
1431
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1435
document = xml.dom.minidom.parseString(xmlstring)
1437
for if_tag in document.getElementsByTagName("interface"):
1438
# Fix argument name for the GetManagedObjects method
1439
if (if_tag.getAttribute("name")
1440
== dbus.OBJECT_MANAGER_IFACE):
1441
for cn in if_tag.getElementsByTagName("method"):
1442
if (cn.getAttribute("name")
1443
== "GetManagedObjects"):
1444
for arg in cn.getElementsByTagName("arg"):
1445
if (arg.getAttribute("direction")
1449
"objpath_interfaces"
1451
xmlstring = document.toxml("utf-8")
1453
except (AttributeError, xml.dom.DOMException,
1454
xml.parsers.expat.ExpatError) as error:
1455
logger.error("Failed to override Introspection method",
1459
def datetime_to_dbus(dt, variant_level=0):
1460
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1462
return dbus.String("", variant_level = variant_level)
1463
return dbus.String(dt.isoformat(), variant_level=variant_level)
1466
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1467
"""A class decorator; applied to a subclass of
1468
dbus.service.Object, it will add alternate D-Bus attributes with
1469
interface names according to the "alt_interface_names" mapping.
1472
@alternate_dbus_interfaces({"org.example.Interface":
1473
"net.example.AlternateInterface"})
1474
class SampleDBusObject(dbus.service.Object):
1475
@dbus.service.method("org.example.Interface")
1476
def SampleDBusMethod():
1479
The above "SampleDBusMethod" on "SampleDBusObject" will be
1480
reachable via two interfaces: "org.example.Interface" and
1481
"net.example.AlternateInterface", the latter of which will have
1482
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1483
"true", unless "deprecate" is passed with a False value.
1485
This works for methods and signals, and also for D-Bus properties
1486
(from DBusObjectWithProperties) and interfaces (from the
1487
dbus_interface_annotations decorator).
1491
for orig_interface_name, alt_interface_name in (
1492
alt_interface_names.items()):
1494
interface_names = set()
1495
# Go though all attributes of the class
1496
for attrname, attribute in inspect.getmembers(cls):
1497
# Ignore non-D-Bus attributes, and D-Bus attributes
1498
# with the wrong interface name
1499
if (not hasattr(attribute, "_dbus_interface")
1500
or not attribute._dbus_interface.startswith(
1501
orig_interface_name)):
1503
# Create an alternate D-Bus interface name based on
1505
alt_interface = attribute._dbus_interface.replace(
1506
orig_interface_name, alt_interface_name)
1507
interface_names.add(alt_interface)
1508
# Is this a D-Bus signal?
1509
if getattr(attribute, "_dbus_is_signal", False):
1510
if sys.version_info.major == 2:
1511
# Extract the original non-method undecorated
1512
# function by black magic
1513
nonmethod_func = (dict(
1514
zip(attribute.func_code.co_freevars,
1515
attribute.__closure__))
1516
["func"].cell_contents)
1518
nonmethod_func = attribute
1519
# Create a new, but exactly alike, function
1520
# object, and decorate it to be a new D-Bus signal
1521
# with the alternate D-Bus interface name
1522
if sys.version_info.major == 2:
1523
new_function = types.FunctionType(
1524
nonmethod_func.func_code,
1525
nonmethod_func.func_globals,
1526
nonmethod_func.func_name,
1527
nonmethod_func.func_defaults,
1528
nonmethod_func.func_closure)
1530
new_function = types.FunctionType(
1531
nonmethod_func.__code__,
1532
nonmethod_func.__globals__,
1533
nonmethod_func.__name__,
1534
nonmethod_func.__defaults__,
1535
nonmethod_func.__closure__)
1536
new_function = (dbus.service.signal(
1538
attribute._dbus_signature)(new_function))
1539
# Copy annotations, if any
1541
new_function._dbus_annotations = dict(
1542
attribute._dbus_annotations)
1543
except AttributeError:
1545
# Define a creator of a function to call both the
1546
# original and alternate functions, so both the
1547
# original and alternate signals gets sent when
1548
# the function is called
1549
def fixscope(func1, func2):
1550
"""This function is a scope container to pass
1551
func1 and func2 to the "call_both" function
1552
outside of its arguments"""
1554
@functools.wraps(func2)
1555
def call_both(*args, **kwargs):
1556
"""This function will emit two D-Bus
1557
signals by calling func1 and func2"""
1558
func1(*args, **kwargs)
1559
func2(*args, **kwargs)
1560
# Make wrapper function look like a D-Bus signal
1561
for name, attr in inspect.getmembers(func2):
1562
if name.startswith("_dbus_"):
1563
setattr(call_both, name, attr)
1566
# Create the "call_both" function and add it to
1568
attr[attrname] = fixscope(attribute, new_function)
1569
# Is this a D-Bus method?
1570
elif getattr(attribute, "_dbus_is_method", False):
1571
# Create a new, but exactly alike, function
1572
# object. Decorate it to be a new D-Bus method
1573
# with the alternate D-Bus interface name. Add it
1576
dbus.service.method(
1578
attribute._dbus_in_signature,
1579
attribute._dbus_out_signature)
1580
(types.FunctionType(attribute.func_code,
1581
attribute.func_globals,
1582
attribute.func_name,
1583
attribute.func_defaults,
1584
attribute.func_closure)))
1585
# Copy annotations, if any
1587
attr[attrname]._dbus_annotations = dict(
1588
attribute._dbus_annotations)
1589
except AttributeError:
1591
# Is this a D-Bus property?
1592
elif getattr(attribute, "_dbus_is_property", False):
1593
# Create a new, but exactly alike, function
1594
# object, and decorate it to be a new D-Bus
1595
# property with the alternate D-Bus interface
1596
# name. Add it to the class.
1597
attr[attrname] = (dbus_service_property(
1598
alt_interface, attribute._dbus_signature,
1599
attribute._dbus_access,
1600
attribute._dbus_get_args_options
1602
(types.FunctionType(
1603
attribute.func_code,
1604
attribute.func_globals,
1605
attribute.func_name,
1606
attribute.func_defaults,
1607
attribute.func_closure)))
1608
# Copy annotations, if any
1610
attr[attrname]._dbus_annotations = dict(
1611
attribute._dbus_annotations)
1612
except AttributeError:
1614
# Is this a D-Bus interface?
1615
elif getattr(attribute, "_dbus_is_interface", False):
1616
# Create a new, but exactly alike, function
1617
# object. Decorate it to be a new D-Bus interface
1618
# with the alternate D-Bus interface name. Add it
1621
dbus_interface_annotations(alt_interface)
1622
(types.FunctionType(attribute.func_code,
1623
attribute.func_globals,
1624
attribute.func_name,
1625
attribute.func_defaults,
1626
attribute.func_closure)))
1628
# Deprecate all alternate interfaces
1629
iname="_AlternateDBusNames_interface_annotation{}"
1630
for interface_name in interface_names:
1632
@dbus_interface_annotations(interface_name)
1634
return { "org.freedesktop.DBus.Deprecated":
1636
# Find an unused name
1637
for aname in (iname.format(i)
1638
for i in itertools.count()):
1639
if aname not in attr:
1643
# Replace the class with a new subclass of it with
1644
# methods, signals, etc. as created above.
1645
cls = type(b"{}Alternate".format(cls.__name__),
1652
@alternate_dbus_interfaces({"se.recompile.Mandos":
1653
"se.bsnet.fukt.Mandos"})
1654
754
class ClientDBus(Client, DBusObjectWithProperties):
1655
755
"""A Client class using D-Bus
1662
762
runtime_expansions = (Client.runtime_expansions
1663
+ ("dbus_object_path", ))
1665
_interface = "se.recompile.Mandos.Client"
763
+ ("dbus_object_path",))
1667
765
# dbus.service.Object doesn't use super(), so we can't either.
1669
767
def __init__(self, bus = None, *args, **kwargs):
768
self._approvals_pending = 0
1671
770
Client.__init__(self, *args, **kwargs)
1672
771
# Only now, when this client is initialized, can it show up on
1674
client_object_name = str(self.name).translate(
773
client_object_name = unicode(self.name).translate(
1675
774
{ord("."): ord("_"),
1676
775
ord("-"): ord("_")})
1677
self.dbus_object_path = dbus.ObjectPath(
1678
"/clients/" + client_object_name)
776
self.dbus_object_path = (dbus.ObjectPath
777
("/clients/" + client_object_name))
1679
778
DBusObjectWithProperties.__init__(self, self.bus,
1680
779
self.dbus_object_path)
1682
def notifychangeproperty(transform_func, dbus_name,
1683
type_func=lambda x: x,
1685
invalidate_only=False,
1686
_interface=_interface):
1687
""" Modify a variable so that it's a property which announces
1688
its changes to DBus.
1690
transform_fun: Function that takes a value and a variant_level
1691
and transforms it to a D-Bus type.
1692
dbus_name: D-Bus name of the variable
1693
type_func: Function that transform the value before sending it
1694
to the D-Bus. Default: no transform
1695
variant_level: D-Bus variant level. Default: 1
1697
attrname = "_{}".format(dbus_name)
1699
def setter(self, value):
1700
if hasattr(self, "dbus_object_path"):
1701
if (not hasattr(self, attrname) or
1702
type_func(getattr(self, attrname, None))
1703
!= type_func(value)):
1705
self.PropertiesChanged(
1706
_interface, dbus.Dictionary(),
1707
dbus.Array((dbus_name, )))
1709
dbus_value = transform_func(
1711
variant_level = variant_level)
1712
self.PropertyChanged(dbus.String(dbus_name),
1714
self.PropertiesChanged(
1716
dbus.Dictionary({ dbus.String(dbus_name):
1719
setattr(self, attrname, value)
1721
return property(lambda self: getattr(self, attrname), setter)
1723
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1724
approvals_pending = notifychangeproperty(dbus.Boolean,
1727
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1728
last_enabled = notifychangeproperty(datetime_to_dbus,
1730
checker = notifychangeproperty(
1731
dbus.Boolean, "CheckerRunning",
1732
type_func = lambda checker: checker is not None)
1733
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1735
last_checker_status = notifychangeproperty(dbus.Int16,
1736
"LastCheckerStatus")
1737
last_approval_request = notifychangeproperty(
1738
datetime_to_dbus, "LastApprovalRequest")
1739
approved_by_default = notifychangeproperty(dbus.Boolean,
1740
"ApprovedByDefault")
1741
approval_delay = notifychangeproperty(
1742
dbus.UInt64, "ApprovalDelay",
1743
type_func = lambda td: td.total_seconds() * 1000)
1744
approval_duration = notifychangeproperty(
1745
dbus.UInt64, "ApprovalDuration",
1746
type_func = lambda td: td.total_seconds() * 1000)
1747
host = notifychangeproperty(dbus.String, "Host")
1748
timeout = notifychangeproperty(
1749
dbus.UInt64, "Timeout",
1750
type_func = lambda td: td.total_seconds() * 1000)
1751
extended_timeout = notifychangeproperty(
1752
dbus.UInt64, "ExtendedTimeout",
1753
type_func = lambda td: td.total_seconds() * 1000)
1754
interval = notifychangeproperty(
1755
dbus.UInt64, "Interval",
1756
type_func = lambda td: td.total_seconds() * 1000)
1757
checker_command = notifychangeproperty(dbus.String, "Checker")
1758
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1759
invalidate_only=True)
1761
del notifychangeproperty
780
def _set_expires(self, value):
781
old_value = getattr(self, "_expires", None)
782
self._expires = value
783
if hasattr(self, "dbus_object_path") and old_value != value:
784
dbus_time = (self._datetime_to_dbus(self._expires,
786
self.PropertyChanged(dbus.String("Expires"),
788
expires = property(lambda self: self._expires, _set_expires)
791
def _get_approvals_pending(self):
792
return self._approvals_pending
793
def _set_approvals_pending(self, value):
794
old_value = self._approvals_pending
795
self._approvals_pending = value
797
if (hasattr(self, "dbus_object_path")
798
and bval is not bool(old_value)):
799
dbus_bool = dbus.Boolean(bval, variant_level=1)
800
self.PropertyChanged(dbus.String("ApprovalPending"),
803
approvals_pending = property(_get_approvals_pending,
804
_set_approvals_pending)
805
del _get_approvals_pending, _set_approvals_pending
808
def _datetime_to_dbus(dt, variant_level=0):
809
"""Convert a UTC datetime.datetime() to a D-Bus type."""
811
return dbus.String("", variant_level = variant_level)
812
return dbus.String(dt.isoformat(),
813
variant_level=variant_level)
816
oldstate = getattr(self, "enabled", False)
817
r = Client.enable(self)
818
if oldstate != self.enabled:
820
self.PropertyChanged(dbus.String("Enabled"),
821
dbus.Boolean(True, variant_level=1))
822
self.PropertyChanged(
823
dbus.String("LastEnabled"),
824
self._datetime_to_dbus(self.last_enabled,
828
def disable(self, quiet = False):
829
oldstate = getattr(self, "enabled", False)
830
r = Client.disable(self, quiet=quiet)
831
if not quiet and oldstate != self.enabled:
833
self.PropertyChanged(dbus.String("Enabled"),
834
dbus.Boolean(False, variant_level=1))
1763
837
def __del__(self, *args, **kwargs):
1769
843
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1770
844
Client.__del__(self, *args, **kwargs)
1772
def checker_callback(self, source, condition,
1773
connection, command, *args, **kwargs):
1774
ret = Client.checker_callback(self, source, condition,
1775
connection, command, *args,
1777
exitstatus = self.last_checker_status
846
def checker_callback(self, pid, condition, command,
848
self.checker_callback_tag = None
851
self.PropertyChanged(dbus.String("CheckerRunning"),
852
dbus.Boolean(False, variant_level=1))
853
if os.WIFEXITED(condition):
854
exitstatus = os.WEXITSTATUS(condition)
1779
855
# Emit D-Bus signal
1780
856
self.CheckerCompleted(dbus.Int16(exitstatus),
1781
# This is specific to GNU libC
1782
dbus.Int64(exitstatus << 8),
857
dbus.Int64(condition),
1783
858
dbus.String(command))
1785
860
# Emit D-Bus signal
1786
861
self.CheckerCompleted(dbus.Int16(-1),
1788
# This is specific to GNU libC
1790
| self.last_checker_signal),
862
dbus.Int64(condition),
1791
863
dbus.String(command))
865
return Client.checker_callback(self, pid, condition, command,
868
def checked_ok(self, *args, **kwargs):
869
Client.checked_ok(self, *args, **kwargs)
871
self.PropertyChanged(
872
dbus.String("LastCheckedOK"),
873
(self._datetime_to_dbus(self.last_checked_ok,
876
def need_approval(self, *args, **kwargs):
877
r = Client.need_approval(self, *args, **kwargs)
879
self.PropertyChanged(
880
dbus.String("LastApprovalRequest"),
881
(self._datetime_to_dbus(self.last_approval_request,
1794
885
def start_checker(self, *args, **kwargs):
1795
old_checker_pid = getattr(self.checker, "pid", None)
886
old_checker = self.checker
887
if self.checker is not None:
888
old_checker_pid = self.checker.pid
890
old_checker_pid = None
1796
891
r = Client.start_checker(self, *args, **kwargs)
1797
892
# Only if new checker process was started
1798
893
if (self.checker is not None
1799
894
and old_checker_pid != self.checker.pid):
1800
895
# Emit D-Bus signal
1801
896
self.CheckerStarted(self.current_checker_command)
897
self.PropertyChanged(
898
dbus.String("CheckerRunning"),
899
dbus.Boolean(True, variant_level=1))
902
def stop_checker(self, *args, **kwargs):
903
old_checker = getattr(self, "checker", None)
904
r = Client.stop_checker(self, *args, **kwargs)
905
if (old_checker is not None
906
and getattr(self, "checker", None) is None):
907
self.PropertyChanged(dbus.String("CheckerRunning"),
908
dbus.Boolean(False, variant_level=1))
1804
911
def _reset_approved(self):
1805
self.approved = None
912
self._approved = None
1808
915
def approve(self, value=True):
1809
self.approved = value
1810
gobject.timeout_add(int(self.approval_duration.total_seconds()
1811
* 1000), self._reset_approved)
1812
916
self.send_changedstate()
917
self._approved = value
918
gobject.timeout_add(self._timedelta_to_milliseconds
919
(self.approval_duration),
920
self._reset_approved)
1814
923
## D-Bus methods, signals & properties
924
_interface = "se.bsnet.fukt.Mandos.Client"
1904
1007
return dbus.Boolean(bool(self.approvals_pending))
1906
1009
# ApprovedByDefault - property
1907
@dbus_service_property(_interface,
1010
@dbus_service_property(_interface, signature="b",
1909
1011
access="readwrite")
1910
1012
def ApprovedByDefault_dbus_property(self, value=None):
1911
1013
if value is None: # get
1912
1014
return dbus.Boolean(self.approved_by_default)
1015
old_value = self.approved_by_default
1913
1016
self.approved_by_default = bool(value)
1018
if old_value != self.approved_by_default:
1019
self.PropertyChanged(dbus.String("ApprovedByDefault"),
1020
dbus.Boolean(value, variant_level=1))
1915
1022
# ApprovalDelay - property
1916
@dbus_service_property(_interface,
1023
@dbus_service_property(_interface, signature="t",
1918
1024
access="readwrite")
1919
1025
def ApprovalDelay_dbus_property(self, value=None):
1920
1026
if value is None: # get
1921
return dbus.UInt64(self.approval_delay.total_seconds()
1027
return dbus.UInt64(self.approval_delay_milliseconds())
1028
old_value = self.approval_delay
1923
1029
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1031
if old_value != self.approval_delay:
1032
self.PropertyChanged(dbus.String("ApprovalDelay"),
1033
dbus.UInt64(value, variant_level=1))
1925
1035
# ApprovalDuration - property
1926
@dbus_service_property(_interface,
1036
@dbus_service_property(_interface, signature="t",
1928
1037
access="readwrite")
1929
1038
def ApprovalDuration_dbus_property(self, value=None):
1930
1039
if value is None: # get
1931
return dbus.UInt64(self.approval_duration.total_seconds()
1040
return dbus.UInt64(self._timedelta_to_milliseconds(
1041
self.approval_duration))
1042
old_value = self.approval_duration
1933
1043
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1045
if old_value != self.approval_duration:
1046
self.PropertyChanged(dbus.String("ApprovalDuration"),
1047
dbus.UInt64(value, variant_level=1))
1935
1049
# Name - property
1937
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1938
1050
@dbus_service_property(_interface, signature="s", access="read")
1939
1051
def Name_dbus_property(self):
1940
1052
return dbus.String(self.name)
1942
1054
# Fingerprint - property
1944
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1945
1055
@dbus_service_property(_interface, signature="s", access="read")
1946
1056
def Fingerprint_dbus_property(self):
1947
1057
return dbus.String(self.fingerprint)
1949
1059
# Host - property
1950
@dbus_service_property(_interface,
1060
@dbus_service_property(_interface, signature="s",
1952
1061
access="readwrite")
1953
1062
def Host_dbus_property(self, value=None):
1954
1063
if value is None: # get
1955
1064
return dbus.String(self.host)
1956
self.host = str(value)
1065
old_value = self.host
1068
if old_value != self.host:
1069
self.PropertyChanged(dbus.String("Host"),
1070
dbus.String(value, variant_level=1))
1958
1072
# Created - property
1960
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1961
1073
@dbus_service_property(_interface, signature="s", access="read")
1962
1074
def Created_dbus_property(self):
1963
return datetime_to_dbus(self.created)
1075
return dbus.String(self._datetime_to_dbus(self.created))
1965
1077
# LastEnabled - property
1966
1078
@dbus_service_property(_interface, signature="s", access="read")
1967
1079
def LastEnabled_dbus_property(self):
1968
return datetime_to_dbus(self.last_enabled)
1080
return self._datetime_to_dbus(self.last_enabled)
1970
1082
# Enabled - property
1971
@dbus_service_property(_interface,
1083
@dbus_service_property(_interface, signature="b",
1973
1084
access="readwrite")
1974
1085
def Enabled_dbus_property(self, value=None):
1975
1086
if value is None: # get
1982
1093
# LastCheckedOK - property
1983
@dbus_service_property(_interface,
1094
@dbus_service_property(_interface, signature="s",
1985
1095
access="readwrite")
1986
1096
def LastCheckedOK_dbus_property(self, value=None):
1987
1097
if value is not None:
1988
1098
self.checked_ok()
1990
return datetime_to_dbus(self.last_checked_ok)
1992
# LastCheckerStatus - property
1993
@dbus_service_property(_interface, signature="n", access="read")
1994
def LastCheckerStatus_dbus_property(self):
1995
return dbus.Int16(self.last_checker_status)
1100
return self._datetime_to_dbus(self.last_checked_ok)
1997
1102
# Expires - property
1998
1103
@dbus_service_property(_interface, signature="s", access="read")
1999
1104
def Expires_dbus_property(self):
2000
return datetime_to_dbus(self.expires)
1105
return self._datetime_to_dbus(self.expires)
2002
1107
# LastApprovalRequest - property
2003
1108
@dbus_service_property(_interface, signature="s", access="read")
2004
1109
def LastApprovalRequest_dbus_property(self):
2005
return datetime_to_dbus(self.last_approval_request)
1110
return self._datetime_to_dbus(self.last_approval_request)
2007
1112
# Timeout - property
2008
@dbus_service_property(_interface,
1113
@dbus_service_property(_interface, signature="t",
2010
1114
access="readwrite")
2011
1115
def Timeout_dbus_property(self, value=None):
2012
1116
if value is None: # get
2013
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2014
old_timeout = self.timeout
1117
return dbus.UInt64(self.timeout_milliseconds())
1118
old_value = self.timeout
2015
1119
self.timeout = datetime.timedelta(0, 0, 0, value)
2016
# Reschedule disabling
2018
now = datetime.datetime.utcnow()
2019
self.expires += self.timeout - old_timeout
2020
if self.expires <= now:
2021
# The timeout has passed
2024
if (getattr(self, "disable_initiator_tag", None)
2027
gobject.source_remove(self.disable_initiator_tag)
2028
self.disable_initiator_tag = gobject.timeout_add(
2029
int((self.expires - now).total_seconds() * 1000),
1121
if old_value != self.timeout:
1122
self.PropertyChanged(dbus.String("Timeout"),
1123
dbus.UInt64(value, variant_level=1))
1124
if getattr(self, "disable_initiator_tag", None) is None:
1126
# Reschedule timeout
1127
gobject.source_remove(self.disable_initiator_tag)
1128
self.disable_initiator_tag = None
1130
time_to_die = (self.
1131
_timedelta_to_milliseconds((self
1136
if time_to_die <= 0:
1137
# The timeout has passed
1140
self.expires = (datetime.datetime.utcnow()
1141
+ datetime.timedelta(milliseconds = time_to_die))
1142
self.disable_initiator_tag = (gobject.timeout_add
1143
(time_to_die, self.disable))
2032
1145
# ExtendedTimeout - property
2033
@dbus_service_property(_interface,
1146
@dbus_service_property(_interface, signature="t",
2035
1147
access="readwrite")
2036
1148
def ExtendedTimeout_dbus_property(self, value=None):
2037
1149
if value is None: # get
2038
return dbus.UInt64(self.extended_timeout.total_seconds()
1150
return dbus.UInt64(self.extended_timeout_milliseconds())
1151
old_value = self.extended_timeout
2040
1152
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1154
if old_value != self.extended_timeout:
1155
self.PropertyChanged(dbus.String("ExtendedTimeout"),
1156
dbus.UInt64(value, variant_level=1))
2042
1158
# Interval - property
2043
@dbus_service_property(_interface,
1159
@dbus_service_property(_interface, signature="t",
2045
1160
access="readwrite")
2046
1161
def Interval_dbus_property(self, value=None):
2047
1162
if value is None: # get
2048
return dbus.UInt64(self.interval.total_seconds() * 1000)
1163
return dbus.UInt64(self.interval_milliseconds())
1164
old_value = self.interval
2049
1165
self.interval = datetime.timedelta(0, 0, 0, value)
1167
if old_value != self.interval:
1168
self.PropertyChanged(dbus.String("Interval"),
1169
dbus.UInt64(value, variant_level=1))
2050
1170
if getattr(self, "checker_initiator_tag", None) is None:
2053
# Reschedule checker run
2054
gobject.source_remove(self.checker_initiator_tag)
2055
self.checker_initiator_tag = gobject.timeout_add(
2056
value, self.start_checker)
2057
self.start_checker() # Start one now, too
1172
# Reschedule checker run
1173
gobject.source_remove(self.checker_initiator_tag)
1174
self.checker_initiator_tag = (gobject.timeout_add
1175
(value, self.start_checker))
1176
self.start_checker() # Start one now, too
2059
1178
# Checker - property
2060
@dbus_service_property(_interface,
1179
@dbus_service_property(_interface, signature="s",
2062
1180
access="readwrite")
2063
1181
def Checker_dbus_property(self, value=None):
2064
1182
if value is None: # get
2065
1183
return dbus.String(self.checker_command)
2066
self.checker_command = str(value)
1184
old_value = self.checker_command
1185
self.checker_command = value
1187
if old_value != self.checker_command:
1188
self.PropertyChanged(dbus.String("Checker"),
1189
dbus.String(self.checker_command,
2068
1192
# CheckerRunning - property
2069
@dbus_service_property(_interface,
1193
@dbus_service_property(_interface, signature="b",
2071
1194
access="readwrite")
2072
1195
def CheckerRunning_dbus_property(self, value=None):
2073
1196
if value is None: # get
2288
1419
def fingerprint(openpgp):
2289
1420
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2290
1421
# New GnuTLS "datum" with the OpenPGP public key
2291
datum = gnutls.datum_t(
2292
ctypes.cast(ctypes.c_char_p(openpgp),
2293
ctypes.POINTER(ctypes.c_ubyte)),
2294
ctypes.c_uint(len(openpgp)))
1422
datum = (gnutls.library.types
1423
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1426
ctypes.c_uint(len(openpgp))))
2295
1427
# New empty GnuTLS certificate
2296
crt = gnutls.openpgp_crt_t()
2297
gnutls.openpgp_crt_init(ctypes.byref(crt))
1428
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1429
(gnutls.library.functions
1430
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2298
1431
# Import the OpenPGP public key into the certificate
2299
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2300
gnutls.OPENPGP_FMT_RAW)
1432
(gnutls.library.functions
1433
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1434
gnutls.library.constants
1435
.GNUTLS_OPENPGP_FMT_RAW))
2301
1436
# Verify the self signature in the key
2302
1437
crtverify = ctypes.c_uint()
2303
gnutls.openpgp_crt_verify_self(crt, 0,
2304
ctypes.byref(crtverify))
1438
(gnutls.library.functions
1439
.gnutls_openpgp_crt_verify_self(crt, 0,
1440
ctypes.byref(crtverify)))
2305
1441
if crtverify.value != 0:
2306
gnutls.openpgp_crt_deinit(crt)
2307
raise gnutls.CertificateSecurityError("Verify failed")
1442
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1443
raise (gnutls.errors.CertificateSecurityError
2308
1445
# New buffer for the fingerprint
2309
1446
buf = ctypes.create_string_buffer(20)
2310
1447
buf_len = ctypes.c_size_t()
2311
1448
# Get the fingerprint from the certificate into the buffer
2312
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2313
ctypes.byref(buf_len))
1449
(gnutls.library.functions
1450
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1451
ctypes.byref(buf_len)))
2314
1452
# Deinit the certificate
2315
gnutls.openpgp_crt_deinit(crt)
1453
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2316
1454
# Convert the buffer to a Python bytestring
2317
1455
fpr = ctypes.string_at(buf, buf_len.value)
2318
1456
# Convert the bytestring to hexadecimal notation
2319
hex_fpr = binascii.hexlify(fpr).upper()
1457
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2323
1461
class MultiprocessingMixIn(object):
2324
1462
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2326
1463
def sub_process_main(self, request, address):
2328
1465
self.finish_request(request, address)
2330
1467
self.handle_error(request, address)
2331
1468
self.close_request(request)
2333
1470
def process_request(self, request, address):
2334
1471
"""Start a new process to process the request."""
2335
proc = multiprocessing.Process(target = self.sub_process_main,
2336
args = (request, address))
1472
multiprocessing.Process(target = self.sub_process_main,
1473
args = (request, address)).start()
2341
1475
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2342
1476
""" adds a pipe to the MixIn """
2344
1477
def process_request(self, request, client_address):
2345
1478
"""Overrides and wraps the original process_request().
2347
1480
This function creates a new pipe in self.pipe
2349
1482
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2351
proc = MultiprocessingMixIn.process_request(self, request,
1484
super(MultiprocessingMixInWithPipe,
1485
self).process_request(request, client_address)
2353
1486
self.child_pipe.close()
2354
self.add_pipe(parent_pipe, proc)
2356
def add_pipe(self, parent_pipe, proc):
1487
self.add_pipe(parent_pipe)
1489
def add_pipe(self, parent_pipe):
2357
1490
"""Dummy function; override as necessary"""
2358
raise NotImplementedError()
1491
raise NotImplementedError
2361
1493
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2362
1494
socketserver.TCPServer, object):
2527
1625
"dress: %s", fpr, address)
2528
1626
if self.use_dbus:
2529
1627
# Emit D-Bus signal
2530
mandos_dbus_service.ClientNotFound(fpr,
1628
mandos_dbus_service.ClientNotFound(fpr, address[0])
2532
1629
parent_pipe.send(False)
2535
gobject.io_add_watch(
2536
parent_pipe.fileno(),
2537
gobject.IO_IN | gobject.IO_HUP,
2538
functools.partial(self.handle_ipc,
2539
parent_pipe = parent_pipe,
2541
client_object = client))
1632
gobject.io_add_watch(parent_pipe.fileno(),
1633
gobject.IO_IN | gobject.IO_HUP,
1634
functools.partial(self.handle_ipc,
1635
parent_pipe = parent_pipe,
1636
client_object = client))
2542
1637
parent_pipe.send(True)
2543
# remove the old hook in favor of the new above hook on
1638
# remove the old hook in favor of the new above hook on same fileno
2546
1640
if command == 'funcall':
2547
1641
funcname = request[1]
2548
1642
args = request[2]
2549
1643
kwargs = request[3]
2551
parent_pipe.send(('data', getattr(client_object,
1645
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2555
1647
if command == 'getattr':
2556
1648
attrname = request[1]
2557
if isinstance(client_object.__getattribute__(attrname),
2558
collections.Callable):
2559
parent_pipe.send(('function', ))
1649
if callable(client_object.__getattribute__(attrname)):
1650
parent_pipe.send(('function',))
2562
'data', client_object.__getattribute__(attrname)))
1652
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2564
1654
if command == 'setattr':
2565
1655
attrname = request[1]
2566
1656
value = request[2]
2567
1657
setattr(client_object, attrname, value)
2572
def rfc3339_duration_to_delta(duration):
2573
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2575
>>> rfc3339_duration_to_delta("P7D")
2576
datetime.timedelta(7)
2577
>>> rfc3339_duration_to_delta("PT60S")
2578
datetime.timedelta(0, 60)
2579
>>> rfc3339_duration_to_delta("PT60M")
2580
datetime.timedelta(0, 3600)
2581
>>> rfc3339_duration_to_delta("PT24H")
2582
datetime.timedelta(1)
2583
>>> rfc3339_duration_to_delta("P1W")
2584
datetime.timedelta(7)
2585
>>> rfc3339_duration_to_delta("PT5M30S")
2586
datetime.timedelta(0, 330)
2587
>>> rfc3339_duration_to_delta("P1DT3M20S")
2588
datetime.timedelta(1, 200)
2591
# Parsing an RFC 3339 duration with regular expressions is not
2592
# possible - there would have to be multiple places for the same
2593
# values, like seconds. The current code, while more esoteric, is
2594
# cleaner without depending on a parsing library. If Python had a
2595
# built-in library for parsing we would use it, but we'd like to
2596
# avoid excessive use of external libraries.
2598
# New type for defining tokens, syntax, and semantics all-in-one
2599
Token = collections.namedtuple("Token", (
2600
"regexp", # To match token; if "value" is not None, must have
2601
# a "group" containing digits
2602
"value", # datetime.timedelta or None
2603
"followers")) # Tokens valid after this token
2604
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2605
# the "duration" ABNF definition in RFC 3339, Appendix A.
2606
token_end = Token(re.compile(r"$"), None, frozenset())
2607
token_second = Token(re.compile(r"(\d+)S"),
2608
datetime.timedelta(seconds=1),
2609
frozenset((token_end, )))
2610
token_minute = Token(re.compile(r"(\d+)M"),
2611
datetime.timedelta(minutes=1),
2612
frozenset((token_second, token_end)))
2613
token_hour = Token(re.compile(r"(\d+)H"),
2614
datetime.timedelta(hours=1),
2615
frozenset((token_minute, token_end)))
2616
token_time = Token(re.compile(r"T"),
2618
frozenset((token_hour, token_minute,
2620
token_day = Token(re.compile(r"(\d+)D"),
2621
datetime.timedelta(days=1),
2622
frozenset((token_time, token_end)))
2623
token_month = Token(re.compile(r"(\d+)M"),
2624
datetime.timedelta(weeks=4),
2625
frozenset((token_day, token_end)))
2626
token_year = Token(re.compile(r"(\d+)Y"),
2627
datetime.timedelta(weeks=52),
2628
frozenset((token_month, token_end)))
2629
token_week = Token(re.compile(r"(\d+)W"),
2630
datetime.timedelta(weeks=1),
2631
frozenset((token_end, )))
2632
token_duration = Token(re.compile(r"P"), None,
2633
frozenset((token_year, token_month,
2634
token_day, token_time,
2636
# Define starting values
2637
value = datetime.timedelta() # Value so far
2639
followers = frozenset((token_duration, )) # Following valid tokens
2640
s = duration # String left to parse
2641
# Loop until end token is found
2642
while found_token is not token_end:
2643
# Search for any currently valid tokens
2644
for token in followers:
2645
match = token.regexp.match(s)
2646
if match is not None:
2648
if token.value is not None:
2649
# Value found, parse digits
2650
factor = int(match.group(1), 10)
2651
# Add to value so far
2652
value += factor * token.value
2653
# Strip token from string
2654
s = token.regexp.sub("", s, 1)
2657
# Set valid next tokens
2658
followers = found_token.followers
2661
# No currently valid tokens were found
2662
raise ValueError("Invalid RFC 3339 duration: {!r}"
2668
1662
def string_to_delta(interval):
2669
1663
"""Parse a string and return a datetime.timedelta
2799
1796
"debug": "False",
2801
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2802
":+SIGN-DSA-SHA256",
1798
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2803
1799
"servicename": "Mandos",
2804
1800
"use_dbus": "True",
2805
1801
"use_ipv6": "True",
2806
1802
"debuglevel": "",
2809
"statedir": "/var/lib/mandos",
2810
"foreground": "False",
2814
1805
# Parse config file for server-global settings
2815
1806
server_config = configparser.SafeConfigParser(server_defaults)
2816
1807
del server_defaults
2817
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1808
server_config.read(os.path.join(options.configdir,
2818
1810
# Convert the SafeConfigParser object to a dict
2819
1811
server_settings = server_config.defaults()
2820
1812
# Use the appropriate methods on the non-string config options
2821
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1813
for option in ("debug", "use_dbus", "use_ipv6"):
2822
1814
server_settings[option] = server_config.getboolean("DEFAULT",
2824
1816
if server_settings["port"]:
2825
1817
server_settings["port"] = server_config.getint("DEFAULT",
2827
if server_settings["socket"]:
2828
server_settings["socket"] = server_config.getint("DEFAULT",
2830
# Later, stdin will, and stdout and stderr might, be dup'ed
2831
# over with an opened os.devnull. But we don't want this to
2832
# happen with a supplied network socket.
2833
if 0 <= server_settings["socket"] <= 2:
2834
server_settings["socket"] = os.dup(server_settings
2836
1819
del server_config
2838
1821
# Override the settings from the config file with command line
2839
1822
# options, if set.
2840
1823
for option in ("interface", "address", "port", "debug",
2841
"priority", "servicename", "configdir", "use_dbus",
2842
"use_ipv6", "debuglevel", "restore", "statedir",
2843
"socket", "foreground", "zeroconf"):
1824
"priority", "servicename", "configdir",
1825
"use_dbus", "use_ipv6", "debuglevel"):
2844
1826
value = getattr(options, option)
2845
1827
if value is not None:
2846
1828
server_settings[option] = value
2848
1830
# Force all strings to be unicode
2849
1831
for option in server_settings.keys():
2850
if isinstance(server_settings[option], bytes):
2851
server_settings[option] = (server_settings[option]
2853
# Force all boolean options to be boolean
2854
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2855
"foreground", "zeroconf"):
2856
server_settings[option] = bool(server_settings[option])
2857
# Debug implies foreground
2858
if server_settings["debug"]:
2859
server_settings["foreground"] = True
1832
if type(server_settings[option]) is str:
1833
server_settings[option] = unicode(server_settings[option])
2860
1834
# Now we have our good server settings in "server_settings"
2862
1836
##################################################################
2864
if (not server_settings["zeroconf"]
2865
and not (server_settings["port"]
2866
or server_settings["socket"] != "")):
2867
parser.error("Needs port or socket to work without Zeroconf")
2869
1838
# For convenience
2870
1839
debug = server_settings["debug"]
2871
1840
debuglevel = server_settings["debuglevel"]
2872
1841
use_dbus = server_settings["use_dbus"]
2873
1842
use_ipv6 = server_settings["use_ipv6"]
2874
stored_state_path = os.path.join(server_settings["statedir"],
2876
foreground = server_settings["foreground"]
2877
zeroconf = server_settings["zeroconf"]
2880
initlogger(debug, logging.DEBUG)
2885
level = getattr(logging, debuglevel.upper())
2886
initlogger(debug, level)
2888
1844
if server_settings["servicename"] != "Mandos":
2889
syslogger.setFormatter(
2890
logging.Formatter('Mandos ({}) [%(process)d]:'
2891
' %(levelname)s: %(message)s'.format(
2892
server_settings["servicename"])))
1845
syslogger.setFormatter(logging.Formatter
1846
('Mandos (%s) [%%(process)d]:'
1847
' %%(levelname)s: %%(message)s'
1848
% server_settings["servicename"]))
2894
1850
# Parse config file with clients
2895
client_config = configparser.SafeConfigParser(Client
1851
client_defaults = { "timeout": "5m",
1852
"extended_timeout": "15m",
1854
"checker": "fping -q -- %%(host)s",
1856
"approval_delay": "0s",
1857
"approval_duration": "1s",
1859
client_config = configparser.SafeConfigParser(client_defaults)
2897
1860
client_config.read(os.path.join(server_settings["configdir"],
2898
1861
"clients.conf"))
2900
1863
global mandos_dbus_service
2901
1864
mandos_dbus_service = None
2904
if server_settings["socket"] != "":
2905
socketfd = server_settings["socket"]
2906
tcp_server = MandosServer(
2907
(server_settings["address"], server_settings["port"]),
2909
interface=(server_settings["interface"] or None),
2911
gnutls_priority=server_settings["priority"],
2915
pidfilename = "/run/mandos.pid"
2916
if not os.path.isdir("/run/."):
2917
pidfilename = "/var/run/mandos.pid"
1866
tcp_server = MandosServer((server_settings["address"],
1867
server_settings["port"]),
1869
interface=(server_settings["interface"]
1873
server_settings["priority"],
1876
pidfilename = "/var/run/mandos.pid"
2920
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2921
except IOError as e:
2922
logger.error("Could not open file %r", pidfilename,
1878
pidfile = open(pidfilename, "w")
1880
logger.error("Could not open file %r", pidfilename)
2925
for name, group in (("_mandos", "_mandos"),
2926
("mandos", "mandos"),
2927
("nobody", "nogroup")):
1883
uid = pwd.getpwnam("_mandos").pw_uid
1884
gid = pwd.getpwnam("_mandos").pw_gid
2929
uid = pwd.getpwnam(name).pw_uid
2930
gid = pwd.getpwnam(group).pw_gid
1887
uid = pwd.getpwnam("mandos").pw_uid
1888
gid = pwd.getpwnam("mandos").pw_gid
2932
1889
except KeyError:
1891
uid = pwd.getpwnam("nobody").pw_uid
1892
gid = pwd.getpwnam("nobody").pw_gid
2940
1899
except OSError as error:
2941
if error.errno != errno.EPERM:
1900
if error[0] != errno.EPERM:
1903
if not debug and not debuglevel:
1904
syslogger.setLevel(logging.WARNING)
1905
console.setLevel(logging.WARNING)
1907
level = getattr(logging, debuglevel.upper())
1908
syslogger.setLevel(level)
1909
console.setLevel(level)
2945
1912
# Enable all possible GnuTLS debugging
2947
1914
# "Use a log level over 10 to enable all debugging options."
2948
1915
# - GnuTLS manual
2949
gnutls.global_set_log_level(11)
1916
gnutls.library.functions.gnutls_global_set_log_level(11)
1918
@gnutls.library.types.gnutls_log_func
2952
1919
def debug_gnutls(level, string):
2953
1920
logger.debug("GnuTLS: %s", string[:-1])
2955
gnutls.global_set_log_function(debug_gnutls)
1922
(gnutls.library.functions
1923
.gnutls_global_set_log_function(debug_gnutls))
2957
1925
# Redirect stdin so all checkers get /dev/null
2958
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1926
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2959
1927
os.dup2(null, sys.stdin.fileno())
1931
# No console logging
1932
logger.removeHandler(console)
2963
1934
# Need to fork before connecting to D-Bus
2965
1936
# Close all input and output, do double fork, etc.
2968
# multiprocessing will use threads, so before we use gobject we
2969
# need to inform gobject that threads will be used.
2970
gobject.threads_init()
2972
1939
global main_loop
2973
1940
# From the Avahi example code
2974
DBusGMainLoop(set_as_default=True)
1941
DBusGMainLoop(set_as_default=True )
2975
1942
main_loop = gobject.MainLoop()
2976
1943
bus = dbus.SystemBus()
2977
1944
# End of Avahi example code
2980
bus_name = dbus.service.BusName("se.recompile.Mandos",
2983
old_bus_name = dbus.service.BusName(
2984
"se.bsnet.fukt.Mandos", bus,
2986
except dbus.exceptions.DBusException as e:
2987
logger.error("Disabling D-Bus:", exc_info=e)
1947
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1948
bus, do_not_queue=True)
1949
except dbus.exceptions.NameExistsException as e:
1950
logger.error(unicode(e) + ", disabling D-Bus")
2988
1951
use_dbus = False
2989
1952
server_settings["use_dbus"] = False
2990
1953
tcp_server.use_dbus = False
2992
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2993
service = AvahiServiceToSyslog(
2994
name = server_settings["servicename"],
2995
servicetype = "_mandos._tcp",
2996
protocol = protocol,
2998
if server_settings["interface"]:
2999
service.interface = if_nametoindex(
3000
server_settings["interface"].encode("utf-8"))
1954
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1955
service = AvahiService(name = server_settings["servicename"],
1956
servicetype = "_mandos._tcp",
1957
protocol = protocol, bus = bus)
1958
if server_settings["interface"]:
1959
service.interface = (if_nametoindex
1960
(str(server_settings["interface"])))
3002
1962
global multiprocessing_manager
3003
1963
multiprocessing_manager = multiprocessing.Manager()
3005
1965
client_class = Client
3007
1967
client_class = functools.partial(ClientDBus, bus = bus)
3009
client_settings = Client.config_parser(client_config)
3010
old_client_settings = {}
3013
# This is used to redirect stdout and stderr for checker processes
3015
wnull = open(os.devnull, "w") # A writable /dev/null
3016
# Only used if server is running in foreground but not in debug
3018
if debug or not foreground:
3021
# Get client data and settings from last running state.
3022
if server_settings["restore"]:
3024
with open(stored_state_path, "rb") as stored_state:
3025
clients_data, old_client_settings = pickle.load(
3027
os.remove(stored_state_path)
3028
except IOError as e:
3029
if e.errno == errno.ENOENT:
3030
logger.warning("Could not load persistent state:"
3031
" {}".format(os.strerror(e.errno)))
3033
logger.critical("Could not load persistent state:",
3036
except EOFError as e:
3037
logger.warning("Could not load persistent state: "
3041
with PGPEngine() as pgp:
3042
for client_name, client in clients_data.items():
3043
# Skip removed clients
3044
if client_name not in client_settings:
3047
# Decide which value to use after restoring saved state.
3048
# We have three different values: Old config file,
3049
# new config file, and saved state.
3050
# New config value takes precedence if it differs from old
3051
# config value, otherwise use saved state.
3052
for name, value in client_settings[client_name].items():
3054
# For each value in new config, check if it
3055
# differs from the old config value (Except for
3056
# the "secret" attribute)
3057
if (name != "secret"
3059
old_client_settings[client_name][name])):
3060
client[name] = value
3064
# Clients who has passed its expire date can still be
3065
# enabled if its last checker was successful. A Client
3066
# whose checker succeeded before we stored its state is
3067
# assumed to have successfully run all checkers during
3069
if client["enabled"]:
3070
if datetime.datetime.utcnow() >= client["expires"]:
3071
if not client["last_checked_ok"]:
3073
"disabling client {} - Client never "
3074
"performed a successful checker".format(
3076
client["enabled"] = False
3077
elif client["last_checker_status"] != 0:
3079
"disabling client {} - Client last"
3080
" checker failed with error code"
3083
client["last_checker_status"]))
3084
client["enabled"] = False
3086
client["expires"] = (
3087
datetime.datetime.utcnow()
3088
+ client["timeout"])
3089
logger.debug("Last checker succeeded,"
3090
" keeping {} enabled".format(
1968
def client_config_items(config, section):
1969
special_settings = {
1970
"approved_by_default":
1971
lambda: config.getboolean(section,
1972
"approved_by_default"),
1974
for name, value in config.items(section):
3093
client["secret"] = pgp.decrypt(
3094
client["encrypted_secret"],
3095
client_settings[client_name]["secret"])
3097
# If decryption fails, we use secret from new settings
3098
logger.debug("Failed to decrypt {} old secret".format(
3100
client["secret"] = (client_settings[client_name]
3103
# Add/remove clients based on new changes made to config
3104
for client_name in (set(old_client_settings)
3105
- set(client_settings)):
3106
del clients_data[client_name]
3107
for client_name in (set(client_settings)
3108
- set(old_client_settings)):
3109
clients_data[client_name] = client_settings[client_name]
3111
# Create all client objects
3112
for client_name, client in clients_data.items():
3113
tcp_server.clients[client_name] = client_class(
3116
server_settings = server_settings)
1976
yield (name, special_settings[name]())
1980
tcp_server.clients.update(set(
1981
client_class(name = section,
1982
config= dict(client_config_items(
1983
client_config, section)))
1984
for section in client_config.sections()))
3118
1985
if not tcp_server.clients:
3119
1986
logger.warning("No clients defined")
3122
if pidfile is not None:
3126
print(pid, file=pidfile)
3128
logger.error("Could not write to file %r with PID %d",
1992
pidfile.write(str(pid) + "\n".encode("utf-8"))
1995
logger.error("Could not write to file %r with PID %d",
1998
# "pidfile" was never created
3131
2000
del pidfilename
2002
signal.signal(signal.SIGINT, signal.SIG_IGN)
3133
2004
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
3134
2005
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3138
@alternate_dbus_interfaces(
3139
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3140
class MandosDBusService(DBusObjectWithObjectManager):
2008
class MandosDBusService(dbus.service.Object):
3141
2009
"""A D-Bus proxy object"""
3143
2010
def __init__(self):
3144
2011
dbus.service.Object.__init__(self, bus, "/")
3146
_interface = "se.recompile.Mandos"
2012
_interface = "se.bsnet.fukt.Mandos"
3148
2014
@dbus.service.signal(_interface, signature="o")
3149
2015
def ClientAdded(self, objpath):
3158
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3160
2024
@dbus.service.signal(_interface, signature="os")
3161
2025
def ClientRemoved(self, objpath, name):
3165
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3167
2029
@dbus.service.method(_interface, out_signature="ao")
3168
2030
def GetAllClients(self):
3170
return dbus.Array(c.dbus_object_path for c in
3171
tcp_server.clients.itervalues())
2032
return dbus.Array(c.dbus_object_path
2033
for c in tcp_server.clients)
3173
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3175
2035
@dbus.service.method(_interface,
3176
2036
out_signature="a{oa{sv}}")
3177
2037
def GetAllClientsWithProperties(self):
3179
2039
return dbus.Dictionary(
3180
{ c.dbus_object_path: c.GetAll(
3181
"se.recompile.Mandos.Client")
3182
for c in tcp_server.clients.itervalues() },
2040
((c.dbus_object_path, c.GetAll(""))
2041
for c in tcp_server.clients),
3183
2042
signature="oa{sv}")
3185
2044
@dbus.service.method(_interface, in_signature="o")
3186
2045
def RemoveClient(self, object_path):
3188
for c in tcp_server.clients.itervalues():
2047
for c in tcp_server.clients:
3189
2048
if c.dbus_object_path == object_path:
3190
del tcp_server.clients[c.name]
2049
tcp_server.clients.remove(c)
3191
2050
c.remove_from_connection()
3192
# Don't signal the disabling
2051
# Don't signal anything except ClientRemoved
3193
2052
c.disable(quiet=True)
3194
# Emit D-Bus signal for removal
3195
self.client_removed_signal(c)
2054
self.ClientRemoved(object_path, c.name)
3197
2056
raise KeyError(object_path)
3201
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3202
out_signature = "a{oa{sa{sv}}}")
3203
def GetManagedObjects(self):
3205
return dbus.Dictionary(
3206
{ client.dbus_object_path:
3208
{ interface: client.GetAll(interface)
3210
client._get_all_interface_names()})
3211
for client in tcp_server.clients.values()})
3213
def client_added_signal(self, client):
3214
"""Send the new standard signal and the old signal"""
3216
# New standard signal
3217
self.InterfacesAdded(
3218
client.dbus_object_path,
3220
{ interface: client.GetAll(interface)
3222
client._get_all_interface_names()}))
3224
self.ClientAdded(client.dbus_object_path)
3226
def client_removed_signal(self, client):
3227
"""Send the new standard signal and the old signal"""
3229
# New standard signal
3230
self.InterfacesRemoved(
3231
client.dbus_object_path,
3232
client._get_all_interface_names())
3234
self.ClientRemoved(client.dbus_object_path,
3237
2060
mandos_dbus_service = MandosDBusService()
3240
2063
"Cleanup function; run on exit"
3244
multiprocessing.active_children()
3246
if not (tcp_server.clients or client_settings):
3249
# Store client before exiting. Secrets are encrypted with key
3250
# based on what config file has. If config file is
3251
# removed/edited, old secret will thus be unrecovable.
3253
with PGPEngine() as pgp:
3254
for client in tcp_server.clients.itervalues():
3255
key = client_settings[client.name]["secret"]
3256
client.encrypted_secret = pgp.encrypt(client.secret,
3260
# A list of attributes that can not be pickled
3262
exclude = { "bus", "changedstate", "secret",
3263
"checker", "server_settings" }
3264
for name, typ in inspect.getmembers(dbus.service
3268
client_dict["encrypted_secret"] = (client
3270
for attr in client.client_structure:
3271
if attr not in exclude:
3272
client_dict[attr] = getattr(client, attr)
3274
clients[client.name] = client_dict
3275
del client_settings[client.name]["secret"]
3278
with tempfile.NamedTemporaryFile(
3282
dir=os.path.dirname(stored_state_path),
3283
delete=False) as stored_state:
3284
pickle.dump((clients, client_settings), stored_state)
3285
tempname = stored_state.name
3286
os.rename(tempname, stored_state_path)
3287
except (IOError, OSError) as e:
3293
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3294
logger.warning("Could not save persistent state: {}"
3295
.format(os.strerror(e.errno)))
3297
logger.warning("Could not save persistent state:",
3301
# Delete all clients, and settings from config
3302
2066
while tcp_server.clients:
3303
name, client = tcp_server.clients.popitem()
2067
client = tcp_server.clients.pop()
3305
2069
client.remove_from_connection()
3306
# Don't signal the disabling
2070
client.disable_hook = None
2071
# Don't signal anything except ClientRemoved
3307
2072
client.disable(quiet=True)
3308
# Emit D-Bus signal for removal
3310
mandos_dbus_service.client_removed_signal(client)
3311
client_settings.clear()
2075
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3313
2078
atexit.register(cleanup)
3315
for client in tcp_server.clients.itervalues():
2080
for client in tcp_server.clients:
3317
# Emit D-Bus signal for adding
3318
mandos_dbus_service.client_added_signal(client)
3319
# Need to initiate checking of clients
3321
client.init_checker()
2083
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3323
2086
tcp_server.enable()
3324
2087
tcp_server.server_activate()
3326
2089
# Find out what port we got
3328
service.port = tcp_server.socket.getsockname()[1]
2090
service.port = tcp_server.socket.getsockname()[1]
3330
2092
logger.info("Now listening on address %r, port %d,"
3331
" flowinfo %d, scope_id %d",
3332
*tcp_server.socket.getsockname())
2093
" flowinfo %d, scope_id %d"
2094
% tcp_server.socket.getsockname())
3334
logger.info("Now listening on address %r, port %d",
3335
*tcp_server.socket.getsockname())
2096
logger.info("Now listening on address %r, port %d"
2097
% tcp_server.socket.getsockname())
3337
2099
#service.interface = tcp_server.socket.getsockname()[3]
3341
# From the Avahi example code
3344
except dbus.exceptions.DBusException as error:
3345
logger.critical("D-Bus Exception", exc_info=error)
3348
# End of Avahi example code
2102
# From the Avahi example code
2105
except dbus.exceptions.DBusException as error:
2106
logger.critical("DBusException: %s", error)
2109
# End of Avahi example code
3350
2111
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3351
2112
lambda *args, **kwargs: