69
import cPickle as pickle
63
import cPickle as pickle
72
64
import multiprocessing
81
68
import dbus.service
82
from gi.repository import GLib
83
71
from dbus.mainloop.glib import DBusGMainLoop
86
74
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
78
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
94
79
except AttributeError:
96
# This is where SO_BINDTODEVICE was up to and including Python
98
81
from IN import SO_BINDTODEVICE
99
82
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,
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
276
# Pretend that we have an Avahi module
278
"""This isn't so much a class as it is a module-like namespace.
279
It is instantiated once, and simulates having an Avahi module."""
280
IF_UNSPEC = -1 # avahi-common/address.h
281
PROTO_UNSPEC = -1 # avahi-common/address.h
282
PROTO_INET = 0 # avahi-common/address.h
283
PROTO_INET6 = 1 # avahi-common/address.h
284
DBUS_NAME = "org.freedesktop.Avahi"
285
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
286
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
287
DBUS_PATH_SERVER = "/"
289
def string_array_to_txt_array(self, t):
290
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
291
for s in t), signature="ay")
292
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
293
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
294
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
295
SERVER_INVALID = 0 # avahi-common/defs.h
296
SERVER_REGISTERING = 1 # avahi-common/defs.h
297
SERVER_RUNNING = 2 # avahi-common/defs.h
298
SERVER_COLLISION = 3 # avahi-common/defs.h
299
SERVER_FAILURE = 4 # avahi-common/defs.h
83
SO_BINDTODEVICE = None
88
#logger = logging.getLogger('mandos')
89
logger = logging.Logger('mandos')
90
syslogger = (logging.handlers.SysLogHandler
91
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
address = str("/dev/log")))
93
syslogger.setFormatter(logging.Formatter
94
('Mandos [%(process)d]: %(levelname)s:'
96
logger.addHandler(syslogger)
98
console = logging.StreamHandler()
99
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
102
logger.addHandler(console)
303
104
class AvahiError(Exception):
304
105
def __init__(self, value, *args, **kwargs):
305
106
self.value = value
306
return super(AvahiError, self).__init__(value, *args,
107
super(AvahiError, self).__init__(value, *args, **kwargs)
108
def __unicode__(self):
109
return unicode(repr(self.value))
310
111
class AvahiServiceError(AvahiError):
314
114
class AvahiGroupError(AvahiError):
318
118
class AvahiService(object):
319
119
"""An Avahi (Zeroconf) service.
322
122
interface: integer; avahi.IF_UNSPEC or an interface index.
323
123
Used to optionally bind to the specified interface.
324
124
name: string; Example: 'Mandos'
325
125
type: string; Example: '_mandos._tcp'.
326
See <https://www.iana.org/assignments/service-names-port-numbers>
126
See <http://www.dns-sd.org/ServiceTypes.html>
327
127
port: integer; what port to announce
328
128
TXT: list of strings; TXT record for the service
329
129
domain: string; Domain to publish on, default to .local if empty.
488
261
follow_name_owner_changes=True),
489
262
avahi.DBUS_INTERFACE_SERVER)
490
263
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
264
self.server_state_changed)
492
265
self.server_state_changed(self.server.GetState())
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
"""Add the new name to the syslog messages"""
498
ret = AvahiService.rename(self, *args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
505
# Pretend that we have a GnuTLS module
506
class GnuTLS(object):
507
"""This isn't so much a class as it is a module-like namespace.
508
It is instantiated once, and simulates having a GnuTLS module."""
510
library = ctypes.util.find_library("gnutls")
512
library = ctypes.util.find_library("gnutls-deb0")
513
_library = ctypes.cdll.LoadLibrary(library)
515
_need_version = b"3.3.0"
518
# Need to use "self" here, since this method is called before
519
# the assignment to the "gnutls" global variable happens.
520
if self.check_version(self._need_version) is None:
521
raise self.Error("Needs GnuTLS {} or later"
522
.format(self._need_version))
524
# Unless otherwise indicated, the constants and types below are
525
# all from the gnutls/gnutls.h C header file.
535
E_NO_CERTIFICATE_FOUND = -49
536
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
539
class session_int(ctypes.Structure):
541
session_t = ctypes.POINTER(session_int)
543
class certificate_credentials_st(ctypes.Structure):
545
certificate_credentials_t = ctypes.POINTER(
546
certificate_credentials_st)
547
certificate_type_t = ctypes.c_int
549
class datum_t(ctypes.Structure):
550
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
551
('size', ctypes.c_uint)]
553
class openpgp_crt_int(ctypes.Structure):
555
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
556
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
557
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
558
credentials_type_t = ctypes.c_int
559
transport_ptr_t = ctypes.c_void_p
560
close_request_t = ctypes.c_int
563
class Error(Exception):
564
# We need to use the class name "GnuTLS" here, since this
565
# exception might be raised from within GnuTLS.__init__,
566
# which is called before the assignment to the "gnutls"
567
# global variable has happened.
568
def __init__(self, message=None, code=None, args=()):
569
# Default usage is by a message string, but if a return
570
# code is passed, convert it to a string with
573
if message is None and code is not None:
574
message = GnuTLS.strerror(code)
575
return super(GnuTLS.Error, self).__init__(
578
class CertificateSecurityError(Error):
582
class Credentials(object):
584
self._c_object = gnutls.certificate_credentials_t()
585
gnutls.certificate_allocate_credentials(
586
ctypes.byref(self._c_object))
587
self.type = gnutls.CRD_CERTIFICATE
590
gnutls.certificate_free_credentials(self._c_object)
592
class ClientSession(object):
593
def __init__(self, socket, credentials=None):
594
self._c_object = gnutls.session_t()
595
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
596
gnutls.set_default_priority(self._c_object)
597
gnutls.transport_set_ptr(self._c_object, socket.fileno())
598
gnutls.handshake_set_private_extensions(self._c_object,
601
if credentials is None:
602
credentials = gnutls.Credentials()
603
gnutls.credentials_set(self._c_object, credentials.type,
604
ctypes.cast(credentials._c_object,
606
self.credentials = credentials
609
gnutls.deinit(self._c_object)
612
return gnutls.handshake(self._c_object)
614
def send(self, data):
618
data_len -= gnutls.record_send(self._c_object,
623
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
625
# Error handling functions
626
def _error_code(result):
627
"""A function to raise exceptions on errors, suitable
628
for the 'restype' attribute on ctypes functions"""
631
if result == gnutls.E_NO_CERTIFICATE_FOUND:
632
raise gnutls.CertificateSecurityError(code=result)
633
raise gnutls.Error(code=result)
635
def _retry_on_error(result, func, arguments):
636
"""A function to retry on some errors, suitable
637
for the 'errcheck' attribute on ctypes functions"""
639
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
640
return _error_code(result)
641
result = func(*arguments)
644
# Unless otherwise indicated, the function declarations below are
645
# all from the gnutls/gnutls.h C header file.
648
priority_set_direct = _library.gnutls_priority_set_direct
649
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
650
ctypes.POINTER(ctypes.c_char_p)]
651
priority_set_direct.restype = _error_code
653
init = _library.gnutls_init
654
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
655
init.restype = _error_code
657
set_default_priority = _library.gnutls_set_default_priority
658
set_default_priority.argtypes = [session_t]
659
set_default_priority.restype = _error_code
661
record_send = _library.gnutls_record_send
662
record_send.argtypes = [session_t, ctypes.c_void_p,
664
record_send.restype = ctypes.c_ssize_t
665
record_send.errcheck = _retry_on_error
667
certificate_allocate_credentials = (
668
_library.gnutls_certificate_allocate_credentials)
669
certificate_allocate_credentials.argtypes = [
670
ctypes.POINTER(certificate_credentials_t)]
671
certificate_allocate_credentials.restype = _error_code
673
certificate_free_credentials = (
674
_library.gnutls_certificate_free_credentials)
675
certificate_free_credentials.argtypes = [
676
certificate_credentials_t]
677
certificate_free_credentials.restype = None
679
handshake_set_private_extensions = (
680
_library.gnutls_handshake_set_private_extensions)
681
handshake_set_private_extensions.argtypes = [session_t,
683
handshake_set_private_extensions.restype = None
685
credentials_set = _library.gnutls_credentials_set
686
credentials_set.argtypes = [session_t, credentials_type_t,
688
credentials_set.restype = _error_code
690
strerror = _library.gnutls_strerror
691
strerror.argtypes = [ctypes.c_int]
692
strerror.restype = ctypes.c_char_p
694
certificate_type_get = _library.gnutls_certificate_type_get
695
certificate_type_get.argtypes = [session_t]
696
certificate_type_get.restype = _error_code
698
certificate_get_peers = _library.gnutls_certificate_get_peers
699
certificate_get_peers.argtypes = [session_t,
700
ctypes.POINTER(ctypes.c_uint)]
701
certificate_get_peers.restype = ctypes.POINTER(datum_t)
703
global_set_log_level = _library.gnutls_global_set_log_level
704
global_set_log_level.argtypes = [ctypes.c_int]
705
global_set_log_level.restype = None
707
global_set_log_function = _library.gnutls_global_set_log_function
708
global_set_log_function.argtypes = [log_func]
709
global_set_log_function.restype = None
711
deinit = _library.gnutls_deinit
712
deinit.argtypes = [session_t]
713
deinit.restype = None
715
handshake = _library.gnutls_handshake
716
handshake.argtypes = [session_t]
717
handshake.restype = _error_code
718
handshake.errcheck = _retry_on_error
720
transport_set_ptr = _library.gnutls_transport_set_ptr
721
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
722
transport_set_ptr.restype = None
724
bye = _library.gnutls_bye
725
bye.argtypes = [session_t, close_request_t]
726
bye.restype = _error_code
727
bye.errcheck = _retry_on_error
729
check_version = _library.gnutls_check_version
730
check_version.argtypes = [ctypes.c_char_p]
731
check_version.restype = ctypes.c_char_p
733
# All the function declarations below are from gnutls/openpgp.h
735
openpgp_crt_init = _library.gnutls_openpgp_crt_init
736
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
737
openpgp_crt_init.restype = _error_code
739
openpgp_crt_import = _library.gnutls_openpgp_crt_import
740
openpgp_crt_import.argtypes = [openpgp_crt_t,
741
ctypes.POINTER(datum_t),
743
openpgp_crt_import.restype = _error_code
745
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
746
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
747
ctypes.POINTER(ctypes.c_uint)]
748
openpgp_crt_verify_self.restype = _error_code
750
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
751
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
752
openpgp_crt_deinit.restype = None
754
openpgp_crt_get_fingerprint = (
755
_library.gnutls_openpgp_crt_get_fingerprint)
756
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
760
openpgp_crt_get_fingerprint.restype = _error_code
762
# Remove non-public functions
763
del _error_code, _retry_on_error
764
# Create the global "gnutls" object, simulating a module
768
def call_pipe(connection, # : multiprocessing.Connection
769
func, *args, **kwargs):
770
"""This function is meant to be called by multiprocessing.Process
772
This function runs func(*args, **kwargs), and writes the resulting
773
return value on the provided multiprocessing.Connection.
775
connection.send(func(*args, **kwargs))
268
def _timedelta_to_milliseconds(td):
269
"Convert a datetime.timedelta() to milliseconds"
270
return ((td.days * 24 * 60 * 60 * 1000)
271
+ (td.seconds * 1000)
272
+ (td.microseconds // 1000))
779
274
class Client(object):
780
275
"""A representation of a client host served by this server.
783
approved: bool(); 'None' if not yet approved/disapproved
278
_approved: bool(); 'None' if not yet approved/disapproved
784
279
approval_delay: datetime.timedelta(); Time to wait for approval
785
280
approval_duration: datetime.timedelta(); Duration of one approval
786
281
checker: subprocess.Popen(); a running checker process used
787
282
to see if the client lives.
788
283
'None' if no process is running.
789
checker_callback_tag: a GLib event source tag, or None
284
checker_callback_tag: a gobject event source tag, or None
790
285
checker_command: string; External command which is run to check
791
286
if client lives. %() expansions are done at
792
287
runtime with vars(self) as dict, so that for
793
288
instance %(name)s can be used in the command.
794
checker_initiator_tag: a GLib event source tag, or None
289
checker_initiator_tag: a gobject event source tag, or None
795
290
created: datetime.datetime(); (UTC) object creation
796
client_structure: Object describing what attributes a client has
797
and is used for storing the client at exit
798
291
current_checker_command: string; current running checker_command
799
disable_initiator_tag: a GLib event source tag, or None
292
disable_hook: If set, called by disable() as disable_hook(self)
293
disable_initiator_tag: a gobject event source tag, or None
801
295
fingerprint: string (40 or 32 hexadecimal digits); used to
802
296
uniquely identify the client
804
298
interval: datetime.timedelta(); How often to start a new checker
805
299
last_approval_request: datetime.datetime(); (UTC) or None
806
300
last_checked_ok: datetime.datetime(); (UTC) or None
807
last_checker_status: integer between 0 and 255 reflecting exit
808
status of last checker. -1 reflects crashed
809
checker, -2 means no checker completed yet.
810
last_checker_signal: The signal which killed the last checker, if
811
last_checker_status is -1
812
last_enabled: datetime.datetime(); (UTC) or None
301
last_enabled: datetime.datetime(); (UTC)
813
302
name: string; from the config file, used in log messages and
814
303
D-Bus identifiers
815
304
secret: bytestring; sent verbatim (over TLS) to client
816
305
timeout: datetime.timedelta(); How long from last_checked_ok
817
306
until this client is disabled
818
extended_timeout: extra long timeout when secret has been sent
307
extended_timeout: extra long timeout when password has been sent
819
308
runtime_expansions: Allowed attributes for runtime expansion.
820
309
expires: datetime.datetime(); time (UTC) when a client will be
821
310
disabled, or None
822
server_settings: The server_settings dict from main()
825
313
runtime_expansions = ("approval_delay", "approval_duration",
826
"created", "enabled", "expires",
827
"fingerprint", "host", "interval",
828
"last_approval_request", "last_checked_ok",
314
"created", "enabled", "fingerprint",
315
"host", "interval", "last_checked_ok",
829
316
"last_enabled", "name", "timeout")
832
"extended_timeout": "PT15M",
834
"checker": "fping -q -- %%(host)s",
836
"approval_delay": "PT0S",
837
"approval_duration": "PT1S",
838
"approved_by_default": "True",
843
def config_parser(config):
844
"""Construct a new dict of client settings of this form:
845
{ client_name: {setting_name: value, ...}, ...}
846
with exceptions for any special settings as defined above.
847
NOTE: Must be a pure function. Must return the same result
848
value given the same arguments.
851
for client_name in config.sections():
852
section = dict(config.items(client_name))
853
client = settings[client_name] = {}
855
client["host"] = section["host"]
856
# Reformat values from string types to Python types
857
client["approved_by_default"] = config.getboolean(
858
client_name, "approved_by_default")
859
client["enabled"] = config.getboolean(client_name,
862
# Uppercase and remove spaces from fingerprint for later
863
# comparison purposes with return value from the
864
# fingerprint() function
865
client["fingerprint"] = (section["fingerprint"].upper()
867
if "secret" in section:
868
client["secret"] = codecs.decode(section["secret"]
871
elif "secfile" in section:
872
with open(os.path.expanduser(os.path.expandvars
873
(section["secfile"])),
875
client["secret"] = secfile.read()
877
raise TypeError("No secret or secfile for section {}"
879
client["timeout"] = string_to_delta(section["timeout"])
880
client["extended_timeout"] = string_to_delta(
881
section["extended_timeout"])
882
client["interval"] = string_to_delta(section["interval"])
883
client["approval_delay"] = string_to_delta(
884
section["approval_delay"])
885
client["approval_duration"] = string_to_delta(
886
section["approval_duration"])
887
client["checker_command"] = section["checker"]
888
client["last_approval_request"] = None
889
client["last_checked_ok"] = None
890
client["last_checker_status"] = -2
894
def __init__(self, settings, name=None, server_settings=None):
318
def timeout_milliseconds(self):
319
"Return the 'timeout' attribute in milliseconds"
320
return _timedelta_to_milliseconds(self.timeout)
322
def extended_timeout_milliseconds(self):
323
"Return the 'extended_timeout' attribute in milliseconds"
324
return _timedelta_to_milliseconds(self.extended_timeout)
326
def interval_milliseconds(self):
327
"Return the 'interval' attribute in milliseconds"
328
return _timedelta_to_milliseconds(self.interval)
330
def approval_delay_milliseconds(self):
331
return _timedelta_to_milliseconds(self.approval_delay)
333
def __init__(self, name = None, disable_hook=None, config=None):
334
"""Note: the 'checker' key in 'config' sets the
335
'checker_command' attribute and *not* the 'checker'
896
if server_settings is None:
898
self.server_settings = server_settings
899
# adding all client settings
900
for setting, value in settings.items():
901
setattr(self, setting, value)
904
if not hasattr(self, "last_enabled"):
905
self.last_enabled = datetime.datetime.utcnow()
906
if not hasattr(self, "expires"):
907
self.expires = (datetime.datetime.utcnow()
910
self.last_enabled = None
913
340
logger.debug("Creating client %r", self.name)
341
# Uppercase and remove spaces from fingerprint for later
342
# comparison purposes with return value from the fingerprint()
344
self.fingerprint = (config["fingerprint"].upper()
914
346
logger.debug(" Fingerprint: %s", self.fingerprint)
915
self.created = settings.get("created",
916
datetime.datetime.utcnow())
918
# attributes specific for this server instance
347
if "secret" in config:
348
self.secret = config["secret"].decode("base64")
349
elif "secfile" in config:
350
with open(os.path.expanduser(os.path.expandvars
351
(config["secfile"])),
353
self.secret = secfile.read()
355
raise TypeError("No secret or secfile for client %s"
357
self.host = config.get("host", "")
358
self.created = datetime.datetime.utcnow()
360
self.last_approval_request = None
361
self.last_enabled = None
362
self.last_checked_ok = None
363
self.timeout = string_to_delta(config["timeout"])
364
self.extended_timeout = string_to_delta(config["extended_timeout"])
365
self.interval = string_to_delta(config["interval"])
366
self.disable_hook = disable_hook
919
367
self.checker = None
920
368
self.checker_initiator_tag = None
921
369
self.disable_initiator_tag = None
922
371
self.checker_callback_tag = None
372
self.checker_command = config["checker"]
923
373
self.current_checker_command = None
374
self.last_connect = None
375
self._approved = None
376
self.approved_by_default = config.get("approved_by_default",
925
378
self.approvals_pending = 0
926
self.changedstate = multiprocessing_manager.Condition(
927
multiprocessing_manager.Lock())
928
self.client_structure = [attr
929
for attr in self.__dict__.keys()
930
if not attr.startswith("_")]
931
self.client_structure.append("client_structure")
933
for name, t in inspect.getmembers(
934
type(self), lambda obj: isinstance(obj, property)):
935
if not name.startswith("_"):
936
self.client_structure.append(name)
938
# Send notice to process children that client state has changed
379
self.approval_delay = string_to_delta(
380
config["approval_delay"])
381
self.approval_duration = string_to_delta(
382
config["approval_duration"])
383
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
939
385
def send_changedstate(self):
940
with self.changedstate:
941
self.changedstate.notify_all()
386
self.changedstate.acquire()
387
self.changedstate.notify_all()
388
self.changedstate.release()
943
390
def enable(self):
944
391
"""Start this client's checker and timeout hooks"""
945
392
if getattr(self, "enabled", False):
946
393
# Already enabled
395
self.send_changedstate()
396
# Schedule a new checker to be started an 'interval' from now,
397
# and every interval from then on.
398
self.checker_initiator_tag = (gobject.timeout_add
399
(self.interval_milliseconds(),
401
# Schedule a disable() when 'timeout' has passed
948
402
self.expires = datetime.datetime.utcnow() + self.timeout
403
self.disable_initiator_tag = (gobject.timeout_add
404
(self.timeout_milliseconds(),
949
406
self.enabled = True
950
407
self.last_enabled = datetime.datetime.utcnow()
952
self.send_changedstate()
408
# Also start a new checker *right now*.
954
411
def disable(self, quiet=True):
955
412
"""Disable this client."""
956
413
if not getattr(self, "enabled", False):
416
self.send_changedstate()
959
418
logger.info("Disabling client %s", self.name)
960
if getattr(self, "disable_initiator_tag", None) is not None:
961
GLib.source_remove(self.disable_initiator_tag)
419
if getattr(self, "disable_initiator_tag", False):
420
gobject.source_remove(self.disable_initiator_tag)
962
421
self.disable_initiator_tag = None
963
422
self.expires = None
964
if getattr(self, "checker_initiator_tag", None) is not None:
965
GLib.source_remove(self.checker_initiator_tag)
423
if getattr(self, "checker_initiator_tag", False):
424
gobject.source_remove(self.checker_initiator_tag)
966
425
self.checker_initiator_tag = None
967
426
self.stop_checker()
427
if self.disable_hook:
428
self.disable_hook(self)
968
429
self.enabled = False
970
self.send_changedstate()
971
# Do not run this again if called by a GLib.timeout_add
430
# Do not run this again if called by a gobject.timeout_add
974
433
def __del__(self):
434
self.disable_hook = None
977
def init_checker(self):
978
# Schedule a new checker to be started an 'interval' from now,
979
# and every interval from then on.
980
if self.checker_initiator_tag is not None:
981
GLib.source_remove(self.checker_initiator_tag)
982
self.checker_initiator_tag = GLib.timeout_add(
983
int(self.interval.total_seconds() * 1000),
985
# Schedule a disable() when 'timeout' has passed
986
if self.disable_initiator_tag is not None:
987
GLib.source_remove(self.disable_initiator_tag)
988
self.disable_initiator_tag = GLib.timeout_add(
989
int(self.timeout.total_seconds() * 1000), self.disable)
990
# Also start a new checker *right now*.
993
def checker_callback(self, source, condition, connection,
437
def checker_callback(self, pid, condition, command):
995
438
"""The checker has completed, so take appropriate actions."""
996
439
self.checker_callback_tag = None
997
440
self.checker = None
998
# Read return code from connection (see call_pipe)
999
returncode = connection.recv()
1003
self.last_checker_status = returncode
1004
self.last_checker_signal = None
1005
if self.last_checker_status == 0:
441
if os.WIFEXITED(condition):
442
exitstatus = os.WEXITSTATUS(condition)
1006
444
logger.info("Checker for %(name)s succeeded",
1008
446
self.checked_ok()
1010
logger.info("Checker for %(name)s failed", vars(self))
448
logger.info("Checker for %(name)s failed",
1012
self.last_checker_status = -1
1013
self.last_checker_signal = -returncode
1014
451
logger.warning("Checker for %(name)s crashed?",
1018
def checked_ok(self):
1019
"""Assert that the client has been seen, alive and well."""
1020
self.last_checked_ok = datetime.datetime.utcnow()
1021
self.last_checker_status = 0
1022
self.last_checker_signal = None
1025
def bump_timeout(self, timeout=None):
1026
"""Bump up the timeout for this client."""
454
def checked_ok(self, timeout=None):
455
"""Bump up the timeout for this client.
457
This should only be called when the client has been seen,
1027
460
if timeout is None:
1028
461
timeout = self.timeout
1029
if self.disable_initiator_tag is not None:
1030
GLib.source_remove(self.disable_initiator_tag)
1031
self.disable_initiator_tag = None
1032
if getattr(self, "enabled", False):
1033
self.disable_initiator_tag = GLib.timeout_add(
1034
int(timeout.total_seconds() * 1000), self.disable)
1035
self.expires = datetime.datetime.utcnow() + timeout
462
self.last_checked_ok = datetime.datetime.utcnow()
463
gobject.source_remove(self.disable_initiator_tag)
464
self.expires = datetime.datetime.utcnow() + timeout
465
self.disable_initiator_tag = (gobject.timeout_add
466
(_timedelta_to_milliseconds(timeout),
1037
469
def need_approval(self):
1038
470
self.last_approval_request = datetime.datetime.utcnow()
1040
472
def start_checker(self):
1041
473
"""Start a new checker subprocess if one is not running.
1043
475
If a checker already exists, leave it running and do
1045
477
# The reason for not killing a running checker is that if we
1046
# did that, and if a checker (for some reason) started running
1047
# slowly and taking more than 'interval' time, then the client
1048
# would inevitably timeout, since no checker would get a
1049
# chance to run to completion. If we instead leave running
478
# did that, then if a checker (for some reason) started
479
# running slowly and taking more than 'interval' time, the
480
# client would inevitably timeout, since no checker would get
481
# a chance to run to completion. If we instead leave running
1050
482
# checkers alone, the checker would have to take more time
1051
483
# than 'timeout' for the client to be disabled, which is as it
1054
if self.checker is not None and not self.checker.is_alive():
1055
logger.warning("Checker was not alive; joining")
486
# If a checker exists, make sure it is not a zombie
488
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
489
except (AttributeError, OSError) as error:
490
if (isinstance(error, OSError)
491
and error.errno != errno.ECHILD):
495
logger.warning("Checker was a zombie")
496
gobject.source_remove(self.checker_callback_tag)
497
self.checker_callback(pid, status,
498
self.current_checker_command)
1058
499
# Start a new checker if needed
1059
500
if self.checker is None:
1060
# Escape attributes for the shell
1062
attr: re.escape(str(getattr(self, attr)))
1063
for attr in self.runtime_expansions}
1065
command = self.checker_command % escaped_attrs
1066
except TypeError as error:
1067
logger.error('Could not format string "%s"',
1068
self.checker_command,
1070
return True # Try again later
502
# In case checker_command has exactly one % operator
503
command = self.checker_command % self.host
505
# Escape attributes for the shell
506
escaped_attrs = dict(
508
re.escape(unicode(str(getattr(self, attr, "")),
512
self.runtime_expansions)
515
command = self.checker_command % escaped_attrs
516
except TypeError as error:
517
logger.error('Could not format string "%s":'
518
' %s', self.checker_command, error)
519
return True # Try again later
1071
520
self.current_checker_command = command
1072
logger.info("Starting checker %r for %s", command,
1074
# We don't need to redirect stdout and stderr, since
1075
# in normal mode, that is already done by daemon(),
1076
# and in debug mode we don't want to. (Stdin is
1077
# always replaced by /dev/null.)
1078
# The exception is when not debugging but nevertheless
1079
# running in the foreground; use the previously
1081
popen_args = {"close_fds": True,
1084
if (not self.server_settings["debug"]
1085
and self.server_settings["foreground"]):
1086
popen_args.update({"stdout": wnull,
1088
pipe = multiprocessing.Pipe(duplex=False)
1089
self.checker = multiprocessing.Process(
1091
args=(pipe[1], subprocess.call, command),
1093
self.checker.start()
1094
self.checker_callback_tag = GLib.io_add_watch(
1095
pipe[0].fileno(), GLib.IO_IN,
1096
self.checker_callback, pipe[0], command)
1097
# Re-run this periodically if run by GLib.timeout_add
522
logger.info("Starting checker %r for %s",
524
# We don't need to redirect stdout and stderr, since
525
# in normal mode, that is already done by daemon(),
526
# and in debug mode we don't want to. (Stdin is
527
# always replaced by /dev/null.)
528
self.checker = subprocess.Popen(command,
531
self.checker_callback_tag = (gobject.child_watch_add
533
self.checker_callback,
535
# The checker may have completed before the gobject
536
# watch was added. Check for this.
537
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
539
gobject.source_remove(self.checker_callback_tag)
540
self.checker_callback(pid, status, command)
541
except OSError as error:
542
logger.error("Failed to start subprocess: %s",
544
# Re-run this periodically if run by gobject.timeout_add
1100
547
def stop_checker(self):
1101
548
"""Force the checker process, if any, to stop."""
1102
549
if self.checker_callback_tag:
1103
GLib.source_remove(self.checker_callback_tag)
550
gobject.source_remove(self.checker_callback_tag)
1104
551
self.checker_callback_tag = None
1105
552
if getattr(self, "checker", None) is None:
1107
554
logger.debug("Stopping checker for %(name)s", vars(self))
1108
self.checker.terminate()
556
os.kill(self.checker.pid, signal.SIGTERM)
558
#if self.checker.poll() is None:
559
# os.kill(self.checker.pid, signal.SIGKILL)
560
except OSError as error:
561
if error.errno != errno.ESRCH: # No such process
1109
563
self.checker = None
1112
def dbus_service_property(dbus_interface,
566
def dbus_service_property(dbus_interface, signature="v",
567
access="readwrite", byte_arrays=False):
1116
568
"""Decorators for marking methods of a DBusObjectWithProperties to
1117
569
become properties on the D-Bus.
1119
571
The decorated method will be called with no arguments by "Get"
1120
572
and with one argument by "Set".
1122
574
The parameters, where they are supported, are the same as
1123
575
dbus.service.method, except there is only "signature", since the
1124
576
type from Get() and the type sent to Set() is the same.
1207
class DBusObjectWithAnnotations(dbus.service.Object):
1208
"""A D-Bus object with annotations.
1210
Classes inheriting from this can use the dbus_annotations
1211
decorator to add annotations to methods or signals.
1215
def _is_dbus_thing(thing):
1216
"""Returns a function testing if an attribute is a D-Bus thing
1218
If called like _is_dbus_thing("method") it returns a function
1219
suitable for use as predicate to inspect.getmembers().
1221
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1224
def _get_all_dbus_things(self, thing):
1225
"""Returns a generator of (name, attribute) pairs
1227
return ((getattr(athing.__get__(self), "_dbus_name", name),
1228
athing.__get__(self))
1229
for cls in self.__class__.__mro__
1231
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1233
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1235
path_keyword='object_path',
1236
connection_keyword='connection')
1237
def Introspect(self, object_path, connection):
1238
"""Overloading of standard D-Bus method.
1240
Inserts annotation tags on methods and signals.
1242
xmlstring = dbus.service.Object.Introspect(self, object_path,
1245
document = xml.dom.minidom.parseString(xmlstring)
1247
for if_tag in document.getElementsByTagName("interface"):
1248
# Add annotation tags
1249
for typ in ("method", "signal"):
1250
for tag in if_tag.getElementsByTagName(typ):
1252
for name, prop in (self.
1253
_get_all_dbus_things(typ)):
1254
if (name == tag.getAttribute("name")
1255
and prop._dbus_interface
1256
== if_tag.getAttribute("name")):
1257
annots.update(getattr(
1258
prop, "_dbus_annotations", {}))
1259
for name, value in annots.items():
1260
ann_tag = document.createElement(
1262
ann_tag.setAttribute("name", name)
1263
ann_tag.setAttribute("value", value)
1264
tag.appendChild(ann_tag)
1265
# Add interface annotation tags
1266
for annotation, value in dict(
1267
itertools.chain.from_iterable(
1268
annotations().items()
1269
for name, annotations
1270
in self._get_all_dbus_things("interface")
1271
if name == if_tag.getAttribute("name")
1273
ann_tag = document.createElement("annotation")
1274
ann_tag.setAttribute("name", annotation)
1275
ann_tag.setAttribute("value", value)
1276
if_tag.appendChild(ann_tag)
1277
# Fix argument name for the Introspect method itself
1278
if (if_tag.getAttribute("name")
1279
== dbus.INTROSPECTABLE_IFACE):
1280
for cn in if_tag.getElementsByTagName("method"):
1281
if cn.getAttribute("name") == "Introspect":
1282
for arg in cn.getElementsByTagName("arg"):
1283
if (arg.getAttribute("direction")
1285
arg.setAttribute("name",
1287
xmlstring = document.toxml("utf-8")
1289
except (AttributeError, xml.dom.DOMException,
1290
xml.parsers.expat.ExpatError) as error:
1291
logger.error("Failed to override Introspection method",
1296
class DBusObjectWithProperties(DBusObjectWithAnnotations):
615
class DBusObjectWithProperties(dbus.service.Object):
1297
616
"""A D-Bus object with properties.
1299
618
Classes inheriting from this can use the dbus_service_property
1300
619
decorator to expose methods as D-Bus properties. It exposes the
1301
620
standard Get(), Set(), and GetAll() methods on the D-Bus.
624
def _is_dbus_property(obj):
625
return getattr(obj, "_dbus_is_property", False)
627
def _get_all_dbus_properties(self):
628
"""Returns a generator of (name, attribute) pairs
630
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
631
for cls in self.__class__.__mro__
632
for name, prop in inspect.getmembers(cls, self._is_dbus_property))
1304
634
def _get_dbus_property(self, interface_name, property_name):
1305
635
"""Returns a bound method if one exists which is a D-Bus
1306
636
property with the specified name and interface.
1308
for cls in self.__class__.__mro__:
1309
for name, value in inspect.getmembers(
1310
cls, self._is_dbus_thing("property")):
1311
if (value._dbus_name == property_name
1312
and value._dbus_interface == interface_name):
638
for cls in self.__class__.__mro__:
639
for name, value in inspect.getmembers(cls, self._is_dbus_property):
640
if value._dbus_name == property_name and value._dbus_interface == interface_name:
1313
641
return value.__get__(self)
1315
643
# No such property
1316
raise DBusPropertyNotFound("{}:{}.{}".format(
1317
self.dbus_object_path, interface_name, property_name))
1320
def _get_all_interface_names(cls):
1321
"""Get a sequence of all interfaces supported by an object"""
1322
return (name for name in set(getattr(getattr(x, attr),
1323
"_dbus_interface", None)
1324
for x in (inspect.getmro(cls))
1326
if name is not None)
1328
@dbus.service.method(dbus.PROPERTIES_IFACE,
644
raise DBusPropertyNotFound(self.dbus_object_path + ":"
645
+ interface_name + "."
649
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1330
650
out_signature="v")
1331
651
def Get(self, interface_name, property_name):
1332
652
"""Standard D-Bus property Get() method, see D-Bus standard.
1457
744
except (AttributeError, xml.dom.DOMException,
1458
745
xml.parsers.expat.ExpatError) as error:
1459
746
logger.error("Failed to override Introspection method",
1464
dbus.OBJECT_MANAGER_IFACE
1465
except AttributeError:
1466
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1469
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1470
"""A D-Bus object with an ObjectManager.
1472
Classes inheriting from this exposes the standard
1473
GetManagedObjects call and the InterfacesAdded and
1474
InterfacesRemoved signals on the standard
1475
"org.freedesktop.DBus.ObjectManager" interface.
1477
Note: No signals are sent automatically; they must be sent
1480
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1481
out_signature="a{oa{sa{sv}}}")
1482
def GetManagedObjects(self):
1483
"""This function must be overridden"""
1484
raise NotImplementedError()
1486
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1487
signature="oa{sa{sv}}")
1488
def InterfacesAdded(self, object_path, interfaces_and_properties):
1491
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1492
def InterfacesRemoved(self, object_path, interfaces):
1495
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1497
path_keyword='object_path',
1498
connection_keyword='connection')
1499
def Introspect(self, object_path, connection):
1500
"""Overloading of standard D-Bus method.
1502
Override return argument name of GetManagedObjects to be
1503
"objpath_interfaces_and_properties"
1505
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1509
document = xml.dom.minidom.parseString(xmlstring)
1511
for if_tag in document.getElementsByTagName("interface"):
1512
# Fix argument name for the GetManagedObjects method
1513
if (if_tag.getAttribute("name")
1514
== dbus.OBJECT_MANAGER_IFACE):
1515
for cn in if_tag.getElementsByTagName("method"):
1516
if (cn.getAttribute("name")
1517
== "GetManagedObjects"):
1518
for arg in cn.getElementsByTagName("arg"):
1519
if (arg.getAttribute("direction")
1523
"objpath_interfaces"
1525
xmlstring = document.toxml("utf-8")
1527
except (AttributeError, xml.dom.DOMException,
1528
xml.parsers.expat.ExpatError) as error:
1529
logger.error("Failed to override Introspection method",
1534
def datetime_to_dbus(dt, variant_level=0):
751
def datetime_to_dbus (dt, variant_level=0):
1535
752
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1537
return dbus.String("", variant_level=variant_level)
1538
return dbus.String(dt.isoformat(), variant_level=variant_level)
1541
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1542
"""A class decorator; applied to a subclass of
1543
dbus.service.Object, it will add alternate D-Bus attributes with
1544
interface names according to the "alt_interface_names" mapping.
1547
@alternate_dbus_interfaces({"org.example.Interface":
1548
"net.example.AlternateInterface"})
1549
class SampleDBusObject(dbus.service.Object):
1550
@dbus.service.method("org.example.Interface")
1551
def SampleDBusMethod():
1554
The above "SampleDBusMethod" on "SampleDBusObject" will be
1555
reachable via two interfaces: "org.example.Interface" and
1556
"net.example.AlternateInterface", the latter of which will have
1557
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1558
"true", unless "deprecate" is passed with a False value.
1560
This works for methods and signals, and also for D-Bus properties
1561
(from DBusObjectWithProperties) and interfaces (from the
1562
dbus_interface_annotations decorator).
1566
for orig_interface_name, alt_interface_name in (
1567
alt_interface_names.items()):
1569
interface_names = set()
1570
# Go though all attributes of the class
1571
for attrname, attribute in inspect.getmembers(cls):
1572
# Ignore non-D-Bus attributes, and D-Bus attributes
1573
# with the wrong interface name
1574
if (not hasattr(attribute, "_dbus_interface")
1575
or not attribute._dbus_interface.startswith(
1576
orig_interface_name)):
1578
# Create an alternate D-Bus interface name based on
1580
alt_interface = attribute._dbus_interface.replace(
1581
orig_interface_name, alt_interface_name)
1582
interface_names.add(alt_interface)
1583
# Is this a D-Bus signal?
1584
if getattr(attribute, "_dbus_is_signal", False):
1585
# Extract the original non-method undecorated
1586
# function by black magic
1587
if sys.version_info.major == 2:
1588
nonmethod_func = (dict(
1589
zip(attribute.func_code.co_freevars,
1590
attribute.__closure__))
1591
["func"].cell_contents)
1593
nonmethod_func = (dict(
1594
zip(attribute.__code__.co_freevars,
1595
attribute.__closure__))
1596
["func"].cell_contents)
1597
# Create a new, but exactly alike, function
1598
# object, and decorate it to be a new D-Bus signal
1599
# with the alternate D-Bus interface name
1600
new_function = copy_function(nonmethod_func)
1601
new_function = (dbus.service.signal(
1603
attribute._dbus_signature)(new_function))
1604
# Copy annotations, if any
1606
new_function._dbus_annotations = dict(
1607
attribute._dbus_annotations)
1608
except AttributeError:
1611
# Define a creator of a function to call both the
1612
# original and alternate functions, so both the
1613
# original and alternate signals gets sent when
1614
# the function is called
1615
def fixscope(func1, func2):
1616
"""This function is a scope container to pass
1617
func1 and func2 to the "call_both" function
1618
outside of its arguments"""
1620
@functools.wraps(func2)
1621
def call_both(*args, **kwargs):
1622
"""This function will emit two D-Bus
1623
signals by calling func1 and func2"""
1624
func1(*args, **kwargs)
1625
func2(*args, **kwargs)
1626
# Make wrapper function look like a D-Bus
1628
for name, attr in inspect.getmembers(func2):
1629
if name.startswith("_dbus_"):
1630
setattr(call_both, name, attr)
1633
# Create the "call_both" function and add it to
1635
attr[attrname] = fixscope(attribute, new_function)
1636
# Is this a D-Bus method?
1637
elif getattr(attribute, "_dbus_is_method", False):
1638
# Create a new, but exactly alike, function
1639
# object. Decorate it to be a new D-Bus method
1640
# with the alternate D-Bus interface name. Add it
1643
dbus.service.method(
1645
attribute._dbus_in_signature,
1646
attribute._dbus_out_signature)
1647
(copy_function(attribute)))
1648
# Copy annotations, if any
1650
attr[attrname]._dbus_annotations = dict(
1651
attribute._dbus_annotations)
1652
except AttributeError:
1654
# Is this a D-Bus property?
1655
elif getattr(attribute, "_dbus_is_property", False):
1656
# Create a new, but exactly alike, function
1657
# object, and decorate it to be a new D-Bus
1658
# property with the alternate D-Bus interface
1659
# name. Add it to the class.
1660
attr[attrname] = (dbus_service_property(
1661
alt_interface, attribute._dbus_signature,
1662
attribute._dbus_access,
1663
attribute._dbus_get_args_options
1665
(copy_function(attribute)))
1666
# Copy annotations, if any
1668
attr[attrname]._dbus_annotations = dict(
1669
attribute._dbus_annotations)
1670
except AttributeError:
1672
# Is this a D-Bus interface?
1673
elif getattr(attribute, "_dbus_is_interface", False):
1674
# Create a new, but exactly alike, function
1675
# object. Decorate it to be a new D-Bus interface
1676
# with the alternate D-Bus interface name. Add it
1679
dbus_interface_annotations(alt_interface)
1680
(copy_function(attribute)))
1682
# Deprecate all alternate interfaces
1683
iname = "_AlternateDBusNames_interface_annotation{}"
1684
for interface_name in interface_names:
1686
@dbus_interface_annotations(interface_name)
1688
return {"org.freedesktop.DBus.Deprecated":
1690
# Find an unused name
1691
for aname in (iname.format(i)
1692
for i in itertools.count()):
1693
if aname not in attr:
1697
# Replace the class with a new subclass of it with
1698
# methods, signals, etc. as created above.
1699
if sys.version_info.major == 2:
1700
cls = type(b"{}Alternate".format(cls.__name__),
1703
cls = type("{}Alternate".format(cls.__name__),
1710
@alternate_dbus_interfaces({"se.recompile.Mandos":
1711
"se.bsnet.fukt.Mandos"})
754
return dbus.String("", variant_level = variant_level)
755
return dbus.String(dt.isoformat(),
756
variant_level=variant_level)
758
class transitional_dbus_metaclass(DBusObjectWithProperties.__metaclass__):
759
def __new__(mcs, name, bases, attr):
760
for attrname, old_dbusobj in inspect.getmembers(bases[0]):
761
new_interface = getattr(old_dbusobj, "_dbus_interface", "").replace("se.bsnet.fukt.", "se.recompile.")
762
if (getattr(old_dbusobj, "_dbus_is_signal", False)
763
and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
764
unwrappedfunc = dict(zip(old_dbusobj.func_code.co_freevars,
765
old_dbusobj.__closure__))["func"].cell_contents
766
newfunc = types.FunctionType(unwrappedfunc.func_code,
767
unwrappedfunc.func_globals,
768
unwrappedfunc.func_name,
769
unwrappedfunc.func_defaults,
770
unwrappedfunc.func_closure)
771
new_dbusfunc = dbus.service.signal(
772
new_interface, old_dbusobj._dbus_signature)(newfunc)
773
attr["_transitional_" + attrname] = new_dbusfunc
775
def fixscope(func1, func2):
776
def newcall(*args, **kwargs):
777
func1(*args, **kwargs)
778
func2(*args, **kwargs)
781
attr[attrname] = fixscope(old_dbusobj, new_dbusfunc)
783
elif (getattr(old_dbusobj, "_dbus_is_method", False)
784
and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
785
new_dbusfunc = (dbus.service.method
787
old_dbusobj._dbus_in_signature,
788
old_dbusobj._dbus_out_signature)
790
(old_dbusobj.func_code,
791
old_dbusobj.func_globals,
792
old_dbusobj.func_name,
793
old_dbusobj.func_defaults,
794
old_dbusobj.func_closure)))
796
attr[attrname] = new_dbusfunc
797
elif (getattr(old_dbusobj, "_dbus_is_property", False)
798
and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
799
new_dbusfunc = (dbus_service_property
801
old_dbusobj._dbus_signature,
802
old_dbusobj._dbus_access,
803
old_dbusobj._dbus_get_args_options["byte_arrays"])
805
(old_dbusobj.func_code,
806
old_dbusobj.func_globals,
807
old_dbusobj.func_name,
808
old_dbusobj.func_defaults,
809
old_dbusobj.func_closure)))
811
attr[attrname] = new_dbusfunc
812
return type.__new__(mcs, name, bases, attr)
1712
814
class ClientDBus(Client, DBusObjectWithProperties):
1713
815
"""A Client class using D-Bus
1716
818
dbus_object_path: dbus.ObjectPath
1717
819
bus: dbus.SystemBus()
1720
822
runtime_expansions = (Client.runtime_expansions
1721
+ ("dbus_object_path", ))
1723
_interface = "se.recompile.Mandos.Client"
823
+ ("dbus_object_path",))
1725
825
# dbus.service.Object doesn't use super(), so we can't either.
1727
def __init__(self, bus=None, *args, **kwargs):
827
def __init__(self, bus = None, *args, **kwargs):
828
self._approvals_pending = 0
1729
830
Client.__init__(self, *args, **kwargs)
1730
831
# Only now, when this client is initialized, can it show up on
1732
client_object_name = str(self.name).translate(
833
client_object_name = unicode(self.name).translate(
1733
834
{ord("."): ord("_"),
1734
835
ord("-"): ord("_")})
1735
self.dbus_object_path = dbus.ObjectPath(
1736
"/clients/" + client_object_name)
836
self.dbus_object_path = (dbus.ObjectPath
837
("/clients/" + client_object_name))
1737
838
DBusObjectWithProperties.__init__(self, self.bus,
1738
839
self.dbus_object_path)
1740
def notifychangeproperty(transform_func, dbus_name,
1741
type_func=lambda x: x,
1743
invalidate_only=False,
1744
_interface=_interface):
1745
""" Modify a variable so that it's a property which announces
1746
its changes to DBus.
1748
transform_fun: Function that takes a value and a variant_level
1749
and transforms it to a D-Bus type.
1750
dbus_name: D-Bus name of the variable
841
def notifychangeproperty(transform_func,
842
dbus_name, type_func=lambda x: x,
844
""" Modify a variable so that its a property that announce its
846
transform_fun: Function that takes a value and transform it to
848
dbus_name: DBus name of the variable
1751
849
type_func: Function that transform the value before sending it
1752
to the D-Bus. Default: no transform
1753
variant_level: D-Bus variant level. Default: 1
851
variant_level: DBus variant level. default: 1
1755
attrname = "_{}".format(dbus_name)
1757
854
def setter(self, value):
855
old_value = real_value[0]
856
real_value[0] = value
1758
857
if hasattr(self, "dbus_object_path"):
1759
if (not hasattr(self, attrname) or
1760
type_func(getattr(self, attrname, None))
1761
!= type_func(value)):
1763
self.PropertiesChanged(
1764
_interface, dbus.Dictionary(),
1765
dbus.Array((dbus_name, )))
1767
dbus_value = transform_func(
1769
variant_level=variant_level)
1770
self.PropertyChanged(dbus.String(dbus_name),
1772
self.PropertiesChanged(
1774
dbus.Dictionary({dbus.String(dbus_name):
1777
setattr(self, attrname, value)
1779
return property(lambda self: getattr(self, attrname), setter)
858
if type_func(old_value) != type_func(real_value[0]):
859
dbus_value = transform_func(type_func(real_value[0]),
861
self.PropertyChanged(dbus.String(dbus_name),
864
return property(lambda self: real_value[0], setter)
1781
867
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1782
868
approvals_pending = notifychangeproperty(dbus.Boolean,
1783
869
"ApprovalPending",
1785
871
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1786
872
last_enabled = notifychangeproperty(datetime_to_dbus,
1788
checker = notifychangeproperty(
1789
dbus.Boolean, "CheckerRunning",
1790
type_func=lambda checker: checker is not None)
874
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
875
type_func = lambda checker: checker is not None)
1791
876
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1792
877
"LastCheckedOK")
1793
last_checker_status = notifychangeproperty(dbus.Int16,
1794
"LastCheckerStatus")
1795
last_approval_request = notifychangeproperty(
1796
datetime_to_dbus, "LastApprovalRequest")
878
last_approval_request = notifychangeproperty(datetime_to_dbus,
879
"LastApprovalRequest")
1797
880
approved_by_default = notifychangeproperty(dbus.Boolean,
1798
881
"ApprovedByDefault")
1799
approval_delay = notifychangeproperty(
1800
dbus.UInt64, "ApprovalDelay",
1801
type_func=lambda td: td.total_seconds() * 1000)
1802
approval_duration = notifychangeproperty(
1803
dbus.UInt64, "ApprovalDuration",
1804
type_func=lambda td: td.total_seconds() * 1000)
882
approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",
883
type_func = _timedelta_to_milliseconds)
884
approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",
885
type_func = _timedelta_to_milliseconds)
1805
886
host = notifychangeproperty(dbus.String, "Host")
1806
timeout = notifychangeproperty(
1807
dbus.UInt64, "Timeout",
1808
type_func=lambda td: td.total_seconds() * 1000)
1809
extended_timeout = notifychangeproperty(
1810
dbus.UInt64, "ExtendedTimeout",
1811
type_func=lambda td: td.total_seconds() * 1000)
1812
interval = notifychangeproperty(
1813
dbus.UInt64, "Interval",
1814
type_func=lambda td: td.total_seconds() * 1000)
887
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
888
type_func = _timedelta_to_milliseconds)
889
extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",
890
type_func = _timedelta_to_milliseconds)
891
interval = notifychangeproperty(dbus.UInt16, "Interval",
892
type_func = _timedelta_to_milliseconds)
1815
893
checker_command = notifychangeproperty(dbus.String, "Checker")
1816
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1817
invalidate_only=True)
1819
895
del notifychangeproperty
1821
897
def __del__(self, *args, **kwargs):
1823
899
self.remove_from_connection()
2162
1206
self._pipe = child_pipe
2163
1207
self._pipe.send(('init', fpr, address))
2164
1208
if not self._pipe.recv():
2167
1211
def __getattribute__(self, name):
1212
if(name == '_pipe'):
2169
1213
return super(ProxyClient, self).__getattribute__(name)
2170
1214
self._pipe.send(('getattr', name))
2171
1215
data = self._pipe.recv()
2172
1216
if data[0] == 'data':
2174
1218
if data[0] == 'function':
2176
1219
def func(*args, **kwargs):
2177
1220
self._pipe.send(('funcall', name, args, kwargs))
2178
1221
return self._pipe.recv()[1]
2182
1224
def __setattr__(self, name, value):
1225
if(name == '_pipe'):
2184
1226
return super(ProxyClient, self).__setattr__(name, value)
2185
1227
self._pipe.send(('setattr', name, value))
1229
class ClientDBusTransitional(ClientDBus):
1230
__metaclass__ = transitional_dbus_metaclass
2188
1232
class ClientHandler(socketserver.BaseRequestHandler, object):
2189
1233
"""A class to handle client connections.
2191
1235
Instantiated once for each connection to handle it.
2192
1236
Note: This will run in its own forked process."""
2194
1238
def handle(self):
2195
1239
with contextlib.closing(self.server.child_pipe) as child_pipe:
2196
1240
logger.info("TCP connection from: %s",
2197
str(self.client_address))
1241
unicode(self.client_address))
2198
1242
logger.debug("Pipe FD: %d",
2199
1243
self.server.child_pipe.fileno())
2201
session = gnutls.ClientSession(self.request)
2203
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2204
# "+AES-256-CBC", "+SHA1",
2205
# "+COMP-NULL", "+CTYPE-OPENPGP",
1245
session = (gnutls.connection
1246
.ClientSession(self.request,
1248
.X509Credentials()))
1250
# Note: gnutls.connection.X509Credentials is really a
1251
# generic GnuTLS certificate credentials object so long as
1252
# no X.509 keys are added to it. Therefore, we can use it
1253
# here despite using OpenPGP certificates.
1255
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1256
# "+AES-256-CBC", "+SHA1",
1257
# "+COMP-NULL", "+CTYPE-OPENPGP",
2207
1259
# Use a fallback default, since this MUST be set.
2208
1260
priority = self.server.gnutls_priority
2209
1261
if priority is None:
2210
1262
priority = "NORMAL"
2211
gnutls.priority_set_direct(session._c_object,
2212
priority.encode("utf-8"),
1263
(gnutls.library.functions
1264
.gnutls_priority_set_direct(session._c_object,
2215
1267
# Start communication using the Mandos protocol
2216
1268
# Get protocol number
2217
1269
line = self.request.makefile().readline()
2218
1270
logger.debug("Protocol version: %r", line)
2220
1272
if int(line.strip().split()[0]) > 1:
2221
raise RuntimeError(line)
2222
1274
except (ValueError, IndexError, RuntimeError) as error:
2223
1275
logger.error("Unknown protocol version: %s", error)
2226
1278
# Start GnuTLS connection
2228
1280
session.handshake()
2229
except gnutls.Error as error:
1281
except gnutls.errors.GNUTLSError as error:
2230
1282
logger.warning("Handshake failed: %s", error)
2231
1283
# Do not run session.bye() here: the session is not
2232
1284
# established. Just abandon the request.
2234
1286
logger.debug("Handshake succeeded")
2236
1288
approval_required = False
2239
fpr = self.fingerprint(
2240
self.peer_certificate(session))
2241
except (TypeError, gnutls.Error) as error:
1291
fpr = self.fingerprint(self.peer_certificate
1294
gnutls.errors.GNUTLSError) as error:
2242
1295
logger.warning("Bad certificate: %s", error)
2244
1297
logger.debug("Fingerprint: %s", fpr)
2247
1300
client = ProxyClient(child_pipe, fpr,
2248
1301
self.client_address)
2249
1302
except KeyError:
2252
1305
if client.approval_delay:
2253
1306
delay = client.approval_delay
2254
1307
client.approvals_pending += 1
2255
1308
approval_required = True
2258
1311
if not client.enabled:
2259
1312
logger.info("Client %s is disabled",
2261
1314
if self.server.use_dbus:
2262
1315
# Emit D-Bus signal
2263
client.Rejected("Disabled")
1316
client.Rejected("Disabled")
2266
if client.approved or not client.approval_delay:
2267
# We are approved or approval is disabled
1319
if client._approved or not client.approval_delay:
1320
#We are approved or approval is disabled
2269
elif client.approved is None:
1322
elif client._approved is None:
2270
1323
logger.info("Client %s needs approval",
2272
1325
if self.server.use_dbus:
2273
1326
# Emit D-Bus signal
2274
1327
client.NeedApproval(
2275
client.approval_delay.total_seconds()
2276
* 1000, client.approved_by_default)
1328
client.approval_delay_milliseconds(),
1329
client.approved_by_default)
2278
1331
logger.warning("Client %s was not approved",
2303
1357
delay -= time2 - time
2306
session.send(client.secret)
2307
except gnutls.Error as error:
2308
logger.warning("gnutls send failed",
1360
while sent_size < len(client.secret):
1362
sent = session.send(client.secret[sent_size:])
1363
except gnutls.errors.GNUTLSError as error:
1364
logger.warning("gnutls send failed")
1366
logger.debug("Sent: %d, remaining: %d",
1367
sent, len(client.secret)
1368
- (sent_size + sent))
2312
1371
logger.info("Sending secret to %s", client.name)
2313
# bump the timeout using extended_timeout
2314
client.bump_timeout(client.extended_timeout)
1372
# bump the timeout as if seen
1373
client.checked_ok(client.extended_timeout)
2315
1374
if self.server.use_dbus:
2316
1375
# Emit D-Bus signal
2317
1376
client.GotSecret()
2320
1379
if approval_required:
2321
1380
client.approvals_pending -= 1
2324
except gnutls.Error as error:
2325
logger.warning("GnuTLS bye failed",
1383
except gnutls.errors.GNUTLSError as error:
1384
logger.warning("GnuTLS bye failed")
2329
1387
def peer_certificate(session):
2330
1388
"Return the peer's OpenPGP certificate as a bytestring"
2331
1389
# If not an OpenPGP certificate...
2332
if (gnutls.certificate_type_get(session._c_object)
2333
!= gnutls.CRT_OPENPGP):
2334
# ...return invalid data
1390
if (gnutls.library.functions
1391
.gnutls_certificate_type_get(session._c_object)
1392
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1393
# ...do the normal thing
1394
return session.peer_certificate
2336
1395
list_size = ctypes.c_uint(1)
2337
cert_list = (gnutls.certificate_get_peers
1396
cert_list = (gnutls.library.functions
1397
.gnutls_certificate_get_peers
2338
1398
(session._c_object, ctypes.byref(list_size)))
2339
1399
if not bool(cert_list) and list_size.value != 0:
2340
raise gnutls.Error("error getting peer certificate")
1400
raise gnutls.errors.GNUTLSError("error getting peer"
2341
1402
if list_size.value == 0:
2343
1404
cert = cert_list[0]
2344
1405
return ctypes.string_at(cert.data, cert.size)
2347
1408
def fingerprint(openpgp):
2348
1409
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2349
1410
# New GnuTLS "datum" with the OpenPGP public key
2350
datum = gnutls.datum_t(
2351
ctypes.cast(ctypes.c_char_p(openpgp),
2352
ctypes.POINTER(ctypes.c_ubyte)),
2353
ctypes.c_uint(len(openpgp)))
1411
datum = (gnutls.library.types
1412
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1415
ctypes.c_uint(len(openpgp))))
2354
1416
# New empty GnuTLS certificate
2355
crt = gnutls.openpgp_crt_t()
2356
gnutls.openpgp_crt_init(ctypes.byref(crt))
1417
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1418
(gnutls.library.functions
1419
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2357
1420
# Import the OpenPGP public key into the certificate
2358
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2359
gnutls.OPENPGP_FMT_RAW)
1421
(gnutls.library.functions
1422
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1423
gnutls.library.constants
1424
.GNUTLS_OPENPGP_FMT_RAW))
2360
1425
# Verify the self signature in the key
2361
1426
crtverify = ctypes.c_uint()
2362
gnutls.openpgp_crt_verify_self(crt, 0,
2363
ctypes.byref(crtverify))
1427
(gnutls.library.functions
1428
.gnutls_openpgp_crt_verify_self(crt, 0,
1429
ctypes.byref(crtverify)))
2364
1430
if crtverify.value != 0:
2365
gnutls.openpgp_crt_deinit(crt)
2366
raise gnutls.CertificateSecurityError("Verify failed")
1431
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1432
raise (gnutls.errors.CertificateSecurityError
2367
1434
# New buffer for the fingerprint
2368
1435
buf = ctypes.create_string_buffer(20)
2369
1436
buf_len = ctypes.c_size_t()
2370
1437
# Get the fingerprint from the certificate into the buffer
2371
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2372
ctypes.byref(buf_len))
1438
(gnutls.library.functions
1439
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1440
ctypes.byref(buf_len)))
2373
1441
# Deinit the certificate
2374
gnutls.openpgp_crt_deinit(crt)
1442
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2375
1443
# Convert the buffer to a Python bytestring
2376
1444
fpr = ctypes.string_at(buf, buf_len.value)
2377
1445
# Convert the bytestring to hexadecimal notation
2378
hex_fpr = binascii.hexlify(fpr).upper()
1446
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2382
1450
class MultiprocessingMixIn(object):
2383
1451
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2385
1452
def sub_process_main(self, request, address):
2387
1454
self.finish_request(request, address)
2389
1456
self.handle_error(request, address)
2390
1457
self.close_request(request)
2392
1459
def process_request(self, request, address):
2393
1460
"""Start a new process to process the request."""
2394
proc = multiprocessing.Process(target=self.sub_process_main,
2395
args=(request, address))
1461
multiprocessing.Process(target = self.sub_process_main,
1462
args = (request, address)).start()
2400
1465
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2401
1466
""" adds a pipe to the MixIn """
2403
1467
def process_request(self, request, client_address):
2404
1468
"""Overrides and wraps the original process_request().
2406
1470
This function creates a new pipe in self.pipe
2408
1472
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2410
proc = MultiprocessingMixIn.process_request(self, request,
1474
super(MultiprocessingMixInWithPipe,
1475
self).process_request(request, client_address)
2412
1476
self.child_pipe.close()
2413
self.add_pipe(parent_pipe, proc)
2415
def add_pipe(self, parent_pipe, proc):
1477
self.add_pipe(parent_pipe)
1479
def add_pipe(self, parent_pipe):
2416
1480
"""Dummy function; override as necessary"""
2417
raise NotImplementedError()
1481
raise NotImplementedError
2420
1484
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2421
1485
socketserver.TCPServer, object):
2422
1486
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2425
1489
enabled: Boolean; whether this server is activated yet
2426
1490
interface: None or a network interface name (string)
2427
1491
use_ipv6: Boolean; to use IPv6 or not
2430
1493
def __init__(self, server_address, RequestHandlerClass,
2434
"""If socketfd is set, use that file descriptor instead of
2435
creating a new one with socket.socket().
1494
interface=None, use_ipv6=True):
2437
1495
self.interface = interface
2439
1497
self.address_family = socket.AF_INET6
2440
if socketfd is not None:
2441
# Save the file descriptor
2442
self.socketfd = socketfd
2443
# Save the original socket.socket() function
2444
self.socket_socket = socket.socket
2446
# To implement --socket, we monkey patch socket.socket.
2448
# (When socketserver.TCPServer is a new-style class, we
2449
# could make self.socket into a property instead of monkey
2450
# patching socket.socket.)
2452
# Create a one-time-only replacement for socket.socket()
2453
@functools.wraps(socket.socket)
2454
def socket_wrapper(*args, **kwargs):
2455
# Restore original function so subsequent calls are
2457
socket.socket = self.socket_socket
2458
del self.socket_socket
2459
# This time only, return a new socket object from the
2460
# saved file descriptor.
2461
return socket.fromfd(self.socketfd, *args, **kwargs)
2462
# Replace socket.socket() function with wrapper
2463
socket.socket = socket_wrapper
2464
# The socketserver.TCPServer.__init__ will call
2465
# socket.socket(), which might be our replacement,
2466
# socket_wrapper(), if socketfd was set.
2467
1498
socketserver.TCPServer.__init__(self, server_address,
2468
1499
RequestHandlerClass)
2470
1500
def server_bind(self):
2471
1501
"""This overrides the normal server_bind() function
2472
1502
to bind to an interface if one was specified, and also NOT to
2473
1503
bind to an address or port if they were not specified."""
2474
global SO_BINDTODEVICE
2475
1504
if self.interface is not None:
2476
1505
if SO_BINDTODEVICE is None:
2477
# Fall back to a hard-coded value which seems to be
2479
logger.warning("SO_BINDTODEVICE not found, trying 25")
2480
SO_BINDTODEVICE = 25
2482
self.socket.setsockopt(
2483
socket.SOL_SOCKET, SO_BINDTODEVICE,
2484
(self.interface + "\0").encode("utf-8"))
2485
except socket.error as error:
2486
if error.errno == errno.EPERM:
2487
logger.error("No permission to bind to"
2488
" interface %s", self.interface)
2489
elif error.errno == errno.ENOPROTOOPT:
2490
logger.error("SO_BINDTODEVICE not available;"
2491
" cannot bind to interface %s",
2493
elif error.errno == errno.ENODEV:
2494
logger.error("Interface %s does not exist,"
2495
" cannot bind", self.interface)
1506
logger.error("SO_BINDTODEVICE does not exist;"
1507
" cannot bind to interface %s",
1511
self.socket.setsockopt(socket.SOL_SOCKET,
1515
except socket.error as error:
1516
if error[0] == errno.EPERM:
1517
logger.error("No permission to"
1518
" bind to interface %s",
1520
elif error[0] == errno.ENOPROTOOPT:
1521
logger.error("SO_BINDTODEVICE not available;"
1522
" cannot bind to interface %s",
2498
1526
# Only bind(2) the socket if we really need to.
2499
1527
if self.server_address[0] or self.server_address[1]:
2500
1528
if not self.server_address[0]:
2501
1529
if self.address_family == socket.AF_INET6:
2502
any_address = "::" # in6addr_any
1530
any_address = "::" # in6addr_any
2504
any_address = "0.0.0.0" # INADDR_ANY
1532
any_address = socket.INADDR_ANY
2505
1533
self.server_address = (any_address,
2506
1534
self.server_address[1])
2507
1535
elif not self.server_address[1]:
2508
self.server_address = (self.server_address[0], 0)
1536
self.server_address = (self.server_address[0],
2509
1538
# if self.interface:
2510
1539
# self.server_address = (self.server_address[0],
2588
1616
"dress: %s", fpr, address)
2589
1617
if self.use_dbus:
2590
1618
# Emit D-Bus signal
2591
mandos_dbus_service.ClientNotFound(fpr,
1619
mandos_dbus_service.ClientNotFound(fpr, address[0])
2593
1620
parent_pipe.send(False)
2597
parent_pipe.fileno(),
2598
GLib.IO_IN | GLib.IO_HUP,
2599
functools.partial(self.handle_ipc,
2600
parent_pipe=parent_pipe,
2602
client_object=client))
1623
gobject.io_add_watch(parent_pipe.fileno(),
1624
gobject.IO_IN | gobject.IO_HUP,
1625
functools.partial(self.handle_ipc,
1626
parent_pipe = parent_pipe,
1627
client_object = client))
2603
1628
parent_pipe.send(True)
2604
# remove the old hook in favor of the new above hook on
1629
# remove the old hook in favor of the new above hook on same fileno
2607
1631
if command == 'funcall':
2608
1632
funcname = request[1]
2609
1633
args = request[2]
2610
1634
kwargs = request[3]
2612
parent_pipe.send(('data', getattr(client_object,
1636
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2616
1638
if command == 'getattr':
2617
1639
attrname = request[1]
2618
if isinstance(client_object.__getattribute__(attrname),
2619
collections.Callable):
2620
parent_pipe.send(('function', ))
1640
if callable(client_object.__getattribute__(attrname)):
1641
parent_pipe.send(('function',))
2623
'data', client_object.__getattribute__(attrname)))
1643
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2625
1645
if command == 'setattr':
2626
1646
attrname = request[1]
2627
1647
value = request[2]
2628
1648
setattr(client_object, attrname, value)
2633
def rfc3339_duration_to_delta(duration):
2634
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2636
>>> rfc3339_duration_to_delta("P7D")
2637
datetime.timedelta(7)
2638
>>> rfc3339_duration_to_delta("PT60S")
2639
datetime.timedelta(0, 60)
2640
>>> rfc3339_duration_to_delta("PT60M")
2641
datetime.timedelta(0, 3600)
2642
>>> rfc3339_duration_to_delta("PT24H")
2643
datetime.timedelta(1)
2644
>>> rfc3339_duration_to_delta("P1W")
2645
datetime.timedelta(7)
2646
>>> rfc3339_duration_to_delta("PT5M30S")
2647
datetime.timedelta(0, 330)
2648
>>> rfc3339_duration_to_delta("P1DT3M20S")
2649
datetime.timedelta(1, 200)
2652
# Parsing an RFC 3339 duration with regular expressions is not
2653
# possible - there would have to be multiple places for the same
2654
# values, like seconds. The current code, while more esoteric, is
2655
# cleaner without depending on a parsing library. If Python had a
2656
# built-in library for parsing we would use it, but we'd like to
2657
# avoid excessive use of external libraries.
2659
# New type for defining tokens, syntax, and semantics all-in-one
2660
Token = collections.namedtuple("Token", (
2661
"regexp", # To match token; if "value" is not None, must have
2662
# a "group" containing digits
2663
"value", # datetime.timedelta or None
2664
"followers")) # Tokens valid after this token
2665
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2666
# the "duration" ABNF definition in RFC 3339, Appendix A.
2667
token_end = Token(re.compile(r"$"), None, frozenset())
2668
token_second = Token(re.compile(r"(\d+)S"),
2669
datetime.timedelta(seconds=1),
2670
frozenset((token_end, )))
2671
token_minute = Token(re.compile(r"(\d+)M"),
2672
datetime.timedelta(minutes=1),
2673
frozenset((token_second, token_end)))
2674
token_hour = Token(re.compile(r"(\d+)H"),
2675
datetime.timedelta(hours=1),
2676
frozenset((token_minute, token_end)))
2677
token_time = Token(re.compile(r"T"),
2679
frozenset((token_hour, token_minute,
2681
token_day = Token(re.compile(r"(\d+)D"),
2682
datetime.timedelta(days=1),
2683
frozenset((token_time, token_end)))
2684
token_month = Token(re.compile(r"(\d+)M"),
2685
datetime.timedelta(weeks=4),
2686
frozenset((token_day, token_end)))
2687
token_year = Token(re.compile(r"(\d+)Y"),
2688
datetime.timedelta(weeks=52),
2689
frozenset((token_month, token_end)))
2690
token_week = Token(re.compile(r"(\d+)W"),
2691
datetime.timedelta(weeks=1),
2692
frozenset((token_end, )))
2693
token_duration = Token(re.compile(r"P"), None,
2694
frozenset((token_year, token_month,
2695
token_day, token_time,
2697
# Define starting values:
2699
value = datetime.timedelta()
2701
# Following valid tokens
2702
followers = frozenset((token_duration, ))
2703
# String left to parse
2705
# Loop until end token is found
2706
while found_token is not token_end:
2707
# Search for any currently valid tokens
2708
for token in followers:
2709
match = token.regexp.match(s)
2710
if match is not None:
2712
if token.value is not None:
2713
# Value found, parse digits
2714
factor = int(match.group(1), 10)
2715
# Add to value so far
2716
value += factor * token.value
2717
# Strip token from string
2718
s = token.regexp.sub("", s, 1)
2721
# Set valid next tokens
2722
followers = found_token.followers
2725
# No currently valid tokens were found
2726
raise ValueError("Invalid RFC 3339 duration: {!r}"
2732
1653
def string_to_delta(interval):
2733
1654
"""Parse a string and return a datetime.timedelta
2735
1656
>>> string_to_delta('7d')
2736
1657
datetime.timedelta(7)
2737
1658
>>> string_to_delta('60s')
2832
1771
parser.add_argument("--no-dbus", action="store_false",
2833
1772
dest="use_dbus", help="Do not provide D-Bus"
2834
" system bus interface", default=None)
1773
" system bus interface")
2835
1774
parser.add_argument("--no-ipv6", action="store_false",
2836
dest="use_ipv6", help="Do not use IPv6",
2838
parser.add_argument("--no-restore", action="store_false",
2839
dest="restore", help="Do not restore stored"
2840
" state", default=None)
2841
parser.add_argument("--socket", type=int,
2842
help="Specify a file descriptor to a network"
2843
" socket to use instead of creating one")
2844
parser.add_argument("--statedir", metavar="DIR",
2845
help="Directory to save/restore state in")
2846
parser.add_argument("--foreground", action="store_true",
2847
help="Run in foreground", default=None)
2848
parser.add_argument("--no-zeroconf", action="store_false",
2849
dest="zeroconf", help="Do not use Zeroconf",
1775
dest="use_ipv6", help="Do not use IPv6")
2852
1776
options = parser.parse_args()
2854
1778
if options.check:
2856
fail_count, test_count = doctest.testmod()
2857
sys.exit(os.EX_OK if fail_count == 0 else 1)
2859
1783
# Default values for config file for server-global settings
2860
server_defaults = {"interface": "",
2865
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2866
":+SIGN-DSA-SHA256",
2867
"servicename": "Mandos",
2873
"statedir": "/var/lib/mandos",
2874
"foreground": "False",
1784
server_defaults = { "interface": "",
1789
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1790
"servicename": "Mandos",
2878
1796
# Parse config file for server-global settings
2879
1797
server_config = configparser.SafeConfigParser(server_defaults)
2880
1798
del server_defaults
2881
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1799
server_config.read(os.path.join(options.configdir,
2882
1801
# Convert the SafeConfigParser object to a dict
2883
1802
server_settings = server_config.defaults()
2884
1803
# Use the appropriate methods on the non-string config options
2885
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1804
for option in ("debug", "use_dbus", "use_ipv6"):
2886
1805
server_settings[option] = server_config.getboolean("DEFAULT",
2888
1807
if server_settings["port"]:
2889
1808
server_settings["port"] = server_config.getint("DEFAULT",
2891
if server_settings["socket"]:
2892
server_settings["socket"] = server_config.getint("DEFAULT",
2894
# Later, stdin will, and stdout and stderr might, be dup'ed
2895
# over with an opened os.devnull. But we don't want this to
2896
# happen with a supplied network socket.
2897
if 0 <= server_settings["socket"] <= 2:
2898
server_settings["socket"] = os.dup(server_settings
2900
1810
del server_config
2902
1812
# Override the settings from the config file with command line
2903
1813
# options, if set.
2904
1814
for option in ("interface", "address", "port", "debug",
2905
"priority", "servicename", "configdir", "use_dbus",
2906
"use_ipv6", "debuglevel", "restore", "statedir",
2907
"socket", "foreground", "zeroconf"):
1815
"priority", "servicename", "configdir",
1816
"use_dbus", "use_ipv6", "debuglevel"):
2908
1817
value = getattr(options, option)
2909
1818
if value is not None:
2910
1819
server_settings[option] = value
2912
1821
# Force all strings to be unicode
2913
1822
for option in server_settings.keys():
2914
if isinstance(server_settings[option], bytes):
2915
server_settings[option] = (server_settings[option]
2917
# Force all boolean options to be boolean
2918
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2919
"foreground", "zeroconf"):
2920
server_settings[option] = bool(server_settings[option])
2921
# Debug implies foreground
2922
if server_settings["debug"]:
2923
server_settings["foreground"] = True
1823
if type(server_settings[option]) is str:
1824
server_settings[option] = unicode(server_settings[option])
2924
1825
# Now we have our good server settings in "server_settings"
2926
1827
##################################################################
2928
if (not server_settings["zeroconf"]
2929
and not (server_settings["port"]
2930
or server_settings["socket"] != "")):
2931
parser.error("Needs port or socket to work without Zeroconf")
2933
1829
# For convenience
2934
1830
debug = server_settings["debug"]
2935
1831
debuglevel = server_settings["debuglevel"]
2936
1832
use_dbus = server_settings["use_dbus"]
2937
1833
use_ipv6 = server_settings["use_ipv6"]
2938
stored_state_path = os.path.join(server_settings["statedir"],
2940
foreground = server_settings["foreground"]
2941
zeroconf = server_settings["zeroconf"]
2944
initlogger(debug, logging.DEBUG)
2949
level = getattr(logging, debuglevel.upper())
2950
initlogger(debug, level)
2952
1835
if server_settings["servicename"] != "Mandos":
2953
syslogger.setFormatter(
2954
logging.Formatter('Mandos ({}) [%(process)d]:'
2955
' %(levelname)s: %(message)s'.format(
2956
server_settings["servicename"])))
1836
syslogger.setFormatter(logging.Formatter
1837
('Mandos (%s) [%%(process)d]:'
1838
' %%(levelname)s: %%(message)s'
1839
% server_settings["servicename"]))
2958
1841
# Parse config file with clients
2959
client_config = configparser.SafeConfigParser(Client
1842
client_defaults = { "timeout": "5m",
1843
"extended_timeout": "15m",
1845
"checker": "fping -q -- %%(host)s",
1847
"approval_delay": "0s",
1848
"approval_duration": "1s",
1850
client_config = configparser.SafeConfigParser(client_defaults)
2961
1851
client_config.read(os.path.join(server_settings["configdir"],
2962
1852
"clients.conf"))
2964
1854
global mandos_dbus_service
2965
1855
mandos_dbus_service = None
2968
if server_settings["socket"] != "":
2969
socketfd = server_settings["socket"]
2970
tcp_server = MandosServer(
2971
(server_settings["address"], server_settings["port"]),
2973
interface=(server_settings["interface"] or None),
2975
gnutls_priority=server_settings["priority"],
2979
pidfilename = "/run/mandos.pid"
2980
if not os.path.isdir("/run/."):
2981
pidfilename = "/var/run/mandos.pid"
2984
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2985
except IOError as e:
2986
logger.error("Could not open file %r", pidfilename,
2989
for name, group in (("_mandos", "_mandos"),
2990
("mandos", "mandos"),
2991
("nobody", "nogroup")):
2993
uid = pwd.getpwnam(name).pw_uid
2994
gid = pwd.getpwnam(group).pw_gid
1857
tcp_server = MandosServer((server_settings["address"],
1858
server_settings["port"]),
1860
interface=(server_settings["interface"]
1864
server_settings["priority"],
1867
pidfilename = "/var/run/mandos.pid"
1869
pidfile = open(pidfilename, "w")
1871
logger.error("Could not open file %r", pidfilename)
1874
uid = pwd.getpwnam("_mandos").pw_uid
1875
gid = pwd.getpwnam("_mandos").pw_gid
1878
uid = pwd.getpwnam("mandos").pw_uid
1879
gid = pwd.getpwnam("mandos").pw_gid
2996
1880
except KeyError:
1882
uid = pwd.getpwnam("nobody").pw_uid
1883
gid = pwd.getpwnam("nobody").pw_gid
3005
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3007
1890
except OSError as error:
3008
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3009
.format(uid, gid, os.strerror(error.errno)))
3010
if error.errno != errno.EPERM:
1891
if error[0] != errno.EPERM:
1894
if not debug and not debuglevel:
1895
syslogger.setLevel(logging.WARNING)
1896
console.setLevel(logging.WARNING)
1898
level = getattr(logging, debuglevel.upper())
1899
syslogger.setLevel(level)
1900
console.setLevel(level)
3014
1903
# Enable all possible GnuTLS debugging
3016
1905
# "Use a log level over 10 to enable all debugging options."
3017
1906
# - GnuTLS manual
3018
gnutls.global_set_log_level(11)
1907
gnutls.library.functions.gnutls_global_set_log_level(11)
1909
@gnutls.library.types.gnutls_log_func
3021
1910
def debug_gnutls(level, string):
3022
1911
logger.debug("GnuTLS: %s", string[:-1])
3024
gnutls.global_set_log_function(debug_gnutls)
1913
(gnutls.library.functions
1914
.gnutls_global_set_log_function(debug_gnutls))
3026
1916
# Redirect stdin so all checkers get /dev/null
3027
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1917
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3028
1918
os.dup2(null, sys.stdin.fileno())
1922
# No console logging
1923
logger.removeHandler(console)
3032
1925
# Need to fork before connecting to D-Bus
3034
1927
# Close all input and output, do double fork, etc.
3037
# multiprocessing will use threads, so before we use GLib we need
3038
# to inform GLib that threads will be used.
3041
1930
global main_loop
3042
1931
# From the Avahi example code
3043
DBusGMainLoop(set_as_default=True)
3044
main_loop = GLib.MainLoop()
1932
DBusGMainLoop(set_as_default=True )
1933
main_loop = gobject.MainLoop()
3045
1934
bus = dbus.SystemBus()
3046
1935
# End of Avahi example code
3049
bus_name = dbus.service.BusName("se.recompile.Mandos",
3052
old_bus_name = dbus.service.BusName(
3053
"se.bsnet.fukt.Mandos", bus,
3055
except dbus.exceptions.DBusException as e:
3056
logger.error("Disabling D-Bus:", exc_info=e)
1938
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1939
bus, do_not_queue=True)
1940
bus_name2 = dbus.service.BusName("se.recompile.Mandos",
1941
bus, do_not_queue=True)
1942
except dbus.exceptions.NameExistsException as e:
1943
logger.error(unicode(e) + ", disabling D-Bus")
3057
1944
use_dbus = False
3058
1945
server_settings["use_dbus"] = False
3059
1946
tcp_server.use_dbus = False
3061
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3062
service = AvahiServiceToSyslog(
3063
name=server_settings["servicename"],
3064
servicetype="_mandos._tcp",
3067
if server_settings["interface"]:
3068
service.interface = if_nametoindex(
3069
server_settings["interface"].encode("utf-8"))
1947
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1948
service = AvahiService(name = server_settings["servicename"],
1949
servicetype = "_mandos._tcp",
1950
protocol = protocol, bus = bus)
1951
if server_settings["interface"]:
1952
service.interface = (if_nametoindex
1953
(str(server_settings["interface"])))
3071
1955
global multiprocessing_manager
3072
1956
multiprocessing_manager = multiprocessing.Manager()
3074
1958
client_class = Client
3076
client_class = functools.partial(ClientDBus, bus=bus)
3078
client_settings = Client.config_parser(client_config)
3079
old_client_settings = {}
3082
# This is used to redirect stdout and stderr for checker processes
3084
wnull = open(os.devnull, "w") # A writable /dev/null
3085
# Only used if server is running in foreground but not in debug
3087
if debug or not foreground:
3090
# Get client data and settings from last running state.
3091
if server_settings["restore"]:
3093
with open(stored_state_path, "rb") as stored_state:
3094
if sys.version_info.major == 2:
3095
clients_data, old_client_settings = pickle.load(
3098
bytes_clients_data, bytes_old_client_settings = (
3099
pickle.load(stored_state, encoding="bytes"))
3100
# Fix bytes to strings
3103
clients_data = {(key.decode("utf-8")
3104
if isinstance(key, bytes)
3107
bytes_clients_data.items()}
3108
del bytes_clients_data
3109
for key in clients_data:
3110
value = {(k.decode("utf-8")
3111
if isinstance(k, bytes) else k): v
3113
clients_data[key].items()}
3114
clients_data[key] = value
3116
value["client_structure"] = [
3118
if isinstance(s, bytes)
3120
value["client_structure"]]
3122
for k in ("name", "host"):
3123
if isinstance(value[k], bytes):
3124
value[k] = value[k].decode("utf-8")
3125
# old_client_settings
3127
old_client_settings = {
3128
(key.decode("utf-8")
3129
if isinstance(key, bytes)
3132
bytes_old_client_settings.items()}
3133
del bytes_old_client_settings
3135
for value in old_client_settings.values():
3136
if isinstance(value["host"], bytes):
3137
value["host"] = (value["host"]
3139
os.remove(stored_state_path)
3140
except IOError as e:
3141
if e.errno == errno.ENOENT:
3142
logger.warning("Could not load persistent state:"
3143
" {}".format(os.strerror(e.errno)))
3145
logger.critical("Could not load persistent state:",
3148
except EOFError as e:
3149
logger.warning("Could not load persistent state: "
3153
with PGPEngine() as pgp:
3154
for client_name, client in clients_data.items():
3155
# Skip removed clients
3156
if client_name not in client_settings:
3159
# Decide which value to use after restoring saved state.
3160
# We have three different values: Old config file,
3161
# new config file, and saved state.
3162
# New config value takes precedence if it differs from old
3163
# config value, otherwise use saved state.
3164
for name, value in client_settings[client_name].items():
3166
# For each value in new config, check if it
3167
# differs from the old config value (Except for
3168
# the "secret" attribute)
3169
if (name != "secret"
3171
old_client_settings[client_name][name])):
3172
client[name] = value
3176
# Clients who has passed its expire date can still be
3177
# enabled if its last checker was successful. A Client
3178
# whose checker succeeded before we stored its state is
3179
# assumed to have successfully run all checkers during
3181
if client["enabled"]:
3182
if datetime.datetime.utcnow() >= client["expires"]:
3183
if not client["last_checked_ok"]:
3185
"disabling client {} - Client never "
3186
"performed a successful checker".format(
3188
client["enabled"] = False
3189
elif client["last_checker_status"] != 0:
3191
"disabling client {} - Client last"
3192
" checker failed with error code"
3195
client["last_checker_status"]))
3196
client["enabled"] = False
3198
client["expires"] = (
3199
datetime.datetime.utcnow()
3200
+ client["timeout"])
3201
logger.debug("Last checker succeeded,"
3202
" keeping {} enabled".format(
1960
client_class = functools.partial(ClientDBusTransitional, bus = bus)
1961
def client_config_items(config, section):
1962
special_settings = {
1963
"approved_by_default":
1964
lambda: config.getboolean(section,
1965
"approved_by_default"),
1967
for name, value in config.items(section):
3205
client["secret"] = pgp.decrypt(
3206
client["encrypted_secret"],
3207
client_settings[client_name]["secret"])
3209
# If decryption fails, we use secret from new settings
3210
logger.debug("Failed to decrypt {} old secret".format(
3212
client["secret"] = (client_settings[client_name]
3215
# Add/remove clients based on new changes made to config
3216
for client_name in (set(old_client_settings)
3217
- set(client_settings)):
3218
del clients_data[client_name]
3219
for client_name in (set(client_settings)
3220
- set(old_client_settings)):
3221
clients_data[client_name] = client_settings[client_name]
3223
# Create all client objects
3224
for client_name, client in clients_data.items():
3225
tcp_server.clients[client_name] = client_class(
3228
server_settings=server_settings)
1969
yield (name, special_settings[name]())
1973
tcp_server.clients.update(set(
1974
client_class(name = section,
1975
config= dict(client_config_items(
1976
client_config, section)))
1977
for section in client_config.sections()))
3230
1978
if not tcp_server.clients:
3231
1979
logger.warning("No clients defined")
3234
if pidfile is not None:
3238
print(pid, file=pidfile)
3240
logger.error("Could not write to file %r with PID %d",
1985
pidfile.write(str(pid) + "\n".encode("utf-8"))
1988
logger.error("Could not write to file %r with PID %d",
1991
# "pidfile" was never created
3243
1993
del pidfilename
3245
for termsig in (signal.SIGHUP, signal.SIGTERM):
3246
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3247
lambda: main_loop.quit() and False)
1995
signal.signal(signal.SIGINT, signal.SIG_IGN)
1997
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1998
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3251
@alternate_dbus_interfaces(
3252
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3253
class MandosDBusService(DBusObjectWithObjectManager):
2001
class MandosDBusService(dbus.service.Object):
3254
2002
"""A D-Bus proxy object"""
3256
2003
def __init__(self):
3257
2004
dbus.service.Object.__init__(self, bus, "/")
3259
_interface = "se.recompile.Mandos"
2005
_interface = "se.bsnet.fukt.Mandos"
3261
2007
@dbus.service.signal(_interface, signature="o")
3262
2008
def ClientAdded(self, objpath):
3266
2012
@dbus.service.signal(_interface, signature="ss")
3267
2013
def ClientNotFound(self, fingerprint, address):
3271
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3273
2017
@dbus.service.signal(_interface, signature="os")
3274
2018
def ClientRemoved(self, objpath, name):
3278
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3280
2022
@dbus.service.method(_interface, out_signature="ao")
3281
2023
def GetAllClients(self):
3283
return dbus.Array(c.dbus_object_path for c in
3284
tcp_server.clients.values())
3286
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2025
return dbus.Array(c.dbus_object_path
2026
for c in tcp_server.clients)
3288
2028
@dbus.service.method(_interface,
3289
2029
out_signature="a{oa{sv}}")
3290
2030
def GetAllClientsWithProperties(self):
3292
2032
return dbus.Dictionary(
3293
{c.dbus_object_path: c.GetAll(
3294
"se.recompile.Mandos.Client")
3295
for c in tcp_server.clients.values()},
2033
((c.dbus_object_path, c.GetAll(""))
2034
for c in tcp_server.clients),
3296
2035
signature="oa{sv}")
3298
2037
@dbus.service.method(_interface, in_signature="o")
3299
2038
def RemoveClient(self, object_path):
3301
for c in tcp_server.clients.values():
2040
for c in tcp_server.clients:
3302
2041
if c.dbus_object_path == object_path:
3303
del tcp_server.clients[c.name]
2042
tcp_server.clients.remove(c)
3304
2043
c.remove_from_connection()
3305
# Don't signal the disabling
2044
# Don't signal anything except ClientRemoved
3306
2045
c.disable(quiet=True)
3307
# Emit D-Bus signal for removal
3308
self.client_removed_signal(c)
2047
self.ClientRemoved(object_path, c.name)
3310
2049
raise KeyError(object_path)
3314
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3315
out_signature="a{oa{sa{sv}}}")
3316
def GetManagedObjects(self):
3318
return dbus.Dictionary(
3319
{client.dbus_object_path:
3321
{interface: client.GetAll(interface)
3323
client._get_all_interface_names()})
3324
for client in tcp_server.clients.values()})
3326
def client_added_signal(self, client):
3327
"""Send the new standard signal and the old signal"""
3329
# New standard signal
3330
self.InterfacesAdded(
3331
client.dbus_object_path,
3333
{interface: client.GetAll(interface)
3335
client._get_all_interface_names()}))
3337
self.ClientAdded(client.dbus_object_path)
3339
def client_removed_signal(self, client):
3340
"""Send the new standard signal and the old signal"""
3342
# New standard signal
3343
self.InterfacesRemoved(
3344
client.dbus_object_path,
3345
client._get_all_interface_names())
3347
self.ClientRemoved(client.dbus_object_path,
3350
mandos_dbus_service = MandosDBusService()
3352
# Save modules to variables to exempt the modules from being
3353
# unloaded before the function registered with atexit() is run.
3354
mp = multiprocessing
2053
class MandosDBusServiceTransitional(MandosDBusService):
2054
__metaclass__ = transitional_dbus_metaclass
2055
mandos_dbus_service = MandosDBusServiceTransitional()
3358
2058
"Cleanup function; run on exit"
3362
mp.active_children()
3364
if not (tcp_server.clients or client_settings):
3367
# Store client before exiting. Secrets are encrypted with key
3368
# based on what config file has. If config file is
3369
# removed/edited, old secret will thus be unrecovable.
3371
with PGPEngine() as pgp:
3372
for client in tcp_server.clients.values():
3373
key = client_settings[client.name]["secret"]
3374
client.encrypted_secret = pgp.encrypt(client.secret,
3378
# A list of attributes that can not be pickled
3380
exclude = {"bus", "changedstate", "secret",
3381
"checker", "server_settings"}
3382
for name, typ in inspect.getmembers(dbus.service
3386
client_dict["encrypted_secret"] = (client
3388
for attr in client.client_structure:
3389
if attr not in exclude:
3390
client_dict[attr] = getattr(client, attr)
3392
clients[client.name] = client_dict
3393
del client_settings[client.name]["secret"]
3396
with tempfile.NamedTemporaryFile(
3400
dir=os.path.dirname(stored_state_path),
3401
delete=False) as stored_state:
3402
pickle.dump((clients, client_settings), stored_state,
3404
tempname = stored_state.name
3405
os.rename(tempname, stored_state_path)
3406
except (IOError, OSError) as e:
3412
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3413
logger.warning("Could not save persistent state: {}"
3414
.format(os.strerror(e.errno)))
3416
logger.warning("Could not save persistent state:",
3420
# Delete all clients, and settings from config
3421
2061
while tcp_server.clients:
3422
name, client = tcp_server.clients.popitem()
2062
client = tcp_server.clients.pop()
3424
2064
client.remove_from_connection()
3425
# Don't signal the disabling
2065
client.disable_hook = None
2066
# Don't signal anything except ClientRemoved
3426
2067
client.disable(quiet=True)
3427
# Emit D-Bus signal for removal
3429
mandos_dbus_service.client_removed_signal(client)
3430
client_settings.clear()
2070
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3432
2073
atexit.register(cleanup)
3434
for client in tcp_server.clients.values():
2075
for client in tcp_server.clients:
3436
# Emit D-Bus signal for adding
3437
mandos_dbus_service.client_added_signal(client)
3438
# Need to initiate checking of clients
3440
client.init_checker()
2078
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3442
2081
tcp_server.enable()
3443
2082
tcp_server.server_activate()
3445
2084
# Find out what port we got
3447
service.port = tcp_server.socket.getsockname()[1]
2085
service.port = tcp_server.socket.getsockname()[1]
3449
2087
logger.info("Now listening on address %r, port %d,"
3450
" flowinfo %d, scope_id %d",
3451
*tcp_server.socket.getsockname())
2088
" flowinfo %d, scope_id %d"
2089
% tcp_server.socket.getsockname())
3453
logger.info("Now listening on address %r, port %d",
3454
*tcp_server.socket.getsockname())
3456
# service.interface = tcp_server.socket.getsockname()[3]
2091
logger.info("Now listening on address %r, port %d"
2092
% tcp_server.socket.getsockname())
2094
#service.interface = tcp_server.socket.getsockname()[3]
3460
# From the Avahi example code
3463
except dbus.exceptions.DBusException as error:
3464
logger.critical("D-Bus Exception", exc_info=error)
3467
# End of Avahi example code
3469
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3470
lambda *args, **kwargs:
3471
(tcp_server.handle_request
3472
(*args[2:], **kwargs) or True))
2097
# From the Avahi example code
2100
except dbus.exceptions.DBusException as error:
2101
logger.critical("DBusException: %s", error)
2104
# End of Avahi example code
2106
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2107
lambda *args, **kwargs:
2108
(tcp_server.handle_request
2109
(*args[2:], **kwargs) or True))
3474
2111
logger.debug("Starting main loop")
3475
2112
main_loop.run()
3476
2113
except AvahiError as error:
3477
logger.critical("Avahi Error", exc_info=error)
2114
logger.critical("AvahiError: %s", error)
3480
2117
except KeyboardInterrupt: