62
import cPickle as pickle
69
import cPickle as pickle
63
72
import multiprocessing
66
81
import dbus.service
82
from gi.repository import GLib
69
83
from dbus.mainloop.glib import DBusGMainLoop
72
86
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:
76
93
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
77
94
except AttributeError:
96
# This is where SO_BINDTODEVICE was up to and including Python
79
98
from IN import SO_BINDTODEVICE
80
99
except ImportError:
81
SO_BINDTODEVICE = None
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
88
syslogger = (logging.handlers.SysLogHandler
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
94
logger.addHandler(syslogger)
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
100
logger.addHandler(console)
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
102
303
class AvahiError(Exception):
103
304
def __init__(self, value, *args, **kwargs):
104
305
self.value = value
105
super(AvahiError, self).__init__(value, *args, **kwargs)
106
def __unicode__(self):
107
return unicode(repr(self.value))
306
return super(AvahiError, self).__init__(value, *args,
109
310
class AvahiServiceError(AvahiError):
112
314
class AvahiGroupError(AvahiError):
116
318
class AvahiService(object):
117
319
"""An Avahi (Zeroconf) service.
120
322
interface: integer; avahi.IF_UNSPEC or an interface index.
121
323
Used to optionally bind to the specified interface.
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
324
name: string; Example: 'Mandos'
325
type: string; Example: '_mandos._tcp'.
326
See <https://www.iana.org/assignments/service-names-port-numbers>
125
327
port: integer; what port to announce
126
328
TXT: list of strings; TXT record for the service
127
329
domain: string; Domain to publish on, default to .local if empty.
197
418
dbus.UInt16(self.port),
198
419
avahi.string_array_to_txt_array(self.TXT))
199
420
self.group.Commit()
200
422
def entry_group_state_changed(self, state, error):
201
423
"""Derived from the Avahi example code"""
202
logger.debug(u"Avahi entry group state change: %i", state)
424
logger.debug("Avahi entry group state change: %i", state)
204
426
if state == avahi.ENTRY_GROUP_ESTABLISHED:
205
logger.debug(u"Zeroconf service established.")
427
logger.debug("Zeroconf service established.")
206
428
elif state == avahi.ENTRY_GROUP_COLLISION:
207
logger.warning(u"Zeroconf service name collision.")
429
logger.info("Zeroconf service name collision.")
209
431
elif state == avahi.ENTRY_GROUP_FAILURE:
210
logger.critical(u"Avahi: Error in group state changed %s",
212
raise AvahiGroupError(u"State changed: %s"
432
logger.critical("Avahi: Error in group state changed %s",
434
raise AvahiGroupError("State changed: {!s}".format(error))
214
436
def cleanup(self):
215
437
"""Derived from the Avahi example code"""
216
438
if self.group is not None:
441
except (dbus.exceptions.UnknownMethodException,
442
dbus.exceptions.DBusException):
218
444
self.group = None
219
def server_state_changed(self, state):
447
def server_state_changed(self, state, error=None):
220
448
"""Derived from the Avahi example code"""
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
449
logger.debug("Avahi server state change: %i", state)
451
avahi.SERVER_INVALID: "Zeroconf server invalid",
452
avahi.SERVER_REGISTERING: None,
453
avahi.SERVER_COLLISION: "Zeroconf server name collision",
454
avahi.SERVER_FAILURE: "Zeroconf server failure",
456
if state in bad_states:
457
if bad_states[state] is not None:
459
logger.error(bad_states[state])
461
logger.error(bad_states[state] + ": %r", error)
225
463
elif state == avahi.SERVER_RUNNING:
466
except dbus.exceptions.DBusException as error:
467
if (error.get_dbus_name()
468
== "org.freedesktop.Avahi.CollisionError"):
469
logger.info("Local Zeroconf service name"
471
return self.rename(remove=False)
473
logger.critical("D-Bus Exception", exc_info=error)
478
logger.debug("Unknown state: %r", state)
480
logger.debug("Unknown state: %r: %r", state, error)
227
482
def activate(self):
228
483
"""Derived from the Avahi example code"""
229
484
if self.server is None:
230
485
self.server = dbus.Interface(
231
486
self.bus.get_object(avahi.DBUS_NAME,
232
avahi.DBUS_PATH_SERVER),
487
avahi.DBUS_PATH_SERVER,
488
follow_name_owner_changes=True),
233
489
avahi.DBUS_INTERFACE_SERVER)
234
self.server.connect_to_signal(u"StateChanged",
235
self.server_state_changed)
490
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
236
492
self.server_state_changed(self.server.GetState())
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
"""Add the new name to the syslog messages"""
498
ret = AvahiService.rename(self, *args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
505
# Pretend that we have a GnuTLS module
506
class GnuTLS(object):
507
"""This isn't so much a class as it is a module-like namespace.
508
It is instantiated once, and simulates having a GnuTLS module."""
510
library = ctypes.util.find_library("gnutls")
512
library = ctypes.util.find_library("gnutls-deb0")
513
_library = ctypes.cdll.LoadLibrary(library)
515
_need_version = b"3.3.0"
518
# Need to use class name "GnuTLS" here, since this method is
519
# called before the assignment to the "gnutls" global variable
521
if GnuTLS.check_version(self._need_version) is None:
522
raise GnuTLS.Error("Needs GnuTLS {} or later"
523
.format(self._need_version))
525
# Unless otherwise indicated, the constants and types below are
526
# all from the gnutls/gnutls.h C header file.
536
E_NO_CERTIFICATE_FOUND = -49
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
540
class session_int(ctypes.Structure):
542
session_t = ctypes.POINTER(session_int)
544
class certificate_credentials_st(ctypes.Structure):
546
certificate_credentials_t = ctypes.POINTER(
547
certificate_credentials_st)
548
certificate_type_t = ctypes.c_int
550
class datum_t(ctypes.Structure):
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
('size', ctypes.c_uint)]
554
class openpgp_crt_int(ctypes.Structure):
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
credentials_type_t = ctypes.c_int
560
transport_ptr_t = ctypes.c_void_p
561
close_request_t = ctypes.c_int
564
class Error(Exception):
565
# We need to use the class name "GnuTLS" here, since this
566
# exception might be raised from within GnuTLS.__init__,
567
# which is called before the assignment to the "gnutls"
568
# global variable has happened.
569
def __init__(self, message=None, code=None, args=()):
570
# Default usage is by a message string, but if a return
571
# code is passed, convert it to a string with
574
if message is None and code is not None:
575
message = GnuTLS.strerror(code)
576
return super(GnuTLS.Error, self).__init__(
579
class CertificateSecurityError(Error):
583
class Credentials(object):
585
self._c_object = gnutls.certificate_credentials_t()
586
gnutls.certificate_allocate_credentials(
587
ctypes.byref(self._c_object))
588
self.type = gnutls.CRD_CERTIFICATE
591
gnutls.certificate_free_credentials(self._c_object)
593
class ClientSession(object):
594
def __init__(self, socket, credentials=None):
595
self._c_object = gnutls.session_t()
596
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
597
gnutls.set_default_priority(self._c_object)
598
gnutls.transport_set_ptr(self._c_object, socket.fileno())
599
gnutls.handshake_set_private_extensions(self._c_object,
602
if credentials is None:
603
credentials = gnutls.Credentials()
604
gnutls.credentials_set(self._c_object, credentials.type,
605
ctypes.cast(credentials._c_object,
607
self.credentials = credentials
610
gnutls.deinit(self._c_object)
613
return gnutls.handshake(self._c_object)
615
def send(self, data):
619
data_len -= gnutls.record_send(self._c_object,
624
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
626
# Error handling functions
627
def _error_code(result):
628
"""A function to raise exceptions on errors, suitable
629
for the 'restype' attribute on ctypes functions"""
632
if result == gnutls.E_NO_CERTIFICATE_FOUND:
633
raise gnutls.CertificateSecurityError(code=result)
634
raise gnutls.Error(code=result)
636
def _retry_on_error(result, func, arguments):
637
"""A function to retry on some errors, suitable
638
for the 'errcheck' attribute on ctypes functions"""
640
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
641
return _error_code(result)
642
result = func(*arguments)
645
# Unless otherwise indicated, the function declarations below are
646
# all from the gnutls/gnutls.h C header file.
649
priority_set_direct = _library.gnutls_priority_set_direct
650
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
651
ctypes.POINTER(ctypes.c_char_p)]
652
priority_set_direct.restype = _error_code
654
init = _library.gnutls_init
655
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
656
init.restype = _error_code
658
set_default_priority = _library.gnutls_set_default_priority
659
set_default_priority.argtypes = [session_t]
660
set_default_priority.restype = _error_code
662
record_send = _library.gnutls_record_send
663
record_send.argtypes = [session_t, ctypes.c_void_p,
665
record_send.restype = ctypes.c_ssize_t
666
record_send.errcheck = _retry_on_error
668
certificate_allocate_credentials = (
669
_library.gnutls_certificate_allocate_credentials)
670
certificate_allocate_credentials.argtypes = [
671
ctypes.POINTER(certificate_credentials_t)]
672
certificate_allocate_credentials.restype = _error_code
674
certificate_free_credentials = (
675
_library.gnutls_certificate_free_credentials)
676
certificate_free_credentials.argtypes = [
677
certificate_credentials_t]
678
certificate_free_credentials.restype = None
680
handshake_set_private_extensions = (
681
_library.gnutls_handshake_set_private_extensions)
682
handshake_set_private_extensions.argtypes = [session_t,
684
handshake_set_private_extensions.restype = None
686
credentials_set = _library.gnutls_credentials_set
687
credentials_set.argtypes = [session_t, credentials_type_t,
689
credentials_set.restype = _error_code
691
strerror = _library.gnutls_strerror
692
strerror.argtypes = [ctypes.c_int]
693
strerror.restype = ctypes.c_char_p
695
certificate_type_get = _library.gnutls_certificate_type_get
696
certificate_type_get.argtypes = [session_t]
697
certificate_type_get.restype = _error_code
699
certificate_get_peers = _library.gnutls_certificate_get_peers
700
certificate_get_peers.argtypes = [session_t,
701
ctypes.POINTER(ctypes.c_uint)]
702
certificate_get_peers.restype = ctypes.POINTER(datum_t)
704
global_set_log_level = _library.gnutls_global_set_log_level
705
global_set_log_level.argtypes = [ctypes.c_int]
706
global_set_log_level.restype = None
708
global_set_log_function = _library.gnutls_global_set_log_function
709
global_set_log_function.argtypes = [log_func]
710
global_set_log_function.restype = None
712
deinit = _library.gnutls_deinit
713
deinit.argtypes = [session_t]
714
deinit.restype = None
716
handshake = _library.gnutls_handshake
717
handshake.argtypes = [session_t]
718
handshake.restype = _error_code
719
handshake.errcheck = _retry_on_error
721
transport_set_ptr = _library.gnutls_transport_set_ptr
722
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
723
transport_set_ptr.restype = None
725
bye = _library.gnutls_bye
726
bye.argtypes = [session_t, close_request_t]
727
bye.restype = _error_code
728
bye.errcheck = _retry_on_error
730
check_version = _library.gnutls_check_version
731
check_version.argtypes = [ctypes.c_char_p]
732
check_version.restype = ctypes.c_char_p
734
# All the function declarations below are from gnutls/openpgp.h
736
openpgp_crt_init = _library.gnutls_openpgp_crt_init
737
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
738
openpgp_crt_init.restype = _error_code
740
openpgp_crt_import = _library.gnutls_openpgp_crt_import
741
openpgp_crt_import.argtypes = [openpgp_crt_t,
742
ctypes.POINTER(datum_t),
744
openpgp_crt_import.restype = _error_code
746
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
747
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
748
ctypes.POINTER(ctypes.c_uint)]
749
openpgp_crt_verify_self.restype = _error_code
751
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
752
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
753
openpgp_crt_deinit.restype = None
755
openpgp_crt_get_fingerprint = (
756
_library.gnutls_openpgp_crt_get_fingerprint)
757
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
761
openpgp_crt_get_fingerprint.restype = _error_code
763
# Remove non-public functions
764
del _error_code, _retry_on_error
765
# Create the global "gnutls" object, simulating a module
769
def call_pipe(connection, # : multiprocessing.Connection
770
func, *args, **kwargs):
771
"""This function is meant to be called by multiprocessing.Process
773
This function runs func(*args, **kwargs), and writes the resulting
774
return value on the provided multiprocessing.Connection.
776
connection.send(func(*args, **kwargs))
239
780
class Client(object):
240
781
"""A representation of a client host served by this server.
243
_approved: bool(); 'None' if not yet approved/disapproved
784
approved: bool(); 'None' if not yet approved/disapproved
244
785
approval_delay: datetime.timedelta(); Time to wait for approval
245
786
approval_duration: datetime.timedelta(); Duration of one approval
246
787
checker: subprocess.Popen(); a running checker process used
247
788
to see if the client lives.
248
789
'None' if no process is running.
249
checker_callback_tag: - '' -
790
checker_callback_tag: a GLib event source tag, or None
250
791
checker_command: string; External command which is run to check
251
792
if client lives. %() expansions are done at
252
793
runtime with vars(self) as dict, so that for
253
794
instance %(name)s can be used in the command.
254
checker_initiator_tag: a gobject event source tag, or None
795
checker_initiator_tag: a GLib event source tag, or None
255
796
created: datetime.datetime(); (UTC) object creation
797
client_structure: Object describing what attributes a client has
798
and is used for storing the client at exit
256
799
current_checker_command: string; current running checker_command
257
disable_hook: If set, called by disable() as disable_hook(self)
258
disable_initiator_tag: - '' -
800
disable_initiator_tag: a GLib event source tag, or None
260
802
fingerprint: string (40 or 32 hexadecimal digits); used to
261
803
uniquely identify the client
262
804
host: string; available for use by the checker command
263
805
interval: datetime.timedelta(); How often to start a new checker
806
last_approval_request: datetime.datetime(); (UTC) or None
264
807
last_checked_ok: datetime.datetime(); (UTC) or None
265
last_enabled: datetime.datetime(); (UTC)
808
last_checker_status: integer between 0 and 255 reflecting exit
809
status of last checker. -1 reflects crashed
810
checker, -2 means no checker completed yet.
811
last_checker_signal: The signal which killed the last checker, if
812
last_checker_status is -1
813
last_enabled: datetime.datetime(); (UTC) or None
266
814
name: string; from the config file, used in log messages and
267
815
D-Bus identifiers
268
816
secret: bytestring; sent verbatim (over TLS) to client
269
817
timeout: datetime.timedelta(); How long from last_checked_ok
270
818
until this client is disabled
819
extended_timeout: extra long timeout when secret has been sent
271
820
runtime_expansions: Allowed attributes for runtime expansion.
821
expires: datetime.datetime(); time (UTC) when a client will be
823
server_settings: The server_settings dict from main()
274
runtime_expansions = (u"approval_delay", u"approval_duration",
275
u"created", u"enabled", u"fingerprint",
276
u"host", u"interval", u"last_checked_ok",
277
u"last_enabled", u"name", u"timeout")
826
runtime_expansions = ("approval_delay", "approval_duration",
827
"created", "enabled", "expires",
828
"fingerprint", "host", "interval",
829
"last_approval_request", "last_checked_ok",
830
"last_enabled", "name", "timeout")
833
"extended_timeout": "PT15M",
835
"checker": "fping -q -- %%(host)s",
837
"approval_delay": "PT0S",
838
"approval_duration": "PT1S",
839
"approved_by_default": "True",
280
def _timedelta_to_milliseconds(td):
281
"Convert a datetime.timedelta() to milliseconds"
282
return ((td.days * 24 * 60 * 60 * 1000)
283
+ (td.seconds * 1000)
284
+ (td.microseconds // 1000))
286
def timeout_milliseconds(self):
287
"Return the 'timeout' attribute in milliseconds"
288
return self._timedelta_to_milliseconds(self.timeout)
290
def interval_milliseconds(self):
291
"Return the 'interval' attribute in milliseconds"
292
return self._timedelta_to_milliseconds(self.interval)
294
def approval_delay_milliseconds(self):
295
return self._timedelta_to_milliseconds(self.approval_delay)
297
def __init__(self, name = None, disable_hook=None, config=None):
298
"""Note: the 'checker' key in 'config' sets the
299
'checker_command' attribute and *not* the 'checker'
844
def config_parser(config):
845
"""Construct a new dict of client settings of this form:
846
{ client_name: {setting_name: value, ...}, ...}
847
with exceptions for any special settings as defined above.
848
NOTE: Must be a pure function. Must return the same result
849
value given the same arguments.
852
for client_name in config.sections():
853
section = dict(config.items(client_name))
854
client = settings[client_name] = {}
856
client["host"] = section["host"]
857
# Reformat values from string types to Python types
858
client["approved_by_default"] = config.getboolean(
859
client_name, "approved_by_default")
860
client["enabled"] = config.getboolean(client_name,
863
# Uppercase and remove spaces from fingerprint for later
864
# comparison purposes with return value from the
865
# fingerprint() function
866
client["fingerprint"] = (section["fingerprint"].upper()
868
if "secret" in section:
869
client["secret"] = codecs.decode(section["secret"]
872
elif "secfile" in section:
873
with open(os.path.expanduser(os.path.expandvars
874
(section["secfile"])),
876
client["secret"] = secfile.read()
878
raise TypeError("No secret or secfile for section {}"
880
client["timeout"] = string_to_delta(section["timeout"])
881
client["extended_timeout"] = string_to_delta(
882
section["extended_timeout"])
883
client["interval"] = string_to_delta(section["interval"])
884
client["approval_delay"] = string_to_delta(
885
section["approval_delay"])
886
client["approval_duration"] = string_to_delta(
887
section["approval_duration"])
888
client["checker_command"] = section["checker"]
889
client["last_approval_request"] = None
890
client["last_checked_ok"] = None
891
client["last_checker_status"] = -2
895
def __init__(self, settings, name=None, server_settings=None):
304
logger.debug(u"Creating client %r", self.name)
305
# Uppercase and remove spaces from fingerprint for later
306
# comparison purposes with return value from the fingerprint()
308
self.fingerprint = (config[u"fingerprint"].upper()
310
logger.debug(u" Fingerprint: %s", self.fingerprint)
311
if u"secret" in config:
312
self.secret = config[u"secret"].decode(u"base64")
313
elif u"secfile" in config:
314
with open(os.path.expanduser(os.path.expandvars
315
(config[u"secfile"])),
317
self.secret = secfile.read()
897
if server_settings is None:
899
self.server_settings = server_settings
900
# adding all client settings
901
for setting, value in settings.items():
902
setattr(self, setting, value)
905
if not hasattr(self, "last_enabled"):
906
self.last_enabled = datetime.datetime.utcnow()
907
if not hasattr(self, "expires"):
908
self.expires = (datetime.datetime.utcnow()
319
raise TypeError(u"No secret or secfile for client %s"
321
self.host = config.get(u"host", u"")
322
self.created = datetime.datetime.utcnow()
324
self.last_enabled = None
325
self.last_checked_ok = None
326
self.timeout = string_to_delta(config[u"timeout"])
327
self.interval = string_to_delta(config[u"interval"])
328
self.disable_hook = disable_hook
911
self.last_enabled = None
914
logger.debug("Creating client %r", self.name)
915
logger.debug(" Fingerprint: %s", self.fingerprint)
916
self.created = settings.get("created",
917
datetime.datetime.utcnow())
919
# attributes specific for this server instance
329
920
self.checker = None
330
921
self.checker_initiator_tag = None
331
922
self.disable_initiator_tag = None
332
923
self.checker_callback_tag = None
333
self.checker_command = config[u"checker"]
334
924
self.current_checker_command = None
335
self.last_connect = None
336
self._approved = None
337
self.approved_by_default = config.get(u"approved_by_default",
339
926
self.approvals_pending = 0
340
self.approval_delay = string_to_delta(
341
config[u"approval_delay"])
342
self.approval_duration = string_to_delta(
343
config[u"approval_duration"])
344
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
927
self.changedstate = multiprocessing_manager.Condition(
928
multiprocessing_manager.Lock())
929
self.client_structure = [attr
930
for attr in self.__dict__.keys()
931
if not attr.startswith("_")]
932
self.client_structure.append("client_structure")
934
for name, t in inspect.getmembers(
935
type(self), lambda obj: isinstance(obj, property)):
936
if not name.startswith("_"):
937
self.client_structure.append(name)
939
# Send notice to process children that client state has changed
346
940
def send_changedstate(self):
347
self.changedstate.acquire()
348
self.changedstate.notify_all()
349
self.changedstate.release()
941
with self.changedstate:
942
self.changedstate.notify_all()
351
944
def enable(self):
352
945
"""Start this client's checker and timeout hooks"""
353
if getattr(self, u"enabled", False):
946
if getattr(self, "enabled", False):
354
947
# Already enabled
356
self.send_changedstate()
949
self.expires = datetime.datetime.utcnow() + self.timeout
357
951
self.last_enabled = datetime.datetime.utcnow()
953
self.send_changedstate()
955
def disable(self, quiet=True):
956
"""Disable this client."""
957
if not getattr(self, "enabled", False):
960
logger.info("Disabling client %s", self.name)
961
if getattr(self, "disable_initiator_tag", None) is not None:
962
GLib.source_remove(self.disable_initiator_tag)
963
self.disable_initiator_tag = None
965
if getattr(self, "checker_initiator_tag", None) is not None:
966
GLib.source_remove(self.checker_initiator_tag)
967
self.checker_initiator_tag = None
971
self.send_changedstate()
972
# Do not run this again if called by a GLib.timeout_add
978
def init_checker(self):
358
979
# Schedule a new checker to be started an 'interval' from now,
359
980
# and every interval from then on.
360
self.checker_initiator_tag = (gobject.timeout_add
361
(self.interval_milliseconds(),
981
if self.checker_initiator_tag is not None:
982
GLib.source_remove(self.checker_initiator_tag)
983
self.checker_initiator_tag = GLib.timeout_add(
984
int(self.interval.total_seconds() * 1000),
363
986
# Schedule a disable() when 'timeout' has passed
364
self.disable_initiator_tag = (gobject.timeout_add
365
(self.timeout_milliseconds(),
987
if self.disable_initiator_tag is not None:
988
GLib.source_remove(self.disable_initiator_tag)
989
self.disable_initiator_tag = GLib.timeout_add(
990
int(self.timeout.total_seconds() * 1000), self.disable)
368
991
# Also start a new checker *right now*.
369
992
self.start_checker()
371
def disable(self, quiet=True):
372
"""Disable this client."""
373
if not getattr(self, "enabled", False):
376
self.send_changedstate()
378
logger.info(u"Disabling client %s", self.name)
379
if getattr(self, u"disable_initiator_tag", False):
380
gobject.source_remove(self.disable_initiator_tag)
381
self.disable_initiator_tag = None
382
if getattr(self, u"checker_initiator_tag", False):
383
gobject.source_remove(self.checker_initiator_tag)
384
self.checker_initiator_tag = None
386
if self.disable_hook:
387
self.disable_hook(self)
389
# Do not run this again if called by a gobject.timeout_add
393
self.disable_hook = None
396
def checker_callback(self, pid, condition, command):
994
def checker_callback(self, source, condition, connection,
397
996
"""The checker has completed, so take appropriate actions."""
398
997
self.checker_callback_tag = None
399
998
self.checker = None
400
if os.WIFEXITED(condition):
401
exitstatus = os.WEXITSTATUS(condition)
403
logger.info(u"Checker for %(name)s succeeded",
999
# Read return code from connection (see call_pipe)
1000
returncode = connection.recv()
1004
self.last_checker_status = returncode
1005
self.last_checker_signal = None
1006
if self.last_checker_status == 0:
1007
logger.info("Checker for %(name)s succeeded",
405
1009
self.checked_ok()
407
logger.info(u"Checker for %(name)s failed",
1011
logger.info("Checker for %(name)s failed", vars(self))
410
logger.warning(u"Checker for %(name)s crashed?",
1013
self.last_checker_status = -1
1014
self.last_checker_signal = -returncode
1015
logger.warning("Checker for %(name)s crashed?",
413
1019
def checked_ok(self):
414
"""Bump up the timeout for this client.
416
This should only be called when the client has been seen,
1020
"""Assert that the client has been seen, alive and well."""
419
1021
self.last_checked_ok = datetime.datetime.utcnow()
420
gobject.source_remove(self.disable_initiator_tag)
421
self.disable_initiator_tag = (gobject.timeout_add
422
(self.timeout_milliseconds(),
1022
self.last_checker_status = 0
1023
self.last_checker_signal = None
1026
def bump_timeout(self, timeout=None):
1027
"""Bump up the timeout for this client."""
1029
timeout = self.timeout
1030
if self.disable_initiator_tag is not None:
1031
GLib.source_remove(self.disable_initiator_tag)
1032
self.disable_initiator_tag = None
1033
if getattr(self, "enabled", False):
1034
self.disable_initiator_tag = GLib.timeout_add(
1035
int(timeout.total_seconds() * 1000), self.disable)
1036
self.expires = datetime.datetime.utcnow() + timeout
1038
def need_approval(self):
1039
self.last_approval_request = datetime.datetime.utcnow()
425
1041
def start_checker(self):
426
1042
"""Start a new checker subprocess if one is not running.
428
1044
If a checker already exists, leave it running and do
430
1046
# The reason for not killing a running checker is that if we
431
# did that, then if a checker (for some reason) started
432
# running slowly and taking more than 'interval' time, the
433
# client would inevitably timeout, since no checker would get
434
# a chance to run to completion. If we instead leave running
1047
# did that, and if a checker (for some reason) started running
1048
# slowly and taking more than 'interval' time, then the client
1049
# would inevitably timeout, since no checker would get a
1050
# chance to run to completion. If we instead leave running
435
1051
# checkers alone, the checker would have to take more time
436
1052
# than 'timeout' for the client to be disabled, which is as it
439
# If a checker exists, make sure it is not a zombie
441
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
442
except (AttributeError, OSError), error:
443
if (isinstance(error, OSError)
444
and error.errno != errno.ECHILD):
448
logger.warning(u"Checker was a zombie")
449
gobject.source_remove(self.checker_callback_tag)
450
self.checker_callback(pid, status,
451
self.current_checker_command)
1055
if self.checker is not None and not self.checker.is_alive():
1056
logger.warning("Checker was not alive; joining")
452
1059
# Start a new checker if needed
453
1060
if self.checker is None:
1061
# Escape attributes for the shell
1063
attr: re.escape(str(getattr(self, attr)))
1064
for attr in self.runtime_expansions}
455
# In case checker_command has exactly one % operator
456
command = self.checker_command % self.host
458
# Escape attributes for the shell
459
escaped_attrs = dict(
461
re.escape(unicode(str(getattr(self, attr, u"")),
465
self.runtime_expansions)
468
command = self.checker_command % escaped_attrs
469
except TypeError, error:
470
logger.error(u'Could not format string "%s":'
471
u' %s', self.checker_command, error)
472
return True # Try again later
1066
command = self.checker_command % escaped_attrs
1067
except TypeError as error:
1068
logger.error('Could not format string "%s"',
1069
self.checker_command,
1071
return True # Try again later
473
1072
self.current_checker_command = command
475
logger.info(u"Starting checker %r for %s",
477
# We don't need to redirect stdout and stderr, since
478
# in normal mode, that is already done by daemon(),
479
# and in debug mode we don't want to. (Stdin is
480
# always replaced by /dev/null.)
481
self.checker = subprocess.Popen(command,
483
shell=True, cwd=u"/")
484
self.checker_callback_tag = (gobject.child_watch_add
486
self.checker_callback,
488
# The checker may have completed before the gobject
489
# watch was added. Check for this.
490
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
492
gobject.source_remove(self.checker_callback_tag)
493
self.checker_callback(pid, status, command)
494
except OSError, error:
495
logger.error(u"Failed to start subprocess: %s",
497
# Re-run this periodically if run by gobject.timeout_add
1073
logger.info("Starting checker %r for %s", command,
1075
# We don't need to redirect stdout and stderr, since
1076
# in normal mode, that is already done by daemon(),
1077
# and in debug mode we don't want to. (Stdin is
1078
# always replaced by /dev/null.)
1079
# The exception is when not debugging but nevertheless
1080
# running in the foreground; use the previously
1082
popen_args = {"close_fds": True,
1085
if (not self.server_settings["debug"]
1086
and self.server_settings["foreground"]):
1087
popen_args.update({"stdout": wnull,
1089
pipe = multiprocessing.Pipe(duplex=False)
1090
self.checker = multiprocessing.Process(
1092
args=(pipe[1], subprocess.call, command),
1094
self.checker.start()
1095
self.checker_callback_tag = GLib.io_add_watch(
1096
pipe[0].fileno(), GLib.IO_IN,
1097
self.checker_callback, pipe[0], command)
1098
# Re-run this periodically if run by GLib.timeout_add
500
1101
def stop_checker(self):
501
1102
"""Force the checker process, if any, to stop."""
502
1103
if self.checker_callback_tag:
503
gobject.source_remove(self.checker_callback_tag)
1104
GLib.source_remove(self.checker_callback_tag)
504
1105
self.checker_callback_tag = None
505
if getattr(self, u"checker", None) is None:
1106
if getattr(self, "checker", None) is None:
507
logger.debug(u"Stopping checker for %(name)s", vars(self))
509
os.kill(self.checker.pid, signal.SIGTERM)
511
#if self.checker.poll() is None:
512
# os.kill(self.checker.pid, signal.SIGKILL)
513
except OSError, error:
514
if error.errno != errno.ESRCH: # No such process
1108
logger.debug("Stopping checker for %(name)s", vars(self))
1109
self.checker.terminate()
516
1110
self.checker = None
518
def dbus_service_property(dbus_interface, signature=u"v",
519
access=u"readwrite", byte_arrays=False):
1113
def dbus_service_property(dbus_interface,
520
1117
"""Decorators for marking methods of a DBusObjectWithProperties to
521
1118
become properties on the D-Bus.
523
1120
The decorated method will be called with no arguments by "Get"
524
1121
and with one argument by "Set".
526
1123
The parameters, where they are supported, are the same as
527
1124
dbus.service.method, except there is only "signature", since the
528
1125
type from Get() and the type sent to Set() is the same.
530
1127
# Encoding deeply encoded byte arrays is not supported yet by the
531
1128
# "Set" method, so we fail early here:
532
if byte_arrays and signature != u"ay":
533
raise ValueError(u"Byte arrays not supported for non-'ay'"
534
u" signature %r" % signature)
1129
if byte_arrays and signature != "ay":
1130
raise ValueError("Byte arrays not supported for non-'ay'"
1131
" signature {!r}".format(signature))
535
1133
def decorator(func):
536
1134
func._dbus_is_property = True
537
1135
func._dbus_interface = dbus_interface
538
1136
func._dbus_signature = signature
539
1137
func._dbus_access = access
540
1138
func._dbus_name = func.__name__
541
if func._dbus_name.endswith(u"_dbus_property"):
1139
if func._dbus_name.endswith("_dbus_property"):
542
1140
func._dbus_name = func._dbus_name[:-14]
543
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1141
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1147
def dbus_interface_annotations(dbus_interface):
1148
"""Decorator for marking functions returning interface annotations
1152
@dbus_interface_annotations("org.example.Interface")
1153
def _foo(self): # Function name does not matter
1154
return {"org.freedesktop.DBus.Deprecated": "true",
1155
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1159
def decorator(func):
1160
func._dbus_is_interface = True
1161
func._dbus_interface = dbus_interface
1162
func._dbus_name = dbus_interface
1168
def dbus_annotations(annotations):
1169
"""Decorator to annotate D-Bus methods, signals or properties
1172
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1173
"org.freedesktop.DBus.Property."
1174
"EmitsChangedSignal": "false"})
1175
@dbus_service_property("org.example.Interface", signature="b",
1177
def Property_dbus_property(self):
1178
return dbus.Boolean(False)
1180
See also the DBusObjectWithAnnotations class.
1183
def decorator(func):
1184
func._dbus_annotations = annotations
545
1187
return decorator
548
1190
class DBusPropertyException(dbus.exceptions.DBusException):
549
1191
"""A base class for D-Bus property-related exceptions
551
def __unicode__(self):
552
return unicode(str(self))
555
1196
class DBusPropertyAccessException(DBusPropertyException):
567
class DBusObjectWithProperties(dbus.service.Object):
1208
class DBusObjectWithAnnotations(dbus.service.Object):
1209
"""A D-Bus object with annotations.
1211
Classes inheriting from this can use the dbus_annotations
1212
decorator to add annotations to methods or signals.
1216
def _is_dbus_thing(thing):
1217
"""Returns a function testing if an attribute is a D-Bus thing
1219
If called like _is_dbus_thing("method") it returns a function
1220
suitable for use as predicate to inspect.getmembers().
1222
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1225
def _get_all_dbus_things(self, thing):
1226
"""Returns a generator of (name, attribute) pairs
1228
return ((getattr(athing.__get__(self), "_dbus_name", name),
1229
athing.__get__(self))
1230
for cls in self.__class__.__mro__
1232
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1234
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1236
path_keyword='object_path',
1237
connection_keyword='connection')
1238
def Introspect(self, object_path, connection):
1239
"""Overloading of standard D-Bus method.
1241
Inserts annotation tags on methods and signals.
1243
xmlstring = dbus.service.Object.Introspect(self, object_path,
1246
document = xml.dom.minidom.parseString(xmlstring)
1248
for if_tag in document.getElementsByTagName("interface"):
1249
# Add annotation tags
1250
for typ in ("method", "signal"):
1251
for tag in if_tag.getElementsByTagName(typ):
1253
for name, prop in (self.
1254
_get_all_dbus_things(typ)):
1255
if (name == tag.getAttribute("name")
1256
and prop._dbus_interface
1257
== if_tag.getAttribute("name")):
1258
annots.update(getattr(
1259
prop, "_dbus_annotations", {}))
1260
for name, value in annots.items():
1261
ann_tag = document.createElement(
1263
ann_tag.setAttribute("name", name)
1264
ann_tag.setAttribute("value", value)
1265
tag.appendChild(ann_tag)
1266
# Add interface annotation tags
1267
for annotation, value in dict(
1268
itertools.chain.from_iterable(
1269
annotations().items()
1270
for name, annotations
1271
in self._get_all_dbus_things("interface")
1272
if name == if_tag.getAttribute("name")
1274
ann_tag = document.createElement("annotation")
1275
ann_tag.setAttribute("name", annotation)
1276
ann_tag.setAttribute("value", value)
1277
if_tag.appendChild(ann_tag)
1278
# Fix argument name for the Introspect method itself
1279
if (if_tag.getAttribute("name")
1280
== dbus.INTROSPECTABLE_IFACE):
1281
for cn in if_tag.getElementsByTagName("method"):
1282
if cn.getAttribute("name") == "Introspect":
1283
for arg in cn.getElementsByTagName("arg"):
1284
if (arg.getAttribute("direction")
1286
arg.setAttribute("name",
1288
xmlstring = document.toxml("utf-8")
1290
except (AttributeError, xml.dom.DOMException,
1291
xml.parsers.expat.ExpatError) as error:
1292
logger.error("Failed to override Introspection method",
1297
class DBusObjectWithProperties(DBusObjectWithAnnotations):
568
1298
"""A D-Bus object with properties.
570
1300
Classes inheriting from this can use the dbus_service_property
571
1301
decorator to expose methods as D-Bus properties. It exposes the
572
1302
standard Get(), Set(), and GetAll() methods on the D-Bus.
576
def _is_dbus_property(obj):
577
return getattr(obj, u"_dbus_is_property", False)
579
def _get_all_dbus_properties(self):
580
"""Returns a generator of (name, attribute) pairs
582
return ((prop._dbus_name, prop)
584
inspect.getmembers(self, self._is_dbus_property))
586
1305
def _get_dbus_property(self, interface_name, property_name):
587
1306
"""Returns a bound method if one exists which is a D-Bus
588
1307
property with the specified name and interface.
590
for name in (property_name,
591
property_name + u"_dbus_property"):
592
prop = getattr(self, name, None)
594
or not self._is_dbus_property(prop)
595
or prop._dbus_name != property_name
596
or (interface_name and prop._dbus_interface
597
and interface_name != prop._dbus_interface)):
1309
for cls in self.__class__.__mro__:
1310
for name, value in inspect.getmembers(
1311
cls, self._is_dbus_thing("property")):
1312
if (value._dbus_name == property_name
1313
and value._dbus_interface == interface_name):
1314
return value.__get__(self)
600
1316
# No such property
601
raise DBusPropertyNotFound(self.dbus_object_path + u":"
602
+ interface_name + u"."
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1317
raise DBusPropertyNotFound("{}:{}.{}".format(
1318
self.dbus_object_path, interface_name, property_name))
1321
def _get_all_interface_names(cls):
1322
"""Get a sequence of all interfaces supported by an object"""
1323
return (name for name in set(getattr(getattr(x, attr),
1324
"_dbus_interface", None)
1325
for x in (inspect.getmro(cls))
1327
if name is not None)
1329
@dbus.service.method(dbus.PROPERTIES_IFACE,
607
1332
def Get(self, interface_name, property_name):
608
1333
"""Standard D-Bus property Get() method, see D-Bus standard.
610
1335
prop = self._get_dbus_property(interface_name, property_name)
611
if prop._dbus_access == u"write":
1336
if prop._dbus_access == "write":
612
1337
raise DBusPropertyAccessException(property_name)
614
if not hasattr(value, u"variant_level"):
1339
if not hasattr(value, "variant_level"):
616
1341
return type(value)(value, variant_level=value.variant_level+1)
618
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1343
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
619
1344
def Set(self, interface_name, property_name, value):
620
1345
"""Standard D-Bus property Set() method, see D-Bus standard.
622
1347
prop = self._get_dbus_property(interface_name, property_name)
623
if prop._dbus_access == u"read":
1348
if prop._dbus_access == "read":
624
1349
raise DBusPropertyAccessException(property_name)
625
if prop._dbus_get_args_options[u"byte_arrays"]:
1350
if prop._dbus_get_args_options["byte_arrays"]:
626
1351
# The byte_arrays option is not supported yet on
627
1352
# signatures other than "ay".
628
if prop._dbus_signature != u"ay":
630
value = dbus.ByteArray(''.join(unichr(byte)
1353
if prop._dbus_signature != "ay":
1354
raise ValueError("Byte arrays not supported for non-"
1355
"'ay' signature {!r}"
1356
.format(prop._dbus_signature))
1357
value = dbus.ByteArray(b''.join(chr(byte)
634
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
635
out_signature=u"a{sv}")
1361
@dbus.service.method(dbus.PROPERTIES_IFACE,
1363
out_signature="a{sv}")
636
1364
def GetAll(self, interface_name):
637
1365
"""Standard D-Bus property GetAll() method, see D-Bus
640
1368
Note: Will not include properties with access="write".
643
for name, prop in self._get_all_dbus_properties():
1371
for name, prop in self._get_all_dbus_things("property"):
644
1372
if (interface_name
645
1373
and interface_name != prop._dbus_interface):
646
1374
# Interface non-empty but did not match
648
1376
# Ignore write-only properties
649
if prop._dbus_access == u"write":
1377
if prop._dbus_access == "write":
652
if not hasattr(value, u"variant_level"):
1380
if not hasattr(value, "variant_level"):
1381
properties[name] = value
655
all[name] = type(value)(value, variant_level=
656
value.variant_level+1)
657
return dbus.Dictionary(all, signature=u"sv")
1383
properties[name] = type(value)(
1384
value, variant_level=value.variant_level + 1)
1385
return dbus.Dictionary(properties, signature="sv")
1387
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1388
def PropertiesChanged(self, interface_name, changed_properties,
1389
invalidated_properties):
1390
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
659
1395
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
661
1397
path_keyword='object_path',
662
1398
connection_keyword='connection')
663
1399
def Introspect(self, object_path, connection):
664
"""Standard D-Bus method, overloaded to insert property tags.
1400
"""Overloading of standard D-Bus method.
1402
Inserts property tags and interface annotation tags.
666
xmlstring = dbus.service.Object.Introspect(self, object_path,
1404
xmlstring = DBusObjectWithAnnotations.Introspect(self,
669
1408
document = xml.dom.minidom.parseString(xmlstring)
670
1410
def make_tag(document, name, prop):
671
e = document.createElement(u"property")
672
e.setAttribute(u"name", name)
673
e.setAttribute(u"type", prop._dbus_signature)
674
e.setAttribute(u"access", prop._dbus_access)
1411
e = document.createElement("property")
1412
e.setAttribute("name", name)
1413
e.setAttribute("type", prop._dbus_signature)
1414
e.setAttribute("access", prop._dbus_access)
676
for if_tag in document.getElementsByTagName(u"interface"):
1417
for if_tag in document.getElementsByTagName("interface"):
677
1419
for tag in (make_tag(document, name, prop)
679
in self._get_all_dbus_properties()
1421
in self._get_all_dbus_things("property")
680
1422
if prop._dbus_interface
681
== if_tag.getAttribute(u"name")):
1423
== if_tag.getAttribute("name")):
682
1424
if_tag.appendChild(tag)
1425
# Add annotation tags for properties
1426
for tag in if_tag.getElementsByTagName("property"):
1428
for name, prop in self._get_all_dbus_things(
1430
if (name == tag.getAttribute("name")
1431
and prop._dbus_interface
1432
== if_tag.getAttribute("name")):
1433
annots.update(getattr(
1434
prop, "_dbus_annotations", {}))
1435
for name, value in annots.items():
1436
ann_tag = document.createElement(
1438
ann_tag.setAttribute("name", name)
1439
ann_tag.setAttribute("value", value)
1440
tag.appendChild(ann_tag)
683
1441
# Add the names to the return values for the
684
1442
# "org.freedesktop.DBus.Properties" methods
685
if (if_tag.getAttribute(u"name")
686
== u"org.freedesktop.DBus.Properties"):
687
for cn in if_tag.getElementsByTagName(u"method"):
688
if cn.getAttribute(u"name") == u"Get":
689
for arg in cn.getElementsByTagName(u"arg"):
690
if (arg.getAttribute(u"direction")
692
arg.setAttribute(u"name", u"value")
693
elif cn.getAttribute(u"name") == u"GetAll":
694
for arg in cn.getElementsByTagName(u"arg"):
695
if (arg.getAttribute(u"direction")
697
arg.setAttribute(u"name", u"props")
698
xmlstring = document.toxml(u"utf-8")
700
except (AttributeError, xml.dom.DOMException,
701
xml.parsers.expat.ExpatError), error:
702
logger.error(u"Failed to override Introspection method",
1443
if (if_tag.getAttribute("name")
1444
== "org.freedesktop.DBus.Properties"):
1445
for cn in if_tag.getElementsByTagName("method"):
1446
if cn.getAttribute("name") == "Get":
1447
for arg in cn.getElementsByTagName("arg"):
1448
if (arg.getAttribute("direction")
1450
arg.setAttribute("name", "value")
1451
elif cn.getAttribute("name") == "GetAll":
1452
for arg in cn.getElementsByTagName("arg"):
1453
if (arg.getAttribute("direction")
1455
arg.setAttribute("name", "props")
1456
xmlstring = document.toxml("utf-8")
1458
except (AttributeError, xml.dom.DOMException,
1459
xml.parsers.expat.ExpatError) as error:
1460
logger.error("Failed to override Introspection method",
1465
dbus.OBJECT_MANAGER_IFACE
1466
except AttributeError:
1467
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1470
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1471
"""A D-Bus object with an ObjectManager.
1473
Classes inheriting from this exposes the standard
1474
GetManagedObjects call and the InterfacesAdded and
1475
InterfacesRemoved signals on the standard
1476
"org.freedesktop.DBus.ObjectManager" interface.
1478
Note: No signals are sent automatically; they must be sent
1481
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1482
out_signature="a{oa{sa{sv}}}")
1483
def GetManagedObjects(self):
1484
"""This function must be overridden"""
1485
raise NotImplementedError()
1487
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1488
signature="oa{sa{sv}}")
1489
def InterfacesAdded(self, object_path, interfaces_and_properties):
1492
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1493
def InterfacesRemoved(self, object_path, interfaces):
1496
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1498
path_keyword='object_path',
1499
connection_keyword='connection')
1500
def Introspect(self, object_path, connection):
1501
"""Overloading of standard D-Bus method.
1503
Override return argument name of GetManagedObjects to be
1504
"objpath_interfaces_and_properties"
1506
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1510
document = xml.dom.minidom.parseString(xmlstring)
1512
for if_tag in document.getElementsByTagName("interface"):
1513
# Fix argument name for the GetManagedObjects method
1514
if (if_tag.getAttribute("name")
1515
== dbus.OBJECT_MANAGER_IFACE):
1516
for cn in if_tag.getElementsByTagName("method"):
1517
if (cn.getAttribute("name")
1518
== "GetManagedObjects"):
1519
for arg in cn.getElementsByTagName("arg"):
1520
if (arg.getAttribute("direction")
1524
"objpath_interfaces"
1526
xmlstring = document.toxml("utf-8")
1528
except (AttributeError, xml.dom.DOMException,
1529
xml.parsers.expat.ExpatError) as error:
1530
logger.error("Failed to override Introspection method",
1535
def datetime_to_dbus(dt, variant_level=0):
1536
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1538
return dbus.String("", variant_level=variant_level)
1539
return dbus.String(dt.isoformat(), variant_level=variant_level)
1542
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1543
"""A class decorator; applied to a subclass of
1544
dbus.service.Object, it will add alternate D-Bus attributes with
1545
interface names according to the "alt_interface_names" mapping.
1548
@alternate_dbus_interfaces({"org.example.Interface":
1549
"net.example.AlternateInterface"})
1550
class SampleDBusObject(dbus.service.Object):
1551
@dbus.service.method("org.example.Interface")
1552
def SampleDBusMethod():
1555
The above "SampleDBusMethod" on "SampleDBusObject" will be
1556
reachable via two interfaces: "org.example.Interface" and
1557
"net.example.AlternateInterface", the latter of which will have
1558
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1559
"true", unless "deprecate" is passed with a False value.
1561
This works for methods and signals, and also for D-Bus properties
1562
(from DBusObjectWithProperties) and interfaces (from the
1563
dbus_interface_annotations decorator).
1567
for orig_interface_name, alt_interface_name in (
1568
alt_interface_names.items()):
1570
interface_names = set()
1571
# Go though all attributes of the class
1572
for attrname, attribute in inspect.getmembers(cls):
1573
# Ignore non-D-Bus attributes, and D-Bus attributes
1574
# with the wrong interface name
1575
if (not hasattr(attribute, "_dbus_interface")
1576
or not attribute._dbus_interface.startswith(
1577
orig_interface_name)):
1579
# Create an alternate D-Bus interface name based on
1581
alt_interface = attribute._dbus_interface.replace(
1582
orig_interface_name, alt_interface_name)
1583
interface_names.add(alt_interface)
1584
# Is this a D-Bus signal?
1585
if getattr(attribute, "_dbus_is_signal", False):
1586
# Extract the original non-method undecorated
1587
# function by black magic
1588
if sys.version_info.major == 2:
1589
nonmethod_func = (dict(
1590
zip(attribute.func_code.co_freevars,
1591
attribute.__closure__))
1592
["func"].cell_contents)
1594
nonmethod_func = (dict(
1595
zip(attribute.__code__.co_freevars,
1596
attribute.__closure__))
1597
["func"].cell_contents)
1598
# Create a new, but exactly alike, function
1599
# object, and decorate it to be a new D-Bus signal
1600
# with the alternate D-Bus interface name
1601
new_function = copy_function(nonmethod_func)
1602
new_function = (dbus.service.signal(
1604
attribute._dbus_signature)(new_function))
1605
# Copy annotations, if any
1607
new_function._dbus_annotations = dict(
1608
attribute._dbus_annotations)
1609
except AttributeError:
1612
# Define a creator of a function to call both the
1613
# original and alternate functions, so both the
1614
# original and alternate signals gets sent when
1615
# the function is called
1616
def fixscope(func1, func2):
1617
"""This function is a scope container to pass
1618
func1 and func2 to the "call_both" function
1619
outside of its arguments"""
1621
@functools.wraps(func2)
1622
def call_both(*args, **kwargs):
1623
"""This function will emit two D-Bus
1624
signals by calling func1 and func2"""
1625
func1(*args, **kwargs)
1626
func2(*args, **kwargs)
1627
# Make wrapper function look like a D-Bus
1629
for name, attr in inspect.getmembers(func2):
1630
if name.startswith("_dbus_"):
1631
setattr(call_both, name, attr)
1634
# Create the "call_both" function and add it to
1636
attr[attrname] = fixscope(attribute, new_function)
1637
# Is this a D-Bus method?
1638
elif getattr(attribute, "_dbus_is_method", False):
1639
# Create a new, but exactly alike, function
1640
# object. Decorate it to be a new D-Bus method
1641
# with the alternate D-Bus interface name. Add it
1644
dbus.service.method(
1646
attribute._dbus_in_signature,
1647
attribute._dbus_out_signature)
1648
(copy_function(attribute)))
1649
# Copy annotations, if any
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1653
except AttributeError:
1655
# Is this a D-Bus property?
1656
elif getattr(attribute, "_dbus_is_property", False):
1657
# Create a new, but exactly alike, function
1658
# object, and decorate it to be a new D-Bus
1659
# property with the alternate D-Bus interface
1660
# name. Add it to the class.
1661
attr[attrname] = (dbus_service_property(
1662
alt_interface, attribute._dbus_signature,
1663
attribute._dbus_access,
1664
attribute._dbus_get_args_options
1666
(copy_function(attribute)))
1667
# Copy annotations, if any
1669
attr[attrname]._dbus_annotations = dict(
1670
attribute._dbus_annotations)
1671
except AttributeError:
1673
# Is this a D-Bus interface?
1674
elif getattr(attribute, "_dbus_is_interface", False):
1675
# Create a new, but exactly alike, function
1676
# object. Decorate it to be a new D-Bus interface
1677
# with the alternate D-Bus interface name. Add it
1680
dbus_interface_annotations(alt_interface)
1681
(copy_function(attribute)))
1683
# Deprecate all alternate interfaces
1684
iname = "_AlternateDBusNames_interface_annotation{}"
1685
for interface_name in interface_names:
1687
@dbus_interface_annotations(interface_name)
1689
return {"org.freedesktop.DBus.Deprecated":
1691
# Find an unused name
1692
for aname in (iname.format(i)
1693
for i in itertools.count()):
1694
if aname not in attr:
1698
# Replace the class with a new subclass of it with
1699
# methods, signals, etc. as created above.
1700
if sys.version_info.major == 2:
1701
cls = type(b"{}Alternate".format(cls.__name__),
1704
cls = type("{}Alternate".format(cls.__name__),
1711
@alternate_dbus_interfaces({"se.recompile.Mandos":
1712
"se.bsnet.fukt.Mandos"})
707
1713
class ClientDBus(Client, DBusObjectWithProperties):
708
1714
"""A Client class using D-Bus
711
1717
dbus_object_path: dbus.ObjectPath
712
1718
bus: dbus.SystemBus()
715
1721
runtime_expansions = (Client.runtime_expansions
716
+ (u"dbus_object_path",))
1722
+ ("dbus_object_path", ))
1724
_interface = "se.recompile.Mandos.Client"
718
1726
# dbus.service.Object doesn't use super(), so we can't either.
720
def __init__(self, bus = None, *args, **kwargs):
721
self._approvals_pending = 0
1728
def __init__(self, bus=None, *args, **kwargs):
723
1730
Client.__init__(self, *args, **kwargs)
724
1731
# Only now, when this client is initialized, can it show up on
726
client_object_name = unicode(self.name).translate(
727
{ord(u"."): ord(u"_"),
728
ord(u"-"): ord(u"_")})
729
self.dbus_object_path = (dbus.ObjectPath
730
(u"/clients/" + client_object_name))
1733
client_object_name = str(self.name).translate(
1734
{ord("."): ord("_"),
1735
ord("-"): ord("_")})
1736
self.dbus_object_path = dbus.ObjectPath(
1737
"/clients/" + client_object_name)
731
1738
DBusObjectWithProperties.__init__(self, self.bus,
732
1739
self.dbus_object_path)
734
def _get_approvals_pending(self):
735
return self._approvals_pending
736
def _set_approvals_pending(self, value):
737
old_value = self._approvals_pending
738
self._approvals_pending = value
740
if (hasattr(self, "dbus_object_path")
741
and bval is not bool(old_value)):
742
dbus_bool = dbus.Boolean(bval, variant_level=1)
743
self.PropertyChanged(dbus.String(u"ApprovalPending"),
746
approvals_pending = property(_get_approvals_pending,
747
_set_approvals_pending)
748
del _get_approvals_pending, _set_approvals_pending
751
def _datetime_to_dbus(dt, variant_level=0):
752
"""Convert a UTC datetime.datetime() to a D-Bus type."""
753
return dbus.String(dt.isoformat(),
754
variant_level=variant_level)
757
oldstate = getattr(self, u"enabled", False)
758
r = Client.enable(self)
759
if oldstate != self.enabled:
761
self.PropertyChanged(dbus.String(u"Enabled"),
762
dbus.Boolean(True, variant_level=1))
763
self.PropertyChanged(
764
dbus.String(u"LastEnabled"),
765
self._datetime_to_dbus(self.last_enabled,
769
def disable(self, quiet = False):
770
oldstate = getattr(self, u"enabled", False)
771
r = Client.disable(self, quiet=quiet)
772
if not quiet and oldstate != self.enabled:
774
self.PropertyChanged(dbus.String(u"Enabled"),
775
dbus.Boolean(False, variant_level=1))
1741
def notifychangeproperty(transform_func, dbus_name,
1742
type_func=lambda x: x,
1744
invalidate_only=False,
1745
_interface=_interface):
1746
""" Modify a variable so that it's a property which announces
1747
its changes to DBus.
1749
transform_fun: Function that takes a value and a variant_level
1750
and transforms it to a D-Bus type.
1751
dbus_name: D-Bus name of the variable
1752
type_func: Function that transform the value before sending it
1753
to the D-Bus. Default: no transform
1754
variant_level: D-Bus variant level. Default: 1
1756
attrname = "_{}".format(dbus_name)
1758
def setter(self, value):
1759
if hasattr(self, "dbus_object_path"):
1760
if (not hasattr(self, attrname) or
1761
type_func(getattr(self, attrname, None))
1762
!= type_func(value)):
1764
self.PropertiesChanged(
1765
_interface, dbus.Dictionary(),
1766
dbus.Array((dbus_name, )))
1768
dbus_value = transform_func(
1770
variant_level=variant_level)
1771
self.PropertyChanged(dbus.String(dbus_name),
1773
self.PropertiesChanged(
1775
dbus.Dictionary({dbus.String(dbus_name):
1778
setattr(self, attrname, value)
1780
return property(lambda self: getattr(self, attrname), setter)
1782
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1783
approvals_pending = notifychangeproperty(dbus.Boolean,
1786
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1787
last_enabled = notifychangeproperty(datetime_to_dbus,
1789
checker = notifychangeproperty(
1790
dbus.Boolean, "CheckerRunning",
1791
type_func=lambda checker: checker is not None)
1792
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1794
last_checker_status = notifychangeproperty(dbus.Int16,
1795
"LastCheckerStatus")
1796
last_approval_request = notifychangeproperty(
1797
datetime_to_dbus, "LastApprovalRequest")
1798
approved_by_default = notifychangeproperty(dbus.Boolean,
1799
"ApprovedByDefault")
1800
approval_delay = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDelay",
1802
type_func=lambda td: td.total_seconds() * 1000)
1803
approval_duration = notifychangeproperty(
1804
dbus.UInt64, "ApprovalDuration",
1805
type_func=lambda td: td.total_seconds() * 1000)
1806
host = notifychangeproperty(dbus.String, "Host")
1807
timeout = notifychangeproperty(
1808
dbus.UInt64, "Timeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
1810
extended_timeout = notifychangeproperty(
1811
dbus.UInt64, "ExtendedTimeout",
1812
type_func=lambda td: td.total_seconds() * 1000)
1813
interval = notifychangeproperty(
1814
dbus.UInt64, "Interval",
1815
type_func=lambda td: td.total_seconds() * 1000)
1816
checker_command = notifychangeproperty(dbus.String, "Checker")
1817
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1818
invalidate_only=True)
1820
del notifychangeproperty
778
1822
def __del__(self, *args, **kwargs):
780
1824
self.remove_from_connection()
781
1825
except LookupError:
783
if hasattr(DBusObjectWithProperties, u"__del__"):
1827
if hasattr(DBusObjectWithProperties, "__del__"):
784
1828
DBusObjectWithProperties.__del__(self, *args, **kwargs)
785
1829
Client.__del__(self, *args, **kwargs)
787
def checker_callback(self, pid, condition, command,
789
self.checker_callback_tag = None
792
self.PropertyChanged(dbus.String(u"CheckerRunning"),
793
dbus.Boolean(False, variant_level=1))
794
if os.WIFEXITED(condition):
795
exitstatus = os.WEXITSTATUS(condition)
1831
def checker_callback(self, source, condition,
1832
connection, command, *args, **kwargs):
1833
ret = Client.checker_callback(self, source, condition,
1834
connection, command, *args,
1836
exitstatus = self.last_checker_status
796
1838
# Emit D-Bus signal
797
1839
self.CheckerCompleted(dbus.Int16(exitstatus),
798
dbus.Int64(condition),
1840
# This is specific to GNU libC
1841
dbus.Int64(exitstatus << 8),
799
1842
dbus.String(command))
801
1844
# Emit D-Bus signal
802
1845
self.CheckerCompleted(dbus.Int16(-1),
803
dbus.Int64(condition),
1847
# This is specific to GNU libC
1849
| self.last_checker_signal),
804
1850
dbus.String(command))
806
return Client.checker_callback(self, pid, condition, command,
809
def checked_ok(self, *args, **kwargs):
810
r = Client.checked_ok(self, *args, **kwargs)
812
self.PropertyChanged(
813
dbus.String(u"LastCheckedOK"),
814
(self._datetime_to_dbus(self.last_checked_ok,
818
1853
def start_checker(self, *args, **kwargs):
819
old_checker = self.checker
820
if self.checker is not None:
821
old_checker_pid = self.checker.pid
823
old_checker_pid = None
1854
old_checker_pid = getattr(self.checker, "pid", None)
824
1855
r = Client.start_checker(self, *args, **kwargs)
825
1856
# Only if new checker process was started
826
1857
if (self.checker is not None
827
1858
and old_checker_pid != self.checker.pid):
828
1859
# Emit D-Bus signal
829
1860
self.CheckerStarted(self.current_checker_command)
830
self.PropertyChanged(
831
dbus.String(u"CheckerRunning"),
832
dbus.Boolean(True, variant_level=1))
835
def stop_checker(self, *args, **kwargs):
836
old_checker = getattr(self, u"checker", None)
837
r = Client.stop_checker(self, *args, **kwargs)
838
if (old_checker is not None
839
and getattr(self, u"checker", None) is None):
840
self.PropertyChanged(dbus.String(u"CheckerRunning"),
841
dbus.Boolean(False, variant_level=1))
844
1863
def _reset_approved(self):
845
self._approved = None
1864
self.approved = None
848
1867
def approve(self, value=True):
1868
self.approved = value
1869
GLib.timeout_add(int(self.approval_duration.total_seconds()
1870
* 1000), self._reset_approved)
849
1871
self.send_changedstate()
850
self._approved = value
851
gobject.timeout_add(self._timedelta_to_milliseconds
852
(self.approval_duration),
853
self._reset_approved)
856
## D-Bus methods, signals & properties
857
_interface = u"se.bsnet.fukt.Mandos.Client"
1873
# D-Bus methods, signals & properties
861
1879
# CheckerCompleted - signal
862
@dbus.service.signal(_interface, signature=u"nxs")
1880
@dbus.service.signal(_interface, signature="nxs")
863
1881
def CheckerCompleted(self, exitcode, waitstatus, command):
867
1885
# CheckerStarted - signal
868
@dbus.service.signal(_interface, signature=u"s")
1886
@dbus.service.signal(_interface, signature="s")
869
1887
def CheckerStarted(self, command):
873
1891
# PropertyChanged - signal
874
@dbus.service.signal(_interface, signature=u"sv")
1892
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1893
@dbus.service.signal(_interface, signature="sv")
875
1894
def PropertyChanged(self, property, value):
879
1898
# GotSecret - signal
880
1899
@dbus.service.signal(_interface)
881
1900
def GotSecret(self):
1265
2304
delay -= time2 - time
1268
while sent_size < len(client.secret):
1270
sent = session.send(client.secret[sent_size:])
1271
except (gnutls.errors.GNUTLSError), error:
1272
logger.warning("gnutls send failed")
1274
logger.debug(u"Sent: %d, remaining: %d",
1275
sent, len(client.secret)
1276
- (sent_size + sent))
1279
logger.info(u"Sending secret to %s", client.name)
1280
# bump the timeout as if seen
2307
session.send(client.secret)
2308
except gnutls.Error as error:
2309
logger.warning("gnutls send failed",
2313
logger.info("Sending secret to %s", client.name)
2314
# bump the timeout using extended_timeout
2315
client.bump_timeout(client.extended_timeout)
1282
2316
if self.server.use_dbus:
1283
2317
# Emit D-Bus signal
1284
2318
client.GotSecret()
1287
2321
if approval_required:
1288
2322
client.approvals_pending -= 1
1291
except (gnutls.errors.GNUTLSError), error:
1292
logger.warning("GnuTLS bye failed")
2325
except gnutls.Error as error:
2326
logger.warning("GnuTLS bye failed",
1295
2330
def peer_certificate(session):
1296
2331
"Return the peer's OpenPGP certificate as a bytestring"
1297
2332
# If not an OpenPGP certificate...
1298
if (gnutls.library.functions
1299
.gnutls_certificate_type_get(session._c_object)
1300
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1301
# ...do the normal thing
1302
return session.peer_certificate
2333
if (gnutls.certificate_type_get(session._c_object)
2334
!= gnutls.CRT_OPENPGP):
2335
# ...return invalid data
1303
2337
list_size = ctypes.c_uint(1)
1304
cert_list = (gnutls.library.functions
1305
.gnutls_certificate_get_peers
2338
cert_list = (gnutls.certificate_get_peers
1306
2339
(session._c_object, ctypes.byref(list_size)))
1307
2340
if not bool(cert_list) and list_size.value != 0:
1308
raise gnutls.errors.GNUTLSError(u"error getting peer"
2341
raise gnutls.Error("error getting peer certificate")
1310
2342
if list_size.value == 0:
1312
2344
cert = cert_list[0]
1313
2345
return ctypes.string_at(cert.data, cert.size)
1316
2348
def fingerprint(openpgp):
1317
2349
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1318
2350
# New GnuTLS "datum" with the OpenPGP public key
1319
datum = (gnutls.library.types
1320
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1323
ctypes.c_uint(len(openpgp))))
2351
datum = gnutls.datum_t(
2352
ctypes.cast(ctypes.c_char_p(openpgp),
2353
ctypes.POINTER(ctypes.c_ubyte)),
2354
ctypes.c_uint(len(openpgp)))
1324
2355
# New empty GnuTLS certificate
1325
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1326
(gnutls.library.functions
1327
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2356
crt = gnutls.openpgp_crt_t()
2357
gnutls.openpgp_crt_init(ctypes.byref(crt))
1328
2358
# Import the OpenPGP public key into the certificate
1329
(gnutls.library.functions
1330
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1331
gnutls.library.constants
1332
.GNUTLS_OPENPGP_FMT_RAW))
2359
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2360
gnutls.OPENPGP_FMT_RAW)
1333
2361
# Verify the self signature in the key
1334
2362
crtverify = ctypes.c_uint()
1335
(gnutls.library.functions
1336
.gnutls_openpgp_crt_verify_self(crt, 0,
1337
ctypes.byref(crtverify)))
2363
gnutls.openpgp_crt_verify_self(crt, 0,
2364
ctypes.byref(crtverify))
1338
2365
if crtverify.value != 0:
1339
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1340
raise (gnutls.errors.CertificateSecurityError
2366
gnutls.openpgp_crt_deinit(crt)
2367
raise gnutls.CertificateSecurityError("Verify failed")
1342
2368
# New buffer for the fingerprint
1343
2369
buf = ctypes.create_string_buffer(20)
1344
2370
buf_len = ctypes.c_size_t()
1345
2371
# Get the fingerprint from the certificate into the buffer
1346
(gnutls.library.functions
1347
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1348
ctypes.byref(buf_len)))
2372
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2373
ctypes.byref(buf_len))
1349
2374
# Deinit the certificate
1350
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2375
gnutls.openpgp_crt_deinit(crt)
1351
2376
# Convert the buffer to a Python bytestring
1352
2377
fpr = ctypes.string_at(buf, buf_len.value)
1353
2378
# Convert the bytestring to hexadecimal notation
1354
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2379
hex_fpr = binascii.hexlify(fpr).upper()
1358
2383
class MultiprocessingMixIn(object):
1359
2384
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1360
2386
def sub_process_main(self, request, address):
1362
2388
self.finish_request(request, address)
1364
2390
self.handle_error(request, address)
1365
2391
self.close_request(request)
1367
2393
def process_request(self, request, address):
1368
2394
"""Start a new process to process the request."""
1369
multiprocessing.Process(target = self.sub_process_main,
1370
args = (request, address)).start()
2395
proc = multiprocessing.Process(target=self.sub_process_main,
2396
args=(request, address))
1372
2401
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1373
2402
""" adds a pipe to the MixIn """
1374
2404
def process_request(self, request, client_address):
1375
2405
"""Overrides and wraps the original process_request().
1377
2407
This function creates a new pipe in self.pipe
1379
2409
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1381
super(MultiprocessingMixInWithPipe,
1382
self).process_request(request, client_address)
2411
proc = MultiprocessingMixIn.process_request(self, request,
1383
2413
self.child_pipe.close()
1384
self.add_pipe(parent_pipe)
2414
self.add_pipe(parent_pipe, proc)
1386
def add_pipe(self, parent_pipe):
2416
def add_pipe(self, parent_pipe, proc):
1387
2417
"""Dummy function; override as necessary"""
2418
raise NotImplementedError()
1390
2421
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1391
2422
socketserver.TCPServer, object):
1392
2423
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1395
2426
enabled: Boolean; whether this server is activated yet
1396
2427
interface: None or a network interface name (string)
1397
2428
use_ipv6: Boolean; to use IPv6 or not
1399
2431
def __init__(self, server_address, RequestHandlerClass,
1400
interface=None, use_ipv6=True):
2435
"""If socketfd is set, use that file descriptor instead of
2436
creating a new one with socket.socket().
1401
2438
self.interface = interface
1403
2440
self.address_family = socket.AF_INET6
2441
if socketfd is not None:
2442
# Save the file descriptor
2443
self.socketfd = socketfd
2444
# Save the original socket.socket() function
2445
self.socket_socket = socket.socket
2447
# To implement --socket, we monkey patch socket.socket.
2449
# (When socketserver.TCPServer is a new-style class, we
2450
# could make self.socket into a property instead of monkey
2451
# patching socket.socket.)
2453
# Create a one-time-only replacement for socket.socket()
2454
@functools.wraps(socket.socket)
2455
def socket_wrapper(*args, **kwargs):
2456
# Restore original function so subsequent calls are
2458
socket.socket = self.socket_socket
2459
del self.socket_socket
2460
# This time only, return a new socket object from the
2461
# saved file descriptor.
2462
return socket.fromfd(self.socketfd, *args, **kwargs)
2463
# Replace socket.socket() function with wrapper
2464
socket.socket = socket_wrapper
2465
# The socketserver.TCPServer.__init__ will call
2466
# socket.socket(), which might be our replacement,
2467
# socket_wrapper(), if socketfd was set.
1404
2468
socketserver.TCPServer.__init__(self, server_address,
1405
2469
RequestHandlerClass)
1406
2471
def server_bind(self):
1407
2472
"""This overrides the normal server_bind() function
1408
2473
to bind to an interface if one was specified, and also NOT to
1409
2474
bind to an address or port if they were not specified."""
2475
global SO_BINDTODEVICE
1410
2476
if self.interface is not None:
1411
2477
if SO_BINDTODEVICE is None:
1412
logger.error(u"SO_BINDTODEVICE does not exist;"
1413
u" cannot bind to interface %s",
1417
self.socket.setsockopt(socket.SOL_SOCKET,
1421
except socket.error, error:
1422
if error[0] == errno.EPERM:
1423
logger.error(u"No permission to"
1424
u" bind to interface %s",
1426
elif error[0] == errno.ENOPROTOOPT:
1427
logger.error(u"SO_BINDTODEVICE not available;"
1428
u" cannot bind to interface %s",
2478
# Fall back to a hard-coded value which seems to be
2480
logger.warning("SO_BINDTODEVICE not found, trying 25")
2481
SO_BINDTODEVICE = 25
2483
self.socket.setsockopt(
2484
socket.SOL_SOCKET, SO_BINDTODEVICE,
2485
(self.interface + "\0").encode("utf-8"))
2486
except socket.error as error:
2487
if error.errno == errno.EPERM:
2488
logger.error("No permission to bind to"
2489
" interface %s", self.interface)
2490
elif error.errno == errno.ENOPROTOOPT:
2491
logger.error("SO_BINDTODEVICE not available;"
2492
" cannot bind to interface %s",
2494
elif error.errno == errno.ENODEV:
2495
logger.error("Interface %s does not exist,"
2496
" cannot bind", self.interface)
1432
2499
# Only bind(2) the socket if we really need to.
1433
2500
if self.server_address[0] or self.server_address[1]:
1434
2501
if not self.server_address[0]:
1435
2502
if self.address_family == socket.AF_INET6:
1436
any_address = u"::" # in6addr_any
2503
any_address = "::" # in6addr_any
1438
any_address = socket.INADDR_ANY
2505
any_address = "0.0.0.0" # INADDR_ANY
1439
2506
self.server_address = (any_address,
1440
2507
self.server_address[1])
1441
2508
elif not self.server_address[1]:
1442
self.server_address = (self.server_address[0],
2509
self.server_address = (self.server_address[0], 0)
1444
2510
# if self.interface:
1445
2511
# self.server_address = (self.server_address[0],
2634
def rfc3339_duration_to_delta(duration):
2635
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2637
>>> rfc3339_duration_to_delta("P7D")
2638
datetime.timedelta(7)
2639
>>> rfc3339_duration_to_delta("PT60S")
2640
datetime.timedelta(0, 60)
2641
>>> rfc3339_duration_to_delta("PT60M")
2642
datetime.timedelta(0, 3600)
2643
>>> rfc3339_duration_to_delta("PT24H")
2644
datetime.timedelta(1)
2645
>>> rfc3339_duration_to_delta("P1W")
2646
datetime.timedelta(7)
2647
>>> rfc3339_duration_to_delta("PT5M30S")
2648
datetime.timedelta(0, 330)
2649
>>> rfc3339_duration_to_delta("P1DT3M20S")
2650
datetime.timedelta(1, 200)
2653
# Parsing an RFC 3339 duration with regular expressions is not
2654
# possible - there would have to be multiple places for the same
2655
# values, like seconds. The current code, while more esoteric, is
2656
# cleaner without depending on a parsing library. If Python had a
2657
# built-in library for parsing we would use it, but we'd like to
2658
# avoid excessive use of external libraries.
2660
# New type for defining tokens, syntax, and semantics all-in-one
2661
Token = collections.namedtuple("Token", (
2662
"regexp", # To match token; if "value" is not None, must have
2663
# a "group" containing digits
2664
"value", # datetime.timedelta or None
2665
"followers")) # Tokens valid after this token
2666
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2667
# the "duration" ABNF definition in RFC 3339, Appendix A.
2668
token_end = Token(re.compile(r"$"), None, frozenset())
2669
token_second = Token(re.compile(r"(\d+)S"),
2670
datetime.timedelta(seconds=1),
2671
frozenset((token_end, )))
2672
token_minute = Token(re.compile(r"(\d+)M"),
2673
datetime.timedelta(minutes=1),
2674
frozenset((token_second, token_end)))
2675
token_hour = Token(re.compile(r"(\d+)H"),
2676
datetime.timedelta(hours=1),
2677
frozenset((token_minute, token_end)))
2678
token_time = Token(re.compile(r"T"),
2680
frozenset((token_hour, token_minute,
2682
token_day = Token(re.compile(r"(\d+)D"),
2683
datetime.timedelta(days=1),
2684
frozenset((token_time, token_end)))
2685
token_month = Token(re.compile(r"(\d+)M"),
2686
datetime.timedelta(weeks=4),
2687
frozenset((token_day, token_end)))
2688
token_year = Token(re.compile(r"(\d+)Y"),
2689
datetime.timedelta(weeks=52),
2690
frozenset((token_month, token_end)))
2691
token_week = Token(re.compile(r"(\d+)W"),
2692
datetime.timedelta(weeks=1),
2693
frozenset((token_end, )))
2694
token_duration = Token(re.compile(r"P"), None,
2695
frozenset((token_year, token_month,
2696
token_day, token_time,
2698
# Define starting values:
2700
value = datetime.timedelta()
2702
# Following valid tokens
2703
followers = frozenset((token_duration, ))
2704
# String left to parse
2706
# Loop until end token is found
2707
while found_token is not token_end:
2708
# Search for any currently valid tokens
2709
for token in followers:
2710
match = token.regexp.match(s)
2711
if match is not None:
2713
if token.value is not None:
2714
# Value found, parse digits
2715
factor = int(match.group(1), 10)
2716
# Add to value so far
2717
value += factor * token.value
2718
# Strip token from string
2719
s = token.regexp.sub("", s, 1)
2722
# Set valid next tokens
2723
followers = found_token.followers
2726
# No currently valid tokens were found
2727
raise ValueError("Invalid RFC 3339 duration: {!r}"
1559
2733
def string_to_delta(interval):
1560
2734
"""Parse a string and return a datetime.timedelta
1562
>>> string_to_delta(u'7d')
2736
>>> string_to_delta('7d')
1563
2737
datetime.timedelta(7)
1564
>>> string_to_delta(u'60s')
2738
>>> string_to_delta('60s')
1565
2739
datetime.timedelta(0, 60)
1566
>>> string_to_delta(u'60m')
2740
>>> string_to_delta('60m')
1567
2741
datetime.timedelta(0, 3600)
1568
>>> string_to_delta(u'24h')
2742
>>> string_to_delta('24h')
1569
2743
datetime.timedelta(1)
1570
>>> string_to_delta(u'1w')
2744
>>> string_to_delta('1w')
1571
2745
datetime.timedelta(7)
1572
>>> string_to_delta(u'5m 30s')
2746
>>> string_to_delta('5m 30s')
1573
2747
datetime.timedelta(0, 330)
2751
return rfc3339_duration_to_delta(interval)
1575
2755
timevalue = datetime.timedelta(0)
1576
2756
for s in interval.split():
1578
suffix = unicode(s[-1])
1579
2759
value = int(s[:-1])
1581
2761
delta = datetime.timedelta(value)
1582
elif suffix == u"s":
1583
2763
delta = datetime.timedelta(0, value)
1584
elif suffix == u"m":
1585
2765
delta = datetime.timedelta(0, 0, 0, 0, value)
1586
elif suffix == u"h":
1587
2767
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1588
elif suffix == u"w":
1589
2769
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1591
raise ValueError(u"Unknown suffix %r" % suffix)
1592
except (ValueError, IndexError), e:
1593
raise ValueError(e.message)
2771
raise ValueError("Unknown suffix {!r}".format(suffix))
2772
except IndexError as e:
2773
raise ValueError(*(e.args))
1594
2774
timevalue += delta
1595
2775
return timevalue
1598
def if_nametoindex(interface):
1599
"""Call the C function if_nametoindex(), or equivalent
1601
Note: This function cannot accept a unicode string."""
1602
global if_nametoindex
1604
if_nametoindex = (ctypes.cdll.LoadLibrary
1605
(ctypes.util.find_library(u"c"))
1607
except (OSError, AttributeError):
1608
logger.warning(u"Doing if_nametoindex the hard way")
1609
def if_nametoindex(interface):
1610
"Get an interface index the hard way, i.e. using fcntl()"
1611
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1612
with contextlib.closing(socket.socket()) as s:
1613
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1614
struct.pack(str(u"16s16x"),
1616
interface_index = struct.unpack(str(u"I"),
1618
return interface_index
1619
return if_nametoindex(interface)
1622
def daemon(nochdir = False, noclose = False):
2778
def daemon(nochdir=False, noclose=False):
1623
2779
"""See daemon(3). Standard BSD Unix function.
1625
2781
This should really exist as os.daemon, but it doesn't (yet)."""
1629
2785
if not nochdir:
1633
2789
if not noclose:
1634
2790
# Close all standard open file descriptors
1635
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2791
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1636
2792
if not stat.S_ISCHR(os.fstat(null).st_mode):
1637
2793
raise OSError(errno.ENODEV,
1638
u"%s not a character device"
2794
"{} not a character device"
2795
.format(os.devnull))
1640
2796
os.dup2(null, sys.stdin.fileno())
1641
2797
os.dup2(null, sys.stdout.fileno())
1642
2798
os.dup2(null, sys.stderr.fileno())
1649
2805
##################################################################
1650
2806
# Parsing of options, both command line and config file
1652
parser = optparse.OptionParser(version = "%%prog %s" % version)
1653
parser.add_option("-i", u"--interface", type=u"string",
1654
metavar="IF", help=u"Bind to interface IF")
1655
parser.add_option("-a", u"--address", type=u"string",
1656
help=u"Address to listen for requests on")
1657
parser.add_option("-p", u"--port", type=u"int",
1658
help=u"Port number to receive requests on")
1659
parser.add_option("--check", action=u"store_true",
1660
help=u"Run self-test")
1661
parser.add_option("--debug", action=u"store_true",
1662
help=u"Debug mode; run in foreground and log to"
1664
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1665
help=u"Debug level for stdout output")
1666
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1667
u" priority string (see GnuTLS documentation)")
1668
parser.add_option("--servicename", type=u"string",
1669
metavar=u"NAME", help=u"Zeroconf service name")
1670
parser.add_option("--configdir", type=u"string",
1671
default=u"/etc/mandos", metavar=u"DIR",
1672
help=u"Directory to search for configuration"
1674
parser.add_option("--no-dbus", action=u"store_false",
1675
dest=u"use_dbus", help=u"Do not provide D-Bus"
1676
u" system bus interface")
1677
parser.add_option("--no-ipv6", action=u"store_false",
1678
dest=u"use_ipv6", help=u"Do not use IPv6")
1679
options = parser.parse_args()[0]
2808
parser = argparse.ArgumentParser()
2809
parser.add_argument("-v", "--version", action="version",
2810
version="%(prog)s {}".format(version),
2811
help="show version number and exit")
2812
parser.add_argument("-i", "--interface", metavar="IF",
2813
help="Bind to interface IF")
2814
parser.add_argument("-a", "--address",
2815
help="Address to listen for requests on")
2816
parser.add_argument("-p", "--port", type=int,
2817
help="Port number to receive requests on")
2818
parser.add_argument("--check", action="store_true",
2819
help="Run self-test")
2820
parser.add_argument("--debug", action="store_true",
2821
help="Debug mode; run in foreground and log"
2822
" to terminal", default=None)
2823
parser.add_argument("--debuglevel", metavar="LEVEL",
2824
help="Debug level for stdout output")
2825
parser.add_argument("--priority", help="GnuTLS"
2826
" priority string (see GnuTLS documentation)")
2827
parser.add_argument("--servicename",
2828
metavar="NAME", help="Zeroconf service name")
2829
parser.add_argument("--configdir",
2830
default="/etc/mandos", metavar="DIR",
2831
help="Directory to search for configuration"
2833
parser.add_argument("--no-dbus", action="store_false",
2834
dest="use_dbus", help="Do not provide D-Bus"
2835
" system bus interface", default=None)
2836
parser.add_argument("--no-ipv6", action="store_false",
2837
dest="use_ipv6", help="Do not use IPv6",
2839
parser.add_argument("--no-restore", action="store_false",
2840
dest="restore", help="Do not restore stored"
2841
" state", default=None)
2842
parser.add_argument("--socket", type=int,
2843
help="Specify a file descriptor to a network"
2844
" socket to use instead of creating one")
2845
parser.add_argument("--statedir", metavar="DIR",
2846
help="Directory to save/restore state in")
2847
parser.add_argument("--foreground", action="store_true",
2848
help="Run in foreground", default=None)
2849
parser.add_argument("--no-zeroconf", action="store_false",
2850
dest="zeroconf", help="Do not use Zeroconf",
2853
options = parser.parse_args()
1681
2855
if options.check:
2857
fail_count, test_count = doctest.testmod()
2858
sys.exit(os.EX_OK if fail_count == 0 else 1)
1686
2860
# Default values for config file for server-global settings
1687
server_defaults = { u"interface": u"",
1692
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1693
u"servicename": u"Mandos",
1694
u"use_dbus": u"True",
1695
u"use_ipv6": u"True",
2861
server_defaults = {"interface": "",
2866
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2867
":+SIGN-DSA-SHA256",
2868
"servicename": "Mandos",
2874
"statedir": "/var/lib/mandos",
2875
"foreground": "False",
1699
2879
# Parse config file for server-global settings
1700
2880
server_config = configparser.SafeConfigParser(server_defaults)
1701
2881
del server_defaults
1702
server_config.read(os.path.join(options.configdir,
2882
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1704
2883
# Convert the SafeConfigParser object to a dict
1705
2884
server_settings = server_config.defaults()
1706
2885
# Use the appropriate methods on the non-string config options
1707
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1708
server_settings[option] = server_config.getboolean(u"DEFAULT",
2886
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2887
server_settings[option] = server_config.getboolean("DEFAULT",
1710
2889
if server_settings["port"]:
1711
server_settings["port"] = server_config.getint(u"DEFAULT",
2890
server_settings["port"] = server_config.getint("DEFAULT",
2892
if server_settings["socket"]:
2893
server_settings["socket"] = server_config.getint("DEFAULT",
2895
# Later, stdin will, and stdout and stderr might, be dup'ed
2896
# over with an opened os.devnull. But we don't want this to
2897
# happen with a supplied network socket.
2898
if 0 <= server_settings["socket"] <= 2:
2899
server_settings["socket"] = os.dup(server_settings
1713
2901
del server_config
1715
2903
# Override the settings from the config file with command line
1716
2904
# options, if set.
1717
for option in (u"interface", u"address", u"port", u"debug",
1718
u"priority", u"servicename", u"configdir",
1719
u"use_dbus", u"use_ipv6", u"debuglevel"):
2905
for option in ("interface", "address", "port", "debug",
2906
"priority", "servicename", "configdir", "use_dbus",
2907
"use_ipv6", "debuglevel", "restore", "statedir",
2908
"socket", "foreground", "zeroconf"):
1720
2909
value = getattr(options, option)
1721
2910
if value is not None:
1722
2911
server_settings[option] = value
1724
2913
# Force all strings to be unicode
1725
2914
for option in server_settings.keys():
1726
if type(server_settings[option]) is str:
1727
server_settings[option] = unicode(server_settings[option])
2915
if isinstance(server_settings[option], bytes):
2916
server_settings[option] = (server_settings[option]
2918
# Force all boolean options to be boolean
2919
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2920
"foreground", "zeroconf"):
2921
server_settings[option] = bool(server_settings[option])
2922
# Debug implies foreground
2923
if server_settings["debug"]:
2924
server_settings["foreground"] = True
1728
2925
# Now we have our good server settings in "server_settings"
1730
2927
##################################################################
2929
if (not server_settings["zeroconf"]
2930
and not (server_settings["port"]
2931
or server_settings["socket"] != "")):
2932
parser.error("Needs port or socket to work without Zeroconf")
1732
2934
# For convenience
1733
debug = server_settings[u"debug"]
1734
debuglevel = server_settings[u"debuglevel"]
1735
use_dbus = server_settings[u"use_dbus"]
1736
use_ipv6 = server_settings[u"use_ipv6"]
1738
if server_settings[u"servicename"] != u"Mandos":
1739
syslogger.setFormatter(logging.Formatter
1740
(u'Mandos (%s) [%%(process)d]:'
1741
u' %%(levelname)s: %%(message)s'
1742
% server_settings[u"servicename"]))
2935
debug = server_settings["debug"]
2936
debuglevel = server_settings["debuglevel"]
2937
use_dbus = server_settings["use_dbus"]
2938
use_ipv6 = server_settings["use_ipv6"]
2939
stored_state_path = os.path.join(server_settings["statedir"],
2941
foreground = server_settings["foreground"]
2942
zeroconf = server_settings["zeroconf"]
2945
initlogger(debug, logging.DEBUG)
2950
level = getattr(logging, debuglevel.upper())
2951
initlogger(debug, level)
2953
if server_settings["servicename"] != "Mandos":
2954
syslogger.setFormatter(
2955
logging.Formatter('Mandos ({}) [%(process)d]:'
2956
' %(levelname)s: %(message)s'.format(
2957
server_settings["servicename"])))
1744
2959
# Parse config file with clients
1745
client_defaults = { u"timeout": u"1h",
1747
u"checker": u"fping -q -- %%(host)s",
1749
u"approval_delay": u"0s",
1750
u"approval_duration": u"1s",
1752
client_config = configparser.SafeConfigParser(client_defaults)
1753
client_config.read(os.path.join(server_settings[u"configdir"],
2960
client_config = configparser.SafeConfigParser(Client
2962
client_config.read(os.path.join(server_settings["configdir"],
1756
2965
global mandos_dbus_service
1757
2966
mandos_dbus_service = None
1759
tcp_server = MandosServer((server_settings[u"address"],
1760
server_settings[u"port"]),
1762
interface=(server_settings[u"interface"]
1766
server_settings[u"priority"],
1769
pidfilename = u"/var/run/mandos.pid"
1771
pidfile = open(pidfilename, u"w")
1773
logger.error(u"Could not open file %r", pidfilename)
1776
uid = pwd.getpwnam(u"_mandos").pw_uid
1777
gid = pwd.getpwnam(u"_mandos").pw_gid
1780
uid = pwd.getpwnam(u"mandos").pw_uid
1781
gid = pwd.getpwnam(u"mandos").pw_gid
2969
if server_settings["socket"] != "":
2970
socketfd = server_settings["socket"]
2971
tcp_server = MandosServer(
2972
(server_settings["address"], server_settings["port"]),
2974
interface=(server_settings["interface"] or None),
2976
gnutls_priority=server_settings["priority"],
2980
pidfilename = "/run/mandos.pid"
2981
if not os.path.isdir("/run/."):
2982
pidfilename = "/var/run/mandos.pid"
2985
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2986
except IOError as e:
2987
logger.error("Could not open file %r", pidfilename,
2990
for name, group in (("_mandos", "_mandos"),
2991
("mandos", "mandos"),
2992
("nobody", "nogroup")):
2994
uid = pwd.getpwnam(name).pw_uid
2995
gid = pwd.getpwnam(group).pw_gid
1782
2997
except KeyError:
1784
uid = pwd.getpwnam(u"nobody").pw_uid
1785
gid = pwd.getpwnam(u"nobody").pw_gid
1792
except OSError, error:
1793
if error[0] != errno.EPERM:
1796
if not debug and not debuglevel:
1797
syslogger.setLevel(logging.WARNING)
1798
console.setLevel(logging.WARNING)
1800
level = getattr(logging, debuglevel.upper())
1801
syslogger.setLevel(level)
1802
console.setLevel(level)
3006
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3008
except OSError as error:
3009
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3010
.format(uid, gid, os.strerror(error.errno)))
3011
if error.errno != errno.EPERM:
1805
3015
# Enable all possible GnuTLS debugging
1807
3017
# "Use a log level over 10 to enable all debugging options."
1808
3018
# - GnuTLS manual
1809
gnutls.library.functions.gnutls_global_set_log_level(11)
1811
@gnutls.library.types.gnutls_log_func
3019
gnutls.global_set_log_level(11)
1812
3022
def debug_gnutls(level, string):
1813
logger.debug(u"GnuTLS: %s", string[:-1])
1815
(gnutls.library.functions
1816
.gnutls_global_set_log_function(debug_gnutls))
3023
logger.debug("GnuTLS: %s", string[:-1])
3025
gnutls.global_set_log_function(debug_gnutls)
1818
3027
# Redirect stdin so all checkers get /dev/null
1819
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3028
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1820
3029
os.dup2(null, sys.stdin.fileno())
1824
# No console logging
1825
logger.removeHandler(console)
3033
# Need to fork before connecting to D-Bus
3035
# Close all input and output, do double fork, etc.
3038
# multiprocessing will use threads, so before we use GLib we need
3039
# to inform GLib that threads will be used.
1828
3042
global main_loop
1829
3043
# From the Avahi example code
1830
DBusGMainLoop(set_as_default=True )
1831
main_loop = gobject.MainLoop()
3044
DBusGMainLoop(set_as_default=True)
3045
main_loop = GLib.MainLoop()
1832
3046
bus = dbus.SystemBus()
1833
3047
# End of Avahi example code
1836
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1837
bus, do_not_queue=True)
1838
except dbus.exceptions.NameExistsException, e:
1839
logger.error(unicode(e) + u", disabling D-Bus")
3050
bus_name = dbus.service.BusName("se.recompile.Mandos",
3053
old_bus_name = dbus.service.BusName(
3054
"se.bsnet.fukt.Mandos", bus,
3056
except dbus.exceptions.DBusException as e:
3057
logger.error("Disabling D-Bus:", exc_info=e)
1840
3058
use_dbus = False
1841
server_settings[u"use_dbus"] = False
3059
server_settings["use_dbus"] = False
1842
3060
tcp_server.use_dbus = False
1843
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1844
service = AvahiService(name = server_settings[u"servicename"],
1845
servicetype = u"_mandos._tcp",
1846
protocol = protocol, bus = bus)
1847
if server_settings["interface"]:
1848
service.interface = (if_nametoindex
1849
(str(server_settings[u"interface"])))
3062
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3063
service = AvahiServiceToSyslog(
3064
name=server_settings["servicename"],
3065
servicetype="_mandos._tcp",
3068
if server_settings["interface"]:
3069
service.interface = if_nametoindex(
3070
server_settings["interface"].encode("utf-8"))
1852
# Close all input and output, do double fork, etc.
1855
3072
global multiprocessing_manager
1856
3073
multiprocessing_manager = multiprocessing.Manager()
1858
3075
client_class = Client
1860
client_class = functools.partial(ClientDBus, bus = bus)
1861
def client_config_items(config, section):
1862
special_settings = {
1863
"approved_by_default":
1864
lambda: config.getboolean(section,
1865
"approved_by_default"),
1867
for name, value in config.items(section):
3077
client_class = functools.partial(ClientDBus, bus=bus)
3079
client_settings = Client.config_parser(client_config)
3080
old_client_settings = {}
3083
# This is used to redirect stdout and stderr for checker processes
3085
wnull = open(os.devnull, "w") # A writable /dev/null
3086
# Only used if server is running in foreground but not in debug
3088
if debug or not foreground:
3091
# Get client data and settings from last running state.
3092
if server_settings["restore"]:
3094
with open(stored_state_path, "rb") as stored_state:
3095
if sys.version_info.major == 2:
3096
clients_data, old_client_settings = pickle.load(
3099
bytes_clients_data, bytes_old_client_settings = (
3100
pickle.load(stored_state, encoding="bytes"))
3101
# Fix bytes to strings
3104
clients_data = {(key.decode("utf-8")
3105
if isinstance(key, bytes)
3108
bytes_clients_data.items()}
3109
del bytes_clients_data
3110
for key in clients_data:
3111
value = {(k.decode("utf-8")
3112
if isinstance(k, bytes) else k): v
3114
clients_data[key].items()}
3115
clients_data[key] = value
3117
value["client_structure"] = [
3119
if isinstance(s, bytes)
3121
value["client_structure"]]
3123
for k in ("name", "host"):
3124
if isinstance(value[k], bytes):
3125
value[k] = value[k].decode("utf-8")
3126
# old_client_settings
3128
old_client_settings = {
3129
(key.decode("utf-8")
3130
if isinstance(key, bytes)
3133
bytes_old_client_settings.items()}
3134
del bytes_old_client_settings
3136
for value in old_client_settings.values():
3137
if isinstance(value["host"], bytes):
3138
value["host"] = (value["host"]
3140
os.remove(stored_state_path)
3141
except IOError as e:
3142
if e.errno == errno.ENOENT:
3143
logger.warning("Could not load persistent state:"
3144
" {}".format(os.strerror(e.errno)))
3146
logger.critical("Could not load persistent state:",
3149
except EOFError as e:
3150
logger.warning("Could not load persistent state: "
3154
with PGPEngine() as pgp:
3155
for client_name, client in clients_data.items():
3156
# Skip removed clients
3157
if client_name not in client_settings:
3160
# Decide which value to use after restoring saved state.
3161
# We have three different values: Old config file,
3162
# new config file, and saved state.
3163
# New config value takes precedence if it differs from old
3164
# config value, otherwise use saved state.
3165
for name, value in client_settings[client_name].items():
3167
# For each value in new config, check if it
3168
# differs from the old config value (Except for
3169
# the "secret" attribute)
3170
if (name != "secret"
3172
old_client_settings[client_name][name])):
3173
client[name] = value
3177
# Clients who has passed its expire date can still be
3178
# enabled if its last checker was successful. A Client
3179
# whose checker succeeded before we stored its state is
3180
# assumed to have successfully run all checkers during
3182
if client["enabled"]:
3183
if datetime.datetime.utcnow() >= client["expires"]:
3184
if not client["last_checked_ok"]:
3186
"disabling client {} - Client never "
3187
"performed a successful checker".format(
3189
client["enabled"] = False
3190
elif client["last_checker_status"] != 0:
3192
"disabling client {} - Client last"
3193
" checker failed with error code"
3196
client["last_checker_status"]))
3197
client["enabled"] = False
3199
client["expires"] = (
3200
datetime.datetime.utcnow()
3201
+ client["timeout"])
3202
logger.debug("Last checker succeeded,"
3203
" keeping {} enabled".format(
1869
yield (name, special_settings[name]())
1873
tcp_server.clients.update(set(
1874
client_class(name = section,
1875
config= dict(client_config_items(
1876
client_config, section)))
1877
for section in client_config.sections()))
3206
client["secret"] = pgp.decrypt(
3207
client["encrypted_secret"],
3208
client_settings[client_name]["secret"])
3210
# If decryption fails, we use secret from new settings
3211
logger.debug("Failed to decrypt {} old secret".format(
3213
client["secret"] = (client_settings[client_name]
3216
# Add/remove clients based on new changes made to config
3217
for client_name in (set(old_client_settings)
3218
- set(client_settings)):
3219
del clients_data[client_name]
3220
for client_name in (set(client_settings)
3221
- set(old_client_settings)):
3222
clients_data[client_name] = client_settings[client_name]
3224
# Create all client objects
3225
for client_name, client in clients_data.items():
3226
tcp_server.clients[client_name] = client_class(
3229
server_settings=server_settings)
1878
3231
if not tcp_server.clients:
1879
logger.warning(u"No clients defined")
1885
pidfile.write(str(pid) + "\n")
1888
logger.error(u"Could not write to file %r with PID %d",
1891
# "pidfile" was never created
3232
logger.warning("No clients defined")
3235
if pidfile is not None:
3239
print(pid, file=pidfile)
3241
logger.error("Could not write to file %r with PID %d",
1893
3244
del pidfilename
1895
signal.signal(signal.SIGINT, signal.SIG_IGN)
1897
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1898
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3246
for termsig in (signal.SIGHUP, signal.SIGTERM):
3247
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3248
lambda: main_loop.quit() and False)
1901
class MandosDBusService(dbus.service.Object):
3252
@alternate_dbus_interfaces(
3253
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3254
class MandosDBusService(DBusObjectWithObjectManager):
1902
3255
"""A D-Bus proxy object"""
1903
3257
def __init__(self):
1904
dbus.service.Object.__init__(self, bus, u"/")
1905
_interface = u"se.bsnet.fukt.Mandos"
1907
@dbus.service.signal(_interface, signature=u"o")
3258
dbus.service.Object.__init__(self, bus, "/")
3260
_interface = "se.recompile.Mandos"
3262
@dbus.service.signal(_interface, signature="o")
1908
3263
def ClientAdded(self, objpath):
1912
@dbus.service.signal(_interface, signature=u"ss")
3267
@dbus.service.signal(_interface, signature="ss")
1913
3268
def ClientNotFound(self, fingerprint, address):
1917
@dbus.service.signal(_interface, signature=u"os")
3272
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3274
@dbus.service.signal(_interface, signature="os")
1918
3275
def ClientRemoved(self, objpath, name):
1922
@dbus.service.method(_interface, out_signature=u"ao")
3279
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3281
@dbus.service.method(_interface, out_signature="ao")
1923
3282
def GetAllClients(self):
1925
return dbus.Array(c.dbus_object_path
1926
for c in tcp_server.clients)
3284
return dbus.Array(c.dbus_object_path for c in
3285
tcp_server.clients.values())
3287
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1928
3289
@dbus.service.method(_interface,
1929
out_signature=u"a{oa{sv}}")
3290
out_signature="a{oa{sv}}")
1930
3291
def GetAllClientsWithProperties(self):
1932
3293
return dbus.Dictionary(
1933
((c.dbus_object_path, c.GetAll(u""))
1934
for c in tcp_server.clients),
1935
signature=u"oa{sv}")
1937
@dbus.service.method(_interface, in_signature=u"o")
3294
{c.dbus_object_path: c.GetAll(
3295
"se.recompile.Mandos.Client")
3296
for c in tcp_server.clients.values()},
3299
@dbus.service.method(_interface, in_signature="o")
1938
3300
def RemoveClient(self, object_path):
1940
for c in tcp_server.clients:
3302
for c in tcp_server.clients.values():
1941
3303
if c.dbus_object_path == object_path:
1942
tcp_server.clients.remove(c)
3304
del tcp_server.clients[c.name]
1943
3305
c.remove_from_connection()
1944
# Don't signal anything except ClientRemoved
3306
# Don't signal the disabling
1945
3307
c.disable(quiet=True)
1947
self.ClientRemoved(object_path, c.name)
3308
# Emit D-Bus signal for removal
3309
self.client_removed_signal(c)
1949
3311
raise KeyError(object_path)
3315
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3316
out_signature="a{oa{sa{sv}}}")
3317
def GetManagedObjects(self):
3319
return dbus.Dictionary(
3320
{client.dbus_object_path:
3322
{interface: client.GetAll(interface)
3324
client._get_all_interface_names()})
3325
for client in tcp_server.clients.values()})
3327
def client_added_signal(self, client):
3328
"""Send the new standard signal and the old signal"""
3330
# New standard signal
3331
self.InterfacesAdded(
3332
client.dbus_object_path,
3334
{interface: client.GetAll(interface)
3336
client._get_all_interface_names()}))
3338
self.ClientAdded(client.dbus_object_path)
3340
def client_removed_signal(self, client):
3341
"""Send the new standard signal and the old signal"""
3343
# New standard signal
3344
self.InterfacesRemoved(
3345
client.dbus_object_path,
3346
client._get_all_interface_names())
3348
self.ClientRemoved(client.dbus_object_path,
1953
3351
mandos_dbus_service = MandosDBusService()
3353
# Save modules to variables to exempt the modules from being
3354
# unloaded before the function registered with atexit() is run.
3355
mp = multiprocessing
1956
3359
"Cleanup function; run on exit"
3363
mp.active_children()
3365
if not (tcp_server.clients or client_settings):
3368
# Store client before exiting. Secrets are encrypted with key
3369
# based on what config file has. If config file is
3370
# removed/edited, old secret will thus be unrecovable.
3372
with PGPEngine() as pgp:
3373
for client in tcp_server.clients.values():
3374
key = client_settings[client.name]["secret"]
3375
client.encrypted_secret = pgp.encrypt(client.secret,
3379
# A list of attributes that can not be pickled
3381
exclude = {"bus", "changedstate", "secret",
3382
"checker", "server_settings"}
3383
for name, typ in inspect.getmembers(dbus.service
3387
client_dict["encrypted_secret"] = (client
3389
for attr in client.client_structure:
3390
if attr not in exclude:
3391
client_dict[attr] = getattr(client, attr)
3393
clients[client.name] = client_dict
3394
del client_settings[client.name]["secret"]
3397
with tempfile.NamedTemporaryFile(
3401
dir=os.path.dirname(stored_state_path),
3402
delete=False) as stored_state:
3403
pickle.dump((clients, client_settings), stored_state,
3405
tempname = stored_state.name
3406
os.rename(tempname, stored_state_path)
3407
except (IOError, OSError) as e:
3413
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3414
logger.warning("Could not save persistent state: {}"
3415
.format(os.strerror(e.errno)))
3417
logger.warning("Could not save persistent state:",
3421
# Delete all clients, and settings from config
1959
3422
while tcp_server.clients:
1960
client = tcp_server.clients.pop()
3423
name, client = tcp_server.clients.popitem()
1962
3425
client.remove_from_connection()
1963
client.disable_hook = None
1964
# Don't signal anything except ClientRemoved
3426
# Don't signal the disabling
1965
3427
client.disable(quiet=True)
3428
# Emit D-Bus signal for removal
1968
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3430
mandos_dbus_service.client_removed_signal(client)
3431
client_settings.clear()
1971
3433
atexit.register(cleanup)
1973
for client in tcp_server.clients:
3435
for client in tcp_server.clients.values():
1976
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3437
# Emit D-Bus signal for adding
3438
mandos_dbus_service.client_added_signal(client)
3439
# Need to initiate checking of clients
3441
client.init_checker()
1979
3443
tcp_server.enable()
1980
3444
tcp_server.server_activate()
1982
3446
# Find out what port we got
1983
service.port = tcp_server.socket.getsockname()[1]
3448
service.port = tcp_server.socket.getsockname()[1]
1985
logger.info(u"Now listening on address %r, port %d,"
1986
" flowinfo %d, scope_id %d"
1987
% tcp_server.socket.getsockname())
3450
logger.info("Now listening on address %r, port %d,"
3451
" flowinfo %d, scope_id %d",
3452
*tcp_server.socket.getsockname())
1989
logger.info(u"Now listening on address %r, port %d"
1990
% tcp_server.socket.getsockname())
1992
#service.interface = tcp_server.socket.getsockname()[3]
3454
logger.info("Now listening on address %r, port %d",
3455
*tcp_server.socket.getsockname())
3457
# service.interface = tcp_server.socket.getsockname()[3]
1995
# From the Avahi example code
1998
except dbus.exceptions.DBusException, error:
1999
logger.critical(u"DBusException: %s", error)
2002
# End of Avahi example code
2004
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2005
lambda *args, **kwargs:
2006
(tcp_server.handle_request
2007
(*args[2:], **kwargs) or True))
2009
logger.debug(u"Starting main loop")
3461
# From the Avahi example code
3464
except dbus.exceptions.DBusException as error:
3465
logger.critical("D-Bus Exception", exc_info=error)
3468
# End of Avahi example code
3470
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3471
lambda *args, **kwargs:
3472
(tcp_server.handle_request
3473
(*args[2:], **kwargs) or True))
3475
logger.debug("Starting main loop")
2010
3476
main_loop.run()
2011
except AvahiError, error:
2012
logger.critical(u"AvahiError: %s", error)
3477
except AvahiError as error:
3478
logger.critical("Avahi Error", exc_info=error)
2015
3481
except KeyboardInterrupt:
2018
logger.debug(u"Server received KeyboardInterrupt")
2019
logger.debug(u"Server exiting")
3483
print("", file=sys.stderr)
3484
logger.debug("Server received KeyboardInterrupt")
3485
logger.debug("Server exiting")
2020
3486
# Must run before the D-Bus bus name gets deregistered
2023
3490
if __name__ == '__main__':