240
167
os.rmdir(self.tempdir)
241
168
self.tempdir = None
243
170
def password_encode(self, password):
244
171
# Passphrase can not be empty and can not contain newlines or
245
172
# NUL bytes. So we prefix it and hex encode it.
246
encoded = b"mandos" + binascii.hexlify(password)
247
if len(encoded) > 2048:
248
# GnuPG can't handle long passwords, so encode differently
249
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
250
.replace(b"\n", b"\\n")
251
.replace(b"\0", b"\\x00"))
173
return b"mandos" + binascii.hexlify(password)
254
175
def encrypt(self, data, password):
255
passphrase = self.password_encode(password)
256
with tempfile.NamedTemporaryFile(
257
dir=self.tempdir) as passfile:
258
passfile.write(passphrase)
260
proc = subprocess.Popen([self.gpg, '--symmetric',
264
stdin=subprocess.PIPE,
265
stdout=subprocess.PIPE,
266
stderr=subprocess.PIPE)
267
ciphertext, err = proc.communicate(input=data)
268
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
270
190
return ciphertext
272
192
def decrypt(self, data, password):
273
passphrase = self.password_encode(password)
274
with tempfile.NamedTemporaryFile(
275
dir=self.tempdir) as passfile:
276
passfile.write(passphrase)
278
proc = subprocess.Popen([self.gpg, '--decrypt',
282
stdin=subprocess.PIPE,
283
stdout=subprocess.PIPE,
284
stderr=subprocess.PIPE)
285
decrypted_plaintext, err = proc.communicate(input=data)
286
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
288
207
return decrypted_plaintext
291
# Pretend that we have an Avahi module
293
"""This isn't so much a class as it is a module-like namespace."""
294
IF_UNSPEC = -1 # avahi-common/address.h
295
PROTO_UNSPEC = -1 # avahi-common/address.h
296
PROTO_INET = 0 # avahi-common/address.h
297
PROTO_INET6 = 1 # avahi-common/address.h
298
DBUS_NAME = "org.freedesktop.Avahi"
299
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
300
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
301
DBUS_PATH_SERVER = "/"
304
def string_array_to_txt_array(t):
305
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
306
for s in t), signature="ay")
307
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
308
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
309
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
310
SERVER_INVALID = 0 # avahi-common/defs.h
311
SERVER_REGISTERING = 1 # avahi-common/defs.h
312
SERVER_RUNNING = 2 # avahi-common/defs.h
313
SERVER_COLLISION = 3 # avahi-common/defs.h
314
SERVER_FAILURE = 4 # avahi-common/defs.h
317
211
class AvahiError(Exception):
318
212
def __init__(self, value, *args, **kwargs):
319
213
self.value = value
320
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))
324
218
class AvahiServiceError(AvahiError):
328
221
class AvahiGroupError(AvahiError):
225
class AvahiService(object):
333
226
"""An Avahi (Zeroconf) service.
336
229
interface: integer; avahi.IF_UNSPEC or an interface index.
337
230
Used to optionally bind to the specified interface.
338
231
name: string; Example: 'Mandos'
339
232
type: string; Example: '_mandos._tcp'.
340
See <https://www.iana.org/assignments/service-names-port-numbers>
233
See <http://www.dns-sd.org/ServiceTypes.html>
341
234
port: integer; what port to announce
342
235
TXT: list of strings; TXT record for the service
343
236
domain: string; Domain to publish on, default to .local if empty.
502
365
follow_name_owner_changes=True),
503
366
avahi.DBUS_INTERFACE_SERVER)
504
367
self.server.connect_to_signal("StateChanged",
505
self.server_state_changed)
368
self.server_state_changed)
506
369
self.server_state_changed(self.server.GetState())
509
371
class AvahiServiceToSyslog(AvahiService):
510
def rename(self, *args, **kwargs):
511
373
"""Add the new name to the syslog messages"""
512
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
513
syslogger.setFormatter(logging.Formatter(
514
'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'
519
# Pretend that we have a GnuTLS module
521
"""This isn't so much a class as it is a module-like namespace."""
523
library = ctypes.util.find_library("gnutls")
525
library = ctypes.util.find_library("gnutls-deb0")
526
_library = ctypes.cdll.LoadLibrary(library)
529
# Unless otherwise indicated, the constants and types below are
530
# all from the gnutls/gnutls.h C header file.
541
E_NO_CERTIFICATE_FOUND = -49
546
KEYID_USE_SHA256 = 1 # gnutls/x509.h
547
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
550
class session_int(ctypes.Structure):
552
session_t = ctypes.POINTER(session_int)
554
class certificate_credentials_st(ctypes.Structure):
556
certificate_credentials_t = ctypes.POINTER(
557
certificate_credentials_st)
558
certificate_type_t = ctypes.c_int
560
class datum_t(ctypes.Structure):
561
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
562
('size', ctypes.c_uint)]
564
class openpgp_crt_int(ctypes.Structure):
566
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
567
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
568
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
569
credentials_type_t = ctypes.c_int
570
transport_ptr_t = ctypes.c_void_p
571
close_request_t = ctypes.c_int
574
class Error(Exception):
575
def __init__(self, message=None, code=None, args=()):
576
# Default usage is by a message string, but if a return
577
# code is passed, convert it to a string with
580
if message is None and code is not None:
581
message = gnutls.strerror(code)
582
return super(gnutls.Error, self).__init__(
585
class CertificateSecurityError(Error):
591
self._c_object = gnutls.certificate_credentials_t()
592
gnutls.certificate_allocate_credentials(
593
ctypes.byref(self._c_object))
594
self.type = gnutls.CRD_CERTIFICATE
597
gnutls.certificate_free_credentials(self._c_object)
600
def __init__(self, socket, credentials=None):
601
self._c_object = gnutls.session_t()
602
gnutls_flags = gnutls.CLIENT
603
if gnutls.check_version(b"3.5.6"):
604
gnutls_flags |= gnutls.NO_TICKETS
606
gnutls_flags |= gnutls.ENABLE_RAWPK
607
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
609
gnutls.set_default_priority(self._c_object)
610
gnutls.transport_set_ptr(self._c_object, socket.fileno())
611
gnutls.handshake_set_private_extensions(self._c_object,
614
if credentials is None:
615
credentials = gnutls.Credentials()
616
gnutls.credentials_set(self._c_object, credentials.type,
617
ctypes.cast(credentials._c_object,
619
self.credentials = credentials
622
gnutls.deinit(self._c_object)
625
return gnutls.handshake(self._c_object)
627
def send(self, data):
631
data_len -= gnutls.record_send(self._c_object,
636
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
638
# Error handling functions
639
def _error_code(result):
640
"""A function to raise exceptions on errors, suitable
641
for the 'restype' attribute on ctypes functions"""
644
if result == gnutls.E_NO_CERTIFICATE_FOUND:
645
raise gnutls.CertificateSecurityError(code=result)
646
raise gnutls.Error(code=result)
648
def _retry_on_error(result, func, arguments):
649
"""A function to retry on some errors, suitable
650
for the 'errcheck' attribute on ctypes functions"""
652
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
653
return _error_code(result)
654
result = func(*arguments)
657
# Unless otherwise indicated, the function declarations below are
658
# all from the gnutls/gnutls.h C header file.
661
priority_set_direct = _library.gnutls_priority_set_direct
662
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
663
ctypes.POINTER(ctypes.c_char_p)]
664
priority_set_direct.restype = _error_code
666
init = _library.gnutls_init
667
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
668
init.restype = _error_code
670
set_default_priority = _library.gnutls_set_default_priority
671
set_default_priority.argtypes = [session_t]
672
set_default_priority.restype = _error_code
674
record_send = _library.gnutls_record_send
675
record_send.argtypes = [session_t, ctypes.c_void_p,
677
record_send.restype = ctypes.c_ssize_t
678
record_send.errcheck = _retry_on_error
680
certificate_allocate_credentials = (
681
_library.gnutls_certificate_allocate_credentials)
682
certificate_allocate_credentials.argtypes = [
683
ctypes.POINTER(certificate_credentials_t)]
684
certificate_allocate_credentials.restype = _error_code
686
certificate_free_credentials = (
687
_library.gnutls_certificate_free_credentials)
688
certificate_free_credentials.argtypes = [
689
certificate_credentials_t]
690
certificate_free_credentials.restype = None
692
handshake_set_private_extensions = (
693
_library.gnutls_handshake_set_private_extensions)
694
handshake_set_private_extensions.argtypes = [session_t,
696
handshake_set_private_extensions.restype = None
698
credentials_set = _library.gnutls_credentials_set
699
credentials_set.argtypes = [session_t, credentials_type_t,
701
credentials_set.restype = _error_code
703
strerror = _library.gnutls_strerror
704
strerror.argtypes = [ctypes.c_int]
705
strerror.restype = ctypes.c_char_p
707
certificate_type_get = _library.gnutls_certificate_type_get
708
certificate_type_get.argtypes = [session_t]
709
certificate_type_get.restype = _error_code
711
certificate_get_peers = _library.gnutls_certificate_get_peers
712
certificate_get_peers.argtypes = [session_t,
713
ctypes.POINTER(ctypes.c_uint)]
714
certificate_get_peers.restype = ctypes.POINTER(datum_t)
716
global_set_log_level = _library.gnutls_global_set_log_level
717
global_set_log_level.argtypes = [ctypes.c_int]
718
global_set_log_level.restype = None
720
global_set_log_function = _library.gnutls_global_set_log_function
721
global_set_log_function.argtypes = [log_func]
722
global_set_log_function.restype = None
724
deinit = _library.gnutls_deinit
725
deinit.argtypes = [session_t]
726
deinit.restype = None
728
handshake = _library.gnutls_handshake
729
handshake.argtypes = [session_t]
730
handshake.restype = _error_code
731
handshake.errcheck = _retry_on_error
733
transport_set_ptr = _library.gnutls_transport_set_ptr
734
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
735
transport_set_ptr.restype = None
737
bye = _library.gnutls_bye
738
bye.argtypes = [session_t, close_request_t]
739
bye.restype = _error_code
740
bye.errcheck = _retry_on_error
742
check_version = _library.gnutls_check_version
743
check_version.argtypes = [ctypes.c_char_p]
744
check_version.restype = ctypes.c_char_p
746
_need_version = b"3.3.0"
747
if check_version(_need_version) is None:
748
raise self.Error("Needs GnuTLS {} or later"
749
.format(_need_version))
751
_tls_rawpk_version = b"3.6.6"
752
has_rawpk = bool(check_version(_tls_rawpk_version))
756
class pubkey_st(ctypes.Structure):
758
pubkey_t = ctypes.POINTER(pubkey_st)
760
x509_crt_fmt_t = ctypes.c_int
762
# All the function declarations below are from gnutls/abstract.h
763
pubkey_init = _library.gnutls_pubkey_init
764
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
765
pubkey_init.restype = _error_code
767
pubkey_import = _library.gnutls_pubkey_import
768
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
770
pubkey_import.restype = _error_code
772
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
773
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
774
ctypes.POINTER(ctypes.c_ubyte),
775
ctypes.POINTER(ctypes.c_size_t)]
776
pubkey_get_key_id.restype = _error_code
778
pubkey_deinit = _library.gnutls_pubkey_deinit
779
pubkey_deinit.argtypes = [pubkey_t]
780
pubkey_deinit.restype = None
782
# All the function declarations below are from gnutls/openpgp.h
784
openpgp_crt_init = _library.gnutls_openpgp_crt_init
785
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
786
openpgp_crt_init.restype = _error_code
788
openpgp_crt_import = _library.gnutls_openpgp_crt_import
789
openpgp_crt_import.argtypes = [openpgp_crt_t,
790
ctypes.POINTER(datum_t),
792
openpgp_crt_import.restype = _error_code
794
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
795
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
796
ctypes.POINTER(ctypes.c_uint)]
797
openpgp_crt_verify_self.restype = _error_code
799
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
800
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
801
openpgp_crt_deinit.restype = None
803
openpgp_crt_get_fingerprint = (
804
_library.gnutls_openpgp_crt_get_fingerprint)
805
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
809
openpgp_crt_get_fingerprint.restype = _error_code
811
if check_version(b"3.6.4"):
812
certificate_type_get2 = _library.gnutls_certificate_type_get2
813
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
814
certificate_type_get2.restype = _error_code
816
# Remove non-public functions
817
del _error_code, _retry_on_error
820
def call_pipe(connection, # : multiprocessing.Connection
821
func, *args, **kwargs):
822
"""This function is meant to be called by multiprocessing.Process
824
This function runs func(*args, **kwargs), and writes the resulting
825
return value on the provided multiprocessing.Connection.
827
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):
832
388
"""A representation of a client host served by this server.
835
391
approved: bool(); 'None' if not yet approved/disapproved
836
392
approval_delay: datetime.timedelta(); Time to wait for approval
837
393
approval_duration: datetime.timedelta(); Duration of one approval
838
checker: multiprocessing.Process(); a running checker process used
839
to see if the client lives. 'None' if no process is
841
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
842
398
checker_command: string; External command which is run to check
843
399
if client lives. %() expansions are done at
844
400
runtime with vars(self) as dict, so that for
845
401
instance %(name)s can be used in the command.
846
checker_initiator_tag: a GLib event source tag, or None
402
checker_initiator_tag: a gobject event source tag, or None
847
403
created: datetime.datetime(); (UTC) object creation
848
404
client_structure: Object describing what attributes a client has
849
405
and is used for storing the client at exit
850
406
current_checker_command: string; current running checker_command
851
disable_initiator_tag: a GLib event source tag, or None
407
disable_initiator_tag: a gobject event source tag, or None
853
409
fingerprint: string (40 or 32 hexadecimal digits); used to
854
uniquely identify an OpenPGP client
855
key_id: string (64 hexadecimal digits); used to uniquely identify
856
a client using raw public keys
410
uniquely identify the client
857
411
host: string; available for use by the checker command
858
412
interval: datetime.timedelta(); How often to start a new checker
859
413
last_approval_request: datetime.datetime(); (UTC) or None
860
414
last_checked_ok: datetime.datetime(); (UTC) or None
861
415
last_checker_status: integer between 0 and 255 reflecting exit
862
416
status of last checker. -1 reflects crashed
863
checker, -2 means no checker completed yet.
864
last_checker_signal: The signal which killed the last checker, if
865
last_checker_status is -1
866
418
last_enabled: datetime.datetime(); (UTC) or None
867
419
name: string; from the config file, used in log messages and
868
420
D-Bus identifiers
869
421
secret: bytestring; sent verbatim (over TLS) to client
870
422
timeout: datetime.timedelta(); How long from last_checked_ok
871
423
until this client is disabled
872
extended_timeout: extra long timeout when secret has been sent
424
extended_timeout: extra long timeout when password has been sent
873
425
runtime_expansions: Allowed attributes for runtime expansion.
874
426
expires: datetime.datetime(); time (UTC) when a client will be
875
427
disabled, or None
876
server_settings: The server_settings dict from main()
879
430
runtime_expansions = ("approval_delay", "approval_duration",
880
"created", "enabled", "expires", "key_id",
881
"fingerprint", "host", "interval",
882
"last_approval_request", "last_checked_ok",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
883
433
"last_enabled", "name", "timeout")
886
"extended_timeout": "PT15M",
888
"checker": "fping -q -- %%(host)s",
890
"approval_delay": "PT0S",
891
"approval_duration": "PT1S",
892
"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)
897
461
def config_parser(config):
898
"""Construct a new dict of client settings of this form:
462
""" Construct a new dict of client settings of this form:
899
463
{ client_name: {setting_name: value, ...}, ...}
900
with exceptions for any special settings as defined above.
901
NOTE: Must be a pure function. Must return the same result
902
value given the same arguments.
464
with exceptions for any special settings as defined above"""
905
466
for client_name in config.sections():
906
467
section = dict(config.items(client_name))
907
468
client = settings[client_name] = {}
909
470
client["host"] = section["host"]
910
471
# Reformat values from string types to Python types
911
472
client["approved_by_default"] = config.getboolean(
912
473
client_name, "approved_by_default")
913
client["enabled"] = config.getboolean(client_name,
916
# Uppercase and remove spaces from key_id and fingerprint
917
# for later comparison purposes with return value from the
918
# key_id() and fingerprint() functions
919
client["key_id"] = (section.get("key_id", "").upper()
474
client["enabled"] = config.getboolean(client_name, "enabled")
921
476
client["fingerprint"] = (section["fingerprint"].upper()
922
477
.replace(" ", ""))
923
478
if "secret" in section:
924
client["secret"] = codecs.decode(section["secret"]
479
client["secret"] = section["secret"].decode("base64")
927
480
elif "secfile" in section:
928
481
with open(os.path.expanduser(os.path.expandvars
929
482
(section["secfile"])),
930
483
"rb") as secfile:
931
484
client["secret"] = secfile.read()
933
raise TypeError("No secret or secfile for section {}"
486
raise TypeError("No secret or secfile for section %s"
935
488
client["timeout"] = string_to_delta(section["timeout"])
936
489
client["extended_timeout"] = string_to_delta(
937
490
section["extended_timeout"])
980
532
self.current_checker_command = None
981
533
self.approved = None
982
534
self.approvals_pending = 0
983
self.changedstate = multiprocessing_manager.Condition(
984
multiprocessing_manager.Lock())
985
self.client_structure = [attr
986
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()
987
540
if not attr.startswith("_")]
988
541
self.client_structure.append("client_structure")
990
for name, t in inspect.getmembers(
991
type(self), lambda obj: isinstance(obj, property)):
543
for name, t in inspect.getmembers(type(self),
992
547
if not name.startswith("_"):
993
548
self.client_structure.append(name)
995
550
# Send notice to process children that client state has changed
996
551
def send_changedstate(self):
997
552
with self.changedstate:
998
553
self.changedstate.notify_all()
1000
555
def enable(self):
1001
556
"""Start this client's checker and timeout hooks"""
1002
557
if getattr(self, "enabled", False):
1003
558
# Already enabled
560
self.send_changedstate()
1005
561
self.expires = datetime.datetime.utcnow() + self.timeout
1006
562
self.enabled = True
1007
563
self.last_enabled = datetime.datetime.utcnow()
1008
564
self.init_checker()
1009
self.send_changedstate()
1011
566
def disable(self, quiet=True):
1012
567
"""Disable this client."""
1013
568
if not getattr(self, "enabled", False):
571
self.send_changedstate()
1016
573
logger.info("Disabling client %s", self.name)
1017
if getattr(self, "disable_initiator_tag", None) is not None:
1018
GLib.source_remove(self.disable_initiator_tag)
574
if getattr(self, "disable_initiator_tag", False):
575
gobject.source_remove(self.disable_initiator_tag)
1019
576
self.disable_initiator_tag = None
1020
577
self.expires = None
1021
if getattr(self, "checker_initiator_tag", None) is not None:
1022
GLib.source_remove(self.checker_initiator_tag)
578
if getattr(self, "checker_initiator_tag", False):
579
gobject.source_remove(self.checker_initiator_tag)
1023
580
self.checker_initiator_tag = None
1024
581
self.stop_checker()
1025
582
self.enabled = False
1027
self.send_changedstate()
1028
# 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
1031
586
def __del__(self):
1034
589
def init_checker(self):
1035
590
# Schedule a new checker to be started an 'interval' from now,
1036
591
# and every interval from then on.
1037
if self.checker_initiator_tag is not None:
1038
GLib.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = GLib.timeout_add(
1040
int(self.interval.total_seconds() * 1000),
592
self.checker_initiator_tag = (gobject.timeout_add
593
(self.interval_milliseconds(),
1042
595
# Schedule a disable() when 'timeout' has passed
1043
if self.disable_initiator_tag is not None:
1044
GLib.source_remove(self.disable_initiator_tag)
1045
self.disable_initiator_tag = GLib.timeout_add(
1046
int(self.timeout.total_seconds() * 1000), self.disable)
596
self.disable_initiator_tag = (gobject.timeout_add
597
(self.timeout_milliseconds(),
1047
599
# Also start a new checker *right now*.
1048
600
self.start_checker()
1050
def checker_callback(self, source, condition, connection,
602
def checker_callback(self, pid, condition, command):
1052
603
"""The checker has completed, so take appropriate actions."""
1053
# Read return code from connection (see call_pipe)
1054
returncode = connection.recv()
1057
604
self.checker_callback_tag = None
1058
605
self.checker = None
1061
self.last_checker_status = returncode
1062
self.last_checker_signal = None
606
if os.WIFEXITED(condition):
607
self.last_checker_status = os.WEXITSTATUS(condition)
1063
608
if self.last_checker_status == 0:
1064
609
logger.info("Checker for %(name)s succeeded",
1066
611
self.checked_ok()
1068
logger.info("Checker for %(name)s failed", vars(self))
613
logger.info("Checker for %(name)s failed",
1070
616
self.last_checker_status = -1
1071
self.last_checker_signal = -returncode
1072
617
logger.warning("Checker for %(name)s crashed?",
1076
def checked_ok(self):
1077
"""Assert that the client has been seen, alive and well."""
1078
self.last_checked_ok = datetime.datetime.utcnow()
1079
self.last_checker_status = 0
1080
self.last_checker_signal = None
1083
def bump_timeout(self, timeout=None):
1084
"""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,
1085
626
if timeout is None:
1086
627
timeout = self.timeout
628
self.last_checked_ok = datetime.datetime.utcnow()
1087
629
if self.disable_initiator_tag is not None:
1088
GLib.source_remove(self.disable_initiator_tag)
1089
self.disable_initiator_tag = None
630
gobject.source_remove(self.disable_initiator_tag)
1090
631
if getattr(self, "enabled", False):
1091
self.disable_initiator_tag = GLib.timeout_add(
1092
int(timeout.total_seconds() * 1000), self.disable)
632
self.disable_initiator_tag = (gobject.timeout_add
633
(timedelta_to_milliseconds
634
(timeout), self.disable))
1093
635
self.expires = datetime.datetime.utcnow() + timeout
1095
637
def need_approval(self):
1096
638
self.last_approval_request = datetime.datetime.utcnow()
1098
640
def start_checker(self):
1099
641
"""Start a new checker subprocess if one is not running.
1101
643
If a checker already exists, leave it running and do
1103
645
# The reason for not killing a running checker is that if we
1104
# did that, and if a checker (for some reason) started running
1105
# slowly and taking more than 'interval' time, then the client
1106
# would inevitably timeout, since no checker would get a
1107
# 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
1108
650
# checkers alone, the checker would have to take more time
1109
651
# than 'timeout' for the client to be disabled, which is as it
1112
if self.checker is not None and not self.checker.is_alive():
1113
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)
1116
667
# Start a new checker if needed
1117
668
if self.checker is None:
1118
# Escape attributes for the shell
1120
attr: re.escape(str(getattr(self, attr)))
1121
for attr in self.runtime_expansions}
1123
command = self.checker_command % escaped_attrs
1124
except TypeError as error:
1125
logger.error('Could not format string "%s"',
1126
self.checker_command,
1128
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
1129
688
self.current_checker_command = command
1130
logger.info("Starting checker %r for %s", command,
1132
# We don't need to redirect stdout and stderr, since
1133
# in normal mode, that is already done by daemon(),
1134
# and in debug mode we don't want to. (Stdin is
1135
# always replaced by /dev/null.)
1136
# The exception is when not debugging but nevertheless
1137
# running in the foreground; use the previously
1139
popen_args = {"close_fds": True,
1142
if (not self.server_settings["debug"]
1143
and self.server_settings["foreground"]):
1144
popen_args.update({"stdout": wnull,
1146
pipe = multiprocessing.Pipe(duplex=False)
1147
self.checker = multiprocessing.Process(
1149
args=(pipe[1], subprocess.call, command),
1151
self.checker.start()
1152
self.checker_callback_tag = GLib.io_add_watch(
1153
GLib.IOChannel.unix_new(pipe[0].fileno()),
1154
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1155
self.checker_callback, pipe[0], command)
1156
# 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
1159
715
def stop_checker(self):
1160
716
"""Force the checker process, if any, to stop."""
1161
717
if self.checker_callback_tag:
1162
GLib.source_remove(self.checker_callback_tag)
718
gobject.source_remove(self.checker_callback_tag)
1163
719
self.checker_callback_tag = None
1164
720
if getattr(self, "checker", None) is None:
1166
722
logger.debug("Stopping checker for %(name)s", vars(self))
1167
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
1168
731
self.checker = None
1171
def dbus_service_property(dbus_interface,
734
def dbus_service_property(dbus_interface, signature="v",
735
access="readwrite", byte_arrays=False):
1175
736
"""Decorators for marking methods of a DBusObjectWithProperties to
1176
737
become properties on the D-Bus.
1178
739
The decorated method will be called with no arguments by "Get"
1179
740
and with one argument by "Set".
1181
742
The parameters, where they are supported, are the same as
1182
743
dbus.service.method, except there is only "signature", since the
1183
744
type from Get() and the type sent to Set() is the same.
1266
class DBusObjectWithAnnotations(dbus.service.Object):
1267
"""A D-Bus object with annotations.
1269
Classes inheriting from this can use the dbus_annotations
1270
decorator to add annotations to methods or signals.
1274
def _is_dbus_thing(thing):
1275
"""Returns a function testing if an attribute is a D-Bus thing
1277
If called like _is_dbus_thing("method") it returns a function
1278
suitable for use as predicate to inspect.getmembers().
1280
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1283
def _get_all_dbus_things(self, thing):
1284
"""Returns a generator of (name, attribute) pairs
1286
return ((getattr(athing.__get__(self), "_dbus_name", name),
1287
athing.__get__(self))
1288
for cls in self.__class__.__mro__
1290
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1292
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1294
path_keyword='object_path',
1295
connection_keyword='connection')
1296
def Introspect(self, object_path, connection):
1297
"""Overloading of standard D-Bus method.
1299
Inserts annotation tags on methods and signals.
1301
xmlstring = dbus.service.Object.Introspect(self, object_path,
1304
document = xml.dom.minidom.parseString(xmlstring)
1306
for if_tag in document.getElementsByTagName("interface"):
1307
# Add annotation tags
1308
for typ in ("method", "signal"):
1309
for tag in if_tag.getElementsByTagName(typ):
1311
for name, prop in (self.
1312
_get_all_dbus_things(typ)):
1313
if (name == tag.getAttribute("name")
1314
and prop._dbus_interface
1315
== if_tag.getAttribute("name")):
1316
annots.update(getattr(
1317
prop, "_dbus_annotations", {}))
1318
for name, value in annots.items():
1319
ann_tag = document.createElement(
1321
ann_tag.setAttribute("name", name)
1322
ann_tag.setAttribute("value", value)
1323
tag.appendChild(ann_tag)
1324
# Add interface annotation tags
1325
for annotation, value in dict(
1326
itertools.chain.from_iterable(
1327
annotations().items()
1328
for name, annotations
1329
in self._get_all_dbus_things("interface")
1330
if name == if_tag.getAttribute("name")
1332
ann_tag = document.createElement("annotation")
1333
ann_tag.setAttribute("name", annotation)
1334
ann_tag.setAttribute("value", value)
1335
if_tag.appendChild(ann_tag)
1336
# Fix argument name for the Introspect method itself
1337
if (if_tag.getAttribute("name")
1338
== dbus.INTROSPECTABLE_IFACE):
1339
for cn in if_tag.getElementsByTagName("method"):
1340
if cn.getAttribute("name") == "Introspect":
1341
for arg in cn.getElementsByTagName("arg"):
1342
if (arg.getAttribute("direction")
1344
arg.setAttribute("name",
1346
xmlstring = document.toxml("utf-8")
1348
except (AttributeError, xml.dom.DOMException,
1349
xml.parsers.expat.ExpatError) as error:
1350
logger.error("Failed to override Introspection method",
1355
class DBusObjectWithProperties(DBusObjectWithAnnotations):
783
class DBusObjectWithProperties(dbus.service.Object):
1356
784
"""A D-Bus object with properties.
1358
786
Classes inheriting from this can use the dbus_service_property
1359
787
decorator to expose methods as D-Bus properties. It exposes the
1360
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))
1363
803
def _get_dbus_property(self, interface_name, property_name):
1364
804
"""Returns a bound method if one exists which is a D-Bus
1365
805
property with the specified name and interface.
1367
for cls in self.__class__.__mro__:
1368
for name, value in inspect.getmembers(
1369
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)):
1370
810
if (value._dbus_name == property_name
1371
811
and value._dbus_interface == interface_name):
1372
812
return value.__get__(self)
1374
814
# No such property
1375
raise DBusPropertyNotFound("{}:{}.{}".format(
1376
self.dbus_object_path, interface_name, property_name))
1379
def _get_all_interface_names(cls):
1380
"""Get a sequence of all interfaces supported by an object"""
1381
return (name for name in set(getattr(getattr(x, attr),
1382
"_dbus_interface", None)
1383
for x in (inspect.getmro(cls))
1385
if name is not None)
1387
@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",
1389
820
out_signature="v")
1390
821
def Get(self, interface_name, property_name):
1391
822
"""Standard D-Bus property Get() method, see D-Bus standard.
1516
914
except (AttributeError, xml.dom.DOMException,
1517
915
xml.parsers.expat.ExpatError) as error:
1518
916
logger.error("Failed to override Introspection method",
1524
dbus.OBJECT_MANAGER_IFACE
1525
except AttributeError:
1526
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1529
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1530
"""A D-Bus object with an ObjectManager.
1532
Classes inheriting from this exposes the standard
1533
GetManagedObjects call and the InterfacesAdded and
1534
InterfacesRemoved signals on the standard
1535
"org.freedesktop.DBus.ObjectManager" interface.
1537
Note: No signals are sent automatically; they must be sent
1540
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1541
out_signature="a{oa{sa{sv}}}")
1542
def GetManagedObjects(self):
1543
"""This function must be overridden"""
1544
raise NotImplementedError()
1546
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1547
signature="oa{sa{sv}}")
1548
def InterfacesAdded(self, object_path, interfaces_and_properties):
1551
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1552
def InterfacesRemoved(self, object_path, interfaces):
1555
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1557
path_keyword='object_path',
1558
connection_keyword='connection')
1559
def Introspect(self, object_path, connection):
1560
"""Overloading of standard D-Bus method.
1562
Override return argument name of GetManagedObjects to be
1563
"objpath_interfaces_and_properties"
1565
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1569
document = xml.dom.minidom.parseString(xmlstring)
1571
for if_tag in document.getElementsByTagName("interface"):
1572
# Fix argument name for the GetManagedObjects method
1573
if (if_tag.getAttribute("name")
1574
== dbus.OBJECT_MANAGER_IFACE):
1575
for cn in if_tag.getElementsByTagName("method"):
1576
if (cn.getAttribute("name")
1577
== "GetManagedObjects"):
1578
for arg in cn.getElementsByTagName("arg"):
1579
if (arg.getAttribute("direction")
1583
"objpath_interfaces"
1585
xmlstring = document.toxml("utf-8")
1587
except (AttributeError, xml.dom.DOMException,
1588
xml.parsers.expat.ExpatError) as error:
1589
logger.error("Failed to override Introspection method",
1594
def datetime_to_dbus(dt, variant_level=0):
921
def datetime_to_dbus (dt, variant_level=0):
1595
922
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1597
return dbus.String("", variant_level=variant_level)
1598
return dbus.String(dt.isoformat(), variant_level=variant_level)
1601
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1602
"""A class decorator; applied to a subclass of
1603
dbus.service.Object, it will add alternate D-Bus attributes with
1604
interface names according to the "alt_interface_names" mapping.
1607
@alternate_dbus_interfaces({"org.example.Interface":
1608
"net.example.AlternateInterface"})
1609
class SampleDBusObject(dbus.service.Object):
1610
@dbus.service.method("org.example.Interface")
1611
def SampleDBusMethod():
1614
The above "SampleDBusMethod" on "SampleDBusObject" will be
1615
reachable via two interfaces: "org.example.Interface" and
1616
"net.example.AlternateInterface", the latter of which will have
1617
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1618
"true", unless "deprecate" is passed with a False value.
1620
This works for methods and signals, and also for D-Bus properties
1621
(from DBusObjectWithProperties) and interfaces (from the
1622
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.
1626
for orig_interface_name, alt_interface_name in (
1627
alt_interface_names.items()):
1629
interface_names = set()
1630
# Go though all attributes of the class
1631
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):
1632
941
# Ignore non-D-Bus attributes, and D-Bus attributes
1633
942
# with the wrong interface name
1634
943
if (not hasattr(attribute, "_dbus_interface")
1635
or not attribute._dbus_interface.startswith(
1636
orig_interface_name)):
944
or not attribute._dbus_interface
945
.startswith("se.recompile.Mandos")):
1638
947
# Create an alternate D-Bus interface name based on
1639
948
# the current name
1640
alt_interface = attribute._dbus_interface.replace(
1641
orig_interface_name, alt_interface_name)
1642
interface_names.add(alt_interface)
949
alt_interface = (attribute._dbus_interface
950
.replace("se.recompile.Mandos",
951
"se.bsnet.fukt.Mandos"))
1643
952
# Is this a D-Bus signal?
1644
953
if getattr(attribute, "_dbus_is_signal", False):
1645
# Extract the original non-method undecorated
1646
# function by black magic
1647
if sys.version_info.major == 2:
1648
nonmethod_func = (dict(
954
# Extract the original non-method function by
956
nonmethod_func = (dict(
1649
957
zip(attribute.func_code.co_freevars,
1650
attribute.__closure__))
1651
["func"].cell_contents)
1653
nonmethod_func = (dict(
1654
zip(attribute.__code__.co_freevars,
1655
attribute.__closure__))
1656
["func"].cell_contents)
958
attribute.__closure__))["func"]
1657
960
# Create a new, but exactly alike, function
1658
961
# object, and decorate it to be a new D-Bus signal
1659
962
# with the alternate D-Bus interface name
1660
new_function = copy_function(nonmethod_func)
1661
new_function = (dbus.service.signal(
1663
attribute._dbus_signature)(new_function))
1664
# Copy annotations, if any
1666
new_function._dbus_annotations = dict(
1667
attribute._dbus_annotations)
1668
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)))
1671
972
# Define a creator of a function to call both the
1672
# original and alternate functions, so both the
1673
# original and alternate signals gets sent when
1674
# the function is called
973
# old and new functions, so both the old and new
974
# signals gets sent when the function is called
1675
975
def fixscope(func1, func2):
1676
976
"""This function is a scope container to pass
1677
977
func1 and func2 to the "call_both" function
1678
978
outside of its arguments"""
1680
@functools.wraps(func2)
1681
979
def call_both(*args, **kwargs):
1682
980
"""This function will emit two D-Bus
1683
981
signals by calling func1 and func2"""
1684
982
func1(*args, **kwargs)
1685
983
func2(*args, **kwargs)
1686
# Make wrapper function look like a D-Bus
1688
for name, attr in inspect.getmembers(func2):
1689
if name.startswith("_dbus_"):
1690
setattr(call_both, name, attr)
1692
984
return call_both
1693
985
# Create the "call_both" function and add it to
1695
attr[attrname] = fixscope(attribute, new_function)
987
attr[attrname] = fixscope(attribute,
1696
989
# Is this a D-Bus method?
1697
990
elif getattr(attribute, "_dbus_is_method", False):
1698
991
# Create a new, but exactly alike, function
1699
992
# object. Decorate it to be a new D-Bus method
1700
993
# with the alternate D-Bus interface name. Add it
1703
dbus.service.method(
1705
attribute._dbus_in_signature,
1706
attribute._dbus_out_signature)
1707
(copy_function(attribute)))
1708
# Copy annotations, if any
1710
attr[attrname]._dbus_annotations = dict(
1711
attribute._dbus_annotations)
1712
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)))
1714
1005
# Is this a D-Bus property?
1715
1006
elif getattr(attribute, "_dbus_is_property", False):
1716
1007
# Create a new, but exactly alike, function
1717
1008
# object, and decorate it to be a new D-Bus
1718
1009
# property with the alternate D-Bus interface
1719
1010
# name. Add it to the class.
1720
attr[attrname] = (dbus_service_property(
1721
alt_interface, attribute._dbus_signature,
1722
attribute._dbus_access,
1723
attribute._dbus_get_args_options
1725
(copy_function(attribute)))
1726
# Copy annotations, if any
1728
attr[attrname]._dbus_annotations = dict(
1729
attribute._dbus_annotations)
1730
except AttributeError:
1732
# Is this a D-Bus interface?
1733
elif getattr(attribute, "_dbus_is_interface", False):
1734
# Create a new, but exactly alike, function
1735
# object. Decorate it to be a new D-Bus interface
1736
# with the alternate D-Bus interface name. Add it
1739
dbus_interface_annotations(alt_interface)
1740
(copy_function(attribute)))
1742
# Deprecate all alternate interfaces
1743
iname = "_AlternateDBusNames_interface_annotation{}"
1744
for interface_name in interface_names:
1746
@dbus_interface_annotations(interface_name)
1748
return {"org.freedesktop.DBus.Deprecated":
1750
# Find an unused name
1751
for aname in (iname.format(i)
1752
for i in itertools.count()):
1753
if aname not in attr:
1757
# Replace the class with a new subclass of it with
1758
# methods, signals, etc. as created above.
1759
if sys.version_info.major == 2:
1760
cls = type(b"{}Alternate".format(cls.__name__),
1763
cls = type("{}Alternate".format(cls.__name__),
1770
@alternate_dbus_interfaces({"se.recompile.Mandos":
1771
"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)
1772
1027
class ClientDBus(Client, DBusObjectWithProperties):
1773
1028
"""A Client class using D-Bus
1776
1031
dbus_object_path: dbus.ObjectPath
1777
1032
bus: dbus.SystemBus()
1780
1035
runtime_expansions = (Client.runtime_expansions
1781
+ ("dbus_object_path", ))
1783
_interface = "se.recompile.Mandos.Client"
1036
+ ("dbus_object_path",))
1785
1038
# dbus.service.Object doesn't use super(), so we can't either.
1787
def __init__(self, bus=None, *args, **kwargs):
1040
def __init__(self, bus = None, *args, **kwargs):
1789
1042
Client.__init__(self, *args, **kwargs)
1043
self._approvals_pending = 0
1045
self._approvals_pending = 0
1790
1046
# Only now, when this client is initialized, can it show up on
1792
client_object_name = str(self.name).translate(
1048
client_object_name = unicode(self.name).translate(
1793
1049
{ord("."): ord("_"),
1794
1050
ord("-"): ord("_")})
1795
self.dbus_object_path = dbus.ObjectPath(
1796
"/clients/" + client_object_name)
1051
self.dbus_object_path = (dbus.ObjectPath
1052
("/clients/" + client_object_name))
1797
1053
DBusObjectWithProperties.__init__(self, self.bus,
1798
1054
self.dbus_object_path)
1800
def notifychangeproperty(transform_func, dbus_name,
1801
type_func=lambda x: x,
1803
invalidate_only=False,
1804
_interface=_interface):
1056
def notifychangeproperty(transform_func,
1057
dbus_name, type_func=lambda x: x,
1805
1059
""" Modify a variable so that it's a property which announces
1806
1060
its changes to DBus.
1808
1062
transform_fun: Function that takes a value and a variant_level
1809
1063
and transforms it to a D-Bus type.
1810
1064
dbus_name: D-Bus name of the variable
1812
1066
to the D-Bus. Default: no transform
1813
1067
variant_level: D-Bus variant level. Default: 1
1815
attrname = "_{}".format(dbus_name)
1069
attrname = "_{0}".format(dbus_name)
1817
1070
def setter(self, value):
1818
1071
if hasattr(self, "dbus_object_path"):
1819
1072
if (not hasattr(self, attrname) or
1820
1073
type_func(getattr(self, attrname, None))
1821
1074
!= type_func(value)):
1823
self.PropertiesChanged(
1824
_interface, dbus.Dictionary(),
1825
dbus.Array((dbus_name, )))
1827
dbus_value = transform_func(
1829
variant_level=variant_level)
1830
self.PropertyChanged(dbus.String(dbus_name),
1832
self.PropertiesChanged(
1834
dbus.Dictionary({dbus.String(dbus_name):
1075
dbus_value = transform_func(type_func(value),
1078
self.PropertyChanged(dbus.String(dbus_name),
1837
1080
setattr(self, attrname, value)
1839
1082
return property(lambda self: getattr(self, attrname), setter)
1841
1085
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1842
1086
approvals_pending = notifychangeproperty(dbus.Boolean,
1843
1087
"ApprovalPending",
1845
1089
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1846
1090
last_enabled = notifychangeproperty(datetime_to_dbus,
1848
checker = notifychangeproperty(
1849
dbus.Boolean, "CheckerRunning",
1850
type_func=lambda checker: checker is not None)
1092
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1093
type_func = lambda checker:
1094
checker is not None)
1851
1095
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1852
1096
"LastCheckedOK")
1853
last_checker_status = notifychangeproperty(dbus.Int16,
1854
"LastCheckerStatus")
1855
1097
last_approval_request = notifychangeproperty(
1856
1098
datetime_to_dbus, "LastApprovalRequest")
1857
1099
approved_by_default = notifychangeproperty(dbus.Boolean,
1858
1100
"ApprovedByDefault")
1859
approval_delay = notifychangeproperty(
1860
dbus.UInt64, "ApprovalDelay",
1861
type_func=lambda td: td.total_seconds() * 1000)
1101
approval_delay = notifychangeproperty(dbus.UInt64,
1104
timedelta_to_milliseconds)
1862
1105
approval_duration = notifychangeproperty(
1863
1106
dbus.UInt64, "ApprovalDuration",
1864
type_func=lambda td: td.total_seconds() * 1000)
1107
type_func = timedelta_to_milliseconds)
1865
1108
host = notifychangeproperty(dbus.String, "Host")
1866
timeout = notifychangeproperty(
1867
dbus.UInt64, "Timeout",
1868
type_func=lambda td: td.total_seconds() * 1000)
1109
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1111
timedelta_to_milliseconds)
1869
1112
extended_timeout = notifychangeproperty(
1870
1113
dbus.UInt64, "ExtendedTimeout",
1871
type_func=lambda td: td.total_seconds() * 1000)
1872
interval = notifychangeproperty(
1873
dbus.UInt64, "Interval",
1874
type_func=lambda td: td.total_seconds() * 1000)
1114
type_func = timedelta_to_milliseconds)
1115
interval = notifychangeproperty(dbus.UInt64,
1118
timedelta_to_milliseconds)
1875
1119
checker_command = notifychangeproperty(dbus.String, "Checker")
1876
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1877
invalidate_only=True)
1879
1121
del notifychangeproperty
1881
1123
def __del__(self, *args, **kwargs):
1883
1125
self.remove_from_connection()
1962
1205
server to mandos-client
1966
1209
# Rejected - signal
1967
1210
@dbus.service.signal(_interface, signature="s")
1968
1211
def Rejected(self, reason):
1972
1215
# NeedApproval - signal
1973
1216
@dbus.service.signal(_interface, signature="tb")
1974
1217
def NeedApproval(self, timeout, default):
1976
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.
1980
1231
# Approve - method
1981
1232
@dbus.service.method(_interface, in_signature="b")
1982
1233
def Approve(self, value):
1983
1234
self.approve(value)
1985
1236
# CheckedOK - method
1986
1237
@dbus.service.method(_interface)
1987
1238
def CheckedOK(self):
1988
1239
self.checked_ok()
1990
1241
# Enable - method
1991
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1992
1242
@dbus.service.method(_interface)
1993
1243
def Enable(self):
1997
1247
# StartChecker - method
1998
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1999
1248
@dbus.service.method(_interface)
2000
1249
def StartChecker(self):
2002
1251
self.start_checker()
2004
1253
# Disable - method
2005
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2006
1254
@dbus.service.method(_interface)
2007
1255
def Disable(self):
2011
1259
# StopChecker - method
2012
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2013
1260
@dbus.service.method(_interface)
2014
1261
def StopChecker(self):
2015
1262
self.stop_checker()
2019
1266
# ApprovalPending - property
2020
1267
@dbus_service_property(_interface, signature="b", access="read")
2021
1268
def ApprovalPending_dbus_property(self):
2022
1269
return dbus.Boolean(bool(self.approvals_pending))
2024
1271
# ApprovedByDefault - property
2025
@dbus_service_property(_interface,
1272
@dbus_service_property(_interface, signature="b",
2027
1273
access="readwrite")
2028
1274
def ApprovedByDefault_dbus_property(self, value=None):
2029
1275
if value is None: # get
2030
1276
return dbus.Boolean(self.approved_by_default)
2031
1277
self.approved_by_default = bool(value)
2033
1279
# ApprovalDelay - property
2034
@dbus_service_property(_interface,
1280
@dbus_service_property(_interface, signature="t",
2036
1281
access="readwrite")
2037
1282
def ApprovalDelay_dbus_property(self, value=None):
2038
1283
if value is None: # get
2039
return dbus.UInt64(self.approval_delay.total_seconds()
1284
return dbus.UInt64(self.approval_delay_milliseconds())
2041
1285
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2043
1287
# ApprovalDuration - property
2044
@dbus_service_property(_interface,
1288
@dbus_service_property(_interface, signature="t",
2046
1289
access="readwrite")
2047
1290
def ApprovalDuration_dbus_property(self, value=None):
2048
1291
if value is None: # get
2049
return dbus.UInt64(self.approval_duration.total_seconds()
1292
return dbus.UInt64(timedelta_to_milliseconds(
1293
self.approval_duration))
2051
1294
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2053
1296
# Name - property
2055
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2056
1297
@dbus_service_property(_interface, signature="s", access="read")
2057
1298
def Name_dbus_property(self):
2058
1299
return dbus.String(self.name)
2062
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2063
@dbus_service_property(_interface, signature="s", access="read")
2064
def KeyID_dbus_property(self):
2065
return dbus.String(self.key_id)
2067
1301
# Fingerprint - property
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
1302
@dbus_service_property(_interface, signature="s", access="read")
2071
1303
def Fingerprint_dbus_property(self):
2072
1304
return dbus.String(self.fingerprint)
2074
1306
# Host - property
2075
@dbus_service_property(_interface,
1307
@dbus_service_property(_interface, signature="s",
2077
1308
access="readwrite")
2078
1309
def Host_dbus_property(self, value=None):
2079
1310
if value is None: # get
2080
1311
return dbus.String(self.host)
2081
self.host = str(value)
1312
self.host = unicode(value)
2083
1314
# Created - property
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
1315
@dbus_service_property(_interface, signature="s", access="read")
2087
1316
def Created_dbus_property(self):
2088
1317
return datetime_to_dbus(self.created)
2090
1319
# LastEnabled - property
2091
1320
@dbus_service_property(_interface, signature="s", access="read")
2092
1321
def LastEnabled_dbus_property(self):
2093
1322
return datetime_to_dbus(self.last_enabled)
2095
1324
# Enabled - property
2096
@dbus_service_property(_interface,
1325
@dbus_service_property(_interface, signature="b",
2098
1326
access="readwrite")
2099
1327
def Enabled_dbus_property(self, value=None):
2100
1328
if value is None: # get
2107
1335
# LastCheckedOK - property
2108
@dbus_service_property(_interface,
1336
@dbus_service_property(_interface, signature="s",
2110
1337
access="readwrite")
2111
1338
def LastCheckedOK_dbus_property(self, value=None):
2112
1339
if value is not None:
2113
1340
self.checked_ok()
2115
1342
return datetime_to_dbus(self.last_checked_ok)
2117
# LastCheckerStatus - property
2118
@dbus_service_property(_interface, signature="n", access="read")
2119
def LastCheckerStatus_dbus_property(self):
2120
return dbus.Int16(self.last_checker_status)
2122
1344
# Expires - property
2123
1345
@dbus_service_property(_interface, signature="s", access="read")
2124
1346
def Expires_dbus_property(self):
2125
1347
return datetime_to_dbus(self.expires)
2127
1349
# LastApprovalRequest - property
2128
1350
@dbus_service_property(_interface, signature="s", access="read")
2129
1351
def LastApprovalRequest_dbus_property(self):
2130
1352
return datetime_to_dbus(self.last_approval_request)
2132
1354
# Timeout - property
2133
@dbus_service_property(_interface,
1355
@dbus_service_property(_interface, signature="t",
2135
1356
access="readwrite")
2136
1357
def Timeout_dbus_property(self, value=None):
2137
1358
if value is None: # get
2138
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2139
old_timeout = self.timeout
1359
return dbus.UInt64(self.timeout_milliseconds())
2140
1360
self.timeout = datetime.timedelta(0, 0, 0, value)
2141
# Reschedule disabling
2143
now = datetime.datetime.utcnow()
2144
self.expires += self.timeout - old_timeout
2145
if self.expires <= now:
2146
# The timeout has passed
2149
if (getattr(self, "disable_initiator_tag", None)
2152
GLib.source_remove(self.disable_initiator_tag)
2153
self.disable_initiator_tag = GLib.timeout_add(
2154
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))
2157
1382
# ExtendedTimeout - property
2158
@dbus_service_property(_interface,
1383
@dbus_service_property(_interface, signature="t",
2160
1384
access="readwrite")
2161
1385
def ExtendedTimeout_dbus_property(self, value=None):
2162
1386
if value is None: # get
2163
return dbus.UInt64(self.extended_timeout.total_seconds()
1387
return dbus.UInt64(self.extended_timeout_milliseconds())
2165
1388
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2167
1390
# Interval - property
2168
@dbus_service_property(_interface,
1391
@dbus_service_property(_interface, signature="t",
2170
1392
access="readwrite")
2171
1393
def Interval_dbus_property(self, value=None):
2172
1394
if value is None: # get
2173
return dbus.UInt64(self.interval.total_seconds() * 1000)
1395
return dbus.UInt64(self.interval_milliseconds())
2174
1396
self.interval = datetime.timedelta(0, 0, 0, value)
2175
1397
if getattr(self, "checker_initiator_tag", None) is None:
2177
1399
if self.enabled:
2178
1400
# Reschedule checker run
2179
GLib.source_remove(self.checker_initiator_tag)
2180
self.checker_initiator_tag = GLib.timeout_add(
2181
value, self.start_checker)
2182
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
2184
1406
# Checker - property
2185
@dbus_service_property(_interface,
1407
@dbus_service_property(_interface, signature="s",
2187
1408
access="readwrite")
2188
1409
def Checker_dbus_property(self, value=None):
2189
1410
if value is None: # get
2190
1411
return dbus.String(self.checker_command)
2191
self.checker_command = str(value)
1412
self.checker_command = unicode(value)
2193
1414
# CheckerRunning - property
2194
@dbus_service_property(_interface,
1415
@dbus_service_property(_interface, signature="b",
2196
1416
access="readwrite")
2197
1417
def CheckerRunning_dbus_property(self, value=None):
2198
1418
if value is None: # get
2239
1451
if data[0] == 'data':
2241
1453
if data[0] == 'function':
2243
1454
def func(*args, **kwargs):
2244
1455
self._pipe.send(('funcall', name, args, kwargs))
2245
1456
return self._pipe.recv()[1]
2249
1459
def __setattr__(self, name, value):
2250
1460
if name == '_pipe':
2251
1461
return super(ProxyClient, self).__setattr__(name, value)
2252
1462
self._pipe.send(('setattr', name, value))
1465
class ClientDBusTransitional(ClientDBus):
1466
__metaclass__ = AlternateDBusNamesMetaclass
2255
1469
class ClientHandler(socketserver.BaseRequestHandler, object):
2256
1470
"""A class to handle client connections.
2258
1472
Instantiated once for each connection to handle it.
2259
1473
Note: This will run in its own forked process."""
2261
1475
def handle(self):
2262
1476
with contextlib.closing(self.server.child_pipe) as child_pipe:
2263
1477
logger.info("TCP connection from: %s",
2264
str(self.client_address))
1478
unicode(self.client_address))
2265
1479
logger.debug("Pipe FD: %d",
2266
1480
self.server.child_pipe.fileno())
2268
session = gnutls.ClientSession(self.request)
2270
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2271
# "+AES-256-CBC", "+SHA1",
2272
# "+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",
2274
1496
# Use a fallback default, since this MUST be set.
2275
1497
priority = self.server.gnutls_priority
2276
1498
if priority is None:
2277
1499
priority = "NORMAL"
2278
gnutls.priority_set_direct(session._c_object,
2279
priority.encode("utf-8"),
1500
(gnutls.library.functions
1501
.gnutls_priority_set_direct(session._c_object,
2282
1504
# Start communication using the Mandos protocol
2283
1505
# Get protocol number
2284
1506
line = self.request.makefile().readline()
2285
1507
logger.debug("Protocol version: %r", line)
2287
1509
if int(line.strip().split()[0]) > 1:
2288
raise RuntimeError(line)
2289
1511
except (ValueError, IndexError, RuntimeError) as error:
2290
1512
logger.error("Unknown protocol version: %s", error)
2293
1515
# Start GnuTLS connection
2295
1517
session.handshake()
2296
except gnutls.Error as error:
1518
except gnutls.errors.GNUTLSError as error:
2297
1519
logger.warning("Handshake failed: %s", error)
2298
1520
# Do not run session.bye() here: the session is not
2299
1521
# established. Just abandon the request.
2301
1523
logger.debug("Handshake succeeded")
2303
1525
approval_required = False
2305
if gnutls.has_rawpk:
2308
key_id = self.key_id(
2309
self.peer_certificate(session))
2310
except (TypeError, gnutls.Error) as error:
2311
logger.warning("Bad certificate: %s", error)
2313
logger.debug("Key ID: %s", key_id)
2318
fpr = self.fingerprint(
2319
self.peer_certificate(session))
2320
except (TypeError, gnutls.Error) as error:
2321
logger.warning("Bad certificate: %s", error)
2323
logger.debug("Fingerprint: %s", fpr)
2326
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,
2327
1538
self.client_address)
2328
1539
except KeyError:
1542
if self.server.use_dbus:
1544
client.NewRequest(str(self.client_address))
2331
1546
if client.approval_delay:
2332
1547
delay = client.approval_delay
2333
1548
client.approvals_pending += 1
2334
1549
approval_required = True
2337
1552
if not client.enabled:
2338
1553
logger.info("Client %s is disabled",
2340
1555
if self.server.use_dbus:
2341
1556
# Emit D-Bus signal
2342
1557
client.Rejected("Disabled")
2345
1560
if client.approved or not client.approval_delay:
2346
# We are approved or approval is disabled
1561
#We are approved or approval is disabled
2348
1563
elif client.approved is None:
2349
1564
logger.info("Client %s needs approval",
2382
1599
delay -= time2 - time
2385
session.send(client.secret)
2386
except gnutls.Error as error:
2387
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))
2391
1613
logger.info("Sending secret to %s", client.name)
2392
1614
# bump the timeout using extended_timeout
2393
client.bump_timeout(client.extended_timeout)
1615
client.checked_ok(client.extended_timeout)
2394
1616
if self.server.use_dbus:
2395
1617
# Emit D-Bus signal
2396
1618
client.GotSecret()
2399
1621
if approval_required:
2400
1622
client.approvals_pending -= 1
2403
except gnutls.Error as error:
2404
logger.warning("GnuTLS bye failed",
1625
except gnutls.errors.GNUTLSError as error:
1626
logger.warning("GnuTLS bye failed")
2408
1629
def peer_certificate(session):
2409
"Return the peer's certificate as a bytestring"
2411
cert_type = gnutls.certificate_type_get2(session._c_object,
2413
except AttributeError:
2414
cert_type = gnutls.certificate_type_get(session._c_object)
2415
if gnutls.has_rawpk:
2416
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2418
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2419
# If not a valid certificate type...
2420
if cert_type not in valid_cert_types:
2421
logger.info("Cert type %r not in %r", cert_type,
2423
# ...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
2425
1637
list_size = ctypes.c_uint(1)
2426
cert_list = (gnutls.certificate_get_peers
1638
cert_list = (gnutls.library.functions
1639
.gnutls_certificate_get_peers
2427
1640
(session._c_object, ctypes.byref(list_size)))
2428
1641
if not bool(cert_list) and list_size.value != 0:
2429
raise gnutls.Error("error getting peer certificate")
1642
raise gnutls.errors.GNUTLSError("error getting peer"
2430
1644
if list_size.value == 0:
2432
1646
cert = cert_list[0]
2433
1647
return ctypes.string_at(cert.data, cert.size)
2436
def key_id(certificate):
2437
"Convert a certificate bytestring to a hexdigit key ID"
2438
# New GnuTLS "datum" with the public key
2439
datum = gnutls.datum_t(
2440
ctypes.cast(ctypes.c_char_p(certificate),
2441
ctypes.POINTER(ctypes.c_ubyte)),
2442
ctypes.c_uint(len(certificate)))
2443
# XXX all these need to be created in the gnutls "module"
2444
# New empty GnuTLS certificate
2445
pubkey = gnutls.pubkey_t()
2446
gnutls.pubkey_init(ctypes.byref(pubkey))
2447
# Import the raw public key into the certificate
2448
gnutls.pubkey_import(pubkey,
2449
ctypes.byref(datum),
2450
gnutls.X509_FMT_DER)
2451
# New buffer for the key ID
2452
buf = ctypes.create_string_buffer(32)
2453
buf_len = ctypes.c_size_t(len(buf))
2454
# Get the key ID from the raw public key into the buffer
2455
gnutls.pubkey_get_key_id(pubkey,
2456
gnutls.KEYID_USE_SHA256,
2457
ctypes.cast(ctypes.byref(buf),
2458
ctypes.POINTER(ctypes.c_ubyte)),
2459
ctypes.byref(buf_len))
2460
# Deinit the certificate
2461
gnutls.pubkey_deinit(pubkey)
2463
# Convert the buffer to a Python bytestring
2464
key_id = ctypes.string_at(buf, buf_len.value)
2465
# Convert the bytestring to hexadecimal notation
2466
hex_key_id = binascii.hexlify(key_id).upper()
2470
1650
def fingerprint(openpgp):
2471
1651
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2472
1652
# New GnuTLS "datum" with the OpenPGP public key
2473
datum = gnutls.datum_t(
2474
ctypes.cast(ctypes.c_char_p(openpgp),
2475
ctypes.POINTER(ctypes.c_ubyte)),
2476
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))))
2477
1658
# New empty GnuTLS certificate
2478
crt = gnutls.openpgp_crt_t()
2479
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)))
2480
1662
# Import the OpenPGP public key into the certificate
2481
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2482
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))
2483
1667
# Verify the self signature in the key
2484
1668
crtverify = ctypes.c_uint()
2485
gnutls.openpgp_crt_verify_self(crt, 0,
2486
ctypes.byref(crtverify))
1669
(gnutls.library.functions
1670
.gnutls_openpgp_crt_verify_self(crt, 0,
1671
ctypes.byref(crtverify)))
2487
1672
if crtverify.value != 0:
2488
gnutls.openpgp_crt_deinit(crt)
2489
raise gnutls.CertificateSecurityError(code
1673
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1674
raise (gnutls.errors.CertificateSecurityError
2491
1676
# New buffer for the fingerprint
2492
1677
buf = ctypes.create_string_buffer(20)
2493
1678
buf_len = ctypes.c_size_t()
2494
1679
# Get the fingerprint from the certificate into the buffer
2495
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2496
ctypes.byref(buf_len))
1680
(gnutls.library.functions
1681
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1682
ctypes.byref(buf_len)))
2497
1683
# Deinit the certificate
2498
gnutls.openpgp_crt_deinit(crt)
1684
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2499
1685
# Convert the buffer to a Python bytestring
2500
1686
fpr = ctypes.string_at(buf, buf_len.value)
2501
1687
# Convert the bytestring to hexadecimal notation
2506
class MultiprocessingMixIn:
1692
class MultiprocessingMixIn(object):
2507
1693
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2509
1694
def sub_process_main(self, request, address):
2511
1696
self.finish_request(request, address)
2512
1697
except Exception:
2513
1698
self.handle_error(request, address)
2514
1699
self.close_request(request)
2516
1701
def process_request(self, request, address):
2517
1702
"""Start a new process to process the request."""
2518
proc = multiprocessing.Process(target=self.sub_process_main,
2519
args=(request, address))
1703
proc = multiprocessing.Process(target = self.sub_process_main,
2524
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1710
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2525
1711
""" adds a pipe to the MixIn """
2527
1712
def process_request(self, request, client_address):
2528
1713
"""Overrides and wraps the original process_request().
2530
1715
This function creates a new pipe in self.pipe
2532
1717
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2534
1719
proc = MultiprocessingMixIn.process_request(self, request,
2535
1720
client_address)
2536
1721
self.child_pipe.close()
2537
1722
self.add_pipe(parent_pipe, proc)
2539
1724
def add_pipe(self, parent_pipe, proc):
2540
1725
"""Dummy function; override as necessary"""
2541
raise NotImplementedError()
1726
raise NotImplementedError
2544
1729
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2545
socketserver.TCPServer):
1730
socketserver.TCPServer, object):
2546
1731
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2549
1734
enabled: Boolean; whether this server is activated yet
2550
1735
interface: None or a network interface name (string)
2551
1736
use_ipv6: Boolean; to use IPv6 or not
2554
1738
def __init__(self, server_address, RequestHandlerClass,
2558
"""If socketfd is set, use that file descriptor instead of
2559
creating a new one with socket.socket().
1739
interface=None, use_ipv6=True):
2561
1740
self.interface = interface
2563
1742
self.address_family = socket.AF_INET6
2564
if socketfd is not None:
2565
# Save the file descriptor
2566
self.socketfd = socketfd
2567
# Save the original socket.socket() function
2568
self.socket_socket = socket.socket
2570
# To implement --socket, we monkey patch socket.socket.
2572
# (When socketserver.TCPServer is a new-style class, we
2573
# could make self.socket into a property instead of monkey
2574
# patching socket.socket.)
2576
# Create a one-time-only replacement for socket.socket()
2577
@functools.wraps(socket.socket)
2578
def socket_wrapper(*args, **kwargs):
2579
# Restore original function so subsequent calls are
2581
socket.socket = self.socket_socket
2582
del self.socket_socket
2583
# This time only, return a new socket object from the
2584
# saved file descriptor.
2585
return socket.fromfd(self.socketfd, *args, **kwargs)
2586
# Replace socket.socket() function with wrapper
2587
socket.socket = socket_wrapper
2588
# The socketserver.TCPServer.__init__ will call
2589
# socket.socket(), which might be our replacement,
2590
# socket_wrapper(), if socketfd was set.
2591
1743
socketserver.TCPServer.__init__(self, server_address,
2592
1744
RequestHandlerClass)
2594
1745
def server_bind(self):
2595
1746
"""This overrides the normal server_bind() function
2596
1747
to bind to an interface if one was specified, and also NOT to
2597
1748
bind to an address or port if they were not specified."""
2598
global SO_BINDTODEVICE
2599
1749
if self.interface is not None:
2600
1750
if SO_BINDTODEVICE is None:
2601
# Fall back to a hard-coded value which seems to be
2603
logger.warning("SO_BINDTODEVICE not found, trying 25")
2604
SO_BINDTODEVICE = 25
2606
self.socket.setsockopt(
2607
socket.SOL_SOCKET, SO_BINDTODEVICE,
2608
(self.interface + "\0").encode("utf-8"))
2609
except socket.error as error:
2610
if error.errno == errno.EPERM:
2611
logger.error("No permission to bind to"
2612
" interface %s", self.interface)
2613
elif error.errno == errno.ENOPROTOOPT:
2614
logger.error("SO_BINDTODEVICE not available;"
2615
" cannot bind to interface %s",
2617
elif error.errno == errno.ENODEV:
2618
logger.error("Interface %s does not exist,"
2619
" 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",
2622
1771
# Only bind(2) the socket if we really need to.
2623
1772
if self.server_address[0] or self.server_address[1]:
2624
if self.server_address[1]:
2625
self.allow_reuse_address = True
2626
1773
if not self.server_address[0]:
2627
1774
if self.address_family == socket.AF_INET6:
2628
any_address = "::" # in6addr_any
1775
any_address = "::" # in6addr_any
2630
any_address = "0.0.0.0" # INADDR_ANY
1777
any_address = socket.INADDR_ANY
2631
1778
self.server_address = (any_address,
2632
1779
self.server_address[1])
2633
1780
elif not self.server_address[1]:
2634
self.server_address = (self.server_address[0], 0)
1781
self.server_address = (self.server_address[0],
2635
1783
# if self.interface:
2636
1784
# self.server_address = (self.server_address[0],
2740
1888
funcname = request[1]
2741
1889
args = request[2]
2742
1890
kwargs = request[3]
2744
1892
parent_pipe.send(('data', getattr(client_object,
2745
1893
funcname)(*args,
2748
1896
if command == 'getattr':
2749
1897
attrname = request[1]
2750
if isinstance(client_object.__getattribute__(attrname),
2751
collections.Callable):
2752
parent_pipe.send(('function', ))
1898
if callable(client_object.__getattribute__(attrname)):
1899
parent_pipe.send(('function',))
2755
'data', client_object.__getattribute__(attrname)))
1901
parent_pipe.send(('data', client_object
1902
.__getattribute__(attrname)))
2757
1904
if command == 'setattr':
2758
1905
attrname = request[1]
2759
1906
value = request[2]
2760
1907
setattr(client_object, attrname, value)
2765
def rfc3339_duration_to_delta(duration):
2766
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2768
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2770
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2772
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2774
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2776
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2778
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2780
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2784
# Parsing an RFC 3339 duration with regular expressions is not
2785
# possible - there would have to be multiple places for the same
2786
# values, like seconds. The current code, while more esoteric, is
2787
# cleaner without depending on a parsing library. If Python had a
2788
# built-in library for parsing we would use it, but we'd like to
2789
# avoid excessive use of external libraries.
2791
# New type for defining tokens, syntax, and semantics all-in-one
2792
Token = collections.namedtuple("Token", (
2793
"regexp", # To match token; if "value" is not None, must have
2794
# a "group" containing digits
2795
"value", # datetime.timedelta or None
2796
"followers")) # Tokens valid after this token
2797
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2798
# the "duration" ABNF definition in RFC 3339, Appendix A.
2799
token_end = Token(re.compile(r"$"), None, frozenset())
2800
token_second = Token(re.compile(r"(\d+)S"),
2801
datetime.timedelta(seconds=1),
2802
frozenset((token_end, )))
2803
token_minute = Token(re.compile(r"(\d+)M"),
2804
datetime.timedelta(minutes=1),
2805
frozenset((token_second, token_end)))
2806
token_hour = Token(re.compile(r"(\d+)H"),
2807
datetime.timedelta(hours=1),
2808
frozenset((token_minute, token_end)))
2809
token_time = Token(re.compile(r"T"),
2811
frozenset((token_hour, token_minute,
2813
token_day = Token(re.compile(r"(\d+)D"),
2814
datetime.timedelta(days=1),
2815
frozenset((token_time, token_end)))
2816
token_month = Token(re.compile(r"(\d+)M"),
2817
datetime.timedelta(weeks=4),
2818
frozenset((token_day, token_end)))
2819
token_year = Token(re.compile(r"(\d+)Y"),
2820
datetime.timedelta(weeks=52),
2821
frozenset((token_month, token_end)))
2822
token_week = Token(re.compile(r"(\d+)W"),
2823
datetime.timedelta(weeks=1),
2824
frozenset((token_end, )))
2825
token_duration = Token(re.compile(r"P"), None,
2826
frozenset((token_year, token_month,
2827
token_day, token_time,
2829
# Define starting values:
2831
value = datetime.timedelta()
2833
# Following valid tokens
2834
followers = frozenset((token_duration, ))
2835
# String left to parse
2837
# Loop until end token is found
2838
while found_token is not token_end:
2839
# Search for any currently valid tokens
2840
for token in followers:
2841
match = token.regexp.match(s)
2842
if match is not None:
2844
if token.value is not None:
2845
# Value found, parse digits
2846
factor = int(match.group(1), 10)
2847
# Add to value so far
2848
value += factor * token.value
2849
# Strip token from string
2850
s = token.regexp.sub("", s, 1)
2853
# Set valid next tokens
2854
followers = found_token.followers
2857
# No currently valid tokens were found
2858
raise ValueError("Invalid RFC 3339 duration: {!r}"
2864
1912
def string_to_delta(interval):
2865
1913
"""Parse a string and return a datetime.timedelta
2867
>>> string_to_delta('7d') == datetime.timedelta(7)
2869
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2871
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2873
>>> string_to_delta('24h') == datetime.timedelta(1)
2875
>>> string_to_delta('1w') == datetime.timedelta(7)
2877
>>> 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)
2882
return rfc3339_duration_to_delta(interval)
2886
1928
timevalue = datetime.timedelta(0)
2887
1929
for s in interval.split():
1931
suffix = unicode(s[-1])
2890
1932
value = int(s[:-1])
2891
1933
if suffix == "d":
2892
1934
delta = datetime.timedelta(value)
2964
2006
parser.add_argument("--no-dbus", action="store_false",
2965
2007
dest="use_dbus", help="Do not provide D-Bus"
2966
" system bus interface", default=None)
2008
" system bus interface")
2967
2009
parser.add_argument("--no-ipv6", action="store_false",
2968
dest="use_ipv6", help="Do not use IPv6",
2010
dest="use_ipv6", help="Do not use IPv6")
2970
2011
parser.add_argument("--no-restore", action="store_false",
2971
2012
dest="restore", help="Do not restore stored"
2972
" state", default=None)
2973
parser.add_argument("--socket", type=int,
2974
help="Specify a file descriptor to a network"
2975
" socket to use instead of creating one")
2976
2014
parser.add_argument("--statedir", metavar="DIR",
2977
2015
help="Directory to save/restore state in")
2978
parser.add_argument("--foreground", action="store_true",
2979
help="Run in foreground", default=None)
2980
parser.add_argument("--no-zeroconf", action="store_false",
2981
dest="zeroconf", help="Do not use Zeroconf",
2984
2017
options = parser.parse_args()
2986
2024
# Default values for config file for server-global settings
2987
if gnutls.has_rawpk:
2988
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2989
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2991
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2992
":+SIGN-DSA-SHA256")
2993
server_defaults = {"interface": "",
2997
"priority": priority,
2998
"servicename": "Mandos",
3004
"statedir": "/var/lib/mandos",
3005
"foreground": "False",
2025
server_defaults = { "interface": "",
2030
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2031
"servicename": "Mandos",
2036
"statedir": "/var/lib/mandos"
3010
2039
# Parse config file for server-global settings
3011
server_config = configparser.ConfigParser(server_defaults)
2040
server_config = configparser.SafeConfigParser(server_defaults)
3012
2041
del server_defaults
3013
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3014
# Convert the ConfigParser object to a dict
2042
server_config.read(os.path.join(options.configdir,
2044
# Convert the SafeConfigParser object to a dict
3015
2045
server_settings = server_config.defaults()
3016
2046
# Use the appropriate methods on the non-string config options
3017
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3018
"foreground", "zeroconf"):
2047
for option in ("debug", "use_dbus", "use_ipv6"):
3019
2048
server_settings[option] = server_config.getboolean("DEFAULT",
3021
2050
if server_settings["port"]:
3022
2051
server_settings["port"] = server_config.getint("DEFAULT",
3024
if server_settings["socket"]:
3025
server_settings["socket"] = server_config.getint("DEFAULT",
3027
# Later, stdin will, and stdout and stderr might, be dup'ed
3028
# over with an opened os.devnull. But we don't want this to
3029
# happen with a supplied network socket.
3030
if 0 <= server_settings["socket"] <= 2:
3031
server_settings["socket"] = os.dup(server_settings
3033
2053
del server_config
3035
2055
# Override the settings from the config file with command line
3036
2056
# options, if set.
3037
2057
for option in ("interface", "address", "port", "debug",
3038
"priority", "servicename", "configdir", "use_dbus",
3039
"use_ipv6", "debuglevel", "restore", "statedir",
3040
"socket", "foreground", "zeroconf"):
2058
"priority", "servicename", "configdir",
2059
"use_dbus", "use_ipv6", "debuglevel", "restore",
3041
2061
value = getattr(options, option)
3042
2062
if value is not None:
3043
2063
server_settings[option] = value
3045
2065
# Force all strings to be unicode
3046
2066
for option in server_settings.keys():
3047
if isinstance(server_settings[option], bytes):
3048
server_settings[option] = (server_settings[option]
3050
# Force all boolean options to be boolean
3051
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3052
"foreground", "zeroconf"):
3053
server_settings[option] = bool(server_settings[option])
3054
# Debug implies foreground
3055
if server_settings["debug"]:
3056
server_settings["foreground"] = True
2067
if type(server_settings[option]) is str:
2068
server_settings[option] = unicode(server_settings[option])
3057
2069
# Now we have our good server settings in "server_settings"
3059
2071
##################################################################
3061
if (not server_settings["zeroconf"]
3062
and not (server_settings["port"]
3063
or server_settings["socket"] != "")):
3064
parser.error("Needs port or socket to work without Zeroconf")
3066
2073
# For convenience
3067
2074
debug = server_settings["debug"]
3068
2075
debuglevel = server_settings["debuglevel"]
3082
2087
level = getattr(logging, debuglevel.upper())
3083
2088
initlogger(debug, level)
3085
2090
if server_settings["servicename"] != "Mandos":
3086
syslogger.setFormatter(
3087
logging.Formatter('Mandos ({}) [%(process)d]:'
3088
' %(levelname)s: %(message)s'.format(
3089
server_settings["servicename"])))
2091
syslogger.setFormatter(logging.Formatter
2092
('Mandos (%s) [%%(process)d]:'
2093
' %%(levelname)s: %%(message)s'
2094
% server_settings["servicename"]))
3091
2096
# Parse config file with clients
3092
client_config = configparser.ConfigParser(Client.client_defaults)
2097
client_config = configparser.SafeConfigParser(Client.client_defaults)
3093
2098
client_config.read(os.path.join(server_settings["configdir"],
3094
2099
"clients.conf"))
3096
2101
global mandos_dbus_service
3097
2102
mandos_dbus_service = None
3100
if server_settings["socket"] != "":
3101
socketfd = server_settings["socket"]
3102
tcp_server = MandosServer(
3103
(server_settings["address"], server_settings["port"]),
3105
interface=(server_settings["interface"] or None),
3107
gnutls_priority=server_settings["priority"],
3111
pidfilename = "/run/mandos.pid"
3112
if not os.path.isdir("/run/."):
3113
pidfilename = "/var/run/mandos.pid"
3116
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3117
except IOError as e:
3118
logger.error("Could not open file %r", pidfilename,
3121
for name, group in (("_mandos", "_mandos"),
3122
("mandos", "mandos"),
3123
("nobody", "nogroup")):
3125
uid = pwd.getpwnam(name).pw_uid
3126
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
3128
2127
except KeyError:
2129
uid = pwd.getpwnam("nobody").pw_uid
2130
gid = pwd.getpwnam("nobody").pw_gid
3137
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3139
2137
except OSError as error:
3140
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3141
.format(uid, gid, os.strerror(error.errno)))
3142
if error.errno != errno.EPERM:
2138
if error[0] != errno.EPERM:
3146
2142
# Enable all possible GnuTLS debugging
3148
2144
# "Use a log level over 10 to enable all debugging options."
3149
2145
# - GnuTLS manual
3150
gnutls.global_set_log_level(11)
2146
gnutls.library.functions.gnutls_global_set_log_level(11)
2148
@gnutls.library.types.gnutls_log_func
3153
2149
def debug_gnutls(level, string):
3154
2150
logger.debug("GnuTLS: %s", string[:-1])
3156
gnutls.global_set_log_function(debug_gnutls)
2152
(gnutls.library.functions
2153
.gnutls_global_set_log_function(debug_gnutls))
3158
2155
# Redirect stdin so all checkers get /dev/null
3159
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3160
2157
os.dup2(null, sys.stdin.fileno())
3164
2161
# Need to fork before connecting to D-Bus
3166
2163
# Close all input and output, do double fork, etc.
3169
if gi.version_info < (3, 10, 2):
3170
# multiprocessing will use threads, so before we use GLib we
3171
# need to inform GLib that threads will be used.
2166
gobject.threads_init()
3174
2168
global main_loop
3175
2169
# From the Avahi example code
3176
DBusGMainLoop(set_as_default=True)
3177
main_loop = GLib.MainLoop()
2170
DBusGMainLoop(set_as_default=True )
2171
main_loop = gobject.MainLoop()
3178
2172
bus = dbus.SystemBus()
3179
2173
# End of Avahi example code
3182
2176
bus_name = dbus.service.BusName("se.recompile.Mandos",
3185
old_bus_name = dbus.service.BusName(
3186
"se.bsnet.fukt.Mandos", bus,
3188
except dbus.exceptions.DBusException as e:
3189
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")
3190
2183
use_dbus = False
3191
2184
server_settings["use_dbus"] = False
3192
2185
tcp_server.use_dbus = False
3194
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3195
service = AvahiServiceToSyslog(
3196
name=server_settings["servicename"],
3197
servicetype="_mandos._tcp",
3200
if server_settings["interface"]:
3201
service.interface = if_nametoindex(
3202
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"])))
3204
2195
global multiprocessing_manager
3205
2196
multiprocessing_manager = multiprocessing.Manager()
3207
2198
client_class = Client
3209
client_class = functools.partial(ClientDBus, bus=bus)
2200
client_class = functools.partial(ClientDBusTransitional,
3211
2203
client_settings = Client.config_parser(client_config)
3212
2204
old_client_settings = {}
3213
2205
clients_data = {}
3215
# This is used to redirect stdout and stderr for checker processes
3217
wnull = open(os.devnull, "w") # A writable /dev/null
3218
# Only used if server is running in foreground but not in debug
3220
if debug or not foreground:
3223
2207
# Get client data and settings from last running state.
3224
2208
if server_settings["restore"]:
3226
2210
with open(stored_state_path, "rb") as stored_state:
3227
if sys.version_info.major == 2:
3228
clients_data, old_client_settings = pickle.load(
3231
bytes_clients_data, bytes_old_client_settings = (
3232
pickle.load(stored_state, encoding="bytes"))
3233
# Fix bytes to strings
3236
clients_data = {(key.decode("utf-8")
3237
if isinstance(key, bytes)
3240
bytes_clients_data.items()}
3241
del bytes_clients_data
3242
for key in clients_data:
3243
value = {(k.decode("utf-8")
3244
if isinstance(k, bytes) else k): v
3246
clients_data[key].items()}
3247
clients_data[key] = value
3249
value["client_structure"] = [
3251
if isinstance(s, bytes)
3253
value["client_structure"]]
3254
# .name, .host, and .checker_command
3255
for k in ("name", "host", "checker_command"):
3256
if isinstance(value[k], bytes):
3257
value[k] = value[k].decode("utf-8")
3258
if "key_id" not in value:
3259
value["key_id"] = ""
3260
elif "fingerprint" not in value:
3261
value["fingerprint"] = ""
3262
# old_client_settings
3264
old_client_settings = {
3265
(key.decode("utf-8")
3266
if isinstance(key, bytes)
3269
bytes_old_client_settings.items()}
3270
del bytes_old_client_settings
3271
# .host and .checker_command
3272
for value in old_client_settings.values():
3273
for attribute in ("host", "checker_command"):
3274
if isinstance(value[attribute], bytes):
3275
value[attribute] = (value[attribute]
2211
clients_data, old_client_settings = (pickle.load
3277
2213
os.remove(stored_state_path)
3278
2214
except IOError as e:
3279
if e.errno == errno.ENOENT:
3280
logger.warning("Could not load persistent state:"
3281
" {}".format(os.strerror(e.errno)))
3283
logger.critical("Could not load persistent state:",
2215
logger.warning("Could not load persistent state: {0}"
2217
if e.errno != errno.ENOENT:
3286
2219
except EOFError as e:
3287
2220
logger.warning("Could not load persistent state: "
2221
"EOFError: {0}".format(e))
3291
2223
with PGPEngine() as pgp:
3292
for client_name, client in clients_data.items():
3293
# Skip removed clients
3294
if client_name not in client_settings:
2224
for client_name, client in clients_data.iteritems():
3297
2225
# Decide which value to use after restoring saved state.
3298
2226
# We have three different values: Old config file,
3299
2227
# new config file, and saved state.
3304
2232
# For each value in new config, check if it
3305
2233
# differs from the old config value (Except for
3306
2234
# the "secret" attribute)
3307
if (name != "secret"
3309
old_client_settings[client_name][name])):
2235
if (name != "secret" and
2236
value != old_client_settings[client_name]
3310
2238
client[name] = value
3311
2239
except KeyError:
3314
2242
# Clients who has passed its expire date can still be
3315
# enabled if its last checker was successful. A Client
3316
# whose checker succeeded before we stored its state is
3317
# 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.
3319
2246
if client["enabled"]:
3320
2247
if datetime.datetime.utcnow() >= client["expires"]:
3321
2248
if not client["last_checked_ok"]:
3322
2249
logger.warning(
3323
"disabling client {} - Client never "
3324
"performed a successful checker".format(
2250
"disabling client {0} - Client never "
2251
"performed a successfull checker"
2252
.format(client["name"]))
3326
2253
client["enabled"] = False
3327
2254
elif client["last_checker_status"] != 0:
3328
2255
logger.warning(
3329
"disabling client {} - Client last"
3330
" checker failed with error code"
3333
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"]))
3334
2260
client["enabled"] = False
3336
client["expires"] = (
3337
datetime.datetime.utcnow()
3338
+ client["timeout"])
3339
logger.debug("Last checker succeeded,"
3340
" keeping {} enabled".format(
2262
client["expires"] = (datetime.datetime
2264
+ client["timeout"])
3343
client["secret"] = pgp.decrypt(
3344
client["encrypted_secret"],
3345
client_settings[client_name]["secret"])
2267
client["secret"] = (
2268
pgp.decrypt(client["encrypted_secret"],
2269
client_settings[client_name]
3346
2271
except PGPError:
3347
2272
# If decryption fails, we use secret from new settings
3348
logger.debug("Failed to decrypt {} old secret".format(
3350
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"])
3353
2279
# Add/remove clients based on new changes made to config
3354
for client_name in (set(old_client_settings)
3355
- set(client_settings)):
2280
for client_name in set(old_client_settings) - set(client_settings):
3356
2281
del clients_data[client_name]
3357
for client_name in (set(client_settings)
3358
- set(old_client_settings)):
2282
for client_name in set(client_settings) - set(old_client_settings):
3359
2283
clients_data[client_name] = client_settings[client_name]
3361
# Create all client objects
3362
for client_name, client in clients_data.items():
2285
# Create clients all clients
2286
for client_name, client in clients_data.iteritems():
3363
2287
tcp_server.clients[client_name] = client_class(
3366
server_settings=server_settings)
2288
name = client_name, settings = client)
3368
2290
if not tcp_server.clients:
3369
2291
logger.warning("No clients defined")
3372
if pidfile is not None:
3376
print(pid, file=pidfile)
3378
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
3381
2305
del pidfilename
3383
for termsig in (signal.SIGHUP, signal.SIGTERM):
3384
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3385
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())
3389
@alternate_dbus_interfaces(
3390
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3391
class MandosDBusService(DBusObjectWithObjectManager):
2312
class MandosDBusService(dbus.service.Object):
3392
2313
"""A D-Bus proxy object"""
3394
2314
def __init__(self):
3395
2315
dbus.service.Object.__init__(self, bus, "/")
3397
2316
_interface = "se.recompile.Mandos"
3399
2318
@dbus.service.signal(_interface, signature="o")
3400
2319
def ClientAdded(self, objpath):
3404
2323
@dbus.service.signal(_interface, signature="ss")
3405
def ClientNotFound(self, key_id, address):
2324
def ClientNotFound(self, fingerprint, address):
3409
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3411
2328
@dbus.service.signal(_interface, signature="os")
3412
2329
def ClientRemoved(self, objpath, name):
3416
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3418
2333
@dbus.service.method(_interface, out_signature="ao")
3419
2334
def GetAllClients(self):
3421
return dbus.Array(c.dbus_object_path for c in
3422
tcp_server.clients.values())
3424
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2336
return dbus.Array(c.dbus_object_path
2338
tcp_server.clients.itervalues())
3426
2340
@dbus.service.method(_interface,
3427
2341
out_signature="a{oa{sv}}")
3428
2342
def GetAllClientsWithProperties(self):
3430
2344
return dbus.Dictionary(
3431
{c.dbus_object_path: c.GetAll(
3432
"se.recompile.Mandos.Client")
3433
for c in tcp_server.clients.values()},
2345
((c.dbus_object_path, c.GetAll(""))
2346
for c in tcp_server.clients.itervalues()),
3434
2347
signature="oa{sv}")
3436
2349
@dbus.service.method(_interface, in_signature="o")
3437
2350
def RemoveClient(self, object_path):
3439
for c in tcp_server.clients.values():
2352
for c in tcp_server.clients.itervalues():
3440
2353
if c.dbus_object_path == object_path:
3441
2354
del tcp_server.clients[c.name]
3442
2355
c.remove_from_connection()
3443
# Don't signal the disabling
2356
# Don't signal anything except ClientRemoved
3444
2357
c.disable(quiet=True)
3445
# Emit D-Bus signal for removal
3446
self.client_removed_signal(c)
2359
self.ClientRemoved(object_path, c.name)
3448
2361
raise KeyError(object_path)
3452
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3453
out_signature="a{oa{sa{sv}}}")
3454
def GetManagedObjects(self):
3456
return dbus.Dictionary(
3457
{client.dbus_object_path:
3459
{interface: client.GetAll(interface)
3461
client._get_all_interface_names()})
3462
for client in tcp_server.clients.values()})
3464
def client_added_signal(self, client):
3465
"""Send the new standard signal and the old signal"""
3467
# New standard signal
3468
self.InterfacesAdded(
3469
client.dbus_object_path,
3471
{interface: client.GetAll(interface)
3473
client._get_all_interface_names()}))
3475
self.ClientAdded(client.dbus_object_path)
3477
def client_removed_signal(self, client):
3478
"""Send the new standard signal and the old signal"""
3480
# New standard signal
3481
self.InterfacesRemoved(
3482
client.dbus_object_path,
3483
client._get_all_interface_names())
3485
self.ClientRemoved(client.dbus_object_path,
3488
mandos_dbus_service = MandosDBusService()
3490
# Save modules to variables to exempt the modules from being
3491
# unloaded before the function registered with atexit() is run.
3492
mp = multiprocessing
2365
class MandosDBusServiceTransitional(MandosDBusService):
2366
__metaclass__ = AlternateDBusNamesMetaclass
2367
mandos_dbus_service = MandosDBusServiceTransitional()
3496
2370
"Cleanup function; run on exit"
3500
mp.active_children()
2373
multiprocessing.active_children()
3502
2374
if not (tcp_server.clients or client_settings):
3505
2377
# Store client before exiting. Secrets are encrypted with key
3506
2378
# based on what config file has. If config file is
3507
2379
# removed/edited, old secret will thus be unrecovable.
3509
2381
with PGPEngine() as pgp:
3510
for client in tcp_server.clients.values():
2382
for client in tcp_server.clients.itervalues():
3511
2383
key = client_settings[client.name]["secret"]
3512
2384
client.encrypted_secret = pgp.encrypt(client.secret,
3514
2386
client_dict = {}
3516
2388
# A list of attributes that can not be pickled
3518
exclude = {"bus", "changedstate", "secret",
3519
"checker", "server_settings"}
3520
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)):
3522
2394
exclude.add(name)
3524
2396
client_dict["encrypted_secret"] = (client
3525
2397
.encrypted_secret)
3526
2398
for attr in client.client_structure:
3527
2399
if attr not in exclude:
3528
2400
client_dict[attr] = getattr(client, attr)
3530
2402
clients[client.name] = client_dict
3531
2403
del client_settings[client.name]["secret"]
3534
with tempfile.NamedTemporaryFile(
3538
dir=os.path.dirname(stored_state_path),
3539
delete=False) as stored_state:
3540
pickle.dump((clients, client_settings), stored_state,
3542
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)
3543
2412
os.rename(tempname, stored_state_path)
3544
2413
except (IOError, OSError) as e:
2414
logger.warning("Could not save persistent state: {0}"
3547
2418
os.remove(tempname)
3548
2419
except NameError:
3550
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3551
logger.warning("Could not save persistent state: {}"
3552
.format(os.strerror(e.errno)))
3554
logger.warning("Could not save persistent state:",
2421
if e.errno not in set((errno.ENOENT, errno.EACCES,
3558
2425
# Delete all clients, and settings from config
3559
2426
while tcp_server.clients:
3560
2427
name, client = tcp_server.clients.popitem()
3562
2429
client.remove_from_connection()
3563
# Don't signal the disabling
2430
# Don't signal anything except ClientRemoved
3564
2431
client.disable(quiet=True)
3565
# Emit D-Bus signal for removal
3567
mandos_dbus_service.client_removed_signal(client)
2434
mandos_dbus_service.ClientRemoved(client
3568
2437
client_settings.clear()
3570
2439
atexit.register(cleanup)
3572
for client in tcp_server.clients.values():
2441
for client in tcp_server.clients.itervalues():
3574
# Emit D-Bus signal for adding
3575
mandos_dbus_service.client_added_signal(client)
2444
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3576
2445
# Need to initiate checking of clients
3577
2446
if client.enabled:
3578
2447
client.init_checker()
3580
2449
tcp_server.enable()
3581
2450
tcp_server.server_activate()
3583
2452
# Find out what port we got
3585
service.port = tcp_server.socket.getsockname()[1]
2453
service.port = tcp_server.socket.getsockname()[1]
3587
2455
logger.info("Now listening on address %r, port %d,"
3588
" flowinfo %d, scope_id %d",
3589
*tcp_server.socket.getsockname())
2456
" flowinfo %d, scope_id %d"
2457
% tcp_server.socket.getsockname())
3591
logger.info("Now listening on address %r, port %d",
3592
*tcp_server.socket.getsockname())
3594
# 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]
3598
# From the Avahi example code
3601
except dbus.exceptions.DBusException as error:
3602
logger.critical("D-Bus Exception", exc_info=error)
3605
# End of Avahi example code
3608
GLib.IOChannel.unix_new(tcp_server.fileno()),
3609
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3610
lambda *args, **kwargs: (tcp_server.handle_request
3611
(*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))
3613
2479
logger.debug("Starting main loop")
3614
2480
main_loop.run()
3615
2481
except AvahiError as error:
3616
logger.critical("Avahi Error", exc_info=error)
2482
logger.critical("AvahiError: %s", error)
3619
2485
except KeyboardInterrupt: