76
94
except ImportError:
77
95
SO_BINDTODEVICE = None
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)
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,
189
def __exit__(self, exc_type, exc_value, traceback):
197
if self.tempdir is not None:
198
# Delete contents of tempdir
199
for root, dirs, files in os.walk(self.tempdir,
201
for filename in files:
202
os.remove(os.path.join(root, filename))
204
os.rmdir(os.path.join(root, dirname))
206
os.rmdir(self.tempdir)
209
def password_encode(self, password):
210
# Passphrase can not be empty and can not contain newlines or
211
# NUL bytes. So we prefix it and hex encode it.
212
encoded = b"mandos" + binascii.hexlify(password)
213
if len(encoded) > 2048:
214
# GnuPG can't handle long passwords, so encode differently
215
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
216
.replace(b"\n", b"\\n")
217
.replace(b"\0", b"\\x00"))
220
def encrypt(self, data, password):
221
passphrase = self.password_encode(password)
222
with tempfile.NamedTemporaryFile(
223
dir=self.tempdir) as passfile:
224
passfile.write(passphrase)
226
proc = subprocess.Popen([self.gpg, '--symmetric',
230
stdin = subprocess.PIPE,
231
stdout = subprocess.PIPE,
232
stderr = subprocess.PIPE)
233
ciphertext, err = proc.communicate(input = data)
234
if proc.returncode != 0:
238
def decrypt(self, data, password):
239
passphrase = self.password_encode(password)
240
with tempfile.NamedTemporaryFile(
241
dir = self.tempdir) as passfile:
242
passfile.write(passphrase)
244
proc = subprocess.Popen([self.gpg, '--decrypt',
248
stdin = subprocess.PIPE,
249
stdout = subprocess.PIPE,
250
stderr = subprocess.PIPE)
251
decrypted_plaintext, err = proc.communicate(input = data)
252
if proc.returncode != 0:
254
return decrypted_plaintext
256
# Pretend that we have an Avahi module
258
"""This isn't so much a class as it is a module-like namespace.
259
It is instantiated once, and simulates having an Avahi module."""
260
IF_UNSPEC = -1 # avahi-common/address.h
261
PROTO_UNSPEC = -1 # avahi-common/address.h
262
PROTO_INET = 0 # avahi-common/address.h
263
PROTO_INET6 = 1 # avahi-common/address.h
264
DBUS_NAME = "org.freedesktop.Avahi"
265
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
266
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
267
DBUS_PATH_SERVER = "/"
268
def string_array_to_txt_array(self, t):
269
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
270
for s in t), signature="ay")
271
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
272
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
273
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
274
SERVER_INVALID = 0 # avahi-common/defs.h
275
SERVER_REGISTERING = 1 # avahi-common/defs.h
276
SERVER_RUNNING = 2 # avahi-common/defs.h
277
SERVER_COLLISION = 3 # avahi-common/defs.h
278
SERVER_FAILURE = 4 # avahi-common/defs.h
97
281
class AvahiError(Exception):
98
282
def __init__(self, value, *args, **kwargs):
99
283
self.value = value
100
super(AvahiError, self).__init__(value, *args, **kwargs)
101
def __unicode__(self):
102
return unicode(repr(self.value))
284
return super(AvahiError, self).__init__(value, *args,
104
288
class AvahiServiceError(AvahiError):
107
292
class AvahiGroupError(AvahiError):
186
396
dbus.UInt16(self.port),
187
397
avahi.string_array_to_txt_array(self.TXT))
188
398
self.group.Commit()
189
400
def entry_group_state_changed(self, state, error):
190
401
"""Derived from the Avahi example code"""
191
logger.debug(u"Avahi state change: %i", state)
402
logger.debug("Avahi entry group state change: %i", state)
193
404
if state == avahi.ENTRY_GROUP_ESTABLISHED:
194
logger.debug(u"Zeroconf service established.")
405
logger.debug("Zeroconf service established.")
195
406
elif state == avahi.ENTRY_GROUP_COLLISION:
196
logger.warning(u"Zeroconf service name collision.")
407
logger.info("Zeroconf service name collision.")
198
409
elif state == avahi.ENTRY_GROUP_FAILURE:
199
logger.critical(u"Avahi: Error in group state changed %s",
201
raise AvahiGroupError(u"State changed: %s"
410
logger.critical("Avahi: Error in group state changed %s",
412
raise AvahiGroupError("State changed: {!s}".format(error))
203
414
def cleanup(self):
204
415
"""Derived from the Avahi example code"""
205
416
if self.group is not None:
419
except (dbus.exceptions.UnknownMethodException,
420
dbus.exceptions.DBusException):
207
422
self.group = None
208
def server_state_changed(self, state):
425
def server_state_changed(self, state, error=None):
209
426
"""Derived from the Avahi example code"""
210
if state == avahi.SERVER_COLLISION:
211
logger.error(u"Zeroconf server name collision")
427
logger.debug("Avahi server state change: %i", state)
429
avahi.SERVER_INVALID: "Zeroconf server invalid",
430
avahi.SERVER_REGISTERING: None,
431
avahi.SERVER_COLLISION: "Zeroconf server name collision",
432
avahi.SERVER_FAILURE: "Zeroconf server failure",
434
if state in bad_states:
435
if bad_states[state] is not None:
437
logger.error(bad_states[state])
439
logger.error(bad_states[state] + ": %r", error)
213
441
elif state == avahi.SERVER_RUNNING:
444
except dbus.exceptions.DBusException as error:
445
if (error.get_dbus_name()
446
== "org.freedesktop.Avahi.CollisionError"):
447
logger.info("Local Zeroconf service name"
449
return self.rename(remove=False)
451
logger.critical("D-Bus Exception", exc_info=error)
456
logger.debug("Unknown state: %r", state)
458
logger.debug("Unknown state: %r: %r", state, error)
215
460
def activate(self):
216
461
"""Derived from the Avahi example code"""
217
462
if self.server is None:
218
463
self.server = dbus.Interface(
219
464
self.bus.get_object(avahi.DBUS_NAME,
220
avahi.DBUS_PATH_SERVER),
465
avahi.DBUS_PATH_SERVER,
466
follow_name_owner_changes=True),
221
467
avahi.DBUS_INTERFACE_SERVER)
222
self.server.connect_to_signal(u"StateChanged",
223
self.server_state_changed)
468
self.server.connect_to_signal("StateChanged",
469
self.server_state_changed)
224
470
self.server_state_changed(self.server.GetState())
473
class AvahiServiceToSyslog(AvahiService):
474
def rename(self, *args, **kwargs):
475
"""Add the new name to the syslog messages"""
476
ret = AvahiService.rename(self, *args, **kwargs)
477
syslogger.setFormatter(logging.Formatter(
478
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
482
# Pretend that we have a GnuTLS module
483
class GnuTLS(object):
484
"""This isn't so much a class as it is a module-like namespace.
485
It is instantiated once, and simulates having a GnuTLS module."""
487
_library = ctypes.cdll.LoadLibrary(
488
ctypes.util.find_library("gnutls"))
489
_need_version = b"3.3.0"
491
# Need to use class name "GnuTLS" here, since this method is
492
# called before the assignment to the "gnutls" global variable
494
if GnuTLS.check_version(self._need_version) is None:
495
raise GnuTLS.Error("Needs GnuTLS {} or later"
496
.format(self._need_version))
498
# Unless otherwise indicated, the constants and types below are
499
# all from the gnutls/gnutls.h C header file.
509
E_NO_CERTIFICATE_FOUND = -49
510
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
513
class session_int(ctypes.Structure):
515
session_t = ctypes.POINTER(session_int)
516
class certificate_credentials_st(ctypes.Structure):
518
certificate_credentials_t = ctypes.POINTER(
519
certificate_credentials_st)
520
certificate_type_t = ctypes.c_int
521
class datum_t(ctypes.Structure):
522
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
523
('size', ctypes.c_uint)]
524
class openpgp_crt_int(ctypes.Structure):
526
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
527
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
528
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
529
credentials_type_t = ctypes.c_int
530
transport_ptr_t = ctypes.c_void_p
531
close_request_t = ctypes.c_int
534
class Error(Exception):
535
# We need to use the class name "GnuTLS" here, since this
536
# exception might be raised from within GnuTLS.__init__,
537
# which is called before the assignment to the "gnutls"
538
# global variable has happened.
539
def __init__(self, message = None, code = None, args=()):
540
# Default usage is by a message string, but if a return
541
# code is passed, convert it to a string with
544
if message is None and code is not None:
545
message = GnuTLS.strerror(code)
546
return super(GnuTLS.Error, self).__init__(
549
class CertificateSecurityError(Error):
553
class Credentials(object):
555
self._c_object = gnutls.certificate_credentials_t()
556
gnutls.certificate_allocate_credentials(
557
ctypes.byref(self._c_object))
558
self.type = gnutls.CRD_CERTIFICATE
561
gnutls.certificate_free_credentials(self._c_object)
563
class ClientSession(object):
564
def __init__(self, socket, credentials = None):
565
self._c_object = gnutls.session_t()
566
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
567
gnutls.set_default_priority(self._c_object)
568
gnutls.transport_set_ptr(self._c_object, socket.fileno())
569
gnutls.handshake_set_private_extensions(self._c_object,
572
if credentials is None:
573
credentials = gnutls.Credentials()
574
gnutls.credentials_set(self._c_object, credentials.type,
575
ctypes.cast(credentials._c_object,
577
self.credentials = credentials
580
gnutls.deinit(self._c_object)
583
return gnutls.handshake(self._c_object)
585
def send(self, data):
589
data_len -= gnutls.record_send(self._c_object,
594
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
596
# Error handling functions
597
def _error_code(result):
598
"""A function to raise exceptions on errors, suitable
599
for the 'restype' attribute on ctypes functions"""
602
if result == gnutls.E_NO_CERTIFICATE_FOUND:
603
raise gnutls.CertificateSecurityError(code = result)
604
raise gnutls.Error(code = result)
606
def _retry_on_error(result, func, arguments):
607
"""A function to retry on some errors, suitable
608
for the 'errcheck' attribute on ctypes functions"""
610
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
611
return _error_code(result)
612
result = func(*arguments)
615
# Unless otherwise indicated, the function declarations below are
616
# all from the gnutls/gnutls.h C header file.
619
priority_set_direct = _library.gnutls_priority_set_direct
620
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
621
ctypes.POINTER(ctypes.c_char_p)]
622
priority_set_direct.restype = _error_code
624
init = _library.gnutls_init
625
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
626
init.restype = _error_code
628
set_default_priority = _library.gnutls_set_default_priority
629
set_default_priority.argtypes = [session_t]
630
set_default_priority.restype = _error_code
632
record_send = _library.gnutls_record_send
633
record_send.argtypes = [session_t, ctypes.c_void_p,
635
record_send.restype = ctypes.c_ssize_t
636
record_send.errcheck = _retry_on_error
638
certificate_allocate_credentials = (
639
_library.gnutls_certificate_allocate_credentials)
640
certificate_allocate_credentials.argtypes = [
641
ctypes.POINTER(certificate_credentials_t)]
642
certificate_allocate_credentials.restype = _error_code
644
certificate_free_credentials = (
645
_library.gnutls_certificate_free_credentials)
646
certificate_free_credentials.argtypes = [certificate_credentials_t]
647
certificate_free_credentials.restype = None
649
handshake_set_private_extensions = (
650
_library.gnutls_handshake_set_private_extensions)
651
handshake_set_private_extensions.argtypes = [session_t,
653
handshake_set_private_extensions.restype = None
655
credentials_set = _library.gnutls_credentials_set
656
credentials_set.argtypes = [session_t, credentials_type_t,
658
credentials_set.restype = _error_code
660
strerror = _library.gnutls_strerror
661
strerror.argtypes = [ctypes.c_int]
662
strerror.restype = ctypes.c_char_p
664
certificate_type_get = _library.gnutls_certificate_type_get
665
certificate_type_get.argtypes = [session_t]
666
certificate_type_get.restype = _error_code
668
certificate_get_peers = _library.gnutls_certificate_get_peers
669
certificate_get_peers.argtypes = [session_t,
670
ctypes.POINTER(ctypes.c_uint)]
671
certificate_get_peers.restype = ctypes.POINTER(datum_t)
673
global_set_log_level = _library.gnutls_global_set_log_level
674
global_set_log_level.argtypes = [ctypes.c_int]
675
global_set_log_level.restype = None
677
global_set_log_function = _library.gnutls_global_set_log_function
678
global_set_log_function.argtypes = [log_func]
679
global_set_log_function.restype = None
681
deinit = _library.gnutls_deinit
682
deinit.argtypes = [session_t]
683
deinit.restype = None
685
handshake = _library.gnutls_handshake
686
handshake.argtypes = [session_t]
687
handshake.restype = _error_code
688
handshake.errcheck = _retry_on_error
690
transport_set_ptr = _library.gnutls_transport_set_ptr
691
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
692
transport_set_ptr.restype = None
694
bye = _library.gnutls_bye
695
bye.argtypes = [session_t, close_request_t]
696
bye.restype = _error_code
697
bye.errcheck = _retry_on_error
699
check_version = _library.gnutls_check_version
700
check_version.argtypes = [ctypes.c_char_p]
701
check_version.restype = ctypes.c_char_p
703
# All the function declarations below are from gnutls/openpgp.h
705
openpgp_crt_init = _library.gnutls_openpgp_crt_init
706
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
707
openpgp_crt_init.restype = _error_code
709
openpgp_crt_import = _library.gnutls_openpgp_crt_import
710
openpgp_crt_import.argtypes = [openpgp_crt_t,
711
ctypes.POINTER(datum_t),
713
openpgp_crt_import.restype = _error_code
715
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
716
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
717
ctypes.POINTER(ctypes.c_uint)]
718
openpgp_crt_verify_self.restype = _error_code
720
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
721
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
722
openpgp_crt_deinit.restype = None
724
openpgp_crt_get_fingerprint = (
725
_library.gnutls_openpgp_crt_get_fingerprint)
726
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
730
openpgp_crt_get_fingerprint.restype = _error_code
732
# Remove non-public functions
733
del _error_code, _retry_on_error
734
# Create the global "gnutls" object, simulating a module
737
def call_pipe(connection, # : multiprocessing.Connection
738
func, *args, **kwargs):
739
"""This function is meant to be called by multiprocessing.Process
741
This function runs func(*args, **kwargs), and writes the resulting
742
return value on the provided multiprocessing.Connection.
744
connection.send(func(*args, **kwargs))
227
747
class Client(object):
228
748
"""A representation of a client host served by this server.
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)
751
approved: bool(); 'None' if not yet approved/disapproved
752
approval_delay: datetime.timedelta(); Time to wait for approval
753
approval_duration: datetime.timedelta(); Duration of one approval
245
754
checker: subprocess.Popen(); a running checker process used
246
755
to see if the client lives.
247
756
'None' if no process is running.
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
757
checker_callback_tag: a GLib event source tag, or None
758
checker_command: string; External command which is run to check
759
if client lives. %() expansions are done at
253
760
runtime with vars(self) as dict, so that for
254
761
instance %(name)s can be used in the command.
762
checker_initiator_tag: a GLib event source tag, or None
763
created: datetime.datetime(); (UTC) object creation
764
client_structure: Object describing what attributes a client has
765
and is used for storing the client at exit
255
766
current_checker_command: string; current running checker_command
767
disable_initiator_tag: a GLib event source tag, or None
769
fingerprint: string (40 or 32 hexadecimal digits); used to
770
uniquely identify the client
771
host: string; available for use by the checker command
772
interval: datetime.timedelta(); How often to start a new checker
773
last_approval_request: datetime.datetime(); (UTC) or None
774
last_checked_ok: datetime.datetime(); (UTC) or None
775
last_checker_status: integer between 0 and 255 reflecting exit
776
status of last checker. -1 reflects crashed
777
checker, -2 means no checker completed yet.
778
last_checker_signal: The signal which killed the last checker, if
779
last_checker_status is -1
780
last_enabled: datetime.datetime(); (UTC) or None
781
name: string; from the config file, used in log messages and
783
secret: bytestring; sent verbatim (over TLS) to client
784
timeout: datetime.timedelta(); How long from last_checked_ok
785
until this client is disabled
786
extended_timeout: extra long timeout when secret has been sent
787
runtime_expansions: Allowed attributes for runtime expansion.
788
expires: datetime.datetime(); time (UTC) when a client will be
790
server_settings: The server_settings dict from main()
793
runtime_expansions = ("approval_delay", "approval_duration",
794
"created", "enabled", "expires",
795
"fingerprint", "host", "interval",
796
"last_approval_request", "last_checked_ok",
797
"last_enabled", "name", "timeout")
800
"extended_timeout": "PT15M",
802
"checker": "fping -q -- %%(host)s",
804
"approval_delay": "PT0S",
805
"approval_duration": "PT1S",
806
"approved_by_default": "True",
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'
811
def config_parser(config):
812
"""Construct a new dict of client settings of this form:
813
{ client_name: {setting_name: value, ...}, ...}
814
with exceptions for any special settings as defined above.
815
NOTE: Must be a pure function. Must return the same result
816
value given the same arguments.
819
for client_name in config.sections():
820
section = dict(config.items(client_name))
821
client = settings[client_name] = {}
823
client["host"] = section["host"]
824
# Reformat values from string types to Python types
825
client["approved_by_default"] = config.getboolean(
826
client_name, "approved_by_default")
827
client["enabled"] = config.getboolean(client_name,
830
# Uppercase and remove spaces from fingerprint for later
831
# comparison purposes with return value from the
832
# fingerprint() function
833
client["fingerprint"] = (section["fingerprint"].upper()
835
if "secret" in section:
836
client["secret"] = codecs.decode(section["secret"]
839
elif "secfile" in section:
840
with open(os.path.expanduser(os.path.expandvars
841
(section["secfile"])),
843
client["secret"] = secfile.read()
845
raise TypeError("No secret or secfile for section {}"
847
client["timeout"] = string_to_delta(section["timeout"])
848
client["extended_timeout"] = string_to_delta(
849
section["extended_timeout"])
850
client["interval"] = string_to_delta(section["interval"])
851
client["approval_delay"] = string_to_delta(
852
section["approval_delay"])
853
client["approval_duration"] = string_to_delta(
854
section["approval_duration"])
855
client["checker_command"] = section["checker"]
856
client["last_approval_request"] = None
857
client["last_checked_ok"] = None
858
client["last_checker_status"] = -2
862
def __init__(self, settings, name = None, server_settings=None):
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()
864
if server_settings is None:
866
self.server_settings = server_settings
867
# adding all client settings
868
for setting, value in settings.items():
869
setattr(self, setting, value)
872
if not hasattr(self, "last_enabled"):
873
self.last_enabled = datetime.datetime.utcnow()
874
if not hasattr(self, "expires"):
875
self.expires = (datetime.datetime.utcnow()
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
878
self.last_enabled = None
881
logger.debug("Creating client %r", self.name)
882
logger.debug(" Fingerprint: %s", self.fingerprint)
883
self.created = settings.get("created",
884
datetime.datetime.utcnow())
886
# attributes specific for this server instance
305
887
self.checker = None
306
888
self.checker_initiator_tag = None
307
889
self.disable_initiator_tag = None
308
890
self.checker_callback_tag = None
309
self.checker_command = config[u"checker"]
310
891
self.current_checker_command = None
311
self.last_connect = None
893
self.approvals_pending = 0
894
self.changedstate = multiprocessing_manager.Condition(
895
multiprocessing_manager.Lock())
896
self.client_structure = [attr
897
for attr in self.__dict__.keys()
898
if not attr.startswith("_")]
899
self.client_structure.append("client_structure")
901
for name, t in inspect.getmembers(
902
type(self), lambda obj: isinstance(obj, property)):
903
if not name.startswith("_"):
904
self.client_structure.append(name)
906
# Send notice to process children that client state has changed
907
def send_changedstate(self):
908
with self.changedstate:
909
self.changedstate.notify_all()
313
911
def enable(self):
314
912
"""Start this client's checker and timeout hooks"""
315
if getattr(self, u"enabled", False):
913
if getattr(self, "enabled", False):
316
914
# Already enabled
916
self.expires = datetime.datetime.utcnow() + self.timeout
318
918
self.last_enabled = datetime.datetime.utcnow()
920
self.send_changedstate()
922
def disable(self, quiet=True):
923
"""Disable this client."""
924
if not getattr(self, "enabled", False):
927
logger.info("Disabling client %s", self.name)
928
if getattr(self, "disable_initiator_tag", None) is not None:
929
GLib.source_remove(self.disable_initiator_tag)
930
self.disable_initiator_tag = None
932
if getattr(self, "checker_initiator_tag", None) is not None:
933
GLib.source_remove(self.checker_initiator_tag)
934
self.checker_initiator_tag = None
938
self.send_changedstate()
939
# Do not run this again if called by a GLib.timeout_add
945
def init_checker(self):
319
946
# Schedule a new checker to be started an 'interval' from now,
320
947
# and every interval from then on.
321
self.checker_initiator_tag = (gobject.timeout_add
322
(self.interval_milliseconds(),
948
if self.checker_initiator_tag is not None:
949
GLib.source_remove(self.checker_initiator_tag)
950
self.checker_initiator_tag = GLib.timeout_add(
951
int(self.interval.total_seconds() * 1000),
953
# Schedule a disable() when 'timeout' has passed
954
if self.disable_initiator_tag is not None:
955
GLib.source_remove(self.disable_initiator_tag)
956
self.disable_initiator_tag = GLib.timeout_add(
957
int(self.timeout.total_seconds() * 1000), self.disable)
324
958
# Also start a new checker *right now*.
325
959
self.start_checker()
326
# Schedule a disable() when 'timeout' has passed
327
self.disable_initiator_tag = (gobject.timeout_add
328
(self.timeout_milliseconds(),
333
"""Disable this client."""
334
if not getattr(self, "enabled", False):
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)
339
self.disable_initiator_tag = None
340
if getattr(self, u"checker_initiator_tag", False):
341
gobject.source_remove(self.checker_initiator_tag)
342
self.checker_initiator_tag = None
344
if self.disable_hook:
345
self.disable_hook(self)
347
# Do not run this again if called by a gobject.timeout_add
351
self.disable_hook = None
354
def checker_callback(self, pid, condition, command):
961
def checker_callback(self, source, condition, connection,
355
963
"""The checker has completed, so take appropriate actions."""
356
964
self.checker_callback_tag = None
357
965
self.checker = None
358
if os.WIFEXITED(condition):
359
exitstatus = os.WEXITSTATUS(condition)
361
logger.info(u"Checker for %(name)s succeeded",
966
# Read return code from connection (see call_pipe)
967
returncode = connection.recv()
971
self.last_checker_status = returncode
972
self.last_checker_signal = None
973
if self.last_checker_status == 0:
974
logger.info("Checker for %(name)s succeeded",
363
976
self.checked_ok()
365
logger.info(u"Checker for %(name)s failed",
978
logger.info("Checker for %(name)s failed", vars(self))
368
logger.warning(u"Checker for %(name)s crashed?",
980
self.last_checker_status = -1
981
self.last_checker_signal = -returncode
982
logger.warning("Checker for %(name)s crashed?",
371
986
def checked_ok(self):
372
"""Bump up the timeout for this client.
374
This should only be called when the client has been seen,
987
"""Assert that the client has been seen, alive and well."""
377
988
self.last_checked_ok = datetime.datetime.utcnow()
378
gobject.source_remove(self.disable_initiator_tag)
379
self.disable_initiator_tag = (gobject.timeout_add
380
(self.timeout_milliseconds(),
989
self.last_checker_status = 0
990
self.last_checker_signal = None
993
def bump_timeout(self, timeout=None):
994
"""Bump up the timeout for this client."""
996
timeout = self.timeout
997
if self.disable_initiator_tag is not None:
998
GLib.source_remove(self.disable_initiator_tag)
999
self.disable_initiator_tag = None
1000
if getattr(self, "enabled", False):
1001
self.disable_initiator_tag = GLib.timeout_add(
1002
int(timeout.total_seconds() * 1000), self.disable)
1003
self.expires = datetime.datetime.utcnow() + timeout
1005
def need_approval(self):
1006
self.last_approval_request = datetime.datetime.utcnow()
383
1008
def start_checker(self):
384
1009
"""Start a new checker subprocess if one is not running.
386
1011
If a checker already exists, leave it running and do
388
1013
# The reason for not killing a running checker is that if we
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
1014
# did that, and if a checker (for some reason) started running
1015
# slowly and taking more than 'interval' time, then the client
1016
# would inevitably timeout, since no checker would get a
1017
# chance to run to completion. If we instead leave running
393
1018
# checkers alone, the checker would have to take more time
394
# than 'timeout' for the client to be declared invalid, which
395
# is as it should be.
1019
# than 'timeout' for the client to be disabled, which is as it
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)
1022
if self.checker is not None and not self.checker.is_alive():
1023
logger.warning("Checker was not alive; joining")
405
1026
# Start a new checker if needed
406
1027
if self.checker is None:
1028
# Escape attributes for the shell
1030
attr: re.escape(str(getattr(self, attr)))
1031
for attr in self.runtime_expansions }
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
1033
command = self.checker_command % escaped_attrs
1034
except TypeError as error:
1035
logger.error('Could not format string "%s"',
1036
self.checker_command,
1038
return True # Try again later
424
1039
self.current_checker_command = command
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
1040
logger.info("Starting checker %r for %s", command,
1042
# We don't need to redirect stdout and stderr, since
1043
# in normal mode, that is already done by daemon(),
1044
# and in debug mode we don't want to. (Stdin is
1045
# always replaced by /dev/null.)
1046
# The exception is when not debugging but nevertheless
1047
# running in the foreground; use the previously
1049
popen_args = { "close_fds": True,
1052
if (not self.server_settings["debug"]
1053
and self.server_settings["foreground"]):
1054
popen_args.update({"stdout": wnull,
1056
pipe = multiprocessing.Pipe(duplex = False)
1057
self.checker = multiprocessing.Process(
1059
args = (pipe[1], subprocess.call, command),
1060
kwargs = popen_args)
1061
self.checker.start()
1062
self.checker_callback_tag = GLib.io_add_watch(
1063
pipe[0].fileno(), GLib.IO_IN,
1064
self.checker_callback, pipe[0], command)
1065
# Re-run this periodically if run by GLib.timeout_add
451
1068
def stop_checker(self):
452
1069
"""Force the checker process, if any, to stop."""
453
1070
if self.checker_callback_tag:
454
gobject.source_remove(self.checker_callback_tag)
1071
GLib.source_remove(self.checker_callback_tag)
455
1072
self.checker_callback_tag = None
456
if getattr(self, u"checker", None) is None:
1073
if getattr(self, "checker", None) is None:
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
1075
logger.debug("Stopping checker for %(name)s", vars(self))
1076
self.checker.terminate()
467
1077
self.checker = None
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):
1080
def dbus_service_property(dbus_interface,
1084
"""Decorators for marking methods of a DBusObjectWithProperties to
1085
become properties on the D-Bus.
1087
The decorated method will be called with no arguments by "Get"
1088
and with one argument by "Set".
1090
The parameters, where they are supported, are the same as
1091
dbus.service.method, except there is only "signature", since the
1092
type from Get() and the type sent to Set() is the same.
1094
# Encoding deeply encoded byte arrays is not supported yet by the
1095
# "Set" method, so we fail early here:
1096
if byte_arrays and signature != "ay":
1097
raise ValueError("Byte arrays not supported for non-'ay'"
1098
" signature {!r}".format(signature))
1100
def decorator(func):
1101
func._dbus_is_property = True
1102
func._dbus_interface = dbus_interface
1103
func._dbus_signature = signature
1104
func._dbus_access = access
1105
func._dbus_name = func.__name__
1106
if func._dbus_name.endswith("_dbus_property"):
1107
func._dbus_name = func._dbus_name[:-14]
1108
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1114
def dbus_interface_annotations(dbus_interface):
1115
"""Decorator for marking functions returning interface annotations
1119
@dbus_interface_annotations("org.example.Interface")
1120
def _foo(self): # Function name does not matter
1121
return {"org.freedesktop.DBus.Deprecated": "true",
1122
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1126
def decorator(func):
1127
func._dbus_is_interface = True
1128
func._dbus_interface = dbus_interface
1129
func._dbus_name = dbus_interface
1135
def dbus_annotations(annotations):
1136
"""Decorator to annotate D-Bus methods, signals or properties
1139
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1140
"org.freedesktop.DBus.Property."
1141
"EmitsChangedSignal": "false"})
1142
@dbus_service_property("org.example.Interface", signature="b",
1144
def Property_dbus_property(self):
1145
return dbus.Boolean(False)
1147
See also the DBusObjectWithAnnotations class.
1150
def decorator(func):
1151
func._dbus_annotations = annotations
1157
class DBusPropertyException(dbus.exceptions.DBusException):
1158
"""A base class for D-Bus property-related exceptions
1163
class DBusPropertyAccessException(DBusPropertyException):
1164
"""A property's access permissions disallows an operation.
1169
class DBusPropertyNotFound(DBusPropertyException):
1170
"""An attempt was made to access a non-existing property.
1175
class DBusObjectWithAnnotations(dbus.service.Object):
1176
"""A D-Bus object with annotations.
1178
Classes inheriting from this can use the dbus_annotations
1179
decorator to add annotations to methods or signals.
1183
def _is_dbus_thing(thing):
1184
"""Returns a function testing if an attribute is a D-Bus thing
1186
If called like _is_dbus_thing("method") it returns a function
1187
suitable for use as predicate to inspect.getmembers().
1189
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1192
def _get_all_dbus_things(self, thing):
1193
"""Returns a generator of (name, attribute) pairs
1195
return ((getattr(athing.__get__(self), "_dbus_name", name),
1196
athing.__get__(self))
1197
for cls in self.__class__.__mro__
1199
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1201
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1202
out_signature = "s",
1203
path_keyword = 'object_path',
1204
connection_keyword = 'connection')
1205
def Introspect(self, object_path, connection):
1206
"""Overloading of standard D-Bus method.
1208
Inserts annotation tags on methods and signals.
1210
xmlstring = dbus.service.Object.Introspect(self, object_path,
1213
document = xml.dom.minidom.parseString(xmlstring)
1215
for if_tag in document.getElementsByTagName("interface"):
1216
# Add annotation tags
1217
for typ in ("method", "signal"):
1218
for tag in if_tag.getElementsByTagName(typ):
1220
for name, prop in (self.
1221
_get_all_dbus_things(typ)):
1222
if (name == tag.getAttribute("name")
1223
and prop._dbus_interface
1224
== if_tag.getAttribute("name")):
1225
annots.update(getattr(
1226
prop, "_dbus_annotations", {}))
1227
for name, value in annots.items():
1228
ann_tag = document.createElement(
1230
ann_tag.setAttribute("name", name)
1231
ann_tag.setAttribute("value", value)
1232
tag.appendChild(ann_tag)
1233
# Add interface annotation tags
1234
for annotation, value in dict(
1235
itertools.chain.from_iterable(
1236
annotations().items()
1237
for name, annotations
1238
in self._get_all_dbus_things("interface")
1239
if name == if_tag.getAttribute("name")
1241
ann_tag = document.createElement("annotation")
1242
ann_tag.setAttribute("name", annotation)
1243
ann_tag.setAttribute("value", value)
1244
if_tag.appendChild(ann_tag)
1245
# Fix argument name for the Introspect method itself
1246
if (if_tag.getAttribute("name")
1247
== dbus.INTROSPECTABLE_IFACE):
1248
for cn in if_tag.getElementsByTagName("method"):
1249
if cn.getAttribute("name") == "Introspect":
1250
for arg in cn.getElementsByTagName("arg"):
1251
if (arg.getAttribute("direction")
1253
arg.setAttribute("name",
1255
xmlstring = document.toxml("utf-8")
1257
except (AttributeError, xml.dom.DOMException,
1258
xml.parsers.expat.ExpatError) as error:
1259
logger.error("Failed to override Introspection method",
1264
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1265
"""A D-Bus object with properties.
1267
Classes inheriting from this can use the dbus_service_property
1268
decorator to expose methods as D-Bus properties. It exposes the
1269
standard Get(), Set(), and GetAll() methods on the D-Bus.
1272
def _get_dbus_property(self, interface_name, property_name):
1273
"""Returns a bound method if one exists which is a D-Bus
1274
property with the specified name and interface.
1276
for cls in self.__class__.__mro__:
1277
for name, value in inspect.getmembers(
1278
cls, self._is_dbus_thing("property")):
1279
if (value._dbus_name == property_name
1280
and value._dbus_interface == interface_name):
1281
return value.__get__(self)
1284
raise DBusPropertyNotFound("{}:{}.{}".format(
1285
self.dbus_object_path, interface_name, property_name))
1288
def _get_all_interface_names(cls):
1289
"""Get a sequence of all interfaces supported by an object"""
1290
return (name for name in set(getattr(getattr(x, attr),
1291
"_dbus_interface", None)
1292
for x in (inspect.getmro(cls))
1294
if name is not None)
1296
@dbus.service.method(dbus.PROPERTIES_IFACE,
1299
def Get(self, interface_name, property_name):
1300
"""Standard D-Bus property Get() method, see D-Bus standard.
1302
prop = self._get_dbus_property(interface_name, property_name)
1303
if prop._dbus_access == "write":
1304
raise DBusPropertyAccessException(property_name)
1306
if not hasattr(value, "variant_level"):
1308
return type(value)(value, variant_level=value.variant_level+1)
1310
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1311
def Set(self, interface_name, property_name, value):
1312
"""Standard D-Bus property Set() method, see D-Bus standard.
1314
prop = self._get_dbus_property(interface_name, property_name)
1315
if prop._dbus_access == "read":
1316
raise DBusPropertyAccessException(property_name)
1317
if prop._dbus_get_args_options["byte_arrays"]:
1318
# The byte_arrays option is not supported yet on
1319
# signatures other than "ay".
1320
if prop._dbus_signature != "ay":
1321
raise ValueError("Byte arrays not supported for non-"
1322
"'ay' signature {!r}"
1323
.format(prop._dbus_signature))
1324
value = dbus.ByteArray(b''.join(chr(byte)
1328
@dbus.service.method(dbus.PROPERTIES_IFACE,
1330
out_signature="a{sv}")
1331
def GetAll(self, interface_name):
1332
"""Standard D-Bus property GetAll() method, see D-Bus
1335
Note: Will not include properties with access="write".
1338
for name, prop in self._get_all_dbus_things("property"):
1340
and interface_name != prop._dbus_interface):
1341
# Interface non-empty but did not match
1343
# Ignore write-only properties
1344
if prop._dbus_access == "write":
1347
if not hasattr(value, "variant_level"):
1348
properties[name] = value
1350
properties[name] = type(value)(
1351
value, variant_level = value.variant_level + 1)
1352
return dbus.Dictionary(properties, signature="sv")
1354
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1355
def PropertiesChanged(self, interface_name, changed_properties,
1356
invalidated_properties):
1357
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1362
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1364
path_keyword='object_path',
1365
connection_keyword='connection')
1366
def Introspect(self, object_path, connection):
1367
"""Overloading of standard D-Bus method.
1369
Inserts property tags and interface annotation tags.
1371
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1375
document = xml.dom.minidom.parseString(xmlstring)
1377
def make_tag(document, name, prop):
1378
e = document.createElement("property")
1379
e.setAttribute("name", name)
1380
e.setAttribute("type", prop._dbus_signature)
1381
e.setAttribute("access", prop._dbus_access)
1384
for if_tag in document.getElementsByTagName("interface"):
1386
for tag in (make_tag(document, name, prop)
1388
in self._get_all_dbus_things("property")
1389
if prop._dbus_interface
1390
== if_tag.getAttribute("name")):
1391
if_tag.appendChild(tag)
1392
# Add annotation tags for properties
1393
for tag in if_tag.getElementsByTagName("property"):
1395
for name, prop in self._get_all_dbus_things(
1397
if (name == tag.getAttribute("name")
1398
and prop._dbus_interface
1399
== if_tag.getAttribute("name")):
1400
annots.update(getattr(
1401
prop, "_dbus_annotations", {}))
1402
for name, value in annots.items():
1403
ann_tag = document.createElement(
1405
ann_tag.setAttribute("name", name)
1406
ann_tag.setAttribute("value", value)
1407
tag.appendChild(ann_tag)
1408
# Add the names to the return values for the
1409
# "org.freedesktop.DBus.Properties" methods
1410
if (if_tag.getAttribute("name")
1411
== "org.freedesktop.DBus.Properties"):
1412
for cn in if_tag.getElementsByTagName("method"):
1413
if cn.getAttribute("name") == "Get":
1414
for arg in cn.getElementsByTagName("arg"):
1415
if (arg.getAttribute("direction")
1417
arg.setAttribute("name", "value")
1418
elif cn.getAttribute("name") == "GetAll":
1419
for arg in cn.getElementsByTagName("arg"):
1420
if (arg.getAttribute("direction")
1422
arg.setAttribute("name", "props")
1423
xmlstring = document.toxml("utf-8")
1425
except (AttributeError, xml.dom.DOMException,
1426
xml.parsers.expat.ExpatError) as error:
1427
logger.error("Failed to override Introspection method",
1432
dbus.OBJECT_MANAGER_IFACE
1433
except AttributeError:
1434
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1436
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1437
"""A D-Bus object with an ObjectManager.
1439
Classes inheriting from this exposes the standard
1440
GetManagedObjects call and the InterfacesAdded and
1441
InterfacesRemoved signals on the standard
1442
"org.freedesktop.DBus.ObjectManager" interface.
1444
Note: No signals are sent automatically; they must be sent
1447
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1448
out_signature = "a{oa{sa{sv}}}")
1449
def GetManagedObjects(self):
1450
"""This function must be overridden"""
1451
raise NotImplementedError()
1453
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1454
signature = "oa{sa{sv}}")
1455
def InterfacesAdded(self, object_path, interfaces_and_properties):
1458
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1459
def InterfacesRemoved(self, object_path, interfaces):
1462
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1463
out_signature = "s",
1464
path_keyword = 'object_path',
1465
connection_keyword = 'connection')
1466
def Introspect(self, object_path, connection):
1467
"""Overloading of standard D-Bus method.
1469
Override return argument name of GetManagedObjects to be
1470
"objpath_interfaces_and_properties"
1472
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1476
document = xml.dom.minidom.parseString(xmlstring)
1478
for if_tag in document.getElementsByTagName("interface"):
1479
# Fix argument name for the GetManagedObjects method
1480
if (if_tag.getAttribute("name")
1481
== dbus.OBJECT_MANAGER_IFACE):
1482
for cn in if_tag.getElementsByTagName("method"):
1483
if (cn.getAttribute("name")
1484
== "GetManagedObjects"):
1485
for arg in cn.getElementsByTagName("arg"):
1486
if (arg.getAttribute("direction")
1490
"objpath_interfaces"
1492
xmlstring = document.toxml("utf-8")
1494
except (AttributeError, xml.dom.DOMException,
1495
xml.parsers.expat.ExpatError) as error:
1496
logger.error("Failed to override Introspection method",
1500
def datetime_to_dbus(dt, variant_level=0):
1501
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1503
return dbus.String("", variant_level = variant_level)
1504
return dbus.String(dt.isoformat(), variant_level=variant_level)
1507
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1508
"""A class decorator; applied to a subclass of
1509
dbus.service.Object, it will add alternate D-Bus attributes with
1510
interface names according to the "alt_interface_names" mapping.
1513
@alternate_dbus_interfaces({"org.example.Interface":
1514
"net.example.AlternateInterface"})
1515
class SampleDBusObject(dbus.service.Object):
1516
@dbus.service.method("org.example.Interface")
1517
def SampleDBusMethod():
1520
The above "SampleDBusMethod" on "SampleDBusObject" will be
1521
reachable via two interfaces: "org.example.Interface" and
1522
"net.example.AlternateInterface", the latter of which will have
1523
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1524
"true", unless "deprecate" is passed with a False value.
1526
This works for methods and signals, and also for D-Bus properties
1527
(from DBusObjectWithProperties) and interfaces (from the
1528
dbus_interface_annotations decorator).
1532
for orig_interface_name, alt_interface_name in (
1533
alt_interface_names.items()):
1535
interface_names = set()
1536
# Go though all attributes of the class
1537
for attrname, attribute in inspect.getmembers(cls):
1538
# Ignore non-D-Bus attributes, and D-Bus attributes
1539
# with the wrong interface name
1540
if (not hasattr(attribute, "_dbus_interface")
1541
or not attribute._dbus_interface.startswith(
1542
orig_interface_name)):
1544
# Create an alternate D-Bus interface name based on
1546
alt_interface = attribute._dbus_interface.replace(
1547
orig_interface_name, alt_interface_name)
1548
interface_names.add(alt_interface)
1549
# Is this a D-Bus signal?
1550
if getattr(attribute, "_dbus_is_signal", False):
1551
# Extract the original non-method undecorated
1552
# function by black magic
1553
if sys.version_info.major == 2:
1554
nonmethod_func = (dict(
1555
zip(attribute.func_code.co_freevars,
1556
attribute.__closure__))
1557
["func"].cell_contents)
1559
nonmethod_func = (dict(
1560
zip(attribute.__code__.co_freevars,
1561
attribute.__closure__))
1562
["func"].cell_contents)
1563
# Create a new, but exactly alike, function
1564
# object, and decorate it to be a new D-Bus signal
1565
# with the alternate D-Bus interface name
1566
new_function = copy_function(nonmethod_func)
1567
new_function = (dbus.service.signal(
1569
attribute._dbus_signature)(new_function))
1570
# Copy annotations, if any
1572
new_function._dbus_annotations = dict(
1573
attribute._dbus_annotations)
1574
except AttributeError:
1576
# Define a creator of a function to call both the
1577
# original and alternate functions, so both the
1578
# original and alternate signals gets sent when
1579
# the function is called
1580
def fixscope(func1, func2):
1581
"""This function is a scope container to pass
1582
func1 and func2 to the "call_both" function
1583
outside of its arguments"""
1585
@functools.wraps(func2)
1586
def call_both(*args, **kwargs):
1587
"""This function will emit two D-Bus
1588
signals by calling func1 and func2"""
1589
func1(*args, **kwargs)
1590
func2(*args, **kwargs)
1591
# Make wrapper function look like a D-Bus signal
1592
for name, attr in inspect.getmembers(func2):
1593
if name.startswith("_dbus_"):
1594
setattr(call_both, name, attr)
1597
# Create the "call_both" function and add it to
1599
attr[attrname] = fixscope(attribute, new_function)
1600
# Is this a D-Bus method?
1601
elif getattr(attribute, "_dbus_is_method", False):
1602
# Create a new, but exactly alike, function
1603
# object. Decorate it to be a new D-Bus method
1604
# with the alternate D-Bus interface name. Add it
1607
dbus.service.method(
1609
attribute._dbus_in_signature,
1610
attribute._dbus_out_signature)
1611
(copy_function(attribute)))
1612
# Copy annotations, if any
1614
attr[attrname]._dbus_annotations = dict(
1615
attribute._dbus_annotations)
1616
except AttributeError:
1618
# Is this a D-Bus property?
1619
elif getattr(attribute, "_dbus_is_property", False):
1620
# Create a new, but exactly alike, function
1621
# object, and decorate it to be a new D-Bus
1622
# property with the alternate D-Bus interface
1623
# name. Add it to the class.
1624
attr[attrname] = (dbus_service_property(
1625
alt_interface, attribute._dbus_signature,
1626
attribute._dbus_access,
1627
attribute._dbus_get_args_options
1629
(copy_function(attribute)))
1630
# Copy annotations, if any
1632
attr[attrname]._dbus_annotations = dict(
1633
attribute._dbus_annotations)
1634
except AttributeError:
1636
# Is this a D-Bus interface?
1637
elif getattr(attribute, "_dbus_is_interface", False):
1638
# Create a new, but exactly alike, function
1639
# object. Decorate it to be a new D-Bus interface
1640
# with the alternate D-Bus interface name. Add it
1643
dbus_interface_annotations(alt_interface)
1644
(copy_function(attribute)))
1646
# Deprecate all alternate interfaces
1647
iname="_AlternateDBusNames_interface_annotation{}"
1648
for interface_name in interface_names:
1650
@dbus_interface_annotations(interface_name)
1652
return { "org.freedesktop.DBus.Deprecated":
1654
# Find an unused name
1655
for aname in (iname.format(i)
1656
for i in itertools.count()):
1657
if aname not in attr:
1661
# Replace the class with a new subclass of it with
1662
# methods, signals, etc. as created above.
1663
if sys.version_info.major == 2:
1664
cls = type(b"{}Alternate".format(cls.__name__),
1667
cls = type("{}Alternate".format(cls.__name__),
1674
@alternate_dbus_interfaces({"se.recompile.Mandos":
1675
"se.bsnet.fukt.Mandos"})
1676
class ClientDBus(Client, DBusObjectWithProperties):
481
1677
"""A Client class using D-Bus
484
1680
dbus_object_path: dbus.ObjectPath
485
1681
bus: dbus.SystemBus()
1684
runtime_expansions = (Client.runtime_expansions
1685
+ ("dbus_object_path", ))
1687
_interface = "se.recompile.Mandos.Client"
487
1689
# dbus.service.Object doesn't use super(), so we can't either.
489
1691
def __init__(self, bus = None, *args, **kwargs):
491
1693
Client.__init__(self, *args, **kwargs)
492
1694
# Only now, when this client is initialized, can it show up on
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))
1696
client_object_name = str(self.name).translate(
1697
{ord("."): ord("_"),
1698
ord("-"): ord("_")})
1699
self.dbus_object_path = dbus.ObjectPath(
1700
"/clients/" + client_object_name)
1701
DBusObjectWithProperties.__init__(self, self.bus,
1702
self.dbus_object_path)
1704
def notifychangeproperty(transform_func, dbus_name,
1705
type_func=lambda x: x,
1707
invalidate_only=False,
1708
_interface=_interface):
1709
""" Modify a variable so that it's a property which announces
1710
its changes to DBus.
1712
transform_fun: Function that takes a value and a variant_level
1713
and transforms it to a D-Bus type.
1714
dbus_name: D-Bus name of the variable
1715
type_func: Function that transform the value before sending it
1716
to the D-Bus. Default: no transform
1717
variant_level: D-Bus variant level. Default: 1
1719
attrname = "_{}".format(dbus_name)
1721
def setter(self, value):
1722
if hasattr(self, "dbus_object_path"):
1723
if (not hasattr(self, attrname) or
1724
type_func(getattr(self, attrname, None))
1725
!= type_func(value)):
1727
self.PropertiesChanged(
1728
_interface, dbus.Dictionary(),
1729
dbus.Array((dbus_name, )))
1731
dbus_value = transform_func(
1733
variant_level = variant_level)
1734
self.PropertyChanged(dbus.String(dbus_name),
1736
self.PropertiesChanged(
1738
dbus.Dictionary({ dbus.String(dbus_name):
1741
setattr(self, attrname, value)
1743
return property(lambda self: getattr(self, attrname), setter)
1745
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1746
approvals_pending = notifychangeproperty(dbus.Boolean,
1749
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1750
last_enabled = notifychangeproperty(datetime_to_dbus,
1752
checker = notifychangeproperty(
1753
dbus.Boolean, "CheckerRunning",
1754
type_func = lambda checker: checker is not None)
1755
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1757
last_checker_status = notifychangeproperty(dbus.Int16,
1758
"LastCheckerStatus")
1759
last_approval_request = notifychangeproperty(
1760
datetime_to_dbus, "LastApprovalRequest")
1761
approved_by_default = notifychangeproperty(dbus.Boolean,
1762
"ApprovedByDefault")
1763
approval_delay = notifychangeproperty(
1764
dbus.UInt64, "ApprovalDelay",
1765
type_func = lambda td: td.total_seconds() * 1000)
1766
approval_duration = notifychangeproperty(
1767
dbus.UInt64, "ApprovalDuration",
1768
type_func = lambda td: td.total_seconds() * 1000)
1769
host = notifychangeproperty(dbus.String, "Host")
1770
timeout = notifychangeproperty(
1771
dbus.UInt64, "Timeout",
1772
type_func = lambda td: td.total_seconds() * 1000)
1773
extended_timeout = notifychangeproperty(
1774
dbus.UInt64, "ExtendedTimeout",
1775
type_func = lambda td: td.total_seconds() * 1000)
1776
interval = notifychangeproperty(
1777
dbus.UInt64, "Interval",
1778
type_func = lambda td: td.total_seconds() * 1000)
1779
checker_command = notifychangeproperty(dbus.String, "Checker")
1780
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1781
invalidate_only=True)
1783
del notifychangeproperty
528
1785
def __del__(self, *args, **kwargs):
530
1787
self.remove_from_connection()
531
1788
except LookupError:
533
if hasattr(dbus.service.Object, u"__del__"):
534
dbus.service.Object.__del__(self, *args, **kwargs)
1790
if hasattr(DBusObjectWithProperties, "__del__"):
1791
DBusObjectWithProperties.__del__(self, *args, **kwargs)
535
1792
Client.__del__(self, *args, **kwargs)
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)
1794
def checker_callback(self, source, condition,
1795
connection, command, *args, **kwargs):
1796
ret = Client.checker_callback(self, source, condition,
1797
connection, command, *args,
1799
exitstatus = self.last_checker_status
546
1801
# Emit D-Bus signal
547
1802
self.CheckerCompleted(dbus.Int16(exitstatus),
548
dbus.Int64(condition),
1803
# This is specific to GNU libC
1804
dbus.Int64(exitstatus << 8),
549
1805
dbus.String(command))
551
1807
# Emit D-Bus signal
552
1808
self.CheckerCompleted(dbus.Int16(-1),
553
dbus.Int64(condition),
1810
# This is specific to GNU libC
1812
| self.last_checker_signal),
554
1813
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,
568
1816
def start_checker(self, *args, **kwargs):
569
old_checker = self.checker
570
if self.checker is not None:
571
old_checker_pid = self.checker.pid
573
old_checker_pid = None
1817
old_checker_pid = getattr(self.checker, "pid", None)
574
1818
r = Client.start_checker(self, *args, **kwargs)
575
1819
# Only if new checker process was started
576
1820
if (self.checker is not None
577
1821
and old_checker_pid != self.checker.pid):
578
1822
# Emit D-Bus signal
579
1823
self.CheckerStarted(self.current_checker_command)
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()
1826
def _reset_approved(self):
1827
self.approved = None
1830
def approve(self, value=True):
1831
self.approved = value
1832
GLib.timeout_add(int(self.approval_duration.total_seconds()
1833
* 1000), self._reset_approved)
1834
self.send_changedstate()
1836
## D-Bus methods, signals & properties
602
1842
# CheckerCompleted - signal
603
@dbus.service.signal(_interface, signature=u"nxs")
1843
@dbus.service.signal(_interface, signature="nxs")
604
1844
def CheckerCompleted(self, exitcode, waitstatus, command):
608
1848
# CheckerStarted - signal
609
@dbus.service.signal(_interface, signature=u"s")
1849
@dbus.service.signal(_interface, signature="s")
610
1850
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()
662
1854
# PropertyChanged - signal
663
@dbus.service.signal(_interface, signature=u"sv")
1855
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1856
@dbus.service.signal(_interface, signature="sv")
664
1857
def PropertyChanged(self, property, value):
668
# ReceivedSecret - signal
1861
# GotSecret - signal
669
1862
@dbus.service.signal(_interface)
670
def ReceivedSecret(self):
1863
def GotSecret(self):
1865
Is sent after a successful transfer of secret from the Mandos
1866
server to mandos-client
674
1870
# Rejected - signal
675
@dbus.service.signal(_interface)
1871
@dbus.service.signal(_interface, signature="s")
1872
def Rejected(self, reason):
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(),
1876
# NeedApproval - signal
1877
@dbus.service.signal(_interface, signature="tb")
1878
def NeedApproval(self, timeout, default):
1880
return self.need_approval()
1885
@dbus.service.method(_interface, in_signature="b")
1886
def Approve(self, value):
1889
# CheckedOK - method
1890
@dbus.service.method(_interface)
1891
def CheckedOK(self):
724
1894
# Enable - method
1895
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
725
1896
@dbus.service.method(_interface)
726
1897
def Enable(self):
730
1901
# StartChecker - method
1902
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
731
1903
@dbus.service.method(_interface)
732
1904
def StartChecker(self):
734
1906
self.start_checker()
736
1908
# Disable - method
1909
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
737
1910
@dbus.service.method(_interface)
738
1911
def Disable(self):
742
1915
# StopChecker - method
1916
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
743
1917
@dbus.service.method(_interface)
744
1918
def StopChecker(self):
745
1919
self.stop_checker()
1923
# ApprovalPending - property
1924
@dbus_service_property(_interface, signature="b", access="read")
1925
def ApprovalPending_dbus_property(self):
1926
return dbus.Boolean(bool(self.approvals_pending))
1928
# ApprovedByDefault - property
1929
@dbus_service_property(_interface,
1932
def ApprovedByDefault_dbus_property(self, value=None):
1933
if value is None: # get
1934
return dbus.Boolean(self.approved_by_default)
1935
self.approved_by_default = bool(value)
1937
# ApprovalDelay - property
1938
@dbus_service_property(_interface,
1941
def ApprovalDelay_dbus_property(self, value=None):
1942
if value is None: # get
1943
return dbus.UInt64(self.approval_delay.total_seconds()
1945
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1947
# ApprovalDuration - property
1948
@dbus_service_property(_interface,
1951
def ApprovalDuration_dbus_property(self, value=None):
1952
if value is None: # get
1953
return dbus.UInt64(self.approval_duration.total_seconds()
1955
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1959
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1960
@dbus_service_property(_interface, signature="s", access="read")
1961
def Name_dbus_property(self):
1962
return dbus.String(self.name)
1964
# Fingerprint - property
1966
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1967
@dbus_service_property(_interface, signature="s", access="read")
1968
def Fingerprint_dbus_property(self):
1969
return dbus.String(self.fingerprint)
1972
@dbus_service_property(_interface,
1975
def Host_dbus_property(self, value=None):
1976
if value is None: # get
1977
return dbus.String(self.host)
1978
self.host = str(value)
1980
# Created - property
1982
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1983
@dbus_service_property(_interface, signature="s", access="read")
1984
def Created_dbus_property(self):
1985
return datetime_to_dbus(self.created)
1987
# LastEnabled - property
1988
@dbus_service_property(_interface, signature="s", access="read")
1989
def LastEnabled_dbus_property(self):
1990
return datetime_to_dbus(self.last_enabled)
1992
# Enabled - property
1993
@dbus_service_property(_interface,
1996
def Enabled_dbus_property(self, value=None):
1997
if value is None: # get
1998
return dbus.Boolean(self.enabled)
2004
# LastCheckedOK - property
2005
@dbus_service_property(_interface,
2008
def LastCheckedOK_dbus_property(self, value=None):
2009
if value is not None:
2012
return datetime_to_dbus(self.last_checked_ok)
2014
# LastCheckerStatus - property
2015
@dbus_service_property(_interface, signature="n", access="read")
2016
def LastCheckerStatus_dbus_property(self):
2017
return dbus.Int16(self.last_checker_status)
2019
# Expires - property
2020
@dbus_service_property(_interface, signature="s", access="read")
2021
def Expires_dbus_property(self):
2022
return datetime_to_dbus(self.expires)
2024
# LastApprovalRequest - property
2025
@dbus_service_property(_interface, signature="s", access="read")
2026
def LastApprovalRequest_dbus_property(self):
2027
return datetime_to_dbus(self.last_approval_request)
2029
# Timeout - property
2030
@dbus_service_property(_interface,
2033
def Timeout_dbus_property(self, value=None):
2034
if value is None: # get
2035
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2036
old_timeout = self.timeout
2037
self.timeout = datetime.timedelta(0, 0, 0, value)
2038
# Reschedule disabling
2040
now = datetime.datetime.utcnow()
2041
self.expires += self.timeout - old_timeout
2042
if self.expires <= now:
2043
# The timeout has passed
2046
if (getattr(self, "disable_initiator_tag", None)
2049
GLib.source_remove(self.disable_initiator_tag)
2050
self.disable_initiator_tag = GLib.timeout_add(
2051
int((self.expires - now).total_seconds() * 1000),
2054
# ExtendedTimeout - property
2055
@dbus_service_property(_interface,
2058
def ExtendedTimeout_dbus_property(self, value=None):
2059
if value is None: # get
2060
return dbus.UInt64(self.extended_timeout.total_seconds()
2062
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2064
# Interval - property
2065
@dbus_service_property(_interface,
2068
def Interval_dbus_property(self, value=None):
2069
if value is None: # get
2070
return dbus.UInt64(self.interval.total_seconds() * 1000)
2071
self.interval = datetime.timedelta(0, 0, 0, value)
2072
if getattr(self, "checker_initiator_tag", None) is None:
2075
# Reschedule checker run
2076
GLib.source_remove(self.checker_initiator_tag)
2077
self.checker_initiator_tag = GLib.timeout_add(
2078
value, self.start_checker)
2079
self.start_checker() # Start one now, too
2081
# Checker - property
2082
@dbus_service_property(_interface,
2085
def Checker_dbus_property(self, value=None):
2086
if value is None: # get
2087
return dbus.String(self.checker_command)
2088
self.checker_command = str(value)
2090
# CheckerRunning - property
2091
@dbus_service_property(_interface,
2094
def CheckerRunning_dbus_property(self, value=None):
2095
if value is None: # get
2096
return dbus.Boolean(self.checker is not None)
2098
self.start_checker()
2102
# ObjectPath - property
2104
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2105
"org.freedesktop.DBus.Deprecated": "true"})
2106
@dbus_service_property(_interface, signature="o", access="read")
2107
def ObjectPath_dbus_property(self):
2108
return self.dbus_object_path # is already a dbus.ObjectPath
2112
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2114
@dbus_service_property(_interface,
2118
def Secret_dbus_property(self, value):
2119
self.secret = bytes(value)
2124
class ProxyClient(object):
2125
def __init__(self, child_pipe, fpr, address):
2126
self._pipe = child_pipe
2127
self._pipe.send(('init', fpr, address))
2128
if not self._pipe.recv():
2131
def __getattribute__(self, name):
2133
return super(ProxyClient, self).__getattribute__(name)
2134
self._pipe.send(('getattr', name))
2135
data = self._pipe.recv()
2136
if data[0] == 'data':
2138
if data[0] == 'function':
2140
def func(*args, **kwargs):
2141
self._pipe.send(('funcall', name, args, kwargs))
2142
return self._pipe.recv()[1]
2146
def __setattr__(self, name, value):
2148
return super(ProxyClient, self).__setattr__(name, value)
2149
self._pipe.send(('setattr', name, value))
750
2152
class ClientHandler(socketserver.BaseRequestHandler, object):
751
2153
"""A class to handle client connections.
754
2156
Note: This will run in its own forked process."""
756
2158
def handle(self):
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",
2159
with contextlib.closing(self.server.child_pipe) as child_pipe:
2160
logger.info("TCP connection from: %s",
2161
str(self.client_address))
2162
logger.debug("Pipe FD: %d",
2163
self.server.child_pipe.fileno())
2165
session = gnutls.ClientSession(self.request)
2167
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2168
# "+AES-256-CBC", "+SHA1",
2169
# "+COMP-NULL", "+CTYPE-OPENPGP",
785
2171
# Use a fallback default, since this MUST be set.
786
2172
priority = self.server.gnutls_priority
787
2173
if priority is None:
789
(gnutls.library.functions
790
.gnutls_priority_set_direct(session._c_object,
2175
gnutls.priority_set_direct(session._c_object, priority,
2178
# Start communication using the Mandos protocol
2179
# Get protocol number
2180
line = self.request.makefile().readline()
2181
logger.debug("Protocol version: %r", line)
2183
if int(line.strip().split()[0]) > 1:
2184
raise RuntimeError(line)
2185
except (ValueError, IndexError, RuntimeError) as error:
2186
logger.error("Unknown protocol version: %s", error)
2189
# Start GnuTLS connection
794
2191
session.handshake()
795
except gnutls.errors.GNUTLSError, error:
796
logger.warning(u"Handshake failed: %s", error)
2192
except gnutls.Error as error:
2193
logger.warning("Handshake failed: %s", error)
797
2194
# Do not run session.bye() here: the session is not
798
2195
# established. Just abandon the request.
800
logger.debug(u"Handshake succeeded")
2197
logger.debug("Handshake succeeded")
2199
approval_required = False
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)
2202
fpr = self.fingerprint(
2203
self.peer_certificate(session))
2204
except (TypeError, gnutls.Error) as error:
2205
logger.warning("Bad certificate: %s", error)
2207
logger.debug("Fingerprint: %s", fpr)
2210
client = ProxyClient(child_pipe, fpr,
2211
self.client_address)
2215
if client.approval_delay:
2216
delay = client.approval_delay
2217
client.approvals_pending += 1
2218
approval_required = True
2221
if not client.enabled:
2222
logger.info("Client %s is disabled",
2224
if self.server.use_dbus:
2226
client.Rejected("Disabled")
2229
if client.approved or not client.approval_delay:
2230
#We are approved or approval is disabled
2232
elif client.approved is None:
2233
logger.info("Client %s needs approval",
2235
if self.server.use_dbus:
2237
client.NeedApproval(
2238
client.approval_delay.total_seconds()
2239
* 1000, client.approved_by_default)
2241
logger.warning("Client %s was not approved",
2243
if self.server.use_dbus:
2245
client.Rejected("Denied")
2248
#wait until timeout or approved
2249
time = datetime.datetime.now()
2250
client.changedstate.acquire()
2251
client.changedstate.wait(delay.total_seconds())
2252
client.changedstate.release()
2253
time2 = datetime.datetime.now()
2254
if (time2 - time) >= delay:
2255
if not client.approved_by_default:
2256
logger.warning("Client %s timed out while"
2257
" waiting for approval",
2259
if self.server.use_dbus:
2261
client.Rejected("Approval timed out")
2266
delay -= time2 - time
2269
session.send(client.secret)
2270
except gnutls.Error as error:
2271
logger.warning("gnutls send failed",
2275
logger.info("Sending secret to %s", client.name)
2276
# bump the timeout using extended_timeout
2277
client.bump_timeout(client.extended_timeout)
2278
if self.server.use_dbus:
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))
2283
if approval_required:
2284
client.approvals_pending -= 1
2287
except gnutls.Error as error:
2288
logger.warning("GnuTLS bye failed",
836
2292
def peer_certificate(session):
837
2293
"Return the peer's OpenPGP certificate as a bytestring"
838
2294
# If not an OpenPGP certificate...
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
2295
if (gnutls.certificate_type_get(session._c_object)
2296
!= gnutls.CRT_OPENPGP):
2297
# ...return invalid data
844
2299
list_size = ctypes.c_uint(1)
845
cert_list = (gnutls.library.functions
846
.gnutls_certificate_get_peers
2300
cert_list = (gnutls.certificate_get_peers
847
2301
(session._c_object, ctypes.byref(list_size)))
848
2302
if not bool(cert_list) and list_size.value != 0:
849
raise gnutls.errors.GNUTLSError(u"error getting peer"
2303
raise gnutls.Error("error getting peer certificate")
851
2304
if list_size.value == 0:
853
2306
cert = cert_list[0]
983
2483
clients: set of Client objects
984
2484
gnutls_priority GnuTLS priority string
985
2485
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
990
Assumes a gobject.MainLoop event loop.
2487
Assumes a GLib.MainLoop event loop.
992
2490
def __init__(self, server_address, RequestHandlerClass,
993
interface=None, use_ipv6=True, clients=None,
994
gnutls_priority=None, use_dbus=True):
2494
gnutls_priority=None,
995
2497
self.enabled = False
996
2498
self.clients = clients
997
2499
if self.clients is None:
999
2501
self.use_dbus = use_dbus
1000
2502
self.gnutls_priority = gnutls_priority
1001
2503
IPv6_TCPServer.__init__(self, server_address,
1002
2504
RequestHandlerClass,
1003
2505
interface = interface,
1004
use_ipv6 = use_ipv6)
2506
use_ipv6 = use_ipv6,
2507
socketfd = socketfd)
1005
2509
def server_activate(self):
1006
2510
if self.enabled:
1007
2511
return socketserver.TCPServer.server_activate(self)
1008
2513
def enable(self):
1009
2514
self.enabled = True
1010
def add_pipe(self, pipe):
2516
def add_pipe(self, parent_pipe, proc):
1011
2517
# Call "handle_ipc" for both data and EOF events
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",
2519
parent_pipe.fileno(),
2520
GLib.IO_IN | GLib.IO_HUP,
2521
functools.partial(self.handle_ipc,
2522
parent_pipe = parent_pipe,
2525
def handle_ipc(self, source, condition,
2528
client_object=None):
2529
# error, or the other end of multiprocessing.Pipe has closed
2530
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2531
# Wait for other process to exit
2535
# Read a request from the child
2536
request = parent_pipe.recv()
2537
command = request[0]
2539
if command == 'init':
2541
address = request[2]
2543
for c in self.clients.values():
2544
if c.fingerprint == fpr:
2548
logger.info("Client not found for fingerprint: %s, ad"
2549
"dress: %s", fpr, address)
2552
mandos_dbus_service.ClientNotFound(fpr,
2554
parent_pipe.send(False)
2558
parent_pipe.fileno(),
2559
GLib.IO_IN | GLib.IO_HUP,
2560
functools.partial(self.handle_ipc,
2561
parent_pipe = parent_pipe,
2563
client_object = client))
2564
parent_pipe.send(True)
2565
# remove the old hook in favor of the new above hook on
2568
if command == 'funcall':
2569
funcname = request[1]
2573
parent_pipe.send(('data', getattr(client_object,
2577
if command == 'getattr':
2578
attrname = request[1]
2579
if isinstance(client_object.__getattribute__(attrname),
2580
collections.Callable):
2581
parent_pipe.send(('function', ))
2584
'data', client_object.__getattribute__(attrname)))
2586
if command == 'setattr':
2587
attrname = request[1]
2589
setattr(client_object, attrname, value)
2594
def rfc3339_duration_to_delta(duration):
2595
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2597
>>> rfc3339_duration_to_delta("P7D")
2598
datetime.timedelta(7)
2599
>>> rfc3339_duration_to_delta("PT60S")
2600
datetime.timedelta(0, 60)
2601
>>> rfc3339_duration_to_delta("PT60M")
2602
datetime.timedelta(0, 3600)
2603
>>> rfc3339_duration_to_delta("PT24H")
2604
datetime.timedelta(1)
2605
>>> rfc3339_duration_to_delta("P1W")
2606
datetime.timedelta(7)
2607
>>> rfc3339_duration_to_delta("PT5M30S")
2608
datetime.timedelta(0, 330)
2609
>>> rfc3339_duration_to_delta("P1DT3M20S")
2610
datetime.timedelta(1, 200)
2613
# Parsing an RFC 3339 duration with regular expressions is not
2614
# possible - there would have to be multiple places for the same
2615
# values, like seconds. The current code, while more esoteric, is
2616
# cleaner without depending on a parsing library. If Python had a
2617
# built-in library for parsing we would use it, but we'd like to
2618
# avoid excessive use of external libraries.
2620
# New type for defining tokens, syntax, and semantics all-in-one
2621
Token = collections.namedtuple("Token", (
2622
"regexp", # To match token; if "value" is not None, must have
2623
# a "group" containing digits
2624
"value", # datetime.timedelta or None
2625
"followers")) # Tokens valid after this token
2626
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2627
# the "duration" ABNF definition in RFC 3339, Appendix A.
2628
token_end = Token(re.compile(r"$"), None, frozenset())
2629
token_second = Token(re.compile(r"(\d+)S"),
2630
datetime.timedelta(seconds=1),
2631
frozenset((token_end, )))
2632
token_minute = Token(re.compile(r"(\d+)M"),
2633
datetime.timedelta(minutes=1),
2634
frozenset((token_second, token_end)))
2635
token_hour = Token(re.compile(r"(\d+)H"),
2636
datetime.timedelta(hours=1),
2637
frozenset((token_minute, token_end)))
2638
token_time = Token(re.compile(r"T"),
2640
frozenset((token_hour, token_minute,
2642
token_day = Token(re.compile(r"(\d+)D"),
2643
datetime.timedelta(days=1),
2644
frozenset((token_time, token_end)))
2645
token_month = Token(re.compile(r"(\d+)M"),
2646
datetime.timedelta(weeks=4),
2647
frozenset((token_day, token_end)))
2648
token_year = Token(re.compile(r"(\d+)Y"),
2649
datetime.timedelta(weeks=52),
2650
frozenset((token_month, token_end)))
2651
token_week = Token(re.compile(r"(\d+)W"),
2652
datetime.timedelta(weeks=1),
2653
frozenset((token_end, )))
2654
token_duration = Token(re.compile(r"P"), None,
2655
frozenset((token_year, token_month,
2656
token_day, token_time,
2658
# Define starting values
2659
value = datetime.timedelta() # Value so far
2661
followers = frozenset((token_duration, )) # Following valid tokens
2662
s = duration # String left to parse
2663
# Loop until end token is found
2664
while found_token is not token_end:
2665
# Search for any currently valid tokens
2666
for token in followers:
2667
match = token.regexp.match(s)
2668
if match is not None:
2670
if token.value is not None:
2671
# Value found, parse digits
2672
factor = int(match.group(1), 10)
2673
# Add to value so far
2674
value += factor * token.value
2675
# Strip token from string
2676
s = token.regexp.sub("", s, 1)
2679
# Set valid next tokens
2680
followers = found_token.followers
1080
logger.error(u"Unknown IPC command: %r", cmdline)
1082
# Keep calling this function
2683
# No currently valid tokens were found
2684
raise ValueError("Invalid RFC 3339 duration: {!r}"
1086
2690
def string_to_delta(interval):
1087
2691
"""Parse a string and return a datetime.timedelta
1089
>>> string_to_delta(u'7d')
2693
>>> string_to_delta('7d')
1090
2694
datetime.timedelta(7)
1091
>>> string_to_delta(u'60s')
2695
>>> string_to_delta('60s')
1092
2696
datetime.timedelta(0, 60)
1093
>>> string_to_delta(u'60m')
2697
>>> string_to_delta('60m')
1094
2698
datetime.timedelta(0, 3600)
1095
>>> string_to_delta(u'24h')
2699
>>> string_to_delta('24h')
1096
2700
datetime.timedelta(1)
1097
>>> string_to_delta(u'1w')
2701
>>> string_to_delta('1w')
1098
2702
datetime.timedelta(7)
1099
>>> string_to_delta(u'5m 30s')
2703
>>> string_to_delta('5m 30s')
1100
2704
datetime.timedelta(0, 330)
2708
return rfc3339_duration_to_delta(interval)
1102
2712
timevalue = datetime.timedelta(0)
1103
2713
for s in interval.split():
1105
suffix = unicode(s[-1])
1106
2716
value = int(s[:-1])
1108
2718
delta = datetime.timedelta(value)
1109
elif suffix == u"s":
1110
2720
delta = datetime.timedelta(0, value)
1111
elif suffix == u"m":
1112
2722
delta = datetime.timedelta(0, 0, 0, 0, value)
1113
elif suffix == u"h":
1114
2724
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1115
elif suffix == u"w":
1116
2726
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1119
except (ValueError, IndexError):
2728
raise ValueError("Unknown suffix {!r}".format(suffix))
2729
except IndexError as e:
2730
raise ValueError(*(e.args))
1121
2731
timevalue += delta
1122
2732
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)
1149
2735
def daemon(nochdir = False, noclose = False):
1150
2736
"""See daemon(3). Standard BSD Unix function.
1175
######################################################################
2762
##################################################################
1176
2763
# Parsing of options, both command line and config file
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",
1200
help=optparse.SUPPRESS_HELP) # XXX: Not done yet
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]
2765
parser = argparse.ArgumentParser()
2766
parser.add_argument("-v", "--version", action="version",
2767
version = "%(prog)s {}".format(version),
2768
help="show version number and exit")
2769
parser.add_argument("-i", "--interface", metavar="IF",
2770
help="Bind to interface IF")
2771
parser.add_argument("-a", "--address",
2772
help="Address to listen for requests on")
2773
parser.add_argument("-p", "--port", type=int,
2774
help="Port number to receive requests on")
2775
parser.add_argument("--check", action="store_true",
2776
help="Run self-test")
2777
parser.add_argument("--debug", action="store_true",
2778
help="Debug mode; run in foreground and log"
2779
" to terminal", default=None)
2780
parser.add_argument("--debuglevel", metavar="LEVEL",
2781
help="Debug level for stdout output")
2782
parser.add_argument("--priority", help="GnuTLS"
2783
" priority string (see GnuTLS documentation)")
2784
parser.add_argument("--servicename",
2785
metavar="NAME", help="Zeroconf service name")
2786
parser.add_argument("--configdir",
2787
default="/etc/mandos", metavar="DIR",
2788
help="Directory to search for configuration"
2790
parser.add_argument("--no-dbus", action="store_false",
2791
dest="use_dbus", help="Do not provide D-Bus"
2792
" system bus interface", default=None)
2793
parser.add_argument("--no-ipv6", action="store_false",
2794
dest="use_ipv6", help="Do not use IPv6",
2796
parser.add_argument("--no-restore", action="store_false",
2797
dest="restore", help="Do not restore stored"
2798
" state", default=None)
2799
parser.add_argument("--socket", type=int,
2800
help="Specify a file descriptor to a network"
2801
" socket to use instead of creating one")
2802
parser.add_argument("--statedir", metavar="DIR",
2803
help="Directory to save/restore state in")
2804
parser.add_argument("--foreground", action="store_true",
2805
help="Run in foreground", default=None)
2806
parser.add_argument("--no-zeroconf", action="store_false",
2807
dest="zeroconf", help="Do not use Zeroconf",
2810
options = parser.parse_args()
1205
2812
if options.check:
2814
fail_count, test_count = doctest.testmod()
2815
sys.exit(os.EX_OK if fail_count == 0 else 1)
1210
2817
# Default values for config file for server-global settings
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",
2818
server_defaults = { "interface": "",
2823
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2824
":+SIGN-DSA-SHA256",
2825
"servicename": "Mandos",
2831
"statedir": "/var/lib/mandos",
2832
"foreground": "False",
1222
2836
# Parse config file for server-global settings
1223
2837
server_config = configparser.SafeConfigParser(server_defaults)
1224
2838
del server_defaults
1225
server_config.read(os.path.join(options.configdir,
2839
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1227
2840
# Convert the SafeConfigParser object to a dict
1228
2841
server_settings = server_config.defaults()
1229
2842
# Use the appropriate methods on the non-string config options
1230
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1231
server_settings[option] = server_config.getboolean(u"DEFAULT",
2843
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2844
server_settings[option] = server_config.getboolean("DEFAULT",
1233
2846
if server_settings["port"]:
1234
server_settings["port"] = server_config.getint(u"DEFAULT",
2847
server_settings["port"] = server_config.getint("DEFAULT",
2849
if server_settings["socket"]:
2850
server_settings["socket"] = server_config.getint("DEFAULT",
2852
# Later, stdin will, and stdout and stderr might, be dup'ed
2853
# over with an opened os.devnull. But we don't want this to
2854
# happen with a supplied network socket.
2855
if 0 <= server_settings["socket"] <= 2:
2856
server_settings["socket"] = os.dup(server_settings
1236
2858
del server_config
1238
2860
# Override the settings from the config file with command line
1239
2861
# options, if set.
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"):
2862
for option in ("interface", "address", "port", "debug",
2863
"priority", "servicename", "configdir", "use_dbus",
2864
"use_ipv6", "debuglevel", "restore", "statedir",
2865
"socket", "foreground", "zeroconf"):
1243
2866
value = getattr(options, option)
1244
2867
if value is not None:
1245
2868
server_settings[option] = value
1247
2870
# Force all strings to be unicode
1248
2871
for option in server_settings.keys():
1249
if type(server_settings[option]) is str:
1250
server_settings[option] = unicode(server_settings[option])
2872
if isinstance(server_settings[option], bytes):
2873
server_settings[option] = (server_settings[option]
2875
# Force all boolean options to be boolean
2876
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2877
"foreground", "zeroconf"):
2878
server_settings[option] = bool(server_settings[option])
2879
# Debug implies foreground
2880
if server_settings["debug"]:
2881
server_settings["foreground"] = True
1251
2882
# Now we have our good server settings in "server_settings"
1253
2884
##################################################################
2886
if (not server_settings["zeroconf"]
2887
and not (server_settings["port"]
2888
or server_settings["socket"] != "")):
2889
parser.error("Needs port or socket to work without Zeroconf")
1255
2891
# For convenience
1256
debug = server_settings[u"debug"]
1257
use_dbus = server_settings[u"use_dbus"]
1258
use_dbus = False # XXX: Not done yet
1259
use_ipv6 = server_settings[u"use_ipv6"]
1262
syslogger.setLevel(logging.WARNING)
1263
console.setLevel(logging.WARNING)
1265
if server_settings[u"servicename"] != u"Mandos":
1266
syslogger.setFormatter(logging.Formatter
1267
(u'Mandos (%s) [%%(process)d]:'
1268
u' %%(levelname)s: %%(message)s'
1269
% server_settings[u"servicename"]))
2892
debug = server_settings["debug"]
2893
debuglevel = server_settings["debuglevel"]
2894
use_dbus = server_settings["use_dbus"]
2895
use_ipv6 = server_settings["use_ipv6"]
2896
stored_state_path = os.path.join(server_settings["statedir"],
2898
foreground = server_settings["foreground"]
2899
zeroconf = server_settings["zeroconf"]
2902
initlogger(debug, logging.DEBUG)
2907
level = getattr(logging, debuglevel.upper())
2908
initlogger(debug, level)
2910
if server_settings["servicename"] != "Mandos":
2911
syslogger.setFormatter(
2912
logging.Formatter('Mandos ({}) [%(process)d]:'
2913
' %(levelname)s: %(message)s'.format(
2914
server_settings["servicename"])))
1271
2916
# Parse config file with clients
1272
client_defaults = { u"timeout": u"1h",
1274
u"checker": u"fping -q -- %%(host)s",
1277
client_config = configparser.SafeConfigParser(client_defaults)
1278
client_config.read(os.path.join(server_settings[u"configdir"],
2917
client_config = configparser.SafeConfigParser(Client
2919
client_config.read(os.path.join(server_settings["configdir"],
1281
2922
global mandos_dbus_service
1282
2923
mandos_dbus_service = None
1284
tcp_server = MandosServer((server_settings[u"address"],
1285
server_settings[u"port"]),
1287
interface=server_settings[u"interface"],
1290
server_settings[u"priority"],
1292
pidfilename = u"/var/run/mandos.pid"
1294
pidfile = open(pidfilename, u"w")
1296
logger.error(u"Could not open file %r", pidfilename)
2926
if server_settings["socket"] != "":
2927
socketfd = server_settings["socket"]
2928
tcp_server = MandosServer(
2929
(server_settings["address"], server_settings["port"]),
2931
interface=(server_settings["interface"] or None),
2933
gnutls_priority=server_settings["priority"],
2937
pidfilename = "/run/mandos.pid"
2938
if not os.path.isdir("/run/."):
2939
pidfilename = "/var/run/mandos.pid"
2942
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2943
except IOError as e:
2944
logger.error("Could not open file %r", pidfilename,
1299
uid = pwd.getpwnam(u"_mandos").pw_uid
1300
gid = pwd.getpwnam(u"_mandos").pw_gid
2947
for name, group in (("_mandos", "_mandos"),
2948
("mandos", "mandos"),
2949
("nobody", "nogroup")):
1303
uid = pwd.getpwnam(u"mandos").pw_uid
1304
gid = pwd.getpwnam(u"mandos").pw_gid
2951
uid = pwd.getpwnam(name).pw_uid
2952
gid = pwd.getpwnam(group).pw_gid
1305
2954
except KeyError:
1307
uid = pwd.getpwnam(u"nobody").pw_uid
1308
gid = pwd.getpwnam(u"nobody").pw_gid
1315
except OSError, error:
1316
if error[0] != errno.EPERM:
2963
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2965
except OSError as error:
2966
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2967
.format(uid, gid, os.strerror(error.errno)))
2968
if error.errno != errno.EPERM:
1319
# Enable all possible GnuTLS debugging
2972
# Enable all possible GnuTLS debugging
1321
2974
# "Use a log level over 10 to enable all debugging options."
1322
2975
# - GnuTLS manual
1323
gnutls.library.functions.gnutls_global_set_log_level(11)
2976
gnutls.global_set_log_level(11)
1325
@gnutls.library.types.gnutls_log_func
1326
2979
def debug_gnutls(level, string):
1327
logger.debug(u"GnuTLS: %s", string[:-1])
1329
(gnutls.library.functions
1330
.gnutls_global_set_log_function(debug_gnutls))
2980
logger.debug("GnuTLS: %s", string[:-1])
2982
gnutls.global_set_log_function(debug_gnutls)
2984
# Redirect stdin so all checkers get /dev/null
2985
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2986
os.dup2(null, sys.stdin.fileno())
2990
# Need to fork before connecting to D-Bus
2992
# Close all input and output, do double fork, etc.
2995
# multiprocessing will use threads, so before we use GLib we need
2996
# to inform GLib that threads will be used.
1332
2999
global main_loop
1333
3000
# From the Avahi example code
1334
DBusGMainLoop(set_as_default=True )
1335
main_loop = gobject.MainLoop()
3001
DBusGMainLoop(set_as_default=True)
3002
main_loop = GLib.MainLoop()
1336
3003
bus = dbus.SystemBus()
1337
3004
# End of Avahi example code
1339
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1340
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1341
service = AvahiService(name = server_settings[u"servicename"],
1342
servicetype = u"_mandos._tcp",
1343
protocol = protocol, bus = bus)
1344
if server_settings["interface"]:
1345
service.interface = (if_nametoindex
1346
(str(server_settings[u"interface"])))
3007
bus_name = dbus.service.BusName("se.recompile.Mandos",
3010
old_bus_name = dbus.service.BusName(
3011
"se.bsnet.fukt.Mandos", bus,
3013
except dbus.exceptions.DBusException as e:
3014
logger.error("Disabling D-Bus:", exc_info=e)
3016
server_settings["use_dbus"] = False
3017
tcp_server.use_dbus = False
3019
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3020
service = AvahiServiceToSyslog(
3021
name = server_settings["servicename"],
3022
servicetype = "_mandos._tcp",
3023
protocol = protocol,
3025
if server_settings["interface"]:
3026
service.interface = if_nametoindex(
3027
server_settings["interface"].encode("utf-8"))
3029
global multiprocessing_manager
3030
multiprocessing_manager = multiprocessing.Manager()
1348
3032
client_class = Client
1350
3034
client_class = functools.partial(ClientDBus, bus = bus)
1351
tcp_server.clients.update(set(
1352
client_class(name = section,
1353
config= dict(client_config.items(section)))
1354
for section in client_config.sections()))
3036
client_settings = Client.config_parser(client_config)
3037
old_client_settings = {}
3040
# This is used to redirect stdout and stderr for checker processes
3042
wnull = open(os.devnull, "w") # A writable /dev/null
3043
# Only used if server is running in foreground but not in debug
3045
if debug or not foreground:
3048
# Get client data and settings from last running state.
3049
if server_settings["restore"]:
3051
with open(stored_state_path, "rb") as stored_state:
3052
if sys.version_info.major == 2:
3053
clients_data, old_client_settings = pickle.load(
3056
bytes_clients_data, bytes_old_client_settings = (
3057
pickle.load(stored_state, encoding = "bytes"))
3058
### Fix bytes to strings
3061
clients_data = { (key.decode("utf-8")
3062
if isinstance(key, bytes)
3065
bytes_clients_data.items() }
3066
del bytes_clients_data
3067
for key in clients_data:
3068
value = { (k.decode("utf-8")
3069
if isinstance(k, bytes) else k): v
3071
clients_data[key].items() }
3072
clients_data[key] = value
3074
value["client_structure"] = [
3076
if isinstance(s, bytes)
3078
value["client_structure"] ]
3080
for k in ("name", "host"):
3081
if isinstance(value[k], bytes):
3082
value[k] = value[k].decode("utf-8")
3083
## old_client_settings
3085
old_client_settings = {
3086
(key.decode("utf-8")
3087
if isinstance(key, bytes)
3090
bytes_old_client_settings.items() }
3091
del bytes_old_client_settings
3093
for value in old_client_settings.values():
3094
if isinstance(value["host"], bytes):
3095
value["host"] = (value["host"]
3097
os.remove(stored_state_path)
3098
except IOError as e:
3099
if e.errno == errno.ENOENT:
3100
logger.warning("Could not load persistent state:"
3101
" {}".format(os.strerror(e.errno)))
3103
logger.critical("Could not load persistent state:",
3106
except EOFError as e:
3107
logger.warning("Could not load persistent state: "
3111
with PGPEngine() as pgp:
3112
for client_name, client in clients_data.items():
3113
# Skip removed clients
3114
if client_name not in client_settings:
3117
# Decide which value to use after restoring saved state.
3118
# We have three different values: Old config file,
3119
# new config file, and saved state.
3120
# New config value takes precedence if it differs from old
3121
# config value, otherwise use saved state.
3122
for name, value in client_settings[client_name].items():
3124
# For each value in new config, check if it
3125
# differs from the old config value (Except for
3126
# the "secret" attribute)
3127
if (name != "secret"
3129
old_client_settings[client_name][name])):
3130
client[name] = value
3134
# Clients who has passed its expire date can still be
3135
# enabled if its last checker was successful. A Client
3136
# whose checker succeeded before we stored its state is
3137
# assumed to have successfully run all checkers during
3139
if client["enabled"]:
3140
if datetime.datetime.utcnow() >= client["expires"]:
3141
if not client["last_checked_ok"]:
3143
"disabling client {} - Client never "
3144
"performed a successful checker".format(
3146
client["enabled"] = False
3147
elif client["last_checker_status"] != 0:
3149
"disabling client {} - Client last"
3150
" checker failed with error code"
3153
client["last_checker_status"]))
3154
client["enabled"] = False
3156
client["expires"] = (
3157
datetime.datetime.utcnow()
3158
+ client["timeout"])
3159
logger.debug("Last checker succeeded,"
3160
" keeping {} enabled".format(
3163
client["secret"] = pgp.decrypt(
3164
client["encrypted_secret"],
3165
client_settings[client_name]["secret"])
3167
# If decryption fails, we use secret from new settings
3168
logger.debug("Failed to decrypt {} old secret".format(
3170
client["secret"] = (client_settings[client_name]
3173
# Add/remove clients based on new changes made to config
3174
for client_name in (set(old_client_settings)
3175
- set(client_settings)):
3176
del clients_data[client_name]
3177
for client_name in (set(client_settings)
3178
- set(old_client_settings)):
3179
clients_data[client_name] = client_settings[client_name]
3181
# Create all client objects
3182
for client_name, client in clients_data.items():
3183
tcp_server.clients[client_name] = client_class(
3186
server_settings = server_settings)
1355
3188
if not tcp_server.clients:
1356
logger.warning(u"No clients defined")
1359
# Redirect stdin so all checkers get /dev/null
1360
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1361
os.dup2(null, sys.stdin.fileno())
1365
# No console logging
1366
logger.removeHandler(console)
1367
# Close all input and output, do double fork, etc.
1371
with closing(pidfile):
3189
logger.warning("No clients defined")
3192
if pidfile is not None:
1372
3193
pid = os.getpid()
1373
pidfile.write(str(pid) + "\n")
3196
print(pid, file=pidfile)
3198
logger.error("Could not write to file %r with PID %d",
1376
logger.error(u"Could not write to file %r with PID %d",
1379
# "pidfile" was never created
1384
"Cleanup function; run on exit"
3203
for termsig in (signal.SIGHUP, signal.SIGTERM):
3204
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3205
lambda: main_loop.quit() and False)
1387
while tcp_server.clients:
1388
client = tcp_server.clients.pop()
1389
client.disable_hook = None
1392
atexit.register(cleanup)
1395
signal.signal(signal.SIGINT, signal.SIG_IGN)
1396
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1397
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1400
class MandosDBusService(dbus.service.Object):
3209
@alternate_dbus_interfaces(
3210
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3211
class MandosDBusService(DBusObjectWithObjectManager):
1401
3212
"""A D-Bus proxy object"""
1402
3214
def __init__(self):
1403
dbus.service.Object.__init__(self, bus, u"/")
1404
_interface = u"se.bsnet.fukt.Mandos"
1406
@dbus.service.signal(_interface, signature=u"oa{sv}")
1407
def ClientAdded(self, objpath, properties):
1411
@dbus.service.signal(_interface, signature=u"s")
1412
def ClientNotFound(self, fingerprint):
1416
@dbus.service.signal(_interface, signature=u"os")
3215
dbus.service.Object.__init__(self, bus, "/")
3217
_interface = "se.recompile.Mandos"
3219
@dbus.service.signal(_interface, signature="o")
3220
def ClientAdded(self, objpath):
3224
@dbus.service.signal(_interface, signature="ss")
3225
def ClientNotFound(self, fingerprint, address):
3229
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3231
@dbus.service.signal(_interface, signature="os")
1417
3232
def ClientRemoved(self, objpath, name):
1421
@dbus.service.method(_interface, out_signature=u"ao")
3236
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3238
@dbus.service.method(_interface, out_signature="ao")
1422
3239
def GetAllClients(self):
1424
return dbus.Array(c.dbus_object_path
1425
for c in tcp_server.clients)
3241
return dbus.Array(c.dbus_object_path for c in
3242
tcp_server.clients.values())
3244
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1427
3246
@dbus.service.method(_interface,
1428
out_signature=u"a{oa{sv}}")
3247
out_signature="a{oa{sv}}")
1429
3248
def GetAllClientsWithProperties(self):
1431
3250
return dbus.Dictionary(
1432
((c.dbus_object_path, c.GetAllProperties())
1433
for c in tcp_server.clients),
1434
signature=u"oa{sv}")
3251
{ c.dbus_object_path: c.GetAll(
3252
"se.recompile.Mandos.Client")
3253
for c in tcp_server.clients.values() },
1436
@dbus.service.method(_interface, in_signature=u"o")
3256
@dbus.service.method(_interface, in_signature="o")
1437
3257
def RemoveClient(self, object_path):
1439
for c in tcp_server.clients:
3259
for c in tcp_server.clients.values():
1440
3260
if c.dbus_object_path == object_path:
1441
tcp_server.clients.remove(c)
3261
del tcp_server.clients[c.name]
1442
3262
c.remove_from_connection()
1443
# Don't signal anything except ClientRemoved
1444
c.disable(signal=False)
1446
self.ClientRemoved(object_path, c.name)
3263
# Don't signal the disabling
3264
c.disable(quiet=True)
3265
# Emit D-Bus signal for removal
3266
self.client_removed_signal(c)
3268
raise KeyError(object_path)
3272
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3273
out_signature = "a{oa{sa{sv}}}")
3274
def GetManagedObjects(self):
3276
return dbus.Dictionary(
3277
{ client.dbus_object_path:
3279
{ interface: client.GetAll(interface)
3281
client._get_all_interface_names()})
3282
for client in tcp_server.clients.values()})
3284
def client_added_signal(self, client):
3285
"""Send the new standard signal and the old signal"""
3287
# New standard signal
3288
self.InterfacesAdded(
3289
client.dbus_object_path,
3291
{ interface: client.GetAll(interface)
3293
client._get_all_interface_names()}))
3295
self.ClientAdded(client.dbus_object_path)
3297
def client_removed_signal(self, client):
3298
"""Send the new standard signal and the old signal"""
3300
# New standard signal
3301
self.InterfacesRemoved(
3302
client.dbus_object_path,
3303
client._get_all_interface_names())
3305
self.ClientRemoved(client.dbus_object_path,
1452
3308
mandos_dbus_service = MandosDBusService()
1454
for client in tcp_server.clients:
3311
"Cleanup function; run on exit"
3315
multiprocessing.active_children()
3317
if not (tcp_server.clients or client_settings):
3320
# Store client before exiting. Secrets are encrypted with key
3321
# based on what config file has. If config file is
3322
# removed/edited, old secret will thus be unrecovable.
3324
with PGPEngine() as pgp:
3325
for client in tcp_server.clients.values():
3326
key = client_settings[client.name]["secret"]
3327
client.encrypted_secret = pgp.encrypt(client.secret,
3331
# A list of attributes that can not be pickled
3333
exclude = { "bus", "changedstate", "secret",
3334
"checker", "server_settings" }
3335
for name, typ in inspect.getmembers(dbus.service
3339
client_dict["encrypted_secret"] = (client
3341
for attr in client.client_structure:
3342
if attr not in exclude:
3343
client_dict[attr] = getattr(client, attr)
3345
clients[client.name] = client_dict
3346
del client_settings[client.name]["secret"]
3349
with tempfile.NamedTemporaryFile(
3353
dir=os.path.dirname(stored_state_path),
3354
delete=False) as stored_state:
3355
pickle.dump((clients, client_settings), stored_state,
3357
tempname = stored_state.name
3358
os.rename(tempname, stored_state_path)
3359
except (IOError, OSError) as e:
3365
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3366
logger.warning("Could not save persistent state: {}"
3367
.format(os.strerror(e.errno)))
3369
logger.warning("Could not save persistent state:",
3373
# Delete all clients, and settings from config
3374
while tcp_server.clients:
3375
name, client = tcp_server.clients.popitem()
3377
client.remove_from_connection()
3378
# Don't signal the disabling
3379
client.disable(quiet=True)
3380
# Emit D-Bus signal for removal
3382
mandos_dbus_service.client_removed_signal(client)
3383
client_settings.clear()
3385
atexit.register(cleanup)
3387
for client in tcp_server.clients.values():
1457
mandos_dbus_service.ClientAdded(client.dbus_object_path,
1458
client.GetAllProperties())
3389
# Emit D-Bus signal for adding
3390
mandos_dbus_service.client_added_signal(client)
3391
# Need to initiate checking of clients
3393
client.init_checker()
1461
3395
tcp_server.enable()
1462
3396
tcp_server.server_activate()
1464
3398
# Find out what port we got
1465
service.port = tcp_server.socket.getsockname()[1]
3400
service.port = tcp_server.socket.getsockname()[1]
1467
logger.info(u"Now listening on address %r, port %d,"
1468
" flowinfo %d, scope_id %d"
1469
% tcp_server.socket.getsockname())
3402
logger.info("Now listening on address %r, port %d,"
3403
" flowinfo %d, scope_id %d",
3404
*tcp_server.socket.getsockname())
1471
logger.info(u"Now listening on address %r, port %d"
1472
% tcp_server.socket.getsockname())
3406
logger.info("Now listening on address %r, port %d",
3407
*tcp_server.socket.getsockname())
1474
3409
#service.interface = tcp_server.socket.getsockname()[3]
1477
# From the Avahi example code
1480
except dbus.exceptions.DBusException, error:
1481
logger.critical(u"DBusException: %s", error)
1483
# End of Avahi example code
1485
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1486
lambda *args, **kwargs:
1487
(tcp_server.handle_request
1488
(*args[2:], **kwargs) or True))
1490
logger.debug(u"Starting main loop")
3413
# From the Avahi example code
3416
except dbus.exceptions.DBusException as error:
3417
logger.critical("D-Bus Exception", exc_info=error)
3420
# End of Avahi example code
3422
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3423
lambda *args, **kwargs:
3424
(tcp_server.handle_request
3425
(*args[2:], **kwargs) or True))
3427
logger.debug("Starting main loop")
1491
3428
main_loop.run()
1492
except AvahiError, error:
1493
logger.critical(u"AvahiError: %s", error)
3429
except AvahiError as error:
3430
logger.critical("Avahi Error", exc_info=error)
1495
3433
except KeyboardInterrupt:
1498
logger.debug(u"Server received KeyboardInterrupt")
1499
logger.debug(u"Server exiting")
3435
print("", file=sys.stderr)
3436
logger.debug("Server received KeyboardInterrupt")
3437
logger.debug("Server exiting")
3438
# Must run before the D-Bus bus name gets deregistered
1501
3442
if __name__ == '__main__':