69
import cPickle as pickle
63
import cPickle as pickle
72
64
import multiprocessing
81
67
import dbus.service
82
from gi.repository import GLib
83
70
from dbus.mainloop.glib import DBusGMainLoop
86
73
import xml.dom.minidom
89
# Try to find the value of SO_BINDTODEVICE:
91
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
92
# newer, and it is also the most natural place for it:
93
77
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
94
78
except AttributeError:
96
# This is where SO_BINDTODEVICE was up to and including Python
98
80
from IN import SO_BINDTODEVICE
99
81
except ImportError:
100
# In Python 2.7 it seems to have been removed entirely.
101
# Try running the C preprocessor:
103
cc = subprocess.Popen(["cc", "--language=c", "-E",
105
stdin=subprocess.PIPE,
106
stdout=subprocess.PIPE)
107
stdout = cc.communicate(
108
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
109
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
110
except (OSError, ValueError, IndexError):
112
SO_BINDTODEVICE = None
114
if sys.version_info.major == 2:
118
stored_state_file = "clients.pickle"
120
logger = logging.getLogger()
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
ctypes.util.find_library("c")).if_nametoindex
126
except (OSError, AttributeError):
128
def if_nametoindex(interface):
129
"Get an interface index the hard way, i.e. using fcntl()"
130
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
131
with contextlib.closing(socket.socket()) as s:
132
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
133
struct.pack(b"16s16x", interface))
134
interface_index = struct.unpack("I", ifreq[16:20])[0]
135
return interface_index
138
def copy_function(func):
139
"""Make a copy of a function"""
140
if sys.version_info.major == 2:
141
return types.FunctionType(func.func_code,
147
return types.FunctionType(func.__code__,
154
def initlogger(debug, level=logging.WARNING):
155
"""init logger and add loglevel"""
158
syslogger = (logging.handlers.SysLogHandler(
159
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
160
address = "/dev/log"))
161
syslogger.setFormatter(logging.Formatter
162
('Mandos [%(process)d]: %(levelname)s:'
164
logger.addHandler(syslogger)
167
console = logging.StreamHandler()
168
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
172
logger.addHandler(console)
173
logger.setLevel(level)
176
class PGPError(Exception):
177
"""Exception if encryption/decryption fails"""
181
class PGPEngine(object):
182
"""A simple class for OpenPGP symmetric encryption & decryption"""
185
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
188
output = subprocess.check_output(["gpgconf"])
189
for line in output.splitlines():
190
name, text, path = line.split(b":")
195
if e.errno != errno.ENOENT:
197
self.gnupgargs = ['--batch',
198
'--homedir', self.tempdir,
201
# Only GPG version 1 has the --no-use-agent option.
202
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
203
self.gnupgargs.append("--no-use-agent")
208
def __exit__(self, exc_type, exc_value, traceback):
216
if self.tempdir is not None:
217
# Delete contents of tempdir
218
for root, dirs, files in os.walk(self.tempdir,
220
for filename in files:
221
os.remove(os.path.join(root, filename))
223
os.rmdir(os.path.join(root, dirname))
225
os.rmdir(self.tempdir)
228
def password_encode(self, password):
229
# Passphrase can not be empty and can not contain newlines or
230
# NUL bytes. So we prefix it and hex encode it.
231
encoded = b"mandos" + binascii.hexlify(password)
232
if len(encoded) > 2048:
233
# GnuPG can't handle long passwords, so encode differently
234
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
235
.replace(b"\n", b"\\n")
236
.replace(b"\0", b"\\x00"))
239
def encrypt(self, data, password):
240
passphrase = self.password_encode(password)
241
with tempfile.NamedTemporaryFile(
242
dir=self.tempdir) as passfile:
243
passfile.write(passphrase)
245
proc = subprocess.Popen([self.gpg, '--symmetric',
249
stdin = subprocess.PIPE,
250
stdout = subprocess.PIPE,
251
stderr = subprocess.PIPE)
252
ciphertext, err = proc.communicate(input = data)
253
if proc.returncode != 0:
257
def decrypt(self, data, password):
258
passphrase = self.password_encode(password)
259
with tempfile.NamedTemporaryFile(
260
dir = self.tempdir) as passfile:
261
passfile.write(passphrase)
263
proc = subprocess.Popen([self.gpg, '--decrypt',
267
stdin = subprocess.PIPE,
268
stdout = subprocess.PIPE,
269
stderr = subprocess.PIPE)
270
decrypted_plaintext, err = proc.communicate(input = data)
271
if proc.returncode != 0:
273
return decrypted_plaintext
275
# Pretend that we have an Avahi module
277
"""This isn't so much a class as it is a module-like namespace.
278
It is instantiated once, and simulates having an Avahi module."""
279
IF_UNSPEC = -1 # avahi-common/address.h
280
PROTO_UNSPEC = -1 # avahi-common/address.h
281
PROTO_INET = 0 # avahi-common/address.h
282
PROTO_INET6 = 1 # avahi-common/address.h
283
DBUS_NAME = "org.freedesktop.Avahi"
284
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
285
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
286
DBUS_PATH_SERVER = "/"
287
def string_array_to_txt_array(self, t):
288
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
289
for s in t), signature="ay")
290
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
291
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
292
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
293
SERVER_INVALID = 0 # avahi-common/defs.h
294
SERVER_REGISTERING = 1 # avahi-common/defs.h
295
SERVER_RUNNING = 2 # avahi-common/defs.h
296
SERVER_COLLISION = 3 # avahi-common/defs.h
297
SERVER_FAILURE = 4 # avahi-common/defs.h
82
SO_BINDTODEVICE = None
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
89
syslogger = (logging.handlers.SysLogHandler
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
address = str("/dev/log")))
92
syslogger.setFormatter(logging.Formatter
93
('Mandos [%(process)d]: %(levelname)s:'
95
logger.addHandler(syslogger)
97
console = logging.StreamHandler()
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
101
logger.addHandler(console)
300
103
class AvahiError(Exception):
301
104
def __init__(self, value, *args, **kwargs):
302
105
self.value = value
303
return super(AvahiError, self).__init__(value, *args,
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
307
110
class AvahiServiceError(AvahiError):
311
113
class AvahiGroupError(AvahiError):
358
152
self.server = None
360
154
self.entry_group_state_changed_match = None
362
def rename(self, remove=True):
363
156
"""Derived from the Avahi example code"""
364
157
if self.rename_count >= self.max_renames:
365
158
logger.critical("No suitable Zeroconf service name found"
366
159
" after %i retries, exiting.",
367
160
self.rename_count)
368
161
raise AvahiServiceError("Too many renames")
370
self.server.GetAlternativeServiceName(self.name))
371
self.rename_count += 1
162
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
372
163
logger.info("Changing Zeroconf service name to %r ...",
165
syslogger.setFormatter(logging.Formatter
166
('Mandos (%s) [%%(process)d]:'
167
' %%(levelname)s: %%(message)s'
378
172
except dbus.exceptions.DBusException as error:
379
if (error.get_dbus_name()
380
== "org.freedesktop.Avahi.CollisionError"):
381
logger.info("Local Zeroconf service name collision.")
382
return self.rename(remove=False)
384
logger.critical("D-Bus Exception", exc_info=error)
173
logger.critical("DBusException: %s", error)
176
self.rename_count += 1
388
177
def remove(self):
389
178
"""Derived from the Avahi example code"""
179
if self.group is not None:
182
except (dbus.exceptions.UnknownMethodException,
183
dbus.exceptions.DBusException) as e:
390
186
if self.entry_group_state_changed_match is not None:
391
187
self.entry_group_state_changed_match.remove()
392
188
self.entry_group_state_changed_match = None
393
if self.group is not None:
397
190
"""Derived from the Avahi example code"""
399
if self.group is None:
400
self.group = dbus.Interface(
401
self.bus.get_object(avahi.DBUS_NAME,
402
self.server.EntryGroupNew()),
403
avahi.DBUS_INTERFACE_ENTRY_GROUP)
192
self.group = dbus.Interface(
193
self.bus.get_object(avahi.DBUS_NAME,
194
self.server.EntryGroupNew(),
195
follow_name_owner_changes=True),
196
avahi.DBUS_INTERFACE_ENTRY_GROUP)
404
197
self.entry_group_state_changed_match = (
405
198
self.group.connect_to_signal(
406
'StateChanged', self.entry_group_state_changed))
199
'StateChanged', self .entry_group_state_changed))
407
200
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
408
201
self.name, self.type)
409
202
self.group.AddService(
485
252
follow_name_owner_changes=True),
486
253
avahi.DBUS_INTERFACE_SERVER)
487
254
self.server.connect_to_signal("StateChanged",
488
self.server_state_changed)
255
self.server_state_changed)
489
256
self.server_state_changed(self.server.GetState())
492
class AvahiServiceToSyslog(AvahiService):
493
def rename(self, *args, **kwargs):
494
"""Add the new name to the syslog messages"""
495
ret = AvahiService.rename(self, *args, **kwargs)
496
syslogger.setFormatter(logging.Formatter(
497
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
501
# Pretend that we have a GnuTLS module
502
class GnuTLS(object):
503
"""This isn't so much a class as it is a module-like namespace.
504
It is instantiated once, and simulates having a GnuTLS module."""
506
_library = ctypes.cdll.LoadLibrary(
507
ctypes.util.find_library("gnutls"))
508
_need_version = b"3.3.0"
510
# Need to use class name "GnuTLS" here, since this method is
511
# called before the assignment to the "gnutls" global variable
513
if GnuTLS.check_version(self._need_version) is None:
514
raise GnuTLS.Error("Needs GnuTLS {} or later"
515
.format(self._need_version))
517
# Unless otherwise indicated, the constants and types below are
518
# all from the gnutls/gnutls.h C header file.
528
E_NO_CERTIFICATE_FOUND = -49
529
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
532
class session_int(ctypes.Structure):
534
session_t = ctypes.POINTER(session_int)
535
class certificate_credentials_st(ctypes.Structure):
537
certificate_credentials_t = ctypes.POINTER(
538
certificate_credentials_st)
539
certificate_type_t = ctypes.c_int
540
class datum_t(ctypes.Structure):
541
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
542
('size', ctypes.c_uint)]
543
class openpgp_crt_int(ctypes.Structure):
545
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
546
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
547
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
548
credentials_type_t = ctypes.c_int
549
transport_ptr_t = ctypes.c_void_p
550
close_request_t = ctypes.c_int
553
class Error(Exception):
554
# We need to use the class name "GnuTLS" here, since this
555
# exception might be raised from within GnuTLS.__init__,
556
# which is called before the assignment to the "gnutls"
557
# global variable has happened.
558
def __init__(self, message = None, code = None, args=()):
559
# Default usage is by a message string, but if a return
560
# code is passed, convert it to a string with
563
if message is None and code is not None:
564
message = GnuTLS.strerror(code)
565
return super(GnuTLS.Error, self).__init__(
568
class CertificateSecurityError(Error):
572
class Credentials(object):
574
self._c_object = gnutls.certificate_credentials_t()
575
gnutls.certificate_allocate_credentials(
576
ctypes.byref(self._c_object))
577
self.type = gnutls.CRD_CERTIFICATE
580
gnutls.certificate_free_credentials(self._c_object)
582
class ClientSession(object):
583
def __init__(self, socket, credentials = None):
584
self._c_object = gnutls.session_t()
585
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
586
gnutls.set_default_priority(self._c_object)
587
gnutls.transport_set_ptr(self._c_object, socket.fileno())
588
gnutls.handshake_set_private_extensions(self._c_object,
591
if credentials is None:
592
credentials = gnutls.Credentials()
593
gnutls.credentials_set(self._c_object, credentials.type,
594
ctypes.cast(credentials._c_object,
596
self.credentials = credentials
599
gnutls.deinit(self._c_object)
602
return gnutls.handshake(self._c_object)
604
def send(self, data):
608
data_len -= gnutls.record_send(self._c_object,
613
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
615
# Error handling functions
616
def _error_code(result):
617
"""A function to raise exceptions on errors, suitable
618
for the 'restype' attribute on ctypes functions"""
621
if result == gnutls.E_NO_CERTIFICATE_FOUND:
622
raise gnutls.CertificateSecurityError(code = result)
623
raise gnutls.Error(code = result)
625
def _retry_on_error(result, func, arguments):
626
"""A function to retry on some errors, suitable
627
for the 'errcheck' attribute on ctypes functions"""
629
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
630
return _error_code(result)
631
result = func(*arguments)
634
# Unless otherwise indicated, the function declarations below are
635
# all from the gnutls/gnutls.h C header file.
638
priority_set_direct = _library.gnutls_priority_set_direct
639
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
640
ctypes.POINTER(ctypes.c_char_p)]
641
priority_set_direct.restype = _error_code
643
init = _library.gnutls_init
644
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
645
init.restype = _error_code
647
set_default_priority = _library.gnutls_set_default_priority
648
set_default_priority.argtypes = [session_t]
649
set_default_priority.restype = _error_code
651
record_send = _library.gnutls_record_send
652
record_send.argtypes = [session_t, ctypes.c_void_p,
654
record_send.restype = ctypes.c_ssize_t
655
record_send.errcheck = _retry_on_error
657
certificate_allocate_credentials = (
658
_library.gnutls_certificate_allocate_credentials)
659
certificate_allocate_credentials.argtypes = [
660
ctypes.POINTER(certificate_credentials_t)]
661
certificate_allocate_credentials.restype = _error_code
663
certificate_free_credentials = (
664
_library.gnutls_certificate_free_credentials)
665
certificate_free_credentials.argtypes = [certificate_credentials_t]
666
certificate_free_credentials.restype = None
668
handshake_set_private_extensions = (
669
_library.gnutls_handshake_set_private_extensions)
670
handshake_set_private_extensions.argtypes = [session_t,
672
handshake_set_private_extensions.restype = None
674
credentials_set = _library.gnutls_credentials_set
675
credentials_set.argtypes = [session_t, credentials_type_t,
677
credentials_set.restype = _error_code
679
strerror = _library.gnutls_strerror
680
strerror.argtypes = [ctypes.c_int]
681
strerror.restype = ctypes.c_char_p
683
certificate_type_get = _library.gnutls_certificate_type_get
684
certificate_type_get.argtypes = [session_t]
685
certificate_type_get.restype = _error_code
687
certificate_get_peers = _library.gnutls_certificate_get_peers
688
certificate_get_peers.argtypes = [session_t,
689
ctypes.POINTER(ctypes.c_uint)]
690
certificate_get_peers.restype = ctypes.POINTER(datum_t)
692
global_set_log_level = _library.gnutls_global_set_log_level
693
global_set_log_level.argtypes = [ctypes.c_int]
694
global_set_log_level.restype = None
696
global_set_log_function = _library.gnutls_global_set_log_function
697
global_set_log_function.argtypes = [log_func]
698
global_set_log_function.restype = None
700
deinit = _library.gnutls_deinit
701
deinit.argtypes = [session_t]
702
deinit.restype = None
704
handshake = _library.gnutls_handshake
705
handshake.argtypes = [session_t]
706
handshake.restype = _error_code
707
handshake.errcheck = _retry_on_error
709
transport_set_ptr = _library.gnutls_transport_set_ptr
710
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
711
transport_set_ptr.restype = None
713
bye = _library.gnutls_bye
714
bye.argtypes = [session_t, close_request_t]
715
bye.restype = _error_code
716
bye.errcheck = _retry_on_error
718
check_version = _library.gnutls_check_version
719
check_version.argtypes = [ctypes.c_char_p]
720
check_version.restype = ctypes.c_char_p
722
# All the function declarations below are from gnutls/openpgp.h
724
openpgp_crt_init = _library.gnutls_openpgp_crt_init
725
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
726
openpgp_crt_init.restype = _error_code
728
openpgp_crt_import = _library.gnutls_openpgp_crt_import
729
openpgp_crt_import.argtypes = [openpgp_crt_t,
730
ctypes.POINTER(datum_t),
732
openpgp_crt_import.restype = _error_code
734
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
735
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
736
ctypes.POINTER(ctypes.c_uint)]
737
openpgp_crt_verify_self.restype = _error_code
739
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
740
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
741
openpgp_crt_deinit.restype = None
743
openpgp_crt_get_fingerprint = (
744
_library.gnutls_openpgp_crt_get_fingerprint)
745
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
749
openpgp_crt_get_fingerprint.restype = _error_code
751
# Remove non-public functions
752
del _error_code, _retry_on_error
753
# Create the global "gnutls" object, simulating a module
756
def call_pipe(connection, # : multiprocessing.Connection
757
func, *args, **kwargs):
758
"""This function is meant to be called by multiprocessing.Process
760
This function runs func(*args, **kwargs), and writes the resulting
761
return value on the provided multiprocessing.Connection.
763
connection.send(func(*args, **kwargs))
766
259
class Client(object):
767
260
"""A representation of a client host served by this server.
770
approved: bool(); 'None' if not yet approved/disapproved
263
_approved: bool(); 'None' if not yet approved/disapproved
771
264
approval_delay: datetime.timedelta(); Time to wait for approval
772
265
approval_duration: datetime.timedelta(); Duration of one approval
773
266
checker: subprocess.Popen(); a running checker process used
774
267
to see if the client lives.
775
268
'None' if no process is running.
776
checker_callback_tag: a GLib event source tag, or None
269
checker_callback_tag: a gobject event source tag, or None
777
270
checker_command: string; External command which is run to check
778
271
if client lives. %() expansions are done at
779
272
runtime with vars(self) as dict, so that for
780
273
instance %(name)s can be used in the command.
781
checker_initiator_tag: a GLib event source tag, or None
274
checker_initiator_tag: a gobject event source tag, or None
782
275
created: datetime.datetime(); (UTC) object creation
783
client_structure: Object describing what attributes a client has
784
and is used for storing the client at exit
785
276
current_checker_command: string; current running checker_command
786
disable_initiator_tag: a GLib event source tag, or None
277
disable_hook: If set, called by disable() as disable_hook(self)
278
disable_initiator_tag: a gobject event source tag, or None
788
280
fingerprint: string (40 or 32 hexadecimal digits); used to
789
281
uniquely identify the client
791
283
interval: datetime.timedelta(); How often to start a new checker
792
284
last_approval_request: datetime.datetime(); (UTC) or None
793
285
last_checked_ok: datetime.datetime(); (UTC) or None
794
last_checker_status: integer between 0 and 255 reflecting exit
795
status of last checker. -1 reflects crashed
796
checker, -2 means no checker completed yet.
797
last_checker_signal: The signal which killed the last checker, if
798
last_checker_status is -1
799
last_enabled: datetime.datetime(); (UTC) or None
286
last_enabled: datetime.datetime(); (UTC)
800
287
name: string; from the config file, used in log messages and
801
288
D-Bus identifiers
802
289
secret: bytestring; sent verbatim (over TLS) to client
803
290
timeout: datetime.timedelta(); How long from last_checked_ok
804
291
until this client is disabled
805
extended_timeout: extra long timeout when secret has been sent
806
292
runtime_expansions: Allowed attributes for runtime expansion.
807
expires: datetime.datetime(); time (UTC) when a client will be
809
server_settings: The server_settings dict from main()
812
295
runtime_expansions = ("approval_delay", "approval_duration",
813
"created", "enabled", "expires",
814
"fingerprint", "host", "interval",
815
"last_approval_request", "last_checked_ok",
296
"created", "enabled", "fingerprint",
297
"host", "interval", "last_checked_ok",
816
298
"last_enabled", "name", "timeout")
819
"extended_timeout": "PT15M",
821
"checker": "fping -q -- %%(host)s",
823
"approval_delay": "PT0S",
824
"approval_duration": "PT1S",
825
"approved_by_default": "True",
830
def config_parser(config):
831
"""Construct a new dict of client settings of this form:
832
{ client_name: {setting_name: value, ...}, ...}
833
with exceptions for any special settings as defined above.
834
NOTE: Must be a pure function. Must return the same result
835
value given the same arguments.
838
for client_name in config.sections():
839
section = dict(config.items(client_name))
840
client = settings[client_name] = {}
842
client["host"] = section["host"]
843
# Reformat values from string types to Python types
844
client["approved_by_default"] = config.getboolean(
845
client_name, "approved_by_default")
846
client["enabled"] = config.getboolean(client_name,
849
# Uppercase and remove spaces from fingerprint for later
850
# comparison purposes with return value from the
851
# fingerprint() function
852
client["fingerprint"] = (section["fingerprint"].upper()
854
if "secret" in section:
855
client["secret"] = codecs.decode(section["secret"]
858
elif "secfile" in section:
859
with open(os.path.expanduser(os.path.expandvars
860
(section["secfile"])),
862
client["secret"] = secfile.read()
864
raise TypeError("No secret or secfile for section {}"
866
client["timeout"] = string_to_delta(section["timeout"])
867
client["extended_timeout"] = string_to_delta(
868
section["extended_timeout"])
869
client["interval"] = string_to_delta(section["interval"])
870
client["approval_delay"] = string_to_delta(
871
section["approval_delay"])
872
client["approval_duration"] = string_to_delta(
873
section["approval_duration"])
874
client["checker_command"] = section["checker"]
875
client["last_approval_request"] = None
876
client["last_checked_ok"] = None
877
client["last_checker_status"] = -2
881
def __init__(self, settings, name = None, server_settings=None):
301
def _timedelta_to_milliseconds(td):
302
"Convert a datetime.timedelta() to milliseconds"
303
return ((td.days * 24 * 60 * 60 * 1000)
304
+ (td.seconds * 1000)
305
+ (td.microseconds // 1000))
307
def timeout_milliseconds(self):
308
"Return the 'timeout' attribute in milliseconds"
309
return self._timedelta_to_milliseconds(self.timeout)
311
def interval_milliseconds(self):
312
"Return the 'interval' attribute in milliseconds"
313
return self._timedelta_to_milliseconds(self.interval)
315
def approval_delay_milliseconds(self):
316
return self._timedelta_to_milliseconds(self.approval_delay)
318
def __init__(self, name = None, disable_hook=None, config=None):
319
"""Note: the 'checker' key in 'config' sets the
320
'checker_command' attribute and *not* the 'checker'
883
if server_settings is None:
885
self.server_settings = server_settings
886
# adding all client settings
887
for setting, value in settings.items():
888
setattr(self, setting, value)
891
if not hasattr(self, "last_enabled"):
892
self.last_enabled = datetime.datetime.utcnow()
893
if not hasattr(self, "expires"):
894
self.expires = (datetime.datetime.utcnow()
897
self.last_enabled = None
900
325
logger.debug("Creating client %r", self.name)
326
# Uppercase and remove spaces from fingerprint for later
327
# comparison purposes with return value from the fingerprint()
329
self.fingerprint = (config["fingerprint"].upper()
901
331
logger.debug(" Fingerprint: %s", self.fingerprint)
902
self.created = settings.get("created",
903
datetime.datetime.utcnow())
905
# attributes specific for this server instance
332
if "secret" in config:
333
self.secret = config["secret"].decode("base64")
334
elif "secfile" in config:
335
with open(os.path.expanduser(os.path.expandvars
336
(config["secfile"])),
338
self.secret = secfile.read()
340
raise TypeError("No secret or secfile for client %s"
342
self.host = config.get("host", "")
343
self.created = datetime.datetime.utcnow()
345
self.last_approval_request = None
346
self.last_enabled = None
347
self.last_checked_ok = None
348
self.timeout = string_to_delta(config["timeout"])
349
self.interval = string_to_delta(config["interval"])
350
self.disable_hook = disable_hook
906
351
self.checker = None
907
352
self.checker_initiator_tag = None
908
353
self.disable_initiator_tag = None
909
354
self.checker_callback_tag = None
355
self.checker_command = config["checker"]
910
356
self.current_checker_command = None
357
self.last_connect = None
358
self._approved = None
359
self.approved_by_default = config.get("approved_by_default",
912
361
self.approvals_pending = 0
913
self.changedstate = multiprocessing_manager.Condition(
914
multiprocessing_manager.Lock())
915
self.client_structure = [attr
916
for attr in self.__dict__.keys()
917
if not attr.startswith("_")]
918
self.client_structure.append("client_structure")
920
for name, t in inspect.getmembers(
921
type(self), lambda obj: isinstance(obj, property)):
922
if not name.startswith("_"):
923
self.client_structure.append(name)
362
self.approval_delay = string_to_delta(
363
config["approval_delay"])
364
self.approval_duration = string_to_delta(
365
config["approval_duration"])
366
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
925
# Send notice to process children that client state has changed
926
368
def send_changedstate(self):
927
with self.changedstate:
928
self.changedstate.notify_all()
369
self.changedstate.acquire()
370
self.changedstate.notify_all()
371
self.changedstate.release()
930
373
def enable(self):
931
374
"""Start this client's checker and timeout hooks"""
932
375
if getattr(self, "enabled", False):
933
376
# Already enabled
935
self.expires = datetime.datetime.utcnow() + self.timeout
378
self.send_changedstate()
937
379
self.last_enabled = datetime.datetime.utcnow()
939
self.send_changedstate()
380
# Schedule a new checker to be started an 'interval' from now,
381
# and every interval from then on.
382
self.checker_initiator_tag = (gobject.timeout_add
383
(self.interval_milliseconds(),
385
# Schedule a disable() when 'timeout' has passed
386
self.disable_initiator_tag = (gobject.timeout_add
387
(self.timeout_milliseconds(),
390
# Also start a new checker *right now*.
941
393
def disable(self, quiet=True):
942
394
"""Disable this client."""
943
395
if not getattr(self, "enabled", False):
398
self.send_changedstate()
946
400
logger.info("Disabling client %s", self.name)
947
if getattr(self, "disable_initiator_tag", None) is not None:
948
GLib.source_remove(self.disable_initiator_tag)
401
if getattr(self, "disable_initiator_tag", False):
402
gobject.source_remove(self.disable_initiator_tag)
949
403
self.disable_initiator_tag = None
951
if getattr(self, "checker_initiator_tag", None) is not None:
952
GLib.source_remove(self.checker_initiator_tag)
404
if getattr(self, "checker_initiator_tag", False):
405
gobject.source_remove(self.checker_initiator_tag)
953
406
self.checker_initiator_tag = None
954
407
self.stop_checker()
408
if self.disable_hook:
409
self.disable_hook(self)
955
410
self.enabled = False
957
self.send_changedstate()
958
# Do not run this again if called by a GLib.timeout_add
411
# Do not run this again if called by a gobject.timeout_add
961
414
def __del__(self):
415
self.disable_hook = None
964
def init_checker(self):
965
# Schedule a new checker to be started an 'interval' from now,
966
# and every interval from then on.
967
if self.checker_initiator_tag is not None:
968
GLib.source_remove(self.checker_initiator_tag)
969
self.checker_initiator_tag = GLib.timeout_add(
970
int(self.interval.total_seconds() * 1000),
972
# Schedule a disable() when 'timeout' has passed
973
if self.disable_initiator_tag is not None:
974
GLib.source_remove(self.disable_initiator_tag)
975
self.disable_initiator_tag = GLib.timeout_add(
976
int(self.timeout.total_seconds() * 1000), self.disable)
977
# Also start a new checker *right now*.
980
def checker_callback(self, source, condition, connection,
418
def checker_callback(self, pid, condition, command):
982
419
"""The checker has completed, so take appropriate actions."""
983
420
self.checker_callback_tag = None
984
421
self.checker = None
985
# Read return code from connection (see call_pipe)
986
returncode = connection.recv()
990
self.last_checker_status = returncode
991
self.last_checker_signal = None
992
if self.last_checker_status == 0:
422
if os.WIFEXITED(condition):
423
exitstatus = os.WEXITSTATUS(condition)
993
425
logger.info("Checker for %(name)s succeeded",
995
427
self.checked_ok()
997
logger.info("Checker for %(name)s failed", vars(self))
429
logger.info("Checker for %(name)s failed",
999
self.last_checker_status = -1
1000
self.last_checker_signal = -returncode
1001
432
logger.warning("Checker for %(name)s crashed?",
1005
435
def checked_ok(self):
1006
"""Assert that the client has been seen, alive and well."""
436
"""Bump up the timeout for this client.
438
This should only be called when the client has been seen,
1007
441
self.last_checked_ok = datetime.datetime.utcnow()
1008
self.last_checker_status = 0
1009
self.last_checker_signal = None
1012
def bump_timeout(self, timeout=None):
1013
"""Bump up the timeout for this client."""
1015
timeout = self.timeout
1016
if self.disable_initiator_tag is not None:
1017
GLib.source_remove(self.disable_initiator_tag)
1018
self.disable_initiator_tag = None
1019
if getattr(self, "enabled", False):
1020
self.disable_initiator_tag = GLib.timeout_add(
1021
int(timeout.total_seconds() * 1000), self.disable)
1022
self.expires = datetime.datetime.utcnow() + timeout
442
gobject.source_remove(self.disable_initiator_tag)
443
self.disable_initiator_tag = (gobject.timeout_add
444
(self.timeout_milliseconds(),
1024
447
def need_approval(self):
1025
448
self.last_approval_request = datetime.datetime.utcnow()
1030
453
If a checker already exists, leave it running and do
1032
455
# The reason for not killing a running checker is that if we
1033
# did that, and if a checker (for some reason) started running
1034
# slowly and taking more than 'interval' time, then the client
1035
# would inevitably timeout, since no checker would get a
1036
# chance to run to completion. If we instead leave running
456
# did that, then if a checker (for some reason) started
457
# running slowly and taking more than 'interval' time, the
458
# client would inevitably timeout, since no checker would get
459
# a chance to run to completion. If we instead leave running
1037
460
# checkers alone, the checker would have to take more time
1038
461
# than 'timeout' for the client to be disabled, which is as it
1041
if self.checker is not None and not self.checker.is_alive():
1042
logger.warning("Checker was not alive; joining")
464
# If a checker exists, make sure it is not a zombie
466
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
467
except (AttributeError, OSError) as error:
468
if (isinstance(error, OSError)
469
and error.errno != errno.ECHILD):
473
logger.warning("Checker was a zombie")
474
gobject.source_remove(self.checker_callback_tag)
475
self.checker_callback(pid, status,
476
self.current_checker_command)
1045
477
# Start a new checker if needed
1046
478
if self.checker is None:
1047
# Escape attributes for the shell
1049
attr: re.escape(str(getattr(self, attr)))
1050
for attr in self.runtime_expansions }
1052
command = self.checker_command % escaped_attrs
1053
except TypeError as error:
1054
logger.error('Could not format string "%s"',
1055
self.checker_command,
1057
return True # Try again later
480
# In case checker_command has exactly one % operator
481
command = self.checker_command % self.host
483
# Escape attributes for the shell
484
escaped_attrs = dict(
486
re.escape(unicode(str(getattr(self, attr, "")),
490
self.runtime_expansions)
493
command = self.checker_command % escaped_attrs
494
except TypeError as error:
495
logger.error('Could not format string "%s":'
496
' %s', self.checker_command, error)
497
return True # Try again later
1058
498
self.current_checker_command = command
1059
logger.info("Starting checker %r for %s", command,
1061
# We don't need to redirect stdout and stderr, since
1062
# in normal mode, that is already done by daemon(),
1063
# and in debug mode we don't want to. (Stdin is
1064
# always replaced by /dev/null.)
1065
# The exception is when not debugging but nevertheless
1066
# running in the foreground; use the previously
1068
popen_args = { "close_fds": True,
1071
if (not self.server_settings["debug"]
1072
and self.server_settings["foreground"]):
1073
popen_args.update({"stdout": wnull,
1075
pipe = multiprocessing.Pipe(duplex = False)
1076
self.checker = multiprocessing.Process(
1078
args = (pipe[1], subprocess.call, command),
1079
kwargs = popen_args)
1080
self.checker.start()
1081
self.checker_callback_tag = GLib.io_add_watch(
1082
pipe[0].fileno(), GLib.IO_IN,
1083
self.checker_callback, pipe[0], command)
1084
# Re-run this periodically if run by GLib.timeout_add
500
logger.info("Starting checker %r for %s",
502
# We don't need to redirect stdout and stderr, since
503
# in normal mode, that is already done by daemon(),
504
# and in debug mode we don't want to. (Stdin is
505
# always replaced by /dev/null.)
506
self.checker = subprocess.Popen(command,
509
self.checker_callback_tag = (gobject.child_watch_add
511
self.checker_callback,
513
# The checker may have completed before the gobject
514
# watch was added. Check for this.
515
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
517
gobject.source_remove(self.checker_callback_tag)
518
self.checker_callback(pid, status, command)
519
except OSError as error:
520
logger.error("Failed to start subprocess: %s",
522
# Re-run this periodically if run by gobject.timeout_add
1087
525
def stop_checker(self):
1088
526
"""Force the checker process, if any, to stop."""
1089
527
if self.checker_callback_tag:
1090
GLib.source_remove(self.checker_callback_tag)
528
gobject.source_remove(self.checker_callback_tag)
1091
529
self.checker_callback_tag = None
1092
530
if getattr(self, "checker", None) is None:
1094
532
logger.debug("Stopping checker for %(name)s", vars(self))
1095
self.checker.terminate()
534
os.kill(self.checker.pid, signal.SIGTERM)
536
#if self.checker.poll() is None:
537
# os.kill(self.checker.pid, signal.SIGKILL)
538
except OSError as error:
539
if error.errno != errno.ESRCH: # No such process
1096
541
self.checker = None
1099
def dbus_service_property(dbus_interface,
543
def dbus_service_property(dbus_interface, signature="v",
544
access="readwrite", byte_arrays=False):
1103
545
"""Decorators for marking methods of a DBusObjectWithProperties to
1104
546
become properties on the D-Bus.
1194
class DBusObjectWithAnnotations(dbus.service.Object):
1195
"""A D-Bus object with annotations.
1197
Classes inheriting from this can use the dbus_annotations
1198
decorator to add annotations to methods or signals.
1202
def _is_dbus_thing(thing):
1203
"""Returns a function testing if an attribute is a D-Bus thing
1205
If called like _is_dbus_thing("method") it returns a function
1206
suitable for use as predicate to inspect.getmembers().
1208
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1211
def _get_all_dbus_things(self, thing):
1212
"""Returns a generator of (name, attribute) pairs
1214
return ((getattr(athing.__get__(self), "_dbus_name", name),
1215
athing.__get__(self))
1216
for cls in self.__class__.__mro__
1218
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1220
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1221
out_signature = "s",
1222
path_keyword = 'object_path',
1223
connection_keyword = 'connection')
1224
def Introspect(self, object_path, connection):
1225
"""Overloading of standard D-Bus method.
1227
Inserts annotation tags on methods and signals.
1229
xmlstring = dbus.service.Object.Introspect(self, object_path,
1232
document = xml.dom.minidom.parseString(xmlstring)
1234
for if_tag in document.getElementsByTagName("interface"):
1235
# Add annotation tags
1236
for typ in ("method", "signal"):
1237
for tag in if_tag.getElementsByTagName(typ):
1239
for name, prop in (self.
1240
_get_all_dbus_things(typ)):
1241
if (name == tag.getAttribute("name")
1242
and prop._dbus_interface
1243
== if_tag.getAttribute("name")):
1244
annots.update(getattr(
1245
prop, "_dbus_annotations", {}))
1246
for name, value in annots.items():
1247
ann_tag = document.createElement(
1249
ann_tag.setAttribute("name", name)
1250
ann_tag.setAttribute("value", value)
1251
tag.appendChild(ann_tag)
1252
# Add interface annotation tags
1253
for annotation, value in dict(
1254
itertools.chain.from_iterable(
1255
annotations().items()
1256
for name, annotations
1257
in self._get_all_dbus_things("interface")
1258
if name == if_tag.getAttribute("name")
1260
ann_tag = document.createElement("annotation")
1261
ann_tag.setAttribute("name", annotation)
1262
ann_tag.setAttribute("value", value)
1263
if_tag.appendChild(ann_tag)
1264
# Fix argument name for the Introspect method itself
1265
if (if_tag.getAttribute("name")
1266
== dbus.INTROSPECTABLE_IFACE):
1267
for cn in if_tag.getElementsByTagName("method"):
1268
if cn.getAttribute("name") == "Introspect":
1269
for arg in cn.getElementsByTagName("arg"):
1270
if (arg.getAttribute("direction")
1272
arg.setAttribute("name",
1274
xmlstring = document.toxml("utf-8")
1276
except (AttributeError, xml.dom.DOMException,
1277
xml.parsers.expat.ExpatError) as error:
1278
logger.error("Failed to override Introspection method",
1283
class DBusObjectWithProperties(DBusObjectWithAnnotations):
592
class DBusObjectWithProperties(dbus.service.Object):
1284
593
"""A D-Bus object with properties.
1286
595
Classes inheriting from this can use the dbus_service_property
1287
596
decorator to expose methods as D-Bus properties. It exposes the
1288
597
standard Get(), Set(), and GetAll() methods on the D-Bus.
601
def _is_dbus_property(obj):
602
return getattr(obj, "_dbus_is_property", False)
604
def _get_all_dbus_properties(self):
605
"""Returns a generator of (name, attribute) pairs
607
return ((prop._dbus_name, prop)
609
inspect.getmembers(self, self._is_dbus_property))
1291
611
def _get_dbus_property(self, interface_name, property_name):
1292
612
"""Returns a bound method if one exists which is a D-Bus
1293
613
property with the specified name and interface.
1295
for cls in self.__class__.__mro__:
1296
for name, value in inspect.getmembers(
1297
cls, self._is_dbus_thing("property")):
1298
if (value._dbus_name == property_name
1299
and value._dbus_interface == interface_name):
1300
return value.__get__(self)
615
for name in (property_name,
616
property_name + "_dbus_property"):
617
prop = getattr(self, name, None)
619
or not self._is_dbus_property(prop)
620
or prop._dbus_name != property_name
621
or (interface_name and prop._dbus_interface
622
and interface_name != prop._dbus_interface)):
1302
625
# No such property
1303
raise DBusPropertyNotFound("{}:{}.{}".format(
1304
self.dbus_object_path, interface_name, property_name))
1307
def _get_all_interface_names(cls):
1308
"""Get a sequence of all interfaces supported by an object"""
1309
return (name for name in set(getattr(getattr(x, attr),
1310
"_dbus_interface", None)
1311
for x in (inspect.getmro(cls))
1313
if name is not None)
1315
@dbus.service.method(dbus.PROPERTIES_IFACE,
626
raise DBusPropertyNotFound(self.dbus_object_path + ":"
627
+ interface_name + "."
630
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1317
631
out_signature="v")
1318
632
def Get(self, interface_name, property_name):
1319
633
"""Standard D-Bus property Get() method, see D-Bus standard.
1366
677
if not hasattr(value, "variant_level"):
1367
properties[name] = value
1369
properties[name] = type(value)(
1370
value, variant_level = value.variant_level + 1)
1371
return dbus.Dictionary(properties, signature="sv")
1373
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1374
def PropertiesChanged(self, interface_name, changed_properties,
1375
invalidated_properties):
1376
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
680
all[name] = type(value)(value, variant_level=
681
value.variant_level+1)
682
return dbus.Dictionary(all, signature="sv")
1381
684
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1382
685
out_signature="s",
1383
686
path_keyword='object_path',
1384
687
connection_keyword='connection')
1385
688
def Introspect(self, object_path, connection):
1386
"""Overloading of standard D-Bus method.
1388
Inserts property tags and interface annotation tags.
689
"""Standard D-Bus method, overloaded to insert property tags.
1390
xmlstring = DBusObjectWithAnnotations.Introspect(self,
691
xmlstring = dbus.service.Object.Introspect(self, object_path,
1394
694
document = xml.dom.minidom.parseString(xmlstring)
1396
695
def make_tag(document, name, prop):
1397
696
e = document.createElement("property")
1398
697
e.setAttribute("name", name)
1399
698
e.setAttribute("type", prop._dbus_signature)
1400
699
e.setAttribute("access", prop._dbus_access)
1403
701
for if_tag in document.getElementsByTagName("interface"):
1405
702
for tag in (make_tag(document, name, prop)
1407
in self._get_all_dbus_things("property")
704
in self._get_all_dbus_properties()
1408
705
if prop._dbus_interface
1409
706
== if_tag.getAttribute("name")):
1410
707
if_tag.appendChild(tag)
1411
# Add annotation tags for properties
1412
for tag in if_tag.getElementsByTagName("property"):
1414
for name, prop in self._get_all_dbus_things(
1416
if (name == tag.getAttribute("name")
1417
and prop._dbus_interface
1418
== if_tag.getAttribute("name")):
1419
annots.update(getattr(
1420
prop, "_dbus_annotations", {}))
1421
for name, value in annots.items():
1422
ann_tag = document.createElement(
1424
ann_tag.setAttribute("name", name)
1425
ann_tag.setAttribute("value", value)
1426
tag.appendChild(ann_tag)
1427
708
# Add the names to the return values for the
1428
709
# "org.freedesktop.DBus.Properties" methods
1429
710
if (if_tag.getAttribute("name")
1444
725
except (AttributeError, xml.dom.DOMException,
1445
726
xml.parsers.expat.ExpatError) as error:
1446
727
logger.error("Failed to override Introspection method",
1451
dbus.OBJECT_MANAGER_IFACE
1452
except AttributeError:
1453
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1455
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1456
"""A D-Bus object with an ObjectManager.
1458
Classes inheriting from this exposes the standard
1459
GetManagedObjects call and the InterfacesAdded and
1460
InterfacesRemoved signals on the standard
1461
"org.freedesktop.DBus.ObjectManager" interface.
1463
Note: No signals are sent automatically; they must be sent
1466
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1467
out_signature = "a{oa{sa{sv}}}")
1468
def GetManagedObjects(self):
1469
"""This function must be overridden"""
1470
raise NotImplementedError()
1472
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1473
signature = "oa{sa{sv}}")
1474
def InterfacesAdded(self, object_path, interfaces_and_properties):
1477
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1478
def InterfacesRemoved(self, object_path, interfaces):
1481
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1482
out_signature = "s",
1483
path_keyword = 'object_path',
1484
connection_keyword = 'connection')
1485
def Introspect(self, object_path, connection):
1486
"""Overloading of standard D-Bus method.
1488
Override return argument name of GetManagedObjects to be
1489
"objpath_interfaces_and_properties"
1491
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1495
document = xml.dom.minidom.parseString(xmlstring)
1497
for if_tag in document.getElementsByTagName("interface"):
1498
# Fix argument name for the GetManagedObjects method
1499
if (if_tag.getAttribute("name")
1500
== dbus.OBJECT_MANAGER_IFACE):
1501
for cn in if_tag.getElementsByTagName("method"):
1502
if (cn.getAttribute("name")
1503
== "GetManagedObjects"):
1504
for arg in cn.getElementsByTagName("arg"):
1505
if (arg.getAttribute("direction")
1509
"objpath_interfaces"
1511
xmlstring = document.toxml("utf-8")
1513
except (AttributeError, xml.dom.DOMException,
1514
xml.parsers.expat.ExpatError) as error:
1515
logger.error("Failed to override Introspection method",
1519
def datetime_to_dbus(dt, variant_level=0):
1520
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1522
return dbus.String("", variant_level = variant_level)
1523
return dbus.String(dt.isoformat(), variant_level=variant_level)
1526
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1527
"""A class decorator; applied to a subclass of
1528
dbus.service.Object, it will add alternate D-Bus attributes with
1529
interface names according to the "alt_interface_names" mapping.
1532
@alternate_dbus_interfaces({"org.example.Interface":
1533
"net.example.AlternateInterface"})
1534
class SampleDBusObject(dbus.service.Object):
1535
@dbus.service.method("org.example.Interface")
1536
def SampleDBusMethod():
1539
The above "SampleDBusMethod" on "SampleDBusObject" will be
1540
reachable via two interfaces: "org.example.Interface" and
1541
"net.example.AlternateInterface", the latter of which will have
1542
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1543
"true", unless "deprecate" is passed with a False value.
1545
This works for methods and signals, and also for D-Bus properties
1546
(from DBusObjectWithProperties) and interfaces (from the
1547
dbus_interface_annotations decorator).
1551
for orig_interface_name, alt_interface_name in (
1552
alt_interface_names.items()):
1554
interface_names = set()
1555
# Go though all attributes of the class
1556
for attrname, attribute in inspect.getmembers(cls):
1557
# Ignore non-D-Bus attributes, and D-Bus attributes
1558
# with the wrong interface name
1559
if (not hasattr(attribute, "_dbus_interface")
1560
or not attribute._dbus_interface.startswith(
1561
orig_interface_name)):
1563
# Create an alternate D-Bus interface name based on
1565
alt_interface = attribute._dbus_interface.replace(
1566
orig_interface_name, alt_interface_name)
1567
interface_names.add(alt_interface)
1568
# Is this a D-Bus signal?
1569
if getattr(attribute, "_dbus_is_signal", False):
1570
# Extract the original non-method undecorated
1571
# function by black magic
1572
if sys.version_info.major == 2:
1573
nonmethod_func = (dict(
1574
zip(attribute.func_code.co_freevars,
1575
attribute.__closure__))
1576
["func"].cell_contents)
1578
nonmethod_func = (dict(
1579
zip(attribute.__code__.co_freevars,
1580
attribute.__closure__))
1581
["func"].cell_contents)
1582
# Create a new, but exactly alike, function
1583
# object, and decorate it to be a new D-Bus signal
1584
# with the alternate D-Bus interface name
1585
new_function = copy_function(nonmethod_func)
1586
new_function = (dbus.service.signal(
1588
attribute._dbus_signature)(new_function))
1589
# Copy annotations, if any
1591
new_function._dbus_annotations = dict(
1592
attribute._dbus_annotations)
1593
except AttributeError:
1595
# Define a creator of a function to call both the
1596
# original and alternate functions, so both the
1597
# original and alternate signals gets sent when
1598
# the function is called
1599
def fixscope(func1, func2):
1600
"""This function is a scope container to pass
1601
func1 and func2 to the "call_both" function
1602
outside of its arguments"""
1604
@functools.wraps(func2)
1605
def call_both(*args, **kwargs):
1606
"""This function will emit two D-Bus
1607
signals by calling func1 and func2"""
1608
func1(*args, **kwargs)
1609
func2(*args, **kwargs)
1610
# Make wrapper function look like a D-Bus signal
1611
for name, attr in inspect.getmembers(func2):
1612
if name.startswith("_dbus_"):
1613
setattr(call_both, name, attr)
1616
# Create the "call_both" function and add it to
1618
attr[attrname] = fixscope(attribute, new_function)
1619
# Is this a D-Bus method?
1620
elif getattr(attribute, "_dbus_is_method", False):
1621
# Create a new, but exactly alike, function
1622
# object. Decorate it to be a new D-Bus method
1623
# with the alternate D-Bus interface name. Add it
1626
dbus.service.method(
1628
attribute._dbus_in_signature,
1629
attribute._dbus_out_signature)
1630
(copy_function(attribute)))
1631
# Copy annotations, if any
1633
attr[attrname]._dbus_annotations = dict(
1634
attribute._dbus_annotations)
1635
except AttributeError:
1637
# Is this a D-Bus property?
1638
elif getattr(attribute, "_dbus_is_property", False):
1639
# Create a new, but exactly alike, function
1640
# object, and decorate it to be a new D-Bus
1641
# property with the alternate D-Bus interface
1642
# name. Add it to the class.
1643
attr[attrname] = (dbus_service_property(
1644
alt_interface, attribute._dbus_signature,
1645
attribute._dbus_access,
1646
attribute._dbus_get_args_options
1648
(copy_function(attribute)))
1649
# Copy annotations, if any
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1653
except AttributeError:
1655
# Is this a D-Bus interface?
1656
elif getattr(attribute, "_dbus_is_interface", False):
1657
# Create a new, but exactly alike, function
1658
# object. Decorate it to be a new D-Bus interface
1659
# with the alternate D-Bus interface name. Add it
1662
dbus_interface_annotations(alt_interface)
1663
(copy_function(attribute)))
1665
# Deprecate all alternate interfaces
1666
iname="_AlternateDBusNames_interface_annotation{}"
1667
for interface_name in interface_names:
1669
@dbus_interface_annotations(interface_name)
1671
return { "org.freedesktop.DBus.Deprecated":
1673
# Find an unused name
1674
for aname in (iname.format(i)
1675
for i in itertools.count()):
1676
if aname not in attr:
1680
# Replace the class with a new subclass of it with
1681
# methods, signals, etc. as created above.
1682
if sys.version_info.major == 2:
1683
cls = type(b"{}Alternate".format(cls.__name__),
1686
cls = type("{}Alternate".format(cls.__name__),
1693
@alternate_dbus_interfaces({"se.recompile.Mandos":
1694
"se.bsnet.fukt.Mandos"})
1695
732
class ClientDBus(Client, DBusObjectWithProperties):
1696
733
"""A Client class using D-Bus
1703
740
runtime_expansions = (Client.runtime_expansions
1704
+ ("dbus_object_path", ))
1706
_interface = "se.recompile.Mandos.Client"
741
+ ("dbus_object_path",))
1708
743
# dbus.service.Object doesn't use super(), so we can't either.
1710
745
def __init__(self, bus = None, *args, **kwargs):
746
self._approvals_pending = 0
1712
748
Client.__init__(self, *args, **kwargs)
1713
749
# Only now, when this client is initialized, can it show up on
1715
client_object_name = str(self.name).translate(
751
client_object_name = unicode(self.name).translate(
1716
752
{ord("."): ord("_"),
1717
753
ord("-"): ord("_")})
1718
self.dbus_object_path = dbus.ObjectPath(
1719
"/clients/" + client_object_name)
754
self.dbus_object_path = (dbus.ObjectPath
755
("/clients/" + client_object_name))
1720
756
DBusObjectWithProperties.__init__(self, self.bus,
1721
757
self.dbus_object_path)
1723
def notifychangeproperty(transform_func, dbus_name,
1724
type_func=lambda x: x,
1726
invalidate_only=False,
1727
_interface=_interface):
1728
""" Modify a variable so that it's a property which announces
1729
its changes to DBus.
1731
transform_fun: Function that takes a value and a variant_level
1732
and transforms it to a D-Bus type.
1733
dbus_name: D-Bus name of the variable
1734
type_func: Function that transform the value before sending it
1735
to the D-Bus. Default: no transform
1736
variant_level: D-Bus variant level. Default: 1
1738
attrname = "_{}".format(dbus_name)
1740
def setter(self, value):
1741
if hasattr(self, "dbus_object_path"):
1742
if (not hasattr(self, attrname) or
1743
type_func(getattr(self, attrname, None))
1744
!= type_func(value)):
1746
self.PropertiesChanged(
1747
_interface, dbus.Dictionary(),
1748
dbus.Array((dbus_name, )))
1750
dbus_value = transform_func(
1752
variant_level = variant_level)
1753
self.PropertyChanged(dbus.String(dbus_name),
1755
self.PropertiesChanged(
1757
dbus.Dictionary({ dbus.String(dbus_name):
1760
setattr(self, attrname, value)
1762
return property(lambda self: getattr(self, attrname), setter)
1764
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1765
approvals_pending = notifychangeproperty(dbus.Boolean,
1768
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1769
last_enabled = notifychangeproperty(datetime_to_dbus,
1771
checker = notifychangeproperty(
1772
dbus.Boolean, "CheckerRunning",
1773
type_func = lambda checker: checker is not None)
1774
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1776
last_checker_status = notifychangeproperty(dbus.Int16,
1777
"LastCheckerStatus")
1778
last_approval_request = notifychangeproperty(
1779
datetime_to_dbus, "LastApprovalRequest")
1780
approved_by_default = notifychangeproperty(dbus.Boolean,
1781
"ApprovedByDefault")
1782
approval_delay = notifychangeproperty(
1783
dbus.UInt64, "ApprovalDelay",
1784
type_func = lambda td: td.total_seconds() * 1000)
1785
approval_duration = notifychangeproperty(
1786
dbus.UInt64, "ApprovalDuration",
1787
type_func = lambda td: td.total_seconds() * 1000)
1788
host = notifychangeproperty(dbus.String, "Host")
1789
timeout = notifychangeproperty(
1790
dbus.UInt64, "Timeout",
1791
type_func = lambda td: td.total_seconds() * 1000)
1792
extended_timeout = notifychangeproperty(
1793
dbus.UInt64, "ExtendedTimeout",
1794
type_func = lambda td: td.total_seconds() * 1000)
1795
interval = notifychangeproperty(
1796
dbus.UInt64, "Interval",
1797
type_func = lambda td: td.total_seconds() * 1000)
1798
checker_command = notifychangeproperty(dbus.String, "Checker")
1799
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1800
invalidate_only=True)
1802
del notifychangeproperty
759
def _get_approvals_pending(self):
760
return self._approvals_pending
761
def _set_approvals_pending(self, value):
762
old_value = self._approvals_pending
763
self._approvals_pending = value
765
if (hasattr(self, "dbus_object_path")
766
and bval is not bool(old_value)):
767
dbus_bool = dbus.Boolean(bval, variant_level=1)
768
self.PropertyChanged(dbus.String("ApprovalPending"),
771
approvals_pending = property(_get_approvals_pending,
772
_set_approvals_pending)
773
del _get_approvals_pending, _set_approvals_pending
776
def _datetime_to_dbus(dt, variant_level=0):
777
"""Convert a UTC datetime.datetime() to a D-Bus type."""
778
return dbus.String(dt.isoformat(),
779
variant_level=variant_level)
782
oldstate = getattr(self, "enabled", False)
783
r = Client.enable(self)
784
if oldstate != self.enabled:
786
self.PropertyChanged(dbus.String("Enabled"),
787
dbus.Boolean(True, variant_level=1))
788
self.PropertyChanged(
789
dbus.String("LastEnabled"),
790
self._datetime_to_dbus(self.last_enabled,
794
def disable(self, quiet = False):
795
oldstate = getattr(self, "enabled", False)
796
r = Client.disable(self, quiet=quiet)
797
if not quiet and oldstate != self.enabled:
799
self.PropertyChanged(dbus.String("Enabled"),
800
dbus.Boolean(False, variant_level=1))
1804
803
def __del__(self, *args, **kwargs):
1810
809
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1811
810
Client.__del__(self, *args, **kwargs)
1813
def checker_callback(self, source, condition,
1814
connection, command, *args, **kwargs):
1815
ret = Client.checker_callback(self, source, condition,
1816
connection, command, *args,
1818
exitstatus = self.last_checker_status
812
def checker_callback(self, pid, condition, command,
814
self.checker_callback_tag = None
817
self.PropertyChanged(dbus.String("CheckerRunning"),
818
dbus.Boolean(False, variant_level=1))
819
if os.WIFEXITED(condition):
820
exitstatus = os.WEXITSTATUS(condition)
1820
821
# Emit D-Bus signal
1821
822
self.CheckerCompleted(dbus.Int16(exitstatus),
1822
# This is specific to GNU libC
1823
dbus.Int64(exitstatus << 8),
823
dbus.Int64(condition),
1824
824
dbus.String(command))
1826
826
# Emit D-Bus signal
1827
827
self.CheckerCompleted(dbus.Int16(-1),
1829
# This is specific to GNU libC
1831
| self.last_checker_signal),
828
dbus.Int64(condition),
1832
829
dbus.String(command))
831
return Client.checker_callback(self, pid, condition, command,
834
def checked_ok(self, *args, **kwargs):
835
Client.checked_ok(self, *args, **kwargs)
837
self.PropertyChanged(
838
dbus.String("LastCheckedOK"),
839
(self._datetime_to_dbus(self.last_checked_ok,
842
def need_approval(self, *args, **kwargs):
843
r = Client.need_approval(self, *args, **kwargs)
845
self.PropertyChanged(
846
dbus.String("LastApprovalRequest"),
847
(self._datetime_to_dbus(self.last_approval_request,
1835
851
def start_checker(self, *args, **kwargs):
1836
old_checker_pid = getattr(self.checker, "pid", None)
852
old_checker = self.checker
853
if self.checker is not None:
854
old_checker_pid = self.checker.pid
856
old_checker_pid = None
1837
857
r = Client.start_checker(self, *args, **kwargs)
1838
858
# Only if new checker process was started
1839
859
if (self.checker is not None
1840
860
and old_checker_pid != self.checker.pid):
1841
861
# Emit D-Bus signal
1842
862
self.CheckerStarted(self.current_checker_command)
863
self.PropertyChanged(
864
dbus.String("CheckerRunning"),
865
dbus.Boolean(True, variant_level=1))
868
def stop_checker(self, *args, **kwargs):
869
old_checker = getattr(self, "checker", None)
870
r = Client.stop_checker(self, *args, **kwargs)
871
if (old_checker is not None
872
and getattr(self, "checker", None) is None):
873
self.PropertyChanged(dbus.String("CheckerRunning"),
874
dbus.Boolean(False, variant_level=1))
1845
877
def _reset_approved(self):
1846
self.approved = None
878
self._approved = None
1849
881
def approve(self, value=True):
1850
self.approved = value
1851
GLib.timeout_add(int(self.approval_duration.total_seconds()
1852
* 1000), self._reset_approved)
1853
882
self.send_changedstate()
883
self._approved = value
884
gobject.timeout_add(self._timedelta_to_milliseconds
885
(self.approval_duration),
886
self._reset_approved)
1855
889
## D-Bus methods, signals & properties
890
_interface = "se.bsnet.fukt.Mandos.Client"
1945
973
return dbus.Boolean(bool(self.approvals_pending))
1947
975
# ApprovedByDefault - property
1948
@dbus_service_property(_interface,
976
@dbus_service_property(_interface, signature="b",
1950
977
access="readwrite")
1951
978
def ApprovedByDefault_dbus_property(self, value=None):
1952
979
if value is None: # get
1953
980
return dbus.Boolean(self.approved_by_default)
1954
981
self.approved_by_default = bool(value)
983
self.PropertyChanged(dbus.String("ApprovedByDefault"),
984
dbus.Boolean(value, variant_level=1))
1956
986
# ApprovalDelay - property
1957
@dbus_service_property(_interface,
987
@dbus_service_property(_interface, signature="t",
1959
988
access="readwrite")
1960
989
def ApprovalDelay_dbus_property(self, value=None):
1961
990
if value is None: # get
1962
return dbus.UInt64(self.approval_delay.total_seconds()
991
return dbus.UInt64(self.approval_delay_milliseconds())
1964
992
self.approval_delay = datetime.timedelta(0, 0, 0, value)
994
self.PropertyChanged(dbus.String("ApprovalDelay"),
995
dbus.UInt64(value, variant_level=1))
1966
997
# ApprovalDuration - property
1967
@dbus_service_property(_interface,
998
@dbus_service_property(_interface, signature="t",
1969
999
access="readwrite")
1970
1000
def ApprovalDuration_dbus_property(self, value=None):
1971
1001
if value is None: # get
1972
return dbus.UInt64(self.approval_duration.total_seconds()
1002
return dbus.UInt64(self._timedelta_to_milliseconds(
1003
self.approval_duration))
1974
1004
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1006
self.PropertyChanged(dbus.String("ApprovalDuration"),
1007
dbus.UInt64(value, variant_level=1))
1976
1009
# Name - property
1978
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1979
1010
@dbus_service_property(_interface, signature="s", access="read")
1980
1011
def Name_dbus_property(self):
1981
1012
return dbus.String(self.name)
1983
1014
# Fingerprint - property
1985
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1986
1015
@dbus_service_property(_interface, signature="s", access="read")
1987
1016
def Fingerprint_dbus_property(self):
1988
1017
return dbus.String(self.fingerprint)
1990
1019
# Host - property
1991
@dbus_service_property(_interface,
1020
@dbus_service_property(_interface, signature="s",
1993
1021
access="readwrite")
1994
1022
def Host_dbus_property(self, value=None):
1995
1023
if value is None: # get
1996
1024
return dbus.String(self.host)
1997
self.host = str(value)
1027
self.PropertyChanged(dbus.String("Host"),
1028
dbus.String(value, variant_level=1))
1999
1030
# Created - property
2001
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2002
1031
@dbus_service_property(_interface, signature="s", access="read")
2003
1032
def Created_dbus_property(self):
2004
return datetime_to_dbus(self.created)
1033
return dbus.String(self._datetime_to_dbus(self.created))
2006
1035
# LastEnabled - property
2007
1036
@dbus_service_property(_interface, signature="s", access="read")
2008
1037
def LastEnabled_dbus_property(self):
2009
return datetime_to_dbus(self.last_enabled)
1038
if self.last_enabled is None:
1039
return dbus.String("")
1040
return dbus.String(self._datetime_to_dbus(self.last_enabled))
2011
1042
# Enabled - property
2012
@dbus_service_property(_interface,
1043
@dbus_service_property(_interface, signature="b",
2014
1044
access="readwrite")
2015
1045
def Enabled_dbus_property(self, value=None):
2016
1046
if value is None: # get
2023
1053
# LastCheckedOK - property
2024
@dbus_service_property(_interface,
1054
@dbus_service_property(_interface, signature="s",
2026
1055
access="readwrite")
2027
1056
def LastCheckedOK_dbus_property(self, value=None):
2028
1057
if value is not None:
2029
1058
self.checked_ok()
2031
return datetime_to_dbus(self.last_checked_ok)
2033
# LastCheckerStatus - property
2034
@dbus_service_property(_interface, signature="n", access="read")
2035
def LastCheckerStatus_dbus_property(self):
2036
return dbus.Int16(self.last_checker_status)
2038
# Expires - property
2039
@dbus_service_property(_interface, signature="s", access="read")
2040
def Expires_dbus_property(self):
2041
return datetime_to_dbus(self.expires)
1060
if self.last_checked_ok is None:
1061
return dbus.String("")
1062
return dbus.String(self._datetime_to_dbus(self
2043
1065
# LastApprovalRequest - property
2044
1066
@dbus_service_property(_interface, signature="s", access="read")
2045
1067
def LastApprovalRequest_dbus_property(self):
2046
return datetime_to_dbus(self.last_approval_request)
1068
if self.last_approval_request is None:
1069
return dbus.String("")
1070
return dbus.String(self.
1071
_datetime_to_dbus(self
1072
.last_approval_request))
2048
1074
# Timeout - property
2049
@dbus_service_property(_interface,
1075
@dbus_service_property(_interface, signature="t",
2051
1076
access="readwrite")
2052
1077
def Timeout_dbus_property(self, value=None):
2053
1078
if value is None: # get
2054
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2055
old_timeout = self.timeout
1079
return dbus.UInt64(self.timeout_milliseconds())
2056
1080
self.timeout = datetime.timedelta(0, 0, 0, value)
2057
# Reschedule disabling
2059
now = datetime.datetime.utcnow()
2060
self.expires += self.timeout - old_timeout
2061
if self.expires <= now:
2062
# The timeout has passed
2065
if (getattr(self, "disable_initiator_tag", None)
2068
GLib.source_remove(self.disable_initiator_tag)
2069
self.disable_initiator_tag = GLib.timeout_add(
2070
int((self.expires - now).total_seconds() * 1000),
2073
# ExtendedTimeout - property
2074
@dbus_service_property(_interface,
2077
def ExtendedTimeout_dbus_property(self, value=None):
2078
if value is None: # get
2079
return dbus.UInt64(self.extended_timeout.total_seconds()
2081
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1082
self.PropertyChanged(dbus.String("Timeout"),
1083
dbus.UInt64(value, variant_level=1))
1084
if getattr(self, "disable_initiator_tag", None) is None:
1086
# Reschedule timeout
1087
gobject.source_remove(self.disable_initiator_tag)
1088
self.disable_initiator_tag = None
1089
time_to_die = (self.
1090
_timedelta_to_milliseconds((self
1095
if time_to_die <= 0:
1096
# The timeout has passed
1099
self.disable_initiator_tag = (gobject.timeout_add
1100
(time_to_die, self.disable))
2083
1102
# Interval - property
2084
@dbus_service_property(_interface,
1103
@dbus_service_property(_interface, signature="t",
2086
1104
access="readwrite")
2087
1105
def Interval_dbus_property(self, value=None):
2088
1106
if value is None: # get
2089
return dbus.UInt64(self.interval.total_seconds() * 1000)
1107
return dbus.UInt64(self.interval_milliseconds())
2090
1108
self.interval = datetime.timedelta(0, 0, 0, value)
1110
self.PropertyChanged(dbus.String("Interval"),
1111
dbus.UInt64(value, variant_level=1))
2091
1112
if getattr(self, "checker_initiator_tag", None) is None:
2094
# Reschedule checker run
2095
GLib.source_remove(self.checker_initiator_tag)
2096
self.checker_initiator_tag = GLib.timeout_add(
2097
value, self.start_checker)
2098
self.start_checker() # Start one now, too
1114
# Reschedule checker run
1115
gobject.source_remove(self.checker_initiator_tag)
1116
self.checker_initiator_tag = (gobject.timeout_add
1117
(value, self.start_checker))
1118
self.start_checker() # Start one now, too
2100
1120
# Checker - property
2101
@dbus_service_property(_interface,
1121
@dbus_service_property(_interface, signature="s",
2103
1122
access="readwrite")
2104
1123
def Checker_dbus_property(self, value=None):
2105
1124
if value is None: # get
2106
1125
return dbus.String(self.checker_command)
2107
self.checker_command = str(value)
1126
self.checker_command = value
1128
self.PropertyChanged(dbus.String("Checker"),
1129
dbus.String(self.checker_command,
2109
1132
# CheckerRunning - property
2110
@dbus_service_property(_interface,
1133
@dbus_service_property(_interface, signature="b",
2112
1134
access="readwrite")
2113
1135
def CheckerRunning_dbus_property(self, value=None):
2114
1136
if value is None: # get
2330
1359
def fingerprint(openpgp):
2331
1360
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2332
1361
# New GnuTLS "datum" with the OpenPGP public key
2333
datum = gnutls.datum_t(
2334
ctypes.cast(ctypes.c_char_p(openpgp),
2335
ctypes.POINTER(ctypes.c_ubyte)),
2336
ctypes.c_uint(len(openpgp)))
1362
datum = (gnutls.library.types
1363
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1366
ctypes.c_uint(len(openpgp))))
2337
1367
# New empty GnuTLS certificate
2338
crt = gnutls.openpgp_crt_t()
2339
gnutls.openpgp_crt_init(ctypes.byref(crt))
1368
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1369
(gnutls.library.functions
1370
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2340
1371
# Import the OpenPGP public key into the certificate
2341
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2342
gnutls.OPENPGP_FMT_RAW)
1372
(gnutls.library.functions
1373
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1374
gnutls.library.constants
1375
.GNUTLS_OPENPGP_FMT_RAW))
2343
1376
# Verify the self signature in the key
2344
1377
crtverify = ctypes.c_uint()
2345
gnutls.openpgp_crt_verify_self(crt, 0,
2346
ctypes.byref(crtverify))
1378
(gnutls.library.functions
1379
.gnutls_openpgp_crt_verify_self(crt, 0,
1380
ctypes.byref(crtverify)))
2347
1381
if crtverify.value != 0:
2348
gnutls.openpgp_crt_deinit(crt)
2349
raise gnutls.CertificateSecurityError("Verify failed")
1382
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1383
raise (gnutls.errors.CertificateSecurityError
2350
1385
# New buffer for the fingerprint
2351
1386
buf = ctypes.create_string_buffer(20)
2352
1387
buf_len = ctypes.c_size_t()
2353
1388
# Get the fingerprint from the certificate into the buffer
2354
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2355
ctypes.byref(buf_len))
1389
(gnutls.library.functions
1390
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1391
ctypes.byref(buf_len)))
2356
1392
# Deinit the certificate
2357
gnutls.openpgp_crt_deinit(crt)
1393
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2358
1394
# Convert the buffer to a Python bytestring
2359
1395
fpr = ctypes.string_at(buf, buf_len.value)
2360
1396
# Convert the bytestring to hexadecimal notation
2361
hex_fpr = binascii.hexlify(fpr).upper()
1397
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2365
1401
class MultiprocessingMixIn(object):
2366
1402
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2368
1403
def sub_process_main(self, request, address):
2370
1405
self.finish_request(request, address)
2372
1407
self.handle_error(request, address)
2373
1408
self.close_request(request)
2375
1410
def process_request(self, request, address):
2376
1411
"""Start a new process to process the request."""
2377
proc = multiprocessing.Process(target = self.sub_process_main,
2378
args = (request, address))
1412
multiprocessing.Process(target = self.sub_process_main,
1413
args = (request, address)).start()
2383
1415
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2384
1416
""" adds a pipe to the MixIn """
2386
1417
def process_request(self, request, client_address):
2387
1418
"""Overrides and wraps the original process_request().
2389
1420
This function creates a new pipe in self.pipe
2391
1422
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2393
proc = MultiprocessingMixIn.process_request(self, request,
1424
super(MultiprocessingMixInWithPipe,
1425
self).process_request(request, client_address)
2395
1426
self.child_pipe.close()
2396
self.add_pipe(parent_pipe, proc)
2398
def add_pipe(self, parent_pipe, proc):
1427
self.add_pipe(parent_pipe)
1429
def add_pipe(self, parent_pipe):
2399
1430
"""Dummy function; override as necessary"""
2400
raise NotImplementedError()
1431
raise NotImplementedError
2403
1433
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2404
1434
socketserver.TCPServer, object):
2409
1439
interface: None or a network interface name (string)
2410
1440
use_ipv6: Boolean; to use IPv6 or not
2413
1442
def __init__(self, server_address, RequestHandlerClass,
2417
"""If socketfd is set, use that file descriptor instead of
2418
creating a new one with socket.socket().
1443
interface=None, use_ipv6=True):
2420
1444
self.interface = interface
2422
1446
self.address_family = socket.AF_INET6
2423
if socketfd is not None:
2424
# Save the file descriptor
2425
self.socketfd = socketfd
2426
# Save the original socket.socket() function
2427
self.socket_socket = socket.socket
2428
# To implement --socket, we monkey patch socket.socket.
2430
# (When socketserver.TCPServer is a new-style class, we
2431
# could make self.socket into a property instead of monkey
2432
# patching socket.socket.)
2434
# Create a one-time-only replacement for socket.socket()
2435
@functools.wraps(socket.socket)
2436
def socket_wrapper(*args, **kwargs):
2437
# Restore original function so subsequent calls are
2439
socket.socket = self.socket_socket
2440
del self.socket_socket
2441
# This time only, return a new socket object from the
2442
# saved file descriptor.
2443
return socket.fromfd(self.socketfd, *args, **kwargs)
2444
# Replace socket.socket() function with wrapper
2445
socket.socket = socket_wrapper
2446
# The socketserver.TCPServer.__init__ will call
2447
# socket.socket(), which might be our replacement,
2448
# socket_wrapper(), if socketfd was set.
2449
1447
socketserver.TCPServer.__init__(self, server_address,
2450
1448
RequestHandlerClass)
2452
1449
def server_bind(self):
2453
1450
"""This overrides the normal server_bind() function
2454
1451
to bind to an interface if one was specified, and also NOT to
2455
1452
bind to an address or port if they were not specified."""
2456
global SO_BINDTODEVICE
2457
1453
if self.interface is not None:
2458
1454
if SO_BINDTODEVICE is None:
2459
# Fall back to a hard-coded value which seems to be
2461
logger.warning("SO_BINDTODEVICE not found, trying 25")
2462
SO_BINDTODEVICE = 25
2464
self.socket.setsockopt(
2465
socket.SOL_SOCKET, SO_BINDTODEVICE,
2466
(self.interface + "\0").encode("utf-8"))
2467
except socket.error as error:
2468
if error.errno == errno.EPERM:
2469
logger.error("No permission to bind to"
2470
" interface %s", self.interface)
2471
elif error.errno == errno.ENOPROTOOPT:
2472
logger.error("SO_BINDTODEVICE not available;"
2473
" cannot bind to interface %s",
2475
elif error.errno == errno.ENODEV:
2476
logger.error("Interface %s does not exist,"
2477
" cannot bind", self.interface)
1455
logger.error("SO_BINDTODEVICE does not exist;"
1456
" cannot bind to interface %s",
1460
self.socket.setsockopt(socket.SOL_SOCKET,
1464
except socket.error as error:
1465
if error[0] == errno.EPERM:
1466
logger.error("No permission to"
1467
" bind to interface %s",
1469
elif error[0] == errno.ENOPROTOOPT:
1470
logger.error("SO_BINDTODEVICE not available;"
1471
" cannot bind to interface %s",
2480
1475
# Only bind(2) the socket if we really need to.
2481
1476
if self.server_address[0] or self.server_address[1]:
2482
1477
if not self.server_address[0]:
2483
1478
if self.address_family == socket.AF_INET6:
2484
1479
any_address = "::" # in6addr_any
2486
any_address = "0.0.0.0" # INADDR_ANY
1481
any_address = socket.INADDR_ANY
2487
1482
self.server_address = (any_address,
2488
1483
self.server_address[1])
2489
1484
elif not self.server_address[1]:
2490
self.server_address = (self.server_address[0], 0)
1485
self.server_address = (self.server_address[0],
2491
1487
# if self.interface:
2492
1488
# self.server_address = (self.server_address[0],
2505
1501
gnutls_priority GnuTLS priority string
2506
1502
use_dbus: Boolean; to emit D-Bus signals or not
2508
Assumes a GLib.MainLoop event loop.
1504
Assumes a gobject.MainLoop event loop.
2511
1506
def __init__(self, server_address, RequestHandlerClass,
2515
gnutls_priority=None,
1507
interface=None, use_ipv6=True, clients=None,
1508
gnutls_priority=None, use_dbus=True):
2518
1509
self.enabled = False
2519
1510
self.clients = clients
2520
1511
if self.clients is None:
1512
self.clients = set()
2522
1513
self.use_dbus = use_dbus
2523
1514
self.gnutls_priority = gnutls_priority
2524
1515
IPv6_TCPServer.__init__(self, server_address,
2525
1516
RequestHandlerClass,
2526
1517
interface = interface,
2527
use_ipv6 = use_ipv6,
2528
socketfd = socketfd)
1518
use_ipv6 = use_ipv6)
2530
1519
def server_activate(self):
2531
1520
if self.enabled:
2532
1521
return socketserver.TCPServer.server_activate(self)
2534
1522
def enable(self):
2535
1523
self.enabled = True
2537
def add_pipe(self, parent_pipe, proc):
1524
def add_pipe(self, parent_pipe):
2538
1525
# Call "handle_ipc" for both data and EOF events
2540
parent_pipe.fileno(),
2541
GLib.IO_IN | GLib.IO_HUP,
2542
functools.partial(self.handle_ipc,
2543
parent_pipe = parent_pipe,
2546
def handle_ipc(self, source, condition,
1526
gobject.io_add_watch(parent_pipe.fileno(),
1527
gobject.IO_IN | gobject.IO_HUP,
1528
functools.partial(self.handle_ipc,
1529
parent_pipe = parent_pipe))
1531
def handle_ipc(self, source, condition, parent_pipe=None,
2549
1532
client_object=None):
2550
# error, or the other end of multiprocessing.Pipe has closed
2551
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2552
# Wait for other process to exit
1534
gobject.IO_IN: "IN", # There is data to read.
1535
gobject.IO_OUT: "OUT", # Data can be written (without
1537
gobject.IO_PRI: "PRI", # There is urgent data to read.
1538
gobject.IO_ERR: "ERR", # Error condition.
1539
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1540
# broken, usually for pipes and
1543
conditions_string = ' | '.join(name
1545
condition_names.iteritems()
1546
if cond & condition)
1547
# error or the other end of multiprocessing.Pipe has closed
1548
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2556
1551
# Read a request from the child
2561
1556
fpr = request[1]
2562
1557
address = request[2]
2564
for c in self.clients.values():
1559
for c in self.clients:
2565
1560
if c.fingerprint == fpr:
2569
logger.info("Client not found for fingerprint: %s, ad"
2570
"dress: %s", fpr, address)
1564
logger.warning("Client not found for fingerprint: %s, ad"
1565
"dress: %s", fpr, address)
2571
1566
if self.use_dbus:
2572
1567
# Emit D-Bus signal
2573
mandos_dbus_service.ClientNotFound(fpr,
1568
mandos_dbus_service.ClientNotFound(fpr, address[0])
2575
1569
parent_pipe.send(False)
2579
parent_pipe.fileno(),
2580
GLib.IO_IN | GLib.IO_HUP,
2581
functools.partial(self.handle_ipc,
2582
parent_pipe = parent_pipe,
2584
client_object = client))
1572
gobject.io_add_watch(parent_pipe.fileno(),
1573
gobject.IO_IN | gobject.IO_HUP,
1574
functools.partial(self.handle_ipc,
1575
parent_pipe = parent_pipe,
1576
client_object = client))
2585
1577
parent_pipe.send(True)
2586
# remove the old hook in favor of the new above hook on
1578
# remove the old hook in favor of the new above hook on same fileno
2589
1580
if command == 'funcall':
2590
1581
funcname = request[1]
2591
1582
args = request[2]
2592
1583
kwargs = request[3]
2594
parent_pipe.send(('data', getattr(client_object,
1585
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2598
1587
if command == 'getattr':
2599
1588
attrname = request[1]
2600
if isinstance(client_object.__getattribute__(attrname),
2601
collections.Callable):
2602
parent_pipe.send(('function', ))
1589
if callable(client_object.__getattribute__(attrname)):
1590
parent_pipe.send(('function',))
2605
'data', client_object.__getattribute__(attrname)))
1592
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2607
1594
if command == 'setattr':
2608
1595
attrname = request[1]
2609
1596
value = request[2]
2610
1597
setattr(client_object, attrname, value)
2615
def rfc3339_duration_to_delta(duration):
2616
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2618
>>> rfc3339_duration_to_delta("P7D")
2619
datetime.timedelta(7)
2620
>>> rfc3339_duration_to_delta("PT60S")
2621
datetime.timedelta(0, 60)
2622
>>> rfc3339_duration_to_delta("PT60M")
2623
datetime.timedelta(0, 3600)
2624
>>> rfc3339_duration_to_delta("PT24H")
2625
datetime.timedelta(1)
2626
>>> rfc3339_duration_to_delta("P1W")
2627
datetime.timedelta(7)
2628
>>> rfc3339_duration_to_delta("PT5M30S")
2629
datetime.timedelta(0, 330)
2630
>>> rfc3339_duration_to_delta("P1DT3M20S")
2631
datetime.timedelta(1, 200)
2634
# Parsing an RFC 3339 duration with regular expressions is not
2635
# possible - there would have to be multiple places for the same
2636
# values, like seconds. The current code, while more esoteric, is
2637
# cleaner without depending on a parsing library. If Python had a
2638
# built-in library for parsing we would use it, but we'd like to
2639
# avoid excessive use of external libraries.
2641
# New type for defining tokens, syntax, and semantics all-in-one
2642
Token = collections.namedtuple("Token", (
2643
"regexp", # To match token; if "value" is not None, must have
2644
# a "group" containing digits
2645
"value", # datetime.timedelta or None
2646
"followers")) # Tokens valid after this token
2647
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2648
# the "duration" ABNF definition in RFC 3339, Appendix A.
2649
token_end = Token(re.compile(r"$"), None, frozenset())
2650
token_second = Token(re.compile(r"(\d+)S"),
2651
datetime.timedelta(seconds=1),
2652
frozenset((token_end, )))
2653
token_minute = Token(re.compile(r"(\d+)M"),
2654
datetime.timedelta(minutes=1),
2655
frozenset((token_second, token_end)))
2656
token_hour = Token(re.compile(r"(\d+)H"),
2657
datetime.timedelta(hours=1),
2658
frozenset((token_minute, token_end)))
2659
token_time = Token(re.compile(r"T"),
2661
frozenset((token_hour, token_minute,
2663
token_day = Token(re.compile(r"(\d+)D"),
2664
datetime.timedelta(days=1),
2665
frozenset((token_time, token_end)))
2666
token_month = Token(re.compile(r"(\d+)M"),
2667
datetime.timedelta(weeks=4),
2668
frozenset((token_day, token_end)))
2669
token_year = Token(re.compile(r"(\d+)Y"),
2670
datetime.timedelta(weeks=52),
2671
frozenset((token_month, token_end)))
2672
token_week = Token(re.compile(r"(\d+)W"),
2673
datetime.timedelta(weeks=1),
2674
frozenset((token_end, )))
2675
token_duration = Token(re.compile(r"P"), None,
2676
frozenset((token_year, token_month,
2677
token_day, token_time,
2679
# Define starting values
2680
value = datetime.timedelta() # Value so far
2682
followers = frozenset((token_duration, )) # Following valid tokens
2683
s = duration # String left to parse
2684
# Loop until end token is found
2685
while found_token is not token_end:
2686
# Search for any currently valid tokens
2687
for token in followers:
2688
match = token.regexp.match(s)
2689
if match is not None:
2691
if token.value is not None:
2692
# Value found, parse digits
2693
factor = int(match.group(1), 10)
2694
# Add to value so far
2695
value += factor * token.value
2696
# Strip token from string
2697
s = token.regexp.sub("", s, 1)
2700
# Set valid next tokens
2701
followers = found_token.followers
2704
# No currently valid tokens were found
2705
raise ValueError("Invalid RFC 3339 duration: {!r}"
2711
1602
def string_to_delta(interval):
2712
1603
"""Parse a string and return a datetime.timedelta
2842
1736
"debug": "False",
2844
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2845
":+SIGN-DSA-SHA256",
1738
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2846
1739
"servicename": "Mandos",
2847
1740
"use_dbus": "True",
2848
1741
"use_ipv6": "True",
2849
1742
"debuglevel": "",
2852
"statedir": "/var/lib/mandos",
2853
"foreground": "False",
2857
1745
# Parse config file for server-global settings
2858
1746
server_config = configparser.SafeConfigParser(server_defaults)
2859
1747
del server_defaults
2860
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1748
server_config.read(os.path.join(options.configdir,
2861
1750
# Convert the SafeConfigParser object to a dict
2862
1751
server_settings = server_config.defaults()
2863
1752
# Use the appropriate methods on the non-string config options
2864
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1753
for option in ("debug", "use_dbus", "use_ipv6"):
2865
1754
server_settings[option] = server_config.getboolean("DEFAULT",
2867
1756
if server_settings["port"]:
2868
1757
server_settings["port"] = server_config.getint("DEFAULT",
2870
if server_settings["socket"]:
2871
server_settings["socket"] = server_config.getint("DEFAULT",
2873
# Later, stdin will, and stdout and stderr might, be dup'ed
2874
# over with an opened os.devnull. But we don't want this to
2875
# happen with a supplied network socket.
2876
if 0 <= server_settings["socket"] <= 2:
2877
server_settings["socket"] = os.dup(server_settings
2879
1759
del server_config
2881
1761
# Override the settings from the config file with command line
2882
1762
# options, if set.
2883
1763
for option in ("interface", "address", "port", "debug",
2884
"priority", "servicename", "configdir", "use_dbus",
2885
"use_ipv6", "debuglevel", "restore", "statedir",
2886
"socket", "foreground", "zeroconf"):
1764
"priority", "servicename", "configdir",
1765
"use_dbus", "use_ipv6", "debuglevel"):
2887
1766
value = getattr(options, option)
2888
1767
if value is not None:
2889
1768
server_settings[option] = value
2891
1770
# Force all strings to be unicode
2892
1771
for option in server_settings.keys():
2893
if isinstance(server_settings[option], bytes):
2894
server_settings[option] = (server_settings[option]
2896
# Force all boolean options to be boolean
2897
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2898
"foreground", "zeroconf"):
2899
server_settings[option] = bool(server_settings[option])
2900
# Debug implies foreground
2901
if server_settings["debug"]:
2902
server_settings["foreground"] = True
1772
if type(server_settings[option]) is str:
1773
server_settings[option] = unicode(server_settings[option])
2903
1774
# Now we have our good server settings in "server_settings"
2905
1776
##################################################################
2907
if (not server_settings["zeroconf"]
2908
and not (server_settings["port"]
2909
or server_settings["socket"] != "")):
2910
parser.error("Needs port or socket to work without Zeroconf")
2912
1778
# For convenience
2913
1779
debug = server_settings["debug"]
2914
1780
debuglevel = server_settings["debuglevel"]
2915
1781
use_dbus = server_settings["use_dbus"]
2916
1782
use_ipv6 = server_settings["use_ipv6"]
2917
stored_state_path = os.path.join(server_settings["statedir"],
2919
foreground = server_settings["foreground"]
2920
zeroconf = server_settings["zeroconf"]
2923
initlogger(debug, logging.DEBUG)
2928
level = getattr(logging, debuglevel.upper())
2929
initlogger(debug, level)
2931
1784
if server_settings["servicename"] != "Mandos":
2932
syslogger.setFormatter(
2933
logging.Formatter('Mandos ({}) [%(process)d]:'
2934
' %(levelname)s: %(message)s'.format(
2935
server_settings["servicename"])))
1785
syslogger.setFormatter(logging.Formatter
1786
('Mandos (%s) [%%(process)d]:'
1787
' %%(levelname)s: %%(message)s'
1788
% server_settings["servicename"]))
2937
1790
# Parse config file with clients
2938
client_config = configparser.SafeConfigParser(Client
1791
client_defaults = { "timeout": "1h",
1793
"checker": "fping -q -- %%(host)s",
1795
"approval_delay": "0s",
1796
"approval_duration": "1s",
1798
client_config = configparser.SafeConfigParser(client_defaults)
2940
1799
client_config.read(os.path.join(server_settings["configdir"],
2941
1800
"clients.conf"))
2943
1802
global mandos_dbus_service
2944
1803
mandos_dbus_service = None
2947
if server_settings["socket"] != "":
2948
socketfd = server_settings["socket"]
2949
tcp_server = MandosServer(
2950
(server_settings["address"], server_settings["port"]),
2952
interface=(server_settings["interface"] or None),
2954
gnutls_priority=server_settings["priority"],
2958
pidfilename = "/run/mandos.pid"
2959
if not os.path.isdir("/run/."):
2960
pidfilename = "/var/run/mandos.pid"
1805
tcp_server = MandosServer((server_settings["address"],
1806
server_settings["port"]),
1808
interface=(server_settings["interface"]
1812
server_settings["priority"],
1815
pidfilename = "/var/run/mandos.pid"
2963
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2964
except IOError as e:
2965
logger.error("Could not open file %r", pidfilename,
1817
pidfile = open(pidfilename, "w")
1819
logger.error("Could not open file %r", pidfilename)
2968
for name, group in (("_mandos", "_mandos"),
2969
("mandos", "mandos"),
2970
("nobody", "nogroup")):
1822
uid = pwd.getpwnam("_mandos").pw_uid
1823
gid = pwd.getpwnam("_mandos").pw_gid
2972
uid = pwd.getpwnam(name).pw_uid
2973
gid = pwd.getpwnam(group).pw_gid
1826
uid = pwd.getpwnam("mandos").pw_uid
1827
gid = pwd.getpwnam("mandos").pw_gid
2975
1828
except KeyError:
1830
uid = pwd.getpwnam("nobody").pw_uid
1831
gid = pwd.getpwnam("nobody").pw_gid
2984
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2986
1838
except OSError as error:
2987
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2988
.format(uid, gid, os.strerror(error.errno)))
2989
if error.errno != errno.EPERM:
1839
if error[0] != errno.EPERM:
1842
if not debug and not debuglevel:
1843
syslogger.setLevel(logging.WARNING)
1844
console.setLevel(logging.WARNING)
1846
level = getattr(logging, debuglevel.upper())
1847
syslogger.setLevel(level)
1848
console.setLevel(level)
2993
1851
# Enable all possible GnuTLS debugging
2995
1853
# "Use a log level over 10 to enable all debugging options."
2996
1854
# - GnuTLS manual
2997
gnutls.global_set_log_level(11)
1855
gnutls.library.functions.gnutls_global_set_log_level(11)
1857
@gnutls.library.types.gnutls_log_func
3000
1858
def debug_gnutls(level, string):
3001
1859
logger.debug("GnuTLS: %s", string[:-1])
3003
gnutls.global_set_log_function(debug_gnutls)
1861
(gnutls.library.functions
1862
.gnutls_global_set_log_function(debug_gnutls))
3005
1864
# Redirect stdin so all checkers get /dev/null
3006
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1865
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3007
1866
os.dup2(null, sys.stdin.fileno())
1870
# No console logging
1871
logger.removeHandler(console)
3011
1873
# Need to fork before connecting to D-Bus
3013
1875
# Close all input and output, do double fork, etc.
3016
# multiprocessing will use threads, so before we use GLib we need
3017
# to inform GLib that threads will be used.
3020
1878
global main_loop
3021
1879
# From the Avahi example code
3022
DBusGMainLoop(set_as_default=True)
3023
main_loop = GLib.MainLoop()
1880
DBusGMainLoop(set_as_default=True )
1881
main_loop = gobject.MainLoop()
3024
1882
bus = dbus.SystemBus()
3025
1883
# End of Avahi example code
3028
bus_name = dbus.service.BusName("se.recompile.Mandos",
3031
old_bus_name = dbus.service.BusName(
3032
"se.bsnet.fukt.Mandos", bus,
3034
except dbus.exceptions.DBusException as e:
3035
logger.error("Disabling D-Bus:", exc_info=e)
1886
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1887
bus, do_not_queue=True)
1888
except dbus.exceptions.NameExistsException as e:
1889
logger.error(unicode(e) + ", disabling D-Bus")
3036
1890
use_dbus = False
3037
1891
server_settings["use_dbus"] = False
3038
1892
tcp_server.use_dbus = False
3040
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3041
service = AvahiServiceToSyslog(
3042
name = server_settings["servicename"],
3043
servicetype = "_mandos._tcp",
3044
protocol = protocol,
3046
if server_settings["interface"]:
3047
service.interface = if_nametoindex(
3048
server_settings["interface"].encode("utf-8"))
1893
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1894
service = AvahiService(name = server_settings["servicename"],
1895
servicetype = "_mandos._tcp",
1896
protocol = protocol, bus = bus)
1897
if server_settings["interface"]:
1898
service.interface = (if_nametoindex
1899
(str(server_settings["interface"])))
3050
1901
global multiprocessing_manager
3051
1902
multiprocessing_manager = multiprocessing.Manager()
3053
1904
client_class = Client
3055
1906
client_class = functools.partial(ClientDBus, bus = bus)
3057
client_settings = Client.config_parser(client_config)
3058
old_client_settings = {}
3061
# This is used to redirect stdout and stderr for checker processes
3063
wnull = open(os.devnull, "w") # A writable /dev/null
3064
# Only used if server is running in foreground but not in debug
3066
if debug or not foreground:
3069
# Get client data and settings from last running state.
3070
if server_settings["restore"]:
3072
with open(stored_state_path, "rb") as stored_state:
3073
if sys.version_info.major == 2:
3074
clients_data, old_client_settings = pickle.load(
3077
bytes_clients_data, bytes_old_client_settings = (
3078
pickle.load(stored_state, encoding = "bytes"))
3079
### Fix bytes to strings
3082
clients_data = { (key.decode("utf-8")
3083
if isinstance(key, bytes)
3086
bytes_clients_data.items() }
3087
del bytes_clients_data
3088
for key in clients_data:
3089
value = { (k.decode("utf-8")
3090
if isinstance(k, bytes) else k): v
3092
clients_data[key].items() }
3093
clients_data[key] = value
3095
value["client_structure"] = [
3097
if isinstance(s, bytes)
3099
value["client_structure"] ]
3101
for k in ("name", "host"):
3102
if isinstance(value[k], bytes):
3103
value[k] = value[k].decode("utf-8")
3104
## old_client_settings
3106
old_client_settings = {
3107
(key.decode("utf-8")
3108
if isinstance(key, bytes)
3111
bytes_old_client_settings.items() }
3112
del bytes_old_client_settings
3114
for value in old_client_settings.values():
3115
if isinstance(value["host"], bytes):
3116
value["host"] = (value["host"]
3118
os.remove(stored_state_path)
3119
except IOError as e:
3120
if e.errno == errno.ENOENT:
3121
logger.warning("Could not load persistent state:"
3122
" {}".format(os.strerror(e.errno)))
3124
logger.critical("Could not load persistent state:",
3127
except EOFError as e:
3128
logger.warning("Could not load persistent state: "
3132
with PGPEngine() as pgp:
3133
for client_name, client in clients_data.items():
3134
# Skip removed clients
3135
if client_name not in client_settings:
3138
# Decide which value to use after restoring saved state.
3139
# We have three different values: Old config file,
3140
# new config file, and saved state.
3141
# New config value takes precedence if it differs from old
3142
# config value, otherwise use saved state.
3143
for name, value in client_settings[client_name].items():
3145
# For each value in new config, check if it
3146
# differs from the old config value (Except for
3147
# the "secret" attribute)
3148
if (name != "secret"
3150
old_client_settings[client_name][name])):
3151
client[name] = value
3155
# Clients who has passed its expire date can still be
3156
# enabled if its last checker was successful. A Client
3157
# whose checker succeeded before we stored its state is
3158
# assumed to have successfully run all checkers during
3160
if client["enabled"]:
3161
if datetime.datetime.utcnow() >= client["expires"]:
3162
if not client["last_checked_ok"]:
3164
"disabling client {} - Client never "
3165
"performed a successful checker".format(
3167
client["enabled"] = False
3168
elif client["last_checker_status"] != 0:
3170
"disabling client {} - Client last"
3171
" checker failed with error code"
3174
client["last_checker_status"]))
3175
client["enabled"] = False
3177
client["expires"] = (
3178
datetime.datetime.utcnow()
3179
+ client["timeout"])
3180
logger.debug("Last checker succeeded,"
3181
" keeping {} enabled".format(
1907
def client_config_items(config, section):
1908
special_settings = {
1909
"approved_by_default":
1910
lambda: config.getboolean(section,
1911
"approved_by_default"),
1913
for name, value in config.items(section):
3184
client["secret"] = pgp.decrypt(
3185
client["encrypted_secret"],
3186
client_settings[client_name]["secret"])
3188
# If decryption fails, we use secret from new settings
3189
logger.debug("Failed to decrypt {} old secret".format(
3191
client["secret"] = (client_settings[client_name]
3194
# Add/remove clients based on new changes made to config
3195
for client_name in (set(old_client_settings)
3196
- set(client_settings)):
3197
del clients_data[client_name]
3198
for client_name in (set(client_settings)
3199
- set(old_client_settings)):
3200
clients_data[client_name] = client_settings[client_name]
3202
# Create all client objects
3203
for client_name, client in clients_data.items():
3204
tcp_server.clients[client_name] = client_class(
3207
server_settings = server_settings)
1915
yield (name, special_settings[name]())
1919
tcp_server.clients.update(set(
1920
client_class(name = section,
1921
config= dict(client_config_items(
1922
client_config, section)))
1923
for section in client_config.sections()))
3209
1924
if not tcp_server.clients:
3210
1925
logger.warning("No clients defined")
3213
if pidfile is not None:
3217
print(pid, file=pidfile)
3219
logger.error("Could not write to file %r with PID %d",
1931
pidfile.write(str(pid) + "\n".encode("utf-8"))
1934
logger.error("Could not write to file %r with PID %d",
1937
# "pidfile" was never created
3222
1939
del pidfilename
3224
for termsig in (signal.SIGHUP, signal.SIGTERM):
3225
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3226
lambda: main_loop.quit() and False)
1941
signal.signal(signal.SIGINT, signal.SIG_IGN)
1943
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1944
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3230
@alternate_dbus_interfaces(
3231
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3232
class MandosDBusService(DBusObjectWithObjectManager):
1947
class MandosDBusService(dbus.service.Object):
3233
1948
"""A D-Bus proxy object"""
3235
1949
def __init__(self):
3236
1950
dbus.service.Object.__init__(self, bus, "/")
3238
_interface = "se.recompile.Mandos"
1951
_interface = "se.bsnet.fukt.Mandos"
3240
1953
@dbus.service.signal(_interface, signature="o")
3241
1954
def ClientAdded(self, objpath):
3250
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3252
1963
@dbus.service.signal(_interface, signature="os")
3253
1964
def ClientRemoved(self, objpath, name):
3257
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3259
1968
@dbus.service.method(_interface, out_signature="ao")
3260
1969
def GetAllClients(self):
3262
return dbus.Array(c.dbus_object_path for c in
3263
tcp_server.clients.values())
1971
return dbus.Array(c.dbus_object_path
1972
for c in tcp_server.clients)
3265
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3267
1974
@dbus.service.method(_interface,
3268
1975
out_signature="a{oa{sv}}")
3269
1976
def GetAllClientsWithProperties(self):
3271
1978
return dbus.Dictionary(
3272
{ c.dbus_object_path: c.GetAll(
3273
"se.recompile.Mandos.Client")
3274
for c in tcp_server.clients.values() },
1979
((c.dbus_object_path, c.GetAll(""))
1980
for c in tcp_server.clients),
3275
1981
signature="oa{sv}")
3277
1983
@dbus.service.method(_interface, in_signature="o")
3278
1984
def RemoveClient(self, object_path):
3280
for c in tcp_server.clients.values():
1986
for c in tcp_server.clients:
3281
1987
if c.dbus_object_path == object_path:
3282
del tcp_server.clients[c.name]
1988
tcp_server.clients.remove(c)
3283
1989
c.remove_from_connection()
3284
# Don't signal the disabling
1990
# Don't signal anything except ClientRemoved
3285
1991
c.disable(quiet=True)
3286
# Emit D-Bus signal for removal
3287
self.client_removed_signal(c)
1993
self.ClientRemoved(object_path, c.name)
3289
1995
raise KeyError(object_path)
3293
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3294
out_signature = "a{oa{sa{sv}}}")
3295
def GetManagedObjects(self):
3297
return dbus.Dictionary(
3298
{ client.dbus_object_path:
3300
{ interface: client.GetAll(interface)
3302
client._get_all_interface_names()})
3303
for client in tcp_server.clients.values()})
3305
def client_added_signal(self, client):
3306
"""Send the new standard signal and the old signal"""
3308
# New standard signal
3309
self.InterfacesAdded(
3310
client.dbus_object_path,
3312
{ interface: client.GetAll(interface)
3314
client._get_all_interface_names()}))
3316
self.ClientAdded(client.dbus_object_path)
3318
def client_removed_signal(self, client):
3319
"""Send the new standard signal and the old signal"""
3321
# New standard signal
3322
self.InterfacesRemoved(
3323
client.dbus_object_path,
3324
client._get_all_interface_names())
3326
self.ClientRemoved(client.dbus_object_path,
3329
1999
mandos_dbus_service = MandosDBusService()
3331
# Save modules to variables to exempt the modules from being
3332
# unloaded before the function registered with atexit() is run.
3333
mp = multiprocessing
3336
2002
"Cleanup function; run on exit"
3340
mp.active_children()
3342
if not (tcp_server.clients or client_settings):
3345
# Store client before exiting. Secrets are encrypted with key
3346
# based on what config file has. If config file is
3347
# removed/edited, old secret will thus be unrecovable.
3349
with PGPEngine() as pgp:
3350
for client in tcp_server.clients.values():
3351
key = client_settings[client.name]["secret"]
3352
client.encrypted_secret = pgp.encrypt(client.secret,
3356
# A list of attributes that can not be pickled
3358
exclude = { "bus", "changedstate", "secret",
3359
"checker", "server_settings" }
3360
for name, typ in inspect.getmembers(dbus.service
3364
client_dict["encrypted_secret"] = (client
3366
for attr in client.client_structure:
3367
if attr not in exclude:
3368
client_dict[attr] = getattr(client, attr)
3370
clients[client.name] = client_dict
3371
del client_settings[client.name]["secret"]
3374
with tempfile.NamedTemporaryFile(
3378
dir=os.path.dirname(stored_state_path),
3379
delete=False) as stored_state:
3380
pickle.dump((clients, client_settings), stored_state,
3382
tempname = stored_state.name
3383
os.rename(tempname, stored_state_path)
3384
except (IOError, OSError) as e:
3390
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3391
logger.warning("Could not save persistent state: {}"
3392
.format(os.strerror(e.errno)))
3394
logger.warning("Could not save persistent state:",
3398
# Delete all clients, and settings from config
3399
2005
while tcp_server.clients:
3400
name, client = tcp_server.clients.popitem()
2006
client = tcp_server.clients.pop()
3402
2008
client.remove_from_connection()
3403
# Don't signal the disabling
2009
client.disable_hook = None
2010
# Don't signal anything except ClientRemoved
3404
2011
client.disable(quiet=True)
3405
# Emit D-Bus signal for removal
3407
mandos_dbus_service.client_removed_signal(client)
3408
client_settings.clear()
2014
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3410
2017
atexit.register(cleanup)
3412
for client in tcp_server.clients.values():
2019
for client in tcp_server.clients:
3414
# Emit D-Bus signal for adding
3415
mandos_dbus_service.client_added_signal(client)
3416
# Need to initiate checking of clients
3418
client.init_checker()
2022
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3420
2025
tcp_server.enable()
3421
2026
tcp_server.server_activate()
3423
2028
# Find out what port we got
3425
service.port = tcp_server.socket.getsockname()[1]
2029
service.port = tcp_server.socket.getsockname()[1]
3427
2031
logger.info("Now listening on address %r, port %d,"
3428
" flowinfo %d, scope_id %d",
3429
*tcp_server.socket.getsockname())
2032
" flowinfo %d, scope_id %d"
2033
% tcp_server.socket.getsockname())
3431
logger.info("Now listening on address %r, port %d",
3432
*tcp_server.socket.getsockname())
2035
logger.info("Now listening on address %r, port %d"
2036
% tcp_server.socket.getsockname())
3434
2038
#service.interface = tcp_server.socket.getsockname()[3]
3438
# From the Avahi example code
3441
except dbus.exceptions.DBusException as error:
3442
logger.critical("D-Bus Exception", exc_info=error)
3445
# End of Avahi example code
2041
# From the Avahi example code
2044
except dbus.exceptions.DBusException as error:
2045
logger.critical("DBusException: %s", error)
2048
# End of Avahi example code
3447
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3448
lambda *args, **kwargs:
3449
(tcp_server.handle_request
3450
(*args[2:], **kwargs) or True))
2050
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2051
lambda *args, **kwargs:
2052
(tcp_server.handle_request
2053
(*args[2:], **kwargs) or True))
3452
2055
logger.debug("Starting main loop")
3453
2056
main_loop.run()
3454
2057
except AvahiError as error:
3455
logger.critical("Avahi Error", exc_info=error)
2058
logger.critical("AvahiError: %s", error)
3458
2061
except KeyboardInterrupt: