166
240
os.rmdir(self.tempdir)
167
241
self.tempdir = None
169
243
def password_encode(self, password):
170
244
# Passphrase can not be empty and can not contain newlines or
171
245
# NUL bytes. So we prefix it and hex encode it.
172
return b"mandos" + binascii.hexlify(password)
246
encoded = b"mandos" + binascii.hexlify(password)
247
if len(encoded) > 2048:
248
# GnuPG can't handle long passwords, so encode differently
249
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
250
.replace(b"\n", b"\\n")
251
.replace(b"\0", b"\\x00"))
174
254
def encrypt(self, data, password):
175
self.gnupg.passphrase = self.password_encode(password)
176
with open(os.devnull) as devnull:
178
proc = self.gnupg.run(['--symmetric'],
179
create_fhs=['stdin', 'stdout'],
180
attach_fhs={'stderr': devnull})
181
with contextlib.closing(proc.handles['stdin']) as f:
183
with contextlib.closing(proc.handles['stdout']) as f:
184
ciphertext = f.read()
188
self.gnupg.passphrase = None
255
passphrase = self.password_encode(password)
256
with tempfile.NamedTemporaryFile(
257
dir=self.tempdir) as passfile:
258
passfile.write(passphrase)
260
proc = subprocess.Popen([self.gpg, '--symmetric',
264
stdin=subprocess.PIPE,
265
stdout=subprocess.PIPE,
266
stderr=subprocess.PIPE)
267
ciphertext, err = proc.communicate(input=data)
268
if proc.returncode != 0:
189
270
return ciphertext
191
272
def decrypt(self, data, password):
192
self.gnupg.passphrase = self.password_encode(password)
193
with open(os.devnull) as devnull:
195
proc = self.gnupg.run(['--decrypt'],
196
create_fhs=['stdin', 'stdout'],
197
attach_fhs={'stderr': devnull})
198
with contextlib.closing(proc.handles['stdin'] ) as f:
200
with contextlib.closing(proc.handles['stdout']) as f:
201
decrypted_plaintext = f.read()
205
self.gnupg.passphrase = None
273
passphrase = self.password_encode(password)
274
with tempfile.NamedTemporaryFile(
275
dir=self.tempdir) as passfile:
276
passfile.write(passphrase)
278
proc = subprocess.Popen([self.gpg, '--decrypt',
282
stdin=subprocess.PIPE,
283
stdout=subprocess.PIPE,
284
stderr=subprocess.PIPE)
285
decrypted_plaintext, err = proc.communicate(input=data)
286
if proc.returncode != 0:
206
288
return decrypted_plaintext
291
# Pretend that we have an Avahi module
293
"""This isn't so much a class as it is a module-like namespace."""
294
IF_UNSPEC = -1 # avahi-common/address.h
295
PROTO_UNSPEC = -1 # avahi-common/address.h
296
PROTO_INET = 0 # avahi-common/address.h
297
PROTO_INET6 = 1 # avahi-common/address.h
298
DBUS_NAME = "org.freedesktop.Avahi"
299
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
300
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
301
DBUS_PATH_SERVER = "/"
304
def string_array_to_txt_array(t):
305
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
306
for s in t), signature="ay")
307
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
308
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
309
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
310
SERVER_INVALID = 0 # avahi-common/defs.h
311
SERVER_REGISTERING = 1 # avahi-common/defs.h
312
SERVER_RUNNING = 2 # avahi-common/defs.h
313
SERVER_COLLISION = 3 # avahi-common/defs.h
314
SERVER_FAILURE = 4 # avahi-common/defs.h
210
317
class AvahiError(Exception):
211
318
def __init__(self, value, *args, **kwargs):
212
319
self.value = value
213
super(AvahiError, self).__init__(value, *args, **kwargs)
214
def __unicode__(self):
215
return unicode(repr(self.value))
320
return super(AvahiError, self).__init__(value, *args,
217
324
class AvahiServiceError(AvahiError):
220
328
class AvahiGroupError(AvahiError):
224
class AvahiService(object):
225
333
"""An Avahi (Zeroconf) service.
228
336
interface: integer; avahi.IF_UNSPEC or an interface index.
229
337
Used to optionally bind to the specified interface.
230
338
name: string; Example: 'Mandos'
231
339
type: string; Example: '_mandos._tcp'.
232
See <http://www.dns-sd.org/ServiceTypes.html>
340
See <https://www.iana.org/assignments/service-names-port-numbers>
233
341
port: integer; what port to announce
234
342
TXT: list of strings; TXT record for the service
235
343
domain: string; Domain to publish on, default to .local if empty.
364
502
follow_name_owner_changes=True),
365
503
avahi.DBUS_INTERFACE_SERVER)
366
504
self.server.connect_to_signal("StateChanged",
367
self.server_state_changed)
505
self.server_state_changed)
368
506
self.server_state_changed(self.server.GetState())
370
509
class AvahiServiceToSyslog(AvahiService):
510
def rename(self, *args, **kwargs):
372
511
"""Add the new name to the syslog messages"""
373
ret = AvahiService.rename(self)
374
syslogger.setFormatter(logging.Formatter
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
512
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
513
syslogger.setFormatter(logging.Formatter(
514
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
380
def timedelta_to_milliseconds(td):
381
"Convert a datetime.timedelta() to milliseconds"
382
return ((td.days * 24 * 60 * 60 * 1000)
383
+ (td.seconds * 1000)
384
+ (td.microseconds // 1000))
386
class Client(object):
519
# Pretend that we have a GnuTLS module
521
"""This isn't so much a class as it is a module-like namespace."""
523
library = ctypes.util.find_library("gnutls")
525
library = ctypes.util.find_library("gnutls-deb0")
526
_library = ctypes.cdll.LoadLibrary(library)
529
# Unless otherwise indicated, the constants and types below are
530
# all from the gnutls/gnutls.h C header file.
541
E_NO_CERTIFICATE_FOUND = -49
546
KEYID_USE_SHA256 = 1 # gnutls/x509.h
547
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
550
class session_int(ctypes.Structure):
552
session_t = ctypes.POINTER(session_int)
554
class certificate_credentials_st(ctypes.Structure):
556
certificate_credentials_t = ctypes.POINTER(
557
certificate_credentials_st)
558
certificate_type_t = ctypes.c_int
560
class datum_t(ctypes.Structure):
561
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
562
('size', ctypes.c_uint)]
564
class openpgp_crt_int(ctypes.Structure):
566
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
567
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
568
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
569
credentials_type_t = ctypes.c_int
570
transport_ptr_t = ctypes.c_void_p
571
close_request_t = ctypes.c_int
574
class Error(Exception):
575
def __init__(self, message=None, code=None, args=()):
576
# Default usage is by a message string, but if a return
577
# code is passed, convert it to a string with
580
if message is None and code is not None:
581
message = gnutls.strerror(code)
582
return super(gnutls.Error, self).__init__(
585
class CertificateSecurityError(Error):
591
self._c_object = gnutls.certificate_credentials_t()
592
gnutls.certificate_allocate_credentials(
593
ctypes.byref(self._c_object))
594
self.type = gnutls.CRD_CERTIFICATE
597
gnutls.certificate_free_credentials(self._c_object)
600
def __init__(self, socket, credentials=None):
601
self._c_object = gnutls.session_t()
602
gnutls_flags = gnutls.CLIENT
603
if gnutls.check_version(b"3.5.6"):
604
gnutls_flags |= gnutls.NO_TICKETS
606
gnutls_flags |= gnutls.ENABLE_RAWPK
607
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
609
gnutls.set_default_priority(self._c_object)
610
gnutls.transport_set_ptr(self._c_object, socket.fileno())
611
gnutls.handshake_set_private_extensions(self._c_object,
614
if credentials is None:
615
credentials = gnutls.Credentials()
616
gnutls.credentials_set(self._c_object, credentials.type,
617
ctypes.cast(credentials._c_object,
619
self.credentials = credentials
622
gnutls.deinit(self._c_object)
625
return gnutls.handshake(self._c_object)
627
def send(self, data):
631
data_len -= gnutls.record_send(self._c_object,
636
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
638
# Error handling functions
639
def _error_code(result):
640
"""A function to raise exceptions on errors, suitable
641
for the 'restype' attribute on ctypes functions"""
644
if result == gnutls.E_NO_CERTIFICATE_FOUND:
645
raise gnutls.CertificateSecurityError(code=result)
646
raise gnutls.Error(code=result)
648
def _retry_on_error(result, func, arguments):
649
"""A function to retry on some errors, suitable
650
for the 'errcheck' attribute on ctypes functions"""
652
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
653
return _error_code(result)
654
result = func(*arguments)
657
# Unless otherwise indicated, the function declarations below are
658
# all from the gnutls/gnutls.h C header file.
661
priority_set_direct = _library.gnutls_priority_set_direct
662
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
663
ctypes.POINTER(ctypes.c_char_p)]
664
priority_set_direct.restype = _error_code
666
init = _library.gnutls_init
667
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
668
init.restype = _error_code
670
set_default_priority = _library.gnutls_set_default_priority
671
set_default_priority.argtypes = [session_t]
672
set_default_priority.restype = _error_code
674
record_send = _library.gnutls_record_send
675
record_send.argtypes = [session_t, ctypes.c_void_p,
677
record_send.restype = ctypes.c_ssize_t
678
record_send.errcheck = _retry_on_error
680
certificate_allocate_credentials = (
681
_library.gnutls_certificate_allocate_credentials)
682
certificate_allocate_credentials.argtypes = [
683
ctypes.POINTER(certificate_credentials_t)]
684
certificate_allocate_credentials.restype = _error_code
686
certificate_free_credentials = (
687
_library.gnutls_certificate_free_credentials)
688
certificate_free_credentials.argtypes = [
689
certificate_credentials_t]
690
certificate_free_credentials.restype = None
692
handshake_set_private_extensions = (
693
_library.gnutls_handshake_set_private_extensions)
694
handshake_set_private_extensions.argtypes = [session_t,
696
handshake_set_private_extensions.restype = None
698
credentials_set = _library.gnutls_credentials_set
699
credentials_set.argtypes = [session_t, credentials_type_t,
701
credentials_set.restype = _error_code
703
strerror = _library.gnutls_strerror
704
strerror.argtypes = [ctypes.c_int]
705
strerror.restype = ctypes.c_char_p
707
certificate_type_get = _library.gnutls_certificate_type_get
708
certificate_type_get.argtypes = [session_t]
709
certificate_type_get.restype = _error_code
711
certificate_get_peers = _library.gnutls_certificate_get_peers
712
certificate_get_peers.argtypes = [session_t,
713
ctypes.POINTER(ctypes.c_uint)]
714
certificate_get_peers.restype = ctypes.POINTER(datum_t)
716
global_set_log_level = _library.gnutls_global_set_log_level
717
global_set_log_level.argtypes = [ctypes.c_int]
718
global_set_log_level.restype = None
720
global_set_log_function = _library.gnutls_global_set_log_function
721
global_set_log_function.argtypes = [log_func]
722
global_set_log_function.restype = None
724
deinit = _library.gnutls_deinit
725
deinit.argtypes = [session_t]
726
deinit.restype = None
728
handshake = _library.gnutls_handshake
729
handshake.argtypes = [session_t]
730
handshake.restype = _error_code
731
handshake.errcheck = _retry_on_error
733
transport_set_ptr = _library.gnutls_transport_set_ptr
734
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
735
transport_set_ptr.restype = None
737
bye = _library.gnutls_bye
738
bye.argtypes = [session_t, close_request_t]
739
bye.restype = _error_code
740
bye.errcheck = _retry_on_error
742
check_version = _library.gnutls_check_version
743
check_version.argtypes = [ctypes.c_char_p]
744
check_version.restype = ctypes.c_char_p
746
_need_version = b"3.3.0"
747
if check_version(_need_version) is None:
748
raise self.Error("Needs GnuTLS {} or later"
749
.format(_need_version))
751
_tls_rawpk_version = b"3.6.6"
752
has_rawpk = bool(check_version(_tls_rawpk_version))
756
class pubkey_st(ctypes.Structure):
758
pubkey_t = ctypes.POINTER(pubkey_st)
760
x509_crt_fmt_t = ctypes.c_int
762
# All the function declarations below are from gnutls/abstract.h
763
pubkey_init = _library.gnutls_pubkey_init
764
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
765
pubkey_init.restype = _error_code
767
pubkey_import = _library.gnutls_pubkey_import
768
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
770
pubkey_import.restype = _error_code
772
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
773
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
774
ctypes.POINTER(ctypes.c_ubyte),
775
ctypes.POINTER(ctypes.c_size_t)]
776
pubkey_get_key_id.restype = _error_code
778
pubkey_deinit = _library.gnutls_pubkey_deinit
779
pubkey_deinit.argtypes = [pubkey_t]
780
pubkey_deinit.restype = None
782
# All the function declarations below are from gnutls/openpgp.h
784
openpgp_crt_init = _library.gnutls_openpgp_crt_init
785
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
786
openpgp_crt_init.restype = _error_code
788
openpgp_crt_import = _library.gnutls_openpgp_crt_import
789
openpgp_crt_import.argtypes = [openpgp_crt_t,
790
ctypes.POINTER(datum_t),
792
openpgp_crt_import.restype = _error_code
794
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
795
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
796
ctypes.POINTER(ctypes.c_uint)]
797
openpgp_crt_verify_self.restype = _error_code
799
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
800
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
801
openpgp_crt_deinit.restype = None
803
openpgp_crt_get_fingerprint = (
804
_library.gnutls_openpgp_crt_get_fingerprint)
805
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
809
openpgp_crt_get_fingerprint.restype = _error_code
811
if check_version(b"3.6.4"):
812
certificate_type_get2 = _library.gnutls_certificate_type_get2
813
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
814
certificate_type_get2.restype = _error_code
816
# Remove non-public functions
817
del _error_code, _retry_on_error
820
def call_pipe(connection, # : multiprocessing.Connection
821
func, *args, **kwargs):
822
"""This function is meant to be called by multiprocessing.Process
824
This function runs func(*args, **kwargs), and writes the resulting
825
return value on the provided multiprocessing.Connection.
827
connection.send(func(*args, **kwargs))
387
832
"""A representation of a client host served by this server.
390
835
approved: bool(); 'None' if not yet approved/disapproved
391
836
approval_delay: datetime.timedelta(); Time to wait for approval
392
837
approval_duration: datetime.timedelta(); Duration of one approval
393
checker: subprocess.Popen(); a running checker process used
394
to see if the client lives.
395
'None' if no process is running.
396
checker_callback_tag: a gobject event source tag, or None
838
checker: multiprocessing.Process(); a running checker process used
839
to see if the client lives. 'None' if no process is
841
checker_callback_tag: a GLib event source tag, or None
397
842
checker_command: string; External command which is run to check
398
843
if client lives. %() expansions are done at
399
844
runtime with vars(self) as dict, so that for
400
845
instance %(name)s can be used in the command.
401
checker_initiator_tag: a gobject event source tag, or None
846
checker_initiator_tag: a GLib event source tag, or None
402
847
created: datetime.datetime(); (UTC) object creation
403
848
client_structure: Object describing what attributes a client has
404
849
and is used for storing the client at exit
405
850
current_checker_command: string; current running checker_command
406
disable_initiator_tag: a gobject event source tag, or None
851
disable_initiator_tag: a GLib event source tag, or None
408
853
fingerprint: string (40 or 32 hexadecimal digits); used to
409
uniquely identify the client
854
uniquely identify an OpenPGP client
855
key_id: string (64 hexadecimal digits); used to uniquely identify
856
a client using raw public keys
410
857
host: string; available for use by the checker command
411
858
interval: datetime.timedelta(); How often to start a new checker
412
859
last_approval_request: datetime.datetime(); (UTC) or None
413
860
last_checked_ok: datetime.datetime(); (UTC) or None
414
861
last_checker_status: integer between 0 and 255 reflecting exit
415
862
status of last checker. -1 reflects crashed
863
checker, -2 means no checker completed yet.
864
last_checker_signal: The signal which killed the last checker, if
865
last_checker_status is -1
417
866
last_enabled: datetime.datetime(); (UTC) or None
418
867
name: string; from the config file, used in log messages and
419
868
D-Bus identifiers
420
869
secret: bytestring; sent verbatim (over TLS) to client
421
870
timeout: datetime.timedelta(); How long from last_checked_ok
422
871
until this client is disabled
423
extended_timeout: extra long timeout when password has been sent
872
extended_timeout: extra long timeout when secret has been sent
424
873
runtime_expansions: Allowed attributes for runtime expansion.
425
874
expires: datetime.datetime(); time (UTC) when a client will be
426
875
disabled, or None
876
server_settings: The server_settings dict from main()
429
879
runtime_expansions = ("approval_delay", "approval_duration",
430
"created", "enabled", "fingerprint",
431
"host", "interval", "last_checked_ok",
880
"created", "enabled", "expires", "key_id",
881
"fingerprint", "host", "interval",
882
"last_approval_request", "last_checked_ok",
432
883
"last_enabled", "name", "timeout")
433
client_defaults = { "timeout": "5m",
434
"extended_timeout": "15m",
436
"checker": "fping -q -- %%(host)s",
438
"approval_delay": "0s",
439
"approval_duration": "1s",
440
"approved_by_default": "True",
444
def timeout_milliseconds(self):
445
"Return the 'timeout' attribute in milliseconds"
446
return timedelta_to_milliseconds(self.timeout)
448
def extended_timeout_milliseconds(self):
449
"Return the 'extended_timeout' attribute in milliseconds"
450
return timedelta_to_milliseconds(self.extended_timeout)
452
def interval_milliseconds(self):
453
"Return the 'interval' attribute in milliseconds"
454
return timedelta_to_milliseconds(self.interval)
456
def approval_delay_milliseconds(self):
457
return timedelta_to_milliseconds(self.approval_delay)
886
"extended_timeout": "PT15M",
888
"checker": "fping -q -- %%(host)s",
890
"approval_delay": "PT0S",
891
"approval_duration": "PT1S",
892
"approved_by_default": "True",
460
897
def config_parser(config):
461
""" Construct a new dict of client settings of this form:
898
"""Construct a new dict of client settings of this form:
462
899
{ client_name: {setting_name: value, ...}, ...}
463
with exceptions for any special settings as defined above"""
900
with exceptions for any special settings as defined above.
901
NOTE: Must be a pure function. Must return the same result
902
value given the same arguments.
465
905
for client_name in config.sections():
466
906
section = dict(config.items(client_name))
467
907
client = settings[client_name] = {}
469
909
client["host"] = section["host"]
470
910
# Reformat values from string types to Python types
471
911
client["approved_by_default"] = config.getboolean(
472
912
client_name, "approved_by_default")
473
client["enabled"] = config.getboolean(client_name, "enabled")
913
client["enabled"] = config.getboolean(client_name,
916
# Uppercase and remove spaces from key_id and fingerprint
917
# for later comparison purposes with return value from the
918
# key_id() and fingerprint() functions
919
client["key_id"] = (section.get("key_id", "").upper()
475
921
client["fingerprint"] = (section["fingerprint"].upper()
476
922
.replace(" ", ""))
477
923
if "secret" in section:
478
client["secret"] = section["secret"].decode("base64")
924
client["secret"] = codecs.decode(section["secret"]
479
927
elif "secfile" in section:
480
928
with open(os.path.expanduser(os.path.expandvars
481
929
(section["secfile"])),
482
930
"rb") as secfile:
483
931
client["secret"] = secfile.read()
485
raise TypeError("No secret or secfile for section %s"
933
raise TypeError("No secret or secfile for section {}"
487
935
client["timeout"] = string_to_delta(section["timeout"])
488
936
client["extended_timeout"] = string_to_delta(
489
937
section["extended_timeout"])
531
980
self.current_checker_command = None
532
981
self.approved = None
533
982
self.approvals_pending = 0
534
self.changedstate = (multiprocessing_manager
535
.Condition(multiprocessing_manager
537
self.client_structure = [attr for attr in
538
self.__dict__.iterkeys()
983
self.changedstate = multiprocessing_manager.Condition(
984
multiprocessing_manager.Lock())
985
self.client_structure = [attr
986
for attr in self.__dict__.keys()
539
987
if not attr.startswith("_")]
540
988
self.client_structure.append("client_structure")
542
for name, t in inspect.getmembers(type(self),
990
for name, t in inspect.getmembers(
991
type(self), lambda obj: isinstance(obj, property)):
546
992
if not name.startswith("_"):
547
993
self.client_structure.append(name)
549
995
# Send notice to process children that client state has changed
550
996
def send_changedstate(self):
551
997
with self.changedstate:
552
998
self.changedstate.notify_all()
554
1000
def enable(self):
555
1001
"""Start this client's checker and timeout hooks"""
556
1002
if getattr(self, "enabled", False):
557
1003
# Already enabled
559
self.send_changedstate()
560
1005
self.expires = datetime.datetime.utcnow() + self.timeout
561
1006
self.enabled = True
562
1007
self.last_enabled = datetime.datetime.utcnow()
563
1008
self.init_checker()
1009
self.send_changedstate()
565
1011
def disable(self, quiet=True):
566
1012
"""Disable this client."""
567
1013
if not getattr(self, "enabled", False):
570
self.send_changedstate()
572
1016
logger.info("Disabling client %s", self.name)
573
if getattr(self, "disable_initiator_tag", False):
574
gobject.source_remove(self.disable_initiator_tag)
1017
if getattr(self, "disable_initiator_tag", None) is not None:
1018
GLib.source_remove(self.disable_initiator_tag)
575
1019
self.disable_initiator_tag = None
576
1020
self.expires = None
577
if getattr(self, "checker_initiator_tag", False):
578
gobject.source_remove(self.checker_initiator_tag)
1021
if getattr(self, "checker_initiator_tag", None) is not None:
1022
GLib.source_remove(self.checker_initiator_tag)
579
1023
self.checker_initiator_tag = None
580
1024
self.stop_checker()
581
1025
self.enabled = False
582
# Do not run this again if called by a gobject.timeout_add
1027
self.send_changedstate()
1028
# Do not run this again if called by a GLib.timeout_add
585
1031
def __del__(self):
588
1034
def init_checker(self):
589
1035
# Schedule a new checker to be started an 'interval' from now,
590
1036
# and every interval from then on.
591
self.checker_initiator_tag = (gobject.timeout_add
592
(self.interval_milliseconds(),
1037
if self.checker_initiator_tag is not None:
1038
GLib.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = GLib.timeout_add(
1040
int(self.interval.total_seconds() * 1000),
594
1042
# Schedule a disable() when 'timeout' has passed
595
self.disable_initiator_tag = (gobject.timeout_add
596
(self.timeout_milliseconds(),
1043
if self.disable_initiator_tag is not None:
1044
GLib.source_remove(self.disable_initiator_tag)
1045
self.disable_initiator_tag = GLib.timeout_add(
1046
int(self.timeout.total_seconds() * 1000), self.disable)
598
1047
# Also start a new checker *right now*.
599
1048
self.start_checker()
601
def checker_callback(self, pid, condition, command):
1050
def checker_callback(self, source, condition, connection,
602
1052
"""The checker has completed, so take appropriate actions."""
1053
# Read return code from connection (see call_pipe)
1054
returncode = connection.recv()
1056
if self.checker is not None:
603
1058
self.checker_callback_tag = None
604
1059
self.checker = None
605
if os.WIFEXITED(condition):
606
self.last_checker_status = os.WEXITSTATUS(condition)
1062
self.last_checker_status = returncode
1063
self.last_checker_signal = None
607
1064
if self.last_checker_status == 0:
608
1065
logger.info("Checker for %(name)s succeeded",
610
1067
self.checked_ok()
612
logger.info("Checker for %(name)s failed",
1069
logger.info("Checker for %(name)s failed", vars(self))
615
1071
self.last_checker_status = -1
1072
self.last_checker_signal = -returncode
616
1073
logger.warning("Checker for %(name)s crashed?",
619
def checked_ok(self, timeout=None):
620
"""Bump up the timeout for this client.
622
This should only be called when the client has been seen,
1077
def checked_ok(self):
1078
"""Assert that the client has been seen, alive and well."""
1079
self.last_checked_ok = datetime.datetime.utcnow()
1080
self.last_checker_status = 0
1081
self.last_checker_signal = None
1084
def bump_timeout(self, timeout=None):
1085
"""Bump up the timeout for this client."""
625
1086
if timeout is None:
626
1087
timeout = self.timeout
627
self.last_checked_ok = datetime.datetime.utcnow()
628
1088
if self.disable_initiator_tag is not None:
629
gobject.source_remove(self.disable_initiator_tag)
1089
GLib.source_remove(self.disable_initiator_tag)
1090
self.disable_initiator_tag = None
630
1091
if getattr(self, "enabled", False):
631
self.disable_initiator_tag = (gobject.timeout_add
632
(timedelta_to_milliseconds
633
(timeout), self.disable))
1092
self.disable_initiator_tag = GLib.timeout_add(
1093
int(timeout.total_seconds() * 1000), self.disable)
634
1094
self.expires = datetime.datetime.utcnow() + timeout
636
1096
def need_approval(self):
637
1097
self.last_approval_request = datetime.datetime.utcnow()
639
1099
def start_checker(self):
640
1100
"""Start a new checker subprocess if one is not running.
642
1102
If a checker already exists, leave it running and do
644
1104
# The reason for not killing a running checker is that if we
645
# did that, then if a checker (for some reason) started
646
# running slowly and taking more than 'interval' time, the
647
# client would inevitably timeout, since no checker would get
648
# a chance to run to completion. If we instead leave running
1105
# did that, and if a checker (for some reason) started running
1106
# slowly and taking more than 'interval' time, then the client
1107
# would inevitably timeout, since no checker would get a
1108
# chance to run to completion. If we instead leave running
649
1109
# checkers alone, the checker would have to take more time
650
1110
# than 'timeout' for the client to be disabled, which is as it
653
# If a checker exists, make sure it is not a zombie
655
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
656
except (AttributeError, OSError) as error:
657
if (isinstance(error, OSError)
658
and error.errno != errno.ECHILD):
662
logger.warning("Checker was a zombie")
663
gobject.source_remove(self.checker_callback_tag)
664
self.checker_callback(pid, status,
665
self.current_checker_command)
1113
if self.checker is not None and not self.checker.is_alive():
1114
logger.warning("Checker was not alive; joining")
666
1117
# Start a new checker if needed
667
1118
if self.checker is None:
1119
# Escape attributes for the shell
1121
attr: re.escape(str(getattr(self, attr)))
1122
for attr in self.runtime_expansions}
669
# In case checker_command has exactly one % operator
670
command = self.checker_command % self.host
672
# Escape attributes for the shell
673
escaped_attrs = dict(
675
re.escape(unicode(str(getattr(self, attr, "")),
679
self.runtime_expansions)
682
command = self.checker_command % escaped_attrs
683
except TypeError as error:
684
logger.error('Could not format string "%s":'
685
' %s', self.checker_command, error)
686
return True # Try again later
1124
command = self.checker_command % escaped_attrs
1125
except TypeError as error:
1126
logger.error('Could not format string "%s"',
1127
self.checker_command,
1129
return True # Try again later
687
1130
self.current_checker_command = command
689
logger.info("Starting checker %r for %s",
691
# We don't need to redirect stdout and stderr, since
692
# in normal mode, that is already done by daemon(),
693
# and in debug mode we don't want to. (Stdin is
694
# always replaced by /dev/null.)
695
self.checker = subprocess.Popen(command,
698
self.checker_callback_tag = (gobject.child_watch_add
700
self.checker_callback,
702
# The checker may have completed before the gobject
703
# watch was added. Check for this.
704
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
706
gobject.source_remove(self.checker_callback_tag)
707
self.checker_callback(pid, status, command)
708
except OSError as error:
709
logger.error("Failed to start subprocess: %s",
711
# Re-run this periodically if run by gobject.timeout_add
1131
logger.info("Starting checker %r for %s", command,
1133
# We don't need to redirect stdout and stderr, since
1134
# in normal mode, that is already done by daemon(),
1135
# and in debug mode we don't want to. (Stdin is
1136
# always replaced by /dev/null.)
1137
# The exception is when not debugging but nevertheless
1138
# running in the foreground; use the previously
1140
popen_args = {"close_fds": True,
1143
if (not self.server_settings["debug"]
1144
and self.server_settings["foreground"]):
1145
popen_args.update({"stdout": wnull,
1147
pipe = multiprocessing.Pipe(duplex=False)
1148
self.checker = multiprocessing.Process(
1150
args=(pipe[1], subprocess.call, command),
1152
self.checker.start()
1153
self.checker_callback_tag = GLib.io_add_watch(
1154
GLib.IOChannel.unix_new(pipe[0].fileno()),
1155
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1156
self.checker_callback, pipe[0], command)
1157
# Re-run this periodically if run by GLib.timeout_add
714
1160
def stop_checker(self):
715
1161
"""Force the checker process, if any, to stop."""
716
1162
if self.checker_callback_tag:
717
gobject.source_remove(self.checker_callback_tag)
1163
GLib.source_remove(self.checker_callback_tag)
718
1164
self.checker_callback_tag = None
719
1165
if getattr(self, "checker", None) is None:
721
1167
logger.debug("Stopping checker for %(name)s", vars(self))
723
os.kill(self.checker.pid, signal.SIGTERM)
725
#if self.checker.poll() is None:
726
# os.kill(self.checker.pid, signal.SIGKILL)
727
except OSError as error:
728
if error.errno != errno.ESRCH: # No such process
1168
self.checker.terminate()
730
1169
self.checker = None
733
def dbus_service_property(dbus_interface, signature="v",
734
access="readwrite", byte_arrays=False):
1172
def dbus_service_property(dbus_interface,
735
1176
"""Decorators for marking methods of a DBusObjectWithProperties to
736
1177
become properties on the D-Bus.
738
1179
The decorated method will be called with no arguments by "Get"
739
1180
and with one argument by "Set".
741
1182
The parameters, where they are supported, are the same as
742
1183
dbus.service.method, except there is only "signature", since the
743
1184
type from Get() and the type sent to Set() is the same.
782
class DBusObjectWithProperties(dbus.service.Object):
1267
class DBusObjectWithAnnotations(dbus.service.Object):
1268
"""A D-Bus object with annotations.
1270
Classes inheriting from this can use the dbus_annotations
1271
decorator to add annotations to methods or signals.
1275
def _is_dbus_thing(thing):
1276
"""Returns a function testing if an attribute is a D-Bus thing
1278
If called like _is_dbus_thing("method") it returns a function
1279
suitable for use as predicate to inspect.getmembers().
1281
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1284
def _get_all_dbus_things(self, thing):
1285
"""Returns a generator of (name, attribute) pairs
1287
return ((getattr(athing.__get__(self), "_dbus_name", name),
1288
athing.__get__(self))
1289
for cls in self.__class__.__mro__
1291
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1293
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1295
path_keyword='object_path',
1296
connection_keyword='connection')
1297
def Introspect(self, object_path, connection):
1298
"""Overloading of standard D-Bus method.
1300
Inserts annotation tags on methods and signals.
1302
xmlstring = dbus.service.Object.Introspect(self, object_path,
1305
document = xml.dom.minidom.parseString(xmlstring)
1307
for if_tag in document.getElementsByTagName("interface"):
1308
# Add annotation tags
1309
for typ in ("method", "signal"):
1310
for tag in if_tag.getElementsByTagName(typ):
1312
for name, prop in (self.
1313
_get_all_dbus_things(typ)):
1314
if (name == tag.getAttribute("name")
1315
and prop._dbus_interface
1316
== if_tag.getAttribute("name")):
1317
annots.update(getattr(
1318
prop, "_dbus_annotations", {}))
1319
for name, value in annots.items():
1320
ann_tag = document.createElement(
1322
ann_tag.setAttribute("name", name)
1323
ann_tag.setAttribute("value", value)
1324
tag.appendChild(ann_tag)
1325
# Add interface annotation tags
1326
for annotation, value in dict(
1327
itertools.chain.from_iterable(
1328
annotations().items()
1329
for name, annotations
1330
in self._get_all_dbus_things("interface")
1331
if name == if_tag.getAttribute("name")
1333
ann_tag = document.createElement("annotation")
1334
ann_tag.setAttribute("name", annotation)
1335
ann_tag.setAttribute("value", value)
1336
if_tag.appendChild(ann_tag)
1337
# Fix argument name for the Introspect method itself
1338
if (if_tag.getAttribute("name")
1339
== dbus.INTROSPECTABLE_IFACE):
1340
for cn in if_tag.getElementsByTagName("method"):
1341
if cn.getAttribute("name") == "Introspect":
1342
for arg in cn.getElementsByTagName("arg"):
1343
if (arg.getAttribute("direction")
1345
arg.setAttribute("name",
1347
xmlstring = document.toxml("utf-8")
1349
except (AttributeError, xml.dom.DOMException,
1350
xml.parsers.expat.ExpatError) as error:
1351
logger.error("Failed to override Introspection method",
1356
class DBusObjectWithProperties(DBusObjectWithAnnotations):
783
1357
"""A D-Bus object with properties.
785
1359
Classes inheriting from this can use the dbus_service_property
786
1360
decorator to expose methods as D-Bus properties. It exposes the
787
1361
standard Get(), Set(), and GetAll() methods on the D-Bus.
791
def _is_dbus_property(obj):
792
return getattr(obj, "_dbus_is_property", False)
794
def _get_all_dbus_properties(self):
795
"""Returns a generator of (name, attribute) pairs
797
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
798
for cls in self.__class__.__mro__
800
inspect.getmembers(cls, self._is_dbus_property))
802
1364
def _get_dbus_property(self, interface_name, property_name):
803
1365
"""Returns a bound method if one exists which is a D-Bus
804
1366
property with the specified name and interface.
806
for cls in self.__class__.__mro__:
807
for name, value in (inspect.getmembers
808
(cls, self._is_dbus_property)):
1368
for cls in self.__class__.__mro__:
1369
for name, value in inspect.getmembers(
1370
cls, self._is_dbus_thing("property")):
809
1371
if (value._dbus_name == property_name
810
1372
and value._dbus_interface == interface_name):
811
1373
return value.__get__(self)
813
1375
# No such property
814
raise DBusPropertyNotFound(self.dbus_object_path + ":"
815
+ interface_name + "."
818
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1376
raise DBusPropertyNotFound("{}:{}.{}".format(
1377
self.dbus_object_path, interface_name, property_name))
1380
def _get_all_interface_names(cls):
1381
"""Get a sequence of all interfaces supported by an object"""
1382
return (name for name in set(getattr(getattr(x, attr),
1383
"_dbus_interface", None)
1384
for x in (inspect.getmro(cls))
1386
if name is not None)
1388
@dbus.service.method(dbus.PROPERTIES_IFACE,
819
1390
out_signature="v")
820
1391
def Get(self, interface_name, property_name):
821
1392
"""Standard D-Bus property Get() method, see D-Bus standard.
913
1517
except (AttributeError, xml.dom.DOMException,
914
1518
xml.parsers.expat.ExpatError) as error:
915
1519
logger.error("Failed to override Introspection method",
920
def datetime_to_dbus (dt, variant_level=0):
1525
dbus.OBJECT_MANAGER_IFACE
1526
except AttributeError:
1527
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1530
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1531
"""A D-Bus object with an ObjectManager.
1533
Classes inheriting from this exposes the standard
1534
GetManagedObjects call and the InterfacesAdded and
1535
InterfacesRemoved signals on the standard
1536
"org.freedesktop.DBus.ObjectManager" interface.
1538
Note: No signals are sent automatically; they must be sent
1541
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1542
out_signature="a{oa{sa{sv}}}")
1543
def GetManagedObjects(self):
1544
"""This function must be overridden"""
1545
raise NotImplementedError()
1547
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1548
signature="oa{sa{sv}}")
1549
def InterfacesAdded(self, object_path, interfaces_and_properties):
1552
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1553
def InterfacesRemoved(self, object_path, interfaces):
1556
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1558
path_keyword='object_path',
1559
connection_keyword='connection')
1560
def Introspect(self, object_path, connection):
1561
"""Overloading of standard D-Bus method.
1563
Override return argument name of GetManagedObjects to be
1564
"objpath_interfaces_and_properties"
1566
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1570
document = xml.dom.minidom.parseString(xmlstring)
1572
for if_tag in document.getElementsByTagName("interface"):
1573
# Fix argument name for the GetManagedObjects method
1574
if (if_tag.getAttribute("name")
1575
== dbus.OBJECT_MANAGER_IFACE):
1576
for cn in if_tag.getElementsByTagName("method"):
1577
if (cn.getAttribute("name")
1578
== "GetManagedObjects"):
1579
for arg in cn.getElementsByTagName("arg"):
1580
if (arg.getAttribute("direction")
1584
"objpath_interfaces"
1586
xmlstring = document.toxml("utf-8")
1588
except (AttributeError, xml.dom.DOMException,
1589
xml.parsers.expat.ExpatError) as error:
1590
logger.error("Failed to override Introspection method",
1595
def datetime_to_dbus(dt, variant_level=0):
921
1596
"""Convert a UTC datetime.datetime() to a D-Bus type."""
923
return dbus.String("", variant_level = variant_level)
924
return dbus.String(dt.isoformat(),
925
variant_level=variant_level)
928
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
930
"""Applied to an empty subclass of a D-Bus object, this metaclass
931
will add additional D-Bus attributes matching a certain pattern.
1598
return dbus.String("", variant_level=variant_level)
1599
return dbus.String(dt.isoformat(), variant_level=variant_level)
1602
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1603
"""A class decorator; applied to a subclass of
1604
dbus.service.Object, it will add alternate D-Bus attributes with
1605
interface names according to the "alt_interface_names" mapping.
1608
@alternate_dbus_interfaces({"org.example.Interface":
1609
"net.example.AlternateInterface"})
1610
class SampleDBusObject(dbus.service.Object):
1611
@dbus.service.method("org.example.Interface")
1612
def SampleDBusMethod():
1615
The above "SampleDBusMethod" on "SampleDBusObject" will be
1616
reachable via two interfaces: "org.example.Interface" and
1617
"net.example.AlternateInterface", the latter of which will have
1618
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1619
"true", unless "deprecate" is passed with a False value.
1621
This works for methods and signals, and also for D-Bus properties
1622
(from DBusObjectWithProperties) and interfaces (from the
1623
dbus_interface_annotations decorator).
933
def __new__(mcs, name, bases, attr):
934
# Go through all the base classes which could have D-Bus
935
# methods, signals, or properties in them
936
for base in (b for b in bases
937
if issubclass(b, dbus.service.Object)):
938
# Go though all attributes of the base class
939
for attrname, attribute in inspect.getmembers(base):
1627
for orig_interface_name, alt_interface_name in (
1628
alt_interface_names.items()):
1630
interface_names = set()
1631
# Go though all attributes of the class
1632
for attrname, attribute in inspect.getmembers(cls):
940
1633
# Ignore non-D-Bus attributes, and D-Bus attributes
941
1634
# with the wrong interface name
942
1635
if (not hasattr(attribute, "_dbus_interface")
943
or not attribute._dbus_interface
944
.startswith("se.recompile.Mandos")):
1636
or not attribute._dbus_interface.startswith(
1637
orig_interface_name)):
946
1639
# Create an alternate D-Bus interface name based on
947
1640
# the current name
948
alt_interface = (attribute._dbus_interface
949
.replace("se.recompile.Mandos",
950
"se.bsnet.fukt.Mandos"))
1641
alt_interface = attribute._dbus_interface.replace(
1642
orig_interface_name, alt_interface_name)
1643
interface_names.add(alt_interface)
951
1644
# Is this a D-Bus signal?
952
1645
if getattr(attribute, "_dbus_is_signal", False):
953
# Extract the original non-method function by
955
nonmethod_func = (dict(
1646
# Extract the original non-method undecorated
1647
# function by black magic
1648
if sys.version_info.major == 2:
1649
nonmethod_func = (dict(
956
1650
zip(attribute.func_code.co_freevars,
957
attribute.__closure__))["func"]
1651
attribute.__closure__))
1652
["func"].cell_contents)
1654
nonmethod_func = (dict(
1655
zip(attribute.__code__.co_freevars,
1656
attribute.__closure__))
1657
["func"].cell_contents)
959
1658
# Create a new, but exactly alike, function
960
1659
# object, and decorate it to be a new D-Bus signal
961
1660
# with the alternate D-Bus interface name
962
new_function = (dbus.service.signal
964
attribute._dbus_signature)
966
nonmethod_func.func_code,
967
nonmethod_func.func_globals,
968
nonmethod_func.func_name,
969
nonmethod_func.func_defaults,
970
nonmethod_func.func_closure)))
1661
new_function = copy_function(nonmethod_func)
1662
new_function = (dbus.service.signal(
1664
attribute._dbus_signature)(new_function))
1665
# Copy annotations, if any
1667
new_function._dbus_annotations = dict(
1668
attribute._dbus_annotations)
1669
except AttributeError:
971
1672
# Define a creator of a function to call both the
972
# old and new functions, so both the old and new
973
# signals gets sent when the function is called
1673
# original and alternate functions, so both the
1674
# original and alternate signals gets sent when
1675
# the function is called
974
1676
def fixscope(func1, func2):
975
1677
"""This function is a scope container to pass
976
1678
func1 and func2 to the "call_both" function
977
1679
outside of its arguments"""
1681
@functools.wraps(func2)
978
1682
def call_both(*args, **kwargs):
979
1683
"""This function will emit two D-Bus
980
1684
signals by calling func1 and func2"""
981
1685
func1(*args, **kwargs)
982
1686
func2(*args, **kwargs)
1687
# Make wrapper function look like a D-Bus
1689
for name, attr in inspect.getmembers(func2):
1690
if name.startswith("_dbus_"):
1691
setattr(call_both, name, attr)
983
1693
return call_both
984
1694
# Create the "call_both" function and add it to
986
attr[attrname] = fixscope(attribute,
1696
attr[attrname] = fixscope(attribute, new_function)
988
1697
# Is this a D-Bus method?
989
1698
elif getattr(attribute, "_dbus_is_method", False):
990
1699
# Create a new, but exactly alike, function
991
1700
# object. Decorate it to be a new D-Bus method
992
1701
# with the alternate D-Bus interface name. Add it
994
attr[attrname] = (dbus.service.method
996
attribute._dbus_in_signature,
997
attribute._dbus_out_signature)
999
(attribute.func_code,
1000
attribute.func_globals,
1001
attribute.func_name,
1002
attribute.func_defaults,
1003
attribute.func_closure)))
1704
dbus.service.method(
1706
attribute._dbus_in_signature,
1707
attribute._dbus_out_signature)
1708
(copy_function(attribute)))
1709
# Copy annotations, if any
1711
attr[attrname]._dbus_annotations = dict(
1712
attribute._dbus_annotations)
1713
except AttributeError:
1004
1715
# Is this a D-Bus property?
1005
1716
elif getattr(attribute, "_dbus_is_property", False):
1006
1717
# Create a new, but exactly alike, function
1007
1718
# object, and decorate it to be a new D-Bus
1008
1719
# property with the alternate D-Bus interface
1009
1720
# name. Add it to the class.
1010
attr[attrname] = (dbus_service_property
1012
attribute._dbus_signature,
1013
attribute._dbus_access,
1015
._dbus_get_args_options
1018
(attribute.func_code,
1019
attribute.func_globals,
1020
attribute.func_name,
1021
attribute.func_defaults,
1022
attribute.func_closure)))
1023
return type.__new__(mcs, name, bases, attr)
1721
attr[attrname] = (dbus_service_property(
1722
alt_interface, attribute._dbus_signature,
1723
attribute._dbus_access,
1724
attribute._dbus_get_args_options
1726
(copy_function(attribute)))
1727
# Copy annotations, if any
1729
attr[attrname]._dbus_annotations = dict(
1730
attribute._dbus_annotations)
1731
except AttributeError:
1733
# Is this a D-Bus interface?
1734
elif getattr(attribute, "_dbus_is_interface", False):
1735
# Create a new, but exactly alike, function
1736
# object. Decorate it to be a new D-Bus interface
1737
# with the alternate D-Bus interface name. Add it
1740
dbus_interface_annotations(alt_interface)
1741
(copy_function(attribute)))
1743
# Deprecate all alternate interfaces
1744
iname = "_AlternateDBusNames_interface_annotation{}"
1745
for interface_name in interface_names:
1747
@dbus_interface_annotations(interface_name)
1749
return {"org.freedesktop.DBus.Deprecated":
1751
# Find an unused name
1752
for aname in (iname.format(i)
1753
for i in itertools.count()):
1754
if aname not in attr:
1758
# Replace the class with a new subclass of it with
1759
# methods, signals, etc. as created above.
1760
if sys.version_info.major == 2:
1761
cls = type(b"{}Alternate".format(cls.__name__),
1764
cls = type("{}Alternate".format(cls.__name__),
1771
@alternate_dbus_interfaces({"se.recompile.Mandos":
1772
"se.bsnet.fukt.Mandos"})
1026
1773
class ClientDBus(Client, DBusObjectWithProperties):
1027
1774
"""A Client class using D-Bus
1030
1777
dbus_object_path: dbus.ObjectPath
1031
1778
bus: dbus.SystemBus()
1034
1781
runtime_expansions = (Client.runtime_expansions
1035
+ ("dbus_object_path",))
1782
+ ("dbus_object_path", ))
1784
_interface = "se.recompile.Mandos.Client"
1037
1786
# dbus.service.Object doesn't use super(), so we can't either.
1039
def __init__(self, bus = None, *args, **kwargs):
1788
def __init__(self, bus=None, *args, **kwargs):
1041
1790
Client.__init__(self, *args, **kwargs)
1042
self._approvals_pending = 0
1044
self._approvals_pending = 0
1045
1791
# Only now, when this client is initialized, can it show up on
1047
client_object_name = unicode(self.name).translate(
1793
client_object_name = str(self.name).translate(
1048
1794
{ord("."): ord("_"),
1049
1795
ord("-"): ord("_")})
1050
self.dbus_object_path = (dbus.ObjectPath
1051
("/clients/" + client_object_name))
1796
self.dbus_object_path = dbus.ObjectPath(
1797
"/clients/" + client_object_name)
1052
1798
DBusObjectWithProperties.__init__(self, self.bus,
1053
1799
self.dbus_object_path)
1055
def notifychangeproperty(transform_func,
1056
dbus_name, type_func=lambda x: x,
1801
def notifychangeproperty(transform_func, dbus_name,
1802
type_func=lambda x: x,
1804
invalidate_only=False,
1805
_interface=_interface):
1058
1806
""" Modify a variable so that it's a property which announces
1059
1807
its changes to DBus.
1061
1809
transform_fun: Function that takes a value and a variant_level
1062
1810
and transforms it to a D-Bus type.
1063
1811
dbus_name: D-Bus name of the variable
1065
1813
to the D-Bus. Default: no transform
1066
1814
variant_level: D-Bus variant level. Default: 1
1068
attrname = "_{0}".format(dbus_name)
1816
attrname = "_{}".format(dbus_name)
1069
1818
def setter(self, value):
1070
1819
if hasattr(self, "dbus_object_path"):
1071
1820
if (not hasattr(self, attrname) or
1072
1821
type_func(getattr(self, attrname, None))
1073
1822
!= type_func(value)):
1074
dbus_value = transform_func(type_func(value),
1077
self.PropertyChanged(dbus.String(dbus_name),
1824
self.PropertiesChanged(
1825
_interface, dbus.Dictionary(),
1826
dbus.Array((dbus_name, )))
1828
dbus_value = transform_func(
1830
variant_level=variant_level)
1831
self.PropertyChanged(dbus.String(dbus_name),
1833
self.PropertiesChanged(
1835
dbus.Dictionary({dbus.String(dbus_name):
1079
1838
setattr(self, attrname, value)
1081
1840
return property(lambda self: getattr(self, attrname), setter)
1084
1842
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1085
1843
approvals_pending = notifychangeproperty(dbus.Boolean,
1086
1844
"ApprovalPending",
1088
1846
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1089
1847
last_enabled = notifychangeproperty(datetime_to_dbus,
1091
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1092
type_func = lambda checker:
1093
checker is not None)
1849
checker = notifychangeproperty(
1850
dbus.Boolean, "CheckerRunning",
1851
type_func=lambda checker: checker is not None)
1094
1852
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1095
1853
"LastCheckedOK")
1854
last_checker_status = notifychangeproperty(dbus.Int16,
1855
"LastCheckerStatus")
1096
1856
last_approval_request = notifychangeproperty(
1097
1857
datetime_to_dbus, "LastApprovalRequest")
1098
1858
approved_by_default = notifychangeproperty(dbus.Boolean,
1099
1859
"ApprovedByDefault")
1100
approval_delay = notifychangeproperty(dbus.UInt64,
1103
timedelta_to_milliseconds)
1860
approval_delay = notifychangeproperty(
1861
dbus.UInt64, "ApprovalDelay",
1862
type_func=lambda td: td.total_seconds() * 1000)
1104
1863
approval_duration = notifychangeproperty(
1105
1864
dbus.UInt64, "ApprovalDuration",
1106
type_func = timedelta_to_milliseconds)
1865
type_func=lambda td: td.total_seconds() * 1000)
1107
1866
host = notifychangeproperty(dbus.String, "Host")
1108
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1110
timedelta_to_milliseconds)
1867
timeout = notifychangeproperty(
1868
dbus.UInt64, "Timeout",
1869
type_func=lambda td: td.total_seconds() * 1000)
1111
1870
extended_timeout = notifychangeproperty(
1112
1871
dbus.UInt64, "ExtendedTimeout",
1113
type_func = timedelta_to_milliseconds)
1114
interval = notifychangeproperty(dbus.UInt64,
1117
timedelta_to_milliseconds)
1872
type_func=lambda td: td.total_seconds() * 1000)
1873
interval = notifychangeproperty(
1874
dbus.UInt64, "Interval",
1875
type_func=lambda td: td.total_seconds() * 1000)
1118
1876
checker_command = notifychangeproperty(dbus.String, "Checker")
1877
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1878
invalidate_only=True)
1120
1880
del notifychangeproperty
1122
1882
def __del__(self, *args, **kwargs):
1124
1884
self.remove_from_connection()
1204
1963
server to mandos-client
1208
1967
# Rejected - signal
1209
1968
@dbus.service.signal(_interface, signature="s")
1210
1969
def Rejected(self, reason):
1214
1973
# NeedApproval - signal
1215
1974
@dbus.service.signal(_interface, signature="tb")
1216
1975
def NeedApproval(self, timeout, default):
1218
1977
return self.need_approval()
1220
# NeRwequest - signal
1221
@dbus.service.signal(_interface, signature="s")
1222
def NewRequest(self, ip):
1224
Is sent after a client request a password.
1230
1981
# Approve - method
1231
1982
@dbus.service.method(_interface, in_signature="b")
1232
1983
def Approve(self, value):
1233
1984
self.approve(value)
1235
1986
# CheckedOK - method
1236
1987
@dbus.service.method(_interface)
1237
1988
def CheckedOK(self):
1238
1989
self.checked_ok()
1240
1991
# Enable - method
1992
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1241
1993
@dbus.service.method(_interface)
1242
1994
def Enable(self):
1246
1998
# StartChecker - method
1999
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1247
2000
@dbus.service.method(_interface)
1248
2001
def StartChecker(self):
1250
2003
self.start_checker()
1252
2005
# Disable - method
2006
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1253
2007
@dbus.service.method(_interface)
1254
2008
def Disable(self):
1258
2012
# StopChecker - method
2013
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1259
2014
@dbus.service.method(_interface)
1260
2015
def StopChecker(self):
1261
2016
self.stop_checker()
1265
2020
# ApprovalPending - property
1266
2021
@dbus_service_property(_interface, signature="b", access="read")
1267
2022
def ApprovalPending_dbus_property(self):
1268
2023
return dbus.Boolean(bool(self.approvals_pending))
1270
2025
# ApprovedByDefault - property
1271
@dbus_service_property(_interface, signature="b",
2026
@dbus_service_property(_interface,
1272
2028
access="readwrite")
1273
2029
def ApprovedByDefault_dbus_property(self, value=None):
1274
2030
if value is None: # get
1275
2031
return dbus.Boolean(self.approved_by_default)
1276
2032
self.approved_by_default = bool(value)
1278
2034
# ApprovalDelay - property
1279
@dbus_service_property(_interface, signature="t",
2035
@dbus_service_property(_interface,
1280
2037
access="readwrite")
1281
2038
def ApprovalDelay_dbus_property(self, value=None):
1282
2039
if value is None: # get
1283
return dbus.UInt64(self.approval_delay_milliseconds())
2040
return dbus.UInt64(self.approval_delay.total_seconds()
1284
2042
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1286
2044
# ApprovalDuration - property
1287
@dbus_service_property(_interface, signature="t",
2045
@dbus_service_property(_interface,
1288
2047
access="readwrite")
1289
2048
def ApprovalDuration_dbus_property(self, value=None):
1290
2049
if value is None: # get
1291
return dbus.UInt64(timedelta_to_milliseconds(
1292
self.approval_duration))
2050
return dbus.UInt64(self.approval_duration.total_seconds()
1293
2052
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1295
2054
# Name - property
2056
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1296
2057
@dbus_service_property(_interface, signature="s", access="read")
1297
2058
def Name_dbus_property(self):
1298
2059
return dbus.String(self.name)
2063
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2064
@dbus_service_property(_interface, signature="s", access="read")
2065
def KeyID_dbus_property(self):
2066
return dbus.String(self.key_id)
1300
2068
# Fingerprint - property
2070
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1301
2071
@dbus_service_property(_interface, signature="s", access="read")
1302
2072
def Fingerprint_dbus_property(self):
1303
2073
return dbus.String(self.fingerprint)
1305
2075
# Host - property
1306
@dbus_service_property(_interface, signature="s",
2076
@dbus_service_property(_interface,
1307
2078
access="readwrite")
1308
2079
def Host_dbus_property(self, value=None):
1309
2080
if value is None: # get
1310
2081
return dbus.String(self.host)
1311
self.host = unicode(value)
2082
self.host = str(value)
1313
2084
# Created - property
2086
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1314
2087
@dbus_service_property(_interface, signature="s", access="read")
1315
2088
def Created_dbus_property(self):
1316
2089
return datetime_to_dbus(self.created)
1318
2091
# LastEnabled - property
1319
2092
@dbus_service_property(_interface, signature="s", access="read")
1320
2093
def LastEnabled_dbus_property(self):
1321
2094
return datetime_to_dbus(self.last_enabled)
1323
2096
# Enabled - property
1324
@dbus_service_property(_interface, signature="b",
2097
@dbus_service_property(_interface,
1325
2099
access="readwrite")
1326
2100
def Enabled_dbus_property(self, value=None):
1327
2101
if value is None: # get
1334
2108
# LastCheckedOK - property
1335
@dbus_service_property(_interface, signature="s",
2109
@dbus_service_property(_interface,
1336
2111
access="readwrite")
1337
2112
def LastCheckedOK_dbus_property(self, value=None):
1338
2113
if value is not None:
1339
2114
self.checked_ok()
1341
2116
return datetime_to_dbus(self.last_checked_ok)
2118
# LastCheckerStatus - property
2119
@dbus_service_property(_interface, signature="n", access="read")
2120
def LastCheckerStatus_dbus_property(self):
2121
return dbus.Int16(self.last_checker_status)
1343
2123
# Expires - property
1344
2124
@dbus_service_property(_interface, signature="s", access="read")
1345
2125
def Expires_dbus_property(self):
1346
2126
return datetime_to_dbus(self.expires)
1348
2128
# LastApprovalRequest - property
1349
2129
@dbus_service_property(_interface, signature="s", access="read")
1350
2130
def LastApprovalRequest_dbus_property(self):
1351
2131
return datetime_to_dbus(self.last_approval_request)
1353
2133
# Timeout - property
1354
@dbus_service_property(_interface, signature="t",
2134
@dbus_service_property(_interface,
1355
2136
access="readwrite")
1356
2137
def Timeout_dbus_property(self, value=None):
1357
2138
if value is None: # get
1358
return dbus.UInt64(self.timeout_milliseconds())
2139
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2140
old_timeout = self.timeout
1359
2141
self.timeout = datetime.timedelta(0, 0, 0, value)
1360
if getattr(self, "disable_initiator_tag", None) is None:
1362
# Reschedule timeout
1363
gobject.source_remove(self.disable_initiator_tag)
1364
self.disable_initiator_tag = None
1366
time_to_die = timedelta_to_milliseconds((self
1371
if time_to_die <= 0:
1372
# The timeout has passed
1375
self.expires = (datetime.datetime.utcnow()
1376
+ datetime.timedelta(milliseconds =
1378
self.disable_initiator_tag = (gobject.timeout_add
1379
(time_to_die, self.disable))
2142
# Reschedule disabling
2144
now = datetime.datetime.utcnow()
2145
self.expires += self.timeout - old_timeout
2146
if self.expires <= now:
2147
# The timeout has passed
2150
if (getattr(self, "disable_initiator_tag", None)
2153
GLib.source_remove(self.disable_initiator_tag)
2154
self.disable_initiator_tag = GLib.timeout_add(
2155
int((self.expires - now).total_seconds() * 1000),
1381
2158
# ExtendedTimeout - property
1382
@dbus_service_property(_interface, signature="t",
2159
@dbus_service_property(_interface,
1383
2161
access="readwrite")
1384
2162
def ExtendedTimeout_dbus_property(self, value=None):
1385
2163
if value is None: # get
1386
return dbus.UInt64(self.extended_timeout_milliseconds())
2164
return dbus.UInt64(self.extended_timeout.total_seconds()
1387
2166
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1389
2168
# Interval - property
1390
@dbus_service_property(_interface, signature="t",
2169
@dbus_service_property(_interface,
1391
2171
access="readwrite")
1392
2172
def Interval_dbus_property(self, value=None):
1393
2173
if value is None: # get
1394
return dbus.UInt64(self.interval_milliseconds())
2174
return dbus.UInt64(self.interval.total_seconds() * 1000)
1395
2175
self.interval = datetime.timedelta(0, 0, 0, value)
1396
2176
if getattr(self, "checker_initiator_tag", None) is None:
1398
2178
if self.enabled:
1399
2179
# Reschedule checker run
1400
gobject.source_remove(self.checker_initiator_tag)
1401
self.checker_initiator_tag = (gobject.timeout_add
1402
(value, self.start_checker))
1403
self.start_checker() # Start one now, too
2180
GLib.source_remove(self.checker_initiator_tag)
2181
self.checker_initiator_tag = GLib.timeout_add(
2182
value, self.start_checker)
2183
self.start_checker() # Start one now, too
1405
2185
# Checker - property
1406
@dbus_service_property(_interface, signature="s",
2186
@dbus_service_property(_interface,
1407
2188
access="readwrite")
1408
2189
def Checker_dbus_property(self, value=None):
1409
2190
if value is None: # get
1410
2191
return dbus.String(self.checker_command)
1411
self.checker_command = unicode(value)
2192
self.checker_command = str(value)
1413
2194
# CheckerRunning - property
1414
@dbus_service_property(_interface, signature="b",
2195
@dbus_service_property(_interface,
1415
2197
access="readwrite")
1416
2198
def CheckerRunning_dbus_property(self, value=None):
1417
2199
if value is None: # get
1450
2240
if data[0] == 'data':
1452
2242
if data[0] == 'function':
1453
2244
def func(*args, **kwargs):
1454
2245
self._pipe.send(('funcall', name, args, kwargs))
1455
2246
return self._pipe.recv()[1]
1458
2250
def __setattr__(self, name, value):
1459
2251
if name == '_pipe':
1460
2252
return super(ProxyClient, self).__setattr__(name, value)
1461
2253
self._pipe.send(('setattr', name, value))
1464
class ClientDBusTransitional(ClientDBus):
1465
__metaclass__ = AlternateDBusNamesMetaclass
1468
2256
class ClientHandler(socketserver.BaseRequestHandler, object):
1469
2257
"""A class to handle client connections.
1471
2259
Instantiated once for each connection to handle it.
1472
2260
Note: This will run in its own forked process."""
1474
2262
def handle(self):
1475
2263
with contextlib.closing(self.server.child_pipe) as child_pipe:
1476
2264
logger.info("TCP connection from: %s",
1477
unicode(self.client_address))
2265
str(self.client_address))
1478
2266
logger.debug("Pipe FD: %d",
1479
2267
self.server.child_pipe.fileno())
1481
session = (gnutls.connection
1482
.ClientSession(self.request,
1484
.X509Credentials()))
1486
# Note: gnutls.connection.X509Credentials is really a
1487
# generic GnuTLS certificate credentials object so long as
1488
# no X.509 keys are added to it. Therefore, we can use it
1489
# here despite using OpenPGP certificates.
1491
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1492
# "+AES-256-CBC", "+SHA1",
1493
# "+COMP-NULL", "+CTYPE-OPENPGP",
2269
session = gnutls.ClientSession(self.request)
2271
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2272
# "+AES-256-CBC", "+SHA1",
2273
# "+COMP-NULL", "+CTYPE-OPENPGP",
1495
2275
# Use a fallback default, since this MUST be set.
1496
2276
priority = self.server.gnutls_priority
1497
2277
if priority is None:
1498
2278
priority = "NORMAL"
1499
(gnutls.library.functions
1500
.gnutls_priority_set_direct(session._c_object,
2279
gnutls.priority_set_direct(session._c_object,
2280
priority.encode("utf-8"),
1503
2283
# Start communication using the Mandos protocol
1504
2284
# Get protocol number
1505
2285
line = self.request.makefile().readline()
1506
2286
logger.debug("Protocol version: %r", line)
1508
2288
if int(line.strip().split()[0]) > 1:
2289
raise RuntimeError(line)
1510
2290
except (ValueError, IndexError, RuntimeError) as error:
1511
2291
logger.error("Unknown protocol version: %s", error)
1514
2294
# Start GnuTLS connection
1516
2296
session.handshake()
1517
except gnutls.errors.GNUTLSError as error:
2297
except gnutls.Error as error:
1518
2298
logger.warning("Handshake failed: %s", error)
1519
2299
# Do not run session.bye() here: the session is not
1520
2300
# established. Just abandon the request.
1522
2302
logger.debug("Handshake succeeded")
1524
2304
approval_required = False
1527
fpr = self.fingerprint(self.peer_certificate
1530
gnutls.errors.GNUTLSError) as error:
1531
logger.warning("Bad certificate: %s", error)
1533
logger.debug("Fingerprint: %s", fpr)
1536
client = ProxyClient(child_pipe, fpr,
2306
if gnutls.has_rawpk:
2309
key_id = self.key_id(
2310
self.peer_certificate(session))
2311
except (TypeError, gnutls.Error) as error:
2312
logger.warning("Bad certificate: %s", error)
2314
logger.debug("Key ID: %s", key_id)
2319
fpr = self.fingerprint(
2320
self.peer_certificate(session))
2321
except (TypeError, gnutls.Error) as error:
2322
logger.warning("Bad certificate: %s", error)
2324
logger.debug("Fingerprint: %s", fpr)
2327
client = ProxyClient(child_pipe, key_id, fpr,
1537
2328
self.client_address)
1538
2329
except KeyError:
1541
if self.server.use_dbus:
1543
client.NewRequest(str(self.client_address))
1545
2332
if client.approval_delay:
1546
2333
delay = client.approval_delay
1547
2334
client.approvals_pending += 1
1548
2335
approval_required = True
1551
2338
if not client.enabled:
1552
2339
logger.info("Client %s is disabled",
1554
2341
if self.server.use_dbus:
1555
2342
# Emit D-Bus signal
1556
2343
client.Rejected("Disabled")
1559
2346
if client.approved or not client.approval_delay:
1560
#We are approved or approval is disabled
2347
# We are approved or approval is disabled
1562
2349
elif client.approved is None:
1563
2350
logger.info("Client %s needs approval",
1598
2383
delay -= time2 - time
1601
while sent_size < len(client.secret):
1603
sent = session.send(client.secret[sent_size:])
1604
except gnutls.errors.GNUTLSError as error:
1605
logger.warning("gnutls send failed")
1607
logger.debug("Sent: %d, remaining: %d",
1608
sent, len(client.secret)
1609
- (sent_size + sent))
2386
session.send(client.secret)
2387
except gnutls.Error as error:
2388
logger.warning("gnutls send failed",
1612
2392
logger.info("Sending secret to %s", client.name)
1613
2393
# bump the timeout using extended_timeout
1614
client.checked_ok(client.extended_timeout)
2394
client.bump_timeout(client.extended_timeout)
1615
2395
if self.server.use_dbus:
1616
2396
# Emit D-Bus signal
1617
2397
client.GotSecret()
1620
2400
if approval_required:
1621
2401
client.approvals_pending -= 1
1624
except gnutls.errors.GNUTLSError as error:
1625
logger.warning("GnuTLS bye failed")
2404
except gnutls.Error as error:
2405
logger.warning("GnuTLS bye failed",
1628
2409
def peer_certificate(session):
1629
"Return the peer's OpenPGP certificate as a bytestring"
1630
# If not an OpenPGP certificate...
1631
if (gnutls.library.functions
1632
.gnutls_certificate_type_get(session._c_object)
1633
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1634
# ...do the normal thing
1635
return session.peer_certificate
2410
"Return the peer's certificate as a bytestring"
2412
cert_type = gnutls.certificate_type_get2(session._c_object,
2414
except AttributeError:
2415
cert_type = gnutls.certificate_type_get(session._c_object)
2416
if gnutls.has_rawpk:
2417
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2419
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2420
# If not a valid certificate type...
2421
if cert_type not in valid_cert_types:
2422
logger.info("Cert type %r not in %r", cert_type,
2424
# ...return invalid data
1636
2426
list_size = ctypes.c_uint(1)
1637
cert_list = (gnutls.library.functions
1638
.gnutls_certificate_get_peers
2427
cert_list = (gnutls.certificate_get_peers
1639
2428
(session._c_object, ctypes.byref(list_size)))
1640
2429
if not bool(cert_list) and list_size.value != 0:
1641
raise gnutls.errors.GNUTLSError("error getting peer"
2430
raise gnutls.Error("error getting peer certificate")
1643
2431
if list_size.value == 0:
1645
2433
cert = cert_list[0]
1646
2434
return ctypes.string_at(cert.data, cert.size)
2437
def key_id(certificate):
2438
"Convert a certificate bytestring to a hexdigit key ID"
2439
# New GnuTLS "datum" with the public key
2440
datum = gnutls.datum_t(
2441
ctypes.cast(ctypes.c_char_p(certificate),
2442
ctypes.POINTER(ctypes.c_ubyte)),
2443
ctypes.c_uint(len(certificate)))
2444
# XXX all these need to be created in the gnutls "module"
2445
# New empty GnuTLS certificate
2446
pubkey = gnutls.pubkey_t()
2447
gnutls.pubkey_init(ctypes.byref(pubkey))
2448
# Import the raw public key into the certificate
2449
gnutls.pubkey_import(pubkey,
2450
ctypes.byref(datum),
2451
gnutls.X509_FMT_DER)
2452
# New buffer for the key ID
2453
buf = ctypes.create_string_buffer(32)
2454
buf_len = ctypes.c_size_t(len(buf))
2455
# Get the key ID from the raw public key into the buffer
2456
gnutls.pubkey_get_key_id(pubkey,
2457
gnutls.KEYID_USE_SHA256,
2458
ctypes.cast(ctypes.byref(buf),
2459
ctypes.POINTER(ctypes.c_ubyte)),
2460
ctypes.byref(buf_len))
2461
# Deinit the certificate
2462
gnutls.pubkey_deinit(pubkey)
2464
# Convert the buffer to a Python bytestring
2465
key_id = ctypes.string_at(buf, buf_len.value)
2466
# Convert the bytestring to hexadecimal notation
2467
hex_key_id = binascii.hexlify(key_id).upper()
1649
2471
def fingerprint(openpgp):
1650
2472
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1651
2473
# New GnuTLS "datum" with the OpenPGP public key
1652
datum = (gnutls.library.types
1653
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1656
ctypes.c_uint(len(openpgp))))
2474
datum = gnutls.datum_t(
2475
ctypes.cast(ctypes.c_char_p(openpgp),
2476
ctypes.POINTER(ctypes.c_ubyte)),
2477
ctypes.c_uint(len(openpgp)))
1657
2478
# New empty GnuTLS certificate
1658
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1659
(gnutls.library.functions
1660
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2479
crt = gnutls.openpgp_crt_t()
2480
gnutls.openpgp_crt_init(ctypes.byref(crt))
1661
2481
# Import the OpenPGP public key into the certificate
1662
(gnutls.library.functions
1663
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1664
gnutls.library.constants
1665
.GNUTLS_OPENPGP_FMT_RAW))
2482
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2483
gnutls.OPENPGP_FMT_RAW)
1666
2484
# Verify the self signature in the key
1667
2485
crtverify = ctypes.c_uint()
1668
(gnutls.library.functions
1669
.gnutls_openpgp_crt_verify_self(crt, 0,
1670
ctypes.byref(crtverify)))
2486
gnutls.openpgp_crt_verify_self(crt, 0,
2487
ctypes.byref(crtverify))
1671
2488
if crtverify.value != 0:
1672
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1673
raise (gnutls.errors.CertificateSecurityError
2489
gnutls.openpgp_crt_deinit(crt)
2490
raise gnutls.CertificateSecurityError(code
1675
2492
# New buffer for the fingerprint
1676
2493
buf = ctypes.create_string_buffer(20)
1677
2494
buf_len = ctypes.c_size_t()
1678
2495
# Get the fingerprint from the certificate into the buffer
1679
(gnutls.library.functions
1680
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1681
ctypes.byref(buf_len)))
2496
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2497
ctypes.byref(buf_len))
1682
2498
# Deinit the certificate
1683
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2499
gnutls.openpgp_crt_deinit(crt)
1684
2500
# Convert the buffer to a Python bytestring
1685
2501
fpr = ctypes.string_at(buf, buf_len.value)
1686
2502
# Convert the bytestring to hexadecimal notation
1691
class MultiprocessingMixIn(object):
2507
class MultiprocessingMixIn:
1692
2508
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1693
2510
def sub_process_main(self, request, address):
1695
2512
self.finish_request(request, address)
1696
2513
except Exception:
1697
2514
self.handle_error(request, address)
1698
2515
self.close_request(request)
1700
2517
def process_request(self, request, address):
1701
2518
"""Start a new process to process the request."""
1702
proc = multiprocessing.Process(target = self.sub_process_main,
2519
proc = multiprocessing.Process(target=self.sub_process_main,
2520
args=(request, address))
1709
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2525
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1710
2526
""" adds a pipe to the MixIn """
1711
2528
def process_request(self, request, client_address):
1712
2529
"""Overrides and wraps the original process_request().
1714
2531
This function creates a new pipe in self.pipe
1716
2533
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1718
2535
proc = MultiprocessingMixIn.process_request(self, request,
1719
2536
client_address)
1720
2537
self.child_pipe.close()
1721
2538
self.add_pipe(parent_pipe, proc)
1723
2540
def add_pipe(self, parent_pipe, proc):
1724
2541
"""Dummy function; override as necessary"""
1725
raise NotImplementedError
2542
raise NotImplementedError()
1728
2545
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1729
socketserver.TCPServer, object):
2546
socketserver.TCPServer):
1730
2547
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1733
2550
enabled: Boolean; whether this server is activated yet
1734
2551
interface: None or a network interface name (string)
1735
2552
use_ipv6: Boolean; to use IPv6 or not
1737
2555
def __init__(self, server_address, RequestHandlerClass,
1738
interface=None, use_ipv6=True):
2559
"""If socketfd is set, use that file descriptor instead of
2560
creating a new one with socket.socket().
1739
2562
self.interface = interface
1741
2564
self.address_family = socket.AF_INET6
2565
if socketfd is not None:
2566
# Save the file descriptor
2567
self.socketfd = socketfd
2568
# Save the original socket.socket() function
2569
self.socket_socket = socket.socket
2571
# To implement --socket, we monkey patch socket.socket.
2573
# (When socketserver.TCPServer is a new-style class, we
2574
# could make self.socket into a property instead of monkey
2575
# patching socket.socket.)
2577
# Create a one-time-only replacement for socket.socket()
2578
@functools.wraps(socket.socket)
2579
def socket_wrapper(*args, **kwargs):
2580
# Restore original function so subsequent calls are
2582
socket.socket = self.socket_socket
2583
del self.socket_socket
2584
# This time only, return a new socket object from the
2585
# saved file descriptor.
2586
return socket.fromfd(self.socketfd, *args, **kwargs)
2587
# Replace socket.socket() function with wrapper
2588
socket.socket = socket_wrapper
2589
# The socketserver.TCPServer.__init__ will call
2590
# socket.socket(), which might be our replacement,
2591
# socket_wrapper(), if socketfd was set.
1742
2592
socketserver.TCPServer.__init__(self, server_address,
1743
2593
RequestHandlerClass)
1744
2595
def server_bind(self):
1745
2596
"""This overrides the normal server_bind() function
1746
2597
to bind to an interface if one was specified, and also NOT to
1747
2598
bind to an address or port if they were not specified."""
2599
global SO_BINDTODEVICE
1748
2600
if self.interface is not None:
1749
2601
if SO_BINDTODEVICE is None:
1750
logger.error("SO_BINDTODEVICE does not exist;"
1751
" cannot bind to interface %s",
1755
self.socket.setsockopt(socket.SOL_SOCKET,
1759
except socket.error as error:
1760
if error[0] == errno.EPERM:
1761
logger.error("No permission to"
1762
" bind to interface %s",
1764
elif error[0] == errno.ENOPROTOOPT:
1765
logger.error("SO_BINDTODEVICE not available;"
1766
" cannot bind to interface %s",
2602
# Fall back to a hard-coded value which seems to be
2604
logger.warning("SO_BINDTODEVICE not found, trying 25")
2605
SO_BINDTODEVICE = 25
2607
self.socket.setsockopt(
2608
socket.SOL_SOCKET, SO_BINDTODEVICE,
2609
(self.interface + "\0").encode("utf-8"))
2610
except socket.error as error:
2611
if error.errno == errno.EPERM:
2612
logger.error("No permission to bind to"
2613
" interface %s", self.interface)
2614
elif error.errno == errno.ENOPROTOOPT:
2615
logger.error("SO_BINDTODEVICE not available;"
2616
" cannot bind to interface %s",
2618
elif error.errno == errno.ENODEV:
2619
logger.error("Interface %s does not exist,"
2620
" cannot bind", self.interface)
1770
2623
# Only bind(2) the socket if we really need to.
1771
2624
if self.server_address[0] or self.server_address[1]:
2625
if self.server_address[1]:
2626
self.allow_reuse_address = True
1772
2627
if not self.server_address[0]:
1773
2628
if self.address_family == socket.AF_INET6:
1774
any_address = "::" # in6addr_any
2629
any_address = "::" # in6addr_any
1776
any_address = socket.INADDR_ANY
2631
any_address = "0.0.0.0" # INADDR_ANY
1777
2632
self.server_address = (any_address,
1778
2633
self.server_address[1])
1779
2634
elif not self.server_address[1]:
1780
self.server_address = (self.server_address[0],
2635
self.server_address = (self.server_address[0], 0)
1782
2636
# if self.interface:
1783
2637
# self.server_address = (self.server_address[0],
1887
2741
funcname = request[1]
1888
2742
args = request[2]
1889
2743
kwargs = request[3]
1891
2745
parent_pipe.send(('data', getattr(client_object,
1892
2746
funcname)(*args,
1895
2749
if command == 'getattr':
1896
2750
attrname = request[1]
1897
if callable(client_object.__getattribute__(attrname)):
1898
parent_pipe.send(('function',))
2751
if isinstance(client_object.__getattribute__(attrname),
2752
collections.Callable):
2753
parent_pipe.send(('function', ))
1900
parent_pipe.send(('data', client_object
1901
.__getattribute__(attrname)))
2756
'data', client_object.__getattribute__(attrname)))
1903
2758
if command == 'setattr':
1904
2759
attrname = request[1]
1905
2760
value = request[2]
1906
2761
setattr(client_object, attrname, value)
2766
def rfc3339_duration_to_delta(duration):
2767
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2769
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2771
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2773
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2775
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2777
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2779
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2781
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2785
# Parsing an RFC 3339 duration with regular expressions is not
2786
# possible - there would have to be multiple places for the same
2787
# values, like seconds. The current code, while more esoteric, is
2788
# cleaner without depending on a parsing library. If Python had a
2789
# built-in library for parsing we would use it, but we'd like to
2790
# avoid excessive use of external libraries.
2792
# New type for defining tokens, syntax, and semantics all-in-one
2793
Token = collections.namedtuple("Token", (
2794
"regexp", # To match token; if "value" is not None, must have
2795
# a "group" containing digits
2796
"value", # datetime.timedelta or None
2797
"followers")) # Tokens valid after this token
2798
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2799
# the "duration" ABNF definition in RFC 3339, Appendix A.
2800
token_end = Token(re.compile(r"$"), None, frozenset())
2801
token_second = Token(re.compile(r"(\d+)S"),
2802
datetime.timedelta(seconds=1),
2803
frozenset((token_end, )))
2804
token_minute = Token(re.compile(r"(\d+)M"),
2805
datetime.timedelta(minutes=1),
2806
frozenset((token_second, token_end)))
2807
token_hour = Token(re.compile(r"(\d+)H"),
2808
datetime.timedelta(hours=1),
2809
frozenset((token_minute, token_end)))
2810
token_time = Token(re.compile(r"T"),
2812
frozenset((token_hour, token_minute,
2814
token_day = Token(re.compile(r"(\d+)D"),
2815
datetime.timedelta(days=1),
2816
frozenset((token_time, token_end)))
2817
token_month = Token(re.compile(r"(\d+)M"),
2818
datetime.timedelta(weeks=4),
2819
frozenset((token_day, token_end)))
2820
token_year = Token(re.compile(r"(\d+)Y"),
2821
datetime.timedelta(weeks=52),
2822
frozenset((token_month, token_end)))
2823
token_week = Token(re.compile(r"(\d+)W"),
2824
datetime.timedelta(weeks=1),
2825
frozenset((token_end, )))
2826
token_duration = Token(re.compile(r"P"), None,
2827
frozenset((token_year, token_month,
2828
token_day, token_time,
2830
# Define starting values:
2832
value = datetime.timedelta()
2834
# Following valid tokens
2835
followers = frozenset((token_duration, ))
2836
# String left to parse
2838
# Loop until end token is found
2839
while found_token is not token_end:
2840
# Search for any currently valid tokens
2841
for token in followers:
2842
match = token.regexp.match(s)
2843
if match is not None:
2845
if token.value is not None:
2846
# Value found, parse digits
2847
factor = int(match.group(1), 10)
2848
# Add to value so far
2849
value += factor * token.value
2850
# Strip token from string
2851
s = token.regexp.sub("", s, 1)
2854
# Set valid next tokens
2855
followers = found_token.followers
2858
# No currently valid tokens were found
2859
raise ValueError("Invalid RFC 3339 duration: {!r}"
1911
2865
def string_to_delta(interval):
1912
2866
"""Parse a string and return a datetime.timedelta
1914
>>> string_to_delta('7d')
1915
datetime.timedelta(7)
1916
>>> string_to_delta('60s')
1917
datetime.timedelta(0, 60)
1918
>>> string_to_delta('60m')
1919
datetime.timedelta(0, 3600)
1920
>>> string_to_delta('24h')
1921
datetime.timedelta(1)
1922
>>> string_to_delta('1w')
1923
datetime.timedelta(7)
1924
>>> string_to_delta('5m 30s')
1925
datetime.timedelta(0, 330)
2868
>>> string_to_delta('7d') == datetime.timedelta(7)
2870
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2872
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2874
>>> string_to_delta('24h') == datetime.timedelta(1)
2876
>>> string_to_delta('1w') == datetime.timedelta(7)
2878
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2883
return rfc3339_duration_to_delta(interval)
1927
2887
timevalue = datetime.timedelta(0)
1928
2888
for s in interval.split():
1930
suffix = unicode(s[-1])
1931
2891
value = int(s[:-1])
1932
2892
if suffix == "d":
1933
2893
delta = datetime.timedelta(value)
2005
2965
parser.add_argument("--no-dbus", action="store_false",
2006
2966
dest="use_dbus", help="Do not provide D-Bus"
2007
" system bus interface")
2967
" system bus interface", default=None)
2008
2968
parser.add_argument("--no-ipv6", action="store_false",
2009
dest="use_ipv6", help="Do not use IPv6")
2969
dest="use_ipv6", help="Do not use IPv6",
2010
2971
parser.add_argument("--no-restore", action="store_false",
2011
2972
dest="restore", help="Do not restore stored"
2973
" state", default=None)
2974
parser.add_argument("--socket", type=int,
2975
help="Specify a file descriptor to a network"
2976
" socket to use instead of creating one")
2013
2977
parser.add_argument("--statedir", metavar="DIR",
2014
2978
help="Directory to save/restore state in")
2979
parser.add_argument("--foreground", action="store_true",
2980
help="Run in foreground", default=None)
2981
parser.add_argument("--no-zeroconf", action="store_false",
2982
dest="zeroconf", help="Do not use Zeroconf",
2016
2985
options = parser.parse_args()
2023
2987
# Default values for config file for server-global settings
2024
server_defaults = { "interface": "",
2029
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2030
"servicename": "Mandos",
2035
"statedir": "/var/lib/mandos"
2988
if gnutls.has_rawpk:
2989
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2990
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2992
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2993
":+SIGN-DSA-SHA256")
2994
server_defaults = {"interface": "",
2998
"priority": priority,
2999
"servicename": "Mandos",
3005
"statedir": "/var/lib/mandos",
3006
"foreground": "False",
2038
3011
# Parse config file for server-global settings
2039
server_config = configparser.SafeConfigParser(server_defaults)
3012
server_config = configparser.ConfigParser(server_defaults)
2040
3013
del server_defaults
2041
server_config.read(os.path.join(options.configdir,
2043
# Convert the SafeConfigParser object to a dict
3014
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3015
# Convert the ConfigParser object to a dict
2044
3016
server_settings = server_config.defaults()
2045
3017
# Use the appropriate methods on the non-string config options
2046
for option in ("debug", "use_dbus", "use_ipv6"):
3018
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3019
"foreground", "zeroconf"):
2047
3020
server_settings[option] = server_config.getboolean("DEFAULT",
2049
3022
if server_settings["port"]:
2050
3023
server_settings["port"] = server_config.getint("DEFAULT",
3025
if server_settings["socket"]:
3026
server_settings["socket"] = server_config.getint("DEFAULT",
3028
# Later, stdin will, and stdout and stderr might, be dup'ed
3029
# over with an opened os.devnull. But we don't want this to
3030
# happen with a supplied network socket.
3031
if 0 <= server_settings["socket"] <= 2:
3032
server_settings["socket"] = os.dup(server_settings
2052
3034
del server_config
2054
3036
# Override the settings from the config file with command line
2055
3037
# options, if set.
2056
3038
for option in ("interface", "address", "port", "debug",
2057
"priority", "servicename", "configdir",
2058
"use_dbus", "use_ipv6", "debuglevel", "restore",
3039
"priority", "servicename", "configdir", "use_dbus",
3040
"use_ipv6", "debuglevel", "restore", "statedir",
3041
"socket", "foreground", "zeroconf"):
2060
3042
value = getattr(options, option)
2061
3043
if value is not None:
2062
3044
server_settings[option] = value
2064
3046
# Force all strings to be unicode
2065
3047
for option in server_settings.keys():
2066
if type(server_settings[option]) is str:
2067
server_settings[option] = unicode(server_settings[option])
3048
if isinstance(server_settings[option], bytes):
3049
server_settings[option] = (server_settings[option]
3051
# Force all boolean options to be boolean
3052
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3053
"foreground", "zeroconf"):
3054
server_settings[option] = bool(server_settings[option])
3055
# Debug implies foreground
3056
if server_settings["debug"]:
3057
server_settings["foreground"] = True
2068
3058
# Now we have our good server settings in "server_settings"
2070
3060
##################################################################
3062
if (not server_settings["zeroconf"]
3063
and not (server_settings["port"]
3064
or server_settings["socket"] != "")):
3065
parser.error("Needs port or socket to work without Zeroconf")
2072
3067
# For convenience
2073
3068
debug = server_settings["debug"]
2074
3069
debuglevel = server_settings["debuglevel"]
2076
3071
use_ipv6 = server_settings["use_ipv6"]
2077
3072
stored_state_path = os.path.join(server_settings["statedir"],
2078
3073
stored_state_file)
3074
foreground = server_settings["foreground"]
3075
zeroconf = server_settings["zeroconf"]
2081
initlogger(logging.DEBUG)
3078
initlogger(debug, logging.DEBUG)
2083
3080
if not debuglevel:
2086
3083
level = getattr(logging, debuglevel.upper())
3084
initlogger(debug, level)
2089
3086
if server_settings["servicename"] != "Mandos":
2090
syslogger.setFormatter(logging.Formatter
2091
('Mandos (%s) [%%(process)d]:'
2092
' %%(levelname)s: %%(message)s'
2093
% server_settings["servicename"]))
3087
syslogger.setFormatter(
3088
logging.Formatter('Mandos ({}) [%(process)d]:'
3089
' %(levelname)s: %(message)s'.format(
3090
server_settings["servicename"])))
2095
3092
# Parse config file with clients
2096
client_config = configparser.SafeConfigParser(Client.client_defaults)
3093
client_config = configparser.ConfigParser(Client.client_defaults)
2097
3094
client_config.read(os.path.join(server_settings["configdir"],
2098
3095
"clients.conf"))
2100
3097
global mandos_dbus_service
2101
3098
mandos_dbus_service = None
2103
tcp_server = MandosServer((server_settings["address"],
2104
server_settings["port"]),
2106
interface=(server_settings["interface"]
2110
server_settings["priority"],
2113
pidfilename = "/var/run/mandos.pid"
2115
pidfile = open(pidfilename, "w")
2117
logger.error("Could not open file %r", pidfilename)
2120
uid = pwd.getpwnam("_mandos").pw_uid
2121
gid = pwd.getpwnam("_mandos").pw_gid
2124
uid = pwd.getpwnam("mandos").pw_uid
2125
gid = pwd.getpwnam("mandos").pw_gid
3101
if server_settings["socket"] != "":
3102
socketfd = server_settings["socket"]
3103
tcp_server = MandosServer(
3104
(server_settings["address"], server_settings["port"]),
3106
interface=(server_settings["interface"] or None),
3108
gnutls_priority=server_settings["priority"],
3112
pidfilename = "/run/mandos.pid"
3113
if not os.path.isdir("/run/."):
3114
pidfilename = "/var/run/mandos.pid"
3117
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3118
except IOError as e:
3119
logger.error("Could not open file %r", pidfilename,
3122
for name, group in (("_mandos", "_mandos"),
3123
("mandos", "mandos"),
3124
("nobody", "nogroup")):
3126
uid = pwd.getpwnam(name).pw_uid
3127
gid = pwd.getpwnam(group).pw_gid
2126
3129
except KeyError:
2128
uid = pwd.getpwnam("nobody").pw_uid
2129
gid = pwd.getpwnam("nobody").pw_gid
3138
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2136
3140
except OSError as error:
2137
if error[0] != errno.EPERM:
3141
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3142
.format(uid, gid, os.strerror(error.errno)))
3143
if error.errno != errno.EPERM:
2141
3147
# Enable all possible GnuTLS debugging
2143
3149
# "Use a log level over 10 to enable all debugging options."
2144
3150
# - GnuTLS manual
2145
gnutls.library.functions.gnutls_global_set_log_level(11)
2147
@gnutls.library.types.gnutls_log_func
3151
gnutls.global_set_log_level(11)
2148
3154
def debug_gnutls(level, string):
2149
3155
logger.debug("GnuTLS: %s", string[:-1])
2151
(gnutls.library.functions
2152
.gnutls_global_set_log_function(debug_gnutls))
3157
gnutls.global_set_log_function(debug_gnutls)
2154
3159
# Redirect stdin so all checkers get /dev/null
2155
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3160
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
3161
os.dup2(null, sys.stdin.fileno())
2160
# No console logging
2161
logger.removeHandler(console)
2163
3165
# Need to fork before connecting to D-Bus
2165
3167
# Close all input and output, do double fork, etc.
2168
gobject.threads_init()
3170
if gi.version_info < (3, 10, 2):
3171
# multiprocessing will use threads, so before we use GLib we
3172
# need to inform GLib that threads will be used.
2170
3175
global main_loop
2171
3176
# From the Avahi example code
2172
DBusGMainLoop(set_as_default=True )
2173
main_loop = gobject.MainLoop()
3177
DBusGMainLoop(set_as_default=True)
3178
main_loop = GLib.MainLoop()
2174
3179
bus = dbus.SystemBus()
2175
3180
# End of Avahi example code
2178
3183
bus_name = dbus.service.BusName("se.recompile.Mandos",
2179
bus, do_not_queue=True)
2180
old_bus_name = (dbus.service.BusName
2181
("se.bsnet.fukt.Mandos", bus,
2183
except dbus.exceptions.NameExistsException as e:
2184
logger.error(unicode(e) + ", disabling D-Bus")
3186
old_bus_name = dbus.service.BusName(
3187
"se.bsnet.fukt.Mandos", bus,
3189
except dbus.exceptions.DBusException as e:
3190
logger.error("Disabling D-Bus:", exc_info=e)
2185
3191
use_dbus = False
2186
3192
server_settings["use_dbus"] = False
2187
3193
tcp_server.use_dbus = False
2188
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2189
service = AvahiServiceToSyslog(name =
2190
server_settings["servicename"],
2191
servicetype = "_mandos._tcp",
2192
protocol = protocol, bus = bus)
2193
if server_settings["interface"]:
2194
service.interface = (if_nametoindex
2195
(str(server_settings["interface"])))
3195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3196
service = AvahiServiceToSyslog(
3197
name=server_settings["servicename"],
3198
servicetype="_mandos._tcp",
3201
if server_settings["interface"]:
3202
service.interface = if_nametoindex(
3203
server_settings["interface"].encode("utf-8"))
2197
3205
global multiprocessing_manager
2198
3206
multiprocessing_manager = multiprocessing.Manager()
2200
3208
client_class = Client
2202
client_class = functools.partial(ClientDBusTransitional,
3210
client_class = functools.partial(ClientDBus, bus=bus)
2205
3212
client_settings = Client.config_parser(client_config)
2206
3213
old_client_settings = {}
2207
3214
clients_data = {}
3216
# This is used to redirect stdout and stderr for checker processes
3218
wnull = open(os.devnull, "w") # A writable /dev/null
3219
# Only used if server is running in foreground but not in debug
3221
if debug or not foreground:
2209
3224
# Get client data and settings from last running state.
2210
3225
if server_settings["restore"]:
2212
3227
with open(stored_state_path, "rb") as stored_state:
2213
clients_data, old_client_settings = (pickle.load
3228
if sys.version_info.major == 2:
3229
clients_data, old_client_settings = pickle.load(
3232
bytes_clients_data, bytes_old_client_settings = (
3233
pickle.load(stored_state, encoding="bytes"))
3234
# Fix bytes to strings
3237
clients_data = {(key.decode("utf-8")
3238
if isinstance(key, bytes)
3241
bytes_clients_data.items()}
3242
del bytes_clients_data
3243
for key in clients_data:
3244
value = {(k.decode("utf-8")
3245
if isinstance(k, bytes) else k): v
3247
clients_data[key].items()}
3248
clients_data[key] = value
3250
value["client_structure"] = [
3252
if isinstance(s, bytes)
3254
value["client_structure"]]
3255
# .name, .host, and .checker_command
3256
for k in ("name", "host", "checker_command"):
3257
if isinstance(value[k], bytes):
3258
value[k] = value[k].decode("utf-8")
3259
if "key_id" not in value:
3260
value["key_id"] = ""
3261
elif "fingerprint" not in value:
3262
value["fingerprint"] = ""
3263
# old_client_settings
3265
old_client_settings = {
3266
(key.decode("utf-8")
3267
if isinstance(key, bytes)
3270
bytes_old_client_settings.items()}
3271
del bytes_old_client_settings
3272
# .host and .checker_command
3273
for value in old_client_settings.values():
3274
for attribute in ("host", "checker_command"):
3275
if isinstance(value[attribute], bytes):
3276
value[attribute] = (value[attribute]
2215
3278
os.remove(stored_state_path)
2216
3279
except IOError as e:
2217
logger.warning("Could not load persistent state: {0}"
2219
if e.errno != errno.ENOENT:
3280
if e.errno == errno.ENOENT:
3281
logger.warning("Could not load persistent state:"
3282
" {}".format(os.strerror(e.errno)))
3284
logger.critical("Could not load persistent state:",
2221
3287
except EOFError as e:
2222
3288
logger.warning("Could not load persistent state: "
2223
"EOFError: {0}".format(e))
2225
3292
with PGPEngine() as pgp:
2226
for client_name, client in clients_data.iteritems():
3293
for client_name, client in clients_data.items():
3294
# Skip removed clients
3295
if client_name not in client_settings:
2227
3298
# Decide which value to use after restoring saved state.
2228
3299
# We have three different values: Old config file,
2229
3300
# new config file, and saved state.
2234
3305
# For each value in new config, check if it
2235
3306
# differs from the old config value (Except for
2236
3307
# the "secret" attribute)
2237
if (name != "secret" and
2238
value != old_client_settings[client_name]
3308
if (name != "secret"
3310
old_client_settings[client_name][name])):
2240
3311
client[name] = value
2241
3312
except KeyError:
2244
3315
# Clients who has passed its expire date can still be
2245
# enabled if its last checker was successful. Clients
2246
# whose checker failed before we stored its state is
2247
# assumed to have failed all checkers during downtime.
3316
# enabled if its last checker was successful. A Client
3317
# whose checker succeeded before we stored its state is
3318
# assumed to have successfully run all checkers during
2248
3320
if client["enabled"]:
2249
3321
if datetime.datetime.utcnow() >= client["expires"]:
2250
3322
if not client["last_checked_ok"]:
2251
3323
logger.warning(
2252
"disabling client {0} - Client never "
2253
"performed a successfull checker"
2254
.format(client["name"]))
3324
"disabling client {} - Client never "
3325
"performed a successful checker".format(
2255
3327
client["enabled"] = False
2256
3328
elif client["last_checker_status"] != 0:
2257
3329
logger.warning(
2258
"disabling client {0} - Client "
2259
"last checker failed with error code {1}"
2260
.format(client["name"],
2261
client["last_checker_status"]))
3330
"disabling client {} - Client last"
3331
" checker failed with error code"
3334
client["last_checker_status"]))
2262
3335
client["enabled"] = False
2264
client["expires"] = (datetime.datetime
2266
+ client["timeout"])
3337
client["expires"] = (
3338
datetime.datetime.utcnow()
3339
+ client["timeout"])
3340
logger.debug("Last checker succeeded,"
3341
" keeping {} enabled".format(
2269
client["secret"] = (
2270
pgp.decrypt(client["encrypted_secret"],
2271
client_settings[client_name]
3344
client["secret"] = pgp.decrypt(
3345
client["encrypted_secret"],
3346
client_settings[client_name]["secret"])
2273
3347
except PGPError:
2274
3348
# If decryption fails, we use secret from new settings
2275
logger.debug("Failed to decrypt {0} old secret"
2276
.format(client_name))
2277
client["secret"] = (
2278
client_settings[client_name]["secret"])
3349
logger.debug("Failed to decrypt {} old secret".format(
3351
client["secret"] = (client_settings[client_name]
2281
3354
# Add/remove clients based on new changes made to config
2282
for client_name in set(old_client_settings) - set(client_settings):
3355
for client_name in (set(old_client_settings)
3356
- set(client_settings)):
2283
3357
del clients_data[client_name]
2284
for client_name in set(client_settings) - set(old_client_settings):
3358
for client_name in (set(client_settings)
3359
- set(old_client_settings)):
2285
3360
clients_data[client_name] = client_settings[client_name]
2287
# Create clients all clients
2288
for client_name, client in clients_data.iteritems():
3362
# Create all client objects
3363
for client_name, client in clients_data.items():
2289
3364
tcp_server.clients[client_name] = client_class(
2290
name = client_name, settings = client)
3367
server_settings=server_settings)
2292
3369
if not tcp_server.clients:
2293
3370
logger.warning("No clients defined")
2299
pidfile.write(str(pid) + "\n".encode("utf-8"))
2302
logger.error("Could not write to file %r with PID %d",
2305
# "pidfile" was never created
3373
if pidfile is not None:
3377
print(pid, file=pidfile)
3379
logger.error("Could not write to file %r with PID %d",
2307
3382
del pidfilename
2308
signal.signal(signal.SIGINT, signal.SIG_IGN)
2310
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2311
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3384
for termsig in (signal.SIGHUP, signal.SIGTERM):
3385
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3386
lambda: main_loop.quit() and False)
2314
class MandosDBusService(dbus.service.Object):
3390
@alternate_dbus_interfaces(
3391
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3392
class MandosDBusService(DBusObjectWithObjectManager):
2315
3393
"""A D-Bus proxy object"""
2316
3395
def __init__(self):
2317
3396
dbus.service.Object.__init__(self, bus, "/")
2318
3398
_interface = "se.recompile.Mandos"
2320
3400
@dbus.service.signal(_interface, signature="o")
2321
3401
def ClientAdded(self, objpath):
2325
3405
@dbus.service.signal(_interface, signature="ss")
2326
def ClientNotFound(self, fingerprint, address):
3406
def ClientNotFound(self, key_id, address):
3410
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2330
3412
@dbus.service.signal(_interface, signature="os")
2331
3413
def ClientRemoved(self, objpath, name):
3417
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2335
3419
@dbus.service.method(_interface, out_signature="ao")
2336
3420
def GetAllClients(self):
2338
return dbus.Array(c.dbus_object_path
2340
tcp_server.clients.itervalues())
3422
return dbus.Array(c.dbus_object_path for c in
3423
tcp_server.clients.values())
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2342
3427
@dbus.service.method(_interface,
2343
3428
out_signature="a{oa{sv}}")
2344
3429
def GetAllClientsWithProperties(self):
2346
3431
return dbus.Dictionary(
2347
((c.dbus_object_path, c.GetAll(""))
2348
for c in tcp_server.clients.itervalues()),
3432
{c.dbus_object_path: c.GetAll(
3433
"se.recompile.Mandos.Client")
3434
for c in tcp_server.clients.values()},
2349
3435
signature="oa{sv}")
2351
3437
@dbus.service.method(_interface, in_signature="o")
2352
3438
def RemoveClient(self, object_path):
2354
for c in tcp_server.clients.itervalues():
3440
for c in tcp_server.clients.values():
2355
3441
if c.dbus_object_path == object_path:
2356
3442
del tcp_server.clients[c.name]
2357
3443
c.remove_from_connection()
2358
# Don't signal anything except ClientRemoved
3444
# Don't signal the disabling
2359
3445
c.disable(quiet=True)
2361
self.ClientRemoved(object_path, c.name)
3446
# Emit D-Bus signal for removal
3447
self.client_removed_signal(c)
2363
3449
raise KeyError(object_path)
2367
class MandosDBusServiceTransitional(MandosDBusService):
2368
__metaclass__ = AlternateDBusNamesMetaclass
2369
mandos_dbus_service = MandosDBusServiceTransitional()
3453
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3454
out_signature="a{oa{sa{sv}}}")
3455
def GetManagedObjects(self):
3457
return dbus.Dictionary(
3458
{client.dbus_object_path:
3460
{interface: client.GetAll(interface)
3462
client._get_all_interface_names()})
3463
for client in tcp_server.clients.values()})
3465
def client_added_signal(self, client):
3466
"""Send the new standard signal and the old signal"""
3468
# New standard signal
3469
self.InterfacesAdded(
3470
client.dbus_object_path,
3472
{interface: client.GetAll(interface)
3474
client._get_all_interface_names()}))
3476
self.ClientAdded(client.dbus_object_path)
3478
def client_removed_signal(self, client):
3479
"""Send the new standard signal and the old signal"""
3481
# New standard signal
3482
self.InterfacesRemoved(
3483
client.dbus_object_path,
3484
client._get_all_interface_names())
3486
self.ClientRemoved(client.dbus_object_path,
3489
mandos_dbus_service = MandosDBusService()
3491
# Save modules to variables to exempt the modules from being
3492
# unloaded before the function registered with atexit() is run.
3493
mp = multiprocessing
2372
3497
"Cleanup function; run on exit"
2375
multiprocessing.active_children()
3501
mp.active_children()
2376
3503
if not (tcp_server.clients or client_settings):
2379
3506
# Store client before exiting. Secrets are encrypted with key
2380
3507
# based on what config file has. If config file is
2381
3508
# removed/edited, old secret will thus be unrecovable.
2383
3510
with PGPEngine() as pgp:
2384
for client in tcp_server.clients.itervalues():
3511
for client in tcp_server.clients.values():
2385
3512
key = client_settings[client.name]["secret"]
2386
3513
client.encrypted_secret = pgp.encrypt(client.secret,
2388
3515
client_dict = {}
2390
3517
# A list of attributes that can not be pickled
2392
exclude = set(("bus", "changedstate", "secret",
2394
for name, typ in (inspect.getmembers
2395
(dbus.service.Object)):
3519
exclude = {"bus", "changedstate", "secret",
3520
"checker", "server_settings"}
3521
for name, typ in inspect.getmembers(dbus.service
2396
3523
exclude.add(name)
2398
3525
client_dict["encrypted_secret"] = (client
2399
3526
.encrypted_secret)
2400
3527
for attr in client.client_structure:
2401
3528
if attr not in exclude:
2402
3529
client_dict[attr] = getattr(client, attr)
2404
3531
clients[client.name] = client_dict
2405
3532
del client_settings[client.name]["secret"]
2408
with os.fdopen(os.open(stored_state_path,
2409
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2410
0600), "wb") as stored_state:
2411
pickle.dump((clients, client_settings), stored_state)
3535
with tempfile.NamedTemporaryFile(
3539
dir=os.path.dirname(stored_state_path),
3540
delete=False) as stored_state:
3541
pickle.dump((clients, client_settings), stored_state,
3543
tempname = stored_state.name
3544
os.rename(tempname, stored_state_path)
2412
3545
except (IOError, OSError) as e:
2413
logger.warning("Could not save persistent state: {0}"
2415
if e.errno not in (errno.ENOENT, errno.EACCES):
3551
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3552
logger.warning("Could not save persistent state: {}"
3553
.format(os.strerror(e.errno)))
3555
logger.warning("Could not save persistent state:",
2418
3559
# Delete all clients, and settings from config
2419
3560
while tcp_server.clients:
2420
3561
name, client = tcp_server.clients.popitem()
2422
3563
client.remove_from_connection()
2423
# Don't signal anything except ClientRemoved
3564
# Don't signal the disabling
2424
3565
client.disable(quiet=True)
3566
# Emit D-Bus signal for removal
2427
mandos_dbus_service.ClientRemoved(client
3568
mandos_dbus_service.client_removed_signal(client)
2430
3569
client_settings.clear()
2432
3571
atexit.register(cleanup)
2434
for client in tcp_server.clients.itervalues():
3573
for client in tcp_server.clients.values():
2437
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3575
# Emit D-Bus signal for adding
3576
mandos_dbus_service.client_added_signal(client)
2438
3577
# Need to initiate checking of clients
2439
3578
if client.enabled:
2440
3579
client.init_checker()
2442
3581
tcp_server.enable()
2443
3582
tcp_server.server_activate()
2445
3584
# Find out what port we got
2446
service.port = tcp_server.socket.getsockname()[1]
3586
service.port = tcp_server.socket.getsockname()[1]
2448
3588
logger.info("Now listening on address %r, port %d,"
2449
" flowinfo %d, scope_id %d"
2450
% tcp_server.socket.getsockname())
3589
" flowinfo %d, scope_id %d",
3590
*tcp_server.socket.getsockname())
2452
logger.info("Now listening on address %r, port %d"
2453
% tcp_server.socket.getsockname())
2455
#service.interface = tcp_server.socket.getsockname()[3]
3592
logger.info("Now listening on address %r, port %d",
3593
*tcp_server.socket.getsockname())
3595
# service.interface = tcp_server.socket.getsockname()[3]
2458
# From the Avahi example code
2461
except dbus.exceptions.DBusException as error:
2462
logger.critical("DBusException: %s", error)
2465
# End of Avahi example code
2467
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2468
lambda *args, **kwargs:
2469
(tcp_server.handle_request
2470
(*args[2:], **kwargs) or True))
3599
# From the Avahi example code
3602
except dbus.exceptions.DBusException as error:
3603
logger.critical("D-Bus Exception", exc_info=error)
3606
# End of Avahi example code
3609
GLib.IOChannel.unix_new(tcp_server.fileno()),
3610
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3611
lambda *args, **kwargs: (tcp_server.handle_request
3612
(*args[2:], **kwargs) or True))
2472
3614
logger.debug("Starting main loop")
2473
3615
main_loop.run()
2474
3616
except AvahiError as error:
2475
logger.critical("AvahiError: %s", error)
3617
logger.critical("Avahi Error", exc_info=error)
2478
3620
except KeyboardInterrupt: