107
270
max_renames: integer; maximum number of renames
108
271
rename_count: integer; counter so we only rename after collisions
109
272
a sensible number of times
273
group: D-Bus Entry Group
275
bus: dbus.SystemBus()
111
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
112
servicetype = None, port = None, TXT = None, domain = "",
113
host = "", max_renames = 32768):
279
interface = avahi.IF_UNSPEC,
287
protocol = avahi.PROTO_UNSPEC,
114
289
self.interface = interface
116
291
self.type = servicetype
293
self.TXT = TXT if TXT is not None else []
122
294
self.domain = domain
124
296
self.rename_count = 0
125
297
self.max_renames = max_renames
298
self.protocol = protocol
299
self.group = None # our entry group
302
self.entry_group_state_changed_match = None
304
def rename(self, remove=True):
127
305
"""Derived from the Avahi example code"""
128
306
if self.rename_count >= self.max_renames:
129
logger.critical(u"No suitable Zeroconf service name found"
130
u" after %i retries, exiting.",
307
logger.critical("No suitable Zeroconf service name found"
308
" after %i retries, exiting.",
131
309
self.rename_count)
132
310
raise AvahiServiceError("Too many renames")
133
self.name = server.GetAlternativeServiceName(self.name)
134
logger.info(u"Changing Zeroconf service name to %r ...",
136
syslogger.setFormatter(logging.Formatter\
137
('Mandos (%s): %%(levelname)s:'
138
' %%(message)s' % self.name))
312
self.server.GetAlternativeServiceName(self.name))
141
313
self.rename_count += 1
314
logger.info("Changing Zeroconf service name to %r ...",
320
except dbus.exceptions.DBusException as error:
321
if (error.get_dbus_name()
322
== "org.freedesktop.Avahi.CollisionError"):
323
logger.info("Local Zeroconf service name collision.")
324
return self.rename(remove=False)
326
logger.critical("D-Bus Exception", exc_info=error)
142
330
def remove(self):
143
331
"""Derived from the Avahi example code"""
144
if group is not None:
332
if self.entry_group_state_changed_match is not None:
333
self.entry_group_state_changed_match.remove()
334
self.entry_group_state_changed_match = None
335
if self.group is not None:
147
339
"""Derived from the Avahi example code"""
150
group = dbus.Interface\
151
(bus.get_object(avahi.DBUS_NAME,
152
server.EntryGroupNew()),
153
avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
group.connect_to_signal('StateChanged',
155
entry_group_state_changed)
156
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
157
service.name, service.type)
159
self.interface, # interface
160
avahi.PROTO_INET6, # protocol
161
dbus.UInt32(0), # flags
162
self.name, self.type,
163
self.domain, self.host,
164
dbus.UInt16(self.port),
165
avahi.string_array_to_txt_array(self.TXT))
168
# From the Avahi example code:
169
group = None # our entry group
170
# End of Avahi example code
341
if self.group is None:
342
self.group = dbus.Interface(
343
self.bus.get_object(avahi.DBUS_NAME,
344
self.server.EntryGroupNew()),
345
avahi.DBUS_INTERFACE_ENTRY_GROUP)
346
self.entry_group_state_changed_match = (
347
self.group.connect_to_signal(
348
'StateChanged', self.entry_group_state_changed))
349
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
350
self.name, self.type)
351
self.group.AddService(
354
dbus.UInt32(0), # flags
355
self.name, self.type,
356
self.domain, self.host,
357
dbus.UInt16(self.port),
358
avahi.string_array_to_txt_array(self.TXT))
361
def entry_group_state_changed(self, state, error):
362
"""Derived from the Avahi example code"""
363
logger.debug("Avahi entry group state change: %i", state)
365
if state == avahi.ENTRY_GROUP_ESTABLISHED:
366
logger.debug("Zeroconf service established.")
367
elif state == avahi.ENTRY_GROUP_COLLISION:
368
logger.info("Zeroconf service name collision.")
370
elif state == avahi.ENTRY_GROUP_FAILURE:
371
logger.critical("Avahi: Error in group state changed %s",
373
raise AvahiGroupError("State changed: {!s}".format(error))
376
"""Derived from the Avahi example code"""
377
if self.group is not None:
380
except (dbus.exceptions.UnknownMethodException,
381
dbus.exceptions.DBusException):
386
def server_state_changed(self, state, error=None):
387
"""Derived from the Avahi example code"""
388
logger.debug("Avahi server state change: %i", state)
390
avahi.SERVER_INVALID: "Zeroconf server invalid",
391
avahi.SERVER_REGISTERING: None,
392
avahi.SERVER_COLLISION: "Zeroconf server name collision",
393
avahi.SERVER_FAILURE: "Zeroconf server failure",
395
if state in bad_states:
396
if bad_states[state] is not None:
398
logger.error(bad_states[state])
400
logger.error(bad_states[state] + ": %r", error)
402
elif state == avahi.SERVER_RUNNING:
405
except dbus.exceptions.DBusException as error:
406
if (error.get_dbus_name()
407
== "org.freedesktop.Avahi.CollisionError"):
408
logger.info("Local Zeroconf service name"
410
return self.rename(remove=False)
412
logger.critical("D-Bus Exception", exc_info=error)
417
logger.debug("Unknown state: %r", state)
419
logger.debug("Unknown state: %r: %r", state, error)
422
"""Derived from the Avahi example code"""
423
if self.server is None:
424
self.server = dbus.Interface(
425
self.bus.get_object(avahi.DBUS_NAME,
426
avahi.DBUS_PATH_SERVER,
427
follow_name_owner_changes=True),
428
avahi.DBUS_INTERFACE_SERVER)
429
self.server.connect_to_signal("StateChanged",
430
self.server_state_changed)
431
self.server_state_changed(self.server.GetState())
434
class AvahiServiceToSyslog(AvahiService):
435
def rename(self, *args, **kwargs):
436
"""Add the new name to the syslog messages"""
437
ret = AvahiService.rename(self, *args, **kwargs)
438
syslogger.setFormatter(logging.Formatter(
439
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
443
# Pretend that we have a GnuTLS module
444
class GnuTLS(object):
445
"""This isn't so much a class as it is a module-like namespace.
446
It is instantiated once, and simulates having a GnuTLS module."""
448
_library = ctypes.cdll.LoadLibrary(
449
ctypes.util.find_library("gnutls"))
450
_need_version = "3.3.0"
452
# Need to use class name "GnuTLS" here, since this method is
453
# called before the assignment to the "gnutls" global variable
455
if GnuTLS.check_version(self._need_version) is None:
456
raise GnuTLS.Error("Needs GnuTLS {} or later"
457
.format(self._need_version))
459
# Unless otherwise indicated, the constants and types below are
460
# all from the gnutls/gnutls.h C header file.
470
E_NO_CERTIFICATE_FOUND = -49
471
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
474
class session_int(ctypes.Structure):
476
session_t = ctypes.POINTER(session_int)
477
class certificate_credentials_st(ctypes.Structure):
479
certificate_credentials_t = ctypes.POINTER(
480
certificate_credentials_st)
481
certificate_type_t = ctypes.c_int
482
class datum_t(ctypes.Structure):
483
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
484
('size', ctypes.c_uint)]
485
class openpgp_crt_int(ctypes.Structure):
487
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
488
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
489
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
490
credentials_type_t = ctypes.c_int #
491
transport_ptr_t = ctypes.c_void_p
492
close_request_t = ctypes.c_int
495
class Error(Exception):
496
# We need to use the class name "GnuTLS" here, since this
497
# exception might be raised from within GnuTLS.__init__,
498
# which is called before the assignment to the "gnutls"
499
# global variable has happened.
500
def __init__(self, message = None, code = None, args=()):
501
# Default usage is by a message string, but if a return
502
# code is passed, convert it to a string with
505
if message is None and code is not None:
506
message = GnuTLS.strerror(code)
507
return super(GnuTLS.Error, self).__init__(
510
class CertificateSecurityError(Error):
514
class Credentials(object):
516
self._c_object = gnutls.certificate_credentials_t()
517
gnutls.certificate_allocate_credentials(
518
ctypes.byref(self._c_object))
519
self.type = gnutls.CRD_CERTIFICATE
522
gnutls.certificate_free_credentials(self._c_object)
524
class ClientSession(object):
525
def __init__(self, socket, credentials = None):
526
self._c_object = gnutls.session_t()
527
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
528
gnutls.set_default_priority(self._c_object)
529
gnutls.transport_set_ptr(self._c_object, socket.fileno())
530
gnutls.handshake_set_private_extensions(self._c_object,
533
if credentials is None:
534
credentials = gnutls.Credentials()
535
gnutls.credentials_set(self._c_object, credentials.type,
536
ctypes.cast(credentials._c_object,
538
self.credentials = credentials
541
gnutls.deinit(self._c_object)
544
return gnutls.handshake(self._c_object)
546
def send(self, data):
550
data_len -= gnutls.record_send(self._c_object,
555
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
557
# Error handling functions
558
def _error_code(result):
559
"""A function to raise exceptions on errors, suitable
560
for the 'restype' attribute on ctypes functions"""
563
if result == gnutls.E_NO_CERTIFICATE_FOUND:
564
raise gnutls.CertificateSecurityError(code = result)
565
raise gnutls.Error(code = result)
567
def _retry_on_error(result, func, arguments):
568
"""A function to retry on some errors, suitable
569
for the 'errcheck' attribute on ctypes functions"""
571
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
572
return _error_code(result)
573
result = func(*arguments)
576
# Unless otherwise indicated, the function declarations below are
577
# all from the gnutls/gnutls.h C header file.
580
priority_set_direct = _library.gnutls_priority_set_direct
581
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
582
ctypes.POINTER(ctypes.c_char_p)]
583
priority_set_direct.restype = _error_code
585
init = _library.gnutls_init
586
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
587
init.restype = _error_code
589
set_default_priority = _library.gnutls_set_default_priority
590
set_default_priority.argtypes = [session_t]
591
set_default_priority.restype = _error_code
593
record_send = _library.gnutls_record_send
594
record_send.argtypes = [session_t, ctypes.c_void_p,
596
record_send.restype = ctypes.c_ssize_t
597
record_send.errcheck = _retry_on_error
599
certificate_allocate_credentials = (
600
_library.gnutls_certificate_allocate_credentials)
601
certificate_allocate_credentials.argtypes = [
602
ctypes.POINTER(certificate_credentials_t)]
603
certificate_allocate_credentials.restype = _error_code
605
certificate_free_credentials = (
606
_library.gnutls_certificate_free_credentials)
607
certificate_free_credentials.argtypes = [certificate_credentials_t]
608
certificate_free_credentials.restype = None
610
handshake_set_private_extensions = (
611
_library.gnutls_handshake_set_private_extensions)
612
handshake_set_private_extensions.argtypes = [session_t,
614
handshake_set_private_extensions.restype = None
616
credentials_set = _library.gnutls_credentials_set
617
credentials_set.argtypes = [session_t, credentials_type_t,
619
credentials_set.restype = _error_code
621
strerror = _library.gnutls_strerror
622
strerror.argtypes = [ctypes.c_int]
623
strerror.restype = ctypes.c_char_p
625
certificate_type_get = _library.gnutls_certificate_type_get
626
certificate_type_get.argtypes = [session_t]
627
certificate_type_get.restype = _error_code
629
certificate_get_peers = _library.gnutls_certificate_get_peers
630
certificate_get_peers.argtypes = [session_t,
631
ctypes.POINTER(ctypes.c_uint)]
632
certificate_get_peers.restype = ctypes.POINTER(datum_t)
634
global_set_log_level = _library.gnutls_global_set_log_level
635
global_set_log_level.argtypes = [ctypes.c_int]
636
global_set_log_level.restype = None
638
global_set_log_function = _library.gnutls_global_set_log_function
639
global_set_log_function.argtypes = [log_func]
640
global_set_log_function.restype = None
642
deinit = _library.gnutls_deinit
643
deinit.argtypes = [session_t]
644
deinit.restype = None
646
handshake = _library.gnutls_handshake
647
handshake.argtypes = [session_t]
648
handshake.restype = _error_code
649
handshake.errcheck = _retry_on_error
651
transport_set_ptr = _library.gnutls_transport_set_ptr
652
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
653
transport_set_ptr.restype = None
655
bye = _library.gnutls_bye
656
bye.argtypes = [session_t, close_request_t]
657
bye.restype = _error_code
658
bye.errcheck = _retry_on_error
660
check_version = _library.gnutls_check_version
661
check_version.argtypes = [ctypes.c_char_p]
662
check_version.restype = ctypes.c_char_p
664
# All the function declarations below are from gnutls/openpgp.h
666
openpgp_crt_init = _library.gnutls_openpgp_crt_init
667
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
668
openpgp_crt_init.restype = _error_code
670
openpgp_crt_import = _library.gnutls_openpgp_crt_import
671
openpgp_crt_import.argtypes = [openpgp_crt_t,
672
ctypes.POINTER(datum_t),
674
openpgp_crt_import.restype = _error_code
676
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
677
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
678
ctypes.POINTER(ctypes.c_uint)]
679
openpgp_crt_verify_self.restype = _error_code
681
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
682
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
683
openpgp_crt_deinit.restype = None
685
openpgp_crt_get_fingerprint = (
686
_library.gnutls_openpgp_crt_get_fingerprint)
687
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
691
openpgp_crt_get_fingerprint.restype = _error_code
693
# Remove non-public functions
694
del _error_code, _retry_on_error
695
# Create the global "gnutls" object, simulating a module
698
def call_pipe(connection, # : multiprocessing.Connection
699
func, *args, **kwargs):
700
"""This function is meant to be called by multiprocessing.Process
702
This function runs func(*args, **kwargs), and writes the resulting
703
return value on the provided multiprocessing.Connection.
705
connection.send(func(*args, **kwargs))
173
708
class Client(object):
174
709
"""A representation of a client host served by this server.
176
name: string; from the config file, used in log messages
712
approved: bool(); 'None' if not yet approved/disapproved
713
approval_delay: datetime.timedelta(); Time to wait for approval
714
approval_duration: datetime.timedelta(); Duration of one approval
715
checker: subprocess.Popen(); a running checker process used
716
to see if the client lives.
717
'None' if no process is running.
718
checker_callback_tag: a gobject event source tag, or None
719
checker_command: string; External command which is run to check
720
if client lives. %() expansions are done at
721
runtime with vars(self) as dict, so that for
722
instance %(name)s can be used in the command.
723
checker_initiator_tag: a gobject event source tag, or None
724
created: datetime.datetime(); (UTC) object creation
725
client_structure: Object describing what attributes a client has
726
and is used for storing the client at exit
727
current_checker_command: string; current running checker_command
728
disable_initiator_tag: a gobject event source tag, or None
177
730
fingerprint: string (40 or 32 hexadecimal digits); used to
178
731
uniquely identify the client
179
secret: bytestring; sent verbatim (over TLS) to client
180
host: string; available for use by the checker command
181
created: datetime.datetime(); object creation, not client host
182
last_checked_ok: datetime.datetime() or None if not yet checked OK
183
timeout: datetime.timedelta(); How long from last_checked_ok
184
until this client is invalid
185
interval: datetime.timedelta(); How often to start a new checker
186
stop_hook: If set, called by stop() as stop_hook(self)
187
checker: subprocess.Popen(); a running checker process used
188
to see if the client lives.
189
'None' if no process is running.
190
checker_initiator_tag: a gobject event source tag, or None
191
stop_initiator_tag: - '' -
192
checker_callback_tag: - '' -
193
checker_command: string; External command which is run to check if
194
client lives. %() expansions are done at
195
runtime with vars(self) as dict, so that for
196
instance %(name)s can be used in the command.
198
_timeout: Real variable for 'timeout'
199
_interval: Real variable for 'interval'
200
_timeout_milliseconds: Used when calling gobject.timeout_add()
201
_interval_milliseconds: - '' -
732
host: string; available for use by the checker command
733
interval: datetime.timedelta(); How often to start a new checker
734
last_approval_request: datetime.datetime(); (UTC) or None
735
last_checked_ok: datetime.datetime(); (UTC) or None
736
last_checker_status: integer between 0 and 255 reflecting exit
737
status of last checker. -1 reflects crashed
738
checker, -2 means no checker completed yet.
739
last_checker_signal: The signal which killed the last checker, if
740
last_checker_status is -1
741
last_enabled: datetime.datetime(); (UTC) or None
742
name: string; from the config file, used in log messages and
744
secret: bytestring; sent verbatim (over TLS) to client
745
timeout: datetime.timedelta(); How long from last_checked_ok
746
until this client is disabled
747
extended_timeout: extra long timeout when secret has been sent
748
runtime_expansions: Allowed attributes for runtime expansion.
749
expires: datetime.datetime(); time (UTC) when a client will be
751
server_settings: The server_settings dict from main()
203
def _set_timeout(self, timeout):
204
"Setter function for 'timeout' attribute"
205
self._timeout = timeout
206
self._timeout_milliseconds = ((self.timeout.days
207
* 24 * 60 * 60 * 1000)
208
+ (self.timeout.seconds * 1000)
209
+ (self.timeout.microseconds
211
timeout = property(lambda self: self._timeout,
214
def _set_interval(self, interval):
215
"Setter function for 'interval' attribute"
216
self._interval = interval
217
self._interval_milliseconds = ((self.interval.days
218
* 24 * 60 * 60 * 1000)
219
+ (self.interval.seconds
221
+ (self.interval.microseconds
223
interval = property(lambda self: self._interval,
226
def __init__(self, name = None, stop_hook=None, config=None):
227
"""Note: the 'checker' key in 'config' sets the
228
'checker_command' attribute and *not* the 'checker'
754
runtime_expansions = ("approval_delay", "approval_duration",
755
"created", "enabled", "expires",
756
"fingerprint", "host", "interval",
757
"last_approval_request", "last_checked_ok",
758
"last_enabled", "name", "timeout")
761
"extended_timeout": "PT15M",
763
"checker": "fping -q -- %%(host)s",
765
"approval_delay": "PT0S",
766
"approval_duration": "PT1S",
767
"approved_by_default": "True",
772
def config_parser(config):
773
"""Construct a new dict of client settings of this form:
774
{ client_name: {setting_name: value, ...}, ...}
775
with exceptions for any special settings as defined above.
776
NOTE: Must be a pure function. Must return the same result
777
value given the same arguments.
780
for client_name in config.sections():
781
section = dict(config.items(client_name))
782
client = settings[client_name] = {}
784
client["host"] = section["host"]
785
# Reformat values from string types to Python types
786
client["approved_by_default"] = config.getboolean(
787
client_name, "approved_by_default")
788
client["enabled"] = config.getboolean(client_name,
791
# Uppercase and remove spaces from fingerprint for later
792
# comparison purposes with return value from the
793
# fingerprint() function
794
client["fingerprint"] = (section["fingerprint"].upper()
796
if "secret" in section:
797
client["secret"] = section["secret"].decode("base64")
798
elif "secfile" in section:
799
with open(os.path.expanduser(os.path.expandvars
800
(section["secfile"])),
802
client["secret"] = secfile.read()
804
raise TypeError("No secret or secfile for section {}"
806
client["timeout"] = string_to_delta(section["timeout"])
807
client["extended_timeout"] = string_to_delta(
808
section["extended_timeout"])
809
client["interval"] = string_to_delta(section["interval"])
810
client["approval_delay"] = string_to_delta(
811
section["approval_delay"])
812
client["approval_duration"] = string_to_delta(
813
section["approval_duration"])
814
client["checker_command"] = section["checker"]
815
client["last_approval_request"] = None
816
client["last_checked_ok"] = None
817
client["last_checker_status"] = -2
821
def __init__(self, settings, name = None, server_settings=None):
233
logger.debug(u"Creating client %r", self.name)
234
# Uppercase and remove spaces from fingerprint for later
235
# comparison purposes with return value from the fingerprint()
237
self.fingerprint = config["fingerprint"].upper()\
239
logger.debug(u" Fingerprint: %s", self.fingerprint)
240
if "secret" in config:
241
self.secret = config["secret"].decode(u"base64")
242
elif "secfile" in config:
243
secfile = open(os.path.expanduser(os.path.expandvars
244
(config["secfile"])))
245
self.secret = secfile.read()
823
if server_settings is None:
825
self.server_settings = server_settings
826
# adding all client settings
827
for setting, value in settings.items():
828
setattr(self, setting, value)
831
if not hasattr(self, "last_enabled"):
832
self.last_enabled = datetime.datetime.utcnow()
833
if not hasattr(self, "expires"):
834
self.expires = (datetime.datetime.utcnow()
248
raise TypeError(u"No secret or secfile for client %s"
250
self.host = config.get("host", "")
251
self.created = datetime.datetime.now()
252
self.last_checked_ok = None
253
self.timeout = string_to_delta(config["timeout"])
254
self.interval = string_to_delta(config["interval"])
255
self.stop_hook = stop_hook
837
self.last_enabled = None
840
logger.debug("Creating client %r", self.name)
841
logger.debug(" Fingerprint: %s", self.fingerprint)
842
self.created = settings.get("created",
843
datetime.datetime.utcnow())
845
# attributes specific for this server instance
256
846
self.checker = None
257
847
self.checker_initiator_tag = None
258
self.stop_initiator_tag = None
848
self.disable_initiator_tag = None
259
849
self.checker_callback_tag = None
260
self.check_command = config["checker"]
850
self.current_checker_command = None
852
self.approvals_pending = 0
853
self.changedstate = multiprocessing_manager.Condition(
854
multiprocessing_manager.Lock())
855
self.client_structure = [attr
856
for attr in self.__dict__.iterkeys()
857
if not attr.startswith("_")]
858
self.client_structure.append("client_structure")
860
for name, t in inspect.getmembers(
861
type(self), lambda obj: isinstance(obj, property)):
862
if not name.startswith("_"):
863
self.client_structure.append(name)
865
# Send notice to process children that client state has changed
866
def send_changedstate(self):
867
with self.changedstate:
868
self.changedstate.notify_all()
262
871
"""Start this client's checker and timeout hooks"""
872
if getattr(self, "enabled", False):
875
self.expires = datetime.datetime.utcnow() + self.timeout
877
self.last_enabled = datetime.datetime.utcnow()
879
self.send_changedstate()
881
def disable(self, quiet=True):
882
"""Disable this client."""
883
if not getattr(self, "enabled", False):
886
logger.info("Disabling client %s", self.name)
887
if getattr(self, "disable_initiator_tag", None) is not None:
888
gobject.source_remove(self.disable_initiator_tag)
889
self.disable_initiator_tag = None
891
if getattr(self, "checker_initiator_tag", None) is not None:
892
gobject.source_remove(self.checker_initiator_tag)
893
self.checker_initiator_tag = None
897
self.send_changedstate()
898
# Do not run this again if called by a gobject.timeout_add
904
def init_checker(self):
263
905
# Schedule a new checker to be started an 'interval' from now,
264
906
# and every interval from then on.
265
self.checker_initiator_tag = gobject.timeout_add\
266
(self._interval_milliseconds,
907
if self.checker_initiator_tag is not None:
908
gobject.source_remove(self.checker_initiator_tag)
909
self.checker_initiator_tag = gobject.timeout_add(
910
int(self.interval.total_seconds() * 1000),
912
# Schedule a disable() when 'timeout' has passed
913
if self.disable_initiator_tag is not None:
914
gobject.source_remove(self.disable_initiator_tag)
915
self.disable_initiator_tag = gobject.timeout_add(
916
int(self.timeout.total_seconds() * 1000), self.disable)
268
917
# Also start a new checker *right now*.
269
918
self.start_checker()
270
# Schedule a stop() when 'timeout' has passed
271
self.stop_initiator_tag = gobject.timeout_add\
272
(self._timeout_milliseconds,
276
The possibility that a client might be restarted is left open,
277
but not currently used."""
278
# If this client doesn't have a secret, it is already stopped.
279
if hasattr(self, "secret") and self.secret:
280
logger.info(u"Stopping client %s", self.name)
284
if getattr(self, "stop_initiator_tag", False):
285
gobject.source_remove(self.stop_initiator_tag)
286
self.stop_initiator_tag = None
287
if getattr(self, "checker_initiator_tag", False):
288
gobject.source_remove(self.checker_initiator_tag)
289
self.checker_initiator_tag = None
293
# Do not run this again if called by a gobject.timeout_add
296
self.stop_hook = None
298
def checker_callback(self, pid, condition):
920
def checker_callback(self, source, condition, connection,
299
922
"""The checker has completed, so take appropriate actions."""
300
now = datetime.datetime.now()
301
923
self.checker_callback_tag = None
302
924
self.checker = None
303
if os.WIFEXITED(condition) \
304
and (os.WEXITSTATUS(condition) == 0):
305
logger.info(u"Checker for %(name)s succeeded",
307
self.last_checked_ok = now
308
gobject.source_remove(self.stop_initiator_tag)
309
self.stop_initiator_tag = gobject.timeout_add\
310
(self._timeout_milliseconds,
312
elif not os.WIFEXITED(condition):
313
logger.warning(u"Checker for %(name)s crashed?",
925
# Read return code from connection (see call_pipe)
926
returncode = connection.recv()
930
self.last_checker_status = returncode
931
self.last_checker_signal = None
932
if self.last_checker_status == 0:
933
logger.info("Checker for %(name)s succeeded",
937
logger.info("Checker for %(name)s failed", vars(self))
939
self.last_checker_status = -1
940
self.last_checker_signal = -returncode
941
logger.warning("Checker for %(name)s crashed?",
316
logger.info(u"Checker for %(name)s failed",
945
def checked_ok(self):
946
"""Assert that the client has been seen, alive and well."""
947
self.last_checked_ok = datetime.datetime.utcnow()
948
self.last_checker_status = 0
949
self.last_checker_signal = None
952
def bump_timeout(self, timeout=None):
953
"""Bump up the timeout for this client."""
955
timeout = self.timeout
956
if self.disable_initiator_tag is not None:
957
gobject.source_remove(self.disable_initiator_tag)
958
self.disable_initiator_tag = None
959
if getattr(self, "enabled", False):
960
self.disable_initiator_tag = gobject.timeout_add(
961
int(timeout.total_seconds() * 1000), self.disable)
962
self.expires = datetime.datetime.utcnow() + timeout
964
def need_approval(self):
965
self.last_approval_request = datetime.datetime.utcnow()
318
967
def start_checker(self):
319
968
"""Start a new checker subprocess if one is not running.
320
970
If a checker already exists, leave it running and do
322
972
# The reason for not killing a running checker is that if we
323
# did that, then if a checker (for some reason) started
324
# running slowly and taking more than 'interval' time, the
325
# client would inevitably timeout, since no checker would get
326
# a chance to run to completion. If we instead leave running
973
# did that, and if a checker (for some reason) started running
974
# slowly and taking more than 'interval' time, then the client
975
# would inevitably timeout, since no checker would get a
976
# chance to run to completion. If we instead leave running
327
977
# checkers alone, the checker would have to take more time
328
# than 'timeout' for the client to be declared invalid, which
329
# is as it should be.
978
# than 'timeout' for the client to be disabled, which is as it
981
if self.checker is not None and not self.checker.is_alive():
982
logger.warning("Checker was not alive; joining")
985
# Start a new checker if needed
330
986
if self.checker is None:
332
# In case check_command has exactly one % operator
333
command = self.check_command % self.host
335
# Escape attributes for the shell
336
escaped_attrs = dict((key, re.escape(str(val)))
338
vars(self).iteritems())
340
command = self.check_command % escaped_attrs
341
except TypeError, error:
342
logger.error(u'Could not format string "%s":'
343
u' %s', self.check_command, error)
344
return True # Try again later
346
logger.info(u"Starting checker %r for %s",
348
# We don't need to redirect stdout and stderr, since
349
# in normal mode, that is already done by daemon(),
350
# and in debug mode we don't want to. (Stdin is
351
# always replaced by /dev/null.)
352
self.checker = subprocess.Popen(command,
355
self.checker_callback_tag = gobject.child_watch_add\
357
self.checker_callback)
358
except OSError, error:
359
logger.error(u"Failed to start subprocess: %s",
987
# Escape attributes for the shell
989
attr: re.escape(str(getattr(self, attr)))
990
for attr in self.runtime_expansions }
992
command = self.checker_command % escaped_attrs
993
except TypeError as error:
994
logger.error('Could not format string "%s"',
995
self.checker_command,
997
return True # Try again later
998
self.current_checker_command = command
999
logger.info("Starting checker %r for %s", command,
1001
# We don't need to redirect stdout and stderr, since
1002
# in normal mode, that is already done by daemon(),
1003
# and in debug mode we don't want to. (Stdin is
1004
# always replaced by /dev/null.)
1005
# The exception is when not debugging but nevertheless
1006
# running in the foreground; use the previously
1008
popen_args = { "close_fds": True,
1011
if (not self.server_settings["debug"]
1012
and self.server_settings["foreground"]):
1013
popen_args.update({"stdout": wnull,
1015
pipe = multiprocessing.Pipe(duplex = False)
1016
self.checker = multiprocessing.Process(
1018
args = (pipe[1], subprocess.call, command),
1019
kwargs = popen_args)
1020
self.checker.start()
1021
self.checker_callback_tag = gobject.io_add_watch(
1022
pipe[0].fileno(), gobject.IO_IN,
1023
self.checker_callback, pipe[0], command)
361
1024
# Re-run this periodically if run by gobject.timeout_add
363
1027
def stop_checker(self):
364
1028
"""Force the checker process, if any, to stop."""
365
1029
if self.checker_callback_tag:
367
1031
self.checker_callback_tag = None
368
1032
if getattr(self, "checker", None) is None:
370
logger.debug(u"Stopping checker for %(name)s", vars(self))
372
os.kill(self.checker.pid, signal.SIGTERM)
374
#if self.checker.poll() is None:
375
# os.kill(self.checker.pid, signal.SIGKILL)
376
except OSError, error:
377
if error.errno != errno.ESRCH: # No such process
1034
logger.debug("Stopping checker for %(name)s", vars(self))
1035
self.checker.terminate()
379
1036
self.checker = None
380
def still_valid(self):
381
"""Has the timeout not yet passed for this client?"""
382
now = datetime.datetime.now()
383
if self.last_checked_ok is None:
384
return now < (self.created + self.timeout)
386
return now < (self.last_checked_ok + self.timeout)
389
def peer_certificate(session):
390
"Return the peer's OpenPGP certificate as a bytestring"
391
# If not an OpenPGP certificate...
392
if gnutls.library.functions.gnutls_certificate_type_get\
393
(session._c_object) \
394
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
395
# ...do the normal thing
396
return session.peer_certificate
397
list_size = ctypes.c_uint()
398
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
399
(session._c_object, ctypes.byref(list_size))
400
if list_size.value == 0:
403
return ctypes.string_at(cert.data, cert.size)
406
def fingerprint(openpgp):
407
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
408
# New GnuTLS "datum" with the OpenPGP public key
409
datum = gnutls.library.types.gnutls_datum_t\
410
(ctypes.cast(ctypes.c_char_p(openpgp),
411
ctypes.POINTER(ctypes.c_ubyte)),
412
ctypes.c_uint(len(openpgp)))
413
# New empty GnuTLS certificate
414
crt = gnutls.library.types.gnutls_openpgp_crt_t()
415
gnutls.library.functions.gnutls_openpgp_crt_init\
417
# Import the OpenPGP public key into the certificate
418
gnutls.library.functions.gnutls_openpgp_crt_import\
419
(crt, ctypes.byref(datum),
420
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
421
# Verify the self signature in the key
422
crtverify = ctypes.c_uint()
423
gnutls.library.functions.gnutls_openpgp_crt_verify_self\
424
(crt, 0, ctypes.byref(crtverify))
425
if crtverify.value != 0:
426
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
427
raise gnutls.errors.CertificateSecurityError("Verify failed")
428
# New buffer for the fingerprint
429
buf = ctypes.create_string_buffer(20)
430
buf_len = ctypes.c_size_t()
431
# Get the fingerprint from the certificate into the buffer
432
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
433
(crt, ctypes.byref(buf), ctypes.byref(buf_len))
434
# Deinit the certificate
435
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
436
# Convert the buffer to a Python bytestring
437
fpr = ctypes.string_at(buf, buf_len.value)
438
# Convert the bytestring to hexadecimal notation
439
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
443
class TCP_handler(SocketServer.BaseRequestHandler, object):
444
"""A TCP request handler class.
445
Instantiated by IPv6_TCPServer for each request to handle it.
1039
def dbus_service_property(dbus_interface,
1043
"""Decorators for marking methods of a DBusObjectWithProperties to
1044
become properties on the D-Bus.
1046
The decorated method will be called with no arguments by "Get"
1047
and with one argument by "Set".
1049
The parameters, where they are supported, are the same as
1050
dbus.service.method, except there is only "signature", since the
1051
type from Get() and the type sent to Set() is the same.
1053
# Encoding deeply encoded byte arrays is not supported yet by the
1054
# "Set" method, so we fail early here:
1055
if byte_arrays and signature != "ay":
1056
raise ValueError("Byte arrays not supported for non-'ay'"
1057
" signature {!r}".format(signature))
1059
def decorator(func):
1060
func._dbus_is_property = True
1061
func._dbus_interface = dbus_interface
1062
func._dbus_signature = signature
1063
func._dbus_access = access
1064
func._dbus_name = func.__name__
1065
if func._dbus_name.endswith("_dbus_property"):
1066
func._dbus_name = func._dbus_name[:-14]
1067
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1073
def dbus_interface_annotations(dbus_interface):
1074
"""Decorator for marking functions returning interface annotations
1078
@dbus_interface_annotations("org.example.Interface")
1079
def _foo(self): # Function name does not matter
1080
return {"org.freedesktop.DBus.Deprecated": "true",
1081
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1085
def decorator(func):
1086
func._dbus_is_interface = True
1087
func._dbus_interface = dbus_interface
1088
func._dbus_name = dbus_interface
1094
def dbus_annotations(annotations):
1095
"""Decorator to annotate D-Bus methods, signals or properties
1098
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1099
"org.freedesktop.DBus.Property."
1100
"EmitsChangedSignal": "false"})
1101
@dbus_service_property("org.example.Interface", signature="b",
1103
def Property_dbus_property(self):
1104
return dbus.Boolean(False)
1106
See also the DBusObjectWithAnnotations class.
1109
def decorator(func):
1110
func._dbus_annotations = annotations
1116
class DBusPropertyException(dbus.exceptions.DBusException):
1117
"""A base class for D-Bus property-related exceptions
1122
class DBusPropertyAccessException(DBusPropertyException):
1123
"""A property's access permissions disallows an operation.
1128
class DBusPropertyNotFound(DBusPropertyException):
1129
"""An attempt was made to access a non-existing property.
1134
class DBusObjectWithAnnotations(dbus.service.Object):
1135
"""A D-Bus object with annotations.
1137
Classes inheriting from this can use the dbus_annotations
1138
decorator to add annotations to methods or signals.
1142
def _is_dbus_thing(thing):
1143
"""Returns a function testing if an attribute is a D-Bus thing
1145
If called like _is_dbus_thing("method") it returns a function
1146
suitable for use as predicate to inspect.getmembers().
1148
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1151
def _get_all_dbus_things(self, thing):
1152
"""Returns a generator of (name, attribute) pairs
1154
return ((getattr(athing.__get__(self), "_dbus_name", name),
1155
athing.__get__(self))
1156
for cls in self.__class__.__mro__
1158
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1160
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1161
out_signature = "s",
1162
path_keyword = 'object_path',
1163
connection_keyword = 'connection')
1164
def Introspect(self, object_path, connection):
1165
"""Overloading of standard D-Bus method.
1167
Inserts annotation tags on methods and signals.
1169
xmlstring = dbus.service.Object.Introspect(self, object_path,
1172
document = xml.dom.minidom.parseString(xmlstring)
1174
for if_tag in document.getElementsByTagName("interface"):
1175
# Add annotation tags
1176
for typ in ("method", "signal"):
1177
for tag in if_tag.getElementsByTagName(typ):
1179
for name, prop in (self.
1180
_get_all_dbus_things(typ)):
1181
if (name == tag.getAttribute("name")
1182
and prop._dbus_interface
1183
== if_tag.getAttribute("name")):
1184
annots.update(getattr(
1185
prop, "_dbus_annotations", {}))
1186
for name, value in annots.items():
1187
ann_tag = document.createElement(
1189
ann_tag.setAttribute("name", name)
1190
ann_tag.setAttribute("value", value)
1191
tag.appendChild(ann_tag)
1192
# Add interface annotation tags
1193
for annotation, value in dict(
1194
itertools.chain.from_iterable(
1195
annotations().items()
1196
for name, annotations
1197
in self._get_all_dbus_things("interface")
1198
if name == if_tag.getAttribute("name")
1200
ann_tag = document.createElement("annotation")
1201
ann_tag.setAttribute("name", annotation)
1202
ann_tag.setAttribute("value", value)
1203
if_tag.appendChild(ann_tag)
1204
# Fix argument name for the Introspect method itself
1205
if (if_tag.getAttribute("name")
1206
== dbus.INTROSPECTABLE_IFACE):
1207
for cn in if_tag.getElementsByTagName("method"):
1208
if cn.getAttribute("name") == "Introspect":
1209
for arg in cn.getElementsByTagName("arg"):
1210
if (arg.getAttribute("direction")
1212
arg.setAttribute("name",
1214
xmlstring = document.toxml("utf-8")
1216
except (AttributeError, xml.dom.DOMException,
1217
xml.parsers.expat.ExpatError) as error:
1218
logger.error("Failed to override Introspection method",
1223
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1224
"""A D-Bus object with properties.
1226
Classes inheriting from this can use the dbus_service_property
1227
decorator to expose methods as D-Bus properties. It exposes the
1228
standard Get(), Set(), and GetAll() methods on the D-Bus.
1231
def _get_dbus_property(self, interface_name, property_name):
1232
"""Returns a bound method if one exists which is a D-Bus
1233
property with the specified name and interface.
1235
for cls in self.__class__.__mro__:
1236
for name, value in inspect.getmembers(
1237
cls, self._is_dbus_thing("property")):
1238
if (value._dbus_name == property_name
1239
and value._dbus_interface == interface_name):
1240
return value.__get__(self)
1243
raise DBusPropertyNotFound("{}:{}.{}".format(
1244
self.dbus_object_path, interface_name, property_name))
1247
def _get_all_interface_names(cls):
1248
"""Get a sequence of all interfaces supported by an object"""
1249
return (name for name in set(getattr(getattr(x, attr),
1250
"_dbus_interface", None)
1251
for x in (inspect.getmro(cls))
1253
if name is not None)
1255
@dbus.service.method(dbus.PROPERTIES_IFACE,
1258
def Get(self, interface_name, property_name):
1259
"""Standard D-Bus property Get() method, see D-Bus standard.
1261
prop = self._get_dbus_property(interface_name, property_name)
1262
if prop._dbus_access == "write":
1263
raise DBusPropertyAccessException(property_name)
1265
if not hasattr(value, "variant_level"):
1267
return type(value)(value, variant_level=value.variant_level+1)
1269
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1270
def Set(self, interface_name, property_name, value):
1271
"""Standard D-Bus property Set() method, see D-Bus standard.
1273
prop = self._get_dbus_property(interface_name, property_name)
1274
if prop._dbus_access == "read":
1275
raise DBusPropertyAccessException(property_name)
1276
if prop._dbus_get_args_options["byte_arrays"]:
1277
# The byte_arrays option is not supported yet on
1278
# signatures other than "ay".
1279
if prop._dbus_signature != "ay":
1280
raise ValueError("Byte arrays not supported for non-"
1281
"'ay' signature {!r}"
1282
.format(prop._dbus_signature))
1283
value = dbus.ByteArray(b''.join(chr(byte)
1287
@dbus.service.method(dbus.PROPERTIES_IFACE,
1289
out_signature="a{sv}")
1290
def GetAll(self, interface_name):
1291
"""Standard D-Bus property GetAll() method, see D-Bus
1294
Note: Will not include properties with access="write".
1297
for name, prop in self._get_all_dbus_things("property"):
1299
and interface_name != prop._dbus_interface):
1300
# Interface non-empty but did not match
1302
# Ignore write-only properties
1303
if prop._dbus_access == "write":
1306
if not hasattr(value, "variant_level"):
1307
properties[name] = value
1309
properties[name] = type(value)(
1310
value, variant_level = value.variant_level + 1)
1311
return dbus.Dictionary(properties, signature="sv")
1313
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1314
def PropertiesChanged(self, interface_name, changed_properties,
1315
invalidated_properties):
1316
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1321
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1323
path_keyword='object_path',
1324
connection_keyword='connection')
1325
def Introspect(self, object_path, connection):
1326
"""Overloading of standard D-Bus method.
1328
Inserts property tags and interface annotation tags.
1330
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1334
document = xml.dom.minidom.parseString(xmlstring)
1336
def make_tag(document, name, prop):
1337
e = document.createElement("property")
1338
e.setAttribute("name", name)
1339
e.setAttribute("type", prop._dbus_signature)
1340
e.setAttribute("access", prop._dbus_access)
1343
for if_tag in document.getElementsByTagName("interface"):
1345
for tag in (make_tag(document, name, prop)
1347
in self._get_all_dbus_things("property")
1348
if prop._dbus_interface
1349
== if_tag.getAttribute("name")):
1350
if_tag.appendChild(tag)
1351
# Add annotation tags for properties
1352
for tag in if_tag.getElementsByTagName("property"):
1354
for name, prop in self._get_all_dbus_things(
1356
if (name == tag.getAttribute("name")
1357
and prop._dbus_interface
1358
== if_tag.getAttribute("name")):
1359
annots.update(getattr(
1360
prop, "_dbus_annotations", {}))
1361
for name, value in annots.items():
1362
ann_tag = document.createElement(
1364
ann_tag.setAttribute("name", name)
1365
ann_tag.setAttribute("value", value)
1366
tag.appendChild(ann_tag)
1367
# Add the names to the return values for the
1368
# "org.freedesktop.DBus.Properties" methods
1369
if (if_tag.getAttribute("name")
1370
== "org.freedesktop.DBus.Properties"):
1371
for cn in if_tag.getElementsByTagName("method"):
1372
if cn.getAttribute("name") == "Get":
1373
for arg in cn.getElementsByTagName("arg"):
1374
if (arg.getAttribute("direction")
1376
arg.setAttribute("name", "value")
1377
elif cn.getAttribute("name") == "GetAll":
1378
for arg in cn.getElementsByTagName("arg"):
1379
if (arg.getAttribute("direction")
1381
arg.setAttribute("name", "props")
1382
xmlstring = document.toxml("utf-8")
1384
except (AttributeError, xml.dom.DOMException,
1385
xml.parsers.expat.ExpatError) as error:
1386
logger.error("Failed to override Introspection method",
1391
dbus.OBJECT_MANAGER_IFACE
1392
except AttributeError:
1393
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1395
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1396
"""A D-Bus object with an ObjectManager.
1398
Classes inheriting from this exposes the standard
1399
GetManagedObjects call and the InterfacesAdded and
1400
InterfacesRemoved signals on the standard
1401
"org.freedesktop.DBus.ObjectManager" interface.
1403
Note: No signals are sent automatically; they must be sent
1406
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1407
out_signature = "a{oa{sa{sv}}}")
1408
def GetManagedObjects(self):
1409
"""This function must be overridden"""
1410
raise NotImplementedError()
1412
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1413
signature = "oa{sa{sv}}")
1414
def InterfacesAdded(self, object_path, interfaces_and_properties):
1417
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1418
def InterfacesRemoved(self, object_path, interfaces):
1421
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1422
out_signature = "s",
1423
path_keyword = 'object_path',
1424
connection_keyword = 'connection')
1425
def Introspect(self, object_path, connection):
1426
"""Overloading of standard D-Bus method.
1428
Override return argument name of GetManagedObjects to be
1429
"objpath_interfaces_and_properties"
1431
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1435
document = xml.dom.minidom.parseString(xmlstring)
1437
for if_tag in document.getElementsByTagName("interface"):
1438
# Fix argument name for the GetManagedObjects method
1439
if (if_tag.getAttribute("name")
1440
== dbus.OBJECT_MANAGER_IFACE):
1441
for cn in if_tag.getElementsByTagName("method"):
1442
if (cn.getAttribute("name")
1443
== "GetManagedObjects"):
1444
for arg in cn.getElementsByTagName("arg"):
1445
if (arg.getAttribute("direction")
1449
"objpath_interfaces"
1451
xmlstring = document.toxml("utf-8")
1453
except (AttributeError, xml.dom.DOMException,
1454
xml.parsers.expat.ExpatError) as error:
1455
logger.error("Failed to override Introspection method",
1459
def datetime_to_dbus(dt, variant_level=0):
1460
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1462
return dbus.String("", variant_level = variant_level)
1463
return dbus.String(dt.isoformat(), variant_level=variant_level)
1466
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1467
"""A class decorator; applied to a subclass of
1468
dbus.service.Object, it will add alternate D-Bus attributes with
1469
interface names according to the "alt_interface_names" mapping.
1472
@alternate_dbus_interfaces({"org.example.Interface":
1473
"net.example.AlternateInterface"})
1474
class SampleDBusObject(dbus.service.Object):
1475
@dbus.service.method("org.example.Interface")
1476
def SampleDBusMethod():
1479
The above "SampleDBusMethod" on "SampleDBusObject" will be
1480
reachable via two interfaces: "org.example.Interface" and
1481
"net.example.AlternateInterface", the latter of which will have
1482
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1483
"true", unless "deprecate" is passed with a False value.
1485
This works for methods and signals, and also for D-Bus properties
1486
(from DBusObjectWithProperties) and interfaces (from the
1487
dbus_interface_annotations decorator).
1491
for orig_interface_name, alt_interface_name in (
1492
alt_interface_names.items()):
1494
interface_names = set()
1495
# Go though all attributes of the class
1496
for attrname, attribute in inspect.getmembers(cls):
1497
# Ignore non-D-Bus attributes, and D-Bus attributes
1498
# with the wrong interface name
1499
if (not hasattr(attribute, "_dbus_interface")
1500
or not attribute._dbus_interface.startswith(
1501
orig_interface_name)):
1503
# Create an alternate D-Bus interface name based on
1505
alt_interface = attribute._dbus_interface.replace(
1506
orig_interface_name, alt_interface_name)
1507
interface_names.add(alt_interface)
1508
# Is this a D-Bus signal?
1509
if getattr(attribute, "_dbus_is_signal", False):
1510
if sys.version_info.major == 2:
1511
# Extract the original non-method undecorated
1512
# function by black magic
1513
nonmethod_func = (dict(
1514
zip(attribute.func_code.co_freevars,
1515
attribute.__closure__))
1516
["func"].cell_contents)
1518
nonmethod_func = attribute
1519
# Create a new, but exactly alike, function
1520
# object, and decorate it to be a new D-Bus signal
1521
# with the alternate D-Bus interface name
1522
if sys.version_info.major == 2:
1523
new_function = types.FunctionType(
1524
nonmethod_func.func_code,
1525
nonmethod_func.func_globals,
1526
nonmethod_func.func_name,
1527
nonmethod_func.func_defaults,
1528
nonmethod_func.func_closure)
1530
new_function = types.FunctionType(
1531
nonmethod_func.__code__,
1532
nonmethod_func.__globals__,
1533
nonmethod_func.__name__,
1534
nonmethod_func.__defaults__,
1535
nonmethod_func.__closure__)
1536
new_function = (dbus.service.signal(
1538
attribute._dbus_signature)(new_function))
1539
# Copy annotations, if any
1541
new_function._dbus_annotations = dict(
1542
attribute._dbus_annotations)
1543
except AttributeError:
1545
# Define a creator of a function to call both the
1546
# original and alternate functions, so both the
1547
# original and alternate signals gets sent when
1548
# the function is called
1549
def fixscope(func1, func2):
1550
"""This function is a scope container to pass
1551
func1 and func2 to the "call_both" function
1552
outside of its arguments"""
1554
@functools.wraps(func2)
1555
def call_both(*args, **kwargs):
1556
"""This function will emit two D-Bus
1557
signals by calling func1 and func2"""
1558
func1(*args, **kwargs)
1559
func2(*args, **kwargs)
1560
# Make wrapper function look like a D-Bus signal
1561
for name, attr in inspect.getmembers(func2):
1562
if name.startswith("_dbus_"):
1563
setattr(call_both, name, attr)
1566
# Create the "call_both" function and add it to
1568
attr[attrname] = fixscope(attribute, new_function)
1569
# Is this a D-Bus method?
1570
elif getattr(attribute, "_dbus_is_method", False):
1571
# Create a new, but exactly alike, function
1572
# object. Decorate it to be a new D-Bus method
1573
# with the alternate D-Bus interface name. Add it
1576
dbus.service.method(
1578
attribute._dbus_in_signature,
1579
attribute._dbus_out_signature)
1580
(types.FunctionType(attribute.func_code,
1581
attribute.func_globals,
1582
attribute.func_name,
1583
attribute.func_defaults,
1584
attribute.func_closure)))
1585
# Copy annotations, if any
1587
attr[attrname]._dbus_annotations = dict(
1588
attribute._dbus_annotations)
1589
except AttributeError:
1591
# Is this a D-Bus property?
1592
elif getattr(attribute, "_dbus_is_property", False):
1593
# Create a new, but exactly alike, function
1594
# object, and decorate it to be a new D-Bus
1595
# property with the alternate D-Bus interface
1596
# name. Add it to the class.
1597
attr[attrname] = (dbus_service_property(
1598
alt_interface, attribute._dbus_signature,
1599
attribute._dbus_access,
1600
attribute._dbus_get_args_options
1602
(types.FunctionType(
1603
attribute.func_code,
1604
attribute.func_globals,
1605
attribute.func_name,
1606
attribute.func_defaults,
1607
attribute.func_closure)))
1608
# Copy annotations, if any
1610
attr[attrname]._dbus_annotations = dict(
1611
attribute._dbus_annotations)
1612
except AttributeError:
1614
# Is this a D-Bus interface?
1615
elif getattr(attribute, "_dbus_is_interface", False):
1616
# Create a new, but exactly alike, function
1617
# object. Decorate it to be a new D-Bus interface
1618
# with the alternate D-Bus interface name. Add it
1621
dbus_interface_annotations(alt_interface)
1622
(types.FunctionType(attribute.func_code,
1623
attribute.func_globals,
1624
attribute.func_name,
1625
attribute.func_defaults,
1626
attribute.func_closure)))
1628
# Deprecate all alternate interfaces
1629
iname="_AlternateDBusNames_interface_annotation{}"
1630
for interface_name in interface_names:
1632
@dbus_interface_annotations(interface_name)
1634
return { "org.freedesktop.DBus.Deprecated":
1636
# Find an unused name
1637
for aname in (iname.format(i)
1638
for i in itertools.count()):
1639
if aname not in attr:
1643
# Replace the class with a new subclass of it with
1644
# methods, signals, etc. as created above.
1645
cls = type(b"{}Alternate".format(cls.__name__),
1652
@alternate_dbus_interfaces({"se.recompile.Mandos":
1653
"se.bsnet.fukt.Mandos"})
1654
class ClientDBus(Client, DBusObjectWithProperties):
1655
"""A Client class using D-Bus
1658
dbus_object_path: dbus.ObjectPath
1659
bus: dbus.SystemBus()
1662
runtime_expansions = (Client.runtime_expansions
1663
+ ("dbus_object_path", ))
1665
_interface = "se.recompile.Mandos.Client"
1667
# dbus.service.Object doesn't use super(), so we can't either.
1669
def __init__(self, bus = None, *args, **kwargs):
1671
Client.__init__(self, *args, **kwargs)
1672
# Only now, when this client is initialized, can it show up on
1674
client_object_name = str(self.name).translate(
1675
{ord("."): ord("_"),
1676
ord("-"): ord("_")})
1677
self.dbus_object_path = dbus.ObjectPath(
1678
"/clients/" + client_object_name)
1679
DBusObjectWithProperties.__init__(self, self.bus,
1680
self.dbus_object_path)
1682
def notifychangeproperty(transform_func, dbus_name,
1683
type_func=lambda x: x,
1685
invalidate_only=False,
1686
_interface=_interface):
1687
""" Modify a variable so that it's a property which announces
1688
its changes to DBus.
1690
transform_fun: Function that takes a value and a variant_level
1691
and transforms it to a D-Bus type.
1692
dbus_name: D-Bus name of the variable
1693
type_func: Function that transform the value before sending it
1694
to the D-Bus. Default: no transform
1695
variant_level: D-Bus variant level. Default: 1
1697
attrname = "_{}".format(dbus_name)
1699
def setter(self, value):
1700
if hasattr(self, "dbus_object_path"):
1701
if (not hasattr(self, attrname) or
1702
type_func(getattr(self, attrname, None))
1703
!= type_func(value)):
1705
self.PropertiesChanged(
1706
_interface, dbus.Dictionary(),
1707
dbus.Array((dbus_name, )))
1709
dbus_value = transform_func(
1711
variant_level = variant_level)
1712
self.PropertyChanged(dbus.String(dbus_name),
1714
self.PropertiesChanged(
1716
dbus.Dictionary({ dbus.String(dbus_name):
1719
setattr(self, attrname, value)
1721
return property(lambda self: getattr(self, attrname), setter)
1723
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1724
approvals_pending = notifychangeproperty(dbus.Boolean,
1727
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1728
last_enabled = notifychangeproperty(datetime_to_dbus,
1730
checker = notifychangeproperty(
1731
dbus.Boolean, "CheckerRunning",
1732
type_func = lambda checker: checker is not None)
1733
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1735
last_checker_status = notifychangeproperty(dbus.Int16,
1736
"LastCheckerStatus")
1737
last_approval_request = notifychangeproperty(
1738
datetime_to_dbus, "LastApprovalRequest")
1739
approved_by_default = notifychangeproperty(dbus.Boolean,
1740
"ApprovedByDefault")
1741
approval_delay = notifychangeproperty(
1742
dbus.UInt64, "ApprovalDelay",
1743
type_func = lambda td: td.total_seconds() * 1000)
1744
approval_duration = notifychangeproperty(
1745
dbus.UInt64, "ApprovalDuration",
1746
type_func = lambda td: td.total_seconds() * 1000)
1747
host = notifychangeproperty(dbus.String, "Host")
1748
timeout = notifychangeproperty(
1749
dbus.UInt64, "Timeout",
1750
type_func = lambda td: td.total_seconds() * 1000)
1751
extended_timeout = notifychangeproperty(
1752
dbus.UInt64, "ExtendedTimeout",
1753
type_func = lambda td: td.total_seconds() * 1000)
1754
interval = notifychangeproperty(
1755
dbus.UInt64, "Interval",
1756
type_func = lambda td: td.total_seconds() * 1000)
1757
checker_command = notifychangeproperty(dbus.String, "Checker")
1758
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1759
invalidate_only=True)
1761
del notifychangeproperty
1763
def __del__(self, *args, **kwargs):
1765
self.remove_from_connection()
1768
if hasattr(DBusObjectWithProperties, "__del__"):
1769
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1770
Client.__del__(self, *args, **kwargs)
1772
def checker_callback(self, source, condition,
1773
connection, command, *args, **kwargs):
1774
ret = Client.checker_callback(self, source, condition,
1775
connection, command, *args,
1777
exitstatus = self.last_checker_status
1780
self.CheckerCompleted(dbus.Int16(exitstatus),
1781
# This is specific to GNU libC
1782
dbus.Int64(exitstatus << 8),
1783
dbus.String(command))
1786
self.CheckerCompleted(dbus.Int16(-1),
1788
# This is specific to GNU libC
1790
| self.last_checker_signal),
1791
dbus.String(command))
1794
def start_checker(self, *args, **kwargs):
1795
old_checker_pid = getattr(self.checker, "pid", None)
1796
r = Client.start_checker(self, *args, **kwargs)
1797
# Only if new checker process was started
1798
if (self.checker is not None
1799
and old_checker_pid != self.checker.pid):
1801
self.CheckerStarted(self.current_checker_command)
1804
def _reset_approved(self):
1805
self.approved = None
1808
def approve(self, value=True):
1809
self.approved = value
1810
gobject.timeout_add(int(self.approval_duration.total_seconds()
1811
* 1000), self._reset_approved)
1812
self.send_changedstate()
1814
## D-Bus methods, signals & properties
1820
# CheckerCompleted - signal
1821
@dbus.service.signal(_interface, signature="nxs")
1822
def CheckerCompleted(self, exitcode, waitstatus, command):
1826
# CheckerStarted - signal
1827
@dbus.service.signal(_interface, signature="s")
1828
def CheckerStarted(self, command):
1832
# PropertyChanged - signal
1833
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1834
@dbus.service.signal(_interface, signature="sv")
1835
def PropertyChanged(self, property, value):
1839
# GotSecret - signal
1840
@dbus.service.signal(_interface)
1841
def GotSecret(self):
1843
Is sent after a successful transfer of secret from the Mandos
1844
server to mandos-client
1849
@dbus.service.signal(_interface, signature="s")
1850
def Rejected(self, reason):
1854
# NeedApproval - signal
1855
@dbus.service.signal(_interface, signature="tb")
1856
def NeedApproval(self, timeout, default):
1858
return self.need_approval()
1863
@dbus.service.method(_interface, in_signature="b")
1864
def Approve(self, value):
1867
# CheckedOK - method
1868
@dbus.service.method(_interface)
1869
def CheckedOK(self):
1873
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1874
@dbus.service.method(_interface)
1879
# StartChecker - method
1880
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1881
@dbus.service.method(_interface)
1882
def StartChecker(self):
1884
self.start_checker()
1887
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1888
@dbus.service.method(_interface)
1893
# StopChecker - method
1894
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1895
@dbus.service.method(_interface)
1896
def StopChecker(self):
1901
# ApprovalPending - property
1902
@dbus_service_property(_interface, signature="b", access="read")
1903
def ApprovalPending_dbus_property(self):
1904
return dbus.Boolean(bool(self.approvals_pending))
1906
# ApprovedByDefault - property
1907
@dbus_service_property(_interface,
1910
def ApprovedByDefault_dbus_property(self, value=None):
1911
if value is None: # get
1912
return dbus.Boolean(self.approved_by_default)
1913
self.approved_by_default = bool(value)
1915
# ApprovalDelay - property
1916
@dbus_service_property(_interface,
1919
def ApprovalDelay_dbus_property(self, value=None):
1920
if value is None: # get
1921
return dbus.UInt64(self.approval_delay.total_seconds()
1923
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1925
# ApprovalDuration - property
1926
@dbus_service_property(_interface,
1929
def ApprovalDuration_dbus_property(self, value=None):
1930
if value is None: # get
1931
return dbus.UInt64(self.approval_duration.total_seconds()
1933
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1937
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1938
@dbus_service_property(_interface, signature="s", access="read")
1939
def Name_dbus_property(self):
1940
return dbus.String(self.name)
1942
# Fingerprint - property
1944
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1945
@dbus_service_property(_interface, signature="s", access="read")
1946
def Fingerprint_dbus_property(self):
1947
return dbus.String(self.fingerprint)
1950
@dbus_service_property(_interface,
1953
def Host_dbus_property(self, value=None):
1954
if value is None: # get
1955
return dbus.String(self.host)
1956
self.host = str(value)
1958
# Created - property
1960
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1961
@dbus_service_property(_interface, signature="s", access="read")
1962
def Created_dbus_property(self):
1963
return datetime_to_dbus(self.created)
1965
# LastEnabled - property
1966
@dbus_service_property(_interface, signature="s", access="read")
1967
def LastEnabled_dbus_property(self):
1968
return datetime_to_dbus(self.last_enabled)
1970
# Enabled - property
1971
@dbus_service_property(_interface,
1974
def Enabled_dbus_property(self, value=None):
1975
if value is None: # get
1976
return dbus.Boolean(self.enabled)
1982
# LastCheckedOK - property
1983
@dbus_service_property(_interface,
1986
def LastCheckedOK_dbus_property(self, value=None):
1987
if value is not None:
1990
return datetime_to_dbus(self.last_checked_ok)
1992
# LastCheckerStatus - property
1993
@dbus_service_property(_interface, signature="n", access="read")
1994
def LastCheckerStatus_dbus_property(self):
1995
return dbus.Int16(self.last_checker_status)
1997
# Expires - property
1998
@dbus_service_property(_interface, signature="s", access="read")
1999
def Expires_dbus_property(self):
2000
return datetime_to_dbus(self.expires)
2002
# LastApprovalRequest - property
2003
@dbus_service_property(_interface, signature="s", access="read")
2004
def LastApprovalRequest_dbus_property(self):
2005
return datetime_to_dbus(self.last_approval_request)
2007
# Timeout - property
2008
@dbus_service_property(_interface,
2011
def Timeout_dbus_property(self, value=None):
2012
if value is None: # get
2013
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2014
old_timeout = self.timeout
2015
self.timeout = datetime.timedelta(0, 0, 0, value)
2016
# Reschedule disabling
2018
now = datetime.datetime.utcnow()
2019
self.expires += self.timeout - old_timeout
2020
if self.expires <= now:
2021
# The timeout has passed
2024
if (getattr(self, "disable_initiator_tag", None)
2027
gobject.source_remove(self.disable_initiator_tag)
2028
self.disable_initiator_tag = gobject.timeout_add(
2029
int((self.expires - now).total_seconds() * 1000),
2032
# ExtendedTimeout - property
2033
@dbus_service_property(_interface,
2036
def ExtendedTimeout_dbus_property(self, value=None):
2037
if value is None: # get
2038
return dbus.UInt64(self.extended_timeout.total_seconds()
2040
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2042
# Interval - property
2043
@dbus_service_property(_interface,
2046
def Interval_dbus_property(self, value=None):
2047
if value is None: # get
2048
return dbus.UInt64(self.interval.total_seconds() * 1000)
2049
self.interval = datetime.timedelta(0, 0, 0, value)
2050
if getattr(self, "checker_initiator_tag", None) is None:
2053
# Reschedule checker run
2054
gobject.source_remove(self.checker_initiator_tag)
2055
self.checker_initiator_tag = gobject.timeout_add(
2056
value, self.start_checker)
2057
self.start_checker() # Start one now, too
2059
# Checker - property
2060
@dbus_service_property(_interface,
2063
def Checker_dbus_property(self, value=None):
2064
if value is None: # get
2065
return dbus.String(self.checker_command)
2066
self.checker_command = str(value)
2068
# CheckerRunning - property
2069
@dbus_service_property(_interface,
2072
def CheckerRunning_dbus_property(self, value=None):
2073
if value is None: # get
2074
return dbus.Boolean(self.checker is not None)
2076
self.start_checker()
2080
# ObjectPath - property
2082
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2083
"org.freedesktop.DBus.Deprecated": "true"})
2084
@dbus_service_property(_interface, signature="o", access="read")
2085
def ObjectPath_dbus_property(self):
2086
return self.dbus_object_path # is already a dbus.ObjectPath
2090
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2092
@dbus_service_property(_interface,
2096
def Secret_dbus_property(self, value):
2097
self.secret = bytes(value)
2102
class ProxyClient(object):
2103
def __init__(self, child_pipe, fpr, address):
2104
self._pipe = child_pipe
2105
self._pipe.send(('init', fpr, address))
2106
if not self._pipe.recv():
2109
def __getattribute__(self, name):
2111
return super(ProxyClient, self).__getattribute__(name)
2112
self._pipe.send(('getattr', name))
2113
data = self._pipe.recv()
2114
if data[0] == 'data':
2116
if data[0] == 'function':
2118
def func(*args, **kwargs):
2119
self._pipe.send(('funcall', name, args, kwargs))
2120
return self._pipe.recv()[1]
2124
def __setattr__(self, name, value):
2126
return super(ProxyClient, self).__setattr__(name, value)
2127
self._pipe.send(('setattr', name, value))
2130
class ClientHandler(socketserver.BaseRequestHandler, object):
2131
"""A class to handle client connections.
2133
Instantiated once for each connection to handle it.
446
2134
Note: This will run in its own forked process."""
448
2136
def handle(self):
449
logger.info(u"TCP connection from: %s",
450
unicode(self.client_address))
451
session = gnutls.connection.ClientSession\
452
(self.request, gnutls.connection.X509Credentials())
454
line = self.request.makefile().readline()
455
logger.debug(u"Protocol version: %r", line)
457
if int(line.strip().split()[0]) > 1:
459
except (ValueError, IndexError, RuntimeError), error:
460
logger.error(u"Unknown protocol version: %s", error)
463
# Note: gnutls.connection.X509Credentials is really a generic
464
# GnuTLS certificate credentials object so long as no X.509
465
# keys are added to it. Therefore, we can use it here despite
466
# using OpenPGP certificates.
468
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
469
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
471
priority = "NORMAL" # Fallback default, since this
473
if self.server.settings["priority"]:
474
priority = self.server.settings["priority"]
475
gnutls.library.functions.gnutls_priority_set_direct\
476
(session._c_object, priority, None)
480
except gnutls.errors.GNUTLSError, error:
481
logger.warning(u"Handshake failed: %s", error)
482
# Do not run session.bye() here: the session is not
483
# established. Just abandon the request.
486
fpr = fingerprint(peer_certificate(session))
487
except (TypeError, gnutls.errors.GNUTLSError), error:
488
logger.warning(u"Bad certificate: %s", error)
491
logger.debug(u"Fingerprint: %s", fpr)
493
for c in self.server.clients:
494
if c.fingerprint == fpr:
498
logger.warning(u"Client not found for fingerprint: %s",
502
# Have to check if client.still_valid(), since it is possible
503
# that the client timed out while establishing the GnuTLS
505
if not client.still_valid():
506
logger.warning(u"Client %(name)s is invalid",
511
while sent_size < len(client.secret):
512
sent = session.send(client.secret[sent_size:])
513
logger.debug(u"Sent: %d, remaining: %d",
514
sent, len(client.secret)
515
- (sent_size + sent))
520
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
521
"""IPv6 TCP server. Accepts 'None' as address and/or port.
2137
with contextlib.closing(self.server.child_pipe) as child_pipe:
2138
logger.info("TCP connection from: %s",
2139
str(self.client_address))
2140
logger.debug("Pipe FD: %d",
2141
self.server.child_pipe.fileno())
2143
session = gnutls.ClientSession(self.request)
2145
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2146
# "+AES-256-CBC", "+SHA1",
2147
# "+COMP-NULL", "+CTYPE-OPENPGP",
2149
# Use a fallback default, since this MUST be set.
2150
priority = self.server.gnutls_priority
2151
if priority is None:
2153
gnutls.priority_set_direct(session._c_object, priority,
2156
# Start communication using the Mandos protocol
2157
# Get protocol number
2158
line = self.request.makefile().readline()
2159
logger.debug("Protocol version: %r", line)
2161
if int(line.strip().split()[0]) > 1:
2162
raise RuntimeError(line)
2163
except (ValueError, IndexError, RuntimeError) as error:
2164
logger.error("Unknown protocol version: %s", error)
2167
# Start GnuTLS connection
2170
except gnutls.Error as error:
2171
logger.warning("Handshake failed: %s", error)
2172
# Do not run session.bye() here: the session is not
2173
# established. Just abandon the request.
2175
logger.debug("Handshake succeeded")
2177
approval_required = False
2180
fpr = self.fingerprint(
2181
self.peer_certificate(session))
2182
except (TypeError, gnutls.Error) as error:
2183
logger.warning("Bad certificate: %s", error)
2185
logger.debug("Fingerprint: %s", fpr)
2188
client = ProxyClient(child_pipe, fpr,
2189
self.client_address)
2193
if client.approval_delay:
2194
delay = client.approval_delay
2195
client.approvals_pending += 1
2196
approval_required = True
2199
if not client.enabled:
2200
logger.info("Client %s is disabled",
2202
if self.server.use_dbus:
2204
client.Rejected("Disabled")
2207
if client.approved or not client.approval_delay:
2208
#We are approved or approval is disabled
2210
elif client.approved is None:
2211
logger.info("Client %s needs approval",
2213
if self.server.use_dbus:
2215
client.NeedApproval(
2216
client.approval_delay.total_seconds()
2217
* 1000, client.approved_by_default)
2219
logger.warning("Client %s was not approved",
2221
if self.server.use_dbus:
2223
client.Rejected("Denied")
2226
#wait until timeout or approved
2227
time = datetime.datetime.now()
2228
client.changedstate.acquire()
2229
client.changedstate.wait(delay.total_seconds())
2230
client.changedstate.release()
2231
time2 = datetime.datetime.now()
2232
if (time2 - time) >= delay:
2233
if not client.approved_by_default:
2234
logger.warning("Client %s timed out while"
2235
" waiting for approval",
2237
if self.server.use_dbus:
2239
client.Rejected("Approval timed out")
2244
delay -= time2 - time
2247
session.send(client.secret)
2248
except gnutls.Error as error:
2249
logger.warning("gnutls send failed",
2253
logger.info("Sending secret to %s", client.name)
2254
# bump the timeout using extended_timeout
2255
client.bump_timeout(client.extended_timeout)
2256
if self.server.use_dbus:
2261
if approval_required:
2262
client.approvals_pending -= 1
2265
except gnutls.Error as error:
2266
logger.warning("GnuTLS bye failed",
2270
def peer_certificate(session):
2271
"Return the peer's OpenPGP certificate as a bytestring"
2272
# If not an OpenPGP certificate...
2273
if (gnutls.certificate_type_get(session._c_object)
2274
!= gnutls.CRT_OPENPGP):
2275
# ...return invalid data
2277
list_size = ctypes.c_uint(1)
2278
cert_list = (gnutls.certificate_get_peers
2279
(session._c_object, ctypes.byref(list_size)))
2280
if not bool(cert_list) and list_size.value != 0:
2281
raise gnutls.Error("error getting peer certificate")
2282
if list_size.value == 0:
2285
return ctypes.string_at(cert.data, cert.size)
2288
def fingerprint(openpgp):
2289
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2290
# New GnuTLS "datum" with the OpenPGP public key
2291
datum = gnutls.datum_t(
2292
ctypes.cast(ctypes.c_char_p(openpgp),
2293
ctypes.POINTER(ctypes.c_ubyte)),
2294
ctypes.c_uint(len(openpgp)))
2295
# New empty GnuTLS certificate
2296
crt = gnutls.openpgp_crt_t()
2297
gnutls.openpgp_crt_init(ctypes.byref(crt))
2298
# Import the OpenPGP public key into the certificate
2299
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2300
gnutls.OPENPGP_FMT_RAW)
2301
# Verify the self signature in the key
2302
crtverify = ctypes.c_uint()
2303
gnutls.openpgp_crt_verify_self(crt, 0,
2304
ctypes.byref(crtverify))
2305
if crtverify.value != 0:
2306
gnutls.openpgp_crt_deinit(crt)
2307
raise gnutls.CertificateSecurityError("Verify failed")
2308
# New buffer for the fingerprint
2309
buf = ctypes.create_string_buffer(20)
2310
buf_len = ctypes.c_size_t()
2311
# Get the fingerprint from the certificate into the buffer
2312
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2313
ctypes.byref(buf_len))
2314
# Deinit the certificate
2315
gnutls.openpgp_crt_deinit(crt)
2316
# Convert the buffer to a Python bytestring
2317
fpr = ctypes.string_at(buf, buf_len.value)
2318
# Convert the bytestring to hexadecimal notation
2319
hex_fpr = binascii.hexlify(fpr).upper()
2323
class MultiprocessingMixIn(object):
2324
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2326
def sub_process_main(self, request, address):
2328
self.finish_request(request, address)
2330
self.handle_error(request, address)
2331
self.close_request(request)
2333
def process_request(self, request, address):
2334
"""Start a new process to process the request."""
2335
proc = multiprocessing.Process(target = self.sub_process_main,
2336
args = (request, address))
2341
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2342
""" adds a pipe to the MixIn """
2344
def process_request(self, request, client_address):
2345
"""Overrides and wraps the original process_request().
2347
This function creates a new pipe in self.pipe
2349
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2351
proc = MultiprocessingMixIn.process_request(self, request,
2353
self.child_pipe.close()
2354
self.add_pipe(parent_pipe, proc)
2356
def add_pipe(self, parent_pipe, proc):
2357
"""Dummy function; override as necessary"""
2358
raise NotImplementedError()
2361
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2362
socketserver.TCPServer, object):
2363
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
523
settings: Server settings
524
clients: Set() of Client objects
525
2366
enabled: Boolean; whether this server is activated yet
2367
interface: None or a network interface name (string)
2368
use_ipv6: Boolean; to use IPv6 or not
527
address_family = socket.AF_INET6
528
def __init__(self, *args, **kwargs):
529
if "settings" in kwargs:
530
self.settings = kwargs["settings"]
531
del kwargs["settings"]
532
if "clients" in kwargs:
533
self.clients = kwargs["clients"]
534
del kwargs["clients"]
536
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
2371
def __init__(self, server_address, RequestHandlerClass,
2375
"""If socketfd is set, use that file descriptor instead of
2376
creating a new one with socket.socket().
2378
self.interface = interface
2380
self.address_family = socket.AF_INET6
2381
if socketfd is not None:
2382
# Save the file descriptor
2383
self.socketfd = socketfd
2384
# Save the original socket.socket() function
2385
self.socket_socket = socket.socket
2386
# To implement --socket, we monkey patch socket.socket.
2388
# (When socketserver.TCPServer is a new-style class, we
2389
# could make self.socket into a property instead of monkey
2390
# patching socket.socket.)
2392
# Create a one-time-only replacement for socket.socket()
2393
@functools.wraps(socket.socket)
2394
def socket_wrapper(*args, **kwargs):
2395
# Restore original function so subsequent calls are
2397
socket.socket = self.socket_socket
2398
del self.socket_socket
2399
# This time only, return a new socket object from the
2400
# saved file descriptor.
2401
return socket.fromfd(self.socketfd, *args, **kwargs)
2402
# Replace socket.socket() function with wrapper
2403
socket.socket = socket_wrapper
2404
# The socketserver.TCPServer.__init__ will call
2405
# socket.socket(), which might be our replacement,
2406
# socket_wrapper(), if socketfd was set.
2407
socketserver.TCPServer.__init__(self, server_address,
2408
RequestHandlerClass)
537
2410
def server_bind(self):
538
2411
"""This overrides the normal server_bind() function
539
2412
to bind to an interface if one was specified, and also NOT to
540
2413
bind to an address or port if they were not specified."""
541
if self.settings["interface"]:
542
# 25 is from /usr/include/asm-i486/socket.h
543
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
545
self.socket.setsockopt(socket.SOL_SOCKET,
547
self.settings["interface"])
548
except socket.error, error:
549
if error[0] == errno.EPERM:
550
logger.error(u"No permission to"
551
u" bind to interface %s",
552
self.settings["interface"])
2414
if self.interface is not None:
2415
if SO_BINDTODEVICE is None:
2416
logger.error("SO_BINDTODEVICE does not exist;"
2417
" cannot bind to interface %s",
2421
self.socket.setsockopt(
2422
socket.SOL_SOCKET, SO_BINDTODEVICE,
2423
(self.interface + "\0").encode("utf-8"))
2424
except socket.error as error:
2425
if error.errno == errno.EPERM:
2426
logger.error("No permission to bind to"
2427
" interface %s", self.interface)
2428
elif error.errno == errno.ENOPROTOOPT:
2429
logger.error("SO_BINDTODEVICE not available;"
2430
" cannot bind to interface %s",
2432
elif error.errno == errno.ENODEV:
2433
logger.error("Interface %s does not exist,"
2434
" cannot bind", self.interface)
555
2437
# Only bind(2) the socket if we really need to.
556
2438
if self.server_address[0] or self.server_address[1]:
557
2439
if not self.server_address[0]:
559
self.server_address = (in6addr_any,
2440
if self.address_family == socket.AF_INET6:
2441
any_address = "::" # in6addr_any
2443
any_address = "0.0.0.0" # INADDR_ANY
2444
self.server_address = (any_address,
560
2445
self.server_address[1])
561
2446
elif not self.server_address[1]:
562
self.server_address = (self.server_address[0],
564
# if self.settings["interface"]:
2447
self.server_address = (self.server_address[0], 0)
2448
# if self.interface:
565
2449
# self.server_address = (self.server_address[0],
568
2452
# if_nametoindex
571
return super(IPv6_TCPServer, self).server_bind()
2454
return socketserver.TCPServer.server_bind(self)
2457
class MandosServer(IPv6_TCPServer):
2461
clients: set of Client objects
2462
gnutls_priority GnuTLS priority string
2463
use_dbus: Boolean; to emit D-Bus signals or not
2465
Assumes a gobject.MainLoop event loop.
2468
def __init__(self, server_address, RequestHandlerClass,
2472
gnutls_priority=None,
2475
self.enabled = False
2476
self.clients = clients
2477
if self.clients is None:
2479
self.use_dbus = use_dbus
2480
self.gnutls_priority = gnutls_priority
2481
IPv6_TCPServer.__init__(self, server_address,
2482
RequestHandlerClass,
2483
interface = interface,
2484
use_ipv6 = use_ipv6,
2485
socketfd = socketfd)
572
2487
def server_activate(self):
573
2488
if self.enabled:
574
return super(IPv6_TCPServer, self).server_activate()
2489
return socketserver.TCPServer.server_activate(self)
575
2491
def enable(self):
576
2492
self.enabled = True
2494
def add_pipe(self, parent_pipe, proc):
2495
# Call "handle_ipc" for both data and EOF events
2496
gobject.io_add_watch(
2497
parent_pipe.fileno(),
2498
gobject.IO_IN | gobject.IO_HUP,
2499
functools.partial(self.handle_ipc,
2500
parent_pipe = parent_pipe,
2503
def handle_ipc(self, source, condition,
2506
client_object=None):
2507
# error, or the other end of multiprocessing.Pipe has closed
2508
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2509
# Wait for other process to exit
2513
# Read a request from the child
2514
request = parent_pipe.recv()
2515
command = request[0]
2517
if command == 'init':
2519
address = request[2]
2521
for c in self.clients.itervalues():
2522
if c.fingerprint == fpr:
2526
logger.info("Client not found for fingerprint: %s, ad"
2527
"dress: %s", fpr, address)
2530
mandos_dbus_service.ClientNotFound(fpr,
2532
parent_pipe.send(False)
2535
gobject.io_add_watch(
2536
parent_pipe.fileno(),
2537
gobject.IO_IN | gobject.IO_HUP,
2538
functools.partial(self.handle_ipc,
2539
parent_pipe = parent_pipe,
2541
client_object = client))
2542
parent_pipe.send(True)
2543
# remove the old hook in favor of the new above hook on
2546
if command == 'funcall':
2547
funcname = request[1]
2551
parent_pipe.send(('data', getattr(client_object,
2555
if command == 'getattr':
2556
attrname = request[1]
2557
if isinstance(client_object.__getattribute__(attrname),
2558
collections.Callable):
2559
parent_pipe.send(('function', ))
2562
'data', client_object.__getattribute__(attrname)))
2564
if command == 'setattr':
2565
attrname = request[1]
2567
setattr(client_object, attrname, value)
2572
def rfc3339_duration_to_delta(duration):
2573
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2575
>>> rfc3339_duration_to_delta("P7D")
2576
datetime.timedelta(7)
2577
>>> rfc3339_duration_to_delta("PT60S")
2578
datetime.timedelta(0, 60)
2579
>>> rfc3339_duration_to_delta("PT60M")
2580
datetime.timedelta(0, 3600)
2581
>>> rfc3339_duration_to_delta("PT24H")
2582
datetime.timedelta(1)
2583
>>> rfc3339_duration_to_delta("P1W")
2584
datetime.timedelta(7)
2585
>>> rfc3339_duration_to_delta("PT5M30S")
2586
datetime.timedelta(0, 330)
2587
>>> rfc3339_duration_to_delta("P1DT3M20S")
2588
datetime.timedelta(1, 200)
2591
# Parsing an RFC 3339 duration with regular expressions is not
2592
# possible - there would have to be multiple places for the same
2593
# values, like seconds. The current code, while more esoteric, is
2594
# cleaner without depending on a parsing library. If Python had a
2595
# built-in library for parsing we would use it, but we'd like to
2596
# avoid excessive use of external libraries.
2598
# New type for defining tokens, syntax, and semantics all-in-one
2599
Token = collections.namedtuple("Token", (
2600
"regexp", # To match token; if "value" is not None, must have
2601
# a "group" containing digits
2602
"value", # datetime.timedelta or None
2603
"followers")) # Tokens valid after this token
2604
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2605
# the "duration" ABNF definition in RFC 3339, Appendix A.
2606
token_end = Token(re.compile(r"$"), None, frozenset())
2607
token_second = Token(re.compile(r"(\d+)S"),
2608
datetime.timedelta(seconds=1),
2609
frozenset((token_end, )))
2610
token_minute = Token(re.compile(r"(\d+)M"),
2611
datetime.timedelta(minutes=1),
2612
frozenset((token_second, token_end)))
2613
token_hour = Token(re.compile(r"(\d+)H"),
2614
datetime.timedelta(hours=1),
2615
frozenset((token_minute, token_end)))
2616
token_time = Token(re.compile(r"T"),
2618
frozenset((token_hour, token_minute,
2620
token_day = Token(re.compile(r"(\d+)D"),
2621
datetime.timedelta(days=1),
2622
frozenset((token_time, token_end)))
2623
token_month = Token(re.compile(r"(\d+)M"),
2624
datetime.timedelta(weeks=4),
2625
frozenset((token_day, token_end)))
2626
token_year = Token(re.compile(r"(\d+)Y"),
2627
datetime.timedelta(weeks=52),
2628
frozenset((token_month, token_end)))
2629
token_week = Token(re.compile(r"(\d+)W"),
2630
datetime.timedelta(weeks=1),
2631
frozenset((token_end, )))
2632
token_duration = Token(re.compile(r"P"), None,
2633
frozenset((token_year, token_month,
2634
token_day, token_time,
2636
# Define starting values
2637
value = datetime.timedelta() # Value so far
2639
followers = frozenset((token_duration, )) # Following valid tokens
2640
s = duration # String left to parse
2641
# Loop until end token is found
2642
while found_token is not token_end:
2643
# Search for any currently valid tokens
2644
for token in followers:
2645
match = token.regexp.match(s)
2646
if match is not None:
2648
if token.value is not None:
2649
# Value found, parse digits
2650
factor = int(match.group(1), 10)
2651
# Add to value so far
2652
value += factor * token.value
2653
# Strip token from string
2654
s = token.regexp.sub("", s, 1)
2657
# Set valid next tokens
2658
followers = found_token.followers
2661
# No currently valid tokens were found
2662
raise ValueError("Invalid RFC 3339 duration: {!r}"
579
2668
def string_to_delta(interval):
580
2669
"""Parse a string and return a datetime.timedelta
582
2671
>>> string_to_delta('7d')
583
2672
datetime.timedelta(7)
584
2673
>>> string_to_delta('60s')
719
2799
"debug": "False",
721
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2801
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2802
":+SIGN-DSA-SHA256",
722
2803
"servicename": "Mandos",
2809
"statedir": "/var/lib/mandos",
2810
"foreground": "False",
725
2814
# Parse config file for server-global settings
726
server_config = ConfigParser.SafeConfigParser(server_defaults)
2815
server_config = configparser.SafeConfigParser(server_defaults)
727
2816
del server_defaults
728
2817
server_config.read(os.path.join(options.configdir, "mandos.conf"))
729
2818
# Convert the SafeConfigParser object to a dict
730
2819
server_settings = server_config.defaults()
731
# Use getboolean on the boolean config option
732
server_settings["debug"] = server_config.getboolean\
2820
# Use the appropriate methods on the non-string config options
2821
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2822
server_settings[option] = server_config.getboolean("DEFAULT",
2824
if server_settings["port"]:
2825
server_settings["port"] = server_config.getint("DEFAULT",
2827
if server_settings["socket"]:
2828
server_settings["socket"] = server_config.getint("DEFAULT",
2830
# Later, stdin will, and stdout and stderr might, be dup'ed
2831
# over with an opened os.devnull. But we don't want this to
2832
# happen with a supplied network socket.
2833
if 0 <= server_settings["socket"] <= 2:
2834
server_settings["socket"] = os.dup(server_settings
734
2836
del server_config
736
2838
# Override the settings from the config file with command line
737
2839
# options, if set.
738
2840
for option in ("interface", "address", "port", "debug",
739
"priority", "servicename", "configdir"):
2841
"priority", "servicename", "configdir", "use_dbus",
2842
"use_ipv6", "debuglevel", "restore", "statedir",
2843
"socket", "foreground", "zeroconf"):
740
2844
value = getattr(options, option)
741
2845
if value is not None:
742
2846
server_settings[option] = value
2848
# Force all strings to be unicode
2849
for option in server_settings.keys():
2850
if isinstance(server_settings[option], bytes):
2851
server_settings[option] = (server_settings[option]
2853
# Force all boolean options to be boolean
2854
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2855
"foreground", "zeroconf"):
2856
server_settings[option] = bool(server_settings[option])
2857
# Debug implies foreground
2858
if server_settings["debug"]:
2859
server_settings["foreground"] = True
744
2860
# Now we have our good server settings in "server_settings"
2862
##################################################################
2864
if (not server_settings["zeroconf"]
2865
and not (server_settings["port"]
2866
or server_settings["socket"] != "")):
2867
parser.error("Needs port or socket to work without Zeroconf")
746
2870
debug = server_settings["debug"]
2871
debuglevel = server_settings["debuglevel"]
2872
use_dbus = server_settings["use_dbus"]
2873
use_ipv6 = server_settings["use_ipv6"]
2874
stored_state_path = os.path.join(server_settings["statedir"],
2876
foreground = server_settings["foreground"]
2877
zeroconf = server_settings["zeroconf"]
749
syslogger.setLevel(logging.WARNING)
750
console.setLevel(logging.WARNING)
2880
initlogger(debug, logging.DEBUG)
2885
level = getattr(logging, debuglevel.upper())
2886
initlogger(debug, level)
752
2888
if server_settings["servicename"] != "Mandos":
753
syslogger.setFormatter(logging.Formatter\
754
('Mandos (%s): %%(levelname)s:'
756
% server_settings["servicename"]))
2889
syslogger.setFormatter(
2890
logging.Formatter('Mandos ({}) [%(process)d]:'
2891
' %(levelname)s: %(message)s'.format(
2892
server_settings["servicename"])))
758
2894
# Parse config file with clients
759
client_defaults = { "timeout": "1h",
761
"checker": "fping -q -- %(host)s",
764
client_config = ConfigParser.SafeConfigParser(client_defaults)
2895
client_config = configparser.SafeConfigParser(Client
765
2897
client_config.read(os.path.join(server_settings["configdir"],
766
2898
"clients.conf"))
769
tcp_server = IPv6_TCPServer((server_settings["address"],
770
server_settings["port"]),
772
settings=server_settings,
774
pidfilename = "/var/run/mandos.pid"
776
pidfile = open(pidfilename, "w")
777
except IOError, error:
778
logger.error("Could not open file %r", pidfilename)
783
uid = pwd.getpwnam("mandos").pw_uid
786
uid = pwd.getpwnam("nobody").pw_uid
790
gid = pwd.getpwnam("mandos").pw_gid
793
gid = pwd.getpwnam("nogroup").pw_gid
2900
global mandos_dbus_service
2901
mandos_dbus_service = None
2904
if server_settings["socket"] != "":
2905
socketfd = server_settings["socket"]
2906
tcp_server = MandosServer(
2907
(server_settings["address"], server_settings["port"]),
2909
interface=(server_settings["interface"] or None),
2911
gnutls_priority=server_settings["priority"],
2915
pidfilename = "/run/mandos.pid"
2916
if not os.path.isdir("/run/."):
2917
pidfilename = "/var/run/mandos.pid"
2920
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2921
except IOError as e:
2922
logger.error("Could not open file %r", pidfilename,
2925
for name in ("_mandos", "mandos", "nobody"):
2927
uid = pwd.getpwnam(name).pw_uid
2928
gid = pwd.getpwnam(name).pw_gid
799
except OSError, error:
800
if error[0] != errno.EPERM:
804
service = AvahiService(name = server_settings["servicename"],
805
servicetype = "_mandos._tcp", )
806
if server_settings["interface"]:
807
service.interface = if_nametoindex\
808
(server_settings["interface"])
2938
except OSError as error:
2939
if error.errno != errno.EPERM:
2943
# Enable all possible GnuTLS debugging
2945
# "Use a log level over 10 to enable all debugging options."
2947
gnutls.global_set_log_level(11)
2950
def debug_gnutls(level, string):
2951
logger.debug("GnuTLS: %s", string[:-1])
2953
gnutls.global_set_log_function(debug_gnutls)
2955
# Redirect stdin so all checkers get /dev/null
2956
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2957
os.dup2(null, sys.stdin.fileno())
2961
# Need to fork before connecting to D-Bus
2963
# Close all input and output, do double fork, etc.
2966
# multiprocessing will use threads, so before we use gobject we
2967
# need to inform gobject that threads will be used.
2968
gobject.threads_init()
810
2970
global main_loop
813
2971
# From the Avahi example code
814
DBusGMainLoop(set_as_default=True )
2972
DBusGMainLoop(set_as_default=True)
815
2973
main_loop = gobject.MainLoop()
816
2974
bus = dbus.SystemBus()
817
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
818
avahi.DBUS_PATH_SERVER),
819
avahi.DBUS_INTERFACE_SERVER)
820
2975
# End of Avahi example code
822
def remove_from_clients(client):
823
clients.remove(client)
825
logger.critical(u"No clients left, exiting")
828
clients.update(Set(Client(name = section,
829
stop_hook = remove_from_clients,
831
= dict(client_config.items(section)))
832
for section in client_config.sections()))
834
logger.critical(u"No clients defined")
838
# Redirect stdin so all checkers get /dev/null
839
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
840
os.dup2(null, sys.stdin.fileno())
845
logger.removeHandler(console)
846
# Close all input and output, do double fork, etc.
851
pidfile.write(str(pid) + "\n")
2978
bus_name = dbus.service.BusName("se.recompile.Mandos",
2981
old_bus_name = dbus.service.BusName(
2982
"se.bsnet.fukt.Mandos", bus,
2984
except dbus.exceptions.DBusException as e:
2985
logger.error("Disabling D-Bus:", exc_info=e)
2987
server_settings["use_dbus"] = False
2988
tcp_server.use_dbus = False
2990
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2991
service = AvahiServiceToSyslog(
2992
name = server_settings["servicename"],
2993
servicetype = "_mandos._tcp",
2994
protocol = protocol,
2996
if server_settings["interface"]:
2997
service.interface = if_nametoindex(
2998
server_settings["interface"].encode("utf-8"))
3000
global multiprocessing_manager
3001
multiprocessing_manager = multiprocessing.Manager()
3003
client_class = Client
3005
client_class = functools.partial(ClientDBus, bus = bus)
3007
client_settings = Client.config_parser(client_config)
3008
old_client_settings = {}
3011
# This is used to redirect stdout and stderr for checker processes
3013
wnull = open(os.devnull, "w") # A writable /dev/null
3014
# Only used if server is running in foreground but not in debug
3016
if debug or not foreground:
3019
# Get client data and settings from last running state.
3020
if server_settings["restore"]:
3022
with open(stored_state_path, "rb") as stored_state:
3023
clients_data, old_client_settings = pickle.load(
3025
os.remove(stored_state_path)
3026
except IOError as e:
3027
if e.errno == errno.ENOENT:
3028
logger.warning("Could not load persistent state:"
3029
" {}".format(os.strerror(e.errno)))
3031
logger.critical("Could not load persistent state:",
3034
except EOFError as e:
3035
logger.warning("Could not load persistent state: "
3039
with PGPEngine() as pgp:
3040
for client_name, client in clients_data.items():
3041
# Skip removed clients
3042
if client_name not in client_settings:
3045
# Decide which value to use after restoring saved state.
3046
# We have three different values: Old config file,
3047
# new config file, and saved state.
3048
# New config value takes precedence if it differs from old
3049
# config value, otherwise use saved state.
3050
for name, value in client_settings[client_name].items():
3052
# For each value in new config, check if it
3053
# differs from the old config value (Except for
3054
# the "secret" attribute)
3055
if (name != "secret"
3057
old_client_settings[client_name][name])):
3058
client[name] = value
3062
# Clients who has passed its expire date can still be
3063
# enabled if its last checker was successful. A Client
3064
# whose checker succeeded before we stored its state is
3065
# assumed to have successfully run all checkers during
3067
if client["enabled"]:
3068
if datetime.datetime.utcnow() >= client["expires"]:
3069
if not client["last_checked_ok"]:
3071
"disabling client {} - Client never "
3072
"performed a successful checker".format(
3074
client["enabled"] = False
3075
elif client["last_checker_status"] != 0:
3077
"disabling client {} - Client last"
3078
" checker failed with error code"
3081
client["last_checker_status"]))
3082
client["enabled"] = False
3084
client["expires"] = (
3085
datetime.datetime.utcnow()
3086
+ client["timeout"])
3087
logger.debug("Last checker succeeded,"
3088
" keeping {} enabled".format(
3091
client["secret"] = pgp.decrypt(
3092
client["encrypted_secret"],
3093
client_settings[client_name]["secret"])
3095
# If decryption fails, we use secret from new settings
3096
logger.debug("Failed to decrypt {} old secret".format(
3098
client["secret"] = (client_settings[client_name]
3101
# Add/remove clients based on new changes made to config
3102
for client_name in (set(old_client_settings)
3103
- set(client_settings)):
3104
del clients_data[client_name]
3105
for client_name in (set(client_settings)
3106
- set(old_client_settings)):
3107
clients_data[client_name] = client_settings[client_name]
3109
# Create all client objects
3110
for client_name, client in clients_data.items():
3111
tcp_server.clients[client_name] = client_class(
3114
server_settings = server_settings)
3116
if not tcp_server.clients:
3117
logger.warning("No clients defined")
3120
if pidfile is not None:
3124
print(pid, file=pidfile)
3126
logger.error("Could not write to file %r with PID %d",
855
logger.error(u"Could not write to file %r with PID %d",
858
# "pidfile" was never created
3131
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
3132
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3136
@alternate_dbus_interfaces(
3137
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3138
class MandosDBusService(DBusObjectWithObjectManager):
3139
"""A D-Bus proxy object"""
3142
dbus.service.Object.__init__(self, bus, "/")
3144
_interface = "se.recompile.Mandos"
3146
@dbus.service.signal(_interface, signature="o")
3147
def ClientAdded(self, objpath):
3151
@dbus.service.signal(_interface, signature="ss")
3152
def ClientNotFound(self, fingerprint, address):
3156
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3158
@dbus.service.signal(_interface, signature="os")
3159
def ClientRemoved(self, objpath, name):
3163
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3165
@dbus.service.method(_interface, out_signature="ao")
3166
def GetAllClients(self):
3168
return dbus.Array(c.dbus_object_path for c in
3169
tcp_server.clients.itervalues())
3171
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3173
@dbus.service.method(_interface,
3174
out_signature="a{oa{sv}}")
3175
def GetAllClientsWithProperties(self):
3177
return dbus.Dictionary(
3178
{ c.dbus_object_path: c.GetAll(
3179
"se.recompile.Mandos.Client")
3180
for c in tcp_server.clients.itervalues() },
3183
@dbus.service.method(_interface, in_signature="o")
3184
def RemoveClient(self, object_path):
3186
for c in tcp_server.clients.itervalues():
3187
if c.dbus_object_path == object_path:
3188
del tcp_server.clients[c.name]
3189
c.remove_from_connection()
3190
# Don't signal the disabling
3191
c.disable(quiet=True)
3192
# Emit D-Bus signal for removal
3193
self.client_removed_signal(c)
3195
raise KeyError(object_path)
3199
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3200
out_signature = "a{oa{sa{sv}}}")
3201
def GetManagedObjects(self):
3203
return dbus.Dictionary(
3204
{ client.dbus_object_path:
3206
{ interface: client.GetAll(interface)
3208
client._get_all_interface_names()})
3209
for client in tcp_server.clients.values()})
3211
def client_added_signal(self, client):
3212
"""Send the new standard signal and the old signal"""
3214
# New standard signal
3215
self.InterfacesAdded(
3216
client.dbus_object_path,
3218
{ interface: client.GetAll(interface)
3220
client._get_all_interface_names()}))
3222
self.ClientAdded(client.dbus_object_path)
3224
def client_removed_signal(self, client):
3225
"""Send the new standard signal and the old signal"""
3227
# New standard signal
3228
self.InterfacesRemoved(
3229
client.dbus_object_path,
3230
client._get_all_interface_names())
3232
self.ClientRemoved(client.dbus_object_path,
3235
mandos_dbus_service = MandosDBusService()
863
3238
"Cleanup function; run on exit"
865
# From the Avahi example code
866
if not group is None:
869
# End of Avahi example code
872
client = clients.pop()
873
client.stop_hook = None
3242
multiprocessing.active_children()
3244
if not (tcp_server.clients or client_settings):
3247
# Store client before exiting. Secrets are encrypted with key
3248
# based on what config file has. If config file is
3249
# removed/edited, old secret will thus be unrecovable.
3251
with PGPEngine() as pgp:
3252
for client in tcp_server.clients.itervalues():
3253
key = client_settings[client.name]["secret"]
3254
client.encrypted_secret = pgp.encrypt(client.secret,
3258
# A list of attributes that can not be pickled
3260
exclude = { "bus", "changedstate", "secret",
3261
"checker", "server_settings" }
3262
for name, typ in inspect.getmembers(dbus.service
3266
client_dict["encrypted_secret"] = (client
3268
for attr in client.client_structure:
3269
if attr not in exclude:
3270
client_dict[attr] = getattr(client, attr)
3272
clients[client.name] = client_dict
3273
del client_settings[client.name]["secret"]
3276
with tempfile.NamedTemporaryFile(
3280
dir=os.path.dirname(stored_state_path),
3281
delete=False) as stored_state:
3282
pickle.dump((clients, client_settings), stored_state)
3283
tempname = stored_state.name
3284
os.rename(tempname, stored_state_path)
3285
except (IOError, OSError) as e:
3291
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3292
logger.warning("Could not save persistent state: {}"
3293
.format(os.strerror(e.errno)))
3295
logger.warning("Could not save persistent state:",
3299
# Delete all clients, and settings from config
3300
while tcp_server.clients:
3301
name, client = tcp_server.clients.popitem()
3303
client.remove_from_connection()
3304
# Don't signal the disabling
3305
client.disable(quiet=True)
3306
# Emit D-Bus signal for removal
3308
mandos_dbus_service.client_removed_signal(client)
3309
client_settings.clear()
876
3311
atexit.register(cleanup)
879
signal.signal(signal.SIGINT, signal.SIG_IGN)
880
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
881
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
883
for client in clients:
3313
for client in tcp_server.clients.itervalues():
3315
# Emit D-Bus signal for adding
3316
mandos_dbus_service.client_added_signal(client)
3317
# Need to initiate checking of clients
3319
client.init_checker()
886
3321
tcp_server.enable()
887
3322
tcp_server.server_activate()
889
3324
# Find out what port we got
890
service.port = tcp_server.socket.getsockname()[1]
891
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
892
u" scope_id %d" % tcp_server.socket.getsockname())
3326
service.port = tcp_server.socket.getsockname()[1]
3328
logger.info("Now listening on address %r, port %d,"
3329
" flowinfo %d, scope_id %d",
3330
*tcp_server.socket.getsockname())
3332
logger.info("Now listening on address %r, port %d",
3333
*tcp_server.socket.getsockname())
894
3335
#service.interface = tcp_server.socket.getsockname()[3]
897
# From the Avahi example code
898
server.connect_to_signal("StateChanged", server_state_changed)
900
server_state_changed(server.GetState())
901
except dbus.exceptions.DBusException, error:
902
logger.critical(u"DBusException: %s", error)
904
# End of Avahi example code
3339
# From the Avahi example code
3342
except dbus.exceptions.DBusException as error:
3343
logger.critical("D-Bus Exception", exc_info=error)
3346
# End of Avahi example code
906
3348
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
907
3349
lambda *args, **kwargs:
908
tcp_server.handle_request\
909
(*args[2:], **kwargs) or True)
3350
(tcp_server.handle_request
3351
(*args[2:], **kwargs) or True))
911
logger.debug(u"Starting main loop")
3353
logger.debug("Starting main loop")
913
except AvahiError, error:
914
logger.critical(u"AvahiError: %s" + unicode(error))
3355
except AvahiError as error:
3356
logger.critical("Avahi Error", exc_info=error)
916
3359
except KeyboardInterrupt:
3361
print("", file=sys.stderr)
3362
logger.debug("Server received KeyboardInterrupt")
3363
logger.debug("Server exiting")
3364
# Must run before the D-Bus bus name gets deregistered
920
3368
if __name__ == '__main__':