226
167
os.rmdir(self.tempdir)
227
168
self.tempdir = None
229
170
def password_encode(self, password):
230
171
# Passphrase can not be empty and can not contain newlines or
231
172
# NUL bytes. So we prefix it and hex encode it.
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"))
173
return b"mandos" + binascii.hexlify(password)
240
175
def encrypt(self, data, password):
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:
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
256
190
return ciphertext
258
192
def decrypt(self, data, password):
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:
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
274
207
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
303
211
class AvahiError(Exception):
304
212
def __init__(self, value, *args, **kwargs):
305
213
self.value = value
306
return super(AvahiError, self).__init__(value, *args,
214
super(AvahiError, self).__init__(value, *args, **kwargs)
215
def __unicode__(self):
216
return unicode(repr(self.value))
310
218
class AvahiServiceError(AvahiError):
314
221
class AvahiGroupError(AvahiError):
318
225
class AvahiService(object):
319
226
"""An Avahi (Zeroconf) service.
322
229
interface: integer; avahi.IF_UNSPEC or an interface index.
323
230
Used to optionally bind to the specified interface.
324
231
name: string; Example: 'Mandos'
325
232
type: string; Example: '_mandos._tcp'.
326
See <https://www.iana.org/assignments/service-names-port-numbers>
233
See <http://www.dns-sd.org/ServiceTypes.html>
327
234
port: integer; what port to announce
328
235
TXT: list of strings; TXT record for the service
329
236
domain: string; Domain to publish on, default to .local if empty.
488
365
follow_name_owner_changes=True),
489
366
avahi.DBUS_INTERFACE_SERVER)
490
367
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
368
self.server_state_changed)
492
369
self.server_state_changed(self.server.GetState())
495
371
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
373
"""Add the new name to the syslog messages"""
498
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
374
ret = AvahiService.rename(self)
375
syslogger.setFormatter(logging.Formatter
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
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))
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))
817
387
class Client(object):
818
388
"""A representation of a client host served by this server.
821
391
approved: bool(); 'None' if not yet approved/disapproved
822
392
approval_delay: datetime.timedelta(); Time to wait for approval
824
394
checker: subprocess.Popen(); a running checker process used
825
395
to see if the client lives.
826
396
'None' if no process is running.
827
checker_callback_tag: a GLib event source tag, or None
397
checker_callback_tag: a gobject event source tag, or None
828
398
checker_command: string; External command which is run to check
829
399
if client lives. %() expansions are done at
830
400
runtime with vars(self) as dict, so that for
831
401
instance %(name)s can be used in the command.
832
checker_initiator_tag: a GLib event source tag, or None
402
checker_initiator_tag: a gobject event source tag, or None
833
403
created: datetime.datetime(); (UTC) object creation
834
404
client_structure: Object describing what attributes a client has
835
405
and is used for storing the client at exit
836
406
current_checker_command: string; current running checker_command
837
disable_initiator_tag: a GLib event source tag, or None
407
disable_initiator_tag: a gobject event source tag, or None
839
409
fingerprint: string (40 or 32 hexadecimal digits); used to
840
uniquely identify an OpenPGP client
841
key_id: string (64 hexadecimal digits); used to uniquely identify
842
a client using raw public keys
410
uniquely identify the client
843
411
host: string; available for use by the checker command
844
412
interval: datetime.timedelta(); How often to start a new checker
845
413
last_approval_request: datetime.datetime(); (UTC) or None
846
414
last_checked_ok: datetime.datetime(); (UTC) or None
847
416
last_checker_status: integer between 0 and 255 reflecting exit
848
417
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
852
419
last_enabled: datetime.datetime(); (UTC) or None
853
420
name: string; from the config file, used in log messages and
854
421
D-Bus identifiers
855
422
secret: bytestring; sent verbatim (over TLS) to client
856
423
timeout: datetime.timedelta(); How long from last_checked_ok
857
424
until this client is disabled
858
extended_timeout: extra long timeout when secret has been sent
425
extended_timeout: extra long timeout when password has been sent
859
426
runtime_expansions: Allowed attributes for runtime expansion.
860
427
expires: datetime.datetime(); time (UTC) when a client will be
861
428
disabled, or None
862
server_settings: The server_settings dict from main()
865
431
runtime_expansions = ("approval_delay", "approval_duration",
866
"created", "enabled", "expires", "key_id",
867
"fingerprint", "host", "interval",
868
"last_approval_request", "last_checked_ok",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
869
434
"last_enabled", "name", "timeout")
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):
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'
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
955
458
logger.debug("Creating client %r", self.name)
956
logger.debug(" Key ID: %s", self.key_id)
459
# Uppercase and remove spaces from fingerprint for later
460
# comparison purposes with return value from the fingerprint()
462
self.fingerprint = (config["fingerprint"].upper()
957
464
logger.debug(" Fingerprint: %s", self.fingerprint)
958
self.created = settings.get("created",
959
datetime.datetime.utcnow())
961
# attributes specific for this server instance
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"])
962
489
self.checker = None
963
490
self.checker_initiator_tag = None
964
491
self.disable_initiator_tag = None
493
self.expires = datetime.datetime.utcnow() + self.timeout
965
496
self.checker_callback_tag = None
497
self.checker_command = config["checker"]
966
498
self.current_checker_command = None
967
499
self.approved = None
500
self.approved_by_default = config.get("approved_by_default",
968
502
self.approvals_pending = 0
969
self.changedstate = multiprocessing_manager.Condition(
970
multiprocessing_manager.Lock())
971
self.client_structure = [attr
972
for attr in self.__dict__.keys()
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()
973
512
if not attr.startswith("_")]
974
513
self.client_structure.append("client_structure")
976
for name, t in inspect.getmembers(
977
type(self), lambda obj: isinstance(obj, property)):
515
for name, t in inspect.getmembers(type(self),
978
519
if not name.startswith("_"):
979
520
self.client_structure.append(name)
981
522
# Send notice to process children that client state has changed
982
523
def send_changedstate(self):
983
524
with self.changedstate:
984
525
self.changedstate.notify_all()
986
527
def enable(self):
987
528
"""Start this client's checker and timeout hooks"""
988
529
if getattr(self, "enabled", False):
989
530
# Already enabled
532
self.send_changedstate()
991
533
self.expires = datetime.datetime.utcnow() + self.timeout
992
534
self.enabled = True
993
535
self.last_enabled = datetime.datetime.utcnow()
994
536
self.init_checker()
995
self.send_changedstate()
997
538
def disable(self, quiet=True):
998
539
"""Disable this client."""
999
540
if not getattr(self, "enabled", False):
543
self.send_changedstate()
1002
545
logger.info("Disabling client %s", self.name)
1003
if getattr(self, "disable_initiator_tag", None) is not None:
1004
GLib.source_remove(self.disable_initiator_tag)
546
if getattr(self, "disable_initiator_tag", False):
547
gobject.source_remove(self.disable_initiator_tag)
1005
548
self.disable_initiator_tag = None
1006
549
self.expires = None
1007
if getattr(self, "checker_initiator_tag", None) is not None:
1008
GLib.source_remove(self.checker_initiator_tag)
550
if getattr(self, "checker_initiator_tag", False):
551
gobject.source_remove(self.checker_initiator_tag)
1009
552
self.checker_initiator_tag = None
1010
553
self.stop_checker()
1011
554
self.enabled = False
1013
self.send_changedstate()
1014
# Do not run this again if called by a GLib.timeout_add
555
# Do not run this again if called by a gobject.timeout_add
1017
558
def __del__(self):
1020
561
def init_checker(self):
1021
562
# Schedule a new checker to be started an 'interval' from now,
1022
563
# and every interval from then on.
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),
564
self.checker_initiator_tag = (gobject.timeout_add
565
(self.interval_milliseconds(),
1028
567
# Schedule a disable() when 'timeout' has passed
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)
568
self.disable_initiator_tag = (gobject.timeout_add
569
(self.timeout_milliseconds(),
1033
571
# Also start a new checker *right now*.
1034
572
self.start_checker()
1036
def checker_callback(self, source, condition, connection,
574
def checker_callback(self, pid, condition, command):
1038
575
"""The checker has completed, so take appropriate actions."""
1039
576
self.checker_callback_tag = None
1040
577
self.checker = None
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
578
if os.WIFEXITED(condition):
579
self.last_checker_status = os.WEXITSTATUS(condition)
1048
580
if self.last_checker_status == 0:
1049
581
logger.info("Checker for %(name)s succeeded",
1051
583
self.checked_ok()
1053
logger.info("Checker for %(name)s failed", vars(self))
585
logger.info("Checker for %(name)s failed",
1055
588
self.last_checker_status = -1
1056
self.last_checker_signal = -returncode
1057
589
logger.warning("Checker for %(name)s crashed?",
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."""
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,
1070
598
if timeout is None:
1071
599
timeout = self.timeout
600
self.last_checked_ok = datetime.datetime.utcnow()
1072
601
if self.disable_initiator_tag is not None:
1073
GLib.source_remove(self.disable_initiator_tag)
1074
self.disable_initiator_tag = None
602
gobject.source_remove(self.disable_initiator_tag)
1075
603
if getattr(self, "enabled", False):
1076
self.disable_initiator_tag = GLib.timeout_add(
1077
int(timeout.total_seconds() * 1000), self.disable)
604
self.disable_initiator_tag = (gobject.timeout_add
605
(timedelta_to_milliseconds
606
(timeout), self.disable))
1078
607
self.expires = datetime.datetime.utcnow() + timeout
1080
609
def need_approval(self):
1081
610
self.last_approval_request = datetime.datetime.utcnow()
1083
612
def start_checker(self):
1084
613
"""Start a new checker subprocess if one is not running.
1086
615
If a checker already exists, leave it running and do
1088
617
# The reason for not killing a running checker is that if we
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
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
1093
622
# checkers alone, the checker would have to take more time
1094
623
# than 'timeout' for the client to be disabled, which is as it
1097
if self.checker is not None and not self.checker.is_alive():
1098
logger.warning("Checker was not alive; joining")
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)
1101
639
# Start a new checker if needed
1102
640
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}
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
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
1114
660
self.current_checker_command = command
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
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
1143
687
def stop_checker(self):
1144
688
"""Force the checker process, if any, to stop."""
1145
689
if self.checker_callback_tag:
1146
GLib.source_remove(self.checker_callback_tag)
690
gobject.source_remove(self.checker_callback_tag)
1147
691
self.checker_callback_tag = None
1148
692
if getattr(self, "checker", None) is None:
1150
694
logger.debug("Stopping checker for %(name)s", vars(self))
1151
self.checker.terminate()
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
1152
703
self.checker = None
1155
def dbus_service_property(dbus_interface,
706
def dbus_service_property(dbus_interface, signature="v",
707
access="readwrite", byte_arrays=False):
1159
708
"""Decorators for marking methods of a DBusObjectWithProperties to
1160
709
become properties on the D-Bus.
1162
711
The decorated method will be called with no arguments by "Get"
1163
712
and with one argument by "Set".
1165
714
The parameters, where they are supported, are the same as
1166
715
dbus.service.method, except there is only "signature", since the
1167
716
type from Get() and the type sent to Set() is the same.
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):
755
class DBusObjectWithProperties(dbus.service.Object):
1340
756
"""A D-Bus object with properties.
1342
758
Classes inheriting from this can use the dbus_service_property
1343
759
decorator to expose methods as D-Bus properties. It exposes the
1344
760
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))
1347
775
def _get_dbus_property(self, interface_name, property_name):
1348
776
"""Returns a bound method if one exists which is a D-Bus
1349
777
property with the specified name and interface.
1351
for cls in self.__class__.__mro__:
1352
for name, value in inspect.getmembers(
1353
cls, self._is_dbus_thing("property")):
779
for cls in self.__class__.__mro__:
780
for name, value in (inspect.getmembers
781
(cls, self._is_dbus_property)):
1354
782
if (value._dbus_name == property_name
1355
783
and value._dbus_interface == interface_name):
1356
784
return value.__get__(self)
1358
786
# No such property
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,
787
raise DBusPropertyNotFound(self.dbus_object_path + ":"
788
+ interface_name + "."
791
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1373
792
out_signature="v")
1374
793
def Get(self, interface_name, property_name):
1375
794
"""Standard D-Bus property Get() method, see D-Bus standard.
1500
886
except (AttributeError, xml.dom.DOMException,
1501
887
xml.parsers.expat.ExpatError) as error:
1502
888
logger.error("Failed to override Introspection method",
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):
893
def datetime_to_dbus (dt, variant_level=0):
1579
894
"""Convert a UTC datetime.datetime() to a D-Bus type."""
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).
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.
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):
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):
1616
913
# Ignore non-D-Bus attributes, and D-Bus attributes
1617
914
# with the wrong interface name
1618
915
if (not hasattr(attribute, "_dbus_interface")
1619
or not attribute._dbus_interface.startswith(
1620
orig_interface_name)):
916
or not attribute._dbus_interface
917
.startswith("se.recompile.Mandos")):
1622
919
# Create an alternate D-Bus interface name based on
1623
920
# the current name
1624
alt_interface = attribute._dbus_interface.replace(
1625
orig_interface_name, alt_interface_name)
1626
interface_names.add(alt_interface)
921
alt_interface = (attribute._dbus_interface
922
.replace("se.recompile.Mandos",
923
"se.bsnet.fukt.Mandos"))
1627
924
# Is this a D-Bus signal?
1628
925
if getattr(attribute, "_dbus_is_signal", False):
1629
# Extract the original non-method undecorated
1630
# function by black magic
1631
if sys.version_info.major == 2:
1632
nonmethod_func = (dict(
926
# Extract the original non-method function by
928
nonmethod_func = (dict(
1633
929
zip(attribute.func_code.co_freevars,
1634
attribute.__closure__))
1635
["func"].cell_contents)
1637
nonmethod_func = (dict(
1638
zip(attribute.__code__.co_freevars,
1639
attribute.__closure__))
1640
["func"].cell_contents)
930
attribute.__closure__))["func"]
1641
932
# Create a new, but exactly alike, function
1642
933
# object, and decorate it to be a new D-Bus signal
1643
934
# with the alternate D-Bus interface name
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:
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)))
1655
944
# Define a creator of a function to call both the
1656
# original and alternate functions, so both the
1657
# original and alternate signals gets sent when
1658
# the function is called
945
# old and new functions, so both the old and new
946
# signals gets sent when the function is called
1659
947
def fixscope(func1, func2):
1660
948
"""This function is a scope container to pass
1661
949
func1 and func2 to the "call_both" function
1662
950
outside of its arguments"""
1664
@functools.wraps(func2)
1665
951
def call_both(*args, **kwargs):
1666
952
"""This function will emit two D-Bus
1667
953
signals by calling func1 and func2"""
1668
954
func1(*args, **kwargs)
1669
955
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)
1676
956
return call_both
1677
957
# Create the "call_both" function and add it to
1679
attr[attrname] = fixscope(attribute, new_function)
959
attr[attrname] = fixscope(attribute,
1680
961
# Is this a D-Bus method?
1681
962
elif getattr(attribute, "_dbus_is_method", False):
1682
963
# Create a new, but exactly alike, function
1683
964
# object. Decorate it to be a new D-Bus method
1684
965
# with the alternate D-Bus interface name. Add it
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:
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)))
1698
977
# Is this a D-Bus property?
1699
978
elif getattr(attribute, "_dbus_is_property", False):
1700
979
# Create a new, but exactly alike, function
1701
980
# object, and decorate it to be a new D-Bus
1702
981
# property with the alternate D-Bus interface
1703
982
# name. Add it to the class.
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"})
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)
1756
999
class ClientDBus(Client, DBusObjectWithProperties):
1757
1000
"""A Client class using D-Bus
1760
1003
dbus_object_path: dbus.ObjectPath
1761
1004
bus: dbus.SystemBus()
1764
1007
runtime_expansions = (Client.runtime_expansions
1765
+ ("dbus_object_path", ))
1767
_interface = "se.recompile.Mandos.Client"
1008
+ ("dbus_object_path",))
1769
1010
# dbus.service.Object doesn't use super(), so we can't either.
1771
def __init__(self, bus=None, *args, **kwargs):
1012
def __init__(self, bus = None, *args, **kwargs):
1773
1014
Client.__init__(self, *args, **kwargs)
1016
self._approvals_pending = 0
1774
1017
# Only now, when this client is initialized, can it show up on
1776
client_object_name = str(self.name).translate(
1019
client_object_name = unicode(self.name).translate(
1777
1020
{ord("."): ord("_"),
1778
1021
ord("-"): ord("_")})
1779
self.dbus_object_path = dbus.ObjectPath(
1780
"/clients/" + client_object_name)
1022
self.dbus_object_path = (dbus.ObjectPath
1023
("/clients/" + client_object_name))
1781
1024
DBusObjectWithProperties.__init__(self, self.bus,
1782
1025
self.dbus_object_path)
1784
def notifychangeproperty(transform_func, dbus_name,
1785
type_func=lambda x: x,
1787
invalidate_only=False,
1788
_interface=_interface):
1027
def notifychangeproperty(transform_func,
1028
dbus_name, type_func=lambda x: x,
1789
1030
""" Modify a variable so that it's a property which announces
1790
1031
its changes to DBus.
1792
1033
transform_fun: Function that takes a value and a variant_level
1793
1034
and transforms it to a D-Bus type.
1794
1035
dbus_name: D-Bus name of the variable
1946
1176
server to mandos-client
1950
1180
# Rejected - signal
1951
1181
@dbus.service.signal(_interface, signature="s")
1952
1182
def Rejected(self, reason):
1956
1186
# NeedApproval - signal
1957
1187
@dbus.service.signal(_interface, signature="tb")
1958
1188
def NeedApproval(self, timeout, default):
1960
1190
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.
1964
1202
# Approve - method
1965
1203
@dbus.service.method(_interface, in_signature="b")
1966
1204
def Approve(self, value):
1967
1205
self.approve(value)
1969
1207
# CheckedOK - method
1970
1208
@dbus.service.method(_interface)
1971
1209
def CheckedOK(self):
1972
1210
self.checked_ok()
1974
1212
# Enable - method
1975
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1976
1213
@dbus.service.method(_interface)
1977
1214
def Enable(self):
1981
1218
# StartChecker - method
1982
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1983
1219
@dbus.service.method(_interface)
1984
1220
def StartChecker(self):
1986
1222
self.start_checker()
1988
1224
# Disable - method
1989
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1990
1225
@dbus.service.method(_interface)
1991
1226
def Disable(self):
1995
1230
# StopChecker - method
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
1231
@dbus.service.method(_interface)
1998
1232
def StopChecker(self):
1999
1233
self.stop_checker()
2003
1237
# ApprovalPending - property
2004
1238
@dbus_service_property(_interface, signature="b", access="read")
2005
1239
def ApprovalPending_dbus_property(self):
2006
1240
return dbus.Boolean(bool(self.approvals_pending))
2008
1242
# ApprovedByDefault - property
2009
@dbus_service_property(_interface,
1243
@dbus_service_property(_interface, signature="b",
2011
1244
access="readwrite")
2012
1245
def ApprovedByDefault_dbus_property(self, value=None):
2013
1246
if value is None: # get
2014
1247
return dbus.Boolean(self.approved_by_default)
2015
1248
self.approved_by_default = bool(value)
2017
1250
# ApprovalDelay - property
2018
@dbus_service_property(_interface,
1251
@dbus_service_property(_interface, signature="t",
2020
1252
access="readwrite")
2021
1253
def ApprovalDelay_dbus_property(self, value=None):
2022
1254
if value is None: # get
2023
return dbus.UInt64(self.approval_delay.total_seconds()
1255
return dbus.UInt64(self.approval_delay_milliseconds())
2025
1256
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2027
1258
# ApprovalDuration - property
2028
@dbus_service_property(_interface,
1259
@dbus_service_property(_interface, signature="t",
2030
1260
access="readwrite")
2031
1261
def ApprovalDuration_dbus_property(self, value=None):
2032
1262
if value is None: # get
2033
return dbus.UInt64(self.approval_duration.total_seconds()
1263
return dbus.UInt64(timedelta_to_milliseconds(
1264
self.approval_duration))
2035
1265
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2037
1267
# Name - property
2039
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2040
1268
@dbus_service_property(_interface, signature="s", access="read")
2041
1269
def Name_dbus_property(self):
2042
1270
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)
2051
1272
# Fingerprint - property
2053
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2054
1273
@dbus_service_property(_interface, signature="s", access="read")
2055
1274
def Fingerprint_dbus_property(self):
2056
1275
return dbus.String(self.fingerprint)
2058
1277
# Host - property
2059
@dbus_service_property(_interface,
1278
@dbus_service_property(_interface, signature="s",
2061
1279
access="readwrite")
2062
1280
def Host_dbus_property(self, value=None):
2063
1281
if value is None: # get
2064
1282
return dbus.String(self.host)
2065
self.host = str(value)
1283
self.host = unicode(value)
2067
1285
# Created - property
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
1286
@dbus_service_property(_interface, signature="s", access="read")
2071
1287
def Created_dbus_property(self):
2072
1288
return datetime_to_dbus(self.created)
2074
1290
# LastEnabled - property
2075
1291
@dbus_service_property(_interface, signature="s", access="read")
2076
1292
def LastEnabled_dbus_property(self):
2077
1293
return datetime_to_dbus(self.last_enabled)
2079
1295
# Enabled - property
2080
@dbus_service_property(_interface,
1296
@dbus_service_property(_interface, signature="b",
2082
1297
access="readwrite")
2083
1298
def Enabled_dbus_property(self, value=None):
2084
1299
if value is None: # get
2091
1306
# LastCheckedOK - property
2092
@dbus_service_property(_interface,
1307
@dbus_service_property(_interface, signature="s",
2094
1308
access="readwrite")
2095
1309
def LastCheckedOK_dbus_property(self, value=None):
2096
1310
if value is not None:
2097
1311
self.checked_ok()
2099
1313
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)
2106
1315
# Expires - property
2107
1316
@dbus_service_property(_interface, signature="s", access="read")
2108
1317
def Expires_dbus_property(self):
2109
1318
return datetime_to_dbus(self.expires)
2111
1320
# LastApprovalRequest - property
2112
1321
@dbus_service_property(_interface, signature="s", access="read")
2113
1322
def LastApprovalRequest_dbus_property(self):
2114
1323
return datetime_to_dbus(self.last_approval_request)
2116
1325
# Timeout - property
2117
@dbus_service_property(_interface,
1326
@dbus_service_property(_interface, signature="t",
2119
1327
access="readwrite")
2120
1328
def Timeout_dbus_property(self, value=None):
2121
1329
if value is None: # get
2122
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2123
old_timeout = self.timeout
1330
return dbus.UInt64(self.timeout_milliseconds())
2124
1331
self.timeout = datetime.timedelta(0, 0, 0, value)
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),
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))
2141
1353
# ExtendedTimeout - property
2142
@dbus_service_property(_interface,
1354
@dbus_service_property(_interface, signature="t",
2144
1355
access="readwrite")
2145
1356
def ExtendedTimeout_dbus_property(self, value=None):
2146
1357
if value is None: # get
2147
return dbus.UInt64(self.extended_timeout.total_seconds()
1358
return dbus.UInt64(self.extended_timeout_milliseconds())
2149
1359
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2151
1361
# Interval - property
2152
@dbus_service_property(_interface,
1362
@dbus_service_property(_interface, signature="t",
2154
1363
access="readwrite")
2155
1364
def Interval_dbus_property(self, value=None):
2156
1365
if value is None: # get
2157
return dbus.UInt64(self.interval.total_seconds() * 1000)
1366
return dbus.UInt64(self.interval_milliseconds())
2158
1367
self.interval = datetime.timedelta(0, 0, 0, value)
2159
1368
if getattr(self, "checker_initiator_tag", None) is None:
2161
1370
if self.enabled:
2162
1371
# Reschedule checker run
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
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
2168
1377
# Checker - property
2169
@dbus_service_property(_interface,
1378
@dbus_service_property(_interface, signature="s",
2171
1379
access="readwrite")
2172
1380
def Checker_dbus_property(self, value=None):
2173
1381
if value is None: # get
2174
1382
return dbus.String(self.checker_command)
2175
self.checker_command = str(value)
1383
self.checker_command = unicode(value)
2177
1385
# CheckerRunning - property
2178
@dbus_service_property(_interface,
1386
@dbus_service_property(_interface, signature="b",
2180
1387
access="readwrite")
2181
1388
def CheckerRunning_dbus_property(self, value=None):
2182
1389
if value is None: # get
2223
1422
if data[0] == 'data':
2225
1424
if data[0] == 'function':
2227
1425
def func(*args, **kwargs):
2228
1426
self._pipe.send(('funcall', name, args, kwargs))
2229
1427
return self._pipe.recv()[1]
2233
1430
def __setattr__(self, name, value):
2234
1431
if name == '_pipe':
2235
1432
return super(ProxyClient, self).__setattr__(name, value)
2236
1433
self._pipe.send(('setattr', name, value))
1436
class ClientDBusTransitional(ClientDBus):
1437
__metaclass__ = AlternateDBusNamesMetaclass
2239
1440
class ClientHandler(socketserver.BaseRequestHandler, object):
2240
1441
"""A class to handle client connections.
2242
1443
Instantiated once for each connection to handle it.
2243
1444
Note: This will run in its own forked process."""
2245
1446
def handle(self):
2246
1447
with contextlib.closing(self.server.child_pipe) as child_pipe:
2247
1448
logger.info("TCP connection from: %s",
2248
str(self.client_address))
1449
unicode(self.client_address))
2249
1450
logger.debug("Pipe FD: %d",
2250
1451
self.server.child_pipe.fileno())
2252
session = gnutls.ClientSession(self.request)
2254
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2255
# "+AES-256-CBC", "+SHA1",
2256
# "+COMP-NULL", "+CTYPE-OPENPGP",
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",
2258
1467
# Use a fallback default, since this MUST be set.
2259
1468
priority = self.server.gnutls_priority
2260
1469
if priority is None:
2261
1470
priority = "NORMAL"
2262
gnutls.priority_set_direct(session._c_object,
2263
priority.encode("utf-8"),
1471
(gnutls.library.functions
1472
.gnutls_priority_set_direct(session._c_object,
2266
1475
# Start communication using the Mandos protocol
2267
1476
# Get protocol number
2268
1477
line = self.request.makefile().readline()
2269
1478
logger.debug("Protocol version: %r", line)
2271
1480
if int(line.strip().split()[0]) > 1:
2272
raise RuntimeError(line)
2273
1482
except (ValueError, IndexError, RuntimeError) as error:
2274
1483
logger.error("Unknown protocol version: %s", error)
2277
1486
# Start GnuTLS connection
2279
1488
session.handshake()
2280
except gnutls.Error as error:
1489
except gnutls.errors.GNUTLSError as error:
2281
1490
logger.warning("Handshake failed: %s", error)
2282
1491
# Do not run session.bye() here: the session is not
2283
1492
# established. Just abandon the request.
2285
1494
logger.debug("Handshake succeeded")
2287
1496
approval_required = False
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,
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,
2311
1509
self.client_address)
2312
1510
except KeyError:
1513
if self.server.use_dbus:
1515
client.NewRequest(str(self.client_address))
2315
1517
if client.approval_delay:
2316
1518
delay = client.approval_delay
2317
1519
client.approvals_pending += 1
2318
1520
approval_required = True
2321
1523
if not client.enabled:
2322
1524
logger.info("Client %s is disabled",
2324
1526
if self.server.use_dbus:
2325
1527
# Emit D-Bus signal
2326
1528
client.Rejected("Disabled")
2329
1531
if client.approved or not client.approval_delay:
2330
# We are approved or approval is disabled
1532
#We are approved or approval is disabled
2332
1534
elif client.approved is None:
2333
1535
logger.info("Client %s needs approval",
2366
1570
delay -= time2 - time
2369
session.send(client.secret)
2370
except gnutls.Error as error:
2371
logger.warning("gnutls send failed",
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))
2375
1584
logger.info("Sending secret to %s", client.name)
2376
1585
# bump the timeout using extended_timeout
2377
client.bump_timeout(client.extended_timeout)
1586
client.checked_ok(client.extended_timeout)
2378
1587
if self.server.use_dbus:
2379
1588
# Emit D-Bus signal
2380
1589
client.GotSecret()
2383
1592
if approval_required:
2384
1593
client.approvals_pending -= 1
2387
except gnutls.Error as error:
2388
logger.warning("GnuTLS bye failed",
1596
except gnutls.errors.GNUTLSError as error:
1597
logger.warning("GnuTLS bye failed")
2392
1600
def peer_certificate(session):
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
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
2409
1608
list_size = ctypes.c_uint(1)
2410
cert_list = (gnutls.certificate_get_peers
1609
cert_list = (gnutls.library.functions
1610
.gnutls_certificate_get_peers
2411
1611
(session._c_object, ctypes.byref(list_size)))
2412
1612
if not bool(cert_list) and list_size.value != 0:
2413
raise gnutls.Error("error getting peer certificate")
1613
raise gnutls.errors.GNUTLSError("error getting peer"
2414
1615
if list_size.value == 0:
2416
1617
cert = cert_list[0]
2417
1618
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()
2454
1621
def fingerprint(openpgp):
2455
1622
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2456
1623
# New GnuTLS "datum" with the OpenPGP public key
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)))
1624
datum = (gnutls.library.types
1625
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1628
ctypes.c_uint(len(openpgp))))
2461
1629
# New empty GnuTLS certificate
2462
crt = gnutls.openpgp_crt_t()
2463
gnutls.openpgp_crt_init(ctypes.byref(crt))
1630
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1631
(gnutls.library.functions
1632
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2464
1633
# Import the OpenPGP public key into the certificate
2465
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2466
gnutls.OPENPGP_FMT_RAW)
1634
(gnutls.library.functions
1635
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1636
gnutls.library.constants
1637
.GNUTLS_OPENPGP_FMT_RAW))
2467
1638
# Verify the self signature in the key
2468
1639
crtverify = ctypes.c_uint()
2469
gnutls.openpgp_crt_verify_self(crt, 0,
2470
ctypes.byref(crtverify))
1640
(gnutls.library.functions
1641
.gnutls_openpgp_crt_verify_self(crt, 0,
1642
ctypes.byref(crtverify)))
2471
1643
if crtverify.value != 0:
2472
gnutls.openpgp_crt_deinit(crt)
2473
raise gnutls.CertificateSecurityError(code
1644
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1645
raise (gnutls.errors.CertificateSecurityError
2475
1647
# New buffer for the fingerprint
2476
1648
buf = ctypes.create_string_buffer(20)
2477
1649
buf_len = ctypes.c_size_t()
2478
1650
# Get the fingerprint from the certificate into the buffer
2479
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2480
ctypes.byref(buf_len))
1651
(gnutls.library.functions
1652
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1653
ctypes.byref(buf_len)))
2481
1654
# Deinit the certificate
2482
gnutls.openpgp_crt_deinit(crt)
1655
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2483
1656
# Convert the buffer to a Python bytestring
2484
1657
fpr = ctypes.string_at(buf, buf_len.value)
2485
1658
# Convert the bytestring to hexadecimal notation
2490
1663
class MultiprocessingMixIn(object):
2491
1664
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2493
1665
def sub_process_main(self, request, address):
2495
1667
self.finish_request(request, address)
2497
1669
self.handle_error(request, address)
2498
1670
self.close_request(request)
2500
1672
def process_request(self, request, address):
2501
1673
"""Start a new process to process the request."""
2502
proc = multiprocessing.Process(target=self.sub_process_main,
2503
args=(request, address))
1674
proc = multiprocessing.Process(target = self.sub_process_main,
2508
1681
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2509
1682
""" adds a pipe to the MixIn """
2511
1683
def process_request(self, request, client_address):
2512
1684
"""Overrides and wraps the original process_request().
2514
1686
This function creates a new pipe in self.pipe
2516
1688
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2518
1690
proc = MultiprocessingMixIn.process_request(self, request,
2519
1691
client_address)
2520
1692
self.child_pipe.close()
2521
1693
self.add_pipe(parent_pipe, proc)
2523
1695
def add_pipe(self, parent_pipe, proc):
2524
1696
"""Dummy function; override as necessary"""
2525
raise NotImplementedError()
1697
raise NotImplementedError
2528
1700
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2529
1701
socketserver.TCPServer, object):
2530
1702
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2533
1705
enabled: Boolean; whether this server is activated yet
2534
1706
interface: None or a network interface name (string)
2535
1707
use_ipv6: Boolean; to use IPv6 or not
2538
1709
def __init__(self, server_address, RequestHandlerClass,
2542
"""If socketfd is set, use that file descriptor instead of
2543
creating a new one with socket.socket().
1710
interface=None, use_ipv6=True):
2545
1711
self.interface = interface
2547
1713
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.
2575
1714
socketserver.TCPServer.__init__(self, server_address,
2576
1715
RequestHandlerClass)
2578
1716
def server_bind(self):
2579
1717
"""This overrides the normal server_bind() function
2580
1718
to bind to an interface if one was specified, and also NOT to
2581
1719
bind to an address or port if they were not specified."""
2582
global SO_BINDTODEVICE
2583
1720
if self.interface is not None:
2584
1721
if SO_BINDTODEVICE is None:
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)
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",
2606
1742
# Only bind(2) the socket if we really need to.
2607
1743
if self.server_address[0] or self.server_address[1]:
2608
1744
if not self.server_address[0]:
2609
1745
if self.address_family == socket.AF_INET6:
2610
any_address = "::" # in6addr_any
1746
any_address = "::" # in6addr_any
2612
any_address = "0.0.0.0" # INADDR_ANY
1748
any_address = socket.INADDR_ANY
2613
1749
self.server_address = (any_address,
2614
1750
self.server_address[1])
2615
1751
elif not self.server_address[1]:
2616
self.server_address = (self.server_address[0], 0)
1752
self.server_address = (self.server_address[0],
2617
1754
# if self.interface:
2618
1755
# self.server_address = (self.server_address[0],
2722
1859
funcname = request[1]
2723
1860
args = request[2]
2724
1861
kwargs = request[3]
2726
1863
parent_pipe.send(('data', getattr(client_object,
2727
1864
funcname)(*args,
2730
1867
if command == 'getattr':
2731
1868
attrname = request[1]
2732
if isinstance(client_object.__getattribute__(attrname),
2733
collections.Callable):
2734
parent_pipe.send(('function', ))
1869
if callable(client_object.__getattribute__(attrname)):
1870
parent_pipe.send(('function',))
2737
'data', client_object.__getattribute__(attrname)))
1872
parent_pipe.send(('data', client_object
1873
.__getattribute__(attrname)))
2739
1875
if command == 'setattr':
2740
1876
attrname = request[1]
2741
1877
value = request[2]
2742
1878
setattr(client_object, attrname, value)
2747
def rfc3339_duration_to_delta(duration):
2748
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2750
>>> rfc3339_duration_to_delta("P7D")
2751
datetime.timedelta(7)
2752
>>> rfc3339_duration_to_delta("PT60S")
2753
datetime.timedelta(0, 60)
2754
>>> rfc3339_duration_to_delta("PT60M")
2755
datetime.timedelta(0, 3600)
2756
>>> rfc3339_duration_to_delta("PT24H")
2757
datetime.timedelta(1)
2758
>>> rfc3339_duration_to_delta("P1W")
2759
datetime.timedelta(7)
2760
>>> rfc3339_duration_to_delta("PT5M30S")
2761
datetime.timedelta(0, 330)
2762
>>> rfc3339_duration_to_delta("P1DT3M20S")
2763
datetime.timedelta(1, 200)
2766
# Parsing an RFC 3339 duration with regular expressions is not
2767
# possible - there would have to be multiple places for the same
2768
# values, like seconds. The current code, while more esoteric, is
2769
# cleaner without depending on a parsing library. If Python had a
2770
# built-in library for parsing we would use it, but we'd like to
2771
# avoid excessive use of external libraries.
2773
# New type for defining tokens, syntax, and semantics all-in-one
2774
Token = collections.namedtuple("Token", (
2775
"regexp", # To match token; if "value" is not None, must have
2776
# a "group" containing digits
2777
"value", # datetime.timedelta or None
2778
"followers")) # Tokens valid after this token
2779
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2780
# the "duration" ABNF definition in RFC 3339, Appendix A.
2781
token_end = Token(re.compile(r"$"), None, frozenset())
2782
token_second = Token(re.compile(r"(\d+)S"),
2783
datetime.timedelta(seconds=1),
2784
frozenset((token_end, )))
2785
token_minute = Token(re.compile(r"(\d+)M"),
2786
datetime.timedelta(minutes=1),
2787
frozenset((token_second, token_end)))
2788
token_hour = Token(re.compile(r"(\d+)H"),
2789
datetime.timedelta(hours=1),
2790
frozenset((token_minute, token_end)))
2791
token_time = Token(re.compile(r"T"),
2793
frozenset((token_hour, token_minute,
2795
token_day = Token(re.compile(r"(\d+)D"),
2796
datetime.timedelta(days=1),
2797
frozenset((token_time, token_end)))
2798
token_month = Token(re.compile(r"(\d+)M"),
2799
datetime.timedelta(weeks=4),
2800
frozenset((token_day, token_end)))
2801
token_year = Token(re.compile(r"(\d+)Y"),
2802
datetime.timedelta(weeks=52),
2803
frozenset((token_month, token_end)))
2804
token_week = Token(re.compile(r"(\d+)W"),
2805
datetime.timedelta(weeks=1),
2806
frozenset((token_end, )))
2807
token_duration = Token(re.compile(r"P"), None,
2808
frozenset((token_year, token_month,
2809
token_day, token_time,
2811
# Define starting values:
2813
value = datetime.timedelta()
2815
# Following valid tokens
2816
followers = frozenset((token_duration, ))
2817
# String left to parse
2819
# Loop until end token is found
2820
while found_token is not token_end:
2821
# Search for any currently valid tokens
2822
for token in followers:
2823
match = token.regexp.match(s)
2824
if match is not None:
2826
if token.value is not None:
2827
# Value found, parse digits
2828
factor = int(match.group(1), 10)
2829
# Add to value so far
2830
value += factor * token.value
2831
# Strip token from string
2832
s = token.regexp.sub("", s, 1)
2835
# Set valid next tokens
2836
followers = found_token.followers
2839
# No currently valid tokens were found
2840
raise ValueError("Invalid RFC 3339 duration: {!r}"
2846
1883
def string_to_delta(interval):
2847
1884
"""Parse a string and return a datetime.timedelta
2849
1886
>>> string_to_delta('7d')
2850
1887
datetime.timedelta(7)
2851
1888
>>> string_to_delta('60s')
2946
1977
parser.add_argument("--no-dbus", action="store_false",
2947
1978
dest="use_dbus", help="Do not provide D-Bus"
2948
" system bus interface", default=None)
1979
" system bus interface")
2949
1980
parser.add_argument("--no-ipv6", action="store_false",
2950
dest="use_ipv6", help="Do not use IPv6",
1981
dest="use_ipv6", help="Do not use IPv6")
2952
1982
parser.add_argument("--no-restore", action="store_false",
2953
1983
dest="restore", help="Do not restore stored"
2954
" state", default=None)
2955
parser.add_argument("--socket", type=int,
2956
help="Specify a file descriptor to a network"
2957
" socket to use instead of creating one")
2958
1985
parser.add_argument("--statedir", metavar="DIR",
2959
1986
help="Directory to save/restore state in")
2960
parser.add_argument("--foreground", action="store_true",
2961
help="Run in foreground", default=None)
2962
parser.add_argument("--no-zeroconf", action="store_false",
2963
dest="zeroconf", help="Do not use Zeroconf",
2966
1988
options = parser.parse_args()
2968
1990
if options.check:
2970
fail_count, test_count = doctest.testmod()
2971
sys.exit(os.EX_OK if fail_count == 0 else 1)
2973
1995
# Default values for config file for server-global settings
2974
if gnutls.has_rawpk:
2975
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2976
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2978
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2979
":+SIGN-DSA-SHA256")
2980
server_defaults = {"interface": "",
2984
"priority": priority,
2985
"servicename": "Mandos",
2991
"statedir": "/var/lib/mandos",
2992
"foreground": "False",
1996
server_defaults = { "interface": "",
2001
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2002
"servicename": "Mandos",
2007
"statedir": "/var/lib/mandos"
2997
2010
# Parse config file for server-global settings
2998
2011
server_config = configparser.SafeConfigParser(server_defaults)
2999
2012
del server_defaults
3000
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2013
server_config.read(os.path.join(options.configdir,
3001
2015
# Convert the SafeConfigParser object to a dict
3002
2016
server_settings = server_config.defaults()
3003
2017
# Use the appropriate methods on the non-string config options
3004
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3005
"foreground", "zeroconf"):
2018
for option in ("debug", "use_dbus", "use_ipv6"):
3006
2019
server_settings[option] = server_config.getboolean("DEFAULT",
3008
2021
if server_settings["port"]:
3009
2022
server_settings["port"] = server_config.getint("DEFAULT",
3011
if server_settings["socket"]:
3012
server_settings["socket"] = server_config.getint("DEFAULT",
3014
# Later, stdin will, and stdout and stderr might, be dup'ed
3015
# over with an opened os.devnull. But we don't want this to
3016
# happen with a supplied network socket.
3017
if 0 <= server_settings["socket"] <= 2:
3018
server_settings["socket"] = os.dup(server_settings
3020
2024
del server_config
3022
2026
# Override the settings from the config file with command line
3023
2027
# options, if set.
3024
2028
for option in ("interface", "address", "port", "debug",
3025
"priority", "servicename", "configdir", "use_dbus",
3026
"use_ipv6", "debuglevel", "restore", "statedir",
3027
"socket", "foreground", "zeroconf"):
2029
"priority", "servicename", "configdir",
2030
"use_dbus", "use_ipv6", "debuglevel", "restore",
3028
2032
value = getattr(options, option)
3029
2033
if value is not None:
3030
2034
server_settings[option] = value
3032
2036
# Force all strings to be unicode
3033
2037
for option in server_settings.keys():
3034
if isinstance(server_settings[option], bytes):
3035
server_settings[option] = (server_settings[option]
3037
# Force all boolean options to be boolean
3038
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3039
"foreground", "zeroconf"):
3040
server_settings[option] = bool(server_settings[option])
3041
# Debug implies foreground
3042
if server_settings["debug"]:
3043
server_settings["foreground"] = True
2038
if type(server_settings[option]) is str:
2039
server_settings[option] = unicode(server_settings[option])
3044
2040
# Now we have our good server settings in "server_settings"
3046
2042
##################################################################
3048
if (not server_settings["zeroconf"]
3049
and not (server_settings["port"]
3050
or server_settings["socket"] != "")):
3051
parser.error("Needs port or socket to work without Zeroconf")
3053
2044
# For convenience
3054
2045
debug = server_settings["debug"]
3055
2046
debuglevel = server_settings["debuglevel"]
3057
2048
use_ipv6 = server_settings["use_ipv6"]
3058
2049
stored_state_path = os.path.join(server_settings["statedir"],
3059
2050
stored_state_file)
3060
foreground = server_settings["foreground"]
3061
zeroconf = server_settings["zeroconf"]
3064
initlogger(debug, logging.DEBUG)
2053
initlogger(logging.DEBUG)
3066
2055
if not debuglevel:
3069
2058
level = getattr(logging, debuglevel.upper())
3070
initlogger(debug, level)
3072
2061
if server_settings["servicename"] != "Mandos":
3073
syslogger.setFormatter(
3074
logging.Formatter('Mandos ({}) [%(process)d]:'
3075
' %(levelname)s: %(message)s'.format(
3076
server_settings["servicename"])))
2062
syslogger.setFormatter(logging.Formatter
2063
('Mandos (%s) [%%(process)d]:'
2064
' %%(levelname)s: %%(message)s'
2065
% server_settings["servicename"]))
3078
2067
# Parse config file with clients
3079
client_config = configparser.SafeConfigParser(Client
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
2077
client_config.read(os.path.join(server_settings["configdir"],
3082
2078
"clients.conf"))
3084
2080
global mandos_dbus_service
3085
2081
mandos_dbus_service = None
3088
if server_settings["socket"] != "":
3089
socketfd = server_settings["socket"]
3090
tcp_server = MandosServer(
3091
(server_settings["address"], server_settings["port"]),
3093
interface=(server_settings["interface"] or None),
3095
gnutls_priority=server_settings["priority"],
3099
pidfilename = "/run/mandos.pid"
3100
if not os.path.isdir("/run/."):
3101
pidfilename = "/var/run/mandos.pid"
3104
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3105
except IOError as e:
3106
logger.error("Could not open file %r", pidfilename,
3109
for name, group in (("_mandos", "_mandos"),
3110
("mandos", "mandos"),
3111
("nobody", "nogroup")):
3113
uid = pwd.getpwnam(name).pw_uid
3114
gid = pwd.getpwnam(group).pw_gid
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
3116
2106
except KeyError:
2108
uid = pwd.getpwnam("nobody").pw_uid
2109
gid = pwd.getpwnam("nobody").pw_gid
3125
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3127
2116
except OSError as error:
3128
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3129
.format(uid, gid, os.strerror(error.errno)))
3130
if error.errno != errno.EPERM:
2117
if error[0] != errno.EPERM:
3134
2121
# Enable all possible GnuTLS debugging
3136
2123
# "Use a log level over 10 to enable all debugging options."
3137
2124
# - GnuTLS manual
3138
gnutls.global_set_log_level(11)
2125
gnutls.library.functions.gnutls_global_set_log_level(11)
2127
@gnutls.library.types.gnutls_log_func
3141
2128
def debug_gnutls(level, string):
3142
2129
logger.debug("GnuTLS: %s", string[:-1])
3144
gnutls.global_set_log_function(debug_gnutls)
2131
(gnutls.library.functions
2132
.gnutls_global_set_log_function(debug_gnutls))
3146
2134
# Redirect stdin so all checkers get /dev/null
3147
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2135
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3148
2136
os.dup2(null, sys.stdin.fileno())
2140
# No console logging
2141
logger.removeHandler(console)
3152
2143
# Need to fork before connecting to D-Bus
3154
2145
# Close all input and output, do double fork, etc.
3157
# multiprocessing will use threads, so before we use GLib we need
3158
# to inform GLib that threads will be used.
3161
2148
global main_loop
3162
2149
# From the Avahi example code
3163
DBusGMainLoop(set_as_default=True)
3164
main_loop = GLib.MainLoop()
2150
DBusGMainLoop(set_as_default=True )
2151
main_loop = gobject.MainLoop()
3165
2152
bus = dbus.SystemBus()
3166
2153
# End of Avahi example code
3169
2156
bus_name = dbus.service.BusName("se.recompile.Mandos",
3172
old_bus_name = dbus.service.BusName(
3173
"se.bsnet.fukt.Mandos", bus,
3175
except dbus.exceptions.DBusException as e:
3176
logger.error("Disabling D-Bus:", exc_info=e)
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")
3177
2163
use_dbus = False
3178
2164
server_settings["use_dbus"] = False
3179
2165
tcp_server.use_dbus = False
3181
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3182
service = AvahiServiceToSyslog(
3183
name=server_settings["servicename"],
3184
servicetype="_mandos._tcp",
3187
if server_settings["interface"]:
3188
service.interface = if_nametoindex(
3189
server_settings["interface"].encode("utf-8"))
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"])))
3191
2175
global multiprocessing_manager
3192
2176
multiprocessing_manager = multiprocessing.Manager()
3194
2178
client_class = Client
3196
client_class = functools.partial(ClientDBus, bus=bus)
3198
client_settings = Client.config_parser(client_config)
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())
3199
2206
old_client_settings = {}
3202
# This is used to redirect stdout and stderr for checker processes
3204
wnull = open(os.devnull, "w") # A writable /dev/null
3205
# Only used if server is running in foreground but not in debug
3207
if debug or not foreground:
3210
2209
# Get client data and settings from last running state.
3211
2210
if server_settings["restore"]:
3213
2212
with open(stored_state_path, "rb") as stored_state:
3214
if sys.version_info.major == 2:
3215
clients_data, old_client_settings = pickle.load(
3218
bytes_clients_data, bytes_old_client_settings = (
3219
pickle.load(stored_state, encoding="bytes"))
3220
# Fix bytes to strings
3223
clients_data = {(key.decode("utf-8")
3224
if isinstance(key, bytes)
3227
bytes_clients_data.items()}
3228
del bytes_clients_data
3229
for key in clients_data:
3230
value = {(k.decode("utf-8")
3231
if isinstance(k, bytes) else k): v
3233
clients_data[key].items()}
3234
clients_data[key] = value
3236
value["client_structure"] = [
3238
if isinstance(s, bytes)
3240
value["client_structure"]]
3242
for k in ("name", "host"):
3243
if isinstance(value[k], bytes):
3244
value[k] = value[k].decode("utf-8")
3245
if not value.has_key("key_id"):
3246
value["key_id"] = ""
3247
elif not value.has_key("fingerprint"):
3248
value["fingerprint"] = ""
3249
# old_client_settings
3251
old_client_settings = {
3252
(key.decode("utf-8")
3253
if isinstance(key, bytes)
3256
bytes_old_client_settings.items()}
3257
del bytes_old_client_settings
3259
for value in old_client_settings.values():
3260
if isinstance(value["host"], bytes):
3261
value["host"] = (value["host"]
2213
clients_data, old_client_settings = (pickle.load
3263
2215
os.remove(stored_state_path)
3264
2216
except IOError as e:
3265
if e.errno == errno.ENOENT:
3266
logger.warning("Could not load persistent state:"
3267
" {}".format(os.strerror(e.errno)))
3269
logger.critical("Could not load persistent state:",
2217
logger.warning("Could not load persistent state: {0}"
2219
if e.errno != errno.ENOENT:
3272
except EOFError as e:
3273
logger.warning("Could not load persistent state: "
3277
2222
with PGPEngine() as pgp:
3278
for client_name, client in clients_data.items():
3279
# Skip removed clients
3280
if client_name not in client_settings:
2223
for client in clients_data:
2224
client_name = client["name"]
3283
2226
# Decide which value to use after restoring saved state.
3284
2227
# We have three different values: Old config file,
3285
2228
# new config file, and saved state.
3290
2233
# For each value in new config, check if it
3291
2234
# differs from the old config value (Except for
3292
2235
# the "secret" attribute)
3293
if (name != "secret"
3295
old_client_settings[client_name][name])):
3296
client[name] = value
2236
if (name != "secret" and
2237
value != old_client_settings[client_name]
2239
setattr(client, name, value)
3297
2240
except KeyError:
3300
2243
# Clients who has passed its expire date can still be
3301
# enabled if its last checker was successful. A Client
3302
# whose checker succeeded before we stored its state is
3303
# assumed to have successfully run all checkers during
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.
3305
2247
if client["enabled"]:
3306
if datetime.datetime.utcnow() >= client["expires"]:
3307
if not client["last_checked_ok"]:
3309
"disabling client {} - Client never "
3310
"performed a successful checker".format(
3312
client["enabled"] = False
3313
elif client["last_checker_status"] != 0:
3315
"disabling client {} - Client last"
3316
" checker failed with error code"
3319
client["last_checker_status"]))
2248
if client["expires"] <= (datetime.datetime
2250
# Client has expired
2251
if client["last_checker_status"] != 0:
3320
2252
client["enabled"] = False
3322
client["expires"] = (
3323
datetime.datetime.utcnow()
3324
+ client["timeout"])
3325
logger.debug("Last checker succeeded,"
3326
" keeping {} enabled".format(
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],
3329
client["secret"] = pgp.decrypt(
3330
client["encrypted_secret"],
3331
client_settings[client_name]["secret"])
2287
tcp_server.clients[client_name].secret = (
2288
pgp.decrypt(tcp_server.clients[client_name]
2290
client_settings[client_name]
3332
2292
except PGPError:
3333
2293
# If decryption fails, we use secret from new settings
3334
logger.debug("Failed to decrypt {} old secret".format(
3336
client["secret"] = (client_settings[client_name]
3339
# Add/remove clients based on new changes made to config
3340
for client_name in (set(old_client_settings)
3341
- set(client_settings)):
3342
del clients_data[client_name]
3343
for client_name in (set(client_settings)
3344
- set(old_client_settings)):
3345
clients_data[client_name] = client_settings[client_name]
3347
# Create all client objects
3348
for client_name, client in clients_data.items():
3349
tcp_server.clients[client_name] = client_class(
3352
server_settings=server_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
3354
2309
if not tcp_server.clients:
3355
2310
logger.warning("No clients defined")
3358
if pidfile is not None:
3362
print(pid, file=pidfile)
3364
logger.error("Could not write to file %r with PID %d",
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
3367
2324
del pidfilename
3369
for termsig in (signal.SIGHUP, signal.SIGTERM):
3370
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3371
lambda: main_loop.quit() and False)
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())
3375
@alternate_dbus_interfaces(
3376
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3377
class MandosDBusService(DBusObjectWithObjectManager):
2332
class MandosDBusService(dbus.service.Object):
3378
2333
"""A D-Bus proxy object"""
3380
2334
def __init__(self):
3381
2335
dbus.service.Object.__init__(self, bus, "/")
3383
2336
_interface = "se.recompile.Mandos"
3385
2338
@dbus.service.signal(_interface, signature="o")
3386
2339
def ClientAdded(self, objpath):
3390
2343
@dbus.service.signal(_interface, signature="ss")
3391
def ClientNotFound(self, key_id, address):
2344
def ClientNotFound(self, fingerprint, address):
3395
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3397
2348
@dbus.service.signal(_interface, signature="os")
3398
2349
def ClientRemoved(self, objpath, name):
3402
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3404
2353
@dbus.service.method(_interface, out_signature="ao")
3405
2354
def GetAllClients(self):
3407
return dbus.Array(c.dbus_object_path for c in
3408
tcp_server.clients.values())
3410
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2356
return dbus.Array(c.dbus_object_path
2358
tcp_server.clients.itervalues())
3412
2360
@dbus.service.method(_interface,
3413
2361
out_signature="a{oa{sv}}")
3414
2362
def GetAllClientsWithProperties(self):
3416
2364
return dbus.Dictionary(
3417
{c.dbus_object_path: c.GetAll(
3418
"se.recompile.Mandos.Client")
3419
for c in tcp_server.clients.values()},
2365
((c.dbus_object_path, c.GetAll(""))
2366
for c in tcp_server.clients.itervalues()),
3420
2367
signature="oa{sv}")
3422
2369
@dbus.service.method(_interface, in_signature="o")
3423
2370
def RemoveClient(self, object_path):
3425
for c in tcp_server.clients.values():
2372
for c in tcp_server.clients.itervalues():
3426
2373
if c.dbus_object_path == object_path:
3427
2374
del tcp_server.clients[c.name]
3428
2375
c.remove_from_connection()
3429
# Don't signal the disabling
2376
# Don't signal anything except ClientRemoved
3430
2377
c.disable(quiet=True)
3431
# Emit D-Bus signal for removal
3432
self.client_removed_signal(c)
2379
self.ClientRemoved(object_path, c.name)
3434
2381
raise KeyError(object_path)
3438
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3439
out_signature="a{oa{sa{sv}}}")
3440
def GetManagedObjects(self):
3442
return dbus.Dictionary(
3443
{client.dbus_object_path:
3445
{interface: client.GetAll(interface)
3447
client._get_all_interface_names()})
3448
for client in tcp_server.clients.values()})
3450
def client_added_signal(self, client):
3451
"""Send the new standard signal and the old signal"""
3453
# New standard signal
3454
self.InterfacesAdded(
3455
client.dbus_object_path,
3457
{interface: client.GetAll(interface)
3459
client._get_all_interface_names()}))
3461
self.ClientAdded(client.dbus_object_path)
3463
def client_removed_signal(self, client):
3464
"""Send the new standard signal and the old signal"""
3466
# New standard signal
3467
self.InterfacesRemoved(
3468
client.dbus_object_path,
3469
client._get_all_interface_names())
3471
self.ClientRemoved(client.dbus_object_path,
3474
mandos_dbus_service = MandosDBusService()
3476
# Save modules to variables to exempt the modules from being
3477
# unloaded before the function registered with atexit() is run.
3478
mp = multiprocessing
2385
class MandosDBusServiceTransitional(MandosDBusService):
2386
__metaclass__ = AlternateDBusNamesMetaclass
2387
mandos_dbus_service = MandosDBusServiceTransitional()
3482
2390
"Cleanup function; run on exit"
3486
mp.active_children()
2393
multiprocessing.active_children()
3488
2394
if not (tcp_server.clients or client_settings):
3491
2397
# Store client before exiting. Secrets are encrypted with key
3492
2398
# based on what config file has. If config file is
3493
2399
# removed/edited, old secret will thus be unrecovable.
3495
2401
with PGPEngine() as pgp:
3496
for client in tcp_server.clients.values():
2402
for client in tcp_server.clients.itervalues():
3497
2403
key = client_settings[client.name]["secret"]
3498
2404
client.encrypted_secret = pgp.encrypt(client.secret,
3500
2406
client_dict = {}
3502
# A list of attributes that can not be pickled
3504
exclude = {"bus", "changedstate", "secret",
3505
"checker", "server_settings"}
3506
for name, typ in inspect.getmembers(dbus.service
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)):
3508
2413
exclude.add(name)
3510
2415
client_dict["encrypted_secret"] = (client
3511
2416
.encrypted_secret)
3512
2417
for attr in client.client_structure:
3513
2418
if attr not in exclude:
3514
2419
client_dict[attr] = getattr(client, attr)
3516
clients[client.name] = client_dict
2421
clients.append(client_dict)
3517
2422
del client_settings[client.name]["secret"]
3520
with tempfile.NamedTemporaryFile(
3524
dir=os.path.dirname(stored_state_path),
3525
delete=False) as stored_state:
3526
pickle.dump((clients, client_settings), stored_state,
3528
tempname = stored_state.name
3529
os.rename(tempname, stored_state_path)
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)
3530
2429
except (IOError, OSError) as e:
3536
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3537
logger.warning("Could not save persistent state: {}"
3538
.format(os.strerror(e.errno)))
3540
logger.warning("Could not save persistent state:",
2430
logger.warning("Could not save persistent state: {0}"
2432
if e.errno not in (errno.ENOENT, errno.EACCES):
3544
2435
# Delete all clients, and settings from config
3545
2436
while tcp_server.clients:
3546
2437
name, client = tcp_server.clients.popitem()
3548
2439
client.remove_from_connection()
3549
# Don't signal the disabling
2440
# Don't signal anything except ClientRemoved
3550
2441
client.disable(quiet=True)
3551
# Emit D-Bus signal for removal
3553
mandos_dbus_service.client_removed_signal(client)
2444
mandos_dbus_service.ClientRemoved(client
3554
2447
client_settings.clear()
3556
2449
atexit.register(cleanup)
3558
for client in tcp_server.clients.values():
2451
for client in tcp_server.clients.itervalues():
3560
# Emit D-Bus signal for adding
3561
mandos_dbus_service.client_added_signal(client)
2454
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3562
2455
# Need to initiate checking of clients
3563
2456
if client.enabled:
3564
2457
client.init_checker()
3566
2459
tcp_server.enable()
3567
2460
tcp_server.server_activate()
3569
2462
# Find out what port we got
3571
service.port = tcp_server.socket.getsockname()[1]
2463
service.port = tcp_server.socket.getsockname()[1]
3573
2465
logger.info("Now listening on address %r, port %d,"
3574
" flowinfo %d, scope_id %d",
3575
*tcp_server.socket.getsockname())
2466
" flowinfo %d, scope_id %d"
2467
% tcp_server.socket.getsockname())
3577
logger.info("Now listening on address %r, port %d",
3578
*tcp_server.socket.getsockname())
3580
# service.interface = tcp_server.socket.getsockname()[3]
2469
logger.info("Now listening on address %r, port %d"
2470
% tcp_server.socket.getsockname())
2472
#service.interface = tcp_server.socket.getsockname()[3]
3584
# From the Avahi example code
3587
except dbus.exceptions.DBusException as error:
3588
logger.critical("D-Bus Exception", exc_info=error)
3591
# End of Avahi example code
3593
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3594
lambda *args, **kwargs:
3595
(tcp_server.handle_request
3596
(*args[2:], **kwargs) or True))
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))
3598
2489
logger.debug("Starting main loop")
3599
2490
main_loop.run()
3600
2491
except AvahiError as error:
3601
logger.critical("Avahi Error", exc_info=error)
2492
logger.critical("AvahiError: %s", error)
3604
2495
except KeyboardInterrupt: