167
248
os.rmdir(self.tempdir)
168
249
self.tempdir = None
170
251
def password_encode(self, password):
171
252
# Passphrase can not be empty and can not contain newlines or
172
253
# NUL bytes. So we prefix it and hex encode it.
173
return b"mandos" + binascii.hexlify(password)
254
encoded = b"mandos" + binascii.hexlify(password)
255
if len(encoded) > 2048:
256
# GnuPG can't handle long passwords, so encode differently
257
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
258
.replace(b"\n", b"\\n")
259
.replace(b"\0", b"\\x00"))
175
262
def encrypt(self, data, password):
176
self.gnupg.passphrase = self.password_encode(password)
177
with open(os.devnull) as devnull:
179
proc = self.gnupg.run(['--symmetric'],
180
create_fhs=['stdin', 'stdout'],
181
attach_fhs={'stderr': devnull})
182
with contextlib.closing(proc.handles['stdin']) as f:
184
with contextlib.closing(proc.handles['stdout']) as f:
185
ciphertext = f.read()
189
self.gnupg.passphrase = None
263
passphrase = self.password_encode(password)
264
with tempfile.NamedTemporaryFile(
265
dir=self.tempdir) as passfile:
266
passfile.write(passphrase)
268
proc = subprocess.Popen([self.gpg, '--symmetric',
272
stdin=subprocess.PIPE,
273
stdout=subprocess.PIPE,
274
stderr=subprocess.PIPE)
275
ciphertext, err = proc.communicate(input=data)
276
if proc.returncode != 0:
190
278
return ciphertext
192
280
def decrypt(self, data, password):
193
self.gnupg.passphrase = self.password_encode(password)
194
with open(os.devnull) as devnull:
196
proc = self.gnupg.run(['--decrypt'],
197
create_fhs=['stdin', 'stdout'],
198
attach_fhs={'stderr': devnull})
199
with contextlib.closing(proc.handles['stdin'] ) as f:
201
with contextlib.closing(proc.handles['stdout']) as f:
202
decrypted_plaintext = f.read()
206
self.gnupg.passphrase = None
281
passphrase = self.password_encode(password)
282
with tempfile.NamedTemporaryFile(
283
dir=self.tempdir) as passfile:
284
passfile.write(passphrase)
286
proc = subprocess.Popen([self.gpg, '--decrypt',
290
stdin=subprocess.PIPE,
291
stdout=subprocess.PIPE,
292
stderr=subprocess.PIPE)
293
decrypted_plaintext, err = proc.communicate(input=data)
294
if proc.returncode != 0:
207
296
return decrypted_plaintext
299
# Pretend that we have an Avahi module
301
"""This isn't so much a class as it is a module-like namespace."""
302
IF_UNSPEC = -1 # avahi-common/address.h
303
PROTO_UNSPEC = -1 # avahi-common/address.h
304
PROTO_INET = 0 # avahi-common/address.h
305
PROTO_INET6 = 1 # avahi-common/address.h
306
DBUS_NAME = "org.freedesktop.Avahi"
307
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
308
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
309
DBUS_PATH_SERVER = "/"
312
def string_array_to_txt_array(t):
313
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
314
for s in t), signature="ay")
315
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
316
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
317
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
318
SERVER_INVALID = 0 # avahi-common/defs.h
319
SERVER_REGISTERING = 1 # avahi-common/defs.h
320
SERVER_RUNNING = 2 # avahi-common/defs.h
321
SERVER_COLLISION = 3 # avahi-common/defs.h
322
SERVER_FAILURE = 4 # avahi-common/defs.h
211
325
class AvahiError(Exception):
212
326
def __init__(self, value, *args, **kwargs):
213
327
self.value = value
214
super(AvahiError, self).__init__(value, *args, **kwargs)
215
def __unicode__(self):
216
return unicode(repr(self.value))
328
return super(AvahiError, self).__init__(value, *args,
218
332
class AvahiServiceError(AvahiError):
221
336
class AvahiGroupError(AvahiError):
225
class AvahiService(object):
226
341
"""An Avahi (Zeroconf) service.
229
344
interface: integer; avahi.IF_UNSPEC or an interface index.
230
345
Used to optionally bind to the specified interface.
231
346
name: string; Example: 'Mandos'
232
347
type: string; Example: '_mandos._tcp'.
233
See <http://www.dns-sd.org/ServiceTypes.html>
348
See <https://www.iana.org/assignments/service-names-port-numbers>
234
349
port: integer; what port to announce
235
350
TXT: list of strings; TXT record for the service
236
351
domain: string; Domain to publish on, default to .local if empty.
365
510
follow_name_owner_changes=True),
366
511
avahi.DBUS_INTERFACE_SERVER)
367
512
self.server.connect_to_signal("StateChanged",
368
self.server_state_changed)
513
self.server_state_changed)
369
514
self.server_state_changed(self.server.GetState())
371
517
class AvahiServiceToSyslog(AvahiService):
518
def rename(self, *args, **kwargs):
373
519
"""Add the new name to the syslog messages"""
374
ret = AvahiService.rename(self)
375
syslogger.setFormatter(logging.Formatter
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
520
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
521
syslogger.setFormatter(logging.Formatter(
522
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
381
def timedelta_to_milliseconds(td):
382
"Convert a datetime.timedelta() to milliseconds"
383
return ((td.days * 24 * 60 * 60 * 1000)
384
+ (td.seconds * 1000)
385
+ (td.microseconds // 1000))
387
class Client(object):
527
# Pretend that we have a GnuTLS module
529
"""This isn't so much a class as it is a module-like namespace."""
531
library = ctypes.util.find_library("gnutls")
533
library = ctypes.util.find_library("gnutls-deb0")
534
_library = ctypes.cdll.LoadLibrary(library)
537
# Unless otherwise indicated, the constants and types below are
538
# all from the gnutls/gnutls.h C header file.
549
E_NO_CERTIFICATE_FOUND = -49
554
KEYID_USE_SHA256 = 1 # gnutls/x509.h
555
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
558
class session_int(ctypes.Structure):
560
session_t = ctypes.POINTER(session_int)
562
class certificate_credentials_st(ctypes.Structure):
564
certificate_credentials_t = ctypes.POINTER(
565
certificate_credentials_st)
566
certificate_type_t = ctypes.c_int
568
class datum_t(ctypes.Structure):
569
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
570
('size', ctypes.c_uint)]
572
class openpgp_crt_int(ctypes.Structure):
574
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
575
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
576
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
577
credentials_type_t = ctypes.c_int
578
transport_ptr_t = ctypes.c_void_p
579
close_request_t = ctypes.c_int
582
class Error(Exception):
583
def __init__(self, message=None, code=None, args=()):
584
# Default usage is by a message string, but if a return
585
# code is passed, convert it to a string with
588
if message is None and code is not None:
589
message = gnutls.strerror(code)
590
return super(gnutls.Error, self).__init__(
593
class CertificateSecurityError(Error):
599
self._c_object = gnutls.certificate_credentials_t()
600
gnutls.certificate_allocate_credentials(
601
ctypes.byref(self._c_object))
602
self.type = gnutls.CRD_CERTIFICATE
605
gnutls.certificate_free_credentials(self._c_object)
608
def __init__(self, socket, credentials=None):
609
self._c_object = gnutls.session_t()
610
gnutls_flags = gnutls.CLIENT
611
if gnutls.check_version(b"3.5.6"):
612
gnutls_flags |= gnutls.NO_TICKETS
614
gnutls_flags |= gnutls.ENABLE_RAWPK
615
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
617
gnutls.set_default_priority(self._c_object)
618
gnutls.transport_set_ptr(self._c_object, socket.fileno())
619
gnutls.handshake_set_private_extensions(self._c_object,
622
if credentials is None:
623
credentials = gnutls.Credentials()
624
gnutls.credentials_set(self._c_object, credentials.type,
625
ctypes.cast(credentials._c_object,
627
self.credentials = credentials
630
gnutls.deinit(self._c_object)
633
return gnutls.handshake(self._c_object)
635
def send(self, data):
639
data_len -= gnutls.record_send(self._c_object,
644
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
646
# Error handling functions
647
def _error_code(result):
648
"""A function to raise exceptions on errors, suitable
649
for the 'restype' attribute on ctypes functions"""
652
if result == gnutls.E_NO_CERTIFICATE_FOUND:
653
raise gnutls.CertificateSecurityError(code=result)
654
raise gnutls.Error(code=result)
656
def _retry_on_error(result, func, arguments):
657
"""A function to retry on some errors, suitable
658
for the 'errcheck' attribute on ctypes functions"""
660
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
661
return _error_code(result)
662
result = func(*arguments)
665
# Unless otherwise indicated, the function declarations below are
666
# all from the gnutls/gnutls.h C header file.
669
priority_set_direct = _library.gnutls_priority_set_direct
670
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
671
ctypes.POINTER(ctypes.c_char_p)]
672
priority_set_direct.restype = _error_code
674
init = _library.gnutls_init
675
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
676
init.restype = _error_code
678
set_default_priority = _library.gnutls_set_default_priority
679
set_default_priority.argtypes = [session_t]
680
set_default_priority.restype = _error_code
682
record_send = _library.gnutls_record_send
683
record_send.argtypes = [session_t, ctypes.c_void_p,
685
record_send.restype = ctypes.c_ssize_t
686
record_send.errcheck = _retry_on_error
688
certificate_allocate_credentials = (
689
_library.gnutls_certificate_allocate_credentials)
690
certificate_allocate_credentials.argtypes = [
691
ctypes.POINTER(certificate_credentials_t)]
692
certificate_allocate_credentials.restype = _error_code
694
certificate_free_credentials = (
695
_library.gnutls_certificate_free_credentials)
696
certificate_free_credentials.argtypes = [
697
certificate_credentials_t]
698
certificate_free_credentials.restype = None
700
handshake_set_private_extensions = (
701
_library.gnutls_handshake_set_private_extensions)
702
handshake_set_private_extensions.argtypes = [session_t,
704
handshake_set_private_extensions.restype = None
706
credentials_set = _library.gnutls_credentials_set
707
credentials_set.argtypes = [session_t, credentials_type_t,
709
credentials_set.restype = _error_code
711
strerror = _library.gnutls_strerror
712
strerror.argtypes = [ctypes.c_int]
713
strerror.restype = ctypes.c_char_p
715
certificate_type_get = _library.gnutls_certificate_type_get
716
certificate_type_get.argtypes = [session_t]
717
certificate_type_get.restype = _error_code
719
certificate_get_peers = _library.gnutls_certificate_get_peers
720
certificate_get_peers.argtypes = [session_t,
721
ctypes.POINTER(ctypes.c_uint)]
722
certificate_get_peers.restype = ctypes.POINTER(datum_t)
724
global_set_log_level = _library.gnutls_global_set_log_level
725
global_set_log_level.argtypes = [ctypes.c_int]
726
global_set_log_level.restype = None
728
global_set_log_function = _library.gnutls_global_set_log_function
729
global_set_log_function.argtypes = [log_func]
730
global_set_log_function.restype = None
732
deinit = _library.gnutls_deinit
733
deinit.argtypes = [session_t]
734
deinit.restype = None
736
handshake = _library.gnutls_handshake
737
handshake.argtypes = [session_t]
738
handshake.restype = _error_code
739
handshake.errcheck = _retry_on_error
741
transport_set_ptr = _library.gnutls_transport_set_ptr
742
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
743
transport_set_ptr.restype = None
745
bye = _library.gnutls_bye
746
bye.argtypes = [session_t, close_request_t]
747
bye.restype = _error_code
748
bye.errcheck = _retry_on_error
750
check_version = _library.gnutls_check_version
751
check_version.argtypes = [ctypes.c_char_p]
752
check_version.restype = ctypes.c_char_p
754
_need_version = b"3.3.0"
755
if check_version(_need_version) is None:
756
raise self.Error("Needs GnuTLS {} or later"
757
.format(_need_version))
759
_tls_rawpk_version = b"3.6.6"
760
has_rawpk = bool(check_version(_tls_rawpk_version))
764
class pubkey_st(ctypes.Structure):
766
pubkey_t = ctypes.POINTER(pubkey_st)
768
x509_crt_fmt_t = ctypes.c_int
770
# All the function declarations below are from gnutls/abstract.h
771
pubkey_init = _library.gnutls_pubkey_init
772
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
773
pubkey_init.restype = _error_code
775
pubkey_import = _library.gnutls_pubkey_import
776
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
778
pubkey_import.restype = _error_code
780
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
781
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
782
ctypes.POINTER(ctypes.c_ubyte),
783
ctypes.POINTER(ctypes.c_size_t)]
784
pubkey_get_key_id.restype = _error_code
786
pubkey_deinit = _library.gnutls_pubkey_deinit
787
pubkey_deinit.argtypes = [pubkey_t]
788
pubkey_deinit.restype = None
790
# All the function declarations below are from gnutls/openpgp.h
792
openpgp_crt_init = _library.gnutls_openpgp_crt_init
793
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
794
openpgp_crt_init.restype = _error_code
796
openpgp_crt_import = _library.gnutls_openpgp_crt_import
797
openpgp_crt_import.argtypes = [openpgp_crt_t,
798
ctypes.POINTER(datum_t),
800
openpgp_crt_import.restype = _error_code
802
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
803
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
804
ctypes.POINTER(ctypes.c_uint)]
805
openpgp_crt_verify_self.restype = _error_code
807
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
808
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
809
openpgp_crt_deinit.restype = None
811
openpgp_crt_get_fingerprint = (
812
_library.gnutls_openpgp_crt_get_fingerprint)
813
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
817
openpgp_crt_get_fingerprint.restype = _error_code
819
if check_version(b"3.6.4"):
820
certificate_type_get2 = _library.gnutls_certificate_type_get2
821
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
822
certificate_type_get2.restype = _error_code
824
# Remove non-public functions
825
del _error_code, _retry_on_error
828
def call_pipe(connection, # : multiprocessing.Connection
829
func, *args, **kwargs):
830
"""This function is meant to be called by multiprocessing.Process
832
This function runs func(*args, **kwargs), and writes the resulting
833
return value on the provided multiprocessing.Connection.
835
connection.send(func(*args, **kwargs))
388
840
"""A representation of a client host served by this server.
391
843
approved: bool(); 'None' if not yet approved/disapproved
392
844
approval_delay: datetime.timedelta(); Time to wait for approval
393
845
approval_duration: datetime.timedelta(); Duration of one approval
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
846
checker: multiprocessing.Process(); a running checker process used
847
to see if the client lives. 'None' if no process is
849
checker_callback_tag: a GLib event source tag, or None
398
850
checker_command: string; External command which is run to check
399
851
if client lives. %() expansions are done at
400
852
runtime with vars(self) as dict, so that for
401
853
instance %(name)s can be used in the command.
402
checker_initiator_tag: a gobject event source tag, or None
854
checker_initiator_tag: a GLib event source tag, or None
403
855
created: datetime.datetime(); (UTC) object creation
404
856
client_structure: Object describing what attributes a client has
405
857
and is used for storing the client at exit
406
858
current_checker_command: string; current running checker_command
407
disable_initiator_tag: a gobject event source tag, or None
859
disable_initiator_tag: a GLib event source tag, or None
409
861
fingerprint: string (40 or 32 hexadecimal digits); used to
410
uniquely identify the client
862
uniquely identify an OpenPGP client
863
key_id: string (64 hexadecimal digits); used to uniquely identify
864
a client using raw public keys
411
865
host: string; available for use by the checker command
412
866
interval: datetime.timedelta(); How often to start a new checker
413
867
last_approval_request: datetime.datetime(); (UTC) or None
414
868
last_checked_ok: datetime.datetime(); (UTC) or None
415
869
last_checker_status: integer between 0 and 255 reflecting exit
416
870
status of last checker. -1 reflects crashed
871
checker, -2 means no checker completed yet.
872
last_checker_signal: The signal which killed the last checker, if
873
last_checker_status is -1
418
874
last_enabled: datetime.datetime(); (UTC) or None
419
875
name: string; from the config file, used in log messages and
420
876
D-Bus identifiers
421
877
secret: bytestring; sent verbatim (over TLS) to client
422
878
timeout: datetime.timedelta(); How long from last_checked_ok
423
879
until this client is disabled
424
extended_timeout: extra long timeout when password has been sent
880
extended_timeout: extra long timeout when secret has been sent
425
881
runtime_expansions: Allowed attributes for runtime expansion.
426
882
expires: datetime.datetime(); time (UTC) when a client will be
427
883
disabled, or None
884
server_settings: The server_settings dict from main()
430
887
runtime_expansions = ("approval_delay", "approval_duration",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
888
"created", "enabled", "expires", "key_id",
889
"fingerprint", "host", "interval",
890
"last_approval_request", "last_checked_ok",
433
891
"last_enabled", "name", "timeout")
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)
894
"extended_timeout": "PT15M",
896
"checker": "fping -q -- %%(host)s",
898
"approval_delay": "PT0S",
899
"approval_duration": "PT1S",
900
"approved_by_default": "True",
461
905
def config_parser(config):
462
""" Construct a new dict of client settings of this form:
906
"""Construct a new dict of client settings of this form:
463
907
{ client_name: {setting_name: value, ...}, ...}
464
with exceptions for any special settings as defined above"""
908
with exceptions for any special settings as defined above.
909
NOTE: Must be a pure function. Must return the same result
910
value given the same arguments.
466
913
for client_name in config.sections():
467
914
section = dict(config.items(client_name))
468
915
client = settings[client_name] = {}
470
917
client["host"] = section["host"]
471
918
# Reformat values from string types to Python types
472
919
client["approved_by_default"] = config.getboolean(
473
920
client_name, "approved_by_default")
474
client["enabled"] = config.getboolean(client_name, "enabled")
921
client["enabled"] = config.getboolean(client_name,
924
# Uppercase and remove spaces from key_id and fingerprint
925
# for later comparison purposes with return value from the
926
# key_id() and fingerprint() functions
927
client["key_id"] = (section.get("key_id", "").upper()
476
929
client["fingerprint"] = (section["fingerprint"].upper()
477
930
.replace(" ", ""))
478
931
if "secret" in section:
479
client["secret"] = section["secret"].decode("base64")
932
client["secret"] = codecs.decode(section["secret"]
480
935
elif "secfile" in section:
481
936
with open(os.path.expanduser(os.path.expandvars
482
937
(section["secfile"])),
483
938
"rb") as secfile:
484
939
client["secret"] = secfile.read()
486
raise TypeError("No secret or secfile for section %s"
941
raise TypeError("No secret or secfile for section {}"
488
943
client["timeout"] = string_to_delta(section["timeout"])
489
944
client["extended_timeout"] = string_to_delta(
490
945
section["extended_timeout"])
532
988
self.current_checker_command = None
533
989
self.approved = None
534
990
self.approvals_pending = 0
535
self.changedstate = (multiprocessing_manager
536
.Condition(multiprocessing_manager
538
self.client_structure = [attr for attr in
539
self.__dict__.iterkeys()
991
self.changedstate = multiprocessing_manager.Condition(
992
multiprocessing_manager.Lock())
993
self.client_structure = [attr
994
for attr in self.__dict__.keys()
540
995
if not attr.startswith("_")]
541
996
self.client_structure.append("client_structure")
543
for name, t in inspect.getmembers(type(self),
998
for name, t in inspect.getmembers(
999
type(self), lambda obj: isinstance(obj, property)):
547
1000
if not name.startswith("_"):
548
1001
self.client_structure.append(name)
550
1003
# Send notice to process children that client state has changed
551
1004
def send_changedstate(self):
552
1005
with self.changedstate:
553
1006
self.changedstate.notify_all()
555
1008
def enable(self):
556
1009
"""Start this client's checker and timeout hooks"""
557
1010
if getattr(self, "enabled", False):
558
1011
# Already enabled
560
self.send_changedstate()
561
1013
self.expires = datetime.datetime.utcnow() + self.timeout
562
1014
self.enabled = True
563
1015
self.last_enabled = datetime.datetime.utcnow()
564
1016
self.init_checker()
1017
self.send_changedstate()
566
1019
def disable(self, quiet=True):
567
1020
"""Disable this client."""
568
1021
if not getattr(self, "enabled", False):
571
self.send_changedstate()
573
1024
logger.info("Disabling client %s", self.name)
574
if getattr(self, "disable_initiator_tag", False):
575
gobject.source_remove(self.disable_initiator_tag)
1025
if getattr(self, "disable_initiator_tag", None) is not None:
1026
GLib.source_remove(self.disable_initiator_tag)
576
1027
self.disable_initiator_tag = None
577
1028
self.expires = None
578
if getattr(self, "checker_initiator_tag", False):
579
gobject.source_remove(self.checker_initiator_tag)
1029
if getattr(self, "checker_initiator_tag", None) is not None:
1030
GLib.source_remove(self.checker_initiator_tag)
580
1031
self.checker_initiator_tag = None
581
1032
self.stop_checker()
582
1033
self.enabled = False
583
# Do not run this again if called by a gobject.timeout_add
1035
self.send_changedstate()
1036
# Do not run this again if called by a GLib.timeout_add
586
1039
def __del__(self):
589
1042
def init_checker(self):
590
1043
# Schedule a new checker to be started an 'interval' from now,
591
1044
# and every interval from then on.
592
self.checker_initiator_tag = (gobject.timeout_add
593
(self.interval_milliseconds(),
1045
if self.checker_initiator_tag is not None:
1046
GLib.source_remove(self.checker_initiator_tag)
1047
self.checker_initiator_tag = GLib.timeout_add(
1048
random.randrange(int(self.interval.total_seconds() * 1000
595
1051
# Schedule a disable() when 'timeout' has passed
596
self.disable_initiator_tag = (gobject.timeout_add
597
(self.timeout_milliseconds(),
1052
if self.disable_initiator_tag is not None:
1053
GLib.source_remove(self.disable_initiator_tag)
1054
self.disable_initiator_tag = GLib.timeout_add(
1055
int(self.timeout.total_seconds() * 1000), self.disable)
599
1056
# Also start a new checker *right now*.
600
1057
self.start_checker()
602
def checker_callback(self, pid, condition, command):
1059
def checker_callback(self, source, condition, connection,
603
1061
"""The checker has completed, so take appropriate actions."""
1062
# Read return code from connection (see call_pipe)
1063
returncode = connection.recv()
1065
if self.checker is not None:
604
1067
self.checker_callback_tag = None
605
1068
self.checker = None
606
if os.WIFEXITED(condition):
607
self.last_checker_status = os.WEXITSTATUS(condition)
1071
self.last_checker_status = returncode
1072
self.last_checker_signal = None
608
1073
if self.last_checker_status == 0:
609
1074
logger.info("Checker for %(name)s succeeded",
611
1076
self.checked_ok()
613
logger.info("Checker for %(name)s failed",
1078
logger.info("Checker for %(name)s failed", vars(self))
616
1080
self.last_checker_status = -1
1081
self.last_checker_signal = -returncode
617
1082
logger.warning("Checker for %(name)s crashed?",
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,
1086
def checked_ok(self):
1087
"""Assert that the client has been seen, alive and well."""
1088
self.last_checked_ok = datetime.datetime.utcnow()
1089
self.last_checker_status = 0
1090
self.last_checker_signal = None
1093
def bump_timeout(self, timeout=None):
1094
"""Bump up the timeout for this client."""
626
1095
if timeout is None:
627
1096
timeout = self.timeout
628
self.last_checked_ok = datetime.datetime.utcnow()
629
1097
if self.disable_initiator_tag is not None:
630
gobject.source_remove(self.disable_initiator_tag)
1098
GLib.source_remove(self.disable_initiator_tag)
1099
self.disable_initiator_tag = None
631
1100
if getattr(self, "enabled", False):
632
self.disable_initiator_tag = (gobject.timeout_add
633
(timedelta_to_milliseconds
634
(timeout), self.disable))
1101
self.disable_initiator_tag = GLib.timeout_add(
1102
int(timeout.total_seconds() * 1000), self.disable)
635
1103
self.expires = datetime.datetime.utcnow() + timeout
637
1105
def need_approval(self):
638
1106
self.last_approval_request = datetime.datetime.utcnow()
640
1108
def start_checker(self):
641
1109
"""Start a new checker subprocess if one is not running.
643
1111
If a checker already exists, leave it running and do
645
1113
# The reason for not killing a running checker is that if we
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
1114
# did that, and if a checker (for some reason) started running
1115
# slowly and taking more than 'interval' time, then the client
1116
# would inevitably timeout, since no checker would get a
1117
# chance to run to completion. If we instead leave running
650
1118
# checkers alone, the checker would have to take more time
651
1119
# than 'timeout' for the client to be disabled, which is as it
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)
1122
if self.checker is not None and not self.checker.is_alive():
1123
logger.warning("Checker was not alive; joining")
667
1126
# Start a new checker if needed
668
1127
if self.checker is None:
1128
# Escape attributes for the shell
1130
attr: re.escape(str(getattr(self, attr)))
1131
for attr in self.runtime_expansions}
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
1133
command = self.checker_command % escaped_attrs
1134
except TypeError as error:
1135
logger.error('Could not format string "%s"',
1136
self.checker_command,
1138
return True # Try again later
688
1139
self.current_checker_command = command
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
1140
logger.info("Starting checker %r for %s", command,
1142
# We don't need to redirect stdout and stderr, since
1143
# in normal mode, that is already done by daemon(),
1144
# and in debug mode we don't want to. (Stdin is
1145
# always replaced by /dev/null.)
1146
# The exception is when not debugging but nevertheless
1147
# running in the foreground; use the previously
1149
popen_args = {"close_fds": True,
1152
if (not self.server_settings["debug"]
1153
and self.server_settings["foreground"]):
1154
popen_args.update({"stdout": wnull,
1156
pipe = multiprocessing.Pipe(duplex=False)
1157
self.checker = multiprocessing.Process(
1159
args=(pipe[1], subprocess.call, command),
1161
self.checker.start()
1162
self.checker_callback_tag = GLib.io_add_watch(
1163
GLib.IOChannel.unix_new(pipe[0].fileno()),
1164
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1165
self.checker_callback, pipe[0], command)
1166
# Re-run this periodically if run by GLib.timeout_add
715
1169
def stop_checker(self):
716
1170
"""Force the checker process, if any, to stop."""
717
1171
if self.checker_callback_tag:
718
gobject.source_remove(self.checker_callback_tag)
1172
GLib.source_remove(self.checker_callback_tag)
719
1173
self.checker_callback_tag = None
720
1174
if getattr(self, "checker", None) is None:
722
1176
logger.debug("Stopping checker for %(name)s", vars(self))
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
1177
self.checker.terminate()
731
1178
self.checker = None
734
def dbus_service_property(dbus_interface, signature="v",
735
access="readwrite", byte_arrays=False):
1181
def dbus_service_property(dbus_interface,
736
1185
"""Decorators for marking methods of a DBusObjectWithProperties to
737
1186
become properties on the D-Bus.
739
1188
The decorated method will be called with no arguments by "Get"
740
1189
and with one argument by "Set".
742
1191
The parameters, where they are supported, are the same as
743
1192
dbus.service.method, except there is only "signature", since the
744
1193
type from Get() and the type sent to Set() is the same.
783
class DBusObjectWithProperties(dbus.service.Object):
1276
class DBusObjectWithAnnotations(dbus.service.Object):
1277
"""A D-Bus object with annotations.
1279
Classes inheriting from this can use the dbus_annotations
1280
decorator to add annotations to methods or signals.
1284
def _is_dbus_thing(thing):
1285
"""Returns a function testing if an attribute is a D-Bus thing
1287
If called like _is_dbus_thing("method") it returns a function
1288
suitable for use as predicate to inspect.getmembers().
1290
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1293
def _get_all_dbus_things(self, thing):
1294
"""Returns a generator of (name, attribute) pairs
1296
return ((getattr(athing.__get__(self), "_dbus_name", name),
1297
athing.__get__(self))
1298
for cls in self.__class__.__mro__
1300
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1302
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1304
path_keyword='object_path',
1305
connection_keyword='connection')
1306
def Introspect(self, object_path, connection):
1307
"""Overloading of standard D-Bus method.
1309
Inserts annotation tags on methods and signals.
1311
xmlstring = dbus.service.Object.Introspect(self, object_path,
1314
document = xml.dom.minidom.parseString(xmlstring)
1316
for if_tag in document.getElementsByTagName("interface"):
1317
# Add annotation tags
1318
for typ in ("method", "signal"):
1319
for tag in if_tag.getElementsByTagName(typ):
1321
for name, prop in (self.
1322
_get_all_dbus_things(typ)):
1323
if (name == tag.getAttribute("name")
1324
and prop._dbus_interface
1325
== if_tag.getAttribute("name")):
1326
annots.update(getattr(
1327
prop, "_dbus_annotations", {}))
1328
for name, value in annots.items():
1329
ann_tag = document.createElement(
1331
ann_tag.setAttribute("name", name)
1332
ann_tag.setAttribute("value", value)
1333
tag.appendChild(ann_tag)
1334
# Add interface annotation tags
1335
for annotation, value in dict(
1336
itertools.chain.from_iterable(
1337
annotations().items()
1338
for name, annotations
1339
in self._get_all_dbus_things("interface")
1340
if name == if_tag.getAttribute("name")
1342
ann_tag = document.createElement("annotation")
1343
ann_tag.setAttribute("name", annotation)
1344
ann_tag.setAttribute("value", value)
1345
if_tag.appendChild(ann_tag)
1346
# Fix argument name for the Introspect method itself
1347
if (if_tag.getAttribute("name")
1348
== dbus.INTROSPECTABLE_IFACE):
1349
for cn in if_tag.getElementsByTagName("method"):
1350
if cn.getAttribute("name") == "Introspect":
1351
for arg in cn.getElementsByTagName("arg"):
1352
if (arg.getAttribute("direction")
1354
arg.setAttribute("name",
1356
xmlstring = document.toxml("utf-8")
1358
except (AttributeError, xml.dom.DOMException,
1359
xml.parsers.expat.ExpatError) as error:
1360
logger.error("Failed to override Introspection method",
1365
class DBusObjectWithProperties(DBusObjectWithAnnotations):
784
1366
"""A D-Bus object with properties.
786
1368
Classes inheriting from this can use the dbus_service_property
787
1369
decorator to expose methods as D-Bus properties. It exposes the
788
1370
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))
803
1373
def _get_dbus_property(self, interface_name, property_name):
804
1374
"""Returns a bound method if one exists which is a D-Bus
805
1375
property with the specified name and interface.
807
for cls in self.__class__.__mro__:
808
for name, value in (inspect.getmembers
809
(cls, self._is_dbus_property)):
1377
for cls in self.__class__.__mro__:
1378
for name, value in inspect.getmembers(
1379
cls, self._is_dbus_thing("property")):
810
1380
if (value._dbus_name == property_name
811
1381
and value._dbus_interface == interface_name):
812
1382
return value.__get__(self)
814
1384
# No such property
815
raise DBusPropertyNotFound(self.dbus_object_path + ":"
816
+ interface_name + "."
819
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1385
raise DBusPropertyNotFound("{}:{}.{}".format(
1386
self.dbus_object_path, interface_name, property_name))
1389
def _get_all_interface_names(cls):
1390
"""Get a sequence of all interfaces supported by an object"""
1391
return (name for name in set(getattr(getattr(x, attr),
1392
"_dbus_interface", None)
1393
for x in (inspect.getmro(cls))
1395
if name is not None)
1397
@dbus.service.method(dbus.PROPERTIES_IFACE,
820
1399
out_signature="v")
821
1400
def Get(self, interface_name, property_name):
822
1401
"""Standard D-Bus property Get() method, see D-Bus standard.
914
1525
except (AttributeError, xml.dom.DOMException,
915
1526
xml.parsers.expat.ExpatError) as error:
916
1527
logger.error("Failed to override Introspection method",
921
def datetime_to_dbus (dt, variant_level=0):
1533
dbus.OBJECT_MANAGER_IFACE
1534
except AttributeError:
1535
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1538
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1539
"""A D-Bus object with an ObjectManager.
1541
Classes inheriting from this exposes the standard
1542
GetManagedObjects call and the InterfacesAdded and
1543
InterfacesRemoved signals on the standard
1544
"org.freedesktop.DBus.ObjectManager" interface.
1546
Note: No signals are sent automatically; they must be sent
1549
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1550
out_signature="a{oa{sa{sv}}}")
1551
def GetManagedObjects(self):
1552
"""This function must be overridden"""
1553
raise NotImplementedError()
1555
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1556
signature="oa{sa{sv}}")
1557
def InterfacesAdded(self, object_path, interfaces_and_properties):
1560
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1561
def InterfacesRemoved(self, object_path, interfaces):
1564
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1566
path_keyword='object_path',
1567
connection_keyword='connection')
1568
def Introspect(self, object_path, connection):
1569
"""Overloading of standard D-Bus method.
1571
Override return argument name of GetManagedObjects to be
1572
"objpath_interfaces_and_properties"
1574
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1578
document = xml.dom.minidom.parseString(xmlstring)
1580
for if_tag in document.getElementsByTagName("interface"):
1581
# Fix argument name for the GetManagedObjects method
1582
if (if_tag.getAttribute("name")
1583
== dbus.OBJECT_MANAGER_IFACE):
1584
for cn in if_tag.getElementsByTagName("method"):
1585
if (cn.getAttribute("name")
1586
== "GetManagedObjects"):
1587
for arg in cn.getElementsByTagName("arg"):
1588
if (arg.getAttribute("direction")
1592
"objpath_interfaces"
1594
xmlstring = document.toxml("utf-8")
1596
except (AttributeError, xml.dom.DOMException,
1597
xml.parsers.expat.ExpatError) as error:
1598
logger.error("Failed to override Introspection method",
1603
def datetime_to_dbus(dt, variant_level=0):
922
1604
"""Convert a UTC datetime.datetime() to a D-Bus type."""
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.
1606
return dbus.String("", variant_level=variant_level)
1607
return dbus.String(dt.isoformat(), variant_level=variant_level)
1610
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1611
"""A class decorator; applied to a subclass of
1612
dbus.service.Object, it will add alternate D-Bus attributes with
1613
interface names according to the "alt_interface_names" mapping.
1616
@alternate_dbus_interfaces({"org.example.Interface":
1617
"net.example.AlternateInterface"})
1618
class SampleDBusObject(dbus.service.Object):
1619
@dbus.service.method("org.example.Interface")
1620
def SampleDBusMethod():
1623
The above "SampleDBusMethod" on "SampleDBusObject" will be
1624
reachable via two interfaces: "org.example.Interface" and
1625
"net.example.AlternateInterface", the latter of which will have
1626
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1627
"true", unless "deprecate" is passed with a False value.
1629
This works for methods and signals, and also for D-Bus properties
1630
(from DBusObjectWithProperties) and interfaces (from the
1631
dbus_interface_annotations decorator).
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):
1635
for orig_interface_name, alt_interface_name in (
1636
alt_interface_names.items()):
1638
interface_names = set()
1639
# Go though all attributes of the class
1640
for attrname, attribute in inspect.getmembers(cls):
941
1641
# Ignore non-D-Bus attributes, and D-Bus attributes
942
1642
# with the wrong interface name
943
1643
if (not hasattr(attribute, "_dbus_interface")
944
or not attribute._dbus_interface
945
.startswith("se.recompile.Mandos")):
1644
or not attribute._dbus_interface.startswith(
1645
orig_interface_name)):
947
1647
# Create an alternate D-Bus interface name based on
948
1648
# the current name
949
alt_interface = (attribute._dbus_interface
950
.replace("se.recompile.Mandos",
951
"se.bsnet.fukt.Mandos"))
1649
alt_interface = attribute._dbus_interface.replace(
1650
orig_interface_name, alt_interface_name)
1651
interface_names.add(alt_interface)
952
1652
# Is this a D-Bus signal?
953
1653
if getattr(attribute, "_dbus_is_signal", False):
954
# Extract the original non-method function by
956
nonmethod_func = (dict(
1654
# Extract the original non-method undecorated
1655
# function by black magic
1656
if sys.version_info.major == 2:
1657
nonmethod_func = (dict(
957
1658
zip(attribute.func_code.co_freevars,
958
attribute.__closure__))["func"]
1659
attribute.__closure__))
1660
["func"].cell_contents)
1662
nonmethod_func = (dict(
1663
zip(attribute.__code__.co_freevars,
1664
attribute.__closure__))
1665
["func"].cell_contents)
960
1666
# Create a new, but exactly alike, function
961
1667
# object, and decorate it to be a new D-Bus signal
962
1668
# with the alternate D-Bus interface name
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)))
1669
new_function = copy_function(nonmethod_func)
1670
new_function = (dbus.service.signal(
1672
attribute._dbus_signature)(new_function))
1673
# Copy annotations, if any
1675
new_function._dbus_annotations = dict(
1676
attribute._dbus_annotations)
1677
except AttributeError:
972
1680
# Define a creator of a function to call both the
973
# old and new functions, so both the old and new
974
# signals gets sent when the function is called
1681
# original and alternate functions, so both the
1682
# original and alternate signals gets sent when
1683
# the function is called
975
1684
def fixscope(func1, func2):
976
1685
"""This function is a scope container to pass
977
1686
func1 and func2 to the "call_both" function
978
1687
outside of its arguments"""
1689
@functools.wraps(func2)
979
1690
def call_both(*args, **kwargs):
980
1691
"""This function will emit two D-Bus
981
1692
signals by calling func1 and func2"""
982
1693
func1(*args, **kwargs)
983
1694
func2(*args, **kwargs)
1695
# Make wrapper function look like a D-Bus
1697
for name, attr in inspect.getmembers(func2):
1698
if name.startswith("_dbus_"):
1699
setattr(call_both, name, attr)
984
1701
return call_both
985
1702
# Create the "call_both" function and add it to
987
attr[attrname] = fixscope(attribute,
1704
attr[attrname] = fixscope(attribute, new_function)
989
1705
# Is this a D-Bus method?
990
1706
elif getattr(attribute, "_dbus_is_method", False):
991
1707
# Create a new, but exactly alike, function
992
1708
# object. Decorate it to be a new D-Bus method
993
1709
# with the alternate D-Bus interface name. Add it
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)))
1712
dbus.service.method(
1714
attribute._dbus_in_signature,
1715
attribute._dbus_out_signature)
1716
(copy_function(attribute)))
1717
# Copy annotations, if any
1719
attr[attrname]._dbus_annotations = dict(
1720
attribute._dbus_annotations)
1721
except AttributeError:
1005
1723
# Is this a D-Bus property?
1006
1724
elif getattr(attribute, "_dbus_is_property", False):
1007
1725
# Create a new, but exactly alike, function
1008
1726
# object, and decorate it to be a new D-Bus
1009
1727
# property with the alternate D-Bus interface
1010
1728
# name. Add it to the class.
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)
1729
attr[attrname] = (dbus_service_property(
1730
alt_interface, attribute._dbus_signature,
1731
attribute._dbus_access,
1732
attribute._dbus_get_args_options
1734
(copy_function(attribute)))
1735
# Copy annotations, if any
1737
attr[attrname]._dbus_annotations = dict(
1738
attribute._dbus_annotations)
1739
except AttributeError:
1741
# Is this a D-Bus interface?
1742
elif getattr(attribute, "_dbus_is_interface", False):
1743
# Create a new, but exactly alike, function
1744
# object. Decorate it to be a new D-Bus interface
1745
# with the alternate D-Bus interface name. Add it
1748
dbus_interface_annotations(alt_interface)
1749
(copy_function(attribute)))
1751
# Deprecate all alternate interfaces
1752
iname = "_AlternateDBusNames_interface_annotation{}"
1753
for interface_name in interface_names:
1755
@dbus_interface_annotations(interface_name)
1757
return {"org.freedesktop.DBus.Deprecated":
1759
# Find an unused name
1760
for aname in (iname.format(i)
1761
for i in itertools.count()):
1762
if aname not in attr:
1766
# Replace the class with a new subclass of it with
1767
# methods, signals, etc. as created above.
1768
if sys.version_info.major == 2:
1769
cls = type(b"{}Alternate".format(cls.__name__),
1772
cls = type("{}Alternate".format(cls.__name__),
1779
@alternate_dbus_interfaces({"se.recompile.Mandos":
1780
"se.bsnet.fukt.Mandos"})
1027
1781
class ClientDBus(Client, DBusObjectWithProperties):
1028
1782
"""A Client class using D-Bus
1031
1785
dbus_object_path: dbus.ObjectPath
1032
1786
bus: dbus.SystemBus()
1035
1789
runtime_expansions = (Client.runtime_expansions
1036
+ ("dbus_object_path",))
1790
+ ("dbus_object_path", ))
1792
_interface = "se.recompile.Mandos.Client"
1038
1794
# dbus.service.Object doesn't use super(), so we can't either.
1040
def __init__(self, bus = None, *args, **kwargs):
1796
def __init__(self, bus=None, *args, **kwargs):
1042
1798
Client.__init__(self, *args, **kwargs)
1043
self._approvals_pending = 0
1045
self._approvals_pending = 0
1046
1799
# Only now, when this client is initialized, can it show up on
1048
client_object_name = unicode(self.name).translate(
1801
client_object_name = str(self.name).translate(
1049
1802
{ord("."): ord("_"),
1050
1803
ord("-"): ord("_")})
1051
self.dbus_object_path = (dbus.ObjectPath
1052
("/clients/" + client_object_name))
1804
self.dbus_object_path = dbus.ObjectPath(
1805
"/clients/" + client_object_name)
1053
1806
DBusObjectWithProperties.__init__(self, self.bus,
1054
1807
self.dbus_object_path)
1056
def notifychangeproperty(transform_func,
1057
dbus_name, type_func=lambda x: x,
1809
def notifychangeproperty(transform_func, dbus_name,
1810
type_func=lambda x: x,
1812
invalidate_only=False,
1813
_interface=_interface):
1059
1814
""" Modify a variable so that it's a property which announces
1060
1815
its changes to DBus.
1062
1817
transform_fun: Function that takes a value and a variant_level
1063
1818
and transforms it to a D-Bus type.
1064
1819
dbus_name: D-Bus name of the variable
1066
1821
to the D-Bus. Default: no transform
1067
1822
variant_level: D-Bus variant level. Default: 1
1069
attrname = "_{0}".format(dbus_name)
1824
attrname = "_{}".format(dbus_name)
1070
1826
def setter(self, value):
1071
1827
if hasattr(self, "dbus_object_path"):
1072
1828
if (not hasattr(self, attrname) or
1073
1829
type_func(getattr(self, attrname, None))
1074
1830
!= type_func(value)):
1075
dbus_value = transform_func(type_func(value),
1078
self.PropertyChanged(dbus.String(dbus_name),
1832
self.PropertiesChanged(
1833
_interface, dbus.Dictionary(),
1834
dbus.Array((dbus_name, )))
1836
dbus_value = transform_func(
1838
variant_level=variant_level)
1839
self.PropertyChanged(dbus.String(dbus_name),
1841
self.PropertiesChanged(
1843
dbus.Dictionary({dbus.String(dbus_name):
1080
1846
setattr(self, attrname, value)
1082
1848
return property(lambda self: getattr(self, attrname), setter)
1085
1850
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1086
1851
approvals_pending = notifychangeproperty(dbus.Boolean,
1087
1852
"ApprovalPending",
1089
1854
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1090
1855
last_enabled = notifychangeproperty(datetime_to_dbus,
1092
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1093
type_func = lambda checker:
1094
checker is not None)
1857
checker = notifychangeproperty(
1858
dbus.Boolean, "CheckerRunning",
1859
type_func=lambda checker: checker is not None)
1095
1860
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1096
1861
"LastCheckedOK")
1862
last_checker_status = notifychangeproperty(dbus.Int16,
1863
"LastCheckerStatus")
1097
1864
last_approval_request = notifychangeproperty(
1098
1865
datetime_to_dbus, "LastApprovalRequest")
1099
1866
approved_by_default = notifychangeproperty(dbus.Boolean,
1100
1867
"ApprovedByDefault")
1101
approval_delay = notifychangeproperty(dbus.UInt64,
1104
timedelta_to_milliseconds)
1868
approval_delay = notifychangeproperty(
1869
dbus.UInt64, "ApprovalDelay",
1870
type_func=lambda td: td.total_seconds() * 1000)
1105
1871
approval_duration = notifychangeproperty(
1106
1872
dbus.UInt64, "ApprovalDuration",
1107
type_func = timedelta_to_milliseconds)
1873
type_func=lambda td: td.total_seconds() * 1000)
1108
1874
host = notifychangeproperty(dbus.String, "Host")
1109
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1111
timedelta_to_milliseconds)
1875
timeout = notifychangeproperty(
1876
dbus.UInt64, "Timeout",
1877
type_func=lambda td: td.total_seconds() * 1000)
1112
1878
extended_timeout = notifychangeproperty(
1113
1879
dbus.UInt64, "ExtendedTimeout",
1114
type_func = timedelta_to_milliseconds)
1115
interval = notifychangeproperty(dbus.UInt64,
1118
timedelta_to_milliseconds)
1880
type_func=lambda td: td.total_seconds() * 1000)
1881
interval = notifychangeproperty(
1882
dbus.UInt64, "Interval",
1883
type_func=lambda td: td.total_seconds() * 1000)
1119
1884
checker_command = notifychangeproperty(dbus.String, "Checker")
1885
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1886
invalidate_only=True)
1121
1888
del notifychangeproperty
1123
1890
def __del__(self, *args, **kwargs):
1125
1892
self.remove_from_connection()
1205
1971
server to mandos-client
1209
1975
# Rejected - signal
1210
1976
@dbus.service.signal(_interface, signature="s")
1211
1977
def Rejected(self, reason):
1215
1981
# NeedApproval - signal
1216
1982
@dbus.service.signal(_interface, signature="tb")
1217
1983
def NeedApproval(self, timeout, default):
1219
1985
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.
1231
1989
# Approve - method
1232
1990
@dbus.service.method(_interface, in_signature="b")
1233
1991
def Approve(self, value):
1234
1992
self.approve(value)
1236
1994
# CheckedOK - method
1237
1995
@dbus.service.method(_interface)
1238
1996
def CheckedOK(self):
1239
1997
self.checked_ok()
1241
1999
# Enable - method
2000
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1242
2001
@dbus.service.method(_interface)
1243
2002
def Enable(self):
1247
2006
# StartChecker - method
2007
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1248
2008
@dbus.service.method(_interface)
1249
2009
def StartChecker(self):
1251
2011
self.start_checker()
1253
2013
# Disable - method
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1254
2015
@dbus.service.method(_interface)
1255
2016
def Disable(self):
1259
2020
# StopChecker - method
2021
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1260
2022
@dbus.service.method(_interface)
1261
2023
def StopChecker(self):
1262
2024
self.stop_checker()
1266
2028
# ApprovalPending - property
1267
2029
@dbus_service_property(_interface, signature="b", access="read")
1268
2030
def ApprovalPending_dbus_property(self):
1269
2031
return dbus.Boolean(bool(self.approvals_pending))
1271
2033
# ApprovedByDefault - property
1272
@dbus_service_property(_interface, signature="b",
2034
@dbus_service_property(_interface,
1273
2036
access="readwrite")
1274
2037
def ApprovedByDefault_dbus_property(self, value=None):
1275
2038
if value is None: # get
1276
2039
return dbus.Boolean(self.approved_by_default)
1277
2040
self.approved_by_default = bool(value)
1279
2042
# ApprovalDelay - property
1280
@dbus_service_property(_interface, signature="t",
2043
@dbus_service_property(_interface,
1281
2045
access="readwrite")
1282
2046
def ApprovalDelay_dbus_property(self, value=None):
1283
2047
if value is None: # get
1284
return dbus.UInt64(self.approval_delay_milliseconds())
2048
return dbus.UInt64(self.approval_delay.total_seconds()
1285
2050
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1287
2052
# ApprovalDuration - property
1288
@dbus_service_property(_interface, signature="t",
2053
@dbus_service_property(_interface,
1289
2055
access="readwrite")
1290
2056
def ApprovalDuration_dbus_property(self, value=None):
1291
2057
if value is None: # get
1292
return dbus.UInt64(timedelta_to_milliseconds(
1293
self.approval_duration))
2058
return dbus.UInt64(self.approval_duration.total_seconds()
1294
2060
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1296
2062
# Name - property
2064
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1297
2065
@dbus_service_property(_interface, signature="s", access="read")
1298
2066
def Name_dbus_property(self):
1299
2067
return dbus.String(self.name)
2071
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2072
@dbus_service_property(_interface, signature="s", access="read")
2073
def KeyID_dbus_property(self):
2074
return dbus.String(self.key_id)
1301
2076
# Fingerprint - property
2078
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1302
2079
@dbus_service_property(_interface, signature="s", access="read")
1303
2080
def Fingerprint_dbus_property(self):
1304
2081
return dbus.String(self.fingerprint)
1306
2083
# Host - property
1307
@dbus_service_property(_interface, signature="s",
2084
@dbus_service_property(_interface,
1308
2086
access="readwrite")
1309
2087
def Host_dbus_property(self, value=None):
1310
2088
if value is None: # get
1311
2089
return dbus.String(self.host)
1312
self.host = unicode(value)
2090
self.host = str(value)
1314
2092
# Created - property
2094
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1315
2095
@dbus_service_property(_interface, signature="s", access="read")
1316
2096
def Created_dbus_property(self):
1317
2097
return datetime_to_dbus(self.created)
1319
2099
# LastEnabled - property
1320
2100
@dbus_service_property(_interface, signature="s", access="read")
1321
2101
def LastEnabled_dbus_property(self):
1322
2102
return datetime_to_dbus(self.last_enabled)
1324
2104
# Enabled - property
1325
@dbus_service_property(_interface, signature="b",
2105
@dbus_service_property(_interface,
1326
2107
access="readwrite")
1327
2108
def Enabled_dbus_property(self, value=None):
1328
2109
if value is None: # get
1335
2116
# LastCheckedOK - property
1336
@dbus_service_property(_interface, signature="s",
2117
@dbus_service_property(_interface,
1337
2119
access="readwrite")
1338
2120
def LastCheckedOK_dbus_property(self, value=None):
1339
2121
if value is not None:
1340
2122
self.checked_ok()
1342
2124
return datetime_to_dbus(self.last_checked_ok)
2126
# LastCheckerStatus - property
2127
@dbus_service_property(_interface, signature="n", access="read")
2128
def LastCheckerStatus_dbus_property(self):
2129
return dbus.Int16(self.last_checker_status)
1344
2131
# Expires - property
1345
2132
@dbus_service_property(_interface, signature="s", access="read")
1346
2133
def Expires_dbus_property(self):
1347
2134
return datetime_to_dbus(self.expires)
1349
2136
# LastApprovalRequest - property
1350
2137
@dbus_service_property(_interface, signature="s", access="read")
1351
2138
def LastApprovalRequest_dbus_property(self):
1352
2139
return datetime_to_dbus(self.last_approval_request)
1354
2141
# Timeout - property
1355
@dbus_service_property(_interface, signature="t",
2142
@dbus_service_property(_interface,
1356
2144
access="readwrite")
1357
2145
def Timeout_dbus_property(self, value=None):
1358
2146
if value is None: # get
1359
return dbus.UInt64(self.timeout_milliseconds())
2147
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2148
old_timeout = self.timeout
1360
2149
self.timeout = datetime.timedelta(0, 0, 0, value)
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))
2150
# Reschedule disabling
2152
now = datetime.datetime.utcnow()
2153
self.expires += self.timeout - old_timeout
2154
if self.expires <= now:
2155
# The timeout has passed
2158
if (getattr(self, "disable_initiator_tag", None)
2161
GLib.source_remove(self.disable_initiator_tag)
2162
self.disable_initiator_tag = GLib.timeout_add(
2163
int((self.expires - now).total_seconds() * 1000),
1382
2166
# ExtendedTimeout - property
1383
@dbus_service_property(_interface, signature="t",
2167
@dbus_service_property(_interface,
1384
2169
access="readwrite")
1385
2170
def ExtendedTimeout_dbus_property(self, value=None):
1386
2171
if value is None: # get
1387
return dbus.UInt64(self.extended_timeout_milliseconds())
2172
return dbus.UInt64(self.extended_timeout.total_seconds()
1388
2174
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1390
2176
# Interval - property
1391
@dbus_service_property(_interface, signature="t",
2177
@dbus_service_property(_interface,
1392
2179
access="readwrite")
1393
2180
def Interval_dbus_property(self, value=None):
1394
2181
if value is None: # get
1395
return dbus.UInt64(self.interval_milliseconds())
2182
return dbus.UInt64(self.interval.total_seconds() * 1000)
1396
2183
self.interval = datetime.timedelta(0, 0, 0, value)
1397
2184
if getattr(self, "checker_initiator_tag", None) is None:
1399
2186
if self.enabled:
1400
2187
# Reschedule checker run
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
2188
GLib.source_remove(self.checker_initiator_tag)
2189
self.checker_initiator_tag = GLib.timeout_add(
2190
value, self.start_checker)
2191
self.start_checker() # Start one now, too
1406
2193
# Checker - property
1407
@dbus_service_property(_interface, signature="s",
2194
@dbus_service_property(_interface,
1408
2196
access="readwrite")
1409
2197
def Checker_dbus_property(self, value=None):
1410
2198
if value is None: # get
1411
2199
return dbus.String(self.checker_command)
1412
self.checker_command = unicode(value)
2200
self.checker_command = str(value)
1414
2202
# CheckerRunning - property
1415
@dbus_service_property(_interface, signature="b",
2203
@dbus_service_property(_interface,
1416
2205
access="readwrite")
1417
2206
def CheckerRunning_dbus_property(self, value=None):
1418
2207
if value is None: # get
1451
2248
if data[0] == 'data':
1453
2250
if data[0] == 'function':
1454
2252
def func(*args, **kwargs):
1455
2253
self._pipe.send(('funcall', name, args, kwargs))
1456
2254
return self._pipe.recv()[1]
1459
2258
def __setattr__(self, name, value):
1460
2259
if name == '_pipe':
1461
2260
return super(ProxyClient, self).__setattr__(name, value)
1462
2261
self._pipe.send(('setattr', name, value))
1465
class ClientDBusTransitional(ClientDBus):
1466
__metaclass__ = AlternateDBusNamesMetaclass
1469
2264
class ClientHandler(socketserver.BaseRequestHandler, object):
1470
2265
"""A class to handle client connections.
1472
2267
Instantiated once for each connection to handle it.
1473
2268
Note: This will run in its own forked process."""
1475
2270
def handle(self):
1476
2271
with contextlib.closing(self.server.child_pipe) as child_pipe:
1477
2272
logger.info("TCP connection from: %s",
1478
unicode(self.client_address))
2273
str(self.client_address))
1479
2274
logger.debug("Pipe FD: %d",
1480
2275
self.server.child_pipe.fileno())
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",
2277
session = gnutls.ClientSession(self.request)
2279
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2280
# "+AES-256-CBC", "+SHA1",
2281
# "+COMP-NULL", "+CTYPE-OPENPGP",
1496
2283
# Use a fallback default, since this MUST be set.
1497
2284
priority = self.server.gnutls_priority
1498
2285
if priority is None:
1499
2286
priority = "NORMAL"
1500
(gnutls.library.functions
1501
.gnutls_priority_set_direct(session._c_object,
2287
gnutls.priority_set_direct(session._c_object,
2288
priority.encode("utf-8"),
1504
2291
# Start communication using the Mandos protocol
1505
2292
# Get protocol number
1506
2293
line = self.request.makefile().readline()
1507
2294
logger.debug("Protocol version: %r", line)
1509
2296
if int(line.strip().split()[0]) > 1:
2297
raise RuntimeError(line)
1511
2298
except (ValueError, IndexError, RuntimeError) as error:
1512
2299
logger.error("Unknown protocol version: %s", error)
1515
2302
# Start GnuTLS connection
1517
2304
session.handshake()
1518
except gnutls.errors.GNUTLSError as error:
2305
except gnutls.Error as error:
1519
2306
logger.warning("Handshake failed: %s", error)
1520
2307
# Do not run session.bye() here: the session is not
1521
2308
# established. Just abandon the request.
1523
2310
logger.debug("Handshake succeeded")
1525
2312
approval_required = False
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,
2314
if gnutls.has_rawpk:
2317
key_id = self.key_id(
2318
self.peer_certificate(session))
2319
except (TypeError, gnutls.Error) as error:
2320
logger.warning("Bad certificate: %s", error)
2322
logger.debug("Key ID: %s", key_id)
2327
fpr = self.fingerprint(
2328
self.peer_certificate(session))
2329
except (TypeError, gnutls.Error) as error:
2330
logger.warning("Bad certificate: %s", error)
2332
logger.debug("Fingerprint: %s", fpr)
2335
client = ProxyClient(child_pipe, key_id, fpr,
1538
2336
self.client_address)
1539
2337
except KeyError:
1542
if self.server.use_dbus:
1544
client.NewRequest(str(self.client_address))
1546
2340
if client.approval_delay:
1547
2341
delay = client.approval_delay
1548
2342
client.approvals_pending += 1
1549
2343
approval_required = True
1552
2346
if not client.enabled:
1553
2347
logger.info("Client %s is disabled",
1555
2349
if self.server.use_dbus:
1556
2350
# Emit D-Bus signal
1557
2351
client.Rejected("Disabled")
1560
2354
if client.approved or not client.approval_delay:
1561
#We are approved or approval is disabled
2355
# We are approved or approval is disabled
1563
2357
elif client.approved is None:
1564
2358
logger.info("Client %s needs approval",
1599
2391
delay -= time2 - time
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))
2394
session.send(client.secret)
2395
except gnutls.Error as error:
2396
logger.warning("gnutls send failed",
1613
2400
logger.info("Sending secret to %s", client.name)
1614
2401
# bump the timeout using extended_timeout
1615
client.checked_ok(client.extended_timeout)
2402
client.bump_timeout(client.extended_timeout)
1616
2403
if self.server.use_dbus:
1617
2404
# Emit D-Bus signal
1618
2405
client.GotSecret()
1621
2408
if approval_required:
1622
2409
client.approvals_pending -= 1
1625
except gnutls.errors.GNUTLSError as error:
1626
logger.warning("GnuTLS bye failed")
2412
except gnutls.Error as error:
2413
logger.warning("GnuTLS bye failed",
1629
2417
def peer_certificate(session):
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
2418
"Return the peer's certificate as a bytestring"
2420
cert_type = gnutls.certificate_type_get2(session._c_object,
2422
except AttributeError:
2423
cert_type = gnutls.certificate_type_get(session._c_object)
2424
if gnutls.has_rawpk:
2425
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2427
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2428
# If not a valid certificate type...
2429
if cert_type not in valid_cert_types:
2430
logger.info("Cert type %r not in %r", cert_type,
2432
# ...return invalid data
1637
2434
list_size = ctypes.c_uint(1)
1638
cert_list = (gnutls.library.functions
1639
.gnutls_certificate_get_peers
2435
cert_list = (gnutls.certificate_get_peers
1640
2436
(session._c_object, ctypes.byref(list_size)))
1641
2437
if not bool(cert_list) and list_size.value != 0:
1642
raise gnutls.errors.GNUTLSError("error getting peer"
2438
raise gnutls.Error("error getting peer certificate")
1644
2439
if list_size.value == 0:
1646
2441
cert = cert_list[0]
1647
2442
return ctypes.string_at(cert.data, cert.size)
2445
def key_id(certificate):
2446
"Convert a certificate bytestring to a hexdigit key ID"
2447
# New GnuTLS "datum" with the public key
2448
datum = gnutls.datum_t(
2449
ctypes.cast(ctypes.c_char_p(certificate),
2450
ctypes.POINTER(ctypes.c_ubyte)),
2451
ctypes.c_uint(len(certificate)))
2452
# XXX all these need to be created in the gnutls "module"
2453
# New empty GnuTLS certificate
2454
pubkey = gnutls.pubkey_t()
2455
gnutls.pubkey_init(ctypes.byref(pubkey))
2456
# Import the raw public key into the certificate
2457
gnutls.pubkey_import(pubkey,
2458
ctypes.byref(datum),
2459
gnutls.X509_FMT_DER)
2460
# New buffer for the key ID
2461
buf = ctypes.create_string_buffer(32)
2462
buf_len = ctypes.c_size_t(len(buf))
2463
# Get the key ID from the raw public key into the buffer
2464
gnutls.pubkey_get_key_id(pubkey,
2465
gnutls.KEYID_USE_SHA256,
2466
ctypes.cast(ctypes.byref(buf),
2467
ctypes.POINTER(ctypes.c_ubyte)),
2468
ctypes.byref(buf_len))
2469
# Deinit the certificate
2470
gnutls.pubkey_deinit(pubkey)
2472
# Convert the buffer to a Python bytestring
2473
key_id = ctypes.string_at(buf, buf_len.value)
2474
# Convert the bytestring to hexadecimal notation
2475
hex_key_id = binascii.hexlify(key_id).upper()
1650
2479
def fingerprint(openpgp):
1651
2480
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1652
2481
# New GnuTLS "datum" with the OpenPGP public key
1653
datum = (gnutls.library.types
1654
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1657
ctypes.c_uint(len(openpgp))))
2482
datum = gnutls.datum_t(
2483
ctypes.cast(ctypes.c_char_p(openpgp),
2484
ctypes.POINTER(ctypes.c_ubyte)),
2485
ctypes.c_uint(len(openpgp)))
1658
2486
# New empty GnuTLS certificate
1659
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1660
(gnutls.library.functions
1661
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2487
crt = gnutls.openpgp_crt_t()
2488
gnutls.openpgp_crt_init(ctypes.byref(crt))
1662
2489
# Import the OpenPGP public key into the certificate
1663
(gnutls.library.functions
1664
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1665
gnutls.library.constants
1666
.GNUTLS_OPENPGP_FMT_RAW))
2490
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2491
gnutls.OPENPGP_FMT_RAW)
1667
2492
# Verify the self signature in the key
1668
2493
crtverify = ctypes.c_uint()
1669
(gnutls.library.functions
1670
.gnutls_openpgp_crt_verify_self(crt, 0,
1671
ctypes.byref(crtverify)))
2494
gnutls.openpgp_crt_verify_self(crt, 0,
2495
ctypes.byref(crtverify))
1672
2496
if crtverify.value != 0:
1673
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1674
raise (gnutls.errors.CertificateSecurityError
2497
gnutls.openpgp_crt_deinit(crt)
2498
raise gnutls.CertificateSecurityError(code
1676
2500
# New buffer for the fingerprint
1677
2501
buf = ctypes.create_string_buffer(20)
1678
2502
buf_len = ctypes.c_size_t()
1679
2503
# Get the fingerprint from the certificate into the buffer
1680
(gnutls.library.functions
1681
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1682
ctypes.byref(buf_len)))
2504
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2505
ctypes.byref(buf_len))
1683
2506
# Deinit the certificate
1684
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2507
gnutls.openpgp_crt_deinit(crt)
1685
2508
# Convert the buffer to a Python bytestring
1686
2509
fpr = ctypes.string_at(buf, buf_len.value)
1687
2510
# Convert the bytestring to hexadecimal notation
1692
class MultiprocessingMixIn(object):
2515
class MultiprocessingMixIn:
1693
2516
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1694
2518
def sub_process_main(self, request, address):
1696
2520
self.finish_request(request, address)
1697
2521
except Exception:
1698
2522
self.handle_error(request, address)
1699
2523
self.close_request(request)
1701
2525
def process_request(self, request, address):
1702
2526
"""Start a new process to process the request."""
1703
proc = multiprocessing.Process(target = self.sub_process_main,
2527
proc = multiprocessing.Process(target=self.sub_process_main,
2528
args=(request, address))
1710
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2533
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1711
2534
""" adds a pipe to the MixIn """
1712
2536
def process_request(self, request, client_address):
1713
2537
"""Overrides and wraps the original process_request().
1715
2539
This function creates a new pipe in self.pipe
1717
2541
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1719
2543
proc = MultiprocessingMixIn.process_request(self, request,
1720
2544
client_address)
1721
2545
self.child_pipe.close()
1722
2546
self.add_pipe(parent_pipe, proc)
1724
2548
def add_pipe(self, parent_pipe, proc):
1725
2549
"""Dummy function; override as necessary"""
1726
raise NotImplementedError
2550
raise NotImplementedError()
1729
2553
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1730
socketserver.TCPServer, object):
2554
socketserver.TCPServer):
1731
2555
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1734
2558
enabled: Boolean; whether this server is activated yet
1735
2559
interface: None or a network interface name (string)
1736
2560
use_ipv6: Boolean; to use IPv6 or not
1738
2563
def __init__(self, server_address, RequestHandlerClass,
1739
interface=None, use_ipv6=True):
2567
"""If socketfd is set, use that file descriptor instead of
2568
creating a new one with socket.socket().
1740
2570
self.interface = interface
1742
2572
self.address_family = socket.AF_INET6
2573
if socketfd is not None:
2574
# Save the file descriptor
2575
self.socketfd = socketfd
2576
# Save the original socket.socket() function
2577
self.socket_socket = socket.socket
2579
# To implement --socket, we monkey patch socket.socket.
2581
# (When socketserver.TCPServer is a new-style class, we
2582
# could make self.socket into a property instead of monkey
2583
# patching socket.socket.)
2585
# Create a one-time-only replacement for socket.socket()
2586
@functools.wraps(socket.socket)
2587
def socket_wrapper(*args, **kwargs):
2588
# Restore original function so subsequent calls are
2590
socket.socket = self.socket_socket
2591
del self.socket_socket
2592
# This time only, return a new socket object from the
2593
# saved file descriptor.
2594
return socket.fromfd(self.socketfd, *args, **kwargs)
2595
# Replace socket.socket() function with wrapper
2596
socket.socket = socket_wrapper
2597
# The socketserver.TCPServer.__init__ will call
2598
# socket.socket(), which might be our replacement,
2599
# socket_wrapper(), if socketfd was set.
1743
2600
socketserver.TCPServer.__init__(self, server_address,
1744
2601
RequestHandlerClass)
1745
2603
def server_bind(self):
1746
2604
"""This overrides the normal server_bind() function
1747
2605
to bind to an interface if one was specified, and also NOT to
1748
2606
bind to an address or port if they were not specified."""
2607
global SO_BINDTODEVICE
1749
2608
if self.interface is not None:
1750
2609
if SO_BINDTODEVICE is None:
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",
2610
# Fall back to a hard-coded value which seems to be
2612
logger.warning("SO_BINDTODEVICE not found, trying 25")
2613
SO_BINDTODEVICE = 25
2615
self.socket.setsockopt(
2616
socket.SOL_SOCKET, SO_BINDTODEVICE,
2617
(self.interface + "\0").encode("utf-8"))
2618
except socket.error as error:
2619
if error.errno == errno.EPERM:
2620
logger.error("No permission to bind to"
2621
" interface %s", self.interface)
2622
elif error.errno == errno.ENOPROTOOPT:
2623
logger.error("SO_BINDTODEVICE not available;"
2624
" cannot bind to interface %s",
2626
elif error.errno == errno.ENODEV:
2627
logger.error("Interface %s does not exist,"
2628
" cannot bind", self.interface)
1771
2631
# Only bind(2) the socket if we really need to.
1772
2632
if self.server_address[0] or self.server_address[1]:
2633
if self.server_address[1]:
2634
self.allow_reuse_address = True
1773
2635
if not self.server_address[0]:
1774
2636
if self.address_family == socket.AF_INET6:
1775
any_address = "::" # in6addr_any
2637
any_address = "::" # in6addr_any
1777
any_address = socket.INADDR_ANY
2639
any_address = "0.0.0.0" # INADDR_ANY
1778
2640
self.server_address = (any_address,
1779
2641
self.server_address[1])
1780
2642
elif not self.server_address[1]:
1781
self.server_address = (self.server_address[0],
2643
self.server_address = (self.server_address[0], 0)
1783
2644
# if self.interface:
1784
2645
# self.server_address = (self.server_address[0],
1888
2749
funcname = request[1]
1889
2750
args = request[2]
1890
2751
kwargs = request[3]
1892
2753
parent_pipe.send(('data', getattr(client_object,
1893
2754
funcname)(*args,
1896
2757
if command == 'getattr':
1897
2758
attrname = request[1]
1898
if callable(client_object.__getattribute__(attrname)):
1899
parent_pipe.send(('function',))
2759
if isinstance(client_object.__getattribute__(attrname),
2760
collections.abc.Callable):
2761
parent_pipe.send(('function', ))
1901
parent_pipe.send(('data', client_object
1902
.__getattribute__(attrname)))
2764
'data', client_object.__getattribute__(attrname)))
1904
2766
if command == 'setattr':
1905
2767
attrname = request[1]
1906
2768
value = request[2]
1907
2769
setattr(client_object, attrname, value)
2774
def rfc3339_duration_to_delta(duration):
2775
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2777
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2779
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2781
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2783
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2785
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2787
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2789
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2793
# Parsing an RFC 3339 duration with regular expressions is not
2794
# possible - there would have to be multiple places for the same
2795
# values, like seconds. The current code, while more esoteric, is
2796
# cleaner without depending on a parsing library. If Python had a
2797
# built-in library for parsing we would use it, but we'd like to
2798
# avoid excessive use of external libraries.
2800
# New type for defining tokens, syntax, and semantics all-in-one
2801
Token = collections.namedtuple("Token", (
2802
"regexp", # To match token; if "value" is not None, must have
2803
# a "group" containing digits
2804
"value", # datetime.timedelta or None
2805
"followers")) # Tokens valid after this token
2806
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2807
# the "duration" ABNF definition in RFC 3339, Appendix A.
2808
token_end = Token(re.compile(r"$"), None, frozenset())
2809
token_second = Token(re.compile(r"(\d+)S"),
2810
datetime.timedelta(seconds=1),
2811
frozenset((token_end, )))
2812
token_minute = Token(re.compile(r"(\d+)M"),
2813
datetime.timedelta(minutes=1),
2814
frozenset((token_second, token_end)))
2815
token_hour = Token(re.compile(r"(\d+)H"),
2816
datetime.timedelta(hours=1),
2817
frozenset((token_minute, token_end)))
2818
token_time = Token(re.compile(r"T"),
2820
frozenset((token_hour, token_minute,
2822
token_day = Token(re.compile(r"(\d+)D"),
2823
datetime.timedelta(days=1),
2824
frozenset((token_time, token_end)))
2825
token_month = Token(re.compile(r"(\d+)M"),
2826
datetime.timedelta(weeks=4),
2827
frozenset((token_day, token_end)))
2828
token_year = Token(re.compile(r"(\d+)Y"),
2829
datetime.timedelta(weeks=52),
2830
frozenset((token_month, token_end)))
2831
token_week = Token(re.compile(r"(\d+)W"),
2832
datetime.timedelta(weeks=1),
2833
frozenset((token_end, )))
2834
token_duration = Token(re.compile(r"P"), None,
2835
frozenset((token_year, token_month,
2836
token_day, token_time,
2838
# Define starting values:
2840
value = datetime.timedelta()
2842
# Following valid tokens
2843
followers = frozenset((token_duration, ))
2844
# String left to parse
2846
# Loop until end token is found
2847
while found_token is not token_end:
2848
# Search for any currently valid tokens
2849
for token in followers:
2850
match = token.regexp.match(s)
2851
if match is not None:
2853
if token.value is not None:
2854
# Value found, parse digits
2855
factor = int(match.group(1), 10)
2856
# Add to value so far
2857
value += factor * token.value
2858
# Strip token from string
2859
s = token.regexp.sub("", s, 1)
2862
# Set valid next tokens
2863
followers = found_token.followers
2866
# No currently valid tokens were found
2867
raise ValueError("Invalid RFC 3339 duration: {!r}"
1912
2873
def string_to_delta(interval):
1913
2874
"""Parse a string and return a datetime.timedelta
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)
2876
>>> string_to_delta('7d') == datetime.timedelta(7)
2878
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2880
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2882
>>> string_to_delta('24h') == datetime.timedelta(1)
2884
>>> string_to_delta('1w') == datetime.timedelta(7)
2886
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2891
return rfc3339_duration_to_delta(interval)
1928
2895
timevalue = datetime.timedelta(0)
1929
2896
for s in interval.split():
1931
suffix = unicode(s[-1])
1932
2899
value = int(s[:-1])
1933
2900
if suffix == "d":
1934
2901
delta = datetime.timedelta(value)
2006
2973
parser.add_argument("--no-dbus", action="store_false",
2007
2974
dest="use_dbus", help="Do not provide D-Bus"
2008
" system bus interface")
2975
" system bus interface", default=None)
2009
2976
parser.add_argument("--no-ipv6", action="store_false",
2010
dest="use_ipv6", help="Do not use IPv6")
2977
dest="use_ipv6", help="Do not use IPv6",
2011
2979
parser.add_argument("--no-restore", action="store_false",
2012
2980
dest="restore", help="Do not restore stored"
2981
" state", default=None)
2982
parser.add_argument("--socket", type=int,
2983
help="Specify a file descriptor to a network"
2984
" socket to use instead of creating one")
2014
2985
parser.add_argument("--statedir", metavar="DIR",
2015
2986
help="Directory to save/restore state in")
2987
parser.add_argument("--foreground", action="store_true",
2988
help="Run in foreground", default=None)
2989
parser.add_argument("--no-zeroconf", action="store_false",
2990
dest="zeroconf", help="Do not use Zeroconf",
2017
2993
options = parser.parse_args()
2024
2995
# Default values for config file for server-global settings
2025
server_defaults = { "interface": "",
2030
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2031
"servicename": "Mandos",
2036
"statedir": "/var/lib/mandos"
2996
if gnutls.has_rawpk:
2997
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2998
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3000
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3001
":+SIGN-DSA-SHA256")
3002
server_defaults = {"interface": "",
3006
"priority": priority,
3007
"servicename": "Mandos",
3013
"statedir": "/var/lib/mandos",
3014
"foreground": "False",
2039
3019
# Parse config file for server-global settings
2040
server_config = configparser.SafeConfigParser(server_defaults)
3020
server_config = configparser.ConfigParser(server_defaults)
2041
3021
del server_defaults
2042
server_config.read(os.path.join(options.configdir,
2044
# Convert the SafeConfigParser object to a dict
3022
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3023
# Convert the ConfigParser object to a dict
2045
3024
server_settings = server_config.defaults()
2046
3025
# Use the appropriate methods on the non-string config options
2047
for option in ("debug", "use_dbus", "use_ipv6"):
3026
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3027
"foreground", "zeroconf"):
2048
3028
server_settings[option] = server_config.getboolean("DEFAULT",
2050
3030
if server_settings["port"]:
2051
3031
server_settings["port"] = server_config.getint("DEFAULT",
3033
if server_settings["socket"]:
3034
server_settings["socket"] = server_config.getint("DEFAULT",
3036
# Later, stdin will, and stdout and stderr might, be dup'ed
3037
# over with an opened os.devnull. But we don't want this to
3038
# happen with a supplied network socket.
3039
if 0 <= server_settings["socket"] <= 2:
3040
server_settings["socket"] = os.dup(server_settings
2053
3042
del server_config
2055
3044
# Override the settings from the config file with command line
2056
3045
# options, if set.
2057
3046
for option in ("interface", "address", "port", "debug",
2058
"priority", "servicename", "configdir",
2059
"use_dbus", "use_ipv6", "debuglevel", "restore",
3047
"priority", "servicename", "configdir", "use_dbus",
3048
"use_ipv6", "debuglevel", "restore", "statedir",
3049
"socket", "foreground", "zeroconf"):
2061
3050
value = getattr(options, option)
2062
3051
if value is not None:
2063
3052
server_settings[option] = value
2065
3054
# Force all strings to be unicode
2066
3055
for option in server_settings.keys():
2067
if type(server_settings[option]) is str:
2068
server_settings[option] = unicode(server_settings[option])
3056
if isinstance(server_settings[option], bytes):
3057
server_settings[option] = (server_settings[option]
3059
# Force all boolean options to be boolean
3060
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3061
"foreground", "zeroconf"):
3062
server_settings[option] = bool(server_settings[option])
3063
# Debug implies foreground
3064
if server_settings["debug"]:
3065
server_settings["foreground"] = True
2069
3066
# Now we have our good server settings in "server_settings"
2071
3068
##################################################################
3070
if (not server_settings["zeroconf"]
3071
and not (server_settings["port"]
3072
or server_settings["socket"] != "")):
3073
parser.error("Needs port or socket to work without Zeroconf")
2073
3075
# For convenience
2074
3076
debug = server_settings["debug"]
2075
3077
debuglevel = server_settings["debuglevel"]
2087
3091
level = getattr(logging, debuglevel.upper())
2088
3092
initlogger(debug, level)
2090
3094
if server_settings["servicename"] != "Mandos":
2091
syslogger.setFormatter(logging.Formatter
2092
('Mandos (%s) [%%(process)d]:'
2093
' %%(levelname)s: %%(message)s'
2094
% server_settings["servicename"]))
3095
syslogger.setFormatter(
3096
logging.Formatter('Mandos ({}) [%(process)d]:'
3097
' %(levelname)s: %(message)s'.format(
3098
server_settings["servicename"])))
2096
3100
# Parse config file with clients
2097
client_config = configparser.SafeConfigParser(Client.client_defaults)
3101
client_config = configparser.ConfigParser(Client.client_defaults)
2098
3102
client_config.read(os.path.join(server_settings["configdir"],
2099
3103
"clients.conf"))
2101
3105
global mandos_dbus_service
2102
3106
mandos_dbus_service = None
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
3109
if server_settings["socket"] != "":
3110
socketfd = server_settings["socket"]
3111
tcp_server = MandosServer(
3112
(server_settings["address"], server_settings["port"]),
3114
interface=(server_settings["interface"] or None),
3116
gnutls_priority=server_settings["priority"],
3120
pidfilename = "/run/mandos.pid"
3121
if not os.path.isdir("/run/."):
3122
pidfilename = "/var/run/mandos.pid"
3125
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3126
except IOError as e:
3127
logger.error("Could not open file %r", pidfilename,
3130
for name, group in (("_mandos", "_mandos"),
3131
("mandos", "mandos"),
3132
("nobody", "nogroup")):
3134
uid = pwd.getpwnam(name).pw_uid
3135
gid = pwd.getpwnam(group).pw_gid
2127
3137
except KeyError:
2129
uid = pwd.getpwnam("nobody").pw_uid
2130
gid = pwd.getpwnam("nobody").pw_gid
3146
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2137
3148
except OSError as error:
2138
if error[0] != errno.EPERM:
3149
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3150
.format(uid, gid, os.strerror(error.errno)))
3151
if error.errno != errno.EPERM:
2142
3155
# Enable all possible GnuTLS debugging
2144
3157
# "Use a log level over 10 to enable all debugging options."
2145
3158
# - GnuTLS manual
2146
gnutls.library.functions.gnutls_global_set_log_level(11)
2148
@gnutls.library.types.gnutls_log_func
3159
gnutls.global_set_log_level(11)
2149
3162
def debug_gnutls(level, string):
2150
3163
logger.debug("GnuTLS: %s", string[:-1])
2152
(gnutls.library.functions
2153
.gnutls_global_set_log_function(debug_gnutls))
3165
gnutls.global_set_log_function(debug_gnutls)
2155
3167
# Redirect stdin so all checkers get /dev/null
2156
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3168
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2157
3169
os.dup2(null, sys.stdin.fileno())
2161
3173
# Need to fork before connecting to D-Bus
2163
3175
# Close all input and output, do double fork, etc.
2166
gobject.threads_init()
3178
if gi.version_info < (3, 10, 2):
3179
# multiprocessing will use threads, so before we use GLib we
3180
# need to inform GLib that threads will be used.
2168
3183
global main_loop
2169
3184
# From the Avahi example code
2170
DBusGMainLoop(set_as_default=True )
2171
main_loop = gobject.MainLoop()
3185
DBusGMainLoop(set_as_default=True)
3186
main_loop = GLib.MainLoop()
2172
3187
bus = dbus.SystemBus()
2173
3188
# End of Avahi example code
2176
3191
bus_name = dbus.service.BusName("se.recompile.Mandos",
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")
3194
old_bus_name = dbus.service.BusName(
3195
"se.bsnet.fukt.Mandos", bus,
3197
except dbus.exceptions.DBusException as e:
3198
logger.error("Disabling D-Bus:", exc_info=e)
2183
3199
use_dbus = False
2184
3200
server_settings["use_dbus"] = False
2185
3201
tcp_server.use_dbus = False
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"])))
3203
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3204
service = AvahiServiceToSyslog(
3205
name=server_settings["servicename"],
3206
servicetype="_mandos._tcp",
3209
if server_settings["interface"]:
3210
service.interface = if_nametoindex(
3211
server_settings["interface"].encode("utf-8"))
2195
3213
global multiprocessing_manager
2196
3214
multiprocessing_manager = multiprocessing.Manager()
2198
3216
client_class = Client
2200
client_class = functools.partial(ClientDBusTransitional,
3218
client_class = functools.partial(ClientDBus, bus=bus)
2203
3220
client_settings = Client.config_parser(client_config)
2204
3221
old_client_settings = {}
2205
3222
clients_data = {}
3224
# This is used to redirect stdout and stderr for checker processes
3226
wnull = open(os.devnull, "w") # A writable /dev/null
3227
# Only used if server is running in foreground but not in debug
3229
if debug or not foreground:
2207
3232
# Get client data and settings from last running state.
2208
3233
if server_settings["restore"]:
2210
3235
with open(stored_state_path, "rb") as stored_state:
2211
clients_data, old_client_settings = (pickle.load
3236
if sys.version_info.major == 2:
3237
clients_data, old_client_settings = pickle.load(
3240
bytes_clients_data, bytes_old_client_settings = (
3241
pickle.load(stored_state, encoding="bytes"))
3242
# Fix bytes to strings
3245
clients_data = {(key.decode("utf-8")
3246
if isinstance(key, bytes)
3249
bytes_clients_data.items()}
3250
del bytes_clients_data
3251
for key in clients_data:
3252
value = {(k.decode("utf-8")
3253
if isinstance(k, bytes) else k): v
3255
clients_data[key].items()}
3256
clients_data[key] = value
3258
value["client_structure"] = [
3260
if isinstance(s, bytes)
3262
value["client_structure"]]
3263
# .name, .host, and .checker_command
3264
for k in ("name", "host", "checker_command"):
3265
if isinstance(value[k], bytes):
3266
value[k] = value[k].decode("utf-8")
3267
if "key_id" not in value:
3268
value["key_id"] = ""
3269
elif "fingerprint" not in value:
3270
value["fingerprint"] = ""
3271
# old_client_settings
3273
old_client_settings = {
3274
(key.decode("utf-8")
3275
if isinstance(key, bytes)
3278
bytes_old_client_settings.items()}
3279
del bytes_old_client_settings
3280
# .host and .checker_command
3281
for value in old_client_settings.values():
3282
for attribute in ("host", "checker_command"):
3283
if isinstance(value[attribute], bytes):
3284
value[attribute] = (value[attribute]
2213
3286
os.remove(stored_state_path)
2214
3287
except IOError as e:
2215
logger.warning("Could not load persistent state: {0}"
2217
if e.errno != errno.ENOENT:
3288
if e.errno == errno.ENOENT:
3289
logger.warning("Could not load persistent state:"
3290
" {}".format(os.strerror(e.errno)))
3292
logger.critical("Could not load persistent state:",
2219
3295
except EOFError as e:
2220
3296
logger.warning("Could not load persistent state: "
2221
"EOFError: {0}".format(e))
2223
3300
with PGPEngine() as pgp:
2224
for client_name, client in clients_data.iteritems():
3301
for client_name, client in clients_data.items():
3302
# Skip removed clients
3303
if client_name not in client_settings:
2225
3306
# Decide which value to use after restoring saved state.
2226
3307
# We have three different values: Old config file,
2227
3308
# new config file, and saved state.
2232
3313
# For each value in new config, check if it
2233
3314
# differs from the old config value (Except for
2234
3315
# the "secret" attribute)
2235
if (name != "secret" and
2236
value != old_client_settings[client_name]
3316
if (name != "secret"
3318
old_client_settings[client_name][name])):
2238
3319
client[name] = value
2239
3320
except KeyError:
2242
3323
# Clients who has passed its expire date can still be
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.
3324
# enabled if its last checker was successful. A Client
3325
# whose checker succeeded before we stored its state is
3326
# assumed to have successfully run all checkers during
2246
3328
if client["enabled"]:
2247
3329
if datetime.datetime.utcnow() >= client["expires"]:
2248
3330
if not client["last_checked_ok"]:
2249
3331
logger.warning(
2250
"disabling client {0} - Client never "
2251
"performed a successfull checker"
2252
.format(client["name"]))
3332
"disabling client {} - Client never "
3333
"performed a successful checker".format(
2253
3335
client["enabled"] = False
2254
3336
elif client["last_checker_status"] != 0:
2255
3337
logger.warning(
2256
"disabling client {0} - Client "
2257
"last checker failed with error code {1}"
2258
.format(client["name"],
2259
client["last_checker_status"]))
3338
"disabling client {} - Client last"
3339
" checker failed with error code"
3342
client["last_checker_status"]))
2260
3343
client["enabled"] = False
2262
client["expires"] = (datetime.datetime
2264
+ client["timeout"])
3345
client["expires"] = (
3346
datetime.datetime.utcnow()
3347
+ client["timeout"])
3348
logger.debug("Last checker succeeded,"
3349
" keeping {} enabled".format(
2267
client["secret"] = (
2268
pgp.decrypt(client["encrypted_secret"],
2269
client_settings[client_name]
3352
client["secret"] = pgp.decrypt(
3353
client["encrypted_secret"],
3354
client_settings[client_name]["secret"])
2271
3355
except PGPError:
2272
3356
# If decryption fails, we use secret from new settings
2273
logger.debug("Failed to decrypt {0} old secret"
2274
.format(client_name))
2275
client["secret"] = (
2276
client_settings[client_name]["secret"])
3357
logger.debug("Failed to decrypt {} old secret".format(
3359
client["secret"] = (client_settings[client_name]
2279
3362
# Add/remove clients based on new changes made to config
2280
for client_name in set(old_client_settings) - set(client_settings):
3363
for client_name in (set(old_client_settings)
3364
- set(client_settings)):
2281
3365
del clients_data[client_name]
2282
for client_name in set(client_settings) - set(old_client_settings):
3366
for client_name in (set(client_settings)
3367
- set(old_client_settings)):
2283
3368
clients_data[client_name] = client_settings[client_name]
2285
# Create clients all clients
2286
for client_name, client in clients_data.iteritems():
3370
# Create all client objects
3371
for client_name, client in clients_data.items():
2287
3372
tcp_server.clients[client_name] = client_class(
2288
name = client_name, settings = client)
3375
server_settings=server_settings)
2290
3377
if not tcp_server.clients:
2291
3378
logger.warning("No clients defined")
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
if pidfile is not None:
3385
print(pid, file=pidfile)
3387
logger.error("Could not write to file %r with PID %d",
2305
3390
del pidfilename
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())
3392
for termsig in (signal.SIGHUP, signal.SIGTERM):
3393
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3394
lambda: main_loop.quit() and False)
2312
class MandosDBusService(dbus.service.Object):
3398
@alternate_dbus_interfaces(
3399
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3400
class MandosDBusService(DBusObjectWithObjectManager):
2313
3401
"""A D-Bus proxy object"""
2314
3403
def __init__(self):
2315
3404
dbus.service.Object.__init__(self, bus, "/")
2316
3406
_interface = "se.recompile.Mandos"
2318
3408
@dbus.service.signal(_interface, signature="o")
2319
3409
def ClientAdded(self, objpath):
2323
3413
@dbus.service.signal(_interface, signature="ss")
2324
def ClientNotFound(self, fingerprint, address):
3414
def ClientNotFound(self, key_id, address):
3418
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2328
3420
@dbus.service.signal(_interface, signature="os")
2329
3421
def ClientRemoved(self, objpath, name):
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2333
3427
@dbus.service.method(_interface, out_signature="ao")
2334
3428
def GetAllClients(self):
2336
return dbus.Array(c.dbus_object_path
2338
tcp_server.clients.itervalues())
3430
return dbus.Array(c.dbus_object_path for c in
3431
tcp_server.clients.values())
3433
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2340
3435
@dbus.service.method(_interface,
2341
3436
out_signature="a{oa{sv}}")
2342
3437
def GetAllClientsWithProperties(self):
2344
3439
return dbus.Dictionary(
2345
((c.dbus_object_path, c.GetAll(""))
2346
for c in tcp_server.clients.itervalues()),
3440
{c.dbus_object_path: c.GetAll(
3441
"se.recompile.Mandos.Client")
3442
for c in tcp_server.clients.values()},
2347
3443
signature="oa{sv}")
2349
3445
@dbus.service.method(_interface, in_signature="o")
2350
3446
def RemoveClient(self, object_path):
2352
for c in tcp_server.clients.itervalues():
3448
for c in tcp_server.clients.values():
2353
3449
if c.dbus_object_path == object_path:
2354
3450
del tcp_server.clients[c.name]
2355
3451
c.remove_from_connection()
2356
# Don't signal anything except ClientRemoved
3452
# Don't signal the disabling
2357
3453
c.disable(quiet=True)
2359
self.ClientRemoved(object_path, c.name)
3454
# Emit D-Bus signal for removal
3455
self.client_removed_signal(c)
2361
3457
raise KeyError(object_path)
2365
class MandosDBusServiceTransitional(MandosDBusService):
2366
__metaclass__ = AlternateDBusNamesMetaclass
2367
mandos_dbus_service = MandosDBusServiceTransitional()
3461
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3462
out_signature="a{oa{sa{sv}}}")
3463
def GetManagedObjects(self):
3465
return dbus.Dictionary(
3466
{client.dbus_object_path:
3468
{interface: client.GetAll(interface)
3470
client._get_all_interface_names()})
3471
for client in tcp_server.clients.values()})
3473
def client_added_signal(self, client):
3474
"""Send the new standard signal and the old signal"""
3476
# New standard signal
3477
self.InterfacesAdded(
3478
client.dbus_object_path,
3480
{interface: client.GetAll(interface)
3482
client._get_all_interface_names()}))
3484
self.ClientAdded(client.dbus_object_path)
3486
def client_removed_signal(self, client):
3487
"""Send the new standard signal and the old signal"""
3489
# New standard signal
3490
self.InterfacesRemoved(
3491
client.dbus_object_path,
3492
client._get_all_interface_names())
3494
self.ClientRemoved(client.dbus_object_path,
3497
mandos_dbus_service = MandosDBusService()
3499
# Save modules to variables to exempt the modules from being
3500
# unloaded before the function registered with atexit() is run.
3501
mp = multiprocessing
2370
3505
"Cleanup function; run on exit"
2373
multiprocessing.active_children()
3509
mp.active_children()
2374
3511
if not (tcp_server.clients or client_settings):
2377
3514
# Store client before exiting. Secrets are encrypted with key
2378
3515
# based on what config file has. If config file is
2379
3516
# removed/edited, old secret will thus be unrecovable.
2381
3518
with PGPEngine() as pgp:
2382
for client in tcp_server.clients.itervalues():
3519
for client in tcp_server.clients.values():
2383
3520
key = client_settings[client.name]["secret"]
2384
3521
client.encrypted_secret = pgp.encrypt(client.secret,
2386
3523
client_dict = {}
2388
3525
# A list of attributes that can not be pickled
2390
exclude = set(("bus", "changedstate", "secret",
2392
for name, typ in (inspect.getmembers
2393
(dbus.service.Object)):
3527
exclude = {"bus", "changedstate", "secret",
3528
"checker", "server_settings"}
3529
for name, typ in inspect.getmembers(dbus.service
2394
3531
exclude.add(name)
2396
3533
client_dict["encrypted_secret"] = (client
2397
3534
.encrypted_secret)
2398
3535
for attr in client.client_structure:
2399
3536
if attr not in exclude:
2400
3537
client_dict[attr] = getattr(client, attr)
2402
3539
clients[client.name] = client_dict
2403
3540
del client_settings[client.name]["secret"]
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
with tempfile.NamedTemporaryFile(
3547
dir=os.path.dirname(stored_state_path),
3548
delete=False) as stored_state:
3549
pickle.dump((clients, client_settings), stored_state,
3551
tempname = stored_state.name
2412
3552
os.rename(tempname, stored_state_path)
2413
3553
except (IOError, OSError) as e:
2414
logger.warning("Could not save persistent state: {0}"
2418
3556
os.remove(tempname)
2419
3557
except NameError:
2421
if e.errno not in set((errno.ENOENT, errno.EACCES,
3559
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3560
logger.warning("Could not save persistent state: {}"
3561
.format(os.strerror(e.errno)))
3563
logger.warning("Could not save persistent state:",
2425
3567
# Delete all clients, and settings from config
2426
3568
while tcp_server.clients:
2427
3569
name, client = tcp_server.clients.popitem()
2429
3571
client.remove_from_connection()
2430
# Don't signal anything except ClientRemoved
3572
# Don't signal the disabling
2431
3573
client.disable(quiet=True)
3574
# Emit D-Bus signal for removal
2434
mandos_dbus_service.ClientRemoved(client
3576
mandos_dbus_service.client_removed_signal(client)
2437
3577
client_settings.clear()
2439
3579
atexit.register(cleanup)
2441
for client in tcp_server.clients.itervalues():
3581
for client in tcp_server.clients.values():
2444
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3583
# Emit D-Bus signal for adding
3584
mandos_dbus_service.client_added_signal(client)
2445
3585
# Need to initiate checking of clients
2446
3586
if client.enabled:
2447
3587
client.init_checker()
2449
3589
tcp_server.enable()
2450
3590
tcp_server.server_activate()
2452
3592
# Find out what port we got
2453
service.port = tcp_server.socket.getsockname()[1]
3594
service.port = tcp_server.socket.getsockname()[1]
2455
3596
logger.info("Now listening on address %r, port %d,"
2456
" flowinfo %d, scope_id %d"
2457
% tcp_server.socket.getsockname())
3597
" flowinfo %d, scope_id %d",
3598
*tcp_server.socket.getsockname())
2459
logger.info("Now listening on address %r, port %d"
2460
% tcp_server.socket.getsockname())
2462
#service.interface = tcp_server.socket.getsockname()[3]
3600
logger.info("Now listening on address %r, port %d",
3601
*tcp_server.socket.getsockname())
3603
# service.interface = tcp_server.socket.getsockname()[3]
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))
3607
# From the Avahi example code
3610
except dbus.exceptions.DBusException as error:
3611
logger.critical("D-Bus Exception", exc_info=error)
3614
# End of Avahi example code
3617
GLib.IOChannel.unix_new(tcp_server.fileno()),
3618
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3619
lambda *args, **kwargs: (tcp_server.handle_request
3620
(*args[2:], **kwargs) or True))
2479
3622
logger.debug("Starting main loop")
2480
3623
main_loop.run()
2481
3624
except AvahiError as error:
2482
logger.critical("AvahiError: %s", error)
3625
logger.critical("Avahi Error", exc_info=error)
2485
3628
except KeyboardInterrupt: