2
# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos server - give out binary blobs to connecting clients.
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
# methods "add", "remove", "server_state_changed",
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
# "AvahiService" class, and some lines in "main".
9
# following functions: "AvahiService.add", "AvahiService.remove",
10
# "server_state_changed", "entry_group_state_changed", and some lines
13
13
# Everything else is
14
# Copyright © 2008-2020 Teddy Hogeborn
15
# Copyright © 2008-2020 Björn Påhlsson
17
# This file is part of Mandos.
19
# Mandos is free software: you can redistribute it and/or modify it
20
# under the terms of the GNU General Public License as published by
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
16
# This program is free software: you can redistribute it and/or modify
17
# it under the terms of the GNU General Public License as published by
21
18
# the Free Software Foundation, either version 3 of the License, or
22
19
# (at your option) any later version.
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
21
# This program is distributed in the hope that it will be useful,
22
# but WITHOUT ANY WARRANTY; without even the implied warranty of
26
23
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27
24
# GNU General Public License for more details.
29
26
# You should have received a copy of the GNU General Public License
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
32
# Contact the authors at <mandos@recompile.se>.
35
from __future__ import (division, absolute_import, print_function,
39
from future_builtins import *
44
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
52
import ConfigParser as configparser
41
import gnutls.connection
43
import gnutls.library.functions
44
import gnutls.library.constants
45
import gnutls.library.types
63
56
import logging.handlers
70
import cPickle as pickle
73
import multiprocessing
87
from gi.repository import GLib
88
61
from dbus.mainloop.glib import DBusGMainLoop
91
import xml.dom.minidom
94
if sys.version_info.major == 2:
98
# Add collections.abc.Callable if it does not exist
100
collections.abc.Callable
101
except AttributeError:
103
Callable = collections.Callable
104
collections.abc = abc
107
# Add shlex.quote if it does not exist
110
except AttributeError:
111
shlex.quote = re.escape
113
# Show warnings by default
114
if not sys.warnoptions:
116
warnings.simplefilter("default")
118
# Try to find the value of SO_BINDTODEVICE:
120
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
121
# newer, and it is also the most natural place for it:
122
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
123
except AttributeError:
125
# This is where SO_BINDTODEVICE was up to and including Python
127
from IN import SO_BINDTODEVICE
129
# In Python 2.7 it seems to have been removed entirely.
130
# Try running the C preprocessor:
132
cc = subprocess.Popen(["cc", "--language=c", "-E",
134
stdin=subprocess.PIPE,
135
stdout=subprocess.PIPE)
136
stdout = cc.communicate(
137
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
138
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
139
except (OSError, ValueError, IndexError):
141
SO_BINDTODEVICE = None
143
if sys.version_info < (3, 2):
144
configparser.Configparser = configparser.SafeConfigParser
147
stored_state_file = "clients.pickle"
149
logger = logging.getLogger()
150
logging.captureWarnings(True) # Show warnings via the logging system
154
if_nametoindex = ctypes.cdll.LoadLibrary(
155
ctypes.util.find_library("c")).if_nametoindex
156
except (OSError, AttributeError):
158
def if_nametoindex(interface):
159
"Get an interface index the hard way, i.e. using fcntl()"
160
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
161
with contextlib.closing(socket.socket()) as s:
162
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
163
struct.pack(b"16s16x", interface))
164
interface_index = struct.unpack("I", ifreq[16:20])[0]
165
return interface_index
168
def copy_function(func):
169
"""Make a copy of a function"""
170
if sys.version_info.major == 2:
171
return types.FunctionType(func.func_code,
177
return types.FunctionType(func.__code__,
184
def initlogger(debug, level=logging.WARNING):
185
"""init logger and add loglevel"""
188
syslogger = (logging.handlers.SysLogHandler(
189
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
191
syslogger.setFormatter(logging.Formatter
192
('Mandos [%(process)d]: %(levelname)s:'
194
logger.addHandler(syslogger)
197
console = logging.StreamHandler()
198
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
202
logger.addHandler(console)
203
logger.setLevel(level)
206
class PGPError(Exception):
207
"""Exception if encryption/decryption fails"""
212
"""A simple class for OpenPGP symmetric encryption & decryption"""
215
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
218
output = subprocess.check_output(["gpgconf"])
219
for line in output.splitlines():
220
name, text, path = line.split(b":")
225
if e.errno != errno.ENOENT:
227
self.gnupgargs = ['--batch',
228
'--homedir', self.tempdir,
231
# Only GPG version 1 has the --no-use-agent option.
232
if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
233
self.gnupgargs.append("--no-use-agent")
238
def __exit__(self, exc_type, exc_value, traceback):
246
if self.tempdir is not None:
247
# Delete contents of tempdir
248
for root, dirs, files in os.walk(self.tempdir,
250
for filename in files:
251
os.remove(os.path.join(root, filename))
253
os.rmdir(os.path.join(root, dirname))
255
os.rmdir(self.tempdir)
258
def password_encode(self, password):
259
# Passphrase can not be empty and can not contain newlines or
260
# NUL bytes. So we prefix it and hex encode it.
261
encoded = b"mandos" + binascii.hexlify(password)
262
if len(encoded) > 2048:
263
# GnuPG can't handle long passwords, so encode differently
264
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
265
.replace(b"\n", b"\\n")
266
.replace(b"\0", b"\\x00"))
269
def encrypt(self, data, password):
270
passphrase = self.password_encode(password)
271
with tempfile.NamedTemporaryFile(
272
dir=self.tempdir) as passfile:
273
passfile.write(passphrase)
275
proc = subprocess.Popen([self.gpg, '--symmetric',
279
stdin=subprocess.PIPE,
280
stdout=subprocess.PIPE,
281
stderr=subprocess.PIPE)
282
ciphertext, err = proc.communicate(input=data)
283
if proc.returncode != 0:
287
def decrypt(self, data, password):
288
passphrase = self.password_encode(password)
289
with tempfile.NamedTemporaryFile(
290
dir=self.tempdir) as passfile:
291
passfile.write(passphrase)
293
proc = subprocess.Popen([self.gpg, '--decrypt',
297
stdin=subprocess.PIPE,
298
stdout=subprocess.PIPE,
299
stderr=subprocess.PIPE)
300
decrypted_plaintext, err = proc.communicate(input=data)
301
if proc.returncode != 0:
303
return decrypted_plaintext
306
# Pretend that we have an Avahi module
308
"""This isn't so much a class as it is a module-like namespace."""
309
IF_UNSPEC = -1 # avahi-common/address.h
310
PROTO_UNSPEC = -1 # avahi-common/address.h
311
PROTO_INET = 0 # avahi-common/address.h
312
PROTO_INET6 = 1 # avahi-common/address.h
313
DBUS_NAME = "org.freedesktop.Avahi"
314
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
315
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
316
DBUS_PATH_SERVER = "/"
319
def string_array_to_txt_array(t):
320
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
321
for s in t), signature="ay")
322
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
323
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
324
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
325
SERVER_INVALID = 0 # avahi-common/defs.h
326
SERVER_REGISTERING = 1 # avahi-common/defs.h
327
SERVER_RUNNING = 2 # avahi-common/defs.h
328
SERVER_COLLISION = 3 # avahi-common/defs.h
329
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)
332
85
class AvahiError(Exception):
333
def __init__(self, value, *args, **kwargs):
86
def __init__(self, value):
334
87
self.value = value
335
return super(AvahiError, self).__init__(value, *args,
89
return repr(self.value)
339
91
class AvahiServiceError(AvahiError):
343
94
class AvahiGroupError(AvahiError):
348
"""An Avahi (Zeroconf) service.
98
class AvahiService(object):
351
100
interface: integer; avahi.IF_UNSPEC or an interface index.
352
101
Used to optionally bind to the specified interface.
353
name: string; Example: 'Mandos'
354
type: string; Example: '_mandos._tcp'.
355
See <https://www.iana.org/assignments/service-names-port-numbers>
356
port: integer; what port to announce
357
TXT: list of strings; TXT record for the service
358
domain: string; Domain to publish on, default to .local if empty.
359
host: string; Host to publish records for, default is localhost
360
max_renames: integer; maximum number of renames
361
rename_count: integer; counter so we only rename after collisions
362
a sensible number of times
363
group: D-Bus Entry Group
365
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
369
interface=avahi.IF_UNSPEC,
377
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. """
379
118
self.interface = interface
381
self.type = servicetype
383
self.TXT = TXT if TXT is not None else []
384
126
self.domain = domain
386
128
self.rename_count = 0
387
self.max_renames = max_renames
388
self.protocol = protocol
389
self.group = None # our entry group
392
self.entry_group_state_changed_match = None
394
def rename(self, remove=True):
395
130
"""Derived from the Avahi example code"""
396
131
if self.rename_count >= self.max_renames:
397
logger.critical("No suitable Zeroconf service name found"
398
" after %i retries, exiting.",
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
400
134
raise AvahiServiceError("Too many renames")
402
self.server.GetAlternativeServiceName(self.name))
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", name)
403
139
self.rename_count += 1
404
logger.info("Changing Zeroconf service name to %r ...",
410
except dbus.exceptions.DBusException as error:
411
if (error.get_dbus_name()
412
== "org.freedesktop.Avahi.CollisionError"):
413
logger.info("Local Zeroconf service name collision.")
414
return self.rename(remove=False)
416
logger.critical("D-Bus Exception", exc_info=error)
420
140
def remove(self):
421
141
"""Derived from the Avahi example code"""
422
if self.entry_group_state_changed_match is not None:
423
self.entry_group_state_changed_match.remove()
424
self.entry_group_state_changed_match = None
425
if self.group is not None:
142
if group is not None:
429
145
"""Derived from the Avahi example code"""
431
if self.group is None:
432
self.group = dbus.Interface(
433
self.bus.get_object(avahi.DBUS_NAME,
434
self.server.EntryGroupNew()),
435
avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
self.entry_group_state_changed_match = (
437
self.group.connect_to_signal(
438
'StateChanged', self.entry_group_state_changed))
439
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
440
self.name, self.type)
441
self.group.AddService(
444
dbus.UInt32(0), # flags
445
self.name, self.type,
446
self.domain, self.host,
447
dbus.UInt16(self.port),
448
avahi.string_array_to_txt_array(self.TXT))
451
def entry_group_state_changed(self, state, error):
452
"""Derived from the Avahi example code"""
453
logger.debug("Avahi entry group state change: %i", state)
455
if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
logger.debug("Zeroconf service established.")
457
elif state == avahi.ENTRY_GROUP_COLLISION:
458
logger.info("Zeroconf service name collision.")
460
elif state == avahi.ENTRY_GROUP_FAILURE:
461
logger.critical("Avahi: Error in group state changed %s",
463
raise AvahiGroupError("State changed: {!s}".format(error))
466
"""Derived from the Avahi example code"""
467
if self.group is not None:
470
except (dbus.exceptions.UnknownMethodException,
471
dbus.exceptions.DBusException):
476
def server_state_changed(self, state, error=None):
477
"""Derived from the Avahi example code"""
478
logger.debug("Avahi server state change: %i", state)
480
avahi.SERVER_INVALID: "Zeroconf server invalid",
481
avahi.SERVER_REGISTERING: None,
482
avahi.SERVER_COLLISION: "Zeroconf server name collision",
483
avahi.SERVER_FAILURE: "Zeroconf server failure",
485
if state in bad_states:
486
if bad_states[state] is not None:
488
logger.error(bad_states[state])
490
logger.error(bad_states[state] + ": %r", error)
492
elif state == avahi.SERVER_RUNNING:
495
except dbus.exceptions.DBusException as error:
496
if (error.get_dbus_name()
497
== "org.freedesktop.Avahi.CollisionError"):
498
logger.info("Local Zeroconf service name"
500
return self.rename(remove=False)
502
logger.critical("D-Bus Exception", exc_info=error)
507
logger.debug("Unknown state: %r", state)
509
logger.debug("Unknown state: %r: %r", state, error)
512
"""Derived from the Avahi example code"""
513
if self.server is None:
514
self.server = dbus.Interface(
515
self.bus.get_object(avahi.DBUS_NAME,
516
avahi.DBUS_PATH_SERVER,
517
follow_name_owner_changes=True),
518
avahi.DBUS_INTERFACE_SERVER)
519
self.server.connect_to_signal("StateChanged",
520
self.server_state_changed)
521
self.server_state_changed(self.server.GetState())
524
class AvahiServiceToSyslog(AvahiService):
525
def rename(self, *args, **kwargs):
526
"""Add the new name to the syslog messages"""
527
ret = super(AvahiServiceToSyslog, self).rename(*args,
529
syslogger.setFormatter(logging.Formatter(
530
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
535
# Pretend that we have a GnuTLS module
537
"""This isn't so much a class as it is a module-like namespace."""
539
library = ctypes.util.find_library("gnutls")
541
library = ctypes.util.find_library("gnutls-deb0")
542
_library = ctypes.cdll.LoadLibrary(library)
545
# Unless otherwise indicated, the constants and types below are
546
# all from the gnutls/gnutls.h C header file.
557
E_NO_CERTIFICATE_FOUND = -49
562
KEYID_USE_SHA256 = 1 # gnutls/x509.h
563
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
566
class session_int(ctypes.Structure):
568
session_t = ctypes.POINTER(session_int)
570
class certificate_credentials_st(ctypes.Structure):
572
certificate_credentials_t = ctypes.POINTER(
573
certificate_credentials_st)
574
certificate_type_t = ctypes.c_int
576
class datum_t(ctypes.Structure):
577
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
578
('size', ctypes.c_uint)]
580
class openpgp_crt_int(ctypes.Structure):
582
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
583
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
584
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
585
credentials_type_t = ctypes.c_int
586
transport_ptr_t = ctypes.c_void_p
587
close_request_t = ctypes.c_int
590
class Error(Exception):
591
def __init__(self, message=None, code=None, args=()):
592
# Default usage is by a message string, but if a return
593
# code is passed, convert it to a string with
596
if message is None and code is not None:
597
message = gnutls.strerror(code)
598
return super(gnutls.Error, self).__init__(
601
class CertificateSecurityError(Error):
607
self._c_object = gnutls.certificate_credentials_t()
608
gnutls.certificate_allocate_credentials(
609
ctypes.byref(self._c_object))
610
self.type = gnutls.CRD_CERTIFICATE
613
gnutls.certificate_free_credentials(self._c_object)
616
def __init__(self, socket, credentials=None):
617
self._c_object = gnutls.session_t()
618
gnutls_flags = gnutls.CLIENT
619
if gnutls.check_version(b"3.5.6"):
620
gnutls_flags |= gnutls.NO_TICKETS
622
gnutls_flags |= gnutls.ENABLE_RAWPK
623
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
625
gnutls.set_default_priority(self._c_object)
626
gnutls.transport_set_ptr(self._c_object, socket.fileno())
627
gnutls.handshake_set_private_extensions(self._c_object,
630
if credentials is None:
631
credentials = gnutls.Credentials()
632
gnutls.credentials_set(self._c_object, credentials.type,
633
ctypes.cast(credentials._c_object,
635
self.credentials = credentials
638
gnutls.deinit(self._c_object)
641
return gnutls.handshake(self._c_object)
643
def send(self, data):
647
data_len -= gnutls.record_send(self._c_object,
652
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
654
# Error handling functions
655
def _error_code(result):
656
"""A function to raise exceptions on errors, suitable
657
for the 'restype' attribute on ctypes functions"""
660
if result == gnutls.E_NO_CERTIFICATE_FOUND:
661
raise gnutls.CertificateSecurityError(code=result)
662
raise gnutls.Error(code=result)
664
def _retry_on_error(result, func, arguments,
665
_error_code=_error_code):
666
"""A function to retry on some errors, suitable
667
for the 'errcheck' attribute on ctypes functions"""
669
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
670
return _error_code(result)
671
result = func(*arguments)
674
# Unless otherwise indicated, the function declarations below are
675
# all from the gnutls/gnutls.h C header file.
678
priority_set_direct = _library.gnutls_priority_set_direct
679
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
680
ctypes.POINTER(ctypes.c_char_p)]
681
priority_set_direct.restype = _error_code
683
init = _library.gnutls_init
684
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
685
init.restype = _error_code
687
set_default_priority = _library.gnutls_set_default_priority
688
set_default_priority.argtypes = [session_t]
689
set_default_priority.restype = _error_code
691
record_send = _library.gnutls_record_send
692
record_send.argtypes = [session_t, ctypes.c_void_p,
694
record_send.restype = ctypes.c_ssize_t
695
record_send.errcheck = _retry_on_error
697
certificate_allocate_credentials = (
698
_library.gnutls_certificate_allocate_credentials)
699
certificate_allocate_credentials.argtypes = [
700
ctypes.POINTER(certificate_credentials_t)]
701
certificate_allocate_credentials.restype = _error_code
703
certificate_free_credentials = (
704
_library.gnutls_certificate_free_credentials)
705
certificate_free_credentials.argtypes = [
706
certificate_credentials_t]
707
certificate_free_credentials.restype = None
709
handshake_set_private_extensions = (
710
_library.gnutls_handshake_set_private_extensions)
711
handshake_set_private_extensions.argtypes = [session_t,
713
handshake_set_private_extensions.restype = None
715
credentials_set = _library.gnutls_credentials_set
716
credentials_set.argtypes = [session_t, credentials_type_t,
718
credentials_set.restype = _error_code
720
strerror = _library.gnutls_strerror
721
strerror.argtypes = [ctypes.c_int]
722
strerror.restype = ctypes.c_char_p
724
certificate_type_get = _library.gnutls_certificate_type_get
725
certificate_type_get.argtypes = [session_t]
726
certificate_type_get.restype = _error_code
728
certificate_get_peers = _library.gnutls_certificate_get_peers
729
certificate_get_peers.argtypes = [session_t,
730
ctypes.POINTER(ctypes.c_uint)]
731
certificate_get_peers.restype = ctypes.POINTER(datum_t)
733
global_set_log_level = _library.gnutls_global_set_log_level
734
global_set_log_level.argtypes = [ctypes.c_int]
735
global_set_log_level.restype = None
737
global_set_log_function = _library.gnutls_global_set_log_function
738
global_set_log_function.argtypes = [log_func]
739
global_set_log_function.restype = None
741
deinit = _library.gnutls_deinit
742
deinit.argtypes = [session_t]
743
deinit.restype = None
745
handshake = _library.gnutls_handshake
746
handshake.argtypes = [session_t]
747
handshake.restype = _error_code
748
handshake.errcheck = _retry_on_error
750
transport_set_ptr = _library.gnutls_transport_set_ptr
751
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
752
transport_set_ptr.restype = None
754
bye = _library.gnutls_bye
755
bye.argtypes = [session_t, close_request_t]
756
bye.restype = _error_code
757
bye.errcheck = _retry_on_error
759
check_version = _library.gnutls_check_version
760
check_version.argtypes = [ctypes.c_char_p]
761
check_version.restype = ctypes.c_char_p
763
_need_version = b"3.3.0"
764
if check_version(_need_version) is None:
765
raise self.Error("Needs GnuTLS {} or later"
766
.format(_need_version))
768
_tls_rawpk_version = b"3.6.6"
769
has_rawpk = bool(check_version(_tls_rawpk_version))
773
class pubkey_st(ctypes.Structure):
775
pubkey_t = ctypes.POINTER(pubkey_st)
777
x509_crt_fmt_t = ctypes.c_int
779
# All the function declarations below are from
781
pubkey_init = _library.gnutls_pubkey_init
782
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
783
pubkey_init.restype = _error_code
785
pubkey_import = _library.gnutls_pubkey_import
786
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
788
pubkey_import.restype = _error_code
790
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
791
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
792
ctypes.POINTER(ctypes.c_ubyte),
793
ctypes.POINTER(ctypes.c_size_t)]
794
pubkey_get_key_id.restype = _error_code
796
pubkey_deinit = _library.gnutls_pubkey_deinit
797
pubkey_deinit.argtypes = [pubkey_t]
798
pubkey_deinit.restype = None
800
# All the function declarations below are from
803
openpgp_crt_init = _library.gnutls_openpgp_crt_init
804
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
805
openpgp_crt_init.restype = _error_code
807
openpgp_crt_import = _library.gnutls_openpgp_crt_import
808
openpgp_crt_import.argtypes = [openpgp_crt_t,
809
ctypes.POINTER(datum_t),
811
openpgp_crt_import.restype = _error_code
813
openpgp_crt_verify_self = \
814
_library.gnutls_openpgp_crt_verify_self
815
openpgp_crt_verify_self.argtypes = [
818
ctypes.POINTER(ctypes.c_uint),
820
openpgp_crt_verify_self.restype = _error_code
822
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
823
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
824
openpgp_crt_deinit.restype = None
826
openpgp_crt_get_fingerprint = (
827
_library.gnutls_openpgp_crt_get_fingerprint)
828
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
832
openpgp_crt_get_fingerprint.restype = _error_code
834
if check_version(b"3.6.4"):
835
certificate_type_get2 = _library.gnutls_certificate_type_get2
836
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
837
certificate_type_get2.restype = _error_code
839
# Remove non-public functions
840
del _error_code, _retry_on_error
843
def call_pipe(connection, # : multiprocessing.Connection
844
func, *args, **kwargs):
845
"""This function is meant to be called by multiprocessing.Process
847
This function runs func(*args, **kwargs), and writes the resulting
848
return value on the provided multiprocessing.Connection.
850
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
171
class Client(object):
855
172
"""A representation of a client host served by this server.
858
approved: bool(); 'None' if not yet approved/disapproved
859
approval_delay: datetime.timedelta(); Time to wait for approval
860
approval_duration: datetime.timedelta(); Duration of one approval
861
checker: multiprocessing.Process(); a running checker process used
862
to see if the client lives. 'None' if no process is
864
checker_callback_tag: a GLib event source tag, or None
865
checker_command: string; External command which is run to check
866
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
867
193
runtime with vars(self) as dict, so that for
868
194
instance %(name)s can be used in the command.
869
checker_initiator_tag: a GLib event source tag, or None
870
created: datetime.datetime(); (UTC) object creation
871
client_structure: Object describing what attributes a client has
872
and is used for storing the client at exit
873
current_checker_command: string; current running checker_command
874
disable_initiator_tag: a GLib event source tag, or None
876
fingerprint: string (40 or 32 hexadecimal digits); used to
877
uniquely identify an OpenPGP client
878
key_id: string (64 hexadecimal digits); used to uniquely identify
879
a client using raw public keys
880
host: string; available for use by the checker command
881
interval: datetime.timedelta(); How often to start a new checker
882
last_approval_request: datetime.datetime(); (UTC) or None
883
last_checked_ok: datetime.datetime(); (UTC) or None
884
last_checker_status: integer between 0 and 255 reflecting exit
885
status of last checker. -1 reflects crashed
886
checker, -2 means no checker completed yet.
887
last_checker_signal: The signal which killed the last checker, if
888
last_checker_status is -1
889
last_enabled: datetime.datetime(); (UTC) or None
890
name: string; from the config file, used in log messages and
892
secret: bytestring; sent verbatim (over TLS) to client
893
timeout: datetime.timedelta(); How long from last_checked_ok
894
until this client is disabled
895
extended_timeout: extra long timeout when secret has been sent
896
runtime_expansions: Allowed attributes for runtime expansion.
897
expires: datetime.datetime(); time (UTC) when a client will be
899
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: - '' -
902
runtime_expansions = ("approval_delay", "approval_duration",
903
"created", "enabled", "expires", "key_id",
904
"fingerprint", "host", "interval",
905
"last_approval_request", "last_checked_ok",
906
"last_enabled", "name", "timeout")
909
"extended_timeout": "PT15M",
911
"checker": "fping -q -- %%(host)s",
913
"approval_delay": "PT0S",
914
"approval_duration": "PT1S",
915
"approved_by_default": "True",
920
def config_parser(config):
921
"""Construct a new dict of client settings of this form:
922
{ client_name: {setting_name: value, ...}, ...}
923
with exceptions for any special settings as defined above.
924
NOTE: Must be a pure function. Must return the same result
925
value given the same arguments.
928
for client_name in config.sections():
929
section = dict(config.items(client_name))
930
client = settings[client_name] = {}
932
client["host"] = section["host"]
933
# Reformat values from string types to Python types
934
client["approved_by_default"] = config.getboolean(
935
client_name, "approved_by_default")
936
client["enabled"] = config.getboolean(client_name,
939
# Uppercase and remove spaces from key_id and fingerprint
940
# for later comparison purposes with return value from the
941
# key_id() and fingerprint() functions
942
client["key_id"] = (section.get("key_id", "").upper()
944
client["fingerprint"] = (section["fingerprint"].upper()
946
if "secret" in section:
947
client["secret"] = codecs.decode(section["secret"]
950
elif "secfile" in section:
951
with open(os.path.expanduser(os.path.expandvars
952
(section["secfile"])),
954
client["secret"] = secfile.read()
956
raise TypeError("No secret or secfile for section {}"
958
client["timeout"] = string_to_delta(section["timeout"])
959
client["extended_timeout"] = string_to_delta(
960
section["extended_timeout"])
961
client["interval"] = string_to_delta(section["interval"])
962
client["approval_delay"] = string_to_delta(
963
section["approval_delay"])
964
client["approval_duration"] = string_to_delta(
965
section["approval_duration"])
966
client["checker_command"] = section["checker"]
967
client["last_approval_request"] = None
968
client["last_checked_ok"] = None
969
client["last_checker_status"] = -2
973
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.."""
975
if server_settings is None:
977
self.server_settings = server_settings
978
# adding all client settings
979
for setting, value in settings.items():
980
setattr(self, setting, value)
983
if not hasattr(self, "last_enabled"):
984
self.last_enabled = datetime.datetime.utcnow()
985
if not hasattr(self, "expires"):
986
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()
989
self.last_enabled = None
992
logger.debug("Creating client %r", self.name)
993
logger.debug(" Key ID: %s", self.key_id)
994
logger.debug(" Fingerprint: %s", self.fingerprint)
995
self.created = settings.get("created",
996
datetime.datetime.utcnow())
998
# 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
999
251
self.checker = None
1000
252
self.checker_initiator_tag = None
1001
self.disable_initiator_tag = None
253
self.stop_initiator_tag = None
1002
254
self.checker_callback_tag = None
1003
self.current_checker_command = None
1004
self.approved = None
1005
self.approvals_pending = 0
1006
self.changedstate = multiprocessing_manager.Condition(
1007
multiprocessing_manager.Lock())
1008
self.client_structure = [attr
1009
for attr in self.__dict__.keys()
1010
if not attr.startswith("_")]
1011
self.client_structure.append("client_structure")
1013
for name, t in inspect.getmembers(
1014
type(self), lambda obj: isinstance(obj, property)):
1015
if not name.startswith("_"):
1016
self.client_structure.append(name)
1018
# Send notice to process children that client state has changed
1019
def send_changedstate(self):
1020
with self.changedstate:
1021
self.changedstate.notify_all()
255
self.check_command = checker
1024
257
"""Start this client's checker and timeout hooks"""
1025
if getattr(self, "enabled", False):
1028
self.expires = datetime.datetime.utcnow() + self.timeout
1030
self.last_enabled = datetime.datetime.utcnow()
1032
self.send_changedstate()
1034
def disable(self, quiet=True):
1035
"""Disable this client."""
1036
if not getattr(self, "enabled", False):
1039
logger.info("Disabling client %s", self.name)
1040
if getattr(self, "disable_initiator_tag", None) is not None:
1041
GLib.source_remove(self.disable_initiator_tag)
1042
self.disable_initiator_tag = None
1044
if getattr(self, "checker_initiator_tag", None) is not None:
1045
GLib.source_remove(self.checker_initiator_tag)
1046
self.checker_initiator_tag = None
1048
self.enabled = False
1050
self.send_changedstate()
1051
# Do not run this again if called by a GLib.timeout_add
1057
def init_checker(self):
1058
258
# Schedule a new checker to be started an 'interval' from now,
1059
259
# and every interval from then on.
1060
if self.checker_initiator_tag is not None:
1061
GLib.source_remove(self.checker_initiator_tag)
1062
self.checker_initiator_tag = GLib.timeout_add(
1063
random.randrange(int(self.interval.total_seconds() * 1000
1066
# Schedule a disable() when 'timeout' has passed
1067
if self.disable_initiator_tag is not None:
1068
GLib.source_remove(self.disable_initiator_tag)
1069
self.disable_initiator_tag = GLib.timeout_add(
1070
int(self.timeout.total_seconds() * 1000), self.disable)
260
self.checker_initiator_tag = gobject.timeout_add\
261
(self._interval_milliseconds,
1071
263
# Also start a new checker *right now*.
1072
264
self.start_checker()
1074
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):
1076
294
"""The checker has completed, so take appropriate actions."""
1077
# Read return code from connection (see call_pipe)
1078
returncode = connection.recv()
1080
if self.checker is not None:
295
now = datetime.datetime.now()
1082
296
self.checker_callback_tag = None
1083
297
self.checker = None
1086
self.last_checker_status = returncode
1087
self.last_checker_signal = None
1088
if self.last_checker_status == 0:
1089
logger.info("Checker for %(name)s succeeded",
1093
logger.info("Checker for %(name)s failed", vars(self))
1095
self.last_checker_status = -1
1096
self.last_checker_signal = -returncode
1097
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?",
1101
def checked_ok(self):
1102
"""Assert that the client has been seen, alive and well."""
1103
self.last_checked_ok = datetime.datetime.utcnow()
1104
self.last_checker_status = 0
1105
self.last_checker_signal = None
1108
def bump_timeout(self, timeout=None):
1109
"""Bump up the timeout for this client."""
1111
timeout = self.timeout
1112
if self.disable_initiator_tag is not None:
1113
GLib.source_remove(self.disable_initiator_tag)
1114
self.disable_initiator_tag = None
1115
if getattr(self, "enabled", False):
1116
self.disable_initiator_tag = GLib.timeout_add(
1117
int(timeout.total_seconds() * 1000), self.disable)
1118
self.expires = datetime.datetime.utcnow() + timeout
1120
def need_approval(self):
1121
self.last_approval_request = datetime.datetime.utcnow()
311
logger.debug(u"Checker for %(name)s failed",
1123
313
def start_checker(self):
1124
314
"""Start a new checker subprocess if one is not running.
1126
315
If a checker already exists, leave it running and do
1128
317
# The reason for not killing a running checker is that if we
1129
# did that, and if a checker (for some reason) started running
1130
# slowly and taking more than 'interval' time, then the client
1131
# would inevitably timeout, since no checker would get a
1132
# 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
1133
322
# checkers alone, the checker would have to take more time
1134
# than 'timeout' for the client to be disabled, which is as it
1137
if self.checker is not None and not self.checker.is_alive():
1138
logger.warning("Checker was not alive; joining")
1141
# Start a new checker if needed
323
# than 'timeout' for the client to be declared invalid, which
324
# is as it should be.
1142
325
if self.checker is None:
1143
# Escape attributes for the shell
1145
attr: shlex.quote(str(getattr(self, attr)))
1146
for attr in self.runtime_expansions}
1148
command = self.checker_command % escaped_attrs
1149
except TypeError as error:
1150
logger.error('Could not format string "%s"',
1151
self.checker_command,
1153
return True # Try again later
1154
self.current_checker_command = command
1155
logger.info("Starting checker %r for %s", command,
1157
# We don't need to redirect stdout and stderr, since
1158
# in normal mode, that is already done by daemon(),
1159
# and in debug mode we don't want to. (Stdin is
1160
# always replaced by /dev/null.)
1161
# The exception is when not debugging but nevertheless
1162
# running in the foreground; use the previously
1164
popen_args = {"close_fds": True,
1167
if (not self.server_settings["debug"]
1168
and self.server_settings["foreground"]):
1169
popen_args.update({"stdout": wnull,
1171
pipe = multiprocessing.Pipe(duplex=False)
1172
self.checker = multiprocessing.Process(
1174
args=(pipe[1], subprocess.call, command),
1176
self.checker.start()
1177
self.checker_callback_tag = GLib.io_add_watch(
1178
GLib.IOChannel.unix_new(pipe[0].fileno()),
1179
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1180
self.checker_callback, pipe[0], command)
1181
# 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
1184
354
def stop_checker(self):
1185
355
"""Force the checker process, if any, to stop."""
1186
356
if self.checker_callback_tag:
1187
GLib.source_remove(self.checker_callback_tag)
357
gobject.source_remove(self.checker_callback_tag)
1188
358
self.checker_callback_tag = None
1189
359
if getattr(self, "checker", None) is None:
1191
361
logger.debug("Stopping checker for %(name)s", vars(self))
1192
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
1193
370
self.checker = None
1196
def dbus_service_property(dbus_interface,
1200
"""Decorators for marking methods of a DBusObjectWithProperties to
1201
become properties on the D-Bus.
1203
The decorated method will be called with no arguments by "Get"
1204
and with one argument by "Set".
1206
The parameters, where they are supported, are the same as
1207
dbus.service.method, except there is only "signature", since the
1208
type from Get() and the type sent to Set() is the same.
1210
# Encoding deeply encoded byte arrays is not supported yet by the
1211
# "Set" method, so we fail early here:
1212
if byte_arrays and signature != "ay":
1213
raise ValueError("Byte arrays not supported for non-'ay'"
1214
" signature {!r}".format(signature))
1216
def decorator(func):
1217
func._dbus_is_property = True
1218
func._dbus_interface = dbus_interface
1219
func._dbus_signature = signature
1220
func._dbus_access = access
1221
func._dbus_name = func.__name__
1222
if func._dbus_name.endswith("_dbus_property"):
1223
func._dbus_name = func._dbus_name[:-14]
1224
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1230
def dbus_interface_annotations(dbus_interface):
1231
"""Decorator for marking functions returning interface annotations
1235
@dbus_interface_annotations("org.example.Interface")
1236
def _foo(self): # Function name does not matter
1237
return {"org.freedesktop.DBus.Deprecated": "true",
1238
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1242
def decorator(func):
1243
func._dbus_is_interface = True
1244
func._dbus_interface = dbus_interface
1245
func._dbus_name = dbus_interface
1251
def dbus_annotations(annotations):
1252
"""Decorator to annotate D-Bus methods, signals or properties
1255
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1256
"org.freedesktop.DBus.Property."
1257
"EmitsChangedSignal": "false"})
1258
@dbus_service_property("org.example.Interface", signature="b",
1260
def Property_dbus_property(self):
1261
return dbus.Boolean(False)
1263
See also the DBusObjectWithAnnotations class.
1266
def decorator(func):
1267
func._dbus_annotations = annotations
1273
class DBusPropertyException(dbus.exceptions.DBusException):
1274
"""A base class for D-Bus property-related exceptions
1279
class DBusPropertyAccessException(DBusPropertyException):
1280
"""A property's access permissions disallows an operation.
1285
class DBusPropertyNotFound(DBusPropertyException):
1286
"""An attempt was made to access a non-existing property.
1291
class DBusObjectWithAnnotations(dbus.service.Object):
1292
"""A D-Bus object with annotations.
1294
Classes inheriting from this can use the dbus_annotations
1295
decorator to add annotations to methods or signals.
1299
def _is_dbus_thing(thing):
1300
"""Returns a function testing if an attribute is a D-Bus thing
1302
If called like _is_dbus_thing("method") it returns a function
1303
suitable for use as predicate to inspect.getmembers().
1305
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1308
def _get_all_dbus_things(self, thing):
1309
"""Returns a generator of (name, attribute) pairs
1311
return ((getattr(athing.__get__(self), "_dbus_name", name),
1312
athing.__get__(self))
1313
for cls in self.__class__.__mro__
1315
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1317
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1319
path_keyword='object_path',
1320
connection_keyword='connection')
1321
def Introspect(self, object_path, connection):
1322
"""Overloading of standard D-Bus method.
1324
Inserts annotation tags on methods and signals.
1326
xmlstring = dbus.service.Object.Introspect(self, object_path,
1329
document = xml.dom.minidom.parseString(xmlstring)
1331
for if_tag in document.getElementsByTagName("interface"):
1332
# Add annotation tags
1333
for typ in ("method", "signal"):
1334
for tag in if_tag.getElementsByTagName(typ):
1336
for name, prop in (self.
1337
_get_all_dbus_things(typ)):
1338
if (name == tag.getAttribute("name")
1339
and prop._dbus_interface
1340
== if_tag.getAttribute("name")):
1341
annots.update(getattr(
1342
prop, "_dbus_annotations", {}))
1343
for name, value in annots.items():
1344
ann_tag = document.createElement(
1346
ann_tag.setAttribute("name", name)
1347
ann_tag.setAttribute("value", value)
1348
tag.appendChild(ann_tag)
1349
# Add interface annotation tags
1350
for annotation, value in dict(
1351
itertools.chain.from_iterable(
1352
annotations().items()
1353
for name, annotations
1354
in self._get_all_dbus_things("interface")
1355
if name == if_tag.getAttribute("name")
1357
ann_tag = document.createElement("annotation")
1358
ann_tag.setAttribute("name", annotation)
1359
ann_tag.setAttribute("value", value)
1360
if_tag.appendChild(ann_tag)
1361
# Fix argument name for the Introspect method itself
1362
if (if_tag.getAttribute("name")
1363
== dbus.INTROSPECTABLE_IFACE):
1364
for cn in if_tag.getElementsByTagName("method"):
1365
if cn.getAttribute("name") == "Introspect":
1366
for arg in cn.getElementsByTagName("arg"):
1367
if (arg.getAttribute("direction")
1369
arg.setAttribute("name",
1371
xmlstring = document.toxml("utf-8")
1373
except (AttributeError, xml.dom.DOMException,
1374
xml.parsers.expat.ExpatError) as error:
1375
logger.error("Failed to override Introspection method",
1380
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1381
"""A D-Bus object with properties.
1383
Classes inheriting from this can use the dbus_service_property
1384
decorator to expose methods as D-Bus properties. It exposes the
1385
standard Get(), Set(), and GetAll() methods on the D-Bus.
1388
def _get_dbus_property(self, interface_name, property_name):
1389
"""Returns a bound method if one exists which is a D-Bus
1390
property with the specified name and interface.
1392
for cls in self.__class__.__mro__:
1393
for name, value in inspect.getmembers(
1394
cls, self._is_dbus_thing("property")):
1395
if (value._dbus_name == property_name
1396
and value._dbus_interface == interface_name):
1397
return value.__get__(self)
1400
raise DBusPropertyNotFound("{}:{}.{}".format(
1401
self.dbus_object_path, interface_name, property_name))
1404
def _get_all_interface_names(cls):
1405
"""Get a sequence of all interfaces supported by an object"""
1406
return (name for name in set(getattr(getattr(x, attr),
1407
"_dbus_interface", None)
1408
for x in (inspect.getmro(cls))
1410
if name is not None)
1412
@dbus.service.method(dbus.PROPERTIES_IFACE,
1415
def Get(self, interface_name, property_name):
1416
"""Standard D-Bus property Get() method, see D-Bus standard.
1418
prop = self._get_dbus_property(interface_name, property_name)
1419
if prop._dbus_access == "write":
1420
raise DBusPropertyAccessException(property_name)
1422
if not hasattr(value, "variant_level"):
1424
return type(value)(value, variant_level=value.variant_level+1)
1426
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1427
def Set(self, interface_name, property_name, value):
1428
"""Standard D-Bus property Set() method, see D-Bus standard.
1430
prop = self._get_dbus_property(interface_name, property_name)
1431
if prop._dbus_access == "read":
1432
raise DBusPropertyAccessException(property_name)
1433
if prop._dbus_get_args_options["byte_arrays"]:
1434
# The byte_arrays option is not supported yet on
1435
# signatures other than "ay".
1436
if prop._dbus_signature != "ay":
1437
raise ValueError("Byte arrays not supported for non-"
1438
"'ay' signature {!r}"
1439
.format(prop._dbus_signature))
1440
value = dbus.ByteArray(bytes(value))
1443
@dbus.service.method(dbus.PROPERTIES_IFACE,
1445
out_signature="a{sv}")
1446
def GetAll(self, interface_name):
1447
"""Standard D-Bus property GetAll() method, see D-Bus
1450
Note: Will not include properties with access="write".
1453
for name, prop in self._get_all_dbus_things("property"):
1455
and interface_name != prop._dbus_interface):
1456
# Interface non-empty but did not match
1458
# Ignore write-only properties
1459
if prop._dbus_access == "write":
1462
if not hasattr(value, "variant_level"):
1463
properties[name] = value
1465
properties[name] = type(value)(
1466
value, variant_level=value.variant_level + 1)
1467
return dbus.Dictionary(properties, signature="sv")
1469
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1470
def PropertiesChanged(self, interface_name, changed_properties,
1471
invalidated_properties):
1472
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1477
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1479
path_keyword='object_path',
1480
connection_keyword='connection')
1481
def Introspect(self, object_path, connection):
1482
"""Overloading of standard D-Bus method.
1484
Inserts property tags and interface annotation tags.
1486
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1490
document = xml.dom.minidom.parseString(xmlstring)
1492
def make_tag(document, name, prop):
1493
e = document.createElement("property")
1494
e.setAttribute("name", name)
1495
e.setAttribute("type", prop._dbus_signature)
1496
e.setAttribute("access", prop._dbus_access)
1499
for if_tag in document.getElementsByTagName("interface"):
1501
for tag in (make_tag(document, name, prop)
1503
in self._get_all_dbus_things("property")
1504
if prop._dbus_interface
1505
== if_tag.getAttribute("name")):
1506
if_tag.appendChild(tag)
1507
# Add annotation tags for properties
1508
for tag in if_tag.getElementsByTagName("property"):
1510
for name, prop in self._get_all_dbus_things(
1512
if (name == tag.getAttribute("name")
1513
and prop._dbus_interface
1514
== if_tag.getAttribute("name")):
1515
annots.update(getattr(
1516
prop, "_dbus_annotations", {}))
1517
for name, value in annots.items():
1518
ann_tag = document.createElement(
1520
ann_tag.setAttribute("name", name)
1521
ann_tag.setAttribute("value", value)
1522
tag.appendChild(ann_tag)
1523
# Add the names to the return values for the
1524
# "org.freedesktop.DBus.Properties" methods
1525
if (if_tag.getAttribute("name")
1526
== "org.freedesktop.DBus.Properties"):
1527
for cn in if_tag.getElementsByTagName("method"):
1528
if cn.getAttribute("name") == "Get":
1529
for arg in cn.getElementsByTagName("arg"):
1530
if (arg.getAttribute("direction")
1532
arg.setAttribute("name", "value")
1533
elif cn.getAttribute("name") == "GetAll":
1534
for arg in cn.getElementsByTagName("arg"):
1535
if (arg.getAttribute("direction")
1537
arg.setAttribute("name", "props")
1538
xmlstring = document.toxml("utf-8")
1540
except (AttributeError, xml.dom.DOMException,
1541
xml.parsers.expat.ExpatError) as error:
1542
logger.error("Failed to override Introspection method",
1548
dbus.OBJECT_MANAGER_IFACE
1549
except AttributeError:
1550
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1553
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1554
"""A D-Bus object with an ObjectManager.
1556
Classes inheriting from this exposes the standard
1557
GetManagedObjects call and the InterfacesAdded and
1558
InterfacesRemoved signals on the standard
1559
"org.freedesktop.DBus.ObjectManager" interface.
1561
Note: No signals are sent automatically; they must be sent
1564
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1565
out_signature="a{oa{sa{sv}}}")
1566
def GetManagedObjects(self):
1567
"""This function must be overridden"""
1568
raise NotImplementedError()
1570
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1571
signature="oa{sa{sv}}")
1572
def InterfacesAdded(self, object_path, interfaces_and_properties):
1575
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1576
def InterfacesRemoved(self, object_path, interfaces):
1579
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1581
path_keyword='object_path',
1582
connection_keyword='connection')
1583
def Introspect(self, object_path, connection):
1584
"""Overloading of standard D-Bus method.
1586
Override return argument name of GetManagedObjects to be
1587
"objpath_interfaces_and_properties"
1589
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1593
document = xml.dom.minidom.parseString(xmlstring)
1595
for if_tag in document.getElementsByTagName("interface"):
1596
# Fix argument name for the GetManagedObjects method
1597
if (if_tag.getAttribute("name")
1598
== dbus.OBJECT_MANAGER_IFACE):
1599
for cn in if_tag.getElementsByTagName("method"):
1600
if (cn.getAttribute("name")
1601
== "GetManagedObjects"):
1602
for arg in cn.getElementsByTagName("arg"):
1603
if (arg.getAttribute("direction")
1607
"objpath_interfaces"
1609
xmlstring = document.toxml("utf-8")
1611
except (AttributeError, xml.dom.DOMException,
1612
xml.parsers.expat.ExpatError) as error:
1613
logger.error("Failed to override Introspection method",
1618
def datetime_to_dbus(dt, variant_level=0):
1619
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1621
return dbus.String("", variant_level=variant_level)
1622
return dbus.String(dt.isoformat(), variant_level=variant_level)
1625
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1626
"""A class decorator; applied to a subclass of
1627
dbus.service.Object, it will add alternate D-Bus attributes with
1628
interface names according to the "alt_interface_names" mapping.
1631
@alternate_dbus_interfaces({"org.example.Interface":
1632
"net.example.AlternateInterface"})
1633
class SampleDBusObject(dbus.service.Object):
1634
@dbus.service.method("org.example.Interface")
1635
def SampleDBusMethod():
1638
The above "SampleDBusMethod" on "SampleDBusObject" will be
1639
reachable via two interfaces: "org.example.Interface" and
1640
"net.example.AlternateInterface", the latter of which will have
1641
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1642
"true", unless "deprecate" is passed with a False value.
1644
This works for methods and signals, and also for D-Bus properties
1645
(from DBusObjectWithProperties) and interfaces (from the
1646
dbus_interface_annotations decorator).
1650
for orig_interface_name, alt_interface_name in (
1651
alt_interface_names.items()):
1653
interface_names = set()
1654
# Go though all attributes of the class
1655
for attrname, attribute in inspect.getmembers(cls):
1656
# Ignore non-D-Bus attributes, and D-Bus attributes
1657
# with the wrong interface name
1658
if (not hasattr(attribute, "_dbus_interface")
1659
or not attribute._dbus_interface.startswith(
1660
orig_interface_name)):
1662
# Create an alternate D-Bus interface name based on
1664
alt_interface = attribute._dbus_interface.replace(
1665
orig_interface_name, alt_interface_name)
1666
interface_names.add(alt_interface)
1667
# Is this a D-Bus signal?
1668
if getattr(attribute, "_dbus_is_signal", False):
1669
# Extract the original non-method undecorated
1670
# function by black magic
1671
if sys.version_info.major == 2:
1672
nonmethod_func = (dict(
1673
zip(attribute.func_code.co_freevars,
1674
attribute.__closure__))
1675
["func"].cell_contents)
1677
nonmethod_func = (dict(
1678
zip(attribute.__code__.co_freevars,
1679
attribute.__closure__))
1680
["func"].cell_contents)
1681
# Create a new, but exactly alike, function
1682
# object, and decorate it to be a new D-Bus signal
1683
# with the alternate D-Bus interface name
1684
new_function = copy_function(nonmethod_func)
1685
new_function = (dbus.service.signal(
1687
attribute._dbus_signature)(new_function))
1688
# Copy annotations, if any
1690
new_function._dbus_annotations = dict(
1691
attribute._dbus_annotations)
1692
except AttributeError:
1695
# Define a creator of a function to call both the
1696
# original and alternate functions, so both the
1697
# original and alternate signals gets sent when
1698
# the function is called
1699
def fixscope(func1, func2):
1700
"""This function is a scope container to pass
1701
func1 and func2 to the "call_both" function
1702
outside of its arguments"""
1704
@functools.wraps(func2)
1705
def call_both(*args, **kwargs):
1706
"""This function will emit two D-Bus
1707
signals by calling func1 and func2"""
1708
func1(*args, **kwargs)
1709
func2(*args, **kwargs)
1710
# Make wrapper function look like a D-Bus
1712
for name, attr in inspect.getmembers(func2):
1713
if name.startswith("_dbus_"):
1714
setattr(call_both, name, attr)
1717
# Create the "call_both" function and add it to
1719
attr[attrname] = fixscope(attribute, new_function)
1720
# Is this a D-Bus method?
1721
elif getattr(attribute, "_dbus_is_method", False):
1722
# Create a new, but exactly alike, function
1723
# object. Decorate it to be a new D-Bus method
1724
# with the alternate D-Bus interface name. Add it
1727
dbus.service.method(
1729
attribute._dbus_in_signature,
1730
attribute._dbus_out_signature)
1731
(copy_function(attribute)))
1732
# Copy annotations, if any
1734
attr[attrname]._dbus_annotations = dict(
1735
attribute._dbus_annotations)
1736
except AttributeError:
1738
# Is this a D-Bus property?
1739
elif getattr(attribute, "_dbus_is_property", False):
1740
# Create a new, but exactly alike, function
1741
# object, and decorate it to be a new D-Bus
1742
# property with the alternate D-Bus interface
1743
# name. Add it to the class.
1744
attr[attrname] = (dbus_service_property(
1745
alt_interface, attribute._dbus_signature,
1746
attribute._dbus_access,
1747
attribute._dbus_get_args_options
1749
(copy_function(attribute)))
1750
# Copy annotations, if any
1752
attr[attrname]._dbus_annotations = dict(
1753
attribute._dbus_annotations)
1754
except AttributeError:
1756
# Is this a D-Bus interface?
1757
elif getattr(attribute, "_dbus_is_interface", False):
1758
# Create a new, but exactly alike, function
1759
# object. Decorate it to be a new D-Bus interface
1760
# with the alternate D-Bus interface name. Add it
1763
dbus_interface_annotations(alt_interface)
1764
(copy_function(attribute)))
1766
# Deprecate all alternate interfaces
1767
iname = "_AlternateDBusNames_interface_annotation{}"
1768
for interface_name in interface_names:
1770
@dbus_interface_annotations(interface_name)
1772
return {"org.freedesktop.DBus.Deprecated":
1774
# Find an unused name
1775
for aname in (iname.format(i)
1776
for i in itertools.count()):
1777
if aname not in attr:
1781
# Replace the class with a new subclass of it with
1782
# methods, signals, etc. as created above.
1783
if sys.version_info.major == 2:
1784
cls = type(b"{}Alternate".format(cls.__name__),
1787
cls = type("{}Alternate".format(cls.__name__),
1794
@alternate_dbus_interfaces({"se.recompile.Mandos":
1795
"se.bsnet.fukt.Mandos"})
1796
class ClientDBus(Client, DBusObjectWithProperties):
1797
"""A Client class using D-Bus
1800
dbus_object_path: dbus.ObjectPath
1801
bus: dbus.SystemBus()
1804
runtime_expansions = (Client.runtime_expansions
1805
+ ("dbus_object_path", ))
1807
_interface = "se.recompile.Mandos.Client"
1809
# dbus.service.Object doesn't use super(), so we can't either.
1811
def __init__(self, bus=None, *args, **kwargs):
1813
Client.__init__(self, *args, **kwargs)
1814
# Only now, when this client is initialized, can it show up on
1816
client_object_name = str(self.name).translate(
1817
{ord("."): ord("_"),
1818
ord("-"): ord("_")})
1819
self.dbus_object_path = dbus.ObjectPath(
1820
"/clients/" + client_object_name)
1821
DBusObjectWithProperties.__init__(self, self.bus,
1822
self.dbus_object_path)
1824
def notifychangeproperty(transform_func, dbus_name,
1825
type_func=lambda x: x,
1827
invalidate_only=False,
1828
_interface=_interface):
1829
""" Modify a variable so that it's a property which announces
1830
its changes to DBus.
1832
transform_fun: Function that takes a value and a variant_level
1833
and transforms it to a D-Bus type.
1834
dbus_name: D-Bus name of the variable
1835
type_func: Function that transform the value before sending it
1836
to the D-Bus. Default: no transform
1837
variant_level: D-Bus variant level. Default: 1
1839
attrname = "_{}".format(dbus_name)
1841
def setter(self, value):
1842
if hasattr(self, "dbus_object_path"):
1843
if (not hasattr(self, attrname) or
1844
type_func(getattr(self, attrname, None))
1845
!= type_func(value)):
1847
self.PropertiesChanged(
1848
_interface, dbus.Dictionary(),
1849
dbus.Array((dbus_name, )))
1851
dbus_value = transform_func(
1853
variant_level=variant_level)
1854
self.PropertyChanged(dbus.String(dbus_name),
1856
self.PropertiesChanged(
1858
dbus.Dictionary({dbus.String(dbus_name):
1861
setattr(self, attrname, value)
1863
return property(lambda self: getattr(self, attrname), setter)
1865
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1866
approvals_pending = notifychangeproperty(dbus.Boolean,
1869
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1870
last_enabled = notifychangeproperty(datetime_to_dbus,
1872
checker = notifychangeproperty(
1873
dbus.Boolean, "CheckerRunning",
1874
type_func=lambda checker: checker is not None)
1875
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1877
last_checker_status = notifychangeproperty(dbus.Int16,
1878
"LastCheckerStatus")
1879
last_approval_request = notifychangeproperty(
1880
datetime_to_dbus, "LastApprovalRequest")
1881
approved_by_default = notifychangeproperty(dbus.Boolean,
1882
"ApprovedByDefault")
1883
approval_delay = notifychangeproperty(
1884
dbus.UInt64, "ApprovalDelay",
1885
type_func=lambda td: td.total_seconds() * 1000)
1886
approval_duration = notifychangeproperty(
1887
dbus.UInt64, "ApprovalDuration",
1888
type_func=lambda td: td.total_seconds() * 1000)
1889
host = notifychangeproperty(dbus.String, "Host")
1890
timeout = notifychangeproperty(
1891
dbus.UInt64, "Timeout",
1892
type_func=lambda td: td.total_seconds() * 1000)
1893
extended_timeout = notifychangeproperty(
1894
dbus.UInt64, "ExtendedTimeout",
1895
type_func=lambda td: td.total_seconds() * 1000)
1896
interval = notifychangeproperty(
1897
dbus.UInt64, "Interval",
1898
type_func=lambda td: td.total_seconds() * 1000)
1899
checker_command = notifychangeproperty(dbus.String, "Checker")
1900
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1901
invalidate_only=True)
1903
del notifychangeproperty
1905
def __del__(self, *args, **kwargs):
1907
self.remove_from_connection()
1910
if hasattr(DBusObjectWithProperties, "__del__"):
1911
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1912
Client.__del__(self, *args, **kwargs)
1914
def checker_callback(self, source, condition,
1915
connection, command, *args, **kwargs):
1916
ret = Client.checker_callback(self, source, condition,
1917
connection, command, *args,
1919
exitstatus = self.last_checker_status
1922
self.CheckerCompleted(dbus.Int16(exitstatus),
1923
# This is specific to GNU libC
1924
dbus.Int64(exitstatus << 8),
1925
dbus.String(command))
1928
self.CheckerCompleted(dbus.Int16(-1),
1930
# This is specific to GNU libC
1932
| self.last_checker_signal),
1933
dbus.String(command))
1936
def start_checker(self, *args, **kwargs):
1937
old_checker_pid = getattr(self.checker, "pid", None)
1938
r = Client.start_checker(self, *args, **kwargs)
1939
# Only if new checker process was started
1940
if (self.checker is not None
1941
and old_checker_pid != self.checker.pid):
1943
self.CheckerStarted(self.current_checker_command)
1946
def _reset_approved(self):
1947
self.approved = None
1950
def approve(self, value=True):
1951
self.approved = value
1952
GLib.timeout_add(int(self.approval_duration.total_seconds()
1953
* 1000), self._reset_approved)
1954
self.send_changedstate()
1956
# D-Bus methods, signals & properties
1962
# CheckerCompleted - signal
1963
@dbus.service.signal(_interface, signature="nxs")
1964
def CheckerCompleted(self, exitcode, waitstatus, command):
1968
# CheckerStarted - signal
1969
@dbus.service.signal(_interface, signature="s")
1970
def CheckerStarted(self, command):
1974
# PropertyChanged - signal
1975
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1976
@dbus.service.signal(_interface, signature="sv")
1977
def PropertyChanged(self, property, value):
1981
# GotSecret - signal
1982
@dbus.service.signal(_interface)
1983
def GotSecret(self):
1985
Is sent after a successful transfer of secret from the Mandos
1986
server to mandos-client
1991
@dbus.service.signal(_interface, signature="s")
1992
def Rejected(self, reason):
1996
# NeedApproval - signal
1997
@dbus.service.signal(_interface, signature="tb")
1998
def NeedApproval(self, timeout, default):
2000
return self.need_approval()
2005
@dbus.service.method(_interface, in_signature="b")
2006
def Approve(self, value):
2009
# CheckedOK - method
2010
@dbus.service.method(_interface)
2011
def CheckedOK(self):
2015
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2016
@dbus.service.method(_interface)
2021
# StartChecker - method
2022
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2023
@dbus.service.method(_interface)
2024
def StartChecker(self):
2026
self.start_checker()
2029
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2030
@dbus.service.method(_interface)
2035
# StopChecker - method
2036
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2037
@dbus.service.method(_interface)
2038
def StopChecker(self):
2043
# ApprovalPending - property
2044
@dbus_service_property(_interface, signature="b", access="read")
2045
def ApprovalPending_dbus_property(self):
2046
return dbus.Boolean(bool(self.approvals_pending))
2048
# ApprovedByDefault - property
2049
@dbus_service_property(_interface,
2052
def ApprovedByDefault_dbus_property(self, value=None):
2053
if value is None: # get
2054
return dbus.Boolean(self.approved_by_default)
2055
self.approved_by_default = bool(value)
2057
# ApprovalDelay - property
2058
@dbus_service_property(_interface,
2061
def ApprovalDelay_dbus_property(self, value=None):
2062
if value is None: # get
2063
return dbus.UInt64(self.approval_delay.total_seconds()
2065
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2067
# ApprovalDuration - property
2068
@dbus_service_property(_interface,
2071
def ApprovalDuration_dbus_property(self, value=None):
2072
if value is None: # get
2073
return dbus.UInt64(self.approval_duration.total_seconds()
2075
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2079
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2080
@dbus_service_property(_interface, signature="s", access="read")
2081
def Name_dbus_property(self):
2082
return dbus.String(self.name)
2086
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2087
@dbus_service_property(_interface, signature="s", access="read")
2088
def KeyID_dbus_property(self):
2089
return dbus.String(self.key_id)
2091
# Fingerprint - property
2093
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2094
@dbus_service_property(_interface, signature="s", access="read")
2095
def Fingerprint_dbus_property(self):
2096
return dbus.String(self.fingerprint)
2099
@dbus_service_property(_interface,
2102
def Host_dbus_property(self, value=None):
2103
if value is None: # get
2104
return dbus.String(self.host)
2105
self.host = str(value)
2107
# Created - property
2109
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2110
@dbus_service_property(_interface, signature="s", access="read")
2111
def Created_dbus_property(self):
2112
return datetime_to_dbus(self.created)
2114
# LastEnabled - property
2115
@dbus_service_property(_interface, signature="s", access="read")
2116
def LastEnabled_dbus_property(self):
2117
return datetime_to_dbus(self.last_enabled)
2119
# Enabled - property
2120
@dbus_service_property(_interface,
2123
def Enabled_dbus_property(self, value=None):
2124
if value is None: # get
2125
return dbus.Boolean(self.enabled)
2131
# LastCheckedOK - property
2132
@dbus_service_property(_interface,
2135
def LastCheckedOK_dbus_property(self, value=None):
2136
if value is not None:
2139
return datetime_to_dbus(self.last_checked_ok)
2141
# LastCheckerStatus - property
2142
@dbus_service_property(_interface, signature="n", access="read")
2143
def LastCheckerStatus_dbus_property(self):
2144
return dbus.Int16(self.last_checker_status)
2146
# Expires - property
2147
@dbus_service_property(_interface, signature="s", access="read")
2148
def Expires_dbus_property(self):
2149
return datetime_to_dbus(self.expires)
2151
# LastApprovalRequest - property
2152
@dbus_service_property(_interface, signature="s", access="read")
2153
def LastApprovalRequest_dbus_property(self):
2154
return datetime_to_dbus(self.last_approval_request)
2156
# Timeout - property
2157
@dbus_service_property(_interface,
2160
def Timeout_dbus_property(self, value=None):
2161
if value is None: # get
2162
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2163
old_timeout = self.timeout
2164
self.timeout = datetime.timedelta(0, 0, 0, value)
2165
# Reschedule disabling
2167
now = datetime.datetime.utcnow()
2168
self.expires += self.timeout - old_timeout
2169
if self.expires <= now:
2170
# The timeout has passed
2173
if (getattr(self, "disable_initiator_tag", None)
2176
GLib.source_remove(self.disable_initiator_tag)
2177
self.disable_initiator_tag = GLib.timeout_add(
2178
int((self.expires - now).total_seconds() * 1000),
2181
# ExtendedTimeout - property
2182
@dbus_service_property(_interface,
2185
def ExtendedTimeout_dbus_property(self, value=None):
2186
if value is None: # get
2187
return dbus.UInt64(self.extended_timeout.total_seconds()
2189
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2191
# Interval - property
2192
@dbus_service_property(_interface,
2195
def Interval_dbus_property(self, value=None):
2196
if value is None: # get
2197
return dbus.UInt64(self.interval.total_seconds() * 1000)
2198
self.interval = datetime.timedelta(0, 0, 0, value)
2199
if getattr(self, "checker_initiator_tag", None) is None:
2202
# Reschedule checker run
2203
GLib.source_remove(self.checker_initiator_tag)
2204
self.checker_initiator_tag = GLib.timeout_add(
2205
value, self.start_checker)
2206
self.start_checker() # Start one now, too
2208
# Checker - property
2209
@dbus_service_property(_interface,
2212
def Checker_dbus_property(self, value=None):
2213
if value is None: # get
2214
return dbus.String(self.checker_command)
2215
self.checker_command = str(value)
2217
# CheckerRunning - property
2218
@dbus_service_property(_interface,
2221
def CheckerRunning_dbus_property(self, value=None):
2222
if value is None: # get
2223
return dbus.Boolean(self.checker is not None)
2225
self.start_checker()
2229
# ObjectPath - property
2231
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2232
"org.freedesktop.DBus.Deprecated": "true"})
2233
@dbus_service_property(_interface, signature="o", access="read")
2234
def ObjectPath_dbus_property(self):
2235
return self.dbus_object_path # is already a dbus.ObjectPath
2239
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2241
@dbus_service_property(_interface,
2245
def Secret_dbus_property(self, value):
2246
self.secret = bytes(value)
2252
def __init__(self, child_pipe, key_id, fpr, address):
2253
self._pipe = child_pipe
2254
self._pipe.send(('init', key_id, fpr, address))
2255
if not self._pipe.recv():
2256
raise KeyError(key_id or fpr)
2258
def __getattribute__(self, name):
2260
return super(ProxyClient, self).__getattribute__(name)
2261
self._pipe.send(('getattr', name))
2262
data = self._pipe.recv()
2263
if data[0] == 'data':
2265
if data[0] == 'function':
2267
def func(*args, **kwargs):
2268
self._pipe.send(('funcall', name, args, kwargs))
2269
return self._pipe.recv()[1]
2273
def __setattr__(self, name, value):
2275
return super(ProxyClient, self).__setattr__(name, value)
2276
self._pipe.send(('setattr', name, value))
2279
class ClientHandler(socketserver.BaseRequestHandler, object):
2280
"""A class to handle client connections.
2282
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.
2283
431
Note: This will run in its own forked process."""
2285
433
def handle(self):
2286
with contextlib.closing(self.server.child_pipe) as child_pipe:
2287
logger.info("TCP connection from: %s",
2288
str(self.client_address))
2289
logger.debug("Pipe FD: %d",
2290
self.server.child_pipe.fileno())
2292
session = gnutls.ClientSession(self.request)
2294
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2295
# "+AES-256-CBC", "+SHA1",
2296
# "+COMP-NULL", "+CTYPE-OPENPGP",
2298
# Use a fallback default, since this MUST be set.
2299
priority = self.server.gnutls_priority
2300
if priority is None:
2302
gnutls.priority_set_direct(session._c_object,
2303
priority.encode("utf-8"),
2306
# Start communication using the Mandos protocol
2307
# Get protocol number
2308
line = self.request.makefile().readline()
2309
logger.debug("Protocol version: %r", line)
2311
if int(line.strip().split()[0]) > 1:
2312
raise RuntimeError(line)
2313
except (ValueError, IndexError, RuntimeError) as error:
2314
logger.error("Unknown protocol version: %s", error)
2317
# Start GnuTLS connection
2320
except gnutls.Error as error:
2321
logger.warning("Handshake failed: %s", error)
2322
# Do not run session.bye() here: the session is not
2323
# established. Just abandon the request.
2325
logger.debug("Handshake succeeded")
2327
approval_required = False
2329
if gnutls.has_rawpk:
2332
key_id = self.key_id(
2333
self.peer_certificate(session))
2334
except (TypeError, gnutls.Error) as error:
2335
logger.warning("Bad certificate: %s", error)
2337
logger.debug("Key ID: %s", key_id)
2342
fpr = self.fingerprint(
2343
self.peer_certificate(session))
2344
except (TypeError, gnutls.Error) as error:
2345
logger.warning("Bad certificate: %s", error)
2347
logger.debug("Fingerprint: %s", fpr)
2350
client = ProxyClient(child_pipe, key_id, fpr,
2351
self.client_address)
2355
if client.approval_delay:
2356
delay = client.approval_delay
2357
client.approvals_pending += 1
2358
approval_required = True
2361
if not client.enabled:
2362
logger.info("Client %s is disabled",
2364
if self.server.use_dbus:
2366
client.Rejected("Disabled")
2369
if client.approved or not client.approval_delay:
2370
# We are approved or approval is disabled
2372
elif client.approved is None:
2373
logger.info("Client %s needs approval",
2375
if self.server.use_dbus:
2377
client.NeedApproval(
2378
client.approval_delay.total_seconds()
2379
* 1000, client.approved_by_default)
2381
logger.warning("Client %s was not approved",
2383
if self.server.use_dbus:
2385
client.Rejected("Denied")
2388
# wait until timeout or approved
2389
time = datetime.datetime.now()
2390
client.changedstate.acquire()
2391
client.changedstate.wait(delay.total_seconds())
2392
client.changedstate.release()
2393
time2 = datetime.datetime.now()
2394
if (time2 - time) >= delay:
2395
if not client.approved_by_default:
2396
logger.warning("Client %s timed out while"
2397
" waiting for approval",
2399
if self.server.use_dbus:
2401
client.Rejected("Approval timed out")
2406
delay -= time2 - time
2409
session.send(client.secret)
2410
except gnutls.Error as error:
2411
logger.warning("gnutls send failed",
2415
logger.info("Sending secret to %s", client.name)
2416
# bump the timeout using extended_timeout
2417
client.bump_timeout(client.extended_timeout)
2418
if self.server.use_dbus:
2423
if approval_required:
2424
client.approvals_pending -= 1
2427
except gnutls.Error as error:
2428
logger.warning("GnuTLS bye failed",
2432
def peer_certificate(session):
2433
"Return the peer's certificate as a bytestring"
2435
cert_type = gnutls.certificate_type_get2(session._c_object,
2437
except AttributeError:
2438
cert_type = gnutls.certificate_type_get(session._c_object)
2439
if gnutls.has_rawpk:
2440
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2442
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2443
# If not a valid certificate type...
2444
if cert_type not in valid_cert_types:
2445
logger.info("Cert type %r not in %r", cert_type,
2447
# ...return invalid data
2449
list_size = ctypes.c_uint(1)
2450
cert_list = (gnutls.certificate_get_peers
2451
(session._c_object, ctypes.byref(list_size)))
2452
if not bool(cert_list) and list_size.value != 0:
2453
raise gnutls.Error("error getting peer certificate")
2454
if list_size.value == 0:
2457
return ctypes.string_at(cert.data, cert.size)
2460
def key_id(certificate):
2461
"Convert a certificate bytestring to a hexdigit key ID"
2462
# New GnuTLS "datum" with the public key
2463
datum = gnutls.datum_t(
2464
ctypes.cast(ctypes.c_char_p(certificate),
2465
ctypes.POINTER(ctypes.c_ubyte)),
2466
ctypes.c_uint(len(certificate)))
2467
# XXX all these need to be created in the gnutls "module"
2468
# New empty GnuTLS certificate
2469
pubkey = gnutls.pubkey_t()
2470
gnutls.pubkey_init(ctypes.byref(pubkey))
2471
# Import the raw public key into the certificate
2472
gnutls.pubkey_import(pubkey,
2473
ctypes.byref(datum),
2474
gnutls.X509_FMT_DER)
2475
# New buffer for the key ID
2476
buf = ctypes.create_string_buffer(32)
2477
buf_len = ctypes.c_size_t(len(buf))
2478
# Get the key ID from the raw public key into the buffer
2479
gnutls.pubkey_get_key_id(
2481
gnutls.KEYID_USE_SHA256,
2482
ctypes.cast(ctypes.byref(buf),
2483
ctypes.POINTER(ctypes.c_ubyte)),
2484
ctypes.byref(buf_len))
2485
# Deinit the certificate
2486
gnutls.pubkey_deinit(pubkey)
2488
# Convert the buffer to a Python bytestring
2489
key_id = ctypes.string_at(buf, buf_len.value)
2490
# Convert the bytestring to hexadecimal notation
2491
hex_key_id = binascii.hexlify(key_id).upper()
2495
def fingerprint(openpgp):
2496
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2497
# New GnuTLS "datum" with the OpenPGP public key
2498
datum = gnutls.datum_t(
2499
ctypes.cast(ctypes.c_char_p(openpgp),
2500
ctypes.POINTER(ctypes.c_ubyte)),
2501
ctypes.c_uint(len(openpgp)))
2502
# New empty GnuTLS certificate
2503
crt = gnutls.openpgp_crt_t()
2504
gnutls.openpgp_crt_init(ctypes.byref(crt))
2505
# Import the OpenPGP public key into the certificate
2506
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2507
gnutls.OPENPGP_FMT_RAW)
2508
# Verify the self signature in the key
2509
crtverify = ctypes.c_uint()
2510
gnutls.openpgp_crt_verify_self(crt, 0,
2511
ctypes.byref(crtverify))
2512
if crtverify.value != 0:
2513
gnutls.openpgp_crt_deinit(crt)
2514
raise gnutls.CertificateSecurityError(code
2516
# New buffer for the fingerprint
2517
buf = ctypes.create_string_buffer(20)
2518
buf_len = ctypes.c_size_t()
2519
# Get the fingerprint from the certificate into the buffer
2520
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2521
ctypes.byref(buf_len))
2522
# Deinit the certificate
2523
gnutls.openpgp_crt_deinit(crt)
2524
# Convert the buffer to a Python bytestring
2525
fpr = ctypes.string_at(buf, buf_len.value)
2526
# Convert the bytestring to hexadecimal notation
2527
hex_fpr = binascii.hexlify(fpr).upper()
2531
class MultiprocessingMixIn:
2532
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2534
def sub_process_main(self, request, address):
2536
self.finish_request(request, address)
2538
self.handle_error(request, address)
2539
self.close_request(request)
2541
def process_request(self, request, address):
2542
"""Start a new process to process the request."""
2543
proc = multiprocessing.Process(target=self.sub_process_main,
2544
args=(request, address))
2549
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2550
""" adds a pipe to the MixIn """
2552
def process_request(self, request, client_address):
2553
"""Overrides and wraps the original process_request().
2555
This function creates a new pipe in self.pipe
2557
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2559
proc = MultiprocessingMixIn.process_request(self, request,
2561
self.child_pipe.close()
2562
self.add_pipe(parent_pipe, proc)
2564
def add_pipe(self, parent_pipe, proc):
2565
"""Dummy function; override as necessary"""
2566
raise NotImplementedError()
2569
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2570
socketserver.TCPServer):
2571
"""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())
438
# Note: gnutls.connection.X509Credentials is really a generic
439
# GnuTLS certificate credentials object so long as no X.509
440
# keys are added to it. Therefore, we can use it here despite
441
# using OpenPGP certificates.
443
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
444
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
446
priority = "NORMAL" # Fallback default, since this
448
if self.server.settings["priority"]:
449
priority = self.server.settings["priority"]
450
gnutls.library.functions.gnutls_priority_set_direct\
451
(session._c_object, priority, None);
455
except gnutls.errors.GNUTLSError, error:
456
logger.debug(u"Handshake failed: %s", error)
457
# Do not run session.bye() here: the session is not
458
# established. Just abandon the request.
461
fpr = fingerprint(peer_certificate(session))
462
except (TypeError, gnutls.errors.GNUTLSError), error:
463
logger.debug(u"Bad certificate: %s", error)
466
logger.debug(u"Fingerprint: %s", fpr)
468
for c in self.server.clients:
469
if c.fingerprint == fpr:
473
logger.debug(u"Client not found for fingerprint: %s", fpr)
476
# Have to check if client.still_valid(), since it is possible
477
# that the client timed out while establishing the GnuTLS
479
if not client.still_valid():
480
logger.debug(u"Client %(name)s is invalid", vars(client))
484
while sent_size < len(client.secret):
485
sent = session.send(client.secret[sent_size:])
486
logger.debug(u"Sent: %d, remaining: %d",
487
sent, len(client.secret)
488
- (sent_size + sent))
493
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
494
"""IPv6 TCP server. Accepts 'None' as address and/or port.
2574
enabled: Boolean; whether this server is activated yet
2575
interface: None or a network interface name (string)
2576
use_ipv6: Boolean; to use IPv6 or not
496
settings: Server settings
497
clients: Set() of Client objects
2579
def __init__(self, server_address, RequestHandlerClass,
2583
"""If socketfd is set, use that file descriptor instead of
2584
creating a new one with socket.socket().
2586
self.interface = interface
2588
self.address_family = socket.AF_INET6
2589
if socketfd is not None:
2590
# Save the file descriptor
2591
self.socketfd = socketfd
2592
# Save the original socket.socket() function
2593
self.socket_socket = socket.socket
2595
# To implement --socket, we monkey patch socket.socket.
2597
# (When socketserver.TCPServer is a new-style class, we
2598
# could make self.socket into a property instead of monkey
2599
# patching socket.socket.)
2601
# Create a one-time-only replacement for socket.socket()
2602
@functools.wraps(socket.socket)
2603
def socket_wrapper(*args, **kwargs):
2604
# Restore original function so subsequent calls are
2606
socket.socket = self.socket_socket
2607
del self.socket_socket
2608
# This time only, return a new socket object from the
2609
# saved file descriptor.
2610
return socket.fromfd(self.socketfd, *args, **kwargs)
2611
# Replace socket.socket() function with wrapper
2612
socket.socket = socket_wrapper
2613
# The socketserver.TCPServer.__init__ will call
2614
# socket.socket(), which might be our replacement,
2615
# socket_wrapper(), if socketfd was set.
2616
socketserver.TCPServer.__init__(self, server_address,
2617
RequestHandlerClass)
499
address_family = socket.AF_INET6
500
def __init__(self, *args, **kwargs):
501
if "settings" in kwargs:
502
self.settings = kwargs["settings"]
503
del kwargs["settings"]
504
if "clients" in kwargs:
505
self.clients = kwargs["clients"]
506
del kwargs["clients"]
507
return super(type(self), self).__init__(*args, **kwargs)
2619
508
def server_bind(self):
2620
509
"""This overrides the normal server_bind() function
2621
510
to bind to an interface if one was specified, and also NOT to
2622
511
bind to an address or port if they were not specified."""
2623
global SO_BINDTODEVICE
2624
if self.interface is not None:
2625
if SO_BINDTODEVICE is None:
2626
# Fall back to a hard-coded value which seems to be
2628
logger.warning("SO_BINDTODEVICE not found, trying 25")
2629
SO_BINDTODEVICE = 25
512
if self.settings["interface"]:
513
# 25 is from /usr/include/asm-i486/socket.h
514
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
2631
self.socket.setsockopt(
2632
socket.SOL_SOCKET, SO_BINDTODEVICE,
2633
(self.interface + "\0").encode("utf-8"))
2634
except socket.error as error:
2635
if error.errno == errno.EPERM:
2636
logger.error("No permission to bind to"
2637
" interface %s", self.interface)
2638
elif error.errno == errno.ENOPROTOOPT:
2639
logger.error("SO_BINDTODEVICE not available;"
2640
" cannot bind to interface %s",
2642
elif error.errno == errno.ENODEV:
2643
logger.error("Interface %s does not exist,"
2644
" cannot bind", self.interface)
516
self.socket.setsockopt(socket.SOL_SOCKET,
518
self.settings["interface"])
519
except socket.error, error:
520
if error[0] == errno.EPERM:
521
logger.warning(u"No permission to"
522
u" bind to interface %s",
523
self.settings["interface"])
2647
526
# Only bind(2) the socket if we really need to.
2648
527
if self.server_address[0] or self.server_address[1]:
2649
if self.server_address[1]:
2650
self.allow_reuse_address = True
2651
528
if not self.server_address[0]:
2652
if self.address_family == socket.AF_INET6:
2653
any_address = "::" # in6addr_any
2655
any_address = "0.0.0.0" # INADDR_ANY
2656
self.server_address = (any_address,
530
self.server_address = (in6addr_any,
2657
531
self.server_address[1])
2658
elif not self.server_address[1]:
2659
self.server_address = (self.server_address[0], 0)
2660
# if self.interface:
2661
# self.server_address = (self.server_address[0],
2666
return socketserver.TCPServer.server_bind(self)
2669
class MandosServer(IPv6_TCPServer):
2673
clients: set of Client objects
2674
gnutls_priority GnuTLS priority string
2675
use_dbus: Boolean; to emit D-Bus signals or not
2677
Assumes a GLib.MainLoop event loop.
2680
def __init__(self, server_address, RequestHandlerClass,
2684
gnutls_priority=None,
2687
self.enabled = False
2688
self.clients = clients
2689
if self.clients is None:
2691
self.use_dbus = use_dbus
2692
self.gnutls_priority = gnutls_priority
2693
IPv6_TCPServer.__init__(self, server_address,
2694
RequestHandlerClass,
2695
interface=interface,
2699
def server_activate(self):
2701
return socketserver.TCPServer.server_activate(self)
2706
def add_pipe(self, parent_pipe, proc):
2707
# Call "handle_ipc" for both data and EOF events
2709
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2710
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2711
functools.partial(self.handle_ipc,
2712
parent_pipe=parent_pipe,
2715
def handle_ipc(self, source, condition,
2718
client_object=None):
2719
# error, or the other end of multiprocessing.Pipe has closed
2720
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2721
# Wait for other process to exit
2725
# Read a request from the child
2726
request = parent_pipe.recv()
2727
command = request[0]
2729
if command == 'init':
2730
key_id = request[1].decode("ascii")
2731
fpr = request[2].decode("ascii")
2732
address = request[3]
2734
for c in self.clients.values():
2735
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2736
"27AE41E4649B934CA495991B7852B855"):
2738
if key_id and c.key_id == key_id:
2741
if fpr and c.fingerprint == fpr:
2745
logger.info("Client not found for key ID: %s, address"
2746
": %s", key_id or fpr, address)
2749
mandos_dbus_service.ClientNotFound(key_id or fpr,
2751
parent_pipe.send(False)
2755
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2756
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2757
functools.partial(self.handle_ipc,
2758
parent_pipe=parent_pipe,
2760
client_object=client))
2761
parent_pipe.send(True)
2762
# remove the old hook in favor of the new above hook on
2765
if command == 'funcall':
2766
funcname = request[1]
2770
parent_pipe.send(('data', getattr(client_object,
2774
if command == 'getattr':
2775
attrname = request[1]
2776
if isinstance(client_object.__getattribute__(attrname),
2777
collections.abc.Callable):
2778
parent_pipe.send(('function', ))
2781
'data', client_object.__getattribute__(attrname)))
2783
if command == 'setattr':
2784
attrname = request[1]
2786
setattr(client_object, attrname, value)
2791
def rfc3339_duration_to_delta(duration):
2792
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2794
>>> timedelta = datetime.timedelta
2795
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2797
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2799
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2801
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2803
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2805
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2807
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2812
# Parsing an RFC 3339 duration with regular expressions is not
2813
# possible - there would have to be multiple places for the same
2814
# values, like seconds. The current code, while more esoteric, is
2815
# cleaner without depending on a parsing library. If Python had a
2816
# built-in library for parsing we would use it, but we'd like to
2817
# avoid excessive use of external libraries.
2819
# New type for defining tokens, syntax, and semantics all-in-one
2820
Token = collections.namedtuple("Token", (
2821
"regexp", # To match token; if "value" is not None, must have
2822
# a "group" containing digits
2823
"value", # datetime.timedelta or None
2824
"followers")) # Tokens valid after this token
2825
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2826
# the "duration" ABNF definition in RFC 3339, Appendix A.
2827
token_end = Token(re.compile(r"$"), None, frozenset())
2828
token_second = Token(re.compile(r"(\d+)S"),
2829
datetime.timedelta(seconds=1),
2830
frozenset((token_end, )))
2831
token_minute = Token(re.compile(r"(\d+)M"),
2832
datetime.timedelta(minutes=1),
2833
frozenset((token_second, token_end)))
2834
token_hour = Token(re.compile(r"(\d+)H"),
2835
datetime.timedelta(hours=1),
2836
frozenset((token_minute, token_end)))
2837
token_time = Token(re.compile(r"T"),
2839
frozenset((token_hour, token_minute,
2841
token_day = Token(re.compile(r"(\d+)D"),
2842
datetime.timedelta(days=1),
2843
frozenset((token_time, token_end)))
2844
token_month = Token(re.compile(r"(\d+)M"),
2845
datetime.timedelta(weeks=4),
2846
frozenset((token_day, token_end)))
2847
token_year = Token(re.compile(r"(\d+)Y"),
2848
datetime.timedelta(weeks=52),
2849
frozenset((token_month, token_end)))
2850
token_week = Token(re.compile(r"(\d+)W"),
2851
datetime.timedelta(weeks=1),
2852
frozenset((token_end, )))
2853
token_duration = Token(re.compile(r"P"), None,
2854
frozenset((token_year, token_month,
2855
token_day, token_time,
2857
# Define starting values:
2859
value = datetime.timedelta()
2861
# Following valid tokens
2862
followers = frozenset((token_duration, ))
2863
# String left to parse
2865
# Loop until end token is found
2866
while found_token is not token_end:
2867
# Search for any currently valid tokens
2868
for token in followers:
2869
match = token.regexp.match(s)
2870
if match is not None:
2872
if token.value is not None:
2873
# Value found, parse digits
2874
factor = int(match.group(1), 10)
2875
# Add to value so far
2876
value += factor * token.value
2877
# Strip token from string
2878
s = token.regexp.sub("", s, 1)
2881
# Set valid next tokens
2882
followers = found_token.followers
2885
# No currently valid tokens were found
2886
raise ValueError("Invalid RFC 3339 duration: {!r}"
532
elif self.server_address[1] is None:
533
self.server_address = (self.server_address[0],
535
return super(type(self), self).server_bind()
2892
538
def string_to_delta(interval):
2893
539
"""Parse a string and return a datetime.timedelta
2895
>>> string_to_delta('7d') == datetime.timedelta(7)
2897
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2899
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2901
>>> string_to_delta('24h') == datetime.timedelta(1)
2903
>>> string_to_delta('1w') == datetime.timedelta(7)
2905
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
541
>>> string_to_delta('7d')
542
datetime.timedelta(7)
543
>>> string_to_delta('60s')
544
datetime.timedelta(0, 60)
545
>>> string_to_delta('60m')
546
datetime.timedelta(0, 3600)
547
>>> string_to_delta('24h')
548
datetime.timedelta(1)
549
>>> string_to_delta(u'1w')
550
datetime.timedelta(7)
2910
return rfc3339_duration_to_delta(interval)
2914
timevalue = datetime.timedelta(0)
2915
for s in interval.split():
2920
delta = datetime.timedelta(value)
2922
delta = datetime.timedelta(0, value)
2924
delta = datetime.timedelta(0, 0, 0, 0, value)
2926
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2928
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2930
raise ValueError("Unknown suffix {!r}".format(suffix))
2931
except IndexError as e:
2932
raise ValueError(*(e.args))
2937
def daemon(nochdir=False, noclose=False):
553
suffix=unicode(interval[-1])
554
value=int(interval[:-1])
556
delta = datetime.timedelta(value)
558
delta = datetime.timedelta(0, value)
560
delta = datetime.timedelta(0, 0, 0, 0, value)
562
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
564
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
567
except (ValueError, IndexError):
572
def server_state_changed(state):
573
"""Derived from the Avahi example code"""
574
if state == avahi.SERVER_COLLISION:
575
logger.warning(u"Server name collision")
577
elif state == avahi.SERVER_RUNNING:
581
def entry_group_state_changed(state, error):
582
"""Derived from the Avahi example code"""
583
logger.debug(u"state change: %i", state)
585
if state == avahi.ENTRY_GROUP_ESTABLISHED:
586
logger.debug(u"Service established.")
587
elif state == avahi.ENTRY_GROUP_COLLISION:
588
logger.warning(u"Service name collision.")
590
elif state == avahi.ENTRY_GROUP_FAILURE:
591
logger.critical(u"Error in group state changed %s",
593
raise AvahiGroupError("State changed: %s", str(error))
595
def if_nametoindex(interface, _func=[None]):
596
"""Call the C function if_nametoindex(), or equivalent"""
597
if _func[0] is not None:
598
return _func[0](interface)
600
if "ctypes.util" not in sys.modules:
604
libc = ctypes.cdll.LoadLibrary\
605
(ctypes.util.find_library("c"))
606
_func[0] = libc.if_nametoindex
607
return _func[0](interface)
611
except (OSError, AttributeError):
612
if "struct" not in sys.modules:
614
if "fcntl" not in sys.modules:
616
def the_hard_way(interface):
617
"Get an interface index the hard way, i.e. using fcntl()"
618
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
620
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
621
struct.pack("16s16x", interface))
623
interface_index = struct.unpack("I", ifreq[16:20])[0]
624
return interface_index
625
_func[0] = the_hard_way
626
return _func[0](interface)
629
def daemon(nochdir, noclose):
2938
630
"""See daemon(3). Standard BSD Unix function.
2940
631
This should really exist as os.daemon, but it doesn't (yet)."""
2949
638
# Close all standard open file descriptors
2950
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
639
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2951
640
if not stat.S_ISCHR(os.fstat(null).st_mode):
2952
641
raise OSError(errno.ENODEV,
2953
"{} not a character device"
2954
.format(os.devnull))
642
"/dev/null not a character device")
2955
643
os.dup2(null, sys.stdin.fileno())
2956
644
os.dup2(null, sys.stdout.fileno())
2957
645
os.dup2(null, sys.stderr.fileno())
2964
##################################################################
2965
# Parsing of options, both command line and config file
2967
parser = argparse.ArgumentParser()
2968
parser.add_argument("-v", "--version", action="version",
2969
version="%(prog)s {}".format(version),
2970
help="show version number and exit")
2971
parser.add_argument("-i", "--interface", metavar="IF",
2972
help="Bind to interface IF")
2973
parser.add_argument("-a", "--address",
2974
help="Address to listen for requests on")
2975
parser.add_argument("-p", "--port", type=int,
2976
help="Port number to receive requests on")
2977
parser.add_argument("--check", action="store_true",
2978
help="Run self-test")
2979
parser.add_argument("--debug", action="store_true",
2980
help="Debug mode; run in foreground and log"
2981
" to terminal", default=None)
2982
parser.add_argument("--debuglevel", metavar="LEVEL",
2983
help="Debug level for stdout output")
2984
parser.add_argument("--priority", help="GnuTLS"
2985
" priority string (see GnuTLS documentation)")
2986
parser.add_argument("--servicename",
2987
metavar="NAME", help="Zeroconf service name")
2988
parser.add_argument("--configdir",
2989
default="/etc/mandos", metavar="DIR",
2990
help="Directory to search for configuration"
2992
parser.add_argument("--no-dbus", action="store_false",
2993
dest="use_dbus", help="Do not provide D-Bus"
2994
" system bus interface", default=None)
2995
parser.add_argument("--no-ipv6", action="store_false",
2996
dest="use_ipv6", help="Do not use IPv6",
2998
parser.add_argument("--no-restore", action="store_false",
2999
dest="restore", help="Do not restore stored"
3000
" state", default=None)
3001
parser.add_argument("--socket", type=int,
3002
help="Specify a file descriptor to a network"
3003
" socket to use instead of creating one")
3004
parser.add_argument("--statedir", metavar="DIR",
3005
help="Directory to save/restore state in")
3006
parser.add_argument("--foreground", action="store_true",
3007
help="Run in foreground", default=None)
3008
parser.add_argument("--no-zeroconf", action="store_false",
3009
dest="zeroconf", help="Do not use Zeroconf",
3012
options = parser.parse_args()
651
global main_loop_started
652
main_loop_started = False
654
parser = OptionParser()
655
parser.add_option("-i", "--interface", type="string",
656
metavar="IF", help="Bind to interface IF")
657
parser.add_option("-a", "--address", type="string",
658
help="Address to listen for requests on")
659
parser.add_option("-p", "--port", type="int",
660
help="Port number to receive requests on")
661
parser.add_option("--check", action="store_true", default=False,
662
help="Run self-test")
663
parser.add_option("--debug", action="store_true", default=False,
664
help="Debug mode; run in foreground and log to"
666
parser.add_option("--priority", type="string", help="GnuTLS"
667
" priority string (see GnuTLS documentation)")
668
parser.add_option("--servicename", type="string", metavar="NAME",
669
help="Zeroconf service name")
670
parser.add_option("--configdir", type="string",
671
default="/etc/mandos", metavar="DIR",
672
help="Directory to search for configuration"
674
(options, args) = parser.parse_args()
3014
681
# Default values for config file for server-global settings
3015
if gnutls.has_rawpk:
3016
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3017
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3019
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3020
":+SIGN-DSA-SHA256")
3021
server_defaults = {"interface": "",
3025
"priority": priority,
3026
"servicename": "Mandos",
3032
"statedir": "/var/lib/mandos",
3033
"foreground": "False",
682
server_defaults = { "interface": "",
687
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
688
"servicename": "Mandos",
3038
691
# Parse config file for server-global settings
3039
server_config = configparser.ConfigParser(server_defaults)
692
server_config = ConfigParser.SafeConfigParser(server_defaults)
3040
693
del server_defaults
3041
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3042
# Convert the ConfigParser object to a dict
3043
server_settings = server_config.defaults()
3044
# Use the appropriate methods on the non-string config options
3045
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3046
"foreground", "zeroconf"):
3047
server_settings[option] = server_config.getboolean("DEFAULT",
3049
if server_settings["port"]:
3050
server_settings["port"] = server_config.getint("DEFAULT",
3052
if server_settings["socket"]:
3053
server_settings["socket"] = server_config.getint("DEFAULT",
3055
# Later, stdin will, and stdout and stderr might, be dup'ed
3056
# over with an opened os.devnull. But we don't want this to
3057
# happen with a supplied network socket.
3058
if 0 <= server_settings["socket"] <= 2:
3059
server_settings["socket"] = os.dup(server_settings
694
server_config.read(os.path.join(options.configdir, "server.conf"))
695
server_section = "server"
696
# Convert the SafeConfigParser object to a dict
697
server_settings = dict(server_config.items(server_section))
698
# Use getboolean on the boolean config option
699
server_settings["debug"] = server_config.getboolean\
700
(server_section, "debug")
3061
701
del server_config
3063
703
# Override the settings from the config file with command line
3064
704
# options, if set.
3065
705
for option in ("interface", "address", "port", "debug",
3066
"priority", "servicename", "configdir", "use_dbus",
3067
"use_ipv6", "debuglevel", "restore", "statedir",
3068
"socket", "foreground", "zeroconf"):
706
"priority", "servicename", "configdir"):
3069
707
value = getattr(options, option)
3070
708
if value is not None:
3071
709
server_settings[option] = value
3073
# Force all strings to be unicode
3074
for option in server_settings.keys():
3075
if isinstance(server_settings[option], bytes):
3076
server_settings[option] = (server_settings[option]
3078
# Force all boolean options to be boolean
3079
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3080
"foreground", "zeroconf"):
3081
server_settings[option] = bool(server_settings[option])
3082
# Debug implies foreground
3083
if server_settings["debug"]:
3084
server_settings["foreground"] = True
3085
711
# Now we have our good server settings in "server_settings"
3087
##################################################################
3089
if (not server_settings["zeroconf"]
3090
and not (server_settings["port"]
3091
or server_settings["socket"] != "")):
3092
parser.error("Needs port or socket to work without Zeroconf")
3095
debug = server_settings["debug"]
3096
debuglevel = server_settings["debuglevel"]
3097
use_dbus = server_settings["use_dbus"]
3098
use_ipv6 = server_settings["use_ipv6"]
3099
stored_state_path = os.path.join(server_settings["statedir"],
3101
foreground = server_settings["foreground"]
3102
zeroconf = server_settings["zeroconf"]
3105
initlogger(debug, logging.DEBUG)
3110
level = getattr(logging, debuglevel.upper())
3111
initlogger(debug, level)
3113
if server_settings["servicename"] != "Mandos":
3114
syslogger.setFormatter(
3115
logging.Formatter('Mandos ({}) [%(process)d]:'
3116
' %(levelname)s: %(message)s'.format(
3117
server_settings["servicename"])))
3119
713
# Parse config file with clients
3120
client_config = configparser.ConfigParser(Client.client_defaults)
714
client_defaults = { "timeout": "1h",
716
"checker": "fping -q -- %%(fqdn)s",
718
client_config = ConfigParser.SafeConfigParser(client_defaults)
3121
719
client_config.read(os.path.join(server_settings["configdir"],
3122
720
"clients.conf"))
3124
global mandos_dbus_service
3125
mandos_dbus_service = None
3128
if server_settings["socket"] != "":
3129
socketfd = server_settings["socket"]
3130
tcp_server = MandosServer(
3131
(server_settings["address"], server_settings["port"]),
3133
interface=(server_settings["interface"] or None),
3135
gnutls_priority=server_settings["priority"],
3139
pidfilename = "/run/mandos.pid"
3140
if not os.path.isdir("/run/."):
3141
pidfilename = "/var/run/mandos.pid"
3144
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3145
except IOError as e:
3146
logger.error("Could not open file %r", pidfilename,
3149
for name, group in (("_mandos", "_mandos"),
3150
("mandos", "mandos"),
3151
("nobody", "nogroup")):
3153
uid = pwd.getpwnam(name).pw_uid
3154
gid = pwd.getpwnam(group).pw_gid
3165
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3167
except OSError as error:
3168
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3169
.format(uid, gid, os.strerror(error.errno)))
3170
if error.errno != errno.EPERM:
3174
# Enable all possible GnuTLS debugging
3176
# "Use a log level over 10 to enable all debugging options."
3178
gnutls.global_set_log_level(11)
3181
def debug_gnutls(level, string):
3182
logger.debug("GnuTLS: %s", string[:-1])
3184
gnutls.global_set_log_function(debug_gnutls)
3186
# Redirect stdin so all checkers get /dev/null
3187
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3188
os.dup2(null, sys.stdin.fileno())
3192
# Need to fork before connecting to D-Bus
3194
# Close all input and output, do double fork, etc.
3197
if gi.version_info < (3, 10, 2):
3198
# multiprocessing will use threads, so before we use GLib we
3199
# need to inform GLib that threads will be used.
723
service = AvahiService(name = server_settings["servicename"],
724
type = "_mandos._tcp", );
725
if server_settings["interface"]:
726
service.interface = if_nametoindex(server_settings["interface"])
3202
728
global main_loop
3203
731
# From the Avahi example code
3204
DBusGMainLoop(set_as_default=True)
3205
main_loop = GLib.MainLoop()
732
DBusGMainLoop(set_as_default=True )
733
main_loop = gobject.MainLoop()
3206
734
bus = dbus.SystemBus()
735
server = dbus.Interface(
736
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
737
avahi.DBUS_INTERFACE_SERVER )
3207
738
# End of Avahi example code
3210
bus_name = dbus.service.BusName("se.recompile.Mandos",
3213
old_bus_name = dbus.service.BusName(
3214
"se.bsnet.fukt.Mandos", bus,
3216
except dbus.exceptions.DBusException as e:
3217
logger.error("Disabling D-Bus:", exc_info=e)
3219
server_settings["use_dbus"] = False
3220
tcp_server.use_dbus = False
3222
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3223
service = AvahiServiceToSyslog(
3224
name=server_settings["servicename"],
3225
servicetype="_mandos._tcp",
3228
if server_settings["interface"]:
3229
service.interface = if_nametoindex(
3230
server_settings["interface"].encode("utf-8"))
3232
global multiprocessing_manager
3233
multiprocessing_manager = multiprocessing.Manager()
3235
client_class = Client
3237
client_class = functools.partial(ClientDBus, bus=bus)
3239
client_settings = Client.config_parser(client_config)
3240
old_client_settings = {}
3243
# This is used to redirect stdout and stderr for checker processes
3245
wnull = open(os.devnull, "w") # A writable /dev/null
3246
# Only used if server is running in foreground but not in debug
3248
if debug or not foreground:
3251
# Get client data and settings from last running state.
3252
if server_settings["restore"]:
3254
with open(stored_state_path, "rb") as stored_state:
3255
if sys.version_info.major == 2:
3256
clients_data, old_client_settings = pickle.load(
3259
bytes_clients_data, bytes_old_client_settings = (
3260
pickle.load(stored_state, encoding="bytes"))
3261
# Fix bytes to strings
3264
clients_data = {(key.decode("utf-8")
3265
if isinstance(key, bytes)
3268
bytes_clients_data.items()}
3269
del bytes_clients_data
3270
for key in clients_data:
3271
value = {(k.decode("utf-8")
3272
if isinstance(k, bytes) else k): v
3274
clients_data[key].items()}
3275
clients_data[key] = value
3277
value["client_structure"] = [
3279
if isinstance(s, bytes)
3281
value["client_structure"]]
3282
# .name, .host, and .checker_command
3283
for k in ("name", "host", "checker_command"):
3284
if isinstance(value[k], bytes):
3285
value[k] = value[k].decode("utf-8")
3286
if "key_id" not in value:
3287
value["key_id"] = ""
3288
elif "fingerprint" not in value:
3289
value["fingerprint"] = ""
3290
# old_client_settings
3292
old_client_settings = {
3293
(key.decode("utf-8")
3294
if isinstance(key, bytes)
3297
bytes_old_client_settings.items()}
3298
del bytes_old_client_settings
3299
# .host and .checker_command
3300
for value in old_client_settings.values():
3301
for attribute in ("host", "checker_command"):
3302
if isinstance(value[attribute], bytes):
3303
value[attribute] = (value[attribute]
3305
os.remove(stored_state_path)
3306
except IOError as e:
3307
if e.errno == errno.ENOENT:
3308
logger.warning("Could not load persistent state:"
3309
" {}".format(os.strerror(e.errno)))
3311
logger.critical("Could not load persistent state:",
3314
except EOFError as e:
3315
logger.warning("Could not load persistent state: "
3319
with PGPEngine() as pgp:
3320
for client_name, client in clients_data.items():
3321
# Skip removed clients
3322
if client_name not in client_settings:
3325
# Decide which value to use after restoring saved state.
3326
# We have three different values: Old config file,
3327
# new config file, and saved state.
3328
# New config value takes precedence if it differs from old
3329
# config value, otherwise use saved state.
3330
for name, value in client_settings[client_name].items():
3332
# For each value in new config, check if it
3333
# differs from the old config value (Except for
3334
# the "secret" attribute)
3335
if (name != "secret"
3337
old_client_settings[client_name][name])):
3338
client[name] = value
3342
# Clients who has passed its expire date can still be
3343
# enabled if its last checker was successful. A Client
3344
# whose checker succeeded before we stored its state is
3345
# assumed to have successfully run all checkers during
3347
if client["enabled"]:
3348
if datetime.datetime.utcnow() >= client["expires"]:
3349
if not client["last_checked_ok"]:
3351
"disabling client {} - Client never "
3352
"performed a successful checker".format(
3354
client["enabled"] = False
3355
elif client["last_checker_status"] != 0:
3357
"disabling client {} - Client last"
3358
" checker failed with error code"
3361
client["last_checker_status"]))
3362
client["enabled"] = False
3364
client["expires"] = (
3365
datetime.datetime.utcnow()
3366
+ client["timeout"])
3367
logger.debug("Last checker succeeded,"
3368
" keeping {} enabled".format(
3371
client["secret"] = pgp.decrypt(
3372
client["encrypted_secret"],
3373
client_settings[client_name]["secret"])
3375
# If decryption fails, we use secret from new settings
3376
logger.debug("Failed to decrypt {} old secret".format(
3378
client["secret"] = (client_settings[client_name]
3381
# Add/remove clients based on new changes made to config
3382
for client_name in (set(old_client_settings)
3383
- set(client_settings)):
3384
del clients_data[client_name]
3385
for client_name in (set(client_settings)
3386
- set(old_client_settings)):
3387
clients_data[client_name] = client_settings[client_name]
3389
# Create all client objects
3390
for client_name, client in clients_data.items():
3391
tcp_server.clients[client_name] = client_class(
3394
server_settings=server_settings)
3396
if not tcp_server.clients:
3397
logger.warning("No clients defined")
3400
if pidfile is not None:
3404
print(pid, file=pidfile)
3406
logger.error("Could not write to file %r with PID %d",
3411
for termsig in (signal.SIGHUP, signal.SIGTERM):
3412
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3413
lambda: main_loop.quit() and False)
3417
@alternate_dbus_interfaces(
3418
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3419
class MandosDBusService(DBusObjectWithObjectManager):
3420
"""A D-Bus proxy object"""
3423
dbus.service.Object.__init__(self, bus, "/")
3425
_interface = "se.recompile.Mandos"
3427
@dbus.service.signal(_interface, signature="o")
3428
def ClientAdded(self, objpath):
3432
@dbus.service.signal(_interface, signature="ss")
3433
def ClientNotFound(self, key_id, address):
3437
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3439
@dbus.service.signal(_interface, signature="os")
3440
def ClientRemoved(self, objpath, name):
3444
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3446
@dbus.service.method(_interface, out_signature="ao")
3447
def GetAllClients(self):
3449
return dbus.Array(c.dbus_object_path for c in
3450
tcp_server.clients.values())
3452
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3454
@dbus.service.method(_interface,
3455
out_signature="a{oa{sv}}")
3456
def GetAllClientsWithProperties(self):
3458
return dbus.Dictionary(
3459
{c.dbus_object_path: c.GetAll(
3460
"se.recompile.Mandos.Client")
3461
for c in tcp_server.clients.values()},
3464
@dbus.service.method(_interface, in_signature="o")
3465
def RemoveClient(self, object_path):
3467
for c in tcp_server.clients.values():
3468
if c.dbus_object_path == object_path:
3469
del tcp_server.clients[c.name]
3470
c.remove_from_connection()
3471
# Don't signal the disabling
3472
c.disable(quiet=True)
3473
# Emit D-Bus signal for removal
3474
self.client_removed_signal(c)
3476
raise KeyError(object_path)
3480
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3481
out_signature="a{oa{sa{sv}}}")
3482
def GetManagedObjects(self):
3484
return dbus.Dictionary(
3485
{client.dbus_object_path:
3487
{interface: client.GetAll(interface)
3489
client._get_all_interface_names()})
3490
for client in tcp_server.clients.values()})
3492
def client_added_signal(self, client):
3493
"""Send the new standard signal and the old signal"""
3495
# New standard signal
3496
self.InterfacesAdded(
3497
client.dbus_object_path,
3499
{interface: client.GetAll(interface)
3501
client._get_all_interface_names()}))
3503
self.ClientAdded(client.dbus_object_path)
3505
def client_removed_signal(self, client):
3506
"""Send the new standard signal and the old signal"""
3508
# New standard signal
3509
self.InterfacesRemoved(
3510
client.dbus_object_path,
3511
client._get_all_interface_names())
3513
self.ClientRemoved(client.dbus_object_path,
3516
mandos_dbus_service = MandosDBusService()
3518
# Save modules to variables to exempt the modules from being
3519
# unloaded before the function registered with atexit() is run.
3520
mp = multiprocessing
740
debug = server_settings["debug"]
743
console = logging.StreamHandler()
744
# console.setLevel(logging.DEBUG)
745
console.setFormatter(logging.Formatter\
746
('%(levelname)s: %(message)s'))
747
logger.addHandler(console)
751
def remove_from_clients(client):
752
clients.remove(client)
754
logger.debug(u"No clients left, exiting")
757
clients.update(Set(Client(name=section,
758
stop_hook = remove_from_clients,
759
**(dict(client_config\
761
for section in client_config.sections()))
3524
767
"Cleanup function; run on exit"
3528
mp.active_children()
3530
if not (tcp_server.clients or client_settings):
3533
# Store client before exiting. Secrets are encrypted with key
3534
# based on what config file has. If config file is
3535
# removed/edited, old secret will thus be unrecovable.
3537
with PGPEngine() as pgp:
3538
for client in tcp_server.clients.values():
3539
key = client_settings[client.name]["secret"]
3540
client.encrypted_secret = pgp.encrypt(client.secret,
3544
# A list of attributes that can not be pickled
3546
exclude = {"bus", "changedstate", "secret",
3547
"checker", "server_settings"}
3548
for name, typ in inspect.getmembers(dbus.service
3552
client_dict["encrypted_secret"] = (client
3554
for attr in client.client_structure:
3555
if attr not in exclude:
3556
client_dict[attr] = getattr(client, attr)
3558
clients[client.name] = client_dict
3559
del client_settings[client.name]["secret"]
3562
with tempfile.NamedTemporaryFile(
3566
dir=os.path.dirname(stored_state_path),
3567
delete=False) as stored_state:
3568
pickle.dump((clients, client_settings), stored_state,
3570
tempname = stored_state.name
3571
os.rename(tempname, stored_state_path)
3572
except (IOError, OSError) as e:
3578
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3579
logger.warning("Could not save persistent state: {}"
3580
.format(os.strerror(e.errno)))
3582
logger.warning("Could not save persistent state:",
3586
# Delete all clients, and settings from config
3587
while tcp_server.clients:
3588
name, client = tcp_server.clients.popitem()
3590
client.remove_from_connection()
3591
# Don't signal the disabling
3592
client.disable(quiet=True)
3593
# Emit D-Bus signal for removal
3595
mandos_dbus_service.client_removed_signal(client)
3596
client_settings.clear()
769
# From the Avahi example code
770
if not group is None:
773
# End of Avahi example code
776
client = clients.pop()
777
client.stop_hook = None
3598
780
atexit.register(cleanup)
3600
for client in tcp_server.clients.values():
3602
# Emit D-Bus signal for adding
3603
mandos_dbus_service.client_added_signal(client)
3604
# Need to initiate checking of clients
3606
client.init_checker()
3609
tcp_server.server_activate()
783
signal.signal(signal.SIGINT, signal.SIG_IGN)
784
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
785
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
787
for client in clients:
790
tcp_server = IPv6_TCPServer((server_settings["address"],
791
server_settings["port"]),
793
settings=server_settings,
3611
795
# Find out what port we got
3613
service.port = tcp_server.socket.getsockname()[1]
3615
logger.info("Now listening on address %r, port %d,"
3616
" flowinfo %d, scope_id %d",
3617
*tcp_server.socket.getsockname())
3619
logger.info("Now listening on address %r, port %d",
3620
*tcp_server.socket.getsockname())
3622
# service.interface = tcp_server.socket.getsockname()[3]
796
service.port = tcp_server.socket.getsockname()[1]
797
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
798
u" scope_id %d" % tcp_server.socket.getsockname())
800
#service.interface = tcp_server.socket.getsockname()[3]
3626
# From the Avahi example code
3629
except dbus.exceptions.DBusException as error:
3630
logger.critical("D-Bus Exception", exc_info=error)
3633
# End of Avahi example code
3636
GLib.IOChannel.unix_new(tcp_server.fileno()),
3637
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3638
lambda *args, **kwargs: (tcp_server.handle_request
3639
(*args[2:], **kwargs) or True))
803
# From the Avahi example code
804
server.connect_to_signal("StateChanged", server_state_changed)
806
server_state_changed(server.GetState())
807
except dbus.exceptions.DBusException, error:
808
logger.critical(u"DBusException: %s", error)
810
# End of Avahi example code
812
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
813
lambda *args, **kwargs:
814
tcp_server.handle_request\
815
(*args[2:], **kwargs) or True)
3641
817
logger.debug("Starting main loop")
818
main_loop_started = True
3643
except AvahiError as error:
3644
logger.critical("Avahi Error", exc_info=error)
820
except AvahiError, error:
821
logger.critical(u"AvahiError: %s" + unicode(error))
3647
823
except KeyboardInterrupt:
3649
print("", file=sys.stderr)
3650
logger.debug("Server received KeyboardInterrupt")
3651
logger.debug("Server exiting")
3652
# Must run before the D-Bus bus name gets deregistered
3656
def should_only_run_tests():
3657
parser = argparse.ArgumentParser(add_help=False)
3658
parser.add_argument("--check", action='store_true')
3659
args, unknown_args = parser.parse_known_args()
3660
run_tests = args.check
3662
# Remove --check argument from sys.argv
3663
sys.argv[1:] = unknown_args
3666
# Add all tests from doctest strings
3667
def load_tests(loader, tests, none):
3669
tests.addTests(doctest.DocTestSuite())
3672
827
if __name__ == '__main__':
3674
if should_only_run_tests():
3675
# Call using ./mandos --check [--verbose]