360
99
max_renames: integer; maximum number of renames
361
100
rename_count: integer; counter so we only rename after collisions
362
101
a sensible number of times
363
group: D-Bus Entry Group
365
bus: dbus.SystemBus()
369
interface=avahi.IF_UNSPEC,
377
protocol=avahi.PROTO_UNSPEC,
103
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
104
type = None, port = None, TXT = None, domain = "",
105
host = "", max_renames = 32768):
379
106
self.interface = interface
381
self.type = servicetype
383
self.TXT = TXT if TXT is not None else []
384
114
self.domain = domain
386
116
self.rename_count = 0
387
self.max_renames = max_renames
388
self.protocol = protocol
389
self.group = None # our entry group
392
self.entry_group_state_changed_match = None
394
def rename(self, remove=True):
395
118
"""Derived from the Avahi example code"""
396
119
if self.rename_count >= self.max_renames:
397
logger.critical("No suitable Zeroconf service name found"
398
" after %i retries, exiting.",
120
logger.critical(u"No suitable service name found after %i"
121
u" retries, exiting.", rename_count)
400
122
raise AvahiServiceError("Too many renames")
402
self.server.GetAlternativeServiceName(self.name))
123
name = server.GetAlternativeServiceName(name)
124
logger.error(u"Changing name to %r ...", name)
125
syslogger.setFormatter(logging.Formatter\
126
('Mandos (%s): %%(levelname)s:'
127
' %%(message)s' % name))
403
130
self.rename_count += 1
404
logger.info("Changing Zeroconf service name to %r ...",
410
except dbus.exceptions.DBusException as error:
411
if (error.get_dbus_name()
412
== "org.freedesktop.Avahi.CollisionError"):
413
logger.info("Local Zeroconf service name collision.")
414
return self.rename(remove=False)
416
logger.critical("D-Bus Exception", exc_info=error)
420
131
def remove(self):
421
132
"""Derived from the Avahi example code"""
422
if self.entry_group_state_changed_match is not None:
423
self.entry_group_state_changed_match.remove()
424
self.entry_group_state_changed_match = None
425
if self.group is not None:
133
if group is not None:
429
136
"""Derived from the Avahi example code"""
431
if self.group is None:
432
self.group = dbus.Interface(
433
self.bus.get_object(avahi.DBUS_NAME,
434
self.server.EntryGroupNew()),
435
avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
self.entry_group_state_changed_match = (
437
self.group.connect_to_signal(
438
'StateChanged', self.entry_group_state_changed))
439
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
440
self.name, self.type)
441
self.group.AddService(
444
dbus.UInt32(0), # flags
445
self.name, self.type,
446
self.domain, self.host,
447
dbus.UInt16(self.port),
448
avahi.string_array_to_txt_array(self.TXT))
451
def entry_group_state_changed(self, state, error):
452
"""Derived from the Avahi example code"""
453
logger.debug("Avahi entry group state change: %i", state)
455
if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
logger.debug("Zeroconf service established.")
457
elif state == avahi.ENTRY_GROUP_COLLISION:
458
logger.info("Zeroconf service name collision.")
460
elif state == avahi.ENTRY_GROUP_FAILURE:
461
logger.critical("Avahi: Error in group state changed %s",
463
raise AvahiGroupError("State changed: {!s}".format(error))
466
"""Derived from the Avahi example code"""
467
if self.group is not None:
470
except (dbus.exceptions.UnknownMethodException,
471
dbus.exceptions.DBusException):
476
def server_state_changed(self, state, error=None):
477
"""Derived from the Avahi example code"""
478
logger.debug("Avahi server state change: %i", state)
480
avahi.SERVER_INVALID: "Zeroconf server invalid",
481
avahi.SERVER_REGISTERING: None,
482
avahi.SERVER_COLLISION: "Zeroconf server name collision",
483
avahi.SERVER_FAILURE: "Zeroconf server failure",
485
if state in bad_states:
486
if bad_states[state] is not None:
488
logger.error(bad_states[state])
490
logger.error(bad_states[state] + ": %r", error)
492
elif state == avahi.SERVER_RUNNING:
495
except dbus.exceptions.DBusException as error:
496
if (error.get_dbus_name()
497
== "org.freedesktop.Avahi.CollisionError"):
498
logger.info("Local Zeroconf service name"
500
return self.rename(remove=False)
502
logger.critical("D-Bus Exception", exc_info=error)
507
logger.debug("Unknown state: %r", state)
509
logger.debug("Unknown state: %r: %r", state, error)
512
"""Derived from the Avahi example code"""
513
if self.server is None:
514
self.server = dbus.Interface(
515
self.bus.get_object(avahi.DBUS_NAME,
516
avahi.DBUS_PATH_SERVER,
517
follow_name_owner_changes=True),
518
avahi.DBUS_INTERFACE_SERVER)
519
self.server.connect_to_signal("StateChanged",
520
self.server_state_changed)
521
self.server_state_changed(self.server.GetState())
524
class AvahiServiceToSyslog(AvahiService):
525
def rename(self, *args, **kwargs):
526
"""Add the new name to the syslog messages"""
527
ret = super(AvahiServiceToSyslog, self).rename(*args,
529
syslogger.setFormatter(logging.Formatter(
530
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
535
# Pretend that we have a GnuTLS module
537
"""This isn't so much a class as it is a module-like namespace."""
539
library = ctypes.util.find_library("gnutls")
541
library = ctypes.util.find_library("gnutls-deb0")
542
_library = ctypes.cdll.LoadLibrary(library)
545
# Unless otherwise indicated, the constants and types below are
546
# all from the gnutls/gnutls.h C header file.
557
E_NO_CERTIFICATE_FOUND = -49
562
KEYID_USE_SHA256 = 1 # gnutls/x509.h
563
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
566
class _session_int(ctypes.Structure):
568
session_t = ctypes.POINTER(_session_int)
570
class certificate_credentials_st(ctypes.Structure):
572
certificate_credentials_t = ctypes.POINTER(
573
certificate_credentials_st)
574
certificate_type_t = ctypes.c_int
576
class datum_t(ctypes.Structure):
577
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
578
('size', ctypes.c_uint)]
580
class _openpgp_crt_int(ctypes.Structure):
582
openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
583
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
584
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
585
credentials_type_t = ctypes.c_int
586
transport_ptr_t = ctypes.c_void_p
587
close_request_t = ctypes.c_int
590
class Error(Exception):
591
def __init__(self, message=None, code=None, args=()):
592
# Default usage is by a message string, but if a return
593
# code is passed, convert it to a string with
596
if message is None and code is not None:
597
message = gnutls.strerror(code).decode(
598
"utf-8", errors="replace")
599
return super(gnutls.Error, self).__init__(
602
class CertificateSecurityError(Error):
606
def __init__(self, cls):
609
def from_param(self, obj):
610
if not isinstance(obj, self.cls):
611
raise TypeError("Not of type {}: {!r}"
612
.format(self.cls.__name__, obj))
613
return ctypes.byref(obj.from_param(obj))
615
class CastToVoidPointer:
616
def __init__(self, cls):
619
def from_param(self, obj):
620
if not isinstance(obj, self.cls):
621
raise TypeError("Not of type {}: {!r}"
622
.format(self.cls.__name__, obj))
623
return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
625
class With_from_param:
627
def from_param(cls, obj):
628
return obj._as_parameter_
631
class Credentials(With_from_param):
633
self._as_parameter_ = gnutls.certificate_credentials_t()
634
gnutls.certificate_allocate_credentials(self)
635
self.type = gnutls.CRD_CERTIFICATE
638
gnutls.certificate_free_credentials(self)
640
class ClientSession(With_from_param):
641
def __init__(self, socket, credentials=None):
642
self._as_parameter_ = gnutls.session_t()
643
gnutls_flags = gnutls.CLIENT
644
if gnutls.check_version(b"3.5.6"):
645
gnutls_flags |= gnutls.NO_TICKETS
647
gnutls_flags |= gnutls.ENABLE_RAWPK
648
gnutls.init(self, gnutls_flags)
650
gnutls.set_default_priority(self)
651
gnutls.transport_set_ptr(self, socket.fileno())
652
gnutls.handshake_set_private_extensions(self, True)
654
if credentials is None:
655
credentials = gnutls.Credentials()
656
gnutls.credentials_set(self, credentials.type,
658
self.credentials = credentials
664
return gnutls.handshake(self)
666
def send(self, data):
670
data_len -= gnutls.record_send(self, data[-data_len:],
674
return gnutls.bye(self, gnutls.SHUT_RDWR)
676
# Error handling functions
677
def _error_code(result):
678
"""A function to raise exceptions on errors, suitable
679
for the 'restype' attribute on ctypes functions"""
680
if result >= gnutls.E_SUCCESS:
682
if result == gnutls.E_NO_CERTIFICATE_FOUND:
683
raise gnutls.CertificateSecurityError(code=result)
684
raise gnutls.Error(code=result)
686
def _retry_on_error(result, func, arguments,
687
_error_code=_error_code):
688
"""A function to retry on some errors, suitable
689
for the 'errcheck' attribute on ctypes functions"""
690
while result < gnutls.E_SUCCESS:
691
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
692
return _error_code(result)
693
result = func(*arguments)
696
# Unless otherwise indicated, the function declarations below are
697
# all from the gnutls/gnutls.h C header file.
700
priority_set_direct = _library.gnutls_priority_set_direct
701
priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
702
ctypes.POINTER(ctypes.c_char_p)]
703
priority_set_direct.restype = _error_code
705
init = _library.gnutls_init
706
init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
707
init.restype = _error_code
709
set_default_priority = _library.gnutls_set_default_priority
710
set_default_priority.argtypes = [ClientSession]
711
set_default_priority.restype = _error_code
713
record_send = _library.gnutls_record_send
714
record_send.argtypes = [ClientSession, ctypes.c_void_p,
716
record_send.restype = ctypes.c_ssize_t
717
record_send.errcheck = _retry_on_error
719
certificate_allocate_credentials = (
720
_library.gnutls_certificate_allocate_credentials)
721
certificate_allocate_credentials.argtypes = [
722
PointerTo(Credentials)]
723
certificate_allocate_credentials.restype = _error_code
725
certificate_free_credentials = (
726
_library.gnutls_certificate_free_credentials)
727
certificate_free_credentials.argtypes = [Credentials]
728
certificate_free_credentials.restype = None
730
handshake_set_private_extensions = (
731
_library.gnutls_handshake_set_private_extensions)
732
handshake_set_private_extensions.argtypes = [ClientSession,
734
handshake_set_private_extensions.restype = None
736
credentials_set = _library.gnutls_credentials_set
737
credentials_set.argtypes = [ClientSession, credentials_type_t,
738
CastToVoidPointer(Credentials)]
739
credentials_set.restype = _error_code
741
strerror = _library.gnutls_strerror
742
strerror.argtypes = [ctypes.c_int]
743
strerror.restype = ctypes.c_char_p
745
certificate_type_get = _library.gnutls_certificate_type_get
746
certificate_type_get.argtypes = [ClientSession]
747
certificate_type_get.restype = _error_code
749
certificate_get_peers = _library.gnutls_certificate_get_peers
750
certificate_get_peers.argtypes = [ClientSession,
751
ctypes.POINTER(ctypes.c_uint)]
752
certificate_get_peers.restype = ctypes.POINTER(datum_t)
754
global_set_log_level = _library.gnutls_global_set_log_level
755
global_set_log_level.argtypes = [ctypes.c_int]
756
global_set_log_level.restype = None
758
global_set_log_function = _library.gnutls_global_set_log_function
759
global_set_log_function.argtypes = [log_func]
760
global_set_log_function.restype = None
762
deinit = _library.gnutls_deinit
763
deinit.argtypes = [ClientSession]
764
deinit.restype = None
766
handshake = _library.gnutls_handshake
767
handshake.argtypes = [ClientSession]
768
handshake.restype = ctypes.c_int
769
handshake.errcheck = _retry_on_error
771
transport_set_ptr = _library.gnutls_transport_set_ptr
772
transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
773
transport_set_ptr.restype = None
775
bye = _library.gnutls_bye
776
bye.argtypes = [ClientSession, close_request_t]
777
bye.restype = ctypes.c_int
778
bye.errcheck = _retry_on_error
780
check_version = _library.gnutls_check_version
781
check_version.argtypes = [ctypes.c_char_p]
782
check_version.restype = ctypes.c_char_p
784
_need_version = b"3.3.0"
785
if check_version(_need_version) is None:
786
raise self.Error("Needs GnuTLS {} or later"
787
.format(_need_version))
789
_tls_rawpk_version = b"3.6.6"
790
has_rawpk = bool(check_version(_tls_rawpk_version))
794
class pubkey_st(ctypes.Structure):
796
pubkey_t = ctypes.POINTER(pubkey_st)
798
x509_crt_fmt_t = ctypes.c_int
800
# All the function declarations below are from
802
pubkey_init = _library.gnutls_pubkey_init
803
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
804
pubkey_init.restype = _error_code
806
pubkey_import = _library.gnutls_pubkey_import
807
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
809
pubkey_import.restype = _error_code
811
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
812
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
813
ctypes.POINTER(ctypes.c_ubyte),
814
ctypes.POINTER(ctypes.c_size_t)]
815
pubkey_get_key_id.restype = _error_code
817
pubkey_deinit = _library.gnutls_pubkey_deinit
818
pubkey_deinit.argtypes = [pubkey_t]
819
pubkey_deinit.restype = None
821
# All the function declarations below are from
824
openpgp_crt_init = _library.gnutls_openpgp_crt_init
825
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
826
openpgp_crt_init.restype = _error_code
828
openpgp_crt_import = _library.gnutls_openpgp_crt_import
829
openpgp_crt_import.argtypes = [openpgp_crt_t,
830
ctypes.POINTER(datum_t),
832
openpgp_crt_import.restype = _error_code
834
openpgp_crt_verify_self = \
835
_library.gnutls_openpgp_crt_verify_self
836
openpgp_crt_verify_self.argtypes = [
839
ctypes.POINTER(ctypes.c_uint),
841
openpgp_crt_verify_self.restype = _error_code
843
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
844
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
845
openpgp_crt_deinit.restype = None
847
openpgp_crt_get_fingerprint = (
848
_library.gnutls_openpgp_crt_get_fingerprint)
849
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
853
openpgp_crt_get_fingerprint.restype = _error_code
855
if check_version(b"3.6.4"):
856
certificate_type_get2 = _library.gnutls_certificate_type_get2
857
certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
858
certificate_type_get2.restype = _error_code
860
# Remove non-public functions
861
del _error_code, _retry_on_error
864
def call_pipe(connection, # : multiprocessing.Connection
865
func, *args, **kwargs):
866
"""This function is meant to be called by multiprocessing.Process
868
This function runs func(*args, **kwargs), and writes the resulting
869
return value on the provided multiprocessing.Connection.
871
connection.send(func(*args, **kwargs))
139
group = dbus.Interface\
140
(bus.get_object(avahi.DBUS_NAME,
141
server.EntryGroupNew()),
142
avahi.DBUS_INTERFACE_ENTRY_GROUP)
143
group.connect_to_signal('StateChanged',
144
entry_group_state_changed)
145
logger.debug(u"Adding service '%s' of type '%s' ...",
146
service.name, service.type)
148
self.interface, # interface
149
avahi.PROTO_INET6, # protocol
150
dbus.UInt32(0), # flags
151
self.name, self.type,
152
self.domain, self.host,
153
dbus.UInt16(self.port),
154
avahi.string_array_to_txt_array(self.TXT))
157
# From the Avahi example code:
158
group = None # our entry group
159
# End of Avahi example code
162
class Client(object):
876
163
"""A representation of a client host served by this server.
879
approved: bool(); 'None' if not yet approved/disapproved
880
approval_delay: datetime.timedelta(); Time to wait for approval
881
approval_duration: datetime.timedelta(); Duration of one approval
882
checker: multiprocessing.Process(); a running checker process used
883
to see if the client lives. 'None' if no process is
885
checker_callback_tag: a GLib event source tag, or None
886
checker_command: string; External command which is run to check
887
if client lives. %() expansions are done at
165
name: string; from the config file, used in log messages
166
fingerprint: string (40 or 32 hexadecimal digits); used to
167
uniquely identify the client
168
secret: bytestring; sent verbatim (over TLS) to client
169
host: string; available for use by the checker command
170
created: datetime.datetime(); object creation, not client host
171
last_checked_ok: datetime.datetime() or None if not yet checked OK
172
timeout: datetime.timedelta(); How long from last_checked_ok
173
until this client is invalid
174
interval: datetime.timedelta(); How often to start a new checker
175
stop_hook: If set, called by stop() as stop_hook(self)
176
checker: subprocess.Popen(); a running checker process used
177
to see if the client lives.
178
'None' if no process is running.
179
checker_initiator_tag: a gobject event source tag, or None
180
stop_initiator_tag: - '' -
181
checker_callback_tag: - '' -
182
checker_command: string; External command which is run to check if
183
client lives. %() expansions are done at
888
184
runtime with vars(self) as dict, so that for
889
185
instance %(name)s can be used in the command.
890
checker_initiator_tag: a GLib event source tag, or None
891
created: datetime.datetime(); (UTC) object creation
892
client_structure: Object describing what attributes a client has
893
and is used for storing the client at exit
894
current_checker_command: string; current running checker_command
895
disable_initiator_tag: a GLib event source tag, or None
897
fingerprint: string (40 or 32 hexadecimal digits); used to
898
uniquely identify an OpenPGP client
899
key_id: string (64 hexadecimal digits); used to uniquely identify
900
a client using raw public keys
901
host: string; available for use by the checker command
902
interval: datetime.timedelta(); How often to start a new checker
903
last_approval_request: datetime.datetime(); (UTC) or None
904
last_checked_ok: datetime.datetime(); (UTC) or None
905
last_checker_status: integer between 0 and 255 reflecting exit
906
status of last checker. -1 reflects crashed
907
checker, -2 means no checker completed yet.
908
last_checker_signal: The signal which killed the last checker, if
909
last_checker_status is -1
910
last_enabled: datetime.datetime(); (UTC) or None
911
name: string; from the config file, used in log messages and
913
secret: bytestring; sent verbatim (over TLS) to client
914
timeout: datetime.timedelta(); How long from last_checked_ok
915
until this client is disabled
916
extended_timeout: extra long timeout when secret has been sent
917
runtime_expansions: Allowed attributes for runtime expansion.
918
expires: datetime.datetime(); time (UTC) when a client will be
920
server_settings: The server_settings dict from main()
187
_timeout: Real variable for 'timeout'
188
_interval: Real variable for 'interval'
189
_timeout_milliseconds: Used when calling gobject.timeout_add()
190
_interval_milliseconds: - '' -
923
runtime_expansions = ("approval_delay", "approval_duration",
924
"created", "enabled", "expires", "key_id",
925
"fingerprint", "host", "interval",
926
"last_approval_request", "last_checked_ok",
927
"last_enabled", "name", "timeout")
930
"extended_timeout": "PT15M",
932
"checker": "fping -q -- %%(host)s",
934
"approval_delay": "PT0S",
935
"approval_duration": "PT1S",
936
"approved_by_default": "True",
941
def config_parser(config):
942
"""Construct a new dict of client settings of this form:
943
{ client_name: {setting_name: value, ...}, ...}
944
with exceptions for any special settings as defined above.
945
NOTE: Must be a pure function. Must return the same result
946
value given the same arguments.
949
for client_name in config.sections():
950
section = dict(config.items(client_name))
951
client = settings[client_name] = {}
953
client["host"] = section["host"]
954
# Reformat values from string types to Python types
955
client["approved_by_default"] = config.getboolean(
956
client_name, "approved_by_default")
957
client["enabled"] = config.getboolean(client_name,
960
# Uppercase and remove spaces from key_id and fingerprint
961
# for later comparison purposes with return value from the
962
# key_id() and fingerprint() functions
963
client["key_id"] = (section.get("key_id", "").upper()
965
client["fingerprint"] = (section["fingerprint"].upper()
967
if "secret" in section:
968
client["secret"] = codecs.decode(section["secret"]
971
elif "secfile" in section:
972
with open(os.path.expanduser(os.path.expandvars
973
(section["secfile"])),
975
client["secret"] = secfile.read()
977
raise TypeError("No secret or secfile for section {}"
979
client["timeout"] = string_to_delta(section["timeout"])
980
client["extended_timeout"] = string_to_delta(
981
section["extended_timeout"])
982
client["interval"] = string_to_delta(section["interval"])
983
client["approval_delay"] = string_to_delta(
984
section["approval_delay"])
985
client["approval_duration"] = string_to_delta(
986
section["approval_duration"])
987
client["checker_command"] = section["checker"]
988
client["last_approval_request"] = None
989
client["last_checked_ok"] = None
990
client["last_checker_status"] = -2
994
def __init__(self, settings, name=None, server_settings=None):
192
def _set_timeout(self, timeout):
193
"Setter function for 'timeout' attribute"
194
self._timeout = timeout
195
self._timeout_milliseconds = ((self.timeout.days
196
* 24 * 60 * 60 * 1000)
197
+ (self.timeout.seconds * 1000)
198
+ (self.timeout.microseconds
200
timeout = property(lambda self: self._timeout,
203
def _set_interval(self, interval):
204
"Setter function for 'interval' attribute"
205
self._interval = interval
206
self._interval_milliseconds = ((self.interval.days
207
* 24 * 60 * 60 * 1000)
208
+ (self.interval.seconds
210
+ (self.interval.microseconds
212
interval = property(lambda self: self._interval,
215
def __init__(self, name = None, stop_hook=None, config={}):
216
"""Note: the 'checker' key in 'config' sets the
217
'checker_command' attribute and *not* the 'checker'
996
if server_settings is None:
998
self.server_settings = server_settings
999
# adding all client settings
1000
for setting, value in settings.items():
1001
setattr(self, setting, value)
1004
if not hasattr(self, "last_enabled"):
1005
self.last_enabled = datetime.datetime.utcnow()
1006
if not hasattr(self, "expires"):
1007
self.expires = (datetime.datetime.utcnow()
220
logger.debug(u"Creating client %r", self.name)
221
# Uppercase and remove spaces from fingerprint for later
222
# comparison purposes with return value from the fingerprint()
224
self.fingerprint = config["fingerprint"].upper()\
226
logger.debug(u" Fingerprint: %s", self.fingerprint)
227
if "secret" in config:
228
self.secret = config["secret"].decode(u"base64")
229
elif "secfile" in config:
230
sf = open(config["secfile"])
231
self.secret = sf.read()
1010
self.last_enabled = None
1013
logger.debug("Creating client %r", self.name)
1014
logger.debug(" Key ID: %s", self.key_id)
1015
logger.debug(" Fingerprint: %s", self.fingerprint)
1016
self.created = settings.get("created",
1017
datetime.datetime.utcnow())
1019
# attributes specific for this server instance
234
raise TypeError(u"No secret or secfile for client %s"
236
self.host = config.get("host", "")
237
self.created = datetime.datetime.now()
238
self.last_checked_ok = None
239
self.timeout = string_to_delta(config["timeout"])
240
self.interval = string_to_delta(config["interval"])
241
self.stop_hook = stop_hook
1020
242
self.checker = None
1021
243
self.checker_initiator_tag = None
1022
self.disable_initiator_tag = None
244
self.stop_initiator_tag = None
1023
245
self.checker_callback_tag = None
1024
self.current_checker_command = None
1025
self.approved = None
1026
self.approvals_pending = 0
1027
self.changedstate = multiprocessing_manager.Condition(
1028
multiprocessing_manager.Lock())
1029
self.client_structure = [attr
1030
for attr in self.__dict__.keys()
1031
if not attr.startswith("_")]
1032
self.client_structure.append("client_structure")
1034
for name, t in inspect.getmembers(
1035
type(self), lambda obj: isinstance(obj, property)):
1036
if not name.startswith("_"):
1037
self.client_structure.append(name)
1039
# Send notice to process children that client state has changed
1040
def send_changedstate(self):
1041
with self.changedstate:
1042
self.changedstate.notify_all()
246
self.check_command = config["checker"]
1045
248
"""Start this client's checker and timeout hooks"""
1046
if getattr(self, "enabled", False):
1049
self.expires = datetime.datetime.utcnow() + self.timeout
1051
self.last_enabled = datetime.datetime.utcnow()
1053
self.send_changedstate()
1055
def disable(self, quiet=True):
1056
"""Disable this client."""
1057
if not getattr(self, "enabled", False):
1060
logger.info("Disabling client %s", self.name)
1061
if getattr(self, "disable_initiator_tag", None) is not None:
1062
GLib.source_remove(self.disable_initiator_tag)
1063
self.disable_initiator_tag = None
1065
if getattr(self, "checker_initiator_tag", None) is not None:
1066
GLib.source_remove(self.checker_initiator_tag)
1067
self.checker_initiator_tag = None
1069
self.enabled = False
1071
self.send_changedstate()
1072
# Do not run this again if called by a GLib.timeout_add
1078
def init_checker(self):
1079
249
# Schedule a new checker to be started an 'interval' from now,
1080
250
# and every interval from then on.
1081
if self.checker_initiator_tag is not None:
1082
GLib.source_remove(self.checker_initiator_tag)
1083
self.checker_initiator_tag = GLib.timeout_add(
1084
random.randrange(int(self.interval.total_seconds() * 1000
1087
# Schedule a disable() when 'timeout' has passed
1088
if self.disable_initiator_tag is not None:
1089
GLib.source_remove(self.disable_initiator_tag)
1090
self.disable_initiator_tag = GLib.timeout_add(
1091
int(self.timeout.total_seconds() * 1000), self.disable)
251
self.checker_initiator_tag = gobject.timeout_add\
252
(self._interval_milliseconds,
1092
254
# Also start a new checker *right now*.
1093
255
self.start_checker()
1095
def checker_callback(self, source, condition, connection,
256
# Schedule a stop() when 'timeout' has passed
257
self.stop_initiator_tag = gobject.timeout_add\
258
(self._timeout_milliseconds,
262
The possibility that a client might be restarted is left open,
263
but not currently used."""
264
# If this client doesn't have a secret, it is already stopped.
265
if hasattr(self, "secret") and self.secret:
266
logger.info(u"Stopping client %s", self.name)
270
if getattr(self, "stop_initiator_tag", False):
271
gobject.source_remove(self.stop_initiator_tag)
272
self.stop_initiator_tag = None
273
if getattr(self, "checker_initiator_tag", False):
274
gobject.source_remove(self.checker_initiator_tag)
275
self.checker_initiator_tag = None
279
# Do not run this again if called by a gobject.timeout_add
282
self.stop_hook = None
284
def checker_callback(self, pid, condition):
1097
285
"""The checker has completed, so take appropriate actions."""
1098
# Read return code from connection (see call_pipe)
1099
returncode = connection.recv()
1101
if self.checker is not None:
286
now = datetime.datetime.now()
1103
287
self.checker_callback_tag = None
1104
288
self.checker = None
1107
self.last_checker_status = returncode
1108
self.last_checker_signal = None
1109
if self.last_checker_status == 0:
1110
logger.info("Checker for %(name)s succeeded",
1114
logger.info("Checker for %(name)s failed", vars(self))
1116
self.last_checker_status = -1
1117
self.last_checker_signal = -returncode
1118
logger.warning("Checker for %(name)s crashed?",
289
if os.WIFEXITED(condition) \
290
and (os.WEXITSTATUS(condition) == 0):
291
logger.info(u"Checker for %(name)s succeeded",
293
self.last_checked_ok = now
294
gobject.source_remove(self.stop_initiator_tag)
295
self.stop_initiator_tag = gobject.timeout_add\
296
(self._timeout_milliseconds,
298
elif not os.WIFEXITED(condition):
299
logger.warning(u"Checker for %(name)s crashed?",
1122
def checked_ok(self):
1123
"""Assert that the client has been seen, alive and well."""
1124
self.last_checked_ok = datetime.datetime.utcnow()
1125
self.last_checker_status = 0
1126
self.last_checker_signal = None
1129
def bump_timeout(self, timeout=None):
1130
"""Bump up the timeout for this client."""
1132
timeout = self.timeout
1133
if self.disable_initiator_tag is not None:
1134
GLib.source_remove(self.disable_initiator_tag)
1135
self.disable_initiator_tag = None
1136
if getattr(self, "enabled", False):
1137
self.disable_initiator_tag = GLib.timeout_add(
1138
int(timeout.total_seconds() * 1000), self.disable)
1139
self.expires = datetime.datetime.utcnow() + timeout
1141
def need_approval(self):
1142
self.last_approval_request = datetime.datetime.utcnow()
302
logger.info(u"Checker for %(name)s failed",
1144
304
def start_checker(self):
1145
305
"""Start a new checker subprocess if one is not running.
1147
306
If a checker already exists, leave it running and do
1149
308
# The reason for not killing a running checker is that if we
1150
# did that, and if a checker (for some reason) started running
1151
# slowly and taking more than 'interval' time, then the client
1152
# would inevitably timeout, since no checker would get a
1153
# chance to run to completion. If we instead leave running
309
# did that, then if a checker (for some reason) started
310
# running slowly and taking more than 'interval' time, the
311
# client would inevitably timeout, since no checker would get
312
# a chance to run to completion. If we instead leave running
1154
313
# checkers alone, the checker would have to take more time
1155
# than 'timeout' for the client to be disabled, which is as it
1158
if self.checker is not None and not self.checker.is_alive():
1159
logger.warning("Checker was not alive; joining")
1162
# Start a new checker if needed
314
# than 'timeout' for the client to be declared invalid, which
315
# is as it should be.
1163
316
if self.checker is None:
1164
# Escape attributes for the shell
1166
attr: shlex.quote(str(getattr(self, attr)))
1167
for attr in self.runtime_expansions}
1169
command = self.checker_command % escaped_attrs
1170
except TypeError as error:
1171
logger.error('Could not format string "%s"',
1172
self.checker_command,
1174
return True # Try again later
1175
self.current_checker_command = command
1176
logger.info("Starting checker %r for %s", command,
1178
# We don't need to redirect stdout and stderr, since
1179
# in normal mode, that is already done by daemon(),
1180
# and in debug mode we don't want to. (Stdin is
1181
# always replaced by /dev/null.)
1182
# The exception is when not debugging but nevertheless
1183
# running in the foreground; use the previously
1185
popen_args = {"close_fds": True,
1188
if (not self.server_settings["debug"]
1189
and self.server_settings["foreground"]):
1190
popen_args.update({"stdout": wnull,
1192
pipe = multiprocessing.Pipe(duplex=False)
1193
self.checker = multiprocessing.Process(
1195
args=(pipe[1], subprocess.call, command),
1197
self.checker.start()
1198
self.checker_callback_tag = GLib.io_add_watch(
1199
GLib.IOChannel.unix_new(pipe[0].fileno()),
1200
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1201
self.checker_callback, pipe[0], command)
1202
# Re-run this periodically if run by GLib.timeout_add
318
# In case check_command has exactly one % operator
319
command = self.check_command % self.host
321
# Escape attributes for the shell
322
escaped_attrs = dict((key, re.escape(str(val)))
324
vars(self).iteritems())
326
command = self.check_command % escaped_attrs
327
except TypeError, error:
328
logger.error(u'Could not format string "%s":'
329
u' %s', self.check_command, error)
330
return True # Try again later
332
logger.info(u"Starting checker %r for %s",
334
self.checker = subprocess.Popen(command,
337
self.checker_callback_tag = gobject.child_watch_add\
339
self.checker_callback)
340
except subprocess.OSError, error:
341
logger.error(u"Failed to start subprocess: %s",
343
# Re-run this periodically if run by gobject.timeout_add
1205
345
def stop_checker(self):
1206
346
"""Force the checker process, if any, to stop."""
1207
347
if self.checker_callback_tag:
1208
GLib.source_remove(self.checker_callback_tag)
348
gobject.source_remove(self.checker_callback_tag)
1209
349
self.checker_callback_tag = None
1210
350
if getattr(self, "checker", None) is None:
1212
logger.debug("Stopping checker for %(name)s", vars(self))
1213
self.checker.terminate()
352
logger.debug(u"Stopping checker for %(name)s", vars(self))
354
os.kill(self.checker.pid, signal.SIGTERM)
356
#if self.checker.poll() is None:
357
# os.kill(self.checker.pid, signal.SIGKILL)
358
except OSError, error:
359
if error.errno != errno.ESRCH: # No such process
1214
361
self.checker = None
1217
def dbus_service_property(dbus_interface,
1221
"""Decorators for marking methods of a DBusObjectWithProperties to
1222
become properties on the D-Bus.
1224
The decorated method will be called with no arguments by "Get"
1225
and with one argument by "Set".
1227
The parameters, where they are supported, are the same as
1228
dbus.service.method, except there is only "signature", since the
1229
type from Get() and the type sent to Set() is the same.
1231
# Encoding deeply encoded byte arrays is not supported yet by the
1232
# "Set" method, so we fail early here:
1233
if byte_arrays and signature != "ay":
1234
raise ValueError("Byte arrays not supported for non-'ay'"
1235
" signature {!r}".format(signature))
1237
def decorator(func):
1238
func._dbus_is_property = True
1239
func._dbus_interface = dbus_interface
1240
func._dbus_signature = signature
1241
func._dbus_access = access
1242
func._dbus_name = func.__name__
1243
if func._dbus_name.endswith("_dbus_property"):
1244
func._dbus_name = func._dbus_name[:-14]
1245
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1251
def dbus_interface_annotations(dbus_interface):
1252
"""Decorator for marking functions returning interface annotations
1256
@dbus_interface_annotations("org.example.Interface")
1257
def _foo(self): # Function name does not matter
1258
return {"org.freedesktop.DBus.Deprecated": "true",
1259
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1263
def decorator(func):
1264
func._dbus_is_interface = True
1265
func._dbus_interface = dbus_interface
1266
func._dbus_name = dbus_interface
1272
def dbus_annotations(annotations):
1273
"""Decorator to annotate D-Bus methods, signals or properties
1276
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1277
"org.freedesktop.DBus.Property."
1278
"EmitsChangedSignal": "false"})
1279
@dbus_service_property("org.example.Interface", signature="b",
1281
def Property_dbus_property(self):
1282
return dbus.Boolean(False)
1284
See also the DBusObjectWithAnnotations class.
1287
def decorator(func):
1288
func._dbus_annotations = annotations
1294
class DBusPropertyException(dbus.exceptions.DBusException):
1295
"""A base class for D-Bus property-related exceptions
1300
class DBusPropertyAccessException(DBusPropertyException):
1301
"""A property's access permissions disallows an operation.
1306
class DBusPropertyNotFound(DBusPropertyException):
1307
"""An attempt was made to access a non-existing property.
1312
class DBusObjectWithAnnotations(dbus.service.Object):
1313
"""A D-Bus object with annotations.
1315
Classes inheriting from this can use the dbus_annotations
1316
decorator to add annotations to methods or signals.
1320
def _is_dbus_thing(thing):
1321
"""Returns a function testing if an attribute is a D-Bus thing
1323
If called like _is_dbus_thing("method") it returns a function
1324
suitable for use as predicate to inspect.getmembers().
1326
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1329
def _get_all_dbus_things(self, thing):
1330
"""Returns a generator of (name, attribute) pairs
1332
return ((getattr(athing.__get__(self), "_dbus_name", name),
1333
athing.__get__(self))
1334
for cls in self.__class__.__mro__
1336
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1338
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1340
path_keyword='object_path',
1341
connection_keyword='connection')
1342
def Introspect(self, object_path, connection):
1343
"""Overloading of standard D-Bus method.
1345
Inserts annotation tags on methods and signals.
1347
xmlstring = dbus.service.Object.Introspect(self, object_path,
1350
document = xml.dom.minidom.parseString(xmlstring)
1352
for if_tag in document.getElementsByTagName("interface"):
1353
# Add annotation tags
1354
for typ in ("method", "signal"):
1355
for tag in if_tag.getElementsByTagName(typ):
1357
for name, prop in (self.
1358
_get_all_dbus_things(typ)):
1359
if (name == tag.getAttribute("name")
1360
and prop._dbus_interface
1361
== if_tag.getAttribute("name")):
1362
annots.update(getattr(
1363
prop, "_dbus_annotations", {}))
1364
for name, value in annots.items():
1365
ann_tag = document.createElement(
1367
ann_tag.setAttribute("name", name)
1368
ann_tag.setAttribute("value", value)
1369
tag.appendChild(ann_tag)
1370
# Add interface annotation tags
1371
for annotation, value in dict(
1372
itertools.chain.from_iterable(
1373
annotations().items()
1374
for name, annotations
1375
in self._get_all_dbus_things("interface")
1376
if name == if_tag.getAttribute("name")
1378
ann_tag = document.createElement("annotation")
1379
ann_tag.setAttribute("name", annotation)
1380
ann_tag.setAttribute("value", value)
1381
if_tag.appendChild(ann_tag)
1382
# Fix argument name for the Introspect method itself
1383
if (if_tag.getAttribute("name")
1384
== dbus.INTROSPECTABLE_IFACE):
1385
for cn in if_tag.getElementsByTagName("method"):
1386
if cn.getAttribute("name") == "Introspect":
1387
for arg in cn.getElementsByTagName("arg"):
1388
if (arg.getAttribute("direction")
1390
arg.setAttribute("name",
1392
xmlstring = document.toxml("utf-8")
1394
except (AttributeError, xml.dom.DOMException,
1395
xml.parsers.expat.ExpatError) as error:
1396
logger.error("Failed to override Introspection method",
1401
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1402
"""A D-Bus object with properties.
1404
Classes inheriting from this can use the dbus_service_property
1405
decorator to expose methods as D-Bus properties. It exposes the
1406
standard Get(), Set(), and GetAll() methods on the D-Bus.
1409
def _get_dbus_property(self, interface_name, property_name):
1410
"""Returns a bound method if one exists which is a D-Bus
1411
property with the specified name and interface.
1413
for cls in self.__class__.__mro__:
1414
for name, value in inspect.getmembers(
1415
cls, self._is_dbus_thing("property")):
1416
if (value._dbus_name == property_name
1417
and value._dbus_interface == interface_name):
1418
return value.__get__(self)
1421
raise DBusPropertyNotFound("{}:{}.{}".format(
1422
self.dbus_object_path, interface_name, property_name))
1425
def _get_all_interface_names(cls):
1426
"""Get a sequence of all interfaces supported by an object"""
1427
return (name for name in set(getattr(getattr(x, attr),
1428
"_dbus_interface", None)
1429
for x in (inspect.getmro(cls))
1431
if name is not None)
1433
@dbus.service.method(dbus.PROPERTIES_IFACE,
1436
def Get(self, interface_name, property_name):
1437
"""Standard D-Bus property Get() method, see D-Bus standard.
1439
prop = self._get_dbus_property(interface_name, property_name)
1440
if prop._dbus_access == "write":
1441
raise DBusPropertyAccessException(property_name)
1443
if not hasattr(value, "variant_level"):
1445
return type(value)(value, variant_level=value.variant_level+1)
1447
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1448
def Set(self, interface_name, property_name, value):
1449
"""Standard D-Bus property Set() method, see D-Bus standard.
1451
prop = self._get_dbus_property(interface_name, property_name)
1452
if prop._dbus_access == "read":
1453
raise DBusPropertyAccessException(property_name)
1454
if prop._dbus_get_args_options["byte_arrays"]:
1455
# The byte_arrays option is not supported yet on
1456
# signatures other than "ay".
1457
if prop._dbus_signature != "ay":
1458
raise ValueError("Byte arrays not supported for non-"
1459
"'ay' signature {!r}"
1460
.format(prop._dbus_signature))
1461
value = dbus.ByteArray(bytes(value))
1464
@dbus.service.method(dbus.PROPERTIES_IFACE,
1466
out_signature="a{sv}")
1467
def GetAll(self, interface_name):
1468
"""Standard D-Bus property GetAll() method, see D-Bus
1471
Note: Will not include properties with access="write".
1474
for name, prop in self._get_all_dbus_things("property"):
1476
and interface_name != prop._dbus_interface):
1477
# Interface non-empty but did not match
1479
# Ignore write-only properties
1480
if prop._dbus_access == "write":
1483
if not hasattr(value, "variant_level"):
1484
properties[name] = value
1486
properties[name] = type(value)(
1487
value, variant_level=value.variant_level + 1)
1488
return dbus.Dictionary(properties, signature="sv")
1490
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1491
def PropertiesChanged(self, interface_name, changed_properties,
1492
invalidated_properties):
1493
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1498
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1500
path_keyword='object_path',
1501
connection_keyword='connection')
1502
def Introspect(self, object_path, connection):
1503
"""Overloading of standard D-Bus method.
1505
Inserts property tags and interface annotation tags.
1507
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1511
document = xml.dom.minidom.parseString(xmlstring)
1513
def make_tag(document, name, prop):
1514
e = document.createElement("property")
1515
e.setAttribute("name", name)
1516
e.setAttribute("type", prop._dbus_signature)
1517
e.setAttribute("access", prop._dbus_access)
1520
for if_tag in document.getElementsByTagName("interface"):
1522
for tag in (make_tag(document, name, prop)
1524
in self._get_all_dbus_things("property")
1525
if prop._dbus_interface
1526
== if_tag.getAttribute("name")):
1527
if_tag.appendChild(tag)
1528
# Add annotation tags for properties
1529
for tag in if_tag.getElementsByTagName("property"):
1531
for name, prop in self._get_all_dbus_things(
1533
if (name == tag.getAttribute("name")
1534
and prop._dbus_interface
1535
== if_tag.getAttribute("name")):
1536
annots.update(getattr(
1537
prop, "_dbus_annotations", {}))
1538
for name, value in annots.items():
1539
ann_tag = document.createElement(
1541
ann_tag.setAttribute("name", name)
1542
ann_tag.setAttribute("value", value)
1543
tag.appendChild(ann_tag)
1544
# Add the names to the return values for the
1545
# "org.freedesktop.DBus.Properties" methods
1546
if (if_tag.getAttribute("name")
1547
== "org.freedesktop.DBus.Properties"):
1548
for cn in if_tag.getElementsByTagName("method"):
1549
if cn.getAttribute("name") == "Get":
1550
for arg in cn.getElementsByTagName("arg"):
1551
if (arg.getAttribute("direction")
1553
arg.setAttribute("name", "value")
1554
elif cn.getAttribute("name") == "GetAll":
1555
for arg in cn.getElementsByTagName("arg"):
1556
if (arg.getAttribute("direction")
1558
arg.setAttribute("name", "props")
1559
xmlstring = document.toxml("utf-8")
1561
except (AttributeError, xml.dom.DOMException,
1562
xml.parsers.expat.ExpatError) as error:
1563
logger.error("Failed to override Introspection method",
1569
dbus.OBJECT_MANAGER_IFACE
1570
except AttributeError:
1571
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1574
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1575
"""A D-Bus object with an ObjectManager.
1577
Classes inheriting from this exposes the standard
1578
GetManagedObjects call and the InterfacesAdded and
1579
InterfacesRemoved signals on the standard
1580
"org.freedesktop.DBus.ObjectManager" interface.
1582
Note: No signals are sent automatically; they must be sent
1585
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1586
out_signature="a{oa{sa{sv}}}")
1587
def GetManagedObjects(self):
1588
"""This function must be overridden"""
1589
raise NotImplementedError()
1591
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1592
signature="oa{sa{sv}}")
1593
def InterfacesAdded(self, object_path, interfaces_and_properties):
1596
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1597
def InterfacesRemoved(self, object_path, interfaces):
1600
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1602
path_keyword='object_path',
1603
connection_keyword='connection')
1604
def Introspect(self, object_path, connection):
1605
"""Overloading of standard D-Bus method.
1607
Override return argument name of GetManagedObjects to be
1608
"objpath_interfaces_and_properties"
1610
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1614
document = xml.dom.minidom.parseString(xmlstring)
1616
for if_tag in document.getElementsByTagName("interface"):
1617
# Fix argument name for the GetManagedObjects method
1618
if (if_tag.getAttribute("name")
1619
== dbus.OBJECT_MANAGER_IFACE):
1620
for cn in if_tag.getElementsByTagName("method"):
1621
if (cn.getAttribute("name")
1622
== "GetManagedObjects"):
1623
for arg in cn.getElementsByTagName("arg"):
1624
if (arg.getAttribute("direction")
1628
"objpath_interfaces"
1630
xmlstring = document.toxml("utf-8")
1632
except (AttributeError, xml.dom.DOMException,
1633
xml.parsers.expat.ExpatError) as error:
1634
logger.error("Failed to override Introspection method",
1639
def datetime_to_dbus(dt, variant_level=0):
1640
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1642
return dbus.String("", variant_level=variant_level)
1643
return dbus.String(dt.isoformat(), variant_level=variant_level)
1646
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1647
"""A class decorator; applied to a subclass of
1648
dbus.service.Object, it will add alternate D-Bus attributes with
1649
interface names according to the "alt_interface_names" mapping.
1652
@alternate_dbus_interfaces({"org.example.Interface":
1653
"net.example.AlternateInterface"})
1654
class SampleDBusObject(dbus.service.Object):
1655
@dbus.service.method("org.example.Interface")
1656
def SampleDBusMethod():
1659
The above "SampleDBusMethod" on "SampleDBusObject" will be
1660
reachable via two interfaces: "org.example.Interface" and
1661
"net.example.AlternateInterface", the latter of which will have
1662
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1663
"true", unless "deprecate" is passed with a False value.
1665
This works for methods and signals, and also for D-Bus properties
1666
(from DBusObjectWithProperties) and interfaces (from the
1667
dbus_interface_annotations decorator).
1671
for orig_interface_name, alt_interface_name in (
1672
alt_interface_names.items()):
1674
interface_names = set()
1675
# Go though all attributes of the class
1676
for attrname, attribute in inspect.getmembers(cls):
1677
# Ignore non-D-Bus attributes, and D-Bus attributes
1678
# with the wrong interface name
1679
if (not hasattr(attribute, "_dbus_interface")
1680
or not attribute._dbus_interface.startswith(
1681
orig_interface_name)):
1683
# Create an alternate D-Bus interface name based on
1685
alt_interface = attribute._dbus_interface.replace(
1686
orig_interface_name, alt_interface_name)
1687
interface_names.add(alt_interface)
1688
# Is this a D-Bus signal?
1689
if getattr(attribute, "_dbus_is_signal", False):
1690
# Extract the original non-method undecorated
1691
# function by black magic
1692
if sys.version_info.major == 2:
1693
nonmethod_func = (dict(
1694
zip(attribute.func_code.co_freevars,
1695
attribute.__closure__))
1696
["func"].cell_contents)
1698
nonmethod_func = (dict(
1699
zip(attribute.__code__.co_freevars,
1700
attribute.__closure__))
1701
["func"].cell_contents)
1702
# Create a new, but exactly alike, function
1703
# object, and decorate it to be a new D-Bus signal
1704
# with the alternate D-Bus interface name
1705
new_function = copy_function(nonmethod_func)
1706
new_function = (dbus.service.signal(
1708
attribute._dbus_signature)(new_function))
1709
# Copy annotations, if any
1711
new_function._dbus_annotations = dict(
1712
attribute._dbus_annotations)
1713
except AttributeError:
1716
# Define a creator of a function to call both the
1717
# original and alternate functions, so both the
1718
# original and alternate signals gets sent when
1719
# the function is called
1720
def fixscope(func1, func2):
1721
"""This function is a scope container to pass
1722
func1 and func2 to the "call_both" function
1723
outside of its arguments"""
1725
@functools.wraps(func2)
1726
def call_both(*args, **kwargs):
1727
"""This function will emit two D-Bus
1728
signals by calling func1 and func2"""
1729
func1(*args, **kwargs)
1730
func2(*args, **kwargs)
1731
# Make wrapper function look like a D-Bus
1733
for name, attr in inspect.getmembers(func2):
1734
if name.startswith("_dbus_"):
1735
setattr(call_both, name, attr)
1738
# Create the "call_both" function and add it to
1740
attr[attrname] = fixscope(attribute, new_function)
1741
# Is this a D-Bus method?
1742
elif getattr(attribute, "_dbus_is_method", False):
1743
# Create a new, but exactly alike, function
1744
# object. Decorate it to be a new D-Bus method
1745
# with the alternate D-Bus interface name. Add it
1748
dbus.service.method(
1750
attribute._dbus_in_signature,
1751
attribute._dbus_out_signature)
1752
(copy_function(attribute)))
1753
# Copy annotations, if any
1755
attr[attrname]._dbus_annotations = dict(
1756
attribute._dbus_annotations)
1757
except AttributeError:
1759
# Is this a D-Bus property?
1760
elif getattr(attribute, "_dbus_is_property", False):
1761
# Create a new, but exactly alike, function
1762
# object, and decorate it to be a new D-Bus
1763
# property with the alternate D-Bus interface
1764
# name. Add it to the class.
1765
attr[attrname] = (dbus_service_property(
1766
alt_interface, attribute._dbus_signature,
1767
attribute._dbus_access,
1768
attribute._dbus_get_args_options
1770
(copy_function(attribute)))
1771
# Copy annotations, if any
1773
attr[attrname]._dbus_annotations = dict(
1774
attribute._dbus_annotations)
1775
except AttributeError:
1777
# Is this a D-Bus interface?
1778
elif getattr(attribute, "_dbus_is_interface", False):
1779
# Create a new, but exactly alike, function
1780
# object. Decorate it to be a new D-Bus interface
1781
# with the alternate D-Bus interface name. Add it
1784
dbus_interface_annotations(alt_interface)
1785
(copy_function(attribute)))
1787
# Deprecate all alternate interfaces
1788
iname = "_AlternateDBusNames_interface_annotation{}"
1789
for interface_name in interface_names:
1791
@dbus_interface_annotations(interface_name)
1793
return {"org.freedesktop.DBus.Deprecated":
1795
# Find an unused name
1796
for aname in (iname.format(i)
1797
for i in itertools.count()):
1798
if aname not in attr:
1802
# Replace the class with a new subclass of it with
1803
# methods, signals, etc. as created above.
1804
if sys.version_info.major == 2:
1805
cls = type(b"{}Alternate".format(cls.__name__),
1808
cls = type("{}Alternate".format(cls.__name__),
1815
@alternate_dbus_interfaces({"se.recompile.Mandos":
1816
"se.bsnet.fukt.Mandos"})
1817
class ClientDBus(Client, DBusObjectWithProperties):
1818
"""A Client class using D-Bus
1821
dbus_object_path: dbus.ObjectPath
1822
bus: dbus.SystemBus()
1825
runtime_expansions = (Client.runtime_expansions
1826
+ ("dbus_object_path", ))
1828
_interface = "se.recompile.Mandos.Client"
1830
# dbus.service.Object doesn't use super(), so we can't either.
1832
def __init__(self, bus=None, *args, **kwargs):
1834
Client.__init__(self, *args, **kwargs)
1835
# Only now, when this client is initialized, can it show up on
1837
client_object_name = str(self.name).translate(
1838
{ord("."): ord("_"),
1839
ord("-"): ord("_")})
1840
self.dbus_object_path = dbus.ObjectPath(
1841
"/clients/" + client_object_name)
1842
DBusObjectWithProperties.__init__(self, self.bus,
1843
self.dbus_object_path)
1845
def notifychangeproperty(transform_func, dbus_name,
1846
type_func=lambda x: x,
1848
invalidate_only=False,
1849
_interface=_interface):
1850
""" Modify a variable so that it's a property which announces
1851
its changes to DBus.
1853
transform_fun: Function that takes a value and a variant_level
1854
and transforms it to a D-Bus type.
1855
dbus_name: D-Bus name of the variable
1856
type_func: Function that transform the value before sending it
1857
to the D-Bus. Default: no transform
1858
variant_level: D-Bus variant level. Default: 1
1860
attrname = "_{}".format(dbus_name)
1862
def setter(self, value):
1863
if hasattr(self, "dbus_object_path"):
1864
if (not hasattr(self, attrname) or
1865
type_func(getattr(self, attrname, None))
1866
!= type_func(value)):
1868
self.PropertiesChanged(
1869
_interface, dbus.Dictionary(),
1870
dbus.Array((dbus_name, )))
1872
dbus_value = transform_func(
1874
variant_level=variant_level)
1875
self.PropertyChanged(dbus.String(dbus_name),
1877
self.PropertiesChanged(
1879
dbus.Dictionary({dbus.String(dbus_name):
1882
setattr(self, attrname, value)
1884
return property(lambda self: getattr(self, attrname), setter)
1886
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1887
approvals_pending = notifychangeproperty(dbus.Boolean,
1890
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1891
last_enabled = notifychangeproperty(datetime_to_dbus,
1893
checker = notifychangeproperty(
1894
dbus.Boolean, "CheckerRunning",
1895
type_func=lambda checker: checker is not None)
1896
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1898
last_checker_status = notifychangeproperty(dbus.Int16,
1899
"LastCheckerStatus")
1900
last_approval_request = notifychangeproperty(
1901
datetime_to_dbus, "LastApprovalRequest")
1902
approved_by_default = notifychangeproperty(dbus.Boolean,
1903
"ApprovedByDefault")
1904
approval_delay = notifychangeproperty(
1905
dbus.UInt64, "ApprovalDelay",
1906
type_func=lambda td: td.total_seconds() * 1000)
1907
approval_duration = notifychangeproperty(
1908
dbus.UInt64, "ApprovalDuration",
1909
type_func=lambda td: td.total_seconds() * 1000)
1910
host = notifychangeproperty(dbus.String, "Host")
1911
timeout = notifychangeproperty(
1912
dbus.UInt64, "Timeout",
1913
type_func=lambda td: td.total_seconds() * 1000)
1914
extended_timeout = notifychangeproperty(
1915
dbus.UInt64, "ExtendedTimeout",
1916
type_func=lambda td: td.total_seconds() * 1000)
1917
interval = notifychangeproperty(
1918
dbus.UInt64, "Interval",
1919
type_func=lambda td: td.total_seconds() * 1000)
1920
checker_command = notifychangeproperty(dbus.String, "Checker")
1921
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1922
invalidate_only=True)
1924
del notifychangeproperty
1926
def __del__(self, *args, **kwargs):
1928
self.remove_from_connection()
1931
if hasattr(DBusObjectWithProperties, "__del__"):
1932
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1933
Client.__del__(self, *args, **kwargs)
1935
def checker_callback(self, source, condition,
1936
connection, command, *args, **kwargs):
1937
ret = Client.checker_callback(self, source, condition,
1938
connection, command, *args,
1940
exitstatus = self.last_checker_status
1943
self.CheckerCompleted(dbus.Int16(exitstatus),
1944
# This is specific to GNU libC
1945
dbus.Int64(exitstatus << 8),
1946
dbus.String(command))
1949
self.CheckerCompleted(dbus.Int16(-1),
1951
# This is specific to GNU libC
1953
| self.last_checker_signal),
1954
dbus.String(command))
1957
def start_checker(self, *args, **kwargs):
1958
old_checker_pid = getattr(self.checker, "pid", None)
1959
r = Client.start_checker(self, *args, **kwargs)
1960
# Only if new checker process was started
1961
if (self.checker is not None
1962
and old_checker_pid != self.checker.pid):
1964
self.CheckerStarted(self.current_checker_command)
1967
def _reset_approved(self):
1968
self.approved = None
1971
def approve(self, value=True):
1972
self.approved = value
1973
GLib.timeout_add(int(self.approval_duration.total_seconds()
1974
* 1000), self._reset_approved)
1975
self.send_changedstate()
1977
# D-Bus methods, signals & properties
1983
# CheckerCompleted - signal
1984
@dbus.service.signal(_interface, signature="nxs")
1985
def CheckerCompleted(self, exitcode, waitstatus, command):
1989
# CheckerStarted - signal
1990
@dbus.service.signal(_interface, signature="s")
1991
def CheckerStarted(self, command):
1995
# PropertyChanged - signal
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
@dbus.service.signal(_interface, signature="sv")
1998
def PropertyChanged(self, property, value):
2002
# GotSecret - signal
2003
@dbus.service.signal(_interface)
2004
def GotSecret(self):
2006
Is sent after a successful transfer of secret from the Mandos
2007
server to mandos-client
2012
@dbus.service.signal(_interface, signature="s")
2013
def Rejected(self, reason):
2017
# NeedApproval - signal
2018
@dbus.service.signal(_interface, signature="tb")
2019
def NeedApproval(self, timeout, default):
2021
return self.need_approval()
2026
@dbus.service.method(_interface, in_signature="b")
2027
def Approve(self, value):
2030
# CheckedOK - method
2031
@dbus.service.method(_interface)
2032
def CheckedOK(self):
2036
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2037
@dbus.service.method(_interface)
2042
# StartChecker - method
2043
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2044
@dbus.service.method(_interface)
2045
def StartChecker(self):
2047
self.start_checker()
2050
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2051
@dbus.service.method(_interface)
2056
# StopChecker - method
2057
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2058
@dbus.service.method(_interface)
2059
def StopChecker(self):
2064
# ApprovalPending - property
2065
@dbus_service_property(_interface, signature="b", access="read")
2066
def ApprovalPending_dbus_property(self):
2067
return dbus.Boolean(bool(self.approvals_pending))
2069
# ApprovedByDefault - property
2070
@dbus_service_property(_interface,
2073
def ApprovedByDefault_dbus_property(self, value=None):
2074
if value is None: # get
2075
return dbus.Boolean(self.approved_by_default)
2076
self.approved_by_default = bool(value)
2078
# ApprovalDelay - property
2079
@dbus_service_property(_interface,
2082
def ApprovalDelay_dbus_property(self, value=None):
2083
if value is None: # get
2084
return dbus.UInt64(self.approval_delay.total_seconds()
2086
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2088
# ApprovalDuration - property
2089
@dbus_service_property(_interface,
2092
def ApprovalDuration_dbus_property(self, value=None):
2093
if value is None: # get
2094
return dbus.UInt64(self.approval_duration.total_seconds()
2096
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2100
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2101
@dbus_service_property(_interface, signature="s", access="read")
2102
def Name_dbus_property(self):
2103
return dbus.String(self.name)
2107
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2108
@dbus_service_property(_interface, signature="s", access="read")
2109
def KeyID_dbus_property(self):
2110
return dbus.String(self.key_id)
2112
# Fingerprint - property
2114
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2115
@dbus_service_property(_interface, signature="s", access="read")
2116
def Fingerprint_dbus_property(self):
2117
return dbus.String(self.fingerprint)
2120
@dbus_service_property(_interface,
2123
def Host_dbus_property(self, value=None):
2124
if value is None: # get
2125
return dbus.String(self.host)
2126
self.host = str(value)
2128
# Created - property
2130
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2131
@dbus_service_property(_interface, signature="s", access="read")
2132
def Created_dbus_property(self):
2133
return datetime_to_dbus(self.created)
2135
# LastEnabled - property
2136
@dbus_service_property(_interface, signature="s", access="read")
2137
def LastEnabled_dbus_property(self):
2138
return datetime_to_dbus(self.last_enabled)
2140
# Enabled - property
2141
@dbus_service_property(_interface,
2144
def Enabled_dbus_property(self, value=None):
2145
if value is None: # get
2146
return dbus.Boolean(self.enabled)
2152
# LastCheckedOK - property
2153
@dbus_service_property(_interface,
2156
def LastCheckedOK_dbus_property(self, value=None):
2157
if value is not None:
2160
return datetime_to_dbus(self.last_checked_ok)
2162
# LastCheckerStatus - property
2163
@dbus_service_property(_interface, signature="n", access="read")
2164
def LastCheckerStatus_dbus_property(self):
2165
return dbus.Int16(self.last_checker_status)
2167
# Expires - property
2168
@dbus_service_property(_interface, signature="s", access="read")
2169
def Expires_dbus_property(self):
2170
return datetime_to_dbus(self.expires)
2172
# LastApprovalRequest - property
2173
@dbus_service_property(_interface, signature="s", access="read")
2174
def LastApprovalRequest_dbus_property(self):
2175
return datetime_to_dbus(self.last_approval_request)
2177
# Timeout - property
2178
@dbus_service_property(_interface,
2181
def Timeout_dbus_property(self, value=None):
2182
if value is None: # get
2183
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2184
old_timeout = self.timeout
2185
self.timeout = datetime.timedelta(0, 0, 0, value)
2186
# Reschedule disabling
2188
now = datetime.datetime.utcnow()
2189
self.expires += self.timeout - old_timeout
2190
if self.expires <= now:
2191
# The timeout has passed
2194
if (getattr(self, "disable_initiator_tag", None)
2197
GLib.source_remove(self.disable_initiator_tag)
2198
self.disable_initiator_tag = GLib.timeout_add(
2199
int((self.expires - now).total_seconds() * 1000),
2202
# ExtendedTimeout - property
2203
@dbus_service_property(_interface,
2206
def ExtendedTimeout_dbus_property(self, value=None):
2207
if value is None: # get
2208
return dbus.UInt64(self.extended_timeout.total_seconds()
2210
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2212
# Interval - property
2213
@dbus_service_property(_interface,
2216
def Interval_dbus_property(self, value=None):
2217
if value is None: # get
2218
return dbus.UInt64(self.interval.total_seconds() * 1000)
2219
self.interval = datetime.timedelta(0, 0, 0, value)
2220
if getattr(self, "checker_initiator_tag", None) is None:
2223
# Reschedule checker run
2224
GLib.source_remove(self.checker_initiator_tag)
2225
self.checker_initiator_tag = GLib.timeout_add(
2226
value, self.start_checker)
2227
self.start_checker() # Start one now, too
2229
# Checker - property
2230
@dbus_service_property(_interface,
2233
def Checker_dbus_property(self, value=None):
2234
if value is None: # get
2235
return dbus.String(self.checker_command)
2236
self.checker_command = str(value)
2238
# CheckerRunning - property
2239
@dbus_service_property(_interface,
2242
def CheckerRunning_dbus_property(self, value=None):
2243
if value is None: # get
2244
return dbus.Boolean(self.checker is not None)
2246
self.start_checker()
2250
# ObjectPath - property
2252
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2253
"org.freedesktop.DBus.Deprecated": "true"})
2254
@dbus_service_property(_interface, signature="o", access="read")
2255
def ObjectPath_dbus_property(self):
2256
return self.dbus_object_path # is already a dbus.ObjectPath
2260
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2262
@dbus_service_property(_interface,
2266
def Secret_dbus_property(self, value):
2267
self.secret = bytes(value)
2273
def __init__(self, child_pipe, key_id, fpr, address):
2274
self._pipe = child_pipe
2275
self._pipe.send(('init', key_id, fpr, address))
2276
if not self._pipe.recv():
2277
raise KeyError(key_id or fpr)
2279
def __getattribute__(self, name):
2281
return super(ProxyClient, self).__getattribute__(name)
2282
self._pipe.send(('getattr', name))
2283
data = self._pipe.recv()
2284
if data[0] == 'data':
2286
if data[0] == 'function':
2288
def func(*args, **kwargs):
2289
self._pipe.send(('funcall', name, args, kwargs))
2290
return self._pipe.recv()[1]
2294
def __setattr__(self, name, value):
2296
return super(ProxyClient, self).__setattr__(name, value)
2297
self._pipe.send(('setattr', name, value))
2300
class ClientHandler(socketserver.BaseRequestHandler, object):
2301
"""A class to handle client connections.
2303
Instantiated once for each connection to handle it.
362
def still_valid(self):
363
"""Has the timeout not yet passed for this client?"""
364
now = datetime.datetime.now()
365
if self.last_checked_ok is None:
366
return now < (self.created + self.timeout)
368
return now < (self.last_checked_ok + self.timeout)
371
def peer_certificate(session):
372
"Return the peer's OpenPGP certificate as a bytestring"
373
# If not an OpenPGP certificate...
374
if gnutls.library.functions.gnutls_certificate_type_get\
375
(session._c_object) \
376
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
377
# ...do the normal thing
378
return session.peer_certificate
379
list_size = ctypes.c_uint()
380
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
381
(session._c_object, ctypes.byref(list_size))
382
if list_size.value == 0:
385
return ctypes.string_at(cert.data, cert.size)
388
def fingerprint(openpgp):
389
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
390
# New GnuTLS "datum" with the OpenPGP public key
391
datum = gnutls.library.types.gnutls_datum_t\
392
(ctypes.cast(ctypes.c_char_p(openpgp),
393
ctypes.POINTER(ctypes.c_ubyte)),
394
ctypes.c_uint(len(openpgp)))
395
# New empty GnuTLS certificate
396
crt = gnutls.library.types.gnutls_openpgp_crt_t()
397
gnutls.library.functions.gnutls_openpgp_crt_init\
399
# Import the OpenPGP public key into the certificate
400
gnutls.library.functions.gnutls_openpgp_crt_import\
401
(crt, ctypes.byref(datum),
402
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
403
# New buffer for the fingerprint
404
buffer = ctypes.create_string_buffer(20)
405
buffer_length = ctypes.c_size_t()
406
# Get the fingerprint from the certificate into the buffer
407
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
408
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
409
# Deinit the certificate
410
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
411
# Convert the buffer to a Python bytestring
412
fpr = ctypes.string_at(buffer, buffer_length.value)
413
# Convert the bytestring to hexadecimal notation
414
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
418
class tcp_handler(SocketServer.BaseRequestHandler, object):
419
"""A TCP request handler class.
420
Instantiated by IPv6_TCPServer for each request to handle it.
2304
421
Note: This will run in its own forked process."""
2306
423
def handle(self):
2307
with contextlib.closing(self.server.child_pipe) as child_pipe:
2308
logger.info("TCP connection from: %s",
2309
str(self.client_address))
2310
logger.debug("Pipe FD: %d",
2311
self.server.child_pipe.fileno())
2313
session = gnutls.ClientSession(self.request)
2315
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2316
# "+AES-256-CBC", "+SHA1",
2317
# "+COMP-NULL", "+CTYPE-OPENPGP",
2319
# Use a fallback default, since this MUST be set.
2320
priority = self.server.gnutls_priority
2321
if priority is None:
2323
gnutls.priority_set_direct(session,
2324
priority.encode("utf-8"), None)
2326
# Start communication using the Mandos protocol
2327
# Get protocol number
2328
line = self.request.makefile().readline()
2329
logger.debug("Protocol version: %r", line)
2331
if int(line.strip().split()[0]) > 1:
2332
raise RuntimeError(line)
2333
except (ValueError, IndexError, RuntimeError) as error:
2334
logger.error("Unknown protocol version: %s", error)
2337
# Start GnuTLS connection
2340
except gnutls.Error as error:
2341
logger.warning("Handshake failed: %s", error)
2342
# Do not run session.bye() here: the session is not
2343
# established. Just abandon the request.
2345
logger.debug("Handshake succeeded")
2347
approval_required = False
2349
if gnutls.has_rawpk:
2352
key_id = self.key_id(
2353
self.peer_certificate(session))
2354
except (TypeError, gnutls.Error) as error:
2355
logger.warning("Bad certificate: %s", error)
2357
logger.debug("Key ID: %s",
2358
key_id.decode("utf-8",
2364
fpr = self.fingerprint(
2365
self.peer_certificate(session))
2366
except (TypeError, gnutls.Error) as error:
2367
logger.warning("Bad certificate: %s", error)
2369
logger.debug("Fingerprint: %s", fpr)
2372
client = ProxyClient(child_pipe, key_id, fpr,
2373
self.client_address)
2377
if client.approval_delay:
2378
delay = client.approval_delay
2379
client.approvals_pending += 1
2380
approval_required = True
2383
if not client.enabled:
2384
logger.info("Client %s is disabled",
2386
if self.server.use_dbus:
2388
client.Rejected("Disabled")
2391
if client.approved or not client.approval_delay:
2392
# We are approved or approval is disabled
2394
elif client.approved is None:
2395
logger.info("Client %s needs approval",
2397
if self.server.use_dbus:
2399
client.NeedApproval(
2400
client.approval_delay.total_seconds()
2401
* 1000, client.approved_by_default)
2403
logger.warning("Client %s was not approved",
2405
if self.server.use_dbus:
2407
client.Rejected("Denied")
2410
# wait until timeout or approved
2411
time = datetime.datetime.now()
2412
client.changedstate.acquire()
2413
client.changedstate.wait(delay.total_seconds())
2414
client.changedstate.release()
2415
time2 = datetime.datetime.now()
2416
if (time2 - time) >= delay:
2417
if not client.approved_by_default:
2418
logger.warning("Client %s timed out while"
2419
" waiting for approval",
2421
if self.server.use_dbus:
2423
client.Rejected("Approval timed out")
2428
delay -= time2 - time
2431
session.send(client.secret)
2432
except gnutls.Error as error:
2433
logger.warning("gnutls send failed",
2437
logger.info("Sending secret to %s", client.name)
2438
# bump the timeout using extended_timeout
2439
client.bump_timeout(client.extended_timeout)
2440
if self.server.use_dbus:
2445
if approval_required:
2446
client.approvals_pending -= 1
2449
except gnutls.Error as error:
2450
logger.warning("GnuTLS bye failed",
2454
def peer_certificate(session):
2455
"Return the peer's certificate as a bytestring"
2457
cert_type = gnutls.certificate_type_get2(
2458
session, gnutls.CTYPE_PEERS)
2459
except AttributeError:
2460
cert_type = gnutls.certificate_type_get(session)
2461
if gnutls.has_rawpk:
2462
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2464
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2465
# If not a valid certificate type...
2466
if cert_type not in valid_cert_types:
2467
logger.info("Cert type %r not in %r", cert_type,
2469
# ...return invalid data
2471
list_size = ctypes.c_uint(1)
2472
cert_list = (gnutls.certificate_get_peers
2473
(session, ctypes.byref(list_size)))
2474
if not bool(cert_list) and list_size.value != 0:
2475
raise gnutls.Error("error getting peer certificate")
2476
if list_size.value == 0:
2479
return ctypes.string_at(cert.data, cert.size)
2482
def key_id(certificate):
2483
"Convert a certificate bytestring to a hexdigit key ID"
2484
# New GnuTLS "datum" with the public key
2485
datum = gnutls.datum_t(
2486
ctypes.cast(ctypes.c_char_p(certificate),
2487
ctypes.POINTER(ctypes.c_ubyte)),
2488
ctypes.c_uint(len(certificate)))
2489
# XXX all these need to be created in the gnutls "module"
2490
# New empty GnuTLS certificate
2491
pubkey = gnutls.pubkey_t()
2492
gnutls.pubkey_init(ctypes.byref(pubkey))
2493
# Import the raw public key into the certificate
2494
gnutls.pubkey_import(pubkey,
2495
ctypes.byref(datum),
2496
gnutls.X509_FMT_DER)
2497
# New buffer for the key ID
2498
buf = ctypes.create_string_buffer(32)
2499
buf_len = ctypes.c_size_t(len(buf))
2500
# Get the key ID from the raw public key into the buffer
2501
gnutls.pubkey_get_key_id(
2503
gnutls.KEYID_USE_SHA256,
2504
ctypes.cast(ctypes.byref(buf),
2505
ctypes.POINTER(ctypes.c_ubyte)),
2506
ctypes.byref(buf_len))
2507
# Deinit the certificate
2508
gnutls.pubkey_deinit(pubkey)
2510
# Convert the buffer to a Python bytestring
2511
key_id = ctypes.string_at(buf, buf_len.value)
2512
# Convert the bytestring to hexadecimal notation
2513
hex_key_id = binascii.hexlify(key_id).upper()
2517
def fingerprint(openpgp):
2518
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2519
# New GnuTLS "datum" with the OpenPGP public key
2520
datum = gnutls.datum_t(
2521
ctypes.cast(ctypes.c_char_p(openpgp),
2522
ctypes.POINTER(ctypes.c_ubyte)),
2523
ctypes.c_uint(len(openpgp)))
2524
# New empty GnuTLS certificate
2525
crt = gnutls.openpgp_crt_t()
2526
gnutls.openpgp_crt_init(ctypes.byref(crt))
2527
# Import the OpenPGP public key into the certificate
2528
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2529
gnutls.OPENPGP_FMT_RAW)
2530
# Verify the self signature in the key
2531
crtverify = ctypes.c_uint()
2532
gnutls.openpgp_crt_verify_self(crt, 0,
2533
ctypes.byref(crtverify))
2534
if crtverify.value != 0:
2535
gnutls.openpgp_crt_deinit(crt)
2536
raise gnutls.CertificateSecurityError(code
2538
# New buffer for the fingerprint
2539
buf = ctypes.create_string_buffer(20)
2540
buf_len = ctypes.c_size_t()
2541
# Get the fingerprint from the certificate into the buffer
2542
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2543
ctypes.byref(buf_len))
2544
# Deinit the certificate
2545
gnutls.openpgp_crt_deinit(crt)
2546
# Convert the buffer to a Python bytestring
2547
fpr = ctypes.string_at(buf, buf_len.value)
2548
# Convert the bytestring to hexadecimal notation
2549
hex_fpr = binascii.hexlify(fpr).upper()
2553
class MultiprocessingMixIn:
2554
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2556
def sub_process_main(self, request, address):
2558
self.finish_request(request, address)
2560
self.handle_error(request, address)
2561
self.close_request(request)
2563
def process_request(self, request, address):
2564
"""Start a new process to process the request."""
2565
proc = multiprocessing.Process(target=self.sub_process_main,
2566
args=(request, address))
2571
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2572
""" adds a pipe to the MixIn """
2574
def process_request(self, request, client_address):
2575
"""Overrides and wraps the original process_request().
2577
This function creates a new pipe in self.pipe
2579
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2581
proc = MultiprocessingMixIn.process_request(self, request,
2583
self.child_pipe.close()
2584
self.add_pipe(parent_pipe, proc)
2586
def add_pipe(self, parent_pipe, proc):
2587
"""Dummy function; override as necessary"""
2588
raise NotImplementedError()
2591
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2592
socketserver.TCPServer):
2593
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
424
logger.info(u"TCP connection from: %s",
425
unicode(self.client_address))
426
session = gnutls.connection.ClientSession\
427
(self.request, gnutls.connection.X509Credentials())
429
line = self.request.makefile().readline()
430
logger.debug(u"Protocol version: %r", line)
432
if int(line.strip().split()[0]) > 1:
434
except (ValueError, IndexError, RuntimeError), error:
435
logger.error(u"Unknown protocol version: %s", error)
438
# Note: gnutls.connection.X509Credentials is really a generic
439
# GnuTLS certificate credentials object so long as no X.509
440
# keys are added to it. Therefore, we can use it here despite
441
# using OpenPGP certificates.
443
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
444
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
446
priority = "NORMAL" # Fallback default, since this
448
if self.server.settings["priority"]:
449
priority = self.server.settings["priority"]
450
gnutls.library.functions.gnutls_priority_set_direct\
451
(session._c_object, priority, None);
455
except gnutls.errors.GNUTLSError, error:
456
logger.warning(u"Handshake failed: %s", error)
457
# Do not run session.bye() here: the session is not
458
# established. Just abandon the request.
461
fpr = fingerprint(peer_certificate(session))
462
except (TypeError, gnutls.errors.GNUTLSError), error:
463
logger.warning(u"Bad certificate: %s", error)
466
logger.debug(u"Fingerprint: %s", fpr)
468
for c in self.server.clients:
469
if c.fingerprint == fpr:
473
logger.warning(u"Client not found for fingerprint: %s",
477
# Have to check if client.still_valid(), since it is possible
478
# that the client timed out while establishing the GnuTLS
480
if not client.still_valid():
481
logger.warning(u"Client %(name)s is invalid",
486
while sent_size < len(client.secret):
487
sent = session.send(client.secret[sent_size:])
488
logger.debug(u"Sent: %d, remaining: %d",
489
sent, len(client.secret)
490
- (sent_size + sent))
495
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
496
"""IPv6 TCP server. Accepts 'None' as address and/or port.
2596
enabled: Boolean; whether this server is activated yet
2597
interface: None or a network interface name (string)
2598
use_ipv6: Boolean; to use IPv6 or not
498
settings: Server settings
499
clients: Set() of Client objects
2601
def __init__(self, server_address, RequestHandlerClass,
2605
"""If socketfd is set, use that file descriptor instead of
2606
creating a new one with socket.socket().
2608
self.interface = interface
2610
self.address_family = socket.AF_INET6
2611
if socketfd is not None:
2612
# Save the file descriptor
2613
self.socketfd = socketfd
2614
# Save the original socket.socket() function
2615
self.socket_socket = socket.socket
2617
# To implement --socket, we monkey patch socket.socket.
2619
# (When socketserver.TCPServer is a new-style class, we
2620
# could make self.socket into a property instead of monkey
2621
# patching socket.socket.)
2623
# Create a one-time-only replacement for socket.socket()
2624
@functools.wraps(socket.socket)
2625
def socket_wrapper(*args, **kwargs):
2626
# Restore original function so subsequent calls are
2628
socket.socket = self.socket_socket
2629
del self.socket_socket
2630
# This time only, return a new socket object from the
2631
# saved file descriptor.
2632
return socket.fromfd(self.socketfd, *args, **kwargs)
2633
# Replace socket.socket() function with wrapper
2634
socket.socket = socket_wrapper
2635
# The socketserver.TCPServer.__init__ will call
2636
# socket.socket(), which might be our replacement,
2637
# socket_wrapper(), if socketfd was set.
2638
socketserver.TCPServer.__init__(self, server_address,
2639
RequestHandlerClass)
501
address_family = socket.AF_INET6
502
def __init__(self, *args, **kwargs):
503
if "settings" in kwargs:
504
self.settings = kwargs["settings"]
505
del kwargs["settings"]
506
if "clients" in kwargs:
507
self.clients = kwargs["clients"]
508
del kwargs["clients"]
509
return super(type(self), self).__init__(*args, **kwargs)
2641
510
def server_bind(self):
2642
511
"""This overrides the normal server_bind() function
2643
512
to bind to an interface if one was specified, and also NOT to
2644
513
bind to an address or port if they were not specified."""
2645
global SO_BINDTODEVICE
2646
if self.interface is not None:
2647
if SO_BINDTODEVICE is None:
2648
# Fall back to a hard-coded value which seems to be
2650
logger.warning("SO_BINDTODEVICE not found, trying 25")
2651
SO_BINDTODEVICE = 25
514
if self.settings["interface"]:
515
# 25 is from /usr/include/asm-i486/socket.h
516
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
2653
self.socket.setsockopt(
2654
socket.SOL_SOCKET, SO_BINDTODEVICE,
2655
(self.interface + "\0").encode("utf-8"))
2656
except socket.error as error:
2657
if error.errno == errno.EPERM:
2658
logger.error("No permission to bind to"
2659
" interface %s", self.interface)
2660
elif error.errno == errno.ENOPROTOOPT:
2661
logger.error("SO_BINDTODEVICE not available;"
2662
" cannot bind to interface %s",
2664
elif error.errno == errno.ENODEV:
2665
logger.error("Interface %s does not exist,"
2666
" cannot bind", self.interface)
518
self.socket.setsockopt(socket.SOL_SOCKET,
520
self.settings["interface"])
521
except socket.error, error:
522
if error[0] == errno.EPERM:
523
logger.error(u"No permission to"
524
u" bind to interface %s",
525
self.settings["interface"])
2669
528
# Only bind(2) the socket if we really need to.
2670
529
if self.server_address[0] or self.server_address[1]:
2671
if self.server_address[1]:
2672
self.allow_reuse_address = True
2673
530
if not self.server_address[0]:
2674
if self.address_family == socket.AF_INET6:
2675
any_address = "::" # in6addr_any
2677
any_address = "0.0.0.0" # INADDR_ANY
2678
self.server_address = (any_address,
532
self.server_address = (in6addr_any,
2679
533
self.server_address[1])
2680
534
elif not self.server_address[1]:
2681
self.server_address = (self.server_address[0], 0)
2682
# if self.interface:
535
self.server_address = (self.server_address[0],
537
# if self.settings["interface"]:
2683
538
# self.server_address = (self.server_address[0],
2686
541
# if_nametoindex
2688
return socketserver.TCPServer.server_bind(self)
2691
class MandosServer(IPv6_TCPServer):
2695
clients: set of Client objects
2696
gnutls_priority GnuTLS priority string
2697
use_dbus: Boolean; to emit D-Bus signals or not
2699
Assumes a GLib.MainLoop event loop.
2702
def __init__(self, server_address, RequestHandlerClass,
2706
gnutls_priority=None,
2709
self.enabled = False
2710
self.clients = clients
2711
if self.clients is None:
2713
self.use_dbus = use_dbus
2714
self.gnutls_priority = gnutls_priority
2715
IPv6_TCPServer.__init__(self, server_address,
2716
RequestHandlerClass,
2717
interface=interface,
2721
def server_activate(self):
2723
return socketserver.TCPServer.server_activate(self)
2728
def add_pipe(self, parent_pipe, proc):
2729
# Call "handle_ipc" for both data and EOF events
2731
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2732
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2733
functools.partial(self.handle_ipc,
2734
parent_pipe=parent_pipe,
2737
def handle_ipc(self, source, condition,
2740
client_object=None):
2741
# error, or the other end of multiprocessing.Pipe has closed
2742
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2743
# Wait for other process to exit
2747
# Read a request from the child
2748
request = parent_pipe.recv()
2749
command = request[0]
2751
if command == 'init':
2752
key_id = request[1].decode("ascii")
2753
fpr = request[2].decode("ascii")
2754
address = request[3]
2756
for c in self.clients.values():
2757
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2758
"27AE41E4649B934CA495991B7852B855"):
2760
if key_id and c.key_id == key_id:
2763
if fpr and c.fingerprint == fpr:
2767
logger.info("Client not found for key ID: %s, address"
2768
": %s", key_id or fpr, address)
2771
mandos_dbus_service.ClientNotFound(key_id or fpr,
2773
parent_pipe.send(False)
2777
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2778
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2779
functools.partial(self.handle_ipc,
2780
parent_pipe=parent_pipe,
2782
client_object=client))
2783
parent_pipe.send(True)
2784
# remove the old hook in favor of the new above hook on
2787
if command == 'funcall':
2788
funcname = request[1]
2792
parent_pipe.send(('data', getattr(client_object,
2796
if command == 'getattr':
2797
attrname = request[1]
2798
if isinstance(client_object.__getattribute__(attrname),
2799
collections.abc.Callable):
2800
parent_pipe.send(('function', ))
2803
'data', client_object.__getattribute__(attrname)))
2805
if command == 'setattr':
2806
attrname = request[1]
2808
setattr(client_object, attrname, value)
2813
def rfc3339_duration_to_delta(duration):
2814
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2816
>>> timedelta = datetime.timedelta
2817
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2819
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2821
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2823
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2825
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2827
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2829
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2834
# Parsing an RFC 3339 duration with regular expressions is not
2835
# possible - there would have to be multiple places for the same
2836
# values, like seconds. The current code, while more esoteric, is
2837
# cleaner without depending on a parsing library. If Python had a
2838
# built-in library for parsing we would use it, but we'd like to
2839
# avoid excessive use of external libraries.
2841
# New type for defining tokens, syntax, and semantics all-in-one
2842
Token = collections.namedtuple("Token", (
2843
"regexp", # To match token; if "value" is not None, must have
2844
# a "group" containing digits
2845
"value", # datetime.timedelta or None
2846
"followers")) # Tokens valid after this token
2847
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2848
# the "duration" ABNF definition in RFC 3339, Appendix A.
2849
token_end = Token(re.compile(r"$"), None, frozenset())
2850
token_second = Token(re.compile(r"(\d+)S"),
2851
datetime.timedelta(seconds=1),
2852
frozenset((token_end, )))
2853
token_minute = Token(re.compile(r"(\d+)M"),
2854
datetime.timedelta(minutes=1),
2855
frozenset((token_second, token_end)))
2856
token_hour = Token(re.compile(r"(\d+)H"),
2857
datetime.timedelta(hours=1),
2858
frozenset((token_minute, token_end)))
2859
token_time = Token(re.compile(r"T"),
2861
frozenset((token_hour, token_minute,
2863
token_day = Token(re.compile(r"(\d+)D"),
2864
datetime.timedelta(days=1),
2865
frozenset((token_time, token_end)))
2866
token_month = Token(re.compile(r"(\d+)M"),
2867
datetime.timedelta(weeks=4),
2868
frozenset((token_day, token_end)))
2869
token_year = Token(re.compile(r"(\d+)Y"),
2870
datetime.timedelta(weeks=52),
2871
frozenset((token_month, token_end)))
2872
token_week = Token(re.compile(r"(\d+)W"),
2873
datetime.timedelta(weeks=1),
2874
frozenset((token_end, )))
2875
token_duration = Token(re.compile(r"P"), None,
2876
frozenset((token_year, token_month,
2877
token_day, token_time,
2879
# Define starting values:
2881
value = datetime.timedelta()
2883
# Following valid tokens
2884
followers = frozenset((token_duration, ))
2885
# String left to parse
2887
# Loop until end token is found
2888
while found_token is not token_end:
2889
# Search for any currently valid tokens
2890
for token in followers:
2891
match = token.regexp.match(s)
2892
if match is not None:
2894
if token.value is not None:
2895
# Value found, parse digits
2896
factor = int(match.group(1), 10)
2897
# Add to value so far
2898
value += factor * token.value
2899
# Strip token from string
2900
s = token.regexp.sub("", s, 1)
2903
# Set valid next tokens
2904
followers = found_token.followers
2907
# No currently valid tokens were found
2908
raise ValueError("Invalid RFC 3339 duration: {!r}"
544
return super(type(self), self).server_bind()
2914
547
def string_to_delta(interval):
2915
548
"""Parse a string and return a datetime.timedelta
2917
>>> string_to_delta('7d') == datetime.timedelta(7)
2919
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2921
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2923
>>> string_to_delta('24h') == datetime.timedelta(1)
2925
>>> string_to_delta('1w') == datetime.timedelta(7)
2927
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
550
>>> string_to_delta('7d')
551
datetime.timedelta(7)
552
>>> string_to_delta('60s')
553
datetime.timedelta(0, 60)
554
>>> string_to_delta('60m')
555
datetime.timedelta(0, 3600)
556
>>> string_to_delta('24h')
557
datetime.timedelta(1)
558
>>> string_to_delta(u'1w')
559
datetime.timedelta(7)
2932
return rfc3339_duration_to_delta(interval)
2936
timevalue = datetime.timedelta(0)
2937
for s in interval.split():
2942
delta = datetime.timedelta(value)
2944
delta = datetime.timedelta(0, value)
2946
delta = datetime.timedelta(0, 0, 0, 0, value)
2948
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2950
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2952
raise ValueError("Unknown suffix {!r}".format(suffix))
2953
except IndexError as e:
2954
raise ValueError(*(e.args))
2959
def daemon(nochdir=False, noclose=False):
562
suffix=unicode(interval[-1])
563
value=int(interval[:-1])
565
delta = datetime.timedelta(value)
567
delta = datetime.timedelta(0, value)
569
delta = datetime.timedelta(0, 0, 0, 0, value)
571
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
573
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
576
except (ValueError, IndexError):
581
def server_state_changed(state):
582
"""Derived from the Avahi example code"""
583
if state == avahi.SERVER_COLLISION:
584
logger.error(u"Server name collision")
586
elif state == avahi.SERVER_RUNNING:
590
def entry_group_state_changed(state, error):
591
"""Derived from the Avahi example code"""
592
logger.debug(u"state change: %i", state)
594
if state == avahi.ENTRY_GROUP_ESTABLISHED:
595
logger.debug(u"Service established.")
596
elif state == avahi.ENTRY_GROUP_COLLISION:
597
logger.warning(u"Service name collision.")
599
elif state == avahi.ENTRY_GROUP_FAILURE:
600
logger.critical(u"Error in group state changed %s",
602
raise AvahiGroupError("State changed: %s", str(error))
604
def if_nametoindex(interface):
605
"""Call the C function if_nametoindex(), or equivalent"""
606
global if_nametoindex
608
if "ctypes.util" not in sys.modules:
610
if_nametoindex = ctypes.cdll.LoadLibrary\
611
(ctypes.util.find_library("c")).if_nametoindex
612
except (OSError, AttributeError):
613
if "struct" not in sys.modules:
615
if "fcntl" not in sys.modules:
617
def if_nametoindex(interface):
618
"Get an interface index the hard way, i.e. using fcntl()"
619
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
621
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
622
struct.pack("16s16x", interface))
624
interface_index = struct.unpack("I", ifreq[16:20])[0]
625
return interface_index
626
return if_nametoindex(interface)
629
def daemon(nochdir = False, noclose = False):
2960
630
"""See daemon(3). Standard BSD Unix function.
2962
631
This should really exist as os.daemon, but it doesn't (yet)."""
2986
##################################################################
2987
# Parsing of options, both command line and config file
2989
parser = argparse.ArgumentParser()
2990
parser.add_argument("-v", "--version", action="version",
2991
version="%(prog)s {}".format(version),
2992
help="show version number and exit")
2993
parser.add_argument("-i", "--interface", metavar="IF",
2994
help="Bind to interface IF")
2995
parser.add_argument("-a", "--address",
2996
help="Address to listen for requests on")
2997
parser.add_argument("-p", "--port", type=int,
2998
help="Port number to receive requests on")
2999
parser.add_argument("--check", action="store_true",
3000
help="Run self-test")
3001
parser.add_argument("--debug", action="store_true",
3002
help="Debug mode; run in foreground and log"
3003
" to terminal", default=None)
3004
parser.add_argument("--debuglevel", metavar="LEVEL",
3005
help="Debug level for stdout output")
3006
parser.add_argument("--priority", help="GnuTLS"
3007
" priority string (see GnuTLS documentation)")
3008
parser.add_argument("--servicename",
3009
metavar="NAME", help="Zeroconf service name")
3010
parser.add_argument("--configdir",
3011
default="/etc/mandos", metavar="DIR",
3012
help="Directory to search for configuration"
3014
parser.add_argument("--no-dbus", action="store_false",
3015
dest="use_dbus", help="Do not provide D-Bus"
3016
" system bus interface", default=None)
3017
parser.add_argument("--no-ipv6", action="store_false",
3018
dest="use_ipv6", help="Do not use IPv6",
3020
parser.add_argument("--no-restore", action="store_false",
3021
dest="restore", help="Do not restore stored"
3022
" state", default=None)
3023
parser.add_argument("--socket", type=int,
3024
help="Specify a file descriptor to a network"
3025
" socket to use instead of creating one")
3026
parser.add_argument("--statedir", metavar="DIR",
3027
help="Directory to save/restore state in")
3028
parser.add_argument("--foreground", action="store_true",
3029
help="Run in foreground", default=None)
3030
parser.add_argument("--no-zeroconf", action="store_false",
3031
dest="zeroconf", help="Do not use Zeroconf",
3034
options = parser.parse_args()
653
global main_loop_started
654
main_loop_started = False
656
parser = OptionParser()
657
parser.add_option("-i", "--interface", type="string",
658
metavar="IF", help="Bind to interface IF")
659
parser.add_option("-a", "--address", type="string",
660
help="Address to listen for requests on")
661
parser.add_option("-p", "--port", type="int",
662
help="Port number to receive requests on")
663
parser.add_option("--check", action="store_true", default=False,
664
help="Run self-test")
665
parser.add_option("--debug", action="store_true",
666
help="Debug mode; run in foreground and log to"
668
parser.add_option("--priority", type="string", help="GnuTLS"
669
" priority string (see GnuTLS documentation)")
670
parser.add_option("--servicename", type="string", metavar="NAME",
671
help="Zeroconf service name")
672
parser.add_option("--configdir", type="string",
673
default="/etc/mandos", metavar="DIR",
674
help="Directory to search for configuration"
676
(options, args) = parser.parse_args()
3036
683
# Default values for config file for server-global settings
3037
if gnutls.has_rawpk:
3038
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3039
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3041
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3042
":+SIGN-DSA-SHA256")
3043
server_defaults = {"interface": "",
3047
"priority": priority,
3048
"servicename": "Mandos",
3054
"statedir": "/var/lib/mandos",
3055
"foreground": "False",
684
server_defaults = { "interface": "",
689
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
690
"servicename": "Mandos",
3060
693
# Parse config file for server-global settings
3061
server_config = configparser.ConfigParser(server_defaults)
694
server_config = ConfigParser.SafeConfigParser(server_defaults)
3062
695
del server_defaults
3063
696
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3064
# Convert the ConfigParser object to a dict
3065
server_settings = server_config.defaults()
3066
# Use the appropriate methods on the non-string config options
3067
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3068
"foreground", "zeroconf"):
3069
server_settings[option] = server_config.getboolean("DEFAULT",
3071
if server_settings["port"]:
3072
server_settings["port"] = server_config.getint("DEFAULT",
3074
if server_settings["socket"]:
3075
server_settings["socket"] = server_config.getint("DEFAULT",
3077
# Later, stdin will, and stdout and stderr might, be dup'ed
3078
# over with an opened os.devnull. But we don't want this to
3079
# happen with a supplied network socket.
3080
if 0 <= server_settings["socket"] <= 2:
3081
server_settings["socket"] = os.dup(server_settings
697
server_section = "server"
698
# Convert the SafeConfigParser object to a dict
699
server_settings = dict(server_config.items(server_section))
700
# Use getboolean on the boolean config option
701
server_settings["debug"] = server_config.getboolean\
702
(server_section, "debug")
3083
703
del server_config
3085
705
# Override the settings from the config file with command line
3086
706
# options, if set.
3087
707
for option in ("interface", "address", "port", "debug",
3088
"priority", "servicename", "configdir", "use_dbus",
3089
"use_ipv6", "debuglevel", "restore", "statedir",
3090
"socket", "foreground", "zeroconf"):
708
"priority", "servicename", "configdir"):
3091
709
value = getattr(options, option)
3092
710
if value is not None:
3093
711
server_settings[option] = value
3095
# Force all strings to be unicode
3096
for option in server_settings.keys():
3097
if isinstance(server_settings[option], bytes):
3098
server_settings[option] = (server_settings[option]
3100
# Force all boolean options to be boolean
3101
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3102
"foreground", "zeroconf"):
3103
server_settings[option] = bool(server_settings[option])
3104
# Debug implies foreground
3105
if server_settings["debug"]:
3106
server_settings["foreground"] = True
3107
713
# Now we have our good server settings in "server_settings"
3109
##################################################################
3111
if (not server_settings["zeroconf"]
3112
and not (server_settings["port"]
3113
or server_settings["socket"] != "")):
3114
parser.error("Needs port or socket to work without Zeroconf")
3117
715
debug = server_settings["debug"]
3118
debuglevel = server_settings["debuglevel"]
3119
use_dbus = server_settings["use_dbus"]
3120
use_ipv6 = server_settings["use_ipv6"]
3121
stored_state_path = os.path.join(server_settings["statedir"],
3123
foreground = server_settings["foreground"]
3124
zeroconf = server_settings["zeroconf"]
3127
initlogger(debug, logging.DEBUG)
3132
level = getattr(logging, debuglevel.upper())
3133
initlogger(debug, level)
718
syslogger.setLevel(logging.WARNING)
3135
720
if server_settings["servicename"] != "Mandos":
3136
syslogger.setFormatter(
3137
logging.Formatter('Mandos ({}) [%(process)d]:'
3138
' %(levelname)s: %(message)s'.format(
3139
server_settings["servicename"])))
721
syslogger.setFormatter(logging.Formatter\
722
('Mandos (%s): %%(levelname)s:'
724
% server_settings["servicename"]))
3141
726
# Parse config file with clients
3142
client_config = configparser.ConfigParser(Client.client_defaults)
727
client_defaults = { "timeout": "1h",
729
"checker": "fping -q -- %%(host)s",
731
client_config = ConfigParser.SafeConfigParser(client_defaults)
3143
732
client_config.read(os.path.join(server_settings["configdir"],
3144
733
"clients.conf"))
3146
global mandos_dbus_service
3147
mandos_dbus_service = None
3150
if server_settings["socket"] != "":
3151
socketfd = server_settings["socket"]
3152
tcp_server = MandosServer(
3153
(server_settings["address"], server_settings["port"]),
3155
interface=(server_settings["interface"] or None),
3157
gnutls_priority=server_settings["priority"],
3161
pidfilename = "/run/mandos.pid"
3162
if not os.path.isdir("/run/."):
3163
pidfilename = "/var/run/mandos.pid"
3166
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3167
except IOError as e:
3168
logger.error("Could not open file %r", pidfilename,
3171
for name, group in (("_mandos", "_mandos"),
3172
("mandos", "mandos"),
3173
("nobody", "nogroup")):
3175
uid = pwd.getpwnam(name).pw_uid
3176
gid = pwd.getpwnam(group).pw_gid
3187
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3189
except OSError as error:
3190
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3191
.format(uid, gid, os.strerror(error.errno)))
3192
if error.errno != errno.EPERM:
3196
# Enable all possible GnuTLS debugging
3198
# "Use a log level over 10 to enable all debugging options."
3200
gnutls.global_set_log_level(11)
3203
def debug_gnutls(level, string):
3204
logger.debug("GnuTLS: %s",
3205
string[:-1].decode("utf-8",
3208
gnutls.global_set_log_function(debug_gnutls)
3210
# Redirect stdin so all checkers get /dev/null
3211
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3212
os.dup2(null, sys.stdin.fileno())
3216
# Need to fork before connecting to D-Bus
3218
# Close all input and output, do double fork, etc.
3221
if gi.version_info < (3, 10, 2):
3222
# multiprocessing will use threads, so before we use GLib we
3223
# need to inform GLib that threads will be used.
736
service = AvahiService(name = server_settings["servicename"],
737
type = "_mandos._tcp", );
738
if server_settings["interface"]:
739
service.interface = if_nametoindex(server_settings["interface"])
3226
741
global main_loop
3227
744
# From the Avahi example code
3228
DBusGMainLoop(set_as_default=True)
3229
main_loop = GLib.MainLoop()
745
DBusGMainLoop(set_as_default=True )
746
main_loop = gobject.MainLoop()
3230
747
bus = dbus.SystemBus()
748
server = dbus.Interface(
749
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
750
avahi.DBUS_INTERFACE_SERVER )
3231
751
# End of Avahi example code
3234
bus_name = dbus.service.BusName("se.recompile.Mandos",
3237
old_bus_name = dbus.service.BusName(
3238
"se.bsnet.fukt.Mandos", bus,
3240
except dbus.exceptions.DBusException as e:
3241
logger.error("Disabling D-Bus:", exc_info=e)
3243
server_settings["use_dbus"] = False
3244
tcp_server.use_dbus = False
3246
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3247
service = AvahiServiceToSyslog(
3248
name=server_settings["servicename"],
3249
servicetype="_mandos._tcp",
3252
if server_settings["interface"]:
3253
service.interface = if_nametoindex(
3254
server_settings["interface"].encode("utf-8"))
3256
global multiprocessing_manager
3257
multiprocessing_manager = multiprocessing.Manager()
3259
client_class = Client
3261
client_class = functools.partial(ClientDBus, bus=bus)
3263
client_settings = Client.config_parser(client_config)
3264
old_client_settings = {}
3267
# This is used to redirect stdout and stderr for checker processes
3269
wnull = open(os.devnull, "w") # A writable /dev/null
3270
# Only used if server is running in foreground but not in debug
3272
if debug or not foreground:
3275
# Get client data and settings from last running state.
3276
if server_settings["restore"]:
3278
with open(stored_state_path, "rb") as stored_state:
3279
if sys.version_info.major == 2:
3280
clients_data, old_client_settings = pickle.load(
3283
bytes_clients_data, bytes_old_client_settings = (
3284
pickle.load(stored_state, encoding="bytes"))
3285
# Fix bytes to strings
3288
clients_data = {(key.decode("utf-8")
3289
if isinstance(key, bytes)
3292
bytes_clients_data.items()}
3293
del bytes_clients_data
3294
for key in clients_data:
3295
value = {(k.decode("utf-8")
3296
if isinstance(k, bytes) else k): v
3298
clients_data[key].items()}
3299
clients_data[key] = value
3301
value["client_structure"] = [
3303
if isinstance(s, bytes)
3305
value["client_structure"]]
3306
# .name, .host, and .checker_command
3307
for k in ("name", "host", "checker_command"):
3308
if isinstance(value[k], bytes):
3309
value[k] = value[k].decode("utf-8")
3310
if "key_id" not in value:
3311
value["key_id"] = ""
3312
elif "fingerprint" not in value:
3313
value["fingerprint"] = ""
3314
# old_client_settings
3316
old_client_settings = {
3317
(key.decode("utf-8")
3318
if isinstance(key, bytes)
3321
bytes_old_client_settings.items()}
3322
del bytes_old_client_settings
3323
# .host and .checker_command
3324
for value in old_client_settings.values():
3325
for attribute in ("host", "checker_command"):
3326
if isinstance(value[attribute], bytes):
3327
value[attribute] = (value[attribute]
3329
os.remove(stored_state_path)
3330
except IOError as e:
3331
if e.errno == errno.ENOENT:
3332
logger.warning("Could not load persistent state:"
3333
" {}".format(os.strerror(e.errno)))
3335
logger.critical("Could not load persistent state:",
3338
except EOFError as e:
3339
logger.warning("Could not load persistent state: "
3343
with PGPEngine() as pgp:
3344
for client_name, client in clients_data.items():
3345
# Skip removed clients
3346
if client_name not in client_settings:
3349
# Decide which value to use after restoring saved state.
3350
# We have three different values: Old config file,
3351
# new config file, and saved state.
3352
# New config value takes precedence if it differs from old
3353
# config value, otherwise use saved state.
3354
for name, value in client_settings[client_name].items():
3356
# For each value in new config, check if it
3357
# differs from the old config value (Except for
3358
# the "secret" attribute)
3359
if (name != "secret"
3361
old_client_settings[client_name][name])):
3362
client[name] = value
3366
# Clients who has passed its expire date can still be
3367
# enabled if its last checker was successful. A Client
3368
# whose checker succeeded before we stored its state is
3369
# assumed to have successfully run all checkers during
3371
if client["enabled"]:
3372
if datetime.datetime.utcnow() >= client["expires"]:
3373
if not client["last_checked_ok"]:
3375
"disabling client {} - Client never "
3376
"performed a successful checker".format(
3378
client["enabled"] = False
3379
elif client["last_checker_status"] != 0:
3381
"disabling client {} - Client last"
3382
" checker failed with error code"
3385
client["last_checker_status"]))
3386
client["enabled"] = False
3388
client["expires"] = (
3389
datetime.datetime.utcnow()
3390
+ client["timeout"])
3391
logger.debug("Last checker succeeded,"
3392
" keeping {} enabled".format(
3395
client["secret"] = pgp.decrypt(
3396
client["encrypted_secret"],
3397
client_settings[client_name]["secret"])
3399
# If decryption fails, we use secret from new settings
3400
logger.debug("Failed to decrypt {} old secret".format(
3402
client["secret"] = (client_settings[client_name]
3405
# Add/remove clients based on new changes made to config
3406
for client_name in (set(old_client_settings)
3407
- set(client_settings)):
3408
del clients_data[client_name]
3409
for client_name in (set(client_settings)
3410
- set(old_client_settings)):
3411
clients_data[client_name] = client_settings[client_name]
3413
# Create all client objects
3414
for client_name, client in clients_data.items():
3415
tcp_server.clients[client_name] = client_class(
3418
server_settings=server_settings)
3420
if not tcp_server.clients:
3421
logger.warning("No clients defined")
3424
if pidfile is not None:
3428
print(pid, file=pidfile)
3430
logger.error("Could not write to file %r with PID %d",
754
console = logging.StreamHandler()
755
# console.setLevel(logging.DEBUG)
756
console.setFormatter(logging.Formatter\
757
('%(levelname)s: %(message)s'))
758
logger.addHandler(console)
762
def remove_from_clients(client):
763
clients.remove(client)
765
logger.critical(u"No clients left, exiting")
768
clients.update(Set(Client(name = section,
769
stop_hook = remove_from_clients,
771
= dict(client_config.items(section)))
772
for section in client_config.sections()))
774
logger.critical(u"No clients defined")
780
pidfilename = "/var/run/mandos/mandos.pid"
783
pidfile = open(pidfilename, "w")
784
pidfile.write(str(pid) + "\n")
3435
for termsig in (signal.SIGHUP, signal.SIGTERM):
3436
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3437
lambda: main_loop.quit() and False)
3441
@alternate_dbus_interfaces(
3442
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3443
class MandosDBusService(DBusObjectWithObjectManager):
3444
"""A D-Bus proxy object"""
3447
dbus.service.Object.__init__(self, bus, "/")
3449
_interface = "se.recompile.Mandos"
3451
@dbus.service.signal(_interface, signature="o")
3452
def ClientAdded(self, objpath):
3456
@dbus.service.signal(_interface, signature="ss")
3457
def ClientNotFound(self, key_id, address):
3461
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3463
@dbus.service.signal(_interface, signature="os")
3464
def ClientRemoved(self, objpath, name):
3468
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3470
@dbus.service.method(_interface, out_signature="ao")
3471
def GetAllClients(self):
3473
return dbus.Array(c.dbus_object_path for c in
3474
tcp_server.clients.values())
3476
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3478
@dbus.service.method(_interface,
3479
out_signature="a{oa{sv}}")
3480
def GetAllClientsWithProperties(self):
3482
return dbus.Dictionary(
3483
{c.dbus_object_path: c.GetAll(
3484
"se.recompile.Mandos.Client")
3485
for c in tcp_server.clients.values()},
3488
@dbus.service.method(_interface, in_signature="o")
3489
def RemoveClient(self, object_path):
3491
for c in tcp_server.clients.values():
3492
if c.dbus_object_path == object_path:
3493
del tcp_server.clients[c.name]
3494
c.remove_from_connection()
3495
# Don't signal the disabling
3496
c.disable(quiet=True)
3497
# Emit D-Bus signal for removal
3498
self.client_removed_signal(c)
3500
raise KeyError(object_path)
3504
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3505
out_signature="a{oa{sa{sv}}}")
3506
def GetManagedObjects(self):
3508
return dbus.Dictionary(
3509
{client.dbus_object_path:
3511
{interface: client.GetAll(interface)
3513
client._get_all_interface_names()})
3514
for client in tcp_server.clients.values()})
3516
def client_added_signal(self, client):
3517
"""Send the new standard signal and the old signal"""
3519
# New standard signal
3520
self.InterfacesAdded(
3521
client.dbus_object_path,
3523
{interface: client.GetAll(interface)
3525
client._get_all_interface_names()}))
3527
self.ClientAdded(client.dbus_object_path)
3529
def client_removed_signal(self, client):
3530
"""Send the new standard signal and the old signal"""
3532
# New standard signal
3533
self.InterfacesRemoved(
3534
client.dbus_object_path,
3535
client._get_all_interface_names())
3537
self.ClientRemoved(client.dbus_object_path,
3540
mandos_dbus_service = MandosDBusService()
3542
# Save modules to variables to exempt the modules from being
3543
# unloaded before the function registered with atexit() is run.
3544
mp = multiprocessing
788
logger.error(u"Could not write %s file with PID %d",
789
pidfilename, os.getpid())
3548
792
"Cleanup function; run on exit"
3552
mp.active_children()
3554
if not (tcp_server.clients or client_settings):
3557
# Store client before exiting. Secrets are encrypted with key
3558
# based on what config file has. If config file is
3559
# removed/edited, old secret will thus be unrecovable.
3561
with PGPEngine() as pgp:
3562
for client in tcp_server.clients.values():
3563
key = client_settings[client.name]["secret"]
3564
client.encrypted_secret = pgp.encrypt(client.secret,
3568
# A list of attributes that can not be pickled
3570
exclude = {"bus", "changedstate", "secret",
3571
"checker", "server_settings"}
3572
for name, typ in inspect.getmembers(dbus.service
3576
client_dict["encrypted_secret"] = (client
3578
for attr in client.client_structure:
3579
if attr not in exclude:
3580
client_dict[attr] = getattr(client, attr)
3582
clients[client.name] = client_dict
3583
del client_settings[client.name]["secret"]
3586
with tempfile.NamedTemporaryFile(
3590
dir=os.path.dirname(stored_state_path),
3591
delete=False) as stored_state:
3592
pickle.dump((clients, client_settings), stored_state,
3594
tempname = stored_state.name
3595
os.rename(tempname, stored_state_path)
3596
except (IOError, OSError) as e:
3602
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3603
logger.warning("Could not save persistent state: {}"
3604
.format(os.strerror(e.errno)))
3606
logger.warning("Could not save persistent state:",
3610
# Delete all clients, and settings from config
3611
while tcp_server.clients:
3612
name, client = tcp_server.clients.popitem()
3614
client.remove_from_connection()
3615
# Don't signal the disabling
3616
client.disable(quiet=True)
3617
# Emit D-Bus signal for removal
3619
mandos_dbus_service.client_removed_signal(client)
3620
client_settings.clear()
794
# From the Avahi example code
795
if not group is None:
798
# End of Avahi example code
801
client = clients.pop()
802
client.stop_hook = None
3622
805
atexit.register(cleanup)
3624
for client in tcp_server.clients.values():
3626
# Emit D-Bus signal for adding
3627
mandos_dbus_service.client_added_signal(client)
3628
# Need to initiate checking of clients
3630
client.init_checker()
3633
tcp_server.server_activate()
808
signal.signal(signal.SIGINT, signal.SIG_IGN)
809
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
810
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
812
for client in clients:
815
tcp_server = IPv6_TCPServer((server_settings["address"],
816
server_settings["port"]),
818
settings=server_settings,
3635
820
# Find out what port we got
3637
service.port = tcp_server.socket.getsockname()[1]
3639
logger.info("Now listening on address %r, port %d,"
3640
" flowinfo %d, scope_id %d",
3641
*tcp_server.socket.getsockname())
3643
logger.info("Now listening on address %r, port %d",
3644
*tcp_server.socket.getsockname())
3646
# service.interface = tcp_server.socket.getsockname()[3]
821
service.port = tcp_server.socket.getsockname()[1]
822
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
823
u" scope_id %d" % tcp_server.socket.getsockname())
825
#service.interface = tcp_server.socket.getsockname()[3]
3650
# From the Avahi example code
3653
except dbus.exceptions.DBusException as error:
3654
logger.critical("D-Bus Exception", exc_info=error)
3657
# End of Avahi example code
3660
GLib.IOChannel.unix_new(tcp_server.fileno()),
3661
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3662
lambda *args, **kwargs: (tcp_server.handle_request
3663
(*args[2:], **kwargs) or True))
3665
logger.debug("Starting main loop")
828
# From the Avahi example code
829
server.connect_to_signal("StateChanged", server_state_changed)
831
server_state_changed(server.GetState())
832
except dbus.exceptions.DBusException, error:
833
logger.critical(u"DBusException: %s", error)
835
# End of Avahi example code
837
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
838
lambda *args, **kwargs:
839
tcp_server.handle_request\
840
(*args[2:], **kwargs) or True)
842
logger.debug(u"Starting main loop")
843
main_loop_started = True
3667
except AvahiError as error:
3668
logger.critical("Avahi Error", exc_info=error)
845
except AvahiError, error:
846
logger.critical(u"AvahiError: %s" + unicode(error))
3671
848
except KeyboardInterrupt:
3673
print("", file=sys.stderr)
3674
logger.debug("Server received KeyboardInterrupt")
3675
logger.debug("Server exiting")
3676
# Must run before the D-Bus bus name gets deregistered
3680
def should_only_run_tests():
3681
parser = argparse.ArgumentParser(add_help=False)
3682
parser.add_argument("--check", action='store_true')
3683
args, unknown_args = parser.parse_known_args()
3684
run_tests = args.check
3686
# Remove --check argument from sys.argv
3687
sys.argv[1:] = unknown_args
3690
# Add all tests from doctest strings
3691
def load_tests(loader, tests, none):
3693
tests.addTests(doctest.DocTestSuite())
3696
852
if __name__ == '__main__':
3698
if should_only_run_tests():
3699
# Call using ./mandos --check [--verbose]