331
104
max_renames: integer; maximum number of renames
332
105
rename_count: integer; counter so we only rename after collisions
333
106
a sensible number of times
334
group: D-Bus Entry Group
336
bus: dbus.SystemBus()
340
interface=avahi.IF_UNSPEC,
348
protocol=avahi.PROTO_UNSPEC,
108
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
109
type = None, port = None, TXT = None, domain = "",
110
host = "", max_renames = 32768):
350
111
self.interface = interface
352
self.type = servicetype
354
self.TXT = TXT if TXT is not None else []
355
119
self.domain = domain
357
121
self.rename_count = 0
358
self.max_renames = max_renames
359
self.protocol = protocol
360
self.group = None # our entry group
363
self.entry_group_state_changed_match = None
365
def rename(self, remove=True):
366
123
"""Derived from the Avahi example code"""
367
124
if self.rename_count >= self.max_renames:
368
logger.critical("No suitable Zeroconf service name found"
369
" after %i retries, exiting.",
125
logger.critical(u"No suitable service name found after %i"
126
u" retries, exiting.", rename_count)
371
127
raise AvahiServiceError("Too many renames")
373
self.server.GetAlternativeServiceName(self.name))
128
name = server.GetAlternativeServiceName(name)
129
logger.error(u"Changing name to %r ...", name)
130
syslogger.setFormatter(logging.Formatter\
131
('Mandos (%s): %%(levelname)s:'
132
' %%(message)s' % name))
374
135
self.rename_count += 1
375
logger.info("Changing Zeroconf service name to %r ...",
381
except dbus.exceptions.DBusException as error:
382
if (error.get_dbus_name()
383
== "org.freedesktop.Avahi.CollisionError"):
384
logger.info("Local Zeroconf service name collision.")
385
return self.rename(remove=False)
387
logger.critical("D-Bus Exception", exc_info=error)
391
136
def remove(self):
392
137
"""Derived from the Avahi example code"""
393
if self.entry_group_state_changed_match is not None:
394
self.entry_group_state_changed_match.remove()
395
self.entry_group_state_changed_match = None
396
if self.group is not None:
138
if group is not None:
400
141
"""Derived from the Avahi example code"""
402
if self.group is None:
403
self.group = dbus.Interface(
404
self.bus.get_object(avahi.DBUS_NAME,
405
self.server.EntryGroupNew()),
406
avahi.DBUS_INTERFACE_ENTRY_GROUP)
407
self.entry_group_state_changed_match = (
408
self.group.connect_to_signal(
409
'StateChanged', self.entry_group_state_changed))
410
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
411
self.name, self.type)
412
self.group.AddService(
415
dbus.UInt32(0), # flags
416
self.name, self.type,
417
self.domain, self.host,
418
dbus.UInt16(self.port),
419
avahi.string_array_to_txt_array(self.TXT))
422
def entry_group_state_changed(self, state, error):
423
"""Derived from the Avahi example code"""
424
logger.debug("Avahi entry group state change: %i", state)
426
if state == avahi.ENTRY_GROUP_ESTABLISHED:
427
logger.debug("Zeroconf service established.")
428
elif state == avahi.ENTRY_GROUP_COLLISION:
429
logger.info("Zeroconf service name collision.")
431
elif state == avahi.ENTRY_GROUP_FAILURE:
432
logger.critical("Avahi: Error in group state changed %s",
434
raise AvahiGroupError("State changed: {!s}".format(error))
437
"""Derived from the Avahi example code"""
438
if self.group is not None:
441
except (dbus.exceptions.UnknownMethodException,
442
dbus.exceptions.DBusException):
447
def server_state_changed(self, state, error=None):
448
"""Derived from the Avahi example code"""
449
logger.debug("Avahi server state change: %i", state)
451
avahi.SERVER_INVALID: "Zeroconf server invalid",
452
avahi.SERVER_REGISTERING: None,
453
avahi.SERVER_COLLISION: "Zeroconf server name collision",
454
avahi.SERVER_FAILURE: "Zeroconf server failure",
456
if state in bad_states:
457
if bad_states[state] is not None:
459
logger.error(bad_states[state])
461
logger.error(bad_states[state] + ": %r", error)
463
elif state == avahi.SERVER_RUNNING:
466
except dbus.exceptions.DBusException as error:
467
if (error.get_dbus_name()
468
== "org.freedesktop.Avahi.CollisionError"):
469
logger.info("Local Zeroconf service name"
471
return self.rename(remove=False)
473
logger.critical("D-Bus Exception", exc_info=error)
478
logger.debug("Unknown state: %r", state)
480
logger.debug("Unknown state: %r: %r", state, error)
483
"""Derived from the Avahi example code"""
484
if self.server is None:
485
self.server = dbus.Interface(
486
self.bus.get_object(avahi.DBUS_NAME,
487
avahi.DBUS_PATH_SERVER,
488
follow_name_owner_changes=True),
489
avahi.DBUS_INTERFACE_SERVER)
490
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
492
self.server_state_changed(self.server.GetState())
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
"""Add the new name to the syslog messages"""
498
ret = AvahiService.rename(self, *args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
505
# Pretend that we have a GnuTLS module
506
class GnuTLS(object):
507
"""This isn't so much a class as it is a module-like namespace.
508
It is instantiated once, and simulates having a GnuTLS module."""
510
library = ctypes.util.find_library("gnutls")
512
library = ctypes.util.find_library("gnutls-deb0")
513
_library = ctypes.cdll.LoadLibrary(library)
515
_need_version = b"3.3.0"
518
# Need to use "self" here, since this method is called before
519
# the assignment to the "gnutls" global variable happens.
520
if self.check_version(self._need_version) is None:
521
raise self.Error("Needs GnuTLS {} or later"
522
.format(self._need_version))
524
# Unless otherwise indicated, the constants and types below are
525
# all from the gnutls/gnutls.h C header file.
535
E_NO_CERTIFICATE_FOUND = -49
536
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
539
class session_int(ctypes.Structure):
541
session_t = ctypes.POINTER(session_int)
543
class certificate_credentials_st(ctypes.Structure):
545
certificate_credentials_t = ctypes.POINTER(
546
certificate_credentials_st)
547
certificate_type_t = ctypes.c_int
549
class datum_t(ctypes.Structure):
550
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
551
('size', ctypes.c_uint)]
553
class openpgp_crt_int(ctypes.Structure):
555
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
556
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
557
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
558
credentials_type_t = ctypes.c_int
559
transport_ptr_t = ctypes.c_void_p
560
close_request_t = ctypes.c_int
563
class Error(Exception):
564
# We need to use the class name "GnuTLS" here, since this
565
# exception might be raised from within GnuTLS.__init__,
566
# which is called before the assignment to the "gnutls"
567
# global variable has happened.
568
def __init__(self, message=None, code=None, args=()):
569
# Default usage is by a message string, but if a return
570
# code is passed, convert it to a string with
573
if message is None and code is not None:
574
message = GnuTLS.strerror(code)
575
return super(GnuTLS.Error, self).__init__(
578
class CertificateSecurityError(Error):
582
class Credentials(object):
584
self._c_object = gnutls.certificate_credentials_t()
585
gnutls.certificate_allocate_credentials(
586
ctypes.byref(self._c_object))
587
self.type = gnutls.CRD_CERTIFICATE
590
gnutls.certificate_free_credentials(self._c_object)
592
class ClientSession(object):
593
def __init__(self, socket, credentials=None):
594
self._c_object = gnutls.session_t()
595
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
596
gnutls.set_default_priority(self._c_object)
597
gnutls.transport_set_ptr(self._c_object, socket.fileno())
598
gnutls.handshake_set_private_extensions(self._c_object,
601
if credentials is None:
602
credentials = gnutls.Credentials()
603
gnutls.credentials_set(self._c_object, credentials.type,
604
ctypes.cast(credentials._c_object,
606
self.credentials = credentials
609
gnutls.deinit(self._c_object)
612
return gnutls.handshake(self._c_object)
614
def send(self, data):
618
data_len -= gnutls.record_send(self._c_object,
623
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
625
# Error handling functions
626
def _error_code(result):
627
"""A function to raise exceptions on errors, suitable
628
for the 'restype' attribute on ctypes functions"""
631
if result == gnutls.E_NO_CERTIFICATE_FOUND:
632
raise gnutls.CertificateSecurityError(code=result)
633
raise gnutls.Error(code=result)
635
def _retry_on_error(result, func, arguments):
636
"""A function to retry on some errors, suitable
637
for the 'errcheck' attribute on ctypes functions"""
639
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
640
return _error_code(result)
641
result = func(*arguments)
644
# Unless otherwise indicated, the function declarations below are
645
# all from the gnutls/gnutls.h C header file.
648
priority_set_direct = _library.gnutls_priority_set_direct
649
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
650
ctypes.POINTER(ctypes.c_char_p)]
651
priority_set_direct.restype = _error_code
653
init = _library.gnutls_init
654
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
655
init.restype = _error_code
657
set_default_priority = _library.gnutls_set_default_priority
658
set_default_priority.argtypes = [session_t]
659
set_default_priority.restype = _error_code
661
record_send = _library.gnutls_record_send
662
record_send.argtypes = [session_t, ctypes.c_void_p,
664
record_send.restype = ctypes.c_ssize_t
665
record_send.errcheck = _retry_on_error
667
certificate_allocate_credentials = (
668
_library.gnutls_certificate_allocate_credentials)
669
certificate_allocate_credentials.argtypes = [
670
ctypes.POINTER(certificate_credentials_t)]
671
certificate_allocate_credentials.restype = _error_code
673
certificate_free_credentials = (
674
_library.gnutls_certificate_free_credentials)
675
certificate_free_credentials.argtypes = [
676
certificate_credentials_t]
677
certificate_free_credentials.restype = None
679
handshake_set_private_extensions = (
680
_library.gnutls_handshake_set_private_extensions)
681
handshake_set_private_extensions.argtypes = [session_t,
683
handshake_set_private_extensions.restype = None
685
credentials_set = _library.gnutls_credentials_set
686
credentials_set.argtypes = [session_t, credentials_type_t,
688
credentials_set.restype = _error_code
690
strerror = _library.gnutls_strerror
691
strerror.argtypes = [ctypes.c_int]
692
strerror.restype = ctypes.c_char_p
694
certificate_type_get = _library.gnutls_certificate_type_get
695
certificate_type_get.argtypes = [session_t]
696
certificate_type_get.restype = _error_code
698
certificate_get_peers = _library.gnutls_certificate_get_peers
699
certificate_get_peers.argtypes = [session_t,
700
ctypes.POINTER(ctypes.c_uint)]
701
certificate_get_peers.restype = ctypes.POINTER(datum_t)
703
global_set_log_level = _library.gnutls_global_set_log_level
704
global_set_log_level.argtypes = [ctypes.c_int]
705
global_set_log_level.restype = None
707
global_set_log_function = _library.gnutls_global_set_log_function
708
global_set_log_function.argtypes = [log_func]
709
global_set_log_function.restype = None
711
deinit = _library.gnutls_deinit
712
deinit.argtypes = [session_t]
713
deinit.restype = None
715
handshake = _library.gnutls_handshake
716
handshake.argtypes = [session_t]
717
handshake.restype = _error_code
718
handshake.errcheck = _retry_on_error
720
transport_set_ptr = _library.gnutls_transport_set_ptr
721
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
722
transport_set_ptr.restype = None
724
bye = _library.gnutls_bye
725
bye.argtypes = [session_t, close_request_t]
726
bye.restype = _error_code
727
bye.errcheck = _retry_on_error
729
check_version = _library.gnutls_check_version
730
check_version.argtypes = [ctypes.c_char_p]
731
check_version.restype = ctypes.c_char_p
733
# All the function declarations below are from gnutls/openpgp.h
735
openpgp_crt_init = _library.gnutls_openpgp_crt_init
736
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
737
openpgp_crt_init.restype = _error_code
739
openpgp_crt_import = _library.gnutls_openpgp_crt_import
740
openpgp_crt_import.argtypes = [openpgp_crt_t,
741
ctypes.POINTER(datum_t),
743
openpgp_crt_import.restype = _error_code
745
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
746
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
747
ctypes.POINTER(ctypes.c_uint)]
748
openpgp_crt_verify_self.restype = _error_code
750
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
751
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
752
openpgp_crt_deinit.restype = None
754
openpgp_crt_get_fingerprint = (
755
_library.gnutls_openpgp_crt_get_fingerprint)
756
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
760
openpgp_crt_get_fingerprint.restype = _error_code
762
# Remove non-public functions
763
del _error_code, _retry_on_error
764
# Create the global "gnutls" object, simulating a module
768
def call_pipe(connection, # : multiprocessing.Connection
769
func, *args, **kwargs):
770
"""This function is meant to be called by multiprocessing.Process
772
This function runs func(*args, **kwargs), and writes the resulting
773
return value on the provided multiprocessing.Connection.
775
connection.send(func(*args, **kwargs))
144
group = dbus.Interface\
145
(bus.get_object(avahi.DBUS_NAME,
146
server.EntryGroupNew()),
147
avahi.DBUS_INTERFACE_ENTRY_GROUP)
148
group.connect_to_signal('StateChanged',
149
entry_group_state_changed)
150
logger.debug(u"Adding service '%s' of type '%s' ...",
151
service.name, service.type)
153
self.interface, # interface
154
avahi.PROTO_INET6, # protocol
155
dbus.UInt32(0), # flags
156
self.name, self.type,
157
self.domain, self.host,
158
dbus.UInt16(self.port),
159
avahi.string_array_to_txt_array(self.TXT))
162
# From the Avahi example code:
163
group = None # our entry group
164
# End of Avahi example code
779
167
class Client(object):
780
168
"""A representation of a client host served by this server.
783
approved: bool(); 'None' if not yet approved/disapproved
784
approval_delay: datetime.timedelta(); Time to wait for approval
785
approval_duration: datetime.timedelta(); Duration of one approval
786
checker: subprocess.Popen(); a running checker process used
787
to see if the client lives.
788
'None' if no process is running.
789
checker_callback_tag: a GLib event source tag, or None
790
checker_command: string; External command which is run to check
791
if client lives. %() expansions are done at
170
name: string; from the config file, used in log messages
171
fingerprint: string (40 or 32 hexadecimal digits); used to
172
uniquely identify the client
173
secret: bytestring; sent verbatim (over TLS) to client
174
host: string; available for use by the checker command
175
created: datetime.datetime(); object creation, not client host
176
last_checked_ok: datetime.datetime() or None if not yet checked OK
177
timeout: datetime.timedelta(); How long from last_checked_ok
178
until this client is invalid
179
interval: datetime.timedelta(); How often to start a new checker
180
stop_hook: If set, called by stop() as stop_hook(self)
181
checker: subprocess.Popen(); a running checker process used
182
to see if the client lives.
183
'None' if no process is running.
184
checker_initiator_tag: a gobject event source tag, or None
185
stop_initiator_tag: - '' -
186
checker_callback_tag: - '' -
187
checker_command: string; External command which is run to check if
188
client lives. %() expansions are done at
792
189
runtime with vars(self) as dict, so that for
793
190
instance %(name)s can be used in the command.
794
checker_initiator_tag: a GLib event source tag, or None
795
created: datetime.datetime(); (UTC) object creation
796
client_structure: Object describing what attributes a client has
797
and is used for storing the client at exit
798
current_checker_command: string; current running checker_command
799
disable_initiator_tag: a GLib event source tag, or None
801
fingerprint: string (40 or 32 hexadecimal digits); used to
802
uniquely identify the client
803
host: string; available for use by the checker command
804
interval: datetime.timedelta(); How often to start a new checker
805
last_approval_request: datetime.datetime(); (UTC) or None
806
last_checked_ok: datetime.datetime(); (UTC) or None
807
last_checker_status: integer between 0 and 255 reflecting exit
808
status of last checker. -1 reflects crashed
809
checker, -2 means no checker completed yet.
810
last_checker_signal: The signal which killed the last checker, if
811
last_checker_status is -1
812
last_enabled: datetime.datetime(); (UTC) or None
813
name: string; from the config file, used in log messages and
815
secret: bytestring; sent verbatim (over TLS) to client
816
timeout: datetime.timedelta(); How long from last_checked_ok
817
until this client is disabled
818
extended_timeout: extra long timeout when secret has been sent
819
runtime_expansions: Allowed attributes for runtime expansion.
820
expires: datetime.datetime(); time (UTC) when a client will be
822
server_settings: The server_settings dict from main()
192
_timeout: Real variable for 'timeout'
193
_interval: Real variable for 'interval'
194
_timeout_milliseconds: Used when calling gobject.timeout_add()
195
_interval_milliseconds: - '' -
825
runtime_expansions = ("approval_delay", "approval_duration",
826
"created", "enabled", "expires",
827
"fingerprint", "host", "interval",
828
"last_approval_request", "last_checked_ok",
829
"last_enabled", "name", "timeout")
832
"extended_timeout": "PT15M",
834
"checker": "fping -q -- %%(host)s",
836
"approval_delay": "PT0S",
837
"approval_duration": "PT1S",
838
"approved_by_default": "True",
843
def config_parser(config):
844
"""Construct a new dict of client settings of this form:
845
{ client_name: {setting_name: value, ...}, ...}
846
with exceptions for any special settings as defined above.
847
NOTE: Must be a pure function. Must return the same result
848
value given the same arguments.
851
for client_name in config.sections():
852
section = dict(config.items(client_name))
853
client = settings[client_name] = {}
855
client["host"] = section["host"]
856
# Reformat values from string types to Python types
857
client["approved_by_default"] = config.getboolean(
858
client_name, "approved_by_default")
859
client["enabled"] = config.getboolean(client_name,
862
# Uppercase and remove spaces from fingerprint for later
863
# comparison purposes with return value from the
864
# fingerprint() function
865
client["fingerprint"] = (section["fingerprint"].upper()
867
if "secret" in section:
868
client["secret"] = codecs.decode(section["secret"]
871
elif "secfile" in section:
872
with open(os.path.expanduser(os.path.expandvars
873
(section["secfile"])),
875
client["secret"] = secfile.read()
877
raise TypeError("No secret or secfile for section {}"
879
client["timeout"] = string_to_delta(section["timeout"])
880
client["extended_timeout"] = string_to_delta(
881
section["extended_timeout"])
882
client["interval"] = string_to_delta(section["interval"])
883
client["approval_delay"] = string_to_delta(
884
section["approval_delay"])
885
client["approval_duration"] = string_to_delta(
886
section["approval_duration"])
887
client["checker_command"] = section["checker"]
888
client["last_approval_request"] = None
889
client["last_checked_ok"] = None
890
client["last_checker_status"] = -2
894
def __init__(self, settings, name=None, server_settings=None):
197
def _set_timeout(self, timeout):
198
"Setter function for 'timeout' attribute"
199
self._timeout = timeout
200
self._timeout_milliseconds = ((self.timeout.days
201
* 24 * 60 * 60 * 1000)
202
+ (self.timeout.seconds * 1000)
203
+ (self.timeout.microseconds
205
timeout = property(lambda self: self._timeout,
208
def _set_interval(self, interval):
209
"Setter function for 'interval' attribute"
210
self._interval = interval
211
self._interval_milliseconds = ((self.interval.days
212
* 24 * 60 * 60 * 1000)
213
+ (self.interval.seconds
215
+ (self.interval.microseconds
217
interval = property(lambda self: self._interval,
220
def __init__(self, name = None, stop_hook=None, config={}):
221
"""Note: the 'checker' key in 'config' sets the
222
'checker_command' attribute and *not* the 'checker'
896
if server_settings is None:
898
self.server_settings = server_settings
899
# adding all client settings
900
for setting, value in settings.items():
901
setattr(self, setting, value)
904
if not hasattr(self, "last_enabled"):
905
self.last_enabled = datetime.datetime.utcnow()
906
if not hasattr(self, "expires"):
907
self.expires = (datetime.datetime.utcnow()
225
logger.debug(u"Creating client %r", self.name)
226
# Uppercase and remove spaces from fingerprint for later
227
# comparison purposes with return value from the fingerprint()
229
self.fingerprint = config["fingerprint"].upper()\
231
logger.debug(u" Fingerprint: %s", self.fingerprint)
232
if "secret" in config:
233
self.secret = config["secret"].decode(u"base64")
234
elif "secfile" in config:
235
sf = open(config["secfile"])
236
self.secret = sf.read()
910
self.last_enabled = None
913
logger.debug("Creating client %r", self.name)
914
logger.debug(" Fingerprint: %s", self.fingerprint)
915
self.created = settings.get("created",
916
datetime.datetime.utcnow())
918
# attributes specific for this server instance
239
raise TypeError(u"No secret or secfile for client %s"
241
self.host = config.get("host", "")
242
self.created = datetime.datetime.now()
243
self.last_checked_ok = None
244
self.timeout = string_to_delta(config["timeout"])
245
self.interval = string_to_delta(config["interval"])
246
self.stop_hook = stop_hook
919
247
self.checker = None
920
248
self.checker_initiator_tag = None
921
self.disable_initiator_tag = None
249
self.stop_initiator_tag = None
922
250
self.checker_callback_tag = None
923
self.current_checker_command = None
925
self.approvals_pending = 0
926
self.changedstate = multiprocessing_manager.Condition(
927
multiprocessing_manager.Lock())
928
self.client_structure = [attr
929
for attr in self.__dict__.keys()
930
if not attr.startswith("_")]
931
self.client_structure.append("client_structure")
933
for name, t in inspect.getmembers(
934
type(self), lambda obj: isinstance(obj, property)):
935
if not name.startswith("_"):
936
self.client_structure.append(name)
938
# Send notice to process children that client state has changed
939
def send_changedstate(self):
940
with self.changedstate:
941
self.changedstate.notify_all()
251
self.check_command = config["checker"]
944
253
"""Start this client's checker and timeout hooks"""
945
if getattr(self, "enabled", False):
948
self.expires = datetime.datetime.utcnow() + self.timeout
950
self.last_enabled = datetime.datetime.utcnow()
952
self.send_changedstate()
954
def disable(self, quiet=True):
955
"""Disable this client."""
956
if not getattr(self, "enabled", False):
959
logger.info("Disabling client %s", self.name)
960
if getattr(self, "disable_initiator_tag", None) is not None:
961
GLib.source_remove(self.disable_initiator_tag)
962
self.disable_initiator_tag = None
964
if getattr(self, "checker_initiator_tag", None) is not None:
965
GLib.source_remove(self.checker_initiator_tag)
966
self.checker_initiator_tag = None
970
self.send_changedstate()
971
# Do not run this again if called by a GLib.timeout_add
977
def init_checker(self):
978
254
# Schedule a new checker to be started an 'interval' from now,
979
255
# and every interval from then on.
980
if self.checker_initiator_tag is not None:
981
GLib.source_remove(self.checker_initiator_tag)
982
self.checker_initiator_tag = GLib.timeout_add(
983
int(self.interval.total_seconds() * 1000),
985
# Schedule a disable() when 'timeout' has passed
986
if self.disable_initiator_tag is not None:
987
GLib.source_remove(self.disable_initiator_tag)
988
self.disable_initiator_tag = GLib.timeout_add(
989
int(self.timeout.total_seconds() * 1000), self.disable)
256
self.checker_initiator_tag = gobject.timeout_add\
257
(self._interval_milliseconds,
990
259
# Also start a new checker *right now*.
991
260
self.start_checker()
993
def checker_callback(self, source, condition, connection,
261
# Schedule a stop() when 'timeout' has passed
262
self.stop_initiator_tag = gobject.timeout_add\
263
(self._timeout_milliseconds,
267
The possibility that a client might be restarted is left open,
268
but not currently used."""
269
# If this client doesn't have a secret, it is already stopped.
270
if hasattr(self, "secret") and self.secret:
271
logger.info(u"Stopping client %s", self.name)
275
if getattr(self, "stop_initiator_tag", False):
276
gobject.source_remove(self.stop_initiator_tag)
277
self.stop_initiator_tag = None
278
if getattr(self, "checker_initiator_tag", False):
279
gobject.source_remove(self.checker_initiator_tag)
280
self.checker_initiator_tag = None
284
# Do not run this again if called by a gobject.timeout_add
287
self.stop_hook = None
289
def checker_callback(self, pid, condition):
995
290
"""The checker has completed, so take appropriate actions."""
291
now = datetime.datetime.now()
996
292
self.checker_callback_tag = None
997
293
self.checker = None
998
# Read return code from connection (see call_pipe)
999
returncode = connection.recv()
1003
self.last_checker_status = returncode
1004
self.last_checker_signal = None
1005
if self.last_checker_status == 0:
1006
logger.info("Checker for %(name)s succeeded",
1010
logger.info("Checker for %(name)s failed", vars(self))
1012
self.last_checker_status = -1
1013
self.last_checker_signal = -returncode
1014
logger.warning("Checker for %(name)s crashed?",
294
if os.WIFEXITED(condition) \
295
and (os.WEXITSTATUS(condition) == 0):
296
logger.info(u"Checker for %(name)s succeeded",
298
self.last_checked_ok = now
299
gobject.source_remove(self.stop_initiator_tag)
300
self.stop_initiator_tag = gobject.timeout_add\
301
(self._timeout_milliseconds,
303
elif not os.WIFEXITED(condition):
304
logger.warning(u"Checker for %(name)s crashed?",
1018
def checked_ok(self):
1019
"""Assert that the client has been seen, alive and well."""
1020
self.last_checked_ok = datetime.datetime.utcnow()
1021
self.last_checker_status = 0
1022
self.last_checker_signal = None
1025
def bump_timeout(self, timeout=None):
1026
"""Bump up the timeout for this client."""
1028
timeout = self.timeout
1029
if self.disable_initiator_tag is not None:
1030
GLib.source_remove(self.disable_initiator_tag)
1031
self.disable_initiator_tag = None
1032
if getattr(self, "enabled", False):
1033
self.disable_initiator_tag = GLib.timeout_add(
1034
int(timeout.total_seconds() * 1000), self.disable)
1035
self.expires = datetime.datetime.utcnow() + timeout
1037
def need_approval(self):
1038
self.last_approval_request = datetime.datetime.utcnow()
307
logger.info(u"Checker for %(name)s failed",
1040
309
def start_checker(self):
1041
310
"""Start a new checker subprocess if one is not running.
1043
311
If a checker already exists, leave it running and do
1045
313
# The reason for not killing a running checker is that if we
1046
# did that, and if a checker (for some reason) started running
1047
# slowly and taking more than 'interval' time, then the client
1048
# would inevitably timeout, since no checker would get a
1049
# chance to run to completion. If we instead leave running
314
# did that, then if a checker (for some reason) started
315
# running slowly and taking more than 'interval' time, the
316
# client would inevitably timeout, since no checker would get
317
# a chance to run to completion. If we instead leave running
1050
318
# checkers alone, the checker would have to take more time
1051
# than 'timeout' for the client to be disabled, which is as it
1054
if self.checker is not None and not self.checker.is_alive():
1055
logger.warning("Checker was not alive; joining")
1058
# Start a new checker if needed
319
# than 'timeout' for the client to be declared invalid, which
320
# is as it should be.
1059
321
if self.checker is None:
1060
# Escape attributes for the shell
1062
attr: re.escape(str(getattr(self, attr)))
1063
for attr in self.runtime_expansions}
1065
command = self.checker_command % escaped_attrs
1066
except TypeError as error:
1067
logger.error('Could not format string "%s"',
1068
self.checker_command,
1070
return True # Try again later
1071
self.current_checker_command = command
1072
logger.info("Starting checker %r for %s", command,
1074
# We don't need to redirect stdout and stderr, since
1075
# in normal mode, that is already done by daemon(),
1076
# and in debug mode we don't want to. (Stdin is
1077
# always replaced by /dev/null.)
1078
# The exception is when not debugging but nevertheless
1079
# running in the foreground; use the previously
1081
popen_args = {"close_fds": True,
1084
if (not self.server_settings["debug"]
1085
and self.server_settings["foreground"]):
1086
popen_args.update({"stdout": wnull,
1088
pipe = multiprocessing.Pipe(duplex=False)
1089
self.checker = multiprocessing.Process(
1091
args=(pipe[1], subprocess.call, command),
1093
self.checker.start()
1094
self.checker_callback_tag = GLib.io_add_watch(
1095
pipe[0].fileno(), GLib.IO_IN,
1096
self.checker_callback, pipe[0], command)
1097
# Re-run this periodically if run by GLib.timeout_add
323
# In case check_command has exactly one % operator
324
command = self.check_command % self.host
326
# Escape attributes for the shell
327
escaped_attrs = dict((key, re.escape(str(val)))
329
vars(self).iteritems())
331
command = self.check_command % escaped_attrs
332
except TypeError, error:
333
logger.error(u'Could not format string "%s":'
334
u' %s', self.check_command, error)
335
return True # Try again later
337
logger.info(u"Starting checker %r for %s",
339
self.checker = subprocess.Popen(command,
342
self.checker_callback_tag = gobject.child_watch_add\
344
self.checker_callback)
345
except subprocess.OSError, error:
346
logger.error(u"Failed to start subprocess: %s",
348
# Re-run this periodically if run by gobject.timeout_add
1100
350
def stop_checker(self):
1101
351
"""Force the checker process, if any, to stop."""
1102
352
if self.checker_callback_tag:
1103
GLib.source_remove(self.checker_callback_tag)
353
gobject.source_remove(self.checker_callback_tag)
1104
354
self.checker_callback_tag = None
1105
355
if getattr(self, "checker", None) is None:
1107
logger.debug("Stopping checker for %(name)s", vars(self))
1108
self.checker.terminate()
357
logger.debug(u"Stopping checker for %(name)s", vars(self))
359
os.kill(self.checker.pid, signal.SIGTERM)
361
#if self.checker.poll() is None:
362
# os.kill(self.checker.pid, signal.SIGKILL)
363
except OSError, error:
364
if error.errno != errno.ESRCH: # No such process
1109
366
self.checker = None
1112
def dbus_service_property(dbus_interface,
1116
"""Decorators for marking methods of a DBusObjectWithProperties to
1117
become properties on the D-Bus.
1119
The decorated method will be called with no arguments by "Get"
1120
and with one argument by "Set".
1122
The parameters, where they are supported, are the same as
1123
dbus.service.method, except there is only "signature", since the
1124
type from Get() and the type sent to Set() is the same.
1126
# Encoding deeply encoded byte arrays is not supported yet by the
1127
# "Set" method, so we fail early here:
1128
if byte_arrays and signature != "ay":
1129
raise ValueError("Byte arrays not supported for non-'ay'"
1130
" signature {!r}".format(signature))
1132
def decorator(func):
1133
func._dbus_is_property = True
1134
func._dbus_interface = dbus_interface
1135
func._dbus_signature = signature
1136
func._dbus_access = access
1137
func._dbus_name = func.__name__
1138
if func._dbus_name.endswith("_dbus_property"):
1139
func._dbus_name = func._dbus_name[:-14]
1140
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1146
def dbus_interface_annotations(dbus_interface):
1147
"""Decorator for marking functions returning interface annotations
1151
@dbus_interface_annotations("org.example.Interface")
1152
def _foo(self): # Function name does not matter
1153
return {"org.freedesktop.DBus.Deprecated": "true",
1154
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1158
def decorator(func):
1159
func._dbus_is_interface = True
1160
func._dbus_interface = dbus_interface
1161
func._dbus_name = dbus_interface
1167
def dbus_annotations(annotations):
1168
"""Decorator to annotate D-Bus methods, signals or properties
1171
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1172
"org.freedesktop.DBus.Property."
1173
"EmitsChangedSignal": "false"})
1174
@dbus_service_property("org.example.Interface", signature="b",
1176
def Property_dbus_property(self):
1177
return dbus.Boolean(False)
1179
See also the DBusObjectWithAnnotations class.
1182
def decorator(func):
1183
func._dbus_annotations = annotations
1189
class DBusPropertyException(dbus.exceptions.DBusException):
1190
"""A base class for D-Bus property-related exceptions
1195
class DBusPropertyAccessException(DBusPropertyException):
1196
"""A property's access permissions disallows an operation.
1201
class DBusPropertyNotFound(DBusPropertyException):
1202
"""An attempt was made to access a non-existing property.
1207
class DBusObjectWithAnnotations(dbus.service.Object):
1208
"""A D-Bus object with annotations.
1210
Classes inheriting from this can use the dbus_annotations
1211
decorator to add annotations to methods or signals.
1215
def _is_dbus_thing(thing):
1216
"""Returns a function testing if an attribute is a D-Bus thing
1218
If called like _is_dbus_thing("method") it returns a function
1219
suitable for use as predicate to inspect.getmembers().
1221
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1224
def _get_all_dbus_things(self, thing):
1225
"""Returns a generator of (name, attribute) pairs
1227
return ((getattr(athing.__get__(self), "_dbus_name", name),
1228
athing.__get__(self))
1229
for cls in self.__class__.__mro__
1231
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1233
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1235
path_keyword='object_path',
1236
connection_keyword='connection')
1237
def Introspect(self, object_path, connection):
1238
"""Overloading of standard D-Bus method.
1240
Inserts annotation tags on methods and signals.
1242
xmlstring = dbus.service.Object.Introspect(self, object_path,
1245
document = xml.dom.minidom.parseString(xmlstring)
1247
for if_tag in document.getElementsByTagName("interface"):
1248
# Add annotation tags
1249
for typ in ("method", "signal"):
1250
for tag in if_tag.getElementsByTagName(typ):
1252
for name, prop in (self.
1253
_get_all_dbus_things(typ)):
1254
if (name == tag.getAttribute("name")
1255
and prop._dbus_interface
1256
== if_tag.getAttribute("name")):
1257
annots.update(getattr(
1258
prop, "_dbus_annotations", {}))
1259
for name, value in annots.items():
1260
ann_tag = document.createElement(
1262
ann_tag.setAttribute("name", name)
1263
ann_tag.setAttribute("value", value)
1264
tag.appendChild(ann_tag)
1265
# Add interface annotation tags
1266
for annotation, value in dict(
1267
itertools.chain.from_iterable(
1268
annotations().items()
1269
for name, annotations
1270
in self._get_all_dbus_things("interface")
1271
if name == if_tag.getAttribute("name")
1273
ann_tag = document.createElement("annotation")
1274
ann_tag.setAttribute("name", annotation)
1275
ann_tag.setAttribute("value", value)
1276
if_tag.appendChild(ann_tag)
1277
# Fix argument name for the Introspect method itself
1278
if (if_tag.getAttribute("name")
1279
== dbus.INTROSPECTABLE_IFACE):
1280
for cn in if_tag.getElementsByTagName("method"):
1281
if cn.getAttribute("name") == "Introspect":
1282
for arg in cn.getElementsByTagName("arg"):
1283
if (arg.getAttribute("direction")
1285
arg.setAttribute("name",
1287
xmlstring = document.toxml("utf-8")
1289
except (AttributeError, xml.dom.DOMException,
1290
xml.parsers.expat.ExpatError) as error:
1291
logger.error("Failed to override Introspection method",
1296
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1297
"""A D-Bus object with properties.
1299
Classes inheriting from this can use the dbus_service_property
1300
decorator to expose methods as D-Bus properties. It exposes the
1301
standard Get(), Set(), and GetAll() methods on the D-Bus.
1304
def _get_dbus_property(self, interface_name, property_name):
1305
"""Returns a bound method if one exists which is a D-Bus
1306
property with the specified name and interface.
1308
for cls in self.__class__.__mro__:
1309
for name, value in inspect.getmembers(
1310
cls, self._is_dbus_thing("property")):
1311
if (value._dbus_name == property_name
1312
and value._dbus_interface == interface_name):
1313
return value.__get__(self)
1316
raise DBusPropertyNotFound("{}:{}.{}".format(
1317
self.dbus_object_path, interface_name, property_name))
1320
def _get_all_interface_names(cls):
1321
"""Get a sequence of all interfaces supported by an object"""
1322
return (name for name in set(getattr(getattr(x, attr),
1323
"_dbus_interface", None)
1324
for x in (inspect.getmro(cls))
1326
if name is not None)
1328
@dbus.service.method(dbus.PROPERTIES_IFACE,
1331
def Get(self, interface_name, property_name):
1332
"""Standard D-Bus property Get() method, see D-Bus standard.
1334
prop = self._get_dbus_property(interface_name, property_name)
1335
if prop._dbus_access == "write":
1336
raise DBusPropertyAccessException(property_name)
1338
if not hasattr(value, "variant_level"):
1340
return type(value)(value, variant_level=value.variant_level+1)
1342
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1343
def Set(self, interface_name, property_name, value):
1344
"""Standard D-Bus property Set() method, see D-Bus standard.
1346
prop = self._get_dbus_property(interface_name, property_name)
1347
if prop._dbus_access == "read":
1348
raise DBusPropertyAccessException(property_name)
1349
if prop._dbus_get_args_options["byte_arrays"]:
1350
# The byte_arrays option is not supported yet on
1351
# signatures other than "ay".
1352
if prop._dbus_signature != "ay":
1353
raise ValueError("Byte arrays not supported for non-"
1354
"'ay' signature {!r}"
1355
.format(prop._dbus_signature))
1356
value = dbus.ByteArray(b''.join(chr(byte)
1360
@dbus.service.method(dbus.PROPERTIES_IFACE,
1362
out_signature="a{sv}")
1363
def GetAll(self, interface_name):
1364
"""Standard D-Bus property GetAll() method, see D-Bus
1367
Note: Will not include properties with access="write".
1370
for name, prop in self._get_all_dbus_things("property"):
1372
and interface_name != prop._dbus_interface):
1373
# Interface non-empty but did not match
1375
# Ignore write-only properties
1376
if prop._dbus_access == "write":
1379
if not hasattr(value, "variant_level"):
1380
properties[name] = value
1382
properties[name] = type(value)(
1383
value, variant_level=value.variant_level + 1)
1384
return dbus.Dictionary(properties, signature="sv")
1386
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1387
def PropertiesChanged(self, interface_name, changed_properties,
1388
invalidated_properties):
1389
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1394
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1396
path_keyword='object_path',
1397
connection_keyword='connection')
1398
def Introspect(self, object_path, connection):
1399
"""Overloading of standard D-Bus method.
1401
Inserts property tags and interface annotation tags.
1403
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1407
document = xml.dom.minidom.parseString(xmlstring)
1409
def make_tag(document, name, prop):
1410
e = document.createElement("property")
1411
e.setAttribute("name", name)
1412
e.setAttribute("type", prop._dbus_signature)
1413
e.setAttribute("access", prop._dbus_access)
1416
for if_tag in document.getElementsByTagName("interface"):
1418
for tag in (make_tag(document, name, prop)
1420
in self._get_all_dbus_things("property")
1421
if prop._dbus_interface
1422
== if_tag.getAttribute("name")):
1423
if_tag.appendChild(tag)
1424
# Add annotation tags for properties
1425
for tag in if_tag.getElementsByTagName("property"):
1427
for name, prop in self._get_all_dbus_things(
1429
if (name == tag.getAttribute("name")
1430
and prop._dbus_interface
1431
== if_tag.getAttribute("name")):
1432
annots.update(getattr(
1433
prop, "_dbus_annotations", {}))
1434
for name, value in annots.items():
1435
ann_tag = document.createElement(
1437
ann_tag.setAttribute("name", name)
1438
ann_tag.setAttribute("value", value)
1439
tag.appendChild(ann_tag)
1440
# Add the names to the return values for the
1441
# "org.freedesktop.DBus.Properties" methods
1442
if (if_tag.getAttribute("name")
1443
== "org.freedesktop.DBus.Properties"):
1444
for cn in if_tag.getElementsByTagName("method"):
1445
if cn.getAttribute("name") == "Get":
1446
for arg in cn.getElementsByTagName("arg"):
1447
if (arg.getAttribute("direction")
1449
arg.setAttribute("name", "value")
1450
elif cn.getAttribute("name") == "GetAll":
1451
for arg in cn.getElementsByTagName("arg"):
1452
if (arg.getAttribute("direction")
1454
arg.setAttribute("name", "props")
1455
xmlstring = document.toxml("utf-8")
1457
except (AttributeError, xml.dom.DOMException,
1458
xml.parsers.expat.ExpatError) as error:
1459
logger.error("Failed to override Introspection method",
1465
dbus.OBJECT_MANAGER_IFACE
1466
except AttributeError:
1467
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1470
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1471
"""A D-Bus object with an ObjectManager.
1473
Classes inheriting from this exposes the standard
1474
GetManagedObjects call and the InterfacesAdded and
1475
InterfacesRemoved signals on the standard
1476
"org.freedesktop.DBus.ObjectManager" interface.
1478
Note: No signals are sent automatically; they must be sent
1481
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1482
out_signature="a{oa{sa{sv}}}")
1483
def GetManagedObjects(self):
1484
"""This function must be overridden"""
1485
raise NotImplementedError()
1487
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1488
signature="oa{sa{sv}}")
1489
def InterfacesAdded(self, object_path, interfaces_and_properties):
1492
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1493
def InterfacesRemoved(self, object_path, interfaces):
1496
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1498
path_keyword='object_path',
1499
connection_keyword='connection')
1500
def Introspect(self, object_path, connection):
1501
"""Overloading of standard D-Bus method.
1503
Override return argument name of GetManagedObjects to be
1504
"objpath_interfaces_and_properties"
1506
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1510
document = xml.dom.minidom.parseString(xmlstring)
1512
for if_tag in document.getElementsByTagName("interface"):
1513
# Fix argument name for the GetManagedObjects method
1514
if (if_tag.getAttribute("name")
1515
== dbus.OBJECT_MANAGER_IFACE):
1516
for cn in if_tag.getElementsByTagName("method"):
1517
if (cn.getAttribute("name")
1518
== "GetManagedObjects"):
1519
for arg in cn.getElementsByTagName("arg"):
1520
if (arg.getAttribute("direction")
1524
"objpath_interfaces"
1526
xmlstring = document.toxml("utf-8")
1528
except (AttributeError, xml.dom.DOMException,
1529
xml.parsers.expat.ExpatError) as error:
1530
logger.error("Failed to override Introspection method",
1535
def datetime_to_dbus(dt, variant_level=0):
1536
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1538
return dbus.String("", variant_level=variant_level)
1539
return dbus.String(dt.isoformat(), variant_level=variant_level)
1542
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1543
"""A class decorator; applied to a subclass of
1544
dbus.service.Object, it will add alternate D-Bus attributes with
1545
interface names according to the "alt_interface_names" mapping.
1548
@alternate_dbus_interfaces({"org.example.Interface":
1549
"net.example.AlternateInterface"})
1550
class SampleDBusObject(dbus.service.Object):
1551
@dbus.service.method("org.example.Interface")
1552
def SampleDBusMethod():
1555
The above "SampleDBusMethod" on "SampleDBusObject" will be
1556
reachable via two interfaces: "org.example.Interface" and
1557
"net.example.AlternateInterface", the latter of which will have
1558
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1559
"true", unless "deprecate" is passed with a False value.
1561
This works for methods and signals, and also for D-Bus properties
1562
(from DBusObjectWithProperties) and interfaces (from the
1563
dbus_interface_annotations decorator).
1567
for orig_interface_name, alt_interface_name in (
1568
alt_interface_names.items()):
1570
interface_names = set()
1571
# Go though all attributes of the class
1572
for attrname, attribute in inspect.getmembers(cls):
1573
# Ignore non-D-Bus attributes, and D-Bus attributes
1574
# with the wrong interface name
1575
if (not hasattr(attribute, "_dbus_interface")
1576
or not attribute._dbus_interface.startswith(
1577
orig_interface_name)):
1579
# Create an alternate D-Bus interface name based on
1581
alt_interface = attribute._dbus_interface.replace(
1582
orig_interface_name, alt_interface_name)
1583
interface_names.add(alt_interface)
1584
# Is this a D-Bus signal?
1585
if getattr(attribute, "_dbus_is_signal", False):
1586
# Extract the original non-method undecorated
1587
# function by black magic
1588
if sys.version_info.major == 2:
1589
nonmethod_func = (dict(
1590
zip(attribute.func_code.co_freevars,
1591
attribute.__closure__))
1592
["func"].cell_contents)
1594
nonmethod_func = (dict(
1595
zip(attribute.__code__.co_freevars,
1596
attribute.__closure__))
1597
["func"].cell_contents)
1598
# Create a new, but exactly alike, function
1599
# object, and decorate it to be a new D-Bus signal
1600
# with the alternate D-Bus interface name
1601
new_function = copy_function(nonmethod_func)
1602
new_function = (dbus.service.signal(
1604
attribute._dbus_signature)(new_function))
1605
# Copy annotations, if any
1607
new_function._dbus_annotations = dict(
1608
attribute._dbus_annotations)
1609
except AttributeError:
1612
# Define a creator of a function to call both the
1613
# original and alternate functions, so both the
1614
# original and alternate signals gets sent when
1615
# the function is called
1616
def fixscope(func1, func2):
1617
"""This function is a scope container to pass
1618
func1 and func2 to the "call_both" function
1619
outside of its arguments"""
1621
@functools.wraps(func2)
1622
def call_both(*args, **kwargs):
1623
"""This function will emit two D-Bus
1624
signals by calling func1 and func2"""
1625
func1(*args, **kwargs)
1626
func2(*args, **kwargs)
1627
# Make wrapper function look like a D-Bus
1629
for name, attr in inspect.getmembers(func2):
1630
if name.startswith("_dbus_"):
1631
setattr(call_both, name, attr)
1634
# Create the "call_both" function and add it to
1636
attr[attrname] = fixscope(attribute, new_function)
1637
# Is this a D-Bus method?
1638
elif getattr(attribute, "_dbus_is_method", False):
1639
# Create a new, but exactly alike, function
1640
# object. Decorate it to be a new D-Bus method
1641
# with the alternate D-Bus interface name. Add it
1644
dbus.service.method(
1646
attribute._dbus_in_signature,
1647
attribute._dbus_out_signature)
1648
(copy_function(attribute)))
1649
# Copy annotations, if any
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1653
except AttributeError:
1655
# Is this a D-Bus property?
1656
elif getattr(attribute, "_dbus_is_property", False):
1657
# Create a new, but exactly alike, function
1658
# object, and decorate it to be a new D-Bus
1659
# property with the alternate D-Bus interface
1660
# name. Add it to the class.
1661
attr[attrname] = (dbus_service_property(
1662
alt_interface, attribute._dbus_signature,
1663
attribute._dbus_access,
1664
attribute._dbus_get_args_options
1666
(copy_function(attribute)))
1667
# Copy annotations, if any
1669
attr[attrname]._dbus_annotations = dict(
1670
attribute._dbus_annotations)
1671
except AttributeError:
1673
# Is this a D-Bus interface?
1674
elif getattr(attribute, "_dbus_is_interface", False):
1675
# Create a new, but exactly alike, function
1676
# object. Decorate it to be a new D-Bus interface
1677
# with the alternate D-Bus interface name. Add it
1680
dbus_interface_annotations(alt_interface)
1681
(copy_function(attribute)))
1683
# Deprecate all alternate interfaces
1684
iname = "_AlternateDBusNames_interface_annotation{}"
1685
for interface_name in interface_names:
1687
@dbus_interface_annotations(interface_name)
1689
return {"org.freedesktop.DBus.Deprecated":
1691
# Find an unused name
1692
for aname in (iname.format(i)
1693
for i in itertools.count()):
1694
if aname not in attr:
1698
# Replace the class with a new subclass of it with
1699
# methods, signals, etc. as created above.
1700
if sys.version_info.major == 2:
1701
cls = type(b"{}Alternate".format(cls.__name__),
1704
cls = type("{}Alternate".format(cls.__name__),
1711
@alternate_dbus_interfaces({"se.recompile.Mandos":
1712
"se.bsnet.fukt.Mandos"})
1713
class ClientDBus(Client, DBusObjectWithProperties):
1714
"""A Client class using D-Bus
1717
dbus_object_path: dbus.ObjectPath
1718
bus: dbus.SystemBus()
1721
runtime_expansions = (Client.runtime_expansions
1722
+ ("dbus_object_path", ))
1724
_interface = "se.recompile.Mandos.Client"
1726
# dbus.service.Object doesn't use super(), so we can't either.
1728
def __init__(self, bus=None, *args, **kwargs):
1730
Client.__init__(self, *args, **kwargs)
1731
# Only now, when this client is initialized, can it show up on
1733
client_object_name = str(self.name).translate(
1734
{ord("."): ord("_"),
1735
ord("-"): ord("_")})
1736
self.dbus_object_path = dbus.ObjectPath(
1737
"/clients/" + client_object_name)
1738
DBusObjectWithProperties.__init__(self, self.bus,
1739
self.dbus_object_path)
1741
def notifychangeproperty(transform_func, dbus_name,
1742
type_func=lambda x: x,
1744
invalidate_only=False,
1745
_interface=_interface):
1746
""" Modify a variable so that it's a property which announces
1747
its changes to DBus.
1749
transform_fun: Function that takes a value and a variant_level
1750
and transforms it to a D-Bus type.
1751
dbus_name: D-Bus name of the variable
1752
type_func: Function that transform the value before sending it
1753
to the D-Bus. Default: no transform
1754
variant_level: D-Bus variant level. Default: 1
1756
attrname = "_{}".format(dbus_name)
1758
def setter(self, value):
1759
if hasattr(self, "dbus_object_path"):
1760
if (not hasattr(self, attrname) or
1761
type_func(getattr(self, attrname, None))
1762
!= type_func(value)):
1764
self.PropertiesChanged(
1765
_interface, dbus.Dictionary(),
1766
dbus.Array((dbus_name, )))
1768
dbus_value = transform_func(
1770
variant_level=variant_level)
1771
self.PropertyChanged(dbus.String(dbus_name),
1773
self.PropertiesChanged(
1775
dbus.Dictionary({dbus.String(dbus_name):
1778
setattr(self, attrname, value)
1780
return property(lambda self: getattr(self, attrname), setter)
1782
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1783
approvals_pending = notifychangeproperty(dbus.Boolean,
1786
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1787
last_enabled = notifychangeproperty(datetime_to_dbus,
1789
checker = notifychangeproperty(
1790
dbus.Boolean, "CheckerRunning",
1791
type_func=lambda checker: checker is not None)
1792
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1794
last_checker_status = notifychangeproperty(dbus.Int16,
1795
"LastCheckerStatus")
1796
last_approval_request = notifychangeproperty(
1797
datetime_to_dbus, "LastApprovalRequest")
1798
approved_by_default = notifychangeproperty(dbus.Boolean,
1799
"ApprovedByDefault")
1800
approval_delay = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDelay",
1802
type_func=lambda td: td.total_seconds() * 1000)
1803
approval_duration = notifychangeproperty(
1804
dbus.UInt64, "ApprovalDuration",
1805
type_func=lambda td: td.total_seconds() * 1000)
1806
host = notifychangeproperty(dbus.String, "Host")
1807
timeout = notifychangeproperty(
1808
dbus.UInt64, "Timeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
1810
extended_timeout = notifychangeproperty(
1811
dbus.UInt64, "ExtendedTimeout",
1812
type_func=lambda td: td.total_seconds() * 1000)
1813
interval = notifychangeproperty(
1814
dbus.UInt64, "Interval",
1815
type_func=lambda td: td.total_seconds() * 1000)
1816
checker_command = notifychangeproperty(dbus.String, "Checker")
1817
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1818
invalidate_only=True)
1820
del notifychangeproperty
1822
def __del__(self, *args, **kwargs):
1824
self.remove_from_connection()
1827
if hasattr(DBusObjectWithProperties, "__del__"):
1828
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1829
Client.__del__(self, *args, **kwargs)
1831
def checker_callback(self, source, condition,
1832
connection, command, *args, **kwargs):
1833
ret = Client.checker_callback(self, source, condition,
1834
connection, command, *args,
1836
exitstatus = self.last_checker_status
1839
self.CheckerCompleted(dbus.Int16(exitstatus),
1840
# This is specific to GNU libC
1841
dbus.Int64(exitstatus << 8),
1842
dbus.String(command))
1845
self.CheckerCompleted(dbus.Int16(-1),
1847
# This is specific to GNU libC
1849
| self.last_checker_signal),
1850
dbus.String(command))
1853
def start_checker(self, *args, **kwargs):
1854
old_checker_pid = getattr(self.checker, "pid", None)
1855
r = Client.start_checker(self, *args, **kwargs)
1856
# Only if new checker process was started
1857
if (self.checker is not None
1858
and old_checker_pid != self.checker.pid):
1860
self.CheckerStarted(self.current_checker_command)
1863
def _reset_approved(self):
1864
self.approved = None
1867
def approve(self, value=True):
1868
self.approved = value
1869
GLib.timeout_add(int(self.approval_duration.total_seconds()
1870
* 1000), self._reset_approved)
1871
self.send_changedstate()
1873
# D-Bus methods, signals & properties
1879
# CheckerCompleted - signal
1880
@dbus.service.signal(_interface, signature="nxs")
1881
def CheckerCompleted(self, exitcode, waitstatus, command):
1885
# CheckerStarted - signal
1886
@dbus.service.signal(_interface, signature="s")
1887
def CheckerStarted(self, command):
1891
# PropertyChanged - signal
1892
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1893
@dbus.service.signal(_interface, signature="sv")
1894
def PropertyChanged(self, property, value):
1898
# GotSecret - signal
1899
@dbus.service.signal(_interface)
1900
def GotSecret(self):
1902
Is sent after a successful transfer of secret from the Mandos
1903
server to mandos-client
1908
@dbus.service.signal(_interface, signature="s")
1909
def Rejected(self, reason):
1913
# NeedApproval - signal
1914
@dbus.service.signal(_interface, signature="tb")
1915
def NeedApproval(self, timeout, default):
1917
return self.need_approval()
1922
@dbus.service.method(_interface, in_signature="b")
1923
def Approve(self, value):
1926
# CheckedOK - method
1927
@dbus.service.method(_interface)
1928
def CheckedOK(self):
1932
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1933
@dbus.service.method(_interface)
1938
# StartChecker - method
1939
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1940
@dbus.service.method(_interface)
1941
def StartChecker(self):
1943
self.start_checker()
1946
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1947
@dbus.service.method(_interface)
1952
# StopChecker - method
1953
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1954
@dbus.service.method(_interface)
1955
def StopChecker(self):
1960
# ApprovalPending - property
1961
@dbus_service_property(_interface, signature="b", access="read")
1962
def ApprovalPending_dbus_property(self):
1963
return dbus.Boolean(bool(self.approvals_pending))
1965
# ApprovedByDefault - property
1966
@dbus_service_property(_interface,
1969
def ApprovedByDefault_dbus_property(self, value=None):
1970
if value is None: # get
1971
return dbus.Boolean(self.approved_by_default)
1972
self.approved_by_default = bool(value)
1974
# ApprovalDelay - property
1975
@dbus_service_property(_interface,
1978
def ApprovalDelay_dbus_property(self, value=None):
1979
if value is None: # get
1980
return dbus.UInt64(self.approval_delay.total_seconds()
1982
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1984
# ApprovalDuration - property
1985
@dbus_service_property(_interface,
1988
def ApprovalDuration_dbus_property(self, value=None):
1989
if value is None: # get
1990
return dbus.UInt64(self.approval_duration.total_seconds()
1992
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1996
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1997
@dbus_service_property(_interface, signature="s", access="read")
1998
def Name_dbus_property(self):
1999
return dbus.String(self.name)
2001
# Fingerprint - property
2003
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2004
@dbus_service_property(_interface, signature="s", access="read")
2005
def Fingerprint_dbus_property(self):
2006
return dbus.String(self.fingerprint)
2009
@dbus_service_property(_interface,
2012
def Host_dbus_property(self, value=None):
2013
if value is None: # get
2014
return dbus.String(self.host)
2015
self.host = str(value)
2017
# Created - property
2019
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2020
@dbus_service_property(_interface, signature="s", access="read")
2021
def Created_dbus_property(self):
2022
return datetime_to_dbus(self.created)
2024
# LastEnabled - property
2025
@dbus_service_property(_interface, signature="s", access="read")
2026
def LastEnabled_dbus_property(self):
2027
return datetime_to_dbus(self.last_enabled)
2029
# Enabled - property
2030
@dbus_service_property(_interface,
2033
def Enabled_dbus_property(self, value=None):
2034
if value is None: # get
2035
return dbus.Boolean(self.enabled)
2041
# LastCheckedOK - property
2042
@dbus_service_property(_interface,
2045
def LastCheckedOK_dbus_property(self, value=None):
2046
if value is not None:
2049
return datetime_to_dbus(self.last_checked_ok)
2051
# LastCheckerStatus - property
2052
@dbus_service_property(_interface, signature="n", access="read")
2053
def LastCheckerStatus_dbus_property(self):
2054
return dbus.Int16(self.last_checker_status)
2056
# Expires - property
2057
@dbus_service_property(_interface, signature="s", access="read")
2058
def Expires_dbus_property(self):
2059
return datetime_to_dbus(self.expires)
2061
# LastApprovalRequest - property
2062
@dbus_service_property(_interface, signature="s", access="read")
2063
def LastApprovalRequest_dbus_property(self):
2064
return datetime_to_dbus(self.last_approval_request)
2066
# Timeout - property
2067
@dbus_service_property(_interface,
2070
def Timeout_dbus_property(self, value=None):
2071
if value is None: # get
2072
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2073
old_timeout = self.timeout
2074
self.timeout = datetime.timedelta(0, 0, 0, value)
2075
# Reschedule disabling
2077
now = datetime.datetime.utcnow()
2078
self.expires += self.timeout - old_timeout
2079
if self.expires <= now:
2080
# The timeout has passed
2083
if (getattr(self, "disable_initiator_tag", None)
2086
GLib.source_remove(self.disable_initiator_tag)
2087
self.disable_initiator_tag = GLib.timeout_add(
2088
int((self.expires - now).total_seconds() * 1000),
2091
# ExtendedTimeout - property
2092
@dbus_service_property(_interface,
2095
def ExtendedTimeout_dbus_property(self, value=None):
2096
if value is None: # get
2097
return dbus.UInt64(self.extended_timeout.total_seconds()
2099
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2101
# Interval - property
2102
@dbus_service_property(_interface,
2105
def Interval_dbus_property(self, value=None):
2106
if value is None: # get
2107
return dbus.UInt64(self.interval.total_seconds() * 1000)
2108
self.interval = datetime.timedelta(0, 0, 0, value)
2109
if getattr(self, "checker_initiator_tag", None) is None:
2112
# Reschedule checker run
2113
GLib.source_remove(self.checker_initiator_tag)
2114
self.checker_initiator_tag = GLib.timeout_add(
2115
value, self.start_checker)
2116
self.start_checker() # Start one now, too
2118
# Checker - property
2119
@dbus_service_property(_interface,
2122
def Checker_dbus_property(self, value=None):
2123
if value is None: # get
2124
return dbus.String(self.checker_command)
2125
self.checker_command = str(value)
2127
# CheckerRunning - property
2128
@dbus_service_property(_interface,
2131
def CheckerRunning_dbus_property(self, value=None):
2132
if value is None: # get
2133
return dbus.Boolean(self.checker is not None)
2135
self.start_checker()
2139
# ObjectPath - property
2141
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2142
"org.freedesktop.DBus.Deprecated": "true"})
2143
@dbus_service_property(_interface, signature="o", access="read")
2144
def ObjectPath_dbus_property(self):
2145
return self.dbus_object_path # is already a dbus.ObjectPath
2149
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2151
@dbus_service_property(_interface,
2155
def Secret_dbus_property(self, value):
2156
self.secret = bytes(value)
2161
class ProxyClient(object):
2162
def __init__(self, child_pipe, fpr, address):
2163
self._pipe = child_pipe
2164
self._pipe.send(('init', fpr, address))
2165
if not self._pipe.recv():
2168
def __getattribute__(self, name):
2170
return super(ProxyClient, self).__getattribute__(name)
2171
self._pipe.send(('getattr', name))
2172
data = self._pipe.recv()
2173
if data[0] == 'data':
2175
if data[0] == 'function':
2177
def func(*args, **kwargs):
2178
self._pipe.send(('funcall', name, args, kwargs))
2179
return self._pipe.recv()[1]
2183
def __setattr__(self, name, value):
2185
return super(ProxyClient, self).__setattr__(name, value)
2186
self._pipe.send(('setattr', name, value))
2189
class ClientHandler(socketserver.BaseRequestHandler, object):
2190
"""A class to handle client connections.
2192
Instantiated once for each connection to handle it.
367
def still_valid(self):
368
"""Has the timeout not yet passed for this client?"""
369
now = datetime.datetime.now()
370
if self.last_checked_ok is None:
371
return now < (self.created + self.timeout)
373
return now < (self.last_checked_ok + self.timeout)
376
def peer_certificate(session):
377
"Return the peer's OpenPGP certificate as a bytestring"
378
# If not an OpenPGP certificate...
379
if gnutls.library.functions.gnutls_certificate_type_get\
380
(session._c_object) \
381
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
382
# ...do the normal thing
383
return session.peer_certificate
384
list_size = ctypes.c_uint()
385
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
386
(session._c_object, ctypes.byref(list_size))
387
if list_size.value == 0:
390
return ctypes.string_at(cert.data, cert.size)
393
def fingerprint(openpgp):
394
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
395
# New GnuTLS "datum" with the OpenPGP public key
396
datum = gnutls.library.types.gnutls_datum_t\
397
(ctypes.cast(ctypes.c_char_p(openpgp),
398
ctypes.POINTER(ctypes.c_ubyte)),
399
ctypes.c_uint(len(openpgp)))
400
# New empty GnuTLS certificate
401
crt = gnutls.library.types.gnutls_openpgp_crt_t()
402
gnutls.library.functions.gnutls_openpgp_crt_init\
404
# Import the OpenPGP public key into the certificate
405
gnutls.library.functions.gnutls_openpgp_crt_import\
406
(crt, ctypes.byref(datum),
407
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
408
# New buffer for the fingerprint
409
buffer = ctypes.create_string_buffer(20)
410
buffer_length = ctypes.c_size_t()
411
# Get the fingerprint from the certificate into the buffer
412
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
413
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
414
# Deinit the certificate
415
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
416
# Convert the buffer to a Python bytestring
417
fpr = ctypes.string_at(buffer, buffer_length.value)
418
# Convert the bytestring to hexadecimal notation
419
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
423
class tcp_handler(SocketServer.BaseRequestHandler, object):
424
"""A TCP request handler class.
425
Instantiated by IPv6_TCPServer for each request to handle it.
2193
426
Note: This will run in its own forked process."""
2195
428
def handle(self):
2196
with contextlib.closing(self.server.child_pipe) as child_pipe:
2197
logger.info("TCP connection from: %s",
2198
str(self.client_address))
2199
logger.debug("Pipe FD: %d",
2200
self.server.child_pipe.fileno())
2202
session = gnutls.ClientSession(self.request)
2204
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2205
# "+AES-256-CBC", "+SHA1",
2206
# "+COMP-NULL", "+CTYPE-OPENPGP",
2208
# Use a fallback default, since this MUST be set.
2209
priority = self.server.gnutls_priority
2210
if priority is None:
2212
gnutls.priority_set_direct(session._c_object,
2213
priority.encode("utf-8"),
2216
# Start communication using the Mandos protocol
2217
# Get protocol number
2218
line = self.request.makefile().readline()
2219
logger.debug("Protocol version: %r", line)
2221
if int(line.strip().split()[0]) > 1:
2222
raise RuntimeError(line)
2223
except (ValueError, IndexError, RuntimeError) as error:
2224
logger.error("Unknown protocol version: %s", error)
2227
# Start GnuTLS connection
2230
except gnutls.Error as error:
2231
logger.warning("Handshake failed: %s", error)
2232
# Do not run session.bye() here: the session is not
2233
# established. Just abandon the request.
2235
logger.debug("Handshake succeeded")
2237
approval_required = False
2240
fpr = self.fingerprint(
2241
self.peer_certificate(session))
2242
except (TypeError, gnutls.Error) as error:
2243
logger.warning("Bad certificate: %s", error)
2245
logger.debug("Fingerprint: %s", fpr)
2248
client = ProxyClient(child_pipe, fpr,
2249
self.client_address)
2253
if client.approval_delay:
2254
delay = client.approval_delay
2255
client.approvals_pending += 1
2256
approval_required = True
2259
if not client.enabled:
2260
logger.info("Client %s is disabled",
2262
if self.server.use_dbus:
2264
client.Rejected("Disabled")
2267
if client.approved or not client.approval_delay:
2268
# We are approved or approval is disabled
2270
elif client.approved is None:
2271
logger.info("Client %s needs approval",
2273
if self.server.use_dbus:
2275
client.NeedApproval(
2276
client.approval_delay.total_seconds()
2277
* 1000, client.approved_by_default)
2279
logger.warning("Client %s was not approved",
2281
if self.server.use_dbus:
2283
client.Rejected("Denied")
2286
# wait until timeout or approved
2287
time = datetime.datetime.now()
2288
client.changedstate.acquire()
2289
client.changedstate.wait(delay.total_seconds())
2290
client.changedstate.release()
2291
time2 = datetime.datetime.now()
2292
if (time2 - time) >= delay:
2293
if not client.approved_by_default:
2294
logger.warning("Client %s timed out while"
2295
" waiting for approval",
2297
if self.server.use_dbus:
2299
client.Rejected("Approval timed out")
2304
delay -= time2 - time
2307
session.send(client.secret)
2308
except gnutls.Error as error:
2309
logger.warning("gnutls send failed",
2313
logger.info("Sending secret to %s", client.name)
2314
# bump the timeout using extended_timeout
2315
client.bump_timeout(client.extended_timeout)
2316
if self.server.use_dbus:
2321
if approval_required:
2322
client.approvals_pending -= 1
2325
except gnutls.Error as error:
2326
logger.warning("GnuTLS bye failed",
2330
def peer_certificate(session):
2331
"Return the peer's OpenPGP certificate as a bytestring"
2332
# If not an OpenPGP certificate...
2333
if (gnutls.certificate_type_get(session._c_object)
2334
!= gnutls.CRT_OPENPGP):
2335
# ...return invalid data
2337
list_size = ctypes.c_uint(1)
2338
cert_list = (gnutls.certificate_get_peers
2339
(session._c_object, ctypes.byref(list_size)))
2340
if not bool(cert_list) and list_size.value != 0:
2341
raise gnutls.Error("error getting peer certificate")
2342
if list_size.value == 0:
2345
return ctypes.string_at(cert.data, cert.size)
2348
def fingerprint(openpgp):
2349
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2350
# New GnuTLS "datum" with the OpenPGP public key
2351
datum = gnutls.datum_t(
2352
ctypes.cast(ctypes.c_char_p(openpgp),
2353
ctypes.POINTER(ctypes.c_ubyte)),
2354
ctypes.c_uint(len(openpgp)))
2355
# New empty GnuTLS certificate
2356
crt = gnutls.openpgp_crt_t()
2357
gnutls.openpgp_crt_init(ctypes.byref(crt))
2358
# Import the OpenPGP public key into the certificate
2359
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2360
gnutls.OPENPGP_FMT_RAW)
2361
# Verify the self signature in the key
2362
crtverify = ctypes.c_uint()
2363
gnutls.openpgp_crt_verify_self(crt, 0,
2364
ctypes.byref(crtverify))
2365
if crtverify.value != 0:
2366
gnutls.openpgp_crt_deinit(crt)
2367
raise gnutls.CertificateSecurityError("Verify failed")
2368
# New buffer for the fingerprint
2369
buf = ctypes.create_string_buffer(20)
2370
buf_len = ctypes.c_size_t()
2371
# Get the fingerprint from the certificate into the buffer
2372
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2373
ctypes.byref(buf_len))
2374
# Deinit the certificate
2375
gnutls.openpgp_crt_deinit(crt)
2376
# Convert the buffer to a Python bytestring
2377
fpr = ctypes.string_at(buf, buf_len.value)
2378
# Convert the bytestring to hexadecimal notation
2379
hex_fpr = binascii.hexlify(fpr).upper()
2383
class MultiprocessingMixIn(object):
2384
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2386
def sub_process_main(self, request, address):
2388
self.finish_request(request, address)
2390
self.handle_error(request, address)
2391
self.close_request(request)
2393
def process_request(self, request, address):
2394
"""Start a new process to process the request."""
2395
proc = multiprocessing.Process(target=self.sub_process_main,
2396
args=(request, address))
2401
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2402
""" adds a pipe to the MixIn """
2404
def process_request(self, request, client_address):
2405
"""Overrides and wraps the original process_request().
2407
This function creates a new pipe in self.pipe
2409
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2411
proc = MultiprocessingMixIn.process_request(self, request,
2413
self.child_pipe.close()
2414
self.add_pipe(parent_pipe, proc)
2416
def add_pipe(self, parent_pipe, proc):
2417
"""Dummy function; override as necessary"""
2418
raise NotImplementedError()
2421
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2422
socketserver.TCPServer, object):
2423
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
429
logger.info(u"TCP connection from: %s",
430
unicode(self.client_address))
431
session = gnutls.connection.ClientSession\
432
(self.request, gnutls.connection.X509Credentials())
434
line = self.request.makefile().readline()
435
logger.debug(u"Protocol version: %r", line)
437
if int(line.strip().split()[0]) > 1:
439
except (ValueError, IndexError, RuntimeError), error:
440
logger.error(u"Unknown protocol version: %s", error)
443
# Note: gnutls.connection.X509Credentials is really a generic
444
# GnuTLS certificate credentials object so long as no X.509
445
# keys are added to it. Therefore, we can use it here despite
446
# using OpenPGP certificates.
448
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
449
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
451
priority = "NORMAL" # Fallback default, since this
453
if self.server.settings["priority"]:
454
priority = self.server.settings["priority"]
455
gnutls.library.functions.gnutls_priority_set_direct\
456
(session._c_object, priority, None);
460
except gnutls.errors.GNUTLSError, error:
461
logger.warning(u"Handshake failed: %s", error)
462
# Do not run session.bye() here: the session is not
463
# established. Just abandon the request.
466
fpr = fingerprint(peer_certificate(session))
467
except (TypeError, gnutls.errors.GNUTLSError), error:
468
logger.warning(u"Bad certificate: %s", error)
471
logger.debug(u"Fingerprint: %s", fpr)
473
for c in self.server.clients:
474
if c.fingerprint == fpr:
478
logger.warning(u"Client not found for fingerprint: %s",
482
# Have to check if client.still_valid(), since it is possible
483
# that the client timed out while establishing the GnuTLS
485
if not client.still_valid():
486
logger.warning(u"Client %(name)s is invalid",
491
while sent_size < len(client.secret):
492
sent = session.send(client.secret[sent_size:])
493
logger.debug(u"Sent: %d, remaining: %d",
494
sent, len(client.secret)
495
- (sent_size + sent))
500
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
501
"""IPv6 TCP server. Accepts 'None' as address and/or port.
2426
enabled: Boolean; whether this server is activated yet
2427
interface: None or a network interface name (string)
2428
use_ipv6: Boolean; to use IPv6 or not
503
settings: Server settings
504
clients: Set() of Client objects
2431
def __init__(self, server_address, RequestHandlerClass,
2435
"""If socketfd is set, use that file descriptor instead of
2436
creating a new one with socket.socket().
2438
self.interface = interface
2440
self.address_family = socket.AF_INET6
2441
if socketfd is not None:
2442
# Save the file descriptor
2443
self.socketfd = socketfd
2444
# Save the original socket.socket() function
2445
self.socket_socket = socket.socket
2447
# To implement --socket, we monkey patch socket.socket.
2449
# (When socketserver.TCPServer is a new-style class, we
2450
# could make self.socket into a property instead of monkey
2451
# patching socket.socket.)
2453
# Create a one-time-only replacement for socket.socket()
2454
@functools.wraps(socket.socket)
2455
def socket_wrapper(*args, **kwargs):
2456
# Restore original function so subsequent calls are
2458
socket.socket = self.socket_socket
2459
del self.socket_socket
2460
# This time only, return a new socket object from the
2461
# saved file descriptor.
2462
return socket.fromfd(self.socketfd, *args, **kwargs)
2463
# Replace socket.socket() function with wrapper
2464
socket.socket = socket_wrapper
2465
# The socketserver.TCPServer.__init__ will call
2466
# socket.socket(), which might be our replacement,
2467
# socket_wrapper(), if socketfd was set.
2468
socketserver.TCPServer.__init__(self, server_address,
2469
RequestHandlerClass)
506
address_family = socket.AF_INET6
507
def __init__(self, *args, **kwargs):
508
if "settings" in kwargs:
509
self.settings = kwargs["settings"]
510
del kwargs["settings"]
511
if "clients" in kwargs:
512
self.clients = kwargs["clients"]
513
del kwargs["clients"]
514
return super(type(self), self).__init__(*args, **kwargs)
2471
515
def server_bind(self):
2472
516
"""This overrides the normal server_bind() function
2473
517
to bind to an interface if one was specified, and also NOT to
2474
518
bind to an address or port if they were not specified."""
2475
global SO_BINDTODEVICE
2476
if self.interface is not None:
2477
if SO_BINDTODEVICE is None:
2478
# Fall back to a hard-coded value which seems to be
2480
logger.warning("SO_BINDTODEVICE not found, trying 25")
2481
SO_BINDTODEVICE = 25
519
if self.settings["interface"]:
520
# 25 is from /usr/include/asm-i486/socket.h
521
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
2483
self.socket.setsockopt(
2484
socket.SOL_SOCKET, SO_BINDTODEVICE,
2485
(self.interface + "\0").encode("utf-8"))
2486
except socket.error as error:
2487
if error.errno == errno.EPERM:
2488
logger.error("No permission to bind to"
2489
" interface %s", self.interface)
2490
elif error.errno == errno.ENOPROTOOPT:
2491
logger.error("SO_BINDTODEVICE not available;"
2492
" cannot bind to interface %s",
2494
elif error.errno == errno.ENODEV:
2495
logger.error("Interface %s does not exist,"
2496
" cannot bind", self.interface)
523
self.socket.setsockopt(socket.SOL_SOCKET,
525
self.settings["interface"])
526
except socket.error, error:
527
if error[0] == errno.EPERM:
528
logger.error(u"No permission to"
529
u" bind to interface %s",
530
self.settings["interface"])
2499
533
# Only bind(2) the socket if we really need to.
2500
534
if self.server_address[0] or self.server_address[1]:
2501
535
if not self.server_address[0]:
2502
if self.address_family == socket.AF_INET6:
2503
any_address = "::" # in6addr_any
2505
any_address = "0.0.0.0" # INADDR_ANY
2506
self.server_address = (any_address,
537
self.server_address = (in6addr_any,
2507
538
self.server_address[1])
2508
539
elif not self.server_address[1]:
2509
self.server_address = (self.server_address[0], 0)
2510
# if self.interface:
540
self.server_address = (self.server_address[0],
542
# if self.settings["interface"]:
2511
543
# self.server_address = (self.server_address[0],
2514
546
# if_nametoindex
2516
return socketserver.TCPServer.server_bind(self)
2519
class MandosServer(IPv6_TCPServer):
2523
clients: set of Client objects
2524
gnutls_priority GnuTLS priority string
2525
use_dbus: Boolean; to emit D-Bus signals or not
2527
Assumes a GLib.MainLoop event loop.
2530
def __init__(self, server_address, RequestHandlerClass,
2534
gnutls_priority=None,
2537
self.enabled = False
2538
self.clients = clients
2539
if self.clients is None:
2541
self.use_dbus = use_dbus
2542
self.gnutls_priority = gnutls_priority
2543
IPv6_TCPServer.__init__(self, server_address,
2544
RequestHandlerClass,
2545
interface=interface,
2549
def server_activate(self):
2551
return socketserver.TCPServer.server_activate(self)
2556
def add_pipe(self, parent_pipe, proc):
2557
# Call "handle_ipc" for both data and EOF events
2559
parent_pipe.fileno(),
2560
GLib.IO_IN | GLib.IO_HUP,
2561
functools.partial(self.handle_ipc,
2562
parent_pipe=parent_pipe,
2565
def handle_ipc(self, source, condition,
2568
client_object=None):
2569
# error, or the other end of multiprocessing.Pipe has closed
2570
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2571
# Wait for other process to exit
2575
# Read a request from the child
2576
request = parent_pipe.recv()
2577
command = request[0]
2579
if command == 'init':
2581
address = request[2]
2583
for c in self.clients.values():
2584
if c.fingerprint == fpr:
2588
logger.info("Client not found for fingerprint: %s, ad"
2589
"dress: %s", fpr, address)
2592
mandos_dbus_service.ClientNotFound(fpr,
2594
parent_pipe.send(False)
2598
parent_pipe.fileno(),
2599
GLib.IO_IN | GLib.IO_HUP,
2600
functools.partial(self.handle_ipc,
2601
parent_pipe=parent_pipe,
2603
client_object=client))
2604
parent_pipe.send(True)
2605
# remove the old hook in favor of the new above hook on
2608
if command == 'funcall':
2609
funcname = request[1]
2613
parent_pipe.send(('data', getattr(client_object,
2617
if command == 'getattr':
2618
attrname = request[1]
2619
if isinstance(client_object.__getattribute__(attrname),
2620
collections.Callable):
2621
parent_pipe.send(('function', ))
2624
'data', client_object.__getattribute__(attrname)))
2626
if command == 'setattr':
2627
attrname = request[1]
2629
setattr(client_object, attrname, value)
2634
def rfc3339_duration_to_delta(duration):
2635
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2637
>>> rfc3339_duration_to_delta("P7D")
2638
datetime.timedelta(7)
2639
>>> rfc3339_duration_to_delta("PT60S")
2640
datetime.timedelta(0, 60)
2641
>>> rfc3339_duration_to_delta("PT60M")
2642
datetime.timedelta(0, 3600)
2643
>>> rfc3339_duration_to_delta("PT24H")
2644
datetime.timedelta(1)
2645
>>> rfc3339_duration_to_delta("P1W")
2646
datetime.timedelta(7)
2647
>>> rfc3339_duration_to_delta("PT5M30S")
2648
datetime.timedelta(0, 330)
2649
>>> rfc3339_duration_to_delta("P1DT3M20S")
2650
datetime.timedelta(1, 200)
2653
# Parsing an RFC 3339 duration with regular expressions is not
2654
# possible - there would have to be multiple places for the same
2655
# values, like seconds. The current code, while more esoteric, is
2656
# cleaner without depending on a parsing library. If Python had a
2657
# built-in library for parsing we would use it, but we'd like to
2658
# avoid excessive use of external libraries.
2660
# New type for defining tokens, syntax, and semantics all-in-one
2661
Token = collections.namedtuple("Token", (
2662
"regexp", # To match token; if "value" is not None, must have
2663
# a "group" containing digits
2664
"value", # datetime.timedelta or None
2665
"followers")) # Tokens valid after this token
2666
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2667
# the "duration" ABNF definition in RFC 3339, Appendix A.
2668
token_end = Token(re.compile(r"$"), None, frozenset())
2669
token_second = Token(re.compile(r"(\d+)S"),
2670
datetime.timedelta(seconds=1),
2671
frozenset((token_end, )))
2672
token_minute = Token(re.compile(r"(\d+)M"),
2673
datetime.timedelta(minutes=1),
2674
frozenset((token_second, token_end)))
2675
token_hour = Token(re.compile(r"(\d+)H"),
2676
datetime.timedelta(hours=1),
2677
frozenset((token_minute, token_end)))
2678
token_time = Token(re.compile(r"T"),
2680
frozenset((token_hour, token_minute,
2682
token_day = Token(re.compile(r"(\d+)D"),
2683
datetime.timedelta(days=1),
2684
frozenset((token_time, token_end)))
2685
token_month = Token(re.compile(r"(\d+)M"),
2686
datetime.timedelta(weeks=4),
2687
frozenset((token_day, token_end)))
2688
token_year = Token(re.compile(r"(\d+)Y"),
2689
datetime.timedelta(weeks=52),
2690
frozenset((token_month, token_end)))
2691
token_week = Token(re.compile(r"(\d+)W"),
2692
datetime.timedelta(weeks=1),
2693
frozenset((token_end, )))
2694
token_duration = Token(re.compile(r"P"), None,
2695
frozenset((token_year, token_month,
2696
token_day, token_time,
2698
# Define starting values:
2700
value = datetime.timedelta()
2702
# Following valid tokens
2703
followers = frozenset((token_duration, ))
2704
# String left to parse
2706
# Loop until end token is found
2707
while found_token is not token_end:
2708
# Search for any currently valid tokens
2709
for token in followers:
2710
match = token.regexp.match(s)
2711
if match is not None:
2713
if token.value is not None:
2714
# Value found, parse digits
2715
factor = int(match.group(1), 10)
2716
# Add to value so far
2717
value += factor * token.value
2718
# Strip token from string
2719
s = token.regexp.sub("", s, 1)
2722
# Set valid next tokens
2723
followers = found_token.followers
2726
# No currently valid tokens were found
2727
raise ValueError("Invalid RFC 3339 duration: {!r}"
549
return super(type(self), self).server_bind()
2733
552
def string_to_delta(interval):
2805
##################################################################
2806
# Parsing of options, both command line and config file
2808
parser = argparse.ArgumentParser()
2809
parser.add_argument("-v", "--version", action="version",
2810
version="%(prog)s {}".format(version),
2811
help="show version number and exit")
2812
parser.add_argument("-i", "--interface", metavar="IF",
2813
help="Bind to interface IF")
2814
parser.add_argument("-a", "--address",
2815
help="Address to listen for requests on")
2816
parser.add_argument("-p", "--port", type=int,
2817
help="Port number to receive requests on")
2818
parser.add_argument("--check", action="store_true",
2819
help="Run self-test")
2820
parser.add_argument("--debug", action="store_true",
2821
help="Debug mode; run in foreground and log"
2822
" to terminal", default=None)
2823
parser.add_argument("--debuglevel", metavar="LEVEL",
2824
help="Debug level for stdout output")
2825
parser.add_argument("--priority", help="GnuTLS"
2826
" priority string (see GnuTLS documentation)")
2827
parser.add_argument("--servicename",
2828
metavar="NAME", help="Zeroconf service name")
2829
parser.add_argument("--configdir",
2830
default="/etc/mandos", metavar="DIR",
2831
help="Directory to search for configuration"
2833
parser.add_argument("--no-dbus", action="store_false",
2834
dest="use_dbus", help="Do not provide D-Bus"
2835
" system bus interface", default=None)
2836
parser.add_argument("--no-ipv6", action="store_false",
2837
dest="use_ipv6", help="Do not use IPv6",
2839
parser.add_argument("--no-restore", action="store_false",
2840
dest="restore", help="Do not restore stored"
2841
" state", default=None)
2842
parser.add_argument("--socket", type=int,
2843
help="Specify a file descriptor to a network"
2844
" socket to use instead of creating one")
2845
parser.add_argument("--statedir", metavar="DIR",
2846
help="Directory to save/restore state in")
2847
parser.add_argument("--foreground", action="store_true",
2848
help="Run in foreground", default=None)
2849
parser.add_argument("--no-zeroconf", action="store_false",
2850
dest="zeroconf", help="Do not use Zeroconf",
2853
options = parser.parse_args()
658
global main_loop_started
659
main_loop_started = False
661
parser = OptionParser(version = "%%prog %s" % version)
662
parser.add_option("-i", "--interface", type="string",
663
metavar="IF", help="Bind to interface IF")
664
parser.add_option("-a", "--address", type="string",
665
help="Address to listen for requests on")
666
parser.add_option("-p", "--port", type="int",
667
help="Port number to receive requests on")
668
parser.add_option("--check", action="store_true", default=False,
669
help="Run self-test")
670
parser.add_option("--debug", action="store_true",
671
help="Debug mode; run in foreground and log to"
673
parser.add_option("--priority", type="string", help="GnuTLS"
674
" priority string (see GnuTLS documentation)")
675
parser.add_option("--servicename", type="string", metavar="NAME",
676
help="Zeroconf service name")
677
parser.add_option("--configdir", type="string",
678
default="/etc/mandos", metavar="DIR",
679
help="Directory to search for configuration"
681
(options, args) = parser.parse_args()
2855
683
if options.check:
2857
fail_count, test_count = doctest.testmod()
2858
sys.exit(os.EX_OK if fail_count == 0 else 1)
2860
688
# Default values for config file for server-global settings
2861
server_defaults = {"interface": "",
2866
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2867
":+SIGN-DSA-SHA256",
2868
"servicename": "Mandos",
2874
"statedir": "/var/lib/mandos",
2875
"foreground": "False",
689
server_defaults = { "interface": "",
694
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
695
"servicename": "Mandos",
2879
698
# Parse config file for server-global settings
2880
server_config = configparser.SafeConfigParser(server_defaults)
699
server_config = ConfigParser.SafeConfigParser(server_defaults)
2881
700
del server_defaults
2882
701
server_config.read(os.path.join(options.configdir, "mandos.conf"))
702
server_section = "server"
2883
703
# Convert the SafeConfigParser object to a dict
2884
server_settings = server_config.defaults()
2885
# Use the appropriate methods on the non-string config options
2886
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2887
"foreground", "zeroconf"):
2888
server_settings[option] = server_config.getboolean("DEFAULT",
2890
if server_settings["port"]:
2891
server_settings["port"] = server_config.getint("DEFAULT",
2893
if server_settings["socket"]:
2894
server_settings["socket"] = server_config.getint("DEFAULT",
2896
# Later, stdin will, and stdout and stderr might, be dup'ed
2897
# over with an opened os.devnull. But we don't want this to
2898
# happen with a supplied network socket.
2899
if 0 <= server_settings["socket"] <= 2:
2900
server_settings["socket"] = os.dup(server_settings
704
server_settings = dict(server_config.items(server_section))
705
# Use getboolean on the boolean config option
706
server_settings["debug"] = server_config.getboolean\
707
(server_section, "debug")
2902
708
del server_config
2904
710
# Override the settings from the config file with command line
2905
711
# options, if set.
2906
712
for option in ("interface", "address", "port", "debug",
2907
"priority", "servicename", "configdir", "use_dbus",
2908
"use_ipv6", "debuglevel", "restore", "statedir",
2909
"socket", "foreground", "zeroconf"):
713
"priority", "servicename", "configdir"):
2910
714
value = getattr(options, option)
2911
715
if value is not None:
2912
716
server_settings[option] = value
2914
# Force all strings to be unicode
2915
for option in server_settings.keys():
2916
if isinstance(server_settings[option], bytes):
2917
server_settings[option] = (server_settings[option]
2919
# Force all boolean options to be boolean
2920
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2921
"foreground", "zeroconf"):
2922
server_settings[option] = bool(server_settings[option])
2923
# Debug implies foreground
2924
if server_settings["debug"]:
2925
server_settings["foreground"] = True
2926
718
# Now we have our good server settings in "server_settings"
2928
##################################################################
2930
if (not server_settings["zeroconf"]
2931
and not (server_settings["port"]
2932
or server_settings["socket"] != "")):
2933
parser.error("Needs port or socket to work without Zeroconf")
2936
720
debug = server_settings["debug"]
2937
debuglevel = server_settings["debuglevel"]
2938
use_dbus = server_settings["use_dbus"]
2939
use_ipv6 = server_settings["use_ipv6"]
2940
stored_state_path = os.path.join(server_settings["statedir"],
2942
foreground = server_settings["foreground"]
2943
zeroconf = server_settings["zeroconf"]
2946
initlogger(debug, logging.DEBUG)
2951
level = getattr(logging, debuglevel.upper())
2952
initlogger(debug, level)
723
syslogger.setLevel(logging.WARNING)
724
console.setLevel(logging.WARNING)
2954
726
if server_settings["servicename"] != "Mandos":
2955
syslogger.setFormatter(
2956
logging.Formatter('Mandos ({}) [%(process)d]:'
2957
' %(levelname)s: %(message)s'.format(
2958
server_settings["servicename"])))
727
syslogger.setFormatter(logging.Formatter\
728
('Mandos (%s): %%(levelname)s:'
730
% server_settings["servicename"]))
2960
732
# Parse config file with clients
2961
client_config = configparser.SafeConfigParser(Client
733
client_defaults = { "timeout": "1h",
735
"checker": "fping -q -- %%(host)s",
737
client_config = ConfigParser.SafeConfigParser(client_defaults)
2963
738
client_config.read(os.path.join(server_settings["configdir"],
2964
739
"clients.conf"))
2966
global mandos_dbus_service
2967
mandos_dbus_service = None
2970
if server_settings["socket"] != "":
2971
socketfd = server_settings["socket"]
2972
tcp_server = MandosServer(
2973
(server_settings["address"], server_settings["port"]),
2975
interface=(server_settings["interface"] or None),
2977
gnutls_priority=server_settings["priority"],
2981
pidfilename = "/run/mandos.pid"
2982
if not os.path.isdir("/run/."):
2983
pidfilename = "/var/run/mandos.pid"
2986
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2987
except IOError as e:
2988
logger.error("Could not open file %r", pidfilename,
2991
for name, group in (("_mandos", "_mandos"),
2992
("mandos", "mandos"),
2993
("nobody", "nogroup")):
2995
uid = pwd.getpwnam(name).pw_uid
2996
gid = pwd.getpwnam(group).pw_gid
3007
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3009
except OSError as error:
3010
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3011
.format(uid, gid, os.strerror(error.errno)))
3012
if error.errno != errno.EPERM:
3016
# Enable all possible GnuTLS debugging
3018
# "Use a log level over 10 to enable all debugging options."
3020
gnutls.global_set_log_level(11)
3023
def debug_gnutls(level, string):
3024
logger.debug("GnuTLS: %s", string[:-1])
3026
gnutls.global_set_log_function(debug_gnutls)
3028
# Redirect stdin so all checkers get /dev/null
3029
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3030
os.dup2(null, sys.stdin.fileno())
3034
# Need to fork before connecting to D-Bus
3036
# Close all input and output, do double fork, etc.
3039
# multiprocessing will use threads, so before we use GLib we need
3040
# to inform GLib that threads will be used.
742
service = AvahiService(name = server_settings["servicename"],
743
type = "_mandos._tcp", );
744
if server_settings["interface"]:
745
service.interface = if_nametoindex(server_settings["interface"])
3043
747
global main_loop
3044
750
# From the Avahi example code
3045
DBusGMainLoop(set_as_default=True)
3046
main_loop = GLib.MainLoop()
751
DBusGMainLoop(set_as_default=True )
752
main_loop = gobject.MainLoop()
3047
753
bus = dbus.SystemBus()
754
server = dbus.Interface(
755
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
756
avahi.DBUS_INTERFACE_SERVER )
3048
757
# End of Avahi example code
3051
bus_name = dbus.service.BusName("se.recompile.Mandos",
3054
old_bus_name = dbus.service.BusName(
3055
"se.bsnet.fukt.Mandos", bus,
3057
except dbus.exceptions.DBusException as e:
3058
logger.error("Disabling D-Bus:", exc_info=e)
3060
server_settings["use_dbus"] = False
3061
tcp_server.use_dbus = False
3063
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3064
service = AvahiServiceToSyslog(
3065
name=server_settings["servicename"],
3066
servicetype="_mandos._tcp",
3069
if server_settings["interface"]:
3070
service.interface = if_nametoindex(
3071
server_settings["interface"].encode("utf-8"))
3073
global multiprocessing_manager
3074
multiprocessing_manager = multiprocessing.Manager()
3076
client_class = Client
3078
client_class = functools.partial(ClientDBus, bus=bus)
3080
client_settings = Client.config_parser(client_config)
3081
old_client_settings = {}
3084
# This is used to redirect stdout and stderr for checker processes
3086
wnull = open(os.devnull, "w") # A writable /dev/null
3087
# Only used if server is running in foreground but not in debug
3089
if debug or not foreground:
3092
# Get client data and settings from last running state.
3093
if server_settings["restore"]:
3095
with open(stored_state_path, "rb") as stored_state:
3096
if sys.version_info.major == 2:
3097
clients_data, old_client_settings = pickle.load(
3100
bytes_clients_data, bytes_old_client_settings = (
3101
pickle.load(stored_state, encoding="bytes"))
3102
# Fix bytes to strings
3105
clients_data = {(key.decode("utf-8")
3106
if isinstance(key, bytes)
3109
bytes_clients_data.items()}
3110
del bytes_clients_data
3111
for key in clients_data:
3112
value = {(k.decode("utf-8")
3113
if isinstance(k, bytes) else k): v
3115
clients_data[key].items()}
3116
clients_data[key] = value
3118
value["client_structure"] = [
3120
if isinstance(s, bytes)
3122
value["client_structure"]]
3124
for k in ("name", "host"):
3125
if isinstance(value[k], bytes):
3126
value[k] = value[k].decode("utf-8")
3127
# old_client_settings
3129
old_client_settings = {
3130
(key.decode("utf-8")
3131
if isinstance(key, bytes)
3134
bytes_old_client_settings.items()}
3135
del bytes_old_client_settings
3137
for value in old_client_settings.values():
3138
if isinstance(value["host"], bytes):
3139
value["host"] = (value["host"]
3141
os.remove(stored_state_path)
3142
except IOError as e:
3143
if e.errno == errno.ENOENT:
3144
logger.warning("Could not load persistent state:"
3145
" {}".format(os.strerror(e.errno)))
3147
logger.critical("Could not load persistent state:",
3150
except EOFError as e:
3151
logger.warning("Could not load persistent state: "
3155
with PGPEngine() as pgp:
3156
for client_name, client in clients_data.items():
3157
# Skip removed clients
3158
if client_name not in client_settings:
3161
# Decide which value to use after restoring saved state.
3162
# We have three different values: Old config file,
3163
# new config file, and saved state.
3164
# New config value takes precedence if it differs from old
3165
# config value, otherwise use saved state.
3166
for name, value in client_settings[client_name].items():
3168
# For each value in new config, check if it
3169
# differs from the old config value (Except for
3170
# the "secret" attribute)
3171
if (name != "secret"
3173
old_client_settings[client_name][name])):
3174
client[name] = value
3178
# Clients who has passed its expire date can still be
3179
# enabled if its last checker was successful. A Client
3180
# whose checker succeeded before we stored its state is
3181
# assumed to have successfully run all checkers during
3183
if client["enabled"]:
3184
if datetime.datetime.utcnow() >= client["expires"]:
3185
if not client["last_checked_ok"]:
3187
"disabling client {} - Client never "
3188
"performed a successful checker".format(
3190
client["enabled"] = False
3191
elif client["last_checker_status"] != 0:
3193
"disabling client {} - Client last"
3194
" checker failed with error code"
3197
client["last_checker_status"]))
3198
client["enabled"] = False
3200
client["expires"] = (
3201
datetime.datetime.utcnow()
3202
+ client["timeout"])
3203
logger.debug("Last checker succeeded,"
3204
" keeping {} enabled".format(
3207
client["secret"] = pgp.decrypt(
3208
client["encrypted_secret"],
3209
client_settings[client_name]["secret"])
3211
# If decryption fails, we use secret from new settings
3212
logger.debug("Failed to decrypt {} old secret".format(
3214
client["secret"] = (client_settings[client_name]
3217
# Add/remove clients based on new changes made to config
3218
for client_name in (set(old_client_settings)
3219
- set(client_settings)):
3220
del clients_data[client_name]
3221
for client_name in (set(client_settings)
3222
- set(old_client_settings)):
3223
clients_data[client_name] = client_settings[client_name]
3225
# Create all client objects
3226
for client_name, client in clients_data.items():
3227
tcp_server.clients[client_name] = client_class(
3230
server_settings=server_settings)
3232
if not tcp_server.clients:
3233
logger.warning("No clients defined")
3236
if pidfile is not None:
3240
print(pid, file=pidfile)
3242
logger.error("Could not write to file %r with PID %d",
760
def remove_from_clients(client):
761
clients.remove(client)
763
logger.critical(u"No clients left, exiting")
766
clients.update(Set(Client(name = section,
767
stop_hook = remove_from_clients,
769
= dict(client_config.items(section)))
770
for section in client_config.sections()))
772
logger.critical(u"No clients defined")
776
logger.removeHandler(console)
779
pidfilename = "/var/run/mandos/mandos.pid"
782
pidfile = open(pidfilename, "w")
783
pidfile.write(str(pid) + "\n")
3247
for termsig in (signal.SIGHUP, signal.SIGTERM):
3248
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3249
lambda: main_loop.quit() and False)
3253
@alternate_dbus_interfaces(
3254
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3255
class MandosDBusService(DBusObjectWithObjectManager):
3256
"""A D-Bus proxy object"""
3259
dbus.service.Object.__init__(self, bus, "/")
3261
_interface = "se.recompile.Mandos"
3263
@dbus.service.signal(_interface, signature="o")
3264
def ClientAdded(self, objpath):
3268
@dbus.service.signal(_interface, signature="ss")
3269
def ClientNotFound(self, fingerprint, address):
3273
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3275
@dbus.service.signal(_interface, signature="os")
3276
def ClientRemoved(self, objpath, name):
3280
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3282
@dbus.service.method(_interface, out_signature="ao")
3283
def GetAllClients(self):
3285
return dbus.Array(c.dbus_object_path for c in
3286
tcp_server.clients.values())
3288
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3290
@dbus.service.method(_interface,
3291
out_signature="a{oa{sv}}")
3292
def GetAllClientsWithProperties(self):
3294
return dbus.Dictionary(
3295
{c.dbus_object_path: c.GetAll(
3296
"se.recompile.Mandos.Client")
3297
for c in tcp_server.clients.values()},
3300
@dbus.service.method(_interface, in_signature="o")
3301
def RemoveClient(self, object_path):
3303
for c in tcp_server.clients.values():
3304
if c.dbus_object_path == object_path:
3305
del tcp_server.clients[c.name]
3306
c.remove_from_connection()
3307
# Don't signal the disabling
3308
c.disable(quiet=True)
3309
# Emit D-Bus signal for removal
3310
self.client_removed_signal(c)
3312
raise KeyError(object_path)
3316
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3317
out_signature="a{oa{sa{sv}}}")
3318
def GetManagedObjects(self):
3320
return dbus.Dictionary(
3321
{client.dbus_object_path:
3323
{interface: client.GetAll(interface)
3325
client._get_all_interface_names()})
3326
for client in tcp_server.clients.values()})
3328
def client_added_signal(self, client):
3329
"""Send the new standard signal and the old signal"""
3331
# New standard signal
3332
self.InterfacesAdded(
3333
client.dbus_object_path,
3335
{interface: client.GetAll(interface)
3337
client._get_all_interface_names()}))
3339
self.ClientAdded(client.dbus_object_path)
3341
def client_removed_signal(self, client):
3342
"""Send the new standard signal and the old signal"""
3344
# New standard signal
3345
self.InterfacesRemoved(
3346
client.dbus_object_path,
3347
client._get_all_interface_names())
3349
self.ClientRemoved(client.dbus_object_path,
3352
mandos_dbus_service = MandosDBusService()
3354
# Save modules to variables to exempt the modules from being
3355
# unloaded before the function registered with atexit() is run.
3356
mp = multiprocessing
787
logger.error(u"Could not write %s file with PID %d",
788
pidfilename, os.getpid())
3360
791
"Cleanup function; run on exit"
3364
mp.active_children()
3366
if not (tcp_server.clients or client_settings):
3369
# Store client before exiting. Secrets are encrypted with key
3370
# based on what config file has. If config file is
3371
# removed/edited, old secret will thus be unrecovable.
3373
with PGPEngine() as pgp:
3374
for client in tcp_server.clients.values():
3375
key = client_settings[client.name]["secret"]
3376
client.encrypted_secret = pgp.encrypt(client.secret,
3380
# A list of attributes that can not be pickled
3382
exclude = {"bus", "changedstate", "secret",
3383
"checker", "server_settings"}
3384
for name, typ in inspect.getmembers(dbus.service
3388
client_dict["encrypted_secret"] = (client
3390
for attr in client.client_structure:
3391
if attr not in exclude:
3392
client_dict[attr] = getattr(client, attr)
3394
clients[client.name] = client_dict
3395
del client_settings[client.name]["secret"]
3398
with tempfile.NamedTemporaryFile(
3402
dir=os.path.dirname(stored_state_path),
3403
delete=False) as stored_state:
3404
pickle.dump((clients, client_settings), stored_state,
3406
tempname = stored_state.name
3407
os.rename(tempname, stored_state_path)
3408
except (IOError, OSError) as e:
3414
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3415
logger.warning("Could not save persistent state: {}"
3416
.format(os.strerror(e.errno)))
3418
logger.warning("Could not save persistent state:",
3422
# Delete all clients, and settings from config
3423
while tcp_server.clients:
3424
name, client = tcp_server.clients.popitem()
3426
client.remove_from_connection()
3427
# Don't signal the disabling
3428
client.disable(quiet=True)
3429
# Emit D-Bus signal for removal
3431
mandos_dbus_service.client_removed_signal(client)
3432
client_settings.clear()
793
# From the Avahi example code
794
if not group is None:
797
# End of Avahi example code
800
client = clients.pop()
801
client.stop_hook = None
3434
804
atexit.register(cleanup)
3436
for client in tcp_server.clients.values():
3438
# Emit D-Bus signal for adding
3439
mandos_dbus_service.client_added_signal(client)
3440
# Need to initiate checking of clients
3442
client.init_checker()
3445
tcp_server.server_activate()
807
signal.signal(signal.SIGINT, signal.SIG_IGN)
808
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
809
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
811
for client in clients:
814
tcp_server = IPv6_TCPServer((server_settings["address"],
815
server_settings["port"]),
817
settings=server_settings,
3447
819
# Find out what port we got
3449
service.port = tcp_server.socket.getsockname()[1]
3451
logger.info("Now listening on address %r, port %d,"
3452
" flowinfo %d, scope_id %d",
3453
*tcp_server.socket.getsockname())
3455
logger.info("Now listening on address %r, port %d",
3456
*tcp_server.socket.getsockname())
3458
# service.interface = tcp_server.socket.getsockname()[3]
820
service.port = tcp_server.socket.getsockname()[1]
821
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
822
u" scope_id %d" % tcp_server.socket.getsockname())
824
#service.interface = tcp_server.socket.getsockname()[3]
3462
# From the Avahi example code
3465
except dbus.exceptions.DBusException as error:
3466
logger.critical("D-Bus Exception", exc_info=error)
3469
# End of Avahi example code
3471
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3472
lambda *args, **kwargs:
3473
(tcp_server.handle_request
3474
(*args[2:], **kwargs) or True))
3476
logger.debug("Starting main loop")
827
# From the Avahi example code
828
server.connect_to_signal("StateChanged", server_state_changed)
830
server_state_changed(server.GetState())
831
except dbus.exceptions.DBusException, error:
832
logger.critical(u"DBusException: %s", error)
834
# End of Avahi example code
836
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
837
lambda *args, **kwargs:
838
tcp_server.handle_request\
839
(*args[2:], **kwargs) or True)
841
logger.debug(u"Starting main loop")
842
main_loop_started = True
3478
except AvahiError as error:
3479
logger.critical("Avahi Error", exc_info=error)
844
except AvahiError, error:
845
logger.critical(u"AvahiError: %s" + unicode(error))
3482
847
except KeyboardInterrupt:
3484
print("", file=sys.stderr)
3485
logger.debug("Server received KeyboardInterrupt")
3486
logger.debug("Server exiting")
3487
# Must run before the D-Bus bus name gets deregistered
3491
851
if __name__ == '__main__':