167
226
os.rmdir(self.tempdir)
168
227
self.tempdir = None
170
229
def password_encode(self, password):
171
230
# Passphrase can not be empty and can not contain newlines or
172
231
# NUL bytes. So we prefix it and hex encode it.
173
return b"mandos" + binascii.hexlify(password)
232
encoded = b"mandos" + binascii.hexlify(password)
233
if len(encoded) > 2048:
234
# GnuPG can't handle long passwords, so encode differently
235
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
236
.replace(b"\n", b"\\n")
237
.replace(b"\0", b"\\x00"))
175
240
def encrypt(self, data, password):
176
self.gnupg.passphrase = self.password_encode(password)
177
with open(os.devnull) as devnull:
179
proc = self.gnupg.run(['--symmetric'],
180
create_fhs=['stdin', 'stdout'],
181
attach_fhs={'stderr': devnull})
182
with contextlib.closing(proc.handles['stdin']) as f:
184
with contextlib.closing(proc.handles['stdout']) as f:
185
ciphertext = f.read()
189
self.gnupg.passphrase = None
241
passphrase = self.password_encode(password)
242
with tempfile.NamedTemporaryFile(
243
dir=self.tempdir) as passfile:
244
passfile.write(passphrase)
246
proc = subprocess.Popen([self.gpg, '--symmetric',
250
stdin=subprocess.PIPE,
251
stdout=subprocess.PIPE,
252
stderr=subprocess.PIPE)
253
ciphertext, err = proc.communicate(input=data)
254
if proc.returncode != 0:
190
256
return ciphertext
192
258
def decrypt(self, data, password):
193
self.gnupg.passphrase = self.password_encode(password)
194
with open(os.devnull) as devnull:
196
proc = self.gnupg.run(['--decrypt'],
197
create_fhs=['stdin', 'stdout'],
198
attach_fhs={'stderr': devnull})
199
with contextlib.closing(proc.handles['stdin'] ) as f:
201
with contextlib.closing(proc.handles['stdout']) as f:
202
decrypted_plaintext = f.read()
206
self.gnupg.passphrase = None
259
passphrase = self.password_encode(password)
260
with tempfile.NamedTemporaryFile(
261
dir=self.tempdir) as passfile:
262
passfile.write(passphrase)
264
proc = subprocess.Popen([self.gpg, '--decrypt',
268
stdin=subprocess.PIPE,
269
stdout=subprocess.PIPE,
270
stderr=subprocess.PIPE)
271
decrypted_plaintext, err = proc.communicate(input=data)
272
if proc.returncode != 0:
207
274
return decrypted_plaintext
277
# Pretend that we have an Avahi module
279
"""This isn't so much a class as it is a module-like namespace."""
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 = "/"
290
def string_array_to_txt_array(t):
291
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
292
for s in t), signature="ay")
293
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
294
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
295
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
296
SERVER_INVALID = 0 # avahi-common/defs.h
297
SERVER_REGISTERING = 1 # avahi-common/defs.h
298
SERVER_RUNNING = 2 # avahi-common/defs.h
299
SERVER_COLLISION = 3 # avahi-common/defs.h
300
SERVER_FAILURE = 4 # avahi-common/defs.h
211
303
class AvahiError(Exception):
212
304
def __init__(self, value, *args, **kwargs):
213
305
self.value = value
214
super(AvahiError, self).__init__(value, *args, **kwargs)
215
def __unicode__(self):
216
return unicode(repr(self.value))
306
return super(AvahiError, self).__init__(value, *args,
218
310
class AvahiServiceError(AvahiError):
221
314
class AvahiGroupError(AvahiError):
225
318
class AvahiService(object):
226
319
"""An Avahi (Zeroconf) service.
229
322
interface: integer; avahi.IF_UNSPEC or an interface index.
230
323
Used to optionally bind to the specified interface.
231
324
name: string; Example: 'Mandos'
232
325
type: string; Example: '_mandos._tcp'.
233
See <http://www.dns-sd.org/ServiceTypes.html>
326
See <https://www.iana.org/assignments/service-names-port-numbers>
234
327
port: integer; what port to announce
235
328
TXT: list of strings; TXT record for the service
236
329
domain: string; Domain to publish on, default to .local if empty.
365
488
follow_name_owner_changes=True),
366
489
avahi.DBUS_INTERFACE_SERVER)
367
490
self.server.connect_to_signal("StateChanged",
368
self.server_state_changed)
491
self.server_state_changed)
369
492
self.server_state_changed(self.server.GetState())
371
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
373
497
"""Add the new name to the syslog messages"""
374
ret = AvahiService.rename(self)
375
syslogger.setFormatter(logging.Formatter
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
498
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
381
def timedelta_to_milliseconds(td):
382
"Convert a datetime.timedelta() to milliseconds"
383
return ((td.days * 24 * 60 * 60 * 1000)
384
+ (td.seconds * 1000)
385
+ (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."""
509
library = ctypes.util.find_library("gnutls")
511
library = ctypes.util.find_library("gnutls-deb0")
512
_library = ctypes.cdll.LoadLibrary(library)
515
# Unless otherwise indicated, the constants and types below are
516
# all from the gnutls/gnutls.h C header file.
527
E_NO_CERTIFICATE_FOUND = -49
532
KEYID_USE_SHA256 = 1 # gnutls/x509.h
533
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
536
class session_int(ctypes.Structure):
538
session_t = ctypes.POINTER(session_int)
540
class certificate_credentials_st(ctypes.Structure):
542
certificate_credentials_t = ctypes.POINTER(
543
certificate_credentials_st)
544
certificate_type_t = ctypes.c_int
546
class datum_t(ctypes.Structure):
547
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
548
('size', ctypes.c_uint)]
550
class openpgp_crt_int(ctypes.Structure):
552
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
553
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
554
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
555
credentials_type_t = ctypes.c_int
556
transport_ptr_t = ctypes.c_void_p
557
close_request_t = ctypes.c_int
560
class Error(Exception):
561
def __init__(self, message=None, code=None, args=()):
562
# Default usage is by a message string, but if a return
563
# code is passed, convert it to a string with
566
if message is None and code is not None:
567
message = gnutls.strerror(code)
568
return super(gnutls.Error, self).__init__(
571
class CertificateSecurityError(Error):
575
class Credentials(object):
577
self._c_object = gnutls.certificate_credentials_t()
578
gnutls.certificate_allocate_credentials(
579
ctypes.byref(self._c_object))
580
self.type = gnutls.CRD_CERTIFICATE
583
gnutls.certificate_free_credentials(self._c_object)
585
class ClientSession(object):
586
def __init__(self, socket, credentials=None):
587
self._c_object = gnutls.session_t()
588
gnutls_flags = gnutls.CLIENT
589
if gnutls.check_version("3.5.6"):
590
gnutls_flags |= gnutls.NO_TICKETS
592
gnutls_flags |= gnutls.ENABLE_RAWPK
593
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
595
gnutls.set_default_priority(self._c_object)
596
gnutls.transport_set_ptr(self._c_object, socket.fileno())
597
gnutls.handshake_set_private_extensions(self._c_object,
600
if credentials is None:
601
credentials = gnutls.Credentials()
602
gnutls.credentials_set(self._c_object, credentials.type,
603
ctypes.cast(credentials._c_object,
605
self.credentials = credentials
608
gnutls.deinit(self._c_object)
611
return gnutls.handshake(self._c_object)
613
def send(self, data):
617
data_len -= gnutls.record_send(self._c_object,
622
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
624
# Error handling functions
625
def _error_code(result):
626
"""A function to raise exceptions on errors, suitable
627
for the 'restype' attribute on ctypes functions"""
630
if result == gnutls.E_NO_CERTIFICATE_FOUND:
631
raise gnutls.CertificateSecurityError(code=result)
632
raise gnutls.Error(code=result)
634
def _retry_on_error(result, func, arguments):
635
"""A function to retry on some errors, suitable
636
for the 'errcheck' attribute on ctypes functions"""
638
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
639
return _error_code(result)
640
result = func(*arguments)
643
# Unless otherwise indicated, the function declarations below are
644
# all from the gnutls/gnutls.h C header file.
647
priority_set_direct = _library.gnutls_priority_set_direct
648
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
649
ctypes.POINTER(ctypes.c_char_p)]
650
priority_set_direct.restype = _error_code
652
init = _library.gnutls_init
653
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
654
init.restype = _error_code
656
set_default_priority = _library.gnutls_set_default_priority
657
set_default_priority.argtypes = [session_t]
658
set_default_priority.restype = _error_code
660
record_send = _library.gnutls_record_send
661
record_send.argtypes = [session_t, ctypes.c_void_p,
663
record_send.restype = ctypes.c_ssize_t
664
record_send.errcheck = _retry_on_error
666
certificate_allocate_credentials = (
667
_library.gnutls_certificate_allocate_credentials)
668
certificate_allocate_credentials.argtypes = [
669
ctypes.POINTER(certificate_credentials_t)]
670
certificate_allocate_credentials.restype = _error_code
672
certificate_free_credentials = (
673
_library.gnutls_certificate_free_credentials)
674
certificate_free_credentials.argtypes = [
675
certificate_credentials_t]
676
certificate_free_credentials.restype = None
678
handshake_set_private_extensions = (
679
_library.gnutls_handshake_set_private_extensions)
680
handshake_set_private_extensions.argtypes = [session_t,
682
handshake_set_private_extensions.restype = None
684
credentials_set = _library.gnutls_credentials_set
685
credentials_set.argtypes = [session_t, credentials_type_t,
687
credentials_set.restype = _error_code
689
strerror = _library.gnutls_strerror
690
strerror.argtypes = [ctypes.c_int]
691
strerror.restype = ctypes.c_char_p
693
certificate_type_get = _library.gnutls_certificate_type_get
694
certificate_type_get.argtypes = [session_t]
695
certificate_type_get.restype = _error_code
697
certificate_get_peers = _library.gnutls_certificate_get_peers
698
certificate_get_peers.argtypes = [session_t,
699
ctypes.POINTER(ctypes.c_uint)]
700
certificate_get_peers.restype = ctypes.POINTER(datum_t)
702
global_set_log_level = _library.gnutls_global_set_log_level
703
global_set_log_level.argtypes = [ctypes.c_int]
704
global_set_log_level.restype = None
706
global_set_log_function = _library.gnutls_global_set_log_function
707
global_set_log_function.argtypes = [log_func]
708
global_set_log_function.restype = None
710
deinit = _library.gnutls_deinit
711
deinit.argtypes = [session_t]
712
deinit.restype = None
714
handshake = _library.gnutls_handshake
715
handshake.argtypes = [session_t]
716
handshake.restype = _error_code
717
handshake.errcheck = _retry_on_error
719
transport_set_ptr = _library.gnutls_transport_set_ptr
720
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
721
transport_set_ptr.restype = None
723
bye = _library.gnutls_bye
724
bye.argtypes = [session_t, close_request_t]
725
bye.restype = _error_code
726
bye.errcheck = _retry_on_error
728
check_version = _library.gnutls_check_version
729
check_version.argtypes = [ctypes.c_char_p]
730
check_version.restype = ctypes.c_char_p
732
_need_version = b"3.3.0"
733
if check_version(_need_version) is None:
734
raise self.Error("Needs GnuTLS {} or later"
735
.format(_need_version))
737
_tls_rawpk_version = b"3.6.6"
738
has_rawpk = bool(check_version(_tls_rawpk_version))
742
class pubkey_st(ctypes.Structure):
744
pubkey_t = ctypes.POINTER(pubkey_st)
746
x509_crt_fmt_t = ctypes.c_int
748
# All the function declarations below are from gnutls/abstract.h
749
pubkey_init = _library.gnutls_pubkey_init
750
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
751
pubkey_init.restype = _error_code
753
pubkey_import = _library.gnutls_pubkey_import
754
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
756
pubkey_import.restype = _error_code
758
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
759
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
760
ctypes.POINTER(ctypes.c_ubyte),
761
ctypes.POINTER(ctypes.c_size_t)]
762
pubkey_get_key_id.restype = _error_code
764
pubkey_deinit = _library.gnutls_pubkey_deinit
765
pubkey_deinit.argtypes = [pubkey_t]
766
pubkey_deinit.restype = None
768
# All the function declarations below are from gnutls/openpgp.h
770
openpgp_crt_init = _library.gnutls_openpgp_crt_init
771
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
772
openpgp_crt_init.restype = _error_code
774
openpgp_crt_import = _library.gnutls_openpgp_crt_import
775
openpgp_crt_import.argtypes = [openpgp_crt_t,
776
ctypes.POINTER(datum_t),
778
openpgp_crt_import.restype = _error_code
780
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
781
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
782
ctypes.POINTER(ctypes.c_uint)]
783
openpgp_crt_verify_self.restype = _error_code
785
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
786
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
787
openpgp_crt_deinit.restype = None
789
openpgp_crt_get_fingerprint = (
790
_library.gnutls_openpgp_crt_get_fingerprint)
791
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
795
openpgp_crt_get_fingerprint.restype = _error_code
797
if check_version("3.6.4"):
798
certificate_type_get2 = _library.gnutls_certificate_type_get2
799
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
800
certificate_type_get2.restype = _error_code
802
# Remove non-public functions
803
del _error_code, _retry_on_error
806
def call_pipe(connection, # : multiprocessing.Connection
807
func, *args, **kwargs):
808
"""This function is meant to be called by multiprocessing.Process
810
This function runs func(*args, **kwargs), and writes the resulting
811
return value on the provided multiprocessing.Connection.
813
connection.send(func(*args, **kwargs))
387
817
class Client(object):
388
818
"""A representation of a client host served by this server.
391
821
approved: bool(); 'None' if not yet approved/disapproved
392
822
approval_delay: datetime.timedelta(); Time to wait for approval
394
824
checker: subprocess.Popen(); a running checker process used
395
825
to see if the client lives.
396
826
'None' if no process is running.
397
checker_callback_tag: a gobject event source tag, or None
827
checker_callback_tag: a GLib event source tag, or None
398
828
checker_command: string; External command which is run to check
399
829
if client lives. %() expansions are done at
400
830
runtime with vars(self) as dict, so that for
401
831
instance %(name)s can be used in the command.
402
checker_initiator_tag: a gobject event source tag, or None
832
checker_initiator_tag: a GLib event source tag, or None
403
833
created: datetime.datetime(); (UTC) object creation
404
834
client_structure: Object describing what attributes a client has
405
835
and is used for storing the client at exit
406
836
current_checker_command: string; current running checker_command
407
disable_initiator_tag: a gobject event source tag, or None
837
disable_initiator_tag: a GLib event source tag, or None
409
839
fingerprint: string (40 or 32 hexadecimal digits); used to
410
uniquely identify the client
840
uniquely identify an OpenPGP client
841
key_id: string (64 hexadecimal digits); used to uniquely identify
842
a client using raw public keys
411
843
host: string; available for use by the checker command
412
844
interval: datetime.timedelta(); How often to start a new checker
413
845
last_approval_request: datetime.datetime(); (UTC) or None
414
846
last_checked_ok: datetime.datetime(); (UTC) or None
416
847
last_checker_status: integer between 0 and 255 reflecting exit
417
848
status of last checker. -1 reflects crashed
849
checker, -2 means no checker completed yet.
850
last_checker_signal: The signal which killed the last checker, if
851
last_checker_status is -1
419
852
last_enabled: datetime.datetime(); (UTC) or None
420
853
name: string; from the config file, used in log messages and
421
854
D-Bus identifiers
422
855
secret: bytestring; sent verbatim (over TLS) to client
423
856
timeout: datetime.timedelta(); How long from last_checked_ok
424
857
until this client is disabled
425
extended_timeout: extra long timeout when password has been sent
858
extended_timeout: extra long timeout when secret has been sent
426
859
runtime_expansions: Allowed attributes for runtime expansion.
427
860
expires: datetime.datetime(); time (UTC) when a client will be
428
861
disabled, or None
862
server_settings: The server_settings dict from main()
431
865
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
866
"created", "enabled", "expires", "key_id",
867
"fingerprint", "host", "interval",
868
"last_approval_request", "last_checked_ok",
434
869
"last_enabled", "name", "timeout")
436
def timeout_milliseconds(self):
437
"Return the 'timeout' attribute in milliseconds"
438
return timedelta_to_milliseconds(self.timeout)
440
def extended_timeout_milliseconds(self):
441
"Return the 'extended_timeout' attribute in milliseconds"
442
return timedelta_to_milliseconds(self.extended_timeout)
444
def interval_milliseconds(self):
445
"Return the 'interval' attribute in milliseconds"
446
return timedelta_to_milliseconds(self.interval)
448
def approval_delay_milliseconds(self):
449
return timedelta_to_milliseconds(self.approval_delay)
451
def __init__(self, name = None, config=None):
452
"""Note: the 'checker' key in 'config' sets the
453
'checker_command' attribute and *not* the 'checker'
872
"extended_timeout": "PT15M",
874
"checker": "fping -q -- %%(host)s",
876
"approval_delay": "PT0S",
877
"approval_duration": "PT1S",
878
"approved_by_default": "True",
883
def config_parser(config):
884
"""Construct a new dict of client settings of this form:
885
{ client_name: {setting_name: value, ...}, ...}
886
with exceptions for any special settings as defined above.
887
NOTE: Must be a pure function. Must return the same result
888
value given the same arguments.
891
for client_name in config.sections():
892
section = dict(config.items(client_name))
893
client = settings[client_name] = {}
895
client["host"] = section["host"]
896
# Reformat values from string types to Python types
897
client["approved_by_default"] = config.getboolean(
898
client_name, "approved_by_default")
899
client["enabled"] = config.getboolean(client_name,
902
# Uppercase and remove spaces from key_id and fingerprint
903
# for later comparison purposes with return value from the
904
# key_id() and fingerprint() functions
905
client["key_id"] = (section.get("key_id", "").upper()
907
client["fingerprint"] = (section["fingerprint"].upper()
909
if "secret" in section:
910
client["secret"] = codecs.decode(section["secret"]
913
elif "secfile" in section:
914
with open(os.path.expanduser(os.path.expandvars
915
(section["secfile"])),
917
client["secret"] = secfile.read()
919
raise TypeError("No secret or secfile for section {}"
921
client["timeout"] = string_to_delta(section["timeout"])
922
client["extended_timeout"] = string_to_delta(
923
section["extended_timeout"])
924
client["interval"] = string_to_delta(section["interval"])
925
client["approval_delay"] = string_to_delta(
926
section["approval_delay"])
927
client["approval_duration"] = string_to_delta(
928
section["approval_duration"])
929
client["checker_command"] = section["checker"]
930
client["last_approval_request"] = None
931
client["last_checked_ok"] = None
932
client["last_checker_status"] = -2
936
def __init__(self, settings, name=None, server_settings=None):
938
if server_settings is None:
940
self.server_settings = server_settings
941
# adding all client settings
942
for setting, value in settings.items():
943
setattr(self, setting, value)
946
if not hasattr(self, "last_enabled"):
947
self.last_enabled = datetime.datetime.utcnow()
948
if not hasattr(self, "expires"):
949
self.expires = (datetime.datetime.utcnow()
952
self.last_enabled = None
458
955
logger.debug("Creating client %r", self.name)
459
# Uppercase and remove spaces from fingerprint for later
460
# comparison purposes with return value from the fingerprint()
462
self.fingerprint = (config["fingerprint"].upper()
956
logger.debug(" Key ID: %s", self.key_id)
464
957
logger.debug(" Fingerprint: %s", self.fingerprint)
465
if "secret" in config:
466
self.secret = config["secret"].decode("base64")
467
elif "secfile" in config:
468
with open(os.path.expanduser(os.path.expandvars
469
(config["secfile"])),
471
self.secret = secfile.read()
473
raise TypeError("No secret or secfile for client %s"
475
self.host = config.get("host", "")
476
self.created = datetime.datetime.utcnow()
477
self.enabled = config.get("enabled", True)
478
self.last_approval_request = None
480
self.last_enabled = datetime.datetime.utcnow()
482
self.last_enabled = None
483
self.last_checked_ok = None
484
self.last_checker_status = None
485
self.timeout = string_to_delta(config["timeout"])
486
self.extended_timeout = string_to_delta(config
487
["extended_timeout"])
488
self.interval = string_to_delta(config["interval"])
958
self.created = settings.get("created",
959
datetime.datetime.utcnow())
961
# attributes specific for this server instance
489
962
self.checker = None
490
963
self.checker_initiator_tag = None
491
964
self.disable_initiator_tag = None
493
self.expires = datetime.datetime.utcnow() + self.timeout
496
965
self.checker_callback_tag = None
497
self.checker_command = config["checker"]
498
966
self.current_checker_command = None
499
967
self.approved = None
500
self.approved_by_default = config.get("approved_by_default",
502
968
self.approvals_pending = 0
503
self.approval_delay = string_to_delta(
504
config["approval_delay"])
505
self.approval_duration = string_to_delta(
506
config["approval_duration"])
507
self.changedstate = (multiprocessing_manager
508
.Condition(multiprocessing_manager
510
self.client_structure = [attr for attr in
511
self.__dict__.iterkeys()
969
self.changedstate = multiprocessing_manager.Condition(
970
multiprocessing_manager.Lock())
971
self.client_structure = [attr
972
for attr in self.__dict__.keys()
512
973
if not attr.startswith("_")]
513
974
self.client_structure.append("client_structure")
515
for name, t in inspect.getmembers(type(self),
976
for name, t in inspect.getmembers(
977
type(self), lambda obj: isinstance(obj, property)):
519
978
if not name.startswith("_"):
520
979
self.client_structure.append(name)
522
981
# Send notice to process children that client state has changed
523
982
def send_changedstate(self):
524
983
with self.changedstate:
525
984
self.changedstate.notify_all()
527
986
def enable(self):
528
987
"""Start this client's checker and timeout hooks"""
529
988
if getattr(self, "enabled", False):
530
989
# Already enabled
532
self.send_changedstate()
533
991
self.expires = datetime.datetime.utcnow() + self.timeout
534
992
self.enabled = True
535
993
self.last_enabled = datetime.datetime.utcnow()
536
994
self.init_checker()
995
self.send_changedstate()
538
997
def disable(self, quiet=True):
539
998
"""Disable this client."""
540
999
if not getattr(self, "enabled", False):
543
self.send_changedstate()
545
1002
logger.info("Disabling client %s", self.name)
546
if getattr(self, "disable_initiator_tag", False):
547
gobject.source_remove(self.disable_initiator_tag)
1003
if getattr(self, "disable_initiator_tag", None) is not None:
1004
GLib.source_remove(self.disable_initiator_tag)
548
1005
self.disable_initiator_tag = None
549
1006
self.expires = None
550
if getattr(self, "checker_initiator_tag", False):
551
gobject.source_remove(self.checker_initiator_tag)
1007
if getattr(self, "checker_initiator_tag", None) is not None:
1008
GLib.source_remove(self.checker_initiator_tag)
552
1009
self.checker_initiator_tag = None
553
1010
self.stop_checker()
554
1011
self.enabled = False
555
# Do not run this again if called by a gobject.timeout_add
1013
self.send_changedstate()
1014
# Do not run this again if called by a GLib.timeout_add
558
1017
def __del__(self):
561
1020
def init_checker(self):
562
1021
# Schedule a new checker to be started an 'interval' from now,
563
1022
# and every interval from then on.
564
self.checker_initiator_tag = (gobject.timeout_add
565
(self.interval_milliseconds(),
1023
if self.checker_initiator_tag is not None:
1024
GLib.source_remove(self.checker_initiator_tag)
1025
self.checker_initiator_tag = GLib.timeout_add(
1026
int(self.interval.total_seconds() * 1000),
567
1028
# Schedule a disable() when 'timeout' has passed
568
self.disable_initiator_tag = (gobject.timeout_add
569
(self.timeout_milliseconds(),
1029
if self.disable_initiator_tag is not None:
1030
GLib.source_remove(self.disable_initiator_tag)
1031
self.disable_initiator_tag = GLib.timeout_add(
1032
int(self.timeout.total_seconds() * 1000), self.disable)
571
1033
# Also start a new checker *right now*.
572
1034
self.start_checker()
574
def checker_callback(self, pid, condition, command):
1036
def checker_callback(self, source, condition, connection,
575
1038
"""The checker has completed, so take appropriate actions."""
576
1039
self.checker_callback_tag = None
577
1040
self.checker = None
578
if os.WIFEXITED(condition):
579
self.last_checker_status = os.WEXITSTATUS(condition)
1041
# Read return code from connection (see call_pipe)
1042
returncode = connection.recv()
1046
self.last_checker_status = returncode
1047
self.last_checker_signal = None
580
1048
if self.last_checker_status == 0:
581
1049
logger.info("Checker for %(name)s succeeded",
583
1051
self.checked_ok()
585
logger.info("Checker for %(name)s failed",
1053
logger.info("Checker for %(name)s failed", vars(self))
588
1055
self.last_checker_status = -1
1056
self.last_checker_signal = -returncode
589
1057
logger.warning("Checker for %(name)s crashed?",
592
def checked_ok(self, timeout=None):
593
"""Bump up the timeout for this client.
595
This should only be called when the client has been seen,
1061
def checked_ok(self):
1062
"""Assert that the client has been seen, alive and well."""
1063
self.last_checked_ok = datetime.datetime.utcnow()
1064
self.last_checker_status = 0
1065
self.last_checker_signal = None
1068
def bump_timeout(self, timeout=None):
1069
"""Bump up the timeout for this client."""
598
1070
if timeout is None:
599
1071
timeout = self.timeout
600
self.last_checked_ok = datetime.datetime.utcnow()
601
1072
if self.disable_initiator_tag is not None:
602
gobject.source_remove(self.disable_initiator_tag)
1073
GLib.source_remove(self.disable_initiator_tag)
1074
self.disable_initiator_tag = None
603
1075
if getattr(self, "enabled", False):
604
self.disable_initiator_tag = (gobject.timeout_add
605
(timedelta_to_milliseconds
606
(timeout), self.disable))
1076
self.disable_initiator_tag = GLib.timeout_add(
1077
int(timeout.total_seconds() * 1000), self.disable)
607
1078
self.expires = datetime.datetime.utcnow() + timeout
609
1080
def need_approval(self):
610
1081
self.last_approval_request = datetime.datetime.utcnow()
612
1083
def start_checker(self):
613
1084
"""Start a new checker subprocess if one is not running.
615
1086
If a checker already exists, leave it running and do
617
1088
# The reason for not killing a running checker is that if we
618
# did that, then if a checker (for some reason) started
619
# running slowly and taking more than 'interval' time, the
620
# client would inevitably timeout, since no checker would get
621
# a chance to run to completion. If we instead leave running
1089
# did that, and if a checker (for some reason) started running
1090
# slowly and taking more than 'interval' time, then the client
1091
# would inevitably timeout, since no checker would get a
1092
# chance to run to completion. If we instead leave running
622
1093
# checkers alone, the checker would have to take more time
623
1094
# than 'timeout' for the client to be disabled, which is as it
626
# If a checker exists, make sure it is not a zombie
628
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
629
except (AttributeError, OSError) as error:
630
if (isinstance(error, OSError)
631
and error.errno != errno.ECHILD):
635
logger.warning("Checker was a zombie")
636
gobject.source_remove(self.checker_callback_tag)
637
self.checker_callback(pid, status,
638
self.current_checker_command)
1097
if self.checker is not None and not self.checker.is_alive():
1098
logger.warning("Checker was not alive; joining")
639
1101
# Start a new checker if needed
640
1102
if self.checker is None:
1103
# Escape attributes for the shell
1105
attr: re.escape(str(getattr(self, attr)))
1106
for attr in self.runtime_expansions}
642
# In case checker_command has exactly one % operator
643
command = self.checker_command % self.host
645
# Escape attributes for the shell
646
escaped_attrs = dict(
648
re.escape(unicode(str(getattr(self, attr, "")),
652
self.runtime_expansions)
655
command = self.checker_command % escaped_attrs
656
except TypeError as error:
657
logger.error('Could not format string "%s":'
658
' %s', self.checker_command, error)
659
return True # Try again later
1108
command = self.checker_command % escaped_attrs
1109
except TypeError as error:
1110
logger.error('Could not format string "%s"',
1111
self.checker_command,
1113
return True # Try again later
660
1114
self.current_checker_command = command
662
logger.info("Starting checker %r for %s",
664
# We don't need to redirect stdout and stderr, since
665
# in normal mode, that is already done by daemon(),
666
# and in debug mode we don't want to. (Stdin is
667
# always replaced by /dev/null.)
668
self.checker = subprocess.Popen(command,
671
self.checker_callback_tag = (gobject.child_watch_add
673
self.checker_callback,
675
# The checker may have completed before the gobject
676
# watch was added. Check for this.
677
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
679
gobject.source_remove(self.checker_callback_tag)
680
self.checker_callback(pid, status, command)
681
except OSError as error:
682
logger.error("Failed to start subprocess: %s",
684
# Re-run this periodically if run by gobject.timeout_add
1115
logger.info("Starting checker %r for %s", command,
1117
# We don't need to redirect stdout and stderr, since
1118
# in normal mode, that is already done by daemon(),
1119
# and in debug mode we don't want to. (Stdin is
1120
# always replaced by /dev/null.)
1121
# The exception is when not debugging but nevertheless
1122
# running in the foreground; use the previously
1124
popen_args = {"close_fds": True,
1127
if (not self.server_settings["debug"]
1128
and self.server_settings["foreground"]):
1129
popen_args.update({"stdout": wnull,
1131
pipe = multiprocessing.Pipe(duplex=False)
1132
self.checker = multiprocessing.Process(
1134
args=(pipe[1], subprocess.call, command),
1136
self.checker.start()
1137
self.checker_callback_tag = GLib.io_add_watch(
1138
pipe[0].fileno(), GLib.IO_IN,
1139
self.checker_callback, pipe[0], command)
1140
# Re-run this periodically if run by GLib.timeout_add
687
1143
def stop_checker(self):
688
1144
"""Force the checker process, if any, to stop."""
689
1145
if self.checker_callback_tag:
690
gobject.source_remove(self.checker_callback_tag)
1146
GLib.source_remove(self.checker_callback_tag)
691
1147
self.checker_callback_tag = None
692
1148
if getattr(self, "checker", None) is None:
694
1150
logger.debug("Stopping checker for %(name)s", vars(self))
696
os.kill(self.checker.pid, signal.SIGTERM)
698
#if self.checker.poll() is None:
699
# os.kill(self.checker.pid, signal.SIGKILL)
700
except OSError as error:
701
if error.errno != errno.ESRCH: # No such process
1151
self.checker.terminate()
703
1152
self.checker = None
706
def dbus_service_property(dbus_interface, signature="v",
707
access="readwrite", byte_arrays=False):
1155
def dbus_service_property(dbus_interface,
708
1159
"""Decorators for marking methods of a DBusObjectWithProperties to
709
1160
become properties on the D-Bus.
711
1162
The decorated method will be called with no arguments by "Get"
712
1163
and with one argument by "Set".
714
1165
The parameters, where they are supported, are the same as
715
1166
dbus.service.method, except there is only "signature", since the
716
1167
type from Get() and the type sent to Set() is the same.
755
class DBusObjectWithProperties(dbus.service.Object):
1250
class DBusObjectWithAnnotations(dbus.service.Object):
1251
"""A D-Bus object with annotations.
1253
Classes inheriting from this can use the dbus_annotations
1254
decorator to add annotations to methods or signals.
1258
def _is_dbus_thing(thing):
1259
"""Returns a function testing if an attribute is a D-Bus thing
1261
If called like _is_dbus_thing("method") it returns a function
1262
suitable for use as predicate to inspect.getmembers().
1264
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1267
def _get_all_dbus_things(self, thing):
1268
"""Returns a generator of (name, attribute) pairs
1270
return ((getattr(athing.__get__(self), "_dbus_name", name),
1271
athing.__get__(self))
1272
for cls in self.__class__.__mro__
1274
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1276
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1278
path_keyword='object_path',
1279
connection_keyword='connection')
1280
def Introspect(self, object_path, connection):
1281
"""Overloading of standard D-Bus method.
1283
Inserts annotation tags on methods and signals.
1285
xmlstring = dbus.service.Object.Introspect(self, object_path,
1288
document = xml.dom.minidom.parseString(xmlstring)
1290
for if_tag in document.getElementsByTagName("interface"):
1291
# Add annotation tags
1292
for typ in ("method", "signal"):
1293
for tag in if_tag.getElementsByTagName(typ):
1295
for name, prop in (self.
1296
_get_all_dbus_things(typ)):
1297
if (name == tag.getAttribute("name")
1298
and prop._dbus_interface
1299
== if_tag.getAttribute("name")):
1300
annots.update(getattr(
1301
prop, "_dbus_annotations", {}))
1302
for name, value in annots.items():
1303
ann_tag = document.createElement(
1305
ann_tag.setAttribute("name", name)
1306
ann_tag.setAttribute("value", value)
1307
tag.appendChild(ann_tag)
1308
# Add interface annotation tags
1309
for annotation, value in dict(
1310
itertools.chain.from_iterable(
1311
annotations().items()
1312
for name, annotations
1313
in self._get_all_dbus_things("interface")
1314
if name == if_tag.getAttribute("name")
1316
ann_tag = document.createElement("annotation")
1317
ann_tag.setAttribute("name", annotation)
1318
ann_tag.setAttribute("value", value)
1319
if_tag.appendChild(ann_tag)
1320
# Fix argument name for the Introspect method itself
1321
if (if_tag.getAttribute("name")
1322
== dbus.INTROSPECTABLE_IFACE):
1323
for cn in if_tag.getElementsByTagName("method"):
1324
if cn.getAttribute("name") == "Introspect":
1325
for arg in cn.getElementsByTagName("arg"):
1326
if (arg.getAttribute("direction")
1328
arg.setAttribute("name",
1330
xmlstring = document.toxml("utf-8")
1332
except (AttributeError, xml.dom.DOMException,
1333
xml.parsers.expat.ExpatError) as error:
1334
logger.error("Failed to override Introspection method",
1339
class DBusObjectWithProperties(DBusObjectWithAnnotations):
756
1340
"""A D-Bus object with properties.
758
1342
Classes inheriting from this can use the dbus_service_property
759
1343
decorator to expose methods as D-Bus properties. It exposes the
760
1344
standard Get(), Set(), and GetAll() methods on the D-Bus.
764
def _is_dbus_property(obj):
765
return getattr(obj, "_dbus_is_property", False)
767
def _get_all_dbus_properties(self):
768
"""Returns a generator of (name, attribute) pairs
770
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
771
for cls in self.__class__.__mro__
773
inspect.getmembers(cls, self._is_dbus_property))
775
1347
def _get_dbus_property(self, interface_name, property_name):
776
1348
"""Returns a bound method if one exists which is a D-Bus
777
1349
property with the specified name and interface.
779
for cls in self.__class__.__mro__:
780
for name, value in (inspect.getmembers
781
(cls, self._is_dbus_property)):
1351
for cls in self.__class__.__mro__:
1352
for name, value in inspect.getmembers(
1353
cls, self._is_dbus_thing("property")):
782
1354
if (value._dbus_name == property_name
783
1355
and value._dbus_interface == interface_name):
784
1356
return value.__get__(self)
786
1358
# No such property
787
raise DBusPropertyNotFound(self.dbus_object_path + ":"
788
+ interface_name + "."
791
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1359
raise DBusPropertyNotFound("{}:{}.{}".format(
1360
self.dbus_object_path, interface_name, property_name))
1363
def _get_all_interface_names(cls):
1364
"""Get a sequence of all interfaces supported by an object"""
1365
return (name for name in set(getattr(getattr(x, attr),
1366
"_dbus_interface", None)
1367
for x in (inspect.getmro(cls))
1369
if name is not None)
1371
@dbus.service.method(dbus.PROPERTIES_IFACE,
792
1373
out_signature="v")
793
1374
def Get(self, interface_name, property_name):
794
1375
"""Standard D-Bus property Get() method, see D-Bus standard.
886
1500
except (AttributeError, xml.dom.DOMException,
887
1501
xml.parsers.expat.ExpatError) as error:
888
1502
logger.error("Failed to override Introspection method",
893
def datetime_to_dbus (dt, variant_level=0):
1508
dbus.OBJECT_MANAGER_IFACE
1509
except AttributeError:
1510
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1513
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1514
"""A D-Bus object with an ObjectManager.
1516
Classes inheriting from this exposes the standard
1517
GetManagedObjects call and the InterfacesAdded and
1518
InterfacesRemoved signals on the standard
1519
"org.freedesktop.DBus.ObjectManager" interface.
1521
Note: No signals are sent automatically; they must be sent
1524
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1525
out_signature="a{oa{sa{sv}}}")
1526
def GetManagedObjects(self):
1527
"""This function must be overridden"""
1528
raise NotImplementedError()
1530
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1531
signature="oa{sa{sv}}")
1532
def InterfacesAdded(self, object_path, interfaces_and_properties):
1535
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1536
def InterfacesRemoved(self, object_path, interfaces):
1539
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1541
path_keyword='object_path',
1542
connection_keyword='connection')
1543
def Introspect(self, object_path, connection):
1544
"""Overloading of standard D-Bus method.
1546
Override return argument name of GetManagedObjects to be
1547
"objpath_interfaces_and_properties"
1549
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1553
document = xml.dom.minidom.parseString(xmlstring)
1555
for if_tag in document.getElementsByTagName("interface"):
1556
# Fix argument name for the GetManagedObjects method
1557
if (if_tag.getAttribute("name")
1558
== dbus.OBJECT_MANAGER_IFACE):
1559
for cn in if_tag.getElementsByTagName("method"):
1560
if (cn.getAttribute("name")
1561
== "GetManagedObjects"):
1562
for arg in cn.getElementsByTagName("arg"):
1563
if (arg.getAttribute("direction")
1567
"objpath_interfaces"
1569
xmlstring = document.toxml("utf-8")
1571
except (AttributeError, xml.dom.DOMException,
1572
xml.parsers.expat.ExpatError) as error:
1573
logger.error("Failed to override Introspection method",
1578
def datetime_to_dbus(dt, variant_level=0):
894
1579
"""Convert a UTC datetime.datetime() to a D-Bus type."""
896
return dbus.String("", variant_level = variant_level)
897
return dbus.String(dt.isoformat(),
898
variant_level=variant_level)
901
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
903
"""Applied to an empty subclass of a D-Bus object, this metaclass
904
will add additional D-Bus attributes matching a certain pattern.
1581
return dbus.String("", variant_level=variant_level)
1582
return dbus.String(dt.isoformat(), variant_level=variant_level)
1585
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1586
"""A class decorator; applied to a subclass of
1587
dbus.service.Object, it will add alternate D-Bus attributes with
1588
interface names according to the "alt_interface_names" mapping.
1591
@alternate_dbus_interfaces({"org.example.Interface":
1592
"net.example.AlternateInterface"})
1593
class SampleDBusObject(dbus.service.Object):
1594
@dbus.service.method("org.example.Interface")
1595
def SampleDBusMethod():
1598
The above "SampleDBusMethod" on "SampleDBusObject" will be
1599
reachable via two interfaces: "org.example.Interface" and
1600
"net.example.AlternateInterface", the latter of which will have
1601
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1602
"true", unless "deprecate" is passed with a False value.
1604
This works for methods and signals, and also for D-Bus properties
1605
(from DBusObjectWithProperties) and interfaces (from the
1606
dbus_interface_annotations decorator).
906
def __new__(mcs, name, bases, attr):
907
# Go through all the base classes which could have D-Bus
908
# methods, signals, or properties in them
909
for base in (b for b in bases
910
if issubclass(b, dbus.service.Object)):
911
# Go though all attributes of the base class
912
for attrname, attribute in inspect.getmembers(base):
1610
for orig_interface_name, alt_interface_name in (
1611
alt_interface_names.items()):
1613
interface_names = set()
1614
# Go though all attributes of the class
1615
for attrname, attribute in inspect.getmembers(cls):
913
1616
# Ignore non-D-Bus attributes, and D-Bus attributes
914
1617
# with the wrong interface name
915
1618
if (not hasattr(attribute, "_dbus_interface")
916
or not attribute._dbus_interface
917
.startswith("se.recompile.Mandos")):
1619
or not attribute._dbus_interface.startswith(
1620
orig_interface_name)):
919
1622
# Create an alternate D-Bus interface name based on
920
1623
# the current name
921
alt_interface = (attribute._dbus_interface
922
.replace("se.recompile.Mandos",
923
"se.bsnet.fukt.Mandos"))
1624
alt_interface = attribute._dbus_interface.replace(
1625
orig_interface_name, alt_interface_name)
1626
interface_names.add(alt_interface)
924
1627
# Is this a D-Bus signal?
925
1628
if getattr(attribute, "_dbus_is_signal", False):
926
# Extract the original non-method function by
928
nonmethod_func = (dict(
1629
# Extract the original non-method undecorated
1630
# function by black magic
1631
if sys.version_info.major == 2:
1632
nonmethod_func = (dict(
929
1633
zip(attribute.func_code.co_freevars,
930
attribute.__closure__))["func"]
1634
attribute.__closure__))
1635
["func"].cell_contents)
1637
nonmethod_func = (dict(
1638
zip(attribute.__code__.co_freevars,
1639
attribute.__closure__))
1640
["func"].cell_contents)
932
1641
# Create a new, but exactly alike, function
933
1642
# object, and decorate it to be a new D-Bus signal
934
1643
# with the alternate D-Bus interface name
935
new_function = (dbus.service.signal
937
attribute._dbus_signature)
939
nonmethod_func.func_code,
940
nonmethod_func.func_globals,
941
nonmethod_func.func_name,
942
nonmethod_func.func_defaults,
943
nonmethod_func.func_closure)))
1644
new_function = copy_function(nonmethod_func)
1645
new_function = (dbus.service.signal(
1647
attribute._dbus_signature)(new_function))
1648
# Copy annotations, if any
1650
new_function._dbus_annotations = dict(
1651
attribute._dbus_annotations)
1652
except AttributeError:
944
1655
# Define a creator of a function to call both the
945
# old and new functions, so both the old and new
946
# signals gets sent when the function is called
1656
# original and alternate functions, so both the
1657
# original and alternate signals gets sent when
1658
# the function is called
947
1659
def fixscope(func1, func2):
948
1660
"""This function is a scope container to pass
949
1661
func1 and func2 to the "call_both" function
950
1662
outside of its arguments"""
1664
@functools.wraps(func2)
951
1665
def call_both(*args, **kwargs):
952
1666
"""This function will emit two D-Bus
953
1667
signals by calling func1 and func2"""
954
1668
func1(*args, **kwargs)
955
1669
func2(*args, **kwargs)
1670
# Make wrapper function look like a D-Bus
1672
for name, attr in inspect.getmembers(func2):
1673
if name.startswith("_dbus_"):
1674
setattr(call_both, name, attr)
956
1676
return call_both
957
1677
# Create the "call_both" function and add it to
959
attr[attrname] = fixscope(attribute,
1679
attr[attrname] = fixscope(attribute, new_function)
961
1680
# Is this a D-Bus method?
962
1681
elif getattr(attribute, "_dbus_is_method", False):
963
1682
# Create a new, but exactly alike, function
964
1683
# object. Decorate it to be a new D-Bus method
965
1684
# with the alternate D-Bus interface name. Add it
967
attr[attrname] = (dbus.service.method
969
attribute._dbus_in_signature,
970
attribute._dbus_out_signature)
972
(attribute.func_code,
973
attribute.func_globals,
975
attribute.func_defaults,
976
attribute.func_closure)))
1687
dbus.service.method(
1689
attribute._dbus_in_signature,
1690
attribute._dbus_out_signature)
1691
(copy_function(attribute)))
1692
# Copy annotations, if any
1694
attr[attrname]._dbus_annotations = dict(
1695
attribute._dbus_annotations)
1696
except AttributeError:
977
1698
# Is this a D-Bus property?
978
1699
elif getattr(attribute, "_dbus_is_property", False):
979
1700
# Create a new, but exactly alike, function
980
1701
# object, and decorate it to be a new D-Bus
981
1702
# property with the alternate D-Bus interface
982
1703
# name. Add it to the class.
983
attr[attrname] = (dbus_service_property
985
attribute._dbus_signature,
986
attribute._dbus_access,
988
._dbus_get_args_options
991
(attribute.func_code,
992
attribute.func_globals,
994
attribute.func_defaults,
995
attribute.func_closure)))
996
return type.__new__(mcs, name, bases, attr)
1704
attr[attrname] = (dbus_service_property(
1705
alt_interface, attribute._dbus_signature,
1706
attribute._dbus_access,
1707
attribute._dbus_get_args_options
1709
(copy_function(attribute)))
1710
# Copy annotations, if any
1712
attr[attrname]._dbus_annotations = dict(
1713
attribute._dbus_annotations)
1714
except AttributeError:
1716
# Is this a D-Bus interface?
1717
elif getattr(attribute, "_dbus_is_interface", False):
1718
# Create a new, but exactly alike, function
1719
# object. Decorate it to be a new D-Bus interface
1720
# with the alternate D-Bus interface name. Add it
1723
dbus_interface_annotations(alt_interface)
1724
(copy_function(attribute)))
1726
# Deprecate all alternate interfaces
1727
iname = "_AlternateDBusNames_interface_annotation{}"
1728
for interface_name in interface_names:
1730
@dbus_interface_annotations(interface_name)
1732
return {"org.freedesktop.DBus.Deprecated":
1734
# Find an unused name
1735
for aname in (iname.format(i)
1736
for i in itertools.count()):
1737
if aname not in attr:
1741
# Replace the class with a new subclass of it with
1742
# methods, signals, etc. as created above.
1743
if sys.version_info.major == 2:
1744
cls = type(b"{}Alternate".format(cls.__name__),
1747
cls = type("{}Alternate".format(cls.__name__),
1754
@alternate_dbus_interfaces({"se.recompile.Mandos":
1755
"se.bsnet.fukt.Mandos"})
999
1756
class ClientDBus(Client, DBusObjectWithProperties):
1000
1757
"""A Client class using D-Bus
1003
1760
dbus_object_path: dbus.ObjectPath
1004
1761
bus: dbus.SystemBus()
1007
1764
runtime_expansions = (Client.runtime_expansions
1008
+ ("dbus_object_path",))
1765
+ ("dbus_object_path", ))
1767
_interface = "se.recompile.Mandos.Client"
1010
1769
# dbus.service.Object doesn't use super(), so we can't either.
1012
def __init__(self, bus = None, *args, **kwargs):
1771
def __init__(self, bus=None, *args, **kwargs):
1014
1773
Client.__init__(self, *args, **kwargs)
1016
self._approvals_pending = 0
1017
1774
# Only now, when this client is initialized, can it show up on
1019
client_object_name = unicode(self.name).translate(
1776
client_object_name = str(self.name).translate(
1020
1777
{ord("."): ord("_"),
1021
1778
ord("-"): ord("_")})
1022
self.dbus_object_path = (dbus.ObjectPath
1023
("/clients/" + client_object_name))
1779
self.dbus_object_path = dbus.ObjectPath(
1780
"/clients/" + client_object_name)
1024
1781
DBusObjectWithProperties.__init__(self, self.bus,
1025
1782
self.dbus_object_path)
1027
def notifychangeproperty(transform_func,
1028
dbus_name, type_func=lambda x: x,
1784
def notifychangeproperty(transform_func, dbus_name,
1785
type_func=lambda x: x,
1787
invalidate_only=False,
1788
_interface=_interface):
1030
1789
""" Modify a variable so that it's a property which announces
1031
1790
its changes to DBus.
1033
1792
transform_fun: Function that takes a value and a variant_level
1034
1793
and transforms it to a D-Bus type.
1035
1794
dbus_name: D-Bus name of the variable
1176
1946
server to mandos-client
1180
1950
# Rejected - signal
1181
1951
@dbus.service.signal(_interface, signature="s")
1182
1952
def Rejected(self, reason):
1186
1956
# NeedApproval - signal
1187
1957
@dbus.service.signal(_interface, signature="tb")
1188
1958
def NeedApproval(self, timeout, default):
1190
1960
return self.need_approval()
1192
# NeRwequest - signal
1193
@dbus.service.signal(_interface, signature="s")
1194
def NewRequest(self, ip):
1196
Is sent after a client request a password.
1202
1964
# Approve - method
1203
1965
@dbus.service.method(_interface, in_signature="b")
1204
1966
def Approve(self, value):
1205
1967
self.approve(value)
1207
1969
# CheckedOK - method
1208
1970
@dbus.service.method(_interface)
1209
1971
def CheckedOK(self):
1210
1972
self.checked_ok()
1212
1974
# Enable - method
1975
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1213
1976
@dbus.service.method(_interface)
1214
1977
def Enable(self):
1218
1981
# StartChecker - method
1982
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1219
1983
@dbus.service.method(_interface)
1220
1984
def StartChecker(self):
1222
1986
self.start_checker()
1224
1988
# Disable - method
1989
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1225
1990
@dbus.service.method(_interface)
1226
1991
def Disable(self):
1230
1995
# StopChecker - method
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1231
1997
@dbus.service.method(_interface)
1232
1998
def StopChecker(self):
1233
1999
self.stop_checker()
1237
2003
# ApprovalPending - property
1238
2004
@dbus_service_property(_interface, signature="b", access="read")
1239
2005
def ApprovalPending_dbus_property(self):
1240
2006
return dbus.Boolean(bool(self.approvals_pending))
1242
2008
# ApprovedByDefault - property
1243
@dbus_service_property(_interface, signature="b",
2009
@dbus_service_property(_interface,
1244
2011
access="readwrite")
1245
2012
def ApprovedByDefault_dbus_property(self, value=None):
1246
2013
if value is None: # get
1247
2014
return dbus.Boolean(self.approved_by_default)
1248
2015
self.approved_by_default = bool(value)
1250
2017
# ApprovalDelay - property
1251
@dbus_service_property(_interface, signature="t",
2018
@dbus_service_property(_interface,
1252
2020
access="readwrite")
1253
2021
def ApprovalDelay_dbus_property(self, value=None):
1254
2022
if value is None: # get
1255
return dbus.UInt64(self.approval_delay_milliseconds())
2023
return dbus.UInt64(self.approval_delay.total_seconds()
1256
2025
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1258
2027
# ApprovalDuration - property
1259
@dbus_service_property(_interface, signature="t",
2028
@dbus_service_property(_interface,
1260
2030
access="readwrite")
1261
2031
def ApprovalDuration_dbus_property(self, value=None):
1262
2032
if value is None: # get
1263
return dbus.UInt64(timedelta_to_milliseconds(
1264
self.approval_duration))
2033
return dbus.UInt64(self.approval_duration.total_seconds()
1265
2035
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1267
2037
# Name - property
2039
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1268
2040
@dbus_service_property(_interface, signature="s", access="read")
1269
2041
def Name_dbus_property(self):
1270
2042
return dbus.String(self.name)
2046
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2047
@dbus_service_property(_interface, signature="s", access="read")
2048
def KeyID_dbus_property(self):
2049
return dbus.String(self.key_id)
1272
2051
# Fingerprint - property
2053
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1273
2054
@dbus_service_property(_interface, signature="s", access="read")
1274
2055
def Fingerprint_dbus_property(self):
1275
2056
return dbus.String(self.fingerprint)
1277
2058
# Host - property
1278
@dbus_service_property(_interface, signature="s",
2059
@dbus_service_property(_interface,
1279
2061
access="readwrite")
1280
2062
def Host_dbus_property(self, value=None):
1281
2063
if value is None: # get
1282
2064
return dbus.String(self.host)
1283
self.host = unicode(value)
2065
self.host = str(value)
1285
2067
# Created - property
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1286
2070
@dbus_service_property(_interface, signature="s", access="read")
1287
2071
def Created_dbus_property(self):
1288
2072
return datetime_to_dbus(self.created)
1290
2074
# LastEnabled - property
1291
2075
@dbus_service_property(_interface, signature="s", access="read")
1292
2076
def LastEnabled_dbus_property(self):
1293
2077
return datetime_to_dbus(self.last_enabled)
1295
2079
# Enabled - property
1296
@dbus_service_property(_interface, signature="b",
2080
@dbus_service_property(_interface,
1297
2082
access="readwrite")
1298
2083
def Enabled_dbus_property(self, value=None):
1299
2084
if value is None: # get
1306
2091
# LastCheckedOK - property
1307
@dbus_service_property(_interface, signature="s",
2092
@dbus_service_property(_interface,
1308
2094
access="readwrite")
1309
2095
def LastCheckedOK_dbus_property(self, value=None):
1310
2096
if value is not None:
1311
2097
self.checked_ok()
1313
2099
return datetime_to_dbus(self.last_checked_ok)
2101
# LastCheckerStatus - property
2102
@dbus_service_property(_interface, signature="n", access="read")
2103
def LastCheckerStatus_dbus_property(self):
2104
return dbus.Int16(self.last_checker_status)
1315
2106
# Expires - property
1316
2107
@dbus_service_property(_interface, signature="s", access="read")
1317
2108
def Expires_dbus_property(self):
1318
2109
return datetime_to_dbus(self.expires)
1320
2111
# LastApprovalRequest - property
1321
2112
@dbus_service_property(_interface, signature="s", access="read")
1322
2113
def LastApprovalRequest_dbus_property(self):
1323
2114
return datetime_to_dbus(self.last_approval_request)
1325
2116
# Timeout - property
1326
@dbus_service_property(_interface, signature="t",
2117
@dbus_service_property(_interface,
1327
2119
access="readwrite")
1328
2120
def Timeout_dbus_property(self, value=None):
1329
2121
if value is None: # get
1330
return dbus.UInt64(self.timeout_milliseconds())
2122
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2123
old_timeout = self.timeout
1331
2124
self.timeout = datetime.timedelta(0, 0, 0, value)
1332
if getattr(self, "disable_initiator_tag", None) is None:
1334
# Reschedule timeout
1335
gobject.source_remove(self.disable_initiator_tag)
1336
self.disable_initiator_tag = None
1338
time_to_die = timedelta_to_milliseconds((self
1343
if time_to_die <= 0:
1344
# The timeout has passed
1347
self.expires = (datetime.datetime.utcnow()
1348
+ datetime.timedelta(milliseconds =
1350
self.disable_initiator_tag = (gobject.timeout_add
1351
(time_to_die, self.disable))
2125
# Reschedule disabling
2127
now = datetime.datetime.utcnow()
2128
self.expires += self.timeout - old_timeout
2129
if self.expires <= now:
2130
# The timeout has passed
2133
if (getattr(self, "disable_initiator_tag", None)
2136
GLib.source_remove(self.disable_initiator_tag)
2137
self.disable_initiator_tag = GLib.timeout_add(
2138
int((self.expires - now).total_seconds() * 1000),
1353
2141
# ExtendedTimeout - property
1354
@dbus_service_property(_interface, signature="t",
2142
@dbus_service_property(_interface,
1355
2144
access="readwrite")
1356
2145
def ExtendedTimeout_dbus_property(self, value=None):
1357
2146
if value is None: # get
1358
return dbus.UInt64(self.extended_timeout_milliseconds())
2147
return dbus.UInt64(self.extended_timeout.total_seconds()
1359
2149
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1361
2151
# Interval - property
1362
@dbus_service_property(_interface, signature="t",
2152
@dbus_service_property(_interface,
1363
2154
access="readwrite")
1364
2155
def Interval_dbus_property(self, value=None):
1365
2156
if value is None: # get
1366
return dbus.UInt64(self.interval_milliseconds())
2157
return dbus.UInt64(self.interval.total_seconds() * 1000)
1367
2158
self.interval = datetime.timedelta(0, 0, 0, value)
1368
2159
if getattr(self, "checker_initiator_tag", None) is None:
1370
2161
if self.enabled:
1371
2162
# Reschedule checker run
1372
gobject.source_remove(self.checker_initiator_tag)
1373
self.checker_initiator_tag = (gobject.timeout_add
1374
(value, self.start_checker))
1375
self.start_checker() # Start one now, too
2163
GLib.source_remove(self.checker_initiator_tag)
2164
self.checker_initiator_tag = GLib.timeout_add(
2165
value, self.start_checker)
2166
self.start_checker() # Start one now, too
1377
2168
# Checker - property
1378
@dbus_service_property(_interface, signature="s",
2169
@dbus_service_property(_interface,
1379
2171
access="readwrite")
1380
2172
def Checker_dbus_property(self, value=None):
1381
2173
if value is None: # get
1382
2174
return dbus.String(self.checker_command)
1383
self.checker_command = unicode(value)
2175
self.checker_command = str(value)
1385
2177
# CheckerRunning - property
1386
@dbus_service_property(_interface, signature="b",
2178
@dbus_service_property(_interface,
1387
2180
access="readwrite")
1388
2181
def CheckerRunning_dbus_property(self, value=None):
1389
2182
if value is None: # get
1422
2223
if data[0] == 'data':
1424
2225
if data[0] == 'function':
1425
2227
def func(*args, **kwargs):
1426
2228
self._pipe.send(('funcall', name, args, kwargs))
1427
2229
return self._pipe.recv()[1]
1430
2233
def __setattr__(self, name, value):
1431
2234
if name == '_pipe':
1432
2235
return super(ProxyClient, self).__setattr__(name, value)
1433
2236
self._pipe.send(('setattr', name, value))
1436
class ClientDBusTransitional(ClientDBus):
1437
__metaclass__ = AlternateDBusNamesMetaclass
1440
2239
class ClientHandler(socketserver.BaseRequestHandler, object):
1441
2240
"""A class to handle client connections.
1443
2242
Instantiated once for each connection to handle it.
1444
2243
Note: This will run in its own forked process."""
1446
2245
def handle(self):
1447
2246
with contextlib.closing(self.server.child_pipe) as child_pipe:
1448
2247
logger.info("TCP connection from: %s",
1449
unicode(self.client_address))
2248
str(self.client_address))
1450
2249
logger.debug("Pipe FD: %d",
1451
2250
self.server.child_pipe.fileno())
1453
session = (gnutls.connection
1454
.ClientSession(self.request,
1456
.X509Credentials()))
1458
# Note: gnutls.connection.X509Credentials is really a
1459
# generic GnuTLS certificate credentials object so long as
1460
# no X.509 keys are added to it. Therefore, we can use it
1461
# here despite using OpenPGP certificates.
1463
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1464
# "+AES-256-CBC", "+SHA1",
1465
# "+COMP-NULL", "+CTYPE-OPENPGP",
2252
session = gnutls.ClientSession(self.request)
2254
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2255
# "+AES-256-CBC", "+SHA1",
2256
# "+COMP-NULL", "+CTYPE-OPENPGP",
1467
2258
# Use a fallback default, since this MUST be set.
1468
2259
priority = self.server.gnutls_priority
1469
2260
if priority is None:
1470
2261
priority = "NORMAL"
1471
(gnutls.library.functions
1472
.gnutls_priority_set_direct(session._c_object,
2262
gnutls.priority_set_direct(session._c_object,
2263
priority.encode("utf-8"),
1475
2266
# Start communication using the Mandos protocol
1476
2267
# Get protocol number
1477
2268
line = self.request.makefile().readline()
1478
2269
logger.debug("Protocol version: %r", line)
1480
2271
if int(line.strip().split()[0]) > 1:
2272
raise RuntimeError(line)
1482
2273
except (ValueError, IndexError, RuntimeError) as error:
1483
2274
logger.error("Unknown protocol version: %s", error)
1486
2277
# Start GnuTLS connection
1488
2279
session.handshake()
1489
except gnutls.errors.GNUTLSError as error:
2280
except gnutls.Error as error:
1490
2281
logger.warning("Handshake failed: %s", error)
1491
2282
# Do not run session.bye() here: the session is not
1492
2283
# established. Just abandon the request.
1494
2285
logger.debug("Handshake succeeded")
1496
2287
approval_required = False
1499
fpr = self.fingerprint(self.peer_certificate
1502
gnutls.errors.GNUTLSError) as error:
1503
logger.warning("Bad certificate: %s", error)
1505
logger.debug("Fingerprint: %s", fpr)
1508
client = ProxyClient(child_pipe, fpr,
2289
if gnutls.has_rawpk:
2292
key_id = self.key_id(
2293
self.peer_certificate(session))
2294
except (TypeError, gnutls.Error) as error:
2295
logger.warning("Bad certificate: %s", error)
2297
logger.debug("Key ID: %s", key_id)
2302
fpr = self.fingerprint(
2303
self.peer_certificate(session))
2304
except (TypeError, gnutls.Error) as error:
2305
logger.warning("Bad certificate: %s", error)
2307
logger.debug("Fingerprint: %s", fpr)
2310
client = ProxyClient(child_pipe, key_id, fpr,
1509
2311
self.client_address)
1510
2312
except KeyError:
1513
if self.server.use_dbus:
1515
client.NewRequest(str(self.client_address))
1517
2315
if client.approval_delay:
1518
2316
delay = client.approval_delay
1519
2317
client.approvals_pending += 1
1520
2318
approval_required = True
1523
2321
if not client.enabled:
1524
2322
logger.info("Client %s is disabled",
1526
2324
if self.server.use_dbus:
1527
2325
# Emit D-Bus signal
1528
2326
client.Rejected("Disabled")
1531
2329
if client.approved or not client.approval_delay:
1532
#We are approved or approval is disabled
2330
# We are approved or approval is disabled
1534
2332
elif client.approved is None:
1535
2333
logger.info("Client %s needs approval",
1570
2366
delay -= time2 - time
1573
while sent_size < len(client.secret):
1575
sent = session.send(client.secret[sent_size:])
1576
except gnutls.errors.GNUTLSError as error:
1577
logger.warning("gnutls send failed")
1579
logger.debug("Sent: %d, remaining: %d",
1580
sent, len(client.secret)
1581
- (sent_size + sent))
2369
session.send(client.secret)
2370
except gnutls.Error as error:
2371
logger.warning("gnutls send failed",
1584
2375
logger.info("Sending secret to %s", client.name)
1585
2376
# bump the timeout using extended_timeout
1586
client.checked_ok(client.extended_timeout)
2377
client.bump_timeout(client.extended_timeout)
1587
2378
if self.server.use_dbus:
1588
2379
# Emit D-Bus signal
1589
2380
client.GotSecret()
1592
2383
if approval_required:
1593
2384
client.approvals_pending -= 1
1596
except gnutls.errors.GNUTLSError as error:
1597
logger.warning("GnuTLS bye failed")
2387
except gnutls.Error as error:
2388
logger.warning("GnuTLS bye failed",
1600
2392
def peer_certificate(session):
1601
"Return the peer's OpenPGP certificate as a bytestring"
1602
# If not an OpenPGP certificate...
1603
if (gnutls.library.functions
1604
.gnutls_certificate_type_get(session._c_object)
1605
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1606
# ...do the normal thing
1607
return session.peer_certificate
2393
"Return the peer's certificate as a bytestring"
2395
cert_type = gnutls.certificate_type_get2(session._c_object,
2397
except AttributeError:
2398
cert_type = gnutls.certificate_type_get(session._c_object)
2399
if gnutls.has_rawpk:
2400
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2402
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2403
# If not a valid certificate type...
2404
if cert_type not in valid_cert_types:
2405
logger.info("Cert type %r not in %r", cert_type,
2407
# ...return invalid data
1608
2409
list_size = ctypes.c_uint(1)
1609
cert_list = (gnutls.library.functions
1610
.gnutls_certificate_get_peers
2410
cert_list = (gnutls.certificate_get_peers
1611
2411
(session._c_object, ctypes.byref(list_size)))
1612
2412
if not bool(cert_list) and list_size.value != 0:
1613
raise gnutls.errors.GNUTLSError("error getting peer"
2413
raise gnutls.Error("error getting peer certificate")
1615
2414
if list_size.value == 0:
1617
2416
cert = cert_list[0]
1618
2417
return ctypes.string_at(cert.data, cert.size)
2420
def key_id(certificate):
2421
"Convert a certificate bytestring to a hexdigit key ID"
2422
# New GnuTLS "datum" with the public key
2423
datum = gnutls.datum_t(
2424
ctypes.cast(ctypes.c_char_p(certificate),
2425
ctypes.POINTER(ctypes.c_ubyte)),
2426
ctypes.c_uint(len(certificate)))
2427
# XXX all these need to be created in the gnutls "module"
2428
# New empty GnuTLS certificate
2429
pubkey = gnutls.pubkey_t()
2430
gnutls.pubkey_init(ctypes.byref(pubkey))
2431
# Import the raw public key into the certificate
2432
gnutls.pubkey_import(pubkey,
2433
ctypes.byref(datum),
2434
gnutls.X509_FMT_DER)
2435
# New buffer for the key ID
2436
buf = ctypes.create_string_buffer(32)
2437
buf_len = ctypes.c_size_t(len(buf))
2438
# Get the key ID from the raw public key into the buffer
2439
gnutls.pubkey_get_key_id(pubkey,
2440
gnutls.KEYID_USE_SHA256,
2441
ctypes.cast(ctypes.byref(buf),
2442
ctypes.POINTER(ctypes.c_ubyte)),
2443
ctypes.byref(buf_len))
2444
# Deinit the certificate
2445
gnutls.pubkey_deinit(pubkey)
2447
# Convert the buffer to a Python bytestring
2448
key_id = ctypes.string_at(buf, buf_len.value)
2449
# Convert the bytestring to hexadecimal notation
2450
hex_key_id = binascii.hexlify(key_id).upper()
1621
2454
def fingerprint(openpgp):
1622
2455
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1623
2456
# New GnuTLS "datum" with the OpenPGP public key
1624
datum = (gnutls.library.types
1625
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1628
ctypes.c_uint(len(openpgp))))
2457
datum = gnutls.datum_t(
2458
ctypes.cast(ctypes.c_char_p(openpgp),
2459
ctypes.POINTER(ctypes.c_ubyte)),
2460
ctypes.c_uint(len(openpgp)))
1629
2461
# New empty GnuTLS certificate
1630
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1631
(gnutls.library.functions
1632
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2462
crt = gnutls.openpgp_crt_t()
2463
gnutls.openpgp_crt_init(ctypes.byref(crt))
1633
2464
# Import the OpenPGP public key into the certificate
1634
(gnutls.library.functions
1635
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1636
gnutls.library.constants
1637
.GNUTLS_OPENPGP_FMT_RAW))
2465
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2466
gnutls.OPENPGP_FMT_RAW)
1638
2467
# Verify the self signature in the key
1639
2468
crtverify = ctypes.c_uint()
1640
(gnutls.library.functions
1641
.gnutls_openpgp_crt_verify_self(crt, 0,
1642
ctypes.byref(crtverify)))
2469
gnutls.openpgp_crt_verify_self(crt, 0,
2470
ctypes.byref(crtverify))
1643
2471
if crtverify.value != 0:
1644
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1645
raise (gnutls.errors.CertificateSecurityError
2472
gnutls.openpgp_crt_deinit(crt)
2473
raise gnutls.CertificateSecurityError(code
1647
2475
# New buffer for the fingerprint
1648
2476
buf = ctypes.create_string_buffer(20)
1649
2477
buf_len = ctypes.c_size_t()
1650
2478
# Get the fingerprint from the certificate into the buffer
1651
(gnutls.library.functions
1652
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1653
ctypes.byref(buf_len)))
2479
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2480
ctypes.byref(buf_len))
1654
2481
# Deinit the certificate
1655
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2482
gnutls.openpgp_crt_deinit(crt)
1656
2483
# Convert the buffer to a Python bytestring
1657
2484
fpr = ctypes.string_at(buf, buf_len.value)
1658
2485
# Convert the bytestring to hexadecimal notation
1663
2490
class MultiprocessingMixIn(object):
1664
2491
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1665
2493
def sub_process_main(self, request, address):
1667
2495
self.finish_request(request, address)
1669
2497
self.handle_error(request, address)
1670
2498
self.close_request(request)
1672
2500
def process_request(self, request, address):
1673
2501
"""Start a new process to process the request."""
1674
proc = multiprocessing.Process(target = self.sub_process_main,
2502
proc = multiprocessing.Process(target=self.sub_process_main,
2503
args=(request, address))
1681
2508
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1682
2509
""" adds a pipe to the MixIn """
1683
2511
def process_request(self, request, client_address):
1684
2512
"""Overrides and wraps the original process_request().
1686
2514
This function creates a new pipe in self.pipe
1688
2516
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1690
2518
proc = MultiprocessingMixIn.process_request(self, request,
1691
2519
client_address)
1692
2520
self.child_pipe.close()
1693
2521
self.add_pipe(parent_pipe, proc)
1695
2523
def add_pipe(self, parent_pipe, proc):
1696
2524
"""Dummy function; override as necessary"""
1697
raise NotImplementedError
2525
raise NotImplementedError()
1700
2528
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1701
2529
socketserver.TCPServer, object):
1702
2530
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1705
2533
enabled: Boolean; whether this server is activated yet
1706
2534
interface: None or a network interface name (string)
1707
2535
use_ipv6: Boolean; to use IPv6 or not
1709
2538
def __init__(self, server_address, RequestHandlerClass,
1710
interface=None, use_ipv6=True):
2542
"""If socketfd is set, use that file descriptor instead of
2543
creating a new one with socket.socket().
1711
2545
self.interface = interface
1713
2547
self.address_family = socket.AF_INET6
2548
if socketfd is not None:
2549
# Save the file descriptor
2550
self.socketfd = socketfd
2551
# Save the original socket.socket() function
2552
self.socket_socket = socket.socket
2554
# To implement --socket, we monkey patch socket.socket.
2556
# (When socketserver.TCPServer is a new-style class, we
2557
# could make self.socket into a property instead of monkey
2558
# patching socket.socket.)
2560
# Create a one-time-only replacement for socket.socket()
2561
@functools.wraps(socket.socket)
2562
def socket_wrapper(*args, **kwargs):
2563
# Restore original function so subsequent calls are
2565
socket.socket = self.socket_socket
2566
del self.socket_socket
2567
# This time only, return a new socket object from the
2568
# saved file descriptor.
2569
return socket.fromfd(self.socketfd, *args, **kwargs)
2570
# Replace socket.socket() function with wrapper
2571
socket.socket = socket_wrapper
2572
# The socketserver.TCPServer.__init__ will call
2573
# socket.socket(), which might be our replacement,
2574
# socket_wrapper(), if socketfd was set.
1714
2575
socketserver.TCPServer.__init__(self, server_address,
1715
2576
RequestHandlerClass)
1716
2578
def server_bind(self):
1717
2579
"""This overrides the normal server_bind() function
1718
2580
to bind to an interface if one was specified, and also NOT to
1719
2581
bind to an address or port if they were not specified."""
2582
global SO_BINDTODEVICE
1720
2583
if self.interface is not None:
1721
2584
if SO_BINDTODEVICE is None:
1722
logger.error("SO_BINDTODEVICE does not exist;"
1723
" cannot bind to interface %s",
1727
self.socket.setsockopt(socket.SOL_SOCKET,
1731
except socket.error as error:
1732
if error[0] == errno.EPERM:
1733
logger.error("No permission to"
1734
" bind to interface %s",
1736
elif error[0] == errno.ENOPROTOOPT:
1737
logger.error("SO_BINDTODEVICE not available;"
1738
" cannot bind to interface %s",
2585
# Fall back to a hard-coded value which seems to be
2587
logger.warning("SO_BINDTODEVICE not found, trying 25")
2588
SO_BINDTODEVICE = 25
2590
self.socket.setsockopt(
2591
socket.SOL_SOCKET, SO_BINDTODEVICE,
2592
(self.interface + "\0").encode("utf-8"))
2593
except socket.error as error:
2594
if error.errno == errno.EPERM:
2595
logger.error("No permission to bind to"
2596
" interface %s", self.interface)
2597
elif error.errno == errno.ENOPROTOOPT:
2598
logger.error("SO_BINDTODEVICE not available;"
2599
" cannot bind to interface %s",
2601
elif error.errno == errno.ENODEV:
2602
logger.error("Interface %s does not exist,"
2603
" cannot bind", self.interface)
1742
2606
# Only bind(2) the socket if we really need to.
1743
2607
if self.server_address[0] or self.server_address[1]:
2608
if self.server_address[1]:
2609
self.allow_reuse_address = True
1744
2610
if not self.server_address[0]:
1745
2611
if self.address_family == socket.AF_INET6:
1746
any_address = "::" # in6addr_any
2612
any_address = "::" # in6addr_any
1748
any_address = socket.INADDR_ANY
2614
any_address = "0.0.0.0" # INADDR_ANY
1749
2615
self.server_address = (any_address,
1750
2616
self.server_address[1])
1751
2617
elif not self.server_address[1]:
1752
self.server_address = (self.server_address[0],
2618
self.server_address = (self.server_address[0], 0)
1754
2619
# if self.interface:
1755
2620
# self.server_address = (self.server_address[0],
1859
2724
funcname = request[1]
1860
2725
args = request[2]
1861
2726
kwargs = request[3]
1863
2728
parent_pipe.send(('data', getattr(client_object,
1864
2729
funcname)(*args,
1867
2732
if command == 'getattr':
1868
2733
attrname = request[1]
1869
if callable(client_object.__getattribute__(attrname)):
1870
parent_pipe.send(('function',))
2734
if isinstance(client_object.__getattribute__(attrname),
2735
collections.Callable):
2736
parent_pipe.send(('function', ))
1872
parent_pipe.send(('data', client_object
1873
.__getattribute__(attrname)))
2739
'data', client_object.__getattribute__(attrname)))
1875
2741
if command == 'setattr':
1876
2742
attrname = request[1]
1877
2743
value = request[2]
1878
2744
setattr(client_object, attrname, value)
2749
def rfc3339_duration_to_delta(duration):
2750
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2752
>>> rfc3339_duration_to_delta("P7D")
2753
datetime.timedelta(7)
2754
>>> rfc3339_duration_to_delta("PT60S")
2755
datetime.timedelta(0, 60)
2756
>>> rfc3339_duration_to_delta("PT60M")
2757
datetime.timedelta(0, 3600)
2758
>>> rfc3339_duration_to_delta("PT24H")
2759
datetime.timedelta(1)
2760
>>> rfc3339_duration_to_delta("P1W")
2761
datetime.timedelta(7)
2762
>>> rfc3339_duration_to_delta("PT5M30S")
2763
datetime.timedelta(0, 330)
2764
>>> rfc3339_duration_to_delta("P1DT3M20S")
2765
datetime.timedelta(1, 200)
2768
# Parsing an RFC 3339 duration with regular expressions is not
2769
# possible - there would have to be multiple places for the same
2770
# values, like seconds. The current code, while more esoteric, is
2771
# cleaner without depending on a parsing library. If Python had a
2772
# built-in library for parsing we would use it, but we'd like to
2773
# avoid excessive use of external libraries.
2775
# New type for defining tokens, syntax, and semantics all-in-one
2776
Token = collections.namedtuple("Token", (
2777
"regexp", # To match token; if "value" is not None, must have
2778
# a "group" containing digits
2779
"value", # datetime.timedelta or None
2780
"followers")) # Tokens valid after this token
2781
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2782
# the "duration" ABNF definition in RFC 3339, Appendix A.
2783
token_end = Token(re.compile(r"$"), None, frozenset())
2784
token_second = Token(re.compile(r"(\d+)S"),
2785
datetime.timedelta(seconds=1),
2786
frozenset((token_end, )))
2787
token_minute = Token(re.compile(r"(\d+)M"),
2788
datetime.timedelta(minutes=1),
2789
frozenset((token_second, token_end)))
2790
token_hour = Token(re.compile(r"(\d+)H"),
2791
datetime.timedelta(hours=1),
2792
frozenset((token_minute, token_end)))
2793
token_time = Token(re.compile(r"T"),
2795
frozenset((token_hour, token_minute,
2797
token_day = Token(re.compile(r"(\d+)D"),
2798
datetime.timedelta(days=1),
2799
frozenset((token_time, token_end)))
2800
token_month = Token(re.compile(r"(\d+)M"),
2801
datetime.timedelta(weeks=4),
2802
frozenset((token_day, token_end)))
2803
token_year = Token(re.compile(r"(\d+)Y"),
2804
datetime.timedelta(weeks=52),
2805
frozenset((token_month, token_end)))
2806
token_week = Token(re.compile(r"(\d+)W"),
2807
datetime.timedelta(weeks=1),
2808
frozenset((token_end, )))
2809
token_duration = Token(re.compile(r"P"), None,
2810
frozenset((token_year, token_month,
2811
token_day, token_time,
2813
# Define starting values:
2815
value = datetime.timedelta()
2817
# Following valid tokens
2818
followers = frozenset((token_duration, ))
2819
# String left to parse
2821
# Loop until end token is found
2822
while found_token is not token_end:
2823
# Search for any currently valid tokens
2824
for token in followers:
2825
match = token.regexp.match(s)
2826
if match is not None:
2828
if token.value is not None:
2829
# Value found, parse digits
2830
factor = int(match.group(1), 10)
2831
# Add to value so far
2832
value += factor * token.value
2833
# Strip token from string
2834
s = token.regexp.sub("", s, 1)
2837
# Set valid next tokens
2838
followers = found_token.followers
2841
# No currently valid tokens were found
2842
raise ValueError("Invalid RFC 3339 duration: {!r}"
1883
2848
def string_to_delta(interval):
1884
2849
"""Parse a string and return a datetime.timedelta
1886
2851
>>> string_to_delta('7d')
1887
2852
datetime.timedelta(7)
1888
2853
>>> string_to_delta('60s')
1977
2948
parser.add_argument("--no-dbus", action="store_false",
1978
2949
dest="use_dbus", help="Do not provide D-Bus"
1979
" system bus interface")
2950
" system bus interface", default=None)
1980
2951
parser.add_argument("--no-ipv6", action="store_false",
1981
dest="use_ipv6", help="Do not use IPv6")
2952
dest="use_ipv6", help="Do not use IPv6",
1982
2954
parser.add_argument("--no-restore", action="store_false",
1983
2955
dest="restore", help="Do not restore stored"
2956
" state", default=None)
2957
parser.add_argument("--socket", type=int,
2958
help="Specify a file descriptor to a network"
2959
" socket to use instead of creating one")
1985
2960
parser.add_argument("--statedir", metavar="DIR",
1986
2961
help="Directory to save/restore state in")
2962
parser.add_argument("--foreground", action="store_true",
2963
help="Run in foreground", default=None)
2964
parser.add_argument("--no-zeroconf", action="store_false",
2965
dest="zeroconf", help="Do not use Zeroconf",
1988
2968
options = parser.parse_args()
1990
2970
if options.check:
2972
fail_count, test_count = doctest.testmod()
2973
sys.exit(os.EX_OK if fail_count == 0 else 1)
1995
2975
# Default values for config file for server-global settings
1996
server_defaults = { "interface": "",
2001
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2002
"servicename": "Mandos",
2007
"statedir": "/var/lib/mandos"
2976
if gnutls.has_rawpk:
2977
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2978
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2980
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2981
":+SIGN-DSA-SHA256")
2982
server_defaults = {"interface": "",
2986
"priority": priority,
2987
"servicename": "Mandos",
2993
"statedir": "/var/lib/mandos",
2994
"foreground": "False",
2010
2999
# Parse config file for server-global settings
2011
3000
server_config = configparser.SafeConfigParser(server_defaults)
2012
3001
del server_defaults
2013
server_config.read(os.path.join(options.configdir,
3002
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2015
3003
# Convert the SafeConfigParser object to a dict
2016
3004
server_settings = server_config.defaults()
2017
3005
# Use the appropriate methods on the non-string config options
2018
for option in ("debug", "use_dbus", "use_ipv6"):
3006
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3007
"foreground", "zeroconf"):
2019
3008
server_settings[option] = server_config.getboolean("DEFAULT",
2021
3010
if server_settings["port"]:
2022
3011
server_settings["port"] = server_config.getint("DEFAULT",
3013
if server_settings["socket"]:
3014
server_settings["socket"] = server_config.getint("DEFAULT",
3016
# Later, stdin will, and stdout and stderr might, be dup'ed
3017
# over with an opened os.devnull. But we don't want this to
3018
# happen with a supplied network socket.
3019
if 0 <= server_settings["socket"] <= 2:
3020
server_settings["socket"] = os.dup(server_settings
2024
3022
del server_config
2026
3024
# Override the settings from the config file with command line
2027
3025
# options, if set.
2028
3026
for option in ("interface", "address", "port", "debug",
2029
"priority", "servicename", "configdir",
2030
"use_dbus", "use_ipv6", "debuglevel", "restore",
3027
"priority", "servicename", "configdir", "use_dbus",
3028
"use_ipv6", "debuglevel", "restore", "statedir",
3029
"socket", "foreground", "zeroconf"):
2032
3030
value = getattr(options, option)
2033
3031
if value is not None:
2034
3032
server_settings[option] = value
2036
3034
# Force all strings to be unicode
2037
3035
for option in server_settings.keys():
2038
if type(server_settings[option]) is str:
2039
server_settings[option] = unicode(server_settings[option])
3036
if isinstance(server_settings[option], bytes):
3037
server_settings[option] = (server_settings[option]
3039
# Force all boolean options to be boolean
3040
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3041
"foreground", "zeroconf"):
3042
server_settings[option] = bool(server_settings[option])
3043
# Debug implies foreground
3044
if server_settings["debug"]:
3045
server_settings["foreground"] = True
2040
3046
# Now we have our good server settings in "server_settings"
2042
3048
##################################################################
3050
if (not server_settings["zeroconf"]
3051
and not (server_settings["port"]
3052
or server_settings["socket"] != "")):
3053
parser.error("Needs port or socket to work without Zeroconf")
2044
3055
# For convenience
2045
3056
debug = server_settings["debug"]
2046
3057
debuglevel = server_settings["debuglevel"]
2048
3059
use_ipv6 = server_settings["use_ipv6"]
2049
3060
stored_state_path = os.path.join(server_settings["statedir"],
2050
3061
stored_state_file)
3062
foreground = server_settings["foreground"]
3063
zeroconf = server_settings["zeroconf"]
2053
initlogger(logging.DEBUG)
3066
initlogger(debug, logging.DEBUG)
2055
3068
if not debuglevel:
2058
3071
level = getattr(logging, debuglevel.upper())
3072
initlogger(debug, level)
2061
3074
if server_settings["servicename"] != "Mandos":
2062
syslogger.setFormatter(logging.Formatter
2063
('Mandos (%s) [%%(process)d]:'
2064
' %%(levelname)s: %%(message)s'
2065
% server_settings["servicename"]))
3075
syslogger.setFormatter(
3076
logging.Formatter('Mandos ({}) [%(process)d]:'
3077
' %(levelname)s: %(message)s'.format(
3078
server_settings["servicename"])))
2067
3080
# Parse config file with clients
2068
client_defaults = { "timeout": "5m",
2069
"extended_timeout": "15m",
2071
"checker": "fping -q -- %%(host)s",
2073
"approval_delay": "0s",
2074
"approval_duration": "1s",
2076
client_config = configparser.SafeConfigParser(client_defaults)
3081
client_config = configparser.SafeConfigParser(Client
2077
3083
client_config.read(os.path.join(server_settings["configdir"],
2078
3084
"clients.conf"))
2080
3086
global mandos_dbus_service
2081
3087
mandos_dbus_service = None
2083
tcp_server = MandosServer((server_settings["address"],
2084
server_settings["port"]),
2086
interface=(server_settings["interface"]
2090
server_settings["priority"],
2093
pidfilename = "/var/run/mandos.pid"
2095
pidfile = open(pidfilename, "w")
2097
logger.error("Could not open file %r", pidfilename)
2100
uid = pwd.getpwnam("_mandos").pw_uid
2101
gid = pwd.getpwnam("_mandos").pw_gid
2104
uid = pwd.getpwnam("mandos").pw_uid
2105
gid = pwd.getpwnam("mandos").pw_gid
3090
if server_settings["socket"] != "":
3091
socketfd = server_settings["socket"]
3092
tcp_server = MandosServer(
3093
(server_settings["address"], server_settings["port"]),
3095
interface=(server_settings["interface"] or None),
3097
gnutls_priority=server_settings["priority"],
3101
pidfilename = "/run/mandos.pid"
3102
if not os.path.isdir("/run/."):
3103
pidfilename = "/var/run/mandos.pid"
3106
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3107
except IOError as e:
3108
logger.error("Could not open file %r", pidfilename,
3111
for name, group in (("_mandos", "_mandos"),
3112
("mandos", "mandos"),
3113
("nobody", "nogroup")):
3115
uid = pwd.getpwnam(name).pw_uid
3116
gid = pwd.getpwnam(group).pw_gid
2106
3118
except KeyError:
2108
uid = pwd.getpwnam("nobody").pw_uid
2109
gid = pwd.getpwnam("nobody").pw_gid
3127
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2116
3129
except OSError as error:
2117
if error[0] != errno.EPERM:
3130
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3131
.format(uid, gid, os.strerror(error.errno)))
3132
if error.errno != errno.EPERM:
2121
3136
# Enable all possible GnuTLS debugging
2123
3138
# "Use a log level over 10 to enable all debugging options."
2124
3139
# - GnuTLS manual
2125
gnutls.library.functions.gnutls_global_set_log_level(11)
2127
@gnutls.library.types.gnutls_log_func
3140
gnutls.global_set_log_level(11)
2128
3143
def debug_gnutls(level, string):
2129
3144
logger.debug("GnuTLS: %s", string[:-1])
2131
(gnutls.library.functions
2132
.gnutls_global_set_log_function(debug_gnutls))
3146
gnutls.global_set_log_function(debug_gnutls)
2134
3148
# Redirect stdin so all checkers get /dev/null
2135
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3149
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2136
3150
os.dup2(null, sys.stdin.fileno())
2140
# No console logging
2141
logger.removeHandler(console)
2143
3154
# Need to fork before connecting to D-Bus
2145
3156
# Close all input and output, do double fork, etc.
3159
# multiprocessing will use threads, so before we use GLib we need
3160
# to inform GLib that threads will be used.
2148
3163
global main_loop
2149
3164
# From the Avahi example code
2150
DBusGMainLoop(set_as_default=True )
2151
main_loop = gobject.MainLoop()
3165
DBusGMainLoop(set_as_default=True)
3166
main_loop = GLib.MainLoop()
2152
3167
bus = dbus.SystemBus()
2153
3168
# End of Avahi example code
2156
3171
bus_name = dbus.service.BusName("se.recompile.Mandos",
2157
bus, do_not_queue=True)
2158
old_bus_name = (dbus.service.BusName
2159
("se.bsnet.fukt.Mandos", bus,
2161
except dbus.exceptions.NameExistsException as e:
2162
logger.error(unicode(e) + ", disabling D-Bus")
3174
old_bus_name = dbus.service.BusName(
3175
"se.bsnet.fukt.Mandos", bus,
3177
except dbus.exceptions.DBusException as e:
3178
logger.error("Disabling D-Bus:", exc_info=e)
2163
3179
use_dbus = False
2164
3180
server_settings["use_dbus"] = False
2165
3181
tcp_server.use_dbus = False
2166
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2167
service = AvahiServiceToSyslog(name =
2168
server_settings["servicename"],
2169
servicetype = "_mandos._tcp",
2170
protocol = protocol, bus = bus)
2171
if server_settings["interface"]:
2172
service.interface = (if_nametoindex
2173
(str(server_settings["interface"])))
3183
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3184
service = AvahiServiceToSyslog(
3185
name=server_settings["servicename"],
3186
servicetype="_mandos._tcp",
3189
if server_settings["interface"]:
3190
service.interface = if_nametoindex(
3191
server_settings["interface"].encode("utf-8"))
2175
3193
global multiprocessing_manager
2176
3194
multiprocessing_manager = multiprocessing.Manager()
2178
3196
client_class = Client
2180
client_class = functools.partial(ClientDBusTransitional,
2183
special_settings = {
2184
# Some settings need to be accessd by special methods;
2185
# booleans need .getboolean(), etc. Here is a list of them:
2186
"approved_by_default":
2188
client_config.getboolean(section, "approved_by_default"),
2191
client_config.getboolean(section, "enabled"),
2193
# Construct a new dict of client settings of this form:
2194
# { client_name: {setting_name: value, ...}, ...}
2195
# with exceptions for any special settings as defined above
2196
client_settings = dict((clientname,
2199
if setting not in special_settings
2200
else special_settings[setting]
2202
for setting, value in
2203
client_config.items(clientname)))
2204
for clientname in client_config.sections())
3198
client_class = functools.partial(ClientDBus, bus=bus)
3200
client_settings = Client.config_parser(client_config)
2206
3201
old_client_settings = {}
3204
# This is used to redirect stdout and stderr for checker processes
3206
wnull = open(os.devnull, "w") # A writable /dev/null
3207
# Only used if server is running in foreground but not in debug
3209
if debug or not foreground:
2209
3212
# Get client data and settings from last running state.
2210
3213
if server_settings["restore"]:
2212
3215
with open(stored_state_path, "rb") as stored_state:
2213
clients_data, old_client_settings = (pickle.load
3216
if sys.version_info.major == 2:
3217
clients_data, old_client_settings = pickle.load(
3220
bytes_clients_data, bytes_old_client_settings = (
3221
pickle.load(stored_state, encoding="bytes"))
3222
# Fix bytes to strings
3225
clients_data = {(key.decode("utf-8")
3226
if isinstance(key, bytes)
3229
bytes_clients_data.items()}
3230
del bytes_clients_data
3231
for key in clients_data:
3232
value = {(k.decode("utf-8")
3233
if isinstance(k, bytes) else k): v
3235
clients_data[key].items()}
3236
clients_data[key] = value
3238
value["client_structure"] = [
3240
if isinstance(s, bytes)
3242
value["client_structure"]]
3244
for k in ("name", "host"):
3245
if isinstance(value[k], bytes):
3246
value[k] = value[k].decode("utf-8")
3247
if not value.has_key("key_id"):
3248
value["key_id"] = ""
3249
elif not value.has_key("fingerprint"):
3250
value["fingerprint"] = ""
3251
# old_client_settings
3253
old_client_settings = {
3254
(key.decode("utf-8")
3255
if isinstance(key, bytes)
3258
bytes_old_client_settings.items()}
3259
del bytes_old_client_settings
3261
for value in old_client_settings.values():
3262
if isinstance(value["host"], bytes):
3263
value["host"] = (value["host"]
2215
3265
os.remove(stored_state_path)
2216
3266
except IOError as e:
2217
logger.warning("Could not load persistent state: {0}"
2219
if e.errno != errno.ENOENT:
3267
if e.errno == errno.ENOENT:
3268
logger.warning("Could not load persistent state:"
3269
" {}".format(os.strerror(e.errno)))
3271
logger.critical("Could not load persistent state:",
3274
except EOFError as e:
3275
logger.warning("Could not load persistent state: "
2222
3279
with PGPEngine() as pgp:
2223
for client in clients_data:
2224
client_name = client["name"]
3280
for client_name, client in clients_data.items():
3281
# Skip removed clients
3282
if client_name not in client_settings:
2226
3285
# Decide which value to use after restoring saved state.
2227
3286
# We have three different values: Old config file,
2228
3287
# new config file, and saved state.
2233
3292
# For each value in new config, check if it
2234
3293
# differs from the old config value (Except for
2235
3294
# the "secret" attribute)
2236
if (name != "secret" and
2237
value != old_client_settings[client_name]
3295
if (name != "secret"
3297
old_client_settings[client_name][name])):
2239
3298
client[name] = value
2240
3299
except KeyError:
2243
3302
# Clients who has passed its expire date can still be
2244
# enabled if its last checker was sucessful. Clients
2245
# whose checker failed before we stored its state is
2246
# assumed to have failed all checkers during downtime.
3303
# enabled if its last checker was successful. A Client
3304
# whose checker succeeded before we stored its state is
3305
# assumed to have successfully run all checkers during
2247
3307
if client["enabled"]:
2248
if client["expires"] <= (datetime.datetime
2250
# Client has expired
2251
if client["last_checker_status"] != 0:
3308
if datetime.datetime.utcnow() >= client["expires"]:
3309
if not client["last_checked_ok"]:
3311
"disabling client {} - Client never "
3312
"performed a successful checker".format(
3314
client["enabled"] = False
3315
elif client["last_checker_status"] != 0:
3317
"disabling client {} - Client last"
3318
" checker failed with error code"
3321
client["last_checker_status"]))
2252
3322
client["enabled"] = False
2254
client["expires"] = (datetime.datetime
2256
+ client["timeout"])
2258
client["changedstate"] = (multiprocessing_manager
2260
(multiprocessing_manager
2263
new_client = (ClientDBusTransitional.__new__
2264
(ClientDBusTransitional))
2265
tcp_server.clients[client_name] = new_client
2266
new_client.bus = bus
2267
for name, value in client.iteritems():
2268
setattr(new_client, name, value)
2269
client_object_name = unicode(client_name).translate(
2270
{ord("."): ord("_"),
2271
ord("-"): ord("_")})
2272
new_client.dbus_object_path = (dbus.ObjectPath
2274
+ client_object_name))
2275
DBusObjectWithProperties.__init__(new_client,
2280
tcp_server.clients[client_name] = (Client.__new__
2282
for name, value in client.iteritems():
2283
setattr(tcp_server.clients[client_name],
3324
client["expires"] = (
3325
datetime.datetime.utcnow()
3326
+ client["timeout"])
3327
logger.debug("Last checker succeeded,"
3328
" keeping {} enabled".format(
2287
tcp_server.clients[client_name].secret = (
2288
pgp.decrypt(tcp_server.clients[client_name]
2290
client_settings[client_name]
3331
client["secret"] = pgp.decrypt(
3332
client["encrypted_secret"],
3333
client_settings[client_name]["secret"])
2292
3334
except PGPError:
2293
3335
# If decryption fails, we use secret from new settings
2294
logger.debug("Failed to decrypt {0} old secret"
2295
.format(client_name))
2296
tcp_server.clients[client_name].secret = (
2297
client_settings[client_name]["secret"])
2299
# Create/remove clients based on new changes made to config
2300
for clientname in set(old_client_settings) - set(client_settings):
2301
del tcp_server.clients[clientname]
2302
for clientname in set(client_settings) - set(old_client_settings):
2303
tcp_server.clients[clientname] = (client_class(name
3336
logger.debug("Failed to decrypt {} old secret".format(
3338
client["secret"] = (client_settings[client_name]
3341
# Add/remove clients based on new changes made to config
3342
for client_name in (set(old_client_settings)
3343
- set(client_settings)):
3344
del clients_data[client_name]
3345
for client_name in (set(client_settings)
3346
- set(old_client_settings)):
3347
clients_data[client_name] = client_settings[client_name]
3349
# Create all client objects
3350
for client_name, client in clients_data.items():
3351
tcp_server.clients[client_name] = client_class(
3354
server_settings=server_settings)
2309
3356
if not tcp_server.clients:
2310
3357
logger.warning("No clients defined")
2316
pidfile.write(str(pid) + "\n".encode("utf-8"))
2319
logger.error("Could not write to file %r with PID %d",
2322
# "pidfile" was never created
3360
if pidfile is not None:
3364
print(pid, file=pidfile)
3366
logger.error("Could not write to file %r with PID %d",
2324
3369
del pidfilename
2326
signal.signal(signal.SIGINT, signal.SIG_IGN)
2328
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2329
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3371
for termsig in (signal.SIGHUP, signal.SIGTERM):
3372
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3373
lambda: main_loop.quit() and False)
2332
class MandosDBusService(dbus.service.Object):
3377
@alternate_dbus_interfaces(
3378
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3379
class MandosDBusService(DBusObjectWithObjectManager):
2333
3380
"""A D-Bus proxy object"""
2334
3382
def __init__(self):
2335
3383
dbus.service.Object.__init__(self, bus, "/")
2336
3385
_interface = "se.recompile.Mandos"
2338
3387
@dbus.service.signal(_interface, signature="o")
2339
3388
def ClientAdded(self, objpath):
2343
3392
@dbus.service.signal(_interface, signature="ss")
2344
def ClientNotFound(self, fingerprint, address):
3393
def ClientNotFound(self, key_id, address):
3397
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2348
3399
@dbus.service.signal(_interface, signature="os")
2349
3400
def ClientRemoved(self, objpath, name):
3404
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2353
3406
@dbus.service.method(_interface, out_signature="ao")
2354
3407
def GetAllClients(self):
2356
return dbus.Array(c.dbus_object_path
2358
tcp_server.clients.itervalues())
3409
return dbus.Array(c.dbus_object_path for c in
3410
tcp_server.clients.values())
3412
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2360
3414
@dbus.service.method(_interface,
2361
3415
out_signature="a{oa{sv}}")
2362
3416
def GetAllClientsWithProperties(self):
2364
3418
return dbus.Dictionary(
2365
((c.dbus_object_path, c.GetAll(""))
2366
for c in tcp_server.clients.itervalues()),
3419
{c.dbus_object_path: c.GetAll(
3420
"se.recompile.Mandos.Client")
3421
for c in tcp_server.clients.values()},
2367
3422
signature="oa{sv}")
2369
3424
@dbus.service.method(_interface, in_signature="o")
2370
3425
def RemoveClient(self, object_path):
2372
for c in tcp_server.clients.itervalues():
3427
for c in tcp_server.clients.values():
2373
3428
if c.dbus_object_path == object_path:
2374
3429
del tcp_server.clients[c.name]
2375
3430
c.remove_from_connection()
2376
# Don't signal anything except ClientRemoved
3431
# Don't signal the disabling
2377
3432
c.disable(quiet=True)
2379
self.ClientRemoved(object_path, c.name)
3433
# Emit D-Bus signal for removal
3434
self.client_removed_signal(c)
2381
3436
raise KeyError(object_path)
2385
class MandosDBusServiceTransitional(MandosDBusService):
2386
__metaclass__ = AlternateDBusNamesMetaclass
2387
mandos_dbus_service = MandosDBusServiceTransitional()
3440
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3441
out_signature="a{oa{sa{sv}}}")
3442
def GetManagedObjects(self):
3444
return dbus.Dictionary(
3445
{client.dbus_object_path:
3447
{interface: client.GetAll(interface)
3449
client._get_all_interface_names()})
3450
for client in tcp_server.clients.values()})
3452
def client_added_signal(self, client):
3453
"""Send the new standard signal and the old signal"""
3455
# New standard signal
3456
self.InterfacesAdded(
3457
client.dbus_object_path,
3459
{interface: client.GetAll(interface)
3461
client._get_all_interface_names()}))
3463
self.ClientAdded(client.dbus_object_path)
3465
def client_removed_signal(self, client):
3466
"""Send the new standard signal and the old signal"""
3468
# New standard signal
3469
self.InterfacesRemoved(
3470
client.dbus_object_path,
3471
client._get_all_interface_names())
3473
self.ClientRemoved(client.dbus_object_path,
3476
mandos_dbus_service = MandosDBusService()
3478
# Save modules to variables to exempt the modules from being
3479
# unloaded before the function registered with atexit() is run.
3480
mp = multiprocessing
2390
3484
"Cleanup function; run on exit"
2393
multiprocessing.active_children()
3488
mp.active_children()
2394
3490
if not (tcp_server.clients or client_settings):
2397
3493
# Store client before exiting. Secrets are encrypted with key
2398
3494
# based on what config file has. If config file is
2399
3495
# removed/edited, old secret will thus be unrecovable.
2401
3497
with PGPEngine() as pgp:
2402
for client in tcp_server.clients.itervalues():
3498
for client in tcp_server.clients.values():
2403
3499
key = client_settings[client.name]["secret"]
2404
3500
client.encrypted_secret = pgp.encrypt(client.secret,
2406
3502
client_dict = {}
2408
# A list of attributes that will not be stored when
2410
exclude = set(("bus", "changedstate", "secret"))
2411
for name, typ in (inspect.getmembers
2412
(dbus.service.Object)):
3504
# A list of attributes that can not be pickled
3506
exclude = {"bus", "changedstate", "secret",
3507
"checker", "server_settings"}
3508
for name, typ in inspect.getmembers(dbus.service
2413
3510
exclude.add(name)
2415
3512
client_dict["encrypted_secret"] = (client
2416
3513
.encrypted_secret)
2417
3514
for attr in client.client_structure:
2418
3515
if attr not in exclude:
2419
3516
client_dict[attr] = getattr(client, attr)
2421
clients.append(client_dict)
3518
clients[client.name] = client_dict
2422
3519
del client_settings[client.name]["secret"]
2425
with os.fdopen(os.open(stored_state_path,
2426
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2427
0600), "wb") as stored_state:
2428
pickle.dump((clients, client_settings), stored_state)
3522
with tempfile.NamedTemporaryFile(
3526
dir=os.path.dirname(stored_state_path),
3527
delete=False) as stored_state:
3528
pickle.dump((clients, client_settings), stored_state,
3530
tempname = stored_state.name
3531
os.rename(tempname, stored_state_path)
2429
3532
except (IOError, OSError) as e:
2430
logger.warning("Could not save persistent state: {0}"
2432
if e.errno not in (errno.ENOENT, errno.EACCES):
3538
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3539
logger.warning("Could not save persistent state: {}"
3540
.format(os.strerror(e.errno)))
3542
logger.warning("Could not save persistent state:",
2435
3546
# Delete all clients, and settings from config
2436
3547
while tcp_server.clients:
2437
3548
name, client = tcp_server.clients.popitem()
2439
3550
client.remove_from_connection()
2440
# Don't signal anything except ClientRemoved
3551
# Don't signal the disabling
2441
3552
client.disable(quiet=True)
3553
# Emit D-Bus signal for removal
2444
mandos_dbus_service.ClientRemoved(client
3555
mandos_dbus_service.client_removed_signal(client)
2447
3556
client_settings.clear()
2449
3558
atexit.register(cleanup)
2451
for client in tcp_server.clients.itervalues():
3560
for client in tcp_server.clients.values():
2454
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3562
# Emit D-Bus signal for adding
3563
mandos_dbus_service.client_added_signal(client)
2455
3564
# Need to initiate checking of clients
2456
3565
if client.enabled:
2457
3566
client.init_checker()
2459
3568
tcp_server.enable()
2460
3569
tcp_server.server_activate()
2462
3571
# Find out what port we got
2463
service.port = tcp_server.socket.getsockname()[1]
3573
service.port = tcp_server.socket.getsockname()[1]
2465
3575
logger.info("Now listening on address %r, port %d,"
2466
" flowinfo %d, scope_id %d"
2467
% tcp_server.socket.getsockname())
3576
" flowinfo %d, scope_id %d",
3577
*tcp_server.socket.getsockname())
2469
logger.info("Now listening on address %r, port %d"
2470
% tcp_server.socket.getsockname())
2472
#service.interface = tcp_server.socket.getsockname()[3]
3579
logger.info("Now listening on address %r, port %d",
3580
*tcp_server.socket.getsockname())
3582
# service.interface = tcp_server.socket.getsockname()[3]
2475
# From the Avahi example code
2478
except dbus.exceptions.DBusException as error:
2479
logger.critical("DBusException: %s", error)
2482
# End of Avahi example code
2484
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2485
lambda *args, **kwargs:
2486
(tcp_server.handle_request
2487
(*args[2:], **kwargs) or True))
3586
# From the Avahi example code
3589
except dbus.exceptions.DBusException as error:
3590
logger.critical("D-Bus Exception", exc_info=error)
3593
# End of Avahi example code
3595
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3596
lambda *args, **kwargs:
3597
(tcp_server.handle_request
3598
(*args[2:], **kwargs) or True))
2489
3600
logger.debug("Starting main loop")
2490
3601
main_loop.run()
2491
3602
except AvahiError as error:
2492
logger.critical("AvahiError: %s", error)
3603
logger.critical("Avahi Error", exc_info=error)
2495
3606
except KeyboardInterrupt: