255
166
os.rmdir(self.tempdir)
256
167
self.tempdir = None
258
169
def password_encode(self, password):
259
170
# Passphrase can not be empty and can not contain newlines or
260
171
# NUL bytes. So we prefix it and hex encode it.
261
encoded = b"mandos" + binascii.hexlify(password)
262
if len(encoded) > 2048:
263
# GnuPG can't handle long passwords, so encode differently
264
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
265
.replace(b"\n", b"\\n")
266
.replace(b"\0", b"\\x00"))
172
return b"mandos" + binascii.hexlify(password)
269
174
def encrypt(self, data, password):
270
passphrase = self.password_encode(password)
271
with tempfile.NamedTemporaryFile(
272
dir=self.tempdir) as passfile:
273
passfile.write(passphrase)
275
proc = subprocess.Popen([self.gpg, '--symmetric',
279
stdin=subprocess.PIPE,
280
stdout=subprocess.PIPE,
281
stderr=subprocess.PIPE)
282
ciphertext, err = proc.communicate(input=data)
283
if proc.returncode != 0:
175
self.gnupg.passphrase = self.password_encode(password)
176
with open(os.devnull) as devnull:
178
proc = self.gnupg.run(['--symmetric'],
179
create_fhs=['stdin', 'stdout'],
180
attach_fhs={'stderr': devnull})
181
with contextlib.closing(proc.handles['stdin']) as f:
183
with contextlib.closing(proc.handles['stdout']) as f:
184
ciphertext = f.read()
188
self.gnupg.passphrase = None
285
189
return ciphertext
287
191
def decrypt(self, data, password):
288
passphrase = self.password_encode(password)
289
with tempfile.NamedTemporaryFile(
290
dir=self.tempdir) as passfile:
291
passfile.write(passphrase)
293
proc = subprocess.Popen([self.gpg, '--decrypt',
297
stdin=subprocess.PIPE,
298
stdout=subprocess.PIPE,
299
stderr=subprocess.PIPE)
300
decrypted_plaintext, err = proc.communicate(input=data)
301
if proc.returncode != 0:
192
self.gnupg.passphrase = self.password_encode(password)
193
with open(os.devnull) as devnull:
195
proc = self.gnupg.run(['--decrypt'],
196
create_fhs=['stdin', 'stdout'],
197
attach_fhs={'stderr': devnull})
198
with contextlib.closing(proc.handles['stdin'] ) as f:
200
with contextlib.closing(proc.handles['stdout']) as f:
201
decrypted_plaintext = f.read()
205
self.gnupg.passphrase = None
303
206
return decrypted_plaintext
306
# Pretend that we have an Avahi module
308
"""This isn't so much a class as it is a module-like namespace."""
309
IF_UNSPEC = -1 # avahi-common/address.h
310
PROTO_UNSPEC = -1 # avahi-common/address.h
311
PROTO_INET = 0 # avahi-common/address.h
312
PROTO_INET6 = 1 # avahi-common/address.h
313
DBUS_NAME = "org.freedesktop.Avahi"
314
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
315
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
316
DBUS_PATH_SERVER = "/"
319
def string_array_to_txt_array(t):
320
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
321
for s in t), signature="ay")
322
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
323
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
324
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
325
SERVER_INVALID = 0 # avahi-common/defs.h
326
SERVER_REGISTERING = 1 # avahi-common/defs.h
327
SERVER_RUNNING = 2 # avahi-common/defs.h
328
SERVER_COLLISION = 3 # avahi-common/defs.h
329
SERVER_FAILURE = 4 # avahi-common/defs.h
332
210
class AvahiError(Exception):
333
211
def __init__(self, value, *args, **kwargs):
334
212
self.value = value
335
return super(AvahiError, self).__init__(value, *args,
213
super(AvahiError, self).__init__(value, *args, **kwargs)
214
def __unicode__(self):
215
return unicode(repr(self.value))
339
217
class AvahiServiceError(AvahiError):
343
220
class AvahiGroupError(AvahiError):
224
class AvahiService(object):
348
225
"""An Avahi (Zeroconf) service.
351
228
interface: integer; avahi.IF_UNSPEC or an interface index.
352
229
Used to optionally bind to the specified interface.
353
230
name: string; Example: 'Mandos'
354
231
type: string; Example: '_mandos._tcp'.
355
See <https://www.iana.org/assignments/service-names-port-numbers>
232
See <http://www.dns-sd.org/ServiceTypes.html>
356
233
port: integer; what port to announce
357
234
TXT: list of strings; TXT record for the service
358
235
domain: string; Domain to publish on, default to .local if empty.
517
364
follow_name_owner_changes=True),
518
365
avahi.DBUS_INTERFACE_SERVER)
519
366
self.server.connect_to_signal("StateChanged",
520
self.server_state_changed)
367
self.server_state_changed)
521
368
self.server_state_changed(self.server.GetState())
524
370
class AvahiServiceToSyslog(AvahiService):
525
def rename(self, *args, **kwargs):
526
372
"""Add the new name to the syslog messages"""
527
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
528
syslogger.setFormatter(logging.Formatter(
529
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
373
ret = AvahiService.rename(self)
374
syslogger.setFormatter(logging.Formatter
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
534
# Pretend that we have a GnuTLS module
536
"""This isn't so much a class as it is a module-like namespace."""
538
library = ctypes.util.find_library("gnutls")
540
library = ctypes.util.find_library("gnutls-deb0")
541
_library = ctypes.cdll.LoadLibrary(library)
544
# Unless otherwise indicated, the constants and types below are
545
# all from the gnutls/gnutls.h C header file.
556
E_NO_CERTIFICATE_FOUND = -49
561
KEYID_USE_SHA256 = 1 # gnutls/x509.h
562
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
565
class session_int(ctypes.Structure):
567
session_t = ctypes.POINTER(session_int)
569
class certificate_credentials_st(ctypes.Structure):
571
certificate_credentials_t = ctypes.POINTER(
572
certificate_credentials_st)
573
certificate_type_t = ctypes.c_int
575
class datum_t(ctypes.Structure):
576
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
577
('size', ctypes.c_uint)]
579
class openpgp_crt_int(ctypes.Structure):
581
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
583
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
credentials_type_t = ctypes.c_int
585
transport_ptr_t = ctypes.c_void_p
586
close_request_t = ctypes.c_int
589
class Error(Exception):
590
def __init__(self, message=None, code=None, args=()):
591
# Default usage is by a message string, but if a return
592
# code is passed, convert it to a string with
595
if message is None and code is not None:
596
message = gnutls.strerror(code)
597
return super(gnutls.Error, self).__init__(
600
class CertificateSecurityError(Error):
606
self._c_object = gnutls.certificate_credentials_t()
607
gnutls.certificate_allocate_credentials(
608
ctypes.byref(self._c_object))
609
self.type = gnutls.CRD_CERTIFICATE
612
gnutls.certificate_free_credentials(self._c_object)
615
def __init__(self, socket, credentials=None):
616
self._c_object = gnutls.session_t()
617
gnutls_flags = gnutls.CLIENT
618
if gnutls.check_version(b"3.5.6"):
619
gnutls_flags |= gnutls.NO_TICKETS
621
gnutls_flags |= gnutls.ENABLE_RAWPK
622
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
624
gnutls.set_default_priority(self._c_object)
625
gnutls.transport_set_ptr(self._c_object, socket.fileno())
626
gnutls.handshake_set_private_extensions(self._c_object,
629
if credentials is None:
630
credentials = gnutls.Credentials()
631
gnutls.credentials_set(self._c_object, credentials.type,
632
ctypes.cast(credentials._c_object,
634
self.credentials = credentials
637
gnutls.deinit(self._c_object)
640
return gnutls.handshake(self._c_object)
642
def send(self, data):
646
data_len -= gnutls.record_send(self._c_object,
651
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
653
# Error handling functions
654
def _error_code(result):
655
"""A function to raise exceptions on errors, suitable
656
for the 'restype' attribute on ctypes functions"""
659
if result == gnutls.E_NO_CERTIFICATE_FOUND:
660
raise gnutls.CertificateSecurityError(code=result)
661
raise gnutls.Error(code=result)
663
def _retry_on_error(result, func, arguments):
664
"""A function to retry on some errors, suitable
665
for the 'errcheck' attribute on ctypes functions"""
667
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
668
return _error_code(result)
669
result = func(*arguments)
672
# Unless otherwise indicated, the function declarations below are
673
# all from the gnutls/gnutls.h C header file.
676
priority_set_direct = _library.gnutls_priority_set_direct
677
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
678
ctypes.POINTER(ctypes.c_char_p)]
679
priority_set_direct.restype = _error_code
681
init = _library.gnutls_init
682
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
683
init.restype = _error_code
685
set_default_priority = _library.gnutls_set_default_priority
686
set_default_priority.argtypes = [session_t]
687
set_default_priority.restype = _error_code
689
record_send = _library.gnutls_record_send
690
record_send.argtypes = [session_t, ctypes.c_void_p,
692
record_send.restype = ctypes.c_ssize_t
693
record_send.errcheck = _retry_on_error
695
certificate_allocate_credentials = (
696
_library.gnutls_certificate_allocate_credentials)
697
certificate_allocate_credentials.argtypes = [
698
ctypes.POINTER(certificate_credentials_t)]
699
certificate_allocate_credentials.restype = _error_code
701
certificate_free_credentials = (
702
_library.gnutls_certificate_free_credentials)
703
certificate_free_credentials.argtypes = [
704
certificate_credentials_t]
705
certificate_free_credentials.restype = None
707
handshake_set_private_extensions = (
708
_library.gnutls_handshake_set_private_extensions)
709
handshake_set_private_extensions.argtypes = [session_t,
711
handshake_set_private_extensions.restype = None
713
credentials_set = _library.gnutls_credentials_set
714
credentials_set.argtypes = [session_t, credentials_type_t,
716
credentials_set.restype = _error_code
718
strerror = _library.gnutls_strerror
719
strerror.argtypes = [ctypes.c_int]
720
strerror.restype = ctypes.c_char_p
722
certificate_type_get = _library.gnutls_certificate_type_get
723
certificate_type_get.argtypes = [session_t]
724
certificate_type_get.restype = _error_code
726
certificate_get_peers = _library.gnutls_certificate_get_peers
727
certificate_get_peers.argtypes = [session_t,
728
ctypes.POINTER(ctypes.c_uint)]
729
certificate_get_peers.restype = ctypes.POINTER(datum_t)
731
global_set_log_level = _library.gnutls_global_set_log_level
732
global_set_log_level.argtypes = [ctypes.c_int]
733
global_set_log_level.restype = None
735
global_set_log_function = _library.gnutls_global_set_log_function
736
global_set_log_function.argtypes = [log_func]
737
global_set_log_function.restype = None
739
deinit = _library.gnutls_deinit
740
deinit.argtypes = [session_t]
741
deinit.restype = None
743
handshake = _library.gnutls_handshake
744
handshake.argtypes = [session_t]
745
handshake.restype = _error_code
746
handshake.errcheck = _retry_on_error
748
transport_set_ptr = _library.gnutls_transport_set_ptr
749
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
750
transport_set_ptr.restype = None
752
bye = _library.gnutls_bye
753
bye.argtypes = [session_t, close_request_t]
754
bye.restype = _error_code
755
bye.errcheck = _retry_on_error
757
check_version = _library.gnutls_check_version
758
check_version.argtypes = [ctypes.c_char_p]
759
check_version.restype = ctypes.c_char_p
761
_need_version = b"3.3.0"
762
if check_version(_need_version) is None:
763
raise self.Error("Needs GnuTLS {} or later"
764
.format(_need_version))
766
_tls_rawpk_version = b"3.6.6"
767
has_rawpk = bool(check_version(_tls_rawpk_version))
771
class pubkey_st(ctypes.Structure):
773
pubkey_t = ctypes.POINTER(pubkey_st)
775
x509_crt_fmt_t = ctypes.c_int
777
# All the function declarations below are from gnutls/abstract.h
778
pubkey_init = _library.gnutls_pubkey_init
779
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
780
pubkey_init.restype = _error_code
782
pubkey_import = _library.gnutls_pubkey_import
783
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
785
pubkey_import.restype = _error_code
787
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
788
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
789
ctypes.POINTER(ctypes.c_ubyte),
790
ctypes.POINTER(ctypes.c_size_t)]
791
pubkey_get_key_id.restype = _error_code
793
pubkey_deinit = _library.gnutls_pubkey_deinit
794
pubkey_deinit.argtypes = [pubkey_t]
795
pubkey_deinit.restype = None
797
# All the function declarations below are from gnutls/openpgp.h
799
openpgp_crt_init = _library.gnutls_openpgp_crt_init
800
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
801
openpgp_crt_init.restype = _error_code
803
openpgp_crt_import = _library.gnutls_openpgp_crt_import
804
openpgp_crt_import.argtypes = [openpgp_crt_t,
805
ctypes.POINTER(datum_t),
807
openpgp_crt_import.restype = _error_code
809
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
810
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
811
ctypes.POINTER(ctypes.c_uint)]
812
openpgp_crt_verify_self.restype = _error_code
814
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
815
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
816
openpgp_crt_deinit.restype = None
818
openpgp_crt_get_fingerprint = (
819
_library.gnutls_openpgp_crt_get_fingerprint)
820
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
824
openpgp_crt_get_fingerprint.restype = _error_code
826
if check_version(b"3.6.4"):
827
certificate_type_get2 = _library.gnutls_certificate_type_get2
828
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
829
certificate_type_get2.restype = _error_code
831
# Remove non-public functions
832
del _error_code, _retry_on_error
835
def call_pipe(connection, # : multiprocessing.Connection
836
func, *args, **kwargs):
837
"""This function is meant to be called by multiprocessing.Process
839
This function runs func(*args, **kwargs), and writes the resulting
840
return value on the provided multiprocessing.Connection.
842
connection.send(func(*args, **kwargs))
380
def timedelta_to_milliseconds(td):
381
"Convert a datetime.timedelta() to milliseconds"
382
return ((td.days * 24 * 60 * 60 * 1000)
383
+ (td.seconds * 1000)
384
+ (td.microseconds // 1000))
386
class Client(object):
847
387
"""A representation of a client host served by this server.
850
390
approved: bool(); 'None' if not yet approved/disapproved
851
391
approval_delay: datetime.timedelta(); Time to wait for approval
852
392
approval_duration: datetime.timedelta(); Duration of one approval
853
checker: multiprocessing.Process(); a running checker process used
854
to see if the client lives. 'None' if no process is
856
checker_callback_tag: a GLib event source tag, or None
393
checker: subprocess.Popen(); a running checker process used
394
to see if the client lives.
395
'None' if no process is running.
396
checker_callback_tag: a gobject event source tag, or None
857
397
checker_command: string; External command which is run to check
858
398
if client lives. %() expansions are done at
859
399
runtime with vars(self) as dict, so that for
860
400
instance %(name)s can be used in the command.
861
checker_initiator_tag: a GLib event source tag, or None
401
checker_initiator_tag: a gobject event source tag, or None
862
402
created: datetime.datetime(); (UTC) object creation
863
403
client_structure: Object describing what attributes a client has
864
404
and is used for storing the client at exit
865
405
current_checker_command: string; current running checker_command
866
disable_initiator_tag: a GLib event source tag, or None
406
disable_initiator_tag: a gobject event source tag, or None
868
408
fingerprint: string (40 or 32 hexadecimal digits); used to
869
uniquely identify an OpenPGP client
870
key_id: string (64 hexadecimal digits); used to uniquely identify
871
a client using raw public keys
409
uniquely identify the client
872
410
host: string; available for use by the checker command
873
411
interval: datetime.timedelta(); How often to start a new checker
874
412
last_approval_request: datetime.datetime(); (UTC) or None
875
413
last_checked_ok: datetime.datetime(); (UTC) or None
876
415
last_checker_status: integer between 0 and 255 reflecting exit
877
416
status of last checker. -1 reflects crashed
878
checker, -2 means no checker completed yet.
879
last_checker_signal: The signal which killed the last checker, if
880
last_checker_status is -1
881
418
last_enabled: datetime.datetime(); (UTC) or None
882
419
name: string; from the config file, used in log messages and
883
420
D-Bus identifiers
884
421
secret: bytestring; sent verbatim (over TLS) to client
885
422
timeout: datetime.timedelta(); How long from last_checked_ok
886
423
until this client is disabled
887
extended_timeout: extra long timeout when secret has been sent
424
extended_timeout: extra long timeout when password has been sent
888
425
runtime_expansions: Allowed attributes for runtime expansion.
889
426
expires: datetime.datetime(); time (UTC) when a client will be
890
427
disabled, or None
891
server_settings: The server_settings dict from main()
894
430
runtime_expansions = ("approval_delay", "approval_duration",
895
"created", "enabled", "expires", "key_id",
896
"fingerprint", "host", "interval",
897
"last_approval_request", "last_checked_ok",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
898
433
"last_enabled", "name", "timeout")
901
"extended_timeout": "PT15M",
903
"checker": "fping -q -- %%(host)s",
905
"approval_delay": "PT0S",
906
"approval_duration": "PT1S",
907
"approved_by_default": "True",
434
client_defaults = { "timeout": "5m",
435
"extended_timeout": "15m",
437
"checker": "fping -q -- %%(host)s",
439
"approval_delay": "0s",
440
"approval_duration": "1s",
441
"approved_by_default": "True",
445
def timeout_milliseconds(self):
446
"Return the 'timeout' attribute in milliseconds"
447
return timedelta_to_milliseconds(self.timeout)
449
def extended_timeout_milliseconds(self):
450
"Return the 'extended_timeout' attribute in milliseconds"
451
return timedelta_to_milliseconds(self.extended_timeout)
453
def interval_milliseconds(self):
454
"Return the 'interval' attribute in milliseconds"
455
return timedelta_to_milliseconds(self.interval)
457
def approval_delay_milliseconds(self):
458
return timedelta_to_milliseconds(self.approval_delay)
912
461
def config_parser(config):
913
"""Construct a new dict of client settings of this form:
462
""" Construct a new dict of client settings of this form:
914
463
{ client_name: {setting_name: value, ...}, ...}
915
with exceptions for any special settings as defined above.
916
NOTE: Must be a pure function. Must return the same result
917
value given the same arguments.
464
with exceptions for any special settings as defined above"""
920
466
for client_name in config.sections():
921
467
section = dict(config.items(client_name))
922
468
client = settings[client_name] = {}
924
client["host"] = section["host"]
470
# Default copying each value from config to new dict
471
for setting, value in section.iteritems():
472
client[setting] = value
925
474
# Reformat values from string types to Python types
926
475
client["approved_by_default"] = config.getboolean(
927
476
client_name, "approved_by_default")
928
client["enabled"] = config.getboolean(client_name,
931
# Uppercase and remove spaces from key_id and fingerprint
932
# for later comparison purposes with return value from the
933
# key_id() and fingerprint() functions
934
client["key_id"] = (section.get("key_id", "").upper()
477
client["enabled"] = config.getboolean(client_name, "enabled")
936
479
client["fingerprint"] = (section["fingerprint"].upper()
937
480
.replace(" ", ""))
938
481
if "secret" in section:
939
client["secret"] = codecs.decode(section["secret"]
482
client["secret"] = section["secret"].decode("base64")
942
483
elif "secfile" in section:
943
484
with open(os.path.expanduser(os.path.expandvars
944
485
(section["secfile"])),
945
486
"rb") as secfile:
946
487
client["secret"] = secfile.read()
948
raise TypeError("No secret or secfile for section {}"
489
raise TypeError("No secret or secfile for section %s"
950
491
client["timeout"] = string_to_delta(section["timeout"])
951
492
client["extended_timeout"] = string_to_delta(
952
493
section["extended_timeout"])
955
496
section["approval_delay"])
956
497
client["approval_duration"] = string_to_delta(
957
498
section["approval_duration"])
958
client["checker_command"] = section["checker"]
959
client["last_approval_request"] = None
960
client["last_checked_ok"] = None
961
client["last_checker_status"] = -2
965
def __init__(self, settings, name=None, server_settings=None):
503
def __init__(self, config, name = None):
504
"""Note: the 'checker' key in 'config' sets the
505
'checker_command' attribute and *not* the 'checker'
967
if server_settings is None:
969
self.server_settings = server_settings
970
# adding all client settings
971
for setting, value in settings.items():
972
setattr(self, setting, value)
975
if not hasattr(self, "last_enabled"):
976
self.last_enabled = datetime.datetime.utcnow()
977
if not hasattr(self, "expires"):
978
self.expires = (datetime.datetime.utcnow()
981
self.last_enabled = None
984
508
logger.debug("Creating client %r", self.name)
985
logger.debug(" Key ID: %s", self.key_id)
509
# Uppercase and remove spaces from fingerprint for later
510
# comparison purposes with return value from the fingerprint()
512
self.fingerprint = config["fingerprint"]
986
513
logger.debug(" Fingerprint: %s", self.fingerprint)
987
self.created = settings.get("created",
988
datetime.datetime.utcnow())
990
# attributes specific for this server instance
514
self.secret = config["secret"]
515
self.host = config["host"]
516
self.created = datetime.datetime.utcnow()
517
self.enabled = config["enabled"]
518
self.last_approval_request = None
520
self.last_enabled = datetime.datetime.utcnow()
522
self.last_enabled = None
523
self.last_checked_ok = None
524
self.last_checker_status = None
525
self.timeout = config["timeout"]
526
self.extended_timeout = config["extended_timeout"]
527
self.interval = config["interval"]
991
528
self.checker = None
992
529
self.checker_initiator_tag = None
993
530
self.disable_initiator_tag = None
532
self.expires = datetime.datetime.utcnow() + self.timeout
994
535
self.checker_callback_tag = None
536
self.checker_command = config["checker"]
995
537
self.current_checker_command = None
996
538
self.approved = None
539
self.approved_by_default = config["approved_by_default"]
997
540
self.approvals_pending = 0
998
self.changedstate = multiprocessing_manager.Condition(
999
multiprocessing_manager.Lock())
1000
self.client_structure = [attr
1001
for attr in self.__dict__.keys()
541
self.approval_delay = config["approval_delay"]
542
self.approval_duration = config["approval_duration"]
543
self.changedstate = (multiprocessing_manager
544
.Condition(multiprocessing_manager
546
self.client_structure = [attr for attr in
547
self.__dict__.iterkeys()
1002
548
if not attr.startswith("_")]
1003
549
self.client_structure.append("client_structure")
1005
for name, t in inspect.getmembers(
1006
type(self), lambda obj: isinstance(obj, property)):
551
for name, t in inspect.getmembers(type(self),
1007
555
if not name.startswith("_"):
1008
556
self.client_structure.append(name)
1010
558
# Send notice to process children that client state has changed
1011
559
def send_changedstate(self):
1012
560
with self.changedstate:
1013
561
self.changedstate.notify_all()
1015
563
def enable(self):
1016
564
"""Start this client's checker and timeout hooks"""
1017
565
if getattr(self, "enabled", False):
1018
566
# Already enabled
568
self.send_changedstate()
1020
569
self.expires = datetime.datetime.utcnow() + self.timeout
1021
570
self.enabled = True
1022
571
self.last_enabled = datetime.datetime.utcnow()
1023
572
self.init_checker()
1024
self.send_changedstate()
1026
574
def disable(self, quiet=True):
1027
575
"""Disable this client."""
1028
576
if not getattr(self, "enabled", False):
579
self.send_changedstate()
1031
581
logger.info("Disabling client %s", self.name)
1032
if getattr(self, "disable_initiator_tag", None) is not None:
1033
GLib.source_remove(self.disable_initiator_tag)
582
if getattr(self, "disable_initiator_tag", False):
583
gobject.source_remove(self.disable_initiator_tag)
1034
584
self.disable_initiator_tag = None
1035
585
self.expires = None
1036
if getattr(self, "checker_initiator_tag", None) is not None:
1037
GLib.source_remove(self.checker_initiator_tag)
586
if getattr(self, "checker_initiator_tag", False):
587
gobject.source_remove(self.checker_initiator_tag)
1038
588
self.checker_initiator_tag = None
1039
589
self.stop_checker()
1040
590
self.enabled = False
1042
self.send_changedstate()
1043
# Do not run this again if called by a GLib.timeout_add
591
# Do not run this again if called by a gobject.timeout_add
1046
594
def __del__(self):
1049
597
def init_checker(self):
1050
598
# Schedule a new checker to be started an 'interval' from now,
1051
599
# and every interval from then on.
1052
if self.checker_initiator_tag is not None:
1053
GLib.source_remove(self.checker_initiator_tag)
1054
self.checker_initiator_tag = GLib.timeout_add(
1055
random.randrange(int(self.interval.total_seconds() * 1000
600
self.checker_initiator_tag = (gobject.timeout_add
601
(self.interval_milliseconds(),
1058
603
# Schedule a disable() when 'timeout' has passed
1059
if self.disable_initiator_tag is not None:
1060
GLib.source_remove(self.disable_initiator_tag)
1061
self.disable_initiator_tag = GLib.timeout_add(
1062
int(self.timeout.total_seconds() * 1000), self.disable)
604
self.disable_initiator_tag = (gobject.timeout_add
605
(self.timeout_milliseconds(),
1063
607
# Also start a new checker *right now*.
1064
608
self.start_checker()
1066
def checker_callback(self, source, condition, connection,
610
def checker_callback(self, pid, condition, command):
1068
611
"""The checker has completed, so take appropriate actions."""
1069
# Read return code from connection (see call_pipe)
1070
returncode = connection.recv()
1072
if self.checker is not None:
1074
612
self.checker_callback_tag = None
1075
613
self.checker = None
1078
self.last_checker_status = returncode
1079
self.last_checker_signal = None
614
if os.WIFEXITED(condition):
615
self.last_checker_status = os.WEXITSTATUS(condition)
1080
616
if self.last_checker_status == 0:
1081
617
logger.info("Checker for %(name)s succeeded",
1083
619
self.checked_ok()
1085
logger.info("Checker for %(name)s failed", vars(self))
621
logger.info("Checker for %(name)s failed",
1087
624
self.last_checker_status = -1
1088
self.last_checker_signal = -returncode
1089
625
logger.warning("Checker for %(name)s crashed?",
1093
def checked_ok(self):
1094
"""Assert that the client has been seen, alive and well."""
1095
self.last_checked_ok = datetime.datetime.utcnow()
1096
self.last_checker_status = 0
1097
self.last_checker_signal = None
1100
def bump_timeout(self, timeout=None):
1101
"""Bump up the timeout for this client."""
628
def checked_ok(self, timeout=None):
629
"""Bump up the timeout for this client.
631
This should only be called when the client has been seen,
1102
634
if timeout is None:
1103
635
timeout = self.timeout
636
self.last_checked_ok = datetime.datetime.utcnow()
1104
637
if self.disable_initiator_tag is not None:
1105
GLib.source_remove(self.disable_initiator_tag)
1106
self.disable_initiator_tag = None
638
gobject.source_remove(self.disable_initiator_tag)
1107
639
if getattr(self, "enabled", False):
1108
self.disable_initiator_tag = GLib.timeout_add(
1109
int(timeout.total_seconds() * 1000), self.disable)
640
self.disable_initiator_tag = (gobject.timeout_add
641
(timedelta_to_milliseconds
642
(timeout), self.disable))
1110
643
self.expires = datetime.datetime.utcnow() + timeout
1112
645
def need_approval(self):
1113
646
self.last_approval_request = datetime.datetime.utcnow()
1115
648
def start_checker(self):
1116
649
"""Start a new checker subprocess if one is not running.
1118
651
If a checker already exists, leave it running and do
1120
653
# The reason for not killing a running checker is that if we
1121
# did that, and if a checker (for some reason) started running
1122
# slowly and taking more than 'interval' time, then the client
1123
# would inevitably timeout, since no checker would get a
1124
# chance to run to completion. If we instead leave running
654
# did that, then if a checker (for some reason) started
655
# running slowly and taking more than 'interval' time, the
656
# client would inevitably timeout, since no checker would get
657
# a chance to run to completion. If we instead leave running
1125
658
# checkers alone, the checker would have to take more time
1126
659
# than 'timeout' for the client to be disabled, which is as it
1129
if self.checker is not None and not self.checker.is_alive():
1130
logger.warning("Checker was not alive; joining")
662
# If a checker exists, make sure it is not a zombie
664
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
665
except (AttributeError, OSError) as error:
666
if (isinstance(error, OSError)
667
and error.errno != errno.ECHILD):
671
logger.warning("Checker was a zombie")
672
gobject.source_remove(self.checker_callback_tag)
673
self.checker_callback(pid, status,
674
self.current_checker_command)
1133
675
# Start a new checker if needed
1134
676
if self.checker is None:
1135
# Escape attributes for the shell
1137
attr: shlex.quote(str(getattr(self, attr)))
1138
for attr in self.runtime_expansions}
1140
command = self.checker_command % escaped_attrs
1141
except TypeError as error:
1142
logger.error('Could not format string "%s"',
1143
self.checker_command,
1145
return True # Try again later
678
# In case checker_command has exactly one % operator
679
command = self.checker_command % self.host
681
# Escape attributes for the shell
682
escaped_attrs = dict(
684
re.escape(unicode(str(getattr(self, attr, "")),
688
self.runtime_expansions)
691
command = self.checker_command % escaped_attrs
692
except TypeError as error:
693
logger.error('Could not format string "%s":'
694
' %s', self.checker_command, error)
695
return True # Try again later
1146
696
self.current_checker_command = command
1147
logger.info("Starting checker %r for %s", command,
1149
# We don't need to redirect stdout and stderr, since
1150
# in normal mode, that is already done by daemon(),
1151
# and in debug mode we don't want to. (Stdin is
1152
# always replaced by /dev/null.)
1153
# The exception is when not debugging but nevertheless
1154
# running in the foreground; use the previously
1156
popen_args = {"close_fds": True,
1159
if (not self.server_settings["debug"]
1160
and self.server_settings["foreground"]):
1161
popen_args.update({"stdout": wnull,
1163
pipe = multiprocessing.Pipe(duplex=False)
1164
self.checker = multiprocessing.Process(
1166
args=(pipe[1], subprocess.call, command),
1168
self.checker.start()
1169
self.checker_callback_tag = GLib.io_add_watch(
1170
GLib.IOChannel.unix_new(pipe[0].fileno()),
1171
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1172
self.checker_callback, pipe[0], command)
1173
# Re-run this periodically if run by GLib.timeout_add
698
logger.info("Starting checker %r for %s",
700
# We don't need to redirect stdout and stderr, since
701
# in normal mode, that is already done by daemon(),
702
# and in debug mode we don't want to. (Stdin is
703
# always replaced by /dev/null.)
704
self.checker = subprocess.Popen(command,
707
self.checker_callback_tag = (gobject.child_watch_add
709
self.checker_callback,
711
# The checker may have completed before the gobject
712
# watch was added. Check for this.
713
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
715
gobject.source_remove(self.checker_callback_tag)
716
self.checker_callback(pid, status, command)
717
except OSError as error:
718
logger.error("Failed to start subprocess: %s",
720
# Re-run this periodically if run by gobject.timeout_add
1176
723
def stop_checker(self):
1177
724
"""Force the checker process, if any, to stop."""
1178
725
if self.checker_callback_tag:
1179
GLib.source_remove(self.checker_callback_tag)
726
gobject.source_remove(self.checker_callback_tag)
1180
727
self.checker_callback_tag = None
1181
728
if getattr(self, "checker", None) is None:
1183
730
logger.debug("Stopping checker for %(name)s", vars(self))
1184
self.checker.terminate()
732
os.kill(self.checker.pid, signal.SIGTERM)
734
#if self.checker.poll() is None:
735
# os.kill(self.checker.pid, signal.SIGKILL)
736
except OSError as error:
737
if error.errno != errno.ESRCH: # No such process
1185
739
self.checker = None
1188
def dbus_service_property(dbus_interface,
742
def dbus_service_property(dbus_interface, signature="v",
743
access="readwrite", byte_arrays=False):
1192
744
"""Decorators for marking methods of a DBusObjectWithProperties to
1193
745
become properties on the D-Bus.
1195
747
The decorated method will be called with no arguments by "Get"
1196
748
and with one argument by "Set".
1198
750
The parameters, where they are supported, are the same as
1199
751
dbus.service.method, except there is only "signature", since the
1200
752
type from Get() and the type sent to Set() is the same.
1283
class DBusObjectWithAnnotations(dbus.service.Object):
1284
"""A D-Bus object with annotations.
1286
Classes inheriting from this can use the dbus_annotations
1287
decorator to add annotations to methods or signals.
1291
def _is_dbus_thing(thing):
1292
"""Returns a function testing if an attribute is a D-Bus thing
1294
If called like _is_dbus_thing("method") it returns a function
1295
suitable for use as predicate to inspect.getmembers().
1297
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1300
def _get_all_dbus_things(self, thing):
1301
"""Returns a generator of (name, attribute) pairs
1303
return ((getattr(athing.__get__(self), "_dbus_name", name),
1304
athing.__get__(self))
1305
for cls in self.__class__.__mro__
1307
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1309
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1311
path_keyword='object_path',
1312
connection_keyword='connection')
1313
def Introspect(self, object_path, connection):
1314
"""Overloading of standard D-Bus method.
1316
Inserts annotation tags on methods and signals.
1318
xmlstring = dbus.service.Object.Introspect(self, object_path,
1321
document = xml.dom.minidom.parseString(xmlstring)
1323
for if_tag in document.getElementsByTagName("interface"):
1324
# Add annotation tags
1325
for typ in ("method", "signal"):
1326
for tag in if_tag.getElementsByTagName(typ):
1328
for name, prop in (self.
1329
_get_all_dbus_things(typ)):
1330
if (name == tag.getAttribute("name")
1331
and prop._dbus_interface
1332
== if_tag.getAttribute("name")):
1333
annots.update(getattr(
1334
prop, "_dbus_annotations", {}))
1335
for name, value in annots.items():
1336
ann_tag = document.createElement(
1338
ann_tag.setAttribute("name", name)
1339
ann_tag.setAttribute("value", value)
1340
tag.appendChild(ann_tag)
1341
# Add interface annotation tags
1342
for annotation, value in dict(
1343
itertools.chain.from_iterable(
1344
annotations().items()
1345
for name, annotations
1346
in self._get_all_dbus_things("interface")
1347
if name == if_tag.getAttribute("name")
1349
ann_tag = document.createElement("annotation")
1350
ann_tag.setAttribute("name", annotation)
1351
ann_tag.setAttribute("value", value)
1352
if_tag.appendChild(ann_tag)
1353
# Fix argument name for the Introspect method itself
1354
if (if_tag.getAttribute("name")
1355
== dbus.INTROSPECTABLE_IFACE):
1356
for cn in if_tag.getElementsByTagName("method"):
1357
if cn.getAttribute("name") == "Introspect":
1358
for arg in cn.getElementsByTagName("arg"):
1359
if (arg.getAttribute("direction")
1361
arg.setAttribute("name",
1363
xmlstring = document.toxml("utf-8")
1365
except (AttributeError, xml.dom.DOMException,
1366
xml.parsers.expat.ExpatError) as error:
1367
logger.error("Failed to override Introspection method",
1372
class DBusObjectWithProperties(DBusObjectWithAnnotations):
791
class DBusObjectWithProperties(dbus.service.Object):
1373
792
"""A D-Bus object with properties.
1375
794
Classes inheriting from this can use the dbus_service_property
1376
795
decorator to expose methods as D-Bus properties. It exposes the
1377
796
standard Get(), Set(), and GetAll() methods on the D-Bus.
800
def _is_dbus_property(obj):
801
return getattr(obj, "_dbus_is_property", False)
803
def _get_all_dbus_properties(self):
804
"""Returns a generator of (name, attribute) pairs
806
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
807
for cls in self.__class__.__mro__
809
inspect.getmembers(cls, self._is_dbus_property))
1380
811
def _get_dbus_property(self, interface_name, property_name):
1381
812
"""Returns a bound method if one exists which is a D-Bus
1382
813
property with the specified name and interface.
1384
for cls in self.__class__.__mro__:
1385
for name, value in inspect.getmembers(
1386
cls, self._is_dbus_thing("property")):
815
for cls in self.__class__.__mro__:
816
for name, value in (inspect.getmembers
817
(cls, self._is_dbus_property)):
1387
818
if (value._dbus_name == property_name
1388
819
and value._dbus_interface == interface_name):
1389
820
return value.__get__(self)
1391
822
# No such property
1392
raise DBusPropertyNotFound("{}:{}.{}".format(
1393
self.dbus_object_path, interface_name, property_name))
1396
def _get_all_interface_names(cls):
1397
"""Get a sequence of all interfaces supported by an object"""
1398
return (name for name in set(getattr(getattr(x, attr),
1399
"_dbus_interface", None)
1400
for x in (inspect.getmro(cls))
1402
if name is not None)
1404
@dbus.service.method(dbus.PROPERTIES_IFACE,
823
raise DBusPropertyNotFound(self.dbus_object_path + ":"
824
+ interface_name + "."
827
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1406
828
out_signature="v")
1407
829
def Get(self, interface_name, property_name):
1408
830
"""Standard D-Bus property Get() method, see D-Bus standard.
1532
922
except (AttributeError, xml.dom.DOMException,
1533
923
xml.parsers.expat.ExpatError) as error:
1534
924
logger.error("Failed to override Introspection method",
1540
dbus.OBJECT_MANAGER_IFACE
1541
except AttributeError:
1542
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1545
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1546
"""A D-Bus object with an ObjectManager.
1548
Classes inheriting from this exposes the standard
1549
GetManagedObjects call and the InterfacesAdded and
1550
InterfacesRemoved signals on the standard
1551
"org.freedesktop.DBus.ObjectManager" interface.
1553
Note: No signals are sent automatically; they must be sent
1556
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1557
out_signature="a{oa{sa{sv}}}")
1558
def GetManagedObjects(self):
1559
"""This function must be overridden"""
1560
raise NotImplementedError()
1562
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1563
signature="oa{sa{sv}}")
1564
def InterfacesAdded(self, object_path, interfaces_and_properties):
1567
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1568
def InterfacesRemoved(self, object_path, interfaces):
1571
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1573
path_keyword='object_path',
1574
connection_keyword='connection')
1575
def Introspect(self, object_path, connection):
1576
"""Overloading of standard D-Bus method.
1578
Override return argument name of GetManagedObjects to be
1579
"objpath_interfaces_and_properties"
1581
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1585
document = xml.dom.minidom.parseString(xmlstring)
1587
for if_tag in document.getElementsByTagName("interface"):
1588
# Fix argument name for the GetManagedObjects method
1589
if (if_tag.getAttribute("name")
1590
== dbus.OBJECT_MANAGER_IFACE):
1591
for cn in if_tag.getElementsByTagName("method"):
1592
if (cn.getAttribute("name")
1593
== "GetManagedObjects"):
1594
for arg in cn.getElementsByTagName("arg"):
1595
if (arg.getAttribute("direction")
1599
"objpath_interfaces"
1601
xmlstring = document.toxml("utf-8")
1603
except (AttributeError, xml.dom.DOMException,
1604
xml.parsers.expat.ExpatError) as error:
1605
logger.error("Failed to override Introspection method",
1610
def datetime_to_dbus(dt, variant_level=0):
929
def datetime_to_dbus (dt, variant_level=0):
1611
930
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1613
return dbus.String("", variant_level=variant_level)
1614
return dbus.String(dt.isoformat(), variant_level=variant_level)
1617
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1618
"""A class decorator; applied to a subclass of
1619
dbus.service.Object, it will add alternate D-Bus attributes with
1620
interface names according to the "alt_interface_names" mapping.
1623
@alternate_dbus_interfaces({"org.example.Interface":
1624
"net.example.AlternateInterface"})
1625
class SampleDBusObject(dbus.service.Object):
1626
@dbus.service.method("org.example.Interface")
1627
def SampleDBusMethod():
1630
The above "SampleDBusMethod" on "SampleDBusObject" will be
1631
reachable via two interfaces: "org.example.Interface" and
1632
"net.example.AlternateInterface", the latter of which will have
1633
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1634
"true", unless "deprecate" is passed with a False value.
1636
This works for methods and signals, and also for D-Bus properties
1637
(from DBusObjectWithProperties) and interfaces (from the
1638
dbus_interface_annotations decorator).
932
return dbus.String("", variant_level = variant_level)
933
return dbus.String(dt.isoformat(),
934
variant_level=variant_level)
937
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
939
"""Applied to an empty subclass of a D-Bus object, this metaclass
940
will add additional D-Bus attributes matching a certain pattern.
1642
for orig_interface_name, alt_interface_name in (
1643
alt_interface_names.items()):
1645
interface_names = set()
1646
# Go though all attributes of the class
1647
for attrname, attribute in inspect.getmembers(cls):
942
def __new__(mcs, name, bases, attr):
943
# Go through all the base classes which could have D-Bus
944
# methods, signals, or properties in them
945
for base in (b for b in bases
946
if issubclass(b, dbus.service.Object)):
947
# Go though all attributes of the base class
948
for attrname, attribute in inspect.getmembers(base):
1648
949
# Ignore non-D-Bus attributes, and D-Bus attributes
1649
950
# with the wrong interface name
1650
951
if (not hasattr(attribute, "_dbus_interface")
1651
or not attribute._dbus_interface.startswith(
1652
orig_interface_name)):
952
or not attribute._dbus_interface
953
.startswith("se.recompile.Mandos")):
1654
955
# Create an alternate D-Bus interface name based on
1655
956
# the current name
1656
alt_interface = attribute._dbus_interface.replace(
1657
orig_interface_name, alt_interface_name)
1658
interface_names.add(alt_interface)
957
alt_interface = (attribute._dbus_interface
958
.replace("se.recompile.Mandos",
959
"se.bsnet.fukt.Mandos"))
1659
960
# Is this a D-Bus signal?
1660
961
if getattr(attribute, "_dbus_is_signal", False):
1661
# Extract the original non-method undecorated
1662
# function by black magic
1663
if sys.version_info.major == 2:
1664
nonmethod_func = (dict(
962
# Extract the original non-method function by
964
nonmethod_func = (dict(
1665
965
zip(attribute.func_code.co_freevars,
1666
attribute.__closure__))
1667
["func"].cell_contents)
1669
nonmethod_func = (dict(
1670
zip(attribute.__code__.co_freevars,
1671
attribute.__closure__))
1672
["func"].cell_contents)
966
attribute.__closure__))["func"]
1673
968
# Create a new, but exactly alike, function
1674
969
# object, and decorate it to be a new D-Bus signal
1675
970
# with the alternate D-Bus interface name
1676
new_function = copy_function(nonmethod_func)
1677
new_function = (dbus.service.signal(
1679
attribute._dbus_signature)(new_function))
1680
# Copy annotations, if any
1682
new_function._dbus_annotations = dict(
1683
attribute._dbus_annotations)
1684
except AttributeError:
971
new_function = (dbus.service.signal
973
attribute._dbus_signature)
975
nonmethod_func.func_code,
976
nonmethod_func.func_globals,
977
nonmethod_func.func_name,
978
nonmethod_func.func_defaults,
979
nonmethod_func.func_closure)))
1687
980
# Define a creator of a function to call both the
1688
# original and alternate functions, so both the
1689
# original and alternate signals gets sent when
1690
# the function is called
981
# old and new functions, so both the old and new
982
# signals gets sent when the function is called
1691
983
def fixscope(func1, func2):
1692
984
"""This function is a scope container to pass
1693
985
func1 and func2 to the "call_both" function
1694
986
outside of its arguments"""
1696
@functools.wraps(func2)
1697
987
def call_both(*args, **kwargs):
1698
988
"""This function will emit two D-Bus
1699
989
signals by calling func1 and func2"""
1700
990
func1(*args, **kwargs)
1701
991
func2(*args, **kwargs)
1702
# Make wrapper function look like a D-Bus
1704
for name, attr in inspect.getmembers(func2):
1705
if name.startswith("_dbus_"):
1706
setattr(call_both, name, attr)
1708
992
return call_both
1709
993
# Create the "call_both" function and add it to
1711
attr[attrname] = fixscope(attribute, new_function)
995
attr[attrname] = fixscope(attribute,
1712
997
# Is this a D-Bus method?
1713
998
elif getattr(attribute, "_dbus_is_method", False):
1714
999
# Create a new, but exactly alike, function
1715
1000
# object. Decorate it to be a new D-Bus method
1716
1001
# with the alternate D-Bus interface name. Add it
1717
1002
# to the class.
1719
dbus.service.method(
1721
attribute._dbus_in_signature,
1722
attribute._dbus_out_signature)
1723
(copy_function(attribute)))
1724
# Copy annotations, if any
1726
attr[attrname]._dbus_annotations = dict(
1727
attribute._dbus_annotations)
1728
except AttributeError:
1003
attr[attrname] = (dbus.service.method
1005
attribute._dbus_in_signature,
1006
attribute._dbus_out_signature)
1008
(attribute.func_code,
1009
attribute.func_globals,
1010
attribute.func_name,
1011
attribute.func_defaults,
1012
attribute.func_closure)))
1730
1013
# Is this a D-Bus property?
1731
1014
elif getattr(attribute, "_dbus_is_property", False):
1732
1015
# Create a new, but exactly alike, function
1733
1016
# object, and decorate it to be a new D-Bus
1734
1017
# property with the alternate D-Bus interface
1735
1018
# name. Add it to the class.
1736
attr[attrname] = (dbus_service_property(
1737
alt_interface, attribute._dbus_signature,
1738
attribute._dbus_access,
1739
attribute._dbus_get_args_options
1741
(copy_function(attribute)))
1742
# Copy annotations, if any
1744
attr[attrname]._dbus_annotations = dict(
1745
attribute._dbus_annotations)
1746
except AttributeError:
1748
# Is this a D-Bus interface?
1749
elif getattr(attribute, "_dbus_is_interface", False):
1750
# Create a new, but exactly alike, function
1751
# object. Decorate it to be a new D-Bus interface
1752
# with the alternate D-Bus interface name. Add it
1755
dbus_interface_annotations(alt_interface)
1756
(copy_function(attribute)))
1758
# Deprecate all alternate interfaces
1759
iname = "_AlternateDBusNames_interface_annotation{}"
1760
for interface_name in interface_names:
1762
@dbus_interface_annotations(interface_name)
1764
return {"org.freedesktop.DBus.Deprecated":
1766
# Find an unused name
1767
for aname in (iname.format(i)
1768
for i in itertools.count()):
1769
if aname not in attr:
1773
# Replace the class with a new subclass of it with
1774
# methods, signals, etc. as created above.
1775
if sys.version_info.major == 2:
1776
cls = type(b"{}Alternate".format(cls.__name__),
1779
cls = type("{}Alternate".format(cls.__name__),
1786
@alternate_dbus_interfaces({"se.recompile.Mandos":
1787
"se.bsnet.fukt.Mandos"})
1019
attr[attrname] = (dbus_service_property
1021
attribute._dbus_signature,
1022
attribute._dbus_access,
1024
._dbus_get_args_options
1027
(attribute.func_code,
1028
attribute.func_globals,
1029
attribute.func_name,
1030
attribute.func_defaults,
1031
attribute.func_closure)))
1032
return type.__new__(mcs, name, bases, attr)
1788
1035
class ClientDBus(Client, DBusObjectWithProperties):
1789
1036
"""A Client class using D-Bus
1792
1039
dbus_object_path: dbus.ObjectPath
1793
1040
bus: dbus.SystemBus()
1796
1043
runtime_expansions = (Client.runtime_expansions
1797
+ ("dbus_object_path", ))
1799
_interface = "se.recompile.Mandos.Client"
1044
+ ("dbus_object_path",))
1801
1046
# dbus.service.Object doesn't use super(), so we can't either.
1803
def __init__(self, bus=None, *args, **kwargs):
1048
def __init__(self, bus = None, *args, **kwargs):
1805
1050
Client.__init__(self, *args, **kwargs)
1052
self._approvals_pending = 0
1806
1053
# Only now, when this client is initialized, can it show up on
1808
client_object_name = str(self.name).translate(
1055
client_object_name = unicode(self.name).translate(
1809
1056
{ord("."): ord("_"),
1810
1057
ord("-"): ord("_")})
1811
self.dbus_object_path = dbus.ObjectPath(
1812
"/clients/" + client_object_name)
1058
self.dbus_object_path = (dbus.ObjectPath
1059
("/clients/" + client_object_name))
1813
1060
DBusObjectWithProperties.__init__(self, self.bus,
1814
1061
self.dbus_object_path)
1816
def notifychangeproperty(transform_func, dbus_name,
1817
type_func=lambda x: x,
1819
invalidate_only=False,
1820
_interface=_interface):
1063
def notifychangeproperty(transform_func,
1064
dbus_name, type_func=lambda x: x,
1821
1066
""" Modify a variable so that it's a property which announces
1822
1067
its changes to DBus.
1824
1069
transform_fun: Function that takes a value and a variant_level
1825
1070
and transforms it to a D-Bus type.
1826
1071
dbus_name: D-Bus name of the variable
1828
1073
to the D-Bus. Default: no transform
1829
1074
variant_level: D-Bus variant level. Default: 1
1831
attrname = "_{}".format(dbus_name)
1076
attrname = "_{0}".format(dbus_name)
1833
1077
def setter(self, value):
1834
1078
if hasattr(self, "dbus_object_path"):
1835
1079
if (not hasattr(self, attrname) or
1836
1080
type_func(getattr(self, attrname, None))
1837
1081
!= type_func(value)):
1839
self.PropertiesChanged(
1840
_interface, dbus.Dictionary(),
1841
dbus.Array((dbus_name, )))
1843
dbus_value = transform_func(
1845
variant_level=variant_level)
1846
self.PropertyChanged(dbus.String(dbus_name),
1848
self.PropertiesChanged(
1850
dbus.Dictionary({dbus.String(dbus_name):
1082
dbus_value = transform_func(type_func(value),
1085
self.PropertyChanged(dbus.String(dbus_name),
1853
1087
setattr(self, attrname, value)
1855
1089
return property(lambda self: getattr(self, attrname), setter)
1857
1092
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1858
1093
approvals_pending = notifychangeproperty(dbus.Boolean,
1859
1094
"ApprovalPending",
1861
1096
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1862
1097
last_enabled = notifychangeproperty(datetime_to_dbus,
1864
checker = notifychangeproperty(
1865
dbus.Boolean, "CheckerRunning",
1866
type_func=lambda checker: checker is not None)
1099
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1100
type_func = lambda checker:
1101
checker is not None)
1867
1102
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1868
1103
"LastCheckedOK")
1869
last_checker_status = notifychangeproperty(dbus.Int16,
1870
"LastCheckerStatus")
1871
1104
last_approval_request = notifychangeproperty(
1872
1105
datetime_to_dbus, "LastApprovalRequest")
1873
1106
approved_by_default = notifychangeproperty(dbus.Boolean,
1874
1107
"ApprovedByDefault")
1875
approval_delay = notifychangeproperty(
1876
dbus.UInt64, "ApprovalDelay",
1877
type_func=lambda td: td.total_seconds() * 1000)
1108
approval_delay = notifychangeproperty(dbus.UInt64,
1111
timedelta_to_milliseconds)
1878
1112
approval_duration = notifychangeproperty(
1879
1113
dbus.UInt64, "ApprovalDuration",
1880
type_func=lambda td: td.total_seconds() * 1000)
1114
type_func = timedelta_to_milliseconds)
1881
1115
host = notifychangeproperty(dbus.String, "Host")
1882
timeout = notifychangeproperty(
1883
dbus.UInt64, "Timeout",
1884
type_func=lambda td: td.total_seconds() * 1000)
1116
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1118
timedelta_to_milliseconds)
1885
1119
extended_timeout = notifychangeproperty(
1886
1120
dbus.UInt64, "ExtendedTimeout",
1887
type_func=lambda td: td.total_seconds() * 1000)
1888
interval = notifychangeproperty(
1889
dbus.UInt64, "Interval",
1890
type_func=lambda td: td.total_seconds() * 1000)
1121
type_func = timedelta_to_milliseconds)
1122
interval = notifychangeproperty(dbus.UInt64,
1125
timedelta_to_milliseconds)
1891
1126
checker_command = notifychangeproperty(dbus.String, "Checker")
1892
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1893
invalidate_only=True)
1895
1128
del notifychangeproperty
1897
1130
def __del__(self, *args, **kwargs):
1899
1132
self.remove_from_connection()
1978
1212
server to mandos-client
1982
1216
# Rejected - signal
1983
1217
@dbus.service.signal(_interface, signature="s")
1984
1218
def Rejected(self, reason):
1988
1222
# NeedApproval - signal
1989
1223
@dbus.service.signal(_interface, signature="tb")
1990
1224
def NeedApproval(self, timeout, default):
1992
1226
return self.need_approval()
1228
# NeRwequest - signal
1229
@dbus.service.signal(_interface, signature="s")
1230
def NewRequest(self, ip):
1232
Is sent after a client request a password.
1996
1238
# Approve - method
1997
1239
@dbus.service.method(_interface, in_signature="b")
1998
1240
def Approve(self, value):
1999
1241
self.approve(value)
2001
1243
# CheckedOK - method
2002
1244
@dbus.service.method(_interface)
2003
1245
def CheckedOK(self):
2004
1246
self.checked_ok()
2006
1248
# Enable - method
2007
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2008
1249
@dbus.service.method(_interface)
2009
1250
def Enable(self):
2013
1254
# StartChecker - method
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2015
1255
@dbus.service.method(_interface)
2016
1256
def StartChecker(self):
2018
1258
self.start_checker()
2020
1260
# Disable - method
2021
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2022
1261
@dbus.service.method(_interface)
2023
1262
def Disable(self):
2027
1266
# StopChecker - method
2028
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2029
1267
@dbus.service.method(_interface)
2030
1268
def StopChecker(self):
2031
1269
self.stop_checker()
2035
1273
# ApprovalPending - property
2036
1274
@dbus_service_property(_interface, signature="b", access="read")
2037
1275
def ApprovalPending_dbus_property(self):
2038
1276
return dbus.Boolean(bool(self.approvals_pending))
2040
1278
# ApprovedByDefault - property
2041
@dbus_service_property(_interface,
1279
@dbus_service_property(_interface, signature="b",
2043
1280
access="readwrite")
2044
1281
def ApprovedByDefault_dbus_property(self, value=None):
2045
1282
if value is None: # get
2046
1283
return dbus.Boolean(self.approved_by_default)
2047
1284
self.approved_by_default = bool(value)
2049
1286
# ApprovalDelay - property
2050
@dbus_service_property(_interface,
1287
@dbus_service_property(_interface, signature="t",
2052
1288
access="readwrite")
2053
1289
def ApprovalDelay_dbus_property(self, value=None):
2054
1290
if value is None: # get
2055
return dbus.UInt64(self.approval_delay.total_seconds()
1291
return dbus.UInt64(self.approval_delay_milliseconds())
2057
1292
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2059
1294
# ApprovalDuration - property
2060
@dbus_service_property(_interface,
1295
@dbus_service_property(_interface, signature="t",
2062
1296
access="readwrite")
2063
1297
def ApprovalDuration_dbus_property(self, value=None):
2064
1298
if value is None: # get
2065
return dbus.UInt64(self.approval_duration.total_seconds()
1299
return dbus.UInt64(timedelta_to_milliseconds(
1300
self.approval_duration))
2067
1301
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2069
1303
# Name - property
2071
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2072
1304
@dbus_service_property(_interface, signature="s", access="read")
2073
1305
def Name_dbus_property(self):
2074
1306
return dbus.String(self.name)
2078
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2079
@dbus_service_property(_interface, signature="s", access="read")
2080
def KeyID_dbus_property(self):
2081
return dbus.String(self.key_id)
2083
1308
# Fingerprint - property
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
1309
@dbus_service_property(_interface, signature="s", access="read")
2087
1310
def Fingerprint_dbus_property(self):
2088
1311
return dbus.String(self.fingerprint)
2090
1313
# Host - property
2091
@dbus_service_property(_interface,
1314
@dbus_service_property(_interface, signature="s",
2093
1315
access="readwrite")
2094
1316
def Host_dbus_property(self, value=None):
2095
1317
if value is None: # get
2096
1318
return dbus.String(self.host)
2097
self.host = str(value)
1319
self.host = unicode(value)
2099
1321
# Created - property
2101
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2102
1322
@dbus_service_property(_interface, signature="s", access="read")
2103
1323
def Created_dbus_property(self):
2104
1324
return datetime_to_dbus(self.created)
2106
1326
# LastEnabled - property
2107
1327
@dbus_service_property(_interface, signature="s", access="read")
2108
1328
def LastEnabled_dbus_property(self):
2109
1329
return datetime_to_dbus(self.last_enabled)
2111
1331
# Enabled - property
2112
@dbus_service_property(_interface,
1332
@dbus_service_property(_interface, signature="b",
2114
1333
access="readwrite")
2115
1334
def Enabled_dbus_property(self, value=None):
2116
1335
if value is None: # get
2123
1342
# LastCheckedOK - property
2124
@dbus_service_property(_interface,
1343
@dbus_service_property(_interface, signature="s",
2126
1344
access="readwrite")
2127
1345
def LastCheckedOK_dbus_property(self, value=None):
2128
1346
if value is not None:
2129
1347
self.checked_ok()
2131
1349
return datetime_to_dbus(self.last_checked_ok)
2133
# LastCheckerStatus - property
2134
@dbus_service_property(_interface, signature="n", access="read")
2135
def LastCheckerStatus_dbus_property(self):
2136
return dbus.Int16(self.last_checker_status)
2138
1351
# Expires - property
2139
1352
@dbus_service_property(_interface, signature="s", access="read")
2140
1353
def Expires_dbus_property(self):
2141
1354
return datetime_to_dbus(self.expires)
2143
1356
# LastApprovalRequest - property
2144
1357
@dbus_service_property(_interface, signature="s", access="read")
2145
1358
def LastApprovalRequest_dbus_property(self):
2146
1359
return datetime_to_dbus(self.last_approval_request)
2148
1361
# Timeout - property
2149
@dbus_service_property(_interface,
1362
@dbus_service_property(_interface, signature="t",
2151
1363
access="readwrite")
2152
1364
def Timeout_dbus_property(self, value=None):
2153
1365
if value is None: # get
2154
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2155
old_timeout = self.timeout
1366
return dbus.UInt64(self.timeout_milliseconds())
2156
1367
self.timeout = datetime.timedelta(0, 0, 0, value)
2157
# Reschedule disabling
2159
now = datetime.datetime.utcnow()
2160
self.expires += self.timeout - old_timeout
2161
if self.expires <= now:
2162
# The timeout has passed
2165
if (getattr(self, "disable_initiator_tag", None)
2168
GLib.source_remove(self.disable_initiator_tag)
2169
self.disable_initiator_tag = GLib.timeout_add(
2170
int((self.expires - now).total_seconds() * 1000),
1368
if getattr(self, "disable_initiator_tag", None) is None:
1370
# Reschedule timeout
1371
gobject.source_remove(self.disable_initiator_tag)
1372
self.disable_initiator_tag = None
1374
time_to_die = timedelta_to_milliseconds((self
1379
if time_to_die <= 0:
1380
# The timeout has passed
1383
self.expires = (datetime.datetime.utcnow()
1384
+ datetime.timedelta(milliseconds =
1386
self.disable_initiator_tag = (gobject.timeout_add
1387
(time_to_die, self.disable))
2173
1389
# ExtendedTimeout - property
2174
@dbus_service_property(_interface,
1390
@dbus_service_property(_interface, signature="t",
2176
1391
access="readwrite")
2177
1392
def ExtendedTimeout_dbus_property(self, value=None):
2178
1393
if value is None: # get
2179
return dbus.UInt64(self.extended_timeout.total_seconds()
1394
return dbus.UInt64(self.extended_timeout_milliseconds())
2181
1395
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2183
1397
# Interval - property
2184
@dbus_service_property(_interface,
1398
@dbus_service_property(_interface, signature="t",
2186
1399
access="readwrite")
2187
1400
def Interval_dbus_property(self, value=None):
2188
1401
if value is None: # get
2189
return dbus.UInt64(self.interval.total_seconds() * 1000)
1402
return dbus.UInt64(self.interval_milliseconds())
2190
1403
self.interval = datetime.timedelta(0, 0, 0, value)
2191
1404
if getattr(self, "checker_initiator_tag", None) is None:
2193
1406
if self.enabled:
2194
1407
# Reschedule checker run
2195
GLib.source_remove(self.checker_initiator_tag)
2196
self.checker_initiator_tag = GLib.timeout_add(
2197
value, self.start_checker)
2198
self.start_checker() # Start one now, too
1408
gobject.source_remove(self.checker_initiator_tag)
1409
self.checker_initiator_tag = (gobject.timeout_add
1410
(value, self.start_checker))
1411
self.start_checker() # Start one now, too
2200
1413
# Checker - property
2201
@dbus_service_property(_interface,
1414
@dbus_service_property(_interface, signature="s",
2203
1415
access="readwrite")
2204
1416
def Checker_dbus_property(self, value=None):
2205
1417
if value is None: # get
2206
1418
return dbus.String(self.checker_command)
2207
self.checker_command = str(value)
1419
self.checker_command = unicode(value)
2209
1421
# CheckerRunning - property
2210
@dbus_service_property(_interface,
1422
@dbus_service_property(_interface, signature="b",
2212
1423
access="readwrite")
2213
1424
def CheckerRunning_dbus_property(self, value=None):
2214
1425
if value is None: # get
2255
1458
if data[0] == 'data':
2257
1460
if data[0] == 'function':
2259
1461
def func(*args, **kwargs):
2260
1462
self._pipe.send(('funcall', name, args, kwargs))
2261
1463
return self._pipe.recv()[1]
2265
1466
def __setattr__(self, name, value):
2266
1467
if name == '_pipe':
2267
1468
return super(ProxyClient, self).__setattr__(name, value)
2268
1469
self._pipe.send(('setattr', name, value))
1472
class ClientDBusTransitional(ClientDBus):
1473
__metaclass__ = AlternateDBusNamesMetaclass
2271
1476
class ClientHandler(socketserver.BaseRequestHandler, object):
2272
1477
"""A class to handle client connections.
2274
1479
Instantiated once for each connection to handle it.
2275
1480
Note: This will run in its own forked process."""
2277
1482
def handle(self):
2278
1483
with contextlib.closing(self.server.child_pipe) as child_pipe:
2279
1484
logger.info("TCP connection from: %s",
2280
str(self.client_address))
1485
unicode(self.client_address))
2281
1486
logger.debug("Pipe FD: %d",
2282
1487
self.server.child_pipe.fileno())
2284
session = gnutls.ClientSession(self.request)
2286
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2287
# "+AES-256-CBC", "+SHA1",
2288
# "+COMP-NULL", "+CTYPE-OPENPGP",
1489
session = (gnutls.connection
1490
.ClientSession(self.request,
1492
.X509Credentials()))
1494
# Note: gnutls.connection.X509Credentials is really a
1495
# generic GnuTLS certificate credentials object so long as
1496
# no X.509 keys are added to it. Therefore, we can use it
1497
# here despite using OpenPGP certificates.
1499
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1500
# "+AES-256-CBC", "+SHA1",
1501
# "+COMP-NULL", "+CTYPE-OPENPGP",
2290
1503
# Use a fallback default, since this MUST be set.
2291
1504
priority = self.server.gnutls_priority
2292
1505
if priority is None:
2293
1506
priority = "NORMAL"
2294
gnutls.priority_set_direct(session._c_object,
2295
priority.encode("utf-8"),
1507
(gnutls.library.functions
1508
.gnutls_priority_set_direct(session._c_object,
2298
1511
# Start communication using the Mandos protocol
2299
1512
# Get protocol number
2300
1513
line = self.request.makefile().readline()
2301
1514
logger.debug("Protocol version: %r", line)
2303
1516
if int(line.strip().split()[0]) > 1:
2304
raise RuntimeError(line)
2305
1518
except (ValueError, IndexError, RuntimeError) as error:
2306
1519
logger.error("Unknown protocol version: %s", error)
2309
1522
# Start GnuTLS connection
2311
1524
session.handshake()
2312
except gnutls.Error as error:
1525
except gnutls.errors.GNUTLSError as error:
2313
1526
logger.warning("Handshake failed: %s", error)
2314
1527
# Do not run session.bye() here: the session is not
2315
1528
# established. Just abandon the request.
2317
1530
logger.debug("Handshake succeeded")
2319
1532
approval_required = False
2321
if gnutls.has_rawpk:
2324
key_id = self.key_id(
2325
self.peer_certificate(session))
2326
except (TypeError, gnutls.Error) as error:
2327
logger.warning("Bad certificate: %s", error)
2329
logger.debug("Key ID: %s", key_id)
2334
fpr = self.fingerprint(
2335
self.peer_certificate(session))
2336
except (TypeError, gnutls.Error) as error:
2337
logger.warning("Bad certificate: %s", error)
2339
logger.debug("Fingerprint: %s", fpr)
2342
client = ProxyClient(child_pipe, key_id, fpr,
1535
fpr = self.fingerprint(self.peer_certificate
1538
gnutls.errors.GNUTLSError) as error:
1539
logger.warning("Bad certificate: %s", error)
1541
logger.debug("Fingerprint: %s", fpr)
1544
client = ProxyClient(child_pipe, fpr,
2343
1545
self.client_address)
2344
1546
except KeyError:
1549
if self.server.use_dbus:
1551
client.NewRequest(str(self.client_address))
2347
1553
if client.approval_delay:
2348
1554
delay = client.approval_delay
2349
1555
client.approvals_pending += 1
2350
1556
approval_required = True
2353
1559
if not client.enabled:
2354
1560
logger.info("Client %s is disabled",
2356
1562
if self.server.use_dbus:
2357
1563
# Emit D-Bus signal
2358
1564
client.Rejected("Disabled")
2361
1567
if client.approved or not client.approval_delay:
2362
# We are approved or approval is disabled
1568
#We are approved or approval is disabled
2364
1570
elif client.approved is None:
2365
1571
logger.info("Client %s needs approval",
2398
1606
delay -= time2 - time
2401
session.send(client.secret)
2402
except gnutls.Error as error:
2403
logger.warning("gnutls send failed",
1609
while sent_size < len(client.secret):
1611
sent = session.send(client.secret[sent_size:])
1612
except gnutls.errors.GNUTLSError as error:
1613
logger.warning("gnutls send failed")
1615
logger.debug("Sent: %d, remaining: %d",
1616
sent, len(client.secret)
1617
- (sent_size + sent))
2407
1620
logger.info("Sending secret to %s", client.name)
2408
1621
# bump the timeout using extended_timeout
2409
client.bump_timeout(client.extended_timeout)
1622
client.checked_ok(client.extended_timeout)
2410
1623
if self.server.use_dbus:
2411
1624
# Emit D-Bus signal
2412
1625
client.GotSecret()
2415
1628
if approval_required:
2416
1629
client.approvals_pending -= 1
2419
except gnutls.Error as error:
2420
logger.warning("GnuTLS bye failed",
1632
except gnutls.errors.GNUTLSError as error:
1633
logger.warning("GnuTLS bye failed")
2424
1636
def peer_certificate(session):
2425
"Return the peer's certificate as a bytestring"
2427
cert_type = gnutls.certificate_type_get2(session._c_object,
2429
except AttributeError:
2430
cert_type = gnutls.certificate_type_get(session._c_object)
2431
if gnutls.has_rawpk:
2432
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2434
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2435
# If not a valid certificate type...
2436
if cert_type not in valid_cert_types:
2437
logger.info("Cert type %r not in %r", cert_type,
2439
# ...return invalid data
1637
"Return the peer's OpenPGP certificate as a bytestring"
1638
# If not an OpenPGP certificate...
1639
if (gnutls.library.functions
1640
.gnutls_certificate_type_get(session._c_object)
1641
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1642
# ...do the normal thing
1643
return session.peer_certificate
2441
1644
list_size = ctypes.c_uint(1)
2442
cert_list = (gnutls.certificate_get_peers
1645
cert_list = (gnutls.library.functions
1646
.gnutls_certificate_get_peers
2443
1647
(session._c_object, ctypes.byref(list_size)))
2444
1648
if not bool(cert_list) and list_size.value != 0:
2445
raise gnutls.Error("error getting peer certificate")
1649
raise gnutls.errors.GNUTLSError("error getting peer"
2446
1651
if list_size.value == 0:
2448
1653
cert = cert_list[0]
2449
1654
return ctypes.string_at(cert.data, cert.size)
2452
def key_id(certificate):
2453
"Convert a certificate bytestring to a hexdigit key ID"
2454
# New GnuTLS "datum" with the public key
2455
datum = gnutls.datum_t(
2456
ctypes.cast(ctypes.c_char_p(certificate),
2457
ctypes.POINTER(ctypes.c_ubyte)),
2458
ctypes.c_uint(len(certificate)))
2459
# XXX all these need to be created in the gnutls "module"
2460
# New empty GnuTLS certificate
2461
pubkey = gnutls.pubkey_t()
2462
gnutls.pubkey_init(ctypes.byref(pubkey))
2463
# Import the raw public key into the certificate
2464
gnutls.pubkey_import(pubkey,
2465
ctypes.byref(datum),
2466
gnutls.X509_FMT_DER)
2467
# New buffer for the key ID
2468
buf = ctypes.create_string_buffer(32)
2469
buf_len = ctypes.c_size_t(len(buf))
2470
# Get the key ID from the raw public key into the buffer
2471
gnutls.pubkey_get_key_id(pubkey,
2472
gnutls.KEYID_USE_SHA256,
2473
ctypes.cast(ctypes.byref(buf),
2474
ctypes.POINTER(ctypes.c_ubyte)),
2475
ctypes.byref(buf_len))
2476
# Deinit the certificate
2477
gnutls.pubkey_deinit(pubkey)
2479
# Convert the buffer to a Python bytestring
2480
key_id = ctypes.string_at(buf, buf_len.value)
2481
# Convert the bytestring to hexadecimal notation
2482
hex_key_id = binascii.hexlify(key_id).upper()
2486
1657
def fingerprint(openpgp):
2487
1658
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2488
1659
# New GnuTLS "datum" with the OpenPGP public key
2489
datum = gnutls.datum_t(
2490
ctypes.cast(ctypes.c_char_p(openpgp),
2491
ctypes.POINTER(ctypes.c_ubyte)),
2492
ctypes.c_uint(len(openpgp)))
1660
datum = (gnutls.library.types
1661
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1664
ctypes.c_uint(len(openpgp))))
2493
1665
# New empty GnuTLS certificate
2494
crt = gnutls.openpgp_crt_t()
2495
gnutls.openpgp_crt_init(ctypes.byref(crt))
1666
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1667
(gnutls.library.functions
1668
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2496
1669
# Import the OpenPGP public key into the certificate
2497
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2498
gnutls.OPENPGP_FMT_RAW)
1670
(gnutls.library.functions
1671
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1672
gnutls.library.constants
1673
.GNUTLS_OPENPGP_FMT_RAW))
2499
1674
# Verify the self signature in the key
2500
1675
crtverify = ctypes.c_uint()
2501
gnutls.openpgp_crt_verify_self(crt, 0,
2502
ctypes.byref(crtverify))
1676
(gnutls.library.functions
1677
.gnutls_openpgp_crt_verify_self(crt, 0,
1678
ctypes.byref(crtverify)))
2503
1679
if crtverify.value != 0:
2504
gnutls.openpgp_crt_deinit(crt)
2505
raise gnutls.CertificateSecurityError(code
1680
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1681
raise (gnutls.errors.CertificateSecurityError
2507
1683
# New buffer for the fingerprint
2508
1684
buf = ctypes.create_string_buffer(20)
2509
1685
buf_len = ctypes.c_size_t()
2510
1686
# Get the fingerprint from the certificate into the buffer
2511
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2512
ctypes.byref(buf_len))
1687
(gnutls.library.functions
1688
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1689
ctypes.byref(buf_len)))
2513
1690
# Deinit the certificate
2514
gnutls.openpgp_crt_deinit(crt)
1691
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2515
1692
# Convert the buffer to a Python bytestring
2516
1693
fpr = ctypes.string_at(buf, buf_len.value)
2517
1694
# Convert the bytestring to hexadecimal notation
2522
class MultiprocessingMixIn:
1699
class MultiprocessingMixIn(object):
2523
1700
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2525
1701
def sub_process_main(self, request, address):
2527
1703
self.finish_request(request, address)
2528
1704
except Exception:
2529
1705
self.handle_error(request, address)
2530
1706
self.close_request(request)
2532
1708
def process_request(self, request, address):
2533
1709
"""Start a new process to process the request."""
2534
proc = multiprocessing.Process(target=self.sub_process_main,
2535
args=(request, address))
1710
proc = multiprocessing.Process(target = self.sub_process_main,
2540
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1717
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2541
1718
""" adds a pipe to the MixIn """
2543
1719
def process_request(self, request, client_address):
2544
1720
"""Overrides and wraps the original process_request().
2546
1722
This function creates a new pipe in self.pipe
2548
1724
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2550
1726
proc = MultiprocessingMixIn.process_request(self, request,
2551
1727
client_address)
2552
1728
self.child_pipe.close()
2553
1729
self.add_pipe(parent_pipe, proc)
2555
1731
def add_pipe(self, parent_pipe, proc):
2556
1732
"""Dummy function; override as necessary"""
2557
raise NotImplementedError()
1733
raise NotImplementedError
2560
1736
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2561
socketserver.TCPServer):
1737
socketserver.TCPServer, object):
2562
1738
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2565
1741
enabled: Boolean; whether this server is activated yet
2566
1742
interface: None or a network interface name (string)
2567
1743
use_ipv6: Boolean; to use IPv6 or not
2570
1745
def __init__(self, server_address, RequestHandlerClass,
2574
"""If socketfd is set, use that file descriptor instead of
2575
creating a new one with socket.socket().
1746
interface=None, use_ipv6=True):
2577
1747
self.interface = interface
2579
1749
self.address_family = socket.AF_INET6
2580
if socketfd is not None:
2581
# Save the file descriptor
2582
self.socketfd = socketfd
2583
# Save the original socket.socket() function
2584
self.socket_socket = socket.socket
2586
# To implement --socket, we monkey patch socket.socket.
2588
# (When socketserver.TCPServer is a new-style class, we
2589
# could make self.socket into a property instead of monkey
2590
# patching socket.socket.)
2592
# Create a one-time-only replacement for socket.socket()
2593
@functools.wraps(socket.socket)
2594
def socket_wrapper(*args, **kwargs):
2595
# Restore original function so subsequent calls are
2597
socket.socket = self.socket_socket
2598
del self.socket_socket
2599
# This time only, return a new socket object from the
2600
# saved file descriptor.
2601
return socket.fromfd(self.socketfd, *args, **kwargs)
2602
# Replace socket.socket() function with wrapper
2603
socket.socket = socket_wrapper
2604
# The socketserver.TCPServer.__init__ will call
2605
# socket.socket(), which might be our replacement,
2606
# socket_wrapper(), if socketfd was set.
2607
1750
socketserver.TCPServer.__init__(self, server_address,
2608
1751
RequestHandlerClass)
2610
1752
def server_bind(self):
2611
1753
"""This overrides the normal server_bind() function
2612
1754
to bind to an interface if one was specified, and also NOT to
2613
1755
bind to an address or port if they were not specified."""
2614
global SO_BINDTODEVICE
2615
1756
if self.interface is not None:
2616
1757
if SO_BINDTODEVICE is None:
2617
# Fall back to a hard-coded value which seems to be
2619
logger.warning("SO_BINDTODEVICE not found, trying 25")
2620
SO_BINDTODEVICE = 25
2622
self.socket.setsockopt(
2623
socket.SOL_SOCKET, SO_BINDTODEVICE,
2624
(self.interface + "\0").encode("utf-8"))
2625
except socket.error as error:
2626
if error.errno == errno.EPERM:
2627
logger.error("No permission to bind to"
2628
" interface %s", self.interface)
2629
elif error.errno == errno.ENOPROTOOPT:
2630
logger.error("SO_BINDTODEVICE not available;"
2631
" cannot bind to interface %s",
2633
elif error.errno == errno.ENODEV:
2634
logger.error("Interface %s does not exist,"
2635
" cannot bind", self.interface)
1758
logger.error("SO_BINDTODEVICE does not exist;"
1759
" cannot bind to interface %s",
1763
self.socket.setsockopt(socket.SOL_SOCKET,
1767
except socket.error as error:
1768
if error[0] == errno.EPERM:
1769
logger.error("No permission to"
1770
" bind to interface %s",
1772
elif error[0] == errno.ENOPROTOOPT:
1773
logger.error("SO_BINDTODEVICE not available;"
1774
" cannot bind to interface %s",
2638
1778
# Only bind(2) the socket if we really need to.
2639
1779
if self.server_address[0] or self.server_address[1]:
2640
if self.server_address[1]:
2641
self.allow_reuse_address = True
2642
1780
if not self.server_address[0]:
2643
1781
if self.address_family == socket.AF_INET6:
2644
any_address = "::" # in6addr_any
1782
any_address = "::" # in6addr_any
2646
any_address = "0.0.0.0" # INADDR_ANY
1784
any_address = socket.INADDR_ANY
2647
1785
self.server_address = (any_address,
2648
1786
self.server_address[1])
2649
1787
elif not self.server_address[1]:
2650
self.server_address = (self.server_address[0], 0)
1788
self.server_address = (self.server_address[0],
2651
1790
# if self.interface:
2652
1791
# self.server_address = (self.server_address[0],
2756
1895
funcname = request[1]
2757
1896
args = request[2]
2758
1897
kwargs = request[3]
2760
1899
parent_pipe.send(('data', getattr(client_object,
2761
1900
funcname)(*args,
2764
1903
if command == 'getattr':
2765
1904
attrname = request[1]
2766
if isinstance(client_object.__getattribute__(attrname),
2767
collections.abc.Callable):
2768
parent_pipe.send(('function', ))
1905
if callable(client_object.__getattribute__(attrname)):
1906
parent_pipe.send(('function',))
2771
'data', client_object.__getattribute__(attrname)))
1908
parent_pipe.send(('data', client_object
1909
.__getattribute__(attrname)))
2773
1911
if command == 'setattr':
2774
1912
attrname = request[1]
2775
1913
value = request[2]
2776
1914
setattr(client_object, attrname, value)
2781
def rfc3339_duration_to_delta(duration):
2782
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2784
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2786
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2788
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2790
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2792
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2794
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2796
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2800
# Parsing an RFC 3339 duration with regular expressions is not
2801
# possible - there would have to be multiple places for the same
2802
# values, like seconds. The current code, while more esoteric, is
2803
# cleaner without depending on a parsing library. If Python had a
2804
# built-in library for parsing we would use it, but we'd like to
2805
# avoid excessive use of external libraries.
2807
# New type for defining tokens, syntax, and semantics all-in-one
2808
Token = collections.namedtuple("Token", (
2809
"regexp", # To match token; if "value" is not None, must have
2810
# a "group" containing digits
2811
"value", # datetime.timedelta or None
2812
"followers")) # Tokens valid after this token
2813
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2814
# the "duration" ABNF definition in RFC 3339, Appendix A.
2815
token_end = Token(re.compile(r"$"), None, frozenset())
2816
token_second = Token(re.compile(r"(\d+)S"),
2817
datetime.timedelta(seconds=1),
2818
frozenset((token_end, )))
2819
token_minute = Token(re.compile(r"(\d+)M"),
2820
datetime.timedelta(minutes=1),
2821
frozenset((token_second, token_end)))
2822
token_hour = Token(re.compile(r"(\d+)H"),
2823
datetime.timedelta(hours=1),
2824
frozenset((token_minute, token_end)))
2825
token_time = Token(re.compile(r"T"),
2827
frozenset((token_hour, token_minute,
2829
token_day = Token(re.compile(r"(\d+)D"),
2830
datetime.timedelta(days=1),
2831
frozenset((token_time, token_end)))
2832
token_month = Token(re.compile(r"(\d+)M"),
2833
datetime.timedelta(weeks=4),
2834
frozenset((token_day, token_end)))
2835
token_year = Token(re.compile(r"(\d+)Y"),
2836
datetime.timedelta(weeks=52),
2837
frozenset((token_month, token_end)))
2838
token_week = Token(re.compile(r"(\d+)W"),
2839
datetime.timedelta(weeks=1),
2840
frozenset((token_end, )))
2841
token_duration = Token(re.compile(r"P"), None,
2842
frozenset((token_year, token_month,
2843
token_day, token_time,
2845
# Define starting values:
2847
value = datetime.timedelta()
2849
# Following valid tokens
2850
followers = frozenset((token_duration, ))
2851
# String left to parse
2853
# Loop until end token is found
2854
while found_token is not token_end:
2855
# Search for any currently valid tokens
2856
for token in followers:
2857
match = token.regexp.match(s)
2858
if match is not None:
2860
if token.value is not None:
2861
# Value found, parse digits
2862
factor = int(match.group(1), 10)
2863
# Add to value so far
2864
value += factor * token.value
2865
# Strip token from string
2866
s = token.regexp.sub("", s, 1)
2869
# Set valid next tokens
2870
followers = found_token.followers
2873
# No currently valid tokens were found
2874
raise ValueError("Invalid RFC 3339 duration: {!r}"
2880
1919
def string_to_delta(interval):
2881
1920
"""Parse a string and return a datetime.timedelta
2883
>>> string_to_delta('7d') == datetime.timedelta(7)
2885
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2887
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2889
>>> string_to_delta('24h') == datetime.timedelta(1)
2891
>>> string_to_delta('1w') == datetime.timedelta(7)
2893
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
1922
>>> string_to_delta('7d')
1923
datetime.timedelta(7)
1924
>>> string_to_delta('60s')
1925
datetime.timedelta(0, 60)
1926
>>> string_to_delta('60m')
1927
datetime.timedelta(0, 3600)
1928
>>> string_to_delta('24h')
1929
datetime.timedelta(1)
1930
>>> string_to_delta('1w')
1931
datetime.timedelta(7)
1932
>>> string_to_delta('5m 30s')
1933
datetime.timedelta(0, 330)
2898
return rfc3339_duration_to_delta(interval)
2902
1935
timevalue = datetime.timedelta(0)
2903
1936
for s in interval.split():
1938
suffix = unicode(s[-1])
2906
1939
value = int(s[:-1])
2907
1940
if suffix == "d":
2908
1941
delta = datetime.timedelta(value)
2980
2013
parser.add_argument("--no-dbus", action="store_false",
2981
2014
dest="use_dbus", help="Do not provide D-Bus"
2982
" system bus interface", default=None)
2015
" system bus interface")
2983
2016
parser.add_argument("--no-ipv6", action="store_false",
2984
dest="use_ipv6", help="Do not use IPv6",
2017
dest="use_ipv6", help="Do not use IPv6")
2986
2018
parser.add_argument("--no-restore", action="store_false",
2987
2019
dest="restore", help="Do not restore stored"
2988
" state", default=None)
2989
parser.add_argument("--socket", type=int,
2990
help="Specify a file descriptor to a network"
2991
" socket to use instead of creating one")
2992
2021
parser.add_argument("--statedir", metavar="DIR",
2993
2022
help="Directory to save/restore state in")
2994
parser.add_argument("--foreground", action="store_true",
2995
help="Run in foreground", default=None)
2996
parser.add_argument("--no-zeroconf", action="store_false",
2997
dest="zeroconf", help="Do not use Zeroconf",
3000
2024
options = parser.parse_args()
3002
2031
# Default values for config file for server-global settings
3003
if gnutls.has_rawpk:
3004
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3005
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3007
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3008
":+SIGN-DSA-SHA256")
3009
server_defaults = {"interface": "",
3013
"priority": priority,
3014
"servicename": "Mandos",
3020
"statedir": "/var/lib/mandos",
3021
"foreground": "False",
2032
server_defaults = { "interface": "",
2037
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2038
"servicename": "Mandos",
2043
"statedir": "/var/lib/mandos"
3026
2046
# Parse config file for server-global settings
3027
server_config = configparser.ConfigParser(server_defaults)
2047
server_config = configparser.SafeConfigParser(server_defaults)
3028
2048
del server_defaults
3029
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3030
# Convert the ConfigParser object to a dict
2049
server_config.read(os.path.join(options.configdir,
2051
# Convert the SafeConfigParser object to a dict
3031
2052
server_settings = server_config.defaults()
3032
2053
# Use the appropriate methods on the non-string config options
3033
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3034
"foreground", "zeroconf"):
2054
for option in ("debug", "use_dbus", "use_ipv6"):
3035
2055
server_settings[option] = server_config.getboolean("DEFAULT",
3037
2057
if server_settings["port"]:
3038
2058
server_settings["port"] = server_config.getint("DEFAULT",
3040
if server_settings["socket"]:
3041
server_settings["socket"] = server_config.getint("DEFAULT",
3043
# Later, stdin will, and stdout and stderr might, be dup'ed
3044
# over with an opened os.devnull. But we don't want this to
3045
# happen with a supplied network socket.
3046
if 0 <= server_settings["socket"] <= 2:
3047
server_settings["socket"] = os.dup(server_settings
3049
2060
del server_config
3051
2062
# Override the settings from the config file with command line
3052
2063
# options, if set.
3053
2064
for option in ("interface", "address", "port", "debug",
3054
"priority", "servicename", "configdir", "use_dbus",
3055
"use_ipv6", "debuglevel", "restore", "statedir",
3056
"socket", "foreground", "zeroconf"):
2065
"priority", "servicename", "configdir",
2066
"use_dbus", "use_ipv6", "debuglevel", "restore",
3057
2068
value = getattr(options, option)
3058
2069
if value is not None:
3059
2070
server_settings[option] = value
3061
2072
# Force all strings to be unicode
3062
2073
for option in server_settings.keys():
3063
if isinstance(server_settings[option], bytes):
3064
server_settings[option] = (server_settings[option]
3066
# Force all boolean options to be boolean
3067
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3068
"foreground", "zeroconf"):
3069
server_settings[option] = bool(server_settings[option])
3070
# Debug implies foreground
3071
if server_settings["debug"]:
3072
server_settings["foreground"] = True
2074
if type(server_settings[option]) is str:
2075
server_settings[option] = unicode(server_settings[option])
3073
2076
# Now we have our good server settings in "server_settings"
3075
2078
##################################################################
3077
if (not server_settings["zeroconf"]
3078
and not (server_settings["port"]
3079
or server_settings["socket"] != "")):
3080
parser.error("Needs port or socket to work without Zeroconf")
3082
2080
# For convenience
3083
2081
debug = server_settings["debug"]
3084
2082
debuglevel = server_settings["debuglevel"]
3086
2084
use_ipv6 = server_settings["use_ipv6"]
3087
2085
stored_state_path = os.path.join(server_settings["statedir"],
3088
2086
stored_state_file)
3089
foreground = server_settings["foreground"]
3090
zeroconf = server_settings["zeroconf"]
3093
initlogger(debug, logging.DEBUG)
2089
initlogger(logging.DEBUG)
3095
2091
if not debuglevel:
3098
2094
level = getattr(logging, debuglevel.upper())
3099
initlogger(debug, level)
3101
2097
if server_settings["servicename"] != "Mandos":
3102
syslogger.setFormatter(
3103
logging.Formatter('Mandos ({}) [%(process)d]:'
3104
' %(levelname)s: %(message)s'.format(
3105
server_settings["servicename"])))
2098
syslogger.setFormatter(logging.Formatter
2099
('Mandos (%s) [%%(process)d]:'
2100
' %%(levelname)s: %%(message)s'
2101
% server_settings["servicename"]))
3107
2103
# Parse config file with clients
3108
client_config = configparser.ConfigParser(Client.client_defaults)
2104
client_config = configparser.SafeConfigParser(Client.client_defaults)
3109
2105
client_config.read(os.path.join(server_settings["configdir"],
3110
2106
"clients.conf"))
3112
2108
global mandos_dbus_service
3113
2109
mandos_dbus_service = None
3116
if server_settings["socket"] != "":
3117
socketfd = server_settings["socket"]
3118
tcp_server = MandosServer(
3119
(server_settings["address"], server_settings["port"]),
3121
interface=(server_settings["interface"] or None),
3123
gnutls_priority=server_settings["priority"],
3127
pidfilename = "/run/mandos.pid"
3128
if not os.path.isdir("/run/."):
3129
pidfilename = "/var/run/mandos.pid"
3132
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3133
except IOError as e:
3134
logger.error("Could not open file %r", pidfilename,
3137
for name, group in (("_mandos", "_mandos"),
3138
("mandos", "mandos"),
3139
("nobody", "nogroup")):
3141
uid = pwd.getpwnam(name).pw_uid
3142
gid = pwd.getpwnam(group).pw_gid
2111
tcp_server = MandosServer((server_settings["address"],
2112
server_settings["port"]),
2114
interface=(server_settings["interface"]
2118
server_settings["priority"],
2121
pidfilename = "/var/run/mandos.pid"
2123
pidfile = open(pidfilename, "w")
2125
logger.error("Could not open file %r", pidfilename)
2128
uid = pwd.getpwnam("_mandos").pw_uid
2129
gid = pwd.getpwnam("_mandos").pw_gid
2132
uid = pwd.getpwnam("mandos").pw_uid
2133
gid = pwd.getpwnam("mandos").pw_gid
3144
2134
except KeyError:
2136
uid = pwd.getpwnam("nobody").pw_uid
2137
gid = pwd.getpwnam("nobody").pw_gid
3153
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3155
2144
except OSError as error:
3156
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3157
.format(uid, gid, os.strerror(error.errno)))
3158
if error.errno != errno.EPERM:
2145
if error[0] != errno.EPERM:
3162
2149
# Enable all possible GnuTLS debugging
3164
2151
# "Use a log level over 10 to enable all debugging options."
3165
2152
# - GnuTLS manual
3166
gnutls.global_set_log_level(11)
2153
gnutls.library.functions.gnutls_global_set_log_level(11)
2155
@gnutls.library.types.gnutls_log_func
3169
2156
def debug_gnutls(level, string):
3170
2157
logger.debug("GnuTLS: %s", string[:-1])
3172
gnutls.global_set_log_function(debug_gnutls)
2159
(gnutls.library.functions
2160
.gnutls_global_set_log_function(debug_gnutls))
3174
2162
# Redirect stdin so all checkers get /dev/null
3175
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2163
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3176
2164
os.dup2(null, sys.stdin.fileno())
2168
# No console logging
2169
logger.removeHandler(console)
3180
2171
# Need to fork before connecting to D-Bus
3182
2173
# Close all input and output, do double fork, etc.
3185
if gi.version_info < (3, 10, 2):
3186
# multiprocessing will use threads, so before we use GLib we
3187
# need to inform GLib that threads will be used.
3190
2176
global main_loop
3191
2177
# From the Avahi example code
3192
DBusGMainLoop(set_as_default=True)
3193
main_loop = GLib.MainLoop()
2178
DBusGMainLoop(set_as_default=True )
2179
main_loop = gobject.MainLoop()
3194
2180
bus = dbus.SystemBus()
3195
2181
# End of Avahi example code
3198
2184
bus_name = dbus.service.BusName("se.recompile.Mandos",
3201
old_bus_name = dbus.service.BusName(
3202
"se.bsnet.fukt.Mandos", bus,
3204
except dbus.exceptions.DBusException as e:
3205
logger.error("Disabling D-Bus:", exc_info=e)
2185
bus, do_not_queue=True)
2186
old_bus_name = (dbus.service.BusName
2187
("se.bsnet.fukt.Mandos", bus,
2189
except dbus.exceptions.NameExistsException as e:
2190
logger.error(unicode(e) + ", disabling D-Bus")
3206
2191
use_dbus = False
3207
2192
server_settings["use_dbus"] = False
3208
2193
tcp_server.use_dbus = False
3210
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3211
service = AvahiServiceToSyslog(
3212
name=server_settings["servicename"],
3213
servicetype="_mandos._tcp",
3216
if server_settings["interface"]:
3217
service.interface = if_nametoindex(
3218
server_settings["interface"].encode("utf-8"))
2194
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2195
service = AvahiServiceToSyslog(name =
2196
server_settings["servicename"],
2197
servicetype = "_mandos._tcp",
2198
protocol = protocol, bus = bus)
2199
if server_settings["interface"]:
2200
service.interface = (if_nametoindex
2201
(str(server_settings["interface"])))
3220
2203
global multiprocessing_manager
3221
2204
multiprocessing_manager = multiprocessing.Manager()
3223
2206
client_class = Client
3225
client_class = functools.partial(ClientDBus, bus=bus)
2208
client_class = functools.partial(ClientDBusTransitional,
3227
2211
client_settings = Client.config_parser(client_config)
3228
2212
old_client_settings = {}
3231
# This is used to redirect stdout and stderr for checker processes
3233
wnull = open(os.devnull, "w") # A writable /dev/null
3234
# Only used if server is running in foreground but not in debug
3236
if debug or not foreground:
3239
2215
# Get client data and settings from last running state.
3240
2216
if server_settings["restore"]:
3242
2218
with open(stored_state_path, "rb") as stored_state:
3243
if sys.version_info.major == 2:
3244
clients_data, old_client_settings = pickle.load(
3247
bytes_clients_data, bytes_old_client_settings = (
3248
pickle.load(stored_state, encoding="bytes"))
3249
# Fix bytes to strings
3252
clients_data = {(key.decode("utf-8")
3253
if isinstance(key, bytes)
3256
bytes_clients_data.items()}
3257
del bytes_clients_data
3258
for key in clients_data:
3259
value = {(k.decode("utf-8")
3260
if isinstance(k, bytes) else k): v
3262
clients_data[key].items()}
3263
clients_data[key] = value
3265
value["client_structure"] = [
3267
if isinstance(s, bytes)
3269
value["client_structure"]]
3270
# .name, .host, and .checker_command
3271
for k in ("name", "host", "checker_command"):
3272
if isinstance(value[k], bytes):
3273
value[k] = value[k].decode("utf-8")
3274
if "key_id" not in value:
3275
value["key_id"] = ""
3276
elif "fingerprint" not in value:
3277
value["fingerprint"] = ""
3278
# old_client_settings
3280
old_client_settings = {
3281
(key.decode("utf-8")
3282
if isinstance(key, bytes)
3285
bytes_old_client_settings.items()}
3286
del bytes_old_client_settings
3287
# .host and .checker_command
3288
for value in old_client_settings.values():
3289
for attribute in ("host", "checker_command"):
3290
if isinstance(value[attribute], bytes):
3291
value[attribute] = (value[attribute]
2219
clients_data, old_client_settings = (pickle.load
3293
2221
os.remove(stored_state_path)
3294
2222
except IOError as e:
3295
if e.errno == errno.ENOENT:
3296
logger.warning("Could not load persistent state:"
3297
" {}".format(os.strerror(e.errno)))
3299
logger.critical("Could not load persistent state:",
2223
logger.warning("Could not load persistent state: {0}"
2225
if e.errno != errno.ENOENT:
3302
except EOFError as e:
3303
logger.warning("Could not load persistent state: "
3307
2228
with PGPEngine() as pgp:
3308
for client_name, client in clients_data.items():
3309
# Skip removed clients
3310
if client_name not in client_settings:
2229
for client in clients_data:
2230
client_name = client["name"]
3313
2232
# Decide which value to use after restoring saved state.
3314
2233
# We have three different values: Old config file,
3315
2234
# new config file, and saved state.
3320
2239
# For each value in new config, check if it
3321
2240
# differs from the old config value (Except for
3322
2241
# the "secret" attribute)
3323
if (name != "secret"
3325
old_client_settings[client_name][name])):
2242
if (name != "secret" and
2243
value != old_client_settings[client_name]
3326
2245
client[name] = value
3327
2246
except KeyError:
3330
2249
# Clients who has passed its expire date can still be
3331
# enabled if its last checker was successful. A Client
3332
# whose checker succeeded before we stored its state is
3333
# assumed to have successfully run all checkers during
2250
# enabled if its last checker was successful. Clients
2251
# whose checker failed before we stored its state is
2252
# assumed to have failed all checkers during downtime.
3335
2253
if client["enabled"]:
3336
2254
if datetime.datetime.utcnow() >= client["expires"]:
3337
2255
if not client["last_checked_ok"]:
3338
2256
logger.warning(
3339
"disabling client {} - Client never "
3340
"performed a successful checker".format(
2257
"disabling client {0} - Client never "
2258
"performed a successfull checker"
2259
.format(client["name"]))
3342
2260
client["enabled"] = False
3343
2261
elif client["last_checker_status"] != 0:
3344
2262
logger.warning(
3345
"disabling client {} - Client last"
3346
" checker failed with error code"
3349
client["last_checker_status"]))
2263
"disabling client {0} - Client "
2264
"last checker failed with error code {1}"
2265
.format(client["name"],
2266
client["last_checker_status"]))
3350
2267
client["enabled"] = False
3352
client["expires"] = (
3353
datetime.datetime.utcnow()
3354
+ client["timeout"])
3355
logger.debug("Last checker succeeded,"
3356
" keeping {} enabled".format(
2269
client["expires"] = (datetime.datetime
2271
+ client["timeout"])
2273
client["changedstate"] = (multiprocessing_manager
2275
(multiprocessing_manager
2277
client["checker"] = None
2279
new_client = (ClientDBusTransitional.__new__
2280
(ClientDBusTransitional))
2281
tcp_server.clients[client_name] = new_client
2282
new_client.bus = bus
2283
for name, value in client.iteritems():
2284
setattr(new_client, name, value)
2285
client_object_name = unicode(client_name).translate(
2286
{ord("."): ord("_"),
2287
ord("-"): ord("_")})
2288
new_client.dbus_object_path = (dbus.ObjectPath
2290
+ client_object_name))
2291
DBusObjectWithProperties.__init__(new_client,
2296
tcp_server.clients[client_name] = (Client.__new__
2298
for name, value in client.iteritems():
2299
setattr(tcp_server.clients[client_name],
3359
client["secret"] = pgp.decrypt(
3360
client["encrypted_secret"],
3361
client_settings[client_name]["secret"])
2303
tcp_server.clients[client_name].secret = (
2304
pgp.decrypt(tcp_server.clients[client_name]
2306
client_settings[client_name]
3362
2308
except PGPError:
3363
2309
# If decryption fails, we use secret from new settings
3364
logger.debug("Failed to decrypt {} old secret".format(
3366
client["secret"] = (client_settings[client_name]
3369
# Add/remove clients based on new changes made to config
3370
for client_name in (set(old_client_settings)
3371
- set(client_settings)):
3372
del clients_data[client_name]
3373
for client_name in (set(client_settings)
3374
- set(old_client_settings)):
3375
clients_data[client_name] = client_settings[client_name]
3377
# Create all client objects
3378
for client_name, client in clients_data.items():
3379
tcp_server.clients[client_name] = client_class(
3382
server_settings=server_settings)
2310
logger.debug("Failed to decrypt {0} old secret"
2311
.format(client_name))
2312
tcp_server.clients[client_name].secret = (
2313
client_settings[client_name]["secret"])
2315
# Create/remove clients based on new changes made to config
2316
for clientname in set(old_client_settings) - set(client_settings):
2317
del tcp_server.clients[clientname]
2318
for clientname in set(client_settings) - set(old_client_settings):
2319
tcp_server.clients[clientname] = (client_class(name = clientname,
3384
2324
if not tcp_server.clients:
3385
2325
logger.warning("No clients defined")
3388
if pidfile is not None:
3392
print(pid, file=pidfile)
3394
logger.error("Could not write to file %r with PID %d",
2331
pidfile.write(str(pid) + "\n".encode("utf-8"))
2334
logger.error("Could not write to file %r with PID %d",
2337
# "pidfile" was never created
3397
2339
del pidfilename
3399
for termsig in (signal.SIGHUP, signal.SIGTERM):
3400
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3401
lambda: main_loop.quit() and False)
2340
signal.signal(signal.SIGINT, signal.SIG_IGN)
2342
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2343
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3405
@alternate_dbus_interfaces(
3406
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3407
class MandosDBusService(DBusObjectWithObjectManager):
2346
class MandosDBusService(dbus.service.Object):
3408
2347
"""A D-Bus proxy object"""
3410
2348
def __init__(self):
3411
2349
dbus.service.Object.__init__(self, bus, "/")
3413
2350
_interface = "se.recompile.Mandos"
3415
2352
@dbus.service.signal(_interface, signature="o")
3416
2353
def ClientAdded(self, objpath):
3420
2357
@dbus.service.signal(_interface, signature="ss")
3421
def ClientNotFound(self, key_id, address):
2358
def ClientNotFound(self, fingerprint, address):
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3427
2362
@dbus.service.signal(_interface, signature="os")
3428
2363
def ClientRemoved(self, objpath, name):
3432
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3434
2367
@dbus.service.method(_interface, out_signature="ao")
3435
2368
def GetAllClients(self):
3437
return dbus.Array(c.dbus_object_path for c in
3438
tcp_server.clients.values())
3440
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2370
return dbus.Array(c.dbus_object_path
2372
tcp_server.clients.itervalues())
3442
2374
@dbus.service.method(_interface,
3443
2375
out_signature="a{oa{sv}}")
3444
2376
def GetAllClientsWithProperties(self):
3446
2378
return dbus.Dictionary(
3447
{c.dbus_object_path: c.GetAll(
3448
"se.recompile.Mandos.Client")
3449
for c in tcp_server.clients.values()},
2379
((c.dbus_object_path, c.GetAll(""))
2380
for c in tcp_server.clients.itervalues()),
3450
2381
signature="oa{sv}")
3452
2383
@dbus.service.method(_interface, in_signature="o")
3453
2384
def RemoveClient(self, object_path):
3455
for c in tcp_server.clients.values():
2386
for c in tcp_server.clients.itervalues():
3456
2387
if c.dbus_object_path == object_path:
3457
2388
del tcp_server.clients[c.name]
3458
2389
c.remove_from_connection()
3459
# Don't signal the disabling
2390
# Don't signal anything except ClientRemoved
3460
2391
c.disable(quiet=True)
3461
# Emit D-Bus signal for removal
3462
self.client_removed_signal(c)
2393
self.ClientRemoved(object_path, c.name)
3464
2395
raise KeyError(object_path)
3468
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3469
out_signature="a{oa{sa{sv}}}")
3470
def GetManagedObjects(self):
3472
return dbus.Dictionary(
3473
{client.dbus_object_path:
3475
{interface: client.GetAll(interface)
3477
client._get_all_interface_names()})
3478
for client in tcp_server.clients.values()})
3480
def client_added_signal(self, client):
3481
"""Send the new standard signal and the old signal"""
3483
# New standard signal
3484
self.InterfacesAdded(
3485
client.dbus_object_path,
3487
{interface: client.GetAll(interface)
3489
client._get_all_interface_names()}))
3491
self.ClientAdded(client.dbus_object_path)
3493
def client_removed_signal(self, client):
3494
"""Send the new standard signal and the old signal"""
3496
# New standard signal
3497
self.InterfacesRemoved(
3498
client.dbus_object_path,
3499
client._get_all_interface_names())
3501
self.ClientRemoved(client.dbus_object_path,
3504
mandos_dbus_service = MandosDBusService()
3506
# Save modules to variables to exempt the modules from being
3507
# unloaded before the function registered with atexit() is run.
3508
mp = multiprocessing
2399
class MandosDBusServiceTransitional(MandosDBusService):
2400
__metaclass__ = AlternateDBusNamesMetaclass
2401
mandos_dbus_service = MandosDBusServiceTransitional()
3512
2404
"Cleanup function; run on exit"
3516
mp.active_children()
2407
multiprocessing.active_children()
3518
2408
if not (tcp_server.clients or client_settings):
3521
2411
# Store client before exiting. Secrets are encrypted with key
3522
2412
# based on what config file has. If config file is
3523
2413
# removed/edited, old secret will thus be unrecovable.
3525
2415
with PGPEngine() as pgp:
3526
for client in tcp_server.clients.values():
2416
for client in tcp_server.clients.itervalues():
3527
2417
key = client_settings[client.name]["secret"]
3528
2418
client.encrypted_secret = pgp.encrypt(client.secret,
3530
2420
client_dict = {}
3532
# A list of attributes that can not be pickled
3534
exclude = {"bus", "changedstate", "secret",
3535
"checker", "server_settings"}
3536
for name, typ in inspect.getmembers(dbus.service
2422
# A list of attributes that will not be stored when
2424
exclude = set(("bus", "changedstate", "secret",
2426
for name, typ in (inspect.getmembers
2427
(dbus.service.Object)):
3538
2428
exclude.add(name)
3540
2430
client_dict["encrypted_secret"] = (client
3541
2431
.encrypted_secret)
3542
2432
for attr in client.client_structure:
3543
2433
if attr not in exclude:
3544
2434
client_dict[attr] = getattr(client, attr)
3546
clients[client.name] = client_dict
2436
clients.append(client_dict)
3547
2437
del client_settings[client.name]["secret"]
3550
with tempfile.NamedTemporaryFile(
3554
dir=os.path.dirname(stored_state_path),
3555
delete=False) as stored_state:
3556
pickle.dump((clients, client_settings), stored_state,
3558
tempname = stored_state.name
3559
os.rename(tempname, stored_state_path)
2440
with os.fdopen(os.open(stored_state_path,
2441
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2442
0600), "wb") as stored_state:
2443
pickle.dump((clients, client_settings), stored_state)
3560
2444
except (IOError, OSError) as e:
3566
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3567
logger.warning("Could not save persistent state: {}"
3568
.format(os.strerror(e.errno)))
3570
logger.warning("Could not save persistent state:",
2445
logger.warning("Could not save persistent state: {0}"
2447
if e.errno not in (errno.ENOENT, errno.EACCES):
3574
2450
# Delete all clients, and settings from config
3575
2451
while tcp_server.clients:
3576
2452
name, client = tcp_server.clients.popitem()
3578
2454
client.remove_from_connection()
3579
# Don't signal the disabling
2455
# Don't signal anything except ClientRemoved
3580
2456
client.disable(quiet=True)
3581
# Emit D-Bus signal for removal
3583
mandos_dbus_service.client_removed_signal(client)
2459
mandos_dbus_service.ClientRemoved(client
3584
2462
client_settings.clear()
3586
2464
atexit.register(cleanup)
3588
for client in tcp_server.clients.values():
2466
for client in tcp_server.clients.itervalues():
3590
# Emit D-Bus signal for adding
3591
mandos_dbus_service.client_added_signal(client)
2469
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3592
2470
# Need to initiate checking of clients
3593
2471
if client.enabled:
3594
2472
client.init_checker()
3596
2474
tcp_server.enable()
3597
2475
tcp_server.server_activate()
3599
2477
# Find out what port we got
3601
service.port = tcp_server.socket.getsockname()[1]
2478
service.port = tcp_server.socket.getsockname()[1]
3603
2480
logger.info("Now listening on address %r, port %d,"
3604
" flowinfo %d, scope_id %d",
3605
*tcp_server.socket.getsockname())
2481
" flowinfo %d, scope_id %d"
2482
% tcp_server.socket.getsockname())
3607
logger.info("Now listening on address %r, port %d",
3608
*tcp_server.socket.getsockname())
3610
# service.interface = tcp_server.socket.getsockname()[3]
2484
logger.info("Now listening on address %r, port %d"
2485
% tcp_server.socket.getsockname())
2487
#service.interface = tcp_server.socket.getsockname()[3]
3614
# From the Avahi example code
3617
except dbus.exceptions.DBusException as error:
3618
logger.critical("D-Bus Exception", exc_info=error)
3621
# End of Avahi example code
3624
GLib.IOChannel.unix_new(tcp_server.fileno()),
3625
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3626
lambda *args, **kwargs: (tcp_server.handle_request
3627
(*args[2:], **kwargs) or True))
2490
# From the Avahi example code
2493
except dbus.exceptions.DBusException as error:
2494
logger.critical("DBusException: %s", error)
2497
# End of Avahi example code
2499
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2500
lambda *args, **kwargs:
2501
(tcp_server.handle_request
2502
(*args[2:], **kwargs) or True))
3629
2504
logger.debug("Starting main loop")
3630
2505
main_loop.run()
3631
2506
except AvahiError as error:
3632
logger.critical("Avahi Error", exc_info=error)
2507
logger.critical("AvahiError: %s", error)
3635
2510
except KeyboardInterrupt: