312
104
max_renames: integer; maximum number of renames
313
105
rename_count: integer; counter so we only rename after collisions
314
106
a sensible number of times
315
group: D-Bus Entry Group
317
bus: dbus.SystemBus()
321
interface = avahi.IF_UNSPEC,
329
protocol = avahi.PROTO_UNSPEC,
108
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
109
type = None, port = None, TXT = None, domain = "",
110
host = "", max_renames = 32768):
331
111
self.interface = interface
333
self.type = servicetype
335
self.TXT = TXT if TXT is not None else []
336
119
self.domain = domain
338
121
self.rename_count = 0
339
122
self.max_renames = max_renames
340
self.protocol = protocol
341
self.group = None # our entry group
344
self.entry_group_state_changed_match = None
346
def rename(self, remove=True):
347
124
"""Derived from the Avahi example code"""
348
125
if self.rename_count >= self.max_renames:
349
logger.critical("No suitable Zeroconf service name found"
350
" after %i retries, exiting.",
126
logger.critical(u"No suitable service name found after %i"
127
u" retries, exiting.", rename_count)
352
128
raise AvahiServiceError("Too many renames")
354
self.server.GetAlternativeServiceName(self.name))
129
self.name = server.GetAlternativeServiceName(self.name)
130
logger.info(u"Changing name to %r ...", str(self.name))
131
syslogger.setFormatter(logging.Formatter\
132
('Mandos (%s): %%(levelname)s:'
133
' %%(message)s' % self.name))
355
136
self.rename_count += 1
356
logger.info("Changing Zeroconf service name to %r ...",
362
except dbus.exceptions.DBusException as error:
363
if (error.get_dbus_name()
364
== "org.freedesktop.Avahi.CollisionError"):
365
logger.info("Local Zeroconf service name collision.")
366
return self.rename(remove=False)
368
logger.critical("D-Bus Exception", exc_info=error)
372
137
def remove(self):
373
138
"""Derived from the Avahi example code"""
374
if self.entry_group_state_changed_match is not None:
375
self.entry_group_state_changed_match.remove()
376
self.entry_group_state_changed_match = None
377
if self.group is not None:
139
if group is not None:
381
142
"""Derived from the Avahi example code"""
383
if self.group is None:
384
self.group = dbus.Interface(
385
self.bus.get_object(avahi.DBUS_NAME,
386
self.server.EntryGroupNew()),
387
avahi.DBUS_INTERFACE_ENTRY_GROUP)
388
self.entry_group_state_changed_match = (
389
self.group.connect_to_signal(
390
'StateChanged', self.entry_group_state_changed))
391
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
392
self.name, self.type)
393
self.group.AddService(
396
dbus.UInt32(0), # flags
397
self.name, self.type,
398
self.domain, self.host,
399
dbus.UInt16(self.port),
400
avahi.string_array_to_txt_array(self.TXT))
403
def entry_group_state_changed(self, state, error):
404
"""Derived from the Avahi example code"""
405
logger.debug("Avahi entry group state change: %i", state)
407
if state == avahi.ENTRY_GROUP_ESTABLISHED:
408
logger.debug("Zeroconf service established.")
409
elif state == avahi.ENTRY_GROUP_COLLISION:
410
logger.info("Zeroconf service name collision.")
412
elif state == avahi.ENTRY_GROUP_FAILURE:
413
logger.critical("Avahi: Error in group state changed %s",
415
raise AvahiGroupError("State changed: {!s}".format(error))
418
"""Derived from the Avahi example code"""
419
if self.group is not None:
422
except (dbus.exceptions.UnknownMethodException,
423
dbus.exceptions.DBusException):
428
def server_state_changed(self, state, error=None):
429
"""Derived from the Avahi example code"""
430
logger.debug("Avahi server state change: %i", state)
432
avahi.SERVER_INVALID: "Zeroconf server invalid",
433
avahi.SERVER_REGISTERING: None,
434
avahi.SERVER_COLLISION: "Zeroconf server name collision",
435
avahi.SERVER_FAILURE: "Zeroconf server failure",
437
if state in bad_states:
438
if bad_states[state] is not None:
440
logger.error(bad_states[state])
442
logger.error(bad_states[state] + ": %r", error)
444
elif state == avahi.SERVER_RUNNING:
447
except dbus.exceptions.DBusException as error:
448
if (error.get_dbus_name()
449
== "org.freedesktop.Avahi.CollisionError"):
450
logger.info("Local Zeroconf service name"
452
return self.rename(remove=False)
454
logger.critical("D-Bus Exception", exc_info=error)
459
logger.debug("Unknown state: %r", state)
461
logger.debug("Unknown state: %r: %r", state, error)
464
"""Derived from the Avahi example code"""
465
if self.server is None:
466
self.server = dbus.Interface(
467
self.bus.get_object(avahi.DBUS_NAME,
468
avahi.DBUS_PATH_SERVER,
469
follow_name_owner_changes=True),
470
avahi.DBUS_INTERFACE_SERVER)
471
self.server.connect_to_signal("StateChanged",
472
self.server_state_changed)
473
self.server_state_changed(self.server.GetState())
476
class AvahiServiceToSyslog(AvahiService):
477
def rename(self, *args, **kwargs):
478
"""Add the new name to the syslog messages"""
479
ret = AvahiService.rename(self, *args, **kwargs)
480
syslogger.setFormatter(logging.Formatter(
481
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
485
# Pretend that we have a GnuTLS module
486
class GnuTLS(object):
487
"""This isn't so much a class as it is a module-like namespace.
488
It is instantiated once, and simulates having a GnuTLS module."""
490
_library = ctypes.cdll.LoadLibrary(
491
ctypes.util.find_library("gnutls"))
492
_need_version = b"3.3.0"
494
# Need to use class name "GnuTLS" here, since this method is
495
# called before the assignment to the "gnutls" global variable
497
if GnuTLS.check_version(self._need_version) is None:
498
raise GnuTLS.Error("Needs GnuTLS {} or later"
499
.format(self._need_version))
501
# Unless otherwise indicated, the constants and types below are
502
# all from the gnutls/gnutls.h C header file.
512
E_NO_CERTIFICATE_FOUND = -49
513
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
516
class session_int(ctypes.Structure):
518
session_t = ctypes.POINTER(session_int)
519
class certificate_credentials_st(ctypes.Structure):
521
certificate_credentials_t = ctypes.POINTER(
522
certificate_credentials_st)
523
certificate_type_t = ctypes.c_int
524
class datum_t(ctypes.Structure):
525
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
526
('size', ctypes.c_uint)]
527
class openpgp_crt_int(ctypes.Structure):
529
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
530
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
531
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
532
credentials_type_t = ctypes.c_int
533
transport_ptr_t = ctypes.c_void_p
534
close_request_t = ctypes.c_int
537
class Error(Exception):
538
# We need to use the class name "GnuTLS" here, since this
539
# exception might be raised from within GnuTLS.__init__,
540
# which is called before the assignment to the "gnutls"
541
# global variable has happened.
542
def __init__(self, message = None, code = None, args=()):
543
# Default usage is by a message string, but if a return
544
# code is passed, convert it to a string with
547
if message is None and code is not None:
548
message = GnuTLS.strerror(code)
549
return super(GnuTLS.Error, self).__init__(
552
class CertificateSecurityError(Error):
556
class Credentials(object):
558
self._c_object = gnutls.certificate_credentials_t()
559
gnutls.certificate_allocate_credentials(
560
ctypes.byref(self._c_object))
561
self.type = gnutls.CRD_CERTIFICATE
564
gnutls.certificate_free_credentials(self._c_object)
566
class ClientSession(object):
567
def __init__(self, socket, credentials = None):
568
self._c_object = gnutls.session_t()
569
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
570
gnutls.set_default_priority(self._c_object)
571
gnutls.transport_set_ptr(self._c_object, socket.fileno())
572
gnutls.handshake_set_private_extensions(self._c_object,
575
if credentials is None:
576
credentials = gnutls.Credentials()
577
gnutls.credentials_set(self._c_object, credentials.type,
578
ctypes.cast(credentials._c_object,
580
self.credentials = credentials
583
gnutls.deinit(self._c_object)
586
return gnutls.handshake(self._c_object)
588
def send(self, data):
592
data_len -= gnutls.record_send(self._c_object,
597
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
599
# Error handling functions
600
def _error_code(result):
601
"""A function to raise exceptions on errors, suitable
602
for the 'restype' attribute on ctypes functions"""
605
if result == gnutls.E_NO_CERTIFICATE_FOUND:
606
raise gnutls.CertificateSecurityError(code = result)
607
raise gnutls.Error(code = result)
609
def _retry_on_error(result, func, arguments):
610
"""A function to retry on some errors, suitable
611
for the 'errcheck' attribute on ctypes functions"""
613
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
614
return _error_code(result)
615
result = func(*arguments)
618
# Unless otherwise indicated, the function declarations below are
619
# all from the gnutls/gnutls.h C header file.
622
priority_set_direct = _library.gnutls_priority_set_direct
623
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
624
ctypes.POINTER(ctypes.c_char_p)]
625
priority_set_direct.restype = _error_code
627
init = _library.gnutls_init
628
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
629
init.restype = _error_code
631
set_default_priority = _library.gnutls_set_default_priority
632
set_default_priority.argtypes = [session_t]
633
set_default_priority.restype = _error_code
635
record_send = _library.gnutls_record_send
636
record_send.argtypes = [session_t, ctypes.c_void_p,
638
record_send.restype = ctypes.c_ssize_t
639
record_send.errcheck = _retry_on_error
641
certificate_allocate_credentials = (
642
_library.gnutls_certificate_allocate_credentials)
643
certificate_allocate_credentials.argtypes = [
644
ctypes.POINTER(certificate_credentials_t)]
645
certificate_allocate_credentials.restype = _error_code
647
certificate_free_credentials = (
648
_library.gnutls_certificate_free_credentials)
649
certificate_free_credentials.argtypes = [certificate_credentials_t]
650
certificate_free_credentials.restype = None
652
handshake_set_private_extensions = (
653
_library.gnutls_handshake_set_private_extensions)
654
handshake_set_private_extensions.argtypes = [session_t,
656
handshake_set_private_extensions.restype = None
658
credentials_set = _library.gnutls_credentials_set
659
credentials_set.argtypes = [session_t, credentials_type_t,
661
credentials_set.restype = _error_code
663
strerror = _library.gnutls_strerror
664
strerror.argtypes = [ctypes.c_int]
665
strerror.restype = ctypes.c_char_p
667
certificate_type_get = _library.gnutls_certificate_type_get
668
certificate_type_get.argtypes = [session_t]
669
certificate_type_get.restype = _error_code
671
certificate_get_peers = _library.gnutls_certificate_get_peers
672
certificate_get_peers.argtypes = [session_t,
673
ctypes.POINTER(ctypes.c_uint)]
674
certificate_get_peers.restype = ctypes.POINTER(datum_t)
676
global_set_log_level = _library.gnutls_global_set_log_level
677
global_set_log_level.argtypes = [ctypes.c_int]
678
global_set_log_level.restype = None
680
global_set_log_function = _library.gnutls_global_set_log_function
681
global_set_log_function.argtypes = [log_func]
682
global_set_log_function.restype = None
684
deinit = _library.gnutls_deinit
685
deinit.argtypes = [session_t]
686
deinit.restype = None
688
handshake = _library.gnutls_handshake
689
handshake.argtypes = [session_t]
690
handshake.restype = _error_code
691
handshake.errcheck = _retry_on_error
693
transport_set_ptr = _library.gnutls_transport_set_ptr
694
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
695
transport_set_ptr.restype = None
697
bye = _library.gnutls_bye
698
bye.argtypes = [session_t, close_request_t]
699
bye.restype = _error_code
700
bye.errcheck = _retry_on_error
702
check_version = _library.gnutls_check_version
703
check_version.argtypes = [ctypes.c_char_p]
704
check_version.restype = ctypes.c_char_p
706
# All the function declarations below are from gnutls/openpgp.h
708
openpgp_crt_init = _library.gnutls_openpgp_crt_init
709
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
710
openpgp_crt_init.restype = _error_code
712
openpgp_crt_import = _library.gnutls_openpgp_crt_import
713
openpgp_crt_import.argtypes = [openpgp_crt_t,
714
ctypes.POINTER(datum_t),
716
openpgp_crt_import.restype = _error_code
718
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
719
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
720
ctypes.POINTER(ctypes.c_uint)]
721
openpgp_crt_verify_self.restype = _error_code
723
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
724
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
725
openpgp_crt_deinit.restype = None
727
openpgp_crt_get_fingerprint = (
728
_library.gnutls_openpgp_crt_get_fingerprint)
729
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
733
openpgp_crt_get_fingerprint.restype = _error_code
735
# Remove non-public functions
736
del _error_code, _retry_on_error
737
# Create the global "gnutls" object, simulating a module
740
def call_pipe(connection, # : multiprocessing.Connection
741
func, *args, **kwargs):
742
"""This function is meant to be called by multiprocessing.Process
744
This function runs func(*args, **kwargs), and writes the resulting
745
return value on the provided multiprocessing.Connection.
747
connection.send(func(*args, **kwargs))
145
group = dbus.Interface\
146
(bus.get_object(avahi.DBUS_NAME,
147
server.EntryGroupNew()),
148
avahi.DBUS_INTERFACE_ENTRY_GROUP)
149
group.connect_to_signal('StateChanged',
150
entry_group_state_changed)
151
logger.debug(u"Adding service '%s' of type '%s' ...",
152
service.name, service.type)
154
self.interface, # interface
155
avahi.PROTO_INET6, # protocol
156
dbus.UInt32(0), # flags
157
self.name, self.type,
158
self.domain, self.host,
159
dbus.UInt16(self.port),
160
avahi.string_array_to_txt_array(self.TXT))
163
# From the Avahi example code:
164
group = None # our entry group
165
# End of Avahi example code
750
168
class Client(object):
751
169
"""A representation of a client host served by this server.
754
approved: bool(); 'None' if not yet approved/disapproved
755
approval_delay: datetime.timedelta(); Time to wait for approval
756
approval_duration: datetime.timedelta(); Duration of one approval
757
checker: subprocess.Popen(); a running checker process used
758
to see if the client lives.
759
'None' if no process is running.
760
checker_callback_tag: a GObject event source tag, or None
761
checker_command: string; External command which is run to check
762
if client lives. %() expansions are done at
171
name: string; from the config file, used in log messages
172
fingerprint: string (40 or 32 hexadecimal digits); used to
173
uniquely identify the client
174
secret: bytestring; sent verbatim (over TLS) to client
175
host: string; available for use by the checker command
176
created: datetime.datetime(); object creation, not client host
177
last_checked_ok: datetime.datetime() or None if not yet checked OK
178
timeout: datetime.timedelta(); How long from last_checked_ok
179
until this client is invalid
180
interval: datetime.timedelta(); How often to start a new checker
181
stop_hook: If set, called by stop() as stop_hook(self)
182
checker: subprocess.Popen(); a running checker process used
183
to see if the client lives.
184
'None' if no process is running.
185
checker_initiator_tag: a gobject event source tag, or None
186
stop_initiator_tag: - '' -
187
checker_callback_tag: - '' -
188
checker_command: string; External command which is run to check if
189
client lives. %() expansions are done at
763
190
runtime with vars(self) as dict, so that for
764
191
instance %(name)s can be used in the command.
765
checker_initiator_tag: a GObject event source tag, or None
766
created: datetime.datetime(); (UTC) object creation
767
client_structure: Object describing what attributes a client has
768
and is used for storing the client at exit
769
current_checker_command: string; current running checker_command
770
disable_initiator_tag: a GObject event source tag, or None
772
fingerprint: string (40 or 32 hexadecimal digits); used to
773
uniquely identify the client
774
host: string; available for use by the checker command
775
interval: datetime.timedelta(); How often to start a new checker
776
last_approval_request: datetime.datetime(); (UTC) or None
777
last_checked_ok: datetime.datetime(); (UTC) or None
778
last_checker_status: integer between 0 and 255 reflecting exit
779
status of last checker. -1 reflects crashed
780
checker, -2 means no checker completed yet.
781
last_checker_signal: The signal which killed the last checker, if
782
last_checker_status is -1
783
last_enabled: datetime.datetime(); (UTC) or None
784
name: string; from the config file, used in log messages and
786
secret: bytestring; sent verbatim (over TLS) to client
787
timeout: datetime.timedelta(); How long from last_checked_ok
788
until this client is disabled
789
extended_timeout: extra long timeout when secret has been sent
790
runtime_expansions: Allowed attributes for runtime expansion.
791
expires: datetime.datetime(); time (UTC) when a client will be
793
server_settings: The server_settings dict from main()
193
_timeout: Real variable for 'timeout'
194
_interval: Real variable for 'interval'
195
_timeout_milliseconds: Used when calling gobject.timeout_add()
196
_interval_milliseconds: - '' -
796
runtime_expansions = ("approval_delay", "approval_duration",
797
"created", "enabled", "expires",
798
"fingerprint", "host", "interval",
799
"last_approval_request", "last_checked_ok",
800
"last_enabled", "name", "timeout")
803
"extended_timeout": "PT15M",
805
"checker": "fping -q -- %%(host)s",
807
"approval_delay": "PT0S",
808
"approval_duration": "PT1S",
809
"approved_by_default": "True",
814
def config_parser(config):
815
"""Construct a new dict of client settings of this form:
816
{ client_name: {setting_name: value, ...}, ...}
817
with exceptions for any special settings as defined above.
818
NOTE: Must be a pure function. Must return the same result
819
value given the same arguments.
822
for client_name in config.sections():
823
section = dict(config.items(client_name))
824
client = settings[client_name] = {}
826
client["host"] = section["host"]
827
# Reformat values from string types to Python types
828
client["approved_by_default"] = config.getboolean(
829
client_name, "approved_by_default")
830
client["enabled"] = config.getboolean(client_name,
833
# Uppercase and remove spaces from fingerprint for later
834
# comparison purposes with return value from the
835
# fingerprint() function
836
client["fingerprint"] = (section["fingerprint"].upper()
838
if "secret" in section:
839
client["secret"] = codecs.decode(section["secret"]
842
elif "secfile" in section:
843
with open(os.path.expanduser(os.path.expandvars
844
(section["secfile"])),
846
client["secret"] = secfile.read()
848
raise TypeError("No secret or secfile for section {}"
850
client["timeout"] = string_to_delta(section["timeout"])
851
client["extended_timeout"] = string_to_delta(
852
section["extended_timeout"])
853
client["interval"] = string_to_delta(section["interval"])
854
client["approval_delay"] = string_to_delta(
855
section["approval_delay"])
856
client["approval_duration"] = string_to_delta(
857
section["approval_duration"])
858
client["checker_command"] = section["checker"]
859
client["last_approval_request"] = None
860
client["last_checked_ok"] = None
861
client["last_checker_status"] = -2
865
def __init__(self, settings, name = None, server_settings=None):
198
def _set_timeout(self, timeout):
199
"Setter function for 'timeout' attribute"
200
self._timeout = timeout
201
self._timeout_milliseconds = ((self.timeout.days
202
* 24 * 60 * 60 * 1000)
203
+ (self.timeout.seconds * 1000)
204
+ (self.timeout.microseconds
206
timeout = property(lambda self: self._timeout,
209
def _set_interval(self, interval):
210
"Setter function for 'interval' attribute"
211
self._interval = interval
212
self._interval_milliseconds = ((self.interval.days
213
* 24 * 60 * 60 * 1000)
214
+ (self.interval.seconds
216
+ (self.interval.microseconds
218
interval = property(lambda self: self._interval,
221
def __init__(self, name = None, stop_hook=None, config={}):
222
"""Note: the 'checker' key in 'config' sets the
223
'checker_command' attribute and *not* the 'checker'
867
if server_settings is None:
869
self.server_settings = server_settings
870
# adding all client settings
871
for setting, value in settings.items():
872
setattr(self, setting, value)
875
if not hasattr(self, "last_enabled"):
876
self.last_enabled = datetime.datetime.utcnow()
877
if not hasattr(self, "expires"):
878
self.expires = (datetime.datetime.utcnow()
226
logger.debug(u"Creating client %r", self.name)
227
# Uppercase and remove spaces from fingerprint for later
228
# comparison purposes with return value from the fingerprint()
230
self.fingerprint = config["fingerprint"].upper()\
232
logger.debug(u" Fingerprint: %s", self.fingerprint)
233
if "secret" in config:
234
self.secret = config["secret"].decode(u"base64")
235
elif "secfile" in config:
236
sf = open(config["secfile"])
237
self.secret = sf.read()
881
self.last_enabled = None
884
logger.debug("Creating client %r", self.name)
885
logger.debug(" Fingerprint: %s", self.fingerprint)
886
self.created = settings.get("created",
887
datetime.datetime.utcnow())
889
# attributes specific for this server instance
240
raise TypeError(u"No secret or secfile for client %s"
242
self.host = config.get("host", "")
243
self.created = datetime.datetime.now()
244
self.last_checked_ok = None
245
self.timeout = string_to_delta(config["timeout"])
246
self.interval = string_to_delta(config["interval"])
247
self.stop_hook = stop_hook
890
248
self.checker = None
891
249
self.checker_initiator_tag = None
892
self.disable_initiator_tag = None
250
self.stop_initiator_tag = None
893
251
self.checker_callback_tag = None
894
self.current_checker_command = None
896
self.approvals_pending = 0
897
self.changedstate = multiprocessing_manager.Condition(
898
multiprocessing_manager.Lock())
899
self.client_structure = [attr
900
for attr in self.__dict__.keys()
901
if not attr.startswith("_")]
902
self.client_structure.append("client_structure")
904
for name, t in inspect.getmembers(
905
type(self), lambda obj: isinstance(obj, property)):
906
if not name.startswith("_"):
907
self.client_structure.append(name)
909
# Send notice to process children that client state has changed
910
def send_changedstate(self):
911
with self.changedstate:
912
self.changedstate.notify_all()
252
self.check_command = config["checker"]
915
254
"""Start this client's checker and timeout hooks"""
916
if getattr(self, "enabled", False):
919
self.expires = datetime.datetime.utcnow() + self.timeout
921
self.last_enabled = datetime.datetime.utcnow()
923
self.send_changedstate()
925
def disable(self, quiet=True):
926
"""Disable this client."""
927
if not getattr(self, "enabled", False):
930
logger.info("Disabling client %s", self.name)
931
if getattr(self, "disable_initiator_tag", None) is not None:
932
GObject.source_remove(self.disable_initiator_tag)
933
self.disable_initiator_tag = None
935
if getattr(self, "checker_initiator_tag", None) is not None:
936
GObject.source_remove(self.checker_initiator_tag)
937
self.checker_initiator_tag = None
941
self.send_changedstate()
942
# Do not run this again if called by a GObject.timeout_add
948
def init_checker(self):
949
255
# Schedule a new checker to be started an 'interval' from now,
950
256
# and every interval from then on.
951
if self.checker_initiator_tag is not None:
952
GObject.source_remove(self.checker_initiator_tag)
953
self.checker_initiator_tag = GObject.timeout_add(
954
int(self.interval.total_seconds() * 1000),
956
# Schedule a disable() when 'timeout' has passed
957
if self.disable_initiator_tag is not None:
958
GObject.source_remove(self.disable_initiator_tag)
959
self.disable_initiator_tag = GObject.timeout_add(
960
int(self.timeout.total_seconds() * 1000), self.disable)
257
self.checker_initiator_tag = gobject.timeout_add\
258
(self._interval_milliseconds,
961
260
# Also start a new checker *right now*.
962
261
self.start_checker()
964
def checker_callback(self, source, condition, connection,
262
# Schedule a stop() when 'timeout' has passed
263
self.stop_initiator_tag = gobject.timeout_add\
264
(self._timeout_milliseconds,
268
The possibility that a client might be restarted is left open,
269
but not currently used."""
270
# If this client doesn't have a secret, it is already stopped.
271
if hasattr(self, "secret") and self.secret:
272
logger.info(u"Stopping client %s", self.name)
276
if getattr(self, "stop_initiator_tag", False):
277
gobject.source_remove(self.stop_initiator_tag)
278
self.stop_initiator_tag = None
279
if getattr(self, "checker_initiator_tag", False):
280
gobject.source_remove(self.checker_initiator_tag)
281
self.checker_initiator_tag = None
285
# Do not run this again if called by a gobject.timeout_add
288
self.stop_hook = None
290
def checker_callback(self, pid, condition):
966
291
"""The checker has completed, so take appropriate actions."""
292
now = datetime.datetime.now()
967
293
self.checker_callback_tag = None
968
294
self.checker = None
969
# Read return code from connection (see call_pipe)
970
returncode = connection.recv()
974
self.last_checker_status = returncode
975
self.last_checker_signal = None
976
if self.last_checker_status == 0:
977
logger.info("Checker for %(name)s succeeded",
981
logger.info("Checker for %(name)s failed", vars(self))
983
self.last_checker_status = -1
984
self.last_checker_signal = -returncode
985
logger.warning("Checker for %(name)s crashed?",
295
if os.WIFEXITED(condition) \
296
and (os.WEXITSTATUS(condition) == 0):
297
logger.info(u"Checker for %(name)s succeeded",
299
self.last_checked_ok = now
300
gobject.source_remove(self.stop_initiator_tag)
301
self.stop_initiator_tag = gobject.timeout_add\
302
(self._timeout_milliseconds,
304
elif not os.WIFEXITED(condition):
305
logger.warning(u"Checker for %(name)s crashed?",
989
def checked_ok(self):
990
"""Assert that the client has been seen, alive and well."""
991
self.last_checked_ok = datetime.datetime.utcnow()
992
self.last_checker_status = 0
993
self.last_checker_signal = None
996
def bump_timeout(self, timeout=None):
997
"""Bump up the timeout for this client."""
999
timeout = self.timeout
1000
if self.disable_initiator_tag is not None:
1001
GObject.source_remove(self.disable_initiator_tag)
1002
self.disable_initiator_tag = None
1003
if getattr(self, "enabled", False):
1004
self.disable_initiator_tag = GObject.timeout_add(
1005
int(timeout.total_seconds() * 1000), self.disable)
1006
self.expires = datetime.datetime.utcnow() + timeout
1008
def need_approval(self):
1009
self.last_approval_request = datetime.datetime.utcnow()
308
logger.info(u"Checker for %(name)s failed",
1011
310
def start_checker(self):
1012
311
"""Start a new checker subprocess if one is not running.
1014
312
If a checker already exists, leave it running and do
1016
314
# The reason for not killing a running checker is that if we
1017
# did that, and if a checker (for some reason) started running
1018
# slowly and taking more than 'interval' time, then the client
1019
# would inevitably timeout, since no checker would get a
1020
# chance to run to completion. If we instead leave running
315
# did that, then if a checker (for some reason) started
316
# running slowly and taking more than 'interval' time, the
317
# client would inevitably timeout, since no checker would get
318
# a chance to run to completion. If we instead leave running
1021
319
# checkers alone, the checker would have to take more time
1022
# than 'timeout' for the client to be disabled, which is as it
1025
if self.checker is not None and not self.checker.is_alive():
1026
logger.warning("Checker was not alive; joining")
1029
# Start a new checker if needed
320
# than 'timeout' for the client to be declared invalid, which
321
# is as it should be.
1030
322
if self.checker is None:
1031
# Escape attributes for the shell
1033
attr: re.escape(str(getattr(self, attr)))
1034
for attr in self.runtime_expansions }
1036
command = self.checker_command % escaped_attrs
1037
except TypeError as error:
1038
logger.error('Could not format string "%s"',
1039
self.checker_command,
1041
return True # Try again later
1042
self.current_checker_command = command
1043
logger.info("Starting checker %r for %s", command,
1045
# We don't need to redirect stdout and stderr, since
1046
# in normal mode, that is already done by daemon(),
1047
# and in debug mode we don't want to. (Stdin is
1048
# always replaced by /dev/null.)
1049
# The exception is when not debugging but nevertheless
1050
# running in the foreground; use the previously
1052
popen_args = { "close_fds": True,
1055
if (not self.server_settings["debug"]
1056
and self.server_settings["foreground"]):
1057
popen_args.update({"stdout": wnull,
1059
pipe = multiprocessing.Pipe(duplex = False)
1060
self.checker = multiprocessing.Process(
1062
args = (pipe[1], subprocess.call, command),
1063
kwargs = popen_args)
1064
self.checker.start()
1065
self.checker_callback_tag = GObject.io_add_watch(
1066
pipe[0].fileno(), GObject.IO_IN,
1067
self.checker_callback, pipe[0], command)
1068
# Re-run this periodically if run by GObject.timeout_add
324
# In case check_command has exactly one % operator
325
command = self.check_command % self.host
327
# Escape attributes for the shell
328
escaped_attrs = dict((key, re.escape(str(val)))
330
vars(self).iteritems())
332
command = self.check_command % escaped_attrs
333
except TypeError, error:
334
logger.error(u'Could not format string "%s":'
335
u' %s', self.check_command, error)
336
return True # Try again later
338
logger.info(u"Starting checker %r for %s",
340
# We don't need to redirect stdout and stderr, since
341
# in normal mode, that is already done by daemon(),
342
# and in debug mode we don't want to. (Stdin is
343
# always replaced by /dev/null.)
344
self.checker = subprocess.Popen(command,
347
self.checker_callback_tag = gobject.child_watch_add\
349
self.checker_callback)
350
except OSError, error:
351
logger.error(u"Failed to start subprocess: %s",
353
# Re-run this periodically if run by gobject.timeout_add
1071
355
def stop_checker(self):
1072
356
"""Force the checker process, if any, to stop."""
1073
357
if self.checker_callback_tag:
1074
GObject.source_remove(self.checker_callback_tag)
358
gobject.source_remove(self.checker_callback_tag)
1075
359
self.checker_callback_tag = None
1076
360
if getattr(self, "checker", None) is None:
1078
logger.debug("Stopping checker for %(name)s", vars(self))
1079
self.checker.terminate()
362
logger.debug(u"Stopping checker for %(name)s", vars(self))
364
os.kill(self.checker.pid, signal.SIGTERM)
366
#if self.checker.poll() is None:
367
# os.kill(self.checker.pid, signal.SIGKILL)
368
except OSError, error:
369
if error.errno != errno.ESRCH: # No such process
1080
371
self.checker = None
1083
def dbus_service_property(dbus_interface,
1087
"""Decorators for marking methods of a DBusObjectWithProperties to
1088
become properties on the D-Bus.
1090
The decorated method will be called with no arguments by "Get"
1091
and with one argument by "Set".
1093
The parameters, where they are supported, are the same as
1094
dbus.service.method, except there is only "signature", since the
1095
type from Get() and the type sent to Set() is the same.
1097
# Encoding deeply encoded byte arrays is not supported yet by the
1098
# "Set" method, so we fail early here:
1099
if byte_arrays and signature != "ay":
1100
raise ValueError("Byte arrays not supported for non-'ay'"
1101
" signature {!r}".format(signature))
1103
def decorator(func):
1104
func._dbus_is_property = True
1105
func._dbus_interface = dbus_interface
1106
func._dbus_signature = signature
1107
func._dbus_access = access
1108
func._dbus_name = func.__name__
1109
if func._dbus_name.endswith("_dbus_property"):
1110
func._dbus_name = func._dbus_name[:-14]
1111
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1117
def dbus_interface_annotations(dbus_interface):
1118
"""Decorator for marking functions returning interface annotations
1122
@dbus_interface_annotations("org.example.Interface")
1123
def _foo(self): # Function name does not matter
1124
return {"org.freedesktop.DBus.Deprecated": "true",
1125
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1129
def decorator(func):
1130
func._dbus_is_interface = True
1131
func._dbus_interface = dbus_interface
1132
func._dbus_name = dbus_interface
1138
def dbus_annotations(annotations):
1139
"""Decorator to annotate D-Bus methods, signals or properties
1142
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1143
"org.freedesktop.DBus.Property."
1144
"EmitsChangedSignal": "false"})
1145
@dbus_service_property("org.example.Interface", signature="b",
1147
def Property_dbus_property(self):
1148
return dbus.Boolean(False)
1150
See also the DBusObjectWithAnnotations class.
1153
def decorator(func):
1154
func._dbus_annotations = annotations
1160
class DBusPropertyException(dbus.exceptions.DBusException):
1161
"""A base class for D-Bus property-related exceptions
1166
class DBusPropertyAccessException(DBusPropertyException):
1167
"""A property's access permissions disallows an operation.
1172
class DBusPropertyNotFound(DBusPropertyException):
1173
"""An attempt was made to access a non-existing property.
1178
class DBusObjectWithAnnotations(dbus.service.Object):
1179
"""A D-Bus object with annotations.
1181
Classes inheriting from this can use the dbus_annotations
1182
decorator to add annotations to methods or signals.
1186
def _is_dbus_thing(thing):
1187
"""Returns a function testing if an attribute is a D-Bus thing
1189
If called like _is_dbus_thing("method") it returns a function
1190
suitable for use as predicate to inspect.getmembers().
1192
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1195
def _get_all_dbus_things(self, thing):
1196
"""Returns a generator of (name, attribute) pairs
1198
return ((getattr(athing.__get__(self), "_dbus_name", name),
1199
athing.__get__(self))
1200
for cls in self.__class__.__mro__
1202
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1204
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1205
out_signature = "s",
1206
path_keyword = 'object_path',
1207
connection_keyword = 'connection')
1208
def Introspect(self, object_path, connection):
1209
"""Overloading of standard D-Bus method.
1211
Inserts annotation tags on methods and signals.
1213
xmlstring = dbus.service.Object.Introspect(self, object_path,
1216
document = xml.dom.minidom.parseString(xmlstring)
1218
for if_tag in document.getElementsByTagName("interface"):
1219
# Add annotation tags
1220
for typ in ("method", "signal"):
1221
for tag in if_tag.getElementsByTagName(typ):
1223
for name, prop in (self.
1224
_get_all_dbus_things(typ)):
1225
if (name == tag.getAttribute("name")
1226
and prop._dbus_interface
1227
== if_tag.getAttribute("name")):
1228
annots.update(getattr(
1229
prop, "_dbus_annotations", {}))
1230
for name, value in annots.items():
1231
ann_tag = document.createElement(
1233
ann_tag.setAttribute("name", name)
1234
ann_tag.setAttribute("value", value)
1235
tag.appendChild(ann_tag)
1236
# Add interface annotation tags
1237
for annotation, value in dict(
1238
itertools.chain.from_iterable(
1239
annotations().items()
1240
for name, annotations
1241
in self._get_all_dbus_things("interface")
1242
if name == if_tag.getAttribute("name")
1244
ann_tag = document.createElement("annotation")
1245
ann_tag.setAttribute("name", annotation)
1246
ann_tag.setAttribute("value", value)
1247
if_tag.appendChild(ann_tag)
1248
# Fix argument name for the Introspect method itself
1249
if (if_tag.getAttribute("name")
1250
== dbus.INTROSPECTABLE_IFACE):
1251
for cn in if_tag.getElementsByTagName("method"):
1252
if cn.getAttribute("name") == "Introspect":
1253
for arg in cn.getElementsByTagName("arg"):
1254
if (arg.getAttribute("direction")
1256
arg.setAttribute("name",
1258
xmlstring = document.toxml("utf-8")
1260
except (AttributeError, xml.dom.DOMException,
1261
xml.parsers.expat.ExpatError) as error:
1262
logger.error("Failed to override Introspection method",
1267
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1268
"""A D-Bus object with properties.
1270
Classes inheriting from this can use the dbus_service_property
1271
decorator to expose methods as D-Bus properties. It exposes the
1272
standard Get(), Set(), and GetAll() methods on the D-Bus.
1275
def _get_dbus_property(self, interface_name, property_name):
1276
"""Returns a bound method if one exists which is a D-Bus
1277
property with the specified name and interface.
1279
for cls in self.__class__.__mro__:
1280
for name, value in inspect.getmembers(
1281
cls, self._is_dbus_thing("property")):
1282
if (value._dbus_name == property_name
1283
and value._dbus_interface == interface_name):
1284
return value.__get__(self)
1287
raise DBusPropertyNotFound("{}:{}.{}".format(
1288
self.dbus_object_path, interface_name, property_name))
1291
def _get_all_interface_names(cls):
1292
"""Get a sequence of all interfaces supported by an object"""
1293
return (name for name in set(getattr(getattr(x, attr),
1294
"_dbus_interface", None)
1295
for x in (inspect.getmro(cls))
1297
if name is not None)
1299
@dbus.service.method(dbus.PROPERTIES_IFACE,
1302
def Get(self, interface_name, property_name):
1303
"""Standard D-Bus property Get() method, see D-Bus standard.
1305
prop = self._get_dbus_property(interface_name, property_name)
1306
if prop._dbus_access == "write":
1307
raise DBusPropertyAccessException(property_name)
1309
if not hasattr(value, "variant_level"):
1311
return type(value)(value, variant_level=value.variant_level+1)
1313
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1314
def Set(self, interface_name, property_name, value):
1315
"""Standard D-Bus property Set() method, see D-Bus standard.
1317
prop = self._get_dbus_property(interface_name, property_name)
1318
if prop._dbus_access == "read":
1319
raise DBusPropertyAccessException(property_name)
1320
if prop._dbus_get_args_options["byte_arrays"]:
1321
# The byte_arrays option is not supported yet on
1322
# signatures other than "ay".
1323
if prop._dbus_signature != "ay":
1324
raise ValueError("Byte arrays not supported for non-"
1325
"'ay' signature {!r}"
1326
.format(prop._dbus_signature))
1327
value = dbus.ByteArray(b''.join(chr(byte)
1331
@dbus.service.method(dbus.PROPERTIES_IFACE,
1333
out_signature="a{sv}")
1334
def GetAll(self, interface_name):
1335
"""Standard D-Bus property GetAll() method, see D-Bus
1338
Note: Will not include properties with access="write".
1341
for name, prop in self._get_all_dbus_things("property"):
1343
and interface_name != prop._dbus_interface):
1344
# Interface non-empty but did not match
1346
# Ignore write-only properties
1347
if prop._dbus_access == "write":
1350
if not hasattr(value, "variant_level"):
1351
properties[name] = value
1353
properties[name] = type(value)(
1354
value, variant_level = value.variant_level + 1)
1355
return dbus.Dictionary(properties, signature="sv")
1357
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1358
def PropertiesChanged(self, interface_name, changed_properties,
1359
invalidated_properties):
1360
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1365
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1367
path_keyword='object_path',
1368
connection_keyword='connection')
1369
def Introspect(self, object_path, connection):
1370
"""Overloading of standard D-Bus method.
1372
Inserts property tags and interface annotation tags.
1374
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1378
document = xml.dom.minidom.parseString(xmlstring)
1380
def make_tag(document, name, prop):
1381
e = document.createElement("property")
1382
e.setAttribute("name", name)
1383
e.setAttribute("type", prop._dbus_signature)
1384
e.setAttribute("access", prop._dbus_access)
1387
for if_tag in document.getElementsByTagName("interface"):
1389
for tag in (make_tag(document, name, prop)
1391
in self._get_all_dbus_things("property")
1392
if prop._dbus_interface
1393
== if_tag.getAttribute("name")):
1394
if_tag.appendChild(tag)
1395
# Add annotation tags for properties
1396
for tag in if_tag.getElementsByTagName("property"):
1398
for name, prop in self._get_all_dbus_things(
1400
if (name == tag.getAttribute("name")
1401
and prop._dbus_interface
1402
== if_tag.getAttribute("name")):
1403
annots.update(getattr(
1404
prop, "_dbus_annotations", {}))
1405
for name, value in annots.items():
1406
ann_tag = document.createElement(
1408
ann_tag.setAttribute("name", name)
1409
ann_tag.setAttribute("value", value)
1410
tag.appendChild(ann_tag)
1411
# Add the names to the return values for the
1412
# "org.freedesktop.DBus.Properties" methods
1413
if (if_tag.getAttribute("name")
1414
== "org.freedesktop.DBus.Properties"):
1415
for cn in if_tag.getElementsByTagName("method"):
1416
if cn.getAttribute("name") == "Get":
1417
for arg in cn.getElementsByTagName("arg"):
1418
if (arg.getAttribute("direction")
1420
arg.setAttribute("name", "value")
1421
elif cn.getAttribute("name") == "GetAll":
1422
for arg in cn.getElementsByTagName("arg"):
1423
if (arg.getAttribute("direction")
1425
arg.setAttribute("name", "props")
1426
xmlstring = document.toxml("utf-8")
1428
except (AttributeError, xml.dom.DOMException,
1429
xml.parsers.expat.ExpatError) as error:
1430
logger.error("Failed to override Introspection method",
1435
dbus.OBJECT_MANAGER_IFACE
1436
except AttributeError:
1437
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1439
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1440
"""A D-Bus object with an ObjectManager.
1442
Classes inheriting from this exposes the standard
1443
GetManagedObjects call and the InterfacesAdded and
1444
InterfacesRemoved signals on the standard
1445
"org.freedesktop.DBus.ObjectManager" interface.
1447
Note: No signals are sent automatically; they must be sent
1450
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1451
out_signature = "a{oa{sa{sv}}}")
1452
def GetManagedObjects(self):
1453
"""This function must be overridden"""
1454
raise NotImplementedError()
1456
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1457
signature = "oa{sa{sv}}")
1458
def InterfacesAdded(self, object_path, interfaces_and_properties):
1461
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1462
def InterfacesRemoved(self, object_path, interfaces):
1465
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1466
out_signature = "s",
1467
path_keyword = 'object_path',
1468
connection_keyword = 'connection')
1469
def Introspect(self, object_path, connection):
1470
"""Overloading of standard D-Bus method.
1472
Override return argument name of GetManagedObjects to be
1473
"objpath_interfaces_and_properties"
1475
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1479
document = xml.dom.minidom.parseString(xmlstring)
1481
for if_tag in document.getElementsByTagName("interface"):
1482
# Fix argument name for the GetManagedObjects method
1483
if (if_tag.getAttribute("name")
1484
== dbus.OBJECT_MANAGER_IFACE):
1485
for cn in if_tag.getElementsByTagName("method"):
1486
if (cn.getAttribute("name")
1487
== "GetManagedObjects"):
1488
for arg in cn.getElementsByTagName("arg"):
1489
if (arg.getAttribute("direction")
1493
"objpath_interfaces"
1495
xmlstring = document.toxml("utf-8")
1497
except (AttributeError, xml.dom.DOMException,
1498
xml.parsers.expat.ExpatError) as error:
1499
logger.error("Failed to override Introspection method",
1503
def datetime_to_dbus(dt, variant_level=0):
1504
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1506
return dbus.String("", variant_level = variant_level)
1507
return dbus.String(dt.isoformat(), variant_level=variant_level)
1510
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1511
"""A class decorator; applied to a subclass of
1512
dbus.service.Object, it will add alternate D-Bus attributes with
1513
interface names according to the "alt_interface_names" mapping.
1516
@alternate_dbus_interfaces({"org.example.Interface":
1517
"net.example.AlternateInterface"})
1518
class SampleDBusObject(dbus.service.Object):
1519
@dbus.service.method("org.example.Interface")
1520
def SampleDBusMethod():
1523
The above "SampleDBusMethod" on "SampleDBusObject" will be
1524
reachable via two interfaces: "org.example.Interface" and
1525
"net.example.AlternateInterface", the latter of which will have
1526
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1527
"true", unless "deprecate" is passed with a False value.
1529
This works for methods and signals, and also for D-Bus properties
1530
(from DBusObjectWithProperties) and interfaces (from the
1531
dbus_interface_annotations decorator).
1535
for orig_interface_name, alt_interface_name in (
1536
alt_interface_names.items()):
1538
interface_names = set()
1539
# Go though all attributes of the class
1540
for attrname, attribute in inspect.getmembers(cls):
1541
# Ignore non-D-Bus attributes, and D-Bus attributes
1542
# with the wrong interface name
1543
if (not hasattr(attribute, "_dbus_interface")
1544
or not attribute._dbus_interface.startswith(
1545
orig_interface_name)):
1547
# Create an alternate D-Bus interface name based on
1549
alt_interface = attribute._dbus_interface.replace(
1550
orig_interface_name, alt_interface_name)
1551
interface_names.add(alt_interface)
1552
# Is this a D-Bus signal?
1553
if getattr(attribute, "_dbus_is_signal", False):
1554
# Extract the original non-method undecorated
1555
# function by black magic
1556
if sys.version_info.major == 2:
1557
nonmethod_func = (dict(
1558
zip(attribute.func_code.co_freevars,
1559
attribute.__closure__))
1560
["func"].cell_contents)
1562
nonmethod_func = (dict(
1563
zip(attribute.__code__.co_freevars,
1564
attribute.__closure__))
1565
["func"].cell_contents)
1566
# Create a new, but exactly alike, function
1567
# object, and decorate it to be a new D-Bus signal
1568
# with the alternate D-Bus interface name
1569
new_function = copy_function(nonmethod_func)
1570
new_function = (dbus.service.signal(
1572
attribute._dbus_signature)(new_function))
1573
# Copy annotations, if any
1575
new_function._dbus_annotations = dict(
1576
attribute._dbus_annotations)
1577
except AttributeError:
1579
# Define a creator of a function to call both the
1580
# original and alternate functions, so both the
1581
# original and alternate signals gets sent when
1582
# the function is called
1583
def fixscope(func1, func2):
1584
"""This function is a scope container to pass
1585
func1 and func2 to the "call_both" function
1586
outside of its arguments"""
1588
@functools.wraps(func2)
1589
def call_both(*args, **kwargs):
1590
"""This function will emit two D-Bus
1591
signals by calling func1 and func2"""
1592
func1(*args, **kwargs)
1593
func2(*args, **kwargs)
1594
# Make wrapper function look like a D-Bus signal
1595
for name, attr in inspect.getmembers(func2):
1596
if name.startswith("_dbus_"):
1597
setattr(call_both, name, attr)
1600
# Create the "call_both" function and add it to
1602
attr[attrname] = fixscope(attribute, new_function)
1603
# Is this a D-Bus method?
1604
elif getattr(attribute, "_dbus_is_method", False):
1605
# Create a new, but exactly alike, function
1606
# object. Decorate it to be a new D-Bus method
1607
# with the alternate D-Bus interface name. Add it
1610
dbus.service.method(
1612
attribute._dbus_in_signature,
1613
attribute._dbus_out_signature)
1614
(copy_function(attribute)))
1615
# Copy annotations, if any
1617
attr[attrname]._dbus_annotations = dict(
1618
attribute._dbus_annotations)
1619
except AttributeError:
1621
# Is this a D-Bus property?
1622
elif getattr(attribute, "_dbus_is_property", False):
1623
# Create a new, but exactly alike, function
1624
# object, and decorate it to be a new D-Bus
1625
# property with the alternate D-Bus interface
1626
# name. Add it to the class.
1627
attr[attrname] = (dbus_service_property(
1628
alt_interface, attribute._dbus_signature,
1629
attribute._dbus_access,
1630
attribute._dbus_get_args_options
1632
(copy_function(attribute)))
1633
# Copy annotations, if any
1635
attr[attrname]._dbus_annotations = dict(
1636
attribute._dbus_annotations)
1637
except AttributeError:
1639
# Is this a D-Bus interface?
1640
elif getattr(attribute, "_dbus_is_interface", False):
1641
# Create a new, but exactly alike, function
1642
# object. Decorate it to be a new D-Bus interface
1643
# with the alternate D-Bus interface name. Add it
1646
dbus_interface_annotations(alt_interface)
1647
(copy_function(attribute)))
1649
# Deprecate all alternate interfaces
1650
iname="_AlternateDBusNames_interface_annotation{}"
1651
for interface_name in interface_names:
1653
@dbus_interface_annotations(interface_name)
1655
return { "org.freedesktop.DBus.Deprecated":
1657
# Find an unused name
1658
for aname in (iname.format(i)
1659
for i in itertools.count()):
1660
if aname not in attr:
1664
# Replace the class with a new subclass of it with
1665
# methods, signals, etc. as created above.
1666
if sys.version_info.major == 2:
1667
cls = type(b"{}Alternate".format(cls.__name__),
1670
cls = type("{}Alternate".format(cls.__name__),
1677
@alternate_dbus_interfaces({"se.recompile.Mandos":
1678
"se.bsnet.fukt.Mandos"})
1679
class ClientDBus(Client, DBusObjectWithProperties):
1680
"""A Client class using D-Bus
1683
dbus_object_path: dbus.ObjectPath
1684
bus: dbus.SystemBus()
1687
runtime_expansions = (Client.runtime_expansions
1688
+ ("dbus_object_path", ))
1690
_interface = "se.recompile.Mandos.Client"
1692
# dbus.service.Object doesn't use super(), so we can't either.
1694
def __init__(self, bus = None, *args, **kwargs):
1696
Client.__init__(self, *args, **kwargs)
1697
# Only now, when this client is initialized, can it show up on
1699
client_object_name = str(self.name).translate(
1700
{ord("."): ord("_"),
1701
ord("-"): ord("_")})
1702
self.dbus_object_path = dbus.ObjectPath(
1703
"/clients/" + client_object_name)
1704
DBusObjectWithProperties.__init__(self, self.bus,
1705
self.dbus_object_path)
1707
def notifychangeproperty(transform_func, dbus_name,
1708
type_func=lambda x: x,
1710
invalidate_only=False,
1711
_interface=_interface):
1712
""" Modify a variable so that it's a property which announces
1713
its changes to DBus.
1715
transform_fun: Function that takes a value and a variant_level
1716
and transforms it to a D-Bus type.
1717
dbus_name: D-Bus name of the variable
1718
type_func: Function that transform the value before sending it
1719
to the D-Bus. Default: no transform
1720
variant_level: D-Bus variant level. Default: 1
1722
attrname = "_{}".format(dbus_name)
1724
def setter(self, value):
1725
if hasattr(self, "dbus_object_path"):
1726
if (not hasattr(self, attrname) or
1727
type_func(getattr(self, attrname, None))
1728
!= type_func(value)):
1730
self.PropertiesChanged(
1731
_interface, dbus.Dictionary(),
1732
dbus.Array((dbus_name, )))
1734
dbus_value = transform_func(
1736
variant_level = variant_level)
1737
self.PropertyChanged(dbus.String(dbus_name),
1739
self.PropertiesChanged(
1741
dbus.Dictionary({ dbus.String(dbus_name):
1744
setattr(self, attrname, value)
1746
return property(lambda self: getattr(self, attrname), setter)
1748
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1749
approvals_pending = notifychangeproperty(dbus.Boolean,
1752
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1753
last_enabled = notifychangeproperty(datetime_to_dbus,
1755
checker = notifychangeproperty(
1756
dbus.Boolean, "CheckerRunning",
1757
type_func = lambda checker: checker is not None)
1758
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1760
last_checker_status = notifychangeproperty(dbus.Int16,
1761
"LastCheckerStatus")
1762
last_approval_request = notifychangeproperty(
1763
datetime_to_dbus, "LastApprovalRequest")
1764
approved_by_default = notifychangeproperty(dbus.Boolean,
1765
"ApprovedByDefault")
1766
approval_delay = notifychangeproperty(
1767
dbus.UInt64, "ApprovalDelay",
1768
type_func = lambda td: td.total_seconds() * 1000)
1769
approval_duration = notifychangeproperty(
1770
dbus.UInt64, "ApprovalDuration",
1771
type_func = lambda td: td.total_seconds() * 1000)
1772
host = notifychangeproperty(dbus.String, "Host")
1773
timeout = notifychangeproperty(
1774
dbus.UInt64, "Timeout",
1775
type_func = lambda td: td.total_seconds() * 1000)
1776
extended_timeout = notifychangeproperty(
1777
dbus.UInt64, "ExtendedTimeout",
1778
type_func = lambda td: td.total_seconds() * 1000)
1779
interval = notifychangeproperty(
1780
dbus.UInt64, "Interval",
1781
type_func = lambda td: td.total_seconds() * 1000)
1782
checker_command = notifychangeproperty(dbus.String, "Checker")
1783
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1784
invalidate_only=True)
1786
del notifychangeproperty
1788
def __del__(self, *args, **kwargs):
1790
self.remove_from_connection()
1793
if hasattr(DBusObjectWithProperties, "__del__"):
1794
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1795
Client.__del__(self, *args, **kwargs)
1797
def checker_callback(self, source, condition,
1798
connection, command, *args, **kwargs):
1799
ret = Client.checker_callback(self, source, condition,
1800
connection, command, *args,
1802
exitstatus = self.last_checker_status
1805
self.CheckerCompleted(dbus.Int16(exitstatus),
1806
# This is specific to GNU libC
1807
dbus.Int64(exitstatus << 8),
1808
dbus.String(command))
1811
self.CheckerCompleted(dbus.Int16(-1),
1813
# This is specific to GNU libC
1815
| self.last_checker_signal),
1816
dbus.String(command))
1819
def start_checker(self, *args, **kwargs):
1820
old_checker_pid = getattr(self.checker, "pid", None)
1821
r = Client.start_checker(self, *args, **kwargs)
1822
# Only if new checker process was started
1823
if (self.checker is not None
1824
and old_checker_pid != self.checker.pid):
1826
self.CheckerStarted(self.current_checker_command)
1829
def _reset_approved(self):
1830
self.approved = None
1833
def approve(self, value=True):
1834
self.approved = value
1835
GObject.timeout_add(int(self.approval_duration.total_seconds()
1836
* 1000), self._reset_approved)
1837
self.send_changedstate()
1839
## D-Bus methods, signals & properties
1845
# CheckerCompleted - signal
1846
@dbus.service.signal(_interface, signature="nxs")
1847
def CheckerCompleted(self, exitcode, waitstatus, command):
1851
# CheckerStarted - signal
1852
@dbus.service.signal(_interface, signature="s")
1853
def CheckerStarted(self, command):
1857
# PropertyChanged - signal
1858
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1859
@dbus.service.signal(_interface, signature="sv")
1860
def PropertyChanged(self, property, value):
1864
# GotSecret - signal
1865
@dbus.service.signal(_interface)
1866
def GotSecret(self):
1868
Is sent after a successful transfer of secret from the Mandos
1869
server to mandos-client
1874
@dbus.service.signal(_interface, signature="s")
1875
def Rejected(self, reason):
1879
# NeedApproval - signal
1880
@dbus.service.signal(_interface, signature="tb")
1881
def NeedApproval(self, timeout, default):
1883
return self.need_approval()
1888
@dbus.service.method(_interface, in_signature="b")
1889
def Approve(self, value):
1892
# CheckedOK - method
1893
@dbus.service.method(_interface)
1894
def CheckedOK(self):
1898
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1899
@dbus.service.method(_interface)
1904
# StartChecker - method
1905
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1906
@dbus.service.method(_interface)
1907
def StartChecker(self):
1909
self.start_checker()
1912
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1913
@dbus.service.method(_interface)
1918
# StopChecker - method
1919
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1920
@dbus.service.method(_interface)
1921
def StopChecker(self):
1926
# ApprovalPending - property
1927
@dbus_service_property(_interface, signature="b", access="read")
1928
def ApprovalPending_dbus_property(self):
1929
return dbus.Boolean(bool(self.approvals_pending))
1931
# ApprovedByDefault - property
1932
@dbus_service_property(_interface,
1935
def ApprovedByDefault_dbus_property(self, value=None):
1936
if value is None: # get
1937
return dbus.Boolean(self.approved_by_default)
1938
self.approved_by_default = bool(value)
1940
# ApprovalDelay - property
1941
@dbus_service_property(_interface,
1944
def ApprovalDelay_dbus_property(self, value=None):
1945
if value is None: # get
1946
return dbus.UInt64(self.approval_delay.total_seconds()
1948
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1950
# ApprovalDuration - property
1951
@dbus_service_property(_interface,
1954
def ApprovalDuration_dbus_property(self, value=None):
1955
if value is None: # get
1956
return dbus.UInt64(self.approval_duration.total_seconds()
1958
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1962
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1963
@dbus_service_property(_interface, signature="s", access="read")
1964
def Name_dbus_property(self):
1965
return dbus.String(self.name)
1967
# Fingerprint - property
1969
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1970
@dbus_service_property(_interface, signature="s", access="read")
1971
def Fingerprint_dbus_property(self):
1972
return dbus.String(self.fingerprint)
1975
@dbus_service_property(_interface,
1978
def Host_dbus_property(self, value=None):
1979
if value is None: # get
1980
return dbus.String(self.host)
1981
self.host = str(value)
1983
# Created - property
1985
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1986
@dbus_service_property(_interface, signature="s", access="read")
1987
def Created_dbus_property(self):
1988
return datetime_to_dbus(self.created)
1990
# LastEnabled - property
1991
@dbus_service_property(_interface, signature="s", access="read")
1992
def LastEnabled_dbus_property(self):
1993
return datetime_to_dbus(self.last_enabled)
1995
# Enabled - property
1996
@dbus_service_property(_interface,
1999
def Enabled_dbus_property(self, value=None):
2000
if value is None: # get
2001
return dbus.Boolean(self.enabled)
2007
# LastCheckedOK - property
2008
@dbus_service_property(_interface,
2011
def LastCheckedOK_dbus_property(self, value=None):
2012
if value is not None:
2015
return datetime_to_dbus(self.last_checked_ok)
2017
# LastCheckerStatus - property
2018
@dbus_service_property(_interface, signature="n", access="read")
2019
def LastCheckerStatus_dbus_property(self):
2020
return dbus.Int16(self.last_checker_status)
2022
# Expires - property
2023
@dbus_service_property(_interface, signature="s", access="read")
2024
def Expires_dbus_property(self):
2025
return datetime_to_dbus(self.expires)
2027
# LastApprovalRequest - property
2028
@dbus_service_property(_interface, signature="s", access="read")
2029
def LastApprovalRequest_dbus_property(self):
2030
return datetime_to_dbus(self.last_approval_request)
2032
# Timeout - property
2033
@dbus_service_property(_interface,
2036
def Timeout_dbus_property(self, value=None):
2037
if value is None: # get
2038
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2039
old_timeout = self.timeout
2040
self.timeout = datetime.timedelta(0, 0, 0, value)
2041
# Reschedule disabling
2043
now = datetime.datetime.utcnow()
2044
self.expires += self.timeout - old_timeout
2045
if self.expires <= now:
2046
# The timeout has passed
2049
if (getattr(self, "disable_initiator_tag", None)
2052
GObject.source_remove(self.disable_initiator_tag)
2053
self.disable_initiator_tag = GObject.timeout_add(
2054
int((self.expires - now).total_seconds() * 1000),
2057
# ExtendedTimeout - property
2058
@dbus_service_property(_interface,
2061
def ExtendedTimeout_dbus_property(self, value=None):
2062
if value is None: # get
2063
return dbus.UInt64(self.extended_timeout.total_seconds()
2065
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2067
# Interval - property
2068
@dbus_service_property(_interface,
2071
def Interval_dbus_property(self, value=None):
2072
if value is None: # get
2073
return dbus.UInt64(self.interval.total_seconds() * 1000)
2074
self.interval = datetime.timedelta(0, 0, 0, value)
2075
if getattr(self, "checker_initiator_tag", None) is None:
2078
# Reschedule checker run
2079
GObject.source_remove(self.checker_initiator_tag)
2080
self.checker_initiator_tag = GObject.timeout_add(
2081
value, self.start_checker)
2082
self.start_checker() # Start one now, too
2084
# Checker - property
2085
@dbus_service_property(_interface,
2088
def Checker_dbus_property(self, value=None):
2089
if value is None: # get
2090
return dbus.String(self.checker_command)
2091
self.checker_command = str(value)
2093
# CheckerRunning - property
2094
@dbus_service_property(_interface,
2097
def CheckerRunning_dbus_property(self, value=None):
2098
if value is None: # get
2099
return dbus.Boolean(self.checker is not None)
2101
self.start_checker()
2105
# ObjectPath - property
2107
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2108
"org.freedesktop.DBus.Deprecated": "true"})
2109
@dbus_service_property(_interface, signature="o", access="read")
2110
def ObjectPath_dbus_property(self):
2111
return self.dbus_object_path # is already a dbus.ObjectPath
2115
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2117
@dbus_service_property(_interface,
2121
def Secret_dbus_property(self, value):
2122
self.secret = bytes(value)
2127
class ProxyClient(object):
2128
def __init__(self, child_pipe, fpr, address):
2129
self._pipe = child_pipe
2130
self._pipe.send(('init', fpr, address))
2131
if not self._pipe.recv():
2134
def __getattribute__(self, name):
2136
return super(ProxyClient, self).__getattribute__(name)
2137
self._pipe.send(('getattr', name))
2138
data = self._pipe.recv()
2139
if data[0] == 'data':
2141
if data[0] == 'function':
2143
def func(*args, **kwargs):
2144
self._pipe.send(('funcall', name, args, kwargs))
2145
return self._pipe.recv()[1]
2149
def __setattr__(self, name, value):
2151
return super(ProxyClient, self).__setattr__(name, value)
2152
self._pipe.send(('setattr', name, value))
2155
class ClientHandler(socketserver.BaseRequestHandler, object):
2156
"""A class to handle client connections.
2158
Instantiated once for each connection to handle it.
372
def still_valid(self):
373
"""Has the timeout not yet passed for this client?"""
374
now = datetime.datetime.now()
375
if self.last_checked_ok is None:
376
return now < (self.created + self.timeout)
378
return now < (self.last_checked_ok + self.timeout)
381
def peer_certificate(session):
382
"Return the peer's OpenPGP certificate as a bytestring"
383
# If not an OpenPGP certificate...
384
if gnutls.library.functions.gnutls_certificate_type_get\
385
(session._c_object) \
386
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
387
# ...do the normal thing
388
return session.peer_certificate
389
list_size = ctypes.c_uint()
390
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
391
(session._c_object, ctypes.byref(list_size))
392
if list_size.value == 0:
395
return ctypes.string_at(cert.data, cert.size)
398
def fingerprint(openpgp):
399
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
400
# New GnuTLS "datum" with the OpenPGP public key
401
datum = gnutls.library.types.gnutls_datum_t\
402
(ctypes.cast(ctypes.c_char_p(openpgp),
403
ctypes.POINTER(ctypes.c_ubyte)),
404
ctypes.c_uint(len(openpgp)))
405
# New empty GnuTLS certificate
406
crt = gnutls.library.types.gnutls_openpgp_crt_t()
407
gnutls.library.functions.gnutls_openpgp_crt_init\
409
# Import the OpenPGP public key into the certificate
410
gnutls.library.functions.gnutls_openpgp_crt_import\
411
(crt, ctypes.byref(datum),
412
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
# Verify the self signature in the key
414
crtverify = ctypes.c_uint();
415
gnutls.library.functions.gnutls_openpgp_crt_verify_self\
416
(crt, ctypes.c_uint(0), ctypes.byref(crtverify))
417
if crtverify.value != 0:
418
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
419
raise gnutls.errors.CertificateSecurityError("Verify failed")
420
# New buffer for the fingerprint
421
buffer = ctypes.create_string_buffer(20)
422
buffer_length = ctypes.c_size_t()
423
# Get the fingerprint from the certificate into the buffer
424
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
425
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
426
# Deinit the certificate
427
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
428
# Convert the buffer to a Python bytestring
429
fpr = ctypes.string_at(buffer, buffer_length.value)
430
# Convert the bytestring to hexadecimal notation
431
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
435
class tcp_handler(SocketServer.BaseRequestHandler, object):
436
"""A TCP request handler class.
437
Instantiated by IPv6_TCPServer for each request to handle it.
2159
438
Note: This will run in its own forked process."""
2161
440
def handle(self):
2162
with contextlib.closing(self.server.child_pipe) as child_pipe:
2163
logger.info("TCP connection from: %s",
2164
str(self.client_address))
2165
logger.debug("Pipe FD: %d",
2166
self.server.child_pipe.fileno())
2168
session = gnutls.ClientSession(self.request)
2170
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2171
# "+AES-256-CBC", "+SHA1",
2172
# "+COMP-NULL", "+CTYPE-OPENPGP",
2174
# Use a fallback default, since this MUST be set.
2175
priority = self.server.gnutls_priority
2176
if priority is None:
2178
gnutls.priority_set_direct(session._c_object, priority,
2181
# Start communication using the Mandos protocol
2182
# Get protocol number
2183
line = self.request.makefile().readline()
2184
logger.debug("Protocol version: %r", line)
2186
if int(line.strip().split()[0]) > 1:
2187
raise RuntimeError(line)
2188
except (ValueError, IndexError, RuntimeError) as error:
2189
logger.error("Unknown protocol version: %s", error)
2192
# Start GnuTLS connection
2195
except gnutls.Error as error:
2196
logger.warning("Handshake failed: %s", error)
2197
# Do not run session.bye() here: the session is not
2198
# established. Just abandon the request.
2200
logger.debug("Handshake succeeded")
2202
approval_required = False
2205
fpr = self.fingerprint(
2206
self.peer_certificate(session))
2207
except (TypeError, gnutls.Error) as error:
2208
logger.warning("Bad certificate: %s", error)
2210
logger.debug("Fingerprint: %s", fpr)
2213
client = ProxyClient(child_pipe, fpr,
2214
self.client_address)
2218
if client.approval_delay:
2219
delay = client.approval_delay
2220
client.approvals_pending += 1
2221
approval_required = True
2224
if not client.enabled:
2225
logger.info("Client %s is disabled",
2227
if self.server.use_dbus:
2229
client.Rejected("Disabled")
2232
if client.approved or not client.approval_delay:
2233
#We are approved or approval is disabled
2235
elif client.approved is None:
2236
logger.info("Client %s needs approval",
2238
if self.server.use_dbus:
2240
client.NeedApproval(
2241
client.approval_delay.total_seconds()
2242
* 1000, client.approved_by_default)
2244
logger.warning("Client %s was not approved",
2246
if self.server.use_dbus:
2248
client.Rejected("Denied")
2251
#wait until timeout or approved
2252
time = datetime.datetime.now()
2253
client.changedstate.acquire()
2254
client.changedstate.wait(delay.total_seconds())
2255
client.changedstate.release()
2256
time2 = datetime.datetime.now()
2257
if (time2 - time) >= delay:
2258
if not client.approved_by_default:
2259
logger.warning("Client %s timed out while"
2260
" waiting for approval",
2262
if self.server.use_dbus:
2264
client.Rejected("Approval timed out")
2269
delay -= time2 - time
2272
session.send(client.secret)
2273
except gnutls.Error as error:
2274
logger.warning("gnutls send failed",
2278
logger.info("Sending secret to %s", client.name)
2279
# bump the timeout using extended_timeout
2280
client.bump_timeout(client.extended_timeout)
2281
if self.server.use_dbus:
2286
if approval_required:
2287
client.approvals_pending -= 1
2290
except gnutls.Error as error:
2291
logger.warning("GnuTLS bye failed",
2295
def peer_certificate(session):
2296
"Return the peer's OpenPGP certificate as a bytestring"
2297
# If not an OpenPGP certificate...
2298
if (gnutls.certificate_type_get(session._c_object)
2299
!= gnutls.CRT_OPENPGP):
2300
# ...return invalid data
2302
list_size = ctypes.c_uint(1)
2303
cert_list = (gnutls.certificate_get_peers
2304
(session._c_object, ctypes.byref(list_size)))
2305
if not bool(cert_list) and list_size.value != 0:
2306
raise gnutls.Error("error getting peer certificate")
2307
if list_size.value == 0:
2310
return ctypes.string_at(cert.data, cert.size)
2313
def fingerprint(openpgp):
2314
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2315
# New GnuTLS "datum" with the OpenPGP public key
2316
datum = gnutls.datum_t(
2317
ctypes.cast(ctypes.c_char_p(openpgp),
2318
ctypes.POINTER(ctypes.c_ubyte)),
2319
ctypes.c_uint(len(openpgp)))
2320
# New empty GnuTLS certificate
2321
crt = gnutls.openpgp_crt_t()
2322
gnutls.openpgp_crt_init(ctypes.byref(crt))
2323
# Import the OpenPGP public key into the certificate
2324
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2325
gnutls.OPENPGP_FMT_RAW)
2326
# Verify the self signature in the key
2327
crtverify = ctypes.c_uint()
2328
gnutls.openpgp_crt_verify_self(crt, 0,
2329
ctypes.byref(crtverify))
2330
if crtverify.value != 0:
2331
gnutls.openpgp_crt_deinit(crt)
2332
raise gnutls.CertificateSecurityError("Verify failed")
2333
# New buffer for the fingerprint
2334
buf = ctypes.create_string_buffer(20)
2335
buf_len = ctypes.c_size_t()
2336
# Get the fingerprint from the certificate into the buffer
2337
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2338
ctypes.byref(buf_len))
2339
# Deinit the certificate
2340
gnutls.openpgp_crt_deinit(crt)
2341
# Convert the buffer to a Python bytestring
2342
fpr = ctypes.string_at(buf, buf_len.value)
2343
# Convert the bytestring to hexadecimal notation
2344
hex_fpr = binascii.hexlify(fpr).upper()
2348
class MultiprocessingMixIn(object):
2349
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2351
def sub_process_main(self, request, address):
2353
self.finish_request(request, address)
2355
self.handle_error(request, address)
2356
self.close_request(request)
2358
def process_request(self, request, address):
2359
"""Start a new process to process the request."""
2360
proc = multiprocessing.Process(target = self.sub_process_main,
2361
args = (request, address))
2366
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2367
""" adds a pipe to the MixIn """
2369
def process_request(self, request, client_address):
2370
"""Overrides and wraps the original process_request().
2372
This function creates a new pipe in self.pipe
2374
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2376
proc = MultiprocessingMixIn.process_request(self, request,
2378
self.child_pipe.close()
2379
self.add_pipe(parent_pipe, proc)
2381
def add_pipe(self, parent_pipe, proc):
2382
"""Dummy function; override as necessary"""
2383
raise NotImplementedError()
2386
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2387
socketserver.TCPServer, object):
2388
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
441
logger.info(u"TCP connection from: %s",
442
unicode(self.client_address))
443
session = gnutls.connection.ClientSession\
444
(self.request, gnutls.connection.X509Credentials())
446
line = self.request.makefile().readline()
447
logger.debug(u"Protocol version: %r", line)
449
if int(line.strip().split()[0]) > 1:
451
except (ValueError, IndexError, RuntimeError), error:
452
logger.error(u"Unknown protocol version: %s", error)
455
# Note: gnutls.connection.X509Credentials is really a generic
456
# GnuTLS certificate credentials object so long as no X.509
457
# keys are added to it. Therefore, we can use it here despite
458
# using OpenPGP certificates.
460
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
461
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
463
priority = "NORMAL" # Fallback default, since this
465
if self.server.settings["priority"]:
466
priority = self.server.settings["priority"]
467
gnutls.library.functions.gnutls_priority_set_direct\
468
(session._c_object, priority, None);
472
except gnutls.errors.GNUTLSError, error:
473
logger.warning(u"Handshake failed: %s", error)
474
# Do not run session.bye() here: the session is not
475
# established. Just abandon the request.
478
fpr = fingerprint(peer_certificate(session))
479
except (TypeError, gnutls.errors.GNUTLSError), error:
480
logger.warning(u"Bad certificate: %s", error)
483
logger.debug(u"Fingerprint: %s", fpr)
485
for c in self.server.clients:
486
if c.fingerprint == fpr:
490
logger.warning(u"Client not found for fingerprint: %s",
494
# Have to check if client.still_valid(), since it is possible
495
# that the client timed out while establishing the GnuTLS
497
if not client.still_valid():
498
logger.warning(u"Client %(name)s is invalid",
503
while sent_size < len(client.secret):
504
sent = session.send(client.secret[sent_size:])
505
logger.debug(u"Sent: %d, remaining: %d",
506
sent, len(client.secret)
507
- (sent_size + sent))
512
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
513
"""IPv6 TCP server. Accepts 'None' as address and/or port.
2391
enabled: Boolean; whether this server is activated yet
2392
interface: None or a network interface name (string)
2393
use_ipv6: Boolean; to use IPv6 or not
515
settings: Server settings
516
clients: Set() of Client objects
2396
def __init__(self, server_address, RequestHandlerClass,
2400
"""If socketfd is set, use that file descriptor instead of
2401
creating a new one with socket.socket().
2403
self.interface = interface
2405
self.address_family = socket.AF_INET6
2406
if socketfd is not None:
2407
# Save the file descriptor
2408
self.socketfd = socketfd
2409
# Save the original socket.socket() function
2410
self.socket_socket = socket.socket
2411
# To implement --socket, we monkey patch socket.socket.
2413
# (When socketserver.TCPServer is a new-style class, we
2414
# could make self.socket into a property instead of monkey
2415
# patching socket.socket.)
2417
# Create a one-time-only replacement for socket.socket()
2418
@functools.wraps(socket.socket)
2419
def socket_wrapper(*args, **kwargs):
2420
# Restore original function so subsequent calls are
2422
socket.socket = self.socket_socket
2423
del self.socket_socket
2424
# This time only, return a new socket object from the
2425
# saved file descriptor.
2426
return socket.fromfd(self.socketfd, *args, **kwargs)
2427
# Replace socket.socket() function with wrapper
2428
socket.socket = socket_wrapper
2429
# The socketserver.TCPServer.__init__ will call
2430
# socket.socket(), which might be our replacement,
2431
# socket_wrapper(), if socketfd was set.
2432
socketserver.TCPServer.__init__(self, server_address,
2433
RequestHandlerClass)
518
address_family = socket.AF_INET6
519
def __init__(self, *args, **kwargs):
520
if "settings" in kwargs:
521
self.settings = kwargs["settings"]
522
del kwargs["settings"]
523
if "clients" in kwargs:
524
self.clients = kwargs["clients"]
525
del kwargs["clients"]
526
return super(type(self), self).__init__(*args, **kwargs)
2435
527
def server_bind(self):
2436
528
"""This overrides the normal server_bind() function
2437
529
to bind to an interface if one was specified, and also NOT to
2438
530
bind to an address or port if they were not specified."""
2439
if self.interface is not None:
2440
if SO_BINDTODEVICE is None:
2441
logger.error("SO_BINDTODEVICE does not exist;"
2442
" cannot bind to interface %s",
2446
self.socket.setsockopt(
2447
socket.SOL_SOCKET, SO_BINDTODEVICE,
2448
(self.interface + "\0").encode("utf-8"))
2449
except socket.error as error:
2450
if error.errno == errno.EPERM:
2451
logger.error("No permission to bind to"
2452
" interface %s", self.interface)
2453
elif error.errno == errno.ENOPROTOOPT:
2454
logger.error("SO_BINDTODEVICE not available;"
2455
" cannot bind to interface %s",
2457
elif error.errno == errno.ENODEV:
2458
logger.error("Interface %s does not exist,"
2459
" cannot bind", self.interface)
531
if self.settings["interface"]:
532
# 25 is from /usr/include/asm-i486/socket.h
533
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
535
self.socket.setsockopt(socket.SOL_SOCKET,
537
self.settings["interface"])
538
except socket.error, error:
539
if error[0] == errno.EPERM:
540
logger.error(u"No permission to"
541
u" bind to interface %s",
542
self.settings["interface"])
2462
545
# Only bind(2) the socket if we really need to.
2463
546
if self.server_address[0] or self.server_address[1]:
2464
547
if not self.server_address[0]:
2465
if self.address_family == socket.AF_INET6:
2466
any_address = "::" # in6addr_any
2468
any_address = "0.0.0.0" # INADDR_ANY
2469
self.server_address = (any_address,
549
self.server_address = (in6addr_any,
2470
550
self.server_address[1])
2471
551
elif not self.server_address[1]:
2472
self.server_address = (self.server_address[0], 0)
2473
# if self.interface:
552
self.server_address = (self.server_address[0],
554
# if self.settings["interface"]:
2474
555
# self.server_address = (self.server_address[0],
2477
558
# if_nametoindex
2479
return socketserver.TCPServer.server_bind(self)
2482
class MandosServer(IPv6_TCPServer):
2486
clients: set of Client objects
2487
gnutls_priority GnuTLS priority string
2488
use_dbus: Boolean; to emit D-Bus signals or not
2490
Assumes a GObject.MainLoop event loop.
2493
def __init__(self, server_address, RequestHandlerClass,
2497
gnutls_priority=None,
2500
self.enabled = False
2501
self.clients = clients
2502
if self.clients is None:
2504
self.use_dbus = use_dbus
2505
self.gnutls_priority = gnutls_priority
2506
IPv6_TCPServer.__init__(self, server_address,
2507
RequestHandlerClass,
2508
interface = interface,
2509
use_ipv6 = use_ipv6,
2510
socketfd = socketfd)
2512
def server_activate(self):
2514
return socketserver.TCPServer.server_activate(self)
2519
def add_pipe(self, parent_pipe, proc):
2520
# Call "handle_ipc" for both data and EOF events
2521
GObject.io_add_watch(
2522
parent_pipe.fileno(),
2523
GObject.IO_IN | GObject.IO_HUP,
2524
functools.partial(self.handle_ipc,
2525
parent_pipe = parent_pipe,
2528
def handle_ipc(self, source, condition,
2531
client_object=None):
2532
# error, or the other end of multiprocessing.Pipe has closed
2533
if condition & (GObject.IO_ERR | GObject.IO_HUP):
2534
# Wait for other process to exit
2538
# Read a request from the child
2539
request = parent_pipe.recv()
2540
command = request[0]
2542
if command == 'init':
2544
address = request[2]
2546
for c in self.clients.values():
2547
if c.fingerprint == fpr:
2551
logger.info("Client not found for fingerprint: %s, ad"
2552
"dress: %s", fpr, address)
2555
mandos_dbus_service.ClientNotFound(fpr,
2557
parent_pipe.send(False)
2560
GObject.io_add_watch(
2561
parent_pipe.fileno(),
2562
GObject.IO_IN | GObject.IO_HUP,
2563
functools.partial(self.handle_ipc,
2564
parent_pipe = parent_pipe,
2566
client_object = client))
2567
parent_pipe.send(True)
2568
# remove the old hook in favor of the new above hook on
2571
if command == 'funcall':
2572
funcname = request[1]
2576
parent_pipe.send(('data', getattr(client_object,
2580
if command == 'getattr':
2581
attrname = request[1]
2582
if isinstance(client_object.__getattribute__(attrname),
2583
collections.Callable):
2584
parent_pipe.send(('function', ))
2587
'data', client_object.__getattribute__(attrname)))
2589
if command == 'setattr':
2590
attrname = request[1]
2592
setattr(client_object, attrname, value)
2597
def rfc3339_duration_to_delta(duration):
2598
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2600
>>> rfc3339_duration_to_delta("P7D")
2601
datetime.timedelta(7)
2602
>>> rfc3339_duration_to_delta("PT60S")
2603
datetime.timedelta(0, 60)
2604
>>> rfc3339_duration_to_delta("PT60M")
2605
datetime.timedelta(0, 3600)
2606
>>> rfc3339_duration_to_delta("PT24H")
2607
datetime.timedelta(1)
2608
>>> rfc3339_duration_to_delta("P1W")
2609
datetime.timedelta(7)
2610
>>> rfc3339_duration_to_delta("PT5M30S")
2611
datetime.timedelta(0, 330)
2612
>>> rfc3339_duration_to_delta("P1DT3M20S")
2613
datetime.timedelta(1, 200)
2616
# Parsing an RFC 3339 duration with regular expressions is not
2617
# possible - there would have to be multiple places for the same
2618
# values, like seconds. The current code, while more esoteric, is
2619
# cleaner without depending on a parsing library. If Python had a
2620
# built-in library for parsing we would use it, but we'd like to
2621
# avoid excessive use of external libraries.
2623
# New type for defining tokens, syntax, and semantics all-in-one
2624
Token = collections.namedtuple("Token", (
2625
"regexp", # To match token; if "value" is not None, must have
2626
# a "group" containing digits
2627
"value", # datetime.timedelta or None
2628
"followers")) # Tokens valid after this token
2629
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2630
# the "duration" ABNF definition in RFC 3339, Appendix A.
2631
token_end = Token(re.compile(r"$"), None, frozenset())
2632
token_second = Token(re.compile(r"(\d+)S"),
2633
datetime.timedelta(seconds=1),
2634
frozenset((token_end, )))
2635
token_minute = Token(re.compile(r"(\d+)M"),
2636
datetime.timedelta(minutes=1),
2637
frozenset((token_second, token_end)))
2638
token_hour = Token(re.compile(r"(\d+)H"),
2639
datetime.timedelta(hours=1),
2640
frozenset((token_minute, token_end)))
2641
token_time = Token(re.compile(r"T"),
2643
frozenset((token_hour, token_minute,
2645
token_day = Token(re.compile(r"(\d+)D"),
2646
datetime.timedelta(days=1),
2647
frozenset((token_time, token_end)))
2648
token_month = Token(re.compile(r"(\d+)M"),
2649
datetime.timedelta(weeks=4),
2650
frozenset((token_day, token_end)))
2651
token_year = Token(re.compile(r"(\d+)Y"),
2652
datetime.timedelta(weeks=52),
2653
frozenset((token_month, token_end)))
2654
token_week = Token(re.compile(r"(\d+)W"),
2655
datetime.timedelta(weeks=1),
2656
frozenset((token_end, )))
2657
token_duration = Token(re.compile(r"P"), None,
2658
frozenset((token_year, token_month,
2659
token_day, token_time,
2661
# Define starting values
2662
value = datetime.timedelta() # Value so far
2664
followers = frozenset((token_duration, )) # Following valid tokens
2665
s = duration # String left to parse
2666
# Loop until end token is found
2667
while found_token is not token_end:
2668
# Search for any currently valid tokens
2669
for token in followers:
2670
match = token.regexp.match(s)
2671
if match is not None:
2673
if token.value is not None:
2674
# Value found, parse digits
2675
factor = int(match.group(1), 10)
2676
# Add to value so far
2677
value += factor * token.value
2678
# Strip token from string
2679
s = token.regexp.sub("", s, 1)
2682
# Set valid next tokens
2683
followers = found_token.followers
2686
# No currently valid tokens were found
2687
raise ValueError("Invalid RFC 3339 duration: {!r}"
561
return super(type(self), self).server_bind()
2693
564
def string_to_delta(interval):
2694
565
"""Parse a string and return a datetime.timedelta
2696
567
>>> string_to_delta('7d')
2697
568
datetime.timedelta(7)
2698
569
>>> string_to_delta('60s')
2824
709
"debug": "False",
2826
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2827
":+SIGN-DSA-SHA256",
711
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2828
712
"servicename": "Mandos",
2834
"statedir": "/var/lib/mandos",
2835
"foreground": "False",
2839
715
# Parse config file for server-global settings
2840
server_config = configparser.SafeConfigParser(server_defaults)
716
server_config = ConfigParser.SafeConfigParser(server_defaults)
2841
717
del server_defaults
2842
718
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2843
719
# Convert the SafeConfigParser object to a dict
2844
720
server_settings = server_config.defaults()
2845
# Use the appropriate methods on the non-string config options
2846
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2847
server_settings[option] = server_config.getboolean("DEFAULT",
2849
if server_settings["port"]:
2850
server_settings["port"] = server_config.getint("DEFAULT",
2852
if server_settings["socket"]:
2853
server_settings["socket"] = server_config.getint("DEFAULT",
2855
# Later, stdin will, and stdout and stderr might, be dup'ed
2856
# over with an opened os.devnull. But we don't want this to
2857
# happen with a supplied network socket.
2858
if 0 <= server_settings["socket"] <= 2:
2859
server_settings["socket"] = os.dup(server_settings
721
# Use getboolean on the boolean config option
722
server_settings["debug"] = server_config.getboolean\
2861
724
del server_config
2863
726
# Override the settings from the config file with command line
2864
727
# options, if set.
2865
728
for option in ("interface", "address", "port", "debug",
2866
"priority", "servicename", "configdir", "use_dbus",
2867
"use_ipv6", "debuglevel", "restore", "statedir",
2868
"socket", "foreground", "zeroconf"):
729
"priority", "servicename", "configdir"):
2869
730
value = getattr(options, option)
2870
731
if value is not None:
2871
732
server_settings[option] = value
2873
# Force all strings to be unicode
2874
for option in server_settings.keys():
2875
if isinstance(server_settings[option], bytes):
2876
server_settings[option] = (server_settings[option]
2878
# Force all boolean options to be boolean
2879
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2880
"foreground", "zeroconf"):
2881
server_settings[option] = bool(server_settings[option])
2882
# Debug implies foreground
2883
if server_settings["debug"]:
2884
server_settings["foreground"] = True
2885
734
# Now we have our good server settings in "server_settings"
2887
##################################################################
2889
if (not server_settings["zeroconf"]
2890
and not (server_settings["port"]
2891
or server_settings["socket"] != "")):
2892
parser.error("Needs port or socket to work without Zeroconf")
2895
736
debug = server_settings["debug"]
2896
debuglevel = server_settings["debuglevel"]
2897
use_dbus = server_settings["use_dbus"]
2898
use_ipv6 = server_settings["use_ipv6"]
2899
stored_state_path = os.path.join(server_settings["statedir"],
2901
foreground = server_settings["foreground"]
2902
zeroconf = server_settings["zeroconf"]
2905
initlogger(debug, logging.DEBUG)
2910
level = getattr(logging, debuglevel.upper())
2911
initlogger(debug, level)
739
syslogger.setLevel(logging.WARNING)
740
console.setLevel(logging.WARNING)
2913
742
if server_settings["servicename"] != "Mandos":
2914
syslogger.setFormatter(
2915
logging.Formatter('Mandos ({}) [%(process)d]:'
2916
' %(levelname)s: %(message)s'.format(
2917
server_settings["servicename"])))
743
syslogger.setFormatter(logging.Formatter\
744
('Mandos (%s): %%(levelname)s:'
746
% server_settings["servicename"]))
2919
748
# Parse config file with clients
2920
client_config = configparser.SafeConfigParser(Client
749
client_defaults = { "timeout": "1h",
751
"checker": "fping -q -- %(host)s",
754
client_config = ConfigParser.SafeConfigParser(client_defaults)
2922
755
client_config.read(os.path.join(server_settings["configdir"],
2923
756
"clients.conf"))
2925
global mandos_dbus_service
2926
mandos_dbus_service = None
2929
if server_settings["socket"] != "":
2930
socketfd = server_settings["socket"]
2931
tcp_server = MandosServer(
2932
(server_settings["address"], server_settings["port"]),
2934
interface=(server_settings["interface"] or None),
2936
gnutls_priority=server_settings["priority"],
2940
pidfilename = "/run/mandos.pid"
2941
if not os.path.isdir("/run/."):
2942
pidfilename = "/var/run/mandos.pid"
2945
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2946
except IOError as e:
2947
logger.error("Could not open file %r", pidfilename,
2950
for name, group in (("_mandos", "_mandos"),
2951
("mandos", "mandos"),
2952
("nobody", "nogroup")):
2954
uid = pwd.getpwnam(name).pw_uid
2955
gid = pwd.getpwnam(group).pw_gid
2966
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2968
except OSError as error:
2969
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2970
.format(uid, gid, os.strerror(error.errno)))
2971
if error.errno != errno.EPERM:
2975
# Enable all possible GnuTLS debugging
2977
# "Use a log level over 10 to enable all debugging options."
2979
gnutls.global_set_log_level(11)
2982
def debug_gnutls(level, string):
2983
logger.debug("GnuTLS: %s", string[:-1])
2985
gnutls.global_set_log_function(debug_gnutls)
2987
# Redirect stdin so all checkers get /dev/null
2988
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2989
os.dup2(null, sys.stdin.fileno())
2993
# Need to fork before connecting to D-Bus
2995
# Close all input and output, do double fork, etc.
2998
# multiprocessing will use threads, so before we use GObject we
2999
# need to inform GObject that threads will be used.
3000
GObject.threads_init()
759
service = AvahiService(name = server_settings["servicename"],
760
type = "_mandos._tcp", );
761
if server_settings["interface"]:
762
service.interface = if_nametoindex(server_settings["interface"])
3002
764
global main_loop
3003
767
# From the Avahi example code
3004
DBusGMainLoop(set_as_default=True)
3005
main_loop = GObject.MainLoop()
768
DBusGMainLoop(set_as_default=True )
769
main_loop = gobject.MainLoop()
3006
770
bus = dbus.SystemBus()
771
server = dbus.Interface(
772
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
773
avahi.DBUS_INTERFACE_SERVER )
3007
774
# End of Avahi example code
3010
bus_name = dbus.service.BusName("se.recompile.Mandos",
3013
old_bus_name = dbus.service.BusName(
3014
"se.bsnet.fukt.Mandos", bus,
3016
except dbus.exceptions.DBusException as e:
3017
logger.error("Disabling D-Bus:", exc_info=e)
3019
server_settings["use_dbus"] = False
3020
tcp_server.use_dbus = False
3022
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3023
service = AvahiServiceToSyslog(
3024
name = server_settings["servicename"],
3025
servicetype = "_mandos._tcp",
3026
protocol = protocol,
3028
if server_settings["interface"]:
3029
service.interface = if_nametoindex(
3030
server_settings["interface"].encode("utf-8"))
3032
global multiprocessing_manager
3033
multiprocessing_manager = multiprocessing.Manager()
3035
client_class = Client
3037
client_class = functools.partial(ClientDBus, bus = bus)
3039
client_settings = Client.config_parser(client_config)
3040
old_client_settings = {}
3043
# This is used to redirect stdout and stderr for checker processes
3045
wnull = open(os.devnull, "w") # A writable /dev/null
3046
# Only used if server is running in foreground but not in debug
3048
if debug or not foreground:
3051
# Get client data and settings from last running state.
3052
if server_settings["restore"]:
3054
with open(stored_state_path, "rb") as stored_state:
3055
if sys.version_info.major == 2:
3056
clients_data, old_client_settings = pickle.load(
3059
bytes_clients_data, bytes_old_client_settings = (
3060
pickle.load(stored_state, encoding = "bytes"))
3061
### Fix bytes to strings
3064
clients_data = { (key.decode("utf-8")
3065
if isinstance(key, bytes)
3068
bytes_clients_data.items() }
3069
del bytes_clients_data
3070
for key in clients_data:
3071
value = { (k.decode("utf-8")
3072
if isinstance(k, bytes) else k): v
3074
clients_data[key].items() }
3075
clients_data[key] = value
3077
value["client_structure"] = [
3079
if isinstance(s, bytes)
3081
value["client_structure"] ]
3083
for k in ("name", "host"):
3084
if isinstance(value[k], bytes):
3085
value[k] = value[k].decode("utf-8")
3086
## old_client_settings
3088
old_client_settings = {
3089
(key.decode("utf-8")
3090
if isinstance(key, bytes)
3093
bytes_old_client_settings.items() }
3094
del bytes_old_client_settings
3096
for value in old_client_settings.values():
3097
if isinstance(value["host"], bytes):
3098
value["host"] = (value["host"]
3100
os.remove(stored_state_path)
3101
except IOError as e:
3102
if e.errno == errno.ENOENT:
3103
logger.warning("Could not load persistent state:"
3104
" {}".format(os.strerror(e.errno)))
3106
logger.critical("Could not load persistent state:",
3109
except EOFError as e:
3110
logger.warning("Could not load persistent state: "
3114
with PGPEngine() as pgp:
3115
for client_name, client in clients_data.items():
3116
# Skip removed clients
3117
if client_name not in client_settings:
3120
# Decide which value to use after restoring saved state.
3121
# We have three different values: Old config file,
3122
# new config file, and saved state.
3123
# New config value takes precedence if it differs from old
3124
# config value, otherwise use saved state.
3125
for name, value in client_settings[client_name].items():
3127
# For each value in new config, check if it
3128
# differs from the old config value (Except for
3129
# the "secret" attribute)
3130
if (name != "secret"
3132
old_client_settings[client_name][name])):
3133
client[name] = value
3137
# Clients who has passed its expire date can still be
3138
# enabled if its last checker was successful. A Client
3139
# whose checker succeeded before we stored its state is
3140
# assumed to have successfully run all checkers during
3142
if client["enabled"]:
3143
if datetime.datetime.utcnow() >= client["expires"]:
3144
if not client["last_checked_ok"]:
3146
"disabling client {} - Client never "
3147
"performed a successful checker".format(
3149
client["enabled"] = False
3150
elif client["last_checker_status"] != 0:
3152
"disabling client {} - Client last"
3153
" checker failed with error code"
3156
client["last_checker_status"]))
3157
client["enabled"] = False
3159
client["expires"] = (
3160
datetime.datetime.utcnow()
3161
+ client["timeout"])
3162
logger.debug("Last checker succeeded,"
3163
" keeping {} enabled".format(
3166
client["secret"] = pgp.decrypt(
3167
client["encrypted_secret"],
3168
client_settings[client_name]["secret"])
3170
# If decryption fails, we use secret from new settings
3171
logger.debug("Failed to decrypt {} old secret".format(
3173
client["secret"] = (client_settings[client_name]
3176
# Add/remove clients based on new changes made to config
3177
for client_name in (set(old_client_settings)
3178
- set(client_settings)):
3179
del clients_data[client_name]
3180
for client_name in (set(client_settings)
3181
- set(old_client_settings)):
3182
clients_data[client_name] = client_settings[client_name]
3184
# Create all client objects
3185
for client_name, client in clients_data.items():
3186
tcp_server.clients[client_name] = client_class(
3189
server_settings = server_settings)
3191
if not tcp_server.clients:
3192
logger.warning("No clients defined")
3195
if pidfile is not None:
3199
print(pid, file=pidfile)
3201
logger.error("Could not write to file %r with PID %d",
777
def remove_from_clients(client):
778
clients.remove(client)
780
logger.critical(u"No clients left, exiting")
783
clients.update(Set(Client(name = section,
784
stop_hook = remove_from_clients,
786
= dict(client_config.items(section)))
787
for section in client_config.sections()))
789
logger.critical(u"No clients defined")
793
# Redirect stdin so all checkers get /dev/null
794
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
795
os.dup2(null, sys.stdin.fileno())
800
logger.removeHandler(console)
801
# Close all input and output, do double fork, etc.
804
pidfilename = "/var/run/mandos/mandos.pid"
807
pidfile = open(pidfilename, "w")
808
pidfile.write(str(pid) + "\n")
3206
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
3207
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3211
@alternate_dbus_interfaces(
3212
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3213
class MandosDBusService(DBusObjectWithObjectManager):
3214
"""A D-Bus proxy object"""
3217
dbus.service.Object.__init__(self, bus, "/")
3219
_interface = "se.recompile.Mandos"
3221
@dbus.service.signal(_interface, signature="o")
3222
def ClientAdded(self, objpath):
3226
@dbus.service.signal(_interface, signature="ss")
3227
def ClientNotFound(self, fingerprint, address):
3231
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3233
@dbus.service.signal(_interface, signature="os")
3234
def ClientRemoved(self, objpath, name):
3238
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3240
@dbus.service.method(_interface, out_signature="ao")
3241
def GetAllClients(self):
3243
return dbus.Array(c.dbus_object_path for c in
3244
tcp_server.clients.values())
3246
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3248
@dbus.service.method(_interface,
3249
out_signature="a{oa{sv}}")
3250
def GetAllClientsWithProperties(self):
3252
return dbus.Dictionary(
3253
{ c.dbus_object_path: c.GetAll(
3254
"se.recompile.Mandos.Client")
3255
for c in tcp_server.clients.values() },
3258
@dbus.service.method(_interface, in_signature="o")
3259
def RemoveClient(self, object_path):
3261
for c in tcp_server.clients.values():
3262
if c.dbus_object_path == object_path:
3263
del tcp_server.clients[c.name]
3264
c.remove_from_connection()
3265
# Don't signal the disabling
3266
c.disable(quiet=True)
3267
# Emit D-Bus signal for removal
3268
self.client_removed_signal(c)
3270
raise KeyError(object_path)
3274
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3275
out_signature = "a{oa{sa{sv}}}")
3276
def GetManagedObjects(self):
3278
return dbus.Dictionary(
3279
{ client.dbus_object_path:
3281
{ interface: client.GetAll(interface)
3283
client._get_all_interface_names()})
3284
for client in tcp_server.clients.values()})
3286
def client_added_signal(self, client):
3287
"""Send the new standard signal and the old signal"""
3289
# New standard signal
3290
self.InterfacesAdded(
3291
client.dbus_object_path,
3293
{ interface: client.GetAll(interface)
3295
client._get_all_interface_names()}))
3297
self.ClientAdded(client.dbus_object_path)
3299
def client_removed_signal(self, client):
3300
"""Send the new standard signal and the old signal"""
3302
# New standard signal
3303
self.InterfacesRemoved(
3304
client.dbus_object_path,
3305
client._get_all_interface_names())
3307
self.ClientRemoved(client.dbus_object_path,
3310
mandos_dbus_service = MandosDBusService()
812
logger.error(u"Could not write %s file with PID %d",
813
pidfilename, os.getpid())
3313
816
"Cleanup function; run on exit"
3317
multiprocessing.active_children()
3319
if not (tcp_server.clients or client_settings):
3322
# Store client before exiting. Secrets are encrypted with key
3323
# based on what config file has. If config file is
3324
# removed/edited, old secret will thus be unrecovable.
3326
with PGPEngine() as pgp:
3327
for client in tcp_server.clients.values():
3328
key = client_settings[client.name]["secret"]
3329
client.encrypted_secret = pgp.encrypt(client.secret,
3333
# A list of attributes that can not be pickled
3335
exclude = { "bus", "changedstate", "secret",
3336
"checker", "server_settings" }
3337
for name, typ in inspect.getmembers(dbus.service
3341
client_dict["encrypted_secret"] = (client
3343
for attr in client.client_structure:
3344
if attr not in exclude:
3345
client_dict[attr] = getattr(client, attr)
3347
clients[client.name] = client_dict
3348
del client_settings[client.name]["secret"]
3351
with tempfile.NamedTemporaryFile(
3355
dir=os.path.dirname(stored_state_path),
3356
delete=False) as stored_state:
3357
pickle.dump((clients, client_settings), stored_state,
3359
tempname = stored_state.name
3360
os.rename(tempname, stored_state_path)
3361
except (IOError, OSError) as e:
3367
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3368
logger.warning("Could not save persistent state: {}"
3369
.format(os.strerror(e.errno)))
3371
logger.warning("Could not save persistent state:",
3375
# Delete all clients, and settings from config
3376
while tcp_server.clients:
3377
name, client = tcp_server.clients.popitem()
3379
client.remove_from_connection()
3380
# Don't signal the disabling
3381
client.disable(quiet=True)
3382
# Emit D-Bus signal for removal
3384
mandos_dbus_service.client_removed_signal(client)
3385
client_settings.clear()
818
# From the Avahi example code
819
if not group is None:
822
# End of Avahi example code
825
client = clients.pop()
826
client.stop_hook = None
3387
829
atexit.register(cleanup)
3389
for client in tcp_server.clients.values():
3391
# Emit D-Bus signal for adding
3392
mandos_dbus_service.client_added_signal(client)
3393
# Need to initiate checking of clients
3395
client.init_checker()
3398
tcp_server.server_activate()
832
signal.signal(signal.SIGINT, signal.SIG_IGN)
833
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
834
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
836
for client in clients:
839
tcp_server = IPv6_TCPServer((server_settings["address"],
840
server_settings["port"]),
842
settings=server_settings,
3400
844
# Find out what port we got
3402
service.port = tcp_server.socket.getsockname()[1]
3404
logger.info("Now listening on address %r, port %d,"
3405
" flowinfo %d, scope_id %d",
3406
*tcp_server.socket.getsockname())
3408
logger.info("Now listening on address %r, port %d",
3409
*tcp_server.socket.getsockname())
845
service.port = tcp_server.socket.getsockname()[1]
846
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
847
u" scope_id %d" % tcp_server.socket.getsockname())
3411
849
#service.interface = tcp_server.socket.getsockname()[3]
3415
# From the Avahi example code
3418
except dbus.exceptions.DBusException as error:
3419
logger.critical("D-Bus Exception", exc_info=error)
3422
# End of Avahi example code
852
# From the Avahi example code
853
server.connect_to_signal("StateChanged", server_state_changed)
855
server_state_changed(server.GetState())
856
except dbus.exceptions.DBusException, error:
857
logger.critical(u"DBusException: %s", error)
859
# End of Avahi example code
3424
GObject.io_add_watch(tcp_server.fileno(), GObject.IO_IN,
861
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3425
862
lambda *args, **kwargs:
3426
(tcp_server.handle_request
3427
(*args[2:], **kwargs) or True))
863
tcp_server.handle_request\
864
(*args[2:], **kwargs) or True)
3429
logger.debug("Starting main loop")
866
logger.debug(u"Starting main loop")
867
main_loop_started = True
3431
except AvahiError as error:
3432
logger.critical("Avahi Error", exc_info=error)
869
except AvahiError, error:
870
logger.critical(u"AvahiError: %s" + unicode(error))
3435
872
except KeyboardInterrupt:
3437
print("", file=sys.stderr)
3438
logger.debug("Server received KeyboardInterrupt")
3439
logger.debug("Server exiting")
3440
# Must run before the D-Bus bus name gets deregistered
3444
876
if __name__ == '__main__':