94
80
except ImportError:
95
81
SO_BINDTODEVICE = None
97
if sys.version_info.major == 2:
101
stored_state_file = "clients.pickle"
103
logger = logging.getLogger()
107
if_nametoindex = ctypes.cdll.LoadLibrary(
108
ctypes.util.find_library("c")).if_nametoindex
109
except (OSError, AttributeError):
111
def if_nametoindex(interface):
112
"Get an interface index the hard way, i.e. using fcntl()"
113
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
114
with contextlib.closing(socket.socket()) as s:
115
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
116
struct.pack(b"16s16x", interface))
117
interface_index = struct.unpack("I", ifreq[16:20])[0]
118
return interface_index
121
def copy_function(func):
122
"""Make a copy of a function"""
123
if sys.version_info.major == 2:
124
return types.FunctionType(func.func_code,
130
return types.FunctionType(func.__code__,
137
def initlogger(debug, level=logging.WARNING):
138
"""init logger and add loglevel"""
141
syslogger = (logging.handlers.SysLogHandler(
142
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
143
address = "/dev/log"))
144
syslogger.setFormatter(logging.Formatter
145
('Mandos [%(process)d]: %(levelname)s:'
147
logger.addHandler(syslogger)
150
console = logging.StreamHandler()
151
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
155
logger.addHandler(console)
156
logger.setLevel(level)
159
class PGPError(Exception):
160
"""Exception if encryption/decryption fails"""
164
class PGPEngine(object):
165
"""A simple class for OpenPGP symmetric encryption & decryption"""
168
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
171
output = subprocess.check_output(["gpgconf"])
172
for line in output.splitlines():
173
name, text, path = line.split(b":")
178
if e.errno != errno.ENOENT:
180
self.gnupgargs = ['--batch',
181
'--homedir', self.tempdir,
184
# Only GPG version 1 has the --no-use-agent option.
185
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
186
self.gnupgargs.append("--no-use-agent")
191
def __exit__(self, exc_type, exc_value, traceback):
199
if self.tempdir is not None:
200
# Delete contents of tempdir
201
for root, dirs, files in os.walk(self.tempdir,
203
for filename in files:
204
os.remove(os.path.join(root, filename))
206
os.rmdir(os.path.join(root, dirname))
208
os.rmdir(self.tempdir)
211
def password_encode(self, password):
212
# Passphrase can not be empty and can not contain newlines or
213
# NUL bytes. So we prefix it and hex encode it.
214
encoded = b"mandos" + binascii.hexlify(password)
215
if len(encoded) > 2048:
216
# GnuPG can't handle long passwords, so encode differently
217
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
218
.replace(b"\n", b"\\n")
219
.replace(b"\0", b"\\x00"))
222
def encrypt(self, data, password):
223
passphrase = self.password_encode(password)
224
with tempfile.NamedTemporaryFile(
225
dir=self.tempdir) as passfile:
226
passfile.write(passphrase)
228
proc = subprocess.Popen([self.gpg, '--symmetric',
232
stdin = subprocess.PIPE,
233
stdout = subprocess.PIPE,
234
stderr = subprocess.PIPE)
235
ciphertext, err = proc.communicate(input = data)
236
if proc.returncode != 0:
240
def decrypt(self, data, password):
241
passphrase = self.password_encode(password)
242
with tempfile.NamedTemporaryFile(
243
dir = self.tempdir) as passfile:
244
passfile.write(passphrase)
246
proc = subprocess.Popen([self.gpg, '--decrypt',
250
stdin = subprocess.PIPE,
251
stdout = subprocess.PIPE,
252
stderr = subprocess.PIPE)
253
decrypted_plaintext, err = proc.communicate(input = data)
254
if proc.returncode != 0:
256
return decrypted_plaintext
258
# Pretend that we have an Avahi module
260
"""This isn't so much a class as it is a module-like namespace.
261
It is instantiated once, and simulates having an Avahi module."""
262
IF_UNSPEC = -1 # avahi-common/address.h
263
PROTO_UNSPEC = -1 # avahi-common/address.h
264
PROTO_INET = 0 # avahi-common/address.h
265
PROTO_INET6 = 1 # avahi-common/address.h
266
DBUS_NAME = "org.freedesktop.Avahi"
267
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
268
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
269
DBUS_PATH_SERVER = "/"
270
def string_array_to_txt_array(self, t):
271
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
272
for s in t), signature="ay")
273
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
274
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
275
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
276
SERVER_INVALID = 0 # avahi-common/defs.h
277
SERVER_REGISTERING = 1 # avahi-common/defs.h
278
SERVER_RUNNING = 2 # avahi-common/defs.h
279
SERVER_COLLISION = 3 # avahi-common/defs.h
280
SERVER_FAILURE = 4 # avahi-common/defs.h
86
logger = logging.Logger(u'mandos')
87
syslogger = (logging.handlers.SysLogHandler
88
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
89
address = "/dev/log"))
90
syslogger.setFormatter(logging.Formatter
91
(u'Mandos [%(process)d]: %(levelname)s:'
93
logger.addHandler(syslogger)
95
console = logging.StreamHandler()
96
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
99
logger.addHandler(console)
283
101
class AvahiError(Exception):
284
102
def __init__(self, value, *args, **kwargs):
285
103
self.value = value
286
return super(AvahiError, self).__init__(value, *args,
104
super(AvahiError, self).__init__(value, *args, **kwargs)
105
def __unicode__(self):
106
return unicode(repr(self.value))
290
108
class AvahiServiceError(AvahiError):
294
111
class AvahiGroupError(AvahiError):
398
191
dbus.UInt16(self.port),
399
192
avahi.string_array_to_txt_array(self.TXT))
400
193
self.group.Commit()
402
194
def entry_group_state_changed(self, state, error):
403
195
"""Derived from the Avahi example code"""
404
logger.debug("Avahi entry group state change: %i", state)
196
logger.debug(u"Avahi entry group state change: %i", state)
406
198
if state == avahi.ENTRY_GROUP_ESTABLISHED:
407
logger.debug("Zeroconf service established.")
199
logger.debug(u"Zeroconf service established.")
408
200
elif state == avahi.ENTRY_GROUP_COLLISION:
409
logger.info("Zeroconf service name collision.")
201
logger.warning(u"Zeroconf service name collision.")
411
203
elif state == avahi.ENTRY_GROUP_FAILURE:
412
logger.critical("Avahi: Error in group state changed %s",
414
raise AvahiGroupError("State changed: {!s}".format(error))
204
logger.critical(u"Avahi: Error in group state changed %s",
206
raise AvahiGroupError(u"State changed: %s"
416
208
def cleanup(self):
417
209
"""Derived from the Avahi example code"""
418
210
if self.group is not None:
421
except (dbus.exceptions.UnknownMethodException,
422
dbus.exceptions.DBusException):
424
212
self.group = None
427
def server_state_changed(self, state, error=None):
213
def server_state_changed(self, state):
428
214
"""Derived from the Avahi example code"""
429
logger.debug("Avahi server state change: %i", state)
431
avahi.SERVER_INVALID: "Zeroconf server invalid",
432
avahi.SERVER_REGISTERING: None,
433
avahi.SERVER_COLLISION: "Zeroconf server name collision",
434
avahi.SERVER_FAILURE: "Zeroconf server failure",
436
if state in bad_states:
437
if bad_states[state] is not None:
439
logger.error(bad_states[state])
441
logger.error(bad_states[state] + ": %r", error)
215
logger.debug(u"Avahi server state change: %i", state)
216
if state == avahi.SERVER_COLLISION:
217
logger.error(u"Zeroconf server name collision")
443
219
elif state == avahi.SERVER_RUNNING:
446
except dbus.exceptions.DBusException as error:
447
if (error.get_dbus_name()
448
== "org.freedesktop.Avahi.CollisionError"):
449
logger.info("Local Zeroconf service name"
451
return self.rename(remove=False)
453
logger.critical("D-Bus Exception", exc_info=error)
458
logger.debug("Unknown state: %r", state)
460
logger.debug("Unknown state: %r: %r", state, error)
462
221
def activate(self):
463
222
"""Derived from the Avahi example code"""
464
223
if self.server is None:
465
224
self.server = dbus.Interface(
466
225
self.bus.get_object(avahi.DBUS_NAME,
467
avahi.DBUS_PATH_SERVER,
468
follow_name_owner_changes=True),
226
avahi.DBUS_PATH_SERVER),
469
227
avahi.DBUS_INTERFACE_SERVER)
470
self.server.connect_to_signal("StateChanged",
471
self.server_state_changed)
228
self.server.connect_to_signal(u"StateChanged",
229
self.server_state_changed)
472
230
self.server_state_changed(self.server.GetState())
475
class AvahiServiceToSyslog(AvahiService):
476
def rename(self, *args, **kwargs):
477
"""Add the new name to the syslog messages"""
478
ret = AvahiService.rename(self, *args, **kwargs)
479
syslogger.setFormatter(logging.Formatter(
480
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
484
# Pretend that we have a GnuTLS module
485
class GnuTLS(object):
486
"""This isn't so much a class as it is a module-like namespace.
487
It is instantiated once, and simulates having a GnuTLS module."""
489
_library = ctypes.cdll.LoadLibrary(
490
ctypes.util.find_library("gnutls"))
491
_need_version = b"3.3.0"
493
# Need to use class name "GnuTLS" here, since this method is
494
# called before the assignment to the "gnutls" global variable
496
if GnuTLS.check_version(self._need_version) is None:
497
raise GnuTLS.Error("Needs GnuTLS {} or later"
498
.format(self._need_version))
500
# Unless otherwise indicated, the constants and types below are
501
# all from the gnutls/gnutls.h C header file.
511
E_NO_CERTIFICATE_FOUND = -49
512
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
515
class session_int(ctypes.Structure):
517
session_t = ctypes.POINTER(session_int)
518
class certificate_credentials_st(ctypes.Structure):
520
certificate_credentials_t = ctypes.POINTER(
521
certificate_credentials_st)
522
certificate_type_t = ctypes.c_int
523
class datum_t(ctypes.Structure):
524
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
525
('size', ctypes.c_uint)]
526
class openpgp_crt_int(ctypes.Structure):
528
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
529
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
530
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
531
credentials_type_t = ctypes.c_int
532
transport_ptr_t = ctypes.c_void_p
533
close_request_t = ctypes.c_int
536
class Error(Exception):
537
# We need to use the class name "GnuTLS" here, since this
538
# exception might be raised from within GnuTLS.__init__,
539
# which is called before the assignment to the "gnutls"
540
# global variable has happened.
541
def __init__(self, message = None, code = None, args=()):
542
# Default usage is by a message string, but if a return
543
# code is passed, convert it to a string with
546
if message is None and code is not None:
547
message = GnuTLS.strerror(code)
548
return super(GnuTLS.Error, self).__init__(
551
class CertificateSecurityError(Error):
555
class Credentials(object):
557
self._c_object = gnutls.certificate_credentials_t()
558
gnutls.certificate_allocate_credentials(
559
ctypes.byref(self._c_object))
560
self.type = gnutls.CRD_CERTIFICATE
563
gnutls.certificate_free_credentials(self._c_object)
565
class ClientSession(object):
566
def __init__(self, socket, credentials = None):
567
self._c_object = gnutls.session_t()
568
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
569
gnutls.set_default_priority(self._c_object)
570
gnutls.transport_set_ptr(self._c_object, socket.fileno())
571
gnutls.handshake_set_private_extensions(self._c_object,
574
if credentials is None:
575
credentials = gnutls.Credentials()
576
gnutls.credentials_set(self._c_object, credentials.type,
577
ctypes.cast(credentials._c_object,
579
self.credentials = credentials
582
gnutls.deinit(self._c_object)
585
return gnutls.handshake(self._c_object)
587
def send(self, data):
591
data_len -= gnutls.record_send(self._c_object,
596
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
598
# Error handling functions
599
def _error_code(result):
600
"""A function to raise exceptions on errors, suitable
601
for the 'restype' attribute on ctypes functions"""
604
if result == gnutls.E_NO_CERTIFICATE_FOUND:
605
raise gnutls.CertificateSecurityError(code = result)
606
raise gnutls.Error(code = result)
608
def _retry_on_error(result, func, arguments):
609
"""A function to retry on some errors, suitable
610
for the 'errcheck' attribute on ctypes functions"""
612
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
613
return _error_code(result)
614
result = func(*arguments)
617
# Unless otherwise indicated, the function declarations below are
618
# all from the gnutls/gnutls.h C header file.
621
priority_set_direct = _library.gnutls_priority_set_direct
622
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
623
ctypes.POINTER(ctypes.c_char_p)]
624
priority_set_direct.restype = _error_code
626
init = _library.gnutls_init
627
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
628
init.restype = _error_code
630
set_default_priority = _library.gnutls_set_default_priority
631
set_default_priority.argtypes = [session_t]
632
set_default_priority.restype = _error_code
634
record_send = _library.gnutls_record_send
635
record_send.argtypes = [session_t, ctypes.c_void_p,
637
record_send.restype = ctypes.c_ssize_t
638
record_send.errcheck = _retry_on_error
640
certificate_allocate_credentials = (
641
_library.gnutls_certificate_allocate_credentials)
642
certificate_allocate_credentials.argtypes = [
643
ctypes.POINTER(certificate_credentials_t)]
644
certificate_allocate_credentials.restype = _error_code
646
certificate_free_credentials = (
647
_library.gnutls_certificate_free_credentials)
648
certificate_free_credentials.argtypes = [certificate_credentials_t]
649
certificate_free_credentials.restype = None
651
handshake_set_private_extensions = (
652
_library.gnutls_handshake_set_private_extensions)
653
handshake_set_private_extensions.argtypes = [session_t,
655
handshake_set_private_extensions.restype = None
657
credentials_set = _library.gnutls_credentials_set
658
credentials_set.argtypes = [session_t, credentials_type_t,
660
credentials_set.restype = _error_code
662
strerror = _library.gnutls_strerror
663
strerror.argtypes = [ctypes.c_int]
664
strerror.restype = ctypes.c_char_p
666
certificate_type_get = _library.gnutls_certificate_type_get
667
certificate_type_get.argtypes = [session_t]
668
certificate_type_get.restype = _error_code
670
certificate_get_peers = _library.gnutls_certificate_get_peers
671
certificate_get_peers.argtypes = [session_t,
672
ctypes.POINTER(ctypes.c_uint)]
673
certificate_get_peers.restype = ctypes.POINTER(datum_t)
675
global_set_log_level = _library.gnutls_global_set_log_level
676
global_set_log_level.argtypes = [ctypes.c_int]
677
global_set_log_level.restype = None
679
global_set_log_function = _library.gnutls_global_set_log_function
680
global_set_log_function.argtypes = [log_func]
681
global_set_log_function.restype = None
683
deinit = _library.gnutls_deinit
684
deinit.argtypes = [session_t]
685
deinit.restype = None
687
handshake = _library.gnutls_handshake
688
handshake.argtypes = [session_t]
689
handshake.restype = _error_code
690
handshake.errcheck = _retry_on_error
692
transport_set_ptr = _library.gnutls_transport_set_ptr
693
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
694
transport_set_ptr.restype = None
696
bye = _library.gnutls_bye
697
bye.argtypes = [session_t, close_request_t]
698
bye.restype = _error_code
699
bye.errcheck = _retry_on_error
701
check_version = _library.gnutls_check_version
702
check_version.argtypes = [ctypes.c_char_p]
703
check_version.restype = ctypes.c_char_p
705
# All the function declarations below are from gnutls/openpgp.h
707
openpgp_crt_init = _library.gnutls_openpgp_crt_init
708
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
709
openpgp_crt_init.restype = _error_code
711
openpgp_crt_import = _library.gnutls_openpgp_crt_import
712
openpgp_crt_import.argtypes = [openpgp_crt_t,
713
ctypes.POINTER(datum_t),
715
openpgp_crt_import.restype = _error_code
717
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
718
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
719
ctypes.POINTER(ctypes.c_uint)]
720
openpgp_crt_verify_self.restype = _error_code
722
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
723
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
724
openpgp_crt_deinit.restype = None
726
openpgp_crt_get_fingerprint = (
727
_library.gnutls_openpgp_crt_get_fingerprint)
728
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
732
openpgp_crt_get_fingerprint.restype = _error_code
734
# Remove non-public functions
735
del _error_code, _retry_on_error
736
# Create the global "gnutls" object, simulating a module
739
def call_pipe(connection, # : multiprocessing.Connection
740
func, *args, **kwargs):
741
"""This function is meant to be called by multiprocessing.Process
743
This function runs func(*args, **kwargs), and writes the resulting
744
return value on the provided multiprocessing.Connection.
746
connection.send(func(*args, **kwargs))
749
233
class Client(object):
750
234
"""A representation of a client host served by this server.
753
approved: bool(); 'None' if not yet approved/disapproved
754
approval_delay: datetime.timedelta(); Time to wait for approval
755
approval_duration: datetime.timedelta(); Duration of one approval
237
name: string; from the config file, used in log messages and
239
fingerprint: string (40 or 32 hexadecimal digits); used to
240
uniquely identify the client
241
secret: bytestring; sent verbatim (over TLS) to client
242
host: string; available for use by the checker command
243
created: datetime.datetime(); (UTC) object creation
244
last_enabled: datetime.datetime(); (UTC)
246
last_checked_ok: datetime.datetime(); (UTC) or None
247
timeout: datetime.timedelta(); How long from last_checked_ok
248
until this client is disabled
249
interval: datetime.timedelta(); How often to start a new checker
250
disable_hook: If set, called by disable() as disable_hook(self)
756
251
checker: subprocess.Popen(); a running checker process used
757
252
to see if the client lives.
758
253
'None' if no process is running.
759
checker_callback_tag: a GLib event source tag, or None
760
checker_command: string; External command which is run to check
761
if client lives. %() expansions are done at
254
checker_initiator_tag: a gobject event source tag, or None
255
disable_initiator_tag: - '' -
256
checker_callback_tag: - '' -
257
checker_command: string; External command which is run to check if
258
client lives. %() expansions are done at
762
259
runtime with vars(self) as dict, so that for
763
260
instance %(name)s can be used in the command.
764
checker_initiator_tag: a GLib event source tag, or None
765
created: datetime.datetime(); (UTC) object creation
766
client_structure: Object describing what attributes a client has
767
and is used for storing the client at exit
768
261
current_checker_command: string; current running checker_command
769
disable_initiator_tag: a GLib event source tag, or None
771
fingerprint: string (40 or 32 hexadecimal digits); used to
772
uniquely identify the client
773
host: string; available for use by the checker command
774
interval: datetime.timedelta(); How often to start a new checker
775
last_approval_request: datetime.datetime(); (UTC) or None
776
last_checked_ok: datetime.datetime(); (UTC) or None
777
last_checker_status: integer between 0 and 255 reflecting exit
778
status of last checker. -1 reflects crashed
779
checker, -2 means no checker completed yet.
780
last_checker_signal: The signal which killed the last checker, if
781
last_checker_status is -1
782
last_enabled: datetime.datetime(); (UTC) or None
783
name: string; from the config file, used in log messages and
785
secret: bytestring; sent verbatim (over TLS) to client
786
timeout: datetime.timedelta(); How long from last_checked_ok
787
until this client is disabled
788
extended_timeout: extra long timeout when secret has been sent
789
runtime_expansions: Allowed attributes for runtime expansion.
790
expires: datetime.datetime(); time (UTC) when a client will be
792
server_settings: The server_settings dict from main()
795
runtime_expansions = ("approval_delay", "approval_duration",
796
"created", "enabled", "expires",
797
"fingerprint", "host", "interval",
798
"last_approval_request", "last_checked_ok",
799
"last_enabled", "name", "timeout")
802
"extended_timeout": "PT15M",
804
"checker": "fping -q -- %%(host)s",
806
"approval_delay": "PT0S",
807
"approval_duration": "PT1S",
808
"approved_by_default": "True",
813
def config_parser(config):
814
"""Construct a new dict of client settings of this form:
815
{ client_name: {setting_name: value, ...}, ...}
816
with exceptions for any special settings as defined above.
817
NOTE: Must be a pure function. Must return the same result
818
value given the same arguments.
821
for client_name in config.sections():
822
section = dict(config.items(client_name))
823
client = settings[client_name] = {}
825
client["host"] = section["host"]
826
# Reformat values from string types to Python types
827
client["approved_by_default"] = config.getboolean(
828
client_name, "approved_by_default")
829
client["enabled"] = config.getboolean(client_name,
832
# Uppercase and remove spaces from fingerprint for later
833
# comparison purposes with return value from the
834
# fingerprint() function
835
client["fingerprint"] = (section["fingerprint"].upper()
837
if "secret" in section:
838
client["secret"] = codecs.decode(section["secret"]
841
elif "secfile" in section:
842
with open(os.path.expanduser(os.path.expandvars
843
(section["secfile"])),
845
client["secret"] = secfile.read()
847
raise TypeError("No secret or secfile for section {}"
849
client["timeout"] = string_to_delta(section["timeout"])
850
client["extended_timeout"] = string_to_delta(
851
section["extended_timeout"])
852
client["interval"] = string_to_delta(section["interval"])
853
client["approval_delay"] = string_to_delta(
854
section["approval_delay"])
855
client["approval_duration"] = string_to_delta(
856
section["approval_duration"])
857
client["checker_command"] = section["checker"]
858
client["last_approval_request"] = None
859
client["last_checked_ok"] = None
860
client["last_checker_status"] = -2
864
def __init__(self, settings, name = None, server_settings=None):
265
def _timedelta_to_milliseconds(td):
266
"Convert a datetime.timedelta() to milliseconds"
267
return ((td.days * 24 * 60 * 60 * 1000)
268
+ (td.seconds * 1000)
269
+ (td.microseconds // 1000))
271
def timeout_milliseconds(self):
272
"Return the 'timeout' attribute in milliseconds"
273
return self._timedelta_to_milliseconds(self.timeout)
275
def interval_milliseconds(self):
276
"Return the 'interval' attribute in milliseconds"
277
return self._timedelta_to_milliseconds(self.interval)
279
def __init__(self, name = None, disable_hook=None, config=None):
280
"""Note: the 'checker' key in 'config' sets the
281
'checker_command' attribute and *not* the 'checker'
866
if server_settings is None:
868
self.server_settings = server_settings
869
# adding all client settings
870
for setting, value in settings.items():
871
setattr(self, setting, value)
874
if not hasattr(self, "last_enabled"):
875
self.last_enabled = datetime.datetime.utcnow()
876
if not hasattr(self, "expires"):
877
self.expires = (datetime.datetime.utcnow()
286
logger.debug(u"Creating client %r", self.name)
287
# Uppercase and remove spaces from fingerprint for later
288
# comparison purposes with return value from the fingerprint()
290
self.fingerprint = (config[u"fingerprint"].upper()
292
logger.debug(u" Fingerprint: %s", self.fingerprint)
293
if u"secret" in config:
294
self.secret = config[u"secret"].decode(u"base64")
295
elif u"secfile" in config:
296
with open(os.path.expanduser(os.path.expandvars
297
(config[u"secfile"])),
299
self.secret = secfile.read()
880
self.last_enabled = None
883
logger.debug("Creating client %r", self.name)
884
logger.debug(" Fingerprint: %s", self.fingerprint)
885
self.created = settings.get("created",
886
datetime.datetime.utcnow())
888
# attributes specific for this server instance
301
raise TypeError(u"No secret or secfile for client %s"
303
self.host = config.get(u"host", u"")
304
self.created = datetime.datetime.utcnow()
306
self.last_enabled = None
307
self.last_checked_ok = None
308
self.timeout = string_to_delta(config[u"timeout"])
309
self.interval = string_to_delta(config[u"interval"])
310
self.disable_hook = disable_hook
889
311
self.checker = None
890
312
self.checker_initiator_tag = None
891
313
self.disable_initiator_tag = None
892
314
self.checker_callback_tag = None
315
self.checker_command = config[u"checker"]
893
316
self.current_checker_command = None
895
self.approvals_pending = 0
896
self.changedstate = multiprocessing_manager.Condition(
897
multiprocessing_manager.Lock())
898
self.client_structure = [attr
899
for attr in self.__dict__.keys()
900
if not attr.startswith("_")]
901
self.client_structure.append("client_structure")
903
for name, t in inspect.getmembers(
904
type(self), lambda obj: isinstance(obj, property)):
905
if not name.startswith("_"):
906
self.client_structure.append(name)
908
# Send notice to process children that client state has changed
909
def send_changedstate(self):
910
with self.changedstate:
911
self.changedstate.notify_all()
317
self.last_connect = None
913
319
def enable(self):
914
320
"""Start this client's checker and timeout hooks"""
915
if getattr(self, "enabled", False):
321
if getattr(self, u"enabled", False):
916
322
# Already enabled
918
self.expires = datetime.datetime.utcnow() + self.timeout
920
324
self.last_enabled = datetime.datetime.utcnow()
922
self.send_changedstate()
325
# Schedule a new checker to be started an 'interval' from now,
326
# and every interval from then on.
327
self.checker_initiator_tag = (gobject.timeout_add
328
(self.interval_milliseconds(),
330
# Schedule a disable() when 'timeout' has passed
331
self.disable_initiator_tag = (gobject.timeout_add
332
(self.timeout_milliseconds(),
335
# Also start a new checker *right now*.
924
338
def disable(self, quiet=True):
925
339
"""Disable this client."""
926
340
if not getattr(self, "enabled", False):
929
logger.info("Disabling client %s", self.name)
930
if getattr(self, "disable_initiator_tag", None) is not None:
931
GLib.source_remove(self.disable_initiator_tag)
343
logger.info(u"Disabling client %s", self.name)
344
if getattr(self, u"disable_initiator_tag", False):
345
gobject.source_remove(self.disable_initiator_tag)
932
346
self.disable_initiator_tag = None
934
if getattr(self, "checker_initiator_tag", None) is not None:
935
GLib.source_remove(self.checker_initiator_tag)
347
if getattr(self, u"checker_initiator_tag", False):
348
gobject.source_remove(self.checker_initiator_tag)
936
349
self.checker_initiator_tag = None
937
350
self.stop_checker()
351
if self.disable_hook:
352
self.disable_hook(self)
938
353
self.enabled = False
940
self.send_changedstate()
941
# Do not run this again if called by a GLib.timeout_add
354
# Do not run this again if called by a gobject.timeout_add
944
357
def __del__(self):
358
self.disable_hook = None
947
def init_checker(self):
948
# Schedule a new checker to be started an 'interval' from now,
949
# and every interval from then on.
950
if self.checker_initiator_tag is not None:
951
GLib.source_remove(self.checker_initiator_tag)
952
self.checker_initiator_tag = GLib.timeout_add(
953
int(self.interval.total_seconds() * 1000),
955
# Schedule a disable() when 'timeout' has passed
956
if self.disable_initiator_tag is not None:
957
GLib.source_remove(self.disable_initiator_tag)
958
self.disable_initiator_tag = GLib.timeout_add(
959
int(self.timeout.total_seconds() * 1000), self.disable)
960
# Also start a new checker *right now*.
963
def checker_callback(self, source, condition, connection,
361
def checker_callback(self, pid, condition, command):
965
362
"""The checker has completed, so take appropriate actions."""
966
363
self.checker_callback_tag = None
967
364
self.checker = None
968
# Read return code from connection (see call_pipe)
969
returncode = connection.recv()
973
self.last_checker_status = returncode
974
self.last_checker_signal = None
975
if self.last_checker_status == 0:
976
logger.info("Checker for %(name)s succeeded",
365
if os.WIFEXITED(condition):
366
exitstatus = os.WEXITSTATUS(condition)
368
logger.info(u"Checker for %(name)s succeeded",
978
370
self.checked_ok()
980
logger.info("Checker for %(name)s failed", vars(self))
372
logger.info(u"Checker for %(name)s failed",
982
self.last_checker_status = -1
983
self.last_checker_signal = -returncode
984
logger.warning("Checker for %(name)s crashed?",
375
logger.warning(u"Checker for %(name)s crashed?",
988
378
def checked_ok(self):
989
"""Assert that the client has been seen, alive and well."""
379
"""Bump up the timeout for this client.
381
This should only be called when the client has been seen,
990
384
self.last_checked_ok = datetime.datetime.utcnow()
991
self.last_checker_status = 0
992
self.last_checker_signal = None
995
def bump_timeout(self, timeout=None):
996
"""Bump up the timeout for this client."""
998
timeout = self.timeout
999
if self.disable_initiator_tag is not None:
1000
GLib.source_remove(self.disable_initiator_tag)
1001
self.disable_initiator_tag = None
1002
if getattr(self, "enabled", False):
1003
self.disable_initiator_tag = GLib.timeout_add(
1004
int(timeout.total_seconds() * 1000), self.disable)
1005
self.expires = datetime.datetime.utcnow() + timeout
1007
def need_approval(self):
1008
self.last_approval_request = datetime.datetime.utcnow()
385
gobject.source_remove(self.disable_initiator_tag)
386
self.disable_initiator_tag = (gobject.timeout_add
387
(self.timeout_milliseconds(),
1010
390
def start_checker(self):
1011
391
"""Start a new checker subprocess if one is not running.
1177
class DBusObjectWithAnnotations(dbus.service.Object):
1178
"""A D-Bus object with annotations.
1180
Classes inheriting from this can use the dbus_annotations
1181
decorator to add annotations to methods or signals.
1185
def _is_dbus_thing(thing):
1186
"""Returns a function testing if an attribute is a D-Bus thing
1188
If called like _is_dbus_thing("method") it returns a function
1189
suitable for use as predicate to inspect.getmembers().
1191
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1194
def _get_all_dbus_things(self, thing):
1195
"""Returns a generator of (name, attribute) pairs
1197
return ((getattr(athing.__get__(self), "_dbus_name", name),
1198
athing.__get__(self))
1199
for cls in self.__class__.__mro__
1201
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1203
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1204
out_signature = "s",
1205
path_keyword = 'object_path',
1206
connection_keyword = 'connection')
1207
def Introspect(self, object_path, connection):
1208
"""Overloading of standard D-Bus method.
1210
Inserts annotation tags on methods and signals.
1212
xmlstring = dbus.service.Object.Introspect(self, object_path,
1215
document = xml.dom.minidom.parseString(xmlstring)
1217
for if_tag in document.getElementsByTagName("interface"):
1218
# Add annotation tags
1219
for typ in ("method", "signal"):
1220
for tag in if_tag.getElementsByTagName(typ):
1222
for name, prop in (self.
1223
_get_all_dbus_things(typ)):
1224
if (name == tag.getAttribute("name")
1225
and prop._dbus_interface
1226
== if_tag.getAttribute("name")):
1227
annots.update(getattr(
1228
prop, "_dbus_annotations", {}))
1229
for name, value in annots.items():
1230
ann_tag = document.createElement(
1232
ann_tag.setAttribute("name", name)
1233
ann_tag.setAttribute("value", value)
1234
tag.appendChild(ann_tag)
1235
# Add interface annotation tags
1236
for annotation, value in dict(
1237
itertools.chain.from_iterable(
1238
annotations().items()
1239
for name, annotations
1240
in self._get_all_dbus_things("interface")
1241
if name == if_tag.getAttribute("name")
1243
ann_tag = document.createElement("annotation")
1244
ann_tag.setAttribute("name", annotation)
1245
ann_tag.setAttribute("value", value)
1246
if_tag.appendChild(ann_tag)
1247
# Fix argument name for the Introspect method itself
1248
if (if_tag.getAttribute("name")
1249
== dbus.INTROSPECTABLE_IFACE):
1250
for cn in if_tag.getElementsByTagName("method"):
1251
if cn.getAttribute("name") == "Introspect":
1252
for arg in cn.getElementsByTagName("arg"):
1253
if (arg.getAttribute("direction")
1255
arg.setAttribute("name",
1257
xmlstring = document.toxml("utf-8")
1259
except (AttributeError, xml.dom.DOMException,
1260
xml.parsers.expat.ExpatError) as error:
1261
logger.error("Failed to override Introspection method",
1266
class DBusObjectWithProperties(DBusObjectWithAnnotations):
531
class DBusObjectWithProperties(dbus.service.Object):
1267
532
"""A D-Bus object with properties.
1269
534
Classes inheriting from this can use the dbus_service_property
1270
535
decorator to expose methods as D-Bus properties. It exposes the
1271
536
standard Get(), Set(), and GetAll() methods on the D-Bus.
540
def _is_dbus_property(obj):
541
return getattr(obj, u"_dbus_is_property", False)
543
def _get_all_dbus_properties(self):
544
"""Returns a generator of (name, attribute) pairs
546
return ((prop._dbus_name, prop)
548
inspect.getmembers(self, self._is_dbus_property))
1274
550
def _get_dbus_property(self, interface_name, property_name):
1275
551
"""Returns a bound method if one exists which is a D-Bus
1276
552
property with the specified name and interface.
1278
for cls in self.__class__.__mro__:
1279
for name, value in inspect.getmembers(
1280
cls, self._is_dbus_thing("property")):
1281
if (value._dbus_name == property_name
1282
and value._dbus_interface == interface_name):
1283
return value.__get__(self)
554
for name in (property_name,
555
property_name + u"_dbus_property"):
556
prop = getattr(self, name, None)
558
or not self._is_dbus_property(prop)
559
or prop._dbus_name != property_name
560
or (interface_name and prop._dbus_interface
561
and interface_name != prop._dbus_interface)):
1285
564
# No such property
1286
raise DBusPropertyNotFound("{}:{}.{}".format(
1287
self.dbus_object_path, interface_name, property_name))
1290
def _get_all_interface_names(cls):
1291
"""Get a sequence of all interfaces supported by an object"""
1292
return (name for name in set(getattr(getattr(x, attr),
1293
"_dbus_interface", None)
1294
for x in (inspect.getmro(cls))
1296
if name is not None)
1298
@dbus.service.method(dbus.PROPERTIES_IFACE,
565
raise DBusPropertyNotFound(self.dbus_object_path + u":"
566
+ interface_name + u"."
569
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1301
571
def Get(self, interface_name, property_name):
1302
572
"""Standard D-Bus property Get() method, see D-Bus standard.
1304
574
prop = self._get_dbus_property(interface_name, property_name)
1305
if prop._dbus_access == "write":
575
if prop._dbus_access == u"write":
1306
576
raise DBusPropertyAccessException(property_name)
1308
if not hasattr(value, "variant_level"):
578
if not hasattr(value, u"variant_level"):
1310
580
return type(value)(value, variant_level=value.variant_level+1)
1312
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
582
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1313
583
def Set(self, interface_name, property_name, value):
1314
584
"""Standard D-Bus property Set() method, see D-Bus standard.
1316
586
prop = self._get_dbus_property(interface_name, property_name)
1317
if prop._dbus_access == "read":
587
if prop._dbus_access == u"read":
1318
588
raise DBusPropertyAccessException(property_name)
1319
if prop._dbus_get_args_options["byte_arrays"]:
589
if prop._dbus_get_args_options[u"byte_arrays"]:
1320
590
# The byte_arrays option is not supported yet on
1321
591
# signatures other than "ay".
1322
if prop._dbus_signature != "ay":
1323
raise ValueError("Byte arrays not supported for non-"
1324
"'ay' signature {!r}"
1325
.format(prop._dbus_signature))
1326
value = dbus.ByteArray(b''.join(chr(byte)
592
if prop._dbus_signature != u"ay":
594
value = dbus.ByteArray(''.join(unichr(byte)
1330
@dbus.service.method(dbus.PROPERTIES_IFACE,
1332
out_signature="a{sv}")
598
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
599
out_signature=u"a{sv}")
1333
600
def GetAll(self, interface_name):
1334
601
"""Standard D-Bus property GetAll() method, see D-Bus
1337
604
Note: Will not include properties with access="write".
1340
for name, prop in self._get_all_dbus_things("property"):
607
for name, prop in self._get_all_dbus_properties():
1341
608
if (interface_name
1342
609
and interface_name != prop._dbus_interface):
1343
610
# Interface non-empty but did not match
1345
612
# Ignore write-only properties
1346
if prop._dbus_access == "write":
613
if prop._dbus_access == u"write":
1349
if not hasattr(value, "variant_level"):
1350
properties[name] = value
616
if not hasattr(value, u"variant_level"):
1352
properties[name] = type(value)(
1353
value, variant_level = value.variant_level + 1)
1354
return dbus.Dictionary(properties, signature="sv")
1356
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1357
def PropertiesChanged(self, interface_name, changed_properties,
1358
invalidated_properties):
1359
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
619
all[name] = type(value)(value, variant_level=
620
value.variant_level+1)
621
return dbus.Dictionary(all, signature=u"sv")
1364
623
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1366
625
path_keyword='object_path',
1367
626
connection_keyword='connection')
1368
627
def Introspect(self, object_path, connection):
1369
"""Overloading of standard D-Bus method.
1371
Inserts property tags and interface annotation tags.
628
"""Standard D-Bus method, overloaded to insert property tags.
1373
xmlstring = DBusObjectWithAnnotations.Introspect(self,
630
xmlstring = dbus.service.Object.Introspect(self, object_path,
1377
633
document = xml.dom.minidom.parseString(xmlstring)
1379
634
def make_tag(document, name, prop):
1380
e = document.createElement("property")
1381
e.setAttribute("name", name)
1382
e.setAttribute("type", prop._dbus_signature)
1383
e.setAttribute("access", prop._dbus_access)
635
e = document.createElement(u"property")
636
e.setAttribute(u"name", name)
637
e.setAttribute(u"type", prop._dbus_signature)
638
e.setAttribute(u"access", prop._dbus_access)
1386
for if_tag in document.getElementsByTagName("interface"):
640
for if_tag in document.getElementsByTagName(u"interface"):
1388
641
for tag in (make_tag(document, name, prop)
1390
in self._get_all_dbus_things("property")
643
in self._get_all_dbus_properties()
1391
644
if prop._dbus_interface
1392
== if_tag.getAttribute("name")):
645
== if_tag.getAttribute(u"name")):
1393
646
if_tag.appendChild(tag)
1394
# Add annotation tags for properties
1395
for tag in if_tag.getElementsByTagName("property"):
1397
for name, prop in self._get_all_dbus_things(
1399
if (name == tag.getAttribute("name")
1400
and prop._dbus_interface
1401
== if_tag.getAttribute("name")):
1402
annots.update(getattr(
1403
prop, "_dbus_annotations", {}))
1404
for name, value in annots.items():
1405
ann_tag = document.createElement(
1407
ann_tag.setAttribute("name", name)
1408
ann_tag.setAttribute("value", value)
1409
tag.appendChild(ann_tag)
1410
647
# Add the names to the return values for the
1411
648
# "org.freedesktop.DBus.Properties" methods
1412
if (if_tag.getAttribute("name")
1413
== "org.freedesktop.DBus.Properties"):
1414
for cn in if_tag.getElementsByTagName("method"):
1415
if cn.getAttribute("name") == "Get":
1416
for arg in cn.getElementsByTagName("arg"):
1417
if (arg.getAttribute("direction")
1419
arg.setAttribute("name", "value")
1420
elif cn.getAttribute("name") == "GetAll":
1421
for arg in cn.getElementsByTagName("arg"):
1422
if (arg.getAttribute("direction")
1424
arg.setAttribute("name", "props")
1425
xmlstring = document.toxml("utf-8")
1427
except (AttributeError, xml.dom.DOMException,
1428
xml.parsers.expat.ExpatError) as error:
1429
logger.error("Failed to override Introspection method",
1434
dbus.OBJECT_MANAGER_IFACE
1435
except AttributeError:
1436
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1438
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1439
"""A D-Bus object with an ObjectManager.
1441
Classes inheriting from this exposes the standard
1442
GetManagedObjects call and the InterfacesAdded and
1443
InterfacesRemoved signals on the standard
1444
"org.freedesktop.DBus.ObjectManager" interface.
1446
Note: No signals are sent automatically; they must be sent
1449
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1450
out_signature = "a{oa{sa{sv}}}")
1451
def GetManagedObjects(self):
1452
"""This function must be overridden"""
1453
raise NotImplementedError()
1455
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1456
signature = "oa{sa{sv}}")
1457
def InterfacesAdded(self, object_path, interfaces_and_properties):
1460
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1461
def InterfacesRemoved(self, object_path, interfaces):
1464
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1465
out_signature = "s",
1466
path_keyword = 'object_path',
1467
connection_keyword = 'connection')
1468
def Introspect(self, object_path, connection):
1469
"""Overloading of standard D-Bus method.
1471
Override return argument name of GetManagedObjects to be
1472
"objpath_interfaces_and_properties"
1474
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1478
document = xml.dom.minidom.parseString(xmlstring)
1480
for if_tag in document.getElementsByTagName("interface"):
1481
# Fix argument name for the GetManagedObjects method
1482
if (if_tag.getAttribute("name")
1483
== dbus.OBJECT_MANAGER_IFACE):
1484
for cn in if_tag.getElementsByTagName("method"):
1485
if (cn.getAttribute("name")
1486
== "GetManagedObjects"):
1487
for arg in cn.getElementsByTagName("arg"):
1488
if (arg.getAttribute("direction")
1492
"objpath_interfaces"
1494
xmlstring = document.toxml("utf-8")
1496
except (AttributeError, xml.dom.DOMException,
1497
xml.parsers.expat.ExpatError) as error:
1498
logger.error("Failed to override Introspection method",
1502
def datetime_to_dbus(dt, variant_level=0):
1503
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1505
return dbus.String("", variant_level = variant_level)
1506
return dbus.String(dt.isoformat(), variant_level=variant_level)
1509
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1510
"""A class decorator; applied to a subclass of
1511
dbus.service.Object, it will add alternate D-Bus attributes with
1512
interface names according to the "alt_interface_names" mapping.
1515
@alternate_dbus_interfaces({"org.example.Interface":
1516
"net.example.AlternateInterface"})
1517
class SampleDBusObject(dbus.service.Object):
1518
@dbus.service.method("org.example.Interface")
1519
def SampleDBusMethod():
1522
The above "SampleDBusMethod" on "SampleDBusObject" will be
1523
reachable via two interfaces: "org.example.Interface" and
1524
"net.example.AlternateInterface", the latter of which will have
1525
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1526
"true", unless "deprecate" is passed with a False value.
1528
This works for methods and signals, and also for D-Bus properties
1529
(from DBusObjectWithProperties) and interfaces (from the
1530
dbus_interface_annotations decorator).
1534
for orig_interface_name, alt_interface_name in (
1535
alt_interface_names.items()):
1537
interface_names = set()
1538
# Go though all attributes of the class
1539
for attrname, attribute in inspect.getmembers(cls):
1540
# Ignore non-D-Bus attributes, and D-Bus attributes
1541
# with the wrong interface name
1542
if (not hasattr(attribute, "_dbus_interface")
1543
or not attribute._dbus_interface.startswith(
1544
orig_interface_name)):
1546
# Create an alternate D-Bus interface name based on
1548
alt_interface = attribute._dbus_interface.replace(
1549
orig_interface_name, alt_interface_name)
1550
interface_names.add(alt_interface)
1551
# Is this a D-Bus signal?
1552
if getattr(attribute, "_dbus_is_signal", False):
1553
# Extract the original non-method undecorated
1554
# function by black magic
1555
if sys.version_info.major == 2:
1556
nonmethod_func = (dict(
1557
zip(attribute.func_code.co_freevars,
1558
attribute.__closure__))
1559
["func"].cell_contents)
1561
nonmethod_func = (dict(
1562
zip(attribute.__code__.co_freevars,
1563
attribute.__closure__))
1564
["func"].cell_contents)
1565
# Create a new, but exactly alike, function
1566
# object, and decorate it to be a new D-Bus signal
1567
# with the alternate D-Bus interface name
1568
new_function = copy_function(nonmethod_func)
1569
new_function = (dbus.service.signal(
1571
attribute._dbus_signature)(new_function))
1572
# Copy annotations, if any
1574
new_function._dbus_annotations = dict(
1575
attribute._dbus_annotations)
1576
except AttributeError:
1578
# Define a creator of a function to call both the
1579
# original and alternate functions, so both the
1580
# original and alternate signals gets sent when
1581
# the function is called
1582
def fixscope(func1, func2):
1583
"""This function is a scope container to pass
1584
func1 and func2 to the "call_both" function
1585
outside of its arguments"""
1587
@functools.wraps(func2)
1588
def call_both(*args, **kwargs):
1589
"""This function will emit two D-Bus
1590
signals by calling func1 and func2"""
1591
func1(*args, **kwargs)
1592
func2(*args, **kwargs)
1593
# Make wrapper function look like a D-Bus signal
1594
for name, attr in inspect.getmembers(func2):
1595
if name.startswith("_dbus_"):
1596
setattr(call_both, name, attr)
1599
# Create the "call_both" function and add it to
1601
attr[attrname] = fixscope(attribute, new_function)
1602
# Is this a D-Bus method?
1603
elif getattr(attribute, "_dbus_is_method", False):
1604
# Create a new, but exactly alike, function
1605
# object. Decorate it to be a new D-Bus method
1606
# with the alternate D-Bus interface name. Add it
1609
dbus.service.method(
1611
attribute._dbus_in_signature,
1612
attribute._dbus_out_signature)
1613
(copy_function(attribute)))
1614
# Copy annotations, if any
1616
attr[attrname]._dbus_annotations = dict(
1617
attribute._dbus_annotations)
1618
except AttributeError:
1620
# Is this a D-Bus property?
1621
elif getattr(attribute, "_dbus_is_property", False):
1622
# Create a new, but exactly alike, function
1623
# object, and decorate it to be a new D-Bus
1624
# property with the alternate D-Bus interface
1625
# name. Add it to the class.
1626
attr[attrname] = (dbus_service_property(
1627
alt_interface, attribute._dbus_signature,
1628
attribute._dbus_access,
1629
attribute._dbus_get_args_options
1631
(copy_function(attribute)))
1632
# Copy annotations, if any
1634
attr[attrname]._dbus_annotations = dict(
1635
attribute._dbus_annotations)
1636
except AttributeError:
1638
# Is this a D-Bus interface?
1639
elif getattr(attribute, "_dbus_is_interface", False):
1640
# Create a new, but exactly alike, function
1641
# object. Decorate it to be a new D-Bus interface
1642
# with the alternate D-Bus interface name. Add it
1645
dbus_interface_annotations(alt_interface)
1646
(copy_function(attribute)))
1648
# Deprecate all alternate interfaces
1649
iname="_AlternateDBusNames_interface_annotation{}"
1650
for interface_name in interface_names:
1652
@dbus_interface_annotations(interface_name)
1654
return { "org.freedesktop.DBus.Deprecated":
1656
# Find an unused name
1657
for aname in (iname.format(i)
1658
for i in itertools.count()):
1659
if aname not in attr:
1663
# Replace the class with a new subclass of it with
1664
# methods, signals, etc. as created above.
1665
if sys.version_info.major == 2:
1666
cls = type(b"{}Alternate".format(cls.__name__),
1669
cls = type("{}Alternate".format(cls.__name__),
1676
@alternate_dbus_interfaces({"se.recompile.Mandos":
1677
"se.bsnet.fukt.Mandos"})
649
if (if_tag.getAttribute(u"name")
650
== u"org.freedesktop.DBus.Properties"):
651
for cn in if_tag.getElementsByTagName(u"method"):
652
if cn.getAttribute(u"name") == u"Get":
653
for arg in cn.getElementsByTagName(u"arg"):
654
if (arg.getAttribute(u"direction")
656
arg.setAttribute(u"name", u"value")
657
elif cn.getAttribute(u"name") == u"GetAll":
658
for arg in cn.getElementsByTagName(u"arg"):
659
if (arg.getAttribute(u"direction")
661
arg.setAttribute(u"name", u"props")
662
xmlstring = document.toxml(u"utf-8")
664
except (AttributeError, xml.dom.DOMException,
665
xml.parsers.expat.ExpatError), error:
666
logger.error(u"Failed to override Introspection method",
1678
671
class ClientDBus(Client, DBusObjectWithProperties):
1679
672
"""A Client class using D-Bus
1695
682
Client.__init__(self, *args, **kwargs)
1696
683
# Only now, when this client is initialized, can it show up on
1698
client_object_name = str(self.name).translate(
1699
{ord("."): ord("_"),
1700
ord("-"): ord("_")})
1701
self.dbus_object_path = dbus.ObjectPath(
1702
"/clients/" + client_object_name)
685
self.dbus_object_path = (dbus.ObjectPath
687
+ self.name.replace(u".", u"_")))
1703
688
DBusObjectWithProperties.__init__(self, self.bus,
1704
689
self.dbus_object_path)
1706
def notifychangeproperty(transform_func, dbus_name,
1707
type_func=lambda x: x,
1709
invalidate_only=False,
1710
_interface=_interface):
1711
""" Modify a variable so that it's a property which announces
1712
its changes to DBus.
1714
transform_fun: Function that takes a value and a variant_level
1715
and transforms it to a D-Bus type.
1716
dbus_name: D-Bus name of the variable
1717
type_func: Function that transform the value before sending it
1718
to the D-Bus. Default: no transform
1719
variant_level: D-Bus variant level. Default: 1
1721
attrname = "_{}".format(dbus_name)
1723
def setter(self, value):
1724
if hasattr(self, "dbus_object_path"):
1725
if (not hasattr(self, attrname) or
1726
type_func(getattr(self, attrname, None))
1727
!= type_func(value)):
1729
self.PropertiesChanged(
1730
_interface, dbus.Dictionary(),
1731
dbus.Array((dbus_name, )))
1733
dbus_value = transform_func(
1735
variant_level = variant_level)
1736
self.PropertyChanged(dbus.String(dbus_name),
1738
self.PropertiesChanged(
1740
dbus.Dictionary({ dbus.String(dbus_name):
1743
setattr(self, attrname, value)
1745
return property(lambda self: getattr(self, attrname), setter)
1747
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1748
approvals_pending = notifychangeproperty(dbus.Boolean,
1751
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1752
last_enabled = notifychangeproperty(datetime_to_dbus,
1754
checker = notifychangeproperty(
1755
dbus.Boolean, "CheckerRunning",
1756
type_func = lambda checker: checker is not None)
1757
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1759
last_checker_status = notifychangeproperty(dbus.Int16,
1760
"LastCheckerStatus")
1761
last_approval_request = notifychangeproperty(
1762
datetime_to_dbus, "LastApprovalRequest")
1763
approved_by_default = notifychangeproperty(dbus.Boolean,
1764
"ApprovedByDefault")
1765
approval_delay = notifychangeproperty(
1766
dbus.UInt64, "ApprovalDelay",
1767
type_func = lambda td: td.total_seconds() * 1000)
1768
approval_duration = notifychangeproperty(
1769
dbus.UInt64, "ApprovalDuration",
1770
type_func = lambda td: td.total_seconds() * 1000)
1771
host = notifychangeproperty(dbus.String, "Host")
1772
timeout = notifychangeproperty(
1773
dbus.UInt64, "Timeout",
1774
type_func = lambda td: td.total_seconds() * 1000)
1775
extended_timeout = notifychangeproperty(
1776
dbus.UInt64, "ExtendedTimeout",
1777
type_func = lambda td: td.total_seconds() * 1000)
1778
interval = notifychangeproperty(
1779
dbus.UInt64, "Interval",
1780
type_func = lambda td: td.total_seconds() * 1000)
1781
checker_command = notifychangeproperty(dbus.String, "Checker")
1782
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1783
invalidate_only=True)
1785
del notifychangeproperty
692
def _datetime_to_dbus(dt, variant_level=0):
693
"""Convert a UTC datetime.datetime() to a D-Bus type."""
694
return dbus.String(dt.isoformat(),
695
variant_level=variant_level)
698
oldstate = getattr(self, u"enabled", False)
699
r = Client.enable(self)
700
if oldstate != self.enabled:
702
self.PropertyChanged(dbus.String(u"enabled"),
703
dbus.Boolean(True, variant_level=1))
704
self.PropertyChanged(
705
dbus.String(u"last_enabled"),
706
self._datetime_to_dbus(self.last_enabled,
710
def disable(self, quiet = False):
711
oldstate = getattr(self, u"enabled", False)
712
r = Client.disable(self, quiet=quiet)
713
if not quiet and oldstate != self.enabled:
715
self.PropertyChanged(dbus.String(u"enabled"),
716
dbus.Boolean(False, variant_level=1))
1787
719
def __del__(self, *args, **kwargs):
1789
721
self.remove_from_connection()
1790
722
except LookupError:
1792
if hasattr(DBusObjectWithProperties, "__del__"):
724
if hasattr(DBusObjectWithProperties, u"__del__"):
1793
725
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1794
726
Client.__del__(self, *args, **kwargs)
1796
def checker_callback(self, source, condition,
1797
connection, command, *args, **kwargs):
1798
ret = Client.checker_callback(self, source, condition,
1799
connection, command, *args,
1801
exitstatus = self.last_checker_status
728
def checker_callback(self, pid, condition, command,
730
self.checker_callback_tag = None
733
self.PropertyChanged(dbus.String(u"checker_running"),
734
dbus.Boolean(False, variant_level=1))
735
if os.WIFEXITED(condition):
736
exitstatus = os.WEXITSTATUS(condition)
1803
737
# Emit D-Bus signal
1804
738
self.CheckerCompleted(dbus.Int16(exitstatus),
1805
# This is specific to GNU libC
1806
dbus.Int64(exitstatus << 8),
739
dbus.Int64(condition),
1807
740
dbus.String(command))
1809
742
# Emit D-Bus signal
1810
743
self.CheckerCompleted(dbus.Int16(-1),
1812
# This is specific to GNU libC
1814
| self.last_checker_signal),
744
dbus.Int64(condition),
1815
745
dbus.String(command))
747
return Client.checker_callback(self, pid, condition, command,
750
def checked_ok(self, *args, **kwargs):
751
r = Client.checked_ok(self, *args, **kwargs)
753
self.PropertyChanged(
754
dbus.String(u"last_checked_ok"),
755
(self._datetime_to_dbus(self.last_checked_ok,
1818
759
def start_checker(self, *args, **kwargs):
1819
old_checker_pid = getattr(self.checker, "pid", None)
760
old_checker = self.checker
761
if self.checker is not None:
762
old_checker_pid = self.checker.pid
764
old_checker_pid = None
1820
765
r = Client.start_checker(self, *args, **kwargs)
1821
766
# Only if new checker process was started
1822
767
if (self.checker is not None
1823
768
and old_checker_pid != self.checker.pid):
1824
769
# Emit D-Bus signal
1825
770
self.CheckerStarted(self.current_checker_command)
1828
def _reset_approved(self):
1829
self.approved = None
1832
def approve(self, value=True):
1833
self.approved = value
1834
GLib.timeout_add(int(self.approval_duration.total_seconds()
1835
* 1000), self._reset_approved)
1836
self.send_changedstate()
771
self.PropertyChanged(
772
dbus.String(u"checker_running"),
773
dbus.Boolean(True, variant_level=1))
776
def stop_checker(self, *args, **kwargs):
777
old_checker = getattr(self, u"checker", None)
778
r = Client.stop_checker(self, *args, **kwargs)
779
if (old_checker is not None
780
and getattr(self, u"checker", None) is None):
781
self.PropertyChanged(dbus.String(u"checker_running"),
782
dbus.Boolean(False, variant_level=1))
1838
785
## D-Bus methods, signals & properties
786
_interface = u"se.bsnet.fukt.Mandos.Client"
1844
790
# CheckerCompleted - signal
1845
@dbus.service.signal(_interface, signature="nxs")
791
@dbus.service.signal(_interface, signature=u"nxs")
1846
792
def CheckerCompleted(self, exitcode, waitstatus, command):
1850
796
# CheckerStarted - signal
1851
@dbus.service.signal(_interface, signature="s")
797
@dbus.service.signal(_interface, signature=u"s")
1852
798
def CheckerStarted(self, command):
1856
802
# PropertyChanged - signal
1857
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1858
@dbus.service.signal(_interface, signature="sv")
803
@dbus.service.signal(_interface, signature=u"sv")
1859
804
def PropertyChanged(self, property, value):
2158
995
Note: This will run in its own forked process."""
2160
997
def handle(self):
2161
with contextlib.closing(self.server.child_pipe) as child_pipe:
2162
logger.info("TCP connection from: %s",
2163
str(self.client_address))
2164
logger.debug("Pipe FD: %d",
2165
self.server.child_pipe.fileno())
2167
session = gnutls.ClientSession(self.request)
2169
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2170
# "+AES-256-CBC", "+SHA1",
2171
# "+COMP-NULL", "+CTYPE-OPENPGP",
998
logger.info(u"TCP connection from: %s",
999
unicode(self.client_address))
1000
logger.debug(u"IPC Pipe FD: %d",
1001
self.server.child_pipe[1].fileno())
1002
# Open IPC pipe to parent process
1003
with contextlib.nested(self.server.child_pipe[1],
1004
self.server.parent_pipe[0]
1005
) as (ipc, ipc_return):
1006
session = (gnutls.connection
1007
.ClientSession(self.request,
1009
.X509Credentials()))
1011
# Note: gnutls.connection.X509Credentials is really a
1012
# generic GnuTLS certificate credentials object so long as
1013
# no X.509 keys are added to it. Therefore, we can use it
1014
# here despite using OpenPGP certificates.
1016
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1017
# u"+AES-256-CBC", u"+SHA1",
1018
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2173
1020
# Use a fallback default, since this MUST be set.
2174
1021
priority = self.server.gnutls_priority
2175
1022
if priority is None:
2177
gnutls.priority_set_direct(session._c_object, priority,
1023
priority = u"NORMAL"
1024
(gnutls.library.functions
1025
.gnutls_priority_set_direct(session._c_object,
2180
1028
# Start communication using the Mandos protocol
2181
1029
# Get protocol number
2182
1030
line = self.request.makefile().readline()
2183
logger.debug("Protocol version: %r", line)
1031
logger.debug(u"Protocol version: %r", line)
2185
1033
if int(line.strip().split()[0]) > 1:
2186
raise RuntimeError(line)
2187
except (ValueError, IndexError, RuntimeError) as error:
2188
logger.error("Unknown protocol version: %s", error)
1035
except (ValueError, IndexError, RuntimeError), error:
1036
logger.error(u"Unknown protocol version: %s", error)
2191
1039
# Start GnuTLS connection
2193
1041
session.handshake()
2194
except gnutls.Error as error:
2195
logger.warning("Handshake failed: %s", error)
1042
except gnutls.errors.GNUTLSError, error:
1043
logger.warning(u"Handshake failed: %s", error)
2196
1044
# Do not run session.bye() here: the session is not
2197
1045
# established. Just abandon the request.
2199
logger.debug("Handshake succeeded")
2201
approval_required = False
1047
logger.debug(u"Handshake succeeded")
2204
fpr = self.fingerprint(
2205
self.peer_certificate(session))
2206
except (TypeError, gnutls.Error) as error:
2207
logger.warning("Bad certificate: %s", error)
2209
logger.debug("Fingerprint: %s", fpr)
2212
client = ProxyClient(child_pipe, fpr,
2213
self.client_address)
2217
if client.approval_delay:
2218
delay = client.approval_delay
2219
client.approvals_pending += 1
2220
approval_required = True
2223
if not client.enabled:
2224
logger.info("Client %s is disabled",
2226
if self.server.use_dbus:
2228
client.Rejected("Disabled")
2231
if client.approved or not client.approval_delay:
2232
#We are approved or approval is disabled
1050
fpr = self.fingerprint(self.peer_certificate
1052
except (TypeError, gnutls.errors.GNUTLSError), error:
1053
logger.warning(u"Bad certificate: %s", error)
1055
logger.debug(u"Fingerprint: %s", fpr)
1057
for c in self.server.clients:
1058
if c.fingerprint == fpr:
2234
elif client.approved is None:
2235
logger.info("Client %s needs approval",
2237
if self.server.use_dbus:
2239
client.NeedApproval(
2240
client.approval_delay.total_seconds()
2241
* 1000, client.approved_by_default)
2243
logger.warning("Client %s was not approved",
2245
if self.server.use_dbus:
2247
client.Rejected("Denied")
2250
#wait until timeout or approved
2251
time = datetime.datetime.now()
2252
client.changedstate.acquire()
2253
client.changedstate.wait(delay.total_seconds())
2254
client.changedstate.release()
2255
time2 = datetime.datetime.now()
2256
if (time2 - time) >= delay:
2257
if not client.approved_by_default:
2258
logger.warning("Client %s timed out while"
2259
" waiting for approval",
2261
if self.server.use_dbus:
2263
client.Rejected("Approval timed out")
2268
delay -= time2 - time
2271
session.send(client.secret)
2272
except gnutls.Error as error:
2273
logger.warning("gnutls send failed",
2277
logger.info("Sending secret to %s", client.name)
2278
# bump the timeout using extended_timeout
2279
client.bump_timeout(client.extended_timeout)
2280
if self.server.use_dbus:
1062
ipc.write(u"NOTFOUND %s %s\n"
1063
% (fpr, unicode(self.client_address)))
1066
class ClientProxy(object):
1067
"""Client proxy object. Not for calling methods."""
1068
def __init__(self, client):
1069
self.client = client
1070
def __getattr__(self, name):
1071
if name.startswith("ipc_"):
1073
ipc.write("%s %s\n" % (name[4:].upper(),
1076
if not hasattr(self.client, name):
1077
raise AttributeError
1078
ipc.write(u"GETATTR %s %s\n"
1079
% (name, self.client.fingerprint))
1080
return pickle.load(ipc_return)
1081
clientproxy = ClientProxy(client)
1082
# Have to check if client.enabled, since it is
1083
# possible that the client was disabled since the
1084
# GnuTLS session was established.
1085
if not clientproxy.enabled:
1086
clientproxy.ipc_disabled()
1089
clientproxy.ipc_sending()
1091
while sent_size < len(client.secret):
1092
sent = session.send(client.secret[sent_size:])
1093
logger.debug(u"Sent: %d, remaining: %d",
1094
sent, len(client.secret)
1095
- (sent_size + sent))
2285
if approval_required:
2286
client.approvals_pending -= 1
2289
except gnutls.Error as error:
2290
logger.warning("GnuTLS bye failed",
2294
1101
def peer_certificate(session):
2295
1102
"Return the peer's OpenPGP certificate as a bytestring"
2296
1103
# If not an OpenPGP certificate...
2297
if (gnutls.certificate_type_get(session._c_object)
2298
!= gnutls.CRT_OPENPGP):
2299
# ...return invalid data
1104
if (gnutls.library.functions
1105
.gnutls_certificate_type_get(session._c_object)
1106
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1107
# ...do the normal thing
1108
return session.peer_certificate
2301
1109
list_size = ctypes.c_uint(1)
2302
cert_list = (gnutls.certificate_get_peers
1110
cert_list = (gnutls.library.functions
1111
.gnutls_certificate_get_peers
2303
1112
(session._c_object, ctypes.byref(list_size)))
2304
1113
if not bool(cert_list) and list_size.value != 0:
2305
raise gnutls.Error("error getting peer certificate")
1114
raise gnutls.errors.GNUTLSError(u"error getting peer"
2306
1116
if list_size.value == 0:
2308
1118
cert = cert_list[0]
2486
1255
gnutls_priority GnuTLS priority string
2487
1256
use_dbus: Boolean; to emit D-Bus signals or not
2489
Assumes a GLib.MainLoop event loop.
1258
Assumes a gobject.MainLoop event loop.
2492
1260
def __init__(self, server_address, RequestHandlerClass,
2496
gnutls_priority=None,
1261
interface=None, use_ipv6=True, clients=None,
1262
gnutls_priority=None, use_dbus=True):
2499
1263
self.enabled = False
2500
1264
self.clients = clients
2501
1265
if self.clients is None:
1266
self.clients = set()
2503
1267
self.use_dbus = use_dbus
2504
1268
self.gnutls_priority = gnutls_priority
2505
1269
IPv6_TCPServer.__init__(self, server_address,
2506
1270
RequestHandlerClass,
2507
1271
interface = interface,
2508
use_ipv6 = use_ipv6,
2509
socketfd = socketfd)
1272
use_ipv6 = use_ipv6)
2511
1273
def server_activate(self):
2512
1274
if self.enabled:
2513
1275
return socketserver.TCPServer.server_activate(self)
2515
1276
def enable(self):
2516
1277
self.enabled = True
2518
def add_pipe(self, parent_pipe, proc):
1278
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
2519
1279
# Call "handle_ipc" for both data and EOF events
2521
parent_pipe.fileno(),
2522
GLib.IO_IN | GLib.IO_HUP,
2523
functools.partial(self.handle_ipc,
2524
parent_pipe = parent_pipe,
2527
def handle_ipc(self, source, condition,
2530
client_object=None):
2531
# error, or the other end of multiprocessing.Pipe has closed
2532
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2533
# Wait for other process to exit
2537
# Read a request from the child
2538
request = parent_pipe.recv()
2539
command = request[0]
2541
if command == 'init':
2543
address = request[2]
2545
for c in self.clients.values():
2546
if c.fingerprint == fpr:
2550
logger.info("Client not found for fingerprint: %s, ad"
2551
"dress: %s", fpr, address)
2554
mandos_dbus_service.ClientNotFound(fpr,
2556
parent_pipe.send(False)
2560
parent_pipe.fileno(),
2561
GLib.IO_IN | GLib.IO_HUP,
2562
functools.partial(self.handle_ipc,
2563
parent_pipe = parent_pipe,
2565
client_object = client))
2566
parent_pipe.send(True)
2567
# remove the old hook in favor of the new above hook on
2570
if command == 'funcall':
2571
funcname = request[1]
2575
parent_pipe.send(('data', getattr(client_object,
2579
if command == 'getattr':
2580
attrname = request[1]
2581
if isinstance(client_object.__getattribute__(attrname),
2582
collections.Callable):
2583
parent_pipe.send(('function', ))
2586
'data', client_object.__getattribute__(attrname)))
2588
if command == 'setattr':
2589
attrname = request[1]
2591
setattr(client_object, attrname, value)
1280
gobject.io_add_watch(child_pipe_fd.fileno(),
1281
gobject.IO_IN | gobject.IO_HUP,
1282
functools.partial(self.handle_ipc,
1283
reply = parent_pipe_fd,
1284
sender= child_pipe_fd))
1285
def handle_ipc(self, source, condition, reply=None, sender=None):
1287
gobject.IO_IN: u"IN", # There is data to read.
1288
gobject.IO_OUT: u"OUT", # Data can be written (without
1290
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1291
gobject.IO_ERR: u"ERR", # Error condition.
1292
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1293
# broken, usually for pipes and
1296
conditions_string = ' | '.join(name
1298
condition_names.iteritems()
1299
if cond & condition)
1300
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1303
# Read a line from the file object
1304
cmdline = sender.readline()
1305
if not cmdline: # Empty line means end of file
1306
# close the IPC pipes
1310
# Stop calling this function
1313
logger.debug(u"IPC command: %r", cmdline)
1315
# Parse and act on command
1316
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1318
if cmd == u"NOTFOUND":
1319
fpr, address = args.split(None, 1)
1320
logger.warning(u"Client not found for fingerprint: %s, ad"
1321
u"dress: %s", fpr, address)
1324
mandos_dbus_service.ClientNotFound(fpr, address)
1325
elif cmd == u"DISABLED":
1326
for client in self.clients:
1327
if client.name == args:
1328
logger.warning(u"Client %s is disabled", args)
1334
logger.error(u"Unknown client %s is disabled", args)
1335
elif cmd == u"SENDING":
1336
for client in self.clients:
1337
if client.name == args:
1338
logger.info(u"Sending secret to %s", client.name)
1345
logger.error(u"Sending secret to unknown client %s",
1347
elif cmd == u"GETATTR":
1348
attr_name, fpr = args.split(None, 1)
1349
for client in self.clients:
1350
if client.fingerprint == fpr:
1351
attr_value = getattr(client, attr_name, None)
1352
logger.debug("IPC reply: %r", attr_value)
1353
pickle.dump(attr_value, reply)
1356
logger.error(u"Client %s on address %s requesting "
1357
u"attribute %s not found", fpr, address,
1359
pickle.dump(None, reply)
1361
logger.error(u"Unknown IPC command: %r", cmdline)
1363
# Keep calling this function
2596
def rfc3339_duration_to_delta(duration):
2597
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2599
>>> rfc3339_duration_to_delta("P7D")
2600
datetime.timedelta(7)
2601
>>> rfc3339_duration_to_delta("PT60S")
2602
datetime.timedelta(0, 60)
2603
>>> rfc3339_duration_to_delta("PT60M")
2604
datetime.timedelta(0, 3600)
2605
>>> rfc3339_duration_to_delta("PT24H")
2606
datetime.timedelta(1)
2607
>>> rfc3339_duration_to_delta("P1W")
2608
datetime.timedelta(7)
2609
>>> rfc3339_duration_to_delta("PT5M30S")
2610
datetime.timedelta(0, 330)
2611
>>> rfc3339_duration_to_delta("P1DT3M20S")
2612
datetime.timedelta(1, 200)
2615
# Parsing an RFC 3339 duration with regular expressions is not
2616
# possible - there would have to be multiple places for the same
2617
# values, like seconds. The current code, while more esoteric, is
2618
# cleaner without depending on a parsing library. If Python had a
2619
# built-in library for parsing we would use it, but we'd like to
2620
# avoid excessive use of external libraries.
2622
# New type for defining tokens, syntax, and semantics all-in-one
2623
Token = collections.namedtuple("Token", (
2624
"regexp", # To match token; if "value" is not None, must have
2625
# a "group" containing digits
2626
"value", # datetime.timedelta or None
2627
"followers")) # Tokens valid after this token
2628
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2629
# the "duration" ABNF definition in RFC 3339, Appendix A.
2630
token_end = Token(re.compile(r"$"), None, frozenset())
2631
token_second = Token(re.compile(r"(\d+)S"),
2632
datetime.timedelta(seconds=1),
2633
frozenset((token_end, )))
2634
token_minute = Token(re.compile(r"(\d+)M"),
2635
datetime.timedelta(minutes=1),
2636
frozenset((token_second, token_end)))
2637
token_hour = Token(re.compile(r"(\d+)H"),
2638
datetime.timedelta(hours=1),
2639
frozenset((token_minute, token_end)))
2640
token_time = Token(re.compile(r"T"),
2642
frozenset((token_hour, token_minute,
2644
token_day = Token(re.compile(r"(\d+)D"),
2645
datetime.timedelta(days=1),
2646
frozenset((token_time, token_end)))
2647
token_month = Token(re.compile(r"(\d+)M"),
2648
datetime.timedelta(weeks=4),
2649
frozenset((token_day, token_end)))
2650
token_year = Token(re.compile(r"(\d+)Y"),
2651
datetime.timedelta(weeks=52),
2652
frozenset((token_month, token_end)))
2653
token_week = Token(re.compile(r"(\d+)W"),
2654
datetime.timedelta(weeks=1),
2655
frozenset((token_end, )))
2656
token_duration = Token(re.compile(r"P"), None,
2657
frozenset((token_year, token_month,
2658
token_day, token_time,
2660
# Define starting values
2661
value = datetime.timedelta() # Value so far
2663
followers = frozenset((token_duration, )) # Following valid tokens
2664
s = duration # String left to parse
2665
# Loop until end token is found
2666
while found_token is not token_end:
2667
# Search for any currently valid tokens
2668
for token in followers:
2669
match = token.regexp.match(s)
2670
if match is not None:
2672
if token.value is not None:
2673
# Value found, parse digits
2674
factor = int(match.group(1), 10)
2675
# Add to value so far
2676
value += factor * token.value
2677
# Strip token from string
2678
s = token.regexp.sub("", s, 1)
2681
# Set valid next tokens
2682
followers = found_token.followers
2685
# No currently valid tokens were found
2686
raise ValueError("Invalid RFC 3339 duration: {!r}"
2692
1367
def string_to_delta(interval):
2693
1368
"""Parse a string and return a datetime.timedelta
2695
>>> string_to_delta('7d')
1370
>>> string_to_delta(u'7d')
2696
1371
datetime.timedelta(7)
2697
>>> string_to_delta('60s')
1372
>>> string_to_delta(u'60s')
2698
1373
datetime.timedelta(0, 60)
2699
>>> string_to_delta('60m')
1374
>>> string_to_delta(u'60m')
2700
1375
datetime.timedelta(0, 3600)
2701
>>> string_to_delta('24h')
1376
>>> string_to_delta(u'24h')
2702
1377
datetime.timedelta(1)
2703
>>> string_to_delta('1w')
1378
>>> string_to_delta(u'1w')
2704
1379
datetime.timedelta(7)
2705
>>> string_to_delta('5m 30s')
1380
>>> string_to_delta(u'5m 30s')
2706
1381
datetime.timedelta(0, 330)
2710
return rfc3339_duration_to_delta(interval)
2714
1383
timevalue = datetime.timedelta(0)
2715
1384
for s in interval.split():
1386
suffix = unicode(s[-1])
2718
1387
value = int(s[:-1])
2720
1389
delta = datetime.timedelta(value)
1390
elif suffix == u"s":
2722
1391
delta = datetime.timedelta(0, value)
1392
elif suffix == u"m":
2724
1393
delta = datetime.timedelta(0, 0, 0, 0, value)
1394
elif suffix == u"h":
2726
1395
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1396
elif suffix == u"w":
2728
1397
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2730
raise ValueError("Unknown suffix {!r}".format(suffix))
2731
except IndexError as e:
2732
raise ValueError(*(e.args))
1399
raise ValueError(u"Unknown suffix %r" % suffix)
1400
except (ValueError, IndexError), e:
1401
raise ValueError(e.message)
2733
1402
timevalue += delta
2734
1403
return timevalue
1406
def if_nametoindex(interface):
1407
"""Call the C function if_nametoindex(), or equivalent
1409
Note: This function cannot accept a unicode string."""
1410
global if_nametoindex
1412
if_nametoindex = (ctypes.cdll.LoadLibrary
1413
(ctypes.util.find_library(u"c"))
1415
except (OSError, AttributeError):
1416
logger.warning(u"Doing if_nametoindex the hard way")
1417
def if_nametoindex(interface):
1418
"Get an interface index the hard way, i.e. using fcntl()"
1419
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1420
with contextlib.closing(socket.socket()) as s:
1421
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1422
struct.pack(str(u"16s16x"),
1424
interface_index = struct.unpack(str(u"I"),
1426
return interface_index
1427
return if_nametoindex(interface)
2737
1430
def daemon(nochdir = False, noclose = False):
2738
1431
"""See daemon(3). Standard BSD Unix function.
2764
1457
##################################################################
2765
1458
# Parsing of options, both command line and config file
2767
parser = argparse.ArgumentParser()
2768
parser.add_argument("-v", "--version", action="version",
2769
version = "%(prog)s {}".format(version),
2770
help="show version number and exit")
2771
parser.add_argument("-i", "--interface", metavar="IF",
2772
help="Bind to interface IF")
2773
parser.add_argument("-a", "--address",
2774
help="Address to listen for requests on")
2775
parser.add_argument("-p", "--port", type=int,
2776
help="Port number to receive requests on")
2777
parser.add_argument("--check", action="store_true",
2778
help="Run self-test")
2779
parser.add_argument("--debug", action="store_true",
2780
help="Debug mode; run in foreground and log"
2781
" to terminal", default=None)
2782
parser.add_argument("--debuglevel", metavar="LEVEL",
2783
help="Debug level for stdout output")
2784
parser.add_argument("--priority", help="GnuTLS"
2785
" priority string (see GnuTLS documentation)")
2786
parser.add_argument("--servicename",
2787
metavar="NAME", help="Zeroconf service name")
2788
parser.add_argument("--configdir",
2789
default="/etc/mandos", metavar="DIR",
2790
help="Directory to search for configuration"
2792
parser.add_argument("--no-dbus", action="store_false",
2793
dest="use_dbus", help="Do not provide D-Bus"
2794
" system bus interface", default=None)
2795
parser.add_argument("--no-ipv6", action="store_false",
2796
dest="use_ipv6", help="Do not use IPv6",
2798
parser.add_argument("--no-restore", action="store_false",
2799
dest="restore", help="Do not restore stored"
2800
" state", default=None)
2801
parser.add_argument("--socket", type=int,
2802
help="Specify a file descriptor to a network"
2803
" socket to use instead of creating one")
2804
parser.add_argument("--statedir", metavar="DIR",
2805
help="Directory to save/restore state in")
2806
parser.add_argument("--foreground", action="store_true",
2807
help="Run in foreground", default=None)
2808
parser.add_argument("--no-zeroconf", action="store_false",
2809
dest="zeroconf", help="Do not use Zeroconf",
2812
options = parser.parse_args()
1460
parser = optparse.OptionParser(version = "%%prog %s" % version)
1461
parser.add_option("-i", u"--interface", type=u"string",
1462
metavar="IF", help=u"Bind to interface IF")
1463
parser.add_option("-a", u"--address", type=u"string",
1464
help=u"Address to listen for requests on")
1465
parser.add_option("-p", u"--port", type=u"int",
1466
help=u"Port number to receive requests on")
1467
parser.add_option("--check", action=u"store_true",
1468
help=u"Run self-test")
1469
parser.add_option("--debug", action=u"store_true",
1470
help=u"Debug mode; run in foreground and log to"
1472
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1473
u" priority string (see GnuTLS documentation)")
1474
parser.add_option("--servicename", type=u"string",
1475
metavar=u"NAME", help=u"Zeroconf service name")
1476
parser.add_option("--configdir", type=u"string",
1477
default=u"/etc/mandos", metavar=u"DIR",
1478
help=u"Directory to search for configuration"
1480
parser.add_option("--no-dbus", action=u"store_false",
1481
dest=u"use_dbus", help=u"Do not provide D-Bus"
1482
u" system bus interface")
1483
parser.add_option("--no-ipv6", action=u"store_false",
1484
dest=u"use_ipv6", help=u"Do not use IPv6")
1485
options = parser.parse_args()[0]
2814
1487
if options.check:
2816
fail_count, test_count = doctest.testmod()
2817
sys.exit(os.EX_OK if fail_count == 0 else 1)
2819
1492
# Default values for config file for server-global settings
2820
server_defaults = { "interface": "",
2825
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2826
":+SIGN-DSA-SHA256",
2827
"servicename": "Mandos",
2833
"statedir": "/var/lib/mandos",
2834
"foreground": "False",
1493
server_defaults = { u"interface": u"",
1498
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1499
u"servicename": u"Mandos",
1500
u"use_dbus": u"True",
1501
u"use_ipv6": u"True",
2838
1504
# Parse config file for server-global settings
2839
1505
server_config = configparser.SafeConfigParser(server_defaults)
2840
1506
del server_defaults
2841
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1507
server_config.read(os.path.join(options.configdir,
2842
1509
# Convert the SafeConfigParser object to a dict
2843
1510
server_settings = server_config.defaults()
2844
1511
# Use the appropriate methods on the non-string config options
2845
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2846
server_settings[option] = server_config.getboolean("DEFAULT",
1512
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1513
server_settings[option] = server_config.getboolean(u"DEFAULT",
2848
1515
if server_settings["port"]:
2849
server_settings["port"] = server_config.getint("DEFAULT",
2851
if server_settings["socket"]:
2852
server_settings["socket"] = server_config.getint("DEFAULT",
2854
# Later, stdin will, and stdout and stderr might, be dup'ed
2855
# over with an opened os.devnull. But we don't want this to
2856
# happen with a supplied network socket.
2857
if 0 <= server_settings["socket"] <= 2:
2858
server_settings["socket"] = os.dup(server_settings
1516
server_settings["port"] = server_config.getint(u"DEFAULT",
2860
1518
del server_config
2862
1520
# Override the settings from the config file with command line
2863
1521
# options, if set.
2864
for option in ("interface", "address", "port", "debug",
2865
"priority", "servicename", "configdir", "use_dbus",
2866
"use_ipv6", "debuglevel", "restore", "statedir",
2867
"socket", "foreground", "zeroconf"):
1522
for option in (u"interface", u"address", u"port", u"debug",
1523
u"priority", u"servicename", u"configdir",
1524
u"use_dbus", u"use_ipv6"):
2868
1525
value = getattr(options, option)
2869
1526
if value is not None:
2870
1527
server_settings[option] = value
2872
1529
# Force all strings to be unicode
2873
1530
for option in server_settings.keys():
2874
if isinstance(server_settings[option], bytes):
2875
server_settings[option] = (server_settings[option]
2877
# Force all boolean options to be boolean
2878
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2879
"foreground", "zeroconf"):
2880
server_settings[option] = bool(server_settings[option])
2881
# Debug implies foreground
2882
if server_settings["debug"]:
2883
server_settings["foreground"] = True
1531
if type(server_settings[option]) is str:
1532
server_settings[option] = unicode(server_settings[option])
2884
1533
# Now we have our good server settings in "server_settings"
2886
1535
##################################################################
2888
if (not server_settings["zeroconf"]
2889
and not (server_settings["port"]
2890
or server_settings["socket"] != "")):
2891
parser.error("Needs port or socket to work without Zeroconf")
2893
1537
# For convenience
2894
debug = server_settings["debug"]
2895
debuglevel = server_settings["debuglevel"]
2896
use_dbus = server_settings["use_dbus"]
2897
use_ipv6 = server_settings["use_ipv6"]
2898
stored_state_path = os.path.join(server_settings["statedir"],
2900
foreground = server_settings["foreground"]
2901
zeroconf = server_settings["zeroconf"]
2904
initlogger(debug, logging.DEBUG)
2909
level = getattr(logging, debuglevel.upper())
2910
initlogger(debug, level)
2912
if server_settings["servicename"] != "Mandos":
2913
syslogger.setFormatter(
2914
logging.Formatter('Mandos ({}) [%(process)d]:'
2915
' %(levelname)s: %(message)s'.format(
2916
server_settings["servicename"])))
1538
debug = server_settings[u"debug"]
1539
use_dbus = server_settings[u"use_dbus"]
1540
use_ipv6 = server_settings[u"use_ipv6"]
1543
syslogger.setLevel(logging.WARNING)
1544
console.setLevel(logging.WARNING)
1546
if server_settings[u"servicename"] != u"Mandos":
1547
syslogger.setFormatter(logging.Formatter
1548
(u'Mandos (%s) [%%(process)d]:'
1549
u' %%(levelname)s: %%(message)s'
1550
% server_settings[u"servicename"]))
2918
1552
# Parse config file with clients
2919
client_config = configparser.SafeConfigParser(Client
2921
client_config.read(os.path.join(server_settings["configdir"],
1553
client_defaults = { u"timeout": u"1h",
1555
u"checker": u"fping -q -- %%(host)s",
1558
client_config = configparser.SafeConfigParser(client_defaults)
1559
client_config.read(os.path.join(server_settings[u"configdir"],
2924
1562
global mandos_dbus_service
2925
1563
mandos_dbus_service = None
2928
if server_settings["socket"] != "":
2929
socketfd = server_settings["socket"]
2930
tcp_server = MandosServer(
2931
(server_settings["address"], server_settings["port"]),
2933
interface=(server_settings["interface"] or None),
2935
gnutls_priority=server_settings["priority"],
2939
pidfilename = "/run/mandos.pid"
2940
if not os.path.isdir("/run/."):
2941
pidfilename = "/var/run/mandos.pid"
2944
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2945
except IOError as e:
2946
logger.error("Could not open file %r", pidfilename,
1565
tcp_server = MandosServer((server_settings[u"address"],
1566
server_settings[u"port"]),
1568
interface=(server_settings[u"interface"]
1572
server_settings[u"priority"],
1574
pidfilename = u"/var/run/mandos.pid"
1576
pidfile = open(pidfilename, u"w")
1578
logger.error(u"Could not open file %r", pidfilename)
2949
for name, group in (("_mandos", "_mandos"),
2950
("mandos", "mandos"),
2951
("nobody", "nogroup")):
1581
uid = pwd.getpwnam(u"_mandos").pw_uid
1582
gid = pwd.getpwnam(u"_mandos").pw_gid
2953
uid = pwd.getpwnam(name).pw_uid
2954
gid = pwd.getpwnam(group).pw_gid
1585
uid = pwd.getpwnam(u"mandos").pw_uid
1586
gid = pwd.getpwnam(u"mandos").pw_gid
2956
1587
except KeyError:
1589
uid = pwd.getpwnam(u"nobody").pw_uid
1590
gid = pwd.getpwnam(u"nobody").pw_gid
2965
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2967
except OSError as error:
2968
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2969
.format(uid, gid, os.strerror(error.errno)))
2970
if error.errno != errno.EPERM:
1597
except OSError, error:
1598
if error[0] != errno.EPERM:
1601
# Enable all possible GnuTLS debugging
2974
# Enable all possible GnuTLS debugging
2976
1603
# "Use a log level over 10 to enable all debugging options."
2977
1604
# - GnuTLS manual
2978
gnutls.global_set_log_level(11)
1605
gnutls.library.functions.gnutls_global_set_log_level(11)
1607
@gnutls.library.types.gnutls_log_func
2981
1608
def debug_gnutls(level, string):
2982
logger.debug("GnuTLS: %s", string[:-1])
2984
gnutls.global_set_log_function(debug_gnutls)
2986
# Redirect stdin so all checkers get /dev/null
2987
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2988
os.dup2(null, sys.stdin.fileno())
2992
# Need to fork before connecting to D-Bus
2994
# Close all input and output, do double fork, etc.
2997
# multiprocessing will use threads, so before we use GLib we need
2998
# to inform GLib that threads will be used.
1609
logger.debug(u"GnuTLS: %s", string[:-1])
1611
(gnutls.library.functions
1612
.gnutls_global_set_log_function(debug_gnutls))
3001
1614
global main_loop
3002
1615
# From the Avahi example code
3003
DBusGMainLoop(set_as_default=True)
3004
main_loop = GLib.MainLoop()
1616
DBusGMainLoop(set_as_default=True )
1617
main_loop = gobject.MainLoop()
3005
1618
bus = dbus.SystemBus()
3006
1619
# End of Avahi example code
3009
bus_name = dbus.service.BusName("se.recompile.Mandos",
3012
old_bus_name = dbus.service.BusName(
3013
"se.bsnet.fukt.Mandos", bus,
3015
except dbus.exceptions.DBusException as e:
3016
logger.error("Disabling D-Bus:", exc_info=e)
1622
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1623
bus, do_not_queue=True)
1624
except dbus.exceptions.NameExistsException, e:
1625
logger.error(unicode(e) + u", disabling D-Bus")
3017
1626
use_dbus = False
3018
server_settings["use_dbus"] = False
1627
server_settings[u"use_dbus"] = False
3019
1628
tcp_server.use_dbus = False
3021
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3022
service = AvahiServiceToSyslog(
3023
name = server_settings["servicename"],
3024
servicetype = "_mandos._tcp",
3025
protocol = protocol,
3027
if server_settings["interface"]:
3028
service.interface = if_nametoindex(
3029
server_settings["interface"].encode("utf-8"))
3031
global multiprocessing_manager
3032
multiprocessing_manager = multiprocessing.Manager()
1629
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1630
service = AvahiService(name = server_settings[u"servicename"],
1631
servicetype = u"_mandos._tcp",
1632
protocol = protocol, bus = bus)
1633
if server_settings["interface"]:
1634
service.interface = (if_nametoindex
1635
(str(server_settings[u"interface"])))
3034
1637
client_class = Client
3036
1639
client_class = functools.partial(ClientDBus, bus = bus)
3038
client_settings = Client.config_parser(client_config)
3039
old_client_settings = {}
3042
# This is used to redirect stdout and stderr for checker processes
3044
wnull = open(os.devnull, "w") # A writable /dev/null
3045
# Only used if server is running in foreground but not in debug
3047
if debug or not foreground:
3050
# Get client data and settings from last running state.
3051
if server_settings["restore"]:
3053
with open(stored_state_path, "rb") as stored_state:
3054
if sys.version_info.major == 2:
3055
clients_data, old_client_settings = pickle.load(
3058
bytes_clients_data, bytes_old_client_settings = (
3059
pickle.load(stored_state, encoding = "bytes"))
3060
### Fix bytes to strings
3063
clients_data = { (key.decode("utf-8")
3064
if isinstance(key, bytes)
3067
bytes_clients_data.items() }
3068
del bytes_clients_data
3069
for key in clients_data:
3070
value = { (k.decode("utf-8")
3071
if isinstance(k, bytes) else k): v
3073
clients_data[key].items() }
3074
clients_data[key] = value
3076
value["client_structure"] = [
3078
if isinstance(s, bytes)
3080
value["client_structure"] ]
3082
for k in ("name", "host"):
3083
if isinstance(value[k], bytes):
3084
value[k] = value[k].decode("utf-8")
3085
## old_client_settings
3087
old_client_settings = {
3088
(key.decode("utf-8")
3089
if isinstance(key, bytes)
3092
bytes_old_client_settings.items() }
3093
del bytes_old_client_settings
3095
for value in old_client_settings.values():
3096
if isinstance(value["host"], bytes):
3097
value["host"] = (value["host"]
3099
os.remove(stored_state_path)
3100
except IOError as e:
3101
if e.errno == errno.ENOENT:
3102
logger.warning("Could not load persistent state:"
3103
" {}".format(os.strerror(e.errno)))
3105
logger.critical("Could not load persistent state:",
3108
except EOFError as e:
3109
logger.warning("Could not load persistent state: "
3113
with PGPEngine() as pgp:
3114
for client_name, client in clients_data.items():
3115
# Skip removed clients
3116
if client_name not in client_settings:
3119
# Decide which value to use after restoring saved state.
3120
# We have three different values: Old config file,
3121
# new config file, and saved state.
3122
# New config value takes precedence if it differs from old
3123
# config value, otherwise use saved state.
3124
for name, value in client_settings[client_name].items():
3126
# For each value in new config, check if it
3127
# differs from the old config value (Except for
3128
# the "secret" attribute)
3129
if (name != "secret"
3131
old_client_settings[client_name][name])):
3132
client[name] = value
3136
# Clients who has passed its expire date can still be
3137
# enabled if its last checker was successful. A Client
3138
# whose checker succeeded before we stored its state is
3139
# assumed to have successfully run all checkers during
3141
if client["enabled"]:
3142
if datetime.datetime.utcnow() >= client["expires"]:
3143
if not client["last_checked_ok"]:
3145
"disabling client {} - Client never "
3146
"performed a successful checker".format(
3148
client["enabled"] = False
3149
elif client["last_checker_status"] != 0:
3151
"disabling client {} - Client last"
3152
" checker failed with error code"
3155
client["last_checker_status"]))
3156
client["enabled"] = False
3158
client["expires"] = (
3159
datetime.datetime.utcnow()
3160
+ client["timeout"])
3161
logger.debug("Last checker succeeded,"
3162
" keeping {} enabled".format(
3165
client["secret"] = pgp.decrypt(
3166
client["encrypted_secret"],
3167
client_settings[client_name]["secret"])
3169
# If decryption fails, we use secret from new settings
3170
logger.debug("Failed to decrypt {} old secret".format(
3172
client["secret"] = (client_settings[client_name]
3175
# Add/remove clients based on new changes made to config
3176
for client_name in (set(old_client_settings)
3177
- set(client_settings)):
3178
del clients_data[client_name]
3179
for client_name in (set(client_settings)
3180
- set(old_client_settings)):
3181
clients_data[client_name] = client_settings[client_name]
3183
# Create all client objects
3184
for client_name, client in clients_data.items():
3185
tcp_server.clients[client_name] = client_class(
3188
server_settings = server_settings)
1640
tcp_server.clients.update(set(
1641
client_class(name = section,
1642
config= dict(client_config.items(section)))
1643
for section in client_config.sections()))
3190
1644
if not tcp_server.clients:
3191
logger.warning("No clients defined")
3194
if pidfile is not None:
1645
logger.warning(u"No clients defined")
1648
# Redirect stdin so all checkers get /dev/null
1649
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1650
os.dup2(null, sys.stdin.fileno())
1654
# No console logging
1655
logger.removeHandler(console)
1656
# Close all input and output, do double fork, etc.
3195
1661
pid = os.getpid()
3198
print(pid, file=pidfile)
3200
logger.error("Could not write to file %r with PID %d",
1662
pidfile.write(str(pid) + "\n")
1665
logger.error(u"Could not write to file %r with PID %d",
1668
# "pidfile" was never created
3205
for termsig in (signal.SIGHUP, signal.SIGTERM):
3206
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3207
lambda: main_loop.quit() and False)
1673
signal.signal(signal.SIGINT, signal.SIG_IGN)
1674
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1675
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3211
@alternate_dbus_interfaces(
3212
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3213
class MandosDBusService(DBusObjectWithObjectManager):
1678
class MandosDBusService(dbus.service.Object):
3214
1679
"""A D-Bus proxy object"""
3216
1680
def __init__(self):
3217
dbus.service.Object.__init__(self, bus, "/")
3219
_interface = "se.recompile.Mandos"
3221
@dbus.service.signal(_interface, signature="o")
1681
dbus.service.Object.__init__(self, bus, u"/")
1682
_interface = u"se.bsnet.fukt.Mandos"
1684
@dbus.service.signal(_interface, signature=u"o")
3222
1685
def ClientAdded(self, objpath):
3226
@dbus.service.signal(_interface, signature="ss")
1689
@dbus.service.signal(_interface, signature=u"ss")
3227
1690
def ClientNotFound(self, fingerprint, address):
3231
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3233
@dbus.service.signal(_interface, signature="os")
1694
@dbus.service.signal(_interface, signature=u"os")
3234
1695
def ClientRemoved(self, objpath, name):
3238
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3240
@dbus.service.method(_interface, out_signature="ao")
1699
@dbus.service.method(_interface, out_signature=u"ao")
3241
1700
def GetAllClients(self):
3243
return dbus.Array(c.dbus_object_path for c in
3244
tcp_server.clients.values())
1702
return dbus.Array(c.dbus_object_path
1703
for c in tcp_server.clients)
3246
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3248
1705
@dbus.service.method(_interface,
3249
out_signature="a{oa{sv}}")
1706
out_signature=u"a{oa{sv}}")
3250
1707
def GetAllClientsWithProperties(self):
3252
1709
return dbus.Dictionary(
3253
{ c.dbus_object_path: c.GetAll(
3254
"se.recompile.Mandos.Client")
3255
for c in tcp_server.clients.values() },
1710
((c.dbus_object_path, c.GetAll(u""))
1711
for c in tcp_server.clients),
1712
signature=u"oa{sv}")
3258
@dbus.service.method(_interface, in_signature="o")
1714
@dbus.service.method(_interface, in_signature=u"o")
3259
1715
def RemoveClient(self, object_path):
3261
for c in tcp_server.clients.values():
1717
for c in tcp_server.clients:
3262
1718
if c.dbus_object_path == object_path:
3263
del tcp_server.clients[c.name]
1719
tcp_server.clients.remove(c)
3264
1720
c.remove_from_connection()
3265
# Don't signal the disabling
1721
# Don't signal anything except ClientRemoved
3266
1722
c.disable(quiet=True)
3267
# Emit D-Bus signal for removal
3268
self.client_removed_signal(c)
1724
self.ClientRemoved(object_path, c.name)
3270
1726
raise KeyError(object_path)
3274
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3275
out_signature = "a{oa{sa{sv}}}")
3276
def GetManagedObjects(self):
3278
return dbus.Dictionary(
3279
{ client.dbus_object_path:
3281
{ interface: client.GetAll(interface)
3283
client._get_all_interface_names()})
3284
for client in tcp_server.clients.values()})
3286
def client_added_signal(self, client):
3287
"""Send the new standard signal and the old signal"""
3289
# New standard signal
3290
self.InterfacesAdded(
3291
client.dbus_object_path,
3293
{ interface: client.GetAll(interface)
3295
client._get_all_interface_names()}))
3297
self.ClientAdded(client.dbus_object_path)
3299
def client_removed_signal(self, client):
3300
"""Send the new standard signal and the old signal"""
3302
# New standard signal
3303
self.InterfacesRemoved(
3304
client.dbus_object_path,
3305
client._get_all_interface_names())
3307
self.ClientRemoved(client.dbus_object_path,
3310
1730
mandos_dbus_service = MandosDBusService()
3313
1733
"Cleanup function; run on exit"
3317
multiprocessing.active_children()
3319
if not (tcp_server.clients or client_settings):
3322
# Store client before exiting. Secrets are encrypted with key
3323
# based on what config file has. If config file is
3324
# removed/edited, old secret will thus be unrecovable.
3326
with PGPEngine() as pgp:
3327
for client in tcp_server.clients.values():
3328
key = client_settings[client.name]["secret"]
3329
client.encrypted_secret = pgp.encrypt(client.secret,
3333
# A list of attributes that can not be pickled
3335
exclude = { "bus", "changedstate", "secret",
3336
"checker", "server_settings" }
3337
for name, typ in inspect.getmembers(dbus.service
3341
client_dict["encrypted_secret"] = (client
3343
for attr in client.client_structure:
3344
if attr not in exclude:
3345
client_dict[attr] = getattr(client, attr)
3347
clients[client.name] = client_dict
3348
del client_settings[client.name]["secret"]
3351
with tempfile.NamedTemporaryFile(
3355
dir=os.path.dirname(stored_state_path),
3356
delete=False) as stored_state:
3357
pickle.dump((clients, client_settings), stored_state,
3359
tempname = stored_state.name
3360
os.rename(tempname, stored_state_path)
3361
except (IOError, OSError) as e:
3367
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3368
logger.warning("Could not save persistent state: {}"
3369
.format(os.strerror(e.errno)))
3371
logger.warning("Could not save persistent state:",
3375
# Delete all clients, and settings from config
3376
1736
while tcp_server.clients:
3377
name, client = tcp_server.clients.popitem()
1737
client = tcp_server.clients.pop()
3379
1739
client.remove_from_connection()
3380
# Don't signal the disabling
1740
client.disable_hook = None
1741
# Don't signal anything except ClientRemoved
3381
1742
client.disable(quiet=True)
3382
# Emit D-Bus signal for removal
3384
mandos_dbus_service.client_removed_signal(client)
3385
client_settings.clear()
1745
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3387
1748
atexit.register(cleanup)
3389
for client in tcp_server.clients.values():
1750
for client in tcp_server.clients:
3391
# Emit D-Bus signal for adding
3392
mandos_dbus_service.client_added_signal(client)
3393
# Need to initiate checking of clients
3395
client.init_checker()
1753
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3397
1756
tcp_server.enable()
3398
1757
tcp_server.server_activate()
3400
1759
# Find out what port we got
3402
service.port = tcp_server.socket.getsockname()[1]
1760
service.port = tcp_server.socket.getsockname()[1]
3404
logger.info("Now listening on address %r, port %d,"
3405
" flowinfo %d, scope_id %d",
3406
*tcp_server.socket.getsockname())
1762
logger.info(u"Now listening on address %r, port %d,"
1763
" flowinfo %d, scope_id %d"
1764
% tcp_server.socket.getsockname())
3408
logger.info("Now listening on address %r, port %d",
3409
*tcp_server.socket.getsockname())
1766
logger.info(u"Now listening on address %r, port %d"
1767
% tcp_server.socket.getsockname())
3411
1769
#service.interface = tcp_server.socket.getsockname()[3]
3415
# From the Avahi example code
3418
except dbus.exceptions.DBusException as error:
3419
logger.critical("D-Bus Exception", exc_info=error)
3422
# End of Avahi example code
3424
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3425
lambda *args, **kwargs:
3426
(tcp_server.handle_request
3427
(*args[2:], **kwargs) or True))
3429
logger.debug("Starting main loop")
1772
# From the Avahi example code
1775
except dbus.exceptions.DBusException, error:
1776
logger.critical(u"DBusException: %s", error)
1779
# End of Avahi example code
1781
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1782
lambda *args, **kwargs:
1783
(tcp_server.handle_request
1784
(*args[2:], **kwargs) or True))
1786
logger.debug(u"Starting main loop")
3430
1787
main_loop.run()
3431
except AvahiError as error:
3432
logger.critical("Avahi Error", exc_info=error)
1788
except AvahiError, error:
1789
logger.critical(u"AvahiError: %s", error)
3435
1792
except KeyboardInterrupt:
3437
print("", file=sys.stderr)
3438
logger.debug("Server received KeyboardInterrupt")
3439
logger.debug("Server exiting")
1795
logger.debug(u"Server received KeyboardInterrupt")
1796
logger.debug(u"Server exiting")
3440
1797
# Must run before the D-Bus bus name gets deregistered
3444
1800
if __name__ == '__main__':