166
238
os.rmdir(self.tempdir)
167
239
self.tempdir = None
169
241
def password_encode(self, password):
170
242
# Passphrase can not be empty and can not contain newlines or
171
243
# NUL bytes. So we prefix it and hex encode it.
172
return b"mandos" + binascii.hexlify(password)
244
encoded = b"mandos" + binascii.hexlify(password)
245
if len(encoded) > 2048:
246
# GnuPG can't handle long passwords, so encode differently
247
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
248
.replace(b"\n", b"\\n")
249
.replace(b"\0", b"\\x00"))
174
252
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
253
passphrase = self.password_encode(password)
254
with tempfile.NamedTemporaryFile(
255
dir=self.tempdir) as passfile:
256
passfile.write(passphrase)
258
proc = subprocess.Popen([self.gpg, '--symmetric',
262
stdin=subprocess.PIPE,
263
stdout=subprocess.PIPE,
264
stderr=subprocess.PIPE)
265
ciphertext, err = proc.communicate(input=data)
266
if proc.returncode != 0:
189
268
return ciphertext
191
270
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
271
passphrase = self.password_encode(password)
272
with tempfile.NamedTemporaryFile(
273
dir=self.tempdir) as passfile:
274
passfile.write(passphrase)
276
proc = subprocess.Popen([self.gpg, '--decrypt',
280
stdin=subprocess.PIPE,
281
stdout=subprocess.PIPE,
282
stderr=subprocess.PIPE)
283
decrypted_plaintext, err = proc.communicate(input=data)
284
if proc.returncode != 0:
206
286
return decrypted_plaintext
289
# Pretend that we have an Avahi module
291
"""This isn't so much a class as it is a module-like namespace."""
292
IF_UNSPEC = -1 # avahi-common/address.h
293
PROTO_UNSPEC = -1 # avahi-common/address.h
294
PROTO_INET = 0 # avahi-common/address.h
295
PROTO_INET6 = 1 # avahi-common/address.h
296
DBUS_NAME = "org.freedesktop.Avahi"
297
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
298
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
299
DBUS_PATH_SERVER = "/"
302
def string_array_to_txt_array(t):
303
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
304
for s in t), signature="ay")
305
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
306
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
307
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
308
SERVER_INVALID = 0 # avahi-common/defs.h
309
SERVER_REGISTERING = 1 # avahi-common/defs.h
310
SERVER_RUNNING = 2 # avahi-common/defs.h
311
SERVER_COLLISION = 3 # avahi-common/defs.h
312
SERVER_FAILURE = 4 # avahi-common/defs.h
210
315
class AvahiError(Exception):
211
316
def __init__(self, value, *args, **kwargs):
212
317
self.value = value
213
super(AvahiError, self).__init__(value, *args, **kwargs)
214
def __unicode__(self):
215
return unicode(repr(self.value))
318
return super(AvahiError, self).__init__(value, *args,
217
322
class AvahiServiceError(AvahiError):
220
326
class AvahiGroupError(AvahiError):
224
class AvahiService(object):
225
331
"""An Avahi (Zeroconf) service.
228
334
interface: integer; avahi.IF_UNSPEC or an interface index.
229
335
Used to optionally bind to the specified interface.
230
336
name: string; Example: 'Mandos'
231
337
type: string; Example: '_mandos._tcp'.
232
See <http://www.dns-sd.org/ServiceTypes.html>
338
See <https://www.iana.org/assignments/service-names-port-numbers>
233
339
port: integer; what port to announce
234
340
TXT: list of strings; TXT record for the service
235
341
domain: string; Domain to publish on, default to .local if empty.
364
500
follow_name_owner_changes=True),
365
501
avahi.DBUS_INTERFACE_SERVER)
366
502
self.server.connect_to_signal("StateChanged",
367
self.server_state_changed)
503
self.server_state_changed)
368
504
self.server_state_changed(self.server.GetState())
370
507
class AvahiServiceToSyslog(AvahiService):
508
def rename(self, *args, **kwargs):
372
509
"""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'
510
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
511
syslogger.setFormatter(logging.Formatter(
512
'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):
517
# Pretend that we have a GnuTLS module
519
"""This isn't so much a class as it is a module-like namespace."""
521
library = ctypes.util.find_library("gnutls")
523
library = ctypes.util.find_library("gnutls-deb0")
524
_library = ctypes.cdll.LoadLibrary(library)
527
# Unless otherwise indicated, the constants and types below are
528
# all from the gnutls/gnutls.h C header file.
539
E_NO_CERTIFICATE_FOUND = -49
544
KEYID_USE_SHA256 = 1 # gnutls/x509.h
545
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
548
class session_int(ctypes.Structure):
550
session_t = ctypes.POINTER(session_int)
552
class certificate_credentials_st(ctypes.Structure):
554
certificate_credentials_t = ctypes.POINTER(
555
certificate_credentials_st)
556
certificate_type_t = ctypes.c_int
558
class datum_t(ctypes.Structure):
559
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
560
('size', ctypes.c_uint)]
562
class openpgp_crt_int(ctypes.Structure):
564
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
565
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
566
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
567
credentials_type_t = ctypes.c_int
568
transport_ptr_t = ctypes.c_void_p
569
close_request_t = ctypes.c_int
572
class Error(Exception):
573
def __init__(self, message=None, code=None, args=()):
574
# Default usage is by a message string, but if a return
575
# code is passed, convert it to a string with
578
if message is None and code is not None:
579
message = gnutls.strerror(code)
580
return super(gnutls.Error, self).__init__(
583
class CertificateSecurityError(Error):
589
self._c_object = gnutls.certificate_credentials_t()
590
gnutls.certificate_allocate_credentials(
591
ctypes.byref(self._c_object))
592
self.type = gnutls.CRD_CERTIFICATE
595
gnutls.certificate_free_credentials(self._c_object)
598
def __init__(self, socket, credentials=None):
599
self._c_object = gnutls.session_t()
600
gnutls_flags = gnutls.CLIENT
601
if gnutls.check_version(b"3.5.6"):
602
gnutls_flags |= gnutls.NO_TICKETS
604
gnutls_flags |= gnutls.ENABLE_RAWPK
605
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
607
gnutls.set_default_priority(self._c_object)
608
gnutls.transport_set_ptr(self._c_object, socket.fileno())
609
gnutls.handshake_set_private_extensions(self._c_object,
612
if credentials is None:
613
credentials = gnutls.Credentials()
614
gnutls.credentials_set(self._c_object, credentials.type,
615
ctypes.cast(credentials._c_object,
617
self.credentials = credentials
620
gnutls.deinit(self._c_object)
623
return gnutls.handshake(self._c_object)
625
def send(self, data):
629
data_len -= gnutls.record_send(self._c_object,
634
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
636
# Error handling functions
637
def _error_code(result):
638
"""A function to raise exceptions on errors, suitable
639
for the 'restype' attribute on ctypes functions"""
642
if result == gnutls.E_NO_CERTIFICATE_FOUND:
643
raise gnutls.CertificateSecurityError(code=result)
644
raise gnutls.Error(code=result)
646
def _retry_on_error(result, func, arguments):
647
"""A function to retry on some errors, suitable
648
for the 'errcheck' attribute on ctypes functions"""
650
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
651
return _error_code(result)
652
result = func(*arguments)
655
# Unless otherwise indicated, the function declarations below are
656
# all from the gnutls/gnutls.h C header file.
659
priority_set_direct = _library.gnutls_priority_set_direct
660
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
661
ctypes.POINTER(ctypes.c_char_p)]
662
priority_set_direct.restype = _error_code
664
init = _library.gnutls_init
665
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
666
init.restype = _error_code
668
set_default_priority = _library.gnutls_set_default_priority
669
set_default_priority.argtypes = [session_t]
670
set_default_priority.restype = _error_code
672
record_send = _library.gnutls_record_send
673
record_send.argtypes = [session_t, ctypes.c_void_p,
675
record_send.restype = ctypes.c_ssize_t
676
record_send.errcheck = _retry_on_error
678
certificate_allocate_credentials = (
679
_library.gnutls_certificate_allocate_credentials)
680
certificate_allocate_credentials.argtypes = [
681
ctypes.POINTER(certificate_credentials_t)]
682
certificate_allocate_credentials.restype = _error_code
684
certificate_free_credentials = (
685
_library.gnutls_certificate_free_credentials)
686
certificate_free_credentials.argtypes = [
687
certificate_credentials_t]
688
certificate_free_credentials.restype = None
690
handshake_set_private_extensions = (
691
_library.gnutls_handshake_set_private_extensions)
692
handshake_set_private_extensions.argtypes = [session_t,
694
handshake_set_private_extensions.restype = None
696
credentials_set = _library.gnutls_credentials_set
697
credentials_set.argtypes = [session_t, credentials_type_t,
699
credentials_set.restype = _error_code
701
strerror = _library.gnutls_strerror
702
strerror.argtypes = [ctypes.c_int]
703
strerror.restype = ctypes.c_char_p
705
certificate_type_get = _library.gnutls_certificate_type_get
706
certificate_type_get.argtypes = [session_t]
707
certificate_type_get.restype = _error_code
709
certificate_get_peers = _library.gnutls_certificate_get_peers
710
certificate_get_peers.argtypes = [session_t,
711
ctypes.POINTER(ctypes.c_uint)]
712
certificate_get_peers.restype = ctypes.POINTER(datum_t)
714
global_set_log_level = _library.gnutls_global_set_log_level
715
global_set_log_level.argtypes = [ctypes.c_int]
716
global_set_log_level.restype = None
718
global_set_log_function = _library.gnutls_global_set_log_function
719
global_set_log_function.argtypes = [log_func]
720
global_set_log_function.restype = None
722
deinit = _library.gnutls_deinit
723
deinit.argtypes = [session_t]
724
deinit.restype = None
726
handshake = _library.gnutls_handshake
727
handshake.argtypes = [session_t]
728
handshake.restype = _error_code
729
handshake.errcheck = _retry_on_error
731
transport_set_ptr = _library.gnutls_transport_set_ptr
732
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
733
transport_set_ptr.restype = None
735
bye = _library.gnutls_bye
736
bye.argtypes = [session_t, close_request_t]
737
bye.restype = _error_code
738
bye.errcheck = _retry_on_error
740
check_version = _library.gnutls_check_version
741
check_version.argtypes = [ctypes.c_char_p]
742
check_version.restype = ctypes.c_char_p
744
_need_version = b"3.3.0"
745
if check_version(_need_version) is None:
746
raise self.Error("Needs GnuTLS {} or later"
747
.format(_need_version))
749
_tls_rawpk_version = b"3.6.6"
750
has_rawpk = bool(check_version(_tls_rawpk_version))
754
class pubkey_st(ctypes.Structure):
756
pubkey_t = ctypes.POINTER(pubkey_st)
758
x509_crt_fmt_t = ctypes.c_int
760
# All the function declarations below are from gnutls/abstract.h
761
pubkey_init = _library.gnutls_pubkey_init
762
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
763
pubkey_init.restype = _error_code
765
pubkey_import = _library.gnutls_pubkey_import
766
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
768
pubkey_import.restype = _error_code
770
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
771
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
772
ctypes.POINTER(ctypes.c_ubyte),
773
ctypes.POINTER(ctypes.c_size_t)]
774
pubkey_get_key_id.restype = _error_code
776
pubkey_deinit = _library.gnutls_pubkey_deinit
777
pubkey_deinit.argtypes = [pubkey_t]
778
pubkey_deinit.restype = None
780
# All the function declarations below are from gnutls/openpgp.h
782
openpgp_crt_init = _library.gnutls_openpgp_crt_init
783
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
784
openpgp_crt_init.restype = _error_code
786
openpgp_crt_import = _library.gnutls_openpgp_crt_import
787
openpgp_crt_import.argtypes = [openpgp_crt_t,
788
ctypes.POINTER(datum_t),
790
openpgp_crt_import.restype = _error_code
792
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
793
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
794
ctypes.POINTER(ctypes.c_uint)]
795
openpgp_crt_verify_self.restype = _error_code
797
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
798
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
799
openpgp_crt_deinit.restype = None
801
openpgp_crt_get_fingerprint = (
802
_library.gnutls_openpgp_crt_get_fingerprint)
803
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
807
openpgp_crt_get_fingerprint.restype = _error_code
809
if check_version(b"3.6.4"):
810
certificate_type_get2 = _library.gnutls_certificate_type_get2
811
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
812
certificate_type_get2.restype = _error_code
814
# Remove non-public functions
815
del _error_code, _retry_on_error
818
def call_pipe(connection, # : multiprocessing.Connection
819
func, *args, **kwargs):
820
"""This function is meant to be called by multiprocessing.Process
822
This function runs func(*args, **kwargs), and writes the resulting
823
return value on the provided multiprocessing.Connection.
825
connection.send(func(*args, **kwargs))
387
830
"""A representation of a client host served by this server.
390
833
approved: bool(); 'None' if not yet approved/disapproved
391
834
approval_delay: datetime.timedelta(); Time to wait for approval
392
835
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
836
checker: multiprocessing.Process(); a running checker process used
837
to see if the client lives. 'None' if no process is
839
checker_callback_tag: a GLib event source tag, or None
397
840
checker_command: string; External command which is run to check
398
841
if client lives. %() expansions are done at
399
842
runtime with vars(self) as dict, so that for
400
843
instance %(name)s can be used in the command.
401
checker_initiator_tag: a gobject event source tag, or None
844
checker_initiator_tag: a GLib event source tag, or None
402
845
created: datetime.datetime(); (UTC) object creation
403
846
client_structure: Object describing what attributes a client has
404
847
and is used for storing the client at exit
405
848
current_checker_command: string; current running checker_command
406
disable_initiator_tag: a gobject event source tag, or None
849
disable_initiator_tag: a GLib event source tag, or None
408
851
fingerprint: string (40 or 32 hexadecimal digits); used to
409
uniquely identify the client
852
uniquely identify an OpenPGP client
853
key_id: string (64 hexadecimal digits); used to uniquely identify
854
a client using raw public keys
410
855
host: string; available for use by the checker command
411
856
interval: datetime.timedelta(); How often to start a new checker
412
857
last_approval_request: datetime.datetime(); (UTC) or None
413
858
last_checked_ok: datetime.datetime(); (UTC) or None
414
859
last_checker_status: integer between 0 and 255 reflecting exit
415
860
status of last checker. -1 reflects crashed
861
checker, -2 means no checker completed yet.
862
last_checker_signal: The signal which killed the last checker, if
863
last_checker_status is -1
417
864
last_enabled: datetime.datetime(); (UTC) or None
418
865
name: string; from the config file, used in log messages and
419
866
D-Bus identifiers
420
867
secret: bytestring; sent verbatim (over TLS) to client
421
868
timeout: datetime.timedelta(); How long from last_checked_ok
422
869
until this client is disabled
423
extended_timeout: extra long timeout when password has been sent
870
extended_timeout: extra long timeout when secret has been sent
424
871
runtime_expansions: Allowed attributes for runtime expansion.
425
872
expires: datetime.datetime(); time (UTC) when a client will be
426
873
disabled, or None
874
server_settings: The server_settings dict from main()
429
877
runtime_expansions = ("approval_delay", "approval_duration",
430
"created", "enabled", "fingerprint",
431
"host", "interval", "last_checked_ok",
878
"created", "enabled", "expires", "key_id",
879
"fingerprint", "host", "interval",
880
"last_approval_request", "last_checked_ok",
432
881
"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)
884
"extended_timeout": "PT15M",
886
"checker": "fping -q -- %%(host)s",
888
"approval_delay": "PT0S",
889
"approval_duration": "PT1S",
890
"approved_by_default": "True",
460
895
def config_parser(config):
461
""" Construct a new dict of client settings of this form:
896
"""Construct a new dict of client settings of this form:
462
897
{ client_name: {setting_name: value, ...}, ...}
463
with exceptions for any special settings as defined above"""
898
with exceptions for any special settings as defined above.
899
NOTE: Must be a pure function. Must return the same result
900
value given the same arguments.
465
903
for client_name in config.sections():
466
904
section = dict(config.items(client_name))
467
905
client = settings[client_name] = {}
469
907
client["host"] = section["host"]
470
908
# Reformat values from string types to Python types
471
909
client["approved_by_default"] = config.getboolean(
472
910
client_name, "approved_by_default")
473
client["enabled"] = config.getboolean(client_name, "enabled")
911
client["enabled"] = config.getboolean(client_name,
914
# Uppercase and remove spaces from key_id and fingerprint
915
# for later comparison purposes with return value from the
916
# key_id() and fingerprint() functions
917
client["key_id"] = (section.get("key_id", "").upper()
475
919
client["fingerprint"] = (section["fingerprint"].upper()
476
920
.replace(" ", ""))
477
921
if "secret" in section:
478
client["secret"] = section["secret"].decode("base64")
922
client["secret"] = codecs.decode(section["secret"]
479
925
elif "secfile" in section:
480
926
with open(os.path.expanduser(os.path.expandvars
481
927
(section["secfile"])),
482
928
"rb") as secfile:
483
929
client["secret"] = secfile.read()
485
raise TypeError("No secret or secfile for section %s"
931
raise TypeError("No secret or secfile for section {}"
487
933
client["timeout"] = string_to_delta(section["timeout"])
488
934
client["extended_timeout"] = string_to_delta(
489
935
section["extended_timeout"])
531
978
self.current_checker_command = None
532
979
self.approved = None
533
980
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()
981
self.changedstate = multiprocessing_manager.Condition(
982
multiprocessing_manager.Lock())
983
self.client_structure = [attr
984
for attr in self.__dict__.keys()
539
985
if not attr.startswith("_")]
540
986
self.client_structure.append("client_structure")
542
for name, t in inspect.getmembers(type(self),
988
for name, t in inspect.getmembers(
989
type(self), lambda obj: isinstance(obj, property)):
546
990
if not name.startswith("_"):
547
991
self.client_structure.append(name)
549
993
# Send notice to process children that client state has changed
550
994
def send_changedstate(self):
551
995
with self.changedstate:
552
996
self.changedstate.notify_all()
554
998
def enable(self):
555
999
"""Start this client's checker and timeout hooks"""
556
1000
if getattr(self, "enabled", False):
557
1001
# Already enabled
559
self.send_changedstate()
560
1003
self.expires = datetime.datetime.utcnow() + self.timeout
561
1004
self.enabled = True
562
1005
self.last_enabled = datetime.datetime.utcnow()
563
1006
self.init_checker()
1007
self.send_changedstate()
565
1009
def disable(self, quiet=True):
566
1010
"""Disable this client."""
567
1011
if not getattr(self, "enabled", False):
570
self.send_changedstate()
572
1014
logger.info("Disabling client %s", self.name)
573
if getattr(self, "disable_initiator_tag", False):
574
gobject.source_remove(self.disable_initiator_tag)
1015
if getattr(self, "disable_initiator_tag", None) is not None:
1016
GLib.source_remove(self.disable_initiator_tag)
575
1017
self.disable_initiator_tag = None
576
1018
self.expires = None
577
if getattr(self, "checker_initiator_tag", False):
578
gobject.source_remove(self.checker_initiator_tag)
1019
if getattr(self, "checker_initiator_tag", None) is not None:
1020
GLib.source_remove(self.checker_initiator_tag)
579
1021
self.checker_initiator_tag = None
580
1022
self.stop_checker()
581
1023
self.enabled = False
582
# Do not run this again if called by a gobject.timeout_add
1025
self.send_changedstate()
1026
# Do not run this again if called by a GLib.timeout_add
585
1029
def __del__(self):
588
1032
def init_checker(self):
589
1033
# Schedule a new checker to be started an 'interval' from now,
590
1034
# and every interval from then on.
591
self.checker_initiator_tag = (gobject.timeout_add
592
(self.interval_milliseconds(),
1035
if self.checker_initiator_tag is not None:
1036
GLib.source_remove(self.checker_initiator_tag)
1037
self.checker_initiator_tag = GLib.timeout_add(
1038
int(self.interval.total_seconds() * 1000),
594
1040
# Schedule a disable() when 'timeout' has passed
595
self.disable_initiator_tag = (gobject.timeout_add
596
(self.timeout_milliseconds(),
1041
if self.disable_initiator_tag is not None:
1042
GLib.source_remove(self.disable_initiator_tag)
1043
self.disable_initiator_tag = GLib.timeout_add(
1044
int(self.timeout.total_seconds() * 1000), self.disable)
598
1045
# Also start a new checker *right now*.
599
1046
self.start_checker()
601
def checker_callback(self, pid, condition, command):
1048
def checker_callback(self, source, condition, connection,
602
1050
"""The checker has completed, so take appropriate actions."""
1051
# Read return code from connection (see call_pipe)
1052
returncode = connection.recv()
1054
if self.checker is not None:
603
1056
self.checker_callback_tag = None
604
1057
self.checker = None
605
if os.WIFEXITED(condition):
606
self.last_checker_status = os.WEXITSTATUS(condition)
1060
self.last_checker_status = returncode
1061
self.last_checker_signal = None
607
1062
if self.last_checker_status == 0:
608
1063
logger.info("Checker for %(name)s succeeded",
610
1065
self.checked_ok()
612
logger.info("Checker for %(name)s failed",
1067
logger.info("Checker for %(name)s failed", vars(self))
615
1069
self.last_checker_status = -1
1070
self.last_checker_signal = -returncode
616
1071
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,
1075
def checked_ok(self):
1076
"""Assert that the client has been seen, alive and well."""
1077
self.last_checked_ok = datetime.datetime.utcnow()
1078
self.last_checker_status = 0
1079
self.last_checker_signal = None
1082
def bump_timeout(self, timeout=None):
1083
"""Bump up the timeout for this client."""
625
1084
if timeout is None:
626
1085
timeout = self.timeout
627
self.last_checked_ok = datetime.datetime.utcnow()
628
1086
if self.disable_initiator_tag is not None:
629
gobject.source_remove(self.disable_initiator_tag)
1087
GLib.source_remove(self.disable_initiator_tag)
1088
self.disable_initiator_tag = None
630
1089
if getattr(self, "enabled", False):
631
self.disable_initiator_tag = (gobject.timeout_add
632
(timedelta_to_milliseconds
633
(timeout), self.disable))
1090
self.disable_initiator_tag = GLib.timeout_add(
1091
int(timeout.total_seconds() * 1000), self.disable)
634
1092
self.expires = datetime.datetime.utcnow() + timeout
636
1094
def need_approval(self):
637
1095
self.last_approval_request = datetime.datetime.utcnow()
639
1097
def start_checker(self):
640
1098
"""Start a new checker subprocess if one is not running.
642
1100
If a checker already exists, leave it running and do
644
1102
# 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
1103
# did that, and if a checker (for some reason) started running
1104
# slowly and taking more than 'interval' time, then the client
1105
# would inevitably timeout, since no checker would get a
1106
# chance to run to completion. If we instead leave running
649
1107
# checkers alone, the checker would have to take more time
650
1108
# 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)
1111
if self.checker is not None and not self.checker.is_alive():
1112
logger.warning("Checker was not alive; joining")
666
1115
# Start a new checker if needed
667
1116
if self.checker is None:
1117
# Escape attributes for the shell
1119
attr: re.escape(str(getattr(self, attr)))
1120
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
1122
command = self.checker_command % escaped_attrs
1123
except TypeError as error:
1124
logger.error('Could not format string "%s"',
1125
self.checker_command,
1127
return True # Try again later
687
1128
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
1129
logger.info("Starting checker %r for %s", command,
1131
# We don't need to redirect stdout and stderr, since
1132
# in normal mode, that is already done by daemon(),
1133
# and in debug mode we don't want to. (Stdin is
1134
# always replaced by /dev/null.)
1135
# The exception is when not debugging but nevertheless
1136
# running in the foreground; use the previously
1138
popen_args = {"close_fds": True,
1141
if (not self.server_settings["debug"]
1142
and self.server_settings["foreground"]):
1143
popen_args.update({"stdout": wnull,
1145
pipe = multiprocessing.Pipe(duplex=False)
1146
self.checker = multiprocessing.Process(
1148
args=(pipe[1], subprocess.call, command),
1150
self.checker.start()
1151
self.checker_callback_tag = GLib.io_add_watch(
1152
GLib.IOChannel.unix_new(pipe[0].fileno()),
1153
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1154
self.checker_callback, pipe[0], command)
1155
# Re-run this periodically if run by GLib.timeout_add
714
1158
def stop_checker(self):
715
1159
"""Force the checker process, if any, to stop."""
716
1160
if self.checker_callback_tag:
717
gobject.source_remove(self.checker_callback_tag)
1161
GLib.source_remove(self.checker_callback_tag)
718
1162
self.checker_callback_tag = None
719
1163
if getattr(self, "checker", None) is None:
721
1165
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
1166
self.checker.terminate()
730
1167
self.checker = None
733
def dbus_service_property(dbus_interface, signature="v",
734
access="readwrite", byte_arrays=False):
1170
def dbus_service_property(dbus_interface,
735
1174
"""Decorators for marking methods of a DBusObjectWithProperties to
736
1175
become properties on the D-Bus.
738
1177
The decorated method will be called with no arguments by "Get"
739
1178
and with one argument by "Set".
741
1180
The parameters, where they are supported, are the same as
742
1181
dbus.service.method, except there is only "signature", since the
743
1182
type from Get() and the type sent to Set() is the same.
782
class DBusObjectWithProperties(dbus.service.Object):
1265
class DBusObjectWithAnnotations(dbus.service.Object):
1266
"""A D-Bus object with annotations.
1268
Classes inheriting from this can use the dbus_annotations
1269
decorator to add annotations to methods or signals.
1273
def _is_dbus_thing(thing):
1274
"""Returns a function testing if an attribute is a D-Bus thing
1276
If called like _is_dbus_thing("method") it returns a function
1277
suitable for use as predicate to inspect.getmembers().
1279
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1282
def _get_all_dbus_things(self, thing):
1283
"""Returns a generator of (name, attribute) pairs
1285
return ((getattr(athing.__get__(self), "_dbus_name", name),
1286
athing.__get__(self))
1287
for cls in self.__class__.__mro__
1289
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1291
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1293
path_keyword='object_path',
1294
connection_keyword='connection')
1295
def Introspect(self, object_path, connection):
1296
"""Overloading of standard D-Bus method.
1298
Inserts annotation tags on methods and signals.
1300
xmlstring = dbus.service.Object.Introspect(self, object_path,
1303
document = xml.dom.minidom.parseString(xmlstring)
1305
for if_tag in document.getElementsByTagName("interface"):
1306
# Add annotation tags
1307
for typ in ("method", "signal"):
1308
for tag in if_tag.getElementsByTagName(typ):
1310
for name, prop in (self.
1311
_get_all_dbus_things(typ)):
1312
if (name == tag.getAttribute("name")
1313
and prop._dbus_interface
1314
== if_tag.getAttribute("name")):
1315
annots.update(getattr(
1316
prop, "_dbus_annotations", {}))
1317
for name, value in annots.items():
1318
ann_tag = document.createElement(
1320
ann_tag.setAttribute("name", name)
1321
ann_tag.setAttribute("value", value)
1322
tag.appendChild(ann_tag)
1323
# Add interface annotation tags
1324
for annotation, value in dict(
1325
itertools.chain.from_iterable(
1326
annotations().items()
1327
for name, annotations
1328
in self._get_all_dbus_things("interface")
1329
if name == if_tag.getAttribute("name")
1331
ann_tag = document.createElement("annotation")
1332
ann_tag.setAttribute("name", annotation)
1333
ann_tag.setAttribute("value", value)
1334
if_tag.appendChild(ann_tag)
1335
# Fix argument name for the Introspect method itself
1336
if (if_tag.getAttribute("name")
1337
== dbus.INTROSPECTABLE_IFACE):
1338
for cn in if_tag.getElementsByTagName("method"):
1339
if cn.getAttribute("name") == "Introspect":
1340
for arg in cn.getElementsByTagName("arg"):
1341
if (arg.getAttribute("direction")
1343
arg.setAttribute("name",
1345
xmlstring = document.toxml("utf-8")
1347
except (AttributeError, xml.dom.DOMException,
1348
xml.parsers.expat.ExpatError) as error:
1349
logger.error("Failed to override Introspection method",
1354
class DBusObjectWithProperties(DBusObjectWithAnnotations):
783
1355
"""A D-Bus object with properties.
785
1357
Classes inheriting from this can use the dbus_service_property
786
1358
decorator to expose methods as D-Bus properties. It exposes the
787
1359
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
1362
def _get_dbus_property(self, interface_name, property_name):
803
1363
"""Returns a bound method if one exists which is a D-Bus
804
1364
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)):
1366
for cls in self.__class__.__mro__:
1367
for name, value in inspect.getmembers(
1368
cls, self._is_dbus_thing("property")):
809
1369
if (value._dbus_name == property_name
810
1370
and value._dbus_interface == interface_name):
811
1371
return value.__get__(self)
813
1373
# No such property
814
raise DBusPropertyNotFound(self.dbus_object_path + ":"
815
+ interface_name + "."
818
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1374
raise DBusPropertyNotFound("{}:{}.{}".format(
1375
self.dbus_object_path, interface_name, property_name))
1378
def _get_all_interface_names(cls):
1379
"""Get a sequence of all interfaces supported by an object"""
1380
return (name for name in set(getattr(getattr(x, attr),
1381
"_dbus_interface", None)
1382
for x in (inspect.getmro(cls))
1384
if name is not None)
1386
@dbus.service.method(dbus.PROPERTIES_IFACE,
819
1388
out_signature="v")
820
1389
def Get(self, interface_name, property_name):
821
1390
"""Standard D-Bus property Get() method, see D-Bus standard.
913
1514
except (AttributeError, xml.dom.DOMException,
914
1515
xml.parsers.expat.ExpatError) as error:
915
1516
logger.error("Failed to override Introspection method",
920
def datetime_to_dbus (dt, variant_level=0):
1522
dbus.OBJECT_MANAGER_IFACE
1523
except AttributeError:
1524
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1527
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1528
"""A D-Bus object with an ObjectManager.
1530
Classes inheriting from this exposes the standard
1531
GetManagedObjects call and the InterfacesAdded and
1532
InterfacesRemoved signals on the standard
1533
"org.freedesktop.DBus.ObjectManager" interface.
1535
Note: No signals are sent automatically; they must be sent
1538
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1539
out_signature="a{oa{sa{sv}}}")
1540
def GetManagedObjects(self):
1541
"""This function must be overridden"""
1542
raise NotImplementedError()
1544
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1545
signature="oa{sa{sv}}")
1546
def InterfacesAdded(self, object_path, interfaces_and_properties):
1549
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1550
def InterfacesRemoved(self, object_path, interfaces):
1553
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1555
path_keyword='object_path',
1556
connection_keyword='connection')
1557
def Introspect(self, object_path, connection):
1558
"""Overloading of standard D-Bus method.
1560
Override return argument name of GetManagedObjects to be
1561
"objpath_interfaces_and_properties"
1563
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1567
document = xml.dom.minidom.parseString(xmlstring)
1569
for if_tag in document.getElementsByTagName("interface"):
1570
# Fix argument name for the GetManagedObjects method
1571
if (if_tag.getAttribute("name")
1572
== dbus.OBJECT_MANAGER_IFACE):
1573
for cn in if_tag.getElementsByTagName("method"):
1574
if (cn.getAttribute("name")
1575
== "GetManagedObjects"):
1576
for arg in cn.getElementsByTagName("arg"):
1577
if (arg.getAttribute("direction")
1581
"objpath_interfaces"
1583
xmlstring = document.toxml("utf-8")
1585
except (AttributeError, xml.dom.DOMException,
1586
xml.parsers.expat.ExpatError) as error:
1587
logger.error("Failed to override Introspection method",
1592
def datetime_to_dbus(dt, variant_level=0):
921
1593
"""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.
1595
return dbus.String("", variant_level=variant_level)
1596
return dbus.String(dt.isoformat(), variant_level=variant_level)
1599
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1600
"""A class decorator; applied to a subclass of
1601
dbus.service.Object, it will add alternate D-Bus attributes with
1602
interface names according to the "alt_interface_names" mapping.
1605
@alternate_dbus_interfaces({"org.example.Interface":
1606
"net.example.AlternateInterface"})
1607
class SampleDBusObject(dbus.service.Object):
1608
@dbus.service.method("org.example.Interface")
1609
def SampleDBusMethod():
1612
The above "SampleDBusMethod" on "SampleDBusObject" will be
1613
reachable via two interfaces: "org.example.Interface" and
1614
"net.example.AlternateInterface", the latter of which will have
1615
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1616
"true", unless "deprecate" is passed with a False value.
1618
This works for methods and signals, and also for D-Bus properties
1619
(from DBusObjectWithProperties) and interfaces (from the
1620
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):
1624
for orig_interface_name, alt_interface_name in (
1625
alt_interface_names.items()):
1627
interface_names = set()
1628
# Go though all attributes of the class
1629
for attrname, attribute in inspect.getmembers(cls):
940
1630
# Ignore non-D-Bus attributes, and D-Bus attributes
941
1631
# with the wrong interface name
942
1632
if (not hasattr(attribute, "_dbus_interface")
943
or not attribute._dbus_interface
944
.startswith("se.recompile.Mandos")):
1633
or not attribute._dbus_interface.startswith(
1634
orig_interface_name)):
946
1636
# Create an alternate D-Bus interface name based on
947
1637
# the current name
948
alt_interface = (attribute._dbus_interface
949
.replace("se.recompile.Mandos",
950
"se.bsnet.fukt.Mandos"))
1638
alt_interface = attribute._dbus_interface.replace(
1639
orig_interface_name, alt_interface_name)
1640
interface_names.add(alt_interface)
951
1641
# Is this a D-Bus signal?
952
1642
if getattr(attribute, "_dbus_is_signal", False):
953
# Extract the original non-method function by
955
nonmethod_func = (dict(
1643
# Extract the original non-method undecorated
1644
# function by black magic
1645
if sys.version_info.major == 2:
1646
nonmethod_func = (dict(
956
1647
zip(attribute.func_code.co_freevars,
957
attribute.__closure__))["func"]
1648
attribute.__closure__))
1649
["func"].cell_contents)
1651
nonmethod_func = (dict(
1652
zip(attribute.__code__.co_freevars,
1653
attribute.__closure__))
1654
["func"].cell_contents)
959
1655
# Create a new, but exactly alike, function
960
1656
# object, and decorate it to be a new D-Bus signal
961
1657
# 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)))
1658
new_function = copy_function(nonmethod_func)
1659
new_function = (dbus.service.signal(
1661
attribute._dbus_signature)(new_function))
1662
# Copy annotations, if any
1664
new_function._dbus_annotations = dict(
1665
attribute._dbus_annotations)
1666
except AttributeError:
971
1669
# 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
1670
# original and alternate functions, so both the
1671
# original and alternate signals gets sent when
1672
# the function is called
974
1673
def fixscope(func1, func2):
975
1674
"""This function is a scope container to pass
976
1675
func1 and func2 to the "call_both" function
977
1676
outside of its arguments"""
1678
@functools.wraps(func2)
978
1679
def call_both(*args, **kwargs):
979
1680
"""This function will emit two D-Bus
980
1681
signals by calling func1 and func2"""
981
1682
func1(*args, **kwargs)
982
1683
func2(*args, **kwargs)
1684
# Make wrapper function look like a D-Bus
1686
for name, attr in inspect.getmembers(func2):
1687
if name.startswith("_dbus_"):
1688
setattr(call_both, name, attr)
983
1690
return call_both
984
1691
# Create the "call_both" function and add it to
986
attr[attrname] = fixscope(attribute,
1693
attr[attrname] = fixscope(attribute, new_function)
988
1694
# Is this a D-Bus method?
989
1695
elif getattr(attribute, "_dbus_is_method", False):
990
1696
# Create a new, but exactly alike, function
991
1697
# object. Decorate it to be a new D-Bus method
992
1698
# 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)))
1701
dbus.service.method(
1703
attribute._dbus_in_signature,
1704
attribute._dbus_out_signature)
1705
(copy_function(attribute)))
1706
# Copy annotations, if any
1708
attr[attrname]._dbus_annotations = dict(
1709
attribute._dbus_annotations)
1710
except AttributeError:
1004
1712
# Is this a D-Bus property?
1005
1713
elif getattr(attribute, "_dbus_is_property", False):
1006
1714
# Create a new, but exactly alike, function
1007
1715
# object, and decorate it to be a new D-Bus
1008
1716
# property with the alternate D-Bus interface
1009
1717
# 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)
1718
attr[attrname] = (dbus_service_property(
1719
alt_interface, attribute._dbus_signature,
1720
attribute._dbus_access,
1721
attribute._dbus_get_args_options
1723
(copy_function(attribute)))
1724
# Copy annotations, if any
1726
attr[attrname]._dbus_annotations = dict(
1727
attribute._dbus_annotations)
1728
except AttributeError:
1730
# Is this a D-Bus interface?
1731
elif getattr(attribute, "_dbus_is_interface", False):
1732
# Create a new, but exactly alike, function
1733
# object. Decorate it to be a new D-Bus interface
1734
# with the alternate D-Bus interface name. Add it
1737
dbus_interface_annotations(alt_interface)
1738
(copy_function(attribute)))
1740
# Deprecate all alternate interfaces
1741
iname = "_AlternateDBusNames_interface_annotation{}"
1742
for interface_name in interface_names:
1744
@dbus_interface_annotations(interface_name)
1746
return {"org.freedesktop.DBus.Deprecated":
1748
# Find an unused name
1749
for aname in (iname.format(i)
1750
for i in itertools.count()):
1751
if aname not in attr:
1755
# Replace the class with a new subclass of it with
1756
# methods, signals, etc. as created above.
1757
if sys.version_info.major == 2:
1758
cls = type(b"{}Alternate".format(cls.__name__),
1761
cls = type("{}Alternate".format(cls.__name__),
1768
@alternate_dbus_interfaces({"se.recompile.Mandos":
1769
"se.bsnet.fukt.Mandos"})
1026
1770
class ClientDBus(Client, DBusObjectWithProperties):
1027
1771
"""A Client class using D-Bus
1030
1774
dbus_object_path: dbus.ObjectPath
1031
1775
bus: dbus.SystemBus()
1034
1778
runtime_expansions = (Client.runtime_expansions
1035
+ ("dbus_object_path",))
1779
+ ("dbus_object_path", ))
1781
_interface = "se.recompile.Mandos.Client"
1037
1783
# dbus.service.Object doesn't use super(), so we can't either.
1039
def __init__(self, bus = None, *args, **kwargs):
1785
def __init__(self, bus=None, *args, **kwargs):
1041
1787
Client.__init__(self, *args, **kwargs)
1042
self._approvals_pending = 0
1044
self._approvals_pending = 0
1045
1788
# Only now, when this client is initialized, can it show up on
1047
client_object_name = unicode(self.name).translate(
1790
client_object_name = str(self.name).translate(
1048
1791
{ord("."): ord("_"),
1049
1792
ord("-"): ord("_")})
1050
self.dbus_object_path = (dbus.ObjectPath
1051
("/clients/" + client_object_name))
1793
self.dbus_object_path = dbus.ObjectPath(
1794
"/clients/" + client_object_name)
1052
1795
DBusObjectWithProperties.__init__(self, self.bus,
1053
1796
self.dbus_object_path)
1055
def notifychangeproperty(transform_func,
1056
dbus_name, type_func=lambda x: x,
1798
def notifychangeproperty(transform_func, dbus_name,
1799
type_func=lambda x: x,
1801
invalidate_only=False,
1802
_interface=_interface):
1058
1803
""" Modify a variable so that it's a property which announces
1059
1804
its changes to DBus.
1061
1806
transform_fun: Function that takes a value and a variant_level
1062
1807
and transforms it to a D-Bus type.
1063
1808
dbus_name: D-Bus name of the variable
1065
1810
to the D-Bus. Default: no transform
1066
1811
variant_level: D-Bus variant level. Default: 1
1068
attrname = "_{0}".format(dbus_name)
1813
attrname = "_{}".format(dbus_name)
1069
1815
def setter(self, value):
1070
1816
if hasattr(self, "dbus_object_path"):
1071
1817
if (not hasattr(self, attrname) or
1072
1818
type_func(getattr(self, attrname, None))
1073
1819
!= type_func(value)):
1074
dbus_value = transform_func(type_func(value),
1077
self.PropertyChanged(dbus.String(dbus_name),
1821
self.PropertiesChanged(
1822
_interface, dbus.Dictionary(),
1823
dbus.Array((dbus_name, )))
1825
dbus_value = transform_func(
1827
variant_level=variant_level)
1828
self.PropertyChanged(dbus.String(dbus_name),
1830
self.PropertiesChanged(
1832
dbus.Dictionary({dbus.String(dbus_name):
1079
1835
setattr(self, attrname, value)
1081
1837
return property(lambda self: getattr(self, attrname), setter)
1084
1839
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1085
1840
approvals_pending = notifychangeproperty(dbus.Boolean,
1086
1841
"ApprovalPending",
1088
1843
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1089
1844
last_enabled = notifychangeproperty(datetime_to_dbus,
1091
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1092
type_func = lambda checker:
1093
checker is not None)
1846
checker = notifychangeproperty(
1847
dbus.Boolean, "CheckerRunning",
1848
type_func=lambda checker: checker is not None)
1094
1849
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1095
1850
"LastCheckedOK")
1851
last_checker_status = notifychangeproperty(dbus.Int16,
1852
"LastCheckerStatus")
1096
1853
last_approval_request = notifychangeproperty(
1097
1854
datetime_to_dbus, "LastApprovalRequest")
1098
1855
approved_by_default = notifychangeproperty(dbus.Boolean,
1099
1856
"ApprovedByDefault")
1100
approval_delay = notifychangeproperty(dbus.UInt64,
1103
timedelta_to_milliseconds)
1857
approval_delay = notifychangeproperty(
1858
dbus.UInt64, "ApprovalDelay",
1859
type_func=lambda td: td.total_seconds() * 1000)
1104
1860
approval_duration = notifychangeproperty(
1105
1861
dbus.UInt64, "ApprovalDuration",
1106
type_func = timedelta_to_milliseconds)
1862
type_func=lambda td: td.total_seconds() * 1000)
1107
1863
host = notifychangeproperty(dbus.String, "Host")
1108
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1110
timedelta_to_milliseconds)
1864
timeout = notifychangeproperty(
1865
dbus.UInt64, "Timeout",
1866
type_func=lambda td: td.total_seconds() * 1000)
1111
1867
extended_timeout = notifychangeproperty(
1112
1868
dbus.UInt64, "ExtendedTimeout",
1113
type_func = timedelta_to_milliseconds)
1114
interval = notifychangeproperty(dbus.UInt64,
1117
timedelta_to_milliseconds)
1869
type_func=lambda td: td.total_seconds() * 1000)
1870
interval = notifychangeproperty(
1871
dbus.UInt64, "Interval",
1872
type_func=lambda td: td.total_seconds() * 1000)
1118
1873
checker_command = notifychangeproperty(dbus.String, "Checker")
1874
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1875
invalidate_only=True)
1120
1877
del notifychangeproperty
1122
1879
def __del__(self, *args, **kwargs):
1124
1881
self.remove_from_connection()
1204
1960
server to mandos-client
1208
1964
# Rejected - signal
1209
1965
@dbus.service.signal(_interface, signature="s")
1210
1966
def Rejected(self, reason):
1214
1970
# NeedApproval - signal
1215
1971
@dbus.service.signal(_interface, signature="tb")
1216
1972
def NeedApproval(self, timeout, default):
1218
1974
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
1978
# Approve - method
1231
1979
@dbus.service.method(_interface, in_signature="b")
1232
1980
def Approve(self, value):
1233
1981
self.approve(value)
1235
1983
# CheckedOK - method
1236
1984
@dbus.service.method(_interface)
1237
1985
def CheckedOK(self):
1238
1986
self.checked_ok()
1240
1988
# Enable - method
1989
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1241
1990
@dbus.service.method(_interface)
1242
1991
def Enable(self):
1246
1995
# StartChecker - method
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1247
1997
@dbus.service.method(_interface)
1248
1998
def StartChecker(self):
1250
2000
self.start_checker()
1252
2002
# Disable - method
2003
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1253
2004
@dbus.service.method(_interface)
1254
2005
def Disable(self):
1258
2009
# StopChecker - method
2010
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1259
2011
@dbus.service.method(_interface)
1260
2012
def StopChecker(self):
1261
2013
self.stop_checker()
1265
2017
# ApprovalPending - property
1266
2018
@dbus_service_property(_interface, signature="b", access="read")
1267
2019
def ApprovalPending_dbus_property(self):
1268
2020
return dbus.Boolean(bool(self.approvals_pending))
1270
2022
# ApprovedByDefault - property
1271
@dbus_service_property(_interface, signature="b",
2023
@dbus_service_property(_interface,
1272
2025
access="readwrite")
1273
2026
def ApprovedByDefault_dbus_property(self, value=None):
1274
2027
if value is None: # get
1275
2028
return dbus.Boolean(self.approved_by_default)
1276
2029
self.approved_by_default = bool(value)
1278
2031
# ApprovalDelay - property
1279
@dbus_service_property(_interface, signature="t",
2032
@dbus_service_property(_interface,
1280
2034
access="readwrite")
1281
2035
def ApprovalDelay_dbus_property(self, value=None):
1282
2036
if value is None: # get
1283
return dbus.UInt64(self.approval_delay_milliseconds())
2037
return dbus.UInt64(self.approval_delay.total_seconds()
1284
2039
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1286
2041
# ApprovalDuration - property
1287
@dbus_service_property(_interface, signature="t",
2042
@dbus_service_property(_interface,
1288
2044
access="readwrite")
1289
2045
def ApprovalDuration_dbus_property(self, value=None):
1290
2046
if value is None: # get
1291
return dbus.UInt64(timedelta_to_milliseconds(
1292
self.approval_duration))
2047
return dbus.UInt64(self.approval_duration.total_seconds()
1293
2049
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1295
2051
# Name - property
2053
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1296
2054
@dbus_service_property(_interface, signature="s", access="read")
1297
2055
def Name_dbus_property(self):
1298
2056
return dbus.String(self.name)
2060
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2061
@dbus_service_property(_interface, signature="s", access="read")
2062
def KeyID_dbus_property(self):
2063
return dbus.String(self.key_id)
1300
2065
# Fingerprint - property
2067
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1301
2068
@dbus_service_property(_interface, signature="s", access="read")
1302
2069
def Fingerprint_dbus_property(self):
1303
2070
return dbus.String(self.fingerprint)
1305
2072
# Host - property
1306
@dbus_service_property(_interface, signature="s",
2073
@dbus_service_property(_interface,
1307
2075
access="readwrite")
1308
2076
def Host_dbus_property(self, value=None):
1309
2077
if value is None: # get
1310
2078
return dbus.String(self.host)
1311
self.host = unicode(value)
2079
self.host = str(value)
1313
2081
# Created - property
2083
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1314
2084
@dbus_service_property(_interface, signature="s", access="read")
1315
2085
def Created_dbus_property(self):
1316
2086
return datetime_to_dbus(self.created)
1318
2088
# LastEnabled - property
1319
2089
@dbus_service_property(_interface, signature="s", access="read")
1320
2090
def LastEnabled_dbus_property(self):
1321
2091
return datetime_to_dbus(self.last_enabled)
1323
2093
# Enabled - property
1324
@dbus_service_property(_interface, signature="b",
2094
@dbus_service_property(_interface,
1325
2096
access="readwrite")
1326
2097
def Enabled_dbus_property(self, value=None):
1327
2098
if value is None: # get
1334
2105
# LastCheckedOK - property
1335
@dbus_service_property(_interface, signature="s",
2106
@dbus_service_property(_interface,
1336
2108
access="readwrite")
1337
2109
def LastCheckedOK_dbus_property(self, value=None):
1338
2110
if value is not None:
1339
2111
self.checked_ok()
1341
2113
return datetime_to_dbus(self.last_checked_ok)
2115
# LastCheckerStatus - property
2116
@dbus_service_property(_interface, signature="n", access="read")
2117
def LastCheckerStatus_dbus_property(self):
2118
return dbus.Int16(self.last_checker_status)
1343
2120
# Expires - property
1344
2121
@dbus_service_property(_interface, signature="s", access="read")
1345
2122
def Expires_dbus_property(self):
1346
2123
return datetime_to_dbus(self.expires)
1348
2125
# LastApprovalRequest - property
1349
2126
@dbus_service_property(_interface, signature="s", access="read")
1350
2127
def LastApprovalRequest_dbus_property(self):
1351
2128
return datetime_to_dbus(self.last_approval_request)
1353
2130
# Timeout - property
1354
@dbus_service_property(_interface, signature="t",
2131
@dbus_service_property(_interface,
1355
2133
access="readwrite")
1356
2134
def Timeout_dbus_property(self, value=None):
1357
2135
if value is None: # get
1358
return dbus.UInt64(self.timeout_milliseconds())
2136
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2137
old_timeout = self.timeout
1359
2138
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))
2139
# Reschedule disabling
2141
now = datetime.datetime.utcnow()
2142
self.expires += self.timeout - old_timeout
2143
if self.expires <= now:
2144
# The timeout has passed
2147
if (getattr(self, "disable_initiator_tag", None)
2150
GLib.source_remove(self.disable_initiator_tag)
2151
self.disable_initiator_tag = GLib.timeout_add(
2152
int((self.expires - now).total_seconds() * 1000),
1381
2155
# ExtendedTimeout - property
1382
@dbus_service_property(_interface, signature="t",
2156
@dbus_service_property(_interface,
1383
2158
access="readwrite")
1384
2159
def ExtendedTimeout_dbus_property(self, value=None):
1385
2160
if value is None: # get
1386
return dbus.UInt64(self.extended_timeout_milliseconds())
2161
return dbus.UInt64(self.extended_timeout.total_seconds()
1387
2163
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1389
2165
# Interval - property
1390
@dbus_service_property(_interface, signature="t",
2166
@dbus_service_property(_interface,
1391
2168
access="readwrite")
1392
2169
def Interval_dbus_property(self, value=None):
1393
2170
if value is None: # get
1394
return dbus.UInt64(self.interval_milliseconds())
2171
return dbus.UInt64(self.interval.total_seconds() * 1000)
1395
2172
self.interval = datetime.timedelta(0, 0, 0, value)
1396
2173
if getattr(self, "checker_initiator_tag", None) is None:
1398
2175
if self.enabled:
1399
2176
# 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
2177
GLib.source_remove(self.checker_initiator_tag)
2178
self.checker_initiator_tag = GLib.timeout_add(
2179
value, self.start_checker)
2180
self.start_checker() # Start one now, too
1405
2182
# Checker - property
1406
@dbus_service_property(_interface, signature="s",
2183
@dbus_service_property(_interface,
1407
2185
access="readwrite")
1408
2186
def Checker_dbus_property(self, value=None):
1409
2187
if value is None: # get
1410
2188
return dbus.String(self.checker_command)
1411
self.checker_command = unicode(value)
2189
self.checker_command = str(value)
1413
2191
# CheckerRunning - property
1414
@dbus_service_property(_interface, signature="b",
2192
@dbus_service_property(_interface,
1415
2194
access="readwrite")
1416
2195
def CheckerRunning_dbus_property(self, value=None):
1417
2196
if value is None: # get
1450
2237
if data[0] == 'data':
1452
2239
if data[0] == 'function':
1453
2241
def func(*args, **kwargs):
1454
2242
self._pipe.send(('funcall', name, args, kwargs))
1455
2243
return self._pipe.recv()[1]
1458
2247
def __setattr__(self, name, value):
1459
2248
if name == '_pipe':
1460
2249
return super(ProxyClient, self).__setattr__(name, value)
1461
2250
self._pipe.send(('setattr', name, value))
1464
class ClientDBusTransitional(ClientDBus):
1465
__metaclass__ = AlternateDBusNamesMetaclass
1468
2253
class ClientHandler(socketserver.BaseRequestHandler, object):
1469
2254
"""A class to handle client connections.
1471
2256
Instantiated once for each connection to handle it.
1472
2257
Note: This will run in its own forked process."""
1474
2259
def handle(self):
1475
2260
with contextlib.closing(self.server.child_pipe) as child_pipe:
1476
2261
logger.info("TCP connection from: %s",
1477
unicode(self.client_address))
2262
str(self.client_address))
1478
2263
logger.debug("Pipe FD: %d",
1479
2264
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",
2266
session = gnutls.ClientSession(self.request)
2268
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2269
# "+AES-256-CBC", "+SHA1",
2270
# "+COMP-NULL", "+CTYPE-OPENPGP",
1495
2272
# Use a fallback default, since this MUST be set.
1496
2273
priority = self.server.gnutls_priority
1497
2274
if priority is None:
1498
2275
priority = "NORMAL"
1499
(gnutls.library.functions
1500
.gnutls_priority_set_direct(session._c_object,
2276
gnutls.priority_set_direct(session._c_object,
2277
priority.encode("utf-8"),
1503
2280
# Start communication using the Mandos protocol
1504
2281
# Get protocol number
1505
2282
line = self.request.makefile().readline()
1506
2283
logger.debug("Protocol version: %r", line)
1508
2285
if int(line.strip().split()[0]) > 1:
2286
raise RuntimeError(line)
1510
2287
except (ValueError, IndexError, RuntimeError) as error:
1511
2288
logger.error("Unknown protocol version: %s", error)
1514
2291
# Start GnuTLS connection
1516
2293
session.handshake()
1517
except gnutls.errors.GNUTLSError as error:
2294
except gnutls.Error as error:
1518
2295
logger.warning("Handshake failed: %s", error)
1519
2296
# Do not run session.bye() here: the session is not
1520
2297
# established. Just abandon the request.
1522
2299
logger.debug("Handshake succeeded")
1524
2301
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,
2303
if gnutls.has_rawpk:
2306
key_id = self.key_id(
2307
self.peer_certificate(session))
2308
except (TypeError, gnutls.Error) as error:
2309
logger.warning("Bad certificate: %s", error)
2311
logger.debug("Key ID: %s", key_id)
2316
fpr = self.fingerprint(
2317
self.peer_certificate(session))
2318
except (TypeError, gnutls.Error) as error:
2319
logger.warning("Bad certificate: %s", error)
2321
logger.debug("Fingerprint: %s", fpr)
2324
client = ProxyClient(child_pipe, key_id, fpr,
1537
2325
self.client_address)
1538
2326
except KeyError:
1541
if self.server.use_dbus:
1543
client.NewRequest(str(self.client_address))
1545
2329
if client.approval_delay:
1546
2330
delay = client.approval_delay
1547
2331
client.approvals_pending += 1
1548
2332
approval_required = True
1551
2335
if not client.enabled:
1552
2336
logger.info("Client %s is disabled",
1554
2338
if self.server.use_dbus:
1555
2339
# Emit D-Bus signal
1556
2340
client.Rejected("Disabled")
1559
2343
if client.approved or not client.approval_delay:
1560
#We are approved or approval is disabled
2344
# We are approved or approval is disabled
1562
2346
elif client.approved is None:
1563
2347
logger.info("Client %s needs approval",
1598
2380
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))
2383
session.send(client.secret)
2384
except gnutls.Error as error:
2385
logger.warning("gnutls send failed",
1612
2389
logger.info("Sending secret to %s", client.name)
1613
2390
# bump the timeout using extended_timeout
1614
client.checked_ok(client.extended_timeout)
2391
client.bump_timeout(client.extended_timeout)
1615
2392
if self.server.use_dbus:
1616
2393
# Emit D-Bus signal
1617
2394
client.GotSecret()
1620
2397
if approval_required:
1621
2398
client.approvals_pending -= 1
1624
except gnutls.errors.GNUTLSError as error:
1625
logger.warning("GnuTLS bye failed")
2401
except gnutls.Error as error:
2402
logger.warning("GnuTLS bye failed",
1628
2406
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
2407
"Return the peer's certificate as a bytestring"
2409
cert_type = gnutls.certificate_type_get2(session._c_object,
2411
except AttributeError:
2412
cert_type = gnutls.certificate_type_get(session._c_object)
2413
if gnutls.has_rawpk:
2414
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2416
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2417
# If not a valid certificate type...
2418
if cert_type not in valid_cert_types:
2419
logger.info("Cert type %r not in %r", cert_type,
2421
# ...return invalid data
1636
2423
list_size = ctypes.c_uint(1)
1637
cert_list = (gnutls.library.functions
1638
.gnutls_certificate_get_peers
2424
cert_list = (gnutls.certificate_get_peers
1639
2425
(session._c_object, ctypes.byref(list_size)))
1640
2426
if not bool(cert_list) and list_size.value != 0:
1641
raise gnutls.errors.GNUTLSError("error getting peer"
2427
raise gnutls.Error("error getting peer certificate")
1643
2428
if list_size.value == 0:
1645
2430
cert = cert_list[0]
1646
2431
return ctypes.string_at(cert.data, cert.size)
2434
def key_id(certificate):
2435
"Convert a certificate bytestring to a hexdigit key ID"
2436
# New GnuTLS "datum" with the public key
2437
datum = gnutls.datum_t(
2438
ctypes.cast(ctypes.c_char_p(certificate),
2439
ctypes.POINTER(ctypes.c_ubyte)),
2440
ctypes.c_uint(len(certificate)))
2441
# XXX all these need to be created in the gnutls "module"
2442
# New empty GnuTLS certificate
2443
pubkey = gnutls.pubkey_t()
2444
gnutls.pubkey_init(ctypes.byref(pubkey))
2445
# Import the raw public key into the certificate
2446
gnutls.pubkey_import(pubkey,
2447
ctypes.byref(datum),
2448
gnutls.X509_FMT_DER)
2449
# New buffer for the key ID
2450
buf = ctypes.create_string_buffer(32)
2451
buf_len = ctypes.c_size_t(len(buf))
2452
# Get the key ID from the raw public key into the buffer
2453
gnutls.pubkey_get_key_id(pubkey,
2454
gnutls.KEYID_USE_SHA256,
2455
ctypes.cast(ctypes.byref(buf),
2456
ctypes.POINTER(ctypes.c_ubyte)),
2457
ctypes.byref(buf_len))
2458
# Deinit the certificate
2459
gnutls.pubkey_deinit(pubkey)
2461
# Convert the buffer to a Python bytestring
2462
key_id = ctypes.string_at(buf, buf_len.value)
2463
# Convert the bytestring to hexadecimal notation
2464
hex_key_id = binascii.hexlify(key_id).upper()
1649
2468
def fingerprint(openpgp):
1650
2469
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1651
2470
# 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))))
2471
datum = gnutls.datum_t(
2472
ctypes.cast(ctypes.c_char_p(openpgp),
2473
ctypes.POINTER(ctypes.c_ubyte)),
2474
ctypes.c_uint(len(openpgp)))
1657
2475
# 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)))
2476
crt = gnutls.openpgp_crt_t()
2477
gnutls.openpgp_crt_init(ctypes.byref(crt))
1661
2478
# 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))
2479
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2480
gnutls.OPENPGP_FMT_RAW)
1666
2481
# Verify the self signature in the key
1667
2482
crtverify = ctypes.c_uint()
1668
(gnutls.library.functions
1669
.gnutls_openpgp_crt_verify_self(crt, 0,
1670
ctypes.byref(crtverify)))
2483
gnutls.openpgp_crt_verify_self(crt, 0,
2484
ctypes.byref(crtverify))
1671
2485
if crtverify.value != 0:
1672
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1673
raise (gnutls.errors.CertificateSecurityError
2486
gnutls.openpgp_crt_deinit(crt)
2487
raise gnutls.CertificateSecurityError(code
1675
2489
# New buffer for the fingerprint
1676
2490
buf = ctypes.create_string_buffer(20)
1677
2491
buf_len = ctypes.c_size_t()
1678
2492
# 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)))
2493
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2494
ctypes.byref(buf_len))
1682
2495
# Deinit the certificate
1683
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2496
gnutls.openpgp_crt_deinit(crt)
1684
2497
# Convert the buffer to a Python bytestring
1685
2498
fpr = ctypes.string_at(buf, buf_len.value)
1686
2499
# Convert the bytestring to hexadecimal notation
1691
class MultiprocessingMixIn(object):
2504
class MultiprocessingMixIn:
1692
2505
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1693
2507
def sub_process_main(self, request, address):
1695
2509
self.finish_request(request, address)
1696
2510
except Exception:
1697
2511
self.handle_error(request, address)
1698
2512
self.close_request(request)
1700
2514
def process_request(self, request, address):
1701
2515
"""Start a new process to process the request."""
1702
proc = multiprocessing.Process(target = self.sub_process_main,
2516
proc = multiprocessing.Process(target=self.sub_process_main,
2517
args=(request, address))
1709
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2522
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1710
2523
""" adds a pipe to the MixIn """
1711
2525
def process_request(self, request, client_address):
1712
2526
"""Overrides and wraps the original process_request().
1714
2528
This function creates a new pipe in self.pipe
1716
2530
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1718
2532
proc = MultiprocessingMixIn.process_request(self, request,
1719
2533
client_address)
1720
2534
self.child_pipe.close()
1721
2535
self.add_pipe(parent_pipe, proc)
1723
2537
def add_pipe(self, parent_pipe, proc):
1724
2538
"""Dummy function; override as necessary"""
1725
raise NotImplementedError
2539
raise NotImplementedError()
1728
2542
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1729
socketserver.TCPServer, object):
2543
socketserver.TCPServer):
1730
2544
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1733
2547
enabled: Boolean; whether this server is activated yet
1734
2548
interface: None or a network interface name (string)
1735
2549
use_ipv6: Boolean; to use IPv6 or not
1737
2552
def __init__(self, server_address, RequestHandlerClass,
1738
interface=None, use_ipv6=True):
2556
"""If socketfd is set, use that file descriptor instead of
2557
creating a new one with socket.socket().
1739
2559
self.interface = interface
1741
2561
self.address_family = socket.AF_INET6
2562
if socketfd is not None:
2563
# Save the file descriptor
2564
self.socketfd = socketfd
2565
# Save the original socket.socket() function
2566
self.socket_socket = socket.socket
2568
# To implement --socket, we monkey patch socket.socket.
2570
# (When socketserver.TCPServer is a new-style class, we
2571
# could make self.socket into a property instead of monkey
2572
# patching socket.socket.)
2574
# Create a one-time-only replacement for socket.socket()
2575
@functools.wraps(socket.socket)
2576
def socket_wrapper(*args, **kwargs):
2577
# Restore original function so subsequent calls are
2579
socket.socket = self.socket_socket
2580
del self.socket_socket
2581
# This time only, return a new socket object from the
2582
# saved file descriptor.
2583
return socket.fromfd(self.socketfd, *args, **kwargs)
2584
# Replace socket.socket() function with wrapper
2585
socket.socket = socket_wrapper
2586
# The socketserver.TCPServer.__init__ will call
2587
# socket.socket(), which might be our replacement,
2588
# socket_wrapper(), if socketfd was set.
1742
2589
socketserver.TCPServer.__init__(self, server_address,
1743
2590
RequestHandlerClass)
1744
2592
def server_bind(self):
1745
2593
"""This overrides the normal server_bind() function
1746
2594
to bind to an interface if one was specified, and also NOT to
1747
2595
bind to an address or port if they were not specified."""
2596
global SO_BINDTODEVICE
1748
2597
if self.interface is not None:
1749
2598
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",
2599
# Fall back to a hard-coded value which seems to be
2601
logger.warning("SO_BINDTODEVICE not found, trying 25")
2602
SO_BINDTODEVICE = 25
2604
self.socket.setsockopt(
2605
socket.SOL_SOCKET, SO_BINDTODEVICE,
2606
(self.interface + "\0").encode("utf-8"))
2607
except socket.error as error:
2608
if error.errno == errno.EPERM:
2609
logger.error("No permission to bind to"
2610
" interface %s", self.interface)
2611
elif error.errno == errno.ENOPROTOOPT:
2612
logger.error("SO_BINDTODEVICE not available;"
2613
" cannot bind to interface %s",
2615
elif error.errno == errno.ENODEV:
2616
logger.error("Interface %s does not exist,"
2617
" cannot bind", self.interface)
1770
2620
# Only bind(2) the socket if we really need to.
1771
2621
if self.server_address[0] or self.server_address[1]:
2622
if self.server_address[1]:
2623
self.allow_reuse_address = True
1772
2624
if not self.server_address[0]:
1773
2625
if self.address_family == socket.AF_INET6:
1774
any_address = "::" # in6addr_any
2626
any_address = "::" # in6addr_any
1776
any_address = socket.INADDR_ANY
2628
any_address = "0.0.0.0" # INADDR_ANY
1777
2629
self.server_address = (any_address,
1778
2630
self.server_address[1])
1779
2631
elif not self.server_address[1]:
1780
self.server_address = (self.server_address[0],
2632
self.server_address = (self.server_address[0], 0)
1782
2633
# if self.interface:
1783
2634
# self.server_address = (self.server_address[0],
1887
2738
funcname = request[1]
1888
2739
args = request[2]
1889
2740
kwargs = request[3]
1891
2742
parent_pipe.send(('data', getattr(client_object,
1892
2743
funcname)(*args,
1895
2746
if command == 'getattr':
1896
2747
attrname = request[1]
1897
if callable(client_object.__getattribute__(attrname)):
1898
parent_pipe.send(('function',))
2748
if isinstance(client_object.__getattribute__(attrname),
2749
collections.Callable):
2750
parent_pipe.send(('function', ))
1900
parent_pipe.send(('data', client_object
1901
.__getattribute__(attrname)))
2753
'data', client_object.__getattribute__(attrname)))
1903
2755
if command == 'setattr':
1904
2756
attrname = request[1]
1905
2757
value = request[2]
1906
2758
setattr(client_object, attrname, value)
2763
def rfc3339_duration_to_delta(duration):
2764
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2766
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2768
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2770
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2772
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2774
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2776
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2778
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2782
# Parsing an RFC 3339 duration with regular expressions is not
2783
# possible - there would have to be multiple places for the same
2784
# values, like seconds. The current code, while more esoteric, is
2785
# cleaner without depending on a parsing library. If Python had a
2786
# built-in library for parsing we would use it, but we'd like to
2787
# avoid excessive use of external libraries.
2789
# New type for defining tokens, syntax, and semantics all-in-one
2790
Token = collections.namedtuple("Token", (
2791
"regexp", # To match token; if "value" is not None, must have
2792
# a "group" containing digits
2793
"value", # datetime.timedelta or None
2794
"followers")) # Tokens valid after this token
2795
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2796
# the "duration" ABNF definition in RFC 3339, Appendix A.
2797
token_end = Token(re.compile(r"$"), None, frozenset())
2798
token_second = Token(re.compile(r"(\d+)S"),
2799
datetime.timedelta(seconds=1),
2800
frozenset((token_end, )))
2801
token_minute = Token(re.compile(r"(\d+)M"),
2802
datetime.timedelta(minutes=1),
2803
frozenset((token_second, token_end)))
2804
token_hour = Token(re.compile(r"(\d+)H"),
2805
datetime.timedelta(hours=1),
2806
frozenset((token_minute, token_end)))
2807
token_time = Token(re.compile(r"T"),
2809
frozenset((token_hour, token_minute,
2811
token_day = Token(re.compile(r"(\d+)D"),
2812
datetime.timedelta(days=1),
2813
frozenset((token_time, token_end)))
2814
token_month = Token(re.compile(r"(\d+)M"),
2815
datetime.timedelta(weeks=4),
2816
frozenset((token_day, token_end)))
2817
token_year = Token(re.compile(r"(\d+)Y"),
2818
datetime.timedelta(weeks=52),
2819
frozenset((token_month, token_end)))
2820
token_week = Token(re.compile(r"(\d+)W"),
2821
datetime.timedelta(weeks=1),
2822
frozenset((token_end, )))
2823
token_duration = Token(re.compile(r"P"), None,
2824
frozenset((token_year, token_month,
2825
token_day, token_time,
2827
# Define starting values:
2829
value = datetime.timedelta()
2831
# Following valid tokens
2832
followers = frozenset((token_duration, ))
2833
# String left to parse
2835
# Loop until end token is found
2836
while found_token is not token_end:
2837
# Search for any currently valid tokens
2838
for token in followers:
2839
match = token.regexp.match(s)
2840
if match is not None:
2842
if token.value is not None:
2843
# Value found, parse digits
2844
factor = int(match.group(1), 10)
2845
# Add to value so far
2846
value += factor * token.value
2847
# Strip token from string
2848
s = token.regexp.sub("", s, 1)
2851
# Set valid next tokens
2852
followers = found_token.followers
2855
# No currently valid tokens were found
2856
raise ValueError("Invalid RFC 3339 duration: {!r}"
1911
2862
def string_to_delta(interval):
1912
2863
"""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)
2865
>>> string_to_delta('7d') == datetime.timedelta(7)
2867
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2869
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2871
>>> string_to_delta('24h') == datetime.timedelta(1)
2873
>>> string_to_delta('1w') == datetime.timedelta(7)
2875
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2880
return rfc3339_duration_to_delta(interval)
1927
2884
timevalue = datetime.timedelta(0)
1928
2885
for s in interval.split():
1930
suffix = unicode(s[-1])
1931
2888
value = int(s[:-1])
1932
2889
if suffix == "d":
1933
2890
delta = datetime.timedelta(value)
2005
2962
parser.add_argument("--no-dbus", action="store_false",
2006
2963
dest="use_dbus", help="Do not provide D-Bus"
2007
" system bus interface")
2964
" system bus interface", default=None)
2008
2965
parser.add_argument("--no-ipv6", action="store_false",
2009
dest="use_ipv6", help="Do not use IPv6")
2966
dest="use_ipv6", help="Do not use IPv6",
2010
2968
parser.add_argument("--no-restore", action="store_false",
2011
2969
dest="restore", help="Do not restore stored"
2970
" state", default=None)
2971
parser.add_argument("--socket", type=int,
2972
help="Specify a file descriptor to a network"
2973
" socket to use instead of creating one")
2013
2974
parser.add_argument("--statedir", metavar="DIR",
2014
2975
help="Directory to save/restore state in")
2976
parser.add_argument("--foreground", action="store_true",
2977
help="Run in foreground", default=None)
2978
parser.add_argument("--no-zeroconf", action="store_false",
2979
dest="zeroconf", help="Do not use Zeroconf",
2016
2982
options = parser.parse_args()
2023
2984
# 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"
2985
if gnutls.has_rawpk:
2986
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2987
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2989
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2990
":+SIGN-DSA-SHA256")
2991
server_defaults = {"interface": "",
2995
"priority": priority,
2996
"servicename": "Mandos",
3002
"statedir": "/var/lib/mandos",
3003
"foreground": "False",
2038
3008
# Parse config file for server-global settings
2039
server_config = configparser.SafeConfigParser(server_defaults)
3009
server_config = configparser.ConfigParser(server_defaults)
2040
3010
del server_defaults
2041
server_config.read(os.path.join(options.configdir,
2043
# Convert the SafeConfigParser object to a dict
3011
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3012
# Convert the ConfigParser object to a dict
2044
3013
server_settings = server_config.defaults()
2045
3014
# Use the appropriate methods on the non-string config options
2046
for option in ("debug", "use_dbus", "use_ipv6"):
3015
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3016
"foreground", "zeroconf"):
2047
3017
server_settings[option] = server_config.getboolean("DEFAULT",
2049
3019
if server_settings["port"]:
2050
3020
server_settings["port"] = server_config.getint("DEFAULT",
3022
if server_settings["socket"]:
3023
server_settings["socket"] = server_config.getint("DEFAULT",
3025
# Later, stdin will, and stdout and stderr might, be dup'ed
3026
# over with an opened os.devnull. But we don't want this to
3027
# happen with a supplied network socket.
3028
if 0 <= server_settings["socket"] <= 2:
3029
server_settings["socket"] = os.dup(server_settings
2052
3031
del server_config
2054
3033
# Override the settings from the config file with command line
2055
3034
# options, if set.
2056
3035
for option in ("interface", "address", "port", "debug",
2057
"priority", "servicename", "configdir",
2058
"use_dbus", "use_ipv6", "debuglevel", "restore",
3036
"priority", "servicename", "configdir", "use_dbus",
3037
"use_ipv6", "debuglevel", "restore", "statedir",
3038
"socket", "foreground", "zeroconf"):
2060
3039
value = getattr(options, option)
2061
3040
if value is not None:
2062
3041
server_settings[option] = value
2064
3043
# Force all strings to be unicode
2065
3044
for option in server_settings.keys():
2066
if type(server_settings[option]) is str:
2067
server_settings[option] = unicode(server_settings[option])
3045
if isinstance(server_settings[option], bytes):
3046
server_settings[option] = (server_settings[option]
3048
# Force all boolean options to be boolean
3049
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3050
"foreground", "zeroconf"):
3051
server_settings[option] = bool(server_settings[option])
3052
# Debug implies foreground
3053
if server_settings["debug"]:
3054
server_settings["foreground"] = True
2068
3055
# Now we have our good server settings in "server_settings"
2070
3057
##################################################################
3059
if (not server_settings["zeroconf"]
3060
and not (server_settings["port"]
3061
or server_settings["socket"] != "")):
3062
parser.error("Needs port or socket to work without Zeroconf")
2072
3064
# For convenience
2073
3065
debug = server_settings["debug"]
2074
3066
debuglevel = server_settings["debuglevel"]
2076
3068
use_ipv6 = server_settings["use_ipv6"]
2077
3069
stored_state_path = os.path.join(server_settings["statedir"],
2078
3070
stored_state_file)
3071
foreground = server_settings["foreground"]
3072
zeroconf = server_settings["zeroconf"]
2081
initlogger(logging.DEBUG)
3075
initlogger(debug, logging.DEBUG)
2083
3077
if not debuglevel:
2086
3080
level = getattr(logging, debuglevel.upper())
3081
initlogger(debug, level)
2089
3083
if server_settings["servicename"] != "Mandos":
2090
syslogger.setFormatter(logging.Formatter
2091
('Mandos (%s) [%%(process)d]:'
2092
' %%(levelname)s: %%(message)s'
2093
% server_settings["servicename"]))
3084
syslogger.setFormatter(
3085
logging.Formatter('Mandos ({}) [%(process)d]:'
3086
' %(levelname)s: %(message)s'.format(
3087
server_settings["servicename"])))
2095
3089
# Parse config file with clients
2096
client_config = configparser.SafeConfigParser(Client.client_defaults)
3090
client_config = configparser.ConfigParser(Client.client_defaults)
2097
3091
client_config.read(os.path.join(server_settings["configdir"],
2098
3092
"clients.conf"))
2100
3094
global mandos_dbus_service
2101
3095
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
3098
if server_settings["socket"] != "":
3099
socketfd = server_settings["socket"]
3100
tcp_server = MandosServer(
3101
(server_settings["address"], server_settings["port"]),
3103
interface=(server_settings["interface"] or None),
3105
gnutls_priority=server_settings["priority"],
3109
pidfilename = "/run/mandos.pid"
3110
if not os.path.isdir("/run/."):
3111
pidfilename = "/var/run/mandos.pid"
3114
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3115
except IOError as e:
3116
logger.error("Could not open file %r", pidfilename,
3119
for name, group in (("_mandos", "_mandos"),
3120
("mandos", "mandos"),
3121
("nobody", "nogroup")):
3123
uid = pwd.getpwnam(name).pw_uid
3124
gid = pwd.getpwnam(group).pw_gid
2126
3126
except KeyError:
2128
uid = pwd.getpwnam("nobody").pw_uid
2129
gid = pwd.getpwnam("nobody").pw_gid
3135
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2136
3137
except OSError as error:
2137
if error[0] != errno.EPERM:
3138
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3139
.format(uid, gid, os.strerror(error.errno)))
3140
if error.errno != errno.EPERM:
2141
3144
# Enable all possible GnuTLS debugging
2143
3146
# "Use a log level over 10 to enable all debugging options."
2144
3147
# - GnuTLS manual
2145
gnutls.library.functions.gnutls_global_set_log_level(11)
2147
@gnutls.library.types.gnutls_log_func
3148
gnutls.global_set_log_level(11)
2148
3151
def debug_gnutls(level, string):
2149
3152
logger.debug("GnuTLS: %s", string[:-1])
2151
(gnutls.library.functions
2152
.gnutls_global_set_log_function(debug_gnutls))
3154
gnutls.global_set_log_function(debug_gnutls)
2154
3156
# Redirect stdin so all checkers get /dev/null
2155
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3157
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
3158
os.dup2(null, sys.stdin.fileno())
2160
# No console logging
2161
logger.removeHandler(console)
2163
3162
# Need to fork before connecting to D-Bus
2165
3164
# Close all input and output, do double fork, etc.
3167
if gi.version_info < (3, 10, 2):
3168
# multiprocessing will use threads, so before we use GLib we
3169
# need to inform GLib that threads will be used.
2168
3172
global main_loop
2169
3173
# From the Avahi example code
2170
DBusGMainLoop(set_as_default=True )
2171
main_loop = gobject.MainLoop()
3174
DBusGMainLoop(set_as_default=True)
3175
main_loop = GLib.MainLoop()
2172
3176
bus = dbus.SystemBus()
2173
3177
# End of Avahi example code
2176
3180
bus_name = dbus.service.BusName("se.recompile.Mandos",
2177
bus, do_not_queue=True)
2178
old_bus_name = (dbus.service.BusName
2179
("se.bsnet.fukt.Mandos", bus,
2181
except dbus.exceptions.NameExistsException as e:
2182
logger.error(unicode(e) + ", disabling D-Bus")
3183
old_bus_name = dbus.service.BusName(
3184
"se.bsnet.fukt.Mandos", bus,
3186
except dbus.exceptions.DBusException as e:
3187
logger.error("Disabling D-Bus:", exc_info=e)
2183
3188
use_dbus = False
2184
3189
server_settings["use_dbus"] = False
2185
3190
tcp_server.use_dbus = False
2186
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2187
service = AvahiServiceToSyslog(name =
2188
server_settings["servicename"],
2189
servicetype = "_mandos._tcp",
2190
protocol = protocol, bus = bus)
2191
if server_settings["interface"]:
2192
service.interface = (if_nametoindex
2193
(str(server_settings["interface"])))
3192
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3193
service = AvahiServiceToSyslog(
3194
name=server_settings["servicename"],
3195
servicetype="_mandos._tcp",
3198
if server_settings["interface"]:
3199
service.interface = if_nametoindex(
3200
server_settings["interface"].encode("utf-8"))
2195
3202
global multiprocessing_manager
2196
3203
multiprocessing_manager = multiprocessing.Manager()
2198
3205
client_class = Client
2200
client_class = functools.partial(ClientDBusTransitional,
3207
client_class = functools.partial(ClientDBus, bus=bus)
2203
3209
client_settings = Client.config_parser(client_config)
2204
3210
old_client_settings = {}
2205
3211
clients_data = {}
3213
# This is used to redirect stdout and stderr for checker processes
3215
wnull = open(os.devnull, "w") # A writable /dev/null
3216
# Only used if server is running in foreground but not in debug
3218
if debug or not foreground:
2207
3221
# Get client data and settings from last running state.
2208
3222
if server_settings["restore"]:
2210
3224
with open(stored_state_path, "rb") as stored_state:
2211
clients_data, old_client_settings = (pickle.load
3225
if sys.version_info.major == 2:
3226
clients_data, old_client_settings = pickle.load(
3229
bytes_clients_data, bytes_old_client_settings = (
3230
pickle.load(stored_state, encoding="bytes"))
3231
# Fix bytes to strings
3234
clients_data = {(key.decode("utf-8")
3235
if isinstance(key, bytes)
3238
bytes_clients_data.items()}
3239
del bytes_clients_data
3240
for key in clients_data:
3241
value = {(k.decode("utf-8")
3242
if isinstance(k, bytes) else k): v
3244
clients_data[key].items()}
3245
clients_data[key] = value
3247
value["client_structure"] = [
3249
if isinstance(s, bytes)
3251
value["client_structure"]]
3252
# .name, .host, and .checker_command
3253
for k in ("name", "host", "checker_command"):
3254
if isinstance(value[k], bytes):
3255
value[k] = value[k].decode("utf-8")
3256
if "key_id" not in value:
3257
value["key_id"] = ""
3258
elif "fingerprint" not in value:
3259
value["fingerprint"] = ""
3260
# old_client_settings
3262
old_client_settings = {
3263
(key.decode("utf-8")
3264
if isinstance(key, bytes)
3267
bytes_old_client_settings.items()}
3268
del bytes_old_client_settings
3269
# .host and .checker_command
3270
for value in old_client_settings.values():
3271
for attribute in ("host", "checker_command"):
3272
if isinstance(value[attribute], bytes):
3273
value[attribute] = (value[attribute]
2213
3275
os.remove(stored_state_path)
2214
3276
except IOError as e:
2215
logger.warning("Could not load persistent state: {0}"
2217
if e.errno != errno.ENOENT:
3277
if e.errno == errno.ENOENT:
3278
logger.warning("Could not load persistent state:"
3279
" {}".format(os.strerror(e.errno)))
3281
logger.critical("Could not load persistent state:",
3284
except EOFError as e:
3285
logger.warning("Could not load persistent state: "
2220
3289
with PGPEngine() as pgp:
2221
for client_name, client in clients_data.iteritems():
3290
for client_name, client in clients_data.items():
3291
# Skip removed clients
3292
if client_name not in client_settings:
2222
3295
# Decide which value to use after restoring saved state.
2223
3296
# We have three different values: Old config file,
2224
3297
# new config file, and saved state.
2229
3302
# For each value in new config, check if it
2230
3303
# differs from the old config value (Except for
2231
3304
# the "secret" attribute)
2232
if (name != "secret" and
2233
value != old_client_settings[client_name]
3305
if (name != "secret"
3307
old_client_settings[client_name][name])):
2235
3308
client[name] = value
2236
3309
except KeyError:
2239
3312
# Clients who has passed its expire date can still be
2240
# enabled if its last checker was successful. Clients
2241
# whose checker failed before we stored its state is
2242
# assumed to have failed all checkers during downtime.
3313
# enabled if its last checker was successful. A Client
3314
# whose checker succeeded before we stored its state is
3315
# assumed to have successfully run all checkers during
2243
3317
if client["enabled"]:
2244
3318
if datetime.datetime.utcnow() >= client["expires"]:
2245
3319
if not client["last_checked_ok"]:
2246
3320
logger.warning(
2247
"disabling client {0} - Client never "
2248
"performed a successfull checker"
2249
.format(client["name"]))
3321
"disabling client {} - Client never "
3322
"performed a successful checker".format(
2250
3324
client["enabled"] = False
2251
3325
elif client["last_checker_status"] != 0:
2252
3326
logger.warning(
2253
"disabling client {0} - Client "
2254
"last checker failed with error code {1}"
2255
.format(client["name"],
2256
client["last_checker_status"]))
3327
"disabling client {} - Client last"
3328
" checker failed with error code"
3331
client["last_checker_status"]))
2257
3332
client["enabled"] = False
2259
client["expires"] = (datetime.datetime
2261
+ client["timeout"])
3334
client["expires"] = (
3335
datetime.datetime.utcnow()
3336
+ client["timeout"])
3337
logger.debug("Last checker succeeded,"
3338
" keeping {} enabled".format(
2264
client["secret"] = (
2265
pgp.decrypt(client["encrypted_secret"],
2266
client_settings[client_name]
3341
client["secret"] = pgp.decrypt(
3342
client["encrypted_secret"],
3343
client_settings[client_name]["secret"])
2268
3344
except PGPError:
2269
3345
# If decryption fails, we use secret from new settings
2270
logger.debug("Failed to decrypt {0} old secret"
2271
.format(client_name))
2272
client["secret"] = (
2273
client_settings[client_name]["secret"])
3346
logger.debug("Failed to decrypt {} old secret".format(
3348
client["secret"] = (client_settings[client_name]
2276
3351
# Add/remove clients based on new changes made to config
2277
for client_name in set(old_client_settings) - set(client_settings):
3352
for client_name in (set(old_client_settings)
3353
- set(client_settings)):
2278
3354
del clients_data[client_name]
2279
for client_name in set(client_settings) - set(old_client_settings):
3355
for client_name in (set(client_settings)
3356
- set(old_client_settings)):
2280
3357
clients_data[client_name] = client_settings[client_name]
2282
# Create clients all clients
2283
for client_name, client in clients_data.iteritems():
3359
# Create all client objects
3360
for client_name, client in clients_data.items():
2284
3361
tcp_server.clients[client_name] = client_class(
2285
name = client_name, settings = client)
3364
server_settings=server_settings)
2287
3366
if not tcp_server.clients:
2288
3367
logger.warning("No clients defined")
2294
pidfile.write(str(pid) + "\n".encode("utf-8"))
2297
logger.error("Could not write to file %r with PID %d",
2300
# "pidfile" was never created
3370
if pidfile is not None:
3374
print(pid, file=pidfile)
3376
logger.error("Could not write to file %r with PID %d",
2302
3379
del pidfilename
2303
signal.signal(signal.SIGINT, signal.SIG_IGN)
2305
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2306
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3381
for termsig in (signal.SIGHUP, signal.SIGTERM):
3382
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3383
lambda: main_loop.quit() and False)
2309
class MandosDBusService(dbus.service.Object):
3387
@alternate_dbus_interfaces(
3388
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3389
class MandosDBusService(DBusObjectWithObjectManager):
2310
3390
"""A D-Bus proxy object"""
2311
3392
def __init__(self):
2312
3393
dbus.service.Object.__init__(self, bus, "/")
2313
3395
_interface = "se.recompile.Mandos"
2315
3397
@dbus.service.signal(_interface, signature="o")
2316
3398
def ClientAdded(self, objpath):
2320
3402
@dbus.service.signal(_interface, signature="ss")
2321
def ClientNotFound(self, fingerprint, address):
3403
def ClientNotFound(self, key_id, address):
3407
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2325
3409
@dbus.service.signal(_interface, signature="os")
2326
3410
def ClientRemoved(self, objpath, name):
3414
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2330
3416
@dbus.service.method(_interface, out_signature="ao")
2331
3417
def GetAllClients(self):
2333
return dbus.Array(c.dbus_object_path
2335
tcp_server.clients.itervalues())
3419
return dbus.Array(c.dbus_object_path for c in
3420
tcp_server.clients.values())
3422
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2337
3424
@dbus.service.method(_interface,
2338
3425
out_signature="a{oa{sv}}")
2339
3426
def GetAllClientsWithProperties(self):
2341
3428
return dbus.Dictionary(
2342
((c.dbus_object_path, c.GetAll(""))
2343
for c in tcp_server.clients.itervalues()),
3429
{c.dbus_object_path: c.GetAll(
3430
"se.recompile.Mandos.Client")
3431
for c in tcp_server.clients.values()},
2344
3432
signature="oa{sv}")
2346
3434
@dbus.service.method(_interface, in_signature="o")
2347
3435
def RemoveClient(self, object_path):
2349
for c in tcp_server.clients.itervalues():
3437
for c in tcp_server.clients.values():
2350
3438
if c.dbus_object_path == object_path:
2351
3439
del tcp_server.clients[c.name]
2352
3440
c.remove_from_connection()
2353
# Don't signal anything except ClientRemoved
3441
# Don't signal the disabling
2354
3442
c.disable(quiet=True)
2356
self.ClientRemoved(object_path, c.name)
3443
# Emit D-Bus signal for removal
3444
self.client_removed_signal(c)
2358
3446
raise KeyError(object_path)
2362
class MandosDBusServiceTransitional(MandosDBusService):
2363
__metaclass__ = AlternateDBusNamesMetaclass
2364
mandos_dbus_service = MandosDBusServiceTransitional()
3450
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3451
out_signature="a{oa{sa{sv}}}")
3452
def GetManagedObjects(self):
3454
return dbus.Dictionary(
3455
{client.dbus_object_path:
3457
{interface: client.GetAll(interface)
3459
client._get_all_interface_names()})
3460
for client in tcp_server.clients.values()})
3462
def client_added_signal(self, client):
3463
"""Send the new standard signal and the old signal"""
3465
# New standard signal
3466
self.InterfacesAdded(
3467
client.dbus_object_path,
3469
{interface: client.GetAll(interface)
3471
client._get_all_interface_names()}))
3473
self.ClientAdded(client.dbus_object_path)
3475
def client_removed_signal(self, client):
3476
"""Send the new standard signal and the old signal"""
3478
# New standard signal
3479
self.InterfacesRemoved(
3480
client.dbus_object_path,
3481
client._get_all_interface_names())
3483
self.ClientRemoved(client.dbus_object_path,
3486
mandos_dbus_service = MandosDBusService()
3488
# Save modules to variables to exempt the modules from being
3489
# unloaded before the function registered with atexit() is run.
3490
mp = multiprocessing
2367
3494
"Cleanup function; run on exit"
2370
multiprocessing.active_children()
3498
mp.active_children()
2371
3500
if not (tcp_server.clients or client_settings):
2374
3503
# Store client before exiting. Secrets are encrypted with key
2375
3504
# based on what config file has. If config file is
2376
3505
# removed/edited, old secret will thus be unrecovable.
2378
3507
with PGPEngine() as pgp:
2379
for client in tcp_server.clients.itervalues():
3508
for client in tcp_server.clients.values():
2380
3509
key = client_settings[client.name]["secret"]
2381
3510
client.encrypted_secret = pgp.encrypt(client.secret,
2383
3512
client_dict = {}
2385
3514
# A list of attributes that can not be pickled
2387
exclude = set(("bus", "changedstate", "secret",
2389
for name, typ in (inspect.getmembers
2390
(dbus.service.Object)):
3516
exclude = {"bus", "changedstate", "secret",
3517
"checker", "server_settings"}
3518
for name, typ in inspect.getmembers(dbus.service
2391
3520
exclude.add(name)
2393
3522
client_dict["encrypted_secret"] = (client
2394
3523
.encrypted_secret)
2395
3524
for attr in client.client_structure:
2396
3525
if attr not in exclude:
2397
3526
client_dict[attr] = getattr(client, attr)
2399
3528
clients[client.name] = client_dict
2400
3529
del client_settings[client.name]["secret"]
2403
with os.fdopen(os.open(stored_state_path,
2404
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2405
0600), "wb") as stored_state:
2406
pickle.dump((clients, client_settings), stored_state)
3532
with tempfile.NamedTemporaryFile(
3536
dir=os.path.dirname(stored_state_path),
3537
delete=False) as stored_state:
3538
pickle.dump((clients, client_settings), stored_state,
3540
tempname = stored_state.name
3541
os.rename(tempname, stored_state_path)
2407
3542
except (IOError, OSError) as e:
2408
logger.warning("Could not save persistent state: {0}"
2410
if e.errno not in (errno.ENOENT, errno.EACCES):
3548
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3549
logger.warning("Could not save persistent state: {}"
3550
.format(os.strerror(e.errno)))
3552
logger.warning("Could not save persistent state:",
2413
3556
# Delete all clients, and settings from config
2414
3557
while tcp_server.clients:
2415
3558
name, client = tcp_server.clients.popitem()
2417
3560
client.remove_from_connection()
2418
# Don't signal anything except ClientRemoved
3561
# Don't signal the disabling
2419
3562
client.disable(quiet=True)
3563
# Emit D-Bus signal for removal
2422
mandos_dbus_service.ClientRemoved(client
3565
mandos_dbus_service.client_removed_signal(client)
2425
3566
client_settings.clear()
2427
3568
atexit.register(cleanup)
2429
for client in tcp_server.clients.itervalues():
3570
for client in tcp_server.clients.values():
2432
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3572
# Emit D-Bus signal for adding
3573
mandos_dbus_service.client_added_signal(client)
2433
3574
# Need to initiate checking of clients
2434
3575
if client.enabled:
2435
3576
client.init_checker()
2437
3578
tcp_server.enable()
2438
3579
tcp_server.server_activate()
2440
3581
# Find out what port we got
2441
service.port = tcp_server.socket.getsockname()[1]
3583
service.port = tcp_server.socket.getsockname()[1]
2443
3585
logger.info("Now listening on address %r, port %d,"
2444
" flowinfo %d, scope_id %d"
2445
% tcp_server.socket.getsockname())
3586
" flowinfo %d, scope_id %d",
3587
*tcp_server.socket.getsockname())
2447
logger.info("Now listening on address %r, port %d"
2448
% tcp_server.socket.getsockname())
2450
#service.interface = tcp_server.socket.getsockname()[3]
3589
logger.info("Now listening on address %r, port %d",
3590
*tcp_server.socket.getsockname())
3592
# service.interface = tcp_server.socket.getsockname()[3]
2453
# From the Avahi example code
2456
except dbus.exceptions.DBusException as error:
2457
logger.critical("DBusException: %s", error)
2460
# End of Avahi example code
2462
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2463
lambda *args, **kwargs:
2464
(tcp_server.handle_request
2465
(*args[2:], **kwargs) or True))
3596
# From the Avahi example code
3599
except dbus.exceptions.DBusException as error:
3600
logger.critical("D-Bus Exception", exc_info=error)
3603
# End of Avahi example code
3606
GLib.IOChannel.unix_new(tcp_server.fileno()),
3607
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3608
lambda *args, **kwargs: (tcp_server.handle_request
3609
(*args[2:], **kwargs) or True))
2467
3611
logger.debug("Starting main loop")
2468
3612
main_loop.run()
2469
3613
except AvahiError as error:
2470
logger.critical("AvahiError: %s", error)
3614
logger.critical("Avahi Error", exc_info=error)
2473
3617
except KeyboardInterrupt: