255
167
os.rmdir(self.tempdir)
256
168
self.tempdir = None
258
170
def password_encode(self, password):
259
171
# Passphrase can not be empty and can not contain newlines or
260
172
# 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"))
173
return b"mandos" + binascii.hexlify(password)
269
175
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:
176
self.gnupg.passphrase = self.password_encode(password)
177
with open(os.devnull) as devnull:
179
proc = self.gnupg.run(['--symmetric'],
180
create_fhs=['stdin', 'stdout'],
181
attach_fhs={'stderr': devnull})
182
with contextlib.closing(proc.handles['stdin']) as f:
184
with contextlib.closing(proc.handles['stdout']) as f:
185
ciphertext = f.read()
189
self.gnupg.passphrase = None
285
190
return ciphertext
287
192
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:
193
self.gnupg.passphrase = self.password_encode(password)
194
with open(os.devnull) as devnull:
196
proc = self.gnupg.run(['--decrypt'],
197
create_fhs=['stdin', 'stdout'],
198
attach_fhs={'stderr': devnull})
199
with contextlib.closing(proc.handles['stdin'] ) as f:
201
with contextlib.closing(proc.handles['stdout']) as f:
202
decrypted_plaintext = f.read()
206
self.gnupg.passphrase = None
303
207
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
211
class AvahiError(Exception):
333
212
def __init__(self, value, *args, **kwargs):
334
213
self.value = value
335
return super(AvahiError, self).__init__(value, *args,
214
super(AvahiError, self).__init__(value, *args, **kwargs)
215
def __unicode__(self):
216
return unicode(repr(self.value))
339
218
class AvahiServiceError(AvahiError):
343
221
class AvahiGroupError(AvahiError):
225
class AvahiService(object):
348
226
"""An Avahi (Zeroconf) service.
351
229
interface: integer; avahi.IF_UNSPEC or an interface index.
352
230
Used to optionally bind to the specified interface.
353
231
name: string; Example: 'Mandos'
354
232
type: string; Example: '_mandos._tcp'.
355
See <https://www.iana.org/assignments/service-names-port-numbers>
233
See <http://www.dns-sd.org/ServiceTypes.html>
356
234
port: integer; what port to announce
357
235
TXT: list of strings; TXT record for the service
358
236
domain: string; Domain to publish on, default to .local if empty.
517
365
follow_name_owner_changes=True),
518
366
avahi.DBUS_INTERFACE_SERVER)
519
367
self.server.connect_to_signal("StateChanged",
520
self.server_state_changed)
368
self.server_state_changed)
521
369
self.server_state_changed(self.server.GetState())
524
371
class AvahiServiceToSyslog(AvahiService):
525
def rename(self, *args, **kwargs):
526
373
"""Add the new name to the syslog messages"""
527
ret = super(AvahiServiceToSyslog, self).rename(*args,
529
syslogger.setFormatter(logging.Formatter(
530
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
374
ret = AvahiService.rename(self)
375
syslogger.setFormatter(logging.Formatter
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
535
# Pretend that we have a GnuTLS module
537
"""This isn't so much a class as it is a module-like namespace."""
539
library = ctypes.util.find_library("gnutls")
541
library = ctypes.util.find_library("gnutls-deb0")
542
_library = ctypes.cdll.LoadLibrary(library)
545
# Unless otherwise indicated, the constants and types below are
546
# all from the gnutls/gnutls.h C header file.
557
E_NO_CERTIFICATE_FOUND = -49
562
KEYID_USE_SHA256 = 1 # gnutls/x509.h
563
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
566
class _session_int(ctypes.Structure):
568
session_t = ctypes.POINTER(_session_int)
570
class certificate_credentials_st(ctypes.Structure):
572
certificate_credentials_t = ctypes.POINTER(
573
certificate_credentials_st)
574
certificate_type_t = ctypes.c_int
576
class datum_t(ctypes.Structure):
577
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
578
('size', ctypes.c_uint)]
580
class _openpgp_crt_int(ctypes.Structure):
582
openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
583
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
584
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
585
credentials_type_t = ctypes.c_int
586
transport_ptr_t = ctypes.c_void_p
587
close_request_t = ctypes.c_int
590
class Error(Exception):
591
def __init__(self, message=None, code=None, args=()):
592
# Default usage is by a message string, but if a return
593
# code is passed, convert it to a string with
596
if message is None and code is not None:
597
message = gnutls.strerror(code).decode(
598
"utf-8", errors="replace")
599
return super(gnutls.Error, self).__init__(
602
class CertificateSecurityError(Error):
606
def __init__(self, cls):
609
def from_param(self, obj):
610
if not isinstance(obj, self.cls):
611
raise TypeError("Not of type {}: {!r}"
612
.format(self.cls.__name__, obj))
613
return ctypes.byref(obj.from_param(obj))
615
class CastToVoidPointer:
616
def __init__(self, cls):
619
def from_param(self, obj):
620
if not isinstance(obj, self.cls):
621
raise TypeError("Not of type {}: {!r}"
622
.format(self.cls.__name__, obj))
623
return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
625
class With_from_param:
627
def from_param(cls, obj):
628
return obj._as_parameter_
631
class Credentials(With_from_param):
633
self._as_parameter_ = gnutls.certificate_credentials_t()
634
gnutls.certificate_allocate_credentials(self)
635
self.type = gnutls.CRD_CERTIFICATE
638
gnutls.certificate_free_credentials(self)
640
class ClientSession(With_from_param):
641
def __init__(self, socket, credentials=None):
642
self._as_parameter_ = gnutls.session_t()
643
gnutls_flags = gnutls.CLIENT
644
if gnutls.check_version(b"3.5.6"):
645
gnutls_flags |= gnutls.NO_TICKETS
647
gnutls_flags |= gnutls.ENABLE_RAWPK
648
gnutls.init(self, gnutls_flags)
650
gnutls.set_default_priority(self)
651
gnutls.transport_set_ptr(self, socket.fileno())
652
gnutls.handshake_set_private_extensions(self, True)
654
if credentials is None:
655
credentials = gnutls.Credentials()
656
gnutls.credentials_set(self, credentials.type,
658
self.credentials = credentials
664
return gnutls.handshake(self)
666
def send(self, data):
670
data_len -= gnutls.record_send(self, data[-data_len:],
674
return gnutls.bye(self, gnutls.SHUT_RDWR)
676
# Error handling functions
677
def _error_code(result):
678
"""A function to raise exceptions on errors, suitable
679
for the 'restype' attribute on ctypes functions"""
680
if result >= gnutls.E_SUCCESS:
682
if result == gnutls.E_NO_CERTIFICATE_FOUND:
683
raise gnutls.CertificateSecurityError(code=result)
684
raise gnutls.Error(code=result)
686
def _retry_on_error(result, func, arguments,
687
_error_code=_error_code):
688
"""A function to retry on some errors, suitable
689
for the 'errcheck' attribute on ctypes functions"""
690
while result < gnutls.E_SUCCESS:
691
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
692
return _error_code(result)
693
result = func(*arguments)
696
# Unless otherwise indicated, the function declarations below are
697
# all from the gnutls/gnutls.h C header file.
700
priority_set_direct = _library.gnutls_priority_set_direct
701
priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
702
ctypes.POINTER(ctypes.c_char_p)]
703
priority_set_direct.restype = _error_code
705
init = _library.gnutls_init
706
init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
707
init.restype = _error_code
709
set_default_priority = _library.gnutls_set_default_priority
710
set_default_priority.argtypes = [ClientSession]
711
set_default_priority.restype = _error_code
713
record_send = _library.gnutls_record_send
714
record_send.argtypes = [ClientSession, ctypes.c_void_p,
716
record_send.restype = ctypes.c_ssize_t
717
record_send.errcheck = _retry_on_error
719
certificate_allocate_credentials = (
720
_library.gnutls_certificate_allocate_credentials)
721
certificate_allocate_credentials.argtypes = [
722
PointerTo(Credentials)]
723
certificate_allocate_credentials.restype = _error_code
725
certificate_free_credentials = (
726
_library.gnutls_certificate_free_credentials)
727
certificate_free_credentials.argtypes = [Credentials]
728
certificate_free_credentials.restype = None
730
handshake_set_private_extensions = (
731
_library.gnutls_handshake_set_private_extensions)
732
handshake_set_private_extensions.argtypes = [ClientSession,
734
handshake_set_private_extensions.restype = None
736
credentials_set = _library.gnutls_credentials_set
737
credentials_set.argtypes = [ClientSession, credentials_type_t,
738
CastToVoidPointer(Credentials)]
739
credentials_set.restype = _error_code
741
strerror = _library.gnutls_strerror
742
strerror.argtypes = [ctypes.c_int]
743
strerror.restype = ctypes.c_char_p
745
certificate_type_get = _library.gnutls_certificate_type_get
746
certificate_type_get.argtypes = [ClientSession]
747
certificate_type_get.restype = _error_code
749
certificate_get_peers = _library.gnutls_certificate_get_peers
750
certificate_get_peers.argtypes = [ClientSession,
751
ctypes.POINTER(ctypes.c_uint)]
752
certificate_get_peers.restype = ctypes.POINTER(datum_t)
754
global_set_log_level = _library.gnutls_global_set_log_level
755
global_set_log_level.argtypes = [ctypes.c_int]
756
global_set_log_level.restype = None
758
global_set_log_function = _library.gnutls_global_set_log_function
759
global_set_log_function.argtypes = [log_func]
760
global_set_log_function.restype = None
762
deinit = _library.gnutls_deinit
763
deinit.argtypes = [ClientSession]
764
deinit.restype = None
766
handshake = _library.gnutls_handshake
767
handshake.argtypes = [ClientSession]
768
handshake.restype = ctypes.c_int
769
handshake.errcheck = _retry_on_error
771
transport_set_ptr = _library.gnutls_transport_set_ptr
772
transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
773
transport_set_ptr.restype = None
775
bye = _library.gnutls_bye
776
bye.argtypes = [ClientSession, close_request_t]
777
bye.restype = ctypes.c_int
778
bye.errcheck = _retry_on_error
780
check_version = _library.gnutls_check_version
781
check_version.argtypes = [ctypes.c_char_p]
782
check_version.restype = ctypes.c_char_p
784
_need_version = b"3.3.0"
785
if check_version(_need_version) is None:
786
raise self.Error("Needs GnuTLS {} or later"
787
.format(_need_version))
789
_tls_rawpk_version = b"3.6.6"
790
has_rawpk = bool(check_version(_tls_rawpk_version))
794
class pubkey_st(ctypes.Structure):
796
pubkey_t = ctypes.POINTER(pubkey_st)
798
x509_crt_fmt_t = ctypes.c_int
800
# All the function declarations below are from
802
pubkey_init = _library.gnutls_pubkey_init
803
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
804
pubkey_init.restype = _error_code
806
pubkey_import = _library.gnutls_pubkey_import
807
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
809
pubkey_import.restype = _error_code
811
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
812
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
813
ctypes.POINTER(ctypes.c_ubyte),
814
ctypes.POINTER(ctypes.c_size_t)]
815
pubkey_get_key_id.restype = _error_code
817
pubkey_deinit = _library.gnutls_pubkey_deinit
818
pubkey_deinit.argtypes = [pubkey_t]
819
pubkey_deinit.restype = None
821
# All the function declarations below are from
824
openpgp_crt_init = _library.gnutls_openpgp_crt_init
825
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
826
openpgp_crt_init.restype = _error_code
828
openpgp_crt_import = _library.gnutls_openpgp_crt_import
829
openpgp_crt_import.argtypes = [openpgp_crt_t,
830
ctypes.POINTER(datum_t),
832
openpgp_crt_import.restype = _error_code
834
openpgp_crt_verify_self = \
835
_library.gnutls_openpgp_crt_verify_self
836
openpgp_crt_verify_self.argtypes = [
839
ctypes.POINTER(ctypes.c_uint),
841
openpgp_crt_verify_self.restype = _error_code
843
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
844
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
845
openpgp_crt_deinit.restype = None
847
openpgp_crt_get_fingerprint = (
848
_library.gnutls_openpgp_crt_get_fingerprint)
849
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
853
openpgp_crt_get_fingerprint.restype = _error_code
855
if check_version(b"3.6.4"):
856
certificate_type_get2 = _library.gnutls_certificate_type_get2
857
certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
858
certificate_type_get2.restype = _error_code
860
# Remove non-public functions
861
del _error_code, _retry_on_error
864
def call_pipe(connection, # : multiprocessing.Connection
865
func, *args, **kwargs):
866
"""This function is meant to be called by multiprocessing.Process
868
This function runs func(*args, **kwargs), and writes the resulting
869
return value on the provided multiprocessing.Connection.
871
connection.send(func(*args, **kwargs))
381
def timedelta_to_milliseconds(td):
382
"Convert a datetime.timedelta() to milliseconds"
383
return ((td.days * 24 * 60 * 60 * 1000)
384
+ (td.seconds * 1000)
385
+ (td.microseconds // 1000))
387
class Client(object):
876
388
"""A representation of a client host served by this server.
879
391
approved: bool(); 'None' if not yet approved/disapproved
880
392
approval_delay: datetime.timedelta(); Time to wait for approval
881
393
approval_duration: datetime.timedelta(); Duration of one approval
882
checker: multiprocessing.Process(); a running checker process used
883
to see if the client lives. 'None' if no process is
885
checker_callback_tag: a GLib event source tag, or None
394
checker: subprocess.Popen(); a running checker process used
395
to see if the client lives.
396
'None' if no process is running.
397
checker_callback_tag: a gobject event source tag, or None
886
398
checker_command: string; External command which is run to check
887
399
if client lives. %() expansions are done at
888
400
runtime with vars(self) as dict, so that for
889
401
instance %(name)s can be used in the command.
890
checker_initiator_tag: a GLib event source tag, or None
402
checker_initiator_tag: a gobject event source tag, or None
891
403
created: datetime.datetime(); (UTC) object creation
892
404
client_structure: Object describing what attributes a client has
893
405
and is used for storing the client at exit
894
406
current_checker_command: string; current running checker_command
895
disable_initiator_tag: a GLib event source tag, or None
407
disable_initiator_tag: a gobject event source tag, or None
897
409
fingerprint: string (40 or 32 hexadecimal digits); used to
898
uniquely identify an OpenPGP client
899
key_id: string (64 hexadecimal digits); used to uniquely identify
900
a client using raw public keys
410
uniquely identify the client
901
411
host: string; available for use by the checker command
902
412
interval: datetime.timedelta(); How often to start a new checker
903
413
last_approval_request: datetime.datetime(); (UTC) or None
904
414
last_checked_ok: datetime.datetime(); (UTC) or None
905
415
last_checker_status: integer between 0 and 255 reflecting exit
906
416
status of last checker. -1 reflects crashed
907
checker, -2 means no checker completed yet.
908
last_checker_signal: The signal which killed the last checker, if
909
last_checker_status is -1
910
418
last_enabled: datetime.datetime(); (UTC) or None
911
419
name: string; from the config file, used in log messages and
912
420
D-Bus identifiers
913
421
secret: bytestring; sent verbatim (over TLS) to client
914
422
timeout: datetime.timedelta(); How long from last_checked_ok
915
423
until this client is disabled
916
extended_timeout: extra long timeout when secret has been sent
424
extended_timeout: extra long timeout when password has been sent
917
425
runtime_expansions: Allowed attributes for runtime expansion.
918
426
expires: datetime.datetime(); time (UTC) when a client will be
919
427
disabled, or None
920
server_settings: The server_settings dict from main()
923
430
runtime_expansions = ("approval_delay", "approval_duration",
924
"created", "enabled", "expires", "key_id",
925
"fingerprint", "host", "interval",
926
"last_approval_request", "last_checked_ok",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
927
433
"last_enabled", "name", "timeout")
930
"extended_timeout": "PT15M",
932
"checker": "fping -q -- %%(host)s",
934
"approval_delay": "PT0S",
935
"approval_duration": "PT1S",
936
"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)
941
461
def config_parser(config):
942
"""Construct a new dict of client settings of this form:
462
""" Construct a new dict of client settings of this form:
943
463
{ client_name: {setting_name: value, ...}, ...}
944
with exceptions for any special settings as defined above.
945
NOTE: Must be a pure function. Must return the same result
946
value given the same arguments.
464
with exceptions for any special settings as defined above"""
949
466
for client_name in config.sections():
950
467
section = dict(config.items(client_name))
951
468
client = settings[client_name] = {}
953
470
client["host"] = section["host"]
954
471
# Reformat values from string types to Python types
955
472
client["approved_by_default"] = config.getboolean(
956
473
client_name, "approved_by_default")
957
client["enabled"] = config.getboolean(client_name,
960
# Uppercase and remove spaces from key_id and fingerprint
961
# for later comparison purposes with return value from the
962
# key_id() and fingerprint() functions
963
client["key_id"] = (section.get("key_id", "").upper()
474
client["enabled"] = config.getboolean(client_name, "enabled")
965
476
client["fingerprint"] = (section["fingerprint"].upper()
966
477
.replace(" ", ""))
967
478
if "secret" in section:
968
client["secret"] = codecs.decode(section["secret"]
479
client["secret"] = section["secret"].decode("base64")
971
480
elif "secfile" in section:
972
481
with open(os.path.expanduser(os.path.expandvars
973
482
(section["secfile"])),
974
483
"rb") as secfile:
975
484
client["secret"] = secfile.read()
977
raise TypeError("No secret or secfile for section {}"
486
raise TypeError("No secret or secfile for section %s"
979
488
client["timeout"] = string_to_delta(section["timeout"])
980
489
client["extended_timeout"] = string_to_delta(
981
490
section["extended_timeout"])
1024
532
self.current_checker_command = None
1025
533
self.approved = None
1026
534
self.approvals_pending = 0
1027
self.changedstate = multiprocessing_manager.Condition(
1028
multiprocessing_manager.Lock())
1029
self.client_structure = [attr
1030
for attr in self.__dict__.keys()
535
self.changedstate = (multiprocessing_manager
536
.Condition(multiprocessing_manager
538
self.client_structure = [attr for attr in
539
self.__dict__.iterkeys()
1031
540
if not attr.startswith("_")]
1032
541
self.client_structure.append("client_structure")
1034
for name, t in inspect.getmembers(
1035
type(self), lambda obj: isinstance(obj, property)):
543
for name, t in inspect.getmembers(type(self),
1036
547
if not name.startswith("_"):
1037
548
self.client_structure.append(name)
1039
550
# Send notice to process children that client state has changed
1040
551
def send_changedstate(self):
1041
552
with self.changedstate:
1042
553
self.changedstate.notify_all()
1044
555
def enable(self):
1045
556
"""Start this client's checker and timeout hooks"""
1046
557
if getattr(self, "enabled", False):
1047
558
# Already enabled
560
self.send_changedstate()
1049
561
self.expires = datetime.datetime.utcnow() + self.timeout
1050
562
self.enabled = True
1051
563
self.last_enabled = datetime.datetime.utcnow()
1052
564
self.init_checker()
1053
self.send_changedstate()
1055
566
def disable(self, quiet=True):
1056
567
"""Disable this client."""
1057
568
if not getattr(self, "enabled", False):
571
self.send_changedstate()
1060
573
logger.info("Disabling client %s", self.name)
1061
if getattr(self, "disable_initiator_tag", None) is not None:
1062
GLib.source_remove(self.disable_initiator_tag)
574
if getattr(self, "disable_initiator_tag", False):
575
gobject.source_remove(self.disable_initiator_tag)
1063
576
self.disable_initiator_tag = None
1064
577
self.expires = None
1065
if getattr(self, "checker_initiator_tag", None) is not None:
1066
GLib.source_remove(self.checker_initiator_tag)
578
if getattr(self, "checker_initiator_tag", False):
579
gobject.source_remove(self.checker_initiator_tag)
1067
580
self.checker_initiator_tag = None
1068
581
self.stop_checker()
1069
582
self.enabled = False
1071
self.send_changedstate()
1072
# Do not run this again if called by a GLib.timeout_add
583
# Do not run this again if called by a gobject.timeout_add
1075
586
def __del__(self):
1078
589
def init_checker(self):
1079
590
# Schedule a new checker to be started an 'interval' from now,
1080
591
# and every interval from then on.
1081
if self.checker_initiator_tag is not None:
1082
GLib.source_remove(self.checker_initiator_tag)
1083
self.checker_initiator_tag = GLib.timeout_add(
1084
random.randrange(int(self.interval.total_seconds() * 1000
592
self.checker_initiator_tag = (gobject.timeout_add
593
(self.interval_milliseconds(),
1087
595
# Schedule a disable() when 'timeout' has passed
1088
if self.disable_initiator_tag is not None:
1089
GLib.source_remove(self.disable_initiator_tag)
1090
self.disable_initiator_tag = GLib.timeout_add(
1091
int(self.timeout.total_seconds() * 1000), self.disable)
596
self.disable_initiator_tag = (gobject.timeout_add
597
(self.timeout_milliseconds(),
1092
599
# Also start a new checker *right now*.
1093
600
self.start_checker()
1095
def checker_callback(self, source, condition, connection,
602
def checker_callback(self, pid, condition, command):
1097
603
"""The checker has completed, so take appropriate actions."""
1098
# Read return code from connection (see call_pipe)
1099
returncode = connection.recv()
1101
if self.checker is not None:
1103
604
self.checker_callback_tag = None
1104
605
self.checker = None
1107
self.last_checker_status = returncode
1108
self.last_checker_signal = None
606
if os.WIFEXITED(condition):
607
self.last_checker_status = os.WEXITSTATUS(condition)
1109
608
if self.last_checker_status == 0:
1110
609
logger.info("Checker for %(name)s succeeded",
1112
611
self.checked_ok()
1114
logger.info("Checker for %(name)s failed", vars(self))
613
logger.info("Checker for %(name)s failed",
1116
616
self.last_checker_status = -1
1117
self.last_checker_signal = -returncode
1118
617
logger.warning("Checker for %(name)s crashed?",
1122
def checked_ok(self):
1123
"""Assert that the client has been seen, alive and well."""
1124
self.last_checked_ok = datetime.datetime.utcnow()
1125
self.last_checker_status = 0
1126
self.last_checker_signal = None
1129
def bump_timeout(self, timeout=None):
1130
"""Bump up the timeout for this client."""
620
def checked_ok(self, timeout=None):
621
"""Bump up the timeout for this client.
623
This should only be called when the client has been seen,
1131
626
if timeout is None:
1132
627
timeout = self.timeout
628
self.last_checked_ok = datetime.datetime.utcnow()
1133
629
if self.disable_initiator_tag is not None:
1134
GLib.source_remove(self.disable_initiator_tag)
1135
self.disable_initiator_tag = None
630
gobject.source_remove(self.disable_initiator_tag)
1136
631
if getattr(self, "enabled", False):
1137
self.disable_initiator_tag = GLib.timeout_add(
1138
int(timeout.total_seconds() * 1000), self.disable)
632
self.disable_initiator_tag = (gobject.timeout_add
633
(timedelta_to_milliseconds
634
(timeout), self.disable))
1139
635
self.expires = datetime.datetime.utcnow() + timeout
1141
637
def need_approval(self):
1142
638
self.last_approval_request = datetime.datetime.utcnow()
1144
640
def start_checker(self):
1145
641
"""Start a new checker subprocess if one is not running.
1147
643
If a checker already exists, leave it running and do
1149
645
# The reason for not killing a running checker is that if we
1150
# did that, and if a checker (for some reason) started running
1151
# slowly and taking more than 'interval' time, then the client
1152
# would inevitably timeout, since no checker would get a
1153
# chance to run to completion. If we instead leave running
646
# did that, then if a checker (for some reason) started
647
# running slowly and taking more than 'interval' time, the
648
# client would inevitably timeout, since no checker would get
649
# a chance to run to completion. If we instead leave running
1154
650
# checkers alone, the checker would have to take more time
1155
651
# than 'timeout' for the client to be disabled, which is as it
1158
if self.checker is not None and not self.checker.is_alive():
1159
logger.warning("Checker was not alive; joining")
654
# If a checker exists, make sure it is not a zombie
656
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
657
except (AttributeError, OSError) as error:
658
if (isinstance(error, OSError)
659
and error.errno != errno.ECHILD):
663
logger.warning("Checker was a zombie")
664
gobject.source_remove(self.checker_callback_tag)
665
self.checker_callback(pid, status,
666
self.current_checker_command)
1162
667
# Start a new checker if needed
1163
668
if self.checker is None:
1164
# Escape attributes for the shell
1166
attr: shlex.quote(str(getattr(self, attr)))
1167
for attr in self.runtime_expansions}
1169
command = self.checker_command % escaped_attrs
1170
except TypeError as error:
1171
logger.error('Could not format string "%s"',
1172
self.checker_command,
1174
return True # Try again later
670
# In case checker_command has exactly one % operator
671
command = self.checker_command % self.host
673
# Escape attributes for the shell
674
escaped_attrs = dict(
676
re.escape(unicode(str(getattr(self, attr, "")),
680
self.runtime_expansions)
683
command = self.checker_command % escaped_attrs
684
except TypeError as error:
685
logger.error('Could not format string "%s":'
686
' %s', self.checker_command, error)
687
return True # Try again later
1175
688
self.current_checker_command = command
1176
logger.info("Starting checker %r for %s", command,
1178
# We don't need to redirect stdout and stderr, since
1179
# in normal mode, that is already done by daemon(),
1180
# and in debug mode we don't want to. (Stdin is
1181
# always replaced by /dev/null.)
1182
# The exception is when not debugging but nevertheless
1183
# running in the foreground; use the previously
1185
popen_args = {"close_fds": True,
1188
if (not self.server_settings["debug"]
1189
and self.server_settings["foreground"]):
1190
popen_args.update({"stdout": wnull,
1192
pipe = multiprocessing.Pipe(duplex=False)
1193
self.checker = multiprocessing.Process(
1195
args=(pipe[1], subprocess.call, command),
1197
self.checker.start()
1198
self.checker_callback_tag = GLib.io_add_watch(
1199
GLib.IOChannel.unix_new(pipe[0].fileno()),
1200
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1201
self.checker_callback, pipe[0], command)
1202
# Re-run this periodically if run by GLib.timeout_add
690
logger.info("Starting checker %r for %s",
692
# We don't need to redirect stdout and stderr, since
693
# in normal mode, that is already done by daemon(),
694
# and in debug mode we don't want to. (Stdin is
695
# always replaced by /dev/null.)
696
self.checker = subprocess.Popen(command,
699
self.checker_callback_tag = (gobject.child_watch_add
701
self.checker_callback,
703
# The checker may have completed before the gobject
704
# watch was added. Check for this.
705
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
707
gobject.source_remove(self.checker_callback_tag)
708
self.checker_callback(pid, status, command)
709
except OSError as error:
710
logger.error("Failed to start subprocess: %s",
712
# Re-run this periodically if run by gobject.timeout_add
1205
715
def stop_checker(self):
1206
716
"""Force the checker process, if any, to stop."""
1207
717
if self.checker_callback_tag:
1208
GLib.source_remove(self.checker_callback_tag)
718
gobject.source_remove(self.checker_callback_tag)
1209
719
self.checker_callback_tag = None
1210
720
if getattr(self, "checker", None) is None:
1212
722
logger.debug("Stopping checker for %(name)s", vars(self))
1213
self.checker.terminate()
724
os.kill(self.checker.pid, signal.SIGTERM)
726
#if self.checker.poll() is None:
727
# os.kill(self.checker.pid, signal.SIGKILL)
728
except OSError as error:
729
if error.errno != errno.ESRCH: # No such process
1214
731
self.checker = None
1217
def dbus_service_property(dbus_interface,
734
def dbus_service_property(dbus_interface, signature="v",
735
access="readwrite", byte_arrays=False):
1221
736
"""Decorators for marking methods of a DBusObjectWithProperties to
1222
737
become properties on the D-Bus.
1224
739
The decorated method will be called with no arguments by "Get"
1225
740
and with one argument by "Set".
1227
742
The parameters, where they are supported, are the same as
1228
743
dbus.service.method, except there is only "signature", since the
1229
744
type from Get() and the type sent to Set() is the same.
1312
class DBusObjectWithAnnotations(dbus.service.Object):
1313
"""A D-Bus object with annotations.
1315
Classes inheriting from this can use the dbus_annotations
1316
decorator to add annotations to methods or signals.
1320
def _is_dbus_thing(thing):
1321
"""Returns a function testing if an attribute is a D-Bus thing
1323
If called like _is_dbus_thing("method") it returns a function
1324
suitable for use as predicate to inspect.getmembers().
1326
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1329
def _get_all_dbus_things(self, thing):
1330
"""Returns a generator of (name, attribute) pairs
1332
return ((getattr(athing.__get__(self), "_dbus_name", name),
1333
athing.__get__(self))
1334
for cls in self.__class__.__mro__
1336
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1338
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1340
path_keyword='object_path',
1341
connection_keyword='connection')
1342
def Introspect(self, object_path, connection):
1343
"""Overloading of standard D-Bus method.
1345
Inserts annotation tags on methods and signals.
1347
xmlstring = dbus.service.Object.Introspect(self, object_path,
1350
document = xml.dom.minidom.parseString(xmlstring)
1352
for if_tag in document.getElementsByTagName("interface"):
1353
# Add annotation tags
1354
for typ in ("method", "signal"):
1355
for tag in if_tag.getElementsByTagName(typ):
1357
for name, prop in (self.
1358
_get_all_dbus_things(typ)):
1359
if (name == tag.getAttribute("name")
1360
and prop._dbus_interface
1361
== if_tag.getAttribute("name")):
1362
annots.update(getattr(
1363
prop, "_dbus_annotations", {}))
1364
for name, value in annots.items():
1365
ann_tag = document.createElement(
1367
ann_tag.setAttribute("name", name)
1368
ann_tag.setAttribute("value", value)
1369
tag.appendChild(ann_tag)
1370
# Add interface annotation tags
1371
for annotation, value in dict(
1372
itertools.chain.from_iterable(
1373
annotations().items()
1374
for name, annotations
1375
in self._get_all_dbus_things("interface")
1376
if name == if_tag.getAttribute("name")
1378
ann_tag = document.createElement("annotation")
1379
ann_tag.setAttribute("name", annotation)
1380
ann_tag.setAttribute("value", value)
1381
if_tag.appendChild(ann_tag)
1382
# Fix argument name for the Introspect method itself
1383
if (if_tag.getAttribute("name")
1384
== dbus.INTROSPECTABLE_IFACE):
1385
for cn in if_tag.getElementsByTagName("method"):
1386
if cn.getAttribute("name") == "Introspect":
1387
for arg in cn.getElementsByTagName("arg"):
1388
if (arg.getAttribute("direction")
1390
arg.setAttribute("name",
1392
xmlstring = document.toxml("utf-8")
1394
except (AttributeError, xml.dom.DOMException,
1395
xml.parsers.expat.ExpatError) as error:
1396
logger.error("Failed to override Introspection method",
1401
class DBusObjectWithProperties(DBusObjectWithAnnotations):
783
class DBusObjectWithProperties(dbus.service.Object):
1402
784
"""A D-Bus object with properties.
1404
786
Classes inheriting from this can use the dbus_service_property
1405
787
decorator to expose methods as D-Bus properties. It exposes the
1406
788
standard Get(), Set(), and GetAll() methods on the D-Bus.
792
def _is_dbus_property(obj):
793
return getattr(obj, "_dbus_is_property", False)
795
def _get_all_dbus_properties(self):
796
"""Returns a generator of (name, attribute) pairs
798
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
799
for cls in self.__class__.__mro__
801
inspect.getmembers(cls, self._is_dbus_property))
1409
803
def _get_dbus_property(self, interface_name, property_name):
1410
804
"""Returns a bound method if one exists which is a D-Bus
1411
805
property with the specified name and interface.
1413
for cls in self.__class__.__mro__:
1414
for name, value in inspect.getmembers(
1415
cls, self._is_dbus_thing("property")):
807
for cls in self.__class__.__mro__:
808
for name, value in (inspect.getmembers
809
(cls, self._is_dbus_property)):
1416
810
if (value._dbus_name == property_name
1417
811
and value._dbus_interface == interface_name):
1418
812
return value.__get__(self)
1420
814
# No such property
1421
raise DBusPropertyNotFound("{}:{}.{}".format(
1422
self.dbus_object_path, interface_name, property_name))
1425
def _get_all_interface_names(cls):
1426
"""Get a sequence of all interfaces supported by an object"""
1427
return (name for name in set(getattr(getattr(x, attr),
1428
"_dbus_interface", None)
1429
for x in (inspect.getmro(cls))
1431
if name is not None)
1433
@dbus.service.method(dbus.PROPERTIES_IFACE,
815
raise DBusPropertyNotFound(self.dbus_object_path + ":"
816
+ interface_name + "."
819
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1435
820
out_signature="v")
1436
821
def Get(self, interface_name, property_name):
1437
822
"""Standard D-Bus property Get() method, see D-Bus standard.
1561
914
except (AttributeError, xml.dom.DOMException,
1562
915
xml.parsers.expat.ExpatError) as error:
1563
916
logger.error("Failed to override Introspection method",
1569
dbus.OBJECT_MANAGER_IFACE
1570
except AttributeError:
1571
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1574
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1575
"""A D-Bus object with an ObjectManager.
1577
Classes inheriting from this exposes the standard
1578
GetManagedObjects call and the InterfacesAdded and
1579
InterfacesRemoved signals on the standard
1580
"org.freedesktop.DBus.ObjectManager" interface.
1582
Note: No signals are sent automatically; they must be sent
1585
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1586
out_signature="a{oa{sa{sv}}}")
1587
def GetManagedObjects(self):
1588
"""This function must be overridden"""
1589
raise NotImplementedError()
1591
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1592
signature="oa{sa{sv}}")
1593
def InterfacesAdded(self, object_path, interfaces_and_properties):
1596
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1597
def InterfacesRemoved(self, object_path, interfaces):
1600
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1602
path_keyword='object_path',
1603
connection_keyword='connection')
1604
def Introspect(self, object_path, connection):
1605
"""Overloading of standard D-Bus method.
1607
Override return argument name of GetManagedObjects to be
1608
"objpath_interfaces_and_properties"
1610
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1614
document = xml.dom.minidom.parseString(xmlstring)
1616
for if_tag in document.getElementsByTagName("interface"):
1617
# Fix argument name for the GetManagedObjects method
1618
if (if_tag.getAttribute("name")
1619
== dbus.OBJECT_MANAGER_IFACE):
1620
for cn in if_tag.getElementsByTagName("method"):
1621
if (cn.getAttribute("name")
1622
== "GetManagedObjects"):
1623
for arg in cn.getElementsByTagName("arg"):
1624
if (arg.getAttribute("direction")
1628
"objpath_interfaces"
1630
xmlstring = document.toxml("utf-8")
1632
except (AttributeError, xml.dom.DOMException,
1633
xml.parsers.expat.ExpatError) as error:
1634
logger.error("Failed to override Introspection method",
1639
def datetime_to_dbus(dt, variant_level=0):
921
def datetime_to_dbus (dt, variant_level=0):
1640
922
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1642
return dbus.String("", variant_level=variant_level)
1643
return dbus.String(dt.isoformat(), variant_level=variant_level)
1646
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1647
"""A class decorator; applied to a subclass of
1648
dbus.service.Object, it will add alternate D-Bus attributes with
1649
interface names according to the "alt_interface_names" mapping.
1652
@alternate_dbus_interfaces({"org.example.Interface":
1653
"net.example.AlternateInterface"})
1654
class SampleDBusObject(dbus.service.Object):
1655
@dbus.service.method("org.example.Interface")
1656
def SampleDBusMethod():
1659
The above "SampleDBusMethod" on "SampleDBusObject" will be
1660
reachable via two interfaces: "org.example.Interface" and
1661
"net.example.AlternateInterface", the latter of which will have
1662
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1663
"true", unless "deprecate" is passed with a False value.
1665
This works for methods and signals, and also for D-Bus properties
1666
(from DBusObjectWithProperties) and interfaces (from the
1667
dbus_interface_annotations decorator).
924
return dbus.String("", variant_level = variant_level)
925
return dbus.String(dt.isoformat(),
926
variant_level=variant_level)
929
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
931
"""Applied to an empty subclass of a D-Bus object, this metaclass
932
will add additional D-Bus attributes matching a certain pattern.
1671
for orig_interface_name, alt_interface_name in (
1672
alt_interface_names.items()):
1674
interface_names = set()
1675
# Go though all attributes of the class
1676
for attrname, attribute in inspect.getmembers(cls):
934
def __new__(mcs, name, bases, attr):
935
# Go through all the base classes which could have D-Bus
936
# methods, signals, or properties in them
937
for base in (b for b in bases
938
if issubclass(b, dbus.service.Object)):
939
# Go though all attributes of the base class
940
for attrname, attribute in inspect.getmembers(base):
1677
941
# Ignore non-D-Bus attributes, and D-Bus attributes
1678
942
# with the wrong interface name
1679
943
if (not hasattr(attribute, "_dbus_interface")
1680
or not attribute._dbus_interface.startswith(
1681
orig_interface_name)):
944
or not attribute._dbus_interface
945
.startswith("se.recompile.Mandos")):
1683
947
# Create an alternate D-Bus interface name based on
1684
948
# the current name
1685
alt_interface = attribute._dbus_interface.replace(
1686
orig_interface_name, alt_interface_name)
1687
interface_names.add(alt_interface)
949
alt_interface = (attribute._dbus_interface
950
.replace("se.recompile.Mandos",
951
"se.bsnet.fukt.Mandos"))
1688
952
# Is this a D-Bus signal?
1689
953
if getattr(attribute, "_dbus_is_signal", False):
1690
# Extract the original non-method undecorated
1691
# function by black magic
1692
if sys.version_info.major == 2:
1693
nonmethod_func = (dict(
954
# Extract the original non-method function by
956
nonmethod_func = (dict(
1694
957
zip(attribute.func_code.co_freevars,
1695
attribute.__closure__))
1696
["func"].cell_contents)
1698
nonmethod_func = (dict(
1699
zip(attribute.__code__.co_freevars,
1700
attribute.__closure__))
1701
["func"].cell_contents)
958
attribute.__closure__))["func"]
1702
960
# Create a new, but exactly alike, function
1703
961
# object, and decorate it to be a new D-Bus signal
1704
962
# with the alternate D-Bus interface name
1705
new_function = copy_function(nonmethod_func)
1706
new_function = (dbus.service.signal(
1708
attribute._dbus_signature)(new_function))
1709
# Copy annotations, if any
1711
new_function._dbus_annotations = dict(
1712
attribute._dbus_annotations)
1713
except AttributeError:
963
new_function = (dbus.service.signal
965
attribute._dbus_signature)
967
nonmethod_func.func_code,
968
nonmethod_func.func_globals,
969
nonmethod_func.func_name,
970
nonmethod_func.func_defaults,
971
nonmethod_func.func_closure)))
1716
972
# Define a creator of a function to call both the
1717
# original and alternate functions, so both the
1718
# original and alternate signals gets sent when
1719
# the function is called
973
# old and new functions, so both the old and new
974
# signals gets sent when the function is called
1720
975
def fixscope(func1, func2):
1721
976
"""This function is a scope container to pass
1722
977
func1 and func2 to the "call_both" function
1723
978
outside of its arguments"""
1725
@functools.wraps(func2)
1726
979
def call_both(*args, **kwargs):
1727
980
"""This function will emit two D-Bus
1728
981
signals by calling func1 and func2"""
1729
982
func1(*args, **kwargs)
1730
983
func2(*args, **kwargs)
1731
# Make wrapper function look like a D-Bus
1733
for name, attr in inspect.getmembers(func2):
1734
if name.startswith("_dbus_"):
1735
setattr(call_both, name, attr)
1737
984
return call_both
1738
985
# Create the "call_both" function and add it to
1740
attr[attrname] = fixscope(attribute, new_function)
987
attr[attrname] = fixscope(attribute,
1741
989
# Is this a D-Bus method?
1742
990
elif getattr(attribute, "_dbus_is_method", False):
1743
991
# Create a new, but exactly alike, function
1744
992
# object. Decorate it to be a new D-Bus method
1745
993
# with the alternate D-Bus interface name. Add it
1748
dbus.service.method(
1750
attribute._dbus_in_signature,
1751
attribute._dbus_out_signature)
1752
(copy_function(attribute)))
1753
# Copy annotations, if any
1755
attr[attrname]._dbus_annotations = dict(
1756
attribute._dbus_annotations)
1757
except AttributeError:
995
attr[attrname] = (dbus.service.method
997
attribute._dbus_in_signature,
998
attribute._dbus_out_signature)
1000
(attribute.func_code,
1001
attribute.func_globals,
1002
attribute.func_name,
1003
attribute.func_defaults,
1004
attribute.func_closure)))
1759
1005
# Is this a D-Bus property?
1760
1006
elif getattr(attribute, "_dbus_is_property", False):
1761
1007
# Create a new, but exactly alike, function
1762
1008
# object, and decorate it to be a new D-Bus
1763
1009
# property with the alternate D-Bus interface
1764
1010
# name. Add it to the class.
1765
attr[attrname] = (dbus_service_property(
1766
alt_interface, attribute._dbus_signature,
1767
attribute._dbus_access,
1768
attribute._dbus_get_args_options
1770
(copy_function(attribute)))
1771
# Copy annotations, if any
1773
attr[attrname]._dbus_annotations = dict(
1774
attribute._dbus_annotations)
1775
except AttributeError:
1777
# Is this a D-Bus interface?
1778
elif getattr(attribute, "_dbus_is_interface", False):
1779
# Create a new, but exactly alike, function
1780
# object. Decorate it to be a new D-Bus interface
1781
# with the alternate D-Bus interface name. Add it
1784
dbus_interface_annotations(alt_interface)
1785
(copy_function(attribute)))
1787
# Deprecate all alternate interfaces
1788
iname = "_AlternateDBusNames_interface_annotation{}"
1789
for interface_name in interface_names:
1791
@dbus_interface_annotations(interface_name)
1793
return {"org.freedesktop.DBus.Deprecated":
1795
# Find an unused name
1796
for aname in (iname.format(i)
1797
for i in itertools.count()):
1798
if aname not in attr:
1802
# Replace the class with a new subclass of it with
1803
# methods, signals, etc. as created above.
1804
if sys.version_info.major == 2:
1805
cls = type(b"{}Alternate".format(cls.__name__),
1808
cls = type("{}Alternate".format(cls.__name__),
1815
@alternate_dbus_interfaces({"se.recompile.Mandos":
1816
"se.bsnet.fukt.Mandos"})
1011
attr[attrname] = (dbus_service_property
1013
attribute._dbus_signature,
1014
attribute._dbus_access,
1016
._dbus_get_args_options
1019
(attribute.func_code,
1020
attribute.func_globals,
1021
attribute.func_name,
1022
attribute.func_defaults,
1023
attribute.func_closure)))
1024
return type.__new__(mcs, name, bases, attr)
1817
1027
class ClientDBus(Client, DBusObjectWithProperties):
1818
1028
"""A Client class using D-Bus
1821
1031
dbus_object_path: dbus.ObjectPath
1822
1032
bus: dbus.SystemBus()
1825
1035
runtime_expansions = (Client.runtime_expansions
1826
+ ("dbus_object_path", ))
1828
_interface = "se.recompile.Mandos.Client"
1036
+ ("dbus_object_path",))
1830
1038
# dbus.service.Object doesn't use super(), so we can't either.
1832
def __init__(self, bus=None, *args, **kwargs):
1040
def __init__(self, bus = None, *args, **kwargs):
1834
1042
Client.__init__(self, *args, **kwargs)
1043
self._approvals_pending = 0
1045
self._approvals_pending = 0
1835
1046
# Only now, when this client is initialized, can it show up on
1837
client_object_name = str(self.name).translate(
1048
client_object_name = unicode(self.name).translate(
1838
1049
{ord("."): ord("_"),
1839
1050
ord("-"): ord("_")})
1840
self.dbus_object_path = dbus.ObjectPath(
1841
"/clients/" + client_object_name)
1051
self.dbus_object_path = (dbus.ObjectPath
1052
("/clients/" + client_object_name))
1842
1053
DBusObjectWithProperties.__init__(self, self.bus,
1843
1054
self.dbus_object_path)
1845
def notifychangeproperty(transform_func, dbus_name,
1846
type_func=lambda x: x,
1848
invalidate_only=False,
1849
_interface=_interface):
1056
def notifychangeproperty(transform_func,
1057
dbus_name, type_func=lambda x: x,
1850
1059
""" Modify a variable so that it's a property which announces
1851
1060
its changes to DBus.
1853
1062
transform_fun: Function that takes a value and a variant_level
1854
1063
and transforms it to a D-Bus type.
1855
1064
dbus_name: D-Bus name of the variable
1857
1066
to the D-Bus. Default: no transform
1858
1067
variant_level: D-Bus variant level. Default: 1
1860
attrname = "_{}".format(dbus_name)
1069
attrname = "_{0}".format(dbus_name)
1862
1070
def setter(self, value):
1863
1071
if hasattr(self, "dbus_object_path"):
1864
1072
if (not hasattr(self, attrname) or
1865
1073
type_func(getattr(self, attrname, None))
1866
1074
!= type_func(value)):
1868
self.PropertiesChanged(
1869
_interface, dbus.Dictionary(),
1870
dbus.Array((dbus_name, )))
1872
dbus_value = transform_func(
1874
variant_level=variant_level)
1875
self.PropertyChanged(dbus.String(dbus_name),
1877
self.PropertiesChanged(
1879
dbus.Dictionary({dbus.String(dbus_name):
1075
dbus_value = transform_func(type_func(value),
1078
self.PropertyChanged(dbus.String(dbus_name),
1882
1080
setattr(self, attrname, value)
1884
1082
return property(lambda self: getattr(self, attrname), setter)
1886
1085
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1887
1086
approvals_pending = notifychangeproperty(dbus.Boolean,
1888
1087
"ApprovalPending",
1890
1089
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1891
1090
last_enabled = notifychangeproperty(datetime_to_dbus,
1893
checker = notifychangeproperty(
1894
dbus.Boolean, "CheckerRunning",
1895
type_func=lambda checker: checker is not None)
1092
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1093
type_func = lambda checker:
1094
checker is not None)
1896
1095
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1897
1096
"LastCheckedOK")
1898
last_checker_status = notifychangeproperty(dbus.Int16,
1899
"LastCheckerStatus")
1900
1097
last_approval_request = notifychangeproperty(
1901
1098
datetime_to_dbus, "LastApprovalRequest")
1902
1099
approved_by_default = notifychangeproperty(dbus.Boolean,
1903
1100
"ApprovedByDefault")
1904
approval_delay = notifychangeproperty(
1905
dbus.UInt64, "ApprovalDelay",
1906
type_func=lambda td: td.total_seconds() * 1000)
1101
approval_delay = notifychangeproperty(dbus.UInt64,
1104
timedelta_to_milliseconds)
1907
1105
approval_duration = notifychangeproperty(
1908
1106
dbus.UInt64, "ApprovalDuration",
1909
type_func=lambda td: td.total_seconds() * 1000)
1107
type_func = timedelta_to_milliseconds)
1910
1108
host = notifychangeproperty(dbus.String, "Host")
1911
timeout = notifychangeproperty(
1912
dbus.UInt64, "Timeout",
1913
type_func=lambda td: td.total_seconds() * 1000)
1109
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1111
timedelta_to_milliseconds)
1914
1112
extended_timeout = notifychangeproperty(
1915
1113
dbus.UInt64, "ExtendedTimeout",
1916
type_func=lambda td: td.total_seconds() * 1000)
1917
interval = notifychangeproperty(
1918
dbus.UInt64, "Interval",
1919
type_func=lambda td: td.total_seconds() * 1000)
1114
type_func = timedelta_to_milliseconds)
1115
interval = notifychangeproperty(dbus.UInt64,
1118
timedelta_to_milliseconds)
1920
1119
checker_command = notifychangeproperty(dbus.String, "Checker")
1921
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1922
invalidate_only=True)
1924
1121
del notifychangeproperty
1926
1123
def __del__(self, *args, **kwargs):
1928
1125
self.remove_from_connection()
2007
1205
server to mandos-client
2011
1209
# Rejected - signal
2012
1210
@dbus.service.signal(_interface, signature="s")
2013
1211
def Rejected(self, reason):
2017
1215
# NeedApproval - signal
2018
1216
@dbus.service.signal(_interface, signature="tb")
2019
1217
def NeedApproval(self, timeout, default):
2021
1219
return self.need_approval()
1221
# NeRwequest - signal
1222
@dbus.service.signal(_interface, signature="s")
1223
def NewRequest(self, ip):
1225
Is sent after a client request a password.
2025
1231
# Approve - method
2026
1232
@dbus.service.method(_interface, in_signature="b")
2027
1233
def Approve(self, value):
2028
1234
self.approve(value)
2030
1236
# CheckedOK - method
2031
1237
@dbus.service.method(_interface)
2032
1238
def CheckedOK(self):
2033
1239
self.checked_ok()
2035
1241
# Enable - method
2036
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2037
1242
@dbus.service.method(_interface)
2038
1243
def Enable(self):
2042
1247
# StartChecker - method
2043
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2044
1248
@dbus.service.method(_interface)
2045
1249
def StartChecker(self):
2047
1251
self.start_checker()
2049
1253
# Disable - method
2050
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2051
1254
@dbus.service.method(_interface)
2052
1255
def Disable(self):
2056
1259
# StopChecker - method
2057
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2058
1260
@dbus.service.method(_interface)
2059
1261
def StopChecker(self):
2060
1262
self.stop_checker()
2064
1266
# ApprovalPending - property
2065
1267
@dbus_service_property(_interface, signature="b", access="read")
2066
1268
def ApprovalPending_dbus_property(self):
2067
1269
return dbus.Boolean(bool(self.approvals_pending))
2069
1271
# ApprovedByDefault - property
2070
@dbus_service_property(_interface,
1272
@dbus_service_property(_interface, signature="b",
2072
1273
access="readwrite")
2073
1274
def ApprovedByDefault_dbus_property(self, value=None):
2074
1275
if value is None: # get
2075
1276
return dbus.Boolean(self.approved_by_default)
2076
1277
self.approved_by_default = bool(value)
2078
1279
# ApprovalDelay - property
2079
@dbus_service_property(_interface,
1280
@dbus_service_property(_interface, signature="t",
2081
1281
access="readwrite")
2082
1282
def ApprovalDelay_dbus_property(self, value=None):
2083
1283
if value is None: # get
2084
return dbus.UInt64(self.approval_delay.total_seconds()
1284
return dbus.UInt64(self.approval_delay_milliseconds())
2086
1285
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2088
1287
# ApprovalDuration - property
2089
@dbus_service_property(_interface,
1288
@dbus_service_property(_interface, signature="t",
2091
1289
access="readwrite")
2092
1290
def ApprovalDuration_dbus_property(self, value=None):
2093
1291
if value is None: # get
2094
return dbus.UInt64(self.approval_duration.total_seconds()
1292
return dbus.UInt64(timedelta_to_milliseconds(
1293
self.approval_duration))
2096
1294
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2098
1296
# Name - property
2100
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2101
1297
@dbus_service_property(_interface, signature="s", access="read")
2102
1298
def Name_dbus_property(self):
2103
1299
return dbus.String(self.name)
2107
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2108
@dbus_service_property(_interface, signature="s", access="read")
2109
def KeyID_dbus_property(self):
2110
return dbus.String(self.key_id)
2112
1301
# Fingerprint - property
2114
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2115
1302
@dbus_service_property(_interface, signature="s", access="read")
2116
1303
def Fingerprint_dbus_property(self):
2117
1304
return dbus.String(self.fingerprint)
2119
1306
# Host - property
2120
@dbus_service_property(_interface,
1307
@dbus_service_property(_interface, signature="s",
2122
1308
access="readwrite")
2123
1309
def Host_dbus_property(self, value=None):
2124
1310
if value is None: # get
2125
1311
return dbus.String(self.host)
2126
self.host = str(value)
1312
self.host = unicode(value)
2128
1314
# Created - property
2130
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2131
1315
@dbus_service_property(_interface, signature="s", access="read")
2132
1316
def Created_dbus_property(self):
2133
1317
return datetime_to_dbus(self.created)
2135
1319
# LastEnabled - property
2136
1320
@dbus_service_property(_interface, signature="s", access="read")
2137
1321
def LastEnabled_dbus_property(self):
2138
1322
return datetime_to_dbus(self.last_enabled)
2140
1324
# Enabled - property
2141
@dbus_service_property(_interface,
1325
@dbus_service_property(_interface, signature="b",
2143
1326
access="readwrite")
2144
1327
def Enabled_dbus_property(self, value=None):
2145
1328
if value is None: # get
2152
1335
# LastCheckedOK - property
2153
@dbus_service_property(_interface,
1336
@dbus_service_property(_interface, signature="s",
2155
1337
access="readwrite")
2156
1338
def LastCheckedOK_dbus_property(self, value=None):
2157
1339
if value is not None:
2158
1340
self.checked_ok()
2160
1342
return datetime_to_dbus(self.last_checked_ok)
2162
# LastCheckerStatus - property
2163
@dbus_service_property(_interface, signature="n", access="read")
2164
def LastCheckerStatus_dbus_property(self):
2165
return dbus.Int16(self.last_checker_status)
2167
1344
# Expires - property
2168
1345
@dbus_service_property(_interface, signature="s", access="read")
2169
1346
def Expires_dbus_property(self):
2170
1347
return datetime_to_dbus(self.expires)
2172
1349
# LastApprovalRequest - property
2173
1350
@dbus_service_property(_interface, signature="s", access="read")
2174
1351
def LastApprovalRequest_dbus_property(self):
2175
1352
return datetime_to_dbus(self.last_approval_request)
2177
1354
# Timeout - property
2178
@dbus_service_property(_interface,
1355
@dbus_service_property(_interface, signature="t",
2180
1356
access="readwrite")
2181
1357
def Timeout_dbus_property(self, value=None):
2182
1358
if value is None: # get
2183
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2184
old_timeout = self.timeout
1359
return dbus.UInt64(self.timeout_milliseconds())
2185
1360
self.timeout = datetime.timedelta(0, 0, 0, value)
2186
# Reschedule disabling
2188
now = datetime.datetime.utcnow()
2189
self.expires += self.timeout - old_timeout
2190
if self.expires <= now:
2191
# The timeout has passed
2194
if (getattr(self, "disable_initiator_tag", None)
2197
GLib.source_remove(self.disable_initiator_tag)
2198
self.disable_initiator_tag = GLib.timeout_add(
2199
int((self.expires - now).total_seconds() * 1000),
1361
if getattr(self, "disable_initiator_tag", None) is None:
1363
# Reschedule timeout
1364
gobject.source_remove(self.disable_initiator_tag)
1365
self.disable_initiator_tag = None
1367
time_to_die = timedelta_to_milliseconds((self
1372
if time_to_die <= 0:
1373
# The timeout has passed
1376
self.expires = (datetime.datetime.utcnow()
1377
+ datetime.timedelta(milliseconds =
1379
self.disable_initiator_tag = (gobject.timeout_add
1380
(time_to_die, self.disable))
2202
1382
# ExtendedTimeout - property
2203
@dbus_service_property(_interface,
1383
@dbus_service_property(_interface, signature="t",
2205
1384
access="readwrite")
2206
1385
def ExtendedTimeout_dbus_property(self, value=None):
2207
1386
if value is None: # get
2208
return dbus.UInt64(self.extended_timeout.total_seconds()
1387
return dbus.UInt64(self.extended_timeout_milliseconds())
2210
1388
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2212
1390
# Interval - property
2213
@dbus_service_property(_interface,
1391
@dbus_service_property(_interface, signature="t",
2215
1392
access="readwrite")
2216
1393
def Interval_dbus_property(self, value=None):
2217
1394
if value is None: # get
2218
return dbus.UInt64(self.interval.total_seconds() * 1000)
1395
return dbus.UInt64(self.interval_milliseconds())
2219
1396
self.interval = datetime.timedelta(0, 0, 0, value)
2220
1397
if getattr(self, "checker_initiator_tag", None) is None:
2222
1399
if self.enabled:
2223
1400
# Reschedule checker run
2224
GLib.source_remove(self.checker_initiator_tag)
2225
self.checker_initiator_tag = GLib.timeout_add(
2226
value, self.start_checker)
2227
self.start_checker() # Start one now, too
1401
gobject.source_remove(self.checker_initiator_tag)
1402
self.checker_initiator_tag = (gobject.timeout_add
1403
(value, self.start_checker))
1404
self.start_checker() # Start one now, too
2229
1406
# Checker - property
2230
@dbus_service_property(_interface,
1407
@dbus_service_property(_interface, signature="s",
2232
1408
access="readwrite")
2233
1409
def Checker_dbus_property(self, value=None):
2234
1410
if value is None: # get
2235
1411
return dbus.String(self.checker_command)
2236
self.checker_command = str(value)
1412
self.checker_command = unicode(value)
2238
1414
# CheckerRunning - property
2239
@dbus_service_property(_interface,
1415
@dbus_service_property(_interface, signature="b",
2241
1416
access="readwrite")
2242
1417
def CheckerRunning_dbus_property(self, value=None):
2243
1418
if value is None: # get
2284
1451
if data[0] == 'data':
2286
1453
if data[0] == 'function':
2288
1454
def func(*args, **kwargs):
2289
1455
self._pipe.send(('funcall', name, args, kwargs))
2290
1456
return self._pipe.recv()[1]
2294
1459
def __setattr__(self, name, value):
2295
1460
if name == '_pipe':
2296
1461
return super(ProxyClient, self).__setattr__(name, value)
2297
1462
self._pipe.send(('setattr', name, value))
1465
class ClientDBusTransitional(ClientDBus):
1466
__metaclass__ = AlternateDBusNamesMetaclass
2300
1469
class ClientHandler(socketserver.BaseRequestHandler, object):
2301
1470
"""A class to handle client connections.
2303
1472
Instantiated once for each connection to handle it.
2304
1473
Note: This will run in its own forked process."""
2306
1475
def handle(self):
2307
1476
with contextlib.closing(self.server.child_pipe) as child_pipe:
2308
1477
logger.info("TCP connection from: %s",
2309
str(self.client_address))
1478
unicode(self.client_address))
2310
1479
logger.debug("Pipe FD: %d",
2311
1480
self.server.child_pipe.fileno())
2313
session = gnutls.ClientSession(self.request)
2315
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2316
# "+AES-256-CBC", "+SHA1",
2317
# "+COMP-NULL", "+CTYPE-OPENPGP",
1482
session = (gnutls.connection
1483
.ClientSession(self.request,
1485
.X509Credentials()))
1487
# Note: gnutls.connection.X509Credentials is really a
1488
# generic GnuTLS certificate credentials object so long as
1489
# no X.509 keys are added to it. Therefore, we can use it
1490
# here despite using OpenPGP certificates.
1492
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1493
# "+AES-256-CBC", "+SHA1",
1494
# "+COMP-NULL", "+CTYPE-OPENPGP",
2319
1496
# Use a fallback default, since this MUST be set.
2320
1497
priority = self.server.gnutls_priority
2321
1498
if priority is None:
2322
1499
priority = "NORMAL"
2323
gnutls.priority_set_direct(session,
2324
priority.encode("utf-8"), None)
1500
(gnutls.library.functions
1501
.gnutls_priority_set_direct(session._c_object,
2326
1504
# Start communication using the Mandos protocol
2327
1505
# Get protocol number
2328
1506
line = self.request.makefile().readline()
2329
1507
logger.debug("Protocol version: %r", line)
2331
1509
if int(line.strip().split()[0]) > 1:
2332
raise RuntimeError(line)
2333
1511
except (ValueError, IndexError, RuntimeError) as error:
2334
1512
logger.error("Unknown protocol version: %s", error)
2337
1515
# Start GnuTLS connection
2339
1517
session.handshake()
2340
except gnutls.Error as error:
1518
except gnutls.errors.GNUTLSError as error:
2341
1519
logger.warning("Handshake failed: %s", error)
2342
1520
# Do not run session.bye() here: the session is not
2343
1521
# established. Just abandon the request.
2345
1523
logger.debug("Handshake succeeded")
2347
1525
approval_required = False
2349
if gnutls.has_rawpk:
2352
key_id = self.key_id(
2353
self.peer_certificate(session))
2354
except (TypeError, gnutls.Error) as error:
2355
logger.warning("Bad certificate: %s", error)
2357
logger.debug("Key ID: %s",
2358
key_id.decode("utf-8",
2364
fpr = self.fingerprint(
2365
self.peer_certificate(session))
2366
except (TypeError, gnutls.Error) as error:
2367
logger.warning("Bad certificate: %s", error)
2369
logger.debug("Fingerprint: %s", fpr)
2372
client = ProxyClient(child_pipe, key_id, fpr,
1528
fpr = self.fingerprint(self.peer_certificate
1531
gnutls.errors.GNUTLSError) as error:
1532
logger.warning("Bad certificate: %s", error)
1534
logger.debug("Fingerprint: %s", fpr)
1537
client = ProxyClient(child_pipe, fpr,
2373
1538
self.client_address)
2374
1539
except KeyError:
1542
if self.server.use_dbus:
1544
client.NewRequest(str(self.client_address))
2377
1546
if client.approval_delay:
2378
1547
delay = client.approval_delay
2379
1548
client.approvals_pending += 1
2380
1549
approval_required = True
2383
1552
if not client.enabled:
2384
1553
logger.info("Client %s is disabled",
2386
1555
if self.server.use_dbus:
2387
1556
# Emit D-Bus signal
2388
1557
client.Rejected("Disabled")
2391
1560
if client.approved or not client.approval_delay:
2392
# We are approved or approval is disabled
1561
#We are approved or approval is disabled
2394
1563
elif client.approved is None:
2395
1564
logger.info("Client %s needs approval",
2428
1599
delay -= time2 - time
2431
session.send(client.secret)
2432
except gnutls.Error as error:
2433
logger.warning("gnutls send failed",
1602
while sent_size < len(client.secret):
1604
sent = session.send(client.secret[sent_size:])
1605
except gnutls.errors.GNUTLSError as error:
1606
logger.warning("gnutls send failed")
1608
logger.debug("Sent: %d, remaining: %d",
1609
sent, len(client.secret)
1610
- (sent_size + sent))
2437
1613
logger.info("Sending secret to %s", client.name)
2438
1614
# bump the timeout using extended_timeout
2439
client.bump_timeout(client.extended_timeout)
1615
client.checked_ok(client.extended_timeout)
2440
1616
if self.server.use_dbus:
2441
1617
# Emit D-Bus signal
2442
1618
client.GotSecret()
2445
1621
if approval_required:
2446
1622
client.approvals_pending -= 1
2449
except gnutls.Error as error:
2450
logger.warning("GnuTLS bye failed",
1625
except gnutls.errors.GNUTLSError as error:
1626
logger.warning("GnuTLS bye failed")
2454
1629
def peer_certificate(session):
2455
"Return the peer's certificate as a bytestring"
2457
cert_type = gnutls.certificate_type_get2(
2458
session, gnutls.CTYPE_PEERS)
2459
except AttributeError:
2460
cert_type = gnutls.certificate_type_get(session)
2461
if gnutls.has_rawpk:
2462
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2464
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2465
# If not a valid certificate type...
2466
if cert_type not in valid_cert_types:
2467
logger.info("Cert type %r not in %r", cert_type,
2469
# ...return invalid data
1630
"Return the peer's OpenPGP certificate as a bytestring"
1631
# If not an OpenPGP certificate...
1632
if (gnutls.library.functions
1633
.gnutls_certificate_type_get(session._c_object)
1634
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1635
# ...do the normal thing
1636
return session.peer_certificate
2471
1637
list_size = ctypes.c_uint(1)
2472
cert_list = (gnutls.certificate_get_peers
2473
(session, ctypes.byref(list_size)))
1638
cert_list = (gnutls.library.functions
1639
.gnutls_certificate_get_peers
1640
(session._c_object, ctypes.byref(list_size)))
2474
1641
if not bool(cert_list) and list_size.value != 0:
2475
raise gnutls.Error("error getting peer certificate")
1642
raise gnutls.errors.GNUTLSError("error getting peer"
2476
1644
if list_size.value == 0:
2478
1646
cert = cert_list[0]
2479
1647
return ctypes.string_at(cert.data, cert.size)
2482
def key_id(certificate):
2483
"Convert a certificate bytestring to a hexdigit key ID"
2484
# New GnuTLS "datum" with the public key
2485
datum = gnutls.datum_t(
2486
ctypes.cast(ctypes.c_char_p(certificate),
2487
ctypes.POINTER(ctypes.c_ubyte)),
2488
ctypes.c_uint(len(certificate)))
2489
# XXX all these need to be created in the gnutls "module"
2490
# New empty GnuTLS certificate
2491
pubkey = gnutls.pubkey_t()
2492
gnutls.pubkey_init(ctypes.byref(pubkey))
2493
# Import the raw public key into the certificate
2494
gnutls.pubkey_import(pubkey,
2495
ctypes.byref(datum),
2496
gnutls.X509_FMT_DER)
2497
# New buffer for the key ID
2498
buf = ctypes.create_string_buffer(32)
2499
buf_len = ctypes.c_size_t(len(buf))
2500
# Get the key ID from the raw public key into the buffer
2501
gnutls.pubkey_get_key_id(
2503
gnutls.KEYID_USE_SHA256,
2504
ctypes.cast(ctypes.byref(buf),
2505
ctypes.POINTER(ctypes.c_ubyte)),
2506
ctypes.byref(buf_len))
2507
# Deinit the certificate
2508
gnutls.pubkey_deinit(pubkey)
2510
# Convert the buffer to a Python bytestring
2511
key_id = ctypes.string_at(buf, buf_len.value)
2512
# Convert the bytestring to hexadecimal notation
2513
hex_key_id = binascii.hexlify(key_id).upper()
2517
1650
def fingerprint(openpgp):
2518
1651
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2519
1652
# New GnuTLS "datum" with the OpenPGP public key
2520
datum = gnutls.datum_t(
2521
ctypes.cast(ctypes.c_char_p(openpgp),
2522
ctypes.POINTER(ctypes.c_ubyte)),
2523
ctypes.c_uint(len(openpgp)))
1653
datum = (gnutls.library.types
1654
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1657
ctypes.c_uint(len(openpgp))))
2524
1658
# New empty GnuTLS certificate
2525
crt = gnutls.openpgp_crt_t()
2526
gnutls.openpgp_crt_init(ctypes.byref(crt))
1659
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1660
(gnutls.library.functions
1661
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2527
1662
# Import the OpenPGP public key into the certificate
2528
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2529
gnutls.OPENPGP_FMT_RAW)
1663
(gnutls.library.functions
1664
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1665
gnutls.library.constants
1666
.GNUTLS_OPENPGP_FMT_RAW))
2530
1667
# Verify the self signature in the key
2531
1668
crtverify = ctypes.c_uint()
2532
gnutls.openpgp_crt_verify_self(crt, 0,
2533
ctypes.byref(crtverify))
1669
(gnutls.library.functions
1670
.gnutls_openpgp_crt_verify_self(crt, 0,
1671
ctypes.byref(crtverify)))
2534
1672
if crtverify.value != 0:
2535
gnutls.openpgp_crt_deinit(crt)
2536
raise gnutls.CertificateSecurityError(code
1673
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1674
raise (gnutls.errors.CertificateSecurityError
2538
1676
# New buffer for the fingerprint
2539
1677
buf = ctypes.create_string_buffer(20)
2540
1678
buf_len = ctypes.c_size_t()
2541
1679
# Get the fingerprint from the certificate into the buffer
2542
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2543
ctypes.byref(buf_len))
1680
(gnutls.library.functions
1681
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1682
ctypes.byref(buf_len)))
2544
1683
# Deinit the certificate
2545
gnutls.openpgp_crt_deinit(crt)
1684
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2546
1685
# Convert the buffer to a Python bytestring
2547
1686
fpr = ctypes.string_at(buf, buf_len.value)
2548
1687
# Convert the bytestring to hexadecimal notation
2553
class MultiprocessingMixIn:
1692
class MultiprocessingMixIn(object):
2554
1693
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2556
1694
def sub_process_main(self, request, address):
2558
1696
self.finish_request(request, address)
2559
1697
except Exception:
2560
1698
self.handle_error(request, address)
2561
1699
self.close_request(request)
2563
1701
def process_request(self, request, address):
2564
1702
"""Start a new process to process the request."""
2565
proc = multiprocessing.Process(target=self.sub_process_main,
2566
args=(request, address))
1703
proc = multiprocessing.Process(target = self.sub_process_main,
2571
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1710
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2572
1711
""" adds a pipe to the MixIn """
2574
1712
def process_request(self, request, client_address):
2575
1713
"""Overrides and wraps the original process_request().
2577
1715
This function creates a new pipe in self.pipe
2579
1717
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2581
1719
proc = MultiprocessingMixIn.process_request(self, request,
2582
1720
client_address)
2583
1721
self.child_pipe.close()
2584
1722
self.add_pipe(parent_pipe, proc)
2586
1724
def add_pipe(self, parent_pipe, proc):
2587
1725
"""Dummy function; override as necessary"""
2588
raise NotImplementedError()
1726
raise NotImplementedError
2591
1729
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2592
socketserver.TCPServer):
1730
socketserver.TCPServer, object):
2593
1731
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2596
1734
enabled: Boolean; whether this server is activated yet
2597
1735
interface: None or a network interface name (string)
2598
1736
use_ipv6: Boolean; to use IPv6 or not
2601
1738
def __init__(self, server_address, RequestHandlerClass,
2605
"""If socketfd is set, use that file descriptor instead of
2606
creating a new one with socket.socket().
1739
interface=None, use_ipv6=True):
2608
1740
self.interface = interface
2610
1742
self.address_family = socket.AF_INET6
2611
if socketfd is not None:
2612
# Save the file descriptor
2613
self.socketfd = socketfd
2614
# Save the original socket.socket() function
2615
self.socket_socket = socket.socket
2617
# To implement --socket, we monkey patch socket.socket.
2619
# (When socketserver.TCPServer is a new-style class, we
2620
# could make self.socket into a property instead of monkey
2621
# patching socket.socket.)
2623
# Create a one-time-only replacement for socket.socket()
2624
@functools.wraps(socket.socket)
2625
def socket_wrapper(*args, **kwargs):
2626
# Restore original function so subsequent calls are
2628
socket.socket = self.socket_socket
2629
del self.socket_socket
2630
# This time only, return a new socket object from the
2631
# saved file descriptor.
2632
return socket.fromfd(self.socketfd, *args, **kwargs)
2633
# Replace socket.socket() function with wrapper
2634
socket.socket = socket_wrapper
2635
# The socketserver.TCPServer.__init__ will call
2636
# socket.socket(), which might be our replacement,
2637
# socket_wrapper(), if socketfd was set.
2638
1743
socketserver.TCPServer.__init__(self, server_address,
2639
1744
RequestHandlerClass)
2641
1745
def server_bind(self):
2642
1746
"""This overrides the normal server_bind() function
2643
1747
to bind to an interface if one was specified, and also NOT to
2644
1748
bind to an address or port if they were not specified."""
2645
global SO_BINDTODEVICE
2646
1749
if self.interface is not None:
2647
1750
if SO_BINDTODEVICE is None:
2648
# Fall back to a hard-coded value which seems to be
2650
logger.warning("SO_BINDTODEVICE not found, trying 25")
2651
SO_BINDTODEVICE = 25
2653
self.socket.setsockopt(
2654
socket.SOL_SOCKET, SO_BINDTODEVICE,
2655
(self.interface + "\0").encode("utf-8"))
2656
except socket.error as error:
2657
if error.errno == errno.EPERM:
2658
logger.error("No permission to bind to"
2659
" interface %s", self.interface)
2660
elif error.errno == errno.ENOPROTOOPT:
2661
logger.error("SO_BINDTODEVICE not available;"
2662
" cannot bind to interface %s",
2664
elif error.errno == errno.ENODEV:
2665
logger.error("Interface %s does not exist,"
2666
" cannot bind", self.interface)
1751
logger.error("SO_BINDTODEVICE does not exist;"
1752
" cannot bind to interface %s",
1756
self.socket.setsockopt(socket.SOL_SOCKET,
1760
except socket.error as error:
1761
if error[0] == errno.EPERM:
1762
logger.error("No permission to"
1763
" bind to interface %s",
1765
elif error[0] == errno.ENOPROTOOPT:
1766
logger.error("SO_BINDTODEVICE not available;"
1767
" cannot bind to interface %s",
2669
1771
# Only bind(2) the socket if we really need to.
2670
1772
if self.server_address[0] or self.server_address[1]:
2671
if self.server_address[1]:
2672
self.allow_reuse_address = True
2673
1773
if not self.server_address[0]:
2674
1774
if self.address_family == socket.AF_INET6:
2675
any_address = "::" # in6addr_any
1775
any_address = "::" # in6addr_any
2677
any_address = "0.0.0.0" # INADDR_ANY
1777
any_address = socket.INADDR_ANY
2678
1778
self.server_address = (any_address,
2679
1779
self.server_address[1])
2680
1780
elif not self.server_address[1]:
2681
self.server_address = (self.server_address[0], 0)
1781
self.server_address = (self.server_address[0],
2682
1783
# if self.interface:
2683
1784
# self.server_address = (self.server_address[0],
2788
1888
funcname = request[1]
2789
1889
args = request[2]
2790
1890
kwargs = request[3]
2792
1892
parent_pipe.send(('data', getattr(client_object,
2793
1893
funcname)(*args,
2796
1896
if command == 'getattr':
2797
1897
attrname = request[1]
2798
if isinstance(client_object.__getattribute__(attrname),
2799
collections.abc.Callable):
2800
parent_pipe.send(('function', ))
1898
if callable(client_object.__getattribute__(attrname)):
1899
parent_pipe.send(('function',))
2803
'data', client_object.__getattribute__(attrname)))
1901
parent_pipe.send(('data', client_object
1902
.__getattribute__(attrname)))
2805
1904
if command == 'setattr':
2806
1905
attrname = request[1]
2807
1906
value = request[2]
2808
1907
setattr(client_object, attrname, value)
2813
def rfc3339_duration_to_delta(duration):
2814
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2816
>>> timedelta = datetime.timedelta
2817
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2819
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2821
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2823
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2825
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2827
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2829
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2834
# Parsing an RFC 3339 duration with regular expressions is not
2835
# possible - there would have to be multiple places for the same
2836
# values, like seconds. The current code, while more esoteric, is
2837
# cleaner without depending on a parsing library. If Python had a
2838
# built-in library for parsing we would use it, but we'd like to
2839
# avoid excessive use of external libraries.
2841
# New type for defining tokens, syntax, and semantics all-in-one
2842
Token = collections.namedtuple("Token", (
2843
"regexp", # To match token; if "value" is not None, must have
2844
# a "group" containing digits
2845
"value", # datetime.timedelta or None
2846
"followers")) # Tokens valid after this token
2847
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2848
# the "duration" ABNF definition in RFC 3339, Appendix A.
2849
token_end = Token(re.compile(r"$"), None, frozenset())
2850
token_second = Token(re.compile(r"(\d+)S"),
2851
datetime.timedelta(seconds=1),
2852
frozenset((token_end, )))
2853
token_minute = Token(re.compile(r"(\d+)M"),
2854
datetime.timedelta(minutes=1),
2855
frozenset((token_second, token_end)))
2856
token_hour = Token(re.compile(r"(\d+)H"),
2857
datetime.timedelta(hours=1),
2858
frozenset((token_minute, token_end)))
2859
token_time = Token(re.compile(r"T"),
2861
frozenset((token_hour, token_minute,
2863
token_day = Token(re.compile(r"(\d+)D"),
2864
datetime.timedelta(days=1),
2865
frozenset((token_time, token_end)))
2866
token_month = Token(re.compile(r"(\d+)M"),
2867
datetime.timedelta(weeks=4),
2868
frozenset((token_day, token_end)))
2869
token_year = Token(re.compile(r"(\d+)Y"),
2870
datetime.timedelta(weeks=52),
2871
frozenset((token_month, token_end)))
2872
token_week = Token(re.compile(r"(\d+)W"),
2873
datetime.timedelta(weeks=1),
2874
frozenset((token_end, )))
2875
token_duration = Token(re.compile(r"P"), None,
2876
frozenset((token_year, token_month,
2877
token_day, token_time,
2879
# Define starting values:
2881
value = datetime.timedelta()
2883
# Following valid tokens
2884
followers = frozenset((token_duration, ))
2885
# String left to parse
2887
# Loop until end token is found
2888
while found_token is not token_end:
2889
# Search for any currently valid tokens
2890
for token in followers:
2891
match = token.regexp.match(s)
2892
if match is not None:
2894
if token.value is not None:
2895
# Value found, parse digits
2896
factor = int(match.group(1), 10)
2897
# Add to value so far
2898
value += factor * token.value
2899
# Strip token from string
2900
s = token.regexp.sub("", s, 1)
2903
# Set valid next tokens
2904
followers = found_token.followers
2907
# No currently valid tokens were found
2908
raise ValueError("Invalid RFC 3339 duration: {!r}"
2914
1912
def string_to_delta(interval):
2915
1913
"""Parse a string and return a datetime.timedelta
2917
>>> string_to_delta('7d') == datetime.timedelta(7)
2919
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2921
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2923
>>> string_to_delta('24h') == datetime.timedelta(1)
2925
>>> string_to_delta('1w') == datetime.timedelta(7)
2927
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
1915
>>> string_to_delta('7d')
1916
datetime.timedelta(7)
1917
>>> string_to_delta('60s')
1918
datetime.timedelta(0, 60)
1919
>>> string_to_delta('60m')
1920
datetime.timedelta(0, 3600)
1921
>>> string_to_delta('24h')
1922
datetime.timedelta(1)
1923
>>> string_to_delta('1w')
1924
datetime.timedelta(7)
1925
>>> string_to_delta('5m 30s')
1926
datetime.timedelta(0, 330)
2932
return rfc3339_duration_to_delta(interval)
2936
1928
timevalue = datetime.timedelta(0)
2937
1929
for s in interval.split():
1931
suffix = unicode(s[-1])
2940
1932
value = int(s[:-1])
2941
1933
if suffix == "d":
2942
1934
delta = datetime.timedelta(value)
3014
2006
parser.add_argument("--no-dbus", action="store_false",
3015
2007
dest="use_dbus", help="Do not provide D-Bus"
3016
" system bus interface", default=None)
2008
" system bus interface")
3017
2009
parser.add_argument("--no-ipv6", action="store_false",
3018
dest="use_ipv6", help="Do not use IPv6",
2010
dest="use_ipv6", help="Do not use IPv6")
3020
2011
parser.add_argument("--no-restore", action="store_false",
3021
2012
dest="restore", help="Do not restore stored"
3022
" state", default=None)
3023
parser.add_argument("--socket", type=int,
3024
help="Specify a file descriptor to a network"
3025
" socket to use instead of creating one")
3026
2014
parser.add_argument("--statedir", metavar="DIR",
3027
2015
help="Directory to save/restore state in")
3028
parser.add_argument("--foreground", action="store_true",
3029
help="Run in foreground", default=None)
3030
parser.add_argument("--no-zeroconf", action="store_false",
3031
dest="zeroconf", help="Do not use Zeroconf",
3034
2017
options = parser.parse_args()
3036
2024
# Default values for config file for server-global settings
3037
if gnutls.has_rawpk:
3038
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3039
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3041
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3042
":+SIGN-DSA-SHA256")
3043
server_defaults = {"interface": "",
3047
"priority": priority,
3048
"servicename": "Mandos",
3054
"statedir": "/var/lib/mandos",
3055
"foreground": "False",
2025
server_defaults = { "interface": "",
2030
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2031
"servicename": "Mandos",
2036
"statedir": "/var/lib/mandos"
3060
2039
# Parse config file for server-global settings
3061
server_config = configparser.ConfigParser(server_defaults)
2040
server_config = configparser.SafeConfigParser(server_defaults)
3062
2041
del server_defaults
3063
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3064
# Convert the ConfigParser object to a dict
2042
server_config.read(os.path.join(options.configdir,
2044
# Convert the SafeConfigParser object to a dict
3065
2045
server_settings = server_config.defaults()
3066
2046
# Use the appropriate methods on the non-string config options
3067
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3068
"foreground", "zeroconf"):
2047
for option in ("debug", "use_dbus", "use_ipv6"):
3069
2048
server_settings[option] = server_config.getboolean("DEFAULT",
3071
2050
if server_settings["port"]:
3072
2051
server_settings["port"] = server_config.getint("DEFAULT",
3074
if server_settings["socket"]:
3075
server_settings["socket"] = server_config.getint("DEFAULT",
3077
# Later, stdin will, and stdout and stderr might, be dup'ed
3078
# over with an opened os.devnull. But we don't want this to
3079
# happen with a supplied network socket.
3080
if 0 <= server_settings["socket"] <= 2:
3081
server_settings["socket"] = os.dup(server_settings
3083
2053
del server_config
3085
2055
# Override the settings from the config file with command line
3086
2056
# options, if set.
3087
2057
for option in ("interface", "address", "port", "debug",
3088
"priority", "servicename", "configdir", "use_dbus",
3089
"use_ipv6", "debuglevel", "restore", "statedir",
3090
"socket", "foreground", "zeroconf"):
2058
"priority", "servicename", "configdir",
2059
"use_dbus", "use_ipv6", "debuglevel", "restore",
3091
2061
value = getattr(options, option)
3092
2062
if value is not None:
3093
2063
server_settings[option] = value
3095
2065
# Force all strings to be unicode
3096
2066
for option in server_settings.keys():
3097
if isinstance(server_settings[option], bytes):
3098
server_settings[option] = (server_settings[option]
3100
# Force all boolean options to be boolean
3101
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3102
"foreground", "zeroconf"):
3103
server_settings[option] = bool(server_settings[option])
3104
# Debug implies foreground
3105
if server_settings["debug"]:
3106
server_settings["foreground"] = True
2067
if type(server_settings[option]) is str:
2068
server_settings[option] = unicode(server_settings[option])
3107
2069
# Now we have our good server settings in "server_settings"
3109
2071
##################################################################
3111
if (not server_settings["zeroconf"]
3112
and not (server_settings["port"]
3113
or server_settings["socket"] != "")):
3114
parser.error("Needs port or socket to work without Zeroconf")
3116
2073
# For convenience
3117
2074
debug = server_settings["debug"]
3118
2075
debuglevel = server_settings["debuglevel"]
3132
2087
level = getattr(logging, debuglevel.upper())
3133
2088
initlogger(debug, level)
3135
2090
if server_settings["servicename"] != "Mandos":
3136
syslogger.setFormatter(
3137
logging.Formatter('Mandos ({}) [%(process)d]:'
3138
' %(levelname)s: %(message)s'.format(
3139
server_settings["servicename"])))
2091
syslogger.setFormatter(logging.Formatter
2092
('Mandos (%s) [%%(process)d]:'
2093
' %%(levelname)s: %%(message)s'
2094
% server_settings["servicename"]))
3141
2096
# Parse config file with clients
3142
client_config = configparser.ConfigParser(Client.client_defaults)
2097
client_config = configparser.SafeConfigParser(Client.client_defaults)
3143
2098
client_config.read(os.path.join(server_settings["configdir"],
3144
2099
"clients.conf"))
3146
2101
global mandos_dbus_service
3147
2102
mandos_dbus_service = None
3150
if server_settings["socket"] != "":
3151
socketfd = server_settings["socket"]
3152
tcp_server = MandosServer(
3153
(server_settings["address"], server_settings["port"]),
3155
interface=(server_settings["interface"] or None),
3157
gnutls_priority=server_settings["priority"],
3161
pidfilename = "/run/mandos.pid"
3162
if not os.path.isdir("/run/."):
3163
pidfilename = "/var/run/mandos.pid"
3166
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3167
except IOError as e:
3168
logger.error("Could not open file %r", pidfilename,
3171
for name, group in (("_mandos", "_mandos"),
3172
("mandos", "mandos"),
3173
("nobody", "nogroup")):
3175
uid = pwd.getpwnam(name).pw_uid
3176
gid = pwd.getpwnam(group).pw_gid
2104
tcp_server = MandosServer((server_settings["address"],
2105
server_settings["port"]),
2107
interface=(server_settings["interface"]
2111
server_settings["priority"],
2114
pidfilename = "/var/run/mandos.pid"
2116
pidfile = open(pidfilename, "w")
2118
logger.error("Could not open file %r", pidfilename)
2121
uid = pwd.getpwnam("_mandos").pw_uid
2122
gid = pwd.getpwnam("_mandos").pw_gid
2125
uid = pwd.getpwnam("mandos").pw_uid
2126
gid = pwd.getpwnam("mandos").pw_gid
3178
2127
except KeyError:
2129
uid = pwd.getpwnam("nobody").pw_uid
2130
gid = pwd.getpwnam("nobody").pw_gid
3187
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3189
2137
except OSError as error:
3190
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3191
.format(uid, gid, os.strerror(error.errno)))
3192
if error.errno != errno.EPERM:
2138
if error[0] != errno.EPERM:
3196
2142
# Enable all possible GnuTLS debugging
3198
2144
# "Use a log level over 10 to enable all debugging options."
3199
2145
# - GnuTLS manual
3200
gnutls.global_set_log_level(11)
2146
gnutls.library.functions.gnutls_global_set_log_level(11)
2148
@gnutls.library.types.gnutls_log_func
3203
2149
def debug_gnutls(level, string):
3204
logger.debug("GnuTLS: %s",
3205
string[:-1].decode("utf-8",
3208
gnutls.global_set_log_function(debug_gnutls)
2150
logger.debug("GnuTLS: %s", string[:-1])
2152
(gnutls.library.functions
2153
.gnutls_global_set_log_function(debug_gnutls))
3210
2155
# Redirect stdin so all checkers get /dev/null
3211
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3212
2157
os.dup2(null, sys.stdin.fileno())
3216
2161
# Need to fork before connecting to D-Bus
3218
2163
# Close all input and output, do double fork, etc.
3221
if gi.version_info < (3, 10, 2):
3222
# multiprocessing will use threads, so before we use GLib we
3223
# need to inform GLib that threads will be used.
2166
gobject.threads_init()
3226
2168
global main_loop
3227
2169
# From the Avahi example code
3228
DBusGMainLoop(set_as_default=True)
3229
main_loop = GLib.MainLoop()
2170
DBusGMainLoop(set_as_default=True )
2171
main_loop = gobject.MainLoop()
3230
2172
bus = dbus.SystemBus()
3231
2173
# End of Avahi example code
3234
2176
bus_name = dbus.service.BusName("se.recompile.Mandos",
3237
old_bus_name = dbus.service.BusName(
3238
"se.bsnet.fukt.Mandos", bus,
3240
except dbus.exceptions.DBusException as e:
3241
logger.error("Disabling D-Bus:", exc_info=e)
2177
bus, do_not_queue=True)
2178
old_bus_name = (dbus.service.BusName
2179
("se.bsnet.fukt.Mandos", bus,
2181
except dbus.exceptions.NameExistsException as e:
2182
logger.error(unicode(e) + ", disabling D-Bus")
3242
2183
use_dbus = False
3243
2184
server_settings["use_dbus"] = False
3244
2185
tcp_server.use_dbus = False
3246
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3247
service = AvahiServiceToSyslog(
3248
name=server_settings["servicename"],
3249
servicetype="_mandos._tcp",
3252
if server_settings["interface"]:
3253
service.interface = if_nametoindex(
3254
server_settings["interface"].encode("utf-8"))
2186
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2187
service = AvahiServiceToSyslog(name =
2188
server_settings["servicename"],
2189
servicetype = "_mandos._tcp",
2190
protocol = protocol, bus = bus)
2191
if server_settings["interface"]:
2192
service.interface = (if_nametoindex
2193
(str(server_settings["interface"])))
3256
2195
global multiprocessing_manager
3257
2196
multiprocessing_manager = multiprocessing.Manager()
3259
2198
client_class = Client
3261
client_class = functools.partial(ClientDBus, bus=bus)
2200
client_class = functools.partial(ClientDBusTransitional,
3263
2203
client_settings = Client.config_parser(client_config)
3264
2204
old_client_settings = {}
3265
2205
clients_data = {}
3267
# This is used to redirect stdout and stderr for checker processes
3269
wnull = open(os.devnull, "w") # A writable /dev/null
3270
# Only used if server is running in foreground but not in debug
3272
if debug or not foreground:
3275
2207
# Get client data and settings from last running state.
3276
2208
if server_settings["restore"]:
3278
2210
with open(stored_state_path, "rb") as stored_state:
3279
if sys.version_info.major == 2:
3280
clients_data, old_client_settings = pickle.load(
3283
bytes_clients_data, bytes_old_client_settings = (
3284
pickle.load(stored_state, encoding="bytes"))
3285
# Fix bytes to strings
3288
clients_data = {(key.decode("utf-8")
3289
if isinstance(key, bytes)
3292
bytes_clients_data.items()}
3293
del bytes_clients_data
3294
for key in clients_data:
3295
value = {(k.decode("utf-8")
3296
if isinstance(k, bytes) else k): v
3298
clients_data[key].items()}
3299
clients_data[key] = value
3301
value["client_structure"] = [
3303
if isinstance(s, bytes)
3305
value["client_structure"]]
3306
# .name, .host, and .checker_command
3307
for k in ("name", "host", "checker_command"):
3308
if isinstance(value[k], bytes):
3309
value[k] = value[k].decode("utf-8")
3310
if "key_id" not in value:
3311
value["key_id"] = ""
3312
elif "fingerprint" not in value:
3313
value["fingerprint"] = ""
3314
# old_client_settings
3316
old_client_settings = {
3317
(key.decode("utf-8")
3318
if isinstance(key, bytes)
3321
bytes_old_client_settings.items()}
3322
del bytes_old_client_settings
3323
# .host and .checker_command
3324
for value in old_client_settings.values():
3325
for attribute in ("host", "checker_command"):
3326
if isinstance(value[attribute], bytes):
3327
value[attribute] = (value[attribute]
2211
clients_data, old_client_settings = (pickle.load
3329
2213
os.remove(stored_state_path)
3330
2214
except IOError as e:
3331
if e.errno == errno.ENOENT:
3332
logger.warning("Could not load persistent state:"
3333
" {}".format(os.strerror(e.errno)))
3335
logger.critical("Could not load persistent state:",
2215
logger.warning("Could not load persistent state: {0}"
2217
if e.errno != errno.ENOENT:
3338
2219
except EOFError as e:
3339
2220
logger.warning("Could not load persistent state: "
2221
"EOFError: {0}".format(e))
3343
2223
with PGPEngine() as pgp:
3344
for client_name, client in clients_data.items():
3345
# Skip removed clients
3346
if client_name not in client_settings:
2224
for client_name, client in clients_data.iteritems():
3349
2225
# Decide which value to use after restoring saved state.
3350
2226
# We have three different values: Old config file,
3351
2227
# new config file, and saved state.
3356
2232
# For each value in new config, check if it
3357
2233
# differs from the old config value (Except for
3358
2234
# the "secret" attribute)
3359
if (name != "secret"
3361
old_client_settings[client_name][name])):
2235
if (name != "secret" and
2236
value != old_client_settings[client_name]
3362
2238
client[name] = value
3363
2239
except KeyError:
3366
2242
# Clients who has passed its expire date can still be
3367
# enabled if its last checker was successful. A Client
3368
# whose checker succeeded before we stored its state is
3369
# assumed to have successfully run all checkers during
2243
# enabled if its last checker was successful. Clients
2244
# whose checker failed before we stored its state is
2245
# assumed to have failed all checkers during downtime.
3371
2246
if client["enabled"]:
3372
2247
if datetime.datetime.utcnow() >= client["expires"]:
3373
2248
if not client["last_checked_ok"]:
3374
2249
logger.warning(
3375
"disabling client {} - Client never "
3376
"performed a successful checker".format(
2250
"disabling client {0} - Client never "
2251
"performed a successfull checker"
2252
.format(client["name"]))
3378
2253
client["enabled"] = False
3379
2254
elif client["last_checker_status"] != 0:
3380
2255
logger.warning(
3381
"disabling client {} - Client last"
3382
" checker failed with error code"
3385
client["last_checker_status"]))
2256
"disabling client {0} - Client "
2257
"last checker failed with error code {1}"
2258
.format(client["name"],
2259
client["last_checker_status"]))
3386
2260
client["enabled"] = False
3388
client["expires"] = (
3389
datetime.datetime.utcnow()
3390
+ client["timeout"])
3391
logger.debug("Last checker succeeded,"
3392
" keeping {} enabled".format(
2262
client["expires"] = (datetime.datetime
2264
+ client["timeout"])
3395
client["secret"] = pgp.decrypt(
3396
client["encrypted_secret"],
3397
client_settings[client_name]["secret"])
2267
client["secret"] = (
2268
pgp.decrypt(client["encrypted_secret"],
2269
client_settings[client_name]
3398
2271
except PGPError:
3399
2272
# If decryption fails, we use secret from new settings
3400
logger.debug("Failed to decrypt {} old secret".format(
3402
client["secret"] = (client_settings[client_name]
2273
logger.debug("Failed to decrypt {0} old secret"
2274
.format(client_name))
2275
client["secret"] = (
2276
client_settings[client_name]["secret"])
3405
2279
# Add/remove clients based on new changes made to config
3406
for client_name in (set(old_client_settings)
3407
- set(client_settings)):
2280
for client_name in set(old_client_settings) - set(client_settings):
3408
2281
del clients_data[client_name]
3409
for client_name in (set(client_settings)
3410
- set(old_client_settings)):
2282
for client_name in set(client_settings) - set(old_client_settings):
3411
2283
clients_data[client_name] = client_settings[client_name]
3413
# Create all client objects
3414
for client_name, client in clients_data.items():
2285
# Create clients all clients
2286
for client_name, client in clients_data.iteritems():
3415
2287
tcp_server.clients[client_name] = client_class(
3418
server_settings=server_settings)
2288
name = client_name, settings = client)
3420
2290
if not tcp_server.clients:
3421
2291
logger.warning("No clients defined")
3424
if pidfile is not None:
3428
print(pid, file=pidfile)
3430
logger.error("Could not write to file %r with PID %d",
2297
pidfile.write(str(pid) + "\n".encode("utf-8"))
2300
logger.error("Could not write to file %r with PID %d",
2303
# "pidfile" was never created
3433
2305
del pidfilename
3435
for termsig in (signal.SIGHUP, signal.SIGTERM):
3436
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3437
lambda: main_loop.quit() and False)
2306
signal.signal(signal.SIGINT, signal.SIG_IGN)
2308
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2309
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3441
@alternate_dbus_interfaces(
3442
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3443
class MandosDBusService(DBusObjectWithObjectManager):
2312
class MandosDBusService(dbus.service.Object):
3444
2313
"""A D-Bus proxy object"""
3446
2314
def __init__(self):
3447
2315
dbus.service.Object.__init__(self, bus, "/")
3449
2316
_interface = "se.recompile.Mandos"
3451
2318
@dbus.service.signal(_interface, signature="o")
3452
2319
def ClientAdded(self, objpath):
3456
2323
@dbus.service.signal(_interface, signature="ss")
3457
def ClientNotFound(self, key_id, address):
2324
def ClientNotFound(self, fingerprint, address):
3461
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3463
2328
@dbus.service.signal(_interface, signature="os")
3464
2329
def ClientRemoved(self, objpath, name):
3468
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3470
2333
@dbus.service.method(_interface, out_signature="ao")
3471
2334
def GetAllClients(self):
3473
return dbus.Array(c.dbus_object_path for c in
3474
tcp_server.clients.values())
3476
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2336
return dbus.Array(c.dbus_object_path
2338
tcp_server.clients.itervalues())
3478
2340
@dbus.service.method(_interface,
3479
2341
out_signature="a{oa{sv}}")
3480
2342
def GetAllClientsWithProperties(self):
3482
2344
return dbus.Dictionary(
3483
{c.dbus_object_path: c.GetAll(
3484
"se.recompile.Mandos.Client")
3485
for c in tcp_server.clients.values()},
2345
((c.dbus_object_path, c.GetAll(""))
2346
for c in tcp_server.clients.itervalues()),
3486
2347
signature="oa{sv}")
3488
2349
@dbus.service.method(_interface, in_signature="o")
3489
2350
def RemoveClient(self, object_path):
3491
for c in tcp_server.clients.values():
2352
for c in tcp_server.clients.itervalues():
3492
2353
if c.dbus_object_path == object_path:
3493
2354
del tcp_server.clients[c.name]
3494
2355
c.remove_from_connection()
3495
# Don't signal the disabling
2356
# Don't signal anything except ClientRemoved
3496
2357
c.disable(quiet=True)
3497
# Emit D-Bus signal for removal
3498
self.client_removed_signal(c)
2359
self.ClientRemoved(object_path, c.name)
3500
2361
raise KeyError(object_path)
3504
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3505
out_signature="a{oa{sa{sv}}}")
3506
def GetManagedObjects(self):
3508
return dbus.Dictionary(
3509
{client.dbus_object_path:
3511
{interface: client.GetAll(interface)
3513
client._get_all_interface_names()})
3514
for client in tcp_server.clients.values()})
3516
def client_added_signal(self, client):
3517
"""Send the new standard signal and the old signal"""
3519
# New standard signal
3520
self.InterfacesAdded(
3521
client.dbus_object_path,
3523
{interface: client.GetAll(interface)
3525
client._get_all_interface_names()}))
3527
self.ClientAdded(client.dbus_object_path)
3529
def client_removed_signal(self, client):
3530
"""Send the new standard signal and the old signal"""
3532
# New standard signal
3533
self.InterfacesRemoved(
3534
client.dbus_object_path,
3535
client._get_all_interface_names())
3537
self.ClientRemoved(client.dbus_object_path,
3540
mandos_dbus_service = MandosDBusService()
3542
# Save modules to variables to exempt the modules from being
3543
# unloaded before the function registered with atexit() is run.
3544
mp = multiprocessing
2365
class MandosDBusServiceTransitional(MandosDBusService):
2366
__metaclass__ = AlternateDBusNamesMetaclass
2367
mandos_dbus_service = MandosDBusServiceTransitional()
3548
2370
"Cleanup function; run on exit"
3552
mp.active_children()
2373
multiprocessing.active_children()
3554
2374
if not (tcp_server.clients or client_settings):
3557
2377
# Store client before exiting. Secrets are encrypted with key
3558
2378
# based on what config file has. If config file is
3559
2379
# removed/edited, old secret will thus be unrecovable.
3561
2381
with PGPEngine() as pgp:
3562
for client in tcp_server.clients.values():
2382
for client in tcp_server.clients.itervalues():
3563
2383
key = client_settings[client.name]["secret"]
3564
2384
client.encrypted_secret = pgp.encrypt(client.secret,
3566
2386
client_dict = {}
3568
2388
# A list of attributes that can not be pickled
3570
exclude = {"bus", "changedstate", "secret",
3571
"checker", "server_settings"}
3572
for name, typ in inspect.getmembers(dbus.service
2390
exclude = set(("bus", "changedstate", "secret",
2392
for name, typ in (inspect.getmembers
2393
(dbus.service.Object)):
3574
2394
exclude.add(name)
3576
2396
client_dict["encrypted_secret"] = (client
3577
2397
.encrypted_secret)
3578
2398
for attr in client.client_structure:
3579
2399
if attr not in exclude:
3580
2400
client_dict[attr] = getattr(client, attr)
3582
2402
clients[client.name] = client_dict
3583
2403
del client_settings[client.name]["secret"]
3586
with tempfile.NamedTemporaryFile(
3590
dir=os.path.dirname(stored_state_path),
3591
delete=False) as stored_state:
3592
pickle.dump((clients, client_settings), stored_state,
3594
tempname = stored_state.name
2406
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2409
(stored_state_path))
2410
with os.fdopen(tempfd, "wb") as stored_state:
2411
pickle.dump((clients, client_settings), stored_state)
3595
2412
os.rename(tempname, stored_state_path)
3596
2413
except (IOError, OSError) as e:
2414
logger.warning("Could not save persistent state: {0}"
3599
2418
os.remove(tempname)
3600
2419
except NameError:
3602
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3603
logger.warning("Could not save persistent state: {}"
3604
.format(os.strerror(e.errno)))
3606
logger.warning("Could not save persistent state:",
2421
if e.errno not in set((errno.ENOENT, errno.EACCES,
3610
2425
# Delete all clients, and settings from config
3611
2426
while tcp_server.clients:
3612
2427
name, client = tcp_server.clients.popitem()
3614
2429
client.remove_from_connection()
3615
# Don't signal the disabling
2430
# Don't signal anything except ClientRemoved
3616
2431
client.disable(quiet=True)
3617
# Emit D-Bus signal for removal
3619
mandos_dbus_service.client_removed_signal(client)
2434
mandos_dbus_service.ClientRemoved(client
3620
2437
client_settings.clear()
3622
2439
atexit.register(cleanup)
3624
for client in tcp_server.clients.values():
2441
for client in tcp_server.clients.itervalues():
3626
# Emit D-Bus signal for adding
3627
mandos_dbus_service.client_added_signal(client)
2444
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3628
2445
# Need to initiate checking of clients
3629
2446
if client.enabled:
3630
2447
client.init_checker()
3632
2449
tcp_server.enable()
3633
2450
tcp_server.server_activate()
3635
2452
# Find out what port we got
3637
service.port = tcp_server.socket.getsockname()[1]
2453
service.port = tcp_server.socket.getsockname()[1]
3639
2455
logger.info("Now listening on address %r, port %d,"
3640
" flowinfo %d, scope_id %d",
3641
*tcp_server.socket.getsockname())
2456
" flowinfo %d, scope_id %d"
2457
% tcp_server.socket.getsockname())
3643
logger.info("Now listening on address %r, port %d",
3644
*tcp_server.socket.getsockname())
3646
# service.interface = tcp_server.socket.getsockname()[3]
2459
logger.info("Now listening on address %r, port %d"
2460
% tcp_server.socket.getsockname())
2462
#service.interface = tcp_server.socket.getsockname()[3]
3650
# From the Avahi example code
3653
except dbus.exceptions.DBusException as error:
3654
logger.critical("D-Bus Exception", exc_info=error)
3657
# End of Avahi example code
3660
GLib.IOChannel.unix_new(tcp_server.fileno()),
3661
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3662
lambda *args, **kwargs: (tcp_server.handle_request
3663
(*args[2:], **kwargs) or True))
2465
# From the Avahi example code
2468
except dbus.exceptions.DBusException as error:
2469
logger.critical("DBusException: %s", error)
2472
# End of Avahi example code
2474
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2475
lambda *args, **kwargs:
2476
(tcp_server.handle_request
2477
(*args[2:], **kwargs) or True))
3665
2479
logger.debug("Starting main loop")
3666
2480
main_loop.run()
3667
2481
except AvahiError as error:
3668
logger.critical("Avahi Error", exc_info=error)
2482
logger.critical("AvahiError: %s", error)
3671
2485
except KeyboardInterrupt: