259
107
max_renames: integer; maximum number of renames
260
108
rename_count: integer; counter so we only rename after collisions
261
109
a sensible number of times
262
group: D-Bus Entry Group
264
bus: dbus.SystemBus()
268
interface = avahi.IF_UNSPEC,
276
protocol = avahi.PROTO_UNSPEC,
111
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
112
servicetype = None, port = None, TXT = None, domain = "",
113
host = "", max_renames = 32768):
278
114
self.interface = interface
280
116
self.type = servicetype
282
self.TXT = TXT if TXT is not None else []
283
122
self.domain = domain
285
124
self.rename_count = 0
286
125
self.max_renames = max_renames
287
self.protocol = protocol
288
self.group = None # our entry group
291
self.entry_group_state_changed_match = None
293
def rename(self, remove=True):
294
127
"""Derived from the Avahi example code"""
295
128
if self.rename_count >= self.max_renames:
296
logger.critical("No suitable Zeroconf service name found"
297
" after %i retries, exiting.",
129
logger.critical(u"No suitable Zeroconf service name found"
130
u" after %i retries, exiting.",
298
131
self.rename_count)
299
132
raise AvahiServiceError("Too many renames")
301
self.server.GetAlternativeServiceName(self.name))
133
self.name = server.GetAlternativeServiceName(self.name)
134
logger.info(u"Changing Zeroconf service name to %r ...",
136
syslogger.setFormatter(logging.Formatter\
137
('Mandos (%s): %%(levelname)s:'
138
' %%(message)s' % self.name))
302
141
self.rename_count += 1
303
logger.info("Changing Zeroconf service name to %r ...",
309
except dbus.exceptions.DBusException as error:
310
if (error.get_dbus_name()
311
== "org.freedesktop.Avahi.CollisionError"):
312
logger.info("Local Zeroconf service name collision.")
313
return self.rename(remove=False)
315
logger.critical("D-Bus Exception", exc_info=error)
319
142
def remove(self):
320
143
"""Derived from the Avahi example code"""
321
if self.entry_group_state_changed_match is not None:
322
self.entry_group_state_changed_match.remove()
323
self.entry_group_state_changed_match = None
324
if self.group is not None:
144
if group is not None:
328
147
"""Derived from the Avahi example code"""
330
if self.group is None:
331
self.group = dbus.Interface(
332
self.bus.get_object(avahi.DBUS_NAME,
333
self.server.EntryGroupNew()),
334
avahi.DBUS_INTERFACE_ENTRY_GROUP)
335
self.entry_group_state_changed_match = (
336
self.group.connect_to_signal(
337
'StateChanged', self.entry_group_state_changed))
338
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
339
self.name, self.type)
340
self.group.AddService(
343
dbus.UInt32(0), # flags
344
self.name, self.type,
345
self.domain, self.host,
346
dbus.UInt16(self.port),
347
avahi.string_array_to_txt_array(self.TXT))
350
def entry_group_state_changed(self, state, error):
351
"""Derived from the Avahi example code"""
352
logger.debug("Avahi entry group state change: %i", state)
354
if state == avahi.ENTRY_GROUP_ESTABLISHED:
355
logger.debug("Zeroconf service established.")
356
elif state == avahi.ENTRY_GROUP_COLLISION:
357
logger.info("Zeroconf service name collision.")
359
elif state == avahi.ENTRY_GROUP_FAILURE:
360
logger.critical("Avahi: Error in group state changed %s",
362
raise AvahiGroupError("State changed: {!s}".format(error))
365
"""Derived from the Avahi example code"""
366
if self.group is not None:
369
except (dbus.exceptions.UnknownMethodException,
370
dbus.exceptions.DBusException):
375
def server_state_changed(self, state, error=None):
376
"""Derived from the Avahi example code"""
377
logger.debug("Avahi server state change: %i", state)
379
avahi.SERVER_INVALID: "Zeroconf server invalid",
380
avahi.SERVER_REGISTERING: None,
381
avahi.SERVER_COLLISION: "Zeroconf server name collision",
382
avahi.SERVER_FAILURE: "Zeroconf server failure",
384
if state in bad_states:
385
if bad_states[state] is not None:
387
logger.error(bad_states[state])
389
logger.error(bad_states[state] + ": %r", error)
391
elif state == avahi.SERVER_RUNNING:
394
except dbus.exceptions.DBusException as error:
395
if (error.get_dbus_name()
396
== "org.freedesktop.Avahi.CollisionError"):
397
logger.info("Local Zeroconf service name"
399
return self.rename(remove=False)
401
logger.critical("D-Bus Exception", exc_info=error)
406
logger.debug("Unknown state: %r", state)
408
logger.debug("Unknown state: %r: %r", state, error)
411
"""Derived from the Avahi example code"""
412
if self.server is None:
413
self.server = dbus.Interface(
414
self.bus.get_object(avahi.DBUS_NAME,
415
avahi.DBUS_PATH_SERVER,
416
follow_name_owner_changes=True),
417
avahi.DBUS_INTERFACE_SERVER)
418
self.server.connect_to_signal("StateChanged",
419
self.server_state_changed)
420
self.server_state_changed(self.server.GetState())
423
class AvahiServiceToSyslog(AvahiService):
424
def rename(self, *args, **kwargs):
425
"""Add the new name to the syslog messages"""
426
ret = AvahiService.rename(self, *args, **kwargs)
427
syslogger.setFormatter(logging.Formatter(
428
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
432
# Pretend that we have a GnuTLS module
433
class GnuTLS(object):
434
"""This isn't so much a class as it is a module-like namespace.
435
It is instantiated once, and simulates having a GnuTLS module."""
437
_library = ctypes.cdll.LoadLibrary(
438
ctypes.util.find_library("gnutls"))
439
_need_version = "3.3.0"
441
# Need to use class name "GnuTLS" here, since this method is
442
# called before the assignment to the "gnutls" global variable
444
if GnuTLS.check_version(self._need_version) is None:
445
raise GnuTLS.Error("Needs GnuTLS {} or later"
446
.format(self._need_version))
448
# Unless otherwise indicated, the constants and types below are
449
# all from the gnutls/gnutls.h C header file.
457
E_NO_CERTIFICATE_FOUND = -49
458
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
461
class session_int(ctypes.Structure):
463
session_t = ctypes.POINTER(session_int)
464
class certificate_credentials_st(ctypes.Structure):
466
certificate_credentials_t = ctypes.POINTER(
467
certificate_credentials_st)
468
certificate_type_t = ctypes.c_int
469
class datum_t(ctypes.Structure):
470
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
471
('size', ctypes.c_uint)]
472
class openpgp_crt_int(ctypes.Structure):
474
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
475
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
476
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
477
credentials_type_t = ctypes.c_int #
478
transport_ptr_t = ctypes.c_void_p
479
close_request_t = ctypes.c_int
482
class Error(Exception):
483
# We need to use the class name "GnuTLS" here, since this
484
# exception might be raised from within GnuTLS.__init__,
485
# which is called before the assignment to the "gnutls"
486
# global variable happens.
487
def __init__(self, message = None, code = None, args=()):
488
# Default usage is by a message string, but if a return
489
# code is passed, convert it to a string with
491
if message is None and code is not None:
492
message = GnuTLS.strerror(code)
493
return super(GnuTLS.Error, self).__init__(
496
class CertificateSecurityError(Error):
500
class Credentials(object):
502
self._c_object = gnutls.certificate_credentials_t()
503
gnutls.certificate_allocate_credentials(
504
ctypes.byref(self._c_object))
505
self.type = gnutls.CRD_CERTIFICATE
508
gnutls.certificate_free_credentials(self._c_object)
510
class ClientSession(object):
511
def __init__(self, socket, credentials = None):
512
self._c_object = gnutls.session_t()
513
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
514
gnutls.set_default_priority(self._c_object)
515
gnutls.transport_set_ptr(self._c_object, socket.fileno())
516
gnutls.handshake_set_private_extensions(self._c_object,
519
if credentials is None:
520
credentials = gnutls.Credentials()
521
gnutls.credentials_set(self._c_object, credentials.type,
522
ctypes.cast(credentials._c_object,
524
self.credentials = credentials
527
gnutls.deinit(self._c_object)
530
return gnutls.handshake(self._c_object)
532
def send(self, data):
536
return gnutls.record_send(self._c_object, data, len(data))
539
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
541
# Error handling function
542
def _error_code(result):
543
"""A function to raise exceptions on errors, suitable
544
for the 'restype' attribute on ctypes functions"""
547
if result == gnutls.E_NO_CERTIFICATE_FOUND:
548
raise gnutls.CertificateSecurityError(code = result)
549
raise gnutls.Error(code = result)
551
# Unless otherwise indicated, the function declarations below are
552
# all from the gnutls/gnutls.h C header file.
555
priority_set_direct = _library.gnutls_priority_set_direct
556
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
557
ctypes.POINTER(ctypes.c_char_p)]
558
priority_set_direct.restype = _error_code
560
init = _library.gnutls_init
561
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
562
init.restype = _error_code
564
set_default_priority = _library.gnutls_set_default_priority
565
set_default_priority.argtypes = [session_t]
566
set_default_priority.restype = _error_code
568
record_send = _library.gnutls_record_send
569
record_send.argtypes = [session_t, ctypes.c_void_p,
571
record_send.restype = ctypes.c_ssize_t
573
certificate_allocate_credentials = (
574
_library.gnutls_certificate_allocate_credentials)
575
certificate_allocate_credentials.argtypes = [
576
ctypes.POINTER(certificate_credentials_t)]
577
certificate_allocate_credentials.restype = _error_code
579
certificate_free_credentials = (
580
_library.gnutls_certificate_free_credentials)
581
certificate_free_credentials.argtypes = [certificate_credentials_t]
582
certificate_free_credentials.restype = None
584
handshake_set_private_extensions = (
585
_library.gnutls_handshake_set_private_extensions)
586
handshake_set_private_extensions.argtypes = [session_t,
588
handshake_set_private_extensions.restype = None
590
credentials_set = _library.gnutls_credentials_set
591
credentials_set.argtypes = [session_t, credentials_type_t,
593
credentials_set.restype = _error_code
595
strerror = _library.gnutls_strerror
596
strerror.argtypes = [ctypes.c_int]
597
strerror.restype = ctypes.c_char_p
599
certificate_type_get = _library.gnutls_certificate_type_get
600
certificate_type_get.argtypes = [session_t]
601
certificate_type_get.restype = _error_code
603
certificate_get_peers = _library.gnutls_certificate_get_peers
604
certificate_get_peers.argtypes = [session_t,
605
ctypes.POINTER(ctypes.c_uint)]
606
certificate_get_peers.restype = ctypes.POINTER(datum_t)
608
global_set_log_level = _library.gnutls_global_set_log_level
609
global_set_log_level.argtypes = [ctypes.c_int]
610
global_set_log_level.restype = None
612
global_set_log_function = _library.gnutls_global_set_log_function
613
global_set_log_function.argtypes = [log_func]
614
global_set_log_function.restype = None
616
deinit = _library.gnutls_deinit
617
deinit.argtypes = [session_t]
618
deinit.restype = None
620
handshake = _library.gnutls_handshake
621
handshake.argtypes = [session_t]
622
handshake.restype = _error_code
624
transport_set_ptr = _library.gnutls_transport_set_ptr
625
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
626
transport_set_ptr.restype = None
628
bye = _library.gnutls_bye
629
bye.argtypes = [session_t, close_request_t]
630
bye.restype = _error_code
632
check_version = _library.gnutls_check_version
633
check_version.argtypes = [ctypes.c_char_p]
634
check_version.restype = ctypes.c_char_p
636
# All the function declarations below are from gnutls/openpgp.h
638
openpgp_crt_init = _library.gnutls_openpgp_crt_init
639
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
640
openpgp_crt_init.restype = _error_code
642
openpgp_crt_import = _library.gnutls_openpgp_crt_import
643
openpgp_crt_import.argtypes = [openpgp_crt_t,
644
ctypes.POINTER(datum_t),
646
openpgp_crt_import.restype = _error_code
648
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
649
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
650
ctypes.POINTER(ctypes.c_uint)]
651
openpgp_crt_verify_self.restype = _error_code
653
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
654
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
655
openpgp_crt_deinit.restype = None
657
openpgp_crt_get_fingerprint = (
658
_library.gnutls_openpgp_crt_get_fingerprint)
659
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
663
openpgp_crt_get_fingerprint.restype = _error_code
665
# Remove non-public function
667
# Create the global "gnutls" object, simulating a module
670
def call_pipe(connection, # : multiprocessing.Connection
671
func, *args, **kwargs):
672
"""This function is meant to be called by multiprocessing.Process
674
This function runs func(*args, **kwargs), and writes the resulting
675
return value on the provided multiprocessing.Connection.
677
connection.send(func(*args, **kwargs))
150
group = dbus.Interface\
151
(bus.get_object(avahi.DBUS_NAME,
152
server.EntryGroupNew()),
153
avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
group.connect_to_signal('StateChanged',
155
entry_group_state_changed)
156
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
157
service.name, service.type)
159
self.interface, # interface
160
avahi.PROTO_INET6, # protocol
161
dbus.UInt32(0), # flags
162
self.name, self.type,
163
self.domain, self.host,
164
dbus.UInt16(self.port),
165
avahi.string_array_to_txt_array(self.TXT))
168
# From the Avahi example code:
169
group = None # our entry group
170
# End of Avahi example code
680
173
class Client(object):
681
174
"""A representation of a client host served by this server.
684
approved: bool(); 'None' if not yet approved/disapproved
685
approval_delay: datetime.timedelta(); Time to wait for approval
686
approval_duration: datetime.timedelta(); Duration of one approval
687
checker: subprocess.Popen(); a running checker process used
688
to see if the client lives.
689
'None' if no process is running.
690
checker_callback_tag: a gobject event source tag, or None
691
checker_command: string; External command which is run to check
692
if client lives. %() expansions are done at
176
name: string; from the config file, used in log messages
177
fingerprint: string (40 or 32 hexadecimal digits); used to
178
uniquely identify the client
179
secret: bytestring; sent verbatim (over TLS) to client
180
host: string; available for use by the checker command
181
created: datetime.datetime(); object creation, not client host
182
last_checked_ok: datetime.datetime() or None if not yet checked OK
183
timeout: datetime.timedelta(); How long from last_checked_ok
184
until this client is invalid
185
interval: datetime.timedelta(); How often to start a new checker
186
stop_hook: If set, called by stop() as stop_hook(self)
187
checker: subprocess.Popen(); a running checker process used
188
to see if the client lives.
189
'None' if no process is running.
190
checker_initiator_tag: a gobject event source tag, or None
191
stop_initiator_tag: - '' -
192
checker_callback_tag: - '' -
193
checker_command: string; External command which is run to check if
194
client lives. %() expansions are done at
693
195
runtime with vars(self) as dict, so that for
694
196
instance %(name)s can be used in the command.
695
checker_initiator_tag: a gobject event source tag, or None
696
created: datetime.datetime(); (UTC) object creation
697
client_structure: Object describing what attributes a client has
698
and is used for storing the client at exit
699
current_checker_command: string; current running checker_command
700
disable_initiator_tag: a gobject event source tag, or None
702
fingerprint: string (40 or 32 hexadecimal digits); used to
703
uniquely identify the client
704
host: string; available for use by the checker command
705
interval: datetime.timedelta(); How often to start a new checker
706
last_approval_request: datetime.datetime(); (UTC) or None
707
last_checked_ok: datetime.datetime(); (UTC) or None
708
last_checker_status: integer between 0 and 255 reflecting exit
709
status of last checker. -1 reflects crashed
710
checker, -2 means no checker completed yet.
711
last_checker_signal: The signal which killed the last checker, if
712
last_checker_status is -1
713
last_enabled: datetime.datetime(); (UTC) or None
714
name: string; from the config file, used in log messages and
716
secret: bytestring; sent verbatim (over TLS) to client
717
timeout: datetime.timedelta(); How long from last_checked_ok
718
until this client is disabled
719
extended_timeout: extra long timeout when secret has been sent
720
runtime_expansions: Allowed attributes for runtime expansion.
721
expires: datetime.datetime(); time (UTC) when a client will be
723
server_settings: The server_settings dict from main()
198
_timeout: Real variable for 'timeout'
199
_interval: Real variable for 'interval'
200
_timeout_milliseconds: Used when calling gobject.timeout_add()
201
_interval_milliseconds: - '' -
726
runtime_expansions = ("approval_delay", "approval_duration",
727
"created", "enabled", "expires",
728
"fingerprint", "host", "interval",
729
"last_approval_request", "last_checked_ok",
730
"last_enabled", "name", "timeout")
733
"extended_timeout": "PT15M",
735
"checker": "fping -q -- %%(host)s",
737
"approval_delay": "PT0S",
738
"approval_duration": "PT1S",
739
"approved_by_default": "True",
744
def config_parser(config):
745
"""Construct a new dict of client settings of this form:
746
{ client_name: {setting_name: value, ...}, ...}
747
with exceptions for any special settings as defined above.
748
NOTE: Must be a pure function. Must return the same result
749
value given the same arguments.
752
for client_name in config.sections():
753
section = dict(config.items(client_name))
754
client = settings[client_name] = {}
756
client["host"] = section["host"]
757
# Reformat values from string types to Python types
758
client["approved_by_default"] = config.getboolean(
759
client_name, "approved_by_default")
760
client["enabled"] = config.getboolean(client_name,
763
# Uppercase and remove spaces from fingerprint for later
764
# comparison purposes with return value from the
765
# fingerprint() function
766
client["fingerprint"] = (section["fingerprint"].upper()
768
if "secret" in section:
769
client["secret"] = section["secret"].decode("base64")
770
elif "secfile" in section:
771
with open(os.path.expanduser(os.path.expandvars
772
(section["secfile"])),
774
client["secret"] = secfile.read()
776
raise TypeError("No secret or secfile for section {}"
778
client["timeout"] = string_to_delta(section["timeout"])
779
client["extended_timeout"] = string_to_delta(
780
section["extended_timeout"])
781
client["interval"] = string_to_delta(section["interval"])
782
client["approval_delay"] = string_to_delta(
783
section["approval_delay"])
784
client["approval_duration"] = string_to_delta(
785
section["approval_duration"])
786
client["checker_command"] = section["checker"]
787
client["last_approval_request"] = None
788
client["last_checked_ok"] = None
789
client["last_checker_status"] = -2
793
def __init__(self, settings, name = None, server_settings=None):
203
def _set_timeout(self, timeout):
204
"Setter function for 'timeout' attribute"
205
self._timeout = timeout
206
self._timeout_milliseconds = ((self.timeout.days
207
* 24 * 60 * 60 * 1000)
208
+ (self.timeout.seconds * 1000)
209
+ (self.timeout.microseconds
211
timeout = property(lambda self: self._timeout,
214
def _set_interval(self, interval):
215
"Setter function for 'interval' attribute"
216
self._interval = interval
217
self._interval_milliseconds = ((self.interval.days
218
* 24 * 60 * 60 * 1000)
219
+ (self.interval.seconds
221
+ (self.interval.microseconds
223
interval = property(lambda self: self._interval,
226
def __init__(self, name = None, stop_hook=None, config=None):
227
"""Note: the 'checker' key in 'config' sets the
228
'checker_command' attribute and *not* the 'checker'
795
if server_settings is None:
797
self.server_settings = server_settings
798
# adding all client settings
799
for setting, value in settings.items():
800
setattr(self, setting, value)
803
if not hasattr(self, "last_enabled"):
804
self.last_enabled = datetime.datetime.utcnow()
805
if not hasattr(self, "expires"):
806
self.expires = (datetime.datetime.utcnow()
233
logger.debug(u"Creating client %r", self.name)
234
# Uppercase and remove spaces from fingerprint for later
235
# comparison purposes with return value from the fingerprint()
237
self.fingerprint = config["fingerprint"].upper()\
239
logger.debug(u" Fingerprint: %s", self.fingerprint)
240
if "secret" in config:
241
self.secret = config["secret"].decode(u"base64")
242
elif "secfile" in config:
243
secfile = open(config["secfile"])
244
self.secret = secfile.read()
809
self.last_enabled = None
812
logger.debug("Creating client %r", self.name)
813
logger.debug(" Fingerprint: %s", self.fingerprint)
814
self.created = settings.get("created",
815
datetime.datetime.utcnow())
817
# attributes specific for this server instance
247
raise TypeError(u"No secret or secfile for client %s"
249
self.host = config.get("host", "")
250
self.created = datetime.datetime.now()
251
self.last_checked_ok = None
252
self.timeout = string_to_delta(config["timeout"])
253
self.interval = string_to_delta(config["interval"])
254
self.stop_hook = stop_hook
818
255
self.checker = None
819
256
self.checker_initiator_tag = None
820
self.disable_initiator_tag = None
257
self.stop_initiator_tag = None
821
258
self.checker_callback_tag = None
822
self.current_checker_command = None
824
self.approvals_pending = 0
825
self.changedstate = multiprocessing_manager.Condition(
826
multiprocessing_manager.Lock())
827
self.client_structure = [attr
828
for attr in self.__dict__.iterkeys()
829
if not attr.startswith("_")]
830
self.client_structure.append("client_structure")
832
for name, t in inspect.getmembers(
833
type(self), lambda obj: isinstance(obj, property)):
834
if not name.startswith("_"):
835
self.client_structure.append(name)
837
# Send notice to process children that client state has changed
838
def send_changedstate(self):
839
with self.changedstate:
840
self.changedstate.notify_all()
259
self.check_command = config["checker"]
843
261
"""Start this client's checker and timeout hooks"""
844
if getattr(self, "enabled", False):
847
self.expires = datetime.datetime.utcnow() + self.timeout
849
self.last_enabled = datetime.datetime.utcnow()
851
self.send_changedstate()
853
def disable(self, quiet=True):
854
"""Disable this client."""
855
if not getattr(self, "enabled", False):
858
logger.info("Disabling client %s", self.name)
859
if getattr(self, "disable_initiator_tag", None) is not None:
860
gobject.source_remove(self.disable_initiator_tag)
861
self.disable_initiator_tag = None
863
if getattr(self, "checker_initiator_tag", None) is not None:
864
gobject.source_remove(self.checker_initiator_tag)
865
self.checker_initiator_tag = None
869
self.send_changedstate()
870
# Do not run this again if called by a gobject.timeout_add
876
def init_checker(self):
877
262
# Schedule a new checker to be started an 'interval' from now,
878
263
# and every interval from then on.
879
if self.checker_initiator_tag is not None:
880
gobject.source_remove(self.checker_initiator_tag)
881
self.checker_initiator_tag = gobject.timeout_add(
882
int(self.interval.total_seconds() * 1000),
884
# Schedule a disable() when 'timeout' has passed
885
if self.disable_initiator_tag is not None:
886
gobject.source_remove(self.disable_initiator_tag)
887
self.disable_initiator_tag = gobject.timeout_add(
888
int(self.timeout.total_seconds() * 1000), self.disable)
264
self.checker_initiator_tag = gobject.timeout_add\
265
(self._interval_milliseconds,
889
267
# Also start a new checker *right now*.
890
268
self.start_checker()
892
def checker_callback(self, source, condition, connection,
269
# Schedule a stop() when 'timeout' has passed
270
self.stop_initiator_tag = gobject.timeout_add\
271
(self._timeout_milliseconds,
275
The possibility that a client might be restarted is left open,
276
but not currently used."""
277
# If this client doesn't have a secret, it is already stopped.
278
if hasattr(self, "secret") and self.secret:
279
logger.info(u"Stopping client %s", self.name)
283
if getattr(self, "stop_initiator_tag", False):
284
gobject.source_remove(self.stop_initiator_tag)
285
self.stop_initiator_tag = None
286
if getattr(self, "checker_initiator_tag", False):
287
gobject.source_remove(self.checker_initiator_tag)
288
self.checker_initiator_tag = None
292
# Do not run this again if called by a gobject.timeout_add
295
self.stop_hook = None
297
def checker_callback(self, pid, condition):
894
298
"""The checker has completed, so take appropriate actions."""
299
now = datetime.datetime.now()
895
300
self.checker_callback_tag = None
896
301
self.checker = None
897
# Read return code from connection (see call_pipe)
898
returncode = connection.recv()
902
self.last_checker_status = returncode
903
self.last_checker_signal = None
904
if self.last_checker_status == 0:
905
logger.info("Checker for %(name)s succeeded",
909
logger.info("Checker for %(name)s failed", vars(self))
911
self.last_checker_status = -1
912
self.last_checker_signal = -returncode
913
logger.warning("Checker for %(name)s crashed?",
302
if os.WIFEXITED(condition) \
303
and (os.WEXITSTATUS(condition) == 0):
304
logger.info(u"Checker for %(name)s succeeded",
306
self.last_checked_ok = now
307
gobject.source_remove(self.stop_initiator_tag)
308
self.stop_initiator_tag = gobject.timeout_add\
309
(self._timeout_milliseconds,
311
elif not os.WIFEXITED(condition):
312
logger.warning(u"Checker for %(name)s crashed?",
917
def checked_ok(self):
918
"""Assert that the client has been seen, alive and well."""
919
self.last_checked_ok = datetime.datetime.utcnow()
920
self.last_checker_status = 0
921
self.last_checker_signal = None
924
def bump_timeout(self, timeout=None):
925
"""Bump up the timeout for this client."""
927
timeout = self.timeout
928
if self.disable_initiator_tag is not None:
929
gobject.source_remove(self.disable_initiator_tag)
930
self.disable_initiator_tag = None
931
if getattr(self, "enabled", False):
932
self.disable_initiator_tag = gobject.timeout_add(
933
int(timeout.total_seconds() * 1000), self.disable)
934
self.expires = datetime.datetime.utcnow() + timeout
936
def need_approval(self):
937
self.last_approval_request = datetime.datetime.utcnow()
315
logger.info(u"Checker for %(name)s failed",
939
317
def start_checker(self):
940
318
"""Start a new checker subprocess if one is not running.
942
319
If a checker already exists, leave it running and do
944
321
# The reason for not killing a running checker is that if we
945
# did that, and if a checker (for some reason) started running
946
# slowly and taking more than 'interval' time, then the client
947
# would inevitably timeout, since no checker would get a
948
# chance to run to completion. If we instead leave running
322
# did that, then if a checker (for some reason) started
323
# running slowly and taking more than 'interval' time, the
324
# client would inevitably timeout, since no checker would get
325
# a chance to run to completion. If we instead leave running
949
326
# checkers alone, the checker would have to take more time
950
# than 'timeout' for the client to be disabled, which is as it
953
if self.checker is not None and not self.checker.is_alive():
954
logger.warning("Checker was not alive; joining")
957
# Start a new checker if needed
327
# than 'timeout' for the client to be declared invalid, which
328
# is as it should be.
958
329
if self.checker is None:
959
# Escape attributes for the shell
961
attr: re.escape(str(getattr(self, attr)))
962
for attr in self.runtime_expansions }
964
command = self.checker_command % escaped_attrs
965
except TypeError as error:
966
logger.error('Could not format string "%s"',
967
self.checker_command,
969
return True # Try again later
970
self.current_checker_command = command
971
logger.info("Starting checker %r for %s", command,
973
# We don't need to redirect stdout and stderr, since
974
# in normal mode, that is already done by daemon(),
975
# and in debug mode we don't want to. (Stdin is
976
# always replaced by /dev/null.)
977
# The exception is when not debugging but nevertheless
978
# running in the foreground; use the previously
980
popen_args = { "close_fds": True,
983
if (not self.server_settings["debug"]
984
and self.server_settings["foreground"]):
985
popen_args.update({"stdout": wnull,
987
pipe = multiprocessing.Pipe(duplex = False)
988
self.checker = multiprocessing.Process(
990
args = (pipe[1], subprocess.call, command),
993
self.checker_callback_tag = gobject.io_add_watch(
994
pipe[0].fileno(), gobject.IO_IN,
995
self.checker_callback, pipe[0], command)
331
# In case check_command has exactly one % operator
332
command = self.check_command % self.host
334
# Escape attributes for the shell
335
escaped_attrs = dict((key, re.escape(str(val)))
337
vars(self).iteritems())
339
command = self.check_command % escaped_attrs
340
except TypeError, error:
341
logger.error(u'Could not format string "%s":'
342
u' %s', self.check_command, error)
343
return True # Try again later
345
logger.info(u"Starting checker %r for %s",
347
# We don't need to redirect stdout and stderr, since
348
# in normal mode, that is already done by daemon(),
349
# and in debug mode we don't want to. (Stdin is
350
# always replaced by /dev/null.)
351
self.checker = subprocess.Popen(command,
354
self.checker_callback_tag = gobject.child_watch_add\
356
self.checker_callback)
357
except OSError, error:
358
logger.error(u"Failed to start subprocess: %s",
996
360
# Re-run this periodically if run by gobject.timeout_add
999
362
def stop_checker(self):
1000
363
"""Force the checker process, if any, to stop."""
1001
364
if self.checker_callback_tag:
1003
366
self.checker_callback_tag = None
1004
367
if getattr(self, "checker", None) is None:
1006
logger.debug("Stopping checker for %(name)s", vars(self))
1007
self.checker.terminate()
369
logger.debug(u"Stopping checker for %(name)s", vars(self))
371
os.kill(self.checker.pid, signal.SIGTERM)
373
#if self.checker.poll() is None:
374
# os.kill(self.checker.pid, signal.SIGKILL)
375
except OSError, error:
376
if error.errno != errno.ESRCH: # No such process
1008
378
self.checker = None
1011
def dbus_service_property(dbus_interface,
1015
"""Decorators for marking methods of a DBusObjectWithProperties to
1016
become properties on the D-Bus.
1018
The decorated method will be called with no arguments by "Get"
1019
and with one argument by "Set".
1021
The parameters, where they are supported, are the same as
1022
dbus.service.method, except there is only "signature", since the
1023
type from Get() and the type sent to Set() is the same.
1025
# Encoding deeply encoded byte arrays is not supported yet by the
1026
# "Set" method, so we fail early here:
1027
if byte_arrays and signature != "ay":
1028
raise ValueError("Byte arrays not supported for non-'ay'"
1029
" signature {!r}".format(signature))
1031
def decorator(func):
1032
func._dbus_is_property = True
1033
func._dbus_interface = dbus_interface
1034
func._dbus_signature = signature
1035
func._dbus_access = access
1036
func._dbus_name = func.__name__
1037
if func._dbus_name.endswith("_dbus_property"):
1038
func._dbus_name = func._dbus_name[:-14]
1039
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1045
def dbus_interface_annotations(dbus_interface):
1046
"""Decorator for marking functions returning interface annotations
1050
@dbus_interface_annotations("org.example.Interface")
1051
def _foo(self): # Function name does not matter
1052
return {"org.freedesktop.DBus.Deprecated": "true",
1053
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1057
def decorator(func):
1058
func._dbus_is_interface = True
1059
func._dbus_interface = dbus_interface
1060
func._dbus_name = dbus_interface
1066
def dbus_annotations(annotations):
1067
"""Decorator to annotate D-Bus methods, signals or properties
1070
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1071
"org.freedesktop.DBus.Property."
1072
"EmitsChangedSignal": "false"})
1073
@dbus_service_property("org.example.Interface", signature="b",
1075
def Property_dbus_property(self):
1076
return dbus.Boolean(False)
1078
See also the DBusObjectWithAnnotations class.
1081
def decorator(func):
1082
func._dbus_annotations = annotations
1088
class DBusPropertyException(dbus.exceptions.DBusException):
1089
"""A base class for D-Bus property-related exceptions
1094
class DBusPropertyAccessException(DBusPropertyException):
1095
"""A property's access permissions disallows an operation.
1100
class DBusPropertyNotFound(DBusPropertyException):
1101
"""An attempt was made to access a non-existing property.
1106
class DBusObjectWithAnnotations(dbus.service.Object):
1107
"""A D-Bus object with annotations.
1109
Classes inheriting from this can use the dbus_annotations
1110
decorator to add annotations to methods or signals.
1114
def _is_dbus_thing(thing):
1115
"""Returns a function testing if an attribute is a D-Bus thing
1117
If called like _is_dbus_thing("method") it returns a function
1118
suitable for use as predicate to inspect.getmembers().
1120
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1123
def _get_all_dbus_things(self, thing):
1124
"""Returns a generator of (name, attribute) pairs
1126
return ((getattr(athing.__get__(self), "_dbus_name", name),
1127
athing.__get__(self))
1128
for cls in self.__class__.__mro__
1130
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1132
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1133
out_signature = "s",
1134
path_keyword = 'object_path',
1135
connection_keyword = 'connection')
1136
def Introspect(self, object_path, connection):
1137
"""Overloading of standard D-Bus method.
1139
Inserts annotation tags on methods and signals.
1141
xmlstring = dbus.service.Object.Introspect(self, object_path,
1144
document = xml.dom.minidom.parseString(xmlstring)
1146
for if_tag in document.getElementsByTagName("interface"):
1147
# Add annotation tags
1148
for typ in ("method", "signal"):
1149
for tag in if_tag.getElementsByTagName(typ):
1151
for name, prop in (self.
1152
_get_all_dbus_things(typ)):
1153
if (name == tag.getAttribute("name")
1154
and prop._dbus_interface
1155
== if_tag.getAttribute("name")):
1156
annots.update(getattr(
1157
prop, "_dbus_annotations", {}))
1158
for name, value in annots.items():
1159
ann_tag = document.createElement(
1161
ann_tag.setAttribute("name", name)
1162
ann_tag.setAttribute("value", value)
1163
tag.appendChild(ann_tag)
1164
# Add interface annotation tags
1165
for annotation, value in dict(
1166
itertools.chain.from_iterable(
1167
annotations().items()
1168
for name, annotations
1169
in self._get_all_dbus_things("interface")
1170
if name == if_tag.getAttribute("name")
1172
ann_tag = document.createElement("annotation")
1173
ann_tag.setAttribute("name", annotation)
1174
ann_tag.setAttribute("value", value)
1175
if_tag.appendChild(ann_tag)
1176
# Fix argument name for the Introspect method itself
1177
if (if_tag.getAttribute("name")
1178
== dbus.INTROSPECTABLE_IFACE):
1179
for cn in if_tag.getElementsByTagName("method"):
1180
if cn.getAttribute("name") == "Introspect":
1181
for arg in cn.getElementsByTagName("arg"):
1182
if (arg.getAttribute("direction")
1184
arg.setAttribute("name",
1186
xmlstring = document.toxml("utf-8")
1188
except (AttributeError, xml.dom.DOMException,
1189
xml.parsers.expat.ExpatError) as error:
1190
logger.error("Failed to override Introspection method",
1195
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1196
"""A D-Bus object with properties.
1198
Classes inheriting from this can use the dbus_service_property
1199
decorator to expose methods as D-Bus properties. It exposes the
1200
standard Get(), Set(), and GetAll() methods on the D-Bus.
1203
def _get_dbus_property(self, interface_name, property_name):
1204
"""Returns a bound method if one exists which is a D-Bus
1205
property with the specified name and interface.
1207
for cls in self.__class__.__mro__:
1208
for name, value in inspect.getmembers(
1209
cls, self._is_dbus_thing("property")):
1210
if (value._dbus_name == property_name
1211
and value._dbus_interface == interface_name):
1212
return value.__get__(self)
1215
raise DBusPropertyNotFound("{}:{}.{}".format(
1216
self.dbus_object_path, interface_name, property_name))
1219
def _get_all_interface_names(cls):
1220
"""Get a sequence of all interfaces supported by an object"""
1221
return (name for name in set(getattr(getattr(x, attr),
1222
"_dbus_interface", None)
1223
for x in (inspect.getmro(cls))
1225
if name is not None)
1227
@dbus.service.method(dbus.PROPERTIES_IFACE,
1230
def Get(self, interface_name, property_name):
1231
"""Standard D-Bus property Get() method, see D-Bus standard.
1233
prop = self._get_dbus_property(interface_name, property_name)
1234
if prop._dbus_access == "write":
1235
raise DBusPropertyAccessException(property_name)
1237
if not hasattr(value, "variant_level"):
1239
return type(value)(value, variant_level=value.variant_level+1)
1241
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1242
def Set(self, interface_name, property_name, value):
1243
"""Standard D-Bus property Set() method, see D-Bus standard.
1245
prop = self._get_dbus_property(interface_name, property_name)
1246
if prop._dbus_access == "read":
1247
raise DBusPropertyAccessException(property_name)
1248
if prop._dbus_get_args_options["byte_arrays"]:
1249
# The byte_arrays option is not supported yet on
1250
# signatures other than "ay".
1251
if prop._dbus_signature != "ay":
1252
raise ValueError("Byte arrays not supported for non-"
1253
"'ay' signature {!r}"
1254
.format(prop._dbus_signature))
1255
value = dbus.ByteArray(b''.join(chr(byte)
1259
@dbus.service.method(dbus.PROPERTIES_IFACE,
1261
out_signature="a{sv}")
1262
def GetAll(self, interface_name):
1263
"""Standard D-Bus property GetAll() method, see D-Bus
1266
Note: Will not include properties with access="write".
1269
for name, prop in self._get_all_dbus_things("property"):
1271
and interface_name != prop._dbus_interface):
1272
# Interface non-empty but did not match
1274
# Ignore write-only properties
1275
if prop._dbus_access == "write":
1278
if not hasattr(value, "variant_level"):
1279
properties[name] = value
1281
properties[name] = type(value)(
1282
value, variant_level = value.variant_level + 1)
1283
return dbus.Dictionary(properties, signature="sv")
1285
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1286
def PropertiesChanged(self, interface_name, changed_properties,
1287
invalidated_properties):
1288
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1293
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1295
path_keyword='object_path',
1296
connection_keyword='connection')
1297
def Introspect(self, object_path, connection):
1298
"""Overloading of standard D-Bus method.
1300
Inserts property tags and interface annotation tags.
1302
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1306
document = xml.dom.minidom.parseString(xmlstring)
1308
def make_tag(document, name, prop):
1309
e = document.createElement("property")
1310
e.setAttribute("name", name)
1311
e.setAttribute("type", prop._dbus_signature)
1312
e.setAttribute("access", prop._dbus_access)
1315
for if_tag in document.getElementsByTagName("interface"):
1317
for tag in (make_tag(document, name, prop)
1319
in self._get_all_dbus_things("property")
1320
if prop._dbus_interface
1321
== if_tag.getAttribute("name")):
1322
if_tag.appendChild(tag)
1323
# Add annotation tags for properties
1324
for tag in if_tag.getElementsByTagName("property"):
1326
for name, prop in self._get_all_dbus_things(
1328
if (name == tag.getAttribute("name")
1329
and prop._dbus_interface
1330
== if_tag.getAttribute("name")):
1331
annots.update(getattr(
1332
prop, "_dbus_annotations", {}))
1333
for name, value in annots.items():
1334
ann_tag = document.createElement(
1336
ann_tag.setAttribute("name", name)
1337
ann_tag.setAttribute("value", value)
1338
tag.appendChild(ann_tag)
1339
# Add the names to the return values for the
1340
# "org.freedesktop.DBus.Properties" methods
1341
if (if_tag.getAttribute("name")
1342
== "org.freedesktop.DBus.Properties"):
1343
for cn in if_tag.getElementsByTagName("method"):
1344
if cn.getAttribute("name") == "Get":
1345
for arg in cn.getElementsByTagName("arg"):
1346
if (arg.getAttribute("direction")
1348
arg.setAttribute("name", "value")
1349
elif cn.getAttribute("name") == "GetAll":
1350
for arg in cn.getElementsByTagName("arg"):
1351
if (arg.getAttribute("direction")
1353
arg.setAttribute("name", "props")
1354
xmlstring = document.toxml("utf-8")
1356
except (AttributeError, xml.dom.DOMException,
1357
xml.parsers.expat.ExpatError) as error:
1358
logger.error("Failed to override Introspection method",
1363
dbus.OBJECT_MANAGER_IFACE
1364
except AttributeError:
1365
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1367
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1368
"""A D-Bus object with an ObjectManager.
1370
Classes inheriting from this exposes the standard
1371
GetManagedObjects call and the InterfacesAdded and
1372
InterfacesRemoved signals on the standard
1373
"org.freedesktop.DBus.ObjectManager" interface.
1375
Note: No signals are sent automatically; they must be sent
1378
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1379
out_signature = "a{oa{sa{sv}}}")
1380
def GetManagedObjects(self):
1381
"""This function must be overridden"""
1382
raise NotImplementedError()
1384
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1385
signature = "oa{sa{sv}}")
1386
def InterfacesAdded(self, object_path, interfaces_and_properties):
1389
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1390
def InterfacesRemoved(self, object_path, interfaces):
1393
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1394
out_signature = "s",
1395
path_keyword = 'object_path',
1396
connection_keyword = 'connection')
1397
def Introspect(self, object_path, connection):
1398
"""Overloading of standard D-Bus method.
1400
Override return argument name of GetManagedObjects to be
1401
"objpath_interfaces_and_properties"
1403
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1407
document = xml.dom.minidom.parseString(xmlstring)
1409
for if_tag in document.getElementsByTagName("interface"):
1410
# Fix argument name for the GetManagedObjects method
1411
if (if_tag.getAttribute("name")
1412
== dbus.OBJECT_MANAGER_IFACE):
1413
for cn in if_tag.getElementsByTagName("method"):
1414
if (cn.getAttribute("name")
1415
== "GetManagedObjects"):
1416
for arg in cn.getElementsByTagName("arg"):
1417
if (arg.getAttribute("direction")
1421
"objpath_interfaces"
1423
xmlstring = document.toxml("utf-8")
1425
except (AttributeError, xml.dom.DOMException,
1426
xml.parsers.expat.ExpatError) as error:
1427
logger.error("Failed to override Introspection method",
1431
def datetime_to_dbus(dt, variant_level=0):
1432
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1434
return dbus.String("", variant_level = variant_level)
1435
return dbus.String(dt.isoformat(), variant_level=variant_level)
1438
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1439
"""A class decorator; applied to a subclass of
1440
dbus.service.Object, it will add alternate D-Bus attributes with
1441
interface names according to the "alt_interface_names" mapping.
1444
@alternate_dbus_interfaces({"org.example.Interface":
1445
"net.example.AlternateInterface"})
1446
class SampleDBusObject(dbus.service.Object):
1447
@dbus.service.method("org.example.Interface")
1448
def SampleDBusMethod():
1451
The above "SampleDBusMethod" on "SampleDBusObject" will be
1452
reachable via two interfaces: "org.example.Interface" and
1453
"net.example.AlternateInterface", the latter of which will have
1454
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1455
"true", unless "deprecate" is passed with a False value.
1457
This works for methods and signals, and also for D-Bus properties
1458
(from DBusObjectWithProperties) and interfaces (from the
1459
dbus_interface_annotations decorator).
1463
for orig_interface_name, alt_interface_name in (
1464
alt_interface_names.items()):
1466
interface_names = set()
1467
# Go though all attributes of the class
1468
for attrname, attribute in inspect.getmembers(cls):
1469
# Ignore non-D-Bus attributes, and D-Bus attributes
1470
# with the wrong interface name
1471
if (not hasattr(attribute, "_dbus_interface")
1472
or not attribute._dbus_interface.startswith(
1473
orig_interface_name)):
1475
# Create an alternate D-Bus interface name based on
1477
alt_interface = attribute._dbus_interface.replace(
1478
orig_interface_name, alt_interface_name)
1479
interface_names.add(alt_interface)
1480
# Is this a D-Bus signal?
1481
if getattr(attribute, "_dbus_is_signal", False):
1482
if sys.version_info.major == 2:
1483
# Extract the original non-method undecorated
1484
# function by black magic
1485
nonmethod_func = (dict(
1486
zip(attribute.func_code.co_freevars,
1487
attribute.__closure__))
1488
["func"].cell_contents)
1490
nonmethod_func = attribute
1491
# Create a new, but exactly alike, function
1492
# object, and decorate it to be a new D-Bus signal
1493
# with the alternate D-Bus interface name
1494
if sys.version_info.major == 2:
1495
new_function = types.FunctionType(
1496
nonmethod_func.func_code,
1497
nonmethod_func.func_globals,
1498
nonmethod_func.func_name,
1499
nonmethod_func.func_defaults,
1500
nonmethod_func.func_closure)
1502
new_function = types.FunctionType(
1503
nonmethod_func.__code__,
1504
nonmethod_func.__globals__,
1505
nonmethod_func.__name__,
1506
nonmethod_func.__defaults__,
1507
nonmethod_func.__closure__)
1508
new_function = (dbus.service.signal(
1510
attribute._dbus_signature)(new_function))
1511
# Copy annotations, if any
1513
new_function._dbus_annotations = dict(
1514
attribute._dbus_annotations)
1515
except AttributeError:
1517
# Define a creator of a function to call both the
1518
# original and alternate functions, so both the
1519
# original and alternate signals gets sent when
1520
# the function is called
1521
def fixscope(func1, func2):
1522
"""This function is a scope container to pass
1523
func1 and func2 to the "call_both" function
1524
outside of its arguments"""
1526
@functools.wraps(func2)
1527
def call_both(*args, **kwargs):
1528
"""This function will emit two D-Bus
1529
signals by calling func1 and func2"""
1530
func1(*args, **kwargs)
1531
func2(*args, **kwargs)
1532
# Make wrapper function look like a D-Bus signal
1533
for name, attr in inspect.getmembers(func2):
1534
if name.startswith("_dbus_"):
1535
setattr(call_both, name, attr)
1538
# Create the "call_both" function and add it to
1540
attr[attrname] = fixscope(attribute, new_function)
1541
# Is this a D-Bus method?
1542
elif getattr(attribute, "_dbus_is_method", False):
1543
# Create a new, but exactly alike, function
1544
# object. Decorate it to be a new D-Bus method
1545
# with the alternate D-Bus interface name. Add it
1548
dbus.service.method(
1550
attribute._dbus_in_signature,
1551
attribute._dbus_out_signature)
1552
(types.FunctionType(attribute.func_code,
1553
attribute.func_globals,
1554
attribute.func_name,
1555
attribute.func_defaults,
1556
attribute.func_closure)))
1557
# Copy annotations, if any
1559
attr[attrname]._dbus_annotations = dict(
1560
attribute._dbus_annotations)
1561
except AttributeError:
1563
# Is this a D-Bus property?
1564
elif getattr(attribute, "_dbus_is_property", False):
1565
# Create a new, but exactly alike, function
1566
# object, and decorate it to be a new D-Bus
1567
# property with the alternate D-Bus interface
1568
# name. Add it to the class.
1569
attr[attrname] = (dbus_service_property(
1570
alt_interface, attribute._dbus_signature,
1571
attribute._dbus_access,
1572
attribute._dbus_get_args_options
1574
(types.FunctionType(
1575
attribute.func_code,
1576
attribute.func_globals,
1577
attribute.func_name,
1578
attribute.func_defaults,
1579
attribute.func_closure)))
1580
# Copy annotations, if any
1582
attr[attrname]._dbus_annotations = dict(
1583
attribute._dbus_annotations)
1584
except AttributeError:
1586
# Is this a D-Bus interface?
1587
elif getattr(attribute, "_dbus_is_interface", False):
1588
# Create a new, but exactly alike, function
1589
# object. Decorate it to be a new D-Bus interface
1590
# with the alternate D-Bus interface name. Add it
1593
dbus_interface_annotations(alt_interface)
1594
(types.FunctionType(attribute.func_code,
1595
attribute.func_globals,
1596
attribute.func_name,
1597
attribute.func_defaults,
1598
attribute.func_closure)))
1600
# Deprecate all alternate interfaces
1601
iname="_AlternateDBusNames_interface_annotation{}"
1602
for interface_name in interface_names:
1604
@dbus_interface_annotations(interface_name)
1606
return { "org.freedesktop.DBus.Deprecated":
1608
# Find an unused name
1609
for aname in (iname.format(i)
1610
for i in itertools.count()):
1611
if aname not in attr:
1615
# Replace the class with a new subclass of it with
1616
# methods, signals, etc. as created above.
1617
cls = type(b"{}Alternate".format(cls.__name__),
1624
@alternate_dbus_interfaces({"se.recompile.Mandos":
1625
"se.bsnet.fukt.Mandos"})
1626
class ClientDBus(Client, DBusObjectWithProperties):
1627
"""A Client class using D-Bus
1630
dbus_object_path: dbus.ObjectPath
1631
bus: dbus.SystemBus()
1634
runtime_expansions = (Client.runtime_expansions
1635
+ ("dbus_object_path", ))
1637
_interface = "se.recompile.Mandos.Client"
1639
# dbus.service.Object doesn't use super(), so we can't either.
1641
def __init__(self, bus = None, *args, **kwargs):
1643
Client.__init__(self, *args, **kwargs)
1644
# Only now, when this client is initialized, can it show up on
1646
client_object_name = str(self.name).translate(
1647
{ord("."): ord("_"),
1648
ord("-"): ord("_")})
1649
self.dbus_object_path = dbus.ObjectPath(
1650
"/clients/" + client_object_name)
1651
DBusObjectWithProperties.__init__(self, self.bus,
1652
self.dbus_object_path)
1654
def notifychangeproperty(transform_func, dbus_name,
1655
type_func=lambda x: x,
1657
invalidate_only=False,
1658
_interface=_interface):
1659
""" Modify a variable so that it's a property which announces
1660
its changes to DBus.
1662
transform_fun: Function that takes a value and a variant_level
1663
and transforms it to a D-Bus type.
1664
dbus_name: D-Bus name of the variable
1665
type_func: Function that transform the value before sending it
1666
to the D-Bus. Default: no transform
1667
variant_level: D-Bus variant level. Default: 1
1669
attrname = "_{}".format(dbus_name)
1671
def setter(self, value):
1672
if hasattr(self, "dbus_object_path"):
1673
if (not hasattr(self, attrname) or
1674
type_func(getattr(self, attrname, None))
1675
!= type_func(value)):
1677
self.PropertiesChanged(
1678
_interface, dbus.Dictionary(),
1679
dbus.Array((dbus_name, )))
1681
dbus_value = transform_func(
1683
variant_level = variant_level)
1684
self.PropertyChanged(dbus.String(dbus_name),
1686
self.PropertiesChanged(
1688
dbus.Dictionary({ dbus.String(dbus_name):
1691
setattr(self, attrname, value)
1693
return property(lambda self: getattr(self, attrname), setter)
1695
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1696
approvals_pending = notifychangeproperty(dbus.Boolean,
1699
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1700
last_enabled = notifychangeproperty(datetime_to_dbus,
1702
checker = notifychangeproperty(
1703
dbus.Boolean, "CheckerRunning",
1704
type_func = lambda checker: checker is not None)
1705
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1707
last_checker_status = notifychangeproperty(dbus.Int16,
1708
"LastCheckerStatus")
1709
last_approval_request = notifychangeproperty(
1710
datetime_to_dbus, "LastApprovalRequest")
1711
approved_by_default = notifychangeproperty(dbus.Boolean,
1712
"ApprovedByDefault")
1713
approval_delay = notifychangeproperty(
1714
dbus.UInt64, "ApprovalDelay",
1715
type_func = lambda td: td.total_seconds() * 1000)
1716
approval_duration = notifychangeproperty(
1717
dbus.UInt64, "ApprovalDuration",
1718
type_func = lambda td: td.total_seconds() * 1000)
1719
host = notifychangeproperty(dbus.String, "Host")
1720
timeout = notifychangeproperty(
1721
dbus.UInt64, "Timeout",
1722
type_func = lambda td: td.total_seconds() * 1000)
1723
extended_timeout = notifychangeproperty(
1724
dbus.UInt64, "ExtendedTimeout",
1725
type_func = lambda td: td.total_seconds() * 1000)
1726
interval = notifychangeproperty(
1727
dbus.UInt64, "Interval",
1728
type_func = lambda td: td.total_seconds() * 1000)
1729
checker_command = notifychangeproperty(dbus.String, "Checker")
1730
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1731
invalidate_only=True)
1733
del notifychangeproperty
1735
def __del__(self, *args, **kwargs):
1737
self.remove_from_connection()
1740
if hasattr(DBusObjectWithProperties, "__del__"):
1741
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1742
Client.__del__(self, *args, **kwargs)
1744
def checker_callback(self, source, condition,
1745
connection, command, *args, **kwargs):
1746
ret = Client.checker_callback(self, source, condition,
1747
connection, command, *args,
1749
exitstatus = self.last_checker_status
1752
self.CheckerCompleted(dbus.Int16(exitstatus),
1753
# This is specific to GNU libC
1754
dbus.Int64(exitstatus << 8),
1755
dbus.String(command))
1758
self.CheckerCompleted(dbus.Int16(-1),
1760
# This is specific to GNU libC
1762
| self.last_checker_signal),
1763
dbus.String(command))
1766
def start_checker(self, *args, **kwargs):
1767
old_checker_pid = getattr(self.checker, "pid", None)
1768
r = Client.start_checker(self, *args, **kwargs)
1769
# Only if new checker process was started
1770
if (self.checker is not None
1771
and old_checker_pid != self.checker.pid):
1773
self.CheckerStarted(self.current_checker_command)
1776
def _reset_approved(self):
1777
self.approved = None
1780
def approve(self, value=True):
1781
self.approved = value
1782
gobject.timeout_add(int(self.approval_duration.total_seconds()
1783
* 1000), self._reset_approved)
1784
self.send_changedstate()
1786
## D-Bus methods, signals & properties
1792
# CheckerCompleted - signal
1793
@dbus.service.signal(_interface, signature="nxs")
1794
def CheckerCompleted(self, exitcode, waitstatus, command):
1798
# CheckerStarted - signal
1799
@dbus.service.signal(_interface, signature="s")
1800
def CheckerStarted(self, command):
1804
# PropertyChanged - signal
1805
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1806
@dbus.service.signal(_interface, signature="sv")
1807
def PropertyChanged(self, property, value):
1811
# GotSecret - signal
1812
@dbus.service.signal(_interface)
1813
def GotSecret(self):
1815
Is sent after a successful transfer of secret from the Mandos
1816
server to mandos-client
1821
@dbus.service.signal(_interface, signature="s")
1822
def Rejected(self, reason):
1826
# NeedApproval - signal
1827
@dbus.service.signal(_interface, signature="tb")
1828
def NeedApproval(self, timeout, default):
1830
return self.need_approval()
1835
@dbus.service.method(_interface, in_signature="b")
1836
def Approve(self, value):
1839
# CheckedOK - method
1840
@dbus.service.method(_interface)
1841
def CheckedOK(self):
1845
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1846
@dbus.service.method(_interface)
1851
# StartChecker - method
1852
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1853
@dbus.service.method(_interface)
1854
def StartChecker(self):
1856
self.start_checker()
1859
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1860
@dbus.service.method(_interface)
1865
# StopChecker - method
1866
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1867
@dbus.service.method(_interface)
1868
def StopChecker(self):
1873
# ApprovalPending - property
1874
@dbus_service_property(_interface, signature="b", access="read")
1875
def ApprovalPending_dbus_property(self):
1876
return dbus.Boolean(bool(self.approvals_pending))
1878
# ApprovedByDefault - property
1879
@dbus_service_property(_interface,
1882
def ApprovedByDefault_dbus_property(self, value=None):
1883
if value is None: # get
1884
return dbus.Boolean(self.approved_by_default)
1885
self.approved_by_default = bool(value)
1887
# ApprovalDelay - property
1888
@dbus_service_property(_interface,
1891
def ApprovalDelay_dbus_property(self, value=None):
1892
if value is None: # get
1893
return dbus.UInt64(self.approval_delay.total_seconds()
1895
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1897
# ApprovalDuration - property
1898
@dbus_service_property(_interface,
1901
def ApprovalDuration_dbus_property(self, value=None):
1902
if value is None: # get
1903
return dbus.UInt64(self.approval_duration.total_seconds()
1905
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1909
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1910
@dbus_service_property(_interface, signature="s", access="read")
1911
def Name_dbus_property(self):
1912
return dbus.String(self.name)
1914
# Fingerprint - property
1916
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1917
@dbus_service_property(_interface, signature="s", access="read")
1918
def Fingerprint_dbus_property(self):
1919
return dbus.String(self.fingerprint)
1922
@dbus_service_property(_interface,
1925
def Host_dbus_property(self, value=None):
1926
if value is None: # get
1927
return dbus.String(self.host)
1928
self.host = str(value)
1930
# Created - property
1932
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1933
@dbus_service_property(_interface, signature="s", access="read")
1934
def Created_dbus_property(self):
1935
return datetime_to_dbus(self.created)
1937
# LastEnabled - property
1938
@dbus_service_property(_interface, signature="s", access="read")
1939
def LastEnabled_dbus_property(self):
1940
return datetime_to_dbus(self.last_enabled)
1942
# Enabled - property
1943
@dbus_service_property(_interface,
1946
def Enabled_dbus_property(self, value=None):
1947
if value is None: # get
1948
return dbus.Boolean(self.enabled)
1954
# LastCheckedOK - property
1955
@dbus_service_property(_interface,
1958
def LastCheckedOK_dbus_property(self, value=None):
1959
if value is not None:
1962
return datetime_to_dbus(self.last_checked_ok)
1964
# LastCheckerStatus - property
1965
@dbus_service_property(_interface, signature="n", access="read")
1966
def LastCheckerStatus_dbus_property(self):
1967
return dbus.Int16(self.last_checker_status)
1969
# Expires - property
1970
@dbus_service_property(_interface, signature="s", access="read")
1971
def Expires_dbus_property(self):
1972
return datetime_to_dbus(self.expires)
1974
# LastApprovalRequest - property
1975
@dbus_service_property(_interface, signature="s", access="read")
1976
def LastApprovalRequest_dbus_property(self):
1977
return datetime_to_dbus(self.last_approval_request)
1979
# Timeout - property
1980
@dbus_service_property(_interface,
1983
def Timeout_dbus_property(self, value=None):
1984
if value is None: # get
1985
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1986
old_timeout = self.timeout
1987
self.timeout = datetime.timedelta(0, 0, 0, value)
1988
# Reschedule disabling
1990
now = datetime.datetime.utcnow()
1991
self.expires += self.timeout - old_timeout
1992
if self.expires <= now:
1993
# The timeout has passed
1996
if (getattr(self, "disable_initiator_tag", None)
1999
gobject.source_remove(self.disable_initiator_tag)
2000
self.disable_initiator_tag = gobject.timeout_add(
2001
int((self.expires - now).total_seconds() * 1000),
2004
# ExtendedTimeout - property
2005
@dbus_service_property(_interface,
2008
def ExtendedTimeout_dbus_property(self, value=None):
2009
if value is None: # get
2010
return dbus.UInt64(self.extended_timeout.total_seconds()
2012
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2014
# Interval - property
2015
@dbus_service_property(_interface,
2018
def Interval_dbus_property(self, value=None):
2019
if value is None: # get
2020
return dbus.UInt64(self.interval.total_seconds() * 1000)
2021
self.interval = datetime.timedelta(0, 0, 0, value)
2022
if getattr(self, "checker_initiator_tag", None) is None:
2025
# Reschedule checker run
2026
gobject.source_remove(self.checker_initiator_tag)
2027
self.checker_initiator_tag = gobject.timeout_add(
2028
value, self.start_checker)
2029
self.start_checker() # Start one now, too
2031
# Checker - property
2032
@dbus_service_property(_interface,
2035
def Checker_dbus_property(self, value=None):
2036
if value is None: # get
2037
return dbus.String(self.checker_command)
2038
self.checker_command = str(value)
2040
# CheckerRunning - property
2041
@dbus_service_property(_interface,
2044
def CheckerRunning_dbus_property(self, value=None):
2045
if value is None: # get
2046
return dbus.Boolean(self.checker is not None)
2048
self.start_checker()
2052
# ObjectPath - property
2054
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2055
"org.freedesktop.DBus.Deprecated": "true"})
2056
@dbus_service_property(_interface, signature="o", access="read")
2057
def ObjectPath_dbus_property(self):
2058
return self.dbus_object_path # is already a dbus.ObjectPath
2062
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2064
@dbus_service_property(_interface,
2068
def Secret_dbus_property(self, value):
2069
self.secret = bytes(value)
2074
class ProxyClient(object):
2075
def __init__(self, child_pipe, fpr, address):
2076
self._pipe = child_pipe
2077
self._pipe.send(('init', fpr, address))
2078
if not self._pipe.recv():
2081
def __getattribute__(self, name):
2083
return super(ProxyClient, self).__getattribute__(name)
2084
self._pipe.send(('getattr', name))
2085
data = self._pipe.recv()
2086
if data[0] == 'data':
2088
if data[0] == 'function':
2090
def func(*args, **kwargs):
2091
self._pipe.send(('funcall', name, args, kwargs))
2092
return self._pipe.recv()[1]
2096
def __setattr__(self, name, value):
2098
return super(ProxyClient, self).__setattr__(name, value)
2099
self._pipe.send(('setattr', name, value))
2102
class ClientHandler(socketserver.BaseRequestHandler, object):
2103
"""A class to handle client connections.
2105
Instantiated once for each connection to handle it.
379
def still_valid(self):
380
"""Has the timeout not yet passed for this client?"""
381
now = datetime.datetime.now()
382
if self.last_checked_ok is None:
383
return now < (self.created + self.timeout)
385
return now < (self.last_checked_ok + self.timeout)
388
def peer_certificate(session):
389
"Return the peer's OpenPGP certificate as a bytestring"
390
# If not an OpenPGP certificate...
391
if gnutls.library.functions.gnutls_certificate_type_get\
392
(session._c_object) \
393
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
394
# ...do the normal thing
395
return session.peer_certificate
396
list_size = ctypes.c_uint()
397
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
398
(session._c_object, ctypes.byref(list_size))
399
if list_size.value == 0:
402
return ctypes.string_at(cert.data, cert.size)
405
def fingerprint(openpgp):
406
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
407
# New GnuTLS "datum" with the OpenPGP public key
408
datum = gnutls.library.types.gnutls_datum_t\
409
(ctypes.cast(ctypes.c_char_p(openpgp),
410
ctypes.POINTER(ctypes.c_ubyte)),
411
ctypes.c_uint(len(openpgp)))
412
# New empty GnuTLS certificate
413
crt = gnutls.library.types.gnutls_openpgp_crt_t()
414
gnutls.library.functions.gnutls_openpgp_crt_init\
416
# Import the OpenPGP public key into the certificate
417
gnutls.library.functions.gnutls_openpgp_crt_import\
418
(crt, ctypes.byref(datum),
419
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
420
# Verify the self signature in the key
421
crtverify = ctypes.c_uint()
422
gnutls.library.functions.gnutls_openpgp_crt_verify_self\
423
(crt, 0, ctypes.byref(crtverify))
424
if crtverify.value != 0:
425
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
426
raise gnutls.errors.CertificateSecurityError("Verify failed")
427
# New buffer for the fingerprint
428
buf = ctypes.create_string_buffer(20)
429
buf_len = ctypes.c_size_t()
430
# Get the fingerprint from the certificate into the buffer
431
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
432
(crt, ctypes.byref(buf), ctypes.byref(buf_len))
433
# Deinit the certificate
434
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
435
# Convert the buffer to a Python bytestring
436
fpr = ctypes.string_at(buf, buf_len.value)
437
# Convert the bytestring to hexadecimal notation
438
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
442
class TCP_handler(SocketServer.BaseRequestHandler, object):
443
"""A TCP request handler class.
444
Instantiated by IPv6_TCPServer for each request to handle it.
2106
445
Note: This will run in its own forked process."""
2108
447
def handle(self):
2109
with contextlib.closing(self.server.child_pipe) as child_pipe:
2110
logger.info("TCP connection from: %s",
2111
str(self.client_address))
2112
logger.debug("Pipe FD: %d",
2113
self.server.child_pipe.fileno())
2115
session = gnutls.ClientSession(self.request)
2117
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2118
# "+AES-256-CBC", "+SHA1",
2119
# "+COMP-NULL", "+CTYPE-OPENPGP",
2121
# Use a fallback default, since this MUST be set.
2122
priority = self.server.gnutls_priority
2123
if priority is None:
2125
gnutls.priority_set_direct(session._c_object, priority,
2128
# Start communication using the Mandos protocol
2129
# Get protocol number
2130
line = self.request.makefile().readline()
2131
logger.debug("Protocol version: %r", line)
2133
if int(line.strip().split()[0]) > 1:
2134
raise RuntimeError(line)
2135
except (ValueError, IndexError, RuntimeError) as error:
2136
logger.error("Unknown protocol version: %s", error)
2139
# Start GnuTLS connection
2142
except gnutls.Error as error:
2143
logger.warning("Handshake failed: %s", error)
2144
# Do not run session.bye() here: the session is not
2145
# established. Just abandon the request.
2147
logger.debug("Handshake succeeded")
2149
approval_required = False
2152
fpr = self.fingerprint(
2153
self.peer_certificate(session))
2154
except (TypeError, gnutls.Error) as error:
2155
logger.warning("Bad certificate: %s", error)
2157
logger.debug("Fingerprint: %s", fpr)
2160
client = ProxyClient(child_pipe, fpr,
2161
self.client_address)
2165
if client.approval_delay:
2166
delay = client.approval_delay
2167
client.approvals_pending += 1
2168
approval_required = True
2171
if not client.enabled:
2172
logger.info("Client %s is disabled",
2174
if self.server.use_dbus:
2176
client.Rejected("Disabled")
2179
if client.approved or not client.approval_delay:
2180
#We are approved or approval is disabled
2182
elif client.approved is None:
2183
logger.info("Client %s needs approval",
2185
if self.server.use_dbus:
2187
client.NeedApproval(
2188
client.approval_delay.total_seconds()
2189
* 1000, client.approved_by_default)
2191
logger.warning("Client %s was not approved",
2193
if self.server.use_dbus:
2195
client.Rejected("Denied")
2198
#wait until timeout or approved
2199
time = datetime.datetime.now()
2200
client.changedstate.acquire()
2201
client.changedstate.wait(delay.total_seconds())
2202
client.changedstate.release()
2203
time2 = datetime.datetime.now()
2204
if (time2 - time) >= delay:
2205
if not client.approved_by_default:
2206
logger.warning("Client %s timed out while"
2207
" waiting for approval",
2209
if self.server.use_dbus:
2211
client.Rejected("Approval timed out")
2216
delay -= time2 - time
2219
while sent_size < len(client.secret):
2221
sent = session.send(client.secret[sent_size:])
2222
except gnutls.Error as error:
2223
logger.warning("gnutls send failed",
2226
logger.debug("Sent: %d, remaining: %d", sent,
2227
len(client.secret) - (sent_size
2231
logger.info("Sending secret to %s", client.name)
2232
# bump the timeout using extended_timeout
2233
client.bump_timeout(client.extended_timeout)
2234
if self.server.use_dbus:
2239
if approval_required:
2240
client.approvals_pending -= 1
2243
except gnutls.Error as error:
2244
logger.warning("GnuTLS bye failed",
2248
def peer_certificate(session):
2249
"Return the peer's OpenPGP certificate as a bytestring"
2250
# If not an OpenPGP certificate...
2251
if (gnutls.certificate_type_get(session._c_object)
2252
!= gnutls.CRT_OPENPGP):
2253
# ...return invalid data
2255
list_size = ctypes.c_uint(1)
2256
cert_list = (gnutls.certificate_get_peers
2257
(session._c_object, ctypes.byref(list_size)))
2258
if not bool(cert_list) and list_size.value != 0:
2259
raise gnutls.Error("error getting peer certificate")
2260
if list_size.value == 0:
2263
return ctypes.string_at(cert.data, cert.size)
2266
def fingerprint(openpgp):
2267
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2268
# New GnuTLS "datum" with the OpenPGP public key
2269
datum = gnutls.datum_t(
2270
ctypes.cast(ctypes.c_char_p(openpgp),
2271
ctypes.POINTER(ctypes.c_ubyte)),
2272
ctypes.c_uint(len(openpgp)))
2273
# New empty GnuTLS certificate
2274
crt = gnutls.openpgp_crt_t()
2275
gnutls.openpgp_crt_init(ctypes.byref(crt))
2276
# Import the OpenPGP public key into the certificate
2277
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2278
gnutls.OPENPGP_FMT_RAW)
2279
# Verify the self signature in the key
2280
crtverify = ctypes.c_uint()
2281
gnutls.openpgp_crt_verify_self(crt, 0,
2282
ctypes.byref(crtverify))
2283
if crtverify.value != 0:
2284
gnutls.openpgp_crt_deinit(crt)
2285
raise gnutls.CertificateSecurityError("Verify failed")
2286
# New buffer for the fingerprint
2287
buf = ctypes.create_string_buffer(20)
2288
buf_len = ctypes.c_size_t()
2289
# Get the fingerprint from the certificate into the buffer
2290
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2291
ctypes.byref(buf_len))
2292
# Deinit the certificate
2293
gnutls.openpgp_crt_deinit(crt)
2294
# Convert the buffer to a Python bytestring
2295
fpr = ctypes.string_at(buf, buf_len.value)
2296
# Convert the bytestring to hexadecimal notation
2297
hex_fpr = binascii.hexlify(fpr).upper()
2301
class MultiprocessingMixIn(object):
2302
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2304
def sub_process_main(self, request, address):
2306
self.finish_request(request, address)
2308
self.handle_error(request, address)
2309
self.close_request(request)
2311
def process_request(self, request, address):
2312
"""Start a new process to process the request."""
2313
proc = multiprocessing.Process(target = self.sub_process_main,
2314
args = (request, address))
2319
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2320
""" adds a pipe to the MixIn """
2322
def process_request(self, request, client_address):
2323
"""Overrides and wraps the original process_request().
2325
This function creates a new pipe in self.pipe
2327
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2329
proc = MultiprocessingMixIn.process_request(self, request,
2331
self.child_pipe.close()
2332
self.add_pipe(parent_pipe, proc)
2334
def add_pipe(self, parent_pipe, proc):
2335
"""Dummy function; override as necessary"""
2336
raise NotImplementedError()
2339
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2340
socketserver.TCPServer, object):
2341
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
448
logger.info(u"TCP connection from: %s",
449
unicode(self.client_address))
450
session = gnutls.connection.ClientSession\
451
(self.request, gnutls.connection.X509Credentials())
453
line = self.request.makefile().readline()
454
logger.debug(u"Protocol version: %r", line)
456
if int(line.strip().split()[0]) > 1:
458
except (ValueError, IndexError, RuntimeError), error:
459
logger.error(u"Unknown protocol version: %s", error)
462
# Note: gnutls.connection.X509Credentials is really a generic
463
# GnuTLS certificate credentials object so long as no X.509
464
# keys are added to it. Therefore, we can use it here despite
465
# using OpenPGP certificates.
467
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
468
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
470
priority = "NORMAL" # Fallback default, since this
472
if self.server.settings["priority"]:
473
priority = self.server.settings["priority"]
474
gnutls.library.functions.gnutls_priority_set_direct\
475
(session._c_object, priority, None)
479
except gnutls.errors.GNUTLSError, error:
480
logger.warning(u"Handshake failed: %s", error)
481
# Do not run session.bye() here: the session is not
482
# established. Just abandon the request.
485
fpr = fingerprint(peer_certificate(session))
486
except (TypeError, gnutls.errors.GNUTLSError), error:
487
logger.warning(u"Bad certificate: %s", error)
490
logger.debug(u"Fingerprint: %s", fpr)
492
for c in self.server.clients:
493
if c.fingerprint == fpr:
497
logger.warning(u"Client not found for fingerprint: %s",
501
# Have to check if client.still_valid(), since it is possible
502
# that the client timed out while establishing the GnuTLS
504
if not client.still_valid():
505
logger.warning(u"Client %(name)s is invalid",
510
while sent_size < len(client.secret):
511
sent = session.send(client.secret[sent_size:])
512
logger.debug(u"Sent: %d, remaining: %d",
513
sent, len(client.secret)
514
- (sent_size + sent))
519
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
520
"""IPv6 TCP server. Accepts 'None' as address and/or port.
522
settings: Server settings
523
clients: Set() of Client objects
2344
524
enabled: Boolean; whether this server is activated yet
2345
interface: None or a network interface name (string)
2346
use_ipv6: Boolean; to use IPv6 or not
2349
def __init__(self, server_address, RequestHandlerClass,
2353
"""If socketfd is set, use that file descriptor instead of
2354
creating a new one with socket.socket().
2356
self.interface = interface
2358
self.address_family = socket.AF_INET6
2359
if socketfd is not None:
2360
# Save the file descriptor
2361
self.socketfd = socketfd
2362
# Save the original socket.socket() function
2363
self.socket_socket = socket.socket
2364
# To implement --socket, we monkey patch socket.socket.
2366
# (When socketserver.TCPServer is a new-style class, we
2367
# could make self.socket into a property instead of monkey
2368
# patching socket.socket.)
2370
# Create a one-time-only replacement for socket.socket()
2371
@functools.wraps(socket.socket)
2372
def socket_wrapper(*args, **kwargs):
2373
# Restore original function so subsequent calls are
2375
socket.socket = self.socket_socket
2376
del self.socket_socket
2377
# This time only, return a new socket object from the
2378
# saved file descriptor.
2379
return socket.fromfd(self.socketfd, *args, **kwargs)
2380
# Replace socket.socket() function with wrapper
2381
socket.socket = socket_wrapper
2382
# The socketserver.TCPServer.__init__ will call
2383
# socket.socket(), which might be our replacement,
2384
# socket_wrapper(), if socketfd was set.
2385
socketserver.TCPServer.__init__(self, server_address,
2386
RequestHandlerClass)
526
address_family = socket.AF_INET6
527
def __init__(self, *args, **kwargs):
528
if "settings" in kwargs:
529
self.settings = kwargs["settings"]
530
del kwargs["settings"]
531
if "clients" in kwargs:
532
self.clients = kwargs["clients"]
533
del kwargs["clients"]
535
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
2388
536
def server_bind(self):
2389
537
"""This overrides the normal server_bind() function
2390
538
to bind to an interface if one was specified, and also NOT to
2391
539
bind to an address or port if they were not specified."""
2392
if self.interface is not None:
2393
if SO_BINDTODEVICE is None:
2394
logger.error("SO_BINDTODEVICE does not exist;"
2395
" cannot bind to interface %s",
2399
self.socket.setsockopt(
2400
socket.SOL_SOCKET, SO_BINDTODEVICE,
2401
(self.interface + "\0").encode("utf-8"))
2402
except socket.error as error:
2403
if error.errno == errno.EPERM:
2404
logger.error("No permission to bind to"
2405
" interface %s", self.interface)
2406
elif error.errno == errno.ENOPROTOOPT:
2407
logger.error("SO_BINDTODEVICE not available;"
2408
" cannot bind to interface %s",
2410
elif error.errno == errno.ENODEV:
2411
logger.error("Interface %s does not exist,"
2412
" cannot bind", self.interface)
540
if self.settings["interface"]:
541
# 25 is from /usr/include/asm-i486/socket.h
542
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
544
self.socket.setsockopt(socket.SOL_SOCKET,
546
self.settings["interface"])
547
except socket.error, error:
548
if error[0] == errno.EPERM:
549
logger.error(u"No permission to"
550
u" bind to interface %s",
551
self.settings["interface"])
2415
554
# Only bind(2) the socket if we really need to.
2416
555
if self.server_address[0] or self.server_address[1]:
2417
556
if not self.server_address[0]:
2418
if self.address_family == socket.AF_INET6:
2419
any_address = "::" # in6addr_any
2421
any_address = "0.0.0.0" # INADDR_ANY
2422
self.server_address = (any_address,
558
self.server_address = (in6addr_any,
2423
559
self.server_address[1])
2424
560
elif not self.server_address[1]:
2425
self.server_address = (self.server_address[0], 0)
2426
# if self.interface:
561
self.server_address = (self.server_address[0],
563
# if self.settings["interface"]:
2427
564
# self.server_address = (self.server_address[0],
2430
567
# if_nametoindex
2432
return socketserver.TCPServer.server_bind(self)
2435
class MandosServer(IPv6_TCPServer):
2439
clients: set of Client objects
2440
gnutls_priority GnuTLS priority string
2441
use_dbus: Boolean; to emit D-Bus signals or not
2443
Assumes a gobject.MainLoop event loop.
2446
def __init__(self, server_address, RequestHandlerClass,
2450
gnutls_priority=None,
2453
self.enabled = False
2454
self.clients = clients
2455
if self.clients is None:
2457
self.use_dbus = use_dbus
2458
self.gnutls_priority = gnutls_priority
2459
IPv6_TCPServer.__init__(self, server_address,
2460
RequestHandlerClass,
2461
interface = interface,
2462
use_ipv6 = use_ipv6,
2463
socketfd = socketfd)
570
return super(IPv6_TCPServer, self).server_bind()
2465
571
def server_activate(self):
2466
572
if self.enabled:
2467
return socketserver.TCPServer.server_activate(self)
573
return super(IPv6_TCPServer, self).server_activate()
2469
574
def enable(self):
2470
575
self.enabled = True
2472
def add_pipe(self, parent_pipe, proc):
2473
# Call "handle_ipc" for both data and EOF events
2474
gobject.io_add_watch(
2475
parent_pipe.fileno(),
2476
gobject.IO_IN | gobject.IO_HUP,
2477
functools.partial(self.handle_ipc,
2478
parent_pipe = parent_pipe,
2481
def handle_ipc(self, source, condition,
2484
client_object=None):
2485
# error, or the other end of multiprocessing.Pipe has closed
2486
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2487
# Wait for other process to exit
2491
# Read a request from the child
2492
request = parent_pipe.recv()
2493
command = request[0]
2495
if command == 'init':
2497
address = request[2]
2499
for c in self.clients.itervalues():
2500
if c.fingerprint == fpr:
2504
logger.info("Client not found for fingerprint: %s, ad"
2505
"dress: %s", fpr, address)
2508
mandos_dbus_service.ClientNotFound(fpr,
2510
parent_pipe.send(False)
2513
gobject.io_add_watch(
2514
parent_pipe.fileno(),
2515
gobject.IO_IN | gobject.IO_HUP,
2516
functools.partial(self.handle_ipc,
2517
parent_pipe = parent_pipe,
2519
client_object = client))
2520
parent_pipe.send(True)
2521
# remove the old hook in favor of the new above hook on
2524
if command == 'funcall':
2525
funcname = request[1]
2529
parent_pipe.send(('data', getattr(client_object,
2533
if command == 'getattr':
2534
attrname = request[1]
2535
if isinstance(client_object.__getattribute__(attrname),
2536
collections.Callable):
2537
parent_pipe.send(('function', ))
2540
'data', client_object.__getattribute__(attrname)))
2542
if command == 'setattr':
2543
attrname = request[1]
2545
setattr(client_object, attrname, value)
2550
def rfc3339_duration_to_delta(duration):
2551
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2553
>>> rfc3339_duration_to_delta("P7D")
2554
datetime.timedelta(7)
2555
>>> rfc3339_duration_to_delta("PT60S")
2556
datetime.timedelta(0, 60)
2557
>>> rfc3339_duration_to_delta("PT60M")
2558
datetime.timedelta(0, 3600)
2559
>>> rfc3339_duration_to_delta("PT24H")
2560
datetime.timedelta(1)
2561
>>> rfc3339_duration_to_delta("P1W")
2562
datetime.timedelta(7)
2563
>>> rfc3339_duration_to_delta("PT5M30S")
2564
datetime.timedelta(0, 330)
2565
>>> rfc3339_duration_to_delta("P1DT3M20S")
2566
datetime.timedelta(1, 200)
2569
# Parsing an RFC 3339 duration with regular expressions is not
2570
# possible - there would have to be multiple places for the same
2571
# values, like seconds. The current code, while more esoteric, is
2572
# cleaner without depending on a parsing library. If Python had a
2573
# built-in library for parsing we would use it, but we'd like to
2574
# avoid excessive use of external libraries.
2576
# New type for defining tokens, syntax, and semantics all-in-one
2577
Token = collections.namedtuple("Token", (
2578
"regexp", # To match token; if "value" is not None, must have
2579
# a "group" containing digits
2580
"value", # datetime.timedelta or None
2581
"followers")) # Tokens valid after this token
2582
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2583
# the "duration" ABNF definition in RFC 3339, Appendix A.
2584
token_end = Token(re.compile(r"$"), None, frozenset())
2585
token_second = Token(re.compile(r"(\d+)S"),
2586
datetime.timedelta(seconds=1),
2587
frozenset((token_end, )))
2588
token_minute = Token(re.compile(r"(\d+)M"),
2589
datetime.timedelta(minutes=1),
2590
frozenset((token_second, token_end)))
2591
token_hour = Token(re.compile(r"(\d+)H"),
2592
datetime.timedelta(hours=1),
2593
frozenset((token_minute, token_end)))
2594
token_time = Token(re.compile(r"T"),
2596
frozenset((token_hour, token_minute,
2598
token_day = Token(re.compile(r"(\d+)D"),
2599
datetime.timedelta(days=1),
2600
frozenset((token_time, token_end)))
2601
token_month = Token(re.compile(r"(\d+)M"),
2602
datetime.timedelta(weeks=4),
2603
frozenset((token_day, token_end)))
2604
token_year = Token(re.compile(r"(\d+)Y"),
2605
datetime.timedelta(weeks=52),
2606
frozenset((token_month, token_end)))
2607
token_week = Token(re.compile(r"(\d+)W"),
2608
datetime.timedelta(weeks=1),
2609
frozenset((token_end, )))
2610
token_duration = Token(re.compile(r"P"), None,
2611
frozenset((token_year, token_month,
2612
token_day, token_time,
2614
# Define starting values
2615
value = datetime.timedelta() # Value so far
2617
followers = frozenset((token_duration, )) # Following valid tokens
2618
s = duration # String left to parse
2619
# Loop until end token is found
2620
while found_token is not token_end:
2621
# Search for any currently valid tokens
2622
for token in followers:
2623
match = token.regexp.match(s)
2624
if match is not None:
2626
if token.value is not None:
2627
# Value found, parse digits
2628
factor = int(match.group(1), 10)
2629
# Add to value so far
2630
value += factor * token.value
2631
# Strip token from string
2632
s = token.regexp.sub("", s, 1)
2635
# Set valid next tokens
2636
followers = found_token.followers
2639
# No currently valid tokens were found
2640
raise ValueError("Invalid RFC 3339 duration: {!r}"
2646
578
def string_to_delta(interval):
2647
579
"""Parse a string and return a datetime.timedelta
2649
581
>>> string_to_delta('7d')
2650
582
datetime.timedelta(7)
2651
583
>>> string_to_delta('60s')
2777
718
"debug": "False",
2779
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2780
":+SIGN-DSA-SHA256",
720
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2781
721
"servicename": "Mandos",
2787
"statedir": "/var/lib/mandos",
2788
"foreground": "False",
2792
724
# Parse config file for server-global settings
2793
server_config = configparser.SafeConfigParser(server_defaults)
725
server_config = ConfigParser.SafeConfigParser(server_defaults)
2794
726
del server_defaults
2795
727
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2796
728
# Convert the SafeConfigParser object to a dict
2797
729
server_settings = server_config.defaults()
2798
# Use the appropriate methods on the non-string config options
2799
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2800
server_settings[option] = server_config.getboolean("DEFAULT",
2802
if server_settings["port"]:
2803
server_settings["port"] = server_config.getint("DEFAULT",
2805
if server_settings["socket"]:
2806
server_settings["socket"] = server_config.getint("DEFAULT",
2808
# Later, stdin will, and stdout and stderr might, be dup'ed
2809
# over with an opened os.devnull. But we don't want this to
2810
# happen with a supplied network socket.
2811
if 0 <= server_settings["socket"] <= 2:
2812
server_settings["socket"] = os.dup(server_settings
730
# Use getboolean on the boolean config option
731
server_settings["debug"] = server_config.getboolean\
2814
733
del server_config
2816
735
# Override the settings from the config file with command line
2817
736
# options, if set.
2818
737
for option in ("interface", "address", "port", "debug",
2819
"priority", "servicename", "configdir", "use_dbus",
2820
"use_ipv6", "debuglevel", "restore", "statedir",
2821
"socket", "foreground", "zeroconf"):
738
"priority", "servicename", "configdir"):
2822
739
value = getattr(options, option)
2823
740
if value is not None:
2824
741
server_settings[option] = value
2826
# Force all strings to be unicode
2827
for option in server_settings.keys():
2828
if isinstance(server_settings[option], bytes):
2829
server_settings[option] = (server_settings[option]
2831
# Force all boolean options to be boolean
2832
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2833
"foreground", "zeroconf"):
2834
server_settings[option] = bool(server_settings[option])
2835
# Debug implies foreground
2836
if server_settings["debug"]:
2837
server_settings["foreground"] = True
2838
743
# Now we have our good server settings in "server_settings"
2840
##################################################################
2842
if (not server_settings["zeroconf"]
2843
and not (server_settings["port"]
2844
or server_settings["socket"] != "")):
2845
parser.error("Needs port or socket to work without Zeroconf")
2848
745
debug = server_settings["debug"]
2849
debuglevel = server_settings["debuglevel"]
2850
use_dbus = server_settings["use_dbus"]
2851
use_ipv6 = server_settings["use_ipv6"]
2852
stored_state_path = os.path.join(server_settings["statedir"],
2854
foreground = server_settings["foreground"]
2855
zeroconf = server_settings["zeroconf"]
2858
initlogger(debug, logging.DEBUG)
2863
level = getattr(logging, debuglevel.upper())
2864
initlogger(debug, level)
748
syslogger.setLevel(logging.WARNING)
749
console.setLevel(logging.WARNING)
2866
751
if server_settings["servicename"] != "Mandos":
2867
syslogger.setFormatter(
2868
logging.Formatter('Mandos ({}) [%(process)d]:'
2869
' %(levelname)s: %(message)s'.format(
2870
server_settings["servicename"])))
752
syslogger.setFormatter(logging.Formatter\
753
('Mandos (%s): %%(levelname)s:'
755
% server_settings["servicename"]))
2872
757
# Parse config file with clients
2873
client_config = configparser.SafeConfigParser(Client
758
client_defaults = { "timeout": "1h",
760
"checker": "fping -q -- %(host)s",
763
client_config = ConfigParser.SafeConfigParser(client_defaults)
2875
764
client_config.read(os.path.join(server_settings["configdir"],
2876
765
"clients.conf"))
2878
global mandos_dbus_service
2879
mandos_dbus_service = None
2882
if server_settings["socket"] != "":
2883
socketfd = server_settings["socket"]
2884
tcp_server = MandosServer(
2885
(server_settings["address"], server_settings["port"]),
2887
interface=(server_settings["interface"] or None),
2889
gnutls_priority=server_settings["priority"],
2893
pidfilename = "/run/mandos.pid"
2894
if not os.path.isdir("/run/."):
2895
pidfilename = "/var/run/mandos.pid"
2898
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2899
except IOError as e:
2900
logger.error("Could not open file %r", pidfilename,
2903
for name in ("_mandos", "mandos", "nobody"):
2905
uid = pwd.getpwnam(name).pw_uid
2906
gid = pwd.getpwnam(name).pw_gid
768
tcp_server = IPv6_TCPServer((server_settings["address"],
769
server_settings["port"]),
771
settings=server_settings,
773
pidfilename = "/var/run/mandos.pid"
775
pidfile = open(pidfilename, "w")
776
except IOError, error:
777
logger.error("Could not open file %r", pidfilename)
782
uid = pwd.getpwnam("mandos").pw_uid
785
uid = pwd.getpwnam("nobody").pw_uid
789
gid = pwd.getpwnam("mandos").pw_gid
792
gid = pwd.getpwnam("nogroup").pw_gid
2916
except OSError as error:
2917
if error.errno != errno.EPERM:
2921
# Enable all possible GnuTLS debugging
2923
# "Use a log level over 10 to enable all debugging options."
2925
gnutls.global_set_log_level(11)
2928
def debug_gnutls(level, string):
2929
logger.debug("GnuTLS: %s", string[:-1])
2931
gnutls.global_set_log_function(debug_gnutls)
2933
# Redirect stdin so all checkers get /dev/null
2934
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2935
os.dup2(null, sys.stdin.fileno())
2939
# Need to fork before connecting to D-Bus
2941
# Close all input and output, do double fork, etc.
2944
# multiprocessing will use threads, so before we use gobject we
2945
# need to inform gobject that threads will be used.
2946
gobject.threads_init()
798
except OSError, error:
799
if error[0] != errno.EPERM:
803
service = AvahiService(name = server_settings["servicename"],
804
servicetype = "_mandos._tcp", )
805
if server_settings["interface"]:
806
service.interface = if_nametoindex\
807
(server_settings["interface"])
2948
809
global main_loop
2949
812
# From the Avahi example code
2950
DBusGMainLoop(set_as_default=True)
813
DBusGMainLoop(set_as_default=True )
2951
814
main_loop = gobject.MainLoop()
2952
815
bus = dbus.SystemBus()
816
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
817
avahi.DBUS_PATH_SERVER),
818
avahi.DBUS_INTERFACE_SERVER)
2953
819
# End of Avahi example code
2956
bus_name = dbus.service.BusName("se.recompile.Mandos",
2959
old_bus_name = dbus.service.BusName(
2960
"se.bsnet.fukt.Mandos", bus,
2962
except dbus.exceptions.DBusException as e:
2963
logger.error("Disabling D-Bus:", exc_info=e)
2965
server_settings["use_dbus"] = False
2966
tcp_server.use_dbus = False
2968
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2969
service = AvahiServiceToSyslog(
2970
name = server_settings["servicename"],
2971
servicetype = "_mandos._tcp",
2972
protocol = protocol,
2974
if server_settings["interface"]:
2975
service.interface = if_nametoindex(
2976
server_settings["interface"].encode("utf-8"))
2978
global multiprocessing_manager
2979
multiprocessing_manager = multiprocessing.Manager()
2981
client_class = Client
2983
client_class = functools.partial(ClientDBus, bus = bus)
2985
client_settings = Client.config_parser(client_config)
2986
old_client_settings = {}
2989
# This is used to redirect stdout and stderr for checker processes
2991
wnull = open(os.devnull, "w") # A writable /dev/null
2992
# Only used if server is running in foreground but not in debug
2994
if debug or not foreground:
2997
# Get client data and settings from last running state.
2998
if server_settings["restore"]:
3000
with open(stored_state_path, "rb") as stored_state:
3001
clients_data, old_client_settings = pickle.load(
3003
os.remove(stored_state_path)
3004
except IOError as e:
3005
if e.errno == errno.ENOENT:
3006
logger.warning("Could not load persistent state:"
3007
" {}".format(os.strerror(e.errno)))
3009
logger.critical("Could not load persistent state:",
3012
except EOFError as e:
3013
logger.warning("Could not load persistent state: "
3017
with PGPEngine() as pgp:
3018
for client_name, client in clients_data.items():
3019
# Skip removed clients
3020
if client_name not in client_settings:
3023
# Decide which value to use after restoring saved state.
3024
# We have three different values: Old config file,
3025
# new config file, and saved state.
3026
# New config value takes precedence if it differs from old
3027
# config value, otherwise use saved state.
3028
for name, value in client_settings[client_name].items():
3030
# For each value in new config, check if it
3031
# differs from the old config value (Except for
3032
# the "secret" attribute)
3033
if (name != "secret"
3035
old_client_settings[client_name][name])):
3036
client[name] = value
3040
# Clients who has passed its expire date can still be
3041
# enabled if its last checker was successful. A Client
3042
# whose checker succeeded before we stored its state is
3043
# assumed to have successfully run all checkers during
3045
if client["enabled"]:
3046
if datetime.datetime.utcnow() >= client["expires"]:
3047
if not client["last_checked_ok"]:
3049
"disabling client {} - Client never "
3050
"performed a successful checker".format(
3052
client["enabled"] = False
3053
elif client["last_checker_status"] != 0:
3055
"disabling client {} - Client last"
3056
" checker failed with error code"
3059
client["last_checker_status"]))
3060
client["enabled"] = False
3062
client["expires"] = (
3063
datetime.datetime.utcnow()
3064
+ client["timeout"])
3065
logger.debug("Last checker succeeded,"
3066
" keeping {} enabled".format(
3069
client["secret"] = pgp.decrypt(
3070
client["encrypted_secret"],
3071
client_settings[client_name]["secret"])
3073
# If decryption fails, we use secret from new settings
3074
logger.debug("Failed to decrypt {} old secret".format(
3076
client["secret"] = (client_settings[client_name]
3079
# Add/remove clients based on new changes made to config
3080
for client_name in (set(old_client_settings)
3081
- set(client_settings)):
3082
del clients_data[client_name]
3083
for client_name in (set(client_settings)
3084
- set(old_client_settings)):
3085
clients_data[client_name] = client_settings[client_name]
3087
# Create all client objects
3088
for client_name, client in clients_data.items():
3089
tcp_server.clients[client_name] = client_class(
3092
server_settings = server_settings)
3094
if not tcp_server.clients:
3095
logger.warning("No clients defined")
3098
if pidfile is not None:
3102
print(pid, file=pidfile)
3104
logger.error("Could not write to file %r with PID %d",
821
def remove_from_clients(client):
822
clients.remove(client)
824
logger.critical(u"No clients left, exiting")
827
clients.update(Set(Client(name = section,
828
stop_hook = remove_from_clients,
830
= dict(client_config.items(section)))
831
for section in client_config.sections()))
833
logger.critical(u"No clients defined")
837
# Redirect stdin so all checkers get /dev/null
838
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
839
os.dup2(null, sys.stdin.fileno())
844
logger.removeHandler(console)
845
# Close all input and output, do double fork, etc.
850
pidfile.write(str(pid) + "\n")
3109
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
3110
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3114
@alternate_dbus_interfaces(
3115
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3116
class MandosDBusService(DBusObjectWithObjectManager):
3117
"""A D-Bus proxy object"""
3120
dbus.service.Object.__init__(self, bus, "/")
3122
_interface = "se.recompile.Mandos"
3124
@dbus.service.signal(_interface, signature="o")
3125
def ClientAdded(self, objpath):
3129
@dbus.service.signal(_interface, signature="ss")
3130
def ClientNotFound(self, fingerprint, address):
3134
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3136
@dbus.service.signal(_interface, signature="os")
3137
def ClientRemoved(self, objpath, name):
3141
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3143
@dbus.service.method(_interface, out_signature="ao")
3144
def GetAllClients(self):
3146
return dbus.Array(c.dbus_object_path for c in
3147
tcp_server.clients.itervalues())
3149
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3151
@dbus.service.method(_interface,
3152
out_signature="a{oa{sv}}")
3153
def GetAllClientsWithProperties(self):
3155
return dbus.Dictionary(
3156
{ c.dbus_object_path: c.GetAll(
3157
"se.recompile.Mandos.Client")
3158
for c in tcp_server.clients.itervalues() },
3161
@dbus.service.method(_interface, in_signature="o")
3162
def RemoveClient(self, object_path):
3164
for c in tcp_server.clients.itervalues():
3165
if c.dbus_object_path == object_path:
3166
del tcp_server.clients[c.name]
3167
c.remove_from_connection()
3168
# Don't signal the disabling
3169
c.disable(quiet=True)
3170
# Emit D-Bus signal for removal
3171
self.client_removed_signal(c)
3173
raise KeyError(object_path)
3177
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3178
out_signature = "a{oa{sa{sv}}}")
3179
def GetManagedObjects(self):
3181
return dbus.Dictionary(
3182
{ client.dbus_object_path:
3184
{ interface: client.GetAll(interface)
3186
client._get_all_interface_names()})
3187
for client in tcp_server.clients.values()})
3189
def client_added_signal(self, client):
3190
"""Send the new standard signal and the old signal"""
3192
# New standard signal
3193
self.InterfacesAdded(
3194
client.dbus_object_path,
3196
{ interface: client.GetAll(interface)
3198
client._get_all_interface_names()}))
3200
self.ClientAdded(client.dbus_object_path)
3202
def client_removed_signal(self, client):
3203
"""Send the new standard signal and the old signal"""
3205
# New standard signal
3206
self.InterfacesRemoved(
3207
client.dbus_object_path,
3208
client._get_all_interface_names())
3210
self.ClientRemoved(client.dbus_object_path,
3213
mandos_dbus_service = MandosDBusService()
854
logger.error(u"Could not write to file %r with PID %d",
857
# "pidfile" was never created
3216
862
"Cleanup function; run on exit"
3220
multiprocessing.active_children()
3222
if not (tcp_server.clients or client_settings):
3225
# Store client before exiting. Secrets are encrypted with key
3226
# based on what config file has. If config file is
3227
# removed/edited, old secret will thus be unrecovable.
3229
with PGPEngine() as pgp:
3230
for client in tcp_server.clients.itervalues():
3231
key = client_settings[client.name]["secret"]
3232
client.encrypted_secret = pgp.encrypt(client.secret,
3236
# A list of attributes that can not be pickled
3238
exclude = { "bus", "changedstate", "secret",
3239
"checker", "server_settings" }
3240
for name, typ in inspect.getmembers(dbus.service
3244
client_dict["encrypted_secret"] = (client
3246
for attr in client.client_structure:
3247
if attr not in exclude:
3248
client_dict[attr] = getattr(client, attr)
3250
clients[client.name] = client_dict
3251
del client_settings[client.name]["secret"]
3254
with tempfile.NamedTemporaryFile(
3258
dir=os.path.dirname(stored_state_path),
3259
delete=False) as stored_state:
3260
pickle.dump((clients, client_settings), stored_state)
3261
tempname = stored_state.name
3262
os.rename(tempname, stored_state_path)
3263
except (IOError, OSError) as e:
3269
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3270
logger.warning("Could not save persistent state: {}"
3271
.format(os.strerror(e.errno)))
3273
logger.warning("Could not save persistent state:",
3277
# Delete all clients, and settings from config
3278
while tcp_server.clients:
3279
name, client = tcp_server.clients.popitem()
3281
client.remove_from_connection()
3282
# Don't signal the disabling
3283
client.disable(quiet=True)
3284
# Emit D-Bus signal for removal
3286
mandos_dbus_service.client_removed_signal(client)
3287
client_settings.clear()
864
# From the Avahi example code
865
if not group is None:
868
# End of Avahi example code
871
client = clients.pop()
872
client.stop_hook = None
3289
875
atexit.register(cleanup)
3291
for client in tcp_server.clients.itervalues():
3293
# Emit D-Bus signal for adding
3294
mandos_dbus_service.client_added_signal(client)
3295
# Need to initiate checking of clients
3297
client.init_checker()
878
signal.signal(signal.SIGINT, signal.SIG_IGN)
879
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
880
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
882
for client in clients:
3299
885
tcp_server.enable()
3300
886
tcp_server.server_activate()
3302
888
# Find out what port we got
3304
service.port = tcp_server.socket.getsockname()[1]
3306
logger.info("Now listening on address %r, port %d,"
3307
" flowinfo %d, scope_id %d",
3308
*tcp_server.socket.getsockname())
3310
logger.info("Now listening on address %r, port %d",
3311
*tcp_server.socket.getsockname())
889
service.port = tcp_server.socket.getsockname()[1]
890
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
891
u" scope_id %d" % tcp_server.socket.getsockname())
3313
893
#service.interface = tcp_server.socket.getsockname()[3]
3317
# From the Avahi example code
3320
except dbus.exceptions.DBusException as error:
3321
logger.critical("D-Bus Exception", exc_info=error)
3324
# End of Avahi example code
896
# From the Avahi example code
897
server.connect_to_signal("StateChanged", server_state_changed)
899
server_state_changed(server.GetState())
900
except dbus.exceptions.DBusException, error:
901
logger.critical(u"DBusException: %s", error)
903
# End of Avahi example code
3326
905
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3327
906
lambda *args, **kwargs:
3328
(tcp_server.handle_request
3329
(*args[2:], **kwargs) or True))
907
tcp_server.handle_request\
908
(*args[2:], **kwargs) or True)
3331
logger.debug("Starting main loop")
910
logger.debug(u"Starting main loop")
3333
except AvahiError as error:
3334
logger.critical("Avahi Error", exc_info=error)
912
except AvahiError, error:
913
logger.critical(u"AvahiError: %s" + unicode(error))
3337
915
except KeyboardInterrupt:
3339
print("", file=sys.stderr)
3340
logger.debug("Server received KeyboardInterrupt")
3341
logger.debug("Server exiting")
3342
# Must run before the D-Bus bus name gets deregistered
3346
919
if __name__ == '__main__':