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"
83
SO_BINDTODEVICE = None
120
88
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
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('%(asctime)s %(name)s'
102
logger.addHandler(console)
303
105
class AvahiError(Exception):
304
106
def __init__(self, value, *args, **kwargs):
305
107
self.value = value
306
return super(AvahiError, self).__init__(value, *args,
108
super(AvahiError, self).__init__(value, *args, **kwargs)
109
def __unicode__(self):
110
return unicode(repr(self.value))
310
112
class AvahiServiceError(AvahiError):
314
115
class AvahiGroupError(AvahiError):
318
119
class AvahiService(object):
319
120
"""An Avahi (Zeroconf) service.
322
123
interface: integer; avahi.IF_UNSPEC or an interface index.
323
124
Used to optionally bind to the specified interface.
324
125
name: string; Example: 'Mandos'
325
126
type: string; Example: '_mandos._tcp'.
326
See <https://www.iana.org/assignments/service-names-port-numbers>
127
See <http://www.dns-sd.org/ServiceTypes.html>
327
128
port: integer; what port to announce
328
129
TXT: list of strings; TXT record for the service
329
130
domain: string; Domain to publish on, default to .local if empty.
488
259
follow_name_owner_changes=True),
489
260
avahi.DBUS_INTERFACE_SERVER)
490
261
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
262
self.server_state_changed)
492
263
self.server_state_changed(self.server.GetState())
495
265
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
267
"""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'
268
ret = AvahiService.rename(self)
269
syslogger.setFormatter(logging.Formatter
270
('Mandos (%s) [%%(process)d]:'
271
' %%(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))
275
def _timedelta_to_milliseconds(td):
276
"Convert a datetime.timedelta() to milliseconds"
277
return ((td.days * 24 * 60 * 60 * 1000)
278
+ (td.seconds * 1000)
279
+ (td.microseconds // 1000))
779
281
class Client(object):
780
282
"""A representation of a client host served by this server.
783
approved: bool(); 'None' if not yet approved/disapproved
285
_approved: bool(); 'None' if not yet approved/disapproved
784
286
approval_delay: datetime.timedelta(); Time to wait for approval
785
287
approval_duration: datetime.timedelta(); Duration of one approval
786
288
checker: subprocess.Popen(); a running checker process used
787
289
to see if the client lives.
788
290
'None' if no process is running.
789
checker_callback_tag: a GLib event source tag, or None
291
checker_callback_tag: a gobject event source tag, or None
790
292
checker_command: string; External command which is run to check
791
293
if client lives. %() expansions are done at
792
294
runtime with vars(self) as dict, so that for
793
295
instance %(name)s can be used in the command.
794
checker_initiator_tag: a GLib event source tag, or None
296
checker_initiator_tag: a gobject event source tag, or None
795
297
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
298
current_checker_command: string; current running checker_command
799
disable_initiator_tag: a GLib event source tag, or None
299
disable_hook: If set, called by disable() as disable_hook(self)
300
disable_initiator_tag: a gobject event source tag, or None
801
302
fingerprint: string (40 or 32 hexadecimal digits); used to
802
303
uniquely identify the client
804
305
interval: datetime.timedelta(); How often to start a new checker
805
306
last_approval_request: datetime.datetime(); (UTC) or None
806
307
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
308
last_enabled: datetime.datetime(); (UTC)
813
309
name: string; from the config file, used in log messages and
814
310
D-Bus identifiers
815
311
secret: bytestring; sent verbatim (over TLS) to client
816
312
timeout: datetime.timedelta(); How long from last_checked_ok
817
313
until this client is disabled
818
extended_timeout: extra long timeout when secret has been sent
314
extended_timeout: extra long timeout when password has been sent
819
315
runtime_expansions: Allowed attributes for runtime expansion.
820
316
expires: datetime.datetime(); time (UTC) when a client will be
821
317
disabled, or None
822
server_settings: The server_settings dict from main()
825
320
runtime_expansions = ("approval_delay", "approval_duration",
826
"created", "enabled", "expires",
827
"fingerprint", "host", "interval",
828
"last_approval_request", "last_checked_ok",
321
"created", "enabled", "fingerprint",
322
"host", "interval", "last_checked_ok",
829
323
"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):
325
def timeout_milliseconds(self):
326
"Return the 'timeout' attribute in milliseconds"
327
return _timedelta_to_milliseconds(self.timeout)
329
def extended_timeout_milliseconds(self):
330
"Return the 'extended_timeout' attribute in milliseconds"
331
return _timedelta_to_milliseconds(self.extended_timeout)
333
def interval_milliseconds(self):
334
"Return the 'interval' attribute in milliseconds"
335
return _timedelta_to_milliseconds(self.interval)
337
def approval_delay_milliseconds(self):
338
return _timedelta_to_milliseconds(self.approval_delay)
340
def __init__(self, name = None, disable_hook=None, config=None):
341
"""Note: the 'checker' key in 'config' sets the
342
'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
347
logger.debug("Creating client %r", self.name)
348
# Uppercase and remove spaces from fingerprint for later
349
# comparison purposes with return value from the fingerprint()
351
self.fingerprint = (config["fingerprint"].upper()
914
353
logger.debug(" Fingerprint: %s", self.fingerprint)
915
self.created = settings.get("created",
916
datetime.datetime.utcnow())
918
# attributes specific for this server instance
354
if "secret" in config:
355
self.secret = config["secret"].decode("base64")
356
elif "secfile" in config:
357
with open(os.path.expanduser(os.path.expandvars
358
(config["secfile"])),
360
self.secret = secfile.read()
362
raise TypeError("No secret or secfile for client %s"
364
self.host = config.get("host", "")
365
self.created = datetime.datetime.utcnow()
367
self.last_approval_request = None
368
self.last_enabled = None
369
self.last_checked_ok = None
370
self.timeout = string_to_delta(config["timeout"])
371
self.extended_timeout = string_to_delta(config
372
["extended_timeout"])
373
self.interval = string_to_delta(config["interval"])
374
self.disable_hook = disable_hook
919
375
self.checker = None
920
376
self.checker_initiator_tag = None
921
377
self.disable_initiator_tag = None
922
379
self.checker_callback_tag = None
380
self.checker_command = config["checker"]
923
381
self.current_checker_command = None
382
self.last_connect = None
383
self._approved = None
384
self.approved_by_default = config.get("approved_by_default",
925
386
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
387
self.approval_delay = string_to_delta(
388
config["approval_delay"])
389
self.approval_duration = string_to_delta(
390
config["approval_duration"])
391
self.changedstate = (multiprocessing_manager
392
.Condition(multiprocessing_manager
939
395
def send_changedstate(self):
940
with self.changedstate:
941
self.changedstate.notify_all()
396
self.changedstate.acquire()
397
self.changedstate.notify_all()
398
self.changedstate.release()
943
400
def enable(self):
944
401
"""Start this client's checker and timeout hooks"""
945
402
if getattr(self, "enabled", False):
946
403
# Already enabled
405
self.send_changedstate()
406
# Schedule a new checker to be started an 'interval' from now,
407
# and every interval from then on.
408
self.checker_initiator_tag = (gobject.timeout_add
409
(self.interval_milliseconds(),
411
# Schedule a disable() when 'timeout' has passed
948
412
self.expires = datetime.datetime.utcnow() + self.timeout
413
self.disable_initiator_tag = (gobject.timeout_add
414
(self.timeout_milliseconds(),
949
416
self.enabled = True
950
417
self.last_enabled = datetime.datetime.utcnow()
952
self.send_changedstate()
418
# Also start a new checker *right now*.
954
421
def disable(self, quiet=True):
955
422
"""Disable this client."""
956
423
if not getattr(self, "enabled", False):
426
self.send_changedstate()
959
428
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)
429
if getattr(self, "disable_initiator_tag", False):
430
gobject.source_remove(self.disable_initiator_tag)
962
431
self.disable_initiator_tag = None
963
432
self.expires = None
964
if getattr(self, "checker_initiator_tag", None) is not None:
965
GLib.source_remove(self.checker_initiator_tag)
433
if getattr(self, "checker_initiator_tag", False):
434
gobject.source_remove(self.checker_initiator_tag)
966
435
self.checker_initiator_tag = None
967
436
self.stop_checker()
437
if self.disable_hook:
438
self.disable_hook(self)
968
439
self.enabled = False
970
self.send_changedstate()
971
# Do not run this again if called by a GLib.timeout_add
440
# Do not run this again if called by a gobject.timeout_add
974
443
def __del__(self):
444
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,
447
def checker_callback(self, pid, condition, command):
995
448
"""The checker has completed, so take appropriate actions."""
996
449
self.checker_callback_tag = None
997
450
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:
451
if os.WIFEXITED(condition):
452
exitstatus = os.WEXITSTATUS(condition)
1006
454
logger.info("Checker for %(name)s succeeded",
1008
456
self.checked_ok()
1010
logger.info("Checker for %(name)s failed", vars(self))
458
logger.info("Checker for %(name)s failed",
1012
self.last_checker_status = -1
1013
self.last_checker_signal = -returncode
1014
461
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."""
464
def checked_ok(self, timeout=None):
465
"""Bump up the timeout for this client.
467
This should only be called when the client has been seen,
1027
470
if timeout is None:
1028
471
timeout = self.timeout
472
self.last_checked_ok = datetime.datetime.utcnow()
1029
473
if self.disable_initiator_tag is not None:
1030
GLib.source_remove(self.disable_initiator_tag)
1031
self.disable_initiator_tag = None
474
gobject.source_remove(self.disable_initiator_tag)
1032
475
if getattr(self, "enabled", False):
1033
self.disable_initiator_tag = GLib.timeout_add(
1034
int(timeout.total_seconds() * 1000), self.disable)
476
self.disable_initiator_tag = (gobject.timeout_add
477
(_timedelta_to_milliseconds
478
(timeout), self.disable))
1035
479
self.expires = datetime.datetime.utcnow() + timeout
1037
481
def need_approval(self):
1038
482
self.last_approval_request = datetime.datetime.utcnow()
1040
484
def start_checker(self):
1041
485
"""Start a new checker subprocess if one is not running.
1043
487
If a checker already exists, leave it running and do
1045
489
# 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
490
# did that, then if a checker (for some reason) started
491
# running slowly and taking more than 'interval' time, the
492
# client would inevitably timeout, since no checker would get
493
# a chance to run to completion. If we instead leave running
1050
494
# checkers alone, the checker would have to take more time
1051
495
# 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")
498
# If a checker exists, make sure it is not a zombie
500
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
501
except (AttributeError, OSError) as error:
502
if (isinstance(error, OSError)
503
and error.errno != errno.ECHILD):
507
logger.warning("Checker was a zombie")
508
gobject.source_remove(self.checker_callback_tag)
509
self.checker_callback(pid, status,
510
self.current_checker_command)
1058
511
# Start a new checker if needed
1059
512
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
514
# In case checker_command has exactly one % operator
515
command = self.checker_command % self.host
517
# Escape attributes for the shell
518
escaped_attrs = dict(
520
re.escape(unicode(str(getattr(self, attr, "")),
524
self.runtime_expansions)
527
command = self.checker_command % escaped_attrs
528
except TypeError as error:
529
logger.error('Could not format string "%s":'
530
' %s', self.checker_command, error)
531
return True # Try again later
1071
532
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
534
logger.info("Starting checker %r for %s",
536
# We don't need to redirect stdout and stderr, since
537
# in normal mode, that is already done by daemon(),
538
# and in debug mode we don't want to. (Stdin is
539
# always replaced by /dev/null.)
540
self.checker = subprocess.Popen(command,
543
self.checker_callback_tag = (gobject.child_watch_add
545
self.checker_callback,
547
# The checker may have completed before the gobject
548
# watch was added. Check for this.
549
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
551
gobject.source_remove(self.checker_callback_tag)
552
self.checker_callback(pid, status, command)
553
except OSError as error:
554
logger.error("Failed to start subprocess: %s",
556
# Re-run this periodically if run by gobject.timeout_add
1100
559
def stop_checker(self):
1101
560
"""Force the checker process, if any, to stop."""
1102
561
if self.checker_callback_tag:
1103
GLib.source_remove(self.checker_callback_tag)
562
gobject.source_remove(self.checker_callback_tag)
1104
563
self.checker_callback_tag = None
1105
564
if getattr(self, "checker", None) is None:
1107
566
logger.debug("Stopping checker for %(name)s", vars(self))
1108
self.checker.terminate()
568
os.kill(self.checker.pid, signal.SIGTERM)
570
#if self.checker.poll() is None:
571
# os.kill(self.checker.pid, signal.SIGKILL)
572
except OSError as error:
573
if error.errno != errno.ESRCH: # No such process
1109
575
self.checker = None
1112
def dbus_service_property(dbus_interface,
578
def dbus_service_property(dbus_interface, signature="v",
579
access="readwrite", byte_arrays=False):
1116
580
"""Decorators for marking methods of a DBusObjectWithProperties to
1117
581
become properties on the D-Bus.
1119
583
The decorated method will be called with no arguments by "Get"
1120
584
and with one argument by "Set".
1122
586
The parameters, where they are supported, are the same as
1123
587
dbus.service.method, except there is only "signature", since the
1124
588
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):
627
class DBusObjectWithProperties(dbus.service.Object):
1297
628
"""A D-Bus object with properties.
1299
630
Classes inheriting from this can use the dbus_service_property
1300
631
decorator to expose methods as D-Bus properties. It exposes the
1301
632
standard Get(), Set(), and GetAll() methods on the D-Bus.
636
def _is_dbus_property(obj):
637
return getattr(obj, "_dbus_is_property", False)
639
def _get_all_dbus_properties(self):
640
"""Returns a generator of (name, attribute) pairs
642
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
643
for cls in self.__class__.__mro__
645
inspect.getmembers(cls, self._is_dbus_property))
1304
647
def _get_dbus_property(self, interface_name, property_name):
1305
648
"""Returns a bound method if one exists which is a D-Bus
1306
649
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")):
651
for cls in self.__class__.__mro__:
652
for name, value in (inspect.getmembers
653
(cls, self._is_dbus_property)):
1311
654
if (value._dbus_name == property_name
1312
655
and value._dbus_interface == interface_name):
1313
656
return value.__get__(self)
1315
658
# 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,
659
raise DBusPropertyNotFound(self.dbus_object_path + ":"
660
+ interface_name + "."
663
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1330
664
out_signature="v")
1331
665
def Get(self, interface_name, property_name):
1332
666
"""Standard D-Bus property Get() method, see D-Bus standard.
1457
758
except (AttributeError, xml.dom.DOMException,
1458
759
xml.parsers.expat.ExpatError) as error:
1459
760
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):
765
def datetime_to_dbus (dt, variant_level=0):
1535
766
"""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).
768
return dbus.String("", variant_level = variant_level)
769
return dbus.String(dt.isoformat(),
770
variant_level=variant_level)
772
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
774
"""Applied to an empty subclass of a D-Bus object, this metaclass
775
will add additional D-Bus attributes matching a certain pattern.
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):
777
def __new__(mcs, name, bases, attr):
778
# Go through all the base classes which could have D-Bus
779
# methods, signals, or properties in them
780
for base in (b for b in bases
781
if issubclass(b, dbus.service.Object)):
782
# Go though all attributes of the base class
783
for attrname, attribute in inspect.getmembers(base):
1572
784
# Ignore non-D-Bus attributes, and D-Bus attributes
1573
785
# with the wrong interface name
1574
786
if (not hasattr(attribute, "_dbus_interface")
1575
or not attribute._dbus_interface.startswith(
1576
orig_interface_name)):
787
or not attribute._dbus_interface
788
.startswith("se.recompile.Mandos")):
1578
790
# Create an alternate D-Bus interface name based on
1579
791
# the current name
1580
alt_interface = attribute._dbus_interface.replace(
1581
orig_interface_name, alt_interface_name)
1582
interface_names.add(alt_interface)
792
alt_interface = (attribute._dbus_interface
793
.replace("se.recompile.Mandos",
794
"se.bsnet.fukt.Mandos"))
1583
795
# Is this a D-Bus signal?
1584
796
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(
797
# Extract the original non-method function by
799
nonmethod_func = (dict(
1589
800
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)
801
attribute.__closure__))["func"]
1597
803
# Create a new, but exactly alike, function
1598
804
# object, and decorate it to be a new D-Bus signal
1599
805
# 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:
806
new_function = (dbus.service.signal
808
attribute._dbus_signature)
810
nonmethod_func.func_code,
811
nonmethod_func.func_globals,
812
nonmethod_func.func_name,
813
nonmethod_func.func_defaults,
814
nonmethod_func.func_closure)))
1611
815
# 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
816
# old and new functions, so both the old and new
817
# signals gets sent when the function is called
1615
818
def fixscope(func1, func2):
1616
819
"""This function is a scope container to pass
1617
820
func1 and func2 to the "call_both" function
1618
821
outside of its arguments"""
1620
@functools.wraps(func2)
1621
822
def call_both(*args, **kwargs):
1622
823
"""This function will emit two D-Bus
1623
824
signals by calling func1 and func2"""
1624
825
func1(*args, **kwargs)
1625
826
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)
1632
827
return call_both
1633
828
# Create the "call_both" function and add it to
1635
attr[attrname] = fixscope(attribute, new_function)
830
attr[attrname] = fixscope(attribute,
1636
832
# Is this a D-Bus method?
1637
833
elif getattr(attribute, "_dbus_is_method", False):
1638
834
# Create a new, but exactly alike, function
1639
835
# object. Decorate it to be a new D-Bus method
1640
836
# 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:
838
attr[attrname] = (dbus.service.method
840
attribute._dbus_in_signature,
841
attribute._dbus_out_signature)
843
(attribute.func_code,
844
attribute.func_globals,
846
attribute.func_defaults,
847
attribute.func_closure)))
1654
848
# Is this a D-Bus property?
1655
849
elif getattr(attribute, "_dbus_is_property", False):
1656
850
# Create a new, but exactly alike, function
1657
851
# object, and decorate it to be a new D-Bus
1658
852
# property with the alternate D-Bus interface
1659
853
# 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"})
854
attr[attrname] = (dbus_service_property
856
attribute._dbus_signature,
857
attribute._dbus_access,
859
._dbus_get_args_options
862
(attribute.func_code,
863
attribute.func_globals,
865
attribute.func_defaults,
866
attribute.func_closure)))
867
return type.__new__(mcs, name, bases, attr)
1712
869
class ClientDBus(Client, DBusObjectWithProperties):
1713
870
"""A Client class using D-Bus
1716
873
dbus_object_path: dbus.ObjectPath
1717
874
bus: dbus.SystemBus()
1720
877
runtime_expansions = (Client.runtime_expansions
1721
+ ("dbus_object_path", ))
1723
_interface = "se.recompile.Mandos.Client"
878
+ ("dbus_object_path",))
1725
880
# dbus.service.Object doesn't use super(), so we can't either.
1727
def __init__(self, bus=None, *args, **kwargs):
882
def __init__(self, bus = None, *args, **kwargs):
883
self._approvals_pending = 0
1729
885
Client.__init__(self, *args, **kwargs)
1730
886
# Only now, when this client is initialized, can it show up on
1732
client_object_name = str(self.name).translate(
888
client_object_name = unicode(self.name).translate(
1733
889
{ord("."): ord("_"),
1734
890
ord("-"): ord("_")})
1735
self.dbus_object_path = dbus.ObjectPath(
1736
"/clients/" + client_object_name)
891
self.dbus_object_path = (dbus.ObjectPath
892
("/clients/" + client_object_name))
1737
893
DBusObjectWithProperties.__init__(self, self.bus,
1738
894
self.dbus_object_path)
1740
def notifychangeproperty(transform_func, dbus_name,
1741
type_func=lambda x: x,
1743
invalidate_only=False,
1744
_interface=_interface):
896
def notifychangeproperty(transform_func,
897
dbus_name, type_func=lambda x: x,
1745
899
""" Modify a variable so that it's a property which announces
1746
900
its changes to DBus.
2303
1424
delay -= time2 - time
2306
session.send(client.secret)
2307
except gnutls.Error as error:
2308
logger.warning("gnutls send failed",
1427
while sent_size < len(client.secret):
1429
sent = session.send(client.secret[sent_size:])
1430
except gnutls.errors.GNUTLSError as error:
1431
logger.warning("gnutls send failed")
1433
logger.debug("Sent: %d, remaining: %d",
1434
sent, len(client.secret)
1435
- (sent_size + sent))
2312
1438
logger.info("Sending secret to %s", client.name)
2313
1439
# bump the timeout using extended_timeout
2314
client.bump_timeout(client.extended_timeout)
1440
client.checked_ok(client.extended_timeout)
2315
1441
if self.server.use_dbus:
2316
1442
# Emit D-Bus signal
2317
1443
client.GotSecret()
2320
1446
if approval_required:
2321
1447
client.approvals_pending -= 1
2324
except gnutls.Error as error:
2325
logger.warning("GnuTLS bye failed",
1450
except gnutls.errors.GNUTLSError as error:
1451
logger.warning("GnuTLS bye failed")
2329
1454
def peer_certificate(session):
2330
1455
"Return the peer's OpenPGP certificate as a bytestring"
2331
1456
# If not an OpenPGP certificate...
2332
if (gnutls.certificate_type_get(session._c_object)
2333
!= gnutls.CRT_OPENPGP):
2334
# ...return invalid data
1457
if (gnutls.library.functions
1458
.gnutls_certificate_type_get(session._c_object)
1459
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1460
# ...do the normal thing
1461
return session.peer_certificate
2336
1462
list_size = ctypes.c_uint(1)
2337
cert_list = (gnutls.certificate_get_peers
1463
cert_list = (gnutls.library.functions
1464
.gnutls_certificate_get_peers
2338
1465
(session._c_object, ctypes.byref(list_size)))
2339
1466
if not bool(cert_list) and list_size.value != 0:
2340
raise gnutls.Error("error getting peer certificate")
1467
raise gnutls.errors.GNUTLSError("error getting peer"
2341
1469
if list_size.value == 0:
2343
1471
cert = cert_list[0]
2344
1472
return ctypes.string_at(cert.data, cert.size)
2347
1475
def fingerprint(openpgp):
2348
1476
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2349
1477
# 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)))
1478
datum = (gnutls.library.types
1479
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1482
ctypes.c_uint(len(openpgp))))
2354
1483
# New empty GnuTLS certificate
2355
crt = gnutls.openpgp_crt_t()
2356
gnutls.openpgp_crt_init(ctypes.byref(crt))
1484
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1485
(gnutls.library.functions
1486
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2357
1487
# Import the OpenPGP public key into the certificate
2358
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2359
gnutls.OPENPGP_FMT_RAW)
1488
(gnutls.library.functions
1489
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1490
gnutls.library.constants
1491
.GNUTLS_OPENPGP_FMT_RAW))
2360
1492
# Verify the self signature in the key
2361
1493
crtverify = ctypes.c_uint()
2362
gnutls.openpgp_crt_verify_self(crt, 0,
2363
ctypes.byref(crtverify))
1494
(gnutls.library.functions
1495
.gnutls_openpgp_crt_verify_self(crt, 0,
1496
ctypes.byref(crtverify)))
2364
1497
if crtverify.value != 0:
2365
gnutls.openpgp_crt_deinit(crt)
2366
raise gnutls.CertificateSecurityError("Verify failed")
1498
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1499
raise (gnutls.errors.CertificateSecurityError
2367
1501
# New buffer for the fingerprint
2368
1502
buf = ctypes.create_string_buffer(20)
2369
1503
buf_len = ctypes.c_size_t()
2370
1504
# Get the fingerprint from the certificate into the buffer
2371
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2372
ctypes.byref(buf_len))
1505
(gnutls.library.functions
1506
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1507
ctypes.byref(buf_len)))
2373
1508
# Deinit the certificate
2374
gnutls.openpgp_crt_deinit(crt)
1509
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2375
1510
# Convert the buffer to a Python bytestring
2376
1511
fpr = ctypes.string_at(buf, buf_len.value)
2377
1512
# Convert the bytestring to hexadecimal notation
2378
hex_fpr = binascii.hexlify(fpr).upper()
1513
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2382
1517
class MultiprocessingMixIn(object):
2383
1518
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2385
1519
def sub_process_main(self, request, address):
2387
1521
self.finish_request(request, address)
2389
1523
self.handle_error(request, address)
2390
1524
self.close_request(request)
2392
1526
def process_request(self, request, address):
2393
1527
"""Start a new process to process the request."""
2394
proc = multiprocessing.Process(target=self.sub_process_main,
2395
args=(request, address))
1528
proc = multiprocessing.Process(target = self.sub_process_main,
2400
1535
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2401
1536
""" adds a pipe to the MixIn """
2403
1537
def process_request(self, request, client_address):
2404
1538
"""Overrides and wraps the original process_request().
2406
1540
This function creates a new pipe in self.pipe
2408
1542
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2410
1544
proc = MultiprocessingMixIn.process_request(self, request,
2411
1545
client_address)
2412
1546
self.child_pipe.close()
2413
1547
self.add_pipe(parent_pipe, proc)
2415
1549
def add_pipe(self, parent_pipe, proc):
2416
1550
"""Dummy function; override as necessary"""
2417
raise NotImplementedError()
1551
raise NotImplementedError
2420
1554
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2421
1555
socketserver.TCPServer, object):
2422
1556
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2425
1559
enabled: Boolean; whether this server is activated yet
2426
1560
interface: None or a network interface name (string)
2427
1561
use_ipv6: Boolean; to use IPv6 or not
2430
1563
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().
1564
interface=None, use_ipv6=True):
2437
1565
self.interface = interface
2439
1567
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
1568
socketserver.TCPServer.__init__(self, server_address,
2468
1569
RequestHandlerClass)
2470
1570
def server_bind(self):
2471
1571
"""This overrides the normal server_bind() function
2472
1572
to bind to an interface if one was specified, and also NOT to
2473
1573
bind to an address or port if they were not specified."""
2474
global SO_BINDTODEVICE
2475
1574
if self.interface is not None:
2476
1575
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)
1576
logger.error("SO_BINDTODEVICE does not exist;"
1577
" cannot bind to interface %s",
1581
self.socket.setsockopt(socket.SOL_SOCKET,
1585
except socket.error as error:
1586
if error[0] == errno.EPERM:
1587
logger.error("No permission to"
1588
" bind to interface %s",
1590
elif error[0] == errno.ENOPROTOOPT:
1591
logger.error("SO_BINDTODEVICE not available;"
1592
" cannot bind to interface %s",
2498
1596
# Only bind(2) the socket if we really need to.
2499
1597
if self.server_address[0] or self.server_address[1]:
2500
1598
if not self.server_address[0]:
2501
1599
if self.address_family == socket.AF_INET6:
2502
any_address = "::" # in6addr_any
1600
any_address = "::" # in6addr_any
2504
any_address = "0.0.0.0" # INADDR_ANY
1602
any_address = socket.INADDR_ANY
2505
1603
self.server_address = (any_address,
2506
1604
self.server_address[1])
2507
1605
elif not self.server_address[1]:
2508
self.server_address = (self.server_address[0], 0)
1606
self.server_address = (self.server_address[0],
2509
1608
# if self.interface:
2510
1609
# self.server_address = (self.server_address[0],
2608
1713
funcname = request[1]
2609
1714
args = request[2]
2610
1715
kwargs = request[3]
2612
1717
parent_pipe.send(('data', getattr(client_object,
2613
1718
funcname)(*args,
2616
1721
if command == 'getattr':
2617
1722
attrname = request[1]
2618
if isinstance(client_object.__getattribute__(attrname),
2619
collections.Callable):
2620
parent_pipe.send(('function', ))
1723
if callable(client_object.__getattribute__(attrname)):
1724
parent_pipe.send(('function',))
2623
'data', client_object.__getattribute__(attrname)))
1726
parent_pipe.send(('data', client_object
1727
.__getattribute__(attrname)))
2625
1729
if command == 'setattr':
2626
1730
attrname = request[1]
2627
1731
value = request[2]
2628
1732
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
1737
def string_to_delta(interval):
2733
1738
"""Parse a string and return a datetime.timedelta
2735
1740
>>> string_to_delta('7d')
2736
1741
datetime.timedelta(7)
2737
1742
>>> string_to_delta('60s')
2832
1855
parser.add_argument("--no-dbus", action="store_false",
2833
1856
dest="use_dbus", help="Do not provide D-Bus"
2834
" system bus interface", default=None)
1857
" system bus interface")
2835
1858
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",
1859
dest="use_ipv6", help="Do not use IPv6")
2852
1860
options = parser.parse_args()
2854
1862
if options.check:
2856
fail_count, test_count = doctest.testmod()
2857
sys.exit(os.EX_OK if fail_count == 0 else 1)
2859
1867
# 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",
1868
server_defaults = { "interface": "",
1873
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1874
"servicename": "Mandos",
2878
1880
# Parse config file for server-global settings
2879
1881
server_config = configparser.SafeConfigParser(server_defaults)
2880
1882
del server_defaults
2881
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1883
server_config.read(os.path.join(options.configdir,
2882
1885
# Convert the SafeConfigParser object to a dict
2883
1886
server_settings = server_config.defaults()
2884
1887
# Use the appropriate methods on the non-string config options
2885
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1888
for option in ("debug", "use_dbus", "use_ipv6"):
2886
1889
server_settings[option] = server_config.getboolean("DEFAULT",
2888
1891
if server_settings["port"]:
2889
1892
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
1894
del server_config
2902
1896
# Override the settings from the config file with command line
2903
1897
# options, if set.
2904
1898
for option in ("interface", "address", "port", "debug",
2905
"priority", "servicename", "configdir", "use_dbus",
2906
"use_ipv6", "debuglevel", "restore", "statedir",
2907
"socket", "foreground", "zeroconf"):
1899
"priority", "servicename", "configdir",
1900
"use_dbus", "use_ipv6", "debuglevel"):
2908
1901
value = getattr(options, option)
2909
1902
if value is not None:
2910
1903
server_settings[option] = value
2912
1905
# Force all strings to be unicode
2913
1906
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
1907
if type(server_settings[option]) is str:
1908
server_settings[option] = unicode(server_settings[option])
2924
1909
# Now we have our good server settings in "server_settings"
2926
1911
##################################################################
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
1913
# For convenience
2934
1914
debug = server_settings["debug"]
2935
1915
debuglevel = server_settings["debuglevel"]
2936
1916
use_dbus = server_settings["use_dbus"]
2937
1917
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
1919
if server_settings["servicename"] != "Mandos":
2953
syslogger.setFormatter(
2954
logging.Formatter('Mandos ({}) [%(process)d]:'
2955
' %(levelname)s: %(message)s'.format(
2956
server_settings["servicename"])))
1920
syslogger.setFormatter(logging.Formatter
1921
('Mandos (%s) [%%(process)d]:'
1922
' %%(levelname)s: %%(message)s'
1923
% server_settings["servicename"]))
2958
1925
# Parse config file with clients
2959
client_config = configparser.SafeConfigParser(Client
1926
client_defaults = { "timeout": "5m",
1927
"extended_timeout": "15m",
1929
"checker": "fping -q -- %%(host)s",
1931
"approval_delay": "0s",
1932
"approval_duration": "1s",
1934
client_config = configparser.SafeConfigParser(client_defaults)
2961
1935
client_config.read(os.path.join(server_settings["configdir"],
2962
1936
"clients.conf"))
2964
1938
global mandos_dbus_service
2965
1939
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
1941
tcp_server = MandosServer((server_settings["address"],
1942
server_settings["port"]),
1944
interface=(server_settings["interface"]
1948
server_settings["priority"],
1951
pidfilename = "/var/run/mandos.pid"
1953
pidfile = open(pidfilename, "w")
1955
logger.error("Could not open file %r", pidfilename)
1958
uid = pwd.getpwnam("_mandos").pw_uid
1959
gid = pwd.getpwnam("_mandos").pw_gid
1962
uid = pwd.getpwnam("mandos").pw_uid
1963
gid = pwd.getpwnam("mandos").pw_gid
2996
1964
except KeyError:
1966
uid = pwd.getpwnam("nobody").pw_uid
1967
gid = pwd.getpwnam("nobody").pw_gid
3005
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3007
1974
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:
1975
if error[0] != errno.EPERM:
1978
if not debug and not debuglevel:
1979
logger.setLevel(logging.WARNING)
1981
level = getattr(logging, debuglevel.upper())
1982
logger.setLevel(level)
1985
logger.setLevel(logging.DEBUG)
3014
1986
# Enable all possible GnuTLS debugging
3016
1988
# "Use a log level over 10 to enable all debugging options."
3017
1989
# - GnuTLS manual
3018
gnutls.global_set_log_level(11)
1990
gnutls.library.functions.gnutls_global_set_log_level(11)
1992
@gnutls.library.types.gnutls_log_func
3021
1993
def debug_gnutls(level, string):
3022
1994
logger.debug("GnuTLS: %s", string[:-1])
3024
gnutls.global_set_log_function(debug_gnutls)
1996
(gnutls.library.functions
1997
.gnutls_global_set_log_function(debug_gnutls))
3026
1999
# Redirect stdin so all checkers get /dev/null
3027
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2000
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3028
2001
os.dup2(null, sys.stdin.fileno())
2005
# No console logging
2006
logger.removeHandler(console)
3032
2008
# Need to fork before connecting to D-Bus
3034
2010
# 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
2013
global main_loop
3042
2014
# From the Avahi example code
3043
DBusGMainLoop(set_as_default=True)
3044
main_loop = GLib.MainLoop()
2015
DBusGMainLoop(set_as_default=True )
2016
main_loop = gobject.MainLoop()
3045
2017
bus = dbus.SystemBus()
3046
2018
# End of Avahi example code
3049
2021
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)
2022
bus, do_not_queue=True)
2023
old_bus_name = (dbus.service.BusName
2024
("se.bsnet.fukt.Mandos", bus,
2026
except dbus.exceptions.NameExistsException as e:
2027
logger.error(unicode(e) + ", disabling D-Bus")
3057
2028
use_dbus = False
3058
2029
server_settings["use_dbus"] = False
3059
2030
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"))
2031
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2032
service = AvahiServiceToSyslog(name =
2033
server_settings["servicename"],
2034
servicetype = "_mandos._tcp",
2035
protocol = protocol, bus = bus)
2036
if server_settings["interface"]:
2037
service.interface = (if_nametoindex
2038
(str(server_settings["interface"])))
3071
2040
global multiprocessing_manager
3072
2041
multiprocessing_manager = multiprocessing.Manager()
3074
2043
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(
2045
client_class = functools.partial(ClientDBusTransitional,
2047
def client_config_items(config, section):
2048
special_settings = {
2049
"approved_by_default":
2050
lambda: config.getboolean(section,
2051
"approved_by_default"),
2053
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)
2055
yield (name, special_settings[name]())
2059
tcp_server.clients.update(set(
2060
client_class(name = section,
2061
config= dict(client_config_items(
2062
client_config, section)))
2063
for section in client_config.sections()))
3230
2064
if not tcp_server.clients:
3231
2065
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",
2071
pidfile.write(str(pid) + "\n".encode("utf-8"))
2074
logger.error("Could not write to file %r with PID %d",
2077
# "pidfile" was never created
3243
2079
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)
2081
signal.signal(signal.SIGINT, signal.SIG_IGN)
2083
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2084
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):
2087
class MandosDBusService(dbus.service.Object):
3254
2088
"""A D-Bus proxy object"""
3256
2089
def __init__(self):
3257
2090
dbus.service.Object.__init__(self, bus, "/")
3259
2091
_interface = "se.recompile.Mandos"
3261
2093
@dbus.service.signal(_interface, signature="o")
3262
2094
def ClientAdded(self, objpath):
3266
2098
@dbus.service.signal(_interface, signature="ss")
3267
2099
def ClientNotFound(self, fingerprint, address):
3271
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3273
2103
@dbus.service.signal(_interface, signature="os")
3274
2104
def ClientRemoved(self, objpath, name):
3278
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3280
2108
@dbus.service.method(_interface, out_signature="ao")
3281
2109
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":
2111
return dbus.Array(c.dbus_object_path
2112
for c in tcp_server.clients)
3288
2114
@dbus.service.method(_interface,
3289
2115
out_signature="a{oa{sv}}")
3290
2116
def GetAllClientsWithProperties(self):
3292
2118
return dbus.Dictionary(
3293
{c.dbus_object_path: c.GetAll(
3294
"se.recompile.Mandos.Client")
3295
for c in tcp_server.clients.values()},
2119
((c.dbus_object_path, c.GetAll(""))
2120
for c in tcp_server.clients),
3296
2121
signature="oa{sv}")
3298
2123
@dbus.service.method(_interface, in_signature="o")
3299
2124
def RemoveClient(self, object_path):
3301
for c in tcp_server.clients.values():
2126
for c in tcp_server.clients:
3302
2127
if c.dbus_object_path == object_path:
3303
del tcp_server.clients[c.name]
2128
tcp_server.clients.remove(c)
3304
2129
c.remove_from_connection()
3305
# Don't signal the disabling
2130
# Don't signal anything except ClientRemoved
3306
2131
c.disable(quiet=True)
3307
# Emit D-Bus signal for removal
3308
self.client_removed_signal(c)
2133
self.ClientRemoved(object_path, c.name)
3310
2135
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
2139
class MandosDBusServiceTransitional(MandosDBusService):
2140
__metaclass__ = AlternateDBusNamesMetaclass
2141
mandos_dbus_service = MandosDBusServiceTransitional()
3358
2144
"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
2147
multiprocessing.active_children()
3421
2148
while tcp_server.clients:
3422
name, client = tcp_server.clients.popitem()
2149
client = tcp_server.clients.pop()
3424
2151
client.remove_from_connection()
3425
# Don't signal the disabling
2152
client.disable_hook = None
2153
# Don't signal anything except ClientRemoved
3426
2154
client.disable(quiet=True)
3427
# Emit D-Bus signal for removal
3429
mandos_dbus_service.client_removed_signal(client)
3430
client_settings.clear()
2157
mandos_dbus_service.ClientRemoved(client
3432
2161
atexit.register(cleanup)
3434
for client in tcp_server.clients.values():
2163
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()
2166
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3442
2169
tcp_server.enable()
3443
2170
tcp_server.server_activate()
3445
2172
# Find out what port we got
3447
service.port = tcp_server.socket.getsockname()[1]
2173
service.port = tcp_server.socket.getsockname()[1]
3449
2175
logger.info("Now listening on address %r, port %d,"
3450
" flowinfo %d, scope_id %d",
3451
*tcp_server.socket.getsockname())
2176
" flowinfo %d, scope_id %d"
2177
% 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]
2179
logger.info("Now listening on address %r, port %d"
2180
% tcp_server.socket.getsockname())
2182
#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))
2185
# From the Avahi example code
2188
except dbus.exceptions.DBusException as error:
2189
logger.critical("DBusException: %s", error)
2192
# End of Avahi example code
2194
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2195
lambda *args, **kwargs:
2196
(tcp_server.handle_request
2197
(*args[2:], **kwargs) or True))
3474
2199
logger.debug("Starting main loop")
3475
2200
main_loop.run()
3476
2201
except AvahiError as error:
3477
logger.critical("Avahi Error", exc_info=error)
2202
logger.critical("AvahiError: %s", error)
3480
2205
except KeyboardInterrupt: