226
167
os.rmdir(self.tempdir)
227
168
self.tempdir = None
229
170
def password_encode(self, password):
230
171
# Passphrase can not be empty and can not contain newlines or
231
172
# NUL bytes. So we prefix it and hex encode it.
232
encoded = b"mandos" + binascii.hexlify(password)
233
if len(encoded) > 2048:
234
# GnuPG can't handle long passwords, so encode differently
235
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
236
.replace(b"\n", b"\\n")
237
.replace(b"\0", b"\\x00"))
173
return b"mandos" + binascii.hexlify(password)
240
175
def encrypt(self, data, password):
241
passphrase = self.password_encode(password)
242
with tempfile.NamedTemporaryFile(
243
dir=self.tempdir) as passfile:
244
passfile.write(passphrase)
246
proc = subprocess.Popen([self.gpg, '--symmetric',
250
stdin=subprocess.PIPE,
251
stdout=subprocess.PIPE,
252
stderr=subprocess.PIPE)
253
ciphertext, err = proc.communicate(input=data)
254
if proc.returncode != 0:
176
self.gnupg.passphrase = self.password_encode(password)
177
with open(os.devnull) as devnull:
179
proc = self.gnupg.run(['--symmetric'],
180
create_fhs=['stdin', 'stdout'],
181
attach_fhs={'stderr': devnull})
182
with contextlib.closing(proc.handles['stdin']) as f:
184
with contextlib.closing(proc.handles['stdout']) as f:
185
ciphertext = f.read()
189
self.gnupg.passphrase = None
256
190
return ciphertext
258
192
def decrypt(self, data, password):
259
passphrase = self.password_encode(password)
260
with tempfile.NamedTemporaryFile(
261
dir=self.tempdir) as passfile:
262
passfile.write(passphrase)
264
proc = subprocess.Popen([self.gpg, '--decrypt',
268
stdin=subprocess.PIPE,
269
stdout=subprocess.PIPE,
270
stderr=subprocess.PIPE)
271
decrypted_plaintext, err = proc.communicate(input=data)
272
if proc.returncode != 0:
193
self.gnupg.passphrase = self.password_encode(password)
194
with open(os.devnull) as devnull:
196
proc = self.gnupg.run(['--decrypt'],
197
create_fhs=['stdin', 'stdout'],
198
attach_fhs={'stderr': devnull})
199
with contextlib.closing(proc.handles['stdin'] ) as f:
201
with contextlib.closing(proc.handles['stdout']) as f:
202
decrypted_plaintext = f.read()
206
self.gnupg.passphrase = None
274
207
return decrypted_plaintext
277
# Pretend that we have an Avahi module
279
"""This isn't so much a class as it is a module-like namespace.
280
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
304
211
class AvahiError(Exception):
305
212
def __init__(self, value, *args, **kwargs):
306
213
self.value = value
307
return super(AvahiError, self).__init__(value, *args,
214
super(AvahiError, self).__init__(value, *args, **kwargs)
215
def __unicode__(self):
216
return unicode(repr(self.value))
311
218
class AvahiServiceError(AvahiError):
315
221
class AvahiGroupError(AvahiError):
319
225
class AvahiService(object):
320
226
"""An Avahi (Zeroconf) service.
323
229
interface: integer; avahi.IF_UNSPEC or an interface index.
324
230
Used to optionally bind to the specified interface.
325
231
name: string; Example: 'Mandos'
326
232
type: string; Example: '_mandos._tcp'.
327
See <https://www.iana.org/assignments/service-names-port-numbers>
233
See <http://www.dns-sd.org/ServiceTypes.html>
328
234
port: integer; what port to announce
329
235
TXT: list of strings; TXT record for the service
330
236
domain: string; Domain to publish on, default to .local if empty.
489
365
follow_name_owner_changes=True),
490
366
avahi.DBUS_INTERFACE_SERVER)
491
367
self.server.connect_to_signal("StateChanged",
492
self.server_state_changed)
368
self.server_state_changed)
493
369
self.server_state_changed(self.server.GetState())
496
371
class AvahiServiceToSyslog(AvahiService):
497
def rename(self, *args, **kwargs):
498
373
"""Add the new name to the syslog messages"""
499
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
500
syslogger.setFormatter(logging.Formatter(
501
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
374
ret = AvahiService.rename(self)
375
syslogger.setFormatter(logging.Formatter
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
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))
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))
828
387
class Client(object):
829
388
"""A representation of a client host served by this server.
832
391
approved: bool(); 'None' if not yet approved/disapproved
833
392
approval_delay: datetime.timedelta(); Time to wait for approval
835
394
checker: subprocess.Popen(); a running checker process used
836
395
to see if the client lives.
837
396
'None' if no process is running.
838
checker_callback_tag: a GLib event source tag, or None
397
checker_callback_tag: a gobject event source tag, or None
839
398
checker_command: string; External command which is run to check
840
399
if client lives. %() expansions are done at
841
400
runtime with vars(self) as dict, so that for
842
401
instance %(name)s can be used in the command.
843
checker_initiator_tag: a GLib event source tag, or None
402
checker_initiator_tag: a gobject event source tag, or None
844
403
created: datetime.datetime(); (UTC) object creation
845
404
client_structure: Object describing what attributes a client has
846
405
and is used for storing the client at exit
847
406
current_checker_command: string; current running checker_command
848
disable_initiator_tag: a GLib event source tag, or None
407
disable_initiator_tag: a gobject event source tag, or None
850
409
fingerprint: string (40 or 32 hexadecimal digits); used to
851
uniquely identify an OpenPGP client
852
key_id: string (64 hexadecimal digits); used to uniquely identify
853
a client using raw public keys
410
uniquely identify the client
854
411
host: string; available for use by the checker command
855
412
interval: datetime.timedelta(); How often to start a new checker
856
413
last_approval_request: datetime.datetime(); (UTC) or None
857
414
last_checked_ok: datetime.datetime(); (UTC) or None
858
416
last_checker_status: integer between 0 and 255 reflecting exit
859
417
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
863
419
last_enabled: datetime.datetime(); (UTC) or None
864
420
name: string; from the config file, used in log messages and
865
421
D-Bus identifiers
866
422
secret: bytestring; sent verbatim (over TLS) to client
867
423
timeout: datetime.timedelta(); How long from last_checked_ok
868
424
until this client is disabled
869
extended_timeout: extra long timeout when secret has been sent
425
extended_timeout: extra long timeout when password has been sent
870
426
runtime_expansions: Allowed attributes for runtime expansion.
871
427
expires: datetime.datetime(); time (UTC) when a client will be
872
428
disabled, or None
873
server_settings: The server_settings dict from main()
876
431
runtime_expansions = ("approval_delay", "approval_duration",
877
"created", "enabled", "expires", "key_id",
878
"fingerprint", "host", "interval",
879
"last_approval_request", "last_checked_ok",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
880
434
"last_enabled", "name", "timeout")
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):
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'
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
966
458
logger.debug("Creating client %r", self.name)
967
logger.debug(" Key ID: %s", self.key_id)
459
# Uppercase and remove spaces from fingerprint for later
460
# comparison purposes with return value from the fingerprint()
462
self.fingerprint = (config["fingerprint"].upper()
968
464
logger.debug(" Fingerprint: %s", self.fingerprint)
969
self.created = settings.get("created",
970
datetime.datetime.utcnow())
972
# attributes specific for this server instance
465
if "secret" in config:
466
self.secret = config["secret"].decode("base64")
467
elif "secfile" in config:
468
with open(os.path.expanduser(os.path.expandvars
469
(config["secfile"])),
471
self.secret = secfile.read()
473
raise TypeError("No secret or secfile for client %s"
475
self.host = config.get("host", "")
476
self.created = datetime.datetime.utcnow()
477
self.enabled = config.get("enabled", True)
478
self.last_approval_request = None
480
self.last_enabled = datetime.datetime.utcnow()
482
self.last_enabled = None
483
self.last_checked_ok = None
484
self.last_checker_status = None
485
self.timeout = string_to_delta(config["timeout"])
486
self.extended_timeout = string_to_delta(config
487
["extended_timeout"])
488
self.interval = string_to_delta(config["interval"])
973
489
self.checker = None
974
490
self.checker_initiator_tag = None
975
491
self.disable_initiator_tag = None
493
self.expires = datetime.datetime.utcnow() + self.timeout
976
496
self.checker_callback_tag = None
497
self.checker_command = config["checker"]
977
498
self.current_checker_command = None
978
499
self.approved = None
500
self.approved_by_default = config.get("approved_by_default",
979
502
self.approvals_pending = 0
980
self.changedstate = multiprocessing_manager.Condition(
981
multiprocessing_manager.Lock())
982
self.client_structure = [attr
983
for attr in self.__dict__.keys()
503
self.approval_delay = string_to_delta(
504
config["approval_delay"])
505
self.approval_duration = string_to_delta(
506
config["approval_duration"])
507
self.changedstate = (multiprocessing_manager
508
.Condition(multiprocessing_manager
510
self.client_structure = [attr for attr in
511
self.__dict__.iterkeys()
984
512
if not attr.startswith("_")]
985
513
self.client_structure.append("client_structure")
987
for name, t in inspect.getmembers(
988
type(self), lambda obj: isinstance(obj, property)):
515
for name, t in inspect.getmembers(type(self),
989
519
if not name.startswith("_"):
990
520
self.client_structure.append(name)
992
522
# Send notice to process children that client state has changed
993
523
def send_changedstate(self):
994
524
with self.changedstate:
995
525
self.changedstate.notify_all()
997
527
def enable(self):
998
528
"""Start this client's checker and timeout hooks"""
999
529
if getattr(self, "enabled", False):
1000
530
# Already enabled
532
self.send_changedstate()
1002
533
self.expires = datetime.datetime.utcnow() + self.timeout
1003
534
self.enabled = True
1004
535
self.last_enabled = datetime.datetime.utcnow()
1005
536
self.init_checker()
1006
self.send_changedstate()
1008
538
def disable(self, quiet=True):
1009
539
"""Disable this client."""
1010
540
if not getattr(self, "enabled", False):
543
self.send_changedstate()
1013
545
logger.info("Disabling client %s", self.name)
1014
if getattr(self, "disable_initiator_tag", None) is not None:
1015
GLib.source_remove(self.disable_initiator_tag)
546
if getattr(self, "disable_initiator_tag", False):
547
gobject.source_remove(self.disable_initiator_tag)
1016
548
self.disable_initiator_tag = None
1017
549
self.expires = None
1018
if getattr(self, "checker_initiator_tag", None) is not None:
1019
GLib.source_remove(self.checker_initiator_tag)
550
if getattr(self, "checker_initiator_tag", False):
551
gobject.source_remove(self.checker_initiator_tag)
1020
552
self.checker_initiator_tag = None
1021
553
self.stop_checker()
1022
554
self.enabled = False
1024
self.send_changedstate()
1025
# Do not run this again if called by a GLib.timeout_add
555
# Do not run this again if called by a gobject.timeout_add
1028
558
def __del__(self):
1031
561
def init_checker(self):
1032
562
# Schedule a new checker to be started an 'interval' from now,
1033
563
# and every interval from then on.
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),
564
self.checker_initiator_tag = (gobject.timeout_add
565
(self.interval_milliseconds(),
1039
567
# Schedule a disable() when 'timeout' has passed
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)
568
self.disable_initiator_tag = (gobject.timeout_add
569
(self.timeout_milliseconds(),
1044
571
# Also start a new checker *right now*.
1045
572
self.start_checker()
1047
def checker_callback(self, source, condition, connection,
574
def checker_callback(self, pid, condition, command):
1049
575
"""The checker has completed, so take appropriate actions."""
1050
576
self.checker_callback_tag = None
1051
577
self.checker = None
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
578
if os.WIFEXITED(condition):
579
self.last_checker_status = os.WEXITSTATUS(condition)
1059
580
if self.last_checker_status == 0:
1060
581
logger.info("Checker for %(name)s succeeded",
1062
583
self.checked_ok()
1064
logger.info("Checker for %(name)s failed", vars(self))
585
logger.info("Checker for %(name)s failed",
1066
588
self.last_checker_status = -1
1067
self.last_checker_signal = -returncode
1068
589
logger.warning("Checker for %(name)s crashed?",
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."""
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,
1081
598
if timeout is None:
1082
599
timeout = self.timeout
600
self.last_checked_ok = datetime.datetime.utcnow()
1083
601
if self.disable_initiator_tag is not None:
1084
GLib.source_remove(self.disable_initiator_tag)
1085
self.disable_initiator_tag = None
602
gobject.source_remove(self.disable_initiator_tag)
1086
603
if getattr(self, "enabled", False):
1087
self.disable_initiator_tag = GLib.timeout_add(
1088
int(timeout.total_seconds() * 1000), self.disable)
604
self.disable_initiator_tag = (gobject.timeout_add
605
(timedelta_to_milliseconds
606
(timeout), self.disable))
1089
607
self.expires = datetime.datetime.utcnow() + timeout
1091
609
def need_approval(self):
1092
610
self.last_approval_request = datetime.datetime.utcnow()
1094
612
def start_checker(self):
1095
613
"""Start a new checker subprocess if one is not running.
1097
615
If a checker already exists, leave it running and do
1099
617
# The reason for not killing a running checker is that if we
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
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
1104
622
# checkers alone, the checker would have to take more time
1105
623
# than 'timeout' for the client to be disabled, which is as it
1108
if self.checker is not None and not self.checker.is_alive():
1109
logger.warning("Checker was not alive; joining")
626
# If a checker exists, make sure it is not a zombie
628
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
629
except (AttributeError, OSError) as error:
630
if (isinstance(error, OSError)
631
and error.errno != errno.ECHILD):
635
logger.warning("Checker was a zombie")
636
gobject.source_remove(self.checker_callback_tag)
637
self.checker_callback(pid, status,
638
self.current_checker_command)
1112
639
# Start a new checker if needed
1113
640
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}
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
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
1125
660
self.current_checker_command = command
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
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
1154
687
def stop_checker(self):
1155
688
"""Force the checker process, if any, to stop."""
1156
689
if self.checker_callback_tag:
1157
GLib.source_remove(self.checker_callback_tag)
690
gobject.source_remove(self.checker_callback_tag)
1158
691
self.checker_callback_tag = None
1159
692
if getattr(self, "checker", None) is None:
1161
694
logger.debug("Stopping checker for %(name)s", vars(self))
1162
self.checker.terminate()
696
os.kill(self.checker.pid, signal.SIGTERM)
698
#if self.checker.poll() is None:
699
# os.kill(self.checker.pid, signal.SIGKILL)
700
except OSError as error:
701
if error.errno != errno.ESRCH: # No such process
1163
703
self.checker = None
1166
def dbus_service_property(dbus_interface,
706
def dbus_service_property(dbus_interface, signature="v",
707
access="readwrite", byte_arrays=False):
1170
708
"""Decorators for marking methods of a DBusObjectWithProperties to
1171
709
become properties on the D-Bus.
1173
711
The decorated method will be called with no arguments by "Get"
1174
712
and with one argument by "Set".
1176
714
The parameters, where they are supported, are the same as
1177
715
dbus.service.method, except there is only "signature", since the
1178
716
type from Get() and the type sent to Set() is the same.
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):
755
class DBusObjectWithProperties(dbus.service.Object):
1351
756
"""A D-Bus object with properties.
1353
758
Classes inheriting from this can use the dbus_service_property
1354
759
decorator to expose methods as D-Bus properties. It exposes the
1355
760
standard Get(), Set(), and GetAll() methods on the D-Bus.
764
def _is_dbus_property(obj):
765
return getattr(obj, "_dbus_is_property", False)
767
def _get_all_dbus_properties(self):
768
"""Returns a generator of (name, attribute) pairs
770
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
771
for cls in self.__class__.__mro__
773
inspect.getmembers(cls, self._is_dbus_property))
1358
775
def _get_dbus_property(self, interface_name, property_name):
1359
776
"""Returns a bound method if one exists which is a D-Bus
1360
777
property with the specified name and interface.
1362
for cls in self.__class__.__mro__:
1363
for name, value in inspect.getmembers(
1364
cls, self._is_dbus_thing("property")):
779
for cls in self.__class__.__mro__:
780
for name, value in (inspect.getmembers
781
(cls, self._is_dbus_property)):
1365
782
if (value._dbus_name == property_name
1366
783
and value._dbus_interface == interface_name):
1367
784
return value.__get__(self)
1369
786
# No such property
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,
787
raise DBusPropertyNotFound(self.dbus_object_path + ":"
788
+ interface_name + "."
791
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1384
792
out_signature="v")
1385
793
def Get(self, interface_name, property_name):
1386
794
"""Standard D-Bus property Get() method, see D-Bus standard.
1511
886
except (AttributeError, xml.dom.DOMException,
1512
887
xml.parsers.expat.ExpatError) as error:
1513
888
logger.error("Failed to override Introspection method",
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):
893
def datetime_to_dbus (dt, variant_level=0):
1590
894
"""Convert a UTC datetime.datetime() to a D-Bus type."""
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).
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.
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):
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):
1627
913
# Ignore non-D-Bus attributes, and D-Bus attributes
1628
914
# with the wrong interface name
1629
915
if (not hasattr(attribute, "_dbus_interface")
1630
or not attribute._dbus_interface.startswith(
1631
orig_interface_name)):
916
or not attribute._dbus_interface
917
.startswith("se.recompile.Mandos")):
1633
919
# Create an alternate D-Bus interface name based on
1634
920
# the current name
1635
alt_interface = attribute._dbus_interface.replace(
1636
orig_interface_name, alt_interface_name)
1637
interface_names.add(alt_interface)
921
alt_interface = (attribute._dbus_interface
922
.replace("se.recompile.Mandos",
923
"se.bsnet.fukt.Mandos"))
1638
924
# Is this a D-Bus signal?
1639
925
if getattr(attribute, "_dbus_is_signal", False):
1640
# Extract the original non-method undecorated
1641
# function by black magic
1642
if sys.version_info.major == 2:
1643
nonmethod_func = (dict(
926
# Extract the original non-method function by
928
nonmethod_func = (dict(
1644
929
zip(attribute.func_code.co_freevars,
1645
attribute.__closure__))
1646
["func"].cell_contents)
1648
nonmethod_func = (dict(
1649
zip(attribute.__code__.co_freevars,
1650
attribute.__closure__))
1651
["func"].cell_contents)
930
attribute.__closure__))["func"]
1652
932
# Create a new, but exactly alike, function
1653
933
# object, and decorate it to be a new D-Bus signal
1654
934
# with the alternate D-Bus interface name
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:
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)))
1666
944
# Define a creator of a function to call both the
1667
# original and alternate functions, so both the
1668
# original and alternate signals gets sent when
1669
# the function is called
945
# old and new functions, so both the old and new
946
# signals gets sent when the function is called
1670
947
def fixscope(func1, func2):
1671
948
"""This function is a scope container to pass
1672
949
func1 and func2 to the "call_both" function
1673
950
outside of its arguments"""
1675
@functools.wraps(func2)
1676
951
def call_both(*args, **kwargs):
1677
952
"""This function will emit two D-Bus
1678
953
signals by calling func1 and func2"""
1679
954
func1(*args, **kwargs)
1680
955
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)
1687
956
return call_both
1688
957
# Create the "call_both" function and add it to
1690
attr[attrname] = fixscope(attribute, new_function)
959
attr[attrname] = fixscope(attribute,
1691
961
# Is this a D-Bus method?
1692
962
elif getattr(attribute, "_dbus_is_method", False):
1693
963
# Create a new, but exactly alike, function
1694
964
# object. Decorate it to be a new D-Bus method
1695
965
# with the alternate D-Bus interface name. Add it
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:
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)))
1709
977
# Is this a D-Bus property?
1710
978
elif getattr(attribute, "_dbus_is_property", False):
1711
979
# Create a new, but exactly alike, function
1712
980
# object, and decorate it to be a new D-Bus
1713
981
# property with the alternate D-Bus interface
1714
982
# name. Add it to the class.
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"})
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)
1767
999
class ClientDBus(Client, DBusObjectWithProperties):
1768
1000
"""A Client class using D-Bus
1771
1003
dbus_object_path: dbus.ObjectPath
1772
1004
bus: dbus.SystemBus()
1775
1007
runtime_expansions = (Client.runtime_expansions
1776
+ ("dbus_object_path", ))
1778
_interface = "se.recompile.Mandos.Client"
1008
+ ("dbus_object_path",))
1780
1010
# dbus.service.Object doesn't use super(), so we can't either.
1782
def __init__(self, bus=None, *args, **kwargs):
1012
def __init__(self, bus = None, *args, **kwargs):
1784
1014
Client.__init__(self, *args, **kwargs)
1016
self._approvals_pending = 0
1785
1017
# Only now, when this client is initialized, can it show up on
1787
client_object_name = str(self.name).translate(
1019
client_object_name = unicode(self.name).translate(
1788
1020
{ord("."): ord("_"),
1789
1021
ord("-"): ord("_")})
1790
self.dbus_object_path = dbus.ObjectPath(
1791
"/clients/" + client_object_name)
1022
self.dbus_object_path = (dbus.ObjectPath
1023
("/clients/" + client_object_name))
1792
1024
DBusObjectWithProperties.__init__(self, self.bus,
1793
1025
self.dbus_object_path)
1795
def notifychangeproperty(transform_func, dbus_name,
1796
type_func=lambda x: x,
1798
invalidate_only=False,
1799
_interface=_interface):
1027
def notifychangeproperty(transform_func,
1028
dbus_name, type_func=lambda x: x,
1800
1030
""" Modify a variable so that it's a property which announces
1801
1031
its changes to DBus.
1803
1033
transform_fun: Function that takes a value and a variant_level
1804
1034
and transforms it to a D-Bus type.
1805
1035
dbus_name: D-Bus name of the variable
1957
1176
server to mandos-client
1961
1180
# Rejected - signal
1962
1181
@dbus.service.signal(_interface, signature="s")
1963
1182
def Rejected(self, reason):
1967
1186
# NeedApproval - signal
1968
1187
@dbus.service.signal(_interface, signature="tb")
1969
1188
def NeedApproval(self, timeout, default):
1971
1190
return self.need_approval()
1192
# NeRwequest - signal
1193
@dbus.service.signal(_interface, signature="s")
1194
def NewRequest(self, ip):
1196
Is sent after a client request a password.
1975
1202
# Approve - method
1976
1203
@dbus.service.method(_interface, in_signature="b")
1977
1204
def Approve(self, value):
1978
1205
self.approve(value)
1980
1207
# CheckedOK - method
1981
1208
@dbus.service.method(_interface)
1982
1209
def CheckedOK(self):
1983
1210
self.checked_ok()
1985
1212
# Enable - method
1986
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1987
1213
@dbus.service.method(_interface)
1988
1214
def Enable(self):
1992
1218
# StartChecker - method
1993
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1994
1219
@dbus.service.method(_interface)
1995
1220
def StartChecker(self):
1997
1222
self.start_checker()
1999
1224
# Disable - method
2000
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2001
1225
@dbus.service.method(_interface)
2002
1226
def Disable(self):
2006
1230
# StopChecker - method
2007
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2008
1231
@dbus.service.method(_interface)
2009
1232
def StopChecker(self):
2010
1233
self.stop_checker()
2014
1237
# ApprovalPending - property
2015
1238
@dbus_service_property(_interface, signature="b", access="read")
2016
1239
def ApprovalPending_dbus_property(self):
2017
1240
return dbus.Boolean(bool(self.approvals_pending))
2019
1242
# ApprovedByDefault - property
2020
@dbus_service_property(_interface,
1243
@dbus_service_property(_interface, signature="b",
2022
1244
access="readwrite")
2023
1245
def ApprovedByDefault_dbus_property(self, value=None):
2024
1246
if value is None: # get
2025
1247
return dbus.Boolean(self.approved_by_default)
2026
1248
self.approved_by_default = bool(value)
2028
1250
# ApprovalDelay - property
2029
@dbus_service_property(_interface,
1251
@dbus_service_property(_interface, signature="t",
2031
1252
access="readwrite")
2032
1253
def ApprovalDelay_dbus_property(self, value=None):
2033
1254
if value is None: # get
2034
return dbus.UInt64(self.approval_delay.total_seconds()
1255
return dbus.UInt64(self.approval_delay_milliseconds())
2036
1256
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2038
1258
# ApprovalDuration - property
2039
@dbus_service_property(_interface,
1259
@dbus_service_property(_interface, signature="t",
2041
1260
access="readwrite")
2042
1261
def ApprovalDuration_dbus_property(self, value=None):
2043
1262
if value is None: # get
2044
return dbus.UInt64(self.approval_duration.total_seconds()
1263
return dbus.UInt64(timedelta_to_milliseconds(
1264
self.approval_duration))
2046
1265
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2048
1267
# Name - property
2050
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2051
1268
@dbus_service_property(_interface, signature="s", access="read")
2052
1269
def Name_dbus_property(self):
2053
1270
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)
2062
1272
# Fingerprint - property
2064
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2065
1273
@dbus_service_property(_interface, signature="s", access="read")
2066
1274
def Fingerprint_dbus_property(self):
2067
1275
return dbus.String(self.fingerprint)
2069
1277
# Host - property
2070
@dbus_service_property(_interface,
1278
@dbus_service_property(_interface, signature="s",
2072
1279
access="readwrite")
2073
1280
def Host_dbus_property(self, value=None):
2074
1281
if value is None: # get
2075
1282
return dbus.String(self.host)
2076
self.host = str(value)
1283
self.host = unicode(value)
2078
1285
# Created - property
2080
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2081
1286
@dbus_service_property(_interface, signature="s", access="read")
2082
1287
def Created_dbus_property(self):
2083
1288
return datetime_to_dbus(self.created)
2085
1290
# LastEnabled - property
2086
1291
@dbus_service_property(_interface, signature="s", access="read")
2087
1292
def LastEnabled_dbus_property(self):
2088
1293
return datetime_to_dbus(self.last_enabled)
2090
1295
# Enabled - property
2091
@dbus_service_property(_interface,
1296
@dbus_service_property(_interface, signature="b",
2093
1297
access="readwrite")
2094
1298
def Enabled_dbus_property(self, value=None):
2095
1299
if value is None: # get
2102
1306
# LastCheckedOK - property
2103
@dbus_service_property(_interface,
1307
@dbus_service_property(_interface, signature="s",
2105
1308
access="readwrite")
2106
1309
def LastCheckedOK_dbus_property(self, value=None):
2107
1310
if value is not None:
2108
1311
self.checked_ok()
2110
1313
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)
2117
1315
# Expires - property
2118
1316
@dbus_service_property(_interface, signature="s", access="read")
2119
1317
def Expires_dbus_property(self):
2120
1318
return datetime_to_dbus(self.expires)
2122
1320
# LastApprovalRequest - property
2123
1321
@dbus_service_property(_interface, signature="s", access="read")
2124
1322
def LastApprovalRequest_dbus_property(self):
2125
1323
return datetime_to_dbus(self.last_approval_request)
2127
1325
# Timeout - property
2128
@dbus_service_property(_interface,
1326
@dbus_service_property(_interface, signature="t",
2130
1327
access="readwrite")
2131
1328
def Timeout_dbus_property(self, value=None):
2132
1329
if value is None: # get
2133
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2134
old_timeout = self.timeout
1330
return dbus.UInt64(self.timeout_milliseconds())
2135
1331
self.timeout = datetime.timedelta(0, 0, 0, value)
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),
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))
2152
1353
# ExtendedTimeout - property
2153
@dbus_service_property(_interface,
1354
@dbus_service_property(_interface, signature="t",
2155
1355
access="readwrite")
2156
1356
def ExtendedTimeout_dbus_property(self, value=None):
2157
1357
if value is None: # get
2158
return dbus.UInt64(self.extended_timeout.total_seconds()
1358
return dbus.UInt64(self.extended_timeout_milliseconds())
2160
1359
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2162
1361
# Interval - property
2163
@dbus_service_property(_interface,
1362
@dbus_service_property(_interface, signature="t",
2165
1363
access="readwrite")
2166
1364
def Interval_dbus_property(self, value=None):
2167
1365
if value is None: # get
2168
return dbus.UInt64(self.interval.total_seconds() * 1000)
1366
return dbus.UInt64(self.interval_milliseconds())
2169
1367
self.interval = datetime.timedelta(0, 0, 0, value)
2170
1368
if getattr(self, "checker_initiator_tag", None) is None:
2172
1370
if self.enabled:
2173
1371
# Reschedule checker run
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
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
2179
1377
# Checker - property
2180
@dbus_service_property(_interface,
1378
@dbus_service_property(_interface, signature="s",
2182
1379
access="readwrite")
2183
1380
def Checker_dbus_property(self, value=None):
2184
1381
if value is None: # get
2185
1382
return dbus.String(self.checker_command)
2186
self.checker_command = str(value)
1383
self.checker_command = unicode(value)
2188
1385
# CheckerRunning - property
2189
@dbus_service_property(_interface,
1386
@dbus_service_property(_interface, signature="b",
2191
1387
access="readwrite")
2192
1388
def CheckerRunning_dbus_property(self, value=None):
2193
1389
if value is None: # get
2234
1422
if data[0] == 'data':
2236
1424
if data[0] == 'function':
2238
1425
def func(*args, **kwargs):
2239
1426
self._pipe.send(('funcall', name, args, kwargs))
2240
1427
return self._pipe.recv()[1]
2244
1430
def __setattr__(self, name, value):
2245
1431
if name == '_pipe':
2246
1432
return super(ProxyClient, self).__setattr__(name, value)
2247
1433
self._pipe.send(('setattr', name, value))
1436
class ClientDBusTransitional(ClientDBus):
1437
__metaclass__ = AlternateDBusNamesMetaclass
2250
1440
class ClientHandler(socketserver.BaseRequestHandler, object):
2251
1441
"""A class to handle client connections.
2253
1443
Instantiated once for each connection to handle it.
2254
1444
Note: This will run in its own forked process."""
2256
1446
def handle(self):
2257
1447
with contextlib.closing(self.server.child_pipe) as child_pipe:
2258
1448
logger.info("TCP connection from: %s",
2259
str(self.client_address))
1449
unicode(self.client_address))
2260
1450
logger.debug("Pipe FD: %d",
2261
1451
self.server.child_pipe.fileno())
2263
session = gnutls.ClientSession(self.request)
2265
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2266
# "+AES-256-CBC", "+SHA1",
2267
# "+COMP-NULL", "+CTYPE-OPENPGP",
1453
session = (gnutls.connection
1454
.ClientSession(self.request,
1456
.X509Credentials()))
1458
# Note: gnutls.connection.X509Credentials is really a
1459
# generic GnuTLS certificate credentials object so long as
1460
# no X.509 keys are added to it. Therefore, we can use it
1461
# here despite using OpenPGP certificates.
1463
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1464
# "+AES-256-CBC", "+SHA1",
1465
# "+COMP-NULL", "+CTYPE-OPENPGP",
2269
1467
# Use a fallback default, since this MUST be set.
2270
1468
priority = self.server.gnutls_priority
2271
1469
if priority is None:
2272
1470
priority = "NORMAL"
2273
gnutls.priority_set_direct(session._c_object,
2274
priority.encode("utf-8"),
1471
(gnutls.library.functions
1472
.gnutls_priority_set_direct(session._c_object,
2277
1475
# Start communication using the Mandos protocol
2278
1476
# Get protocol number
2279
1477
line = self.request.makefile().readline()
2280
1478
logger.debug("Protocol version: %r", line)
2282
1480
if int(line.strip().split()[0]) > 1:
2283
raise RuntimeError(line)
2284
1482
except (ValueError, IndexError, RuntimeError) as error:
2285
1483
logger.error("Unknown protocol version: %s", error)
2288
1486
# Start GnuTLS connection
2290
1488
session.handshake()
2291
except gnutls.Error as error:
1489
except gnutls.errors.GNUTLSError as error:
2292
1490
logger.warning("Handshake failed: %s", error)
2293
1491
# Do not run session.bye() here: the session is not
2294
1492
# established. Just abandon the request.
2296
1494
logger.debug("Handshake succeeded")
2298
1496
approval_required = False
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,
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,
2322
1509
self.client_address)
2323
1510
except KeyError:
1513
if self.server.use_dbus:
1515
client.NewRequest(str(self.client_address))
2326
1517
if client.approval_delay:
2327
1518
delay = client.approval_delay
2328
1519
client.approvals_pending += 1
2329
1520
approval_required = True
2332
1523
if not client.enabled:
2333
1524
logger.info("Client %s is disabled",
2335
1526
if self.server.use_dbus:
2336
1527
# Emit D-Bus signal
2337
1528
client.Rejected("Disabled")
2340
1531
if client.approved or not client.approval_delay:
2341
# We are approved or approval is disabled
1532
#We are approved or approval is disabled
2343
1534
elif client.approved is None:
2344
1535
logger.info("Client %s needs approval",
2377
1570
delay -= time2 - time
2380
session.send(client.secret)
2381
except gnutls.Error as error:
2382
logger.warning("gnutls send failed",
1573
while sent_size < len(client.secret):
1575
sent = session.send(client.secret[sent_size:])
1576
except gnutls.errors.GNUTLSError as error:
1577
logger.warning("gnutls send failed")
1579
logger.debug("Sent: %d, remaining: %d",
1580
sent, len(client.secret)
1581
- (sent_size + sent))
2386
1584
logger.info("Sending secret to %s", client.name)
2387
1585
# bump the timeout using extended_timeout
2388
client.bump_timeout(client.extended_timeout)
1586
client.checked_ok(client.extended_timeout)
2389
1587
if self.server.use_dbus:
2390
1588
# Emit D-Bus signal
2391
1589
client.GotSecret()
2394
1592
if approval_required:
2395
1593
client.approvals_pending -= 1
2398
except gnutls.Error as error:
2399
logger.warning("GnuTLS bye failed",
1596
except gnutls.errors.GNUTLSError as error:
1597
logger.warning("GnuTLS bye failed")
2403
1600
def peer_certificate(session):
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
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
2420
1608
list_size = ctypes.c_uint(1)
2421
cert_list = (gnutls.certificate_get_peers
1609
cert_list = (gnutls.library.functions
1610
.gnutls_certificate_get_peers
2422
1611
(session._c_object, ctypes.byref(list_size)))
2423
1612
if not bool(cert_list) and list_size.value != 0:
2424
raise gnutls.Error("error getting peer certificate")
1613
raise gnutls.errors.GNUTLSError("error getting peer"
2425
1615
if list_size.value == 0:
2427
1617
cert = cert_list[0]
2428
1618
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()
2465
1621
def fingerprint(openpgp):
2466
1622
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2467
1623
# New GnuTLS "datum" with the OpenPGP public key
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)))
1624
datum = (gnutls.library.types
1625
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1628
ctypes.c_uint(len(openpgp))))
2472
1629
# New empty GnuTLS certificate
2473
crt = gnutls.openpgp_crt_t()
2474
gnutls.openpgp_crt_init(ctypes.byref(crt))
1630
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1631
(gnutls.library.functions
1632
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2475
1633
# Import the OpenPGP public key into the certificate
2476
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2477
gnutls.OPENPGP_FMT_RAW)
1634
(gnutls.library.functions
1635
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1636
gnutls.library.constants
1637
.GNUTLS_OPENPGP_FMT_RAW))
2478
1638
# Verify the self signature in the key
2479
1639
crtverify = ctypes.c_uint()
2480
gnutls.openpgp_crt_verify_self(crt, 0,
2481
ctypes.byref(crtverify))
1640
(gnutls.library.functions
1641
.gnutls_openpgp_crt_verify_self(crt, 0,
1642
ctypes.byref(crtverify)))
2482
1643
if crtverify.value != 0:
2483
gnutls.openpgp_crt_deinit(crt)
2484
raise gnutls.CertificateSecurityError(code
1644
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1645
raise (gnutls.errors.CertificateSecurityError
2486
1647
# New buffer for the fingerprint
2487
1648
buf = ctypes.create_string_buffer(20)
2488
1649
buf_len = ctypes.c_size_t()
2489
1650
# Get the fingerprint from the certificate into the buffer
2490
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2491
ctypes.byref(buf_len))
1651
(gnutls.library.functions
1652
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1653
ctypes.byref(buf_len)))
2492
1654
# Deinit the certificate
2493
gnutls.openpgp_crt_deinit(crt)
1655
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2494
1656
# Convert the buffer to a Python bytestring
2495
1657
fpr = ctypes.string_at(buf, buf_len.value)
2496
1658
# Convert the bytestring to hexadecimal notation
2501
1663
class MultiprocessingMixIn(object):
2502
1664
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2504
1665
def sub_process_main(self, request, address):
2506
1667
self.finish_request(request, address)
2508
1669
self.handle_error(request, address)
2509
1670
self.close_request(request)
2511
1672
def process_request(self, request, address):
2512
1673
"""Start a new process to process the request."""
2513
proc = multiprocessing.Process(target=self.sub_process_main,
2514
args=(request, address))
1674
proc = multiprocessing.Process(target = self.sub_process_main,
2519
1681
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2520
1682
""" adds a pipe to the MixIn """
2522
1683
def process_request(self, request, client_address):
2523
1684
"""Overrides and wraps the original process_request().
2525
1686
This function creates a new pipe in self.pipe
2527
1688
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2529
1690
proc = MultiprocessingMixIn.process_request(self, request,
2530
1691
client_address)
2531
1692
self.child_pipe.close()
2532
1693
self.add_pipe(parent_pipe, proc)
2534
1695
def add_pipe(self, parent_pipe, proc):
2535
1696
"""Dummy function; override as necessary"""
2536
raise NotImplementedError()
1697
raise NotImplementedError
2539
1700
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2540
1701
socketserver.TCPServer, object):
2541
1702
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2544
1705
enabled: Boolean; whether this server is activated yet
2545
1706
interface: None or a network interface name (string)
2546
1707
use_ipv6: Boolean; to use IPv6 or not
2549
1709
def __init__(self, server_address, RequestHandlerClass,
2553
"""If socketfd is set, use that file descriptor instead of
2554
creating a new one with socket.socket().
1710
interface=None, use_ipv6=True):
2556
1711
self.interface = interface
2558
1713
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.
2586
1714
socketserver.TCPServer.__init__(self, server_address,
2587
1715
RequestHandlerClass)
2589
1716
def server_bind(self):
2590
1717
"""This overrides the normal server_bind() function
2591
1718
to bind to an interface if one was specified, and also NOT to
2592
1719
bind to an address or port if they were not specified."""
2593
global SO_BINDTODEVICE
2594
1720
if self.interface is not None:
2595
1721
if SO_BINDTODEVICE is None:
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)
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",
2617
1742
# Only bind(2) the socket if we really need to.
2618
1743
if self.server_address[0] or self.server_address[1]:
2619
1744
if not self.server_address[0]:
2620
1745
if self.address_family == socket.AF_INET6:
2621
any_address = "::" # in6addr_any
1746
any_address = "::" # in6addr_any
2623
any_address = "0.0.0.0" # INADDR_ANY
1748
any_address = socket.INADDR_ANY
2624
1749
self.server_address = (any_address,
2625
1750
self.server_address[1])
2626
1751
elif not self.server_address[1]:
2627
self.server_address = (self.server_address[0], 0)
1752
self.server_address = (self.server_address[0],
2628
1754
# if self.interface:
2629
1755
# self.server_address = (self.server_address[0],
2731
1859
funcname = request[1]
2732
1860
args = request[2]
2733
1861
kwargs = request[3]
2735
1863
parent_pipe.send(('data', getattr(client_object,
2736
1864
funcname)(*args,
2739
1867
if command == 'getattr':
2740
1868
attrname = request[1]
2741
if isinstance(client_object.__getattribute__(attrname),
2742
collections.Callable):
2743
parent_pipe.send(('function', ))
1869
if callable(client_object.__getattribute__(attrname)):
1870
parent_pipe.send(('function',))
2746
'data', client_object.__getattribute__(attrname)))
1872
parent_pipe.send(('data', client_object
1873
.__getattribute__(attrname)))
2748
1875
if command == 'setattr':
2749
1876
attrname = request[1]
2750
1877
value = request[2]
2751
1878
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}"
2855
1883
def string_to_delta(interval):
2856
1884
"""Parse a string and return a datetime.timedelta
2858
1886
>>> string_to_delta('7d')
2859
1887
datetime.timedelta(7)
2860
1888
>>> string_to_delta('60s')
2955
1977
parser.add_argument("--no-dbus", action="store_false",
2956
1978
dest="use_dbus", help="Do not provide D-Bus"
2957
" system bus interface", default=None)
1979
" system bus interface")
2958
1980
parser.add_argument("--no-ipv6", action="store_false",
2959
dest="use_ipv6", help="Do not use IPv6",
1981
dest="use_ipv6", help="Do not use IPv6")
2961
1982
parser.add_argument("--no-restore", action="store_false",
2962
1983
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")
2967
1985
parser.add_argument("--statedir", metavar="DIR",
2968
1986
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",
2975
1988
options = parser.parse_args()
2977
1990
if options.check:
2979
fail_count, test_count = doctest.testmod()
2980
sys.exit(os.EX_OK if fail_count == 0 else 1)
2982
1995
# Default values for config file for server-global settings
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",
1996
server_defaults = { "interface": "",
2001
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2002
"servicename": "Mandos",
2007
"statedir": "/var/lib/mandos"
3006
2010
# Parse config file for server-global settings
3007
2011
server_config = configparser.SafeConfigParser(server_defaults)
3008
2012
del server_defaults
3009
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2013
server_config.read(os.path.join(options.configdir,
3010
2015
# Convert the SafeConfigParser object to a dict
3011
2016
server_settings = server_config.defaults()
3012
2017
# Use the appropriate methods on the non-string config options
3013
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3014
"foreground", "zeroconf"):
2018
for option in ("debug", "use_dbus", "use_ipv6"):
3015
2019
server_settings[option] = server_config.getboolean("DEFAULT",
3017
2021
if server_settings["port"]:
3018
2022
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
3029
2024
del server_config
3031
2026
# Override the settings from the config file with command line
3032
2027
# options, if set.
3033
2028
for option in ("interface", "address", "port", "debug",
3034
"priority", "servicename", "configdir", "use_dbus",
3035
"use_ipv6", "debuglevel", "restore", "statedir",
3036
"socket", "foreground", "zeroconf"):
2029
"priority", "servicename", "configdir",
2030
"use_dbus", "use_ipv6", "debuglevel", "restore",
3037
2032
value = getattr(options, option)
3038
2033
if value is not None:
3039
2034
server_settings[option] = value
3041
2036
# Force all strings to be unicode
3042
2037
for option in server_settings.keys():
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
2038
if type(server_settings[option]) is str:
2039
server_settings[option] = unicode(server_settings[option])
3053
2040
# Now we have our good server settings in "server_settings"
3055
2042
##################################################################
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")
3062
2044
# For convenience
3063
2045
debug = server_settings["debug"]
3064
2046
debuglevel = server_settings["debuglevel"]
3066
2048
use_ipv6 = server_settings["use_ipv6"]
3067
2049
stored_state_path = os.path.join(server_settings["statedir"],
3068
2050
stored_state_file)
3069
foreground = server_settings["foreground"]
3070
zeroconf = server_settings["zeroconf"]
3073
initlogger(debug, logging.DEBUG)
2053
initlogger(logging.DEBUG)
3075
2055
if not debuglevel:
3078
2058
level = getattr(logging, debuglevel.upper())
3079
initlogger(debug, level)
3081
2061
if server_settings["servicename"] != "Mandos":
3082
syslogger.setFormatter(
3083
logging.Formatter('Mandos ({}) [%(process)d]:'
3084
' %(levelname)s: %(message)s'.format(
3085
server_settings["servicename"])))
2062
syslogger.setFormatter(logging.Formatter
2063
('Mandos (%s) [%%(process)d]:'
2064
' %%(levelname)s: %%(message)s'
2065
% server_settings["servicename"]))
3087
2067
# Parse config file with clients
3088
client_config = configparser.SafeConfigParser(Client
2068
client_defaults = { "timeout": "5m",
2069
"extended_timeout": "15m",
2071
"checker": "fping -q -- %%(host)s",
2073
"approval_delay": "0s",
2074
"approval_duration": "1s",
2076
client_config = configparser.SafeConfigParser(client_defaults)
3090
2077
client_config.read(os.path.join(server_settings["configdir"],
3091
2078
"clients.conf"))
3093
2080
global mandos_dbus_service
3094
2081
mandos_dbus_service = None
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
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
3125
2106
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,
3136
2116
except OSError as error:
3137
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3138
.format(uid, gid, os.strerror(error.errno)))
3139
if error.errno != errno.EPERM:
2117
if error[0] != errno.EPERM:
3143
2121
# Enable all possible GnuTLS debugging
3145
2123
# "Use a log level over 10 to enable all debugging options."
3146
2124
# - GnuTLS manual
3147
gnutls.global_set_log_level(11)
2125
gnutls.library.functions.gnutls_global_set_log_level(11)
2127
@gnutls.library.types.gnutls_log_func
3150
2128
def debug_gnutls(level, string):
3151
2129
logger.debug("GnuTLS: %s", string[:-1])
3153
gnutls.global_set_log_function(debug_gnutls)
2131
(gnutls.library.functions
2132
.gnutls_global_set_log_function(debug_gnutls))
3155
2134
# Redirect stdin so all checkers get /dev/null
3156
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2135
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3157
2136
os.dup2(null, sys.stdin.fileno())
2140
# No console logging
2141
logger.removeHandler(console)
3161
2143
# Need to fork before connecting to D-Bus
3163
2145
# 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.
3170
2148
global main_loop
3171
2149
# From the Avahi example code
3172
DBusGMainLoop(set_as_default=True)
3173
main_loop = GLib.MainLoop()
2150
DBusGMainLoop(set_as_default=True )
2151
main_loop = gobject.MainLoop()
3174
2152
bus = dbus.SystemBus()
3175
2153
# End of Avahi example code
3178
2156
bus_name = dbus.service.BusName("se.recompile.Mandos",
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)
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")
3186
2163
use_dbus = False
3187
2164
server_settings["use_dbus"] = False
3188
2165
tcp_server.use_dbus = False
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"))
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"])))
3200
2175
global multiprocessing_manager
3201
2176
multiprocessing_manager = multiprocessing.Manager()
3203
2178
client_class = Client
3205
client_class = functools.partial(ClientDBus, bus=bus)
3207
client_settings = Client.config_parser(client_config)
2180
client_class = functools.partial(ClientDBusTransitional,
2183
special_settings = {
2184
# Some settings need to be accessd by special methods;
2185
# booleans need .getboolean(), etc. Here is a list of them:
2186
"approved_by_default":
2188
client_config.getboolean(section, "approved_by_default"),
2191
client_config.getboolean(section, "enabled"),
2193
# Construct a new dict of client settings of this form:
2194
# { client_name: {setting_name: value, ...}, ...}
2195
# with exceptions for any special settings as defined above
2196
client_settings = dict((clientname,
2199
if setting not in special_settings
2200
else special_settings[setting]
2202
for setting, value in
2203
client_config.items(clientname)))
2204
for clientname in client_config.sections())
3208
2206
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:
3219
2209
# Get client data and settings from last running state.
3220
2210
if server_settings["restore"]:
3222
2212
with open(stored_state_path, "rb") as stored_state:
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"]
2213
clients_data, old_client_settings = (pickle.load
3272
2215
os.remove(stored_state_path)
3273
2216
except IOError as e:
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:",
2217
logger.warning("Could not load persistent state: {0}"
2219
if e.errno != errno.ENOENT:
3281
except EOFError as e:
3282
logger.warning("Could not load persistent state: "
3286
2222
with PGPEngine() as pgp:
3287
for client_name, client in clients_data.items():
3288
# Skip removed clients
3289
if client_name not in client_settings:
2223
for client in clients_data:
2224
client_name = client["name"]
3292
2226
# Decide which value to use after restoring saved state.
3293
2227
# We have three different values: Old config file,
3294
2228
# new config file, and saved state.
3299
2233
# For each value in new config, check if it
3300
2234
# differs from the old config value (Except for
3301
2235
# the "secret" attribute)
3302
if (name != "secret"
3304
old_client_settings[client_name][name])):
3305
client[name] = value
2236
if (name != "secret" and
2237
value != old_client_settings[client_name]
2239
setattr(client, name, value)
3306
2240
except KeyError:
3309
2243
# Clients who has passed its expire date can still be
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
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.
3314
2247
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"]))
2248
if client["expires"] <= (datetime.datetime
2250
# Client has expired
2251
if client["last_checker_status"] != 0:
3329
2252
client["enabled"] = False
3331
client["expires"] = (
3332
datetime.datetime.utcnow()
3333
+ client["timeout"])
3334
logger.debug("Last checker succeeded,"
3335
" keeping {} enabled".format(
2254
client["expires"] = (datetime.datetime
2256
+ client["timeout"])
2258
client["changedstate"] = (multiprocessing_manager
2260
(multiprocessing_manager
2263
new_client = (ClientDBusTransitional.__new__
2264
(ClientDBusTransitional))
2265
tcp_server.clients[client_name] = new_client
2266
new_client.bus = bus
2267
for name, value in client.iteritems():
2268
setattr(new_client, name, value)
2269
client_object_name = unicode(client_name).translate(
2270
{ord("."): ord("_"),
2271
ord("-"): ord("_")})
2272
new_client.dbus_object_path = (dbus.ObjectPath
2274
+ client_object_name))
2275
DBusObjectWithProperties.__init__(new_client,
2280
tcp_server.clients[client_name] = (Client.__new__
2282
for name, value in client.iteritems():
2283
setattr(tcp_server.clients[client_name],
3338
client["secret"] = pgp.decrypt(
3339
client["encrypted_secret"],
3340
client_settings[client_name]["secret"])
2287
tcp_server.clients[client_name].secret = (
2288
pgp.decrypt(tcp_server.clients[client_name]
2290
client_settings[client_name]
3341
2292
except PGPError:
3342
2293
# If decryption fails, we use secret from new settings
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)
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
3363
2309
if not tcp_server.clients:
3364
2310
logger.warning("No clients defined")
3367
if pidfile is not None:
3371
print(pid, file=pidfile)
3373
logger.error("Could not write to file %r with PID %d",
2316
pidfile.write(str(pid) + "\n".encode("utf-8"))
2319
logger.error("Could not write to file %r with PID %d",
2322
# "pidfile" was never created
3376
2324
del pidfilename
3378
for termsig in (signal.SIGHUP, signal.SIGTERM):
3379
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3380
lambda: main_loop.quit() and False)
2326
signal.signal(signal.SIGINT, signal.SIG_IGN)
2328
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2329
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3384
@alternate_dbus_interfaces(
3385
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3386
class MandosDBusService(DBusObjectWithObjectManager):
2332
class MandosDBusService(dbus.service.Object):
3387
2333
"""A D-Bus proxy object"""
3389
2334
def __init__(self):
3390
2335
dbus.service.Object.__init__(self, bus, "/")
3392
2336
_interface = "se.recompile.Mandos"
3394
2338
@dbus.service.signal(_interface, signature="o")
3395
2339
def ClientAdded(self, objpath):
3399
2343
@dbus.service.signal(_interface, signature="ss")
3400
def ClientNotFound(self, key_id, address):
2344
def ClientNotFound(self, fingerprint, address):
3404
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3406
2348
@dbus.service.signal(_interface, signature="os")
3407
2349
def ClientRemoved(self, objpath, name):
3411
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3413
2353
@dbus.service.method(_interface, out_signature="ao")
3414
2354
def GetAllClients(self):
3416
return dbus.Array(c.dbus_object_path for c in
3417
tcp_server.clients.values())
3419
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2356
return dbus.Array(c.dbus_object_path
2358
tcp_server.clients.itervalues())
3421
2360
@dbus.service.method(_interface,
3422
2361
out_signature="a{oa{sv}}")
3423
2362
def GetAllClientsWithProperties(self):
3425
2364
return dbus.Dictionary(
3426
{c.dbus_object_path: c.GetAll(
3427
"se.recompile.Mandos.Client")
3428
for c in tcp_server.clients.values()},
2365
((c.dbus_object_path, c.GetAll(""))
2366
for c in tcp_server.clients.itervalues()),
3429
2367
signature="oa{sv}")
3431
2369
@dbus.service.method(_interface, in_signature="o")
3432
2370
def RemoveClient(self, object_path):
3434
for c in tcp_server.clients.values():
2372
for c in tcp_server.clients.itervalues():
3435
2373
if c.dbus_object_path == object_path:
3436
2374
del tcp_server.clients[c.name]
3437
2375
c.remove_from_connection()
3438
# Don't signal the disabling
2376
# Don't signal anything except ClientRemoved
3439
2377
c.disable(quiet=True)
3440
# Emit D-Bus signal for removal
3441
self.client_removed_signal(c)
2379
self.ClientRemoved(object_path, c.name)
3443
2381
raise KeyError(object_path)
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
2385
class MandosDBusServiceTransitional(MandosDBusService):
2386
__metaclass__ = AlternateDBusNamesMetaclass
2387
mandos_dbus_service = MandosDBusServiceTransitional()
3491
2390
"Cleanup function; run on exit"
3495
mp.active_children()
2393
multiprocessing.active_children()
3497
2394
if not (tcp_server.clients or client_settings):
3500
2397
# Store client before exiting. Secrets are encrypted with key
3501
2398
# based on what config file has. If config file is
3502
2399
# removed/edited, old secret will thus be unrecovable.
3504
2401
with PGPEngine() as pgp:
3505
for client in tcp_server.clients.values():
2402
for client in tcp_server.clients.itervalues():
3506
2403
key = client_settings[client.name]["secret"]
3507
2404
client.encrypted_secret = pgp.encrypt(client.secret,
3509
2406
client_dict = {}
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
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)):
3517
2413
exclude.add(name)
3519
2415
client_dict["encrypted_secret"] = (client
3520
2416
.encrypted_secret)
3521
2417
for attr in client.client_structure:
3522
2418
if attr not in exclude:
3523
2419
client_dict[attr] = getattr(client, attr)
3525
clients[client.name] = client_dict
2421
clients.append(client_dict)
3526
2422
del client_settings[client.name]["secret"]
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)
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)
3539
2429
except (IOError, OSError) as e:
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:",
2430
logger.warning("Could not save persistent state: {0}"
2432
if e.errno not in (errno.ENOENT, errno.EACCES):
3553
2435
# Delete all clients, and settings from config
3554
2436
while tcp_server.clients:
3555
2437
name, client = tcp_server.clients.popitem()
3557
2439
client.remove_from_connection()
3558
# Don't signal the disabling
2440
# Don't signal anything except ClientRemoved
3559
2441
client.disable(quiet=True)
3560
# Emit D-Bus signal for removal
3562
mandos_dbus_service.client_removed_signal(client)
2444
mandos_dbus_service.ClientRemoved(client
3563
2447
client_settings.clear()
3565
2449
atexit.register(cleanup)
3567
for client in tcp_server.clients.values():
2451
for client in tcp_server.clients.itervalues():
3569
# Emit D-Bus signal for adding
3570
mandos_dbus_service.client_added_signal(client)
2454
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3571
2455
# Need to initiate checking of clients
3572
2456
if client.enabled:
3573
2457
client.init_checker()
3575
2459
tcp_server.enable()
3576
2460
tcp_server.server_activate()
3578
2462
# Find out what port we got
3580
service.port = tcp_server.socket.getsockname()[1]
2463
service.port = tcp_server.socket.getsockname()[1]
3582
2465
logger.info("Now listening on address %r, port %d,"
3583
" flowinfo %d, scope_id %d",
3584
*tcp_server.socket.getsockname())
2466
" flowinfo %d, scope_id %d"
2467
% tcp_server.socket.getsockname())
3586
logger.info("Now listening on address %r, port %d",
3587
*tcp_server.socket.getsockname())
3589
# service.interface = tcp_server.socket.getsockname()[3]
2469
logger.info("Now listening on address %r, port %d"
2470
% tcp_server.socket.getsockname())
2472
#service.interface = tcp_server.socket.getsockname()[3]
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))
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))
3607
2489
logger.debug("Starting main loop")
3608
2490
main_loop.run()
3609
2491
except AvahiError as error:
3610
logger.critical("Avahi Error", exc_info=error)
2492
logger.critical("AvahiError: %s", error)
3613
2495
except KeyboardInterrupt: