238
166
os.rmdir(self.tempdir)
239
167
self.tempdir = None
241
169
def password_encode(self, password):
242
170
# Passphrase can not be empty and can not contain newlines or
243
171
# NUL bytes. So we prefix it and hex encode it.
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"))
172
return b"mandos" + binascii.hexlify(password)
252
174
def encrypt(self, data, password):
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:
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
268
189
return ciphertext
270
191
def decrypt(self, data, password):
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:
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
286
206
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
315
210
class AvahiError(Exception):
316
211
def __init__(self, value, *args, **kwargs):
317
212
self.value = value
318
return super(AvahiError, self).__init__(value, *args,
213
super(AvahiError, self).__init__(value, *args, **kwargs)
214
def __unicode__(self):
215
return unicode(repr(self.value))
322
217
class AvahiServiceError(AvahiError):
326
220
class AvahiGroupError(AvahiError):
224
class AvahiService(object):
331
225
"""An Avahi (Zeroconf) service.
334
228
interface: integer; avahi.IF_UNSPEC or an interface index.
335
229
Used to optionally bind to the specified interface.
336
230
name: string; Example: 'Mandos'
337
231
type: string; Example: '_mandos._tcp'.
338
See <https://www.iana.org/assignments/service-names-port-numbers>
232
See <http://www.dns-sd.org/ServiceTypes.html>
339
233
port: integer; what port to announce
340
234
TXT: list of strings; TXT record for the service
341
235
domain: string; Domain to publish on, default to .local if empty.
500
364
follow_name_owner_changes=True),
501
365
avahi.DBUS_INTERFACE_SERVER)
502
366
self.server.connect_to_signal("StateChanged",
503
self.server_state_changed)
367
self.server_state_changed)
504
368
self.server_state_changed(self.server.GetState())
507
370
class AvahiServiceToSyslog(AvahiService):
508
def rename(self, *args, **kwargs):
509
372
"""Add the new name to the syslog messages"""
510
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
511
syslogger.setFormatter(logging.Formatter(
512
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
373
ret = AvahiService.rename(self)
374
syslogger.setFormatter(logging.Formatter
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
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))
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):
830
387
"""A representation of a client host served by this server.
833
390
approved: bool(); 'None' if not yet approved/disapproved
834
391
approval_delay: datetime.timedelta(); Time to wait for approval
835
392
approval_duration: datetime.timedelta(); Duration of one approval
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
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
840
397
checker_command: string; External command which is run to check
841
398
if client lives. %() expansions are done at
842
399
runtime with vars(self) as dict, so that for
843
400
instance %(name)s can be used in the command.
844
checker_initiator_tag: a GLib event source tag, or None
401
checker_initiator_tag: a gobject event source tag, or None
845
402
created: datetime.datetime(); (UTC) object creation
846
403
client_structure: Object describing what attributes a client has
847
404
and is used for storing the client at exit
848
405
current_checker_command: string; current running checker_command
849
disable_initiator_tag: a GLib event source tag, or None
406
disable_initiator_tag: a gobject event source tag, or None
851
408
fingerprint: string (40 or 32 hexadecimal digits); used to
852
uniquely identify an OpenPGP client
853
key_id: string (64 hexadecimal digits); used to uniquely identify
854
a client using raw public keys
409
uniquely identify the client
855
410
host: string; available for use by the checker command
856
411
interval: datetime.timedelta(); How often to start a new checker
857
412
last_approval_request: datetime.datetime(); (UTC) or None
858
413
last_checked_ok: datetime.datetime(); (UTC) or None
859
414
last_checker_status: integer between 0 and 255 reflecting exit
860
415
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
864
417
last_enabled: datetime.datetime(); (UTC) or None
865
418
name: string; from the config file, used in log messages and
866
419
D-Bus identifiers
867
420
secret: bytestring; sent verbatim (over TLS) to client
868
421
timeout: datetime.timedelta(); How long from last_checked_ok
869
422
until this client is disabled
870
extended_timeout: extra long timeout when secret has been sent
423
extended_timeout: extra long timeout when password has been sent
871
424
runtime_expansions: Allowed attributes for runtime expansion.
872
425
expires: datetime.datetime(); time (UTC) when a client will be
873
426
disabled, or None
874
server_settings: The server_settings dict from main()
877
429
runtime_expansions = ("approval_delay", "approval_duration",
878
"created", "enabled", "expires", "key_id",
879
"fingerprint", "host", "interval",
880
"last_approval_request", "last_checked_ok",
430
"created", "enabled", "fingerprint",
431
"host", "interval", "last_checked_ok",
881
432
"last_enabled", "name", "timeout")
884
"extended_timeout": "PT15M",
886
"checker": "fping -q -- %%(host)s",
888
"approval_delay": "PT0S",
889
"approval_duration": "PT1S",
890
"approved_by_default": "True",
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)
895
460
def config_parser(config):
896
"""Construct a new dict of client settings of this form:
461
""" Construct a new dict of client settings of this form:
897
462
{ client_name: {setting_name: value, ...}, ...}
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.
463
with exceptions for any special settings as defined above"""
903
465
for client_name in config.sections():
904
466
section = dict(config.items(client_name))
905
467
client = settings[client_name] = {}
907
469
client["host"] = section["host"]
908
470
# Reformat values from string types to Python types
909
471
client["approved_by_default"] = config.getboolean(
910
472
client_name, "approved_by_default")
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()
473
client["enabled"] = config.getboolean(client_name, "enabled")
919
475
client["fingerprint"] = (section["fingerprint"].upper()
920
476
.replace(" ", ""))
921
477
if "secret" in section:
922
client["secret"] = codecs.decode(section["secret"]
478
client["secret"] = section["secret"].decode("base64")
925
479
elif "secfile" in section:
926
480
with open(os.path.expanduser(os.path.expandvars
927
481
(section["secfile"])),
928
482
"rb") as secfile:
929
483
client["secret"] = secfile.read()
931
raise TypeError("No secret or secfile for section {}"
485
raise TypeError("No secret or secfile for section %s"
933
487
client["timeout"] = string_to_delta(section["timeout"])
934
488
client["extended_timeout"] = string_to_delta(
935
489
section["extended_timeout"])
978
531
self.current_checker_command = None
979
532
self.approved = None
980
533
self.approvals_pending = 0
981
self.changedstate = multiprocessing_manager.Condition(
982
multiprocessing_manager.Lock())
983
self.client_structure = [attr
984
for attr in self.__dict__.keys()
534
self.changedstate = (multiprocessing_manager
535
.Condition(multiprocessing_manager
537
self.client_structure = [attr for attr in
538
self.__dict__.iterkeys()
985
539
if not attr.startswith("_")]
986
540
self.client_structure.append("client_structure")
988
for name, t in inspect.getmembers(
989
type(self), lambda obj: isinstance(obj, property)):
542
for name, t in inspect.getmembers(type(self),
990
546
if not name.startswith("_"):
991
547
self.client_structure.append(name)
993
549
# Send notice to process children that client state has changed
994
550
def send_changedstate(self):
995
551
with self.changedstate:
996
552
self.changedstate.notify_all()
998
554
def enable(self):
999
555
"""Start this client's checker and timeout hooks"""
1000
556
if getattr(self, "enabled", False):
1001
557
# Already enabled
559
self.send_changedstate()
1003
560
self.expires = datetime.datetime.utcnow() + self.timeout
1004
561
self.enabled = True
1005
562
self.last_enabled = datetime.datetime.utcnow()
1006
563
self.init_checker()
1007
self.send_changedstate()
1009
565
def disable(self, quiet=True):
1010
566
"""Disable this client."""
1011
567
if not getattr(self, "enabled", False):
570
self.send_changedstate()
1014
572
logger.info("Disabling client %s", self.name)
1015
if getattr(self, "disable_initiator_tag", None) is not None:
1016
GLib.source_remove(self.disable_initiator_tag)
573
if getattr(self, "disable_initiator_tag", False):
574
gobject.source_remove(self.disable_initiator_tag)
1017
575
self.disable_initiator_tag = None
1018
576
self.expires = None
1019
if getattr(self, "checker_initiator_tag", None) is not None:
1020
GLib.source_remove(self.checker_initiator_tag)
577
if getattr(self, "checker_initiator_tag", False):
578
gobject.source_remove(self.checker_initiator_tag)
1021
579
self.checker_initiator_tag = None
1022
580
self.stop_checker()
1023
581
self.enabled = False
1025
self.send_changedstate()
1026
# Do not run this again if called by a GLib.timeout_add
582
# Do not run this again if called by a gobject.timeout_add
1029
585
def __del__(self):
1032
588
def init_checker(self):
1033
589
# Schedule a new checker to be started an 'interval' from now,
1034
590
# and every interval from then on.
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),
591
self.checker_initiator_tag = (gobject.timeout_add
592
(self.interval_milliseconds(),
1040
594
# Schedule a disable() when 'timeout' has passed
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)
595
self.disable_initiator_tag = (gobject.timeout_add
596
(self.timeout_milliseconds(),
1045
598
# Also start a new checker *right now*.
1046
599
self.start_checker()
1048
def checker_callback(self, source, condition, connection,
601
def checker_callback(self, pid, condition, command):
1050
602
"""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:
1056
603
self.checker_callback_tag = None
1057
604
self.checker = None
1060
self.last_checker_status = returncode
1061
self.last_checker_signal = None
605
if os.WIFEXITED(condition):
606
self.last_checker_status = os.WEXITSTATUS(condition)
1062
607
if self.last_checker_status == 0:
1063
608
logger.info("Checker for %(name)s succeeded",
1065
610
self.checked_ok()
1067
logger.info("Checker for %(name)s failed", vars(self))
612
logger.info("Checker for %(name)s failed",
1069
615
self.last_checker_status = -1
1070
self.last_checker_signal = -returncode
1071
616
logger.warning("Checker for %(name)s crashed?",
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."""
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,
1084
625
if timeout is None:
1085
626
timeout = self.timeout
627
self.last_checked_ok = datetime.datetime.utcnow()
1086
628
if self.disable_initiator_tag is not None:
1087
GLib.source_remove(self.disable_initiator_tag)
1088
self.disable_initiator_tag = None
629
gobject.source_remove(self.disable_initiator_tag)
1089
630
if getattr(self, "enabled", False):
1090
self.disable_initiator_tag = GLib.timeout_add(
1091
int(timeout.total_seconds() * 1000), self.disable)
631
self.disable_initiator_tag = (gobject.timeout_add
632
(timedelta_to_milliseconds
633
(timeout), self.disable))
1092
634
self.expires = datetime.datetime.utcnow() + timeout
1094
636
def need_approval(self):
1095
637
self.last_approval_request = datetime.datetime.utcnow()
1097
639
def start_checker(self):
1098
640
"""Start a new checker subprocess if one is not running.
1100
642
If a checker already exists, leave it running and do
1102
644
# The reason for not killing a running checker is that if we
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
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
1107
649
# checkers alone, the checker would have to take more time
1108
650
# than 'timeout' for the client to be disabled, which is as it
1111
if self.checker is not None and not self.checker.is_alive():
1112
logger.warning("Checker was not alive; joining")
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)
1115
666
# Start a new checker if needed
1116
667
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}
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
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
1128
687
self.current_checker_command = command
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
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
1158
714
def stop_checker(self):
1159
715
"""Force the checker process, if any, to stop."""
1160
716
if self.checker_callback_tag:
1161
GLib.source_remove(self.checker_callback_tag)
717
gobject.source_remove(self.checker_callback_tag)
1162
718
self.checker_callback_tag = None
1163
719
if getattr(self, "checker", None) is None:
1165
721
logger.debug("Stopping checker for %(name)s", vars(self))
1166
self.checker.terminate()
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
1167
730
self.checker = None
1170
def dbus_service_property(dbus_interface,
733
def dbus_service_property(dbus_interface, signature="v",
734
access="readwrite", byte_arrays=False):
1174
735
"""Decorators for marking methods of a DBusObjectWithProperties to
1175
736
become properties on the D-Bus.
1177
738
The decorated method will be called with no arguments by "Get"
1178
739
and with one argument by "Set".
1180
741
The parameters, where they are supported, are the same as
1181
742
dbus.service.method, except there is only "signature", since the
1182
743
type from Get() and the type sent to Set() is the same.
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):
782
class DBusObjectWithProperties(dbus.service.Object):
1355
783
"""A D-Bus object with properties.
1357
785
Classes inheriting from this can use the dbus_service_property
1358
786
decorator to expose methods as D-Bus properties. It exposes the
1359
787
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))
1362
802
def _get_dbus_property(self, interface_name, property_name):
1363
803
"""Returns a bound method if one exists which is a D-Bus
1364
804
property with the specified name and interface.
1366
for cls in self.__class__.__mro__:
1367
for name, value in inspect.getmembers(
1368
cls, self._is_dbus_thing("property")):
806
for cls in self.__class__.__mro__:
807
for name, value in (inspect.getmembers
808
(cls, self._is_dbus_property)):
1369
809
if (value._dbus_name == property_name
1370
810
and value._dbus_interface == interface_name):
1371
811
return value.__get__(self)
1373
813
# No such property
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,
814
raise DBusPropertyNotFound(self.dbus_object_path + ":"
815
+ interface_name + "."
818
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1388
819
out_signature="v")
1389
820
def Get(self, interface_name, property_name):
1390
821
"""Standard D-Bus property Get() method, see D-Bus standard.
1514
913
except (AttributeError, xml.dom.DOMException,
1515
914
xml.parsers.expat.ExpatError) as error:
1516
915
logger.error("Failed to override Introspection method",
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):
920
def datetime_to_dbus (dt, variant_level=0):
1593
921
"""Convert a UTC datetime.datetime() to a D-Bus type."""
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).
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.
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):
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):
1630
940
# Ignore non-D-Bus attributes, and D-Bus attributes
1631
941
# with the wrong interface name
1632
942
if (not hasattr(attribute, "_dbus_interface")
1633
or not attribute._dbus_interface.startswith(
1634
orig_interface_name)):
943
or not attribute._dbus_interface
944
.startswith("se.recompile.Mandos")):
1636
946
# Create an alternate D-Bus interface name based on
1637
947
# the current name
1638
alt_interface = attribute._dbus_interface.replace(
1639
orig_interface_name, alt_interface_name)
1640
interface_names.add(alt_interface)
948
alt_interface = (attribute._dbus_interface
949
.replace("se.recompile.Mandos",
950
"se.bsnet.fukt.Mandos"))
1641
951
# Is this a D-Bus signal?
1642
952
if getattr(attribute, "_dbus_is_signal", False):
1643
# Extract the original non-method undecorated
1644
# function by black magic
1645
if sys.version_info.major == 2:
1646
nonmethod_func = (dict(
953
# Extract the original non-method function by
955
nonmethod_func = (dict(
1647
956
zip(attribute.func_code.co_freevars,
1648
attribute.__closure__))
1649
["func"].cell_contents)
1651
nonmethod_func = (dict(
1652
zip(attribute.__code__.co_freevars,
1653
attribute.__closure__))
1654
["func"].cell_contents)
957
attribute.__closure__))["func"]
1655
959
# Create a new, but exactly alike, function
1656
960
# object, and decorate it to be a new D-Bus signal
1657
961
# with the alternate D-Bus interface name
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:
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)))
1669
971
# Define a creator of a function to call both the
1670
# original and alternate functions, so both the
1671
# original and alternate signals gets sent when
1672
# the function is called
972
# old and new functions, so both the old and new
973
# signals gets sent when the function is called
1673
974
def fixscope(func1, func2):
1674
975
"""This function is a scope container to pass
1675
976
func1 and func2 to the "call_both" function
1676
977
outside of its arguments"""
1678
@functools.wraps(func2)
1679
978
def call_both(*args, **kwargs):
1680
979
"""This function will emit two D-Bus
1681
980
signals by calling func1 and func2"""
1682
981
func1(*args, **kwargs)
1683
982
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)
1690
983
return call_both
1691
984
# Create the "call_both" function and add it to
1693
attr[attrname] = fixscope(attribute, new_function)
986
attr[attrname] = fixscope(attribute,
1694
988
# Is this a D-Bus method?
1695
989
elif getattr(attribute, "_dbus_is_method", False):
1696
990
# Create a new, but exactly alike, function
1697
991
# object. Decorate it to be a new D-Bus method
1698
992
# with the alternate D-Bus interface name. Add it
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:
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)))
1712
1004
# Is this a D-Bus property?
1713
1005
elif getattr(attribute, "_dbus_is_property", False):
1714
1006
# Create a new, but exactly alike, function
1715
1007
# object, and decorate it to be a new D-Bus
1716
1008
# property with the alternate D-Bus interface
1717
1009
# name. Add it to the class.
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"})
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)
1770
1026
class ClientDBus(Client, DBusObjectWithProperties):
1771
1027
"""A Client class using D-Bus
1774
1030
dbus_object_path: dbus.ObjectPath
1775
1031
bus: dbus.SystemBus()
1778
1034
runtime_expansions = (Client.runtime_expansions
1779
+ ("dbus_object_path", ))
1781
_interface = "se.recompile.Mandos.Client"
1035
+ ("dbus_object_path",))
1783
1037
# dbus.service.Object doesn't use super(), so we can't either.
1785
def __init__(self, bus=None, *args, **kwargs):
1039
def __init__(self, bus = None, *args, **kwargs):
1787
1041
Client.__init__(self, *args, **kwargs)
1042
self._approvals_pending = 0
1044
self._approvals_pending = 0
1788
1045
# Only now, when this client is initialized, can it show up on
1790
client_object_name = str(self.name).translate(
1047
client_object_name = unicode(self.name).translate(
1791
1048
{ord("."): ord("_"),
1792
1049
ord("-"): ord("_")})
1793
self.dbus_object_path = dbus.ObjectPath(
1794
"/clients/" + client_object_name)
1050
self.dbus_object_path = (dbus.ObjectPath
1051
("/clients/" + client_object_name))
1795
1052
DBusObjectWithProperties.__init__(self, self.bus,
1796
1053
self.dbus_object_path)
1798
def notifychangeproperty(transform_func, dbus_name,
1799
type_func=lambda x: x,
1801
invalidate_only=False,
1802
_interface=_interface):
1055
def notifychangeproperty(transform_func,
1056
dbus_name, type_func=lambda x: x,
1803
1058
""" Modify a variable so that it's a property which announces
1804
1059
its changes to DBus.
1806
1061
transform_fun: Function that takes a value and a variant_level
1807
1062
and transforms it to a D-Bus type.
1808
1063
dbus_name: D-Bus name of the variable
1810
1065
to the D-Bus. Default: no transform
1811
1066
variant_level: D-Bus variant level. Default: 1
1813
attrname = "_{}".format(dbus_name)
1068
attrname = "_{0}".format(dbus_name)
1815
1069
def setter(self, value):
1816
1070
if hasattr(self, "dbus_object_path"):
1817
1071
if (not hasattr(self, attrname) or
1818
1072
type_func(getattr(self, attrname, None))
1819
1073
!= type_func(value)):
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):
1074
dbus_value = transform_func(type_func(value),
1077
self.PropertyChanged(dbus.String(dbus_name),
1835
1079
setattr(self, attrname, value)
1837
1081
return property(lambda self: getattr(self, attrname), setter)
1839
1084
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1840
1085
approvals_pending = notifychangeproperty(dbus.Boolean,
1841
1086
"ApprovalPending",
1843
1088
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1844
1089
last_enabled = notifychangeproperty(datetime_to_dbus,
1846
checker = notifychangeproperty(
1847
dbus.Boolean, "CheckerRunning",
1848
type_func=lambda checker: checker is not None)
1091
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1092
type_func = lambda checker:
1093
checker is not None)
1849
1094
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1850
1095
"LastCheckedOK")
1851
last_checker_status = notifychangeproperty(dbus.Int16,
1852
"LastCheckerStatus")
1853
1096
last_approval_request = notifychangeproperty(
1854
1097
datetime_to_dbus, "LastApprovalRequest")
1855
1098
approved_by_default = notifychangeproperty(dbus.Boolean,
1856
1099
"ApprovedByDefault")
1857
approval_delay = notifychangeproperty(
1858
dbus.UInt64, "ApprovalDelay",
1859
type_func=lambda td: td.total_seconds() * 1000)
1100
approval_delay = notifychangeproperty(dbus.UInt64,
1103
timedelta_to_milliseconds)
1860
1104
approval_duration = notifychangeproperty(
1861
1105
dbus.UInt64, "ApprovalDuration",
1862
type_func=lambda td: td.total_seconds() * 1000)
1106
type_func = timedelta_to_milliseconds)
1863
1107
host = notifychangeproperty(dbus.String, "Host")
1864
timeout = notifychangeproperty(
1865
dbus.UInt64, "Timeout",
1866
type_func=lambda td: td.total_seconds() * 1000)
1108
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1110
timedelta_to_milliseconds)
1867
1111
extended_timeout = notifychangeproperty(
1868
1112
dbus.UInt64, "ExtendedTimeout",
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)
1113
type_func = timedelta_to_milliseconds)
1114
interval = notifychangeproperty(dbus.UInt64,
1117
timedelta_to_milliseconds)
1873
1118
checker_command = notifychangeproperty(dbus.String, "Checker")
1874
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1875
invalidate_only=True)
1877
1120
del notifychangeproperty
1879
1122
def __del__(self, *args, **kwargs):
1881
1124
self.remove_from_connection()
1960
1204
server to mandos-client
1964
1208
# Rejected - signal
1965
1209
@dbus.service.signal(_interface, signature="s")
1966
1210
def Rejected(self, reason):
1970
1214
# NeedApproval - signal
1971
1215
@dbus.service.signal(_interface, signature="tb")
1972
1216
def NeedApproval(self, timeout, default):
1974
1218
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.
1978
1230
# Approve - method
1979
1231
@dbus.service.method(_interface, in_signature="b")
1980
1232
def Approve(self, value):
1981
1233
self.approve(value)
1983
1235
# CheckedOK - method
1984
1236
@dbus.service.method(_interface)
1985
1237
def CheckedOK(self):
1986
1238
self.checked_ok()
1988
1240
# Enable - method
1989
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1990
1241
@dbus.service.method(_interface)
1991
1242
def Enable(self):
1995
1246
# StartChecker - method
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
1247
@dbus.service.method(_interface)
1998
1248
def StartChecker(self):
2000
1250
self.start_checker()
2002
1252
# Disable - method
2003
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2004
1253
@dbus.service.method(_interface)
2005
1254
def Disable(self):
2009
1258
# StopChecker - method
2010
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2011
1259
@dbus.service.method(_interface)
2012
1260
def StopChecker(self):
2013
1261
self.stop_checker()
2017
1265
# ApprovalPending - property
2018
1266
@dbus_service_property(_interface, signature="b", access="read")
2019
1267
def ApprovalPending_dbus_property(self):
2020
1268
return dbus.Boolean(bool(self.approvals_pending))
2022
1270
# ApprovedByDefault - property
2023
@dbus_service_property(_interface,
1271
@dbus_service_property(_interface, signature="b",
2025
1272
access="readwrite")
2026
1273
def ApprovedByDefault_dbus_property(self, value=None):
2027
1274
if value is None: # get
2028
1275
return dbus.Boolean(self.approved_by_default)
2029
1276
self.approved_by_default = bool(value)
2031
1278
# ApprovalDelay - property
2032
@dbus_service_property(_interface,
1279
@dbus_service_property(_interface, signature="t",
2034
1280
access="readwrite")
2035
1281
def ApprovalDelay_dbus_property(self, value=None):
2036
1282
if value is None: # get
2037
return dbus.UInt64(self.approval_delay.total_seconds()
1283
return dbus.UInt64(self.approval_delay_milliseconds())
2039
1284
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2041
1286
# ApprovalDuration - property
2042
@dbus_service_property(_interface,
1287
@dbus_service_property(_interface, signature="t",
2044
1288
access="readwrite")
2045
1289
def ApprovalDuration_dbus_property(self, value=None):
2046
1290
if value is None: # get
2047
return dbus.UInt64(self.approval_duration.total_seconds()
1291
return dbus.UInt64(timedelta_to_milliseconds(
1292
self.approval_duration))
2049
1293
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2051
1295
# Name - property
2053
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2054
1296
@dbus_service_property(_interface, signature="s", access="read")
2055
1297
def Name_dbus_property(self):
2056
1298
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)
2065
1300
# Fingerprint - property
2067
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2068
1301
@dbus_service_property(_interface, signature="s", access="read")
2069
1302
def Fingerprint_dbus_property(self):
2070
1303
return dbus.String(self.fingerprint)
2072
1305
# Host - property
2073
@dbus_service_property(_interface,
1306
@dbus_service_property(_interface, signature="s",
2075
1307
access="readwrite")
2076
1308
def Host_dbus_property(self, value=None):
2077
1309
if value is None: # get
2078
1310
return dbus.String(self.host)
2079
self.host = str(value)
1311
self.host = unicode(value)
2081
1313
# Created - property
2083
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2084
1314
@dbus_service_property(_interface, signature="s", access="read")
2085
1315
def Created_dbus_property(self):
2086
1316
return datetime_to_dbus(self.created)
2088
1318
# LastEnabled - property
2089
1319
@dbus_service_property(_interface, signature="s", access="read")
2090
1320
def LastEnabled_dbus_property(self):
2091
1321
return datetime_to_dbus(self.last_enabled)
2093
1323
# Enabled - property
2094
@dbus_service_property(_interface,
1324
@dbus_service_property(_interface, signature="b",
2096
1325
access="readwrite")
2097
1326
def Enabled_dbus_property(self, value=None):
2098
1327
if value is None: # get
2105
1334
# LastCheckedOK - property
2106
@dbus_service_property(_interface,
1335
@dbus_service_property(_interface, signature="s",
2108
1336
access="readwrite")
2109
1337
def LastCheckedOK_dbus_property(self, value=None):
2110
1338
if value is not None:
2111
1339
self.checked_ok()
2113
1341
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)
2120
1343
# Expires - property
2121
1344
@dbus_service_property(_interface, signature="s", access="read")
2122
1345
def Expires_dbus_property(self):
2123
1346
return datetime_to_dbus(self.expires)
2125
1348
# LastApprovalRequest - property
2126
1349
@dbus_service_property(_interface, signature="s", access="read")
2127
1350
def LastApprovalRequest_dbus_property(self):
2128
1351
return datetime_to_dbus(self.last_approval_request)
2130
1353
# Timeout - property
2131
@dbus_service_property(_interface,
1354
@dbus_service_property(_interface, signature="t",
2133
1355
access="readwrite")
2134
1356
def Timeout_dbus_property(self, value=None):
2135
1357
if value is None: # get
2136
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2137
old_timeout = self.timeout
1358
return dbus.UInt64(self.timeout_milliseconds())
2138
1359
self.timeout = datetime.timedelta(0, 0, 0, value)
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),
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))
2155
1381
# ExtendedTimeout - property
2156
@dbus_service_property(_interface,
1382
@dbus_service_property(_interface, signature="t",
2158
1383
access="readwrite")
2159
1384
def ExtendedTimeout_dbus_property(self, value=None):
2160
1385
if value is None: # get
2161
return dbus.UInt64(self.extended_timeout.total_seconds()
1386
return dbus.UInt64(self.extended_timeout_milliseconds())
2163
1387
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2165
1389
# Interval - property
2166
@dbus_service_property(_interface,
1390
@dbus_service_property(_interface, signature="t",
2168
1391
access="readwrite")
2169
1392
def Interval_dbus_property(self, value=None):
2170
1393
if value is None: # get
2171
return dbus.UInt64(self.interval.total_seconds() * 1000)
1394
return dbus.UInt64(self.interval_milliseconds())
2172
1395
self.interval = datetime.timedelta(0, 0, 0, value)
2173
1396
if getattr(self, "checker_initiator_tag", None) is None:
2175
1398
if self.enabled:
2176
1399
# Reschedule checker run
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
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
2182
1405
# Checker - property
2183
@dbus_service_property(_interface,
1406
@dbus_service_property(_interface, signature="s",
2185
1407
access="readwrite")
2186
1408
def Checker_dbus_property(self, value=None):
2187
1409
if value is None: # get
2188
1410
return dbus.String(self.checker_command)
2189
self.checker_command = str(value)
1411
self.checker_command = unicode(value)
2191
1413
# CheckerRunning - property
2192
@dbus_service_property(_interface,
1414
@dbus_service_property(_interface, signature="b",
2194
1415
access="readwrite")
2195
1416
def CheckerRunning_dbus_property(self, value=None):
2196
1417
if value is None: # get
2237
1450
if data[0] == 'data':
2239
1452
if data[0] == 'function':
2241
1453
def func(*args, **kwargs):
2242
1454
self._pipe.send(('funcall', name, args, kwargs))
2243
1455
return self._pipe.recv()[1]
2247
1458
def __setattr__(self, name, value):
2248
1459
if name == '_pipe':
2249
1460
return super(ProxyClient, self).__setattr__(name, value)
2250
1461
self._pipe.send(('setattr', name, value))
1464
class ClientDBusTransitional(ClientDBus):
1465
__metaclass__ = AlternateDBusNamesMetaclass
2253
1468
class ClientHandler(socketserver.BaseRequestHandler, object):
2254
1469
"""A class to handle client connections.
2256
1471
Instantiated once for each connection to handle it.
2257
1472
Note: This will run in its own forked process."""
2259
1474
def handle(self):
2260
1475
with contextlib.closing(self.server.child_pipe) as child_pipe:
2261
1476
logger.info("TCP connection from: %s",
2262
str(self.client_address))
1477
unicode(self.client_address))
2263
1478
logger.debug("Pipe FD: %d",
2264
1479
self.server.child_pipe.fileno())
2266
session = gnutls.ClientSession(self.request)
2268
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2269
# "+AES-256-CBC", "+SHA1",
2270
# "+COMP-NULL", "+CTYPE-OPENPGP",
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",
2272
1495
# Use a fallback default, since this MUST be set.
2273
1496
priority = self.server.gnutls_priority
2274
1497
if priority is None:
2275
1498
priority = "NORMAL"
2276
gnutls.priority_set_direct(session._c_object,
2277
priority.encode("utf-8"),
1499
(gnutls.library.functions
1500
.gnutls_priority_set_direct(session._c_object,
2280
1503
# Start communication using the Mandos protocol
2281
1504
# Get protocol number
2282
1505
line = self.request.makefile().readline()
2283
1506
logger.debug("Protocol version: %r", line)
2285
1508
if int(line.strip().split()[0]) > 1:
2286
raise RuntimeError(line)
2287
1510
except (ValueError, IndexError, RuntimeError) as error:
2288
1511
logger.error("Unknown protocol version: %s", error)
2291
1514
# Start GnuTLS connection
2293
1516
session.handshake()
2294
except gnutls.Error as error:
1517
except gnutls.errors.GNUTLSError as error:
2295
1518
logger.warning("Handshake failed: %s", error)
2296
1519
# Do not run session.bye() here: the session is not
2297
1520
# established. Just abandon the request.
2299
1522
logger.debug("Handshake succeeded")
2301
1524
approval_required = False
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,
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,
2325
1537
self.client_address)
2326
1538
except KeyError:
1541
if self.server.use_dbus:
1543
client.NewRequest(str(self.client_address))
2329
1545
if client.approval_delay:
2330
1546
delay = client.approval_delay
2331
1547
client.approvals_pending += 1
2332
1548
approval_required = True
2335
1551
if not client.enabled:
2336
1552
logger.info("Client %s is disabled",
2338
1554
if self.server.use_dbus:
2339
1555
# Emit D-Bus signal
2340
1556
client.Rejected("Disabled")
2343
1559
if client.approved or not client.approval_delay:
2344
# We are approved or approval is disabled
1560
#We are approved or approval is disabled
2346
1562
elif client.approved is None:
2347
1563
logger.info("Client %s needs approval",
2380
1598
delay -= time2 - time
2383
session.send(client.secret)
2384
except gnutls.Error as error:
2385
logger.warning("gnutls send failed",
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))
2389
1612
logger.info("Sending secret to %s", client.name)
2390
1613
# bump the timeout using extended_timeout
2391
client.bump_timeout(client.extended_timeout)
1614
client.checked_ok(client.extended_timeout)
2392
1615
if self.server.use_dbus:
2393
1616
# Emit D-Bus signal
2394
1617
client.GotSecret()
2397
1620
if approval_required:
2398
1621
client.approvals_pending -= 1
2401
except gnutls.Error as error:
2402
logger.warning("GnuTLS bye failed",
1624
except gnutls.errors.GNUTLSError as error:
1625
logger.warning("GnuTLS bye failed")
2406
1628
def peer_certificate(session):
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
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
2423
1636
list_size = ctypes.c_uint(1)
2424
cert_list = (gnutls.certificate_get_peers
1637
cert_list = (gnutls.library.functions
1638
.gnutls_certificate_get_peers
2425
1639
(session._c_object, ctypes.byref(list_size)))
2426
1640
if not bool(cert_list) and list_size.value != 0:
2427
raise gnutls.Error("error getting peer certificate")
1641
raise gnutls.errors.GNUTLSError("error getting peer"
2428
1643
if list_size.value == 0:
2430
1645
cert = cert_list[0]
2431
1646
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()
2468
1649
def fingerprint(openpgp):
2469
1650
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2470
1651
# New GnuTLS "datum" with the OpenPGP public key
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)))
1652
datum = (gnutls.library.types
1653
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1656
ctypes.c_uint(len(openpgp))))
2475
1657
# New empty GnuTLS certificate
2476
crt = gnutls.openpgp_crt_t()
2477
gnutls.openpgp_crt_init(ctypes.byref(crt))
1658
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1659
(gnutls.library.functions
1660
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2478
1661
# Import the OpenPGP public key into the certificate
2479
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2480
gnutls.OPENPGP_FMT_RAW)
1662
(gnutls.library.functions
1663
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1664
gnutls.library.constants
1665
.GNUTLS_OPENPGP_FMT_RAW))
2481
1666
# Verify the self signature in the key
2482
1667
crtverify = ctypes.c_uint()
2483
gnutls.openpgp_crt_verify_self(crt, 0,
2484
ctypes.byref(crtverify))
1668
(gnutls.library.functions
1669
.gnutls_openpgp_crt_verify_self(crt, 0,
1670
ctypes.byref(crtverify)))
2485
1671
if crtverify.value != 0:
2486
gnutls.openpgp_crt_deinit(crt)
2487
raise gnutls.CertificateSecurityError(code
1672
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1673
raise (gnutls.errors.CertificateSecurityError
2489
1675
# New buffer for the fingerprint
2490
1676
buf = ctypes.create_string_buffer(20)
2491
1677
buf_len = ctypes.c_size_t()
2492
1678
# Get the fingerprint from the certificate into the buffer
2493
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2494
ctypes.byref(buf_len))
1679
(gnutls.library.functions
1680
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1681
ctypes.byref(buf_len)))
2495
1682
# Deinit the certificate
2496
gnutls.openpgp_crt_deinit(crt)
1683
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2497
1684
# Convert the buffer to a Python bytestring
2498
1685
fpr = ctypes.string_at(buf, buf_len.value)
2499
1686
# Convert the bytestring to hexadecimal notation
2504
class MultiprocessingMixIn:
1691
class MultiprocessingMixIn(object):
2505
1692
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2507
1693
def sub_process_main(self, request, address):
2509
1695
self.finish_request(request, address)
2510
1696
except Exception:
2511
1697
self.handle_error(request, address)
2512
1698
self.close_request(request)
2514
1700
def process_request(self, request, address):
2515
1701
"""Start a new process to process the request."""
2516
proc = multiprocessing.Process(target=self.sub_process_main,
2517
args=(request, address))
1702
proc = multiprocessing.Process(target = self.sub_process_main,
2522
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1709
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2523
1710
""" adds a pipe to the MixIn """
2525
1711
def process_request(self, request, client_address):
2526
1712
"""Overrides and wraps the original process_request().
2528
1714
This function creates a new pipe in self.pipe
2530
1716
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2532
1718
proc = MultiprocessingMixIn.process_request(self, request,
2533
1719
client_address)
2534
1720
self.child_pipe.close()
2535
1721
self.add_pipe(parent_pipe, proc)
2537
1723
def add_pipe(self, parent_pipe, proc):
2538
1724
"""Dummy function; override as necessary"""
2539
raise NotImplementedError()
1725
raise NotImplementedError
2542
1728
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2543
socketserver.TCPServer):
1729
socketserver.TCPServer, object):
2544
1730
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2547
1733
enabled: Boolean; whether this server is activated yet
2548
1734
interface: None or a network interface name (string)
2549
1735
use_ipv6: Boolean; to use IPv6 or not
2552
1737
def __init__(self, server_address, RequestHandlerClass,
2556
"""If socketfd is set, use that file descriptor instead of
2557
creating a new one with socket.socket().
1738
interface=None, use_ipv6=True):
2559
1739
self.interface = interface
2561
1741
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.
2589
1742
socketserver.TCPServer.__init__(self, server_address,
2590
1743
RequestHandlerClass)
2592
1744
def server_bind(self):
2593
1745
"""This overrides the normal server_bind() function
2594
1746
to bind to an interface if one was specified, and also NOT to
2595
1747
bind to an address or port if they were not specified."""
2596
global SO_BINDTODEVICE
2597
1748
if self.interface is not None:
2598
1749
if SO_BINDTODEVICE is None:
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)
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",
2620
1770
# Only bind(2) the socket if we really need to.
2621
1771
if self.server_address[0] or self.server_address[1]:
2622
if self.server_address[1]:
2623
self.allow_reuse_address = True
2624
1772
if not self.server_address[0]:
2625
1773
if self.address_family == socket.AF_INET6:
2626
any_address = "::" # in6addr_any
1774
any_address = "::" # in6addr_any
2628
any_address = "0.0.0.0" # INADDR_ANY
1776
any_address = socket.INADDR_ANY
2629
1777
self.server_address = (any_address,
2630
1778
self.server_address[1])
2631
1779
elif not self.server_address[1]:
2632
self.server_address = (self.server_address[0], 0)
1780
self.server_address = (self.server_address[0],
2633
1782
# if self.interface:
2634
1783
# self.server_address = (self.server_address[0],
2738
1887
funcname = request[1]
2739
1888
args = request[2]
2740
1889
kwargs = request[3]
2742
1891
parent_pipe.send(('data', getattr(client_object,
2743
1892
funcname)(*args,
2746
1895
if command == 'getattr':
2747
1896
attrname = request[1]
2748
if isinstance(client_object.__getattribute__(attrname),
2749
collections.Callable):
2750
parent_pipe.send(('function', ))
1897
if callable(client_object.__getattribute__(attrname)):
1898
parent_pipe.send(('function',))
2753
'data', client_object.__getattribute__(attrname)))
1900
parent_pipe.send(('data', client_object
1901
.__getattribute__(attrname)))
2755
1903
if command == 'setattr':
2756
1904
attrname = request[1]
2757
1905
value = request[2]
2758
1906
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}"
2862
1911
def string_to_delta(interval):
2863
1912
"""Parse a string and return a datetime.timedelta
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)
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)
2880
return rfc3339_duration_to_delta(interval)
2884
1927
timevalue = datetime.timedelta(0)
2885
1928
for s in interval.split():
1930
suffix = unicode(s[-1])
2888
1931
value = int(s[:-1])
2889
1932
if suffix == "d":
2890
1933
delta = datetime.timedelta(value)
2962
2005
parser.add_argument("--no-dbus", action="store_false",
2963
2006
dest="use_dbus", help="Do not provide D-Bus"
2964
" system bus interface", default=None)
2007
" system bus interface")
2965
2008
parser.add_argument("--no-ipv6", action="store_false",
2966
dest="use_ipv6", help="Do not use IPv6",
2009
dest="use_ipv6", help="Do not use IPv6")
2968
2010
parser.add_argument("--no-restore", action="store_false",
2969
2011
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")
2974
2013
parser.add_argument("--statedir", metavar="DIR",
2975
2014
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",
2982
2016
options = parser.parse_args()
2984
2023
# Default values for config file for server-global settings
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",
2024
server_defaults = { "interface": "",
2029
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2030
"servicename": "Mandos",
2035
"statedir": "/var/lib/mandos"
3008
2038
# Parse config file for server-global settings
3009
server_config = configparser.ConfigParser(server_defaults)
2039
server_config = configparser.SafeConfigParser(server_defaults)
3010
2040
del server_defaults
3011
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3012
# Convert the ConfigParser object to a dict
2041
server_config.read(os.path.join(options.configdir,
2043
# Convert the SafeConfigParser object to a dict
3013
2044
server_settings = server_config.defaults()
3014
2045
# Use the appropriate methods on the non-string config options
3015
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3016
"foreground", "zeroconf"):
2046
for option in ("debug", "use_dbus", "use_ipv6"):
3017
2047
server_settings[option] = server_config.getboolean("DEFAULT",
3019
2049
if server_settings["port"]:
3020
2050
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
3031
2052
del server_config
3033
2054
# Override the settings from the config file with command line
3034
2055
# options, if set.
3035
2056
for option in ("interface", "address", "port", "debug",
3036
"priority", "servicename", "configdir", "use_dbus",
3037
"use_ipv6", "debuglevel", "restore", "statedir",
3038
"socket", "foreground", "zeroconf"):
2057
"priority", "servicename", "configdir",
2058
"use_dbus", "use_ipv6", "debuglevel", "restore",
3039
2060
value = getattr(options, option)
3040
2061
if value is not None:
3041
2062
server_settings[option] = value
3043
2064
# Force all strings to be unicode
3044
2065
for option in server_settings.keys():
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
2066
if type(server_settings[option]) is str:
2067
server_settings[option] = unicode(server_settings[option])
3055
2068
# Now we have our good server settings in "server_settings"
3057
2070
##################################################################
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")
3064
2072
# For convenience
3065
2073
debug = server_settings["debug"]
3066
2074
debuglevel = server_settings["debuglevel"]
3068
2076
use_ipv6 = server_settings["use_ipv6"]
3069
2077
stored_state_path = os.path.join(server_settings["statedir"],
3070
2078
stored_state_file)
3071
foreground = server_settings["foreground"]
3072
zeroconf = server_settings["zeroconf"]
3075
initlogger(debug, logging.DEBUG)
2081
initlogger(logging.DEBUG)
3077
2083
if not debuglevel:
3080
2086
level = getattr(logging, debuglevel.upper())
3081
initlogger(debug, level)
3083
2089
if server_settings["servicename"] != "Mandos":
3084
syslogger.setFormatter(
3085
logging.Formatter('Mandos ({}) [%(process)d]:'
3086
' %(levelname)s: %(message)s'.format(
3087
server_settings["servicename"])))
2090
syslogger.setFormatter(logging.Formatter
2091
('Mandos (%s) [%%(process)d]:'
2092
' %%(levelname)s: %%(message)s'
2093
% server_settings["servicename"]))
3089
2095
# Parse config file with clients
3090
client_config = configparser.ConfigParser(Client.client_defaults)
2096
client_config = configparser.SafeConfigParser(Client.client_defaults)
3091
2097
client_config.read(os.path.join(server_settings["configdir"],
3092
2098
"clients.conf"))
3094
2100
global mandos_dbus_service
3095
2101
mandos_dbus_service = None
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
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
3126
2126
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,
3137
2136
except OSError as error:
3138
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3139
.format(uid, gid, os.strerror(error.errno)))
3140
if error.errno != errno.EPERM:
2137
if error[0] != errno.EPERM:
3144
2141
# Enable all possible GnuTLS debugging
3146
2143
# "Use a log level over 10 to enable all debugging options."
3147
2144
# - GnuTLS manual
3148
gnutls.global_set_log_level(11)
2145
gnutls.library.functions.gnutls_global_set_log_level(11)
2147
@gnutls.library.types.gnutls_log_func
3151
2148
def debug_gnutls(level, string):
3152
2149
logger.debug("GnuTLS: %s", string[:-1])
3154
gnutls.global_set_log_function(debug_gnutls)
2151
(gnutls.library.functions
2152
.gnutls_global_set_log_function(debug_gnutls))
3156
2154
# Redirect stdin so all checkers get /dev/null
3157
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2155
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3158
2156
os.dup2(null, sys.stdin.fileno())
2160
# No console logging
2161
logger.removeHandler(console)
3162
2163
# Need to fork before connecting to D-Bus
3164
2165
# 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.
3172
2168
global main_loop
3173
2169
# From the Avahi example code
3174
DBusGMainLoop(set_as_default=True)
3175
main_loop = GLib.MainLoop()
2170
DBusGMainLoop(set_as_default=True )
2171
main_loop = gobject.MainLoop()
3176
2172
bus = dbus.SystemBus()
3177
2173
# End of Avahi example code
3180
2176
bus_name = dbus.service.BusName("se.recompile.Mandos",
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)
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")
3188
2183
use_dbus = False
3189
2184
server_settings["use_dbus"] = False
3190
2185
tcp_server.use_dbus = False
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"))
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"])))
3202
2195
global multiprocessing_manager
3203
2196
multiprocessing_manager = multiprocessing.Manager()
3205
2198
client_class = Client
3207
client_class = functools.partial(ClientDBus, bus=bus)
2200
client_class = functools.partial(ClientDBusTransitional,
3209
2203
client_settings = Client.config_parser(client_config)
3210
2204
old_client_settings = {}
3211
2205
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:
3221
2207
# Get client data and settings from last running state.
3222
2208
if server_settings["restore"]:
3224
2210
with open(stored_state_path, "rb") as stored_state:
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]
2211
clients_data, old_client_settings = (pickle.load
3275
2213
os.remove(stored_state_path)
3276
2214
except IOError as e:
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:",
2215
logger.warning("Could not load persistent state: {0}"
2217
if e.errno != errno.ENOENT:
3284
except EOFError as e:
3285
logger.warning("Could not load persistent state: "
3289
2220
with PGPEngine() as pgp:
3290
for client_name, client in clients_data.items():
3291
# Skip removed clients
3292
if client_name not in client_settings:
2221
for client_name, client in clients_data.iteritems():
3295
2222
# Decide which value to use after restoring saved state.
3296
2223
# We have three different values: Old config file,
3297
2224
# new config file, and saved state.
3302
2229
# For each value in new config, check if it
3303
2230
# differs from the old config value (Except for
3304
2231
# the "secret" attribute)
3305
if (name != "secret"
3307
old_client_settings[client_name][name])):
2232
if (name != "secret" and
2233
value != old_client_settings[client_name]
3308
2235
client[name] = value
3309
2236
except KeyError:
3312
2239
# Clients who has passed its expire date can still be
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
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.
3317
2243
if client["enabled"]:
3318
2244
if datetime.datetime.utcnow() >= client["expires"]:
3319
2245
if not client["last_checked_ok"]:
3320
2246
logger.warning(
3321
"disabling client {} - Client never "
3322
"performed a successful checker".format(
2247
"disabling client {0} - Client never "
2248
"performed a successfull checker"
2249
.format(client["name"]))
3324
2250
client["enabled"] = False
3325
2251
elif client["last_checker_status"] != 0:
3326
2252
logger.warning(
3327
"disabling client {} - Client last"
3328
" checker failed with error code"
3331
client["last_checker_status"]))
2253
"disabling client {0} - Client "
2254
"last checker failed with error code {1}"
2255
.format(client["name"],
2256
client["last_checker_status"]))
3332
2257
client["enabled"] = False
3334
client["expires"] = (
3335
datetime.datetime.utcnow()
3336
+ client["timeout"])
3337
logger.debug("Last checker succeeded,"
3338
" keeping {} enabled".format(
2259
client["expires"] = (datetime.datetime
2261
+ client["timeout"])
3341
client["secret"] = pgp.decrypt(
3342
client["encrypted_secret"],
3343
client_settings[client_name]["secret"])
2264
client["secret"] = (
2265
pgp.decrypt(client["encrypted_secret"],
2266
client_settings[client_name]
3344
2268
except PGPError:
3345
2269
# If decryption fails, we use secret from new settings
3346
logger.debug("Failed to decrypt {} old secret".format(
3348
client["secret"] = (client_settings[client_name]
2270
logger.debug("Failed to decrypt {0} old secret"
2271
.format(client_name))
2272
client["secret"] = (
2273
client_settings[client_name]["secret"])
3351
2276
# Add/remove clients based on new changes made to config
3352
for client_name in (set(old_client_settings)
3353
- set(client_settings)):
2277
for client_name in set(old_client_settings) - set(client_settings):
3354
2278
del clients_data[client_name]
3355
for client_name in (set(client_settings)
3356
- set(old_client_settings)):
2279
for client_name in set(client_settings) - set(old_client_settings):
3357
2280
clients_data[client_name] = client_settings[client_name]
3359
# Create all client objects
3360
for client_name, client in clients_data.items():
2282
# Create clients all clients
2283
for client_name, client in clients_data.iteritems():
3361
2284
tcp_server.clients[client_name] = client_class(
3364
server_settings=server_settings)
2285
name = client_name, settings = client)
3366
2287
if not tcp_server.clients:
3367
2288
logger.warning("No clients defined")
3370
if pidfile is not None:
3374
print(pid, file=pidfile)
3376
logger.error("Could not write to file %r with PID %d",
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
3379
2302
del pidfilename
3381
for termsig in (signal.SIGHUP, signal.SIGTERM):
3382
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3383
lambda: main_loop.quit() and False)
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())
3387
@alternate_dbus_interfaces(
3388
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3389
class MandosDBusService(DBusObjectWithObjectManager):
2309
class MandosDBusService(dbus.service.Object):
3390
2310
"""A D-Bus proxy object"""
3392
2311
def __init__(self):
3393
2312
dbus.service.Object.__init__(self, bus, "/")
3395
2313
_interface = "se.recompile.Mandos"
3397
2315
@dbus.service.signal(_interface, signature="o")
3398
2316
def ClientAdded(self, objpath):
3402
2320
@dbus.service.signal(_interface, signature="ss")
3403
def ClientNotFound(self, key_id, address):
2321
def ClientNotFound(self, fingerprint, address):
3407
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3409
2325
@dbus.service.signal(_interface, signature="os")
3410
2326
def ClientRemoved(self, objpath, name):
3414
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3416
2330
@dbus.service.method(_interface, out_signature="ao")
3417
2331
def GetAllClients(self):
3419
return dbus.Array(c.dbus_object_path for c in
3420
tcp_server.clients.values())
3422
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2333
return dbus.Array(c.dbus_object_path
2335
tcp_server.clients.itervalues())
3424
2337
@dbus.service.method(_interface,
3425
2338
out_signature="a{oa{sv}}")
3426
2339
def GetAllClientsWithProperties(self):
3428
2341
return dbus.Dictionary(
3429
{c.dbus_object_path: c.GetAll(
3430
"se.recompile.Mandos.Client")
3431
for c in tcp_server.clients.values()},
2342
((c.dbus_object_path, c.GetAll(""))
2343
for c in tcp_server.clients.itervalues()),
3432
2344
signature="oa{sv}")
3434
2346
@dbus.service.method(_interface, in_signature="o")
3435
2347
def RemoveClient(self, object_path):
3437
for c in tcp_server.clients.values():
2349
for c in tcp_server.clients.itervalues():
3438
2350
if c.dbus_object_path == object_path:
3439
2351
del tcp_server.clients[c.name]
3440
2352
c.remove_from_connection()
3441
# Don't signal the disabling
2353
# Don't signal anything except ClientRemoved
3442
2354
c.disable(quiet=True)
3443
# Emit D-Bus signal for removal
3444
self.client_removed_signal(c)
2356
self.ClientRemoved(object_path, c.name)
3446
2358
raise KeyError(object_path)
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
2362
class MandosDBusServiceTransitional(MandosDBusService):
2363
__metaclass__ = AlternateDBusNamesMetaclass
2364
mandos_dbus_service = MandosDBusServiceTransitional()
3494
2367
"Cleanup function; run on exit"
3498
mp.active_children()
2370
multiprocessing.active_children()
3500
2371
if not (tcp_server.clients or client_settings):
3503
2374
# Store client before exiting. Secrets are encrypted with key
3504
2375
# based on what config file has. If config file is
3505
2376
# removed/edited, old secret will thus be unrecovable.
3507
2378
with PGPEngine() as pgp:
3508
for client in tcp_server.clients.values():
2379
for client in tcp_server.clients.itervalues():
3509
2380
key = client_settings[client.name]["secret"]
3510
2381
client.encrypted_secret = pgp.encrypt(client.secret,
3512
2383
client_dict = {}
3514
2385
# A list of attributes that can not be pickled
3516
exclude = {"bus", "changedstate", "secret",
3517
"checker", "server_settings"}
3518
for name, typ in inspect.getmembers(dbus.service
2387
exclude = set(("bus", "changedstate", "secret",
2389
for name, typ in (inspect.getmembers
2390
(dbus.service.Object)):
3520
2391
exclude.add(name)
3522
2393
client_dict["encrypted_secret"] = (client
3523
2394
.encrypted_secret)
3524
2395
for attr in client.client_structure:
3525
2396
if attr not in exclude:
3526
2397
client_dict[attr] = getattr(client, attr)
3528
2399
clients[client.name] = client_dict
3529
2400
del client_settings[client.name]["secret"]
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)
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)
3542
2407
except (IOError, OSError) as e:
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:",
2408
logger.warning("Could not save persistent state: {0}"
2410
if e.errno not in (errno.ENOENT, errno.EACCES):
3556
2413
# Delete all clients, and settings from config
3557
2414
while tcp_server.clients:
3558
2415
name, client = tcp_server.clients.popitem()
3560
2417
client.remove_from_connection()
3561
# Don't signal the disabling
2418
# Don't signal anything except ClientRemoved
3562
2419
client.disable(quiet=True)
3563
# Emit D-Bus signal for removal
3565
mandos_dbus_service.client_removed_signal(client)
2422
mandos_dbus_service.ClientRemoved(client
3566
2425
client_settings.clear()
3568
2427
atexit.register(cleanup)
3570
for client in tcp_server.clients.values():
2429
for client in tcp_server.clients.itervalues():
3572
# Emit D-Bus signal for adding
3573
mandos_dbus_service.client_added_signal(client)
2432
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3574
2433
# Need to initiate checking of clients
3575
2434
if client.enabled:
3576
2435
client.init_checker()
3578
2437
tcp_server.enable()
3579
2438
tcp_server.server_activate()
3581
2440
# Find out what port we got
3583
service.port = tcp_server.socket.getsockname()[1]
2441
service.port = tcp_server.socket.getsockname()[1]
3585
2443
logger.info("Now listening on address %r, port %d,"
3586
" flowinfo %d, scope_id %d",
3587
*tcp_server.socket.getsockname())
2444
" flowinfo %d, scope_id %d"
2445
% tcp_server.socket.getsockname())
3589
logger.info("Now listening on address %r, port %d",
3590
*tcp_server.socket.getsockname())
3592
# service.interface = tcp_server.socket.getsockname()[3]
2447
logger.info("Now listening on address %r, port %d"
2448
% tcp_server.socket.getsockname())
2450
#service.interface = tcp_server.socket.getsockname()[3]
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))
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))
3611
2467
logger.debug("Starting main loop")
3612
2468
main_loop.run()
3613
2469
except AvahiError as error:
3614
logger.critical("Avahi Error", exc_info=error)
2470
logger.critical("AvahiError: %s", error)
3617
2473
except KeyboardInterrupt: