94
76
except ImportError:
95
77
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
82
logger = logging.Logger(u'mandos')
83
syslogger = (logging.handlers.SysLogHandler
84
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
85
address = "/dev/log"))
86
syslogger.setFormatter(logging.Formatter
87
(u'Mandos [%(process)d]: %(levelname)s:'
89
logger.addHandler(syslogger)
91
console = logging.StreamHandler()
92
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
95
logger.addHandler(console)
283
97
class AvahiError(Exception):
284
98
def __init__(self, value, *args, **kwargs):
285
99
self.value = value
286
return super(AvahiError, self).__init__(value, *args,
100
super(AvahiError, self).__init__(value, *args, **kwargs)
101
def __unicode__(self):
102
return unicode(repr(self.value))
290
104
class AvahiServiceError(AvahiError):
294
107
class AvahiGroupError(AvahiError):
398
186
dbus.UInt16(self.port),
399
187
avahi.string_array_to_txt_array(self.TXT))
400
188
self.group.Commit()
402
189
def entry_group_state_changed(self, state, error):
403
190
"""Derived from the Avahi example code"""
404
logger.debug("Avahi entry group state change: %i", state)
191
logger.debug(u"Avahi state change: %i", state)
406
193
if state == avahi.ENTRY_GROUP_ESTABLISHED:
407
logger.debug("Zeroconf service established.")
194
logger.debug(u"Zeroconf service established.")
408
195
elif state == avahi.ENTRY_GROUP_COLLISION:
409
logger.info("Zeroconf service name collision.")
196
logger.warning(u"Zeroconf service name collision.")
411
198
elif state == avahi.ENTRY_GROUP_FAILURE:
412
logger.critical("Avahi: Error in group state changed %s",
414
raise AvahiGroupError("State changed: {!s}".format(error))
199
logger.critical(u"Avahi: Error in group state changed %s",
201
raise AvahiGroupError(u"State changed: %s"
416
203
def cleanup(self):
417
204
"""Derived from the Avahi example code"""
418
205
if self.group is not None:
421
except (dbus.exceptions.UnknownMethodException,
422
dbus.exceptions.DBusException):
424
207
self.group = None
427
def server_state_changed(self, state, error=None):
208
def server_state_changed(self, state):
428
209
"""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)
210
if state == avahi.SERVER_COLLISION:
211
logger.error(u"Zeroconf server name collision")
443
213
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
215
def activate(self):
463
216
"""Derived from the Avahi example code"""
464
217
if self.server is None:
465
218
self.server = dbus.Interface(
466
219
self.bus.get_object(avahi.DBUS_NAME,
467
avahi.DBUS_PATH_SERVER,
468
follow_name_owner_changes=True),
220
avahi.DBUS_PATH_SERVER),
469
221
avahi.DBUS_INTERFACE_SERVER)
470
self.server.connect_to_signal("StateChanged",
471
self.server_state_changed)
222
self.server.connect_to_signal(u"StateChanged",
223
self.server_state_changed)
472
224
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
227
class Client(object):
750
228
"""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
231
name: string; from the config file, used in log messages and
233
fingerprint: string (40 or 32 hexadecimal digits); used to
234
uniquely identify the client
235
secret: bytestring; sent verbatim (over TLS) to client
236
host: string; available for use by the checker command
237
created: datetime.datetime(); (UTC) object creation
238
last_enabled: datetime.datetime(); (UTC)
240
last_checked_ok: datetime.datetime(); (UTC) or None
241
timeout: datetime.timedelta(); How long from last_checked_ok
242
until this client is invalid
243
interval: datetime.timedelta(); How often to start a new checker
244
disable_hook: If set, called by disable() as disable_hook(self)
756
245
checker: subprocess.Popen(); a running checker process used
757
246
to see if the client lives.
758
247
'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
248
checker_initiator_tag: a gobject event source tag, or None
249
disable_initiator_tag: - '' -
250
checker_callback_tag: - '' -
251
checker_command: string; External command which is run to check if
252
client lives. %() expansions are done at
762
253
runtime with vars(self) as dict, so that for
763
254
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
255
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):
259
def _datetime_to_milliseconds(dt):
260
"Convert a datetime.datetime() to milliseconds"
261
return ((dt.days * 24 * 60 * 60 * 1000)
262
+ (dt.seconds * 1000)
263
+ (dt.microseconds // 1000))
265
def timeout_milliseconds(self):
266
"Return the 'timeout' attribute in milliseconds"
267
return self._datetime_to_milliseconds(self.timeout)
269
def interval_milliseconds(self):
270
"Return the 'interval' attribute in milliseconds"
271
return self._datetime_to_milliseconds(self.interval)
273
def __init__(self, name = None, disable_hook=None, config=None):
274
"""Note: the 'checker' key in 'config' sets the
275
'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()
280
logger.debug(u"Creating client %r", self.name)
281
# Uppercase and remove spaces from fingerprint for later
282
# comparison purposes with return value from the fingerprint()
284
self.fingerprint = (config[u"fingerprint"].upper()
286
logger.debug(u" Fingerprint: %s", self.fingerprint)
287
if u"secret" in config:
288
self.secret = config[u"secret"].decode(u"base64")
289
elif u"secfile" in config:
290
with closing(open(os.path.expanduser
292
(config[u"secfile"])))) as secfile:
293
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
295
raise TypeError(u"No secret or secfile for client %s"
297
self.host = config.get(u"host", u"")
298
self.created = datetime.datetime.utcnow()
300
self.last_enabled = None
301
self.last_checked_ok = None
302
self.timeout = string_to_delta(config[u"timeout"])
303
self.interval = string_to_delta(config[u"interval"])
304
self.disable_hook = disable_hook
889
305
self.checker = None
890
306
self.checker_initiator_tag = None
891
307
self.disable_initiator_tag = None
892
308
self.checker_callback_tag = None
309
self.checker_command = config[u"checker"]
893
310
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()
311
self.last_connect = None
913
313
def enable(self):
914
314
"""Start this client's checker and timeout hooks"""
915
if getattr(self, "enabled", False):
315
if getattr(self, u"enabled", False):
916
316
# Already enabled
918
self.expires = datetime.datetime.utcnow() + self.timeout
920
318
self.last_enabled = datetime.datetime.utcnow()
922
self.send_changedstate()
319
# Schedule a new checker to be started an 'interval' from now,
320
# and every interval from then on.
321
self.checker_initiator_tag = (gobject.timeout_add
322
(self.interval_milliseconds(),
324
# Also start a new checker *right now*.
326
# Schedule a disable() when 'timeout' has passed
327
self.disable_initiator_tag = (gobject.timeout_add
328
(self.timeout_milliseconds(),
924
def disable(self, quiet=True):
925
333
"""Disable this client."""
926
334
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)
336
logger.info(u"Disabling client %s", self.name)
337
if getattr(self, u"disable_initiator_tag", False):
338
gobject.source_remove(self.disable_initiator_tag)
932
339
self.disable_initiator_tag = None
934
if getattr(self, "checker_initiator_tag", None) is not None:
935
GLib.source_remove(self.checker_initiator_tag)
340
if getattr(self, u"checker_initiator_tag", False):
341
gobject.source_remove(self.checker_initiator_tag)
936
342
self.checker_initiator_tag = None
937
343
self.stop_checker()
344
if self.disable_hook:
345
self.disable_hook(self)
938
346
self.enabled = False
940
self.send_changedstate()
941
# Do not run this again if called by a GLib.timeout_add
347
# Do not run this again if called by a gobject.timeout_add
944
350
def __del__(self):
351
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,
354
def checker_callback(self, pid, condition, command):
965
355
"""The checker has completed, so take appropriate actions."""
966
356
self.checker_callback_tag = None
967
357
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",
358
if os.WIFEXITED(condition):
359
exitstatus = os.WEXITSTATUS(condition)
361
logger.info(u"Checker for %(name)s succeeded",
978
363
self.checked_ok()
980
logger.info("Checker for %(name)s failed", vars(self))
365
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?",
368
logger.warning(u"Checker for %(name)s crashed?",
988
371
def checked_ok(self):
989
"""Assert that the client has been seen, alive and well."""
372
"""Bump up the timeout for this client.
374
This should only be called when the client has been seen,
990
377
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()
378
gobject.source_remove(self.disable_initiator_tag)
379
self.disable_initiator_tag = (gobject.timeout_add
380
(self.timeout_milliseconds(),
1010
383
def start_checker(self):
1011
384
"""Start a new checker subprocess if one is not running.
1013
386
If a checker already exists, leave it running and do
1015
388
# The reason for not killing a running checker is that if we
1016
# did that, and if a checker (for some reason) started running
1017
# slowly and taking more than 'interval' time, then the client
1018
# would inevitably timeout, since no checker would get a
1019
# chance to run to completion. If we instead leave running
389
# did that, then if a checker (for some reason) started
390
# running slowly and taking more than 'interval' time, the
391
# client would inevitably timeout, since no checker would get
392
# a chance to run to completion. If we instead leave running
1020
393
# checkers alone, the checker would have to take more time
1021
# than 'timeout' for the client to be disabled, which is as it
394
# than 'timeout' for the client to be declared invalid, which
395
# is as it should be.
1024
if self.checker is not None and not self.checker.is_alive():
1025
logger.warning("Checker was not alive; joining")
397
# If a checker exists, make sure it is not a zombie
398
if self.checker is not None:
399
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
401
logger.warning(u"Checker was a zombie")
402
gobject.source_remove(self.checker_callback_tag)
403
self.checker_callback(pid, status,
404
self.current_checker_command)
1028
405
# Start a new checker if needed
1029
406
if self.checker is None:
1030
# Escape attributes for the shell
1032
attr: re.escape(str(getattr(self, attr)))
1033
for attr in self.runtime_expansions }
1035
command = self.checker_command % escaped_attrs
1036
except TypeError as error:
1037
logger.error('Could not format string "%s"',
1038
self.checker_command,
1040
return True # Try again later
408
# In case checker_command has exactly one % operator
409
command = self.checker_command % self.host
411
# Escape attributes for the shell
412
escaped_attrs = dict((key,
413
re.escape(unicode(str(val),
417
vars(self).iteritems())
419
command = self.checker_command % escaped_attrs
420
except TypeError, error:
421
logger.error(u'Could not format string "%s":'
422
u' %s', self.checker_command, error)
423
return True # Try again later
1041
424
self.current_checker_command = command
1042
logger.info("Starting checker %r for %s", command,
1044
# We don't need to redirect stdout and stderr, since
1045
# in normal mode, that is already done by daemon(),
1046
# and in debug mode we don't want to. (Stdin is
1047
# always replaced by /dev/null.)
1048
# The exception is when not debugging but nevertheless
1049
# running in the foreground; use the previously
1051
popen_args = { "close_fds": True,
1054
if (not self.server_settings["debug"]
1055
and self.server_settings["foreground"]):
1056
popen_args.update({"stdout": wnull,
1058
pipe = multiprocessing.Pipe(duplex = False)
1059
self.checker = multiprocessing.Process(
1061
args = (pipe[1], subprocess.call, command),
1062
kwargs = popen_args)
1063
self.checker.start()
1064
self.checker_callback_tag = GLib.io_add_watch(
1065
pipe[0].fileno(), GLib.IO_IN,
1066
self.checker_callback, pipe[0], command)
1067
# Re-run this periodically if run by GLib.timeout_add
426
logger.info(u"Starting checker %r for %s",
428
# We don't need to redirect stdout and stderr, since
429
# in normal mode, that is already done by daemon(),
430
# and in debug mode we don't want to. (Stdin is
431
# always replaced by /dev/null.)
432
self.checker = subprocess.Popen(command,
434
shell=True, cwd=u"/")
435
self.checker_callback_tag = (gobject.child_watch_add
437
self.checker_callback,
439
# The checker may have completed before the gobject
440
# watch was added. Check for this.
441
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
443
gobject.source_remove(self.checker_callback_tag)
444
self.checker_callback(pid, status, command)
445
except OSError, error:
446
logger.error(u"Failed to start subprocess: %s",
448
# Re-run this periodically if run by gobject.timeout_add
1070
451
def stop_checker(self):
1071
452
"""Force the checker process, if any, to stop."""
1072
453
if self.checker_callback_tag:
1073
GLib.source_remove(self.checker_callback_tag)
454
gobject.source_remove(self.checker_callback_tag)
1074
455
self.checker_callback_tag = None
1075
if getattr(self, "checker", None) is None:
456
if getattr(self, u"checker", None) is None:
1077
logger.debug("Stopping checker for %(name)s", vars(self))
1078
self.checker.terminate()
458
logger.debug(u"Stopping checker for %(name)s", vars(self))
460
os.kill(self.checker.pid, signal.SIGTERM)
462
#if self.checker.poll() is None:
463
# os.kill(self.checker.pid, signal.SIGKILL)
464
except OSError, error:
465
if error.errno != errno.ESRCH: # No such process
1079
467
self.checker = None
1082
def dbus_service_property(dbus_interface,
1086
"""Decorators for marking methods of a DBusObjectWithProperties to
1087
become properties on the D-Bus.
1089
The decorated method will be called with no arguments by "Get"
1090
and with one argument by "Set".
1092
The parameters, where they are supported, are the same as
1093
dbus.service.method, except there is only "signature", since the
1094
type from Get() and the type sent to Set() is the same.
1096
# Encoding deeply encoded byte arrays is not supported yet by the
1097
# "Set" method, so we fail early here:
1098
if byte_arrays and signature != "ay":
1099
raise ValueError("Byte arrays not supported for non-'ay'"
1100
" signature {!r}".format(signature))
1102
def decorator(func):
1103
func._dbus_is_property = True
1104
func._dbus_interface = dbus_interface
1105
func._dbus_signature = signature
1106
func._dbus_access = access
1107
func._dbus_name = func.__name__
1108
if func._dbus_name.endswith("_dbus_property"):
1109
func._dbus_name = func._dbus_name[:-14]
1110
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1116
def dbus_interface_annotations(dbus_interface):
1117
"""Decorator for marking functions returning interface annotations
1121
@dbus_interface_annotations("org.example.Interface")
1122
def _foo(self): # Function name does not matter
1123
return {"org.freedesktop.DBus.Deprecated": "true",
1124
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1128
def decorator(func):
1129
func._dbus_is_interface = True
1130
func._dbus_interface = dbus_interface
1131
func._dbus_name = dbus_interface
1137
def dbus_annotations(annotations):
1138
"""Decorator to annotate D-Bus methods, signals or properties
1141
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1142
"org.freedesktop.DBus.Property."
1143
"EmitsChangedSignal": "false"})
1144
@dbus_service_property("org.example.Interface", signature="b",
1146
def Property_dbus_property(self):
1147
return dbus.Boolean(False)
1149
See also the DBusObjectWithAnnotations class.
1152
def decorator(func):
1153
func._dbus_annotations = annotations
1159
class DBusPropertyException(dbus.exceptions.DBusException):
1160
"""A base class for D-Bus property-related exceptions
1165
class DBusPropertyAccessException(DBusPropertyException):
1166
"""A property's access permissions disallows an operation.
1171
class DBusPropertyNotFound(DBusPropertyException):
1172
"""An attempt was made to access a non-existing property.
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):
1267
"""A D-Bus object with properties.
1269
Classes inheriting from this can use the dbus_service_property
1270
decorator to expose methods as D-Bus properties. It exposes the
1271
standard Get(), Set(), and GetAll() methods on the D-Bus.
1274
def _get_dbus_property(self, interface_name, property_name):
1275
"""Returns a bound method if one exists which is a D-Bus
1276
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)
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,
1301
def Get(self, interface_name, property_name):
1302
"""Standard D-Bus property Get() method, see D-Bus standard.
1304
prop = self._get_dbus_property(interface_name, property_name)
1305
if prop._dbus_access == "write":
1306
raise DBusPropertyAccessException(property_name)
1308
if not hasattr(value, "variant_level"):
1310
return type(value)(value, variant_level=value.variant_level+1)
1312
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1313
def Set(self, interface_name, property_name, value):
1314
"""Standard D-Bus property Set() method, see D-Bus standard.
1316
prop = self._get_dbus_property(interface_name, property_name)
1317
if prop._dbus_access == "read":
1318
raise DBusPropertyAccessException(property_name)
1319
if prop._dbus_get_args_options["byte_arrays"]:
1320
# The byte_arrays option is not supported yet on
1321
# 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)
1330
@dbus.service.method(dbus.PROPERTIES_IFACE,
1332
out_signature="a{sv}")
1333
def GetAll(self, interface_name):
1334
"""Standard D-Bus property GetAll() method, see D-Bus
1337
Note: Will not include properties with access="write".
1340
for name, prop in self._get_all_dbus_things("property"):
1342
and interface_name != prop._dbus_interface):
1343
# Interface non-empty but did not match
1345
# Ignore write-only properties
1346
if prop._dbus_access == "write":
1349
if not hasattr(value, "variant_level"):
1350
properties[name] = value
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
1364
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1366
path_keyword='object_path',
1367
connection_keyword='connection')
1368
def Introspect(self, object_path, connection):
1369
"""Overloading of standard D-Bus method.
1371
Inserts property tags and interface annotation tags.
1373
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1377
document = xml.dom.minidom.parseString(xmlstring)
1379
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)
1386
for if_tag in document.getElementsByTagName("interface"):
1388
for tag in (make_tag(document, name, prop)
1390
in self._get_all_dbus_things("property")
1391
if prop._dbus_interface
1392
== if_tag.getAttribute("name")):
1393
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
# Add the names to the return values for the
1411
# "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"})
1678
class ClientDBus(Client, DBusObjectWithProperties):
469
def still_valid(self):
470
"""Has the timeout not yet passed for this client?"""
471
if not getattr(self, u"enabled", False):
473
now = datetime.datetime.utcnow()
474
if self.last_checked_ok is None:
475
return now < (self.created + self.timeout)
477
return now < (self.last_checked_ok + self.timeout)
480
class ClientDBus(Client, dbus.service.Object):
1679
481
"""A Client class using D-Bus
1682
484
dbus_object_path: dbus.ObjectPath
1683
485
bus: dbus.SystemBus()
1686
runtime_expansions = (Client.runtime_expansions
1687
+ ("dbus_object_path", ))
1689
_interface = "se.recompile.Mandos.Client"
1691
487
# dbus.service.Object doesn't use super(), so we can't either.
1693
489
def __init__(self, bus = None, *args, **kwargs):
1695
491
Client.__init__(self, *args, **kwargs)
1696
492
# 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)
1703
DBusObjectWithProperties.__init__(self, self.bus,
1704
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
494
self.dbus_object_path = (dbus.ObjectPath
496
+ self.name.replace(u".", u"_")))
497
dbus.service.Object.__init__(self, self.bus,
498
self.dbus_object_path)
501
def _datetime_to_dbus(dt, variant_level=0):
502
"""Convert a UTC datetime.datetime() to a D-Bus type."""
503
return dbus.String(dt.isoformat(),
504
variant_level=variant_level)
507
oldstate = getattr(self, u"enabled", False)
508
r = Client.enable(self)
509
if oldstate != self.enabled:
511
self.PropertyChanged(dbus.String(u"enabled"),
512
dbus.Boolean(True, variant_level=1))
513
self.PropertyChanged(
514
dbus.String(u"last_enabled"),
515
self._datetime_to_dbus(self.last_enabled,
519
def disable(self, signal = True):
520
oldstate = getattr(self, u"enabled", False)
521
r = Client.disable(self)
522
if signal and oldstate != self.enabled:
524
self.PropertyChanged(dbus.String(u"enabled"),
525
dbus.Boolean(False, variant_level=1))
1787
528
def __del__(self, *args, **kwargs):
1789
530
self.remove_from_connection()
1790
531
except LookupError:
1792
if hasattr(DBusObjectWithProperties, "__del__"):
1793
DBusObjectWithProperties.__del__(self, *args, **kwargs)
533
if hasattr(dbus.service.Object, u"__del__"):
534
dbus.service.Object.__del__(self, *args, **kwargs)
1794
535
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
537
def checker_callback(self, pid, condition, command,
539
self.checker_callback_tag = None
542
self.PropertyChanged(dbus.String(u"checker_running"),
543
dbus.Boolean(False, variant_level=1))
544
if os.WIFEXITED(condition):
545
exitstatus = os.WEXITSTATUS(condition)
1803
546
# Emit D-Bus signal
1804
547
self.CheckerCompleted(dbus.Int16(exitstatus),
1805
# This is specific to GNU libC
1806
dbus.Int64(exitstatus << 8),
548
dbus.Int64(condition),
1807
549
dbus.String(command))
1809
551
# Emit D-Bus signal
1810
552
self.CheckerCompleted(dbus.Int16(-1),
1812
# This is specific to GNU libC
1814
| self.last_checker_signal),
553
dbus.Int64(condition),
1815
554
dbus.String(command))
556
return Client.checker_callback(self, pid, condition, command,
559
def checked_ok(self, *args, **kwargs):
560
r = Client.checked_ok(self, *args, **kwargs)
562
self.PropertyChanged(
563
dbus.String(u"last_checked_ok"),
564
(self._datetime_to_dbus(self.last_checked_ok,
1818
568
def start_checker(self, *args, **kwargs):
1819
old_checker_pid = getattr(self.checker, "pid", None)
569
old_checker = self.checker
570
if self.checker is not None:
571
old_checker_pid = self.checker.pid
573
old_checker_pid = None
1820
574
r = Client.start_checker(self, *args, **kwargs)
1821
575
# Only if new checker process was started
1822
576
if (self.checker is not None
1823
577
and old_checker_pid != self.checker.pid):
1824
578
# Emit D-Bus signal
1825
579
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()
1838
## D-Bus methods, signals & properties
580
self.PropertyChanged(
581
dbus.String(u"checker_running"),
582
dbus.Boolean(True, variant_level=1))
585
def stop_checker(self, *args, **kwargs):
586
old_checker = getattr(self, u"checker", None)
587
r = Client.stop_checker(self, *args, **kwargs)
588
if (old_checker is not None
589
and getattr(self, u"checker", None) is None):
590
self.PropertyChanged(dbus.String(u"checker_running"),
591
dbus.Boolean(False, variant_level=1))
594
## D-Bus methods & signals
595
_interface = u"se.bsnet.fukt.Mandos.Client"
598
@dbus.service.method(_interface)
600
return self.checked_ok()
1844
602
# CheckerCompleted - signal
1845
@dbus.service.signal(_interface, signature="nxs")
603
@dbus.service.signal(_interface, signature=u"nxs")
1846
604
def CheckerCompleted(self, exitcode, waitstatus, command):
1850
608
# CheckerStarted - signal
1851
@dbus.service.signal(_interface, signature="s")
609
@dbus.service.signal(_interface, signature=u"s")
1852
610
def CheckerStarted(self, command):
614
# GetAllProperties - method
615
@dbus.service.method(_interface, out_signature=u"a{sv}")
616
def GetAllProperties(self):
618
return dbus.Dictionary({
619
dbus.String(u"name"):
620
dbus.String(self.name, variant_level=1),
621
dbus.String(u"fingerprint"):
622
dbus.String(self.fingerprint, variant_level=1),
623
dbus.String(u"host"):
624
dbus.String(self.host, variant_level=1),
625
dbus.String(u"created"):
626
self._datetime_to_dbus(self.created,
628
dbus.String(u"last_enabled"):
629
(self._datetime_to_dbus(self.last_enabled,
631
if self.last_enabled is not None
632
else dbus.Boolean(False, variant_level=1)),
633
dbus.String(u"enabled"):
634
dbus.Boolean(self.enabled, variant_level=1),
635
dbus.String(u"last_checked_ok"):
636
(self._datetime_to_dbus(self.last_checked_ok,
638
if self.last_checked_ok is not None
639
else dbus.Boolean (False, variant_level=1)),
640
dbus.String(u"timeout"):
641
dbus.UInt64(self.timeout_milliseconds(),
643
dbus.String(u"interval"):
644
dbus.UInt64(self.interval_milliseconds(),
646
dbus.String(u"checker"):
647
dbus.String(self.checker_command,
649
dbus.String(u"checker_running"):
650
dbus.Boolean(self.checker is not None,
652
dbus.String(u"object_path"):
653
dbus.ObjectPath(self.dbus_object_path,
657
# IsStillValid - method
658
@dbus.service.method(_interface, out_signature=u"b")
659
def IsStillValid(self):
660
return self.still_valid()
1856
662
# PropertyChanged - signal
1857
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1858
@dbus.service.signal(_interface, signature="sv")
663
@dbus.service.signal(_interface, signature=u"sv")
1859
664
def PropertyChanged(self, property, value):
1863
# GotSecret - signal
668
# ReceivedSecret - signal
1864
669
@dbus.service.signal(_interface)
1865
def GotSecret(self):
1867
Is sent after a successful transfer of secret from the Mandos
1868
server to mandos-client
670
def ReceivedSecret(self):
1872
674
# Rejected - signal
1873
@dbus.service.signal(_interface, signature="s")
1874
def Rejected(self, reason):
675
@dbus.service.signal(_interface)
1878
# NeedApproval - signal
1879
@dbus.service.signal(_interface, signature="tb")
1880
def NeedApproval(self, timeout, default):
1882
return self.need_approval()
1887
@dbus.service.method(_interface, in_signature="b")
1888
def Approve(self, value):
1891
# CheckedOK - method
1892
@dbus.service.method(_interface)
1893
def CheckedOK(self):
680
# SetChecker - method
681
@dbus.service.method(_interface, in_signature=u"s")
682
def SetChecker(self, checker):
683
"D-Bus setter method"
684
self.checker_command = checker
686
self.PropertyChanged(dbus.String(u"checker"),
687
dbus.String(self.checker_command,
691
@dbus.service.method(_interface, in_signature=u"s")
692
def SetHost(self, host):
693
"D-Bus setter method"
696
self.PropertyChanged(dbus.String(u"host"),
697
dbus.String(self.host, variant_level=1))
699
# SetInterval - method
700
@dbus.service.method(_interface, in_signature=u"t")
701
def SetInterval(self, milliseconds):
702
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
704
self.PropertyChanged(dbus.String(u"interval"),
705
(dbus.UInt64(self.interval_milliseconds(),
709
@dbus.service.method(_interface, in_signature=u"ay",
711
def SetSecret(self, secret):
712
"D-Bus setter method"
713
self.secret = str(secret)
715
# SetTimeout - method
716
@dbus.service.method(_interface, in_signature=u"t")
717
def SetTimeout(self, milliseconds):
718
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
720
self.PropertyChanged(dbus.String(u"timeout"),
721
(dbus.UInt64(self.timeout_milliseconds(),
1896
724
# Enable - method
1897
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1898
725
@dbus.service.method(_interface)
1899
726
def Enable(self):
1903
730
# StartChecker - method
1904
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1905
731
@dbus.service.method(_interface)
1906
732
def StartChecker(self):
1908
734
self.start_checker()
1910
736
# Disable - method
1911
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1912
737
@dbus.service.method(_interface)
1913
738
def Disable(self):
1917
742
# StopChecker - method
1918
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1919
743
@dbus.service.method(_interface)
1920
744
def StopChecker(self):
1921
745
self.stop_checker()
1925
# ApprovalPending - property
1926
@dbus_service_property(_interface, signature="b", access="read")
1927
def ApprovalPending_dbus_property(self):
1928
return dbus.Boolean(bool(self.approvals_pending))
1930
# ApprovedByDefault - property
1931
@dbus_service_property(_interface,
1934
def ApprovedByDefault_dbus_property(self, value=None):
1935
if value is None: # get
1936
return dbus.Boolean(self.approved_by_default)
1937
self.approved_by_default = bool(value)
1939
# ApprovalDelay - property
1940
@dbus_service_property(_interface,
1943
def ApprovalDelay_dbus_property(self, value=None):
1944
if value is None: # get
1945
return dbus.UInt64(self.approval_delay.total_seconds()
1947
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1949
# ApprovalDuration - property
1950
@dbus_service_property(_interface,
1953
def ApprovalDuration_dbus_property(self, value=None):
1954
if value is None: # get
1955
return dbus.UInt64(self.approval_duration.total_seconds()
1957
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1961
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1962
@dbus_service_property(_interface, signature="s", access="read")
1963
def Name_dbus_property(self):
1964
return dbus.String(self.name)
1966
# Fingerprint - property
1968
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1969
@dbus_service_property(_interface, signature="s", access="read")
1970
def Fingerprint_dbus_property(self):
1971
return dbus.String(self.fingerprint)
1974
@dbus_service_property(_interface,
1977
def Host_dbus_property(self, value=None):
1978
if value is None: # get
1979
return dbus.String(self.host)
1980
self.host = str(value)
1982
# Created - property
1984
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1985
@dbus_service_property(_interface, signature="s", access="read")
1986
def Created_dbus_property(self):
1987
return datetime_to_dbus(self.created)
1989
# LastEnabled - property
1990
@dbus_service_property(_interface, signature="s", access="read")
1991
def LastEnabled_dbus_property(self):
1992
return datetime_to_dbus(self.last_enabled)
1994
# Enabled - property
1995
@dbus_service_property(_interface,
1998
def Enabled_dbus_property(self, value=None):
1999
if value is None: # get
2000
return dbus.Boolean(self.enabled)
2006
# LastCheckedOK - property
2007
@dbus_service_property(_interface,
2010
def LastCheckedOK_dbus_property(self, value=None):
2011
if value is not None:
2014
return datetime_to_dbus(self.last_checked_ok)
2016
# LastCheckerStatus - property
2017
@dbus_service_property(_interface, signature="n", access="read")
2018
def LastCheckerStatus_dbus_property(self):
2019
return dbus.Int16(self.last_checker_status)
2021
# Expires - property
2022
@dbus_service_property(_interface, signature="s", access="read")
2023
def Expires_dbus_property(self):
2024
return datetime_to_dbus(self.expires)
2026
# LastApprovalRequest - property
2027
@dbus_service_property(_interface, signature="s", access="read")
2028
def LastApprovalRequest_dbus_property(self):
2029
return datetime_to_dbus(self.last_approval_request)
2031
# Timeout - property
2032
@dbus_service_property(_interface,
2035
def Timeout_dbus_property(self, value=None):
2036
if value is None: # get
2037
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2038
old_timeout = self.timeout
2039
self.timeout = datetime.timedelta(0, 0, 0, value)
2040
# Reschedule disabling
2042
now = datetime.datetime.utcnow()
2043
self.expires += self.timeout - old_timeout
2044
if self.expires <= now:
2045
# The timeout has passed
2048
if (getattr(self, "disable_initiator_tag", None)
2051
GLib.source_remove(self.disable_initiator_tag)
2052
self.disable_initiator_tag = GLib.timeout_add(
2053
int((self.expires - now).total_seconds() * 1000),
2056
# ExtendedTimeout - property
2057
@dbus_service_property(_interface,
2060
def ExtendedTimeout_dbus_property(self, value=None):
2061
if value is None: # get
2062
return dbus.UInt64(self.extended_timeout.total_seconds()
2064
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2066
# Interval - property
2067
@dbus_service_property(_interface,
2070
def Interval_dbus_property(self, value=None):
2071
if value is None: # get
2072
return dbus.UInt64(self.interval.total_seconds() * 1000)
2073
self.interval = datetime.timedelta(0, 0, 0, value)
2074
if getattr(self, "checker_initiator_tag", None) is None:
2077
# Reschedule checker run
2078
GLib.source_remove(self.checker_initiator_tag)
2079
self.checker_initiator_tag = GLib.timeout_add(
2080
value, self.start_checker)
2081
self.start_checker() # Start one now, too
2083
# Checker - property
2084
@dbus_service_property(_interface,
2087
def Checker_dbus_property(self, value=None):
2088
if value is None: # get
2089
return dbus.String(self.checker_command)
2090
self.checker_command = str(value)
2092
# CheckerRunning - property
2093
@dbus_service_property(_interface,
2096
def CheckerRunning_dbus_property(self, value=None):
2097
if value is None: # get
2098
return dbus.Boolean(self.checker is not None)
2100
self.start_checker()
2104
# ObjectPath - property
2106
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2107
"org.freedesktop.DBus.Deprecated": "true"})
2108
@dbus_service_property(_interface, signature="o", access="read")
2109
def ObjectPath_dbus_property(self):
2110
return self.dbus_object_path # is already a dbus.ObjectPath
2114
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2116
@dbus_service_property(_interface,
2120
def Secret_dbus_property(self, value):
2121
self.secret = bytes(value)
2126
class ProxyClient(object):
2127
def __init__(self, child_pipe, fpr, address):
2128
self._pipe = child_pipe
2129
self._pipe.send(('init', fpr, address))
2130
if not self._pipe.recv():
2133
def __getattribute__(self, name):
2135
return super(ProxyClient, self).__getattribute__(name)
2136
self._pipe.send(('getattr', name))
2137
data = self._pipe.recv()
2138
if data[0] == 'data':
2140
if data[0] == 'function':
2142
def func(*args, **kwargs):
2143
self._pipe.send(('funcall', name, args, kwargs))
2144
return self._pipe.recv()[1]
2148
def __setattr__(self, name, value):
2150
return super(ProxyClient, self).__setattr__(name, value)
2151
self._pipe.send(('setattr', name, value))
2154
750
class ClientHandler(socketserver.BaseRequestHandler, object):
2155
751
"""A class to handle client connections.
2158
754
Note: This will run in its own forked process."""
2160
756
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",
757
logger.info(u"TCP connection from: %s",
758
unicode(self.client_address))
759
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
760
# Open IPC pipe to parent process
761
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
762
session = (gnutls.connection
763
.ClientSession(self.request,
767
line = self.request.makefile().readline()
768
logger.debug(u"Protocol version: %r", line)
770
if int(line.strip().split()[0]) > 1:
772
except (ValueError, IndexError, RuntimeError), error:
773
logger.error(u"Unknown protocol version: %s", error)
776
# Note: gnutls.connection.X509Credentials is really a
777
# generic GnuTLS certificate credentials object so long as
778
# no X.509 keys are added to it. Therefore, we can use it
779
# here despite using OpenPGP certificates.
781
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
782
# u"+AES-256-CBC", u"+SHA1",
783
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2173
785
# Use a fallback default, since this MUST be set.
2174
786
priority = self.server.gnutls_priority
2175
787
if priority is None:
2177
gnutls.priority_set_direct(session._c_object, priority,
2180
# Start communication using the Mandos protocol
2181
# Get protocol number
2182
line = self.request.makefile().readline()
2183
logger.debug("Protocol version: %r", line)
2185
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)
2191
# Start GnuTLS connection
789
(gnutls.library.functions
790
.gnutls_priority_set_direct(session._c_object,
2193
794
session.handshake()
2194
except gnutls.Error as error:
2195
logger.warning("Handshake failed: %s", error)
795
except gnutls.errors.GNUTLSError, error:
796
logger.warning(u"Handshake failed: %s", error)
2196
797
# Do not run session.bye() here: the session is not
2197
798
# established. Just abandon the request.
2199
logger.debug("Handshake succeeded")
2201
approval_required = False
800
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
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:
802
fpr = self.fingerprint(self.peer_certificate(session))
803
except (TypeError, gnutls.errors.GNUTLSError), error:
804
logger.warning(u"Bad certificate: %s", error)
807
logger.debug(u"Fingerprint: %s", fpr)
2285
if approval_required:
2286
client.approvals_pending -= 1
2289
except gnutls.Error as error:
2290
logger.warning("GnuTLS bye failed",
809
for c in self.server.clients:
810
if c.fingerprint == fpr:
814
ipc.write(u"NOTFOUND %s %s\n"
815
% (fpr, unicode(self.client_address)))
818
# Have to check if client.still_valid(), since it is
819
# possible that the client timed out while establishing
820
# the GnuTLS session.
821
if not client.still_valid():
822
ipc.write(u"INVALID %s\n" % client.name)
825
ipc.write(u"SENDING %s\n" % client.name)
827
while sent_size < len(client.secret):
828
sent = session.send(client.secret[sent_size:])
829
logger.debug(u"Sent: %d, remaining: %d",
830
sent, len(client.secret)
831
- (sent_size + sent))
2294
836
def peer_certificate(session):
2295
837
"Return the peer's OpenPGP certificate as a bytestring"
2296
838
# If not an OpenPGP certificate...
2297
if (gnutls.certificate_type_get(session._c_object)
2298
!= gnutls.CRT_OPENPGP):
2299
# ...return invalid data
839
if (gnutls.library.functions
840
.gnutls_certificate_type_get(session._c_object)
841
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
842
# ...do the normal thing
843
return session.peer_certificate
2301
844
list_size = ctypes.c_uint(1)
2302
cert_list = (gnutls.certificate_get_peers
845
cert_list = (gnutls.library.functions
846
.gnutls_certificate_get_peers
2303
847
(session._c_object, ctypes.byref(list_size)))
2304
848
if not bool(cert_list) and list_size.value != 0:
2305
raise gnutls.Error("error getting peer certificate")
849
raise gnutls.errors.GNUTLSError(u"error getting peer"
2306
851
if list_size.value == 0:
2308
853
cert = cert_list[0]
2485
983
clients: set of Client objects
2486
984
gnutls_priority GnuTLS priority string
2487
985
use_dbus: Boolean; to emit D-Bus signals or not
986
clients: set of Client objects
987
gnutls_priority GnuTLS priority string
988
use_dbus: Boolean; to emit D-Bus signals or not
2489
Assumes a GLib.MainLoop event loop.
990
Assumes a gobject.MainLoop event loop.
2492
992
def __init__(self, server_address, RequestHandlerClass,
2496
gnutls_priority=None,
993
interface=None, use_ipv6=True, clients=None,
994
gnutls_priority=None, use_dbus=True):
2499
995
self.enabled = False
2500
996
self.clients = clients
2501
997
if self.clients is None:
2503
999
self.use_dbus = use_dbus
2504
1000
self.gnutls_priority = gnutls_priority
2505
1001
IPv6_TCPServer.__init__(self, server_address,
2506
1002
RequestHandlerClass,
2507
1003
interface = interface,
2508
use_ipv6 = use_ipv6,
2509
socketfd = socketfd)
1004
use_ipv6 = use_ipv6)
2511
1005
def server_activate(self):
2512
1006
if self.enabled:
2513
1007
return socketserver.TCPServer.server_activate(self)
2515
1008
def enable(self):
2516
1009
self.enabled = True
2518
def add_pipe(self, parent_pipe, proc):
1010
def add_pipe(self, pipe):
2519
1011
# 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)
1012
gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1014
def handle_ipc(self, source, condition, file_objects={}):
1016
gobject.IO_IN: u"IN", # There is data to read.
1017
gobject.IO_OUT: u"OUT", # Data can be written (without
1019
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1020
gobject.IO_ERR: u"ERR", # Error condition.
1021
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1022
# broken, usually for pipes and
1025
conditions_string = ' | '.join(name
1027
condition_names.iteritems()
1028
if cond & condition)
1029
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1032
# Turn the pipe file descriptor into a Python file object
1033
if source not in file_objects:
1034
file_objects[source] = os.fdopen(source, u"r", 1)
1036
# Read a line from the file object
1037
cmdline = file_objects[source].readline()
1038
if not cmdline: # Empty line means end of file
1039
# close the IPC pipe
1040
file_objects[source].close()
1041
del file_objects[source]
1043
# Stop calling this function
1046
logger.debug(u"IPC command: %r", cmdline)
1048
# Parse and act on command
1049
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1051
if cmd == u"NOTFOUND":
1052
logger.warning(u"Client not found for fingerprint: %s",
1056
mandos_dbus_service.ClientNotFound(args)
1057
elif cmd == u"INVALID":
1058
for client in self.clients:
1059
if client.name == args:
1060
logger.warning(u"Client %s is invalid", args)
1066
logger.error(u"Unknown client %s is invalid", args)
1067
elif cmd == u"SENDING":
1068
for client in self.clients:
1069
if client.name == args:
1070
logger.info(u"Sending secret to %s", client.name)
1074
client.ReceivedSecret()
1077
logger.error(u"Sending secret to unknown client %s",
1080
logger.error(u"Unknown IPC command: %r", cmdline)
1082
# 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
1086
def string_to_delta(interval):
2693
1087
"""Parse a string and return a datetime.timedelta
2695
>>> string_to_delta('7d')
1089
>>> string_to_delta(u'7d')
2696
1090
datetime.timedelta(7)
2697
>>> string_to_delta('60s')
1091
>>> string_to_delta(u'60s')
2698
1092
datetime.timedelta(0, 60)
2699
>>> string_to_delta('60m')
1093
>>> string_to_delta(u'60m')
2700
1094
datetime.timedelta(0, 3600)
2701
>>> string_to_delta('24h')
1095
>>> string_to_delta(u'24h')
2702
1096
datetime.timedelta(1)
2703
>>> string_to_delta('1w')
1097
>>> string_to_delta(u'1w')
2704
1098
datetime.timedelta(7)
2705
>>> string_to_delta('5m 30s')
1099
>>> string_to_delta(u'5m 30s')
2706
1100
datetime.timedelta(0, 330)
2710
return rfc3339_duration_to_delta(interval)
2714
1102
timevalue = datetime.timedelta(0)
2715
1103
for s in interval.split():
1105
suffix = unicode(s[-1])
2718
1106
value = int(s[:-1])
2720
1108
delta = datetime.timedelta(value)
1109
elif suffix == u"s":
2722
1110
delta = datetime.timedelta(0, value)
1111
elif suffix == u"m":
2724
1112
delta = datetime.timedelta(0, 0, 0, 0, value)
1113
elif suffix == u"h":
2726
1114
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1115
elif suffix == u"w":
2728
1116
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))
1119
except (ValueError, IndexError):
2733
1121
timevalue += delta
2734
1122
return timevalue
1125
def if_nametoindex(interface):
1126
"""Call the C function if_nametoindex(), or equivalent
1128
Note: This function cannot accept a unicode string."""
1129
global if_nametoindex
1131
if_nametoindex = (ctypes.cdll.LoadLibrary
1132
(ctypes.util.find_library(u"c"))
1134
except (OSError, AttributeError):
1135
logger.warning(u"Doing if_nametoindex the hard way")
1136
def if_nametoindex(interface):
1137
"Get an interface index the hard way, i.e. using fcntl()"
1138
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1139
with closing(socket.socket()) as s:
1140
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1141
struct.pack(str(u"16s16x"),
1143
interface_index = struct.unpack(str(u"I"),
1145
return interface_index
1146
return if_nametoindex(interface)
2737
1149
def daemon(nochdir = False, noclose = False):
2738
1150
"""See daemon(3). Standard BSD Unix function.
2764
##################################################################
1175
######################################################################
2765
1176
# 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()
1178
parser = optparse.OptionParser(version = "%%prog %s" % version)
1179
parser.add_option("-i", u"--interface", type=u"string",
1180
metavar="IF", help=u"Bind to interface IF")
1181
parser.add_option("-a", u"--address", type=u"string",
1182
help=u"Address to listen for requests on")
1183
parser.add_option("-p", u"--port", type=u"int",
1184
help=u"Port number to receive requests on")
1185
parser.add_option("--check", action=u"store_true",
1186
help=u"Run self-test")
1187
parser.add_option("--debug", action=u"store_true",
1188
help=u"Debug mode; run in foreground and log to"
1190
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1191
u" priority string (see GnuTLS documentation)")
1192
parser.add_option("--servicename", type=u"string",
1193
metavar=u"NAME", help=u"Zeroconf service name")
1194
parser.add_option("--configdir", type=u"string",
1195
default=u"/etc/mandos", metavar=u"DIR",
1196
help=u"Directory to search for configuration"
1198
parser.add_option("--no-dbus", action=u"store_false",
1199
dest=u"use_dbus", help=u"Do not provide D-Bus"
1200
u" system bus interface")
1201
parser.add_option("--no-ipv6", action=u"store_false",
1202
dest=u"use_ipv6", help=u"Do not use IPv6")
1203
options = parser.parse_args()[0]
2814
1205
if options.check:
2816
fail_count, test_count = doctest.testmod()
2817
sys.exit(os.EX_OK if fail_count == 0 else 1)
2819
1210
# 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",
1211
server_defaults = { u"interface": u"",
1216
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1217
u"servicename": u"Mandos",
1218
u"use_dbus": u"True",
1219
u"use_ipv6": u"True",
2838
1222
# Parse config file for server-global settings
2839
1223
server_config = configparser.SafeConfigParser(server_defaults)
2840
1224
del server_defaults
2841
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1225
server_config.read(os.path.join(options.configdir,
2842
1227
# Convert the SafeConfigParser object to a dict
2843
1228
server_settings = server_config.defaults()
2844
1229
# 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",
1230
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1231
server_settings[option] = server_config.getboolean(u"DEFAULT",
2848
1233
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
1234
server_settings["port"] = server_config.getint(u"DEFAULT",
2860
1236
del server_config
2862
1238
# Override the settings from the config file with command line
2863
1239
# 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"):
1240
for option in (u"interface", u"address", u"port", u"debug",
1241
u"priority", u"servicename", u"configdir",
1242
u"use_dbus", u"use_ipv6"):
2868
1243
value = getattr(options, option)
2869
1244
if value is not None:
2870
1245
server_settings[option] = value
2872
1247
# Force all strings to be unicode
2873
1248
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
1249
if type(server_settings[option]) is str:
1250
server_settings[option] = unicode(server_settings[option])
2884
1251
# Now we have our good server settings in "server_settings"
2886
1253
##################################################################
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
1255
# 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"])))
1256
debug = server_settings[u"debug"]
1257
use_dbus = server_settings[u"use_dbus"]
1258
use_ipv6 = server_settings[u"use_ipv6"]
1261
syslogger.setLevel(logging.WARNING)
1262
console.setLevel(logging.WARNING)
1264
if server_settings[u"servicename"] != u"Mandos":
1265
syslogger.setFormatter(logging.Formatter
1266
(u'Mandos (%s) [%%(process)d]:'
1267
u' %%(levelname)s: %%(message)s'
1268
% server_settings[u"servicename"]))
2918
1270
# Parse config file with clients
2919
client_config = configparser.SafeConfigParser(Client
2921
client_config.read(os.path.join(server_settings["configdir"],
1271
client_defaults = { u"timeout": u"1h",
1273
u"checker": u"fping -q -- %%(host)s",
1276
client_config = configparser.SafeConfigParser(client_defaults)
1277
client_config.read(os.path.join(server_settings[u"configdir"],
2924
1280
global mandos_dbus_service
2925
1281
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,
1283
tcp_server = MandosServer((server_settings[u"address"],
1284
server_settings[u"port"]),
1286
interface=server_settings[u"interface"],
1289
server_settings[u"priority"],
1291
pidfilename = u"/var/run/mandos.pid"
1293
pidfile = open(pidfilename, u"w")
1295
logger.error(u"Could not open file %r", pidfilename)
2949
for name, group in (("_mandos", "_mandos"),
2950
("mandos", "mandos"),
2951
("nobody", "nogroup")):
1298
uid = pwd.getpwnam(u"_mandos").pw_uid
1299
gid = pwd.getpwnam(u"_mandos").pw_gid
2953
uid = pwd.getpwnam(name).pw_uid
2954
gid = pwd.getpwnam(group).pw_gid
1302
uid = pwd.getpwnam(u"mandos").pw_uid
1303
gid = pwd.getpwnam(u"mandos").pw_gid
2956
1304
except KeyError:
1306
uid = pwd.getpwnam(u"nobody").pw_uid
1307
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:
1314
except OSError, error:
1315
if error[0] != errno.EPERM:
1318
# Enable all possible GnuTLS debugging
2974
# Enable all possible GnuTLS debugging
2976
1320
# "Use a log level over 10 to enable all debugging options."
2977
1321
# - GnuTLS manual
2978
gnutls.global_set_log_level(11)
1322
gnutls.library.functions.gnutls_global_set_log_level(11)
1324
@gnutls.library.types.gnutls_log_func
2981
1325
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.
1326
logger.debug(u"GnuTLS: %s", string[:-1])
1328
(gnutls.library.functions
1329
.gnutls_global_set_log_function(debug_gnutls))
3001
1331
global main_loop
3002
1332
# From the Avahi example code
3003
DBusGMainLoop(set_as_default=True)
3004
main_loop = GLib.MainLoop()
1333
DBusGMainLoop(set_as_default=True )
1334
main_loop = gobject.MainLoop()
3005
1335
bus = dbus.SystemBus()
3006
1336
# 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)
3018
server_settings["use_dbus"] = False
3019
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()
1338
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1339
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1340
service = AvahiService(name = server_settings[u"servicename"],
1341
servicetype = u"_mandos._tcp",
1342
protocol = protocol, bus = bus)
1343
if server_settings["interface"]:
1344
service.interface = (if_nametoindex
1345
(str(server_settings[u"interface"])))
3034
1347
client_class = Client
3036
1349
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)
1350
tcp_server.clients.update(set(
1351
client_class(name = section,
1352
config= dict(client_config.items(section)))
1353
for section in client_config.sections()))
3190
1354
if not tcp_server.clients:
3191
logger.warning("No clients defined")
3194
if pidfile is not None:
1355
logger.warning(u"No clients defined")
1358
# Redirect stdin so all checkers get /dev/null
1359
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1360
os.dup2(null, sys.stdin.fileno())
1364
# No console logging
1365
logger.removeHandler(console)
1366
# Close all input and output, do double fork, etc.
1370
with closing(pidfile):
3195
1371
pid = os.getpid()
3198
print(pid, file=pidfile)
3200
logger.error("Could not write to file %r with PID %d",
1372
pidfile.write(str(pid) + "\n")
3205
for termsig in (signal.SIGHUP, signal.SIGTERM):
3206
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3207
lambda: main_loop.quit() and False)
1375
logger.error(u"Could not write to file %r with PID %d",
1378
# "pidfile" was never created
1383
"Cleanup function; run on exit"
1386
while tcp_server.clients:
1387
client = tcp_server.clients.pop()
1388
client.disable_hook = None
1391
atexit.register(cleanup)
1394
signal.signal(signal.SIGINT, signal.SIG_IGN)
1395
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1396
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):
1399
class MandosDBusService(dbus.service.Object):
3214
1400
"""A D-Bus proxy object"""
3216
1401
def __init__(self):
3217
dbus.service.Object.__init__(self, bus, "/")
3219
_interface = "se.recompile.Mandos"
3221
@dbus.service.signal(_interface, signature="o")
3222
def ClientAdded(self, objpath):
3226
@dbus.service.signal(_interface, signature="ss")
3227
def ClientNotFound(self, fingerprint, address):
3231
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3233
@dbus.service.signal(_interface, signature="os")
1402
dbus.service.Object.__init__(self, bus, u"/")
1403
_interface = u"se.bsnet.fukt.Mandos"
1405
@dbus.service.signal(_interface, signature=u"oa{sv}")
1406
def ClientAdded(self, objpath, properties):
1410
@dbus.service.signal(_interface, signature=u"s")
1411
def ClientNotFound(self, fingerprint):
1415
@dbus.service.signal(_interface, signature=u"os")
3234
1416
def ClientRemoved(self, objpath, name):
3238
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3240
@dbus.service.method(_interface, out_signature="ao")
1420
@dbus.service.method(_interface, out_signature=u"ao")
3241
1421
def GetAllClients(self):
3243
return dbus.Array(c.dbus_object_path for c in
3244
tcp_server.clients.values())
1423
return dbus.Array(c.dbus_object_path
1424
for c in tcp_server.clients)
3246
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3248
1426
@dbus.service.method(_interface,
3249
out_signature="a{oa{sv}}")
1427
out_signature=u"a{oa{sv}}")
3250
1428
def GetAllClientsWithProperties(self):
3252
1430
return dbus.Dictionary(
3253
{ c.dbus_object_path: c.GetAll(
3254
"se.recompile.Mandos.Client")
3255
for c in tcp_server.clients.values() },
1431
((c.dbus_object_path, c.GetAllProperties())
1432
for c in tcp_server.clients),
1433
signature=u"oa{sv}")
3258
@dbus.service.method(_interface, in_signature="o")
1435
@dbus.service.method(_interface, in_signature=u"o")
3259
1436
def RemoveClient(self, object_path):
3261
for c in tcp_server.clients.values():
1438
for c in tcp_server.clients:
3262
1439
if c.dbus_object_path == object_path:
3263
del tcp_server.clients[c.name]
1440
tcp_server.clients.remove(c)
3264
1441
c.remove_from_connection()
3265
# Don't signal the disabling
3266
c.disable(quiet=True)
3267
# Emit D-Bus signal for removal
3268
self.client_removed_signal(c)
1442
# Don't signal anything except ClientRemoved
1443
c.disable(signal=False)
1445
self.ClientRemoved(object_path, c.name)
3270
raise KeyError(object_path)
3274
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3275
out_signature = "a{oa{sa{sv}}}")
3276
def GetManagedObjects(self):
3278
return dbus.Dictionary(
3279
{ client.dbus_object_path:
3281
{ interface: client.GetAll(interface)
3283
client._get_all_interface_names()})
3284
for client in tcp_server.clients.values()})
3286
def client_added_signal(self, client):
3287
"""Send the new standard signal and the old signal"""
3289
# New standard signal
3290
self.InterfacesAdded(
3291
client.dbus_object_path,
3293
{ interface: client.GetAll(interface)
3295
client._get_all_interface_names()}))
3297
self.ClientAdded(client.dbus_object_path)
3299
def client_removed_signal(self, client):
3300
"""Send the new standard signal and the old signal"""
3302
# New standard signal
3303
self.InterfacesRemoved(
3304
client.dbus_object_path,
3305
client._get_all_interface_names())
3307
self.ClientRemoved(client.dbus_object_path,
3310
1451
mandos_dbus_service = MandosDBusService()
3313
"Cleanup function; run on exit"
3317
multiprocessing.active_children()
3319
if not (tcp_server.clients or client_settings):
3322
# Store client before exiting. Secrets are encrypted with key
3323
# based on what config file has. If config file is
3324
# removed/edited, old secret will thus be unrecovable.
3326
with PGPEngine() as pgp:
3327
for client in tcp_server.clients.values():
3328
key = client_settings[client.name]["secret"]
3329
client.encrypted_secret = pgp.encrypt(client.secret,
3333
# A list of attributes that can not be pickled
3335
exclude = { "bus", "changedstate", "secret",
3336
"checker", "server_settings" }
3337
for name, typ in inspect.getmembers(dbus.service
3341
client_dict["encrypted_secret"] = (client
3343
for attr in client.client_structure:
3344
if attr not in exclude:
3345
client_dict[attr] = getattr(client, attr)
3347
clients[client.name] = client_dict
3348
del client_settings[client.name]["secret"]
3351
with tempfile.NamedTemporaryFile(
3355
dir=os.path.dirname(stored_state_path),
3356
delete=False) as stored_state:
3357
pickle.dump((clients, client_settings), stored_state,
3359
tempname = stored_state.name
3360
os.rename(tempname, stored_state_path)
3361
except (IOError, OSError) as e:
3367
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3368
logger.warning("Could not save persistent state: {}"
3369
.format(os.strerror(e.errno)))
3371
logger.warning("Could not save persistent state:",
3375
# Delete all clients, and settings from config
3376
while tcp_server.clients:
3377
name, client = tcp_server.clients.popitem()
3379
client.remove_from_connection()
3380
# Don't signal the disabling
3381
client.disable(quiet=True)
3382
# Emit D-Bus signal for removal
3384
mandos_dbus_service.client_removed_signal(client)
3385
client_settings.clear()
3387
atexit.register(cleanup)
3389
for client in tcp_server.clients.values():
1453
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()
1456
mandos_dbus_service.ClientAdded(client.dbus_object_path,
1457
client.GetAllProperties())
3397
1460
tcp_server.enable()
3398
1461
tcp_server.server_activate()
3400
1463
# Find out what port we got
3402
service.port = tcp_server.socket.getsockname()[1]
1464
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())
1466
logger.info(u"Now listening on address %r, port %d,"
1467
" flowinfo %d, scope_id %d"
1468
% tcp_server.socket.getsockname())
3408
logger.info("Now listening on address %r, port %d",
3409
*tcp_server.socket.getsockname())
1470
logger.info(u"Now listening on address %r, port %d"
1471
% tcp_server.socket.getsockname())
3411
1473
#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")
1476
# From the Avahi example code
1479
except dbus.exceptions.DBusException, error:
1480
logger.critical(u"DBusException: %s", error)
1482
# End of Avahi example code
1484
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1485
lambda *args, **kwargs:
1486
(tcp_server.handle_request
1487
(*args[2:], **kwargs) or True))
1489
logger.debug(u"Starting main loop")
3430
1490
main_loop.run()
3431
except AvahiError as error:
3432
logger.critical("Avahi Error", exc_info=error)
1491
except AvahiError, error:
1492
logger.critical(u"AvahiError: %s", error)
3435
1494
except KeyboardInterrupt:
3437
print("", file=sys.stderr)
3438
logger.debug("Server received KeyboardInterrupt")
3439
logger.debug("Server exiting")
3440
# Must run before the D-Bus bus name gets deregistered
1497
logger.debug(u"Server received KeyboardInterrupt")
1498
logger.debug(u"Server exiting")
3444
1500
if __name__ == '__main__':