25
24
# GNU General Public License for more details.
27
26
# You should have received a copy of the GNU General Public License
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
31
# Contact the authors at <mandos@recompile.se>.
34
from __future__ import (division, absolute_import, print_function,
38
from future_builtins import *
43
import SocketServer as socketserver
27
# along with this program. If not, see <http://www.gnu.org/licenses/>.
29
# Contact the authors at <mandos@fukt.bsnet.se>.
32
from __future__ import division
37
from optparse import OptionParser
51
import ConfigParser as configparser
41
import gnutls.connection
43
import gnutls.library.functions
44
import gnutls.library.constants
45
import gnutls.library.types
62
56
import logging.handlers
69
import cPickle as pickle
72
import multiprocessing
82
from gi.repository import GLib
83
61
from dbus.mainloop.glib import DBusGMainLoop
86
import xml.dom.minidom
90
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
91
except AttributeError:
93
from IN import SO_BINDTODEVICE
95
SO_BINDTODEVICE = None
97
if sys.version_info.major == 2:
101
stored_state_file = "clients.pickle"
103
logger = logging.getLogger()
107
if_nametoindex = ctypes.cdll.LoadLibrary(
108
ctypes.util.find_library("c")).if_nametoindex
109
except (OSError, AttributeError):
111
def if_nametoindex(interface):
112
"Get an interface index the hard way, i.e. using fcntl()"
113
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
114
with contextlib.closing(socket.socket()) as s:
115
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
116
struct.pack(b"16s16x", interface))
117
interface_index = struct.unpack("I", ifreq[16:20])[0]
118
return interface_index
121
def copy_function(func):
122
"""Make a copy of a function"""
123
if sys.version_info.major == 2:
124
return types.FunctionType(func.func_code,
130
return types.FunctionType(func.__code__,
137
def initlogger(debug, level=logging.WARNING):
138
"""init logger and add loglevel"""
141
syslogger = (logging.handlers.SysLogHandler(
142
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
143
address = "/dev/log"))
144
syslogger.setFormatter(logging.Formatter
145
('Mandos [%(process)d]: %(levelname)s:'
147
logger.addHandler(syslogger)
150
console = logging.StreamHandler()
151
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
155
logger.addHandler(console)
156
logger.setLevel(level)
159
class PGPError(Exception):
160
"""Exception if encryption/decryption fails"""
164
class PGPEngine(object):
165
"""A simple class for OpenPGP symmetric encryption & decryption"""
168
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
171
output = subprocess.check_output(["gpgconf"])
172
for line in output.splitlines():
173
name, text, path = line.split(b":")
178
if e.errno != errno.ENOENT:
180
self.gnupgargs = ['--batch',
181
'--homedir', self.tempdir,
184
# Only GPG version 1 has the --no-use-agent option.
185
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
186
self.gnupgargs.append("--no-use-agent")
191
def __exit__(self, exc_type, exc_value, traceback):
199
if self.tempdir is not None:
200
# Delete contents of tempdir
201
for root, dirs, files in os.walk(self.tempdir,
203
for filename in files:
204
os.remove(os.path.join(root, filename))
206
os.rmdir(os.path.join(root, dirname))
208
os.rmdir(self.tempdir)
211
def password_encode(self, password):
212
# Passphrase can not be empty and can not contain newlines or
213
# NUL bytes. So we prefix it and hex encode it.
214
encoded = b"mandos" + binascii.hexlify(password)
215
if len(encoded) > 2048:
216
# GnuPG can't handle long passwords, so encode differently
217
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
218
.replace(b"\n", b"\\n")
219
.replace(b"\0", b"\\x00"))
222
def encrypt(self, data, password):
223
passphrase = self.password_encode(password)
224
with tempfile.NamedTemporaryFile(
225
dir=self.tempdir) as passfile:
226
passfile.write(passphrase)
228
proc = subprocess.Popen([self.gpg, '--symmetric',
232
stdin = subprocess.PIPE,
233
stdout = subprocess.PIPE,
234
stderr = subprocess.PIPE)
235
ciphertext, err = proc.communicate(input = data)
236
if proc.returncode != 0:
240
def decrypt(self, data, password):
241
passphrase = self.password_encode(password)
242
with tempfile.NamedTemporaryFile(
243
dir = self.tempdir) as passfile:
244
passfile.write(passphrase)
246
proc = subprocess.Popen([self.gpg, '--decrypt',
250
stdin = subprocess.PIPE,
251
stdout = subprocess.PIPE,
252
stderr = subprocess.PIPE)
253
decrypted_plaintext, err = proc.communicate(input = data)
254
if proc.returncode != 0:
256
return decrypted_plaintext
258
# Pretend that we have an Avahi module
260
"""This isn't so much a class as it is a module-like namespace.
261
It is instantiated once, and simulates having an Avahi module."""
262
IF_UNSPEC = -1 # avahi-common/address.h
263
PROTO_UNSPEC = -1 # avahi-common/address.h
264
PROTO_INET = 0 # avahi-common/address.h
265
PROTO_INET6 = 1 # avahi-common/address.h
266
DBUS_NAME = "org.freedesktop.Avahi"
267
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
268
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
269
DBUS_PATH_SERVER = "/"
270
def string_array_to_txt_array(self, t):
271
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
272
for s in t), signature="ay")
273
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
274
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
275
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
276
SERVER_INVALID = 0 # avahi-common/defs.h
277
SERVER_REGISTERING = 1 # avahi-common/defs.h
278
SERVER_RUNNING = 2 # avahi-common/defs.h
279
SERVER_COLLISION = 3 # avahi-common/defs.h
280
SERVER_FAILURE = 4 # avahi-common/defs.h
64
# Brief description of the operation of this program:
66
# This server announces itself as a Zeroconf service. Connecting
67
# clients use the TLS protocol, with the unusual quirk that this
68
# server program acts as a TLS "client" while a connecting client acts
69
# as a TLS "server". The client (acting as a TLS "server") must
70
# supply an OpenPGP certificate, and the fingerprint of this
71
# certificate is used by this server to look up (in a list read from a
72
# file at start time) which binary blob to give the client. No other
73
# authentication or authorization is done by this server.
76
logger = logging.Logger('mandos')
77
syslogger = logging.handlers.SysLogHandler\
78
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
79
syslogger.setFormatter(logging.Formatter\
80
('%(levelname)s: %(message)s'))
81
logger.addHandler(syslogger)
283
85
class AvahiError(Exception):
284
def __init__(self, value, *args, **kwargs):
86
def __init__(self, value):
285
87
self.value = value
286
return super(AvahiError, self).__init__(value, *args,
89
return repr(self.value)
290
91
class AvahiServiceError(AvahiError):
294
94
class AvahiGroupError(AvahiError):
298
98
class AvahiService(object):
299
"""An Avahi (Zeroconf) service.
302
100
interface: integer; avahi.IF_UNSPEC or an interface index.
303
101
Used to optionally bind to the specified interface.
304
name: string; Example: 'Mandos'
305
type: string; Example: '_mandos._tcp'.
306
See <https://www.iana.org/assignments/service-names-port-numbers>
307
port: integer; what port to announce
308
TXT: list of strings; TXT record for the service
309
domain: string; Domain to publish on, default to .local if empty.
310
host: string; Host to publish records for, default is localhost
311
max_renames: integer; maximum number of renames
312
rename_count: integer; counter so we only rename after collisions
313
a sensible number of times
314
group: D-Bus Entry Group
316
bus: dbus.SystemBus()
102
name = string; Example: "Mandos"
103
type = string; Example: "_mandos._tcp".
104
See <http://www.dns-sd.org/ServiceTypes.html>
105
port = integer; what port to announce
106
TXT = list of strings; TXT record for the service
107
domain = string; Domain to publish on, default to .local if empty.
108
host = string; Host to publish records for, default to localhost
110
max_renames = integer; maximum number of renames
111
rename_count = integer; counter so we only rename after collisions
112
a sensible number of times
320
interface = avahi.IF_UNSPEC,
328
protocol = avahi.PROTO_UNSPEC,
114
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
330
118
self.interface = interface
332
self.type = servicetype
334
self.TXT = TXT if TXT is not None else []
335
126
self.domain = domain
337
128
self.rename_count = 0
338
self.max_renames = max_renames
339
self.protocol = protocol
340
self.group = None # our entry group
343
self.entry_group_state_changed_match = None
345
def rename(self, remove=True):
346
130
"""Derived from the Avahi example code"""
347
131
if self.rename_count >= self.max_renames:
348
logger.critical("No suitable Zeroconf service name found"
349
" after %i retries, exiting.",
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
351
134
raise AvahiServiceError("Too many renames")
353
self.server.GetAlternativeServiceName(self.name))
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", name)
354
139
self.rename_count += 1
355
logger.info("Changing Zeroconf service name to %r ...",
361
except dbus.exceptions.DBusException as error:
362
if (error.get_dbus_name()
363
== "org.freedesktop.Avahi.CollisionError"):
364
logger.info("Local Zeroconf service name collision.")
365
return self.rename(remove=False)
367
logger.critical("D-Bus Exception", exc_info=error)
371
140
def remove(self):
372
141
"""Derived from the Avahi example code"""
373
if self.entry_group_state_changed_match is not None:
374
self.entry_group_state_changed_match.remove()
375
self.entry_group_state_changed_match = None
376
if self.group is not None:
142
if group is not None:
380
145
"""Derived from the Avahi example code"""
382
if self.group is None:
383
self.group = dbus.Interface(
384
self.bus.get_object(avahi.DBUS_NAME,
385
self.server.EntryGroupNew()),
386
avahi.DBUS_INTERFACE_ENTRY_GROUP)
387
self.entry_group_state_changed_match = (
388
self.group.connect_to_signal(
389
'StateChanged', self.entry_group_state_changed))
390
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
391
self.name, self.type)
392
self.group.AddService(
395
dbus.UInt32(0), # flags
396
self.name, self.type,
397
self.domain, self.host,
398
dbus.UInt16(self.port),
399
avahi.string_array_to_txt_array(self.TXT))
402
def entry_group_state_changed(self, state, error):
403
"""Derived from the Avahi example code"""
404
logger.debug("Avahi entry group state change: %i", state)
406
if state == avahi.ENTRY_GROUP_ESTABLISHED:
407
logger.debug("Zeroconf service established.")
408
elif state == avahi.ENTRY_GROUP_COLLISION:
409
logger.info("Zeroconf service name collision.")
411
elif state == avahi.ENTRY_GROUP_FAILURE:
412
logger.critical("Avahi: Error in group state changed %s",
414
raise AvahiGroupError("State changed: {!s}".format(error))
417
"""Derived from the Avahi example code"""
418
if self.group is not None:
421
except (dbus.exceptions.UnknownMethodException,
422
dbus.exceptions.DBusException):
427
def server_state_changed(self, state, error=None):
428
"""Derived from the Avahi example code"""
429
logger.debug("Avahi server state change: %i", state)
431
avahi.SERVER_INVALID: "Zeroconf server invalid",
432
avahi.SERVER_REGISTERING: None,
433
avahi.SERVER_COLLISION: "Zeroconf server name collision",
434
avahi.SERVER_FAILURE: "Zeroconf server failure",
436
if state in bad_states:
437
if bad_states[state] is not None:
439
logger.error(bad_states[state])
441
logger.error(bad_states[state] + ": %r", error)
443
elif state == avahi.SERVER_RUNNING:
446
except dbus.exceptions.DBusException as error:
447
if (error.get_dbus_name()
448
== "org.freedesktop.Avahi.CollisionError"):
449
logger.info("Local Zeroconf service name"
451
return self.rename(remove=False)
453
logger.critical("D-Bus Exception", exc_info=error)
458
logger.debug("Unknown state: %r", state)
460
logger.debug("Unknown state: %r: %r", state, error)
463
"""Derived from the Avahi example code"""
464
if self.server is None:
465
self.server = dbus.Interface(
466
self.bus.get_object(avahi.DBUS_NAME,
467
avahi.DBUS_PATH_SERVER,
468
follow_name_owner_changes=True),
469
avahi.DBUS_INTERFACE_SERVER)
470
self.server.connect_to_signal("StateChanged",
471
self.server_state_changed)
472
self.server_state_changed(self.server.GetState())
475
class AvahiServiceToSyslog(AvahiService):
476
def rename(self, *args, **kwargs):
477
"""Add the new name to the syslog messages"""
478
ret = AvahiService.rename(self, *args, **kwargs)
479
syslogger.setFormatter(logging.Formatter(
480
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
484
# Pretend that we have a GnuTLS module
485
class GnuTLS(object):
486
"""This isn't so much a class as it is a module-like namespace.
487
It is instantiated once, and simulates having a GnuTLS module."""
489
_library = ctypes.cdll.LoadLibrary(
490
ctypes.util.find_library("gnutls"))
491
_need_version = b"3.3.0"
493
# Need to use class name "GnuTLS" here, since this method is
494
# called before the assignment to the "gnutls" global variable
496
if GnuTLS.check_version(self._need_version) is None:
497
raise GnuTLS.Error("Needs GnuTLS {} or later"
498
.format(self._need_version))
500
# Unless otherwise indicated, the constants and types below are
501
# all from the gnutls/gnutls.h C header file.
511
E_NO_CERTIFICATE_FOUND = -49
512
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
515
class session_int(ctypes.Structure):
517
session_t = ctypes.POINTER(session_int)
518
class certificate_credentials_st(ctypes.Structure):
520
certificate_credentials_t = ctypes.POINTER(
521
certificate_credentials_st)
522
certificate_type_t = ctypes.c_int
523
class datum_t(ctypes.Structure):
524
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
525
('size', ctypes.c_uint)]
526
class openpgp_crt_int(ctypes.Structure):
528
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
529
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
530
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
531
credentials_type_t = ctypes.c_int
532
transport_ptr_t = ctypes.c_void_p
533
close_request_t = ctypes.c_int
536
class Error(Exception):
537
# We need to use the class name "GnuTLS" here, since this
538
# exception might be raised from within GnuTLS.__init__,
539
# which is called before the assignment to the "gnutls"
540
# global variable has happened.
541
def __init__(self, message = None, code = None, args=()):
542
# Default usage is by a message string, but if a return
543
# code is passed, convert it to a string with
546
if message is None and code is not None:
547
message = GnuTLS.strerror(code)
548
return super(GnuTLS.Error, self).__init__(
551
class CertificateSecurityError(Error):
555
class Credentials(object):
557
self._c_object = gnutls.certificate_credentials_t()
558
gnutls.certificate_allocate_credentials(
559
ctypes.byref(self._c_object))
560
self.type = gnutls.CRD_CERTIFICATE
563
gnutls.certificate_free_credentials(self._c_object)
565
class ClientSession(object):
566
def __init__(self, socket, credentials = None):
567
self._c_object = gnutls.session_t()
568
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
569
gnutls.set_default_priority(self._c_object)
570
gnutls.transport_set_ptr(self._c_object, socket.fileno())
571
gnutls.handshake_set_private_extensions(self._c_object,
574
if credentials is None:
575
credentials = gnutls.Credentials()
576
gnutls.credentials_set(self._c_object, credentials.type,
577
ctypes.cast(credentials._c_object,
579
self.credentials = credentials
582
gnutls.deinit(self._c_object)
585
return gnutls.handshake(self._c_object)
587
def send(self, data):
591
data_len -= gnutls.record_send(self._c_object,
596
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
598
# Error handling functions
599
def _error_code(result):
600
"""A function to raise exceptions on errors, suitable
601
for the 'restype' attribute on ctypes functions"""
604
if result == gnutls.E_NO_CERTIFICATE_FOUND:
605
raise gnutls.CertificateSecurityError(code = result)
606
raise gnutls.Error(code = result)
608
def _retry_on_error(result, func, arguments):
609
"""A function to retry on some errors, suitable
610
for the 'errcheck' attribute on ctypes functions"""
612
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
613
return _error_code(result)
614
result = func(*arguments)
617
# Unless otherwise indicated, the function declarations below are
618
# all from the gnutls/gnutls.h C header file.
621
priority_set_direct = _library.gnutls_priority_set_direct
622
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
623
ctypes.POINTER(ctypes.c_char_p)]
624
priority_set_direct.restype = _error_code
626
init = _library.gnutls_init
627
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
628
init.restype = _error_code
630
set_default_priority = _library.gnutls_set_default_priority
631
set_default_priority.argtypes = [session_t]
632
set_default_priority.restype = _error_code
634
record_send = _library.gnutls_record_send
635
record_send.argtypes = [session_t, ctypes.c_void_p,
637
record_send.restype = ctypes.c_ssize_t
638
record_send.errcheck = _retry_on_error
640
certificate_allocate_credentials = (
641
_library.gnutls_certificate_allocate_credentials)
642
certificate_allocate_credentials.argtypes = [
643
ctypes.POINTER(certificate_credentials_t)]
644
certificate_allocate_credentials.restype = _error_code
646
certificate_free_credentials = (
647
_library.gnutls_certificate_free_credentials)
648
certificate_free_credentials.argtypes = [certificate_credentials_t]
649
certificate_free_credentials.restype = None
651
handshake_set_private_extensions = (
652
_library.gnutls_handshake_set_private_extensions)
653
handshake_set_private_extensions.argtypes = [session_t,
655
handshake_set_private_extensions.restype = None
657
credentials_set = _library.gnutls_credentials_set
658
credentials_set.argtypes = [session_t, credentials_type_t,
660
credentials_set.restype = _error_code
662
strerror = _library.gnutls_strerror
663
strerror.argtypes = [ctypes.c_int]
664
strerror.restype = ctypes.c_char_p
666
certificate_type_get = _library.gnutls_certificate_type_get
667
certificate_type_get.argtypes = [session_t]
668
certificate_type_get.restype = _error_code
670
certificate_get_peers = _library.gnutls_certificate_get_peers
671
certificate_get_peers.argtypes = [session_t,
672
ctypes.POINTER(ctypes.c_uint)]
673
certificate_get_peers.restype = ctypes.POINTER(datum_t)
675
global_set_log_level = _library.gnutls_global_set_log_level
676
global_set_log_level.argtypes = [ctypes.c_int]
677
global_set_log_level.restype = None
679
global_set_log_function = _library.gnutls_global_set_log_function
680
global_set_log_function.argtypes = [log_func]
681
global_set_log_function.restype = None
683
deinit = _library.gnutls_deinit
684
deinit.argtypes = [session_t]
685
deinit.restype = None
687
handshake = _library.gnutls_handshake
688
handshake.argtypes = [session_t]
689
handshake.restype = _error_code
690
handshake.errcheck = _retry_on_error
692
transport_set_ptr = _library.gnutls_transport_set_ptr
693
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
694
transport_set_ptr.restype = None
696
bye = _library.gnutls_bye
697
bye.argtypes = [session_t, close_request_t]
698
bye.restype = _error_code
699
bye.errcheck = _retry_on_error
701
check_version = _library.gnutls_check_version
702
check_version.argtypes = [ctypes.c_char_p]
703
check_version.restype = ctypes.c_char_p
705
# All the function declarations below are from gnutls/openpgp.h
707
openpgp_crt_init = _library.gnutls_openpgp_crt_init
708
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
709
openpgp_crt_init.restype = _error_code
711
openpgp_crt_import = _library.gnutls_openpgp_crt_import
712
openpgp_crt_import.argtypes = [openpgp_crt_t,
713
ctypes.POINTER(datum_t),
715
openpgp_crt_import.restype = _error_code
717
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
718
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
719
ctypes.POINTER(ctypes.c_uint)]
720
openpgp_crt_verify_self.restype = _error_code
722
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
723
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
724
openpgp_crt_deinit.restype = None
726
openpgp_crt_get_fingerprint = (
727
_library.gnutls_openpgp_crt_get_fingerprint)
728
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
732
openpgp_crt_get_fingerprint.restype = _error_code
734
# Remove non-public functions
735
del _error_code, _retry_on_error
736
# Create the global "gnutls" object, simulating a module
739
def call_pipe(connection, # : multiprocessing.Connection
740
func, *args, **kwargs):
741
"""This function is meant to be called by multiprocessing.Process
743
This function runs func(*args, **kwargs), and writes the resulting
744
return value on the provided multiprocessing.Connection.
746
connection.send(func(*args, **kwargs))
148
group = dbus.Interface\
149
(bus.get_object(avahi.DBUS_NAME,
150
server.EntryGroupNew()),
151
avahi.DBUS_INTERFACE_ENTRY_GROUP)
152
group.connect_to_signal('StateChanged',
153
entry_group_state_changed)
154
logger.debug(u"Adding service '%s' of type '%s' ...",
155
service.name, service.type)
157
self.interface, # interface
158
avahi.PROTO_INET6, # protocol
159
dbus.UInt32(0), # flags
160
self.name, self.type,
161
self.domain, self.host,
162
dbus.UInt16(self.port),
163
avahi.string_array_to_txt_array(self.TXT))
166
# From the Avahi example code:
167
group = None # our entry group
168
# End of Avahi example code
749
171
class Client(object):
750
172
"""A representation of a client host served by this server.
753
approved: bool(); 'None' if not yet approved/disapproved
754
approval_delay: datetime.timedelta(); Time to wait for approval
755
approval_duration: datetime.timedelta(); Duration of one approval
756
checker: subprocess.Popen(); a running checker process used
757
to see if the client lives.
758
'None' if no process is running.
759
checker_callback_tag: a GLib event source tag, or None
760
checker_command: string; External command which is run to check
761
if client lives. %() expansions are done at
174
name: string; from the config file, used in log messages
175
fingerprint: string (40 or 32 hexadecimal digits); used to
176
uniquely identify the client
177
secret: bytestring; sent verbatim (over TLS) to client
178
fqdn: string (FQDN); available for use by the checker command
179
created: datetime.datetime(); object creation, not client host
180
last_checked_ok: datetime.datetime() or None if not yet checked OK
181
timeout: datetime.timedelta(); How long from last_checked_ok
182
until this client is invalid
183
interval: datetime.timedelta(); How often to start a new checker
184
stop_hook: If set, called by stop() as stop_hook(self)
185
checker: subprocess.Popen(); a running checker process used
186
to see if the client lives.
187
'None' if no process is running.
188
checker_initiator_tag: a gobject event source tag, or None
189
stop_initiator_tag: - '' -
190
checker_callback_tag: - '' -
191
checker_command: string; External command which is run to check if
192
client lives. %() expansions are done at
762
193
runtime with vars(self) as dict, so that for
763
194
instance %(name)s can be used in the command.
764
checker_initiator_tag: a GLib event source tag, or None
765
created: datetime.datetime(); (UTC) object creation
766
client_structure: Object describing what attributes a client has
767
and is used for storing the client at exit
768
current_checker_command: string; current running checker_command
769
disable_initiator_tag: a GLib event source tag, or None
771
fingerprint: string (40 or 32 hexadecimal digits); used to
772
uniquely identify the client
773
host: string; available for use by the checker command
774
interval: datetime.timedelta(); How often to start a new checker
775
last_approval_request: datetime.datetime(); (UTC) or None
776
last_checked_ok: datetime.datetime(); (UTC) or None
777
last_checker_status: integer between 0 and 255 reflecting exit
778
status of last checker. -1 reflects crashed
779
checker, -2 means no checker completed yet.
780
last_checker_signal: The signal which killed the last checker, if
781
last_checker_status is -1
782
last_enabled: datetime.datetime(); (UTC) or None
783
name: string; from the config file, used in log messages and
785
secret: bytestring; sent verbatim (over TLS) to client
786
timeout: datetime.timedelta(); How long from last_checked_ok
787
until this client is disabled
788
extended_timeout: extra long timeout when secret has been sent
789
runtime_expansions: Allowed attributes for runtime expansion.
790
expires: datetime.datetime(); time (UTC) when a client will be
792
server_settings: The server_settings dict from main()
196
_timeout: Real variable for 'timeout'
197
_interval: Real variable for 'interval'
198
_timeout_milliseconds: Used when calling gobject.timeout_add()
199
_interval_milliseconds: - '' -
795
runtime_expansions = ("approval_delay", "approval_duration",
796
"created", "enabled", "expires",
797
"fingerprint", "host", "interval",
798
"last_approval_request", "last_checked_ok",
799
"last_enabled", "name", "timeout")
802
"extended_timeout": "PT15M",
804
"checker": "fping -q -- %%(host)s",
806
"approval_delay": "PT0S",
807
"approval_duration": "PT1S",
808
"approved_by_default": "True",
813
def config_parser(config):
814
"""Construct a new dict of client settings of this form:
815
{ client_name: {setting_name: value, ...}, ...}
816
with exceptions for any special settings as defined above.
817
NOTE: Must be a pure function. Must return the same result
818
value given the same arguments.
821
for client_name in config.sections():
822
section = dict(config.items(client_name))
823
client = settings[client_name] = {}
825
client["host"] = section["host"]
826
# Reformat values from string types to Python types
827
client["approved_by_default"] = config.getboolean(
828
client_name, "approved_by_default")
829
client["enabled"] = config.getboolean(client_name,
832
# Uppercase and remove spaces from fingerprint for later
833
# comparison purposes with return value from the
834
# fingerprint() function
835
client["fingerprint"] = (section["fingerprint"].upper()
837
if "secret" in section:
838
client["secret"] = codecs.decode(section["secret"]
841
elif "secfile" in section:
842
with open(os.path.expanduser(os.path.expandvars
843
(section["secfile"])),
845
client["secret"] = secfile.read()
847
raise TypeError("No secret or secfile for section {}"
849
client["timeout"] = string_to_delta(section["timeout"])
850
client["extended_timeout"] = string_to_delta(
851
section["extended_timeout"])
852
client["interval"] = string_to_delta(section["interval"])
853
client["approval_delay"] = string_to_delta(
854
section["approval_delay"])
855
client["approval_duration"] = string_to_delta(
856
section["approval_duration"])
857
client["checker_command"] = section["checker"]
858
client["last_approval_request"] = None
859
client["last_checked_ok"] = None
860
client["last_checker_status"] = -2
864
def __init__(self, settings, name = None, server_settings=None):
201
def _set_timeout(self, timeout):
202
"Setter function for 'timeout' attribute"
203
self._timeout = timeout
204
self._timeout_milliseconds = ((self.timeout.days
205
* 24 * 60 * 60 * 1000)
206
+ (self.timeout.seconds * 1000)
207
+ (self.timeout.microseconds
209
timeout = property(lambda self: self._timeout,
212
def _set_interval(self, interval):
213
"Setter function for 'interval' attribute"
214
self._interval = interval
215
self._interval_milliseconds = ((self.interval.days
216
* 24 * 60 * 60 * 1000)
217
+ (self.interval.seconds
219
+ (self.interval.microseconds
221
interval = property(lambda self: self._interval,
224
def __init__(self, name=None, stop_hook=None, fingerprint=None,
225
secret=None, secfile=None, fqdn=None, timeout=None,
226
interval=-1, checker=None):
227
"""Note: the 'checker' argument sets the 'checker_command'
228
attribute and not the 'checker' attribute.."""
866
if server_settings is None:
868
self.server_settings = server_settings
869
# adding all client settings
870
for setting, value in settings.items():
871
setattr(self, setting, value)
874
if not hasattr(self, "last_enabled"):
875
self.last_enabled = datetime.datetime.utcnow()
876
if not hasattr(self, "expires"):
877
self.expires = (datetime.datetime.utcnow()
230
logger.debug(u"Creating client %r", self.name)
231
# Uppercase and remove spaces from fingerprint
232
# for later comparison purposes with return value of
233
# the fingerprint() function
234
self.fingerprint = fingerprint.upper().replace(u" ", u"")
235
logger.debug(u" Fingerprint: %s", self.fingerprint)
237
self.secret = secret.decode(u"base64")
240
self.secret = sf.read()
880
self.last_enabled = None
883
logger.debug("Creating client %r", self.name)
884
logger.debug(" Fingerprint: %s", self.fingerprint)
885
self.created = settings.get("created",
886
datetime.datetime.utcnow())
888
# attributes specific for this server instance
243
raise TypeError(u"No secret or secfile for client %s"
246
self.created = datetime.datetime.now()
247
self.last_checked_ok = None
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
250
self.stop_hook = stop_hook
889
251
self.checker = None
890
252
self.checker_initiator_tag = None
891
self.disable_initiator_tag = None
253
self.stop_initiator_tag = None
892
254
self.checker_callback_tag = None
893
self.current_checker_command = None
895
self.approvals_pending = 0
896
self.changedstate = multiprocessing_manager.Condition(
897
multiprocessing_manager.Lock())
898
self.client_structure = [attr
899
for attr in self.__dict__.keys()
900
if not attr.startswith("_")]
901
self.client_structure.append("client_structure")
903
for name, t in inspect.getmembers(
904
type(self), lambda obj: isinstance(obj, property)):
905
if not name.startswith("_"):
906
self.client_structure.append(name)
908
# Send notice to process children that client state has changed
909
def send_changedstate(self):
910
with self.changedstate:
911
self.changedstate.notify_all()
255
self.check_command = checker
914
257
"""Start this client's checker and timeout hooks"""
915
if getattr(self, "enabled", False):
918
self.expires = datetime.datetime.utcnow() + self.timeout
920
self.last_enabled = datetime.datetime.utcnow()
922
self.send_changedstate()
924
def disable(self, quiet=True):
925
"""Disable this client."""
926
if not getattr(self, "enabled", False):
929
logger.info("Disabling client %s", self.name)
930
if getattr(self, "disable_initiator_tag", None) is not None:
931
GLib.source_remove(self.disable_initiator_tag)
932
self.disable_initiator_tag = None
934
if getattr(self, "checker_initiator_tag", None) is not None:
935
GLib.source_remove(self.checker_initiator_tag)
936
self.checker_initiator_tag = None
940
self.send_changedstate()
941
# Do not run this again if called by a GLib.timeout_add
947
def init_checker(self):
948
258
# Schedule a new checker to be started an 'interval' from now,
949
259
# and every interval from then on.
950
if self.checker_initiator_tag is not None:
951
GLib.source_remove(self.checker_initiator_tag)
952
self.checker_initiator_tag = GLib.timeout_add(
953
int(self.interval.total_seconds() * 1000),
955
# Schedule a disable() when 'timeout' has passed
956
if self.disable_initiator_tag is not None:
957
GLib.source_remove(self.disable_initiator_tag)
958
self.disable_initiator_tag = GLib.timeout_add(
959
int(self.timeout.total_seconds() * 1000), self.disable)
260
self.checker_initiator_tag = gobject.timeout_add\
261
(self._interval_milliseconds,
960
263
# Also start a new checker *right now*.
961
264
self.start_checker()
963
def checker_callback(self, source, condition, connection,
265
# Schedule a stop() when 'timeout' has passed
266
self.stop_initiator_tag = gobject.timeout_add\
267
(self._timeout_milliseconds,
271
The possibility that a client might be restarted is left open,
272
but not currently used."""
273
# If this client doesn't have a secret, it is already stopped.
275
logger.debug(u"Stopping client %s", self.name)
279
if getattr(self, "stop_initiator_tag", False):
280
gobject.source_remove(self.stop_initiator_tag)
281
self.stop_initiator_tag = None
282
if getattr(self, "checker_initiator_tag", False):
283
gobject.source_remove(self.checker_initiator_tag)
284
self.checker_initiator_tag = None
288
# Do not run this again if called by a gobject.timeout_add
291
self.stop_hook = None
293
def checker_callback(self, pid, condition):
965
294
"""The checker has completed, so take appropriate actions."""
295
now = datetime.datetime.now()
966
296
self.checker_callback_tag = None
967
297
self.checker = None
968
# Read return code from connection (see call_pipe)
969
returncode = connection.recv()
973
self.last_checker_status = returncode
974
self.last_checker_signal = None
975
if self.last_checker_status == 0:
976
logger.info("Checker for %(name)s succeeded",
980
logger.info("Checker for %(name)s failed", vars(self))
982
self.last_checker_status = -1
983
self.last_checker_signal = -returncode
984
logger.warning("Checker for %(name)s crashed?",
298
if os.WIFEXITED(condition) \
299
and (os.WEXITSTATUS(condition) == 0):
300
logger.debug(u"Checker for %(name)s succeeded",
302
self.last_checked_ok = now
303
gobject.source_remove(self.stop_initiator_tag)
304
self.stop_initiator_tag = gobject.timeout_add\
305
(self._timeout_milliseconds,
307
elif not os.WIFEXITED(condition):
308
logger.warning(u"Checker for %(name)s crashed?",
988
def checked_ok(self):
989
"""Assert that the client has been seen, alive and well."""
990
self.last_checked_ok = datetime.datetime.utcnow()
991
self.last_checker_status = 0
992
self.last_checker_signal = None
995
def bump_timeout(self, timeout=None):
996
"""Bump up the timeout for this client."""
998
timeout = self.timeout
999
if self.disable_initiator_tag is not None:
1000
GLib.source_remove(self.disable_initiator_tag)
1001
self.disable_initiator_tag = None
1002
if getattr(self, "enabled", False):
1003
self.disable_initiator_tag = GLib.timeout_add(
1004
int(timeout.total_seconds() * 1000), self.disable)
1005
self.expires = datetime.datetime.utcnow() + timeout
1007
def need_approval(self):
1008
self.last_approval_request = datetime.datetime.utcnow()
311
logger.debug(u"Checker for %(name)s failed",
1010
313
def start_checker(self):
1011
314
"""Start a new checker subprocess if one is not running.
1013
315
If a checker already exists, leave it running and do
1015
317
# The reason for not killing a running checker is that if we
1016
# did that, and if a checker (for some reason) started running
1017
# slowly and taking more than 'interval' time, then the client
1018
# would inevitably timeout, since no checker would get a
1019
# chance to run to completion. If we instead leave running
318
# did that, then if a checker (for some reason) started
319
# running slowly and taking more than 'interval' time, the
320
# client would inevitably timeout, since no checker would get
321
# a chance to run to completion. If we instead leave running
1020
322
# checkers alone, the checker would have to take more time
1021
# than 'timeout' for the client to be disabled, which is as it
1024
if self.checker is not None and not self.checker.is_alive():
1025
logger.warning("Checker was not alive; joining")
1028
# Start a new checker if needed
323
# than 'timeout' for the client to be declared invalid, which
324
# is as it should be.
1029
325
if self.checker is None:
1030
# Escape attributes for the shell
1032
attr: re.escape(str(getattr(self, attr)))
1033
for attr in self.runtime_expansions }
1035
command = self.checker_command % escaped_attrs
1036
except TypeError as error:
1037
logger.error('Could not format string "%s"',
1038
self.checker_command,
1040
return True # Try again later
1041
self.current_checker_command = command
1042
logger.info("Starting checker %r for %s", command,
1044
# We don't need to redirect stdout and stderr, since
1045
# in normal mode, that is already done by daemon(),
1046
# and in debug mode we don't want to. (Stdin is
1047
# always replaced by /dev/null.)
1048
# The exception is when not debugging but nevertheless
1049
# running in the foreground; use the previously
1051
popen_args = { "close_fds": True,
1054
if (not self.server_settings["debug"]
1055
and self.server_settings["foreground"]):
1056
popen_args.update({"stdout": wnull,
1058
pipe = multiprocessing.Pipe(duplex = False)
1059
self.checker = multiprocessing.Process(
1061
args = (pipe[1], subprocess.call, command),
1062
kwargs = popen_args)
1063
self.checker.start()
1064
self.checker_callback_tag = GLib.io_add_watch(
1065
pipe[0].fileno(), GLib.IO_IN,
1066
self.checker_callback, pipe[0], command)
1067
# Re-run this periodically if run by GLib.timeout_add
327
# In case check_command has exactly one % operator
328
command = self.check_command % self.fqdn
330
# Escape attributes for the shell
331
escaped_attrs = dict((key, re.escape(str(val)))
333
vars(self).iteritems())
335
command = self.check_command % escaped_attrs
336
except TypeError, error:
337
logger.error(u'Could not format string "%s":'
338
u' %s', self.check_command, error)
339
return True # Try again later
341
logger.debug(u"Starting checker %r for %s",
343
self.checker = subprocess.Popen(command,
346
self.checker_callback_tag = gobject.child_watch_add\
348
self.checker_callback)
349
except subprocess.OSError, error:
350
logger.error(u"Failed to start subprocess: %s",
352
# Re-run this periodically if run by gobject.timeout_add
1070
354
def stop_checker(self):
1071
355
"""Force the checker process, if any, to stop."""
1072
356
if self.checker_callback_tag:
1073
GLib.source_remove(self.checker_callback_tag)
357
gobject.source_remove(self.checker_callback_tag)
1074
358
self.checker_callback_tag = None
1075
359
if getattr(self, "checker", None) is None:
1077
361
logger.debug("Stopping checker for %(name)s", vars(self))
1078
self.checker.terminate()
363
os.kill(self.checker.pid, signal.SIGTERM)
365
#if self.checker.poll() is None:
366
# os.kill(self.checker.pid, signal.SIGKILL)
367
except OSError, error:
368
if error.errno != errno.ESRCH: # No such process
1079
370
self.checker = None
1082
def dbus_service_property(dbus_interface,
1086
"""Decorators for marking methods of a DBusObjectWithProperties to
1087
become properties on the D-Bus.
1089
The decorated method will be called with no arguments by "Get"
1090
and with one argument by "Set".
1092
The parameters, where they are supported, are the same as
1093
dbus.service.method, except there is only "signature", since the
1094
type from Get() and the type sent to Set() is the same.
1096
# Encoding deeply encoded byte arrays is not supported yet by the
1097
# "Set" method, so we fail early here:
1098
if byte_arrays and signature != "ay":
1099
raise ValueError("Byte arrays not supported for non-'ay'"
1100
" signature {!r}".format(signature))
1102
def decorator(func):
1103
func._dbus_is_property = True
1104
func._dbus_interface = dbus_interface
1105
func._dbus_signature = signature
1106
func._dbus_access = access
1107
func._dbus_name = func.__name__
1108
if func._dbus_name.endswith("_dbus_property"):
1109
func._dbus_name = func._dbus_name[:-14]
1110
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1116
def dbus_interface_annotations(dbus_interface):
1117
"""Decorator for marking functions returning interface annotations
1121
@dbus_interface_annotations("org.example.Interface")
1122
def _foo(self): # Function name does not matter
1123
return {"org.freedesktop.DBus.Deprecated": "true",
1124
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1128
def decorator(func):
1129
func._dbus_is_interface = True
1130
func._dbus_interface = dbus_interface
1131
func._dbus_name = dbus_interface
1137
def dbus_annotations(annotations):
1138
"""Decorator to annotate D-Bus methods, signals or properties
1141
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1142
"org.freedesktop.DBus.Property."
1143
"EmitsChangedSignal": "false"})
1144
@dbus_service_property("org.example.Interface", signature="b",
1146
def Property_dbus_property(self):
1147
return dbus.Boolean(False)
1149
See also the DBusObjectWithAnnotations class.
1152
def decorator(func):
1153
func._dbus_annotations = annotations
1159
class DBusPropertyException(dbus.exceptions.DBusException):
1160
"""A base class for D-Bus property-related exceptions
1165
class DBusPropertyAccessException(DBusPropertyException):
1166
"""A property's access permissions disallows an operation.
1171
class DBusPropertyNotFound(DBusPropertyException):
1172
"""An attempt was made to access a non-existing property.
1177
class DBusObjectWithAnnotations(dbus.service.Object):
1178
"""A D-Bus object with annotations.
1180
Classes inheriting from this can use the dbus_annotations
1181
decorator to add annotations to methods or signals.
1185
def _is_dbus_thing(thing):
1186
"""Returns a function testing if an attribute is a D-Bus thing
1188
If called like _is_dbus_thing("method") it returns a function
1189
suitable for use as predicate to inspect.getmembers().
1191
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1194
def _get_all_dbus_things(self, thing):
1195
"""Returns a generator of (name, attribute) pairs
1197
return ((getattr(athing.__get__(self), "_dbus_name", name),
1198
athing.__get__(self))
1199
for cls in self.__class__.__mro__
1201
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1203
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1204
out_signature = "s",
1205
path_keyword = 'object_path',
1206
connection_keyword = 'connection')
1207
def Introspect(self, object_path, connection):
1208
"""Overloading of standard D-Bus method.
1210
Inserts annotation tags on methods and signals.
1212
xmlstring = dbus.service.Object.Introspect(self, object_path,
1215
document = xml.dom.minidom.parseString(xmlstring)
1217
for if_tag in document.getElementsByTagName("interface"):
1218
# Add annotation tags
1219
for typ in ("method", "signal"):
1220
for tag in if_tag.getElementsByTagName(typ):
1222
for name, prop in (self.
1223
_get_all_dbus_things(typ)):
1224
if (name == tag.getAttribute("name")
1225
and prop._dbus_interface
1226
== if_tag.getAttribute("name")):
1227
annots.update(getattr(
1228
prop, "_dbus_annotations", {}))
1229
for name, value in annots.items():
1230
ann_tag = document.createElement(
1232
ann_tag.setAttribute("name", name)
1233
ann_tag.setAttribute("value", value)
1234
tag.appendChild(ann_tag)
1235
# Add interface annotation tags
1236
for annotation, value in dict(
1237
itertools.chain.from_iterable(
1238
annotations().items()
1239
for name, annotations
1240
in self._get_all_dbus_things("interface")
1241
if name == if_tag.getAttribute("name")
1243
ann_tag = document.createElement("annotation")
1244
ann_tag.setAttribute("name", annotation)
1245
ann_tag.setAttribute("value", value)
1246
if_tag.appendChild(ann_tag)
1247
# Fix argument name for the Introspect method itself
1248
if (if_tag.getAttribute("name")
1249
== dbus.INTROSPECTABLE_IFACE):
1250
for cn in if_tag.getElementsByTagName("method"):
1251
if cn.getAttribute("name") == "Introspect":
1252
for arg in cn.getElementsByTagName("arg"):
1253
if (arg.getAttribute("direction")
1255
arg.setAttribute("name",
1257
xmlstring = document.toxml("utf-8")
1259
except (AttributeError, xml.dom.DOMException,
1260
xml.parsers.expat.ExpatError) as error:
1261
logger.error("Failed to override Introspection method",
1266
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1267
"""A D-Bus object with properties.
1269
Classes inheriting from this can use the dbus_service_property
1270
decorator to expose methods as D-Bus properties. It exposes the
1271
standard Get(), Set(), and GetAll() methods on the D-Bus.
1274
def _get_dbus_property(self, interface_name, property_name):
1275
"""Returns a bound method if one exists which is a D-Bus
1276
property with the specified name and interface.
1278
for cls in self.__class__.__mro__:
1279
for name, value in inspect.getmembers(
1280
cls, self._is_dbus_thing("property")):
1281
if (value._dbus_name == property_name
1282
and value._dbus_interface == interface_name):
1283
return value.__get__(self)
1286
raise DBusPropertyNotFound("{}:{}.{}".format(
1287
self.dbus_object_path, interface_name, property_name))
1290
def _get_all_interface_names(cls):
1291
"""Get a sequence of all interfaces supported by an object"""
1292
return (name for name in set(getattr(getattr(x, attr),
1293
"_dbus_interface", None)
1294
for x in (inspect.getmro(cls))
1296
if name is not None)
1298
@dbus.service.method(dbus.PROPERTIES_IFACE,
1301
def Get(self, interface_name, property_name):
1302
"""Standard D-Bus property Get() method, see D-Bus standard.
1304
prop = self._get_dbus_property(interface_name, property_name)
1305
if prop._dbus_access == "write":
1306
raise DBusPropertyAccessException(property_name)
1308
if not hasattr(value, "variant_level"):
1310
return type(value)(value, variant_level=value.variant_level+1)
1312
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1313
def Set(self, interface_name, property_name, value):
1314
"""Standard D-Bus property Set() method, see D-Bus standard.
1316
prop = self._get_dbus_property(interface_name, property_name)
1317
if prop._dbus_access == "read":
1318
raise DBusPropertyAccessException(property_name)
1319
if prop._dbus_get_args_options["byte_arrays"]:
1320
# The byte_arrays option is not supported yet on
1321
# signatures other than "ay".
1322
if prop._dbus_signature != "ay":
1323
raise ValueError("Byte arrays not supported for non-"
1324
"'ay' signature {!r}"
1325
.format(prop._dbus_signature))
1326
value = dbus.ByteArray(b''.join(chr(byte)
1330
@dbus.service.method(dbus.PROPERTIES_IFACE,
1332
out_signature="a{sv}")
1333
def GetAll(self, interface_name):
1334
"""Standard D-Bus property GetAll() method, see D-Bus
1337
Note: Will not include properties with access="write".
1340
for name, prop in self._get_all_dbus_things("property"):
1342
and interface_name != prop._dbus_interface):
1343
# Interface non-empty but did not match
1345
# Ignore write-only properties
1346
if prop._dbus_access == "write":
1349
if not hasattr(value, "variant_level"):
1350
properties[name] = value
1352
properties[name] = type(value)(
1353
value, variant_level = value.variant_level + 1)
1354
return dbus.Dictionary(properties, signature="sv")
1356
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1357
def PropertiesChanged(self, interface_name, changed_properties,
1358
invalidated_properties):
1359
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1364
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1366
path_keyword='object_path',
1367
connection_keyword='connection')
1368
def Introspect(self, object_path, connection):
1369
"""Overloading of standard D-Bus method.
1371
Inserts property tags and interface annotation tags.
1373
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1377
document = xml.dom.minidom.parseString(xmlstring)
1379
def make_tag(document, name, prop):
1380
e = document.createElement("property")
1381
e.setAttribute("name", name)
1382
e.setAttribute("type", prop._dbus_signature)
1383
e.setAttribute("access", prop._dbus_access)
1386
for if_tag in document.getElementsByTagName("interface"):
1388
for tag in (make_tag(document, name, prop)
1390
in self._get_all_dbus_things("property")
1391
if prop._dbus_interface
1392
== if_tag.getAttribute("name")):
1393
if_tag.appendChild(tag)
1394
# Add annotation tags for properties
1395
for tag in if_tag.getElementsByTagName("property"):
1397
for name, prop in self._get_all_dbus_things(
1399
if (name == tag.getAttribute("name")
1400
and prop._dbus_interface
1401
== if_tag.getAttribute("name")):
1402
annots.update(getattr(
1403
prop, "_dbus_annotations", {}))
1404
for name, value in annots.items():
1405
ann_tag = document.createElement(
1407
ann_tag.setAttribute("name", name)
1408
ann_tag.setAttribute("value", value)
1409
tag.appendChild(ann_tag)
1410
# Add the names to the return values for the
1411
# "org.freedesktop.DBus.Properties" methods
1412
if (if_tag.getAttribute("name")
1413
== "org.freedesktop.DBus.Properties"):
1414
for cn in if_tag.getElementsByTagName("method"):
1415
if cn.getAttribute("name") == "Get":
1416
for arg in cn.getElementsByTagName("arg"):
1417
if (arg.getAttribute("direction")
1419
arg.setAttribute("name", "value")
1420
elif cn.getAttribute("name") == "GetAll":
1421
for arg in cn.getElementsByTagName("arg"):
1422
if (arg.getAttribute("direction")
1424
arg.setAttribute("name", "props")
1425
xmlstring = document.toxml("utf-8")
1427
except (AttributeError, xml.dom.DOMException,
1428
xml.parsers.expat.ExpatError) as error:
1429
logger.error("Failed to override Introspection method",
1434
dbus.OBJECT_MANAGER_IFACE
1435
except AttributeError:
1436
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1438
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1439
"""A D-Bus object with an ObjectManager.
1441
Classes inheriting from this exposes the standard
1442
GetManagedObjects call and the InterfacesAdded and
1443
InterfacesRemoved signals on the standard
1444
"org.freedesktop.DBus.ObjectManager" interface.
1446
Note: No signals are sent automatically; they must be sent
1449
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1450
out_signature = "a{oa{sa{sv}}}")
1451
def GetManagedObjects(self):
1452
"""This function must be overridden"""
1453
raise NotImplementedError()
1455
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1456
signature = "oa{sa{sv}}")
1457
def InterfacesAdded(self, object_path, interfaces_and_properties):
1460
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1461
def InterfacesRemoved(self, object_path, interfaces):
1464
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1465
out_signature = "s",
1466
path_keyword = 'object_path',
1467
connection_keyword = 'connection')
1468
def Introspect(self, object_path, connection):
1469
"""Overloading of standard D-Bus method.
1471
Override return argument name of GetManagedObjects to be
1472
"objpath_interfaces_and_properties"
1474
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1478
document = xml.dom.minidom.parseString(xmlstring)
1480
for if_tag in document.getElementsByTagName("interface"):
1481
# Fix argument name for the GetManagedObjects method
1482
if (if_tag.getAttribute("name")
1483
== dbus.OBJECT_MANAGER_IFACE):
1484
for cn in if_tag.getElementsByTagName("method"):
1485
if (cn.getAttribute("name")
1486
== "GetManagedObjects"):
1487
for arg in cn.getElementsByTagName("arg"):
1488
if (arg.getAttribute("direction")
1492
"objpath_interfaces"
1494
xmlstring = document.toxml("utf-8")
1496
except (AttributeError, xml.dom.DOMException,
1497
xml.parsers.expat.ExpatError) as error:
1498
logger.error("Failed to override Introspection method",
1502
def datetime_to_dbus(dt, variant_level=0):
1503
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1505
return dbus.String("", variant_level = variant_level)
1506
return dbus.String(dt.isoformat(), variant_level=variant_level)
1509
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1510
"""A class decorator; applied to a subclass of
1511
dbus.service.Object, it will add alternate D-Bus attributes with
1512
interface names according to the "alt_interface_names" mapping.
1515
@alternate_dbus_interfaces({"org.example.Interface":
1516
"net.example.AlternateInterface"})
1517
class SampleDBusObject(dbus.service.Object):
1518
@dbus.service.method("org.example.Interface")
1519
def SampleDBusMethod():
1522
The above "SampleDBusMethod" on "SampleDBusObject" will be
1523
reachable via two interfaces: "org.example.Interface" and
1524
"net.example.AlternateInterface", the latter of which will have
1525
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1526
"true", unless "deprecate" is passed with a False value.
1528
This works for methods and signals, and also for D-Bus properties
1529
(from DBusObjectWithProperties) and interfaces (from the
1530
dbus_interface_annotations decorator).
1534
for orig_interface_name, alt_interface_name in (
1535
alt_interface_names.items()):
1537
interface_names = set()
1538
# Go though all attributes of the class
1539
for attrname, attribute in inspect.getmembers(cls):
1540
# Ignore non-D-Bus attributes, and D-Bus attributes
1541
# with the wrong interface name
1542
if (not hasattr(attribute, "_dbus_interface")
1543
or not attribute._dbus_interface.startswith(
1544
orig_interface_name)):
1546
# Create an alternate D-Bus interface name based on
1548
alt_interface = attribute._dbus_interface.replace(
1549
orig_interface_name, alt_interface_name)
1550
interface_names.add(alt_interface)
1551
# Is this a D-Bus signal?
1552
if getattr(attribute, "_dbus_is_signal", False):
1553
# Extract the original non-method undecorated
1554
# function by black magic
1555
if sys.version_info.major == 2:
1556
nonmethod_func = (dict(
1557
zip(attribute.func_code.co_freevars,
1558
attribute.__closure__))
1559
["func"].cell_contents)
1561
nonmethod_func = (dict(
1562
zip(attribute.__code__.co_freevars,
1563
attribute.__closure__))
1564
["func"].cell_contents)
1565
# Create a new, but exactly alike, function
1566
# object, and decorate it to be a new D-Bus signal
1567
# with the alternate D-Bus interface name
1568
new_function = copy_function(nonmethod_func)
1569
new_function = (dbus.service.signal(
1571
attribute._dbus_signature)(new_function))
1572
# Copy annotations, if any
1574
new_function._dbus_annotations = dict(
1575
attribute._dbus_annotations)
1576
except AttributeError:
1578
# Define a creator of a function to call both the
1579
# original and alternate functions, so both the
1580
# original and alternate signals gets sent when
1581
# the function is called
1582
def fixscope(func1, func2):
1583
"""This function is a scope container to pass
1584
func1 and func2 to the "call_both" function
1585
outside of its arguments"""
1587
@functools.wraps(func2)
1588
def call_both(*args, **kwargs):
1589
"""This function will emit two D-Bus
1590
signals by calling func1 and func2"""
1591
func1(*args, **kwargs)
1592
func2(*args, **kwargs)
1593
# Make wrapper function look like a D-Bus signal
1594
for name, attr in inspect.getmembers(func2):
1595
if name.startswith("_dbus_"):
1596
setattr(call_both, name, attr)
1599
# Create the "call_both" function and add it to
1601
attr[attrname] = fixscope(attribute, new_function)
1602
# Is this a D-Bus method?
1603
elif getattr(attribute, "_dbus_is_method", False):
1604
# Create a new, but exactly alike, function
1605
# object. Decorate it to be a new D-Bus method
1606
# with the alternate D-Bus interface name. Add it
1609
dbus.service.method(
1611
attribute._dbus_in_signature,
1612
attribute._dbus_out_signature)
1613
(copy_function(attribute)))
1614
# Copy annotations, if any
1616
attr[attrname]._dbus_annotations = dict(
1617
attribute._dbus_annotations)
1618
except AttributeError:
1620
# Is this a D-Bus property?
1621
elif getattr(attribute, "_dbus_is_property", False):
1622
# Create a new, but exactly alike, function
1623
# object, and decorate it to be a new D-Bus
1624
# property with the alternate D-Bus interface
1625
# name. Add it to the class.
1626
attr[attrname] = (dbus_service_property(
1627
alt_interface, attribute._dbus_signature,
1628
attribute._dbus_access,
1629
attribute._dbus_get_args_options
1631
(copy_function(attribute)))
1632
# Copy annotations, if any
1634
attr[attrname]._dbus_annotations = dict(
1635
attribute._dbus_annotations)
1636
except AttributeError:
1638
# Is this a D-Bus interface?
1639
elif getattr(attribute, "_dbus_is_interface", False):
1640
# Create a new, but exactly alike, function
1641
# object. Decorate it to be a new D-Bus interface
1642
# with the alternate D-Bus interface name. Add it
1645
dbus_interface_annotations(alt_interface)
1646
(copy_function(attribute)))
1648
# Deprecate all alternate interfaces
1649
iname="_AlternateDBusNames_interface_annotation{}"
1650
for interface_name in interface_names:
1652
@dbus_interface_annotations(interface_name)
1654
return { "org.freedesktop.DBus.Deprecated":
1656
# Find an unused name
1657
for aname in (iname.format(i)
1658
for i in itertools.count()):
1659
if aname not in attr:
1663
# Replace the class with a new subclass of it with
1664
# methods, signals, etc. as created above.
1665
if sys.version_info.major == 2:
1666
cls = type(b"{}Alternate".format(cls.__name__),
1669
cls = type("{}Alternate".format(cls.__name__),
1676
@alternate_dbus_interfaces({"se.recompile.Mandos":
1677
"se.bsnet.fukt.Mandos"})
1678
class ClientDBus(Client, DBusObjectWithProperties):
1679
"""A Client class using D-Bus
1682
dbus_object_path: dbus.ObjectPath
1683
bus: dbus.SystemBus()
1686
runtime_expansions = (Client.runtime_expansions
1687
+ ("dbus_object_path", ))
1689
_interface = "se.recompile.Mandos.Client"
1691
# dbus.service.Object doesn't use super(), so we can't either.
1693
def __init__(self, bus = None, *args, **kwargs):
1695
Client.__init__(self, *args, **kwargs)
1696
# Only now, when this client is initialized, can it show up on
1698
client_object_name = str(self.name).translate(
1699
{ord("."): ord("_"),
1700
ord("-"): ord("_")})
1701
self.dbus_object_path = dbus.ObjectPath(
1702
"/clients/" + client_object_name)
1703
DBusObjectWithProperties.__init__(self, self.bus,
1704
self.dbus_object_path)
1706
def notifychangeproperty(transform_func, dbus_name,
1707
type_func=lambda x: x,
1709
invalidate_only=False,
1710
_interface=_interface):
1711
""" Modify a variable so that it's a property which announces
1712
its changes to DBus.
1714
transform_fun: Function that takes a value and a variant_level
1715
and transforms it to a D-Bus type.
1716
dbus_name: D-Bus name of the variable
1717
type_func: Function that transform the value before sending it
1718
to the D-Bus. Default: no transform
1719
variant_level: D-Bus variant level. Default: 1
1721
attrname = "_{}".format(dbus_name)
1723
def setter(self, value):
1724
if hasattr(self, "dbus_object_path"):
1725
if (not hasattr(self, attrname) or
1726
type_func(getattr(self, attrname, None))
1727
!= type_func(value)):
1729
self.PropertiesChanged(
1730
_interface, dbus.Dictionary(),
1731
dbus.Array((dbus_name, )))
1733
dbus_value = transform_func(
1735
variant_level = variant_level)
1736
self.PropertyChanged(dbus.String(dbus_name),
1738
self.PropertiesChanged(
1740
dbus.Dictionary({ dbus.String(dbus_name):
1743
setattr(self, attrname, value)
1745
return property(lambda self: getattr(self, attrname), setter)
1747
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1748
approvals_pending = notifychangeproperty(dbus.Boolean,
1751
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1752
last_enabled = notifychangeproperty(datetime_to_dbus,
1754
checker = notifychangeproperty(
1755
dbus.Boolean, "CheckerRunning",
1756
type_func = lambda checker: checker is not None)
1757
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1759
last_checker_status = notifychangeproperty(dbus.Int16,
1760
"LastCheckerStatus")
1761
last_approval_request = notifychangeproperty(
1762
datetime_to_dbus, "LastApprovalRequest")
1763
approved_by_default = notifychangeproperty(dbus.Boolean,
1764
"ApprovedByDefault")
1765
approval_delay = notifychangeproperty(
1766
dbus.UInt64, "ApprovalDelay",
1767
type_func = lambda td: td.total_seconds() * 1000)
1768
approval_duration = notifychangeproperty(
1769
dbus.UInt64, "ApprovalDuration",
1770
type_func = lambda td: td.total_seconds() * 1000)
1771
host = notifychangeproperty(dbus.String, "Host")
1772
timeout = notifychangeproperty(
1773
dbus.UInt64, "Timeout",
1774
type_func = lambda td: td.total_seconds() * 1000)
1775
extended_timeout = notifychangeproperty(
1776
dbus.UInt64, "ExtendedTimeout",
1777
type_func = lambda td: td.total_seconds() * 1000)
1778
interval = notifychangeproperty(
1779
dbus.UInt64, "Interval",
1780
type_func = lambda td: td.total_seconds() * 1000)
1781
checker_command = notifychangeproperty(dbus.String, "Checker")
1782
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1783
invalidate_only=True)
1785
del notifychangeproperty
1787
def __del__(self, *args, **kwargs):
1789
self.remove_from_connection()
1792
if hasattr(DBusObjectWithProperties, "__del__"):
1793
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1794
Client.__del__(self, *args, **kwargs)
1796
def checker_callback(self, source, condition,
1797
connection, command, *args, **kwargs):
1798
ret = Client.checker_callback(self, source, condition,
1799
connection, command, *args,
1801
exitstatus = self.last_checker_status
1804
self.CheckerCompleted(dbus.Int16(exitstatus),
1805
# This is specific to GNU libC
1806
dbus.Int64(exitstatus << 8),
1807
dbus.String(command))
1810
self.CheckerCompleted(dbus.Int16(-1),
1812
# This is specific to GNU libC
1814
| self.last_checker_signal),
1815
dbus.String(command))
1818
def start_checker(self, *args, **kwargs):
1819
old_checker_pid = getattr(self.checker, "pid", None)
1820
r = Client.start_checker(self, *args, **kwargs)
1821
# Only if new checker process was started
1822
if (self.checker is not None
1823
and old_checker_pid != self.checker.pid):
1825
self.CheckerStarted(self.current_checker_command)
1828
def _reset_approved(self):
1829
self.approved = None
1832
def approve(self, value=True):
1833
self.approved = value
1834
GLib.timeout_add(int(self.approval_duration.total_seconds()
1835
* 1000), self._reset_approved)
1836
self.send_changedstate()
1838
## D-Bus methods, signals & properties
1844
# CheckerCompleted - signal
1845
@dbus.service.signal(_interface, signature="nxs")
1846
def CheckerCompleted(self, exitcode, waitstatus, command):
1850
# CheckerStarted - signal
1851
@dbus.service.signal(_interface, signature="s")
1852
def CheckerStarted(self, command):
1856
# PropertyChanged - signal
1857
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1858
@dbus.service.signal(_interface, signature="sv")
1859
def PropertyChanged(self, property, value):
1863
# GotSecret - signal
1864
@dbus.service.signal(_interface)
1865
def GotSecret(self):
1867
Is sent after a successful transfer of secret from the Mandos
1868
server to mandos-client
1873
@dbus.service.signal(_interface, signature="s")
1874
def Rejected(self, reason):
1878
# NeedApproval - signal
1879
@dbus.service.signal(_interface, signature="tb")
1880
def NeedApproval(self, timeout, default):
1882
return self.need_approval()
1887
@dbus.service.method(_interface, in_signature="b")
1888
def Approve(self, value):
1891
# CheckedOK - method
1892
@dbus.service.method(_interface)
1893
def CheckedOK(self):
1897
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1898
@dbus.service.method(_interface)
1903
# StartChecker - method
1904
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1905
@dbus.service.method(_interface)
1906
def StartChecker(self):
1908
self.start_checker()
1911
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1912
@dbus.service.method(_interface)
1917
# StopChecker - method
1918
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1919
@dbus.service.method(_interface)
1920
def StopChecker(self):
1925
# ApprovalPending - property
1926
@dbus_service_property(_interface, signature="b", access="read")
1927
def ApprovalPending_dbus_property(self):
1928
return dbus.Boolean(bool(self.approvals_pending))
1930
# ApprovedByDefault - property
1931
@dbus_service_property(_interface,
1934
def ApprovedByDefault_dbus_property(self, value=None):
1935
if value is None: # get
1936
return dbus.Boolean(self.approved_by_default)
1937
self.approved_by_default = bool(value)
1939
# ApprovalDelay - property
1940
@dbus_service_property(_interface,
1943
def ApprovalDelay_dbus_property(self, value=None):
1944
if value is None: # get
1945
return dbus.UInt64(self.approval_delay.total_seconds()
1947
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1949
# ApprovalDuration - property
1950
@dbus_service_property(_interface,
1953
def ApprovalDuration_dbus_property(self, value=None):
1954
if value is None: # get
1955
return dbus.UInt64(self.approval_duration.total_seconds()
1957
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1961
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1962
@dbus_service_property(_interface, signature="s", access="read")
1963
def Name_dbus_property(self):
1964
return dbus.String(self.name)
1966
# Fingerprint - property
1968
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1969
@dbus_service_property(_interface, signature="s", access="read")
1970
def Fingerprint_dbus_property(self):
1971
return dbus.String(self.fingerprint)
1974
@dbus_service_property(_interface,
1977
def Host_dbus_property(self, value=None):
1978
if value is None: # get
1979
return dbus.String(self.host)
1980
self.host = str(value)
1982
# Created - property
1984
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1985
@dbus_service_property(_interface, signature="s", access="read")
1986
def Created_dbus_property(self):
1987
return datetime_to_dbus(self.created)
1989
# LastEnabled - property
1990
@dbus_service_property(_interface, signature="s", access="read")
1991
def LastEnabled_dbus_property(self):
1992
return datetime_to_dbus(self.last_enabled)
1994
# Enabled - property
1995
@dbus_service_property(_interface,
1998
def Enabled_dbus_property(self, value=None):
1999
if value is None: # get
2000
return dbus.Boolean(self.enabled)
2006
# LastCheckedOK - property
2007
@dbus_service_property(_interface,
2010
def LastCheckedOK_dbus_property(self, value=None):
2011
if value is not None:
2014
return datetime_to_dbus(self.last_checked_ok)
2016
# LastCheckerStatus - property
2017
@dbus_service_property(_interface, signature="n", access="read")
2018
def LastCheckerStatus_dbus_property(self):
2019
return dbus.Int16(self.last_checker_status)
2021
# Expires - property
2022
@dbus_service_property(_interface, signature="s", access="read")
2023
def Expires_dbus_property(self):
2024
return datetime_to_dbus(self.expires)
2026
# LastApprovalRequest - property
2027
@dbus_service_property(_interface, signature="s", access="read")
2028
def LastApprovalRequest_dbus_property(self):
2029
return datetime_to_dbus(self.last_approval_request)
2031
# Timeout - property
2032
@dbus_service_property(_interface,
2035
def Timeout_dbus_property(self, value=None):
2036
if value is None: # get
2037
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2038
old_timeout = self.timeout
2039
self.timeout = datetime.timedelta(0, 0, 0, value)
2040
# Reschedule disabling
2042
now = datetime.datetime.utcnow()
2043
self.expires += self.timeout - old_timeout
2044
if self.expires <= now:
2045
# The timeout has passed
2048
if (getattr(self, "disable_initiator_tag", None)
2051
GLib.source_remove(self.disable_initiator_tag)
2052
self.disable_initiator_tag = GLib.timeout_add(
2053
int((self.expires - now).total_seconds() * 1000),
2056
# ExtendedTimeout - property
2057
@dbus_service_property(_interface,
2060
def ExtendedTimeout_dbus_property(self, value=None):
2061
if value is None: # get
2062
return dbus.UInt64(self.extended_timeout.total_seconds()
2064
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2066
# Interval - property
2067
@dbus_service_property(_interface,
2070
def Interval_dbus_property(self, value=None):
2071
if value is None: # get
2072
return dbus.UInt64(self.interval.total_seconds() * 1000)
2073
self.interval = datetime.timedelta(0, 0, 0, value)
2074
if getattr(self, "checker_initiator_tag", None) is None:
2077
# Reschedule checker run
2078
GLib.source_remove(self.checker_initiator_tag)
2079
self.checker_initiator_tag = GLib.timeout_add(
2080
value, self.start_checker)
2081
self.start_checker() # Start one now, too
2083
# Checker - property
2084
@dbus_service_property(_interface,
2087
def Checker_dbus_property(self, value=None):
2088
if value is None: # get
2089
return dbus.String(self.checker_command)
2090
self.checker_command = str(value)
2092
# CheckerRunning - property
2093
@dbus_service_property(_interface,
2096
def CheckerRunning_dbus_property(self, value=None):
2097
if value is None: # get
2098
return dbus.Boolean(self.checker is not None)
2100
self.start_checker()
2104
# ObjectPath - property
2106
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2107
"org.freedesktop.DBus.Deprecated": "true"})
2108
@dbus_service_property(_interface, signature="o", access="read")
2109
def ObjectPath_dbus_property(self):
2110
return self.dbus_object_path # is already a dbus.ObjectPath
2114
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2116
@dbus_service_property(_interface,
2120
def Secret_dbus_property(self, value):
2121
self.secret = bytes(value)
2126
class ProxyClient(object):
2127
def __init__(self, child_pipe, fpr, address):
2128
self._pipe = child_pipe
2129
self._pipe.send(('init', fpr, address))
2130
if not self._pipe.recv():
2133
def __getattribute__(self, name):
2135
return super(ProxyClient, self).__getattribute__(name)
2136
self._pipe.send(('getattr', name))
2137
data = self._pipe.recv()
2138
if data[0] == 'data':
2140
if data[0] == 'function':
2142
def func(*args, **kwargs):
2143
self._pipe.send(('funcall', name, args, kwargs))
2144
return self._pipe.recv()[1]
2148
def __setattr__(self, name, value):
2150
return super(ProxyClient, self).__setattr__(name, value)
2151
self._pipe.send(('setattr', name, value))
2154
class ClientHandler(socketserver.BaseRequestHandler, object):
2155
"""A class to handle client connections.
2157
Instantiated once for each connection to handle it.
371
def still_valid(self):
372
"""Has the timeout not yet passed for this client?"""
373
now = datetime.datetime.now()
374
if self.last_checked_ok is None:
375
return now < (self.created + self.timeout)
377
return now < (self.last_checked_ok + self.timeout)
380
def peer_certificate(session):
381
"Return the peer's OpenPGP certificate as a bytestring"
382
# If not an OpenPGP certificate...
383
if gnutls.library.functions.gnutls_certificate_type_get\
384
(session._c_object) \
385
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
386
# ...do the normal thing
387
return session.peer_certificate
388
list_size = ctypes.c_uint()
389
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
390
(session._c_object, ctypes.byref(list_size))
391
if list_size.value == 0:
394
return ctypes.string_at(cert.data, cert.size)
397
def fingerprint(openpgp):
398
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
399
# New empty GnuTLS certificate
400
crt = gnutls.library.types.gnutls_openpgp_crt_t()
401
gnutls.library.functions.gnutls_openpgp_crt_init\
403
# New GnuTLS "datum" with the OpenPGP public key
404
datum = gnutls.library.types.gnutls_datum_t\
405
(ctypes.cast(ctypes.c_char_p(openpgp),
406
ctypes.POINTER(ctypes.c_ubyte)),
407
ctypes.c_uint(len(openpgp)))
408
# Import the OpenPGP public key into the certificate
409
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
412
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
# New buffer for the fingerprint
414
buffer = ctypes.create_string_buffer(20)
415
buffer_length = ctypes.c_size_t()
416
# Get the fingerprint from the certificate into the buffer
417
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
418
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
419
# Deinit the certificate
420
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
421
# Convert the buffer to a Python bytestring
422
fpr = ctypes.string_at(buffer, buffer_length.value)
423
# Convert the bytestring to hexadecimal notation
424
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
428
class tcp_handler(SocketServer.BaseRequestHandler, object):
429
"""A TCP request handler class.
430
Instantiated by IPv6_TCPServer for each request to handle it.
2158
431
Note: This will run in its own forked process."""
2160
433
def handle(self):
2161
with contextlib.closing(self.server.child_pipe) as child_pipe:
2162
logger.info("TCP connection from: %s",
2163
str(self.client_address))
2164
logger.debug("Pipe FD: %d",
2165
self.server.child_pipe.fileno())
2167
session = gnutls.ClientSession(self.request)
2169
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
2170
# "+AES-256-CBC", "+SHA1",
2171
# "+COMP-NULL", "+CTYPE-OPENPGP",
2173
# Use a fallback default, since this MUST be set.
2174
priority = self.server.gnutls_priority
2175
if priority is None:
2177
gnutls.priority_set_direct(session._c_object, priority,
2180
# Start communication using the Mandos protocol
2181
# Get protocol number
2182
line = self.request.makefile().readline()
2183
logger.debug("Protocol version: %r", line)
2185
if int(line.strip().split()[0]) > 1:
2186
raise RuntimeError(line)
2187
except (ValueError, IndexError, RuntimeError) as error:
2188
logger.error("Unknown protocol version: %s", error)
2191
# Start GnuTLS connection
2194
except gnutls.Error as error:
2195
logger.warning("Handshake failed: %s", error)
2196
# Do not run session.bye() here: the session is not
2197
# established. Just abandon the request.
2199
logger.debug("Handshake succeeded")
2201
approval_required = False
2204
fpr = self.fingerprint(
2205
self.peer_certificate(session))
2206
except (TypeError, gnutls.Error) as error:
2207
logger.warning("Bad certificate: %s", error)
2209
logger.debug("Fingerprint: %s", fpr)
2212
client = ProxyClient(child_pipe, fpr,
2213
self.client_address)
2217
if client.approval_delay:
2218
delay = client.approval_delay
2219
client.approvals_pending += 1
2220
approval_required = True
2223
if not client.enabled:
2224
logger.info("Client %s is disabled",
2226
if self.server.use_dbus:
2228
client.Rejected("Disabled")
2231
if client.approved or not client.approval_delay:
2232
#We are approved or approval is disabled
2234
elif client.approved is None:
2235
logger.info("Client %s needs approval",
2237
if self.server.use_dbus:
2239
client.NeedApproval(
2240
client.approval_delay.total_seconds()
2241
* 1000, client.approved_by_default)
2243
logger.warning("Client %s was not approved",
2245
if self.server.use_dbus:
2247
client.Rejected("Denied")
2250
#wait until timeout or approved
2251
time = datetime.datetime.now()
2252
client.changedstate.acquire()
2253
client.changedstate.wait(delay.total_seconds())
2254
client.changedstate.release()
2255
time2 = datetime.datetime.now()
2256
if (time2 - time) >= delay:
2257
if not client.approved_by_default:
2258
logger.warning("Client %s timed out while"
2259
" waiting for approval",
2261
if self.server.use_dbus:
2263
client.Rejected("Approval timed out")
2268
delay -= time2 - time
2271
session.send(client.secret)
2272
except gnutls.Error as error:
2273
logger.warning("gnutls send failed",
2277
logger.info("Sending secret to %s", client.name)
2278
# bump the timeout using extended_timeout
2279
client.bump_timeout(client.extended_timeout)
2280
if self.server.use_dbus:
2285
if approval_required:
2286
client.approvals_pending -= 1
2289
except gnutls.Error as error:
2290
logger.warning("GnuTLS bye failed",
2294
def peer_certificate(session):
2295
"Return the peer's OpenPGP certificate as a bytestring"
2296
# If not an OpenPGP certificate...
2297
if (gnutls.certificate_type_get(session._c_object)
2298
!= gnutls.CRT_OPENPGP):
2299
# ...return invalid data
2301
list_size = ctypes.c_uint(1)
2302
cert_list = (gnutls.certificate_get_peers
2303
(session._c_object, ctypes.byref(list_size)))
2304
if not bool(cert_list) and list_size.value != 0:
2305
raise gnutls.Error("error getting peer certificate")
2306
if list_size.value == 0:
2309
return ctypes.string_at(cert.data, cert.size)
2312
def fingerprint(openpgp):
2313
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2314
# New GnuTLS "datum" with the OpenPGP public key
2315
datum = gnutls.datum_t(
2316
ctypes.cast(ctypes.c_char_p(openpgp),
2317
ctypes.POINTER(ctypes.c_ubyte)),
2318
ctypes.c_uint(len(openpgp)))
2319
# New empty GnuTLS certificate
2320
crt = gnutls.openpgp_crt_t()
2321
gnutls.openpgp_crt_init(ctypes.byref(crt))
2322
# Import the OpenPGP public key into the certificate
2323
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2324
gnutls.OPENPGP_FMT_RAW)
2325
# Verify the self signature in the key
2326
crtverify = ctypes.c_uint()
2327
gnutls.openpgp_crt_verify_self(crt, 0,
2328
ctypes.byref(crtverify))
2329
if crtverify.value != 0:
2330
gnutls.openpgp_crt_deinit(crt)
2331
raise gnutls.CertificateSecurityError("Verify failed")
2332
# New buffer for the fingerprint
2333
buf = ctypes.create_string_buffer(20)
2334
buf_len = ctypes.c_size_t()
2335
# Get the fingerprint from the certificate into the buffer
2336
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2337
ctypes.byref(buf_len))
2338
# Deinit the certificate
2339
gnutls.openpgp_crt_deinit(crt)
2340
# Convert the buffer to a Python bytestring
2341
fpr = ctypes.string_at(buf, buf_len.value)
2342
# Convert the bytestring to hexadecimal notation
2343
hex_fpr = binascii.hexlify(fpr).upper()
2347
class MultiprocessingMixIn(object):
2348
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2350
def sub_process_main(self, request, address):
2352
self.finish_request(request, address)
2354
self.handle_error(request, address)
2355
self.close_request(request)
2357
def process_request(self, request, address):
2358
"""Start a new process to process the request."""
2359
proc = multiprocessing.Process(target = self.sub_process_main,
2360
args = (request, address))
2365
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2366
""" adds a pipe to the MixIn """
2368
def process_request(self, request, client_address):
2369
"""Overrides and wraps the original process_request().
2371
This function creates a new pipe in self.pipe
2373
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2375
proc = MultiprocessingMixIn.process_request(self, request,
2377
self.child_pipe.close()
2378
self.add_pipe(parent_pipe, proc)
2380
def add_pipe(self, parent_pipe, proc):
2381
"""Dummy function; override as necessary"""
2382
raise NotImplementedError()
2385
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2386
socketserver.TCPServer, object):
2387
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
434
logger.debug(u"TCP connection from: %s",
435
unicode(self.client_address))
436
session = gnutls.connection.ClientSession\
437
(self.request, gnutls.connection.X509Credentials())
439
line = self.request.makefile().readline()
440
logger.debug(u"Protocol version: %r", line)
442
if int(line.strip().split()[0]) > 1:
444
except (ValueError, IndexError, RuntimeError), error:
445
logger.error(u"Unknown protocol version: %s", error)
448
# Note: gnutls.connection.X509Credentials is really a generic
449
# GnuTLS certificate credentials object so long as no X.509
450
# keys are added to it. Therefore, we can use it here despite
451
# using OpenPGP certificates.
453
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
454
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
456
priority = "NORMAL" # Fallback default, since this
458
if self.server.settings["priority"]:
459
priority = self.server.settings["priority"]
460
gnutls.library.functions.gnutls_priority_set_direct\
461
(session._c_object, priority, None);
465
except gnutls.errors.GNUTLSError, error:
466
logger.debug(u"Handshake failed: %s", error)
467
# Do not run session.bye() here: the session is not
468
# established. Just abandon the request.
471
fpr = fingerprint(peer_certificate(session))
472
except (TypeError, gnutls.errors.GNUTLSError), error:
473
logger.debug(u"Bad certificate: %s", error)
476
logger.debug(u"Fingerprint: %s", fpr)
478
for c in self.server.clients:
479
if c.fingerprint == fpr:
483
logger.debug(u"Client not found for fingerprint: %s", fpr)
486
# Have to check if client.still_valid(), since it is possible
487
# that the client timed out while establishing the GnuTLS
489
if not client.still_valid():
490
logger.debug(u"Client %(name)s is invalid", vars(client))
494
while sent_size < len(client.secret):
495
sent = session.send(client.secret[sent_size:])
496
logger.debug(u"Sent: %d, remaining: %d",
497
sent, len(client.secret)
498
- (sent_size + sent))
503
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
504
"""IPv6 TCP server. Accepts 'None' as address and/or port.
2390
enabled: Boolean; whether this server is activated yet
2391
interface: None or a network interface name (string)
2392
use_ipv6: Boolean; to use IPv6 or not
506
settings: Server settings
507
clients: Set() of Client objects
2395
def __init__(self, server_address, RequestHandlerClass,
2399
"""If socketfd is set, use that file descriptor instead of
2400
creating a new one with socket.socket().
2402
self.interface = interface
2404
self.address_family = socket.AF_INET6
2405
if socketfd is not None:
2406
# Save the file descriptor
2407
self.socketfd = socketfd
2408
# Save the original socket.socket() function
2409
self.socket_socket = socket.socket
2410
# To implement --socket, we monkey patch socket.socket.
2412
# (When socketserver.TCPServer is a new-style class, we
2413
# could make self.socket into a property instead of monkey
2414
# patching socket.socket.)
2416
# Create a one-time-only replacement for socket.socket()
2417
@functools.wraps(socket.socket)
2418
def socket_wrapper(*args, **kwargs):
2419
# Restore original function so subsequent calls are
2421
socket.socket = self.socket_socket
2422
del self.socket_socket
2423
# This time only, return a new socket object from the
2424
# saved file descriptor.
2425
return socket.fromfd(self.socketfd, *args, **kwargs)
2426
# Replace socket.socket() function with wrapper
2427
socket.socket = socket_wrapper
2428
# The socketserver.TCPServer.__init__ will call
2429
# socket.socket(), which might be our replacement,
2430
# socket_wrapper(), if socketfd was set.
2431
socketserver.TCPServer.__init__(self, server_address,
2432
RequestHandlerClass)
509
address_family = socket.AF_INET6
510
def __init__(self, *args, **kwargs):
511
if "settings" in kwargs:
512
self.settings = kwargs["settings"]
513
del kwargs["settings"]
514
if "clients" in kwargs:
515
self.clients = kwargs["clients"]
516
del kwargs["clients"]
517
return super(type(self), self).__init__(*args, **kwargs)
2434
518
def server_bind(self):
2435
519
"""This overrides the normal server_bind() function
2436
520
to bind to an interface if one was specified, and also NOT to
2437
521
bind to an address or port if they were not specified."""
2438
if self.interface is not None:
2439
if SO_BINDTODEVICE is None:
2440
logger.error("SO_BINDTODEVICE does not exist;"
2441
" cannot bind to interface %s",
2445
self.socket.setsockopt(
2446
socket.SOL_SOCKET, SO_BINDTODEVICE,
2447
(self.interface + "\0").encode("utf-8"))
2448
except socket.error as error:
2449
if error.errno == errno.EPERM:
2450
logger.error("No permission to bind to"
2451
" interface %s", self.interface)
2452
elif error.errno == errno.ENOPROTOOPT:
2453
logger.error("SO_BINDTODEVICE not available;"
2454
" cannot bind to interface %s",
2456
elif error.errno == errno.ENODEV:
2457
logger.error("Interface %s does not exist,"
2458
" cannot bind", self.interface)
522
if self.settings["interface"]:
523
# 25 is from /usr/include/asm-i486/socket.h
524
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
526
self.socket.setsockopt(socket.SOL_SOCKET,
528
self.settings["interface"])
529
except socket.error, error:
530
if error[0] == errno.EPERM:
531
logger.warning(u"No permission to"
532
u" bind to interface %s",
533
self.settings["interface"])
2461
536
# Only bind(2) the socket if we really need to.
2462
537
if self.server_address[0] or self.server_address[1]:
2463
538
if not self.server_address[0]:
2464
if self.address_family == socket.AF_INET6:
2465
any_address = "::" # in6addr_any
2467
any_address = "0.0.0.0" # INADDR_ANY
2468
self.server_address = (any_address,
540
self.server_address = (in6addr_any,
2469
541
self.server_address[1])
2470
elif not self.server_address[1]:
2471
self.server_address = (self.server_address[0], 0)
2472
# if self.interface:
2473
# self.server_address = (self.server_address[0],
2478
return socketserver.TCPServer.server_bind(self)
2481
class MandosServer(IPv6_TCPServer):
2485
clients: set of Client objects
2486
gnutls_priority GnuTLS priority string
2487
use_dbus: Boolean; to emit D-Bus signals or not
2489
Assumes a GLib.MainLoop event loop.
2492
def __init__(self, server_address, RequestHandlerClass,
2496
gnutls_priority=None,
2499
self.enabled = False
2500
self.clients = clients
2501
if self.clients is None:
2503
self.use_dbus = use_dbus
2504
self.gnutls_priority = gnutls_priority
2505
IPv6_TCPServer.__init__(self, server_address,
2506
RequestHandlerClass,
2507
interface = interface,
2508
use_ipv6 = use_ipv6,
2509
socketfd = socketfd)
2511
def server_activate(self):
2513
return socketserver.TCPServer.server_activate(self)
2518
def add_pipe(self, parent_pipe, proc):
2519
# Call "handle_ipc" for both data and EOF events
2521
parent_pipe.fileno(),
2522
GLib.IO_IN | GLib.IO_HUP,
2523
functools.partial(self.handle_ipc,
2524
parent_pipe = parent_pipe,
2527
def handle_ipc(self, source, condition,
2530
client_object=None):
2531
# error, or the other end of multiprocessing.Pipe has closed
2532
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2533
# Wait for other process to exit
2537
# Read a request from the child
2538
request = parent_pipe.recv()
2539
command = request[0]
2541
if command == 'init':
2543
address = request[2]
2545
for c in self.clients.values():
2546
if c.fingerprint == fpr:
2550
logger.info("Client not found for fingerprint: %s, ad"
2551
"dress: %s", fpr, address)
2554
mandos_dbus_service.ClientNotFound(fpr,
2556
parent_pipe.send(False)
2560
parent_pipe.fileno(),
2561
GLib.IO_IN | GLib.IO_HUP,
2562
functools.partial(self.handle_ipc,
2563
parent_pipe = parent_pipe,
2565
client_object = client))
2566
parent_pipe.send(True)
2567
# remove the old hook in favor of the new above hook on
2570
if command == 'funcall':
2571
funcname = request[1]
2575
parent_pipe.send(('data', getattr(client_object,
2579
if command == 'getattr':
2580
attrname = request[1]
2581
if isinstance(client_object.__getattribute__(attrname),
2582
collections.Callable):
2583
parent_pipe.send(('function', ))
2586
'data', client_object.__getattribute__(attrname)))
2588
if command == 'setattr':
2589
attrname = request[1]
2591
setattr(client_object, attrname, value)
2596
def rfc3339_duration_to_delta(duration):
2597
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2599
>>> rfc3339_duration_to_delta("P7D")
2600
datetime.timedelta(7)
2601
>>> rfc3339_duration_to_delta("PT60S")
2602
datetime.timedelta(0, 60)
2603
>>> rfc3339_duration_to_delta("PT60M")
2604
datetime.timedelta(0, 3600)
2605
>>> rfc3339_duration_to_delta("PT24H")
2606
datetime.timedelta(1)
2607
>>> rfc3339_duration_to_delta("P1W")
2608
datetime.timedelta(7)
2609
>>> rfc3339_duration_to_delta("PT5M30S")
2610
datetime.timedelta(0, 330)
2611
>>> rfc3339_duration_to_delta("P1DT3M20S")
2612
datetime.timedelta(1, 200)
2615
# Parsing an RFC 3339 duration with regular expressions is not
2616
# possible - there would have to be multiple places for the same
2617
# values, like seconds. The current code, while more esoteric, is
2618
# cleaner without depending on a parsing library. If Python had a
2619
# built-in library for parsing we would use it, but we'd like to
2620
# avoid excessive use of external libraries.
2622
# New type for defining tokens, syntax, and semantics all-in-one
2623
Token = collections.namedtuple("Token", (
2624
"regexp", # To match token; if "value" is not None, must have
2625
# a "group" containing digits
2626
"value", # datetime.timedelta or None
2627
"followers")) # Tokens valid after this token
2628
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2629
# the "duration" ABNF definition in RFC 3339, Appendix A.
2630
token_end = Token(re.compile(r"$"), None, frozenset())
2631
token_second = Token(re.compile(r"(\d+)S"),
2632
datetime.timedelta(seconds=1),
2633
frozenset((token_end, )))
2634
token_minute = Token(re.compile(r"(\d+)M"),
2635
datetime.timedelta(minutes=1),
2636
frozenset((token_second, token_end)))
2637
token_hour = Token(re.compile(r"(\d+)H"),
2638
datetime.timedelta(hours=1),
2639
frozenset((token_minute, token_end)))
2640
token_time = Token(re.compile(r"T"),
2642
frozenset((token_hour, token_minute,
2644
token_day = Token(re.compile(r"(\d+)D"),
2645
datetime.timedelta(days=1),
2646
frozenset((token_time, token_end)))
2647
token_month = Token(re.compile(r"(\d+)M"),
2648
datetime.timedelta(weeks=4),
2649
frozenset((token_day, token_end)))
2650
token_year = Token(re.compile(r"(\d+)Y"),
2651
datetime.timedelta(weeks=52),
2652
frozenset((token_month, token_end)))
2653
token_week = Token(re.compile(r"(\d+)W"),
2654
datetime.timedelta(weeks=1),
2655
frozenset((token_end, )))
2656
token_duration = Token(re.compile(r"P"), None,
2657
frozenset((token_year, token_month,
2658
token_day, token_time,
2660
# Define starting values
2661
value = datetime.timedelta() # Value so far
2663
followers = frozenset((token_duration, )) # Following valid tokens
2664
s = duration # String left to parse
2665
# Loop until end token is found
2666
while found_token is not token_end:
2667
# Search for any currently valid tokens
2668
for token in followers:
2669
match = token.regexp.match(s)
2670
if match is not None:
2672
if token.value is not None:
2673
# Value found, parse digits
2674
factor = int(match.group(1), 10)
2675
# Add to value so far
2676
value += factor * token.value
2677
# Strip token from string
2678
s = token.regexp.sub("", s, 1)
2681
# Set valid next tokens
2682
followers = found_token.followers
2685
# No currently valid tokens were found
2686
raise ValueError("Invalid RFC 3339 duration: {!r}"
542
elif self.server_address[1] is None:
543
self.server_address = (self.server_address[0],
545
return super(type(self), self).server_bind()
2692
548
def string_to_delta(interval):
2693
549
"""Parse a string and return a datetime.timedelta
2695
551
>>> string_to_delta('7d')
2696
552
datetime.timedelta(7)
2697
553
>>> string_to_delta('60s')
2823
686
"debug": "False",
2825
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2826
":+SIGN-DSA-SHA256",
688
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2827
689
"servicename": "Mandos",
2833
"statedir": "/var/lib/mandos",
2834
"foreground": "False",
2838
692
# Parse config file for server-global settings
2839
server_config = configparser.SafeConfigParser(server_defaults)
693
server_config = ConfigParser.SafeConfigParser(server_defaults)
2840
694
del server_defaults
2841
server_config.read(os.path.join(options.configdir, "mandos.conf"))
695
server_config.read(os.path.join(options.configdir, "server.conf"))
696
server_section = "server"
2842
697
# Convert the SafeConfigParser object to a dict
2843
server_settings = server_config.defaults()
2844
# Use the appropriate methods on the non-string config options
2845
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2846
server_settings[option] = server_config.getboolean("DEFAULT",
2848
if server_settings["port"]:
2849
server_settings["port"] = server_config.getint("DEFAULT",
2851
if server_settings["socket"]:
2852
server_settings["socket"] = server_config.getint("DEFAULT",
2854
# Later, stdin will, and stdout and stderr might, be dup'ed
2855
# over with an opened os.devnull. But we don't want this to
2856
# happen with a supplied network socket.
2857
if 0 <= server_settings["socket"] <= 2:
2858
server_settings["socket"] = os.dup(server_settings
698
server_settings = dict(server_config.items(server_section))
699
# Use getboolean on the boolean config option
700
server_settings["debug"] = server_config.getboolean\
701
(server_section, "debug")
2860
702
del server_config
2862
704
# Override the settings from the config file with command line
2863
705
# options, if set.
2864
706
for option in ("interface", "address", "port", "debug",
2865
"priority", "servicename", "configdir", "use_dbus",
2866
"use_ipv6", "debuglevel", "restore", "statedir",
2867
"socket", "foreground", "zeroconf"):
707
"priority", "servicename", "configdir"):
2868
708
value = getattr(options, option)
2869
709
if value is not None:
2870
710
server_settings[option] = value
2872
# Force all strings to be unicode
2873
for option in server_settings.keys():
2874
if isinstance(server_settings[option], bytes):
2875
server_settings[option] = (server_settings[option]
2877
# Force all boolean options to be boolean
2878
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2879
"foreground", "zeroconf"):
2880
server_settings[option] = bool(server_settings[option])
2881
# Debug implies foreground
2882
if server_settings["debug"]:
2883
server_settings["foreground"] = True
2884
712
# Now we have our good server settings in "server_settings"
2886
##################################################################
2888
if (not server_settings["zeroconf"]
2889
and not (server_settings["port"]
2890
or server_settings["socket"] != "")):
2891
parser.error("Needs port or socket to work without Zeroconf")
2894
debug = server_settings["debug"]
2895
debuglevel = server_settings["debuglevel"]
2896
use_dbus = server_settings["use_dbus"]
2897
use_ipv6 = server_settings["use_ipv6"]
2898
stored_state_path = os.path.join(server_settings["statedir"],
2900
foreground = server_settings["foreground"]
2901
zeroconf = server_settings["zeroconf"]
2904
initlogger(debug, logging.DEBUG)
2909
level = getattr(logging, debuglevel.upper())
2910
initlogger(debug, level)
2912
if server_settings["servicename"] != "Mandos":
2913
syslogger.setFormatter(
2914
logging.Formatter('Mandos ({}) [%(process)d]:'
2915
' %(levelname)s: %(message)s'.format(
2916
server_settings["servicename"])))
2918
714
# Parse config file with clients
2919
client_config = configparser.SafeConfigParser(Client
715
client_defaults = { "timeout": "1h",
717
"checker": "fping -q -- %%(fqdn)s",
719
client_config = ConfigParser.SafeConfigParser(client_defaults)
2921
720
client_config.read(os.path.join(server_settings["configdir"],
2922
721
"clients.conf"))
2924
global mandos_dbus_service
2925
mandos_dbus_service = None
2928
if server_settings["socket"] != "":
2929
socketfd = server_settings["socket"]
2930
tcp_server = MandosServer(
2931
(server_settings["address"], server_settings["port"]),
2933
interface=(server_settings["interface"] or None),
2935
gnutls_priority=server_settings["priority"],
2939
pidfilename = "/run/mandos.pid"
2940
if not os.path.isdir("/run/."):
2941
pidfilename = "/var/run/mandos.pid"
2944
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2945
except IOError as e:
2946
logger.error("Could not open file %r", pidfilename,
2949
for name, group in (("_mandos", "_mandos"),
2950
("mandos", "mandos"),
2951
("nobody", "nogroup")):
2953
uid = pwd.getpwnam(name).pw_uid
2954
gid = pwd.getpwnam(group).pw_gid
2965
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2967
except OSError as error:
2968
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2969
.format(uid, gid, os.strerror(error.errno)))
2970
if error.errno != errno.EPERM:
2974
# Enable all possible GnuTLS debugging
2976
# "Use a log level over 10 to enable all debugging options."
2978
gnutls.global_set_log_level(11)
2981
def debug_gnutls(level, string):
2982
logger.debug("GnuTLS: %s", string[:-1])
2984
gnutls.global_set_log_function(debug_gnutls)
2986
# Redirect stdin so all checkers get /dev/null
2987
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2988
os.dup2(null, sys.stdin.fileno())
2992
# Need to fork before connecting to D-Bus
2994
# Close all input and output, do double fork, etc.
2997
# multiprocessing will use threads, so before we use GLib we need
2998
# to inform GLib that threads will be used.
724
service = AvahiService(name = server_settings["servicename"],
725
type = "_mandos._tcp", );
726
if server_settings["interface"]:
727
service.interface = if_nametoindex(server_settings["interface"])
3001
729
global main_loop
3002
732
# From the Avahi example code
3003
DBusGMainLoop(set_as_default=True)
3004
main_loop = GLib.MainLoop()
733
DBusGMainLoop(set_as_default=True )
734
main_loop = gobject.MainLoop()
3005
735
bus = dbus.SystemBus()
736
server = dbus.Interface(
737
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
738
avahi.DBUS_INTERFACE_SERVER )
3006
739
# End of Avahi example code
3009
bus_name = dbus.service.BusName("se.recompile.Mandos",
3012
old_bus_name = dbus.service.BusName(
3013
"se.bsnet.fukt.Mandos", bus,
3015
except dbus.exceptions.DBusException as e:
3016
logger.error("Disabling D-Bus:", exc_info=e)
3018
server_settings["use_dbus"] = False
3019
tcp_server.use_dbus = False
3021
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3022
service = AvahiServiceToSyslog(
3023
name = server_settings["servicename"],
3024
servicetype = "_mandos._tcp",
3025
protocol = protocol,
3027
if server_settings["interface"]:
3028
service.interface = if_nametoindex(
3029
server_settings["interface"].encode("utf-8"))
3031
global multiprocessing_manager
3032
multiprocessing_manager = multiprocessing.Manager()
3034
client_class = Client
3036
client_class = functools.partial(ClientDBus, bus = bus)
3038
client_settings = Client.config_parser(client_config)
3039
old_client_settings = {}
3042
# This is used to redirect stdout and stderr for checker processes
3044
wnull = open(os.devnull, "w") # A writable /dev/null
3045
# Only used if server is running in foreground but not in debug
3047
if debug or not foreground:
3050
# Get client data and settings from last running state.
3051
if server_settings["restore"]:
3053
with open(stored_state_path, "rb") as stored_state:
3054
if sys.version_info.major == 2:
3055
clients_data, old_client_settings = pickle.load(
3058
bytes_clients_data, bytes_old_client_settings = (
3059
pickle.load(stored_state, encoding = "bytes"))
3060
### Fix bytes to strings
3063
clients_data = { (key.decode("utf-8")
3064
if isinstance(key, bytes)
3067
bytes_clients_data.items() }
3068
del bytes_clients_data
3069
for key in clients_data:
3070
value = { (k.decode("utf-8")
3071
if isinstance(k, bytes) else k): v
3073
clients_data[key].items() }
3074
clients_data[key] = value
3076
value["client_structure"] = [
3078
if isinstance(s, bytes)
3080
value["client_structure"] ]
3082
for k in ("name", "host"):
3083
if isinstance(value[k], bytes):
3084
value[k] = value[k].decode("utf-8")
3085
## old_client_settings
3087
old_client_settings = {
3088
(key.decode("utf-8")
3089
if isinstance(key, bytes)
3092
bytes_old_client_settings.items() }
3093
del bytes_old_client_settings
3095
for value in old_client_settings.values():
3096
if isinstance(value["host"], bytes):
3097
value["host"] = (value["host"]
3099
os.remove(stored_state_path)
3100
except IOError as e:
3101
if e.errno == errno.ENOENT:
3102
logger.warning("Could not load persistent state:"
3103
" {}".format(os.strerror(e.errno)))
3105
logger.critical("Could not load persistent state:",
3108
except EOFError as e:
3109
logger.warning("Could not load persistent state: "
3113
with PGPEngine() as pgp:
3114
for client_name, client in clients_data.items():
3115
# Skip removed clients
3116
if client_name not in client_settings:
3119
# Decide which value to use after restoring saved state.
3120
# We have three different values: Old config file,
3121
# new config file, and saved state.
3122
# New config value takes precedence if it differs from old
3123
# config value, otherwise use saved state.
3124
for name, value in client_settings[client_name].items():
3126
# For each value in new config, check if it
3127
# differs from the old config value (Except for
3128
# the "secret" attribute)
3129
if (name != "secret"
3131
old_client_settings[client_name][name])):
3132
client[name] = value
3136
# Clients who has passed its expire date can still be
3137
# enabled if its last checker was successful. A Client
3138
# whose checker succeeded before we stored its state is
3139
# assumed to have successfully run all checkers during
3141
if client["enabled"]:
3142
if datetime.datetime.utcnow() >= client["expires"]:
3143
if not client["last_checked_ok"]:
3145
"disabling client {} - Client never "
3146
"performed a successful checker".format(
3148
client["enabled"] = False
3149
elif client["last_checker_status"] != 0:
3151
"disabling client {} - Client last"
3152
" checker failed with error code"
3155
client["last_checker_status"]))
3156
client["enabled"] = False
3158
client["expires"] = (
3159
datetime.datetime.utcnow()
3160
+ client["timeout"])
3161
logger.debug("Last checker succeeded,"
3162
" keeping {} enabled".format(
3165
client["secret"] = pgp.decrypt(
3166
client["encrypted_secret"],
3167
client_settings[client_name]["secret"])
3169
# If decryption fails, we use secret from new settings
3170
logger.debug("Failed to decrypt {} old secret".format(
3172
client["secret"] = (client_settings[client_name]
3175
# Add/remove clients based on new changes made to config
3176
for client_name in (set(old_client_settings)
3177
- set(client_settings)):
3178
del clients_data[client_name]
3179
for client_name in (set(client_settings)
3180
- set(old_client_settings)):
3181
clients_data[client_name] = client_settings[client_name]
3183
# Create all client objects
3184
for client_name, client in clients_data.items():
3185
tcp_server.clients[client_name] = client_class(
3188
server_settings = server_settings)
3190
if not tcp_server.clients:
3191
logger.warning("No clients defined")
3194
if pidfile is not None:
3198
print(pid, file=pidfile)
3200
logger.error("Could not write to file %r with PID %d",
3205
for termsig in (signal.SIGHUP, signal.SIGTERM):
3206
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3207
lambda: main_loop.quit() and False)
3211
@alternate_dbus_interfaces(
3212
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3213
class MandosDBusService(DBusObjectWithObjectManager):
3214
"""A D-Bus proxy object"""
3217
dbus.service.Object.__init__(self, bus, "/")
3219
_interface = "se.recompile.Mandos"
3221
@dbus.service.signal(_interface, signature="o")
3222
def ClientAdded(self, objpath):
3226
@dbus.service.signal(_interface, signature="ss")
3227
def ClientNotFound(self, fingerprint, address):
3231
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3233
@dbus.service.signal(_interface, signature="os")
3234
def ClientRemoved(self, objpath, name):
3238
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3240
@dbus.service.method(_interface, out_signature="ao")
3241
def GetAllClients(self):
3243
return dbus.Array(c.dbus_object_path for c in
3244
tcp_server.clients.values())
3246
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3248
@dbus.service.method(_interface,
3249
out_signature="a{oa{sv}}")
3250
def GetAllClientsWithProperties(self):
3252
return dbus.Dictionary(
3253
{ c.dbus_object_path: c.GetAll(
3254
"se.recompile.Mandos.Client")
3255
for c in tcp_server.clients.values() },
3258
@dbus.service.method(_interface, in_signature="o")
3259
def RemoveClient(self, object_path):
3261
for c in tcp_server.clients.values():
3262
if c.dbus_object_path == object_path:
3263
del tcp_server.clients[c.name]
3264
c.remove_from_connection()
3265
# Don't signal the disabling
3266
c.disable(quiet=True)
3267
# Emit D-Bus signal for removal
3268
self.client_removed_signal(c)
3270
raise KeyError(object_path)
3274
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3275
out_signature = "a{oa{sa{sv}}}")
3276
def GetManagedObjects(self):
3278
return dbus.Dictionary(
3279
{ client.dbus_object_path:
3281
{ interface: client.GetAll(interface)
3283
client._get_all_interface_names()})
3284
for client in tcp_server.clients.values()})
3286
def client_added_signal(self, client):
3287
"""Send the new standard signal and the old signal"""
3289
# New standard signal
3290
self.InterfacesAdded(
3291
client.dbus_object_path,
3293
{ interface: client.GetAll(interface)
3295
client._get_all_interface_names()}))
3297
self.ClientAdded(client.dbus_object_path)
3299
def client_removed_signal(self, client):
3300
"""Send the new standard signal and the old signal"""
3302
# New standard signal
3303
self.InterfacesRemoved(
3304
client.dbus_object_path,
3305
client._get_all_interface_names())
3307
self.ClientRemoved(client.dbus_object_path,
3310
mandos_dbus_service = MandosDBusService()
741
debug = server_settings["debug"]
744
console = logging.StreamHandler()
745
# console.setLevel(logging.DEBUG)
746
console.setFormatter(logging.Formatter\
747
('%(levelname)s: %(message)s'))
748
logger.addHandler(console)
752
def remove_from_clients(client):
753
clients.remove(client)
755
logger.debug(u"No clients left, exiting")
758
clients.update(Set(Client(name=section,
759
stop_hook = remove_from_clients,
760
**(dict(client_config\
762
for section in client_config.sections()))
3313
768
"Cleanup function; run on exit"
3317
multiprocessing.active_children()
3319
if not (tcp_server.clients or client_settings):
3322
# Store client before exiting. Secrets are encrypted with key
3323
# based on what config file has. If config file is
3324
# removed/edited, old secret will thus be unrecovable.
3326
with PGPEngine() as pgp:
3327
for client in tcp_server.clients.values():
3328
key = client_settings[client.name]["secret"]
3329
client.encrypted_secret = pgp.encrypt(client.secret,
3333
# A list of attributes that can not be pickled
3335
exclude = { "bus", "changedstate", "secret",
3336
"checker", "server_settings" }
3337
for name, typ in inspect.getmembers(dbus.service
3341
client_dict["encrypted_secret"] = (client
3343
for attr in client.client_structure:
3344
if attr not in exclude:
3345
client_dict[attr] = getattr(client, attr)
3347
clients[client.name] = client_dict
3348
del client_settings[client.name]["secret"]
3351
with tempfile.NamedTemporaryFile(
3355
dir=os.path.dirname(stored_state_path),
3356
delete=False) as stored_state:
3357
pickle.dump((clients, client_settings), stored_state,
3359
tempname = stored_state.name
3360
os.rename(tempname, stored_state_path)
3361
except (IOError, OSError) as e:
3367
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3368
logger.warning("Could not save persistent state: {}"
3369
.format(os.strerror(e.errno)))
3371
logger.warning("Could not save persistent state:",
3375
# Delete all clients, and settings from config
3376
while tcp_server.clients:
3377
name, client = tcp_server.clients.popitem()
3379
client.remove_from_connection()
3380
# Don't signal the disabling
3381
client.disable(quiet=True)
3382
# Emit D-Bus signal for removal
3384
mandos_dbus_service.client_removed_signal(client)
3385
client_settings.clear()
770
# From the Avahi example code
771
if not group is None:
774
# End of Avahi example code
777
client = clients.pop()
778
client.stop_hook = None
3387
781
atexit.register(cleanup)
3389
for client in tcp_server.clients.values():
3391
# Emit D-Bus signal for adding
3392
mandos_dbus_service.client_added_signal(client)
3393
# Need to initiate checking of clients
3395
client.init_checker()
3398
tcp_server.server_activate()
784
signal.signal(signal.SIGINT, signal.SIG_IGN)
785
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
786
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
788
for client in clients:
791
tcp_server = IPv6_TCPServer((server_settings["address"],
792
server_settings["port"]),
794
settings=server_settings,
3400
796
# Find out what port we got
3402
service.port = tcp_server.socket.getsockname()[1]
3404
logger.info("Now listening on address %r, port %d,"
3405
" flowinfo %d, scope_id %d",
3406
*tcp_server.socket.getsockname())
3408
logger.info("Now listening on address %r, port %d",
3409
*tcp_server.socket.getsockname())
797
service.port = tcp_server.socket.getsockname()[1]
798
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
799
u" scope_id %d" % tcp_server.socket.getsockname())
3411
801
#service.interface = tcp_server.socket.getsockname()[3]
3415
# From the Avahi example code
3418
except dbus.exceptions.DBusException as error:
3419
logger.critical("D-Bus Exception", exc_info=error)
3422
# End of Avahi example code
804
# From the Avahi example code
805
server.connect_to_signal("StateChanged", server_state_changed)
807
server_state_changed(server.GetState())
808
except dbus.exceptions.DBusException, error:
809
logger.critical(u"DBusException: %s", error)
811
# End of Avahi example code
3424
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3425
lambda *args, **kwargs:
3426
(tcp_server.handle_request
3427
(*args[2:], **kwargs) or True))
813
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
814
lambda *args, **kwargs:
815
tcp_server.handle_request\
816
(*args[2:], **kwargs) or True)
3429
818
logger.debug("Starting main loop")
819
main_loop_started = True
3431
except AvahiError as error:
3432
logger.critical("Avahi Error", exc_info=error)
821
except AvahiError, error:
822
logger.critical(u"AvahiError: %s" + unicode(error))
3435
824
except KeyboardInterrupt:
3437
print("", file=sys.stderr)
3438
logger.debug("Server received KeyboardInterrupt")
3439
logger.debug("Server exiting")
3440
# Must run before the D-Bus bus name gets deregistered
3444
828
if __name__ == '__main__':