343
100
max_renames: integer; maximum number of renames
344
101
rename_count: integer; counter so we only rename after collisions
345
102
a sensible number of times
346
group: D-Bus Entry Group
348
bus: dbus.SystemBus()
352
interface=avahi.IF_UNSPEC,
360
protocol=avahi.PROTO_UNSPEC,
104
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
105
type = None, port = None, TXT = None, domain = "",
106
host = "", max_renames = 32768):
362
107
self.interface = interface
364
self.type = servicetype
366
self.TXT = TXT if TXT is not None else []
367
115
self.domain = domain
369
117
self.rename_count = 0
370
self.max_renames = max_renames
371
self.protocol = protocol
372
self.group = None # our entry group
375
self.entry_group_state_changed_match = None
377
def rename(self, remove=True):
378
119
"""Derived from the Avahi example code"""
379
120
if self.rename_count >= self.max_renames:
380
logger.critical("No suitable Zeroconf service name found"
381
" after %i retries, exiting.",
121
logger.critical(u"No suitable service name found after %i"
122
u" retries, exiting.", rename_count)
383
123
raise AvahiServiceError("Too many renames")
385
self.server.GetAlternativeServiceName(self.name))
124
name = server.GetAlternativeServiceName(name)
125
logger.error(u"Changing name to %r ...", name)
126
syslogger.setFormatter(logging.Formatter\
127
('Mandos (%s): %%(levelname)s:'
128
' %%(message)s' % name))
386
131
self.rename_count += 1
387
logger.info("Changing Zeroconf service name to %r ...",
393
except dbus.exceptions.DBusException as error:
394
if (error.get_dbus_name()
395
== "org.freedesktop.Avahi.CollisionError"):
396
logger.info("Local Zeroconf service name collision.")
397
return self.rename(remove=False)
399
logger.critical("D-Bus Exception", exc_info=error)
403
132
def remove(self):
404
133
"""Derived from the Avahi example code"""
405
if self.entry_group_state_changed_match is not None:
406
self.entry_group_state_changed_match.remove()
407
self.entry_group_state_changed_match = None
408
if self.group is not None:
134
if group is not None:
412
137
"""Derived from the Avahi example code"""
414
if self.group is None:
415
self.group = dbus.Interface(
416
self.bus.get_object(avahi.DBUS_NAME,
417
self.server.EntryGroupNew()),
418
avahi.DBUS_INTERFACE_ENTRY_GROUP)
419
self.entry_group_state_changed_match = (
420
self.group.connect_to_signal(
421
'StateChanged', self.entry_group_state_changed))
422
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
423
self.name, self.type)
424
self.group.AddService(
427
dbus.UInt32(0), # flags
428
self.name, self.type,
429
self.domain, self.host,
430
dbus.UInt16(self.port),
431
avahi.string_array_to_txt_array(self.TXT))
434
def entry_group_state_changed(self, state, error):
435
"""Derived from the Avahi example code"""
436
logger.debug("Avahi entry group state change: %i", state)
438
if state == avahi.ENTRY_GROUP_ESTABLISHED:
439
logger.debug("Zeroconf service established.")
440
elif state == avahi.ENTRY_GROUP_COLLISION:
441
logger.info("Zeroconf service name collision.")
443
elif state == avahi.ENTRY_GROUP_FAILURE:
444
logger.critical("Avahi: Error in group state changed %s",
446
raise AvahiGroupError("State changed: {!s}".format(error))
449
"""Derived from the Avahi example code"""
450
if self.group is not None:
453
except (dbus.exceptions.UnknownMethodException,
454
dbus.exceptions.DBusException):
459
def server_state_changed(self, state, error=None):
460
"""Derived from the Avahi example code"""
461
logger.debug("Avahi server state change: %i", state)
463
avahi.SERVER_INVALID: "Zeroconf server invalid",
464
avahi.SERVER_REGISTERING: None,
465
avahi.SERVER_COLLISION: "Zeroconf server name collision",
466
avahi.SERVER_FAILURE: "Zeroconf server failure",
468
if state in bad_states:
469
if bad_states[state] is not None:
471
logger.error(bad_states[state])
473
logger.error(bad_states[state] + ": %r", error)
475
elif state == avahi.SERVER_RUNNING:
478
except dbus.exceptions.DBusException as error:
479
if (error.get_dbus_name()
480
== "org.freedesktop.Avahi.CollisionError"):
481
logger.info("Local Zeroconf service name"
483
return self.rename(remove=False)
485
logger.critical("D-Bus Exception", exc_info=error)
490
logger.debug("Unknown state: %r", state)
492
logger.debug("Unknown state: %r: %r", state, error)
495
"""Derived from the Avahi example code"""
496
if self.server is None:
497
self.server = dbus.Interface(
498
self.bus.get_object(avahi.DBUS_NAME,
499
avahi.DBUS_PATH_SERVER,
500
follow_name_owner_changes=True),
501
avahi.DBUS_INTERFACE_SERVER)
502
self.server.connect_to_signal("StateChanged",
503
self.server_state_changed)
504
self.server_state_changed(self.server.GetState())
507
class AvahiServiceToSyslog(AvahiService):
508
def rename(self, *args, **kwargs):
509
"""Add the new name to the syslog messages"""
510
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
511
syslogger.setFormatter(logging.Formatter(
512
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
517
# Pretend that we have a GnuTLS module
519
"""This isn't so much a class as it is a module-like namespace."""
521
library = ctypes.util.find_library("gnutls")
523
library = ctypes.util.find_library("gnutls-deb0")
524
_library = ctypes.cdll.LoadLibrary(library)
527
# Unless otherwise indicated, the constants and types below are
528
# all from the gnutls/gnutls.h C header file.
539
E_NO_CERTIFICATE_FOUND = -49
544
KEYID_USE_SHA256 = 1 # gnutls/x509.h
545
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
548
class session_int(ctypes.Structure):
550
session_t = ctypes.POINTER(session_int)
552
class certificate_credentials_st(ctypes.Structure):
554
certificate_credentials_t = ctypes.POINTER(
555
certificate_credentials_st)
556
certificate_type_t = ctypes.c_int
558
class datum_t(ctypes.Structure):
559
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
560
('size', ctypes.c_uint)]
562
class openpgp_crt_int(ctypes.Structure):
564
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
565
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
566
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
567
credentials_type_t = ctypes.c_int
568
transport_ptr_t = ctypes.c_void_p
569
close_request_t = ctypes.c_int
572
class Error(Exception):
573
def __init__(self, message=None, code=None, args=()):
574
# Default usage is by a message string, but if a return
575
# code is passed, convert it to a string with
578
if message is None and code is not None:
579
message = gnutls.strerror(code)
580
return super(gnutls.Error, self).__init__(
583
class CertificateSecurityError(Error):
589
self._c_object = gnutls.certificate_credentials_t()
590
gnutls.certificate_allocate_credentials(
591
ctypes.byref(self._c_object))
592
self.type = gnutls.CRD_CERTIFICATE
595
gnutls.certificate_free_credentials(self._c_object)
598
def __init__(self, socket, credentials=None):
599
self._c_object = gnutls.session_t()
600
gnutls_flags = gnutls.CLIENT
601
if gnutls.check_version(b"3.5.6"):
602
gnutls_flags |= gnutls.NO_TICKETS
604
gnutls_flags |= gnutls.ENABLE_RAWPK
605
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
607
gnutls.set_default_priority(self._c_object)
608
gnutls.transport_set_ptr(self._c_object, socket.fileno())
609
gnutls.handshake_set_private_extensions(self._c_object,
612
if credentials is None:
613
credentials = gnutls.Credentials()
614
gnutls.credentials_set(self._c_object, credentials.type,
615
ctypes.cast(credentials._c_object,
617
self.credentials = credentials
620
gnutls.deinit(self._c_object)
623
return gnutls.handshake(self._c_object)
625
def send(self, data):
629
data_len -= gnutls.record_send(self._c_object,
634
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
636
# Error handling functions
637
def _error_code(result):
638
"""A function to raise exceptions on errors, suitable
639
for the 'restype' attribute on ctypes functions"""
642
if result == gnutls.E_NO_CERTIFICATE_FOUND:
643
raise gnutls.CertificateSecurityError(code=result)
644
raise gnutls.Error(code=result)
646
def _retry_on_error(result, func, arguments):
647
"""A function to retry on some errors, suitable
648
for the 'errcheck' attribute on ctypes functions"""
650
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
651
return _error_code(result)
652
result = func(*arguments)
655
# Unless otherwise indicated, the function declarations below are
656
# all from the gnutls/gnutls.h C header file.
659
priority_set_direct = _library.gnutls_priority_set_direct
660
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
661
ctypes.POINTER(ctypes.c_char_p)]
662
priority_set_direct.restype = _error_code
664
init = _library.gnutls_init
665
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
666
init.restype = _error_code
668
set_default_priority = _library.gnutls_set_default_priority
669
set_default_priority.argtypes = [session_t]
670
set_default_priority.restype = _error_code
672
record_send = _library.gnutls_record_send
673
record_send.argtypes = [session_t, ctypes.c_void_p,
675
record_send.restype = ctypes.c_ssize_t
676
record_send.errcheck = _retry_on_error
678
certificate_allocate_credentials = (
679
_library.gnutls_certificate_allocate_credentials)
680
certificate_allocate_credentials.argtypes = [
681
ctypes.POINTER(certificate_credentials_t)]
682
certificate_allocate_credentials.restype = _error_code
684
certificate_free_credentials = (
685
_library.gnutls_certificate_free_credentials)
686
certificate_free_credentials.argtypes = [
687
certificate_credentials_t]
688
certificate_free_credentials.restype = None
690
handshake_set_private_extensions = (
691
_library.gnutls_handshake_set_private_extensions)
692
handshake_set_private_extensions.argtypes = [session_t,
694
handshake_set_private_extensions.restype = None
696
credentials_set = _library.gnutls_credentials_set
697
credentials_set.argtypes = [session_t, credentials_type_t,
699
credentials_set.restype = _error_code
701
strerror = _library.gnutls_strerror
702
strerror.argtypes = [ctypes.c_int]
703
strerror.restype = ctypes.c_char_p
705
certificate_type_get = _library.gnutls_certificate_type_get
706
certificate_type_get.argtypes = [session_t]
707
certificate_type_get.restype = _error_code
709
certificate_get_peers = _library.gnutls_certificate_get_peers
710
certificate_get_peers.argtypes = [session_t,
711
ctypes.POINTER(ctypes.c_uint)]
712
certificate_get_peers.restype = ctypes.POINTER(datum_t)
714
global_set_log_level = _library.gnutls_global_set_log_level
715
global_set_log_level.argtypes = [ctypes.c_int]
716
global_set_log_level.restype = None
718
global_set_log_function = _library.gnutls_global_set_log_function
719
global_set_log_function.argtypes = [log_func]
720
global_set_log_function.restype = None
722
deinit = _library.gnutls_deinit
723
deinit.argtypes = [session_t]
724
deinit.restype = None
726
handshake = _library.gnutls_handshake
727
handshake.argtypes = [session_t]
728
handshake.restype = _error_code
729
handshake.errcheck = _retry_on_error
731
transport_set_ptr = _library.gnutls_transport_set_ptr
732
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
733
transport_set_ptr.restype = None
735
bye = _library.gnutls_bye
736
bye.argtypes = [session_t, close_request_t]
737
bye.restype = _error_code
738
bye.errcheck = _retry_on_error
740
check_version = _library.gnutls_check_version
741
check_version.argtypes = [ctypes.c_char_p]
742
check_version.restype = ctypes.c_char_p
744
_need_version = b"3.3.0"
745
if check_version(_need_version) is None:
746
raise self.Error("Needs GnuTLS {} or later"
747
.format(_need_version))
749
_tls_rawpk_version = b"3.6.6"
750
has_rawpk = bool(check_version(_tls_rawpk_version))
754
class pubkey_st(ctypes.Structure):
756
pubkey_t = ctypes.POINTER(pubkey_st)
758
x509_crt_fmt_t = ctypes.c_int
760
# All the function declarations below are from gnutls/abstract.h
761
pubkey_init = _library.gnutls_pubkey_init
762
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
763
pubkey_init.restype = _error_code
765
pubkey_import = _library.gnutls_pubkey_import
766
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
768
pubkey_import.restype = _error_code
770
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
771
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
772
ctypes.POINTER(ctypes.c_ubyte),
773
ctypes.POINTER(ctypes.c_size_t)]
774
pubkey_get_key_id.restype = _error_code
776
pubkey_deinit = _library.gnutls_pubkey_deinit
777
pubkey_deinit.argtypes = [pubkey_t]
778
pubkey_deinit.restype = None
780
# All the function declarations below are from gnutls/openpgp.h
782
openpgp_crt_init = _library.gnutls_openpgp_crt_init
783
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
784
openpgp_crt_init.restype = _error_code
786
openpgp_crt_import = _library.gnutls_openpgp_crt_import
787
openpgp_crt_import.argtypes = [openpgp_crt_t,
788
ctypes.POINTER(datum_t),
790
openpgp_crt_import.restype = _error_code
792
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
793
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
794
ctypes.POINTER(ctypes.c_uint)]
795
openpgp_crt_verify_self.restype = _error_code
797
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
798
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
799
openpgp_crt_deinit.restype = None
801
openpgp_crt_get_fingerprint = (
802
_library.gnutls_openpgp_crt_get_fingerprint)
803
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
807
openpgp_crt_get_fingerprint.restype = _error_code
809
if check_version(b"3.6.4"):
810
certificate_type_get2 = _library.gnutls_certificate_type_get2
811
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
812
certificate_type_get2.restype = _error_code
814
# Remove non-public functions
815
del _error_code, _retry_on_error
818
def call_pipe(connection, # : multiprocessing.Connection
819
func, *args, **kwargs):
820
"""This function is meant to be called by multiprocessing.Process
822
This function runs func(*args, **kwargs), and writes the resulting
823
return value on the provided multiprocessing.Connection.
825
connection.send(func(*args, **kwargs))
140
group = dbus.Interface\
141
(bus.get_object(avahi.DBUS_NAME,
142
server.EntryGroupNew()),
143
avahi.DBUS_INTERFACE_ENTRY_GROUP)
144
group.connect_to_signal('StateChanged',
145
entry_group_state_changed)
146
logger.debug(u"Adding service '%s' of type '%s' ...",
147
service.name, service.type)
149
self.interface, # interface
150
avahi.PROTO_INET6, # protocol
151
dbus.UInt32(0), # flags
152
self.name, self.type,
153
self.domain, self.host,
154
dbus.UInt16(self.port),
155
avahi.string_array_to_txt_array(self.TXT))
158
# From the Avahi example code:
159
group = None # our entry group
160
# End of Avahi example code
163
class Client(object):
830
164
"""A representation of a client host served by this server.
833
approved: bool(); 'None' if not yet approved/disapproved
834
approval_delay: datetime.timedelta(); Time to wait for approval
835
approval_duration: datetime.timedelta(); Duration of one approval
836
checker: multiprocessing.Process(); a running checker process used
837
to see if the client lives. 'None' if no process is
839
checker_callback_tag: a GLib event source tag, or None
840
checker_command: string; External command which is run to check
841
if client lives. %() expansions are done at
166
name: string; from the config file, used in log messages
167
fingerprint: string (40 or 32 hexadecimal digits); used to
168
uniquely identify the client
169
secret: bytestring; sent verbatim (over TLS) to client
170
host: string; available for use by the checker command
171
created: datetime.datetime(); object creation, not client host
172
last_checked_ok: datetime.datetime() or None if not yet checked OK
173
timeout: datetime.timedelta(); How long from last_checked_ok
174
until this client is invalid
175
interval: datetime.timedelta(); How often to start a new checker
176
stop_hook: If set, called by stop() as stop_hook(self)
177
checker: subprocess.Popen(); a running checker process used
178
to see if the client lives.
179
'None' if no process is running.
180
checker_initiator_tag: a gobject event source tag, or None
181
stop_initiator_tag: - '' -
182
checker_callback_tag: - '' -
183
checker_command: string; External command which is run to check if
184
client lives. %() expansions are done at
842
185
runtime with vars(self) as dict, so that for
843
186
instance %(name)s can be used in the command.
844
checker_initiator_tag: a GLib event source tag, or None
845
created: datetime.datetime(); (UTC) object creation
846
client_structure: Object describing what attributes a client has
847
and is used for storing the client at exit
848
current_checker_command: string; current running checker_command
849
disable_initiator_tag: a GLib event source tag, or None
851
fingerprint: string (40 or 32 hexadecimal digits); used to
852
uniquely identify an OpenPGP client
853
key_id: string (64 hexadecimal digits); used to uniquely identify
854
a client using raw public keys
855
host: string; available for use by the checker command
856
interval: datetime.timedelta(); How often to start a new checker
857
last_approval_request: datetime.datetime(); (UTC) or None
858
last_checked_ok: datetime.datetime(); (UTC) or None
859
last_checker_status: integer between 0 and 255 reflecting exit
860
status of last checker. -1 reflects crashed
861
checker, -2 means no checker completed yet.
862
last_checker_signal: The signal which killed the last checker, if
863
last_checker_status is -1
864
last_enabled: datetime.datetime(); (UTC) or None
865
name: string; from the config file, used in log messages and
867
secret: bytestring; sent verbatim (over TLS) to client
868
timeout: datetime.timedelta(); How long from last_checked_ok
869
until this client is disabled
870
extended_timeout: extra long timeout when secret has been sent
871
runtime_expansions: Allowed attributes for runtime expansion.
872
expires: datetime.datetime(); time (UTC) when a client will be
874
server_settings: The server_settings dict from main()
188
_timeout: Real variable for 'timeout'
189
_interval: Real variable for 'interval'
190
_timeout_milliseconds: Used when calling gobject.timeout_add()
191
_interval_milliseconds: - '' -
877
runtime_expansions = ("approval_delay", "approval_duration",
878
"created", "enabled", "expires", "key_id",
879
"fingerprint", "host", "interval",
880
"last_approval_request", "last_checked_ok",
881
"last_enabled", "name", "timeout")
884
"extended_timeout": "PT15M",
886
"checker": "fping -q -- %%(host)s",
888
"approval_delay": "PT0S",
889
"approval_duration": "PT1S",
890
"approved_by_default": "True",
895
def config_parser(config):
896
"""Construct a new dict of client settings of this form:
897
{ client_name: {setting_name: value, ...}, ...}
898
with exceptions for any special settings as defined above.
899
NOTE: Must be a pure function. Must return the same result
900
value given the same arguments.
903
for client_name in config.sections():
904
section = dict(config.items(client_name))
905
client = settings[client_name] = {}
907
client["host"] = section["host"]
908
# Reformat values from string types to Python types
909
client["approved_by_default"] = config.getboolean(
910
client_name, "approved_by_default")
911
client["enabled"] = config.getboolean(client_name,
914
# Uppercase and remove spaces from key_id and fingerprint
915
# for later comparison purposes with return value from the
916
# key_id() and fingerprint() functions
917
client["key_id"] = (section.get("key_id", "").upper()
919
client["fingerprint"] = (section["fingerprint"].upper()
921
if "secret" in section:
922
client["secret"] = codecs.decode(section["secret"]
925
elif "secfile" in section:
926
with open(os.path.expanduser(os.path.expandvars
927
(section["secfile"])),
929
client["secret"] = secfile.read()
931
raise TypeError("No secret or secfile for section {}"
933
client["timeout"] = string_to_delta(section["timeout"])
934
client["extended_timeout"] = string_to_delta(
935
section["extended_timeout"])
936
client["interval"] = string_to_delta(section["interval"])
937
client["approval_delay"] = string_to_delta(
938
section["approval_delay"])
939
client["approval_duration"] = string_to_delta(
940
section["approval_duration"])
941
client["checker_command"] = section["checker"]
942
client["last_approval_request"] = None
943
client["last_checked_ok"] = None
944
client["last_checker_status"] = -2
948
def __init__(self, settings, name=None, server_settings=None):
193
def _set_timeout(self, timeout):
194
"Setter function for 'timeout' attribute"
195
self._timeout = timeout
196
self._timeout_milliseconds = ((self.timeout.days
197
* 24 * 60 * 60 * 1000)
198
+ (self.timeout.seconds * 1000)
199
+ (self.timeout.microseconds
201
timeout = property(lambda self: self._timeout,
204
def _set_interval(self, interval):
205
"Setter function for 'interval' attribute"
206
self._interval = interval
207
self._interval_milliseconds = ((self.interval.days
208
* 24 * 60 * 60 * 1000)
209
+ (self.interval.seconds
211
+ (self.interval.microseconds
213
interval = property(lambda self: self._interval,
216
def __init__(self, name = None, stop_hook=None, config={}):
217
"""Note: the 'checker' key in 'config' sets the
218
'checker_command' attribute and *not* the 'checker'
950
if server_settings is None:
952
self.server_settings = server_settings
953
# adding all client settings
954
for setting, value in settings.items():
955
setattr(self, setting, value)
958
if not hasattr(self, "last_enabled"):
959
self.last_enabled = datetime.datetime.utcnow()
960
if not hasattr(self, "expires"):
961
self.expires = (datetime.datetime.utcnow()
221
logger.debug(u"Creating client %r", self.name)
222
# Uppercase and remove spaces from fingerprint for later
223
# comparison purposes with return value from the fingerprint()
225
self.fingerprint = config["fingerprint"].upper()\
227
logger.debug(u" Fingerprint: %s", self.fingerprint)
228
if "secret" in config:
229
self.secret = config["secret"].decode(u"base64")
230
elif "secfile" in config:
231
sf = open(config["secfile"])
232
self.secret = sf.read()
964
self.last_enabled = None
967
logger.debug("Creating client %r", self.name)
968
logger.debug(" Key ID: %s", self.key_id)
969
logger.debug(" Fingerprint: %s", self.fingerprint)
970
self.created = settings.get("created",
971
datetime.datetime.utcnow())
973
# attributes specific for this server instance
235
raise TypeError(u"No secret or secfile for client %s"
237
self.host = config.get("host", "")
238
self.created = datetime.datetime.now()
239
self.last_checked_ok = None
240
self.timeout = string_to_delta(config["timeout"])
241
self.interval = string_to_delta(config["interval"])
242
self.stop_hook = stop_hook
974
243
self.checker = None
975
244
self.checker_initiator_tag = None
976
self.disable_initiator_tag = None
245
self.stop_initiator_tag = None
977
246
self.checker_callback_tag = None
978
self.current_checker_command = None
980
self.approvals_pending = 0
981
self.changedstate = multiprocessing_manager.Condition(
982
multiprocessing_manager.Lock())
983
self.client_structure = [attr
984
for attr in self.__dict__.keys()
985
if not attr.startswith("_")]
986
self.client_structure.append("client_structure")
988
for name, t in inspect.getmembers(
989
type(self), lambda obj: isinstance(obj, property)):
990
if not name.startswith("_"):
991
self.client_structure.append(name)
993
# Send notice to process children that client state has changed
994
def send_changedstate(self):
995
with self.changedstate:
996
self.changedstate.notify_all()
247
self.check_command = config["checker"]
999
249
"""Start this client's checker and timeout hooks"""
1000
if getattr(self, "enabled", False):
1003
self.expires = datetime.datetime.utcnow() + self.timeout
1005
self.last_enabled = datetime.datetime.utcnow()
1007
self.send_changedstate()
1009
def disable(self, quiet=True):
1010
"""Disable this client."""
1011
if not getattr(self, "enabled", False):
1014
logger.info("Disabling client %s", self.name)
1015
if getattr(self, "disable_initiator_tag", None) is not None:
1016
GLib.source_remove(self.disable_initiator_tag)
1017
self.disable_initiator_tag = None
1019
if getattr(self, "checker_initiator_tag", None) is not None:
1020
GLib.source_remove(self.checker_initiator_tag)
1021
self.checker_initiator_tag = None
1023
self.enabled = False
1025
self.send_changedstate()
1026
# Do not run this again if called by a GLib.timeout_add
1032
def init_checker(self):
1033
250
# Schedule a new checker to be started an 'interval' from now,
1034
251
# and every interval from then on.
1035
if self.checker_initiator_tag is not None:
1036
GLib.source_remove(self.checker_initiator_tag)
1037
self.checker_initiator_tag = GLib.timeout_add(
1038
int(self.interval.total_seconds() * 1000),
1040
# Schedule a disable() when 'timeout' has passed
1041
if self.disable_initiator_tag is not None:
1042
GLib.source_remove(self.disable_initiator_tag)
1043
self.disable_initiator_tag = GLib.timeout_add(
1044
int(self.timeout.total_seconds() * 1000), self.disable)
252
self.checker_initiator_tag = gobject.timeout_add\
253
(self._interval_milliseconds,
1045
255
# Also start a new checker *right now*.
1046
256
self.start_checker()
1048
def checker_callback(self, source, condition, connection,
257
# Schedule a stop() when 'timeout' has passed
258
self.stop_initiator_tag = gobject.timeout_add\
259
(self._timeout_milliseconds,
263
The possibility that a client might be restarted is left open,
264
but not currently used."""
265
# If this client doesn't have a secret, it is already stopped.
266
if hasattr(self, "secret") and self.secret:
267
logger.info(u"Stopping client %s", self.name)
271
if getattr(self, "stop_initiator_tag", False):
272
gobject.source_remove(self.stop_initiator_tag)
273
self.stop_initiator_tag = None
274
if getattr(self, "checker_initiator_tag", False):
275
gobject.source_remove(self.checker_initiator_tag)
276
self.checker_initiator_tag = None
280
# Do not run this again if called by a gobject.timeout_add
283
self.stop_hook = None
285
def checker_callback(self, pid, condition):
1050
286
"""The checker has completed, so take appropriate actions."""
1051
# Read return code from connection (see call_pipe)
1052
returncode = connection.recv()
1054
if self.checker is not None:
287
now = datetime.datetime.now()
1056
288
self.checker_callback_tag = None
1057
289
self.checker = None
1060
self.last_checker_status = returncode
1061
self.last_checker_signal = None
1062
if self.last_checker_status == 0:
1063
logger.info("Checker for %(name)s succeeded",
1067
logger.info("Checker for %(name)s failed", vars(self))
1069
self.last_checker_status = -1
1070
self.last_checker_signal = -returncode
1071
logger.warning("Checker for %(name)s crashed?",
290
if os.WIFEXITED(condition) \
291
and (os.WEXITSTATUS(condition) == 0):
292
logger.info(u"Checker for %(name)s succeeded",
294
self.last_checked_ok = now
295
gobject.source_remove(self.stop_initiator_tag)
296
self.stop_initiator_tag = gobject.timeout_add\
297
(self._timeout_milliseconds,
299
elif not os.WIFEXITED(condition):
300
logger.warning(u"Checker for %(name)s crashed?",
1075
def checked_ok(self):
1076
"""Assert that the client has been seen, alive and well."""
1077
self.last_checked_ok = datetime.datetime.utcnow()
1078
self.last_checker_status = 0
1079
self.last_checker_signal = None
1082
def bump_timeout(self, timeout=None):
1083
"""Bump up the timeout for this client."""
1085
timeout = self.timeout
1086
if self.disable_initiator_tag is not None:
1087
GLib.source_remove(self.disable_initiator_tag)
1088
self.disable_initiator_tag = None
1089
if getattr(self, "enabled", False):
1090
self.disable_initiator_tag = GLib.timeout_add(
1091
int(timeout.total_seconds() * 1000), self.disable)
1092
self.expires = datetime.datetime.utcnow() + timeout
1094
def need_approval(self):
1095
self.last_approval_request = datetime.datetime.utcnow()
303
logger.info(u"Checker for %(name)s failed",
1097
305
def start_checker(self):
1098
306
"""Start a new checker subprocess if one is not running.
1100
307
If a checker already exists, leave it running and do
1102
309
# The reason for not killing a running checker is that if we
1103
# did that, and if a checker (for some reason) started running
1104
# slowly and taking more than 'interval' time, then the client
1105
# would inevitably timeout, since no checker would get a
1106
# chance to run to completion. If we instead leave running
310
# did that, then if a checker (for some reason) started
311
# running slowly and taking more than 'interval' time, the
312
# client would inevitably timeout, since no checker would get
313
# a chance to run to completion. If we instead leave running
1107
314
# checkers alone, the checker would have to take more time
1108
# than 'timeout' for the client to be disabled, which is as it
1111
if self.checker is not None and not self.checker.is_alive():
1112
logger.warning("Checker was not alive; joining")
1115
# Start a new checker if needed
315
# than 'timeout' for the client to be declared invalid, which
316
# is as it should be.
1116
317
if self.checker is None:
1117
# Escape attributes for the shell
1119
attr: re.escape(str(getattr(self, attr)))
1120
for attr in self.runtime_expansions}
1122
command = self.checker_command % escaped_attrs
1123
except TypeError as error:
1124
logger.error('Could not format string "%s"',
1125
self.checker_command,
1127
return True # Try again later
1128
self.current_checker_command = command
1129
logger.info("Starting checker %r for %s", command,
1131
# We don't need to redirect stdout and stderr, since
1132
# in normal mode, that is already done by daemon(),
1133
# and in debug mode we don't want to. (Stdin is
1134
# always replaced by /dev/null.)
1135
# The exception is when not debugging but nevertheless
1136
# running in the foreground; use the previously
1138
popen_args = {"close_fds": True,
1141
if (not self.server_settings["debug"]
1142
and self.server_settings["foreground"]):
1143
popen_args.update({"stdout": wnull,
1145
pipe = multiprocessing.Pipe(duplex=False)
1146
self.checker = multiprocessing.Process(
1148
args=(pipe[1], subprocess.call, command),
1150
self.checker.start()
1151
self.checker_callback_tag = GLib.io_add_watch(
1152
GLib.IOChannel.unix_new(pipe[0].fileno()),
1153
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1154
self.checker_callback, pipe[0], command)
1155
# Re-run this periodically if run by GLib.timeout_add
319
# In case check_command has exactly one % operator
320
command = self.check_command % self.host
322
# Escape attributes for the shell
323
escaped_attrs = dict((key, re.escape(str(val)))
325
vars(self).iteritems())
327
command = self.check_command % escaped_attrs
328
except TypeError, error:
329
logger.error(u'Could not format string "%s":'
330
u' %s', self.check_command, error)
331
return True # Try again later
333
logger.info(u"Starting checker %r for %s",
335
self.checker = subprocess.Popen(command,
338
self.checker_callback_tag = gobject.child_watch_add\
340
self.checker_callback)
341
except subprocess.OSError, error:
342
logger.error(u"Failed to start subprocess: %s",
344
# Re-run this periodically if run by gobject.timeout_add
1158
346
def stop_checker(self):
1159
347
"""Force the checker process, if any, to stop."""
1160
348
if self.checker_callback_tag:
1161
GLib.source_remove(self.checker_callback_tag)
349
gobject.source_remove(self.checker_callback_tag)
1162
350
self.checker_callback_tag = None
1163
351
if getattr(self, "checker", None) is None:
1165
logger.debug("Stopping checker for %(name)s", vars(self))
1166
self.checker.terminate()
353
logger.debug(u"Stopping checker for %(name)s", vars(self))
355
os.kill(self.checker.pid, signal.SIGTERM)
357
#if self.checker.poll() is None:
358
# os.kill(self.checker.pid, signal.SIGKILL)
359
except OSError, error:
360
if error.errno != errno.ESRCH: # No such process
1167
362
self.checker = None
1170
def dbus_service_property(dbus_interface,
1174
"""Decorators for marking methods of a DBusObjectWithProperties to
1175
become properties on the D-Bus.
1177
The decorated method will be called with no arguments by "Get"
1178
and with one argument by "Set".
1180
The parameters, where they are supported, are the same as
1181
dbus.service.method, except there is only "signature", since the
1182
type from Get() and the type sent to Set() is the same.
1184
# Encoding deeply encoded byte arrays is not supported yet by the
1185
# "Set" method, so we fail early here:
1186
if byte_arrays and signature != "ay":
1187
raise ValueError("Byte arrays not supported for non-'ay'"
1188
" signature {!r}".format(signature))
1190
def decorator(func):
1191
func._dbus_is_property = True
1192
func._dbus_interface = dbus_interface
1193
func._dbus_signature = signature
1194
func._dbus_access = access
1195
func._dbus_name = func.__name__
1196
if func._dbus_name.endswith("_dbus_property"):
1197
func._dbus_name = func._dbus_name[:-14]
1198
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1204
def dbus_interface_annotations(dbus_interface):
1205
"""Decorator for marking functions returning interface annotations
1209
@dbus_interface_annotations("org.example.Interface")
1210
def _foo(self): # Function name does not matter
1211
return {"org.freedesktop.DBus.Deprecated": "true",
1212
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1216
def decorator(func):
1217
func._dbus_is_interface = True
1218
func._dbus_interface = dbus_interface
1219
func._dbus_name = dbus_interface
1225
def dbus_annotations(annotations):
1226
"""Decorator to annotate D-Bus methods, signals or properties
1229
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1230
"org.freedesktop.DBus.Property."
1231
"EmitsChangedSignal": "false"})
1232
@dbus_service_property("org.example.Interface", signature="b",
1234
def Property_dbus_property(self):
1235
return dbus.Boolean(False)
1237
See also the DBusObjectWithAnnotations class.
1240
def decorator(func):
1241
func._dbus_annotations = annotations
1247
class DBusPropertyException(dbus.exceptions.DBusException):
1248
"""A base class for D-Bus property-related exceptions
1253
class DBusPropertyAccessException(DBusPropertyException):
1254
"""A property's access permissions disallows an operation.
1259
class DBusPropertyNotFound(DBusPropertyException):
1260
"""An attempt was made to access a non-existing property.
1265
class DBusObjectWithAnnotations(dbus.service.Object):
1266
"""A D-Bus object with annotations.
1268
Classes inheriting from this can use the dbus_annotations
1269
decorator to add annotations to methods or signals.
1273
def _is_dbus_thing(thing):
1274
"""Returns a function testing if an attribute is a D-Bus thing
1276
If called like _is_dbus_thing("method") it returns a function
1277
suitable for use as predicate to inspect.getmembers().
1279
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1282
def _get_all_dbus_things(self, thing):
1283
"""Returns a generator of (name, attribute) pairs
1285
return ((getattr(athing.__get__(self), "_dbus_name", name),
1286
athing.__get__(self))
1287
for cls in self.__class__.__mro__
1289
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1291
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1293
path_keyword='object_path',
1294
connection_keyword='connection')
1295
def Introspect(self, object_path, connection):
1296
"""Overloading of standard D-Bus method.
1298
Inserts annotation tags on methods and signals.
1300
xmlstring = dbus.service.Object.Introspect(self, object_path,
1303
document = xml.dom.minidom.parseString(xmlstring)
1305
for if_tag in document.getElementsByTagName("interface"):
1306
# Add annotation tags
1307
for typ in ("method", "signal"):
1308
for tag in if_tag.getElementsByTagName(typ):
1310
for name, prop in (self.
1311
_get_all_dbus_things(typ)):
1312
if (name == tag.getAttribute("name")
1313
and prop._dbus_interface
1314
== if_tag.getAttribute("name")):
1315
annots.update(getattr(
1316
prop, "_dbus_annotations", {}))
1317
for name, value in annots.items():
1318
ann_tag = document.createElement(
1320
ann_tag.setAttribute("name", name)
1321
ann_tag.setAttribute("value", value)
1322
tag.appendChild(ann_tag)
1323
# Add interface annotation tags
1324
for annotation, value in dict(
1325
itertools.chain.from_iterable(
1326
annotations().items()
1327
for name, annotations
1328
in self._get_all_dbus_things("interface")
1329
if name == if_tag.getAttribute("name")
1331
ann_tag = document.createElement("annotation")
1332
ann_tag.setAttribute("name", annotation)
1333
ann_tag.setAttribute("value", value)
1334
if_tag.appendChild(ann_tag)
1335
# Fix argument name for the Introspect method itself
1336
if (if_tag.getAttribute("name")
1337
== dbus.INTROSPECTABLE_IFACE):
1338
for cn in if_tag.getElementsByTagName("method"):
1339
if cn.getAttribute("name") == "Introspect":
1340
for arg in cn.getElementsByTagName("arg"):
1341
if (arg.getAttribute("direction")
1343
arg.setAttribute("name",
1345
xmlstring = document.toxml("utf-8")
1347
except (AttributeError, xml.dom.DOMException,
1348
xml.parsers.expat.ExpatError) as error:
1349
logger.error("Failed to override Introspection method",
1354
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1355
"""A D-Bus object with properties.
1357
Classes inheriting from this can use the dbus_service_property
1358
decorator to expose methods as D-Bus properties. It exposes the
1359
standard Get(), Set(), and GetAll() methods on the D-Bus.
1362
def _get_dbus_property(self, interface_name, property_name):
1363
"""Returns a bound method if one exists which is a D-Bus
1364
property with the specified name and interface.
1366
for cls in self.__class__.__mro__:
1367
for name, value in inspect.getmembers(
1368
cls, self._is_dbus_thing("property")):
1369
if (value._dbus_name == property_name
1370
and value._dbus_interface == interface_name):
1371
return value.__get__(self)
1374
raise DBusPropertyNotFound("{}:{}.{}".format(
1375
self.dbus_object_path, interface_name, property_name))
1378
def _get_all_interface_names(cls):
1379
"""Get a sequence of all interfaces supported by an object"""
1380
return (name for name in set(getattr(getattr(x, attr),
1381
"_dbus_interface", None)
1382
for x in (inspect.getmro(cls))
1384
if name is not None)
1386
@dbus.service.method(dbus.PROPERTIES_IFACE,
1389
def Get(self, interface_name, property_name):
1390
"""Standard D-Bus property Get() method, see D-Bus standard.
1392
prop = self._get_dbus_property(interface_name, property_name)
1393
if prop._dbus_access == "write":
1394
raise DBusPropertyAccessException(property_name)
1396
if not hasattr(value, "variant_level"):
1398
return type(value)(value, variant_level=value.variant_level+1)
1400
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1401
def Set(self, interface_name, property_name, value):
1402
"""Standard D-Bus property Set() method, see D-Bus standard.
1404
prop = self._get_dbus_property(interface_name, property_name)
1405
if prop._dbus_access == "read":
1406
raise DBusPropertyAccessException(property_name)
1407
if prop._dbus_get_args_options["byte_arrays"]:
1408
# The byte_arrays option is not supported yet on
1409
# signatures other than "ay".
1410
if prop._dbus_signature != "ay":
1411
raise ValueError("Byte arrays not supported for non-"
1412
"'ay' signature {!r}"
1413
.format(prop._dbus_signature))
1414
value = dbus.ByteArray(bytes(value))
1417
@dbus.service.method(dbus.PROPERTIES_IFACE,
1419
out_signature="a{sv}")
1420
def GetAll(self, interface_name):
1421
"""Standard D-Bus property GetAll() method, see D-Bus
1424
Note: Will not include properties with access="write".
1427
for name, prop in self._get_all_dbus_things("property"):
1429
and interface_name != prop._dbus_interface):
1430
# Interface non-empty but did not match
1432
# Ignore write-only properties
1433
if prop._dbus_access == "write":
1436
if not hasattr(value, "variant_level"):
1437
properties[name] = value
1439
properties[name] = type(value)(
1440
value, variant_level=value.variant_level + 1)
1441
return dbus.Dictionary(properties, signature="sv")
1443
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1444
def PropertiesChanged(self, interface_name, changed_properties,
1445
invalidated_properties):
1446
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1451
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1453
path_keyword='object_path',
1454
connection_keyword='connection')
1455
def Introspect(self, object_path, connection):
1456
"""Overloading of standard D-Bus method.
1458
Inserts property tags and interface annotation tags.
1460
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1464
document = xml.dom.minidom.parseString(xmlstring)
1466
def make_tag(document, name, prop):
1467
e = document.createElement("property")
1468
e.setAttribute("name", name)
1469
e.setAttribute("type", prop._dbus_signature)
1470
e.setAttribute("access", prop._dbus_access)
1473
for if_tag in document.getElementsByTagName("interface"):
1475
for tag in (make_tag(document, name, prop)
1477
in self._get_all_dbus_things("property")
1478
if prop._dbus_interface
1479
== if_tag.getAttribute("name")):
1480
if_tag.appendChild(tag)
1481
# Add annotation tags for properties
1482
for tag in if_tag.getElementsByTagName("property"):
1484
for name, prop in self._get_all_dbus_things(
1486
if (name == tag.getAttribute("name")
1487
and prop._dbus_interface
1488
== if_tag.getAttribute("name")):
1489
annots.update(getattr(
1490
prop, "_dbus_annotations", {}))
1491
for name, value in annots.items():
1492
ann_tag = document.createElement(
1494
ann_tag.setAttribute("name", name)
1495
ann_tag.setAttribute("value", value)
1496
tag.appendChild(ann_tag)
1497
# Add the names to the return values for the
1498
# "org.freedesktop.DBus.Properties" methods
1499
if (if_tag.getAttribute("name")
1500
== "org.freedesktop.DBus.Properties"):
1501
for cn in if_tag.getElementsByTagName("method"):
1502
if cn.getAttribute("name") == "Get":
1503
for arg in cn.getElementsByTagName("arg"):
1504
if (arg.getAttribute("direction")
1506
arg.setAttribute("name", "value")
1507
elif cn.getAttribute("name") == "GetAll":
1508
for arg in cn.getElementsByTagName("arg"):
1509
if (arg.getAttribute("direction")
1511
arg.setAttribute("name", "props")
1512
xmlstring = document.toxml("utf-8")
1514
except (AttributeError, xml.dom.DOMException,
1515
xml.parsers.expat.ExpatError) as error:
1516
logger.error("Failed to override Introspection method",
1522
dbus.OBJECT_MANAGER_IFACE
1523
except AttributeError:
1524
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1527
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1528
"""A D-Bus object with an ObjectManager.
1530
Classes inheriting from this exposes the standard
1531
GetManagedObjects call and the InterfacesAdded and
1532
InterfacesRemoved signals on the standard
1533
"org.freedesktop.DBus.ObjectManager" interface.
1535
Note: No signals are sent automatically; they must be sent
1538
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1539
out_signature="a{oa{sa{sv}}}")
1540
def GetManagedObjects(self):
1541
"""This function must be overridden"""
1542
raise NotImplementedError()
1544
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1545
signature="oa{sa{sv}}")
1546
def InterfacesAdded(self, object_path, interfaces_and_properties):
1549
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1550
def InterfacesRemoved(self, object_path, interfaces):
1553
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1555
path_keyword='object_path',
1556
connection_keyword='connection')
1557
def Introspect(self, object_path, connection):
1558
"""Overloading of standard D-Bus method.
1560
Override return argument name of GetManagedObjects to be
1561
"objpath_interfaces_and_properties"
1563
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1567
document = xml.dom.minidom.parseString(xmlstring)
1569
for if_tag in document.getElementsByTagName("interface"):
1570
# Fix argument name for the GetManagedObjects method
1571
if (if_tag.getAttribute("name")
1572
== dbus.OBJECT_MANAGER_IFACE):
1573
for cn in if_tag.getElementsByTagName("method"):
1574
if (cn.getAttribute("name")
1575
== "GetManagedObjects"):
1576
for arg in cn.getElementsByTagName("arg"):
1577
if (arg.getAttribute("direction")
1581
"objpath_interfaces"
1583
xmlstring = document.toxml("utf-8")
1585
except (AttributeError, xml.dom.DOMException,
1586
xml.parsers.expat.ExpatError) as error:
1587
logger.error("Failed to override Introspection method",
1592
def datetime_to_dbus(dt, variant_level=0):
1593
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1595
return dbus.String("", variant_level=variant_level)
1596
return dbus.String(dt.isoformat(), variant_level=variant_level)
1599
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1600
"""A class decorator; applied to a subclass of
1601
dbus.service.Object, it will add alternate D-Bus attributes with
1602
interface names according to the "alt_interface_names" mapping.
1605
@alternate_dbus_interfaces({"org.example.Interface":
1606
"net.example.AlternateInterface"})
1607
class SampleDBusObject(dbus.service.Object):
1608
@dbus.service.method("org.example.Interface")
1609
def SampleDBusMethod():
1612
The above "SampleDBusMethod" on "SampleDBusObject" will be
1613
reachable via two interfaces: "org.example.Interface" and
1614
"net.example.AlternateInterface", the latter of which will have
1615
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1616
"true", unless "deprecate" is passed with a False value.
1618
This works for methods and signals, and also for D-Bus properties
1619
(from DBusObjectWithProperties) and interfaces (from the
1620
dbus_interface_annotations decorator).
1624
for orig_interface_name, alt_interface_name in (
1625
alt_interface_names.items()):
1627
interface_names = set()
1628
# Go though all attributes of the class
1629
for attrname, attribute in inspect.getmembers(cls):
1630
# Ignore non-D-Bus attributes, and D-Bus attributes
1631
# with the wrong interface name
1632
if (not hasattr(attribute, "_dbus_interface")
1633
or not attribute._dbus_interface.startswith(
1634
orig_interface_name)):
1636
# Create an alternate D-Bus interface name based on
1638
alt_interface = attribute._dbus_interface.replace(
1639
orig_interface_name, alt_interface_name)
1640
interface_names.add(alt_interface)
1641
# Is this a D-Bus signal?
1642
if getattr(attribute, "_dbus_is_signal", False):
1643
# Extract the original non-method undecorated
1644
# function by black magic
1645
if sys.version_info.major == 2:
1646
nonmethod_func = (dict(
1647
zip(attribute.func_code.co_freevars,
1648
attribute.__closure__))
1649
["func"].cell_contents)
1651
nonmethod_func = (dict(
1652
zip(attribute.__code__.co_freevars,
1653
attribute.__closure__))
1654
["func"].cell_contents)
1655
# Create a new, but exactly alike, function
1656
# object, and decorate it to be a new D-Bus signal
1657
# with the alternate D-Bus interface name
1658
new_function = copy_function(nonmethod_func)
1659
new_function = (dbus.service.signal(
1661
attribute._dbus_signature)(new_function))
1662
# Copy annotations, if any
1664
new_function._dbus_annotations = dict(
1665
attribute._dbus_annotations)
1666
except AttributeError:
1669
# Define a creator of a function to call both the
1670
# original and alternate functions, so both the
1671
# original and alternate signals gets sent when
1672
# the function is called
1673
def fixscope(func1, func2):
1674
"""This function is a scope container to pass
1675
func1 and func2 to the "call_both" function
1676
outside of its arguments"""
1678
@functools.wraps(func2)
1679
def call_both(*args, **kwargs):
1680
"""This function will emit two D-Bus
1681
signals by calling func1 and func2"""
1682
func1(*args, **kwargs)
1683
func2(*args, **kwargs)
1684
# Make wrapper function look like a D-Bus
1686
for name, attr in inspect.getmembers(func2):
1687
if name.startswith("_dbus_"):
1688
setattr(call_both, name, attr)
1691
# Create the "call_both" function and add it to
1693
attr[attrname] = fixscope(attribute, new_function)
1694
# Is this a D-Bus method?
1695
elif getattr(attribute, "_dbus_is_method", False):
1696
# Create a new, but exactly alike, function
1697
# object. Decorate it to be a new D-Bus method
1698
# with the alternate D-Bus interface name. Add it
1701
dbus.service.method(
1703
attribute._dbus_in_signature,
1704
attribute._dbus_out_signature)
1705
(copy_function(attribute)))
1706
# Copy annotations, if any
1708
attr[attrname]._dbus_annotations = dict(
1709
attribute._dbus_annotations)
1710
except AttributeError:
1712
# Is this a D-Bus property?
1713
elif getattr(attribute, "_dbus_is_property", False):
1714
# Create a new, but exactly alike, function
1715
# object, and decorate it to be a new D-Bus
1716
# property with the alternate D-Bus interface
1717
# name. Add it to the class.
1718
attr[attrname] = (dbus_service_property(
1719
alt_interface, attribute._dbus_signature,
1720
attribute._dbus_access,
1721
attribute._dbus_get_args_options
1723
(copy_function(attribute)))
1724
# Copy annotations, if any
1726
attr[attrname]._dbus_annotations = dict(
1727
attribute._dbus_annotations)
1728
except AttributeError:
1730
# Is this a D-Bus interface?
1731
elif getattr(attribute, "_dbus_is_interface", False):
1732
# Create a new, but exactly alike, function
1733
# object. Decorate it to be a new D-Bus interface
1734
# with the alternate D-Bus interface name. Add it
1737
dbus_interface_annotations(alt_interface)
1738
(copy_function(attribute)))
1740
# Deprecate all alternate interfaces
1741
iname = "_AlternateDBusNames_interface_annotation{}"
1742
for interface_name in interface_names:
1744
@dbus_interface_annotations(interface_name)
1746
return {"org.freedesktop.DBus.Deprecated":
1748
# Find an unused name
1749
for aname in (iname.format(i)
1750
for i in itertools.count()):
1751
if aname not in attr:
1755
# Replace the class with a new subclass of it with
1756
# methods, signals, etc. as created above.
1757
if sys.version_info.major == 2:
1758
cls = type(b"{}Alternate".format(cls.__name__),
1761
cls = type("{}Alternate".format(cls.__name__),
1768
@alternate_dbus_interfaces({"se.recompile.Mandos":
1769
"se.bsnet.fukt.Mandos"})
1770
class ClientDBus(Client, DBusObjectWithProperties):
1771
"""A Client class using D-Bus
1774
dbus_object_path: dbus.ObjectPath
1775
bus: dbus.SystemBus()
1778
runtime_expansions = (Client.runtime_expansions
1779
+ ("dbus_object_path", ))
1781
_interface = "se.recompile.Mandos.Client"
1783
# dbus.service.Object doesn't use super(), so we can't either.
1785
def __init__(self, bus=None, *args, **kwargs):
1787
Client.__init__(self, *args, **kwargs)
1788
# Only now, when this client is initialized, can it show up on
1790
client_object_name = str(self.name).translate(
1791
{ord("."): ord("_"),
1792
ord("-"): ord("_")})
1793
self.dbus_object_path = dbus.ObjectPath(
1794
"/clients/" + client_object_name)
1795
DBusObjectWithProperties.__init__(self, self.bus,
1796
self.dbus_object_path)
1798
def notifychangeproperty(transform_func, dbus_name,
1799
type_func=lambda x: x,
1801
invalidate_only=False,
1802
_interface=_interface):
1803
""" Modify a variable so that it's a property which announces
1804
its changes to DBus.
1806
transform_fun: Function that takes a value and a variant_level
1807
and transforms it to a D-Bus type.
1808
dbus_name: D-Bus name of the variable
1809
type_func: Function that transform the value before sending it
1810
to the D-Bus. Default: no transform
1811
variant_level: D-Bus variant level. Default: 1
1813
attrname = "_{}".format(dbus_name)
1815
def setter(self, value):
1816
if hasattr(self, "dbus_object_path"):
1817
if (not hasattr(self, attrname) or
1818
type_func(getattr(self, attrname, None))
1819
!= type_func(value)):
1821
self.PropertiesChanged(
1822
_interface, dbus.Dictionary(),
1823
dbus.Array((dbus_name, )))
1825
dbus_value = transform_func(
1827
variant_level=variant_level)
1828
self.PropertyChanged(dbus.String(dbus_name),
1830
self.PropertiesChanged(
1832
dbus.Dictionary({dbus.String(dbus_name):
1835
setattr(self, attrname, value)
1837
return property(lambda self: getattr(self, attrname), setter)
1839
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1840
approvals_pending = notifychangeproperty(dbus.Boolean,
1843
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1844
last_enabled = notifychangeproperty(datetime_to_dbus,
1846
checker = notifychangeproperty(
1847
dbus.Boolean, "CheckerRunning",
1848
type_func=lambda checker: checker is not None)
1849
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1851
last_checker_status = notifychangeproperty(dbus.Int16,
1852
"LastCheckerStatus")
1853
last_approval_request = notifychangeproperty(
1854
datetime_to_dbus, "LastApprovalRequest")
1855
approved_by_default = notifychangeproperty(dbus.Boolean,
1856
"ApprovedByDefault")
1857
approval_delay = notifychangeproperty(
1858
dbus.UInt64, "ApprovalDelay",
1859
type_func=lambda td: td.total_seconds() * 1000)
1860
approval_duration = notifychangeproperty(
1861
dbus.UInt64, "ApprovalDuration",
1862
type_func=lambda td: td.total_seconds() * 1000)
1863
host = notifychangeproperty(dbus.String, "Host")
1864
timeout = notifychangeproperty(
1865
dbus.UInt64, "Timeout",
1866
type_func=lambda td: td.total_seconds() * 1000)
1867
extended_timeout = notifychangeproperty(
1868
dbus.UInt64, "ExtendedTimeout",
1869
type_func=lambda td: td.total_seconds() * 1000)
1870
interval = notifychangeproperty(
1871
dbus.UInt64, "Interval",
1872
type_func=lambda td: td.total_seconds() * 1000)
1873
checker_command = notifychangeproperty(dbus.String, "Checker")
1874
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1875
invalidate_only=True)
1877
del notifychangeproperty
1879
def __del__(self, *args, **kwargs):
1881
self.remove_from_connection()
1884
if hasattr(DBusObjectWithProperties, "__del__"):
1885
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1886
Client.__del__(self, *args, **kwargs)
1888
def checker_callback(self, source, condition,
1889
connection, command, *args, **kwargs):
1890
ret = Client.checker_callback(self, source, condition,
1891
connection, command, *args,
1893
exitstatus = self.last_checker_status
1896
self.CheckerCompleted(dbus.Int16(exitstatus),
1897
# This is specific to GNU libC
1898
dbus.Int64(exitstatus << 8),
1899
dbus.String(command))
1902
self.CheckerCompleted(dbus.Int16(-1),
1904
# This is specific to GNU libC
1906
| self.last_checker_signal),
1907
dbus.String(command))
1910
def start_checker(self, *args, **kwargs):
1911
old_checker_pid = getattr(self.checker, "pid", None)
1912
r = Client.start_checker(self, *args, **kwargs)
1913
# Only if new checker process was started
1914
if (self.checker is not None
1915
and old_checker_pid != self.checker.pid):
1917
self.CheckerStarted(self.current_checker_command)
1920
def _reset_approved(self):
1921
self.approved = None
1924
def approve(self, value=True):
1925
self.approved = value
1926
GLib.timeout_add(int(self.approval_duration.total_seconds()
1927
* 1000), self._reset_approved)
1928
self.send_changedstate()
1930
# D-Bus methods, signals & properties
1936
# CheckerCompleted - signal
1937
@dbus.service.signal(_interface, signature="nxs")
1938
def CheckerCompleted(self, exitcode, waitstatus, command):
1942
# CheckerStarted - signal
1943
@dbus.service.signal(_interface, signature="s")
1944
def CheckerStarted(self, command):
1948
# PropertyChanged - signal
1949
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1950
@dbus.service.signal(_interface, signature="sv")
1951
def PropertyChanged(self, property, value):
1955
# GotSecret - signal
1956
@dbus.service.signal(_interface)
1957
def GotSecret(self):
1959
Is sent after a successful transfer of secret from the Mandos
1960
server to mandos-client
1965
@dbus.service.signal(_interface, signature="s")
1966
def Rejected(self, reason):
1970
# NeedApproval - signal
1971
@dbus.service.signal(_interface, signature="tb")
1972
def NeedApproval(self, timeout, default):
1974
return self.need_approval()
1979
@dbus.service.method(_interface, in_signature="b")
1980
def Approve(self, value):
1983
# CheckedOK - method
1984
@dbus.service.method(_interface)
1985
def CheckedOK(self):
1989
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1990
@dbus.service.method(_interface)
1995
# StartChecker - method
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
@dbus.service.method(_interface)
1998
def StartChecker(self):
2000
self.start_checker()
2003
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2004
@dbus.service.method(_interface)
2009
# StopChecker - method
2010
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2011
@dbus.service.method(_interface)
2012
def StopChecker(self):
2017
# ApprovalPending - property
2018
@dbus_service_property(_interface, signature="b", access="read")
2019
def ApprovalPending_dbus_property(self):
2020
return dbus.Boolean(bool(self.approvals_pending))
2022
# ApprovedByDefault - property
2023
@dbus_service_property(_interface,
2026
def ApprovedByDefault_dbus_property(self, value=None):
2027
if value is None: # get
2028
return dbus.Boolean(self.approved_by_default)
2029
self.approved_by_default = bool(value)
2031
# ApprovalDelay - property
2032
@dbus_service_property(_interface,
2035
def ApprovalDelay_dbus_property(self, value=None):
2036
if value is None: # get
2037
return dbus.UInt64(self.approval_delay.total_seconds()
2039
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2041
# ApprovalDuration - property
2042
@dbus_service_property(_interface,
2045
def ApprovalDuration_dbus_property(self, value=None):
2046
if value is None: # get
2047
return dbus.UInt64(self.approval_duration.total_seconds()
2049
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2053
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2054
@dbus_service_property(_interface, signature="s", access="read")
2055
def Name_dbus_property(self):
2056
return dbus.String(self.name)
2060
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2061
@dbus_service_property(_interface, signature="s", access="read")
2062
def KeyID_dbus_property(self):
2063
return dbus.String(self.key_id)
2065
# Fingerprint - property
2067
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2068
@dbus_service_property(_interface, signature="s", access="read")
2069
def Fingerprint_dbus_property(self):
2070
return dbus.String(self.fingerprint)
2073
@dbus_service_property(_interface,
2076
def Host_dbus_property(self, value=None):
2077
if value is None: # get
2078
return dbus.String(self.host)
2079
self.host = str(value)
2081
# Created - property
2083
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2084
@dbus_service_property(_interface, signature="s", access="read")
2085
def Created_dbus_property(self):
2086
return datetime_to_dbus(self.created)
2088
# LastEnabled - property
2089
@dbus_service_property(_interface, signature="s", access="read")
2090
def LastEnabled_dbus_property(self):
2091
return datetime_to_dbus(self.last_enabled)
2093
# Enabled - property
2094
@dbus_service_property(_interface,
2097
def Enabled_dbus_property(self, value=None):
2098
if value is None: # get
2099
return dbus.Boolean(self.enabled)
2105
# LastCheckedOK - property
2106
@dbus_service_property(_interface,
2109
def LastCheckedOK_dbus_property(self, value=None):
2110
if value is not None:
2113
return datetime_to_dbus(self.last_checked_ok)
2115
# LastCheckerStatus - property
2116
@dbus_service_property(_interface, signature="n", access="read")
2117
def LastCheckerStatus_dbus_property(self):
2118
return dbus.Int16(self.last_checker_status)
2120
# Expires - property
2121
@dbus_service_property(_interface, signature="s", access="read")
2122
def Expires_dbus_property(self):
2123
return datetime_to_dbus(self.expires)
2125
# LastApprovalRequest - property
2126
@dbus_service_property(_interface, signature="s", access="read")
2127
def LastApprovalRequest_dbus_property(self):
2128
return datetime_to_dbus(self.last_approval_request)
2130
# Timeout - property
2131
@dbus_service_property(_interface,
2134
def Timeout_dbus_property(self, value=None):
2135
if value is None: # get
2136
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2137
old_timeout = self.timeout
2138
self.timeout = datetime.timedelta(0, 0, 0, value)
2139
# Reschedule disabling
2141
now = datetime.datetime.utcnow()
2142
self.expires += self.timeout - old_timeout
2143
if self.expires <= now:
2144
# The timeout has passed
2147
if (getattr(self, "disable_initiator_tag", None)
2150
GLib.source_remove(self.disable_initiator_tag)
2151
self.disable_initiator_tag = GLib.timeout_add(
2152
int((self.expires - now).total_seconds() * 1000),
2155
# ExtendedTimeout - property
2156
@dbus_service_property(_interface,
2159
def ExtendedTimeout_dbus_property(self, value=None):
2160
if value is None: # get
2161
return dbus.UInt64(self.extended_timeout.total_seconds()
2163
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2165
# Interval - property
2166
@dbus_service_property(_interface,
2169
def Interval_dbus_property(self, value=None):
2170
if value is None: # get
2171
return dbus.UInt64(self.interval.total_seconds() * 1000)
2172
self.interval = datetime.timedelta(0, 0, 0, value)
2173
if getattr(self, "checker_initiator_tag", None) is None:
2176
# Reschedule checker run
2177
GLib.source_remove(self.checker_initiator_tag)
2178
self.checker_initiator_tag = GLib.timeout_add(
2179
value, self.start_checker)
2180
self.start_checker() # Start one now, too
2182
# Checker - property
2183
@dbus_service_property(_interface,
2186
def Checker_dbus_property(self, value=None):
2187
if value is None: # get
2188
return dbus.String(self.checker_command)
2189
self.checker_command = str(value)
2191
# CheckerRunning - property
2192
@dbus_service_property(_interface,
2195
def CheckerRunning_dbus_property(self, value=None):
2196
if value is None: # get
2197
return dbus.Boolean(self.checker is not None)
2199
self.start_checker()
2203
# ObjectPath - property
2205
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2206
"org.freedesktop.DBus.Deprecated": "true"})
2207
@dbus_service_property(_interface, signature="o", access="read")
2208
def ObjectPath_dbus_property(self):
2209
return self.dbus_object_path # is already a dbus.ObjectPath
2213
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2215
@dbus_service_property(_interface,
2219
def Secret_dbus_property(self, value):
2220
self.secret = bytes(value)
2226
def __init__(self, child_pipe, key_id, fpr, address):
2227
self._pipe = child_pipe
2228
self._pipe.send(('init', key_id, fpr, address))
2229
if not self._pipe.recv():
2230
raise KeyError(key_id or fpr)
2232
def __getattribute__(self, name):
2234
return super(ProxyClient, self).__getattribute__(name)
2235
self._pipe.send(('getattr', name))
2236
data = self._pipe.recv()
2237
if data[0] == 'data':
2239
if data[0] == 'function':
2241
def func(*args, **kwargs):
2242
self._pipe.send(('funcall', name, args, kwargs))
2243
return self._pipe.recv()[1]
2247
def __setattr__(self, name, value):
2249
return super(ProxyClient, self).__setattr__(name, value)
2250
self._pipe.send(('setattr', name, value))
2253
class ClientHandler(socketserver.BaseRequestHandler, object):
2254
"""A class to handle client connections.
2256
Instantiated once for each connection to handle it.
363
def still_valid(self):
364
"""Has the timeout not yet passed for this client?"""
365
now = datetime.datetime.now()
366
if self.last_checked_ok is None:
367
return now < (self.created + self.timeout)
369
return now < (self.last_checked_ok + self.timeout)
372
def peer_certificate(session):
373
"Return the peer's OpenPGP certificate as a bytestring"
374
# If not an OpenPGP certificate...
375
if gnutls.library.functions.gnutls_certificate_type_get\
376
(session._c_object) \
377
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
378
# ...do the normal thing
379
return session.peer_certificate
380
list_size = ctypes.c_uint()
381
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
382
(session._c_object, ctypes.byref(list_size))
383
if list_size.value == 0:
386
return ctypes.string_at(cert.data, cert.size)
389
def fingerprint(openpgp):
390
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
391
# New GnuTLS "datum" with the OpenPGP public key
392
datum = gnutls.library.types.gnutls_datum_t\
393
(ctypes.cast(ctypes.c_char_p(openpgp),
394
ctypes.POINTER(ctypes.c_ubyte)),
395
ctypes.c_uint(len(openpgp)))
396
# New empty GnuTLS certificate
397
crt = gnutls.library.types.gnutls_openpgp_crt_t()
398
gnutls.library.functions.gnutls_openpgp_crt_init\
400
# Import the OpenPGP public key into the certificate
401
gnutls.library.functions.gnutls_openpgp_crt_import\
402
(crt, ctypes.byref(datum),
403
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
404
# New buffer for the fingerprint
405
buffer = ctypes.create_string_buffer(20)
406
buffer_length = ctypes.c_size_t()
407
# Get the fingerprint from the certificate into the buffer
408
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
409
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
410
# Deinit the certificate
411
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
412
# Convert the buffer to a Python bytestring
413
fpr = ctypes.string_at(buffer, buffer_length.value)
414
# Convert the bytestring to hexadecimal notation
415
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
419
class tcp_handler(SocketServer.BaseRequestHandler, object):
420
"""A TCP request handler class.
421
Instantiated by IPv6_TCPServer for each request to handle it.
2257
422
Note: This will run in its own forked process."""
2259
424
def handle(self):
2260
with contextlib.closing(self.server.child_pipe) as child_pipe:
2261
logger.info("TCP connection from: %s",
2262
str(self.client_address))
2263
logger.debug("Pipe FD: %d",
2264
self.server.child_pipe.fileno())
2266
session = gnutls.ClientSession(self.request)
2268
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2269
# "+AES-256-CBC", "+SHA1",
2270
# "+COMP-NULL", "+CTYPE-OPENPGP",
2272
# Use a fallback default, since this MUST be set.
2273
priority = self.server.gnutls_priority
2274
if priority is None:
2276
gnutls.priority_set_direct(session._c_object,
2277
priority.encode("utf-8"),
2280
# Start communication using the Mandos protocol
2281
# Get protocol number
2282
line = self.request.makefile().readline()
2283
logger.debug("Protocol version: %r", line)
2285
if int(line.strip().split()[0]) > 1:
2286
raise RuntimeError(line)
2287
except (ValueError, IndexError, RuntimeError) as error:
2288
logger.error("Unknown protocol version: %s", error)
2291
# Start GnuTLS connection
2294
except gnutls.Error as error:
2295
logger.warning("Handshake failed: %s", error)
2296
# Do not run session.bye() here: the session is not
2297
# established. Just abandon the request.
2299
logger.debug("Handshake succeeded")
2301
approval_required = False
2303
if gnutls.has_rawpk:
2306
key_id = self.key_id(
2307
self.peer_certificate(session))
2308
except (TypeError, gnutls.Error) as error:
2309
logger.warning("Bad certificate: %s", error)
2311
logger.debug("Key ID: %s", key_id)
2316
fpr = self.fingerprint(
2317
self.peer_certificate(session))
2318
except (TypeError, gnutls.Error) as error:
2319
logger.warning("Bad certificate: %s", error)
2321
logger.debug("Fingerprint: %s", fpr)
2324
client = ProxyClient(child_pipe, key_id, fpr,
2325
self.client_address)
2329
if client.approval_delay:
2330
delay = client.approval_delay
2331
client.approvals_pending += 1
2332
approval_required = True
2335
if not client.enabled:
2336
logger.info("Client %s is disabled",
2338
if self.server.use_dbus:
2340
client.Rejected("Disabled")
2343
if client.approved or not client.approval_delay:
2344
# We are approved or approval is disabled
2346
elif client.approved is None:
2347
logger.info("Client %s needs approval",
2349
if self.server.use_dbus:
2351
client.NeedApproval(
2352
client.approval_delay.total_seconds()
2353
* 1000, client.approved_by_default)
2355
logger.warning("Client %s was not approved",
2357
if self.server.use_dbus:
2359
client.Rejected("Denied")
2362
# wait until timeout or approved
2363
time = datetime.datetime.now()
2364
client.changedstate.acquire()
2365
client.changedstate.wait(delay.total_seconds())
2366
client.changedstate.release()
2367
time2 = datetime.datetime.now()
2368
if (time2 - time) >= delay:
2369
if not client.approved_by_default:
2370
logger.warning("Client %s timed out while"
2371
" waiting for approval",
2373
if self.server.use_dbus:
2375
client.Rejected("Approval timed out")
2380
delay -= time2 - time
2383
session.send(client.secret)
2384
except gnutls.Error as error:
2385
logger.warning("gnutls send failed",
2389
logger.info("Sending secret to %s", client.name)
2390
# bump the timeout using extended_timeout
2391
client.bump_timeout(client.extended_timeout)
2392
if self.server.use_dbus:
2397
if approval_required:
2398
client.approvals_pending -= 1
2401
except gnutls.Error as error:
2402
logger.warning("GnuTLS bye failed",
2406
def peer_certificate(session):
2407
"Return the peer's certificate as a bytestring"
2409
cert_type = gnutls.certificate_type_get2(session._c_object,
2411
except AttributeError:
2412
cert_type = gnutls.certificate_type_get(session._c_object)
2413
if gnutls.has_rawpk:
2414
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2416
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2417
# If not a valid certificate type...
2418
if cert_type not in valid_cert_types:
2419
logger.info("Cert type %r not in %r", cert_type,
2421
# ...return invalid data
2423
list_size = ctypes.c_uint(1)
2424
cert_list = (gnutls.certificate_get_peers
2425
(session._c_object, ctypes.byref(list_size)))
2426
if not bool(cert_list) and list_size.value != 0:
2427
raise gnutls.Error("error getting peer certificate")
2428
if list_size.value == 0:
2431
return ctypes.string_at(cert.data, cert.size)
2434
def key_id(certificate):
2435
"Convert a certificate bytestring to a hexdigit key ID"
2436
# New GnuTLS "datum" with the public key
2437
datum = gnutls.datum_t(
2438
ctypes.cast(ctypes.c_char_p(certificate),
2439
ctypes.POINTER(ctypes.c_ubyte)),
2440
ctypes.c_uint(len(certificate)))
2441
# XXX all these need to be created in the gnutls "module"
2442
# New empty GnuTLS certificate
2443
pubkey = gnutls.pubkey_t()
2444
gnutls.pubkey_init(ctypes.byref(pubkey))
2445
# Import the raw public key into the certificate
2446
gnutls.pubkey_import(pubkey,
2447
ctypes.byref(datum),
2448
gnutls.X509_FMT_DER)
2449
# New buffer for the key ID
2450
buf = ctypes.create_string_buffer(32)
2451
buf_len = ctypes.c_size_t(len(buf))
2452
# Get the key ID from the raw public key into the buffer
2453
gnutls.pubkey_get_key_id(pubkey,
2454
gnutls.KEYID_USE_SHA256,
2455
ctypes.cast(ctypes.byref(buf),
2456
ctypes.POINTER(ctypes.c_ubyte)),
2457
ctypes.byref(buf_len))
2458
# Deinit the certificate
2459
gnutls.pubkey_deinit(pubkey)
2461
# Convert the buffer to a Python bytestring
2462
key_id = ctypes.string_at(buf, buf_len.value)
2463
# Convert the bytestring to hexadecimal notation
2464
hex_key_id = binascii.hexlify(key_id).upper()
2468
def fingerprint(openpgp):
2469
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2470
# New GnuTLS "datum" with the OpenPGP public key
2471
datum = gnutls.datum_t(
2472
ctypes.cast(ctypes.c_char_p(openpgp),
2473
ctypes.POINTER(ctypes.c_ubyte)),
2474
ctypes.c_uint(len(openpgp)))
2475
# New empty GnuTLS certificate
2476
crt = gnutls.openpgp_crt_t()
2477
gnutls.openpgp_crt_init(ctypes.byref(crt))
2478
# Import the OpenPGP public key into the certificate
2479
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2480
gnutls.OPENPGP_FMT_RAW)
2481
# Verify the self signature in the key
2482
crtverify = ctypes.c_uint()
2483
gnutls.openpgp_crt_verify_self(crt, 0,
2484
ctypes.byref(crtverify))
2485
if crtverify.value != 0:
2486
gnutls.openpgp_crt_deinit(crt)
2487
raise gnutls.CertificateSecurityError(code
2489
# New buffer for the fingerprint
2490
buf = ctypes.create_string_buffer(20)
2491
buf_len = ctypes.c_size_t()
2492
# Get the fingerprint from the certificate into the buffer
2493
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2494
ctypes.byref(buf_len))
2495
# Deinit the certificate
2496
gnutls.openpgp_crt_deinit(crt)
2497
# Convert the buffer to a Python bytestring
2498
fpr = ctypes.string_at(buf, buf_len.value)
2499
# Convert the bytestring to hexadecimal notation
2500
hex_fpr = binascii.hexlify(fpr).upper()
2504
class MultiprocessingMixIn:
2505
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2507
def sub_process_main(self, request, address):
2509
self.finish_request(request, address)
2511
self.handle_error(request, address)
2512
self.close_request(request)
2514
def process_request(self, request, address):
2515
"""Start a new process to process the request."""
2516
proc = multiprocessing.Process(target=self.sub_process_main,
2517
args=(request, address))
2522
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2523
""" adds a pipe to the MixIn """
2525
def process_request(self, request, client_address):
2526
"""Overrides and wraps the original process_request().
2528
This function creates a new pipe in self.pipe
2530
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2532
proc = MultiprocessingMixIn.process_request(self, request,
2534
self.child_pipe.close()
2535
self.add_pipe(parent_pipe, proc)
2537
def add_pipe(self, parent_pipe, proc):
2538
"""Dummy function; override as necessary"""
2539
raise NotImplementedError()
2542
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2543
socketserver.TCPServer):
2544
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
425
logger.info(u"TCP connection from: %s",
426
unicode(self.client_address))
427
session = gnutls.connection.ClientSession\
428
(self.request, gnutls.connection.X509Credentials())
430
line = self.request.makefile().readline()
431
logger.debug(u"Protocol version: %r", line)
433
if int(line.strip().split()[0]) > 1:
435
except (ValueError, IndexError, RuntimeError), error:
436
logger.error(u"Unknown protocol version: %s", error)
439
# Note: gnutls.connection.X509Credentials is really a generic
440
# GnuTLS certificate credentials object so long as no X.509
441
# keys are added to it. Therefore, we can use it here despite
442
# using OpenPGP certificates.
444
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
445
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
447
priority = "NORMAL" # Fallback default, since this
449
if self.server.settings["priority"]:
450
priority = self.server.settings["priority"]
451
gnutls.library.functions.gnutls_priority_set_direct\
452
(session._c_object, priority, None);
456
except gnutls.errors.GNUTLSError, error:
457
logger.warning(u"Handshake failed: %s", error)
458
# Do not run session.bye() here: the session is not
459
# established. Just abandon the request.
462
fpr = fingerprint(peer_certificate(session))
463
except (TypeError, gnutls.errors.GNUTLSError), error:
464
logger.warning(u"Bad certificate: %s", error)
467
logger.debug(u"Fingerprint: %s", fpr)
469
for c in self.server.clients:
470
if c.fingerprint == fpr:
474
logger.warning(u"Client not found for fingerprint: %s",
478
# Have to check if client.still_valid(), since it is possible
479
# that the client timed out while establishing the GnuTLS
481
if not client.still_valid():
482
logger.warning(u"Client %(name)s is invalid",
487
while sent_size < len(client.secret):
488
sent = session.send(client.secret[sent_size:])
489
logger.debug(u"Sent: %d, remaining: %d",
490
sent, len(client.secret)
491
- (sent_size + sent))
496
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
497
"""IPv6 TCP server. Accepts 'None' as address and/or port.
2547
enabled: Boolean; whether this server is activated yet
2548
interface: None or a network interface name (string)
2549
use_ipv6: Boolean; to use IPv6 or not
499
settings: Server settings
500
clients: Set() of Client objects
2552
def __init__(self, server_address, RequestHandlerClass,
2556
"""If socketfd is set, use that file descriptor instead of
2557
creating a new one with socket.socket().
2559
self.interface = interface
2561
self.address_family = socket.AF_INET6
2562
if socketfd is not None:
2563
# Save the file descriptor
2564
self.socketfd = socketfd
2565
# Save the original socket.socket() function
2566
self.socket_socket = socket.socket
2568
# To implement --socket, we monkey patch socket.socket.
2570
# (When socketserver.TCPServer is a new-style class, we
2571
# could make self.socket into a property instead of monkey
2572
# patching socket.socket.)
2574
# Create a one-time-only replacement for socket.socket()
2575
@functools.wraps(socket.socket)
2576
def socket_wrapper(*args, **kwargs):
2577
# Restore original function so subsequent calls are
2579
socket.socket = self.socket_socket
2580
del self.socket_socket
2581
# This time only, return a new socket object from the
2582
# saved file descriptor.
2583
return socket.fromfd(self.socketfd, *args, **kwargs)
2584
# Replace socket.socket() function with wrapper
2585
socket.socket = socket_wrapper
2586
# The socketserver.TCPServer.__init__ will call
2587
# socket.socket(), which might be our replacement,
2588
# socket_wrapper(), if socketfd was set.
2589
socketserver.TCPServer.__init__(self, server_address,
2590
RequestHandlerClass)
502
address_family = socket.AF_INET6
503
def __init__(self, *args, **kwargs):
504
if "settings" in kwargs:
505
self.settings = kwargs["settings"]
506
del kwargs["settings"]
507
if "clients" in kwargs:
508
self.clients = kwargs["clients"]
509
del kwargs["clients"]
510
return super(type(self), self).__init__(*args, **kwargs)
2592
511
def server_bind(self):
2593
512
"""This overrides the normal server_bind() function
2594
513
to bind to an interface if one was specified, and also NOT to
2595
514
bind to an address or port if they were not specified."""
2596
global SO_BINDTODEVICE
2597
if self.interface is not None:
2598
if SO_BINDTODEVICE is None:
2599
# Fall back to a hard-coded value which seems to be
2601
logger.warning("SO_BINDTODEVICE not found, trying 25")
2602
SO_BINDTODEVICE = 25
515
if self.settings["interface"]:
516
# 25 is from /usr/include/asm-i486/socket.h
517
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
2604
self.socket.setsockopt(
2605
socket.SOL_SOCKET, SO_BINDTODEVICE,
2606
(self.interface + "\0").encode("utf-8"))
2607
except socket.error as error:
2608
if error.errno == errno.EPERM:
2609
logger.error("No permission to bind to"
2610
" interface %s", self.interface)
2611
elif error.errno == errno.ENOPROTOOPT:
2612
logger.error("SO_BINDTODEVICE not available;"
2613
" cannot bind to interface %s",
2615
elif error.errno == errno.ENODEV:
2616
logger.error("Interface %s does not exist,"
2617
" cannot bind", self.interface)
519
self.socket.setsockopt(socket.SOL_SOCKET,
521
self.settings["interface"])
522
except socket.error, error:
523
if error[0] == errno.EPERM:
524
logger.error(u"No permission to"
525
u" bind to interface %s",
526
self.settings["interface"])
2620
529
# Only bind(2) the socket if we really need to.
2621
530
if self.server_address[0] or self.server_address[1]:
2622
if self.server_address[1]:
2623
self.allow_reuse_address = True
2624
531
if not self.server_address[0]:
2625
if self.address_family == socket.AF_INET6:
2626
any_address = "::" # in6addr_any
2628
any_address = "0.0.0.0" # INADDR_ANY
2629
self.server_address = (any_address,
533
self.server_address = (in6addr_any,
2630
534
self.server_address[1])
2631
535
elif not self.server_address[1]:
2632
self.server_address = (self.server_address[0], 0)
2633
# if self.interface:
536
self.server_address = (self.server_address[0],
538
# if self.settings["interface"]:
2634
539
# self.server_address = (self.server_address[0],
2637
542
# if_nametoindex
2639
return socketserver.TCPServer.server_bind(self)
2642
class MandosServer(IPv6_TCPServer):
2646
clients: set of Client objects
2647
gnutls_priority GnuTLS priority string
2648
use_dbus: Boolean; to emit D-Bus signals or not
2650
Assumes a GLib.MainLoop event loop.
2653
def __init__(self, server_address, RequestHandlerClass,
2657
gnutls_priority=None,
2660
self.enabled = False
2661
self.clients = clients
2662
if self.clients is None:
2664
self.use_dbus = use_dbus
2665
self.gnutls_priority = gnutls_priority
2666
IPv6_TCPServer.__init__(self, server_address,
2667
RequestHandlerClass,
2668
interface=interface,
2672
def server_activate(self):
2674
return socketserver.TCPServer.server_activate(self)
2679
def add_pipe(self, parent_pipe, proc):
2680
# Call "handle_ipc" for both data and EOF events
2682
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2683
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2684
functools.partial(self.handle_ipc,
2685
parent_pipe=parent_pipe,
2688
def handle_ipc(self, source, condition,
2691
client_object=None):
2692
# error, or the other end of multiprocessing.Pipe has closed
2693
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2694
# Wait for other process to exit
2698
# Read a request from the child
2699
request = parent_pipe.recv()
2700
command = request[0]
2702
if command == 'init':
2703
key_id = request[1].decode("ascii")
2704
fpr = request[2].decode("ascii")
2705
address = request[3]
2707
for c in self.clients.values():
2708
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2710
if key_id and c.key_id == key_id:
2713
if fpr and c.fingerprint == fpr:
2717
logger.info("Client not found for key ID: %s, address"
2718
": %s", key_id or fpr, address)
2721
mandos_dbus_service.ClientNotFound(key_id or fpr,
2723
parent_pipe.send(False)
2727
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2728
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2729
functools.partial(self.handle_ipc,
2730
parent_pipe=parent_pipe,
2732
client_object=client))
2733
parent_pipe.send(True)
2734
# remove the old hook in favor of the new above hook on
2737
if command == 'funcall':
2738
funcname = request[1]
2742
parent_pipe.send(('data', getattr(client_object,
2746
if command == 'getattr':
2747
attrname = request[1]
2748
if isinstance(client_object.__getattribute__(attrname),
2749
collections.Callable):
2750
parent_pipe.send(('function', ))
2753
'data', client_object.__getattribute__(attrname)))
2755
if command == 'setattr':
2756
attrname = request[1]
2758
setattr(client_object, attrname, value)
2763
def rfc3339_duration_to_delta(duration):
2764
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2766
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2768
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2770
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2772
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2774
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2776
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2778
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2782
# Parsing an RFC 3339 duration with regular expressions is not
2783
# possible - there would have to be multiple places for the same
2784
# values, like seconds. The current code, while more esoteric, is
2785
# cleaner without depending on a parsing library. If Python had a
2786
# built-in library for parsing we would use it, but we'd like to
2787
# avoid excessive use of external libraries.
2789
# New type for defining tokens, syntax, and semantics all-in-one
2790
Token = collections.namedtuple("Token", (
2791
"regexp", # To match token; if "value" is not None, must have
2792
# a "group" containing digits
2793
"value", # datetime.timedelta or None
2794
"followers")) # Tokens valid after this token
2795
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2796
# the "duration" ABNF definition in RFC 3339, Appendix A.
2797
token_end = Token(re.compile(r"$"), None, frozenset())
2798
token_second = Token(re.compile(r"(\d+)S"),
2799
datetime.timedelta(seconds=1),
2800
frozenset((token_end, )))
2801
token_minute = Token(re.compile(r"(\d+)M"),
2802
datetime.timedelta(minutes=1),
2803
frozenset((token_second, token_end)))
2804
token_hour = Token(re.compile(r"(\d+)H"),
2805
datetime.timedelta(hours=1),
2806
frozenset((token_minute, token_end)))
2807
token_time = Token(re.compile(r"T"),
2809
frozenset((token_hour, token_minute,
2811
token_day = Token(re.compile(r"(\d+)D"),
2812
datetime.timedelta(days=1),
2813
frozenset((token_time, token_end)))
2814
token_month = Token(re.compile(r"(\d+)M"),
2815
datetime.timedelta(weeks=4),
2816
frozenset((token_day, token_end)))
2817
token_year = Token(re.compile(r"(\d+)Y"),
2818
datetime.timedelta(weeks=52),
2819
frozenset((token_month, token_end)))
2820
token_week = Token(re.compile(r"(\d+)W"),
2821
datetime.timedelta(weeks=1),
2822
frozenset((token_end, )))
2823
token_duration = Token(re.compile(r"P"), None,
2824
frozenset((token_year, token_month,
2825
token_day, token_time,
2827
# Define starting values:
2829
value = datetime.timedelta()
2831
# Following valid tokens
2832
followers = frozenset((token_duration, ))
2833
# String left to parse
2835
# Loop until end token is found
2836
while found_token is not token_end:
2837
# Search for any currently valid tokens
2838
for token in followers:
2839
match = token.regexp.match(s)
2840
if match is not None:
2842
if token.value is not None:
2843
# Value found, parse digits
2844
factor = int(match.group(1), 10)
2845
# Add to value so far
2846
value += factor * token.value
2847
# Strip token from string
2848
s = token.regexp.sub("", s, 1)
2851
# Set valid next tokens
2852
followers = found_token.followers
2855
# No currently valid tokens were found
2856
raise ValueError("Invalid RFC 3339 duration: {!r}"
545
return super(type(self), self).server_bind()
2862
548
def string_to_delta(interval):
2863
549
"""Parse a string and return a datetime.timedelta
2865
>>> string_to_delta('7d') == datetime.timedelta(7)
2867
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2869
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2871
>>> string_to_delta('24h') == datetime.timedelta(1)
2873
>>> string_to_delta('1w') == datetime.timedelta(7)
2875
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
551
>>> string_to_delta('7d')
552
datetime.timedelta(7)
553
>>> string_to_delta('60s')
554
datetime.timedelta(0, 60)
555
>>> string_to_delta('60m')
556
datetime.timedelta(0, 3600)
557
>>> string_to_delta('24h')
558
datetime.timedelta(1)
559
>>> string_to_delta(u'1w')
560
datetime.timedelta(7)
2880
return rfc3339_duration_to_delta(interval)
2884
timevalue = datetime.timedelta(0)
2885
for s in interval.split():
2890
delta = datetime.timedelta(value)
2892
delta = datetime.timedelta(0, value)
2894
delta = datetime.timedelta(0, 0, 0, 0, value)
2896
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2898
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2900
raise ValueError("Unknown suffix {!r}".format(suffix))
2901
except IndexError as e:
2902
raise ValueError(*(e.args))
2907
def daemon(nochdir=False, noclose=False):
563
suffix=unicode(interval[-1])
564
value=int(interval[:-1])
566
delta = datetime.timedelta(value)
568
delta = datetime.timedelta(0, value)
570
delta = datetime.timedelta(0, 0, 0, 0, value)
572
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
574
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
577
except (ValueError, IndexError):
582
def server_state_changed(state):
583
"""Derived from the Avahi example code"""
584
if state == avahi.SERVER_COLLISION:
585
logger.error(u"Server name collision")
587
elif state == avahi.SERVER_RUNNING:
591
def entry_group_state_changed(state, error):
592
"""Derived from the Avahi example code"""
593
logger.debug(u"state change: %i", state)
595
if state == avahi.ENTRY_GROUP_ESTABLISHED:
596
logger.debug(u"Service established.")
597
elif state == avahi.ENTRY_GROUP_COLLISION:
598
logger.warning(u"Service name collision.")
600
elif state == avahi.ENTRY_GROUP_FAILURE:
601
logger.critical(u"Error in group state changed %s",
603
raise AvahiGroupError("State changed: %s", str(error))
605
def if_nametoindex(interface):
606
"""Call the C function if_nametoindex(), or equivalent"""
607
global if_nametoindex
609
if "ctypes.util" not in sys.modules:
611
if_nametoindex = ctypes.cdll.LoadLibrary\
612
(ctypes.util.find_library("c")).if_nametoindex
613
except (OSError, AttributeError):
614
if "struct" not in sys.modules:
616
if "fcntl" not in sys.modules:
618
def if_nametoindex(interface):
619
"Get an interface index the hard way, i.e. using fcntl()"
620
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
622
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
623
struct.pack("16s16x", interface))
625
interface_index = struct.unpack("I", ifreq[16:20])[0]
626
return interface_index
627
return if_nametoindex(interface)
630
def daemon(nochdir = False, noclose = False):
2908
631
"""See daemon(3). Standard BSD Unix function.
2910
632
This should really exist as os.daemon, but it doesn't (yet)."""
2934
##################################################################
2935
# Parsing of options, both command line and config file
2937
parser = argparse.ArgumentParser()
2938
parser.add_argument("-v", "--version", action="version",
2939
version="%(prog)s {}".format(version),
2940
help="show version number and exit")
2941
parser.add_argument("-i", "--interface", metavar="IF",
2942
help="Bind to interface IF")
2943
parser.add_argument("-a", "--address",
2944
help="Address to listen for requests on")
2945
parser.add_argument("-p", "--port", type=int,
2946
help="Port number to receive requests on")
2947
parser.add_argument("--check", action="store_true",
2948
help="Run self-test")
2949
parser.add_argument("--debug", action="store_true",
2950
help="Debug mode; run in foreground and log"
2951
" to terminal", default=None)
2952
parser.add_argument("--debuglevel", metavar="LEVEL",
2953
help="Debug level for stdout output")
2954
parser.add_argument("--priority", help="GnuTLS"
2955
" priority string (see GnuTLS documentation)")
2956
parser.add_argument("--servicename",
2957
metavar="NAME", help="Zeroconf service name")
2958
parser.add_argument("--configdir",
2959
default="/etc/mandos", metavar="DIR",
2960
help="Directory to search for configuration"
2962
parser.add_argument("--no-dbus", action="store_false",
2963
dest="use_dbus", help="Do not provide D-Bus"
2964
" system bus interface", default=None)
2965
parser.add_argument("--no-ipv6", action="store_false",
2966
dest="use_ipv6", help="Do not use IPv6",
2968
parser.add_argument("--no-restore", action="store_false",
2969
dest="restore", help="Do not restore stored"
2970
" state", default=None)
2971
parser.add_argument("--socket", type=int,
2972
help="Specify a file descriptor to a network"
2973
" socket to use instead of creating one")
2974
parser.add_argument("--statedir", metavar="DIR",
2975
help="Directory to save/restore state in")
2976
parser.add_argument("--foreground", action="store_true",
2977
help="Run in foreground", default=None)
2978
parser.add_argument("--no-zeroconf", action="store_false",
2979
dest="zeroconf", help="Do not use Zeroconf",
2982
options = parser.parse_args()
654
global main_loop_started
655
main_loop_started = False
657
parser = OptionParser(version = "Mandos server %s" % version)
658
parser.add_option("-i", "--interface", type="string",
659
metavar="IF", help="Bind to interface IF")
660
parser.add_option("-a", "--address", type="string",
661
help="Address to listen for requests on")
662
parser.add_option("-p", "--port", type="int",
663
help="Port number to receive requests on")
664
parser.add_option("--check", action="store_true", default=False,
665
help="Run self-test")
666
parser.add_option("--debug", action="store_true",
667
help="Debug mode; run in foreground and log to"
669
parser.add_option("--priority", type="string", help="GnuTLS"
670
" priority string (see GnuTLS documentation)")
671
parser.add_option("--servicename", type="string", metavar="NAME",
672
help="Zeroconf service name")
673
parser.add_option("--configdir", type="string",
674
default="/etc/mandos", metavar="DIR",
675
help="Directory to search for configuration"
677
(options, args) = parser.parse_args()
2984
684
# Default values for config file for server-global settings
2985
if gnutls.has_rawpk:
2986
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2987
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2989
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2990
":+SIGN-DSA-SHA256")
2991
server_defaults = {"interface": "",
2995
"priority": priority,
2996
"servicename": "Mandos",
3002
"statedir": "/var/lib/mandos",
3003
"foreground": "False",
685
server_defaults = { "interface": "",
690
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
691
"servicename": "Mandos",
3008
694
# Parse config file for server-global settings
3009
server_config = configparser.ConfigParser(server_defaults)
695
server_config = ConfigParser.SafeConfigParser(server_defaults)
3010
696
del server_defaults
3011
697
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3012
# Convert the ConfigParser object to a dict
3013
server_settings = server_config.defaults()
3014
# Use the appropriate methods on the non-string config options
3015
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3016
"foreground", "zeroconf"):
3017
server_settings[option] = server_config.getboolean("DEFAULT",
3019
if server_settings["port"]:
3020
server_settings["port"] = server_config.getint("DEFAULT",
3022
if server_settings["socket"]:
3023
server_settings["socket"] = server_config.getint("DEFAULT",
3025
# Later, stdin will, and stdout and stderr might, be dup'ed
3026
# over with an opened os.devnull. But we don't want this to
3027
# happen with a supplied network socket.
3028
if 0 <= server_settings["socket"] <= 2:
3029
server_settings["socket"] = os.dup(server_settings
698
server_section = "server"
699
# Convert the SafeConfigParser object to a dict
700
server_settings = dict(server_config.items(server_section))
701
# Use getboolean on the boolean config option
702
server_settings["debug"] = server_config.getboolean\
703
(server_section, "debug")
3031
704
del server_config
3033
706
# Override the settings from the config file with command line
3034
707
# options, if set.
3035
708
for option in ("interface", "address", "port", "debug",
3036
"priority", "servicename", "configdir", "use_dbus",
3037
"use_ipv6", "debuglevel", "restore", "statedir",
3038
"socket", "foreground", "zeroconf"):
709
"priority", "servicename", "configdir"):
3039
710
value = getattr(options, option)
3040
711
if value is not None:
3041
712
server_settings[option] = value
3043
# Force all strings to be unicode
3044
for option in server_settings.keys():
3045
if isinstance(server_settings[option], bytes):
3046
server_settings[option] = (server_settings[option]
3048
# Force all boolean options to be boolean
3049
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3050
"foreground", "zeroconf"):
3051
server_settings[option] = bool(server_settings[option])
3052
# Debug implies foreground
3053
if server_settings["debug"]:
3054
server_settings["foreground"] = True
3055
714
# Now we have our good server settings in "server_settings"
3057
##################################################################
3059
if (not server_settings["zeroconf"]
3060
and not (server_settings["port"]
3061
or server_settings["socket"] != "")):
3062
parser.error("Needs port or socket to work without Zeroconf")
3065
716
debug = server_settings["debug"]
3066
debuglevel = server_settings["debuglevel"]
3067
use_dbus = server_settings["use_dbus"]
3068
use_ipv6 = server_settings["use_ipv6"]
3069
stored_state_path = os.path.join(server_settings["statedir"],
3071
foreground = server_settings["foreground"]
3072
zeroconf = server_settings["zeroconf"]
3075
initlogger(debug, logging.DEBUG)
3080
level = getattr(logging, debuglevel.upper())
3081
initlogger(debug, level)
719
syslogger.setLevel(logging.WARNING)
3083
721
if server_settings["servicename"] != "Mandos":
3084
syslogger.setFormatter(
3085
logging.Formatter('Mandos ({}) [%(process)d]:'
3086
' %(levelname)s: %(message)s'.format(
3087
server_settings["servicename"])))
722
syslogger.setFormatter(logging.Formatter\
723
('Mandos (%s): %%(levelname)s:'
725
% server_settings["servicename"]))
3089
727
# Parse config file with clients
3090
client_config = configparser.ConfigParser(Client.client_defaults)
728
client_defaults = { "timeout": "1h",
730
"checker": "fping -q -- %%(host)s",
732
client_config = ConfigParser.SafeConfigParser(client_defaults)
3091
733
client_config.read(os.path.join(server_settings["configdir"],
3092
734
"clients.conf"))
3094
global mandos_dbus_service
3095
mandos_dbus_service = None
3098
if server_settings["socket"] != "":
3099
socketfd = server_settings["socket"]
3100
tcp_server = MandosServer(
3101
(server_settings["address"], server_settings["port"]),
3103
interface=(server_settings["interface"] or None),
3105
gnutls_priority=server_settings["priority"],
3109
pidfilename = "/run/mandos.pid"
3110
if not os.path.isdir("/run/."):
3111
pidfilename = "/var/run/mandos.pid"
3114
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3115
except IOError as e:
3116
logger.error("Could not open file %r", pidfilename,
3119
for name, group in (("_mandos", "_mandos"),
3120
("mandos", "mandos"),
3121
("nobody", "nogroup")):
3123
uid = pwd.getpwnam(name).pw_uid
3124
gid = pwd.getpwnam(group).pw_gid
3135
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3137
except OSError as error:
3138
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3139
.format(uid, gid, os.strerror(error.errno)))
3140
if error.errno != errno.EPERM:
3144
# Enable all possible GnuTLS debugging
3146
# "Use a log level over 10 to enable all debugging options."
3148
gnutls.global_set_log_level(11)
3151
def debug_gnutls(level, string):
3152
logger.debug("GnuTLS: %s", string[:-1])
3154
gnutls.global_set_log_function(debug_gnutls)
3156
# Redirect stdin so all checkers get /dev/null
3157
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3158
os.dup2(null, sys.stdin.fileno())
3162
# Need to fork before connecting to D-Bus
3164
# Close all input and output, do double fork, etc.
3167
if gi.version_info < (3, 10, 2):
3168
# multiprocessing will use threads, so before we use GLib we
3169
# need to inform GLib that threads will be used.
737
service = AvahiService(name = server_settings["servicename"],
738
type = "_mandos._tcp", );
739
if server_settings["interface"]:
740
service.interface = if_nametoindex(server_settings["interface"])
3172
742
global main_loop
3173
745
# From the Avahi example code
3174
DBusGMainLoop(set_as_default=True)
3175
main_loop = GLib.MainLoop()
746
DBusGMainLoop(set_as_default=True )
747
main_loop = gobject.MainLoop()
3176
748
bus = dbus.SystemBus()
749
server = dbus.Interface(
750
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
751
avahi.DBUS_INTERFACE_SERVER )
3177
752
# End of Avahi example code
3180
bus_name = dbus.service.BusName("se.recompile.Mandos",
3183
old_bus_name = dbus.service.BusName(
3184
"se.bsnet.fukt.Mandos", bus,
3186
except dbus.exceptions.DBusException as e:
3187
logger.error("Disabling D-Bus:", exc_info=e)
3189
server_settings["use_dbus"] = False
3190
tcp_server.use_dbus = False
3192
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3193
service = AvahiServiceToSyslog(
3194
name=server_settings["servicename"],
3195
servicetype="_mandos._tcp",
3198
if server_settings["interface"]:
3199
service.interface = if_nametoindex(
3200
server_settings["interface"].encode("utf-8"))
3202
global multiprocessing_manager
3203
multiprocessing_manager = multiprocessing.Manager()
3205
client_class = Client
3207
client_class = functools.partial(ClientDBus, bus=bus)
3209
client_settings = Client.config_parser(client_config)
3210
old_client_settings = {}
3213
# This is used to redirect stdout and stderr for checker processes
3215
wnull = open(os.devnull, "w") # A writable /dev/null
3216
# Only used if server is running in foreground but not in debug
3218
if debug or not foreground:
3221
# Get client data and settings from last running state.
3222
if server_settings["restore"]:
3224
with open(stored_state_path, "rb") as stored_state:
3225
if sys.version_info.major == 2:
3226
clients_data, old_client_settings = pickle.load(
3229
bytes_clients_data, bytes_old_client_settings = (
3230
pickle.load(stored_state, encoding="bytes"))
3231
# Fix bytes to strings
3234
clients_data = {(key.decode("utf-8")
3235
if isinstance(key, bytes)
3238
bytes_clients_data.items()}
3239
del bytes_clients_data
3240
for key in clients_data:
3241
value = {(k.decode("utf-8")
3242
if isinstance(k, bytes) else k): v
3244
clients_data[key].items()}
3245
clients_data[key] = value
3247
value["client_structure"] = [
3249
if isinstance(s, bytes)
3251
value["client_structure"]]
3252
# .name, .host, and .checker_command
3253
for k in ("name", "host", "checker_command"):
3254
if isinstance(value[k], bytes):
3255
value[k] = value[k].decode("utf-8")
3256
if "key_id" not in value:
3257
value["key_id"] = ""
3258
elif "fingerprint" not in value:
3259
value["fingerprint"] = ""
3260
# old_client_settings
3262
old_client_settings = {
3263
(key.decode("utf-8")
3264
if isinstance(key, bytes)
3267
bytes_old_client_settings.items()}
3268
del bytes_old_client_settings
3269
# .host and .checker_command
3270
for value in old_client_settings.values():
3271
for attribute in ("host", "checker_command"):
3272
if isinstance(value[attribute], bytes):
3273
value[attribute] = (value[attribute]
3275
os.remove(stored_state_path)
3276
except IOError as e:
3277
if e.errno == errno.ENOENT:
3278
logger.warning("Could not load persistent state:"
3279
" {}".format(os.strerror(e.errno)))
3281
logger.critical("Could not load persistent state:",
3284
except EOFError as e:
3285
logger.warning("Could not load persistent state: "
3289
with PGPEngine() as pgp:
3290
for client_name, client in clients_data.items():
3291
# Skip removed clients
3292
if client_name not in client_settings:
3295
# Decide which value to use after restoring saved state.
3296
# We have three different values: Old config file,
3297
# new config file, and saved state.
3298
# New config value takes precedence if it differs from old
3299
# config value, otherwise use saved state.
3300
for name, value in client_settings[client_name].items():
3302
# For each value in new config, check if it
3303
# differs from the old config value (Except for
3304
# the "secret" attribute)
3305
if (name != "secret"
3307
old_client_settings[client_name][name])):
3308
client[name] = value
3312
# Clients who has passed its expire date can still be
3313
# enabled if its last checker was successful. A Client
3314
# whose checker succeeded before we stored its state is
3315
# assumed to have successfully run all checkers during
3317
if client["enabled"]:
3318
if datetime.datetime.utcnow() >= client["expires"]:
3319
if not client["last_checked_ok"]:
3321
"disabling client {} - Client never "
3322
"performed a successful checker".format(
3324
client["enabled"] = False
3325
elif client["last_checker_status"] != 0:
3327
"disabling client {} - Client last"
3328
" checker failed with error code"
3331
client["last_checker_status"]))
3332
client["enabled"] = False
3334
client["expires"] = (
3335
datetime.datetime.utcnow()
3336
+ client["timeout"])
3337
logger.debug("Last checker succeeded,"
3338
" keeping {} enabled".format(
3341
client["secret"] = pgp.decrypt(
3342
client["encrypted_secret"],
3343
client_settings[client_name]["secret"])
3345
# If decryption fails, we use secret from new settings
3346
logger.debug("Failed to decrypt {} old secret".format(
3348
client["secret"] = (client_settings[client_name]
3351
# Add/remove clients based on new changes made to config
3352
for client_name in (set(old_client_settings)
3353
- set(client_settings)):
3354
del clients_data[client_name]
3355
for client_name in (set(client_settings)
3356
- set(old_client_settings)):
3357
clients_data[client_name] = client_settings[client_name]
3359
# Create all client objects
3360
for client_name, client in clients_data.items():
3361
tcp_server.clients[client_name] = client_class(
3364
server_settings=server_settings)
3366
if not tcp_server.clients:
3367
logger.warning("No clients defined")
3370
if pidfile is not None:
3374
print(pid, file=pidfile)
3376
logger.error("Could not write to file %r with PID %d",
755
console = logging.StreamHandler()
756
# console.setLevel(logging.DEBUG)
757
console.setFormatter(logging.Formatter\
758
('%(levelname)s: %(message)s'))
759
logger.addHandler(console)
763
def remove_from_clients(client):
764
clients.remove(client)
766
logger.critical(u"No clients left, exiting")
769
clients.update(Set(Client(name = section,
770
stop_hook = remove_from_clients,
772
= dict(client_config.items(section)))
773
for section in client_config.sections()))
775
logger.critical(u"No clients defined")
781
pidfilename = "/var/run/mandos/mandos.pid"
784
pidfile = open(pidfilename, "w")
785
pidfile.write(str(pid) + "\n")
3381
for termsig in (signal.SIGHUP, signal.SIGTERM):
3382
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3383
lambda: main_loop.quit() and False)
3387
@alternate_dbus_interfaces(
3388
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3389
class MandosDBusService(DBusObjectWithObjectManager):
3390
"""A D-Bus proxy object"""
3393
dbus.service.Object.__init__(self, bus, "/")
3395
_interface = "se.recompile.Mandos"
3397
@dbus.service.signal(_interface, signature="o")
3398
def ClientAdded(self, objpath):
3402
@dbus.service.signal(_interface, signature="ss")
3403
def ClientNotFound(self, key_id, address):
3407
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3409
@dbus.service.signal(_interface, signature="os")
3410
def ClientRemoved(self, objpath, name):
3414
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3416
@dbus.service.method(_interface, out_signature="ao")
3417
def GetAllClients(self):
3419
return dbus.Array(c.dbus_object_path for c in
3420
tcp_server.clients.values())
3422
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3424
@dbus.service.method(_interface,
3425
out_signature="a{oa{sv}}")
3426
def GetAllClientsWithProperties(self):
3428
return dbus.Dictionary(
3429
{c.dbus_object_path: c.GetAll(
3430
"se.recompile.Mandos.Client")
3431
for c in tcp_server.clients.values()},
3434
@dbus.service.method(_interface, in_signature="o")
3435
def RemoveClient(self, object_path):
3437
for c in tcp_server.clients.values():
3438
if c.dbus_object_path == object_path:
3439
del tcp_server.clients[c.name]
3440
c.remove_from_connection()
3441
# Don't signal the disabling
3442
c.disable(quiet=True)
3443
# Emit D-Bus signal for removal
3444
self.client_removed_signal(c)
3446
raise KeyError(object_path)
3450
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3451
out_signature="a{oa{sa{sv}}}")
3452
def GetManagedObjects(self):
3454
return dbus.Dictionary(
3455
{client.dbus_object_path:
3457
{interface: client.GetAll(interface)
3459
client._get_all_interface_names()})
3460
for client in tcp_server.clients.values()})
3462
def client_added_signal(self, client):
3463
"""Send the new standard signal and the old signal"""
3465
# New standard signal
3466
self.InterfacesAdded(
3467
client.dbus_object_path,
3469
{interface: client.GetAll(interface)
3471
client._get_all_interface_names()}))
3473
self.ClientAdded(client.dbus_object_path)
3475
def client_removed_signal(self, client):
3476
"""Send the new standard signal and the old signal"""
3478
# New standard signal
3479
self.InterfacesRemoved(
3480
client.dbus_object_path,
3481
client._get_all_interface_names())
3483
self.ClientRemoved(client.dbus_object_path,
3486
mandos_dbus_service = MandosDBusService()
3488
# Save modules to variables to exempt the modules from being
3489
# unloaded before the function registered with atexit() is run.
3490
mp = multiprocessing
789
logger.error(u"Could not write %s file with PID %d",
790
pidfilename, os.getpid())
3494
793
"Cleanup function; run on exit"
3498
mp.active_children()
3500
if not (tcp_server.clients or client_settings):
3503
# Store client before exiting. Secrets are encrypted with key
3504
# based on what config file has. If config file is
3505
# removed/edited, old secret will thus be unrecovable.
3507
with PGPEngine() as pgp:
3508
for client in tcp_server.clients.values():
3509
key = client_settings[client.name]["secret"]
3510
client.encrypted_secret = pgp.encrypt(client.secret,
3514
# A list of attributes that can not be pickled
3516
exclude = {"bus", "changedstate", "secret",
3517
"checker", "server_settings"}
3518
for name, typ in inspect.getmembers(dbus.service
3522
client_dict["encrypted_secret"] = (client
3524
for attr in client.client_structure:
3525
if attr not in exclude:
3526
client_dict[attr] = getattr(client, attr)
3528
clients[client.name] = client_dict
3529
del client_settings[client.name]["secret"]
3532
with tempfile.NamedTemporaryFile(
3536
dir=os.path.dirname(stored_state_path),
3537
delete=False) as stored_state:
3538
pickle.dump((clients, client_settings), stored_state,
3540
tempname = stored_state.name
3541
os.rename(tempname, stored_state_path)
3542
except (IOError, OSError) as e:
3548
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3549
logger.warning("Could not save persistent state: {}"
3550
.format(os.strerror(e.errno)))
3552
logger.warning("Could not save persistent state:",
3556
# Delete all clients, and settings from config
3557
while tcp_server.clients:
3558
name, client = tcp_server.clients.popitem()
3560
client.remove_from_connection()
3561
# Don't signal the disabling
3562
client.disable(quiet=True)
3563
# Emit D-Bus signal for removal
3565
mandos_dbus_service.client_removed_signal(client)
3566
client_settings.clear()
795
# From the Avahi example code
796
if not group is None:
799
# End of Avahi example code
802
client = clients.pop()
803
client.stop_hook = None
3568
806
atexit.register(cleanup)
3570
for client in tcp_server.clients.values():
3572
# Emit D-Bus signal for adding
3573
mandos_dbus_service.client_added_signal(client)
3574
# Need to initiate checking of clients
3576
client.init_checker()
3579
tcp_server.server_activate()
809
signal.signal(signal.SIGINT, signal.SIG_IGN)
810
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
811
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
813
for client in clients:
816
tcp_server = IPv6_TCPServer((server_settings["address"],
817
server_settings["port"]),
819
settings=server_settings,
3581
821
# Find out what port we got
3583
service.port = tcp_server.socket.getsockname()[1]
3585
logger.info("Now listening on address %r, port %d,"
3586
" flowinfo %d, scope_id %d",
3587
*tcp_server.socket.getsockname())
3589
logger.info("Now listening on address %r, port %d",
3590
*tcp_server.socket.getsockname())
3592
# service.interface = tcp_server.socket.getsockname()[3]
822
service.port = tcp_server.socket.getsockname()[1]
823
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
824
u" scope_id %d" % tcp_server.socket.getsockname())
826
#service.interface = tcp_server.socket.getsockname()[3]
3596
# From the Avahi example code
3599
except dbus.exceptions.DBusException as error:
3600
logger.critical("D-Bus Exception", exc_info=error)
3603
# End of Avahi example code
3606
GLib.IOChannel.unix_new(tcp_server.fileno()),
3607
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3608
lambda *args, **kwargs: (tcp_server.handle_request
3609
(*args[2:], **kwargs) or True))
3611
logger.debug("Starting main loop")
829
# From the Avahi example code
830
server.connect_to_signal("StateChanged", server_state_changed)
832
server_state_changed(server.GetState())
833
except dbus.exceptions.DBusException, error:
834
logger.critical(u"DBusException: %s", error)
836
# End of Avahi example code
838
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
839
lambda *args, **kwargs:
840
tcp_server.handle_request\
841
(*args[2:], **kwargs) or True)
843
logger.debug(u"Starting main loop")
844
main_loop_started = True
3613
except AvahiError as error:
3614
logger.critical("Avahi Error", exc_info=error)
846
except AvahiError, error:
847
logger.critical(u"AvahiError: %s" + unicode(error))
3617
849
except KeyboardInterrupt:
3619
print("", file=sys.stderr)
3620
logger.debug("Server received KeyboardInterrupt")
3621
logger.debug("Server exiting")
3622
# Must run before the D-Bus bus name gets deregistered
3626
def should_only_run_tests():
3627
parser = argparse.ArgumentParser(add_help=False)
3628
parser.add_argument("--check", action='store_true')
3629
args, unknown_args = parser.parse_known_args()
3630
run_tests = args.check
3632
# Remove --check argument from sys.argv
3633
sys.argv[1:] = unknown_args
3636
# Add all tests from doctest strings
3637
def load_tests(loader, tests, none):
3639
tests.addTests(doctest.DocTestSuite())
3642
853
if __name__ == '__main__':
3644
if should_only_run_tests():
3645
# Call using ./mandos --check [--verbose]