69
import cPickle as pickle
63
import cPickle as pickle
72
64
import multiprocessing
81
67
import dbus.service
82
from gi.repository import GLib
83
70
from dbus.mainloop.glib import DBusGMainLoop
86
73
import xml.dom.minidom
89
# Try to find the value of SO_BINDTODEVICE:
91
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
92
# newer, and it is also the most natural place for it:
93
77
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
94
78
except AttributeError:
96
# This is where SO_BINDTODEVICE was up to and including Python
98
80
from IN import SO_BINDTODEVICE
99
81
except ImportError:
100
# In Python 2.7 it seems to have been removed entirely.
101
# Try running the C preprocessor:
103
cc = subprocess.Popen(["cc", "--language=c", "-E",
105
stdin=subprocess.PIPE,
106
stdout=subprocess.PIPE)
107
stdout = cc.communicate(
108
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
109
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
110
except (OSError, ValueError, IndexError):
112
SO_BINDTODEVICE = None
114
if sys.version_info.major == 2:
118
stored_state_file = "clients.pickle"
120
logger = logging.getLogger()
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
ctypes.util.find_library("c")).if_nametoindex
126
except (OSError, AttributeError):
128
def if_nametoindex(interface):
129
"Get an interface index the hard way, i.e. using fcntl()"
130
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
131
with contextlib.closing(socket.socket()) as s:
132
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
133
struct.pack(b"16s16x", interface))
134
interface_index = struct.unpack("I", ifreq[16:20])[0]
135
return interface_index
138
def copy_function(func):
139
"""Make a copy of a function"""
140
if sys.version_info.major == 2:
141
return types.FunctionType(func.func_code,
147
return types.FunctionType(func.__code__,
154
def initlogger(debug, level=logging.WARNING):
155
"""init logger and add loglevel"""
158
syslogger = (logging.handlers.SysLogHandler(
159
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
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
82
SO_BINDTODEVICE = None
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
89
syslogger = (logging.handlers.SysLogHandler
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
address = str("/dev/log")))
92
syslogger.setFormatter(logging.Formatter
93
('Mandos [%(process)d]: %(levelname)s:'
95
logger.addHandler(syslogger)
97
console = logging.StreamHandler()
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
101
logger.addHandler(console)
303
103
class AvahiError(Exception):
304
104
def __init__(self, value, *args, **kwargs):
305
105
self.value = value
306
return super(AvahiError, self).__init__(value, *args,
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
310
110
class AvahiServiceError(AvahiError):
314
113
class AvahiGroupError(AvahiError):
318
117
class AvahiService(object):
319
118
"""An Avahi (Zeroconf) service.
322
121
interface: integer; avahi.IF_UNSPEC or an interface index.
323
122
Used to optionally bind to the specified interface.
324
123
name: string; Example: 'Mandos'
325
124
type: string; Example: '_mandos._tcp'.
326
See <https://www.iana.org/assignments/service-names-port-numbers>
125
See <http://www.dns-sd.org/ServiceTypes.html>
327
126
port: integer; what port to announce
328
127
TXT: list of strings; TXT record for the service
329
128
domain: string; Domain to publish on, default to .local if empty.
488
260
follow_name_owner_changes=True),
489
261
avahi.DBUS_INTERFACE_SERVER)
490
262
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
263
self.server_state_changed)
492
264
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.cdll.LoadLibrary(
511
ctypes.util.find_library("gnutls"))
512
_need_version = b"3.3.0"
515
# Need to use class name "GnuTLS" here, since this method is
516
# called before the assignment to the "gnutls" global variable
518
if GnuTLS.check_version(self._need_version) is None:
519
raise GnuTLS.Error("Needs GnuTLS {} or later"
520
.format(self._need_version))
522
# Unless otherwise indicated, the constants and types below are
523
# all from the gnutls/gnutls.h C header file.
533
E_NO_CERTIFICATE_FOUND = -49
534
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
537
class session_int(ctypes.Structure):
539
session_t = ctypes.POINTER(session_int)
541
class certificate_credentials_st(ctypes.Structure):
543
certificate_credentials_t = ctypes.POINTER(
544
certificate_credentials_st)
545
certificate_type_t = ctypes.c_int
547
class datum_t(ctypes.Structure):
548
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
549
('size', ctypes.c_uint)]
551
class openpgp_crt_int(ctypes.Structure):
553
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
554
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
555
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
556
credentials_type_t = ctypes.c_int
557
transport_ptr_t = ctypes.c_void_p
558
close_request_t = ctypes.c_int
561
class Error(Exception):
562
# We need to use the class name "GnuTLS" here, since this
563
# exception might be raised from within GnuTLS.__init__,
564
# which is called before the assignment to the "gnutls"
565
# global variable has happened.
566
def __init__(self, message=None, code=None, args=()):
567
# Default usage is by a message string, but if a return
568
# code is passed, convert it to a string with
571
if message is None and code is not None:
572
message = GnuTLS.strerror(code)
573
return super(GnuTLS.Error, self).__init__(
576
class CertificateSecurityError(Error):
580
class Credentials(object):
582
self._c_object = gnutls.certificate_credentials_t()
583
gnutls.certificate_allocate_credentials(
584
ctypes.byref(self._c_object))
585
self.type = gnutls.CRD_CERTIFICATE
588
gnutls.certificate_free_credentials(self._c_object)
590
class ClientSession(object):
591
def __init__(self, socket, credentials=None):
592
self._c_object = gnutls.session_t()
593
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
594
gnutls.set_default_priority(self._c_object)
595
gnutls.transport_set_ptr(self._c_object, socket.fileno())
596
gnutls.handshake_set_private_extensions(self._c_object,
599
if credentials is None:
600
credentials = gnutls.Credentials()
601
gnutls.credentials_set(self._c_object, credentials.type,
602
ctypes.cast(credentials._c_object,
604
self.credentials = credentials
607
gnutls.deinit(self._c_object)
610
return gnutls.handshake(self._c_object)
612
def send(self, data):
616
data_len -= gnutls.record_send(self._c_object,
621
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
623
# Error handling functions
624
def _error_code(result):
625
"""A function to raise exceptions on errors, suitable
626
for the 'restype' attribute on ctypes functions"""
629
if result == gnutls.E_NO_CERTIFICATE_FOUND:
630
raise gnutls.CertificateSecurityError(code=result)
631
raise gnutls.Error(code=result)
633
def _retry_on_error(result, func, arguments):
634
"""A function to retry on some errors, suitable
635
for the 'errcheck' attribute on ctypes functions"""
637
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
638
return _error_code(result)
639
result = func(*arguments)
642
# Unless otherwise indicated, the function declarations below are
643
# all from the gnutls/gnutls.h C header file.
646
priority_set_direct = _library.gnutls_priority_set_direct
647
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
648
ctypes.POINTER(ctypes.c_char_p)]
649
priority_set_direct.restype = _error_code
651
init = _library.gnutls_init
652
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
653
init.restype = _error_code
655
set_default_priority = _library.gnutls_set_default_priority
656
set_default_priority.argtypes = [session_t]
657
set_default_priority.restype = _error_code
659
record_send = _library.gnutls_record_send
660
record_send.argtypes = [session_t, ctypes.c_void_p,
662
record_send.restype = ctypes.c_ssize_t
663
record_send.errcheck = _retry_on_error
665
certificate_allocate_credentials = (
666
_library.gnutls_certificate_allocate_credentials)
667
certificate_allocate_credentials.argtypes = [
668
ctypes.POINTER(certificate_credentials_t)]
669
certificate_allocate_credentials.restype = _error_code
671
certificate_free_credentials = (
672
_library.gnutls_certificate_free_credentials)
673
certificate_free_credentials.argtypes = [
674
certificate_credentials_t]
675
certificate_free_credentials.restype = None
677
handshake_set_private_extensions = (
678
_library.gnutls_handshake_set_private_extensions)
679
handshake_set_private_extensions.argtypes = [session_t,
681
handshake_set_private_extensions.restype = None
683
credentials_set = _library.gnutls_credentials_set
684
credentials_set.argtypes = [session_t, credentials_type_t,
686
credentials_set.restype = _error_code
688
strerror = _library.gnutls_strerror
689
strerror.argtypes = [ctypes.c_int]
690
strerror.restype = ctypes.c_char_p
692
certificate_type_get = _library.gnutls_certificate_type_get
693
certificate_type_get.argtypes = [session_t]
694
certificate_type_get.restype = _error_code
696
certificate_get_peers = _library.gnutls_certificate_get_peers
697
certificate_get_peers.argtypes = [session_t,
698
ctypes.POINTER(ctypes.c_uint)]
699
certificate_get_peers.restype = ctypes.POINTER(datum_t)
701
global_set_log_level = _library.gnutls_global_set_log_level
702
global_set_log_level.argtypes = [ctypes.c_int]
703
global_set_log_level.restype = None
705
global_set_log_function = _library.gnutls_global_set_log_function
706
global_set_log_function.argtypes = [log_func]
707
global_set_log_function.restype = None
709
deinit = _library.gnutls_deinit
710
deinit.argtypes = [session_t]
711
deinit.restype = None
713
handshake = _library.gnutls_handshake
714
handshake.argtypes = [session_t]
715
handshake.restype = _error_code
716
handshake.errcheck = _retry_on_error
718
transport_set_ptr = _library.gnutls_transport_set_ptr
719
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
720
transport_set_ptr.restype = None
722
bye = _library.gnutls_bye
723
bye.argtypes = [session_t, close_request_t]
724
bye.restype = _error_code
725
bye.errcheck = _retry_on_error
727
check_version = _library.gnutls_check_version
728
check_version.argtypes = [ctypes.c_char_p]
729
check_version.restype = ctypes.c_char_p
731
# All the function declarations below are from gnutls/openpgp.h
733
openpgp_crt_init = _library.gnutls_openpgp_crt_init
734
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
735
openpgp_crt_init.restype = _error_code
737
openpgp_crt_import = _library.gnutls_openpgp_crt_import
738
openpgp_crt_import.argtypes = [openpgp_crt_t,
739
ctypes.POINTER(datum_t),
741
openpgp_crt_import.restype = _error_code
743
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
744
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
745
ctypes.POINTER(ctypes.c_uint)]
746
openpgp_crt_verify_self.restype = _error_code
748
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
749
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
750
openpgp_crt_deinit.restype = None
752
openpgp_crt_get_fingerprint = (
753
_library.gnutls_openpgp_crt_get_fingerprint)
754
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
758
openpgp_crt_get_fingerprint.restype = _error_code
760
# Remove non-public functions
761
del _error_code, _retry_on_error
762
# Create the global "gnutls" object, simulating a module
766
def call_pipe(connection, # : multiprocessing.Connection
767
func, *args, **kwargs):
768
"""This function is meant to be called by multiprocessing.Process
770
This function runs func(*args, **kwargs), and writes the resulting
771
return value on the provided multiprocessing.Connection.
773
connection.send(func(*args, **kwargs))
267
def _timedelta_to_milliseconds(td):
268
"Convert a datetime.timedelta() to milliseconds"
269
return ((td.days * 24 * 60 * 60 * 1000)
270
+ (td.seconds * 1000)
271
+ (td.microseconds // 1000))
777
273
class Client(object):
778
274
"""A representation of a client host served by this server.
781
approved: bool(); 'None' if not yet approved/disapproved
277
_approved: bool(); 'None' if not yet approved/disapproved
782
278
approval_delay: datetime.timedelta(); Time to wait for approval
783
279
approval_duration: datetime.timedelta(); Duration of one approval
784
280
checker: subprocess.Popen(); a running checker process used
785
281
to see if the client lives.
786
282
'None' if no process is running.
787
checker_callback_tag: a GLib event source tag, or None
283
checker_callback_tag: a gobject event source tag, or None
788
284
checker_command: string; External command which is run to check
789
285
if client lives. %() expansions are done at
790
286
runtime with vars(self) as dict, so that for
791
287
instance %(name)s can be used in the command.
792
checker_initiator_tag: a GLib event source tag, or None
288
checker_initiator_tag: a gobject event source tag, or None
793
289
created: datetime.datetime(); (UTC) object creation
794
client_structure: Object describing what attributes a client has
795
and is used for storing the client at exit
796
290
current_checker_command: string; current running checker_command
797
disable_initiator_tag: a GLib event source tag, or None
291
disable_hook: If set, called by disable() as disable_hook(self)
292
disable_initiator_tag: a gobject event source tag, or None
799
294
fingerprint: string (40 or 32 hexadecimal digits); used to
800
295
uniquely identify the client
802
297
interval: datetime.timedelta(); How often to start a new checker
803
298
last_approval_request: datetime.datetime(); (UTC) or None
804
299
last_checked_ok: datetime.datetime(); (UTC) or None
805
last_checker_status: integer between 0 and 255 reflecting exit
806
status of last checker. -1 reflects crashed
807
checker, -2 means no checker completed yet.
808
last_checker_signal: The signal which killed the last checker, if
809
last_checker_status is -1
810
last_enabled: datetime.datetime(); (UTC) or None
300
last_enabled: datetime.datetime(); (UTC)
811
301
name: string; from the config file, used in log messages and
812
302
D-Bus identifiers
813
303
secret: bytestring; sent verbatim (over TLS) to client
814
304
timeout: datetime.timedelta(); How long from last_checked_ok
815
305
until this client is disabled
816
extended_timeout: extra long timeout when secret has been sent
306
extended_timeout: extra long timeout when password has been sent
817
307
runtime_expansions: Allowed attributes for runtime expansion.
818
308
expires: datetime.datetime(); time (UTC) when a client will be
819
309
disabled, or None
820
server_settings: The server_settings dict from main()
823
312
runtime_expansions = ("approval_delay", "approval_duration",
824
"created", "enabled", "expires",
825
"fingerprint", "host", "interval",
826
"last_approval_request", "last_checked_ok",
313
"created", "enabled", "fingerprint",
314
"host", "interval", "last_checked_ok",
827
315
"last_enabled", "name", "timeout")
830
"extended_timeout": "PT15M",
832
"checker": "fping -q -- %%(host)s",
834
"approval_delay": "PT0S",
835
"approval_duration": "PT1S",
836
"approved_by_default": "True",
841
def config_parser(config):
842
"""Construct a new dict of client settings of this form:
843
{ client_name: {setting_name: value, ...}, ...}
844
with exceptions for any special settings as defined above.
845
NOTE: Must be a pure function. Must return the same result
846
value given the same arguments.
849
for client_name in config.sections():
850
section = dict(config.items(client_name))
851
client = settings[client_name] = {}
853
client["host"] = section["host"]
854
# Reformat values from string types to Python types
855
client["approved_by_default"] = config.getboolean(
856
client_name, "approved_by_default")
857
client["enabled"] = config.getboolean(client_name,
860
# Uppercase and remove spaces from fingerprint for later
861
# comparison purposes with return value from the
862
# fingerprint() function
863
client["fingerprint"] = (section["fingerprint"].upper()
865
if "secret" in section:
866
client["secret"] = codecs.decode(section["secret"]
869
elif "secfile" in section:
870
with open(os.path.expanduser(os.path.expandvars
871
(section["secfile"])),
873
client["secret"] = secfile.read()
875
raise TypeError("No secret or secfile for section {}"
877
client["timeout"] = string_to_delta(section["timeout"])
878
client["extended_timeout"] = string_to_delta(
879
section["extended_timeout"])
880
client["interval"] = string_to_delta(section["interval"])
881
client["approval_delay"] = string_to_delta(
882
section["approval_delay"])
883
client["approval_duration"] = string_to_delta(
884
section["approval_duration"])
885
client["checker_command"] = section["checker"]
886
client["last_approval_request"] = None
887
client["last_checked_ok"] = None
888
client["last_checker_status"] = -2
892
def __init__(self, settings, name=None, server_settings=None):
317
def timeout_milliseconds(self):
318
"Return the 'timeout' attribute in milliseconds"
319
return _timedelta_to_milliseconds(self.timeout)
321
def extended_timeout_milliseconds(self):
322
"Return the 'extended_timeout' attribute in milliseconds"
323
return _timedelta_to_milliseconds(self.extended_timeout)
325
def interval_milliseconds(self):
326
"Return the 'interval' attribute in milliseconds"
327
return _timedelta_to_milliseconds(self.interval)
329
def approval_delay_milliseconds(self):
330
return _timedelta_to_milliseconds(self.approval_delay)
332
def __init__(self, name = None, disable_hook=None, config=None):
333
"""Note: the 'checker' key in 'config' sets the
334
'checker_command' attribute and *not* the 'checker'
894
if server_settings is None:
896
self.server_settings = server_settings
897
# adding all client settings
898
for setting, value in settings.items():
899
setattr(self, setting, value)
902
if not hasattr(self, "last_enabled"):
903
self.last_enabled = datetime.datetime.utcnow()
904
if not hasattr(self, "expires"):
905
self.expires = (datetime.datetime.utcnow()
908
self.last_enabled = None
911
339
logger.debug("Creating client %r", self.name)
340
# Uppercase and remove spaces from fingerprint for later
341
# comparison purposes with return value from the fingerprint()
343
self.fingerprint = (config["fingerprint"].upper()
912
345
logger.debug(" Fingerprint: %s", self.fingerprint)
913
self.created = settings.get("created",
914
datetime.datetime.utcnow())
916
# attributes specific for this server instance
346
if "secret" in config:
347
self.secret = config["secret"].decode("base64")
348
elif "secfile" in config:
349
with open(os.path.expanduser(os.path.expandvars
350
(config["secfile"])),
352
self.secret = secfile.read()
354
raise TypeError("No secret or secfile for client %s"
356
self.host = config.get("host", "")
357
self.created = datetime.datetime.utcnow()
359
self.last_approval_request = None
360
self.last_enabled = None
361
self.last_checked_ok = None
362
self.timeout = string_to_delta(config["timeout"])
363
self.extended_timeout = string_to_delta(config["extended_timeout"])
364
self.interval = string_to_delta(config["interval"])
365
self.disable_hook = disable_hook
917
366
self.checker = None
918
367
self.checker_initiator_tag = None
919
368
self.disable_initiator_tag = None
920
370
self.checker_callback_tag = None
371
self.checker_command = config["checker"]
921
372
self.current_checker_command = None
373
self.last_connect = None
374
self._approved = None
375
self.approved_by_default = config.get("approved_by_default",
923
377
self.approvals_pending = 0
924
self.changedstate = multiprocessing_manager.Condition(
925
multiprocessing_manager.Lock())
926
self.client_structure = [attr
927
for attr in self.__dict__.keys()
928
if not attr.startswith("_")]
929
self.client_structure.append("client_structure")
931
for name, t in inspect.getmembers(
932
type(self), lambda obj: isinstance(obj, property)):
933
if not name.startswith("_"):
934
self.client_structure.append(name)
936
# Send notice to process children that client state has changed
378
self.approval_delay = string_to_delta(
379
config["approval_delay"])
380
self.approval_duration = string_to_delta(
381
config["approval_duration"])
382
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
937
384
def send_changedstate(self):
938
with self.changedstate:
939
self.changedstate.notify_all()
385
self.changedstate.acquire()
386
self.changedstate.notify_all()
387
self.changedstate.release()
941
389
def enable(self):
942
390
"""Start this client's checker and timeout hooks"""
943
391
if getattr(self, "enabled", False):
944
392
# Already enabled
394
self.send_changedstate()
395
# Schedule a new checker to be started an 'interval' from now,
396
# and every interval from then on.
397
self.checker_initiator_tag = (gobject.timeout_add
398
(self.interval_milliseconds(),
400
# Schedule a disable() when 'timeout' has passed
946
401
self.expires = datetime.datetime.utcnow() + self.timeout
402
self.disable_initiator_tag = (gobject.timeout_add
403
(self.timeout_milliseconds(),
947
405
self.enabled = True
948
406
self.last_enabled = datetime.datetime.utcnow()
950
self.send_changedstate()
407
# Also start a new checker *right now*.
952
410
def disable(self, quiet=True):
953
411
"""Disable this client."""
954
412
if not getattr(self, "enabled", False):
415
self.send_changedstate()
957
417
logger.info("Disabling client %s", self.name)
958
if getattr(self, "disable_initiator_tag", None) is not None:
959
GLib.source_remove(self.disable_initiator_tag)
418
if getattr(self, "disable_initiator_tag", False):
419
gobject.source_remove(self.disable_initiator_tag)
960
420
self.disable_initiator_tag = None
961
421
self.expires = None
962
if getattr(self, "checker_initiator_tag", None) is not None:
963
GLib.source_remove(self.checker_initiator_tag)
422
if getattr(self, "checker_initiator_tag", False):
423
gobject.source_remove(self.checker_initiator_tag)
964
424
self.checker_initiator_tag = None
965
425
self.stop_checker()
426
if self.disable_hook:
427
self.disable_hook(self)
966
428
self.enabled = False
968
self.send_changedstate()
969
# Do not run this again if called by a GLib.timeout_add
429
# Do not run this again if called by a gobject.timeout_add
972
432
def __del__(self):
433
self.disable_hook = None
975
def init_checker(self):
976
# Schedule a new checker to be started an 'interval' from now,
977
# and every interval from then on.
978
if self.checker_initiator_tag is not None:
979
GLib.source_remove(self.checker_initiator_tag)
980
self.checker_initiator_tag = GLib.timeout_add(
981
int(self.interval.total_seconds() * 1000),
983
# Schedule a disable() when 'timeout' has passed
984
if self.disable_initiator_tag is not None:
985
GLib.source_remove(self.disable_initiator_tag)
986
self.disable_initiator_tag = GLib.timeout_add(
987
int(self.timeout.total_seconds() * 1000), self.disable)
988
# Also start a new checker *right now*.
991
def checker_callback(self, source, condition, connection,
436
def checker_callback(self, pid, condition, command):
993
437
"""The checker has completed, so take appropriate actions."""
994
438
self.checker_callback_tag = None
995
439
self.checker = None
996
# Read return code from connection (see call_pipe)
997
returncode = connection.recv()
1001
self.last_checker_status = returncode
1002
self.last_checker_signal = None
1003
if self.last_checker_status == 0:
440
if os.WIFEXITED(condition):
441
exitstatus = os.WEXITSTATUS(condition)
1004
443
logger.info("Checker for %(name)s succeeded",
1006
445
self.checked_ok()
1008
logger.info("Checker for %(name)s failed", vars(self))
447
logger.info("Checker for %(name)s failed",
1010
self.last_checker_status = -1
1011
self.last_checker_signal = -returncode
1012
450
logger.warning("Checker for %(name)s crashed?",
1016
def checked_ok(self):
1017
"""Assert that the client has been seen, alive and well."""
1018
self.last_checked_ok = datetime.datetime.utcnow()
1019
self.last_checker_status = 0
1020
self.last_checker_signal = None
1023
def bump_timeout(self, timeout=None):
1024
"""Bump up the timeout for this client."""
453
def checked_ok(self, timeout=None):
454
"""Bump up the timeout for this client.
456
This should only be called when the client has been seen,
1025
459
if timeout is None:
1026
460
timeout = self.timeout
1027
if self.disable_initiator_tag is not None:
1028
GLib.source_remove(self.disable_initiator_tag)
1029
self.disable_initiator_tag = None
1030
if getattr(self, "enabled", False):
1031
self.disable_initiator_tag = GLib.timeout_add(
1032
int(timeout.total_seconds() * 1000), self.disable)
1033
self.expires = datetime.datetime.utcnow() + timeout
461
self.last_checked_ok = datetime.datetime.utcnow()
462
gobject.source_remove(self.disable_initiator_tag)
463
self.expires = datetime.datetime.utcnow() + timeout
464
self.disable_initiator_tag = (gobject.timeout_add
465
(_timedelta_to_milliseconds(timeout),
1035
468
def need_approval(self):
1036
469
self.last_approval_request = datetime.datetime.utcnow()
1038
471
def start_checker(self):
1039
472
"""Start a new checker subprocess if one is not running.
1041
474
If a checker already exists, leave it running and do
1043
476
# The reason for not killing a running checker is that if we
1044
# did that, and if a checker (for some reason) started running
1045
# slowly and taking more than 'interval' time, then the client
1046
# would inevitably timeout, since no checker would get a
1047
# chance to run to completion. If we instead leave running
477
# did that, then if a checker (for some reason) started
478
# running slowly and taking more than 'interval' time, the
479
# client would inevitably timeout, since no checker would get
480
# a chance to run to completion. If we instead leave running
1048
481
# checkers alone, the checker would have to take more time
1049
482
# than 'timeout' for the client to be disabled, which is as it
1052
if self.checker is not None and not self.checker.is_alive():
1053
logger.warning("Checker was not alive; joining")
485
# If a checker exists, make sure it is not a zombie
487
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
488
except (AttributeError, OSError) as error:
489
if (isinstance(error, OSError)
490
and error.errno != errno.ECHILD):
494
logger.warning("Checker was a zombie")
495
gobject.source_remove(self.checker_callback_tag)
496
self.checker_callback(pid, status,
497
self.current_checker_command)
1056
498
# Start a new checker if needed
1057
499
if self.checker is None:
1058
# Escape attributes for the shell
1060
attr: re.escape(str(getattr(self, attr)))
1061
for attr in self.runtime_expansions}
1063
command = self.checker_command % escaped_attrs
1064
except TypeError as error:
1065
logger.error('Could not format string "%s"',
1066
self.checker_command,
1068
return True # Try again later
501
# In case checker_command has exactly one % operator
502
command = self.checker_command % self.host
504
# Escape attributes for the shell
505
escaped_attrs = dict(
507
re.escape(unicode(str(getattr(self, attr, "")),
511
self.runtime_expansions)
514
command = self.checker_command % escaped_attrs
515
except TypeError as error:
516
logger.error('Could not format string "%s":'
517
' %s', self.checker_command, error)
518
return True # Try again later
1069
519
self.current_checker_command = command
1070
logger.info("Starting checker %r for %s", command,
1072
# We don't need to redirect stdout and stderr, since
1073
# in normal mode, that is already done by daemon(),
1074
# and in debug mode we don't want to. (Stdin is
1075
# always replaced by /dev/null.)
1076
# The exception is when not debugging but nevertheless
1077
# running in the foreground; use the previously
1079
popen_args = {"close_fds": True,
1082
if (not self.server_settings["debug"]
1083
and self.server_settings["foreground"]):
1084
popen_args.update({"stdout": wnull,
1086
pipe = multiprocessing.Pipe(duplex=False)
1087
self.checker = multiprocessing.Process(
1089
args=(pipe[1], subprocess.call, command),
1091
self.checker.start()
1092
self.checker_callback_tag = GLib.io_add_watch(
1093
pipe[0].fileno(), GLib.IO_IN,
1094
self.checker_callback, pipe[0], command)
1095
# Re-run this periodically if run by GLib.timeout_add
521
logger.info("Starting checker %r for %s",
523
# We don't need to redirect stdout and stderr, since
524
# in normal mode, that is already done by daemon(),
525
# and in debug mode we don't want to. (Stdin is
526
# always replaced by /dev/null.)
527
self.checker = subprocess.Popen(command,
530
self.checker_callback_tag = (gobject.child_watch_add
532
self.checker_callback,
534
# The checker may have completed before the gobject
535
# watch was added. Check for this.
536
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
538
gobject.source_remove(self.checker_callback_tag)
539
self.checker_callback(pid, status, command)
540
except OSError as error:
541
logger.error("Failed to start subprocess: %s",
543
# Re-run this periodically if run by gobject.timeout_add
1098
546
def stop_checker(self):
1099
547
"""Force the checker process, if any, to stop."""
1100
548
if self.checker_callback_tag:
1101
GLib.source_remove(self.checker_callback_tag)
549
gobject.source_remove(self.checker_callback_tag)
1102
550
self.checker_callback_tag = None
1103
551
if getattr(self, "checker", None) is None:
1105
553
logger.debug("Stopping checker for %(name)s", vars(self))
1106
self.checker.terminate()
555
os.kill(self.checker.pid, signal.SIGTERM)
557
#if self.checker.poll() is None:
558
# os.kill(self.checker.pid, signal.SIGKILL)
559
except OSError as error:
560
if error.errno != errno.ESRCH: # No such process
1107
562
self.checker = None
1110
def dbus_service_property(dbus_interface,
564
def dbus_service_property(dbus_interface, signature="v",
565
access="readwrite", byte_arrays=False):
1114
566
"""Decorators for marking methods of a DBusObjectWithProperties to
1115
567
become properties on the D-Bus.
1117
569
The decorated method will be called with no arguments by "Get"
1118
570
and with one argument by "Set".
1120
572
The parameters, where they are supported, are the same as
1121
573
dbus.service.method, except there is only "signature", since the
1122
574
type from Get() and the type sent to Set() is the same.
1205
class DBusObjectWithAnnotations(dbus.service.Object):
1206
"""A D-Bus object with annotations.
1208
Classes inheriting from this can use the dbus_annotations
1209
decorator to add annotations to methods or signals.
1213
def _is_dbus_thing(thing):
1214
"""Returns a function testing if an attribute is a D-Bus thing
1216
If called like _is_dbus_thing("method") it returns a function
1217
suitable for use as predicate to inspect.getmembers().
1219
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1222
def _get_all_dbus_things(self, thing):
1223
"""Returns a generator of (name, attribute) pairs
1225
return ((getattr(athing.__get__(self), "_dbus_name", name),
1226
athing.__get__(self))
1227
for cls in self.__class__.__mro__
1229
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1231
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1233
path_keyword='object_path',
1234
connection_keyword='connection')
1235
def Introspect(self, object_path, connection):
1236
"""Overloading of standard D-Bus method.
1238
Inserts annotation tags on methods and signals.
1240
xmlstring = dbus.service.Object.Introspect(self, object_path,
1243
document = xml.dom.minidom.parseString(xmlstring)
1245
for if_tag in document.getElementsByTagName("interface"):
1246
# Add annotation tags
1247
for typ in ("method", "signal"):
1248
for tag in if_tag.getElementsByTagName(typ):
1250
for name, prop in (self.
1251
_get_all_dbus_things(typ)):
1252
if (name == tag.getAttribute("name")
1253
and prop._dbus_interface
1254
== if_tag.getAttribute("name")):
1255
annots.update(getattr(
1256
prop, "_dbus_annotations", {}))
1257
for name, value in annots.items():
1258
ann_tag = document.createElement(
1260
ann_tag.setAttribute("name", name)
1261
ann_tag.setAttribute("value", value)
1262
tag.appendChild(ann_tag)
1263
# Add interface annotation tags
1264
for annotation, value in dict(
1265
itertools.chain.from_iterable(
1266
annotations().items()
1267
for name, annotations
1268
in self._get_all_dbus_things("interface")
1269
if name == if_tag.getAttribute("name")
1271
ann_tag = document.createElement("annotation")
1272
ann_tag.setAttribute("name", annotation)
1273
ann_tag.setAttribute("value", value)
1274
if_tag.appendChild(ann_tag)
1275
# Fix argument name for the Introspect method itself
1276
if (if_tag.getAttribute("name")
1277
== dbus.INTROSPECTABLE_IFACE):
1278
for cn in if_tag.getElementsByTagName("method"):
1279
if cn.getAttribute("name") == "Introspect":
1280
for arg in cn.getElementsByTagName("arg"):
1281
if (arg.getAttribute("direction")
1283
arg.setAttribute("name",
1285
xmlstring = document.toxml("utf-8")
1287
except (AttributeError, xml.dom.DOMException,
1288
xml.parsers.expat.ExpatError) as error:
1289
logger.error("Failed to override Introspection method",
1294
class DBusObjectWithProperties(DBusObjectWithAnnotations):
613
class DBusObjectWithProperties(dbus.service.Object):
1295
614
"""A D-Bus object with properties.
1297
616
Classes inheriting from this can use the dbus_service_property
1298
617
decorator to expose methods as D-Bus properties. It exposes the
1299
618
standard Get(), Set(), and GetAll() methods on the D-Bus.
622
def _is_dbus_property(obj):
623
return getattr(obj, "_dbus_is_property", False)
625
def _get_all_dbus_properties(self):
626
"""Returns a generator of (name, attribute) pairs
628
return ((prop._dbus_name, prop)
630
inspect.getmembers(self, self._is_dbus_property))
1302
632
def _get_dbus_property(self, interface_name, property_name):
1303
633
"""Returns a bound method if one exists which is a D-Bus
1304
634
property with the specified name and interface.
1306
for cls in self.__class__.__mro__:
1307
for name, value in inspect.getmembers(
1308
cls, self._is_dbus_thing("property")):
1309
if (value._dbus_name == property_name
1310
and value._dbus_interface == interface_name):
1311
return value.__get__(self)
636
for name in (property_name,
637
property_name + "_dbus_property"):
638
prop = getattr(self, name, None)
640
or not self._is_dbus_property(prop)
641
or prop._dbus_name != property_name
642
or (interface_name and prop._dbus_interface
643
and interface_name != prop._dbus_interface)):
1313
646
# No such property
1314
raise DBusPropertyNotFound("{}:{}.{}".format(
1315
self.dbus_object_path, interface_name, property_name))
1318
def _get_all_interface_names(cls):
1319
"""Get a sequence of all interfaces supported by an object"""
1320
return (name for name in set(getattr(getattr(x, attr),
1321
"_dbus_interface", None)
1322
for x in (inspect.getmro(cls))
1324
if name is not None)
1326
@dbus.service.method(dbus.PROPERTIES_IFACE,
647
raise DBusPropertyNotFound(self.dbus_object_path + ":"
648
+ interface_name + "."
651
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1328
652
out_signature="v")
1329
653
def Get(self, interface_name, property_name):
1330
654
"""Standard D-Bus property Get() method, see D-Bus standard.
1455
746
except (AttributeError, xml.dom.DOMException,
1456
747
xml.parsers.expat.ExpatError) as error:
1457
748
logger.error("Failed to override Introspection method",
1462
dbus.OBJECT_MANAGER_IFACE
1463
except AttributeError:
1464
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1467
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1468
"""A D-Bus object with an ObjectManager.
1470
Classes inheriting from this exposes the standard
1471
GetManagedObjects call and the InterfacesAdded and
1472
InterfacesRemoved signals on the standard
1473
"org.freedesktop.DBus.ObjectManager" interface.
1475
Note: No signals are sent automatically; they must be sent
1478
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1479
out_signature="a{oa{sa{sv}}}")
1480
def GetManagedObjects(self):
1481
"""This function must be overridden"""
1482
raise NotImplementedError()
1484
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1485
signature="oa{sa{sv}}")
1486
def InterfacesAdded(self, object_path, interfaces_and_properties):
1489
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1490
def InterfacesRemoved(self, object_path, interfaces):
1493
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1495
path_keyword='object_path',
1496
connection_keyword='connection')
1497
def Introspect(self, object_path, connection):
1498
"""Overloading of standard D-Bus method.
1500
Override return argument name of GetManagedObjects to be
1501
"objpath_interfaces_and_properties"
1503
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1507
document = xml.dom.minidom.parseString(xmlstring)
1509
for if_tag in document.getElementsByTagName("interface"):
1510
# Fix argument name for the GetManagedObjects method
1511
if (if_tag.getAttribute("name")
1512
== dbus.OBJECT_MANAGER_IFACE):
1513
for cn in if_tag.getElementsByTagName("method"):
1514
if (cn.getAttribute("name")
1515
== "GetManagedObjects"):
1516
for arg in cn.getElementsByTagName("arg"):
1517
if (arg.getAttribute("direction")
1521
"objpath_interfaces"
1523
xmlstring = document.toxml("utf-8")
1525
except (AttributeError, xml.dom.DOMException,
1526
xml.parsers.expat.ExpatError) as error:
1527
logger.error("Failed to override Introspection method",
1532
def datetime_to_dbus(dt, variant_level=0):
753
def datetime_to_dbus (dt, variant_level=0):
1533
754
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1535
return dbus.String("", variant_level=variant_level)
1536
return dbus.String(dt.isoformat(), variant_level=variant_level)
1539
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1540
"""A class decorator; applied to a subclass of
1541
dbus.service.Object, it will add alternate D-Bus attributes with
1542
interface names according to the "alt_interface_names" mapping.
1545
@alternate_dbus_interfaces({"org.example.Interface":
1546
"net.example.AlternateInterface"})
1547
class SampleDBusObject(dbus.service.Object):
1548
@dbus.service.method("org.example.Interface")
1549
def SampleDBusMethod():
1552
The above "SampleDBusMethod" on "SampleDBusObject" will be
1553
reachable via two interfaces: "org.example.Interface" and
1554
"net.example.AlternateInterface", the latter of which will have
1555
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1556
"true", unless "deprecate" is passed with a False value.
1558
This works for methods and signals, and also for D-Bus properties
1559
(from DBusObjectWithProperties) and interfaces (from the
1560
dbus_interface_annotations decorator).
1564
for orig_interface_name, alt_interface_name in (
1565
alt_interface_names.items()):
1567
interface_names = set()
1568
# Go though all attributes of the class
1569
for attrname, attribute in inspect.getmembers(cls):
1570
# Ignore non-D-Bus attributes, and D-Bus attributes
1571
# with the wrong interface name
1572
if (not hasattr(attribute, "_dbus_interface")
1573
or not attribute._dbus_interface.startswith(
1574
orig_interface_name)):
1576
# Create an alternate D-Bus interface name based on
1578
alt_interface = attribute._dbus_interface.replace(
1579
orig_interface_name, alt_interface_name)
1580
interface_names.add(alt_interface)
1581
# Is this a D-Bus signal?
1582
if getattr(attribute, "_dbus_is_signal", False):
1583
# Extract the original non-method undecorated
1584
# function by black magic
1585
if sys.version_info.major == 2:
1586
nonmethod_func = (dict(
1587
zip(attribute.func_code.co_freevars,
1588
attribute.__closure__))
1589
["func"].cell_contents)
1591
nonmethod_func = (dict(
1592
zip(attribute.__code__.co_freevars,
1593
attribute.__closure__))
1594
["func"].cell_contents)
1595
# Create a new, but exactly alike, function
1596
# object, and decorate it to be a new D-Bus signal
1597
# with the alternate D-Bus interface name
1598
new_function = copy_function(nonmethod_func)
1599
new_function = (dbus.service.signal(
1601
attribute._dbus_signature)(new_function))
1602
# Copy annotations, if any
1604
new_function._dbus_annotations = dict(
1605
attribute._dbus_annotations)
1606
except AttributeError:
1609
# Define a creator of a function to call both the
1610
# original and alternate functions, so both the
1611
# original and alternate signals gets sent when
1612
# the function is called
1613
def fixscope(func1, func2):
1614
"""This function is a scope container to pass
1615
func1 and func2 to the "call_both" function
1616
outside of its arguments"""
1618
@functools.wraps(func2)
1619
def call_both(*args, **kwargs):
1620
"""This function will emit two D-Bus
1621
signals by calling func1 and func2"""
1622
func1(*args, **kwargs)
1623
func2(*args, **kwargs)
1624
# Make wrapper function look like a D-Bus
1626
for name, attr in inspect.getmembers(func2):
1627
if name.startswith("_dbus_"):
1628
setattr(call_both, name, attr)
1631
# Create the "call_both" function and add it to
1633
attr[attrname] = fixscope(attribute, new_function)
1634
# Is this a D-Bus method?
1635
elif getattr(attribute, "_dbus_is_method", False):
1636
# Create a new, but exactly alike, function
1637
# object. Decorate it to be a new D-Bus method
1638
# with the alternate D-Bus interface name. Add it
1641
dbus.service.method(
1643
attribute._dbus_in_signature,
1644
attribute._dbus_out_signature)
1645
(copy_function(attribute)))
1646
# Copy annotations, if any
1648
attr[attrname]._dbus_annotations = dict(
1649
attribute._dbus_annotations)
1650
except AttributeError:
1652
# Is this a D-Bus property?
1653
elif getattr(attribute, "_dbus_is_property", False):
1654
# Create a new, but exactly alike, function
1655
# object, and decorate it to be a new D-Bus
1656
# property with the alternate D-Bus interface
1657
# name. Add it to the class.
1658
attr[attrname] = (dbus_service_property(
1659
alt_interface, attribute._dbus_signature,
1660
attribute._dbus_access,
1661
attribute._dbus_get_args_options
1663
(copy_function(attribute)))
1664
# Copy annotations, if any
1666
attr[attrname]._dbus_annotations = dict(
1667
attribute._dbus_annotations)
1668
except AttributeError:
1670
# Is this a D-Bus interface?
1671
elif getattr(attribute, "_dbus_is_interface", False):
1672
# Create a new, but exactly alike, function
1673
# object. Decorate it to be a new D-Bus interface
1674
# with the alternate D-Bus interface name. Add it
1677
dbus_interface_annotations(alt_interface)
1678
(copy_function(attribute)))
1680
# Deprecate all alternate interfaces
1681
iname = "_AlternateDBusNames_interface_annotation{}"
1682
for interface_name in interface_names:
1684
@dbus_interface_annotations(interface_name)
1686
return {"org.freedesktop.DBus.Deprecated":
1688
# Find an unused name
1689
for aname in (iname.format(i)
1690
for i in itertools.count()):
1691
if aname not in attr:
1695
# Replace the class with a new subclass of it with
1696
# methods, signals, etc. as created above.
1697
if sys.version_info.major == 2:
1698
cls = type(b"{}Alternate".format(cls.__name__),
1701
cls = type("{}Alternate".format(cls.__name__),
1708
@alternate_dbus_interfaces({"se.recompile.Mandos":
1709
"se.bsnet.fukt.Mandos"})
756
return dbus.String("", variant_level = variant_level)
757
return dbus.String(dt.isoformat(),
758
variant_level=variant_level)
1710
760
class ClientDBus(Client, DBusObjectWithProperties):
1711
761
"""A Client class using D-Bus
1714
764
dbus_object_path: dbus.ObjectPath
1715
765
bus: dbus.SystemBus()
1718
768
runtime_expansions = (Client.runtime_expansions
1719
+ ("dbus_object_path", ))
1721
_interface = "se.recompile.Mandos.Client"
769
+ ("dbus_object_path",))
1723
771
# dbus.service.Object doesn't use super(), so we can't either.
1725
def __init__(self, bus=None, *args, **kwargs):
773
def __init__(self, bus = None, *args, **kwargs):
774
self._approvals_pending = 0
1727
776
Client.__init__(self, *args, **kwargs)
1728
777
# Only now, when this client is initialized, can it show up on
1730
client_object_name = str(self.name).translate(
779
client_object_name = unicode(self.name).translate(
1731
780
{ord("."): ord("_"),
1732
781
ord("-"): ord("_")})
1733
self.dbus_object_path = dbus.ObjectPath(
1734
"/clients/" + client_object_name)
782
self.dbus_object_path = (dbus.ObjectPath
783
("/clients/" + client_object_name))
1735
784
DBusObjectWithProperties.__init__(self, self.bus,
1736
785
self.dbus_object_path)
1738
def notifychangeproperty(transform_func, dbus_name,
1739
type_func=lambda x: x,
1741
invalidate_only=False,
1742
_interface=_interface):
1743
""" Modify a variable so that it's a property which announces
1744
its changes to DBus.
1746
transform_fun: Function that takes a value and a variant_level
1747
and transforms it to a D-Bus type.
1748
dbus_name: D-Bus name of the variable
787
def notifychangeproperty(transform_func,
788
dbus_name, type_func=lambda x: x,
790
""" Modify a variable so that its a property that announce its
792
transform_fun: Function that takes a value and transform it to
794
dbus_name: DBus name of the variable
1749
795
type_func: Function that transform the value before sending it
1750
to the D-Bus. Default: no transform
1751
variant_level: D-Bus variant level. Default: 1
797
variant_level: DBus variant level. default: 1
1753
attrname = "_{}".format(dbus_name)
1755
800
def setter(self, value):
801
old_value = real_value[0]
802
real_value[0] = value
1756
803
if hasattr(self, "dbus_object_path"):
1757
if (not hasattr(self, attrname) or
1758
type_func(getattr(self, attrname, None))
1759
!= type_func(value)):
1761
self.PropertiesChanged(
1762
_interface, dbus.Dictionary(),
1763
dbus.Array((dbus_name, )))
1765
dbus_value = transform_func(
1767
variant_level=variant_level)
1768
self.PropertyChanged(dbus.String(dbus_name),
1770
self.PropertiesChanged(
1772
dbus.Dictionary({dbus.String(dbus_name):
1775
setattr(self, attrname, value)
1777
return property(lambda self: getattr(self, attrname), setter)
804
if type_func(old_value) != type_func(real_value[0]):
805
dbus_value = transform_func(type_func(real_value[0]),
807
self.PropertyChanged(dbus.String(dbus_name),
810
return property(lambda self: real_value[0], setter)
1779
813
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1780
814
approvals_pending = notifychangeproperty(dbus.Boolean,
1781
815
"ApprovalPending",
1783
817
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1784
818
last_enabled = notifychangeproperty(datetime_to_dbus,
1786
checker = notifychangeproperty(
1787
dbus.Boolean, "CheckerRunning",
1788
type_func=lambda checker: checker is not None)
820
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
821
type_func = lambda checker: checker is not None)
1789
822
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1790
823
"LastCheckedOK")
1791
last_checker_status = notifychangeproperty(dbus.Int16,
1792
"LastCheckerStatus")
1793
last_approval_request = notifychangeproperty(
1794
datetime_to_dbus, "LastApprovalRequest")
824
last_approval_request = notifychangeproperty(datetime_to_dbus,
825
"LastApprovalRequest")
1795
826
approved_by_default = notifychangeproperty(dbus.Boolean,
1796
827
"ApprovedByDefault")
1797
approval_delay = notifychangeproperty(
1798
dbus.UInt64, "ApprovalDelay",
1799
type_func=lambda td: td.total_seconds() * 1000)
1800
approval_duration = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDuration",
1802
type_func=lambda td: td.total_seconds() * 1000)
828
approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",
829
type_func = _timedelta_to_milliseconds)
830
approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",
831
type_func = _timedelta_to_milliseconds)
1803
832
host = notifychangeproperty(dbus.String, "Host")
1804
timeout = notifychangeproperty(
1805
dbus.UInt64, "Timeout",
1806
type_func=lambda td: td.total_seconds() * 1000)
1807
extended_timeout = notifychangeproperty(
1808
dbus.UInt64, "ExtendedTimeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
1810
interval = notifychangeproperty(
1811
dbus.UInt64, "Interval",
1812
type_func=lambda td: td.total_seconds() * 1000)
833
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
834
type_func = _timedelta_to_milliseconds)
835
extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",
836
type_func = _timedelta_to_milliseconds)
837
interval = notifychangeproperty(dbus.UInt16, "Interval",
838
type_func = _timedelta_to_milliseconds)
1813
839
checker_command = notifychangeproperty(dbus.String, "Checker")
1814
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1815
invalidate_only=True)
1817
841
del notifychangeproperty
1819
843
def __del__(self, *args, **kwargs):
1821
845
self.remove_from_connection()
2301
1301
delay -= time2 - time
2304
session.send(client.secret)
2305
except gnutls.Error as error:
2306
logger.warning("gnutls send failed",
1304
while sent_size < len(client.secret):
1306
sent = session.send(client.secret[sent_size:])
1307
except gnutls.errors.GNUTLSError as error:
1308
logger.warning("gnutls send failed")
1310
logger.debug("Sent: %d, remaining: %d",
1311
sent, len(client.secret)
1312
- (sent_size + sent))
2310
1315
logger.info("Sending secret to %s", client.name)
2311
# bump the timeout using extended_timeout
2312
client.bump_timeout(client.extended_timeout)
1316
# bump the timeout as if seen
1317
client.checked_ok(client.extended_timeout)
2313
1318
if self.server.use_dbus:
2314
1319
# Emit D-Bus signal
2315
1320
client.GotSecret()
2318
1323
if approval_required:
2319
1324
client.approvals_pending -= 1
2322
except gnutls.Error as error:
2323
logger.warning("GnuTLS bye failed",
1327
except gnutls.errors.GNUTLSError as error:
1328
logger.warning("GnuTLS bye failed")
2327
1331
def peer_certificate(session):
2328
1332
"Return the peer's OpenPGP certificate as a bytestring"
2329
1333
# If not an OpenPGP certificate...
2330
if (gnutls.certificate_type_get(session._c_object)
2331
!= gnutls.CRT_OPENPGP):
2332
# ...return invalid data
1334
if (gnutls.library.functions
1335
.gnutls_certificate_type_get(session._c_object)
1336
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1337
# ...do the normal thing
1338
return session.peer_certificate
2334
1339
list_size = ctypes.c_uint(1)
2335
cert_list = (gnutls.certificate_get_peers
1340
cert_list = (gnutls.library.functions
1341
.gnutls_certificate_get_peers
2336
1342
(session._c_object, ctypes.byref(list_size)))
2337
1343
if not bool(cert_list) and list_size.value != 0:
2338
raise gnutls.Error("error getting peer certificate")
1344
raise gnutls.errors.GNUTLSError("error getting peer"
2339
1346
if list_size.value == 0:
2341
1348
cert = cert_list[0]
2342
1349
return ctypes.string_at(cert.data, cert.size)
2345
1352
def fingerprint(openpgp):
2346
1353
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2347
1354
# New GnuTLS "datum" with the OpenPGP public key
2348
datum = gnutls.datum_t(
2349
ctypes.cast(ctypes.c_char_p(openpgp),
2350
ctypes.POINTER(ctypes.c_ubyte)),
2351
ctypes.c_uint(len(openpgp)))
1355
datum = (gnutls.library.types
1356
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1359
ctypes.c_uint(len(openpgp))))
2352
1360
# New empty GnuTLS certificate
2353
crt = gnutls.openpgp_crt_t()
2354
gnutls.openpgp_crt_init(ctypes.byref(crt))
1361
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1362
(gnutls.library.functions
1363
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2355
1364
# Import the OpenPGP public key into the certificate
2356
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2357
gnutls.OPENPGP_FMT_RAW)
1365
(gnutls.library.functions
1366
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1367
gnutls.library.constants
1368
.GNUTLS_OPENPGP_FMT_RAW))
2358
1369
# Verify the self signature in the key
2359
1370
crtverify = ctypes.c_uint()
2360
gnutls.openpgp_crt_verify_self(crt, 0,
2361
ctypes.byref(crtverify))
1371
(gnutls.library.functions
1372
.gnutls_openpgp_crt_verify_self(crt, 0,
1373
ctypes.byref(crtverify)))
2362
1374
if crtverify.value != 0:
2363
gnutls.openpgp_crt_deinit(crt)
2364
raise gnutls.CertificateSecurityError("Verify failed")
1375
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1376
raise (gnutls.errors.CertificateSecurityError
2365
1378
# New buffer for the fingerprint
2366
1379
buf = ctypes.create_string_buffer(20)
2367
1380
buf_len = ctypes.c_size_t()
2368
1381
# Get the fingerprint from the certificate into the buffer
2369
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2370
ctypes.byref(buf_len))
1382
(gnutls.library.functions
1383
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1384
ctypes.byref(buf_len)))
2371
1385
# Deinit the certificate
2372
gnutls.openpgp_crt_deinit(crt)
1386
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2373
1387
# Convert the buffer to a Python bytestring
2374
1388
fpr = ctypes.string_at(buf, buf_len.value)
2375
1389
# Convert the bytestring to hexadecimal notation
2376
hex_fpr = binascii.hexlify(fpr).upper()
1390
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2380
1394
class MultiprocessingMixIn(object):
2381
1395
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2383
1396
def sub_process_main(self, request, address):
2385
1398
self.finish_request(request, address)
2387
1400
self.handle_error(request, address)
2388
1401
self.close_request(request)
2390
1403
def process_request(self, request, address):
2391
1404
"""Start a new process to process the request."""
2392
proc = multiprocessing.Process(target=self.sub_process_main,
2393
args=(request, address))
1405
multiprocessing.Process(target = self.sub_process_main,
1406
args = (request, address)).start()
2398
1408
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2399
1409
""" adds a pipe to the MixIn """
2401
1410
def process_request(self, request, client_address):
2402
1411
"""Overrides and wraps the original process_request().
2404
1413
This function creates a new pipe in self.pipe
2406
1415
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2408
proc = MultiprocessingMixIn.process_request(self, request,
1417
super(MultiprocessingMixInWithPipe,
1418
self).process_request(request, client_address)
2410
1419
self.child_pipe.close()
2411
self.add_pipe(parent_pipe, proc)
1420
self.add_pipe(parent_pipe)
2413
def add_pipe(self, parent_pipe, proc):
1422
def add_pipe(self, parent_pipe):
2414
1423
"""Dummy function; override as necessary"""
2415
raise NotImplementedError()
1424
raise NotImplementedError
2418
1426
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2419
1427
socketserver.TCPServer, object):
2420
1428
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2423
1431
enabled: Boolean; whether this server is activated yet
2424
1432
interface: None or a network interface name (string)
2425
1433
use_ipv6: Boolean; to use IPv6 or not
2428
1435
def __init__(self, server_address, RequestHandlerClass,
2432
"""If socketfd is set, use that file descriptor instead of
2433
creating a new one with socket.socket().
1436
interface=None, use_ipv6=True):
2435
1437
self.interface = interface
2437
1439
self.address_family = socket.AF_INET6
2438
if socketfd is not None:
2439
# Save the file descriptor
2440
self.socketfd = socketfd
2441
# Save the original socket.socket() function
2442
self.socket_socket = socket.socket
2444
# To implement --socket, we monkey patch socket.socket.
2446
# (When socketserver.TCPServer is a new-style class, we
2447
# could make self.socket into a property instead of monkey
2448
# patching socket.socket.)
2450
# Create a one-time-only replacement for socket.socket()
2451
@functools.wraps(socket.socket)
2452
def socket_wrapper(*args, **kwargs):
2453
# Restore original function so subsequent calls are
2455
socket.socket = self.socket_socket
2456
del self.socket_socket
2457
# This time only, return a new socket object from the
2458
# saved file descriptor.
2459
return socket.fromfd(self.socketfd, *args, **kwargs)
2460
# Replace socket.socket() function with wrapper
2461
socket.socket = socket_wrapper
2462
# The socketserver.TCPServer.__init__ will call
2463
# socket.socket(), which might be our replacement,
2464
# socket_wrapper(), if socketfd was set.
2465
1440
socketserver.TCPServer.__init__(self, server_address,
2466
1441
RequestHandlerClass)
2468
1442
def server_bind(self):
2469
1443
"""This overrides the normal server_bind() function
2470
1444
to bind to an interface if one was specified, and also NOT to
2471
1445
bind to an address or port if they were not specified."""
2472
global SO_BINDTODEVICE
2473
1446
if self.interface is not None:
2474
1447
if SO_BINDTODEVICE is None:
2475
# Fall back to a hard-coded value which seems to be
2477
logger.warning("SO_BINDTODEVICE not found, trying 25")
2478
SO_BINDTODEVICE = 25
2480
self.socket.setsockopt(
2481
socket.SOL_SOCKET, SO_BINDTODEVICE,
2482
(self.interface + "\0").encode("utf-8"))
2483
except socket.error as error:
2484
if error.errno == errno.EPERM:
2485
logger.error("No permission to bind to"
2486
" interface %s", self.interface)
2487
elif error.errno == errno.ENOPROTOOPT:
2488
logger.error("SO_BINDTODEVICE not available;"
2489
" cannot bind to interface %s",
2491
elif error.errno == errno.ENODEV:
2492
logger.error("Interface %s does not exist,"
2493
" cannot bind", self.interface)
1448
logger.error("SO_BINDTODEVICE does not exist;"
1449
" cannot bind to interface %s",
1453
self.socket.setsockopt(socket.SOL_SOCKET,
1457
except socket.error as error:
1458
if error[0] == errno.EPERM:
1459
logger.error("No permission to"
1460
" bind to interface %s",
1462
elif error[0] == errno.ENOPROTOOPT:
1463
logger.error("SO_BINDTODEVICE not available;"
1464
" cannot bind to interface %s",
2496
1468
# Only bind(2) the socket if we really need to.
2497
1469
if self.server_address[0] or self.server_address[1]:
2498
1470
if not self.server_address[0]:
2499
1471
if self.address_family == socket.AF_INET6:
2500
any_address = "::" # in6addr_any
1472
any_address = "::" # in6addr_any
2502
any_address = "0.0.0.0" # INADDR_ANY
1474
any_address = socket.INADDR_ANY
2503
1475
self.server_address = (any_address,
2504
1476
self.server_address[1])
2505
1477
elif not self.server_address[1]:
2506
self.server_address = (self.server_address[0], 0)
1478
self.server_address = (self.server_address[0],
2507
1480
# if self.interface:
2508
1481
# self.server_address = (self.server_address[0],
2830
1713
parser.add_argument("--no-dbus", action="store_false",
2831
1714
dest="use_dbus", help="Do not provide D-Bus"
2832
" system bus interface", default=None)
1715
" system bus interface")
2833
1716
parser.add_argument("--no-ipv6", action="store_false",
2834
dest="use_ipv6", help="Do not use IPv6",
2836
parser.add_argument("--no-restore", action="store_false",
2837
dest="restore", help="Do not restore stored"
2838
" state", default=None)
2839
parser.add_argument("--socket", type=int,
2840
help="Specify a file descriptor to a network"
2841
" socket to use instead of creating one")
2842
parser.add_argument("--statedir", metavar="DIR",
2843
help="Directory to save/restore state in")
2844
parser.add_argument("--foreground", action="store_true",
2845
help="Run in foreground", default=None)
2846
parser.add_argument("--no-zeroconf", action="store_false",
2847
dest="zeroconf", help="Do not use Zeroconf",
1717
dest="use_ipv6", help="Do not use IPv6")
2850
1718
options = parser.parse_args()
2852
1720
if options.check:
2854
fail_count, test_count = doctest.testmod()
2855
sys.exit(os.EX_OK if fail_count == 0 else 1)
2857
1725
# Default values for config file for server-global settings
2858
server_defaults = {"interface": "",
2863
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2864
":+SIGN-DSA-SHA256",
2865
"servicename": "Mandos",
2871
"statedir": "/var/lib/mandos",
2872
"foreground": "False",
1726
server_defaults = { "interface": "",
1731
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1732
"servicename": "Mandos",
2876
1738
# Parse config file for server-global settings
2877
1739
server_config = configparser.SafeConfigParser(server_defaults)
2878
1740
del server_defaults
2879
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1741
server_config.read(os.path.join(options.configdir,
2880
1743
# Convert the SafeConfigParser object to a dict
2881
1744
server_settings = server_config.defaults()
2882
1745
# Use the appropriate methods on the non-string config options
2883
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1746
for option in ("debug", "use_dbus", "use_ipv6"):
2884
1747
server_settings[option] = server_config.getboolean("DEFAULT",
2886
1749
if server_settings["port"]:
2887
1750
server_settings["port"] = server_config.getint("DEFAULT",
2889
if server_settings["socket"]:
2890
server_settings["socket"] = server_config.getint("DEFAULT",
2892
# Later, stdin will, and stdout and stderr might, be dup'ed
2893
# over with an opened os.devnull. But we don't want this to
2894
# happen with a supplied network socket.
2895
if 0 <= server_settings["socket"] <= 2:
2896
server_settings["socket"] = os.dup(server_settings
2898
1752
del server_config
2900
1754
# Override the settings from the config file with command line
2901
1755
# options, if set.
2902
1756
for option in ("interface", "address", "port", "debug",
2903
"priority", "servicename", "configdir", "use_dbus",
2904
"use_ipv6", "debuglevel", "restore", "statedir",
2905
"socket", "foreground", "zeroconf"):
1757
"priority", "servicename", "configdir",
1758
"use_dbus", "use_ipv6", "debuglevel"):
2906
1759
value = getattr(options, option)
2907
1760
if value is not None:
2908
1761
server_settings[option] = value
2910
1763
# Force all strings to be unicode
2911
1764
for option in server_settings.keys():
2912
if isinstance(server_settings[option], bytes):
2913
server_settings[option] = (server_settings[option]
2915
# Force all boolean options to be boolean
2916
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2917
"foreground", "zeroconf"):
2918
server_settings[option] = bool(server_settings[option])
2919
# Debug implies foreground
2920
if server_settings["debug"]:
2921
server_settings["foreground"] = True
1765
if type(server_settings[option]) is str:
1766
server_settings[option] = unicode(server_settings[option])
2922
1767
# Now we have our good server settings in "server_settings"
2924
1769
##################################################################
2926
if (not server_settings["zeroconf"]
2927
and not (server_settings["port"]
2928
or server_settings["socket"] != "")):
2929
parser.error("Needs port or socket to work without Zeroconf")
2931
1771
# For convenience
2932
1772
debug = server_settings["debug"]
2933
1773
debuglevel = server_settings["debuglevel"]
2934
1774
use_dbus = server_settings["use_dbus"]
2935
1775
use_ipv6 = server_settings["use_ipv6"]
2936
stored_state_path = os.path.join(server_settings["statedir"],
2938
foreground = server_settings["foreground"]
2939
zeroconf = server_settings["zeroconf"]
2942
initlogger(debug, logging.DEBUG)
2947
level = getattr(logging, debuglevel.upper())
2948
initlogger(debug, level)
2950
1777
if server_settings["servicename"] != "Mandos":
2951
syslogger.setFormatter(
2952
logging.Formatter('Mandos ({}) [%(process)d]:'
2953
' %(levelname)s: %(message)s'.format(
2954
server_settings["servicename"])))
1778
syslogger.setFormatter(logging.Formatter
1779
('Mandos (%s) [%%(process)d]:'
1780
' %%(levelname)s: %%(message)s'
1781
% server_settings["servicename"]))
2956
1783
# Parse config file with clients
2957
client_config = configparser.SafeConfigParser(Client
1784
client_defaults = { "timeout": "5m",
1785
"extended_timeout": "15m",
1787
"checker": "fping -q -- %%(host)s",
1789
"approval_delay": "0s",
1790
"approval_duration": "1s",
1792
client_config = configparser.SafeConfigParser(client_defaults)
2959
1793
client_config.read(os.path.join(server_settings["configdir"],
2960
1794
"clients.conf"))
2962
1796
global mandos_dbus_service
2963
1797
mandos_dbus_service = None
2966
if server_settings["socket"] != "":
2967
socketfd = server_settings["socket"]
2968
tcp_server = MandosServer(
2969
(server_settings["address"], server_settings["port"]),
2971
interface=(server_settings["interface"] or None),
2973
gnutls_priority=server_settings["priority"],
2977
pidfilename = "/run/mandos.pid"
2978
if not os.path.isdir("/run/."):
2979
pidfilename = "/var/run/mandos.pid"
2982
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2983
except IOError as e:
2984
logger.error("Could not open file %r", pidfilename,
2987
for name, group in (("_mandos", "_mandos"),
2988
("mandos", "mandos"),
2989
("nobody", "nogroup")):
2991
uid = pwd.getpwnam(name).pw_uid
2992
gid = pwd.getpwnam(group).pw_gid
1799
tcp_server = MandosServer((server_settings["address"],
1800
server_settings["port"]),
1802
interface=(server_settings["interface"]
1806
server_settings["priority"],
1809
pidfilename = "/var/run/mandos.pid"
1811
pidfile = open(pidfilename, "w")
1813
logger.error("Could not open file %r", pidfilename)
1816
uid = pwd.getpwnam("_mandos").pw_uid
1817
gid = pwd.getpwnam("_mandos").pw_gid
1820
uid = pwd.getpwnam("mandos").pw_uid
1821
gid = pwd.getpwnam("mandos").pw_gid
2994
1822
except KeyError:
1824
uid = pwd.getpwnam("nobody").pw_uid
1825
gid = pwd.getpwnam("nobody").pw_gid
3003
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3005
1832
except OSError as error:
3006
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3007
.format(uid, gid, os.strerror(error.errno)))
3008
if error.errno != errno.EPERM:
1833
if error[0] != errno.EPERM:
1836
if not debug and not debuglevel:
1837
syslogger.setLevel(logging.WARNING)
1838
console.setLevel(logging.WARNING)
1840
level = getattr(logging, debuglevel.upper())
1841
syslogger.setLevel(level)
1842
console.setLevel(level)
3012
1845
# Enable all possible GnuTLS debugging
3014
1847
# "Use a log level over 10 to enable all debugging options."
3015
1848
# - GnuTLS manual
3016
gnutls.global_set_log_level(11)
1849
gnutls.library.functions.gnutls_global_set_log_level(11)
1851
@gnutls.library.types.gnutls_log_func
3019
1852
def debug_gnutls(level, string):
3020
1853
logger.debug("GnuTLS: %s", string[:-1])
3022
gnutls.global_set_log_function(debug_gnutls)
1855
(gnutls.library.functions
1856
.gnutls_global_set_log_function(debug_gnutls))
3024
1858
# Redirect stdin so all checkers get /dev/null
3025
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1859
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3026
1860
os.dup2(null, sys.stdin.fileno())
1864
# No console logging
1865
logger.removeHandler(console)
3030
1867
# Need to fork before connecting to D-Bus
3032
1869
# Close all input and output, do double fork, etc.
3035
# multiprocessing will use threads, so before we use GLib we need
3036
# to inform GLib that threads will be used.
3039
1872
global main_loop
3040
1873
# From the Avahi example code
3041
DBusGMainLoop(set_as_default=True)
3042
main_loop = GLib.MainLoop()
1874
DBusGMainLoop(set_as_default=True )
1875
main_loop = gobject.MainLoop()
3043
1876
bus = dbus.SystemBus()
3044
1877
# End of Avahi example code
3047
bus_name = dbus.service.BusName("se.recompile.Mandos",
3050
old_bus_name = dbus.service.BusName(
3051
"se.bsnet.fukt.Mandos", bus,
3053
except dbus.exceptions.DBusException as e:
3054
logger.error("Disabling D-Bus:", exc_info=e)
1880
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1881
bus, do_not_queue=True)
1882
except dbus.exceptions.NameExistsException as e:
1883
logger.error(unicode(e) + ", disabling D-Bus")
3055
1884
use_dbus = False
3056
1885
server_settings["use_dbus"] = False
3057
1886
tcp_server.use_dbus = False
3059
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3060
service = AvahiServiceToSyslog(
3061
name=server_settings["servicename"],
3062
servicetype="_mandos._tcp",
3065
if server_settings["interface"]:
3066
service.interface = if_nametoindex(
3067
server_settings["interface"].encode("utf-8"))
1887
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1888
service = AvahiService(name = server_settings["servicename"],
1889
servicetype = "_mandos._tcp",
1890
protocol = protocol, bus = bus)
1891
if server_settings["interface"]:
1892
service.interface = (if_nametoindex
1893
(str(server_settings["interface"])))
3069
1895
global multiprocessing_manager
3070
1896
multiprocessing_manager = multiprocessing.Manager()
3072
1898
client_class = Client
3074
client_class = functools.partial(ClientDBus, bus=bus)
3076
client_settings = Client.config_parser(client_config)
3077
old_client_settings = {}
3080
# This is used to redirect stdout and stderr for checker processes
3082
wnull = open(os.devnull, "w") # A writable /dev/null
3083
# Only used if server is running in foreground but not in debug
3085
if debug or not foreground:
3088
# Get client data and settings from last running state.
3089
if server_settings["restore"]:
3091
with open(stored_state_path, "rb") as stored_state:
3092
if sys.version_info.major == 2:
3093
clients_data, old_client_settings = pickle.load(
3096
bytes_clients_data, bytes_old_client_settings = (
3097
pickle.load(stored_state, encoding="bytes"))
3098
# Fix bytes to strings
3101
clients_data = {(key.decode("utf-8")
3102
if isinstance(key, bytes)
3105
bytes_clients_data.items()}
3106
del bytes_clients_data
3107
for key in clients_data:
3108
value = {(k.decode("utf-8")
3109
if isinstance(k, bytes) else k): v
3111
clients_data[key].items()}
3112
clients_data[key] = value
3114
value["client_structure"] = [
3116
if isinstance(s, bytes)
3118
value["client_structure"]]
3120
for k in ("name", "host"):
3121
if isinstance(value[k], bytes):
3122
value[k] = value[k].decode("utf-8")
3123
# old_client_settings
3125
old_client_settings = {
3126
(key.decode("utf-8")
3127
if isinstance(key, bytes)
3130
bytes_old_client_settings.items()}
3131
del bytes_old_client_settings
3133
for value in old_client_settings.values():
3134
if isinstance(value["host"], bytes):
3135
value["host"] = (value["host"]
3137
os.remove(stored_state_path)
3138
except IOError as e:
3139
if e.errno == errno.ENOENT:
3140
logger.warning("Could not load persistent state:"
3141
" {}".format(os.strerror(e.errno)))
3143
logger.critical("Could not load persistent state:",
3146
except EOFError as e:
3147
logger.warning("Could not load persistent state: "
3151
with PGPEngine() as pgp:
3152
for client_name, client in clients_data.items():
3153
# Skip removed clients
3154
if client_name not in client_settings:
3157
# Decide which value to use after restoring saved state.
3158
# We have three different values: Old config file,
3159
# new config file, and saved state.
3160
# New config value takes precedence if it differs from old
3161
# config value, otherwise use saved state.
3162
for name, value in client_settings[client_name].items():
3164
# For each value in new config, check if it
3165
# differs from the old config value (Except for
3166
# the "secret" attribute)
3167
if (name != "secret"
3169
old_client_settings[client_name][name])):
3170
client[name] = value
3174
# Clients who has passed its expire date can still be
3175
# enabled if its last checker was successful. A Client
3176
# whose checker succeeded before we stored its state is
3177
# assumed to have successfully run all checkers during
3179
if client["enabled"]:
3180
if datetime.datetime.utcnow() >= client["expires"]:
3181
if not client["last_checked_ok"]:
3183
"disabling client {} - Client never "
3184
"performed a successful checker".format(
3186
client["enabled"] = False
3187
elif client["last_checker_status"] != 0:
3189
"disabling client {} - Client last"
3190
" checker failed with error code"
3193
client["last_checker_status"]))
3194
client["enabled"] = False
3196
client["expires"] = (
3197
datetime.datetime.utcnow()
3198
+ client["timeout"])
3199
logger.debug("Last checker succeeded,"
3200
" keeping {} enabled".format(
1900
client_class = functools.partial(ClientDBus, bus = bus)
1901
def client_config_items(config, section):
1902
special_settings = {
1903
"approved_by_default":
1904
lambda: config.getboolean(section,
1905
"approved_by_default"),
1907
for name, value in config.items(section):
3203
client["secret"] = pgp.decrypt(
3204
client["encrypted_secret"],
3205
client_settings[client_name]["secret"])
3207
# If decryption fails, we use secret from new settings
3208
logger.debug("Failed to decrypt {} old secret".format(
3210
client["secret"] = (client_settings[client_name]
3213
# Add/remove clients based on new changes made to config
3214
for client_name in (set(old_client_settings)
3215
- set(client_settings)):
3216
del clients_data[client_name]
3217
for client_name in (set(client_settings)
3218
- set(old_client_settings)):
3219
clients_data[client_name] = client_settings[client_name]
3221
# Create all client objects
3222
for client_name, client in clients_data.items():
3223
tcp_server.clients[client_name] = client_class(
3226
server_settings=server_settings)
1909
yield (name, special_settings[name]())
1913
tcp_server.clients.update(set(
1914
client_class(name = section,
1915
config= dict(client_config_items(
1916
client_config, section)))
1917
for section in client_config.sections()))
3228
1918
if not tcp_server.clients:
3229
1919
logger.warning("No clients defined")
3232
if pidfile is not None:
3236
print(pid, file=pidfile)
3238
logger.error("Could not write to file %r with PID %d",
1925
pidfile.write(str(pid) + "\n".encode("utf-8"))
1928
logger.error("Could not write to file %r with PID %d",
1931
# "pidfile" was never created
3241
1933
del pidfilename
3243
for termsig in (signal.SIGHUP, signal.SIGTERM):
3244
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3245
lambda: main_loop.quit() and False)
1935
signal.signal(signal.SIGINT, signal.SIG_IGN)
1937
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1938
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3249
@alternate_dbus_interfaces(
3250
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3251
class MandosDBusService(DBusObjectWithObjectManager):
1941
class MandosDBusService(dbus.service.Object):
3252
1942
"""A D-Bus proxy object"""
3254
1943
def __init__(self):
3255
1944
dbus.service.Object.__init__(self, bus, "/")
3257
_interface = "se.recompile.Mandos"
1945
_interface = "se.bsnet.fukt.Mandos"
3259
1947
@dbus.service.signal(_interface, signature="o")
3260
1948
def ClientAdded(self, objpath):
3264
1952
@dbus.service.signal(_interface, signature="ss")
3265
1953
def ClientNotFound(self, fingerprint, address):
3269
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3271
1957
@dbus.service.signal(_interface, signature="os")
3272
1958
def ClientRemoved(self, objpath, name):
3276
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3278
1962
@dbus.service.method(_interface, out_signature="ao")
3279
1963
def GetAllClients(self):
3281
return dbus.Array(c.dbus_object_path for c in
3282
tcp_server.clients.values())
3284
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1965
return dbus.Array(c.dbus_object_path
1966
for c in tcp_server.clients)
3286
1968
@dbus.service.method(_interface,
3287
1969
out_signature="a{oa{sv}}")
3288
1970
def GetAllClientsWithProperties(self):
3290
1972
return dbus.Dictionary(
3291
{c.dbus_object_path: c.GetAll(
3292
"se.recompile.Mandos.Client")
3293
for c in tcp_server.clients.values()},
1973
((c.dbus_object_path, c.GetAll(""))
1974
for c in tcp_server.clients),
3294
1975
signature="oa{sv}")
3296
1977
@dbus.service.method(_interface, in_signature="o")
3297
1978
def RemoveClient(self, object_path):
3299
for c in tcp_server.clients.values():
1980
for c in tcp_server.clients:
3300
1981
if c.dbus_object_path == object_path:
3301
del tcp_server.clients[c.name]
1982
tcp_server.clients.remove(c)
3302
1983
c.remove_from_connection()
3303
# Don't signal the disabling
1984
# Don't signal anything except ClientRemoved
3304
1985
c.disable(quiet=True)
3305
# Emit D-Bus signal for removal
3306
self.client_removed_signal(c)
1987
self.ClientRemoved(object_path, c.name)
3308
1989
raise KeyError(object_path)
3312
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3313
out_signature="a{oa{sa{sv}}}")
3314
def GetManagedObjects(self):
3316
return dbus.Dictionary(
3317
{client.dbus_object_path:
3319
{interface: client.GetAll(interface)
3321
client._get_all_interface_names()})
3322
for client in tcp_server.clients.values()})
3324
def client_added_signal(self, client):
3325
"""Send the new standard signal and the old signal"""
3327
# New standard signal
3328
self.InterfacesAdded(
3329
client.dbus_object_path,
3331
{interface: client.GetAll(interface)
3333
client._get_all_interface_names()}))
3335
self.ClientAdded(client.dbus_object_path)
3337
def client_removed_signal(self, client):
3338
"""Send the new standard signal and the old signal"""
3340
# New standard signal
3341
self.InterfacesRemoved(
3342
client.dbus_object_path,
3343
client._get_all_interface_names())
3345
self.ClientRemoved(client.dbus_object_path,
3348
1993
mandos_dbus_service = MandosDBusService()
3350
# Save modules to variables to exempt the modules from being
3351
# unloaded before the function registered with atexit() is run.
3352
mp = multiprocessing
3356
1996
"Cleanup function; run on exit"
3360
mp.active_children()
3362
if not (tcp_server.clients or client_settings):
3365
# Store client before exiting. Secrets are encrypted with key
3366
# based on what config file has. If config file is
3367
# removed/edited, old secret will thus be unrecovable.
3369
with PGPEngine() as pgp:
3370
for client in tcp_server.clients.values():
3371
key = client_settings[client.name]["secret"]
3372
client.encrypted_secret = pgp.encrypt(client.secret,
3376
# A list of attributes that can not be pickled
3378
exclude = {"bus", "changedstate", "secret",
3379
"checker", "server_settings"}
3380
for name, typ in inspect.getmembers(dbus.service
3384
client_dict["encrypted_secret"] = (client
3386
for attr in client.client_structure:
3387
if attr not in exclude:
3388
client_dict[attr] = getattr(client, attr)
3390
clients[client.name] = client_dict
3391
del client_settings[client.name]["secret"]
3394
with tempfile.NamedTemporaryFile(
3398
dir=os.path.dirname(stored_state_path),
3399
delete=False) as stored_state:
3400
pickle.dump((clients, client_settings), stored_state,
3402
tempname = stored_state.name
3403
os.rename(tempname, stored_state_path)
3404
except (IOError, OSError) as e:
3410
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3411
logger.warning("Could not save persistent state: {}"
3412
.format(os.strerror(e.errno)))
3414
logger.warning("Could not save persistent state:",
3418
# Delete all clients, and settings from config
3419
1999
while tcp_server.clients:
3420
name, client = tcp_server.clients.popitem()
2000
client = tcp_server.clients.pop()
3422
2002
client.remove_from_connection()
3423
# Don't signal the disabling
2003
client.disable_hook = None
2004
# Don't signal anything except ClientRemoved
3424
2005
client.disable(quiet=True)
3425
# Emit D-Bus signal for removal
3427
mandos_dbus_service.client_removed_signal(client)
3428
client_settings.clear()
2008
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3430
2011
atexit.register(cleanup)
3432
for client in tcp_server.clients.values():
2013
for client in tcp_server.clients:
3434
# Emit D-Bus signal for adding
3435
mandos_dbus_service.client_added_signal(client)
3436
# Need to initiate checking of clients
3438
client.init_checker()
2016
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3440
2019
tcp_server.enable()
3441
2020
tcp_server.server_activate()
3443
2022
# Find out what port we got
3445
service.port = tcp_server.socket.getsockname()[1]
2023
service.port = tcp_server.socket.getsockname()[1]
3447
2025
logger.info("Now listening on address %r, port %d,"
3448
" flowinfo %d, scope_id %d",
3449
*tcp_server.socket.getsockname())
2026
" flowinfo %d, scope_id %d"
2027
% tcp_server.socket.getsockname())
3451
logger.info("Now listening on address %r, port %d",
3452
*tcp_server.socket.getsockname())
3454
# service.interface = tcp_server.socket.getsockname()[3]
2029
logger.info("Now listening on address %r, port %d"
2030
% tcp_server.socket.getsockname())
2032
#service.interface = tcp_server.socket.getsockname()[3]
3458
# From the Avahi example code
3461
except dbus.exceptions.DBusException as error:
3462
logger.critical("D-Bus Exception", exc_info=error)
3465
# End of Avahi example code
3467
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3468
lambda *args, **kwargs:
3469
(tcp_server.handle_request
3470
(*args[2:], **kwargs) or True))
2035
# From the Avahi example code
2038
except dbus.exceptions.DBusException as error:
2039
logger.critical("DBusException: %s", error)
2042
# End of Avahi example code
2044
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2045
lambda *args, **kwargs:
2046
(tcp_server.handle_request
2047
(*args[2:], **kwargs) or True))
3472
2049
logger.debug("Starting main loop")
3473
2050
main_loop.run()
3474
2051
except AvahiError as error:
3475
logger.critical("Avahi Error", exc_info=error)
2052
logger.critical("AvahiError: %s", error)
3478
2055
except KeyboardInterrupt: