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