2
# -*- mode: python; coding: utf-8 -*-
2
# -*- coding: utf-8; lexical-binding: t -*-
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
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
13
13
# Everything else is
14
# Copyright © 2008-2010 Teddy Hogeborn
15
# Copyright © 2008-2010 Björn Påhlsson
17
# This program is free software: you can redistribute it and/or modify
18
# it under the terms of the GNU General Public License as published by
14
# Copyright © 2008-2022 Teddy Hogeborn
15
# Copyright © 2008-2022 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
19
21
# the Free Software Foundation, either version 3 of the License, or
20
22
# (at your option) any later version.
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
24
26
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25
27
# GNU General Public License for more details.
27
29
# You should have received a copy of the GNU General Public License
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
31
# Contact the authors at <mandos@fukt.bsnet.se>.
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
32
# Contact the authors at <mandos@recompile.se>.
34
34
from __future__ import (division, absolute_import, print_function,
37
import SocketServer as socketserver
38
from future_builtins import *
48
import SocketServer as socketserver
43
import gnutls.connection
45
import gnutls.library.functions
46
import gnutls.library.constants
47
import gnutls.library.types
48
import ConfigParser as configparser
55
import ConfigParser as configparser
57
63
import logging.handlers
63
import cPickle as pickle
70
import cPickle as pickle
64
73
import multiprocessing
67
84
import dbus.service
86
from gi.repository import GLib
70
87
from dbus.mainloop.glib import DBusGMainLoop
73
90
import xml.dom.minidom
93
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:
77
122
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
78
123
except AttributeError:
125
# This is where SO_BINDTODEVICE was up to and including Python
80
127
from IN import SO_BINDTODEVICE
81
128
except ImportError:
82
SO_BINDTODEVICE = None
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
89
syslogger = (logging.handlers.SysLogHandler
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
address = str("/dev/log")))
92
syslogger.setFormatter(logging.Formatter
93
('Mandos [%(process)d]: %(levelname)s:'
95
logger.addHandler(syslogger)
97
console = logging.StreamHandler()
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
101
logger.addHandler(console)
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
log = logging.getLogger(os.path.basename(sys.argv[0]))
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
log.addHandler(syslogger)
197
console = logging.StreamHandler()
198
console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
202
log.addHandler(console)
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
103
332
class AvahiError(Exception):
104
333
def __init__(self, value, *args, **kwargs):
105
334
self.value = value
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
335
return super(AvahiError, self).__init__(value, *args,
110
339
class AvahiServiceError(AvahiError):
113
343
class AvahiGroupError(AvahiError):
117
class AvahiService(object):
118
348
"""An Avahi (Zeroconf) service.
121
351
interface: integer; avahi.IF_UNSPEC or an interface index.
122
352
Used to optionally bind to the specified interface.
123
name: string; Example: 'Mandos'
124
type: string; Example: '_mandos._tcp'.
125
See <http://www.dns-sd.org/ServiceTypes.html>
353
name: string; Example: "Mandos"
354
type: string; Example: "_mandos._tcp".
355
See <https://www.iana.org/assignments/service-names-port-numbers>
126
356
port: integer; what port to announce
127
357
TXT: list of strings; TXT record for the service
128
358
domain: string; Domain to publish on, default to .local if empty.
198
447
dbus.UInt16(self.port),
199
448
avahi.string_array_to_txt_array(self.TXT))
200
449
self.group.Commit()
201
451
def entry_group_state_changed(self, state, error):
202
452
"""Derived from the Avahi example code"""
203
logger.debug("Avahi entry group state change: %i", state)
453
log.debug("Avahi entry group state change: %i", state)
205
455
if state == avahi.ENTRY_GROUP_ESTABLISHED:
206
logger.debug("Zeroconf service established.")
456
log.debug("Zeroconf service established.")
207
457
elif state == avahi.ENTRY_GROUP_COLLISION:
208
logger.info("Zeroconf service name collision.")
458
log.info("Zeroconf service name collision.")
210
460
elif state == avahi.ENTRY_GROUP_FAILURE:
211
logger.critical("Avahi: Error in group state changed %s",
213
raise AvahiGroupError("State changed: %s"
461
log.critical("Avahi: Error in group state changed %s",
463
raise AvahiGroupError("State changed: {!s}".format(error))
215
465
def cleanup(self):
216
466
"""Derived from the Avahi example code"""
217
467
if self.group is not None:
470
except (dbus.exceptions.UnknownMethodException,
471
dbus.exceptions.DBusException):
219
473
self.group = None
220
def server_state_changed(self, state):
476
def server_state_changed(self, state, error=None):
221
477
"""Derived from the Avahi example code"""
222
logger.debug("Avahi server state change: %i", state)
223
if state == avahi.SERVER_COLLISION:
224
logger.error("Zeroconf server name collision")
478
log.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
log.error(bad_states[state])
490
log.error(bad_states[state] + ": %r", error)
226
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
log.info("Local Zeroconf service name collision.")
499
return self.rename(remove=False)
501
log.critical("D-Bus Exception", exc_info=error)
506
log.debug("Unknown state: %r", state)
508
log.debug("Unknown state: %r: %r", state, error)
228
510
def activate(self):
229
511
"""Derived from the Avahi example code"""
230
512
if self.server is None:
231
513
self.server = dbus.Interface(
232
514
self.bus.get_object(avahi.DBUS_NAME,
233
avahi.DBUS_PATH_SERVER),
515
avahi.DBUS_PATH_SERVER,
516
follow_name_owner_changes=True),
234
517
avahi.DBUS_INTERFACE_SERVER)
235
518
self.server.connect_to_signal("StateChanged",
236
self.server_state_changed)
519
self.server_state_changed)
237
520
self.server_state_changed(self.server.GetState())
240
class Client(object):
523
class AvahiServiceToSyslog(AvahiService):
524
def rename(self, *args, **kwargs):
525
"""Add the new name to the syslog messages"""
526
ret = super(AvahiServiceToSyslog, self).rename(*args,
528
syslogger.setFormatter(logging.Formatter(
529
"Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
534
# Pretend that we have a GnuTLS module
536
"""This isn't so much a class as it is a module-like namespace."""
538
library = ctypes.util.find_library("gnutls")
540
library = ctypes.util.find_library("gnutls-deb0")
541
_library = ctypes.cdll.LoadLibrary(library)
544
# Unless otherwise indicated, the constants and types below are
545
# all from the gnutls/gnutls.h C header file.
556
E_NO_CERTIFICATE_FOUND = -49
561
KEYID_USE_SHA256 = 1 # gnutls/x509.h
562
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
565
class _session_int(ctypes.Structure):
567
session_t = ctypes.POINTER(_session_int)
569
class certificate_credentials_st(ctypes.Structure):
571
certificate_credentials_t = ctypes.POINTER(
572
certificate_credentials_st)
573
certificate_type_t = ctypes.c_int
575
class datum_t(ctypes.Structure):
576
_fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
("size", ctypes.c_uint)]
579
class _openpgp_crt_int(ctypes.Structure):
581
openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
582
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
583
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
credentials_type_t = ctypes.c_int
585
transport_ptr_t = ctypes.c_void_p
586
close_request_t = ctypes.c_int
589
class Error(Exception):
590
def __init__(self, message=None, code=None, args=()):
591
# Default usage is by a message string, but if a return
592
# code is passed, convert it to a string with
595
if message is None and code is not None:
596
message = gnutls.strerror(code).decode(
597
"utf-8", errors="replace")
598
return super(gnutls.Error, self).__init__(
601
class CertificateSecurityError(Error):
605
def __init__(self, cls):
608
def from_param(self, obj):
609
if not isinstance(obj, self.cls):
610
raise TypeError("Not of type {}: {!r}"
611
.format(self.cls.__name__, obj))
612
return ctypes.byref(obj.from_param(obj))
614
class CastToVoidPointer:
615
def __init__(self, cls):
618
def from_param(self, obj):
619
if not isinstance(obj, self.cls):
620
raise TypeError("Not of type {}: {!r}"
621
.format(self.cls.__name__, obj))
622
return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
624
class With_from_param:
626
def from_param(cls, obj):
627
return obj._as_parameter_
630
class Credentials(With_from_param):
632
self._as_parameter_ = gnutls.certificate_credentials_t()
633
gnutls.certificate_allocate_credentials(self)
634
self.type = gnutls.CRD_CERTIFICATE
637
gnutls.certificate_free_credentials(self)
639
class ClientSession(With_from_param):
640
def __init__(self, socket, credentials=None):
641
self._as_parameter_ = gnutls.session_t()
642
gnutls_flags = gnutls.CLIENT
643
if gnutls.check_version(b"3.5.6"):
644
gnutls_flags |= gnutls.NO_TICKETS
646
gnutls_flags |= gnutls.ENABLE_RAWPK
647
gnutls.init(self, gnutls_flags)
649
gnutls.set_default_priority(self)
650
gnutls.transport_set_ptr(self, socket.fileno())
651
gnutls.handshake_set_private_extensions(self, True)
653
if credentials is None:
654
credentials = gnutls.Credentials()
655
gnutls.credentials_set(self, credentials.type,
657
self.credentials = credentials
663
return gnutls.handshake(self)
665
def send(self, data):
669
data_len -= gnutls.record_send(self, data[-data_len:],
673
return gnutls.bye(self, gnutls.SHUT_RDWR)
675
# Error handling functions
676
def _error_code(result):
677
"""A function to raise exceptions on errors, suitable
678
for the "restype" attribute on ctypes functions"""
679
if result >= gnutls.E_SUCCESS:
681
if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
raise gnutls.CertificateSecurityError(code=result)
683
raise gnutls.Error(code=result)
685
def _retry_on_error(result, func, arguments,
686
_error_code=_error_code):
687
"""A function to retry on some errors, suitable
688
for the "errcheck" attribute on ctypes functions"""
689
while result < gnutls.E_SUCCESS:
690
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
return _error_code(result)
692
result = func(*arguments)
695
# Unless otherwise indicated, the function declarations below are
696
# all from the gnutls/gnutls.h C header file.
699
priority_set_direct = _library.gnutls_priority_set_direct
700
priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
701
ctypes.POINTER(ctypes.c_char_p)]
702
priority_set_direct.restype = _error_code
704
init = _library.gnutls_init
705
init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
706
init.restype = _error_code
708
set_default_priority = _library.gnutls_set_default_priority
709
set_default_priority.argtypes = [ClientSession]
710
set_default_priority.restype = _error_code
712
record_send = _library.gnutls_record_send
713
record_send.argtypes = [ClientSession, ctypes.c_void_p,
715
record_send.restype = ctypes.c_ssize_t
716
record_send.errcheck = _retry_on_error
718
certificate_allocate_credentials = (
719
_library.gnutls_certificate_allocate_credentials)
720
certificate_allocate_credentials.argtypes = [
721
PointerTo(Credentials)]
722
certificate_allocate_credentials.restype = _error_code
724
certificate_free_credentials = (
725
_library.gnutls_certificate_free_credentials)
726
certificate_free_credentials.argtypes = [Credentials]
727
certificate_free_credentials.restype = None
729
handshake_set_private_extensions = (
730
_library.gnutls_handshake_set_private_extensions)
731
handshake_set_private_extensions.argtypes = [ClientSession,
733
handshake_set_private_extensions.restype = None
735
credentials_set = _library.gnutls_credentials_set
736
credentials_set.argtypes = [ClientSession, credentials_type_t,
737
CastToVoidPointer(Credentials)]
738
credentials_set.restype = _error_code
740
strerror = _library.gnutls_strerror
741
strerror.argtypes = [ctypes.c_int]
742
strerror.restype = ctypes.c_char_p
744
certificate_type_get = _library.gnutls_certificate_type_get
745
certificate_type_get.argtypes = [ClientSession]
746
certificate_type_get.restype = _error_code
748
certificate_get_peers = _library.gnutls_certificate_get_peers
749
certificate_get_peers.argtypes = [ClientSession,
750
ctypes.POINTER(ctypes.c_uint)]
751
certificate_get_peers.restype = ctypes.POINTER(datum_t)
753
global_set_log_level = _library.gnutls_global_set_log_level
754
global_set_log_level.argtypes = [ctypes.c_int]
755
global_set_log_level.restype = None
757
global_set_log_function = _library.gnutls_global_set_log_function
758
global_set_log_function.argtypes = [log_func]
759
global_set_log_function.restype = None
761
deinit = _library.gnutls_deinit
762
deinit.argtypes = [ClientSession]
763
deinit.restype = None
765
handshake = _library.gnutls_handshake
766
handshake.argtypes = [ClientSession]
767
handshake.restype = ctypes.c_int
768
handshake.errcheck = _retry_on_error
770
transport_set_ptr = _library.gnutls_transport_set_ptr
771
transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
772
transport_set_ptr.restype = None
774
bye = _library.gnutls_bye
775
bye.argtypes = [ClientSession, close_request_t]
776
bye.restype = ctypes.c_int
777
bye.errcheck = _retry_on_error
779
check_version = _library.gnutls_check_version
780
check_version.argtypes = [ctypes.c_char_p]
781
check_version.restype = ctypes.c_char_p
783
_need_version = b"3.3.0"
784
if check_version(_need_version) is None:
785
raise self.Error("Needs GnuTLS {} or later"
786
.format(_need_version))
788
_tls_rawpk_version = b"3.6.6"
789
has_rawpk = bool(check_version(_tls_rawpk_version))
793
class pubkey_st(ctypes.Structure):
795
pubkey_t = ctypes.POINTER(pubkey_st)
797
x509_crt_fmt_t = ctypes.c_int
799
# All the function declarations below are from
801
pubkey_init = _library.gnutls_pubkey_init
802
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
803
pubkey_init.restype = _error_code
805
pubkey_import = _library.gnutls_pubkey_import
806
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
808
pubkey_import.restype = _error_code
810
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
811
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
812
ctypes.POINTER(ctypes.c_ubyte),
813
ctypes.POINTER(ctypes.c_size_t)]
814
pubkey_get_key_id.restype = _error_code
816
pubkey_deinit = _library.gnutls_pubkey_deinit
817
pubkey_deinit.argtypes = [pubkey_t]
818
pubkey_deinit.restype = None
820
# All the function declarations below are from
823
openpgp_crt_init = _library.gnutls_openpgp_crt_init
824
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
825
openpgp_crt_init.restype = _error_code
827
openpgp_crt_import = _library.gnutls_openpgp_crt_import
828
openpgp_crt_import.argtypes = [openpgp_crt_t,
829
ctypes.POINTER(datum_t),
831
openpgp_crt_import.restype = _error_code
833
openpgp_crt_verify_self = \
834
_library.gnutls_openpgp_crt_verify_self
835
openpgp_crt_verify_self.argtypes = [
838
ctypes.POINTER(ctypes.c_uint),
840
openpgp_crt_verify_self.restype = _error_code
842
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
843
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
844
openpgp_crt_deinit.restype = None
846
openpgp_crt_get_fingerprint = (
847
_library.gnutls_openpgp_crt_get_fingerprint)
848
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
852
openpgp_crt_get_fingerprint.restype = _error_code
854
if check_version(b"3.6.4"):
855
certificate_type_get2 = _library.gnutls_certificate_type_get2
856
certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
857
certificate_type_get2.restype = _error_code
859
# Remove non-public functions
860
del _error_code, _retry_on_error
863
def call_pipe(connection, # : multiprocessing.Connection
864
func, *args, **kwargs):
865
"""This function is meant to be called by multiprocessing.Process
867
This function runs func(*args, **kwargs), and writes the resulting
868
return value on the provided multiprocessing.Connection.
870
connection.send(func(*args, **kwargs))
241
875
"""A representation of a client host served by this server.
244
_approved: bool(); 'None' if not yet approved/disapproved
878
approved: bool(); None if not yet approved/disapproved
245
879
approval_delay: datetime.timedelta(); Time to wait for approval
246
880
approval_duration: datetime.timedelta(); Duration of one approval
247
checker: subprocess.Popen(); a running checker process used
248
to see if the client lives.
249
'None' if no process is running.
250
checker_callback_tag: a gobject event source tag, or None
881
checker: multiprocessing.Process(); a running checker process used
882
to see if the client lives. None if no process is
884
checker_callback_tag: a GLib event source tag, or None
251
885
checker_command: string; External command which is run to check
252
886
if client lives. %() expansions are done at
253
887
runtime with vars(self) as dict, so that for
254
888
instance %(name)s can be used in the command.
255
checker_initiator_tag: a gobject event source tag, or None
889
checker_initiator_tag: a GLib event source tag, or None
256
890
created: datetime.datetime(); (UTC) object creation
891
client_structure: Object describing what attributes a client has
892
and is used for storing the client at exit
257
893
current_checker_command: string; current running checker_command
258
disable_hook: If set, called by disable() as disable_hook(self)
259
disable_initiator_tag: a gobject event source tag, or None
894
disable_initiator_tag: a GLib event source tag, or None
261
896
fingerprint: string (40 or 32 hexadecimal digits); used to
262
uniquely identify the client
897
uniquely identify an OpenPGP client
898
key_id: string (64 hexadecimal digits); used to uniquely identify
899
a client using raw public keys
263
900
host: string; available for use by the checker command
264
901
interval: datetime.timedelta(); How often to start a new checker
265
902
last_approval_request: datetime.datetime(); (UTC) or None
266
903
last_checked_ok: datetime.datetime(); (UTC) or None
267
last_enabled: datetime.datetime(); (UTC)
904
last_checker_status: integer between 0 and 255 reflecting exit
905
status of last checker. -1 reflects crashed
906
checker, -2 means no checker completed yet.
907
last_checker_signal: The signal which killed the last checker, if
908
last_checker_status is -1
909
last_enabled: datetime.datetime(); (UTC) or None
268
910
name: string; from the config file, used in log messages and
269
911
D-Bus identifiers
270
912
secret: bytestring; sent verbatim (over TLS) to client
271
913
timeout: datetime.timedelta(); How long from last_checked_ok
272
914
until this client is disabled
915
extended_timeout: extra long timeout when secret has been sent
273
916
runtime_expansions: Allowed attributes for runtime expansion.
917
expires: datetime.datetime(); time (UTC) when a client will be
919
server_settings: The server_settings dict from main()
276
922
runtime_expansions = ("approval_delay", "approval_duration",
277
"created", "enabled", "fingerprint",
278
"host", "interval", "last_checked_ok",
923
"created", "enabled", "expires", "key_id",
924
"fingerprint", "host", "interval",
925
"last_approval_request", "last_checked_ok",
279
926
"last_enabled", "name", "timeout")
929
"extended_timeout": "PT15M",
931
"checker": "fping -q -- %%(host)s",
933
"approval_delay": "PT0S",
934
"approval_duration": "PT1S",
935
"approved_by_default": "True",
282
def _timedelta_to_milliseconds(td):
283
"Convert a datetime.timedelta() to milliseconds"
284
return ((td.days * 24 * 60 * 60 * 1000)
285
+ (td.seconds * 1000)
286
+ (td.microseconds // 1000))
288
def timeout_milliseconds(self):
289
"Return the 'timeout' attribute in milliseconds"
290
return self._timedelta_to_milliseconds(self.timeout)
292
def interval_milliseconds(self):
293
"Return the 'interval' attribute in milliseconds"
294
return self._timedelta_to_milliseconds(self.interval)
296
def approval_delay_milliseconds(self):
297
return self._timedelta_to_milliseconds(self.approval_delay)
299
def __init__(self, name = None, disable_hook=None, config=None):
300
"""Note: the 'checker' key in 'config' sets the
301
'checker_command' attribute and *not* the 'checker'
940
def config_parser(config):
941
"""Construct a new dict of client settings of this form:
942
{ client_name: {setting_name: value, ...}, ...}
943
with exceptions for any special settings as defined above.
944
NOTE: Must be a pure function. Must return the same result
945
value given the same arguments.
948
for client_name in config.sections():
949
section = dict(config.items(client_name))
950
client = settings[client_name] = {}
952
client["host"] = section["host"]
953
# Reformat values from string types to Python types
954
client["approved_by_default"] = config.getboolean(
955
client_name, "approved_by_default")
956
client["enabled"] = config.getboolean(client_name,
959
# Uppercase and remove spaces from key_id and fingerprint
960
# for later comparison purposes with return value from the
961
# key_id() and fingerprint() functions
962
client["key_id"] = (section.get("key_id", "").upper()
964
client["fingerprint"] = (section["fingerprint"].upper()
966
if "secret" in section:
967
client["secret"] = codecs.decode(section["secret"]
970
elif "secfile" in section:
971
with open(os.path.expanduser(os.path.expandvars
972
(section["secfile"])),
974
client["secret"] = secfile.read()
976
raise TypeError("No secret or secfile for section {}"
978
client["timeout"] = string_to_delta(section["timeout"])
979
client["extended_timeout"] = string_to_delta(
980
section["extended_timeout"])
981
client["interval"] = string_to_delta(section["interval"])
982
client["approval_delay"] = string_to_delta(
983
section["approval_delay"])
984
client["approval_duration"] = string_to_delta(
985
section["approval_duration"])
986
client["checker_command"] = section["checker"]
987
client["last_approval_request"] = None
988
client["last_checked_ok"] = None
989
client["last_checker_status"] = -2
993
def __init__(self, settings, name=None, server_settings=None):
306
logger.debug("Creating client %r", self.name)
307
# Uppercase and remove spaces from fingerprint for later
308
# comparison purposes with return value from the fingerprint()
310
self.fingerprint = (config["fingerprint"].upper()
312
logger.debug(" Fingerprint: %s", self.fingerprint)
313
if "secret" in config:
314
self.secret = config["secret"].decode("base64")
315
elif "secfile" in config:
316
with open(os.path.expanduser(os.path.expandvars
317
(config["secfile"])),
319
self.secret = secfile.read()
995
if server_settings is None:
997
self.server_settings = server_settings
998
# adding all client settings
999
for setting, value in settings.items():
1000
setattr(self, setting, value)
1003
if not hasattr(self, "last_enabled"):
1004
self.last_enabled = datetime.datetime.utcnow()
1005
if not hasattr(self, "expires"):
1006
self.expires = (datetime.datetime.utcnow()
321
raise TypeError("No secret or secfile for client %s"
323
self.host = config.get("host", "")
324
self.created = datetime.datetime.utcnow()
326
self.last_approval_request = None
327
self.last_enabled = None
328
self.last_checked_ok = None
329
self.timeout = string_to_delta(config["timeout"])
330
self.interval = string_to_delta(config["interval"])
331
self.disable_hook = disable_hook
1009
self.last_enabled = None
1012
log.debug("Creating client %r", self.name)
1013
log.debug(" Key ID: %s", self.key_id)
1014
log.debug(" Fingerprint: %s", self.fingerprint)
1015
self.created = settings.get("created",
1016
datetime.datetime.utcnow())
1018
# attributes specific for this server instance
332
1019
self.checker = None
333
1020
self.checker_initiator_tag = None
334
1021
self.disable_initiator_tag = None
335
1022
self.checker_callback_tag = None
336
self.checker_command = config["checker"]
337
1023
self.current_checker_command = None
338
self.last_connect = None
339
self._approved = None
340
self.approved_by_default = config.get("approved_by_default",
1024
self.approved = None
342
1025
self.approvals_pending = 0
343
self.approval_delay = string_to_delta(
344
config["approval_delay"])
345
self.approval_duration = string_to_delta(
346
config["approval_duration"])
347
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
1026
self.changedstate = multiprocessing_manager.Condition(
1027
multiprocessing_manager.Lock())
1028
self.client_structure = [attr
1029
for attr in self.__dict__.keys()
1030
if not attr.startswith("_")]
1031
self.client_structure.append("client_structure")
1033
for name, t in inspect.getmembers(
1034
type(self), lambda obj: isinstance(obj, property)):
1035
if not name.startswith("_"):
1036
self.client_structure.append(name)
1038
# Send notice to process children that client state has changed
349
1039
def send_changedstate(self):
350
self.changedstate.acquire()
351
self.changedstate.notify_all()
352
self.changedstate.release()
1040
with self.changedstate:
1041
self.changedstate.notify_all()
354
1043
def enable(self):
355
1044
"""Start this client's checker and timeout hooks"""
356
1045
if getattr(self, "enabled", False):
357
1046
# Already enabled
359
self.send_changedstate()
360
1049
self.last_enabled = datetime.datetime.utcnow()
361
# Schedule a new checker to be started an 'interval' from now,
362
# and every interval from then on.
363
self.checker_initiator_tag = (gobject.timeout_add
364
(self.interval_milliseconds(),
366
# Schedule a disable() when 'timeout' has passed
367
self.disable_initiator_tag = (gobject.timeout_add
368
(self.timeout_milliseconds(),
371
# Also start a new checker *right now*.
1051
self.send_changedstate()
374
1053
def disable(self, quiet=True):
375
1054
"""Disable this client."""
376
1055
if not getattr(self, "enabled", False):
1058
log.info("Disabling client %s", self.name)
1059
if getattr(self, "disable_initiator_tag", None) is not None:
1060
GLib.source_remove(self.disable_initiator_tag)
1061
self.disable_initiator_tag = None
1063
if getattr(self, "checker_initiator_tag", None) is not None:
1064
GLib.source_remove(self.checker_initiator_tag)
1065
self.checker_initiator_tag = None
1067
self.enabled = False
379
1069
self.send_changedstate()
381
logger.info("Disabling client %s", self.name)
382
if getattr(self, "disable_initiator_tag", False):
383
gobject.source_remove(self.disable_initiator_tag)
384
self.disable_initiator_tag = None
385
if getattr(self, "checker_initiator_tag", False):
386
gobject.source_remove(self.checker_initiator_tag)
387
self.checker_initiator_tag = None
389
if self.disable_hook:
390
self.disable_hook(self)
392
# Do not run this again if called by a gobject.timeout_add
1070
# Do not run this again if called by a GLib.timeout_add
395
1073
def __del__(self):
396
self.disable_hook = None
399
def checker_callback(self, pid, condition, command):
1076
def init_checker(self, randomize_start=False):
1077
# Schedule a new checker to be started a randomly selected
1078
# time (a fraction of 'interval') from now. This spreads out
1079
# the startup of checkers over time when the server is
1081
if self.checker_initiator_tag is not None:
1082
GLib.source_remove(self.checker_initiator_tag)
1083
interval_milliseconds = int(self.interval.total_seconds()
1086
delay_milliseconds = random.randrange(
1087
interval_milliseconds + 1)
1089
delay_milliseconds = interval_milliseconds
1090
self.checker_initiator_tag = GLib.timeout_add(
1091
delay_milliseconds, self.start_checker, randomize_start)
1092
delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1093
# A checker might take up to an 'interval' of time, so we can
1094
# expire at the soonest one interval after a checker was
1095
# started. Since the initial checker is delayed, the expire
1096
# time might have to be extended.
1097
now = datetime.datetime.utcnow()
1098
self.expires = now + delay + self.interval
1099
# Schedule a disable() at expire time
1100
if self.disable_initiator_tag is not None:
1101
GLib.source_remove(self.disable_initiator_tag)
1102
self.disable_initiator_tag = GLib.timeout_add(
1103
int((self.expires - now).total_seconds() * 1000),
1106
def checker_callback(self, source, condition, connection,
400
1108
"""The checker has completed, so take appropriate actions."""
1109
# Read return code from connection (see call_pipe)
1110
returncode = connection.recv()
1112
if self.checker is not None:
401
1114
self.checker_callback_tag = None
402
1115
self.checker = None
403
if os.WIFEXITED(condition):
404
exitstatus = os.WEXITSTATUS(condition)
406
logger.info("Checker for %(name)s succeeded",
1118
self.last_checker_status = returncode
1119
self.last_checker_signal = None
1120
if self.last_checker_status == 0:
1121
log.info("Checker for %(name)s succeeded", vars(self))
408
1122
self.checked_ok()
410
logger.info("Checker for %(name)s failed",
1124
log.info("Checker for %(name)s failed", vars(self))
413
logger.warning("Checker for %(name)s crashed?",
1126
self.last_checker_status = -1
1127
self.last_checker_signal = -returncode
1128
log.warning("Checker for %(name)s crashed?", vars(self))
416
1131
def checked_ok(self):
417
"""Bump up the timeout for this client.
419
This should only be called when the client has been seen,
1132
"""Assert that the client has been seen, alive and well."""
422
1133
self.last_checked_ok = datetime.datetime.utcnow()
423
gobject.source_remove(self.disable_initiator_tag)
424
self.disable_initiator_tag = (gobject.timeout_add
425
(self.timeout_milliseconds(),
1134
self.last_checker_status = 0
1135
self.last_checker_signal = None
1138
def bump_timeout(self, timeout=None):
1139
"""Bump up the timeout for this client."""
1141
timeout = self.timeout
1142
if self.disable_initiator_tag is not None:
1143
GLib.source_remove(self.disable_initiator_tag)
1144
self.disable_initiator_tag = None
1145
if getattr(self, "enabled", False):
1146
self.disable_initiator_tag = GLib.timeout_add(
1147
int(timeout.total_seconds() * 1000), self.disable)
1148
self.expires = datetime.datetime.utcnow() + timeout
428
1150
def need_approval(self):
429
1151
self.last_approval_request = datetime.datetime.utcnow()
431
def start_checker(self):
1153
def start_checker(self, start_was_randomized=False):
432
1154
"""Start a new checker subprocess if one is not running.
434
1156
If a checker already exists, leave it running and do
436
1158
# The reason for not killing a running checker is that if we
437
# did that, then if a checker (for some reason) started
438
# running slowly and taking more than 'interval' time, the
439
# client would inevitably timeout, since no checker would get
440
# a chance to run to completion. If we instead leave running
1159
# did that, and if a checker (for some reason) started running
1160
# slowly and taking more than 'interval' time, then the client
1161
# would inevitably timeout, since no checker would get a
1162
# chance to run to completion. If we instead leave running
441
1163
# checkers alone, the checker would have to take more time
442
1164
# than 'timeout' for the client to be disabled, which is as it
445
# If a checker exists, make sure it is not a zombie
447
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
448
except (AttributeError, OSError), error:
449
if (isinstance(error, OSError)
450
and error.errno != errno.ECHILD):
454
logger.warning("Checker was a zombie")
455
gobject.source_remove(self.checker_callback_tag)
456
self.checker_callback(pid, status,
457
self.current_checker_command)
1167
if self.checker is not None and not self.checker.is_alive():
1168
log.warning("Checker was not alive; joining")
458
1171
# Start a new checker if needed
459
1172
if self.checker is None:
1173
# Escape attributes for the shell
1175
attr: shlex.quote(str(getattr(self, attr)))
1176
for attr in self.runtime_expansions}
461
# In case checker_command has exactly one % operator
462
command = self.checker_command % self.host
464
# Escape attributes for the shell
465
escaped_attrs = dict(
467
re.escape(unicode(str(getattr(self, attr, "")),
471
self.runtime_expansions)
474
command = self.checker_command % escaped_attrs
475
except TypeError, error:
476
logger.error('Could not format string "%s":'
477
' %s', self.checker_command, error)
478
return True # Try again later
1178
command = self.checker_command % escaped_attrs
1179
except TypeError as error:
1180
log.error('Could not format string "%s"',
1181
self.checker_command, exc_info=error)
1182
return True # Try again later
479
1183
self.current_checker_command = command
481
logger.info("Starting checker %r for %s",
483
# We don't need to redirect stdout and stderr, since
484
# in normal mode, that is already done by daemon(),
485
# and in debug mode we don't want to. (Stdin is
486
# always replaced by /dev/null.)
487
self.checker = subprocess.Popen(command,
490
self.checker_callback_tag = (gobject.child_watch_add
492
self.checker_callback,
494
# The checker may have completed before the gobject
495
# watch was added. Check for this.
496
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
498
gobject.source_remove(self.checker_callback_tag)
499
self.checker_callback(pid, status, command)
500
except OSError, error:
501
logger.error("Failed to start subprocess: %s",
503
# Re-run this periodically if run by gobject.timeout_add
1184
log.info("Starting checker %r for %s", command, self.name)
1185
# We don't need to redirect stdout and stderr, since
1186
# in normal mode, that is already done by daemon(),
1187
# and in debug mode we don't want to. (Stdin is
1188
# always replaced by /dev/null.)
1189
# The exception is when not debugging but nevertheless
1190
# running in the foreground; use the previously
1192
popen_args = {"close_fds": True,
1195
if (not self.server_settings["debug"]
1196
and self.server_settings["foreground"]):
1197
popen_args.update({"stdout": wnull,
1199
pipe = multiprocessing.Pipe(duplex=False)
1200
self.checker = multiprocessing.Process(
1202
args=(pipe[1], subprocess.call, command),
1204
self.checker.start()
1205
self.checker_callback_tag = GLib.io_add_watch(
1206
GLib.IOChannel.unix_new(pipe[0].fileno()),
1207
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1208
self.checker_callback, pipe[0], command)
1209
if start_was_randomized:
1210
# We were started after a random delay; Schedule a new
1211
# checker to be started an 'interval' from now, and every
1212
# interval from then on.
1213
now = datetime.datetime.utcnow()
1214
self.checker_initiator_tag = GLib.timeout_add(
1215
int(self.interval.total_seconds() * 1000),
1217
self.expires = max(self.expires, now + self.interval)
1218
# Don't start a new checker again after same random delay
1220
# Re-run this periodically if run by GLib.timeout_add
506
1223
def stop_checker(self):
507
1224
"""Force the checker process, if any, to stop."""
508
1225
if self.checker_callback_tag:
509
gobject.source_remove(self.checker_callback_tag)
1226
GLib.source_remove(self.checker_callback_tag)
510
1227
self.checker_callback_tag = None
511
1228
if getattr(self, "checker", None) is None:
513
logger.debug("Stopping checker for %(name)s", vars(self))
515
os.kill(self.checker.pid, signal.SIGTERM)
517
#if self.checker.poll() is None:
518
# os.kill(self.checker.pid, signal.SIGKILL)
519
except OSError, error:
520
if error.errno != errno.ESRCH: # No such process
1230
log.debug("Stopping checker for %(name)s", vars(self))
1231
self.checker.terminate()
522
1232
self.checker = None
524
def dbus_service_property(dbus_interface, signature="v",
525
access="readwrite", byte_arrays=False):
1235
def dbus_service_property(dbus_interface,
526
1239
"""Decorators for marking methods of a DBusObjectWithProperties to
527
1240
become properties on the D-Bus.
529
1242
The decorated method will be called with no arguments by "Get"
530
1243
and with one argument by "Set".
532
1245
The parameters, where they are supported, are the same as
533
1246
dbus.service.method, except there is only "signature", since the
534
1247
type from Get() and the type sent to Set() is the same.
704
1577
xmlstring = document.toxml("utf-8")
705
1578
document.unlink()
706
1579
except (AttributeError, xml.dom.DOMException,
707
xml.parsers.expat.ExpatError), error:
708
logger.error("Failed to override Introspection method",
1580
xml.parsers.expat.ExpatError) as error:
1581
log.error("Failed to override Introspection method",
1587
dbus.OBJECT_MANAGER_IFACE
1588
except AttributeError:
1589
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1592
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1593
"""A D-Bus object with an ObjectManager.
1595
Classes inheriting from this exposes the standard
1596
GetManagedObjects call and the InterfacesAdded and
1597
InterfacesRemoved signals on the standard
1598
"org.freedesktop.DBus.ObjectManager" interface.
1600
Note: No signals are sent automatically; they must be sent
1603
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1604
out_signature="a{oa{sa{sv}}}")
1605
def GetManagedObjects(self):
1606
"""This function must be overridden"""
1607
raise NotImplementedError()
1609
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1610
signature="oa{sa{sv}}")
1611
def InterfacesAdded(self, object_path, interfaces_and_properties):
1614
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1615
def InterfacesRemoved(self, object_path, interfaces):
1618
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1620
path_keyword="object_path",
1621
connection_keyword="connection")
1622
def Introspect(self, object_path, connection):
1623
"""Overloading of standard D-Bus method.
1625
Override return argument name of GetManagedObjects to be
1626
"objpath_interfaces_and_properties"
1628
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1632
document = xml.dom.minidom.parseString(xmlstring)
1634
for if_tag in document.getElementsByTagName("interface"):
1635
# Fix argument name for the GetManagedObjects method
1636
if (if_tag.getAttribute("name")
1637
== dbus.OBJECT_MANAGER_IFACE):
1638
for cn in if_tag.getElementsByTagName("method"):
1639
if (cn.getAttribute("name")
1640
== "GetManagedObjects"):
1641
for arg in cn.getElementsByTagName("arg"):
1642
if (arg.getAttribute("direction")
1646
"objpath_interfaces"
1648
xmlstring = document.toxml("utf-8")
1650
except (AttributeError, xml.dom.DOMException,
1651
xml.parsers.expat.ExpatError) as error:
1652
log.error("Failed to override Introspection method",
1657
def datetime_to_dbus(dt, variant_level=0):
1658
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1660
return dbus.String("", variant_level=variant_level)
1661
return dbus.String(dt.isoformat(), variant_level=variant_level)
1664
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1665
"""A class decorator; applied to a subclass of
1666
dbus.service.Object, it will add alternate D-Bus attributes with
1667
interface names according to the "alt_interface_names" mapping.
1670
@alternate_dbus_interfaces({"org.example.Interface":
1671
"net.example.AlternateInterface"})
1672
class SampleDBusObject(dbus.service.Object):
1673
@dbus.service.method("org.example.Interface")
1674
def SampleDBusMethod():
1677
The above "SampleDBusMethod" on "SampleDBusObject" will be
1678
reachable via two interfaces: "org.example.Interface" and
1679
"net.example.AlternateInterface", the latter of which will have
1680
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1681
"true", unless "deprecate" is passed with a False value.
1683
This works for methods and signals, and also for D-Bus properties
1684
(from DBusObjectWithProperties) and interfaces (from the
1685
dbus_interface_annotations decorator).
1689
for orig_interface_name, alt_interface_name in (
1690
alt_interface_names.items()):
1692
interface_names = set()
1693
# Go though all attributes of the class
1694
for attrname, attribute in inspect.getmembers(cls):
1695
# Ignore non-D-Bus attributes, and D-Bus attributes
1696
# with the wrong interface name
1697
if (not hasattr(attribute, "_dbus_interface")
1698
or not attribute._dbus_interface.startswith(
1699
orig_interface_name)):
1701
# Create an alternate D-Bus interface name based on
1703
alt_interface = attribute._dbus_interface.replace(
1704
orig_interface_name, alt_interface_name)
1705
interface_names.add(alt_interface)
1706
# Is this a D-Bus signal?
1707
if getattr(attribute, "_dbus_is_signal", False):
1708
# Extract the original non-method undecorated
1709
# function by black magic
1710
if sys.version_info.major == 2:
1711
nonmethod_func = (dict(
1712
zip(attribute.func_code.co_freevars,
1713
attribute.__closure__))
1714
["func"].cell_contents)
1716
nonmethod_func = (dict(
1717
zip(attribute.__code__.co_freevars,
1718
attribute.__closure__))
1719
["func"].cell_contents)
1720
# Create a new, but exactly alike, function
1721
# object, and decorate it to be a new D-Bus signal
1722
# with the alternate D-Bus interface name
1723
new_function = copy_function(nonmethod_func)
1724
new_function = (dbus.service.signal(
1726
attribute._dbus_signature)(new_function))
1727
# Copy annotations, if any
1729
new_function._dbus_annotations = dict(
1730
attribute._dbus_annotations)
1731
except AttributeError:
1734
# Define a creator of a function to call both the
1735
# original and alternate functions, so both the
1736
# original and alternate signals gets sent when
1737
# the function is called
1738
def fixscope(func1, func2):
1739
"""This function is a scope container to pass
1740
func1 and func2 to the "call_both" function
1741
outside of its arguments"""
1743
@functools.wraps(func2)
1744
def call_both(*args, **kwargs):
1745
"""This function will emit two D-Bus
1746
signals by calling func1 and func2"""
1747
func1(*args, **kwargs)
1748
func2(*args, **kwargs)
1749
# Make wrapper function look like a D-Bus
1751
for name, attr in inspect.getmembers(func2):
1752
if name.startswith("_dbus_"):
1753
setattr(call_both, name, attr)
1756
# Create the "call_both" function and add it to
1758
attr[attrname] = fixscope(attribute, new_function)
1759
# Is this a D-Bus method?
1760
elif getattr(attribute, "_dbus_is_method", False):
1761
# Create a new, but exactly alike, function
1762
# object. Decorate it to be a new D-Bus method
1763
# with the alternate D-Bus interface name. Add it
1766
dbus.service.method(
1768
attribute._dbus_in_signature,
1769
attribute._dbus_out_signature)
1770
(copy_function(attribute)))
1771
# Copy annotations, if any
1773
attr[attrname]._dbus_annotations = dict(
1774
attribute._dbus_annotations)
1775
except AttributeError:
1777
# Is this a D-Bus property?
1778
elif getattr(attribute, "_dbus_is_property", False):
1779
# Create a new, but exactly alike, function
1780
# object, and decorate it to be a new D-Bus
1781
# property with the alternate D-Bus interface
1782
# name. Add it to the class.
1783
attr[attrname] = (dbus_service_property(
1784
alt_interface, attribute._dbus_signature,
1785
attribute._dbus_access,
1786
attribute._dbus_get_args_options
1788
(copy_function(attribute)))
1789
# Copy annotations, if any
1791
attr[attrname]._dbus_annotations = dict(
1792
attribute._dbus_annotations)
1793
except AttributeError:
1795
# Is this a D-Bus interface?
1796
elif getattr(attribute, "_dbus_is_interface", False):
1797
# Create a new, but exactly alike, function
1798
# object. Decorate it to be a new D-Bus interface
1799
# with the alternate D-Bus interface name. Add it
1802
dbus_interface_annotations(alt_interface)
1803
(copy_function(attribute)))
1805
# Deprecate all alternate interfaces
1806
iname = "_AlternateDBusNames_interface_annotation{}"
1807
for interface_name in interface_names:
1809
@dbus_interface_annotations(interface_name)
1811
return {"org.freedesktop.DBus.Deprecated":
1813
# Find an unused name
1814
for aname in (iname.format(i)
1815
for i in itertools.count()):
1816
if aname not in attr:
1820
# Replace the class with a new subclass of it with
1821
# methods, signals, etc. as created above.
1822
if sys.version_info.major == 2:
1823
cls = type(b"{}Alternate".format(cls.__name__),
1826
cls = type("{}Alternate".format(cls.__name__),
1833
@alternate_dbus_interfaces({"se.recompile.Mandos":
1834
"se.bsnet.fukt.Mandos"})
713
1835
class ClientDBus(Client, DBusObjectWithProperties):
714
1836
"""A Client class using D-Bus
717
1839
dbus_object_path: dbus.ObjectPath
718
1840
bus: dbus.SystemBus()
721
1843
runtime_expansions = (Client.runtime_expansions
722
+ ("dbus_object_path",))
1844
+ ("dbus_object_path", ))
1846
_interface = "se.recompile.Mandos.Client"
724
1848
# dbus.service.Object doesn't use super(), so we can't either.
726
def __init__(self, bus = None, *args, **kwargs):
727
self._approvals_pending = 0
1850
def __init__(self, bus=None, *args, **kwargs):
729
1852
Client.__init__(self, *args, **kwargs)
730
1853
# Only now, when this client is initialized, can it show up on
732
client_object_name = unicode(self.name).translate(
1855
client_object_name = str(self.name).translate(
733
1856
{ord("."): ord("_"),
734
1857
ord("-"): ord("_")})
735
self.dbus_object_path = (dbus.ObjectPath
736
("/clients/" + client_object_name))
1858
self.dbus_object_path = dbus.ObjectPath(
1859
"/clients/" + client_object_name)
737
1860
DBusObjectWithProperties.__init__(self, self.bus,
738
1861
self.dbus_object_path)
740
def _get_approvals_pending(self):
741
return self._approvals_pending
742
def _set_approvals_pending(self, value):
743
old_value = self._approvals_pending
744
self._approvals_pending = value
746
if (hasattr(self, "dbus_object_path")
747
and bval is not bool(old_value)):
748
dbus_bool = dbus.Boolean(bval, variant_level=1)
749
self.PropertyChanged(dbus.String("ApprovalPending"),
752
approvals_pending = property(_get_approvals_pending,
753
_set_approvals_pending)
754
del _get_approvals_pending, _set_approvals_pending
757
def _datetime_to_dbus(dt, variant_level=0):
758
"""Convert a UTC datetime.datetime() to a D-Bus type."""
759
return dbus.String(dt.isoformat(),
760
variant_level=variant_level)
763
oldstate = getattr(self, "enabled", False)
764
r = Client.enable(self)
765
if oldstate != self.enabled:
767
self.PropertyChanged(dbus.String("Enabled"),
768
dbus.Boolean(True, variant_level=1))
769
self.PropertyChanged(
770
dbus.String("LastEnabled"),
771
self._datetime_to_dbus(self.last_enabled,
775
def disable(self, quiet = False):
776
oldstate = getattr(self, "enabled", False)
777
r = Client.disable(self, quiet=quiet)
778
if not quiet and oldstate != self.enabled:
780
self.PropertyChanged(dbus.String("Enabled"),
781
dbus.Boolean(False, variant_level=1))
1863
def notifychangeproperty(transform_func, dbus_name,
1864
type_func=lambda x: x,
1866
invalidate_only=False,
1867
_interface=_interface):
1868
""" Modify a variable so that it's a property which announces
1869
its changes to DBus.
1871
transform_fun: Function that takes a value and a variant_level
1872
and transforms it to a D-Bus type.
1873
dbus_name: D-Bus name of the variable
1874
type_func: Function that transform the value before sending it
1875
to the D-Bus. Default: no transform
1876
variant_level: D-Bus variant level. Default: 1
1878
attrname = "_{}".format(dbus_name)
1880
def setter(self, value):
1881
if hasattr(self, "dbus_object_path"):
1882
if (not hasattr(self, attrname) or
1883
type_func(getattr(self, attrname, None))
1884
!= type_func(value)):
1886
self.PropertiesChanged(
1887
_interface, dbus.Dictionary(),
1888
dbus.Array((dbus_name, )))
1890
dbus_value = transform_func(
1892
variant_level=variant_level)
1893
self.PropertyChanged(dbus.String(dbus_name),
1895
self.PropertiesChanged(
1897
dbus.Dictionary({dbus.String(dbus_name):
1900
setattr(self, attrname, value)
1902
return property(lambda self: getattr(self, attrname), setter)
1904
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1905
approvals_pending = notifychangeproperty(dbus.Boolean,
1908
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1909
last_enabled = notifychangeproperty(datetime_to_dbus,
1911
checker = notifychangeproperty(
1912
dbus.Boolean, "CheckerRunning",
1913
type_func=lambda checker: checker is not None)
1914
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1916
last_checker_status = notifychangeproperty(dbus.Int16,
1917
"LastCheckerStatus")
1918
last_approval_request = notifychangeproperty(
1919
datetime_to_dbus, "LastApprovalRequest")
1920
approved_by_default = notifychangeproperty(dbus.Boolean,
1921
"ApprovedByDefault")
1922
approval_delay = notifychangeproperty(
1923
dbus.UInt64, "ApprovalDelay",
1924
type_func=lambda td: td.total_seconds() * 1000)
1925
approval_duration = notifychangeproperty(
1926
dbus.UInt64, "ApprovalDuration",
1927
type_func=lambda td: td.total_seconds() * 1000)
1928
host = notifychangeproperty(dbus.String, "Host")
1929
timeout = notifychangeproperty(
1930
dbus.UInt64, "Timeout",
1931
type_func=lambda td: td.total_seconds() * 1000)
1932
extended_timeout = notifychangeproperty(
1933
dbus.UInt64, "ExtendedTimeout",
1934
type_func=lambda td: td.total_seconds() * 1000)
1935
interval = notifychangeproperty(
1936
dbus.UInt64, "Interval",
1937
type_func=lambda td: td.total_seconds() * 1000)
1938
checker_command = notifychangeproperty(dbus.String, "Checker")
1939
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1940
invalidate_only=True)
1942
del notifychangeproperty
784
1944
def __del__(self, *args, **kwargs):
786
1946
self.remove_from_connection()
1121
2264
self.start_checker()
1123
2266
self.stop_checker()
1125
2268
# ObjectPath - property
2270
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2271
"org.freedesktop.DBus.Deprecated": "true"})
1126
2272
@dbus_service_property(_interface, signature="o", access="read")
1127
2273
def ObjectPath_dbus_property(self):
1128
return self.dbus_object_path # is already a dbus.ObjectPath
2274
return self.dbus_object_path # is already a dbus.ObjectPath
1130
2276
# Secret = property
1131
@dbus_service_property(_interface, signature="ay",
1132
access="write", byte_arrays=True)
2278
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2280
@dbus_service_property(_interface,
1133
2284
def Secret_dbus_property(self, value):
1134
self.secret = str(value)
2285
self.secret = bytes(value)
1139
class ProxyClient(object):
1140
def __init__(self, child_pipe, fpr, address):
2291
def __init__(self, child_pipe, key_id, fpr, address):
1141
2292
self._pipe = child_pipe
1142
self._pipe.send(('init', fpr, address))
2293
self._pipe.send(("init", key_id, fpr, address))
1143
2294
if not self._pipe.recv():
2295
raise KeyError(key_id or fpr)
1146
2297
def __getattribute__(self, name):
1147
if(name == '_pipe'):
1148
2299
return super(ProxyClient, self).__getattribute__(name)
1149
self._pipe.send(('getattr', name))
2300
self._pipe.send(("getattr", name))
1150
2301
data = self._pipe.recv()
1151
if data[0] == 'data':
2302
if data[0] == "data":
1153
if data[0] == 'function':
2304
if data[0] == "function":
1154
2306
def func(*args, **kwargs):
1155
self._pipe.send(('funcall', name, args, kwargs))
2307
self._pipe.send(("funcall", name, args, kwargs))
1156
2308
return self._pipe.recv()[1]
1159
2312
def __setattr__(self, name, value):
1160
if(name == '_pipe'):
1161
2314
return super(ProxyClient, self).__setattr__(name, value)
1162
self._pipe.send(('setattr', name, value))
2315
self._pipe.send(("setattr", name, value))
1165
2318
class ClientHandler(socketserver.BaseRequestHandler, object):
1166
2319
"""A class to handle client connections.
1168
2321
Instantiated once for each connection to handle it.
1169
2322
Note: This will run in its own forked process."""
1171
2324
def handle(self):
1172
2325
with contextlib.closing(self.server.child_pipe) as child_pipe:
1173
logger.info("TCP connection from: %s",
1174
unicode(self.client_address))
1175
logger.debug("Pipe FD: %d",
1176
self.server.child_pipe.fileno())
1178
session = (gnutls.connection
1179
.ClientSession(self.request,
1181
.X509Credentials()))
1183
# Note: gnutls.connection.X509Credentials is really a
1184
# generic GnuTLS certificate credentials object so long as
1185
# no X.509 keys are added to it. Therefore, we can use it
1186
# here despite using OpenPGP certificates.
1188
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1189
# "+AES-256-CBC", "+SHA1",
1190
# "+COMP-NULL", "+CTYPE-OPENPGP",
2326
log.info("TCP connection from: %s",
2327
str(self.client_address))
2328
log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2330
session = gnutls.ClientSession(self.request)
2332
# priority = ":".join(("NONE", "+VERS-TLS1.1",
2333
# "+AES-256-CBC", "+SHA1",
2334
# "+COMP-NULL", "+CTYPE-OPENPGP",
1192
2336
# Use a fallback default, since this MUST be set.
1193
2337
priority = self.server.gnutls_priority
1194
2338
if priority is None:
1195
2339
priority = "NORMAL"
1196
(gnutls.library.functions
1197
.gnutls_priority_set_direct(session._c_object,
2340
gnutls.priority_set_direct(session,
2341
priority.encode("utf-8"), None)
1200
2343
# Start communication using the Mandos protocol
1201
2344
# Get protocol number
1202
2345
line = self.request.makefile().readline()
1203
logger.debug("Protocol version: %r", line)
2346
log.debug("Protocol version: %r", line)
1205
2348
if int(line.strip().split()[0]) > 1:
1207
except (ValueError, IndexError, RuntimeError), error:
1208
logger.error("Unknown protocol version: %s", error)
2349
raise RuntimeError(line)
2350
except (ValueError, IndexError, RuntimeError) as error:
2351
log.error("Unknown protocol version: %s", error)
1211
2354
# Start GnuTLS connection
1213
2356
session.handshake()
1214
except gnutls.errors.GNUTLSError, error:
1215
logger.warning("Handshake failed: %s", error)
2357
except gnutls.Error as error:
2358
log.warning("Handshake failed: %s", error)
1216
2359
# Do not run session.bye() here: the session is not
1217
2360
# established. Just abandon the request.
1219
logger.debug("Handshake succeeded")
2362
log.debug("Handshake succeeded")
1221
2364
approval_required = False
1224
fpr = self.fingerprint(self.peer_certificate
1226
except (TypeError, gnutls.errors.GNUTLSError), error:
1227
logger.warning("Bad certificate: %s", error)
1229
logger.debug("Fingerprint: %s", fpr)
1232
client = ProxyClient(child_pipe, fpr,
2366
if gnutls.has_rawpk:
2369
key_id = self.key_id(
2370
self.peer_certificate(session))
2371
except (TypeError, gnutls.Error) as error:
2372
log.warning("Bad certificate: %s", error)
2374
log.debug("Key ID: %s",
2375
key_id.decode("utf-8",
2381
fpr = self.fingerprint(
2382
self.peer_certificate(session))
2383
except (TypeError, gnutls.Error) as error:
2384
log.warning("Bad certificate: %s", error)
2386
log.debug("Fingerprint: %s", fpr)
2389
client = ProxyClient(child_pipe, key_id, fpr,
1233
2390
self.client_address)
1234
2391
except KeyError:
1237
2394
if client.approval_delay:
1238
2395
delay = client.approval_delay
1239
2396
client.approvals_pending += 1
1240
2397
approval_required = True
1243
2400
if not client.enabled:
1244
logger.warning("Client %s is disabled",
2401
log.info("Client %s is disabled", client.name)
1246
2402
if self.server.use_dbus:
1247
2403
# Emit D-Bus signal
1248
client.Rejected("Disabled")
2404
client.Rejected("Disabled")
1251
if client._approved or not client.approval_delay:
1252
#We are approved or approval is disabled
2407
if client.approved or not client.approval_delay:
2408
# We are approved or approval is disabled
1254
elif client._approved is None:
1255
logger.info("Client %s needs approval",
2410
elif client.approved is None:
2411
log.info("Client %s needs approval",
2413
if self.server.use_dbus:
2415
client.NeedApproval(
2416
client.approval_delay.total_seconds()
2417
* 1000, client.approved_by_default)
2419
log.warning("Client %s was not approved",
1257
2421
if self.server.use_dbus:
1258
2422
# Emit D-Bus signal
1259
client.NeedApproval(
1260
client.approval_delay_milliseconds(),
1261
client.approved_by_default)
1263
logger.warning("Client %s was not approved",
1265
if self.server.use_dbus:
1267
2423
client.Rejected("Denied")
1270
#wait until timeout or approved
1271
#x = float(client._timedelta_to_milliseconds(delay))
2426
# wait until timeout or approved
1272
2427
time = datetime.datetime.now()
1273
2428
client.changedstate.acquire()
1274
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2429
client.changedstate.wait(delay.total_seconds())
1275
2430
client.changedstate.release()
1276
2431
time2 = datetime.datetime.now()
1277
2432
if (time2 - time) >= delay:
1278
2433
if not client.approved_by_default:
1279
logger.warning("Client %s timed out while"
1280
" waiting for approval",
2434
log.warning("Client %s timed out while"
2435
" waiting for approval",
1282
2437
if self.server.use_dbus:
1283
2438
# Emit D-Bus signal
1284
2439
client.Rejected("Approval timed out")
1289
2444
delay -= time2 - time
1292
while sent_size < len(client.secret):
1294
sent = session.send(client.secret[sent_size:])
1295
except (gnutls.errors.GNUTLSError), error:
1296
logger.warning("gnutls send failed")
1298
logger.debug("Sent: %d, remaining: %d",
1299
sent, len(client.secret)
1300
- (sent_size + sent))
1303
logger.info("Sending secret to %s", client.name)
1304
# bump the timeout as if seen
2447
session.send(client.secret)
2448
except gnutls.Error as error:
2449
log.warning("gnutls send failed", exc_info=error)
2452
log.info("Sending secret to %s", client.name)
2453
# bump the timeout using extended_timeout
2454
client.bump_timeout(client.extended_timeout)
1306
2455
if self.server.use_dbus:
1307
2456
# Emit D-Bus signal
1308
2457
client.GotSecret()
1311
2460
if approval_required:
1312
2461
client.approvals_pending -= 1
1315
except (gnutls.errors.GNUTLSError), error:
1316
logger.warning("GnuTLS bye failed")
2464
except gnutls.Error as error:
2465
log.warning("GnuTLS bye failed", exc_info=error)
1319
2468
def peer_certificate(session):
1320
"Return the peer's OpenPGP certificate as a bytestring"
1321
# If not an OpenPGP certificate...
1322
if (gnutls.library.functions
1323
.gnutls_certificate_type_get(session._c_object)
1324
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1325
# ...do the normal thing
1326
return session.peer_certificate
2469
"Return the peer's certificate as a bytestring"
2471
cert_type = gnutls.certificate_type_get2(
2472
session, gnutls.CTYPE_PEERS)
2473
except AttributeError:
2474
cert_type = gnutls.certificate_type_get(session)
2475
if gnutls.has_rawpk:
2476
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2478
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2479
# If not a valid certificate type...
2480
if cert_type not in valid_cert_types:
2481
log.info("Cert type %r not in %r", cert_type,
2483
# ...return invalid data
1327
2485
list_size = ctypes.c_uint(1)
1328
cert_list = (gnutls.library.functions
1329
.gnutls_certificate_get_peers
1330
(session._c_object, ctypes.byref(list_size)))
2486
cert_list = (gnutls.certificate_get_peers
2487
(session, ctypes.byref(list_size)))
1331
2488
if not bool(cert_list) and list_size.value != 0:
1332
raise gnutls.errors.GNUTLSError("error getting peer"
2489
raise gnutls.Error("error getting peer certificate")
1334
2490
if list_size.value == 0:
1336
2492
cert = cert_list[0]
1337
2493
return ctypes.string_at(cert.data, cert.size)
2496
def key_id(certificate):
2497
"Convert a certificate bytestring to a hexdigit key ID"
2498
# New GnuTLS "datum" with the public key
2499
datum = gnutls.datum_t(
2500
ctypes.cast(ctypes.c_char_p(certificate),
2501
ctypes.POINTER(ctypes.c_ubyte)),
2502
ctypes.c_uint(len(certificate)))
2503
# XXX all these need to be created in the gnutls "module"
2504
# New empty GnuTLS certificate
2505
pubkey = gnutls.pubkey_t()
2506
gnutls.pubkey_init(ctypes.byref(pubkey))
2507
# Import the raw public key into the certificate
2508
gnutls.pubkey_import(pubkey,
2509
ctypes.byref(datum),
2510
gnutls.X509_FMT_DER)
2511
# New buffer for the key ID
2512
buf = ctypes.create_string_buffer(32)
2513
buf_len = ctypes.c_size_t(len(buf))
2514
# Get the key ID from the raw public key into the buffer
2515
gnutls.pubkey_get_key_id(
2517
gnutls.KEYID_USE_SHA256,
2518
ctypes.cast(ctypes.byref(buf),
2519
ctypes.POINTER(ctypes.c_ubyte)),
2520
ctypes.byref(buf_len))
2521
# Deinit the certificate
2522
gnutls.pubkey_deinit(pubkey)
2524
# Convert the buffer to a Python bytestring
2525
key_id = ctypes.string_at(buf, buf_len.value)
2526
# Convert the bytestring to hexadecimal notation
2527
hex_key_id = binascii.hexlify(key_id).upper()
1340
2531
def fingerprint(openpgp):
1341
2532
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1342
2533
# New GnuTLS "datum" with the OpenPGP public key
1343
datum = (gnutls.library.types
1344
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1347
ctypes.c_uint(len(openpgp))))
2534
datum = gnutls.datum_t(
2535
ctypes.cast(ctypes.c_char_p(openpgp),
2536
ctypes.POINTER(ctypes.c_ubyte)),
2537
ctypes.c_uint(len(openpgp)))
1348
2538
# New empty GnuTLS certificate
1349
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1350
(gnutls.library.functions
1351
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2539
crt = gnutls.openpgp_crt_t()
2540
gnutls.openpgp_crt_init(ctypes.byref(crt))
1352
2541
# Import the OpenPGP public key into the certificate
1353
(gnutls.library.functions
1354
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1355
gnutls.library.constants
1356
.GNUTLS_OPENPGP_FMT_RAW))
2542
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2543
gnutls.OPENPGP_FMT_RAW)
1357
2544
# Verify the self signature in the key
1358
2545
crtverify = ctypes.c_uint()
1359
(gnutls.library.functions
1360
.gnutls_openpgp_crt_verify_self(crt, 0,
1361
ctypes.byref(crtverify)))
2546
gnutls.openpgp_crt_verify_self(crt, 0,
2547
ctypes.byref(crtverify))
1362
2548
if crtverify.value != 0:
1363
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1364
raise (gnutls.errors.CertificateSecurityError
2549
gnutls.openpgp_crt_deinit(crt)
2550
raise gnutls.CertificateSecurityError(code
1366
2552
# New buffer for the fingerprint
1367
2553
buf = ctypes.create_string_buffer(20)
1368
2554
buf_len = ctypes.c_size_t()
1369
2555
# Get the fingerprint from the certificate into the buffer
1370
(gnutls.library.functions
1371
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1372
ctypes.byref(buf_len)))
2556
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2557
ctypes.byref(buf_len))
1373
2558
# Deinit the certificate
1374
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2559
gnutls.openpgp_crt_deinit(crt)
1375
2560
# Convert the buffer to a Python bytestring
1376
2561
fpr = ctypes.string_at(buf, buf_len.value)
1377
2562
# Convert the bytestring to hexadecimal notation
1378
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2563
hex_fpr = binascii.hexlify(fpr).upper()
1382
class MultiprocessingMixIn(object):
2567
class MultiprocessingMixIn:
1383
2568
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1384
2570
def sub_process_main(self, request, address):
1386
2572
self.finish_request(request, address)
1388
2574
self.handle_error(request, address)
1389
2575
self.close_request(request)
1391
2577
def process_request(self, request, address):
1392
2578
"""Start a new process to process the request."""
1393
multiprocessing.Process(target = self.sub_process_main,
1394
args = (request, address)).start()
1396
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2579
proc = multiprocessing.Process(target=self.sub_process_main,
2580
args=(request, address))
2585
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1397
2586
""" adds a pipe to the MixIn """
1398
2588
def process_request(self, request, client_address):
1399
2589
"""Overrides and wraps the original process_request().
1401
2591
This function creates a new pipe in self.pipe
1403
2593
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1405
super(MultiprocessingMixInWithPipe,
1406
self).process_request(request, client_address)
2595
proc = MultiprocessingMixIn.process_request(self, request,
1407
2597
self.child_pipe.close()
1408
self.add_pipe(parent_pipe)
2598
self.add_pipe(parent_pipe, proc)
1410
def add_pipe(self, parent_pipe):
2600
def add_pipe(self, parent_pipe, proc):
1411
2601
"""Dummy function; override as necessary"""
2602
raise NotImplementedError()
1414
2605
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1415
socketserver.TCPServer, object):
1416
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2606
socketserver.TCPServer):
2607
"""IPv6-capable TCP server. Accepts None as address and/or port
1419
2610
enabled: Boolean; whether this server is activated yet
1420
2611
interface: None or a network interface name (string)
1421
2612
use_ipv6: Boolean; to use IPv6 or not
1423
2615
def __init__(self, server_address, RequestHandlerClass,
1424
interface=None, use_ipv6=True):
2619
"""If socketfd is set, use that file descriptor instead of
2620
creating a new one with socket.socket().
1425
2622
self.interface = interface
1427
2624
self.address_family = socket.AF_INET6
2625
if socketfd is not None:
2626
# Save the file descriptor
2627
self.socketfd = socketfd
2628
# Save the original socket.socket() function
2629
self.socket_socket = socket.socket
2631
# To implement --socket, we monkey patch socket.socket.
2633
# (When socketserver.TCPServer is a new-style class, we
2634
# could make self.socket into a property instead of monkey
2635
# patching socket.socket.)
2637
# Create a one-time-only replacement for socket.socket()
2638
@functools.wraps(socket.socket)
2639
def socket_wrapper(*args, **kwargs):
2640
# Restore original function so subsequent calls are
2642
socket.socket = self.socket_socket
2643
del self.socket_socket
2644
# This time only, return a new socket object from the
2645
# saved file descriptor.
2646
return socket.fromfd(self.socketfd, *args, **kwargs)
2647
# Replace socket.socket() function with wrapper
2648
socket.socket = socket_wrapper
2649
# The socketserver.TCPServer.__init__ will call
2650
# socket.socket(), which might be our replacement,
2651
# socket_wrapper(), if socketfd was set.
1428
2652
socketserver.TCPServer.__init__(self, server_address,
1429
2653
RequestHandlerClass)
1430
2655
def server_bind(self):
1431
2656
"""This overrides the normal server_bind() function
1432
2657
to bind to an interface if one was specified, and also NOT to
1433
2658
bind to an address or port if they were not specified."""
2659
global SO_BINDTODEVICE
1434
2660
if self.interface is not None:
1435
2661
if SO_BINDTODEVICE is None:
1436
logger.error("SO_BINDTODEVICE does not exist;"
1437
" cannot bind to interface %s",
1441
self.socket.setsockopt(socket.SOL_SOCKET,
1445
except socket.error, error:
1446
if error[0] == errno.EPERM:
1447
logger.error("No permission to"
1448
" bind to interface %s",
1450
elif error[0] == errno.ENOPROTOOPT:
1451
logger.error("SO_BINDTODEVICE not available;"
1452
" cannot bind to interface %s",
2662
# Fall back to a hard-coded value which seems to be
2664
log.warning("SO_BINDTODEVICE not found, trying 25")
2665
SO_BINDTODEVICE = 25
2667
self.socket.setsockopt(
2668
socket.SOL_SOCKET, SO_BINDTODEVICE,
2669
(self.interface + "\0").encode("utf-8"))
2670
except socket.error as error:
2671
if error.errno == errno.EPERM:
2672
log.error("No permission to bind to interface %s",
2674
elif error.errno == errno.ENOPROTOOPT:
2675
log.error("SO_BINDTODEVICE not available; cannot"
2676
" bind to interface %s", self.interface)
2677
elif error.errno == errno.ENODEV:
2678
log.error("Interface %s does not exist, cannot"
2679
" bind", self.interface)
1456
2682
# Only bind(2) the socket if we really need to.
1457
2683
if self.server_address[0] or self.server_address[1]:
2684
if self.server_address[1]:
2685
self.allow_reuse_address = True
1458
2686
if not self.server_address[0]:
1459
2687
if self.address_family == socket.AF_INET6:
1460
any_address = "::" # in6addr_any
2688
any_address = "::" # in6addr_any
1462
any_address = socket.INADDR_ANY
2690
any_address = "0.0.0.0" # INADDR_ANY
1463
2691
self.server_address = (any_address,
1464
2692
self.server_address[1])
1465
2693
elif not self.server_address[1]:
1466
self.server_address = (self.server_address[0],
2694
self.server_address = (self.server_address[0], 0)
1468
2695
# if self.interface:
1469
2696
# self.server_address = (self.server_address[0],
1673
2999
##################################################################
1674
3000
# Parsing of options, both command line and config file
1676
parser = optparse.OptionParser(version = "%%prog %s" % version)
1677
parser.add_option("-i", "--interface", type="string",
1678
metavar="IF", help="Bind to interface IF")
1679
parser.add_option("-a", "--address", type="string",
1680
help="Address to listen for requests on")
1681
parser.add_option("-p", "--port", type="int",
1682
help="Port number to receive requests on")
1683
parser.add_option("--check", action="store_true",
1684
help="Run self-test")
1685
parser.add_option("--debug", action="store_true",
1686
help="Debug mode; run in foreground and log to"
1688
parser.add_option("--debuglevel", type="string", metavar="LEVEL",
1689
help="Debug level for stdout output")
1690
parser.add_option("--priority", type="string", help="GnuTLS"
1691
" priority string (see GnuTLS documentation)")
1692
parser.add_option("--servicename", type="string",
1693
metavar="NAME", help="Zeroconf service name")
1694
parser.add_option("--configdir", type="string",
1695
default="/etc/mandos", metavar="DIR",
1696
help="Directory to search for configuration"
1698
parser.add_option("--no-dbus", action="store_false",
1699
dest="use_dbus", help="Do not provide D-Bus"
1700
" system bus interface")
1701
parser.add_option("--no-ipv6", action="store_false",
1702
dest="use_ipv6", help="Do not use IPv6")
1703
options = parser.parse_args()[0]
3002
parser = argparse.ArgumentParser()
3003
parser.add_argument("-v", "--version", action="version",
3004
version="%(prog)s {}".format(version),
3005
help="show version number and exit")
3006
parser.add_argument("-i", "--interface", metavar="IF",
3007
help="Bind to interface IF")
3008
parser.add_argument("-a", "--address",
3009
help="Address to listen for requests on")
3010
parser.add_argument("-p", "--port", type=int,
3011
help="Port number to receive requests on")
3012
parser.add_argument("--check", action="store_true",
3013
help="Run self-test")
3014
parser.add_argument("--debug", action="store_true",
3015
help="Debug mode; run in foreground and log"
3016
" to terminal", default=None)
3017
parser.add_argument("--debuglevel", metavar="LEVEL",
3018
help="Debug level for stdout output")
3019
parser.add_argument("--priority", help="GnuTLS"
3020
" priority string (see GnuTLS documentation)")
3021
parser.add_argument("--servicename",
3022
metavar="NAME", help="Zeroconf service name")
3023
parser.add_argument("--configdir",
3024
default="/etc/mandos", metavar="DIR",
3025
help="Directory to search for configuration"
3027
parser.add_argument("--no-dbus", action="store_false",
3028
dest="use_dbus", help="Do not provide D-Bus"
3029
" system bus interface", default=None)
3030
parser.add_argument("--no-ipv6", action="store_false",
3031
dest="use_ipv6", help="Do not use IPv6",
3033
parser.add_argument("--no-restore", action="store_false",
3034
dest="restore", help="Do not restore stored"
3035
" state", default=None)
3036
parser.add_argument("--socket", type=int,
3037
help="Specify a file descriptor to a network"
3038
" socket to use instead of creating one")
3039
parser.add_argument("--statedir", metavar="DIR",
3040
help="Directory to save/restore state in")
3041
parser.add_argument("--foreground", action="store_true",
3042
help="Run in foreground", default=None)
3043
parser.add_argument("--no-zeroconf", action="store_false",
3044
dest="zeroconf", help="Do not use Zeroconf",
3047
options = parser.parse_args()
1710
3049
# Default values for config file for server-global settings
1711
server_defaults = { "interface": "",
1716
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1717
"servicename": "Mandos",
3050
if gnutls.has_rawpk:
3051
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3052
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3054
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3055
":+SIGN-DSA-SHA256")
3056
server_defaults = {"interface": "",
3060
"priority": priority,
3061
"servicename": "Mandos",
3067
"statedir": "/var/lib/mandos",
3068
"foreground": "False",
1723
3073
# Parse config file for server-global settings
1724
server_config = configparser.SafeConfigParser(server_defaults)
3074
server_config = configparser.ConfigParser(server_defaults)
1725
3075
del server_defaults
1726
server_config.read(os.path.join(options.configdir,
1728
# Convert the SafeConfigParser object to a dict
3076
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3077
# Convert the ConfigParser object to a dict
1729
3078
server_settings = server_config.defaults()
1730
3079
# Use the appropriate methods on the non-string config options
1731
for option in ("debug", "use_dbus", "use_ipv6"):
3080
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3081
"foreground", "zeroconf"):
1732
3082
server_settings[option] = server_config.getboolean("DEFAULT",
1734
3084
if server_settings["port"]:
1735
3085
server_settings["port"] = server_config.getint("DEFAULT",
3087
if server_settings["socket"]:
3088
server_settings["socket"] = server_config.getint("DEFAULT",
3090
# Later, stdin will, and stdout and stderr might, be dup'ed
3091
# over with an opened os.devnull. But we don't want this to
3092
# happen with a supplied network socket.
3093
if 0 <= server_settings["socket"] <= 2:
3094
server_settings["socket"] = os.dup(server_settings
1737
3096
del server_config
1739
3098
# Override the settings from the config file with command line
1740
3099
# options, if set.
1741
3100
for option in ("interface", "address", "port", "debug",
1742
"priority", "servicename", "configdir",
1743
"use_dbus", "use_ipv6", "debuglevel"):
3101
"priority", "servicename", "configdir", "use_dbus",
3102
"use_ipv6", "debuglevel", "restore", "statedir",
3103
"socket", "foreground", "zeroconf"):
1744
3104
value = getattr(options, option)
1745
3105
if value is not None:
1746
3106
server_settings[option] = value
1748
3108
# Force all strings to be unicode
1749
3109
for option in server_settings.keys():
1750
if type(server_settings[option]) is str:
1751
server_settings[option] = unicode(server_settings[option])
3110
if isinstance(server_settings[option], bytes):
3111
server_settings[option] = (server_settings[option]
3113
# Force all boolean options to be boolean
3114
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3115
"foreground", "zeroconf"):
3116
server_settings[option] = bool(server_settings[option])
3117
# Debug implies foreground
3118
if server_settings["debug"]:
3119
server_settings["foreground"] = True
1752
3120
# Now we have our good server settings in "server_settings"
1754
3122
##################################################################
3124
if (not server_settings["zeroconf"]
3125
and not (server_settings["port"]
3126
or server_settings["socket"] != "")):
3127
parser.error("Needs port or socket to work without Zeroconf")
1756
3129
# For convenience
1757
3130
debug = server_settings["debug"]
1758
3131
debuglevel = server_settings["debuglevel"]
1759
3132
use_dbus = server_settings["use_dbus"]
1760
3133
use_ipv6 = server_settings["use_ipv6"]
3134
stored_state_path = os.path.join(server_settings["statedir"],
3136
foreground = server_settings["foreground"]
3137
zeroconf = server_settings["zeroconf"]
3140
initlogger(debug, logging.DEBUG)
3145
level = getattr(logging, debuglevel.upper())
3146
initlogger(debug, level)
1762
3148
if server_settings["servicename"] != "Mandos":
1763
syslogger.setFormatter(logging.Formatter
1764
('Mandos (%s) [%%(process)d]:'
1765
' %%(levelname)s: %%(message)s'
1766
% server_settings["servicename"]))
3149
syslogger.setFormatter(
3150
logging.Formatter("Mandos ({}) [%(process)d]:"
3151
" %(levelname)s: %(message)s".format(
3152
server_settings["servicename"])))
1768
3154
# Parse config file with clients
1769
client_defaults = { "timeout": "1h",
1771
"checker": "fping -q -- %%(host)s",
1773
"approval_delay": "0s",
1774
"approval_duration": "1s",
1776
client_config = configparser.SafeConfigParser(client_defaults)
3155
client_config = configparser.ConfigParser(Client.client_defaults)
1777
3156
client_config.read(os.path.join(server_settings["configdir"],
1778
3157
"clients.conf"))
1780
3159
global mandos_dbus_service
1781
3160
mandos_dbus_service = None
1783
tcp_server = MandosServer((server_settings["address"],
1784
server_settings["port"]),
1786
interface=(server_settings["interface"]
1790
server_settings["priority"],
1793
pidfilename = "/var/run/mandos.pid"
1795
pidfile = open(pidfilename, "w")
1797
logger.error("Could not open file %r", pidfilename)
1800
uid = pwd.getpwnam("_mandos").pw_uid
1801
gid = pwd.getpwnam("_mandos").pw_gid
1804
uid = pwd.getpwnam("mandos").pw_uid
1805
gid = pwd.getpwnam("mandos").pw_gid
3163
if server_settings["socket"] != "":
3164
socketfd = server_settings["socket"]
3165
tcp_server = MandosServer(
3166
(server_settings["address"], server_settings["port"]),
3168
interface=(server_settings["interface"] or None),
3170
gnutls_priority=server_settings["priority"],
3174
pidfilename = "/run/mandos.pid"
3175
if not os.path.isdir("/run/."):
3176
pidfilename = "/var/run/mandos.pid"
3179
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3180
except IOError as e:
3181
log.error("Could not open file %r", pidfilename,
3184
for name, group in (("_mandos", "_mandos"),
3185
("mandos", "mandos"),
3186
("nobody", "nogroup")):
3188
uid = pwd.getpwnam(name).pw_uid
3189
gid = pwd.getpwnam(group).pw_gid
1806
3191
except KeyError:
1808
uid = pwd.getpwnam("nobody").pw_uid
1809
gid = pwd.getpwnam("nobody").pw_gid
1816
except OSError, error:
1817
if error[0] != errno.EPERM:
1820
if not debug and not debuglevel:
1821
syslogger.setLevel(logging.WARNING)
1822
console.setLevel(logging.WARNING)
1824
level = getattr(logging, debuglevel.upper())
1825
syslogger.setLevel(level)
1826
console.setLevel(level)
3199
log.debug("Did setuid/setgid to %s:%s", uid, gid)
3200
except OSError as error:
3201
log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3202
os.strerror(error.errno))
3203
if error.errno != errno.EPERM:
1829
3207
# Enable all possible GnuTLS debugging
1831
3209
# "Use a log level over 10 to enable all debugging options."
1832
3210
# - GnuTLS manual
1833
gnutls.library.functions.gnutls_global_set_log_level(11)
1835
@gnutls.library.types.gnutls_log_func
3211
gnutls.global_set_log_level(11)
1836
3214
def debug_gnutls(level, string):
1837
logger.debug("GnuTLS: %s", string[:-1])
1839
(gnutls.library.functions
1840
.gnutls_global_set_log_function(debug_gnutls))
3215
log.debug("GnuTLS: %s",
3216
string[:-1].decode("utf-8", errors="replace"))
3218
gnutls.global_set_log_function(debug_gnutls)
1842
3220
# Redirect stdin so all checkers get /dev/null
1843
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3221
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1844
3222
os.dup2(null, sys.stdin.fileno())
1848
# No console logging
1849
logger.removeHandler(console)
1851
3226
# Need to fork before connecting to D-Bus
1853
3228
# Close all input and output, do double fork, etc.
3231
if gi.version_info < (3, 10, 2):
3232
# multiprocessing will use threads, so before we use GLib we
3233
# need to inform GLib that threads will be used.
1856
3236
global main_loop
1857
3237
# From the Avahi example code
1858
DBusGMainLoop(set_as_default=True )
1859
main_loop = gobject.MainLoop()
3238
DBusGMainLoop(set_as_default=True)
3239
main_loop = GLib.MainLoop()
1860
3240
bus = dbus.SystemBus()
1861
3241
# End of Avahi example code
1864
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1865
bus, do_not_queue=True)
1866
except dbus.exceptions.NameExistsException, e:
1867
logger.error(unicode(e) + ", disabling D-Bus")
3244
bus_name = dbus.service.BusName("se.recompile.Mandos",
3247
old_bus_name = dbus.service.BusName(
3248
"se.bsnet.fukt.Mandos", bus,
3250
except dbus.exceptions.DBusException as e:
3251
log.error("Disabling D-Bus:", exc_info=e)
1868
3252
use_dbus = False
1869
3253
server_settings["use_dbus"] = False
1870
3254
tcp_server.use_dbus = False
1871
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1872
service = AvahiService(name = server_settings["servicename"],
1873
servicetype = "_mandos._tcp",
1874
protocol = protocol, bus = bus)
1875
if server_settings["interface"]:
1876
service.interface = (if_nametoindex
1877
(str(server_settings["interface"])))
3256
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3257
service = AvahiServiceToSyslog(
3258
name=server_settings["servicename"],
3259
servicetype="_mandos._tcp",
3262
if server_settings["interface"]:
3263
service.interface = if_nametoindex(
3264
server_settings["interface"].encode("utf-8"))
1879
3266
global multiprocessing_manager
1880
3267
multiprocessing_manager = multiprocessing.Manager()
1882
3269
client_class = Client
1884
client_class = functools.partial(ClientDBus, bus = bus)
1885
def client_config_items(config, section):
1886
special_settings = {
1887
"approved_by_default":
1888
lambda: config.getboolean(section,
1889
"approved_by_default"),
1891
for name, value in config.items(section):
3271
client_class = functools.partial(ClientDBus, bus=bus)
3273
client_settings = Client.config_parser(client_config)
3274
old_client_settings = {}
3277
# This is used to redirect stdout and stderr for checker processes
3279
wnull = open(os.devnull, "w") # A writable /dev/null
3280
# Only used if server is running in foreground but not in debug
3282
if debug or not foreground:
3285
# Get client data and settings from last running state.
3286
if server_settings["restore"]:
3288
with open(stored_state_path, "rb") as stored_state:
3289
if sys.version_info.major == 2:
3290
clients_data, old_client_settings = pickle.load(
3293
bytes_clients_data, bytes_old_client_settings = (
3294
pickle.load(stored_state, encoding="bytes"))
3295
# Fix bytes to strings
3298
clients_data = {(key.decode("utf-8")
3299
if isinstance(key, bytes)
3302
bytes_clients_data.items()}
3303
del bytes_clients_data
3304
for key in clients_data:
3305
value = {(k.decode("utf-8")
3306
if isinstance(k, bytes) else k): v
3308
clients_data[key].items()}
3309
clients_data[key] = value
3311
value["client_structure"] = [
3313
if isinstance(s, bytes)
3315
value["client_structure"]]
3316
# .name, .host, and .checker_command
3317
for k in ("name", "host", "checker_command"):
3318
if isinstance(value[k], bytes):
3319
value[k] = value[k].decode("utf-8")
3320
if "key_id" not in value:
3321
value["key_id"] = ""
3322
elif "fingerprint" not in value:
3323
value["fingerprint"] = ""
3324
# old_client_settings
3326
old_client_settings = {
3327
(key.decode("utf-8")
3328
if isinstance(key, bytes)
3331
bytes_old_client_settings.items()}
3332
del bytes_old_client_settings
3333
# .host and .checker_command
3334
for value in old_client_settings.values():
3335
for attribute in ("host", "checker_command"):
3336
if isinstance(value[attribute], bytes):
3337
value[attribute] = (value[attribute]
3339
os.remove(stored_state_path)
3340
except IOError as e:
3341
if e.errno == errno.ENOENT:
3342
log.warning("Could not load persistent state:"
3343
" %s", os.strerror(e.errno))
3345
log.critical("Could not load persistent state:",
3348
except EOFError as e:
3349
log.warning("Could not load persistent state: EOFError:",
3352
with PGPEngine() as pgp:
3353
for client_name, client in clients_data.items():
3354
# Skip removed clients
3355
if client_name not in client_settings:
3358
# Decide which value to use after restoring saved state.
3359
# We have three different values: Old config file,
3360
# new config file, and saved state.
3361
# New config value takes precedence if it differs from old
3362
# config value, otherwise use saved state.
3363
for name, value in client_settings[client_name].items():
3365
# For each value in new config, check if it
3366
# differs from the old config value (Except for
3367
# the "secret" attribute)
3368
if (name != "secret"
3370
old_client_settings[client_name][name])):
3371
client[name] = value
3375
# Clients who has passed its expire date can still be
3376
# enabled if its last checker was successful. A Client
3377
# whose checker succeeded before we stored its state is
3378
# assumed to have successfully run all checkers during
3380
if client["enabled"]:
3381
if datetime.datetime.utcnow() >= client["expires"]:
3382
if not client["last_checked_ok"]:
3383
log.warning("disabling client %s - Client"
3384
" never performed a successful"
3385
" checker", client_name)
3386
client["enabled"] = False
3387
elif client["last_checker_status"] != 0:
3388
log.warning("disabling client %s - Client"
3389
" last checker failed with error"
3390
" code %s", client_name,
3391
client["last_checker_status"])
3392
client["enabled"] = False
3394
client["expires"] = (
3395
datetime.datetime.utcnow()
3396
+ client["timeout"])
3397
log.debug("Last checker succeeded, keeping %s"
3398
" enabled", client_name)
1893
yield (name, special_settings[name]())
1897
tcp_server.clients.update(set(
1898
client_class(name = section,
1899
config= dict(client_config_items(
1900
client_config, section)))
1901
for section in client_config.sections()))
3400
client["secret"] = pgp.decrypt(
3401
client["encrypted_secret"],
3402
client_settings[client_name]["secret"])
3404
# If decryption fails, we use secret from new settings
3405
log.debug("Failed to decrypt %s old secret",
3407
client["secret"] = (client_settings[client_name]
3410
# Add/remove clients based on new changes made to config
3411
for client_name in (set(old_client_settings)
3412
- set(client_settings)):
3413
del clients_data[client_name]
3414
for client_name in (set(client_settings)
3415
- set(old_client_settings)):
3416
clients_data[client_name] = client_settings[client_name]
3418
# Create all client objects
3419
for client_name, client in clients_data.items():
3420
tcp_server.clients[client_name] = client_class(
3423
server_settings=server_settings)
1902
3425
if not tcp_server.clients:
1903
logger.warning("No clients defined")
1909
pidfile.write(str(pid) + "\n".encode("utf-8"))
1912
logger.error("Could not write to file %r with PID %d",
1915
# "pidfile" was never created
3426
log.warning("No clients defined")
3429
if pidfile is not None:
3433
print(pid, file=pidfile)
3435
log.error("Could not write to file %r with PID %d",
1917
3438
del pidfilename
1919
signal.signal(signal.SIGINT, signal.SIG_IGN)
1921
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1922
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3440
for termsig in (signal.SIGHUP, signal.SIGTERM):
3441
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3442
lambda: main_loop.quit() and False)
1925
class MandosDBusService(dbus.service.Object):
3446
@alternate_dbus_interfaces(
3447
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3448
class MandosDBusService(DBusObjectWithObjectManager):
1926
3449
"""A D-Bus proxy object"""
1927
3451
def __init__(self):
1928
3452
dbus.service.Object.__init__(self, bus, "/")
1929
_interface = "se.bsnet.fukt.Mandos"
3454
_interface = "se.recompile.Mandos"
1931
3456
@dbus.service.signal(_interface, signature="o")
1932
3457
def ClientAdded(self, objpath):
1936
3461
@dbus.service.signal(_interface, signature="ss")
1937
def ClientNotFound(self, fingerprint, address):
3462
def ClientNotFound(self, key_id, address):
3466
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1941
3468
@dbus.service.signal(_interface, signature="os")
1942
3469
def ClientRemoved(self, objpath, name):
3473
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1946
3475
@dbus.service.method(_interface, out_signature="ao")
1947
3476
def GetAllClients(self):
1949
return dbus.Array(c.dbus_object_path
1950
for c in tcp_server.clients)
3478
return dbus.Array(c.dbus_object_path for c in
3479
tcp_server.clients.values())
3481
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1952
3483
@dbus.service.method(_interface,
1953
3484
out_signature="a{oa{sv}}")
1954
3485
def GetAllClientsWithProperties(self):
1956
3487
return dbus.Dictionary(
1957
((c.dbus_object_path, c.GetAll(""))
1958
for c in tcp_server.clients),
3488
{c.dbus_object_path: c.GetAll(
3489
"se.recompile.Mandos.Client")
3490
for c in tcp_server.clients.values()},
1959
3491
signature="oa{sv}")
1961
3493
@dbus.service.method(_interface, in_signature="o")
1962
3494
def RemoveClient(self, object_path):
1964
for c in tcp_server.clients:
3496
for c in tcp_server.clients.values():
1965
3497
if c.dbus_object_path == object_path:
1966
tcp_server.clients.remove(c)
3498
del tcp_server.clients[c.name]
1967
3499
c.remove_from_connection()
1968
# Don't signal anything except ClientRemoved
3500
# Don't signal the disabling
1969
3501
c.disable(quiet=True)
1971
self.ClientRemoved(object_path, c.name)
3502
# Emit D-Bus signal for removal
3503
self.client_removed_signal(c)
1973
3505
raise KeyError(object_path)
3509
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3510
out_signature="a{oa{sa{sv}}}")
3511
def GetManagedObjects(self):
3513
return dbus.Dictionary(
3514
{client.dbus_object_path:
3516
{interface: client.GetAll(interface)
3518
client._get_all_interface_names()})
3519
for client in tcp_server.clients.values()})
3521
def client_added_signal(self, client):
3522
"""Send the new standard signal and the old signal"""
3524
# New standard signal
3525
self.InterfacesAdded(
3526
client.dbus_object_path,
3528
{interface: client.GetAll(interface)
3530
client._get_all_interface_names()}))
3532
self.ClientAdded(client.dbus_object_path)
3534
def client_removed_signal(self, client):
3535
"""Send the new standard signal and the old signal"""
3537
# New standard signal
3538
self.InterfacesRemoved(
3539
client.dbus_object_path,
3540
client._get_all_interface_names())
3542
self.ClientRemoved(client.dbus_object_path,
1977
3545
mandos_dbus_service = MandosDBusService()
3547
# Save modules to variables to exempt the modules from being
3548
# unloaded before the function registered with atexit() is run.
3549
mp = multiprocessing
1980
3553
"Cleanup function; run on exit"
3557
mp.active_children()
3559
if not (tcp_server.clients or client_settings):
3562
# Store client before exiting. Secrets are encrypted with key
3563
# based on what config file has. If config file is
3564
# removed/edited, old secret will thus be unrecovable.
3566
with PGPEngine() as pgp:
3567
for client in tcp_server.clients.values():
3568
key = client_settings[client.name]["secret"]
3569
client.encrypted_secret = pgp.encrypt(client.secret,
3573
# A list of attributes that can not be pickled
3575
exclude = {"bus", "changedstate", "secret",
3576
"checker", "server_settings"}
3577
for name, typ in inspect.getmembers(dbus.service
3581
client_dict["encrypted_secret"] = (client
3583
for attr in client.client_structure:
3584
if attr not in exclude:
3585
client_dict[attr] = getattr(client, attr)
3587
clients[client.name] = client_dict
3588
del client_settings[client.name]["secret"]
3591
with tempfile.NamedTemporaryFile(
3595
dir=os.path.dirname(stored_state_path),
3596
delete=False) as stored_state:
3597
pickle.dump((clients, client_settings), stored_state,
3599
tempname = stored_state.name
3600
os.rename(tempname, stored_state_path)
3601
except (IOError, OSError) as e:
3607
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3608
log.warning("Could not save persistent state: %s",
3609
os.strerror(e.errno))
3611
log.warning("Could not save persistent state:",
3615
# Delete all clients, and settings from config
1983
3616
while tcp_server.clients:
1984
client = tcp_server.clients.pop()
3617
name, client = tcp_server.clients.popitem()
1986
3619
client.remove_from_connection()
1987
client.disable_hook = None
1988
# Don't signal anything except ClientRemoved
3620
# Don't signal the disabling
1989
3621
client.disable(quiet=True)
3622
# Emit D-Bus signal for removal
1992
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3624
mandos_dbus_service.client_removed_signal(client)
3625
client_settings.clear()
1995
3627
atexit.register(cleanup)
1997
for client in tcp_server.clients:
3629
for client in tcp_server.clients.values():
2000
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3631
# Emit D-Bus signal for adding
3632
mandos_dbus_service.client_added_signal(client)
3633
# Need to initiate checking of clients
3635
client.init_checker(randomize_start=True)
2003
3637
tcp_server.enable()
2004
3638
tcp_server.server_activate()
2006
3640
# Find out what port we got
2007
service.port = tcp_server.socket.getsockname()[1]
3642
service.port = tcp_server.socket.getsockname()[1]
2009
logger.info("Now listening on address %r, port %d,"
2010
" flowinfo %d, scope_id %d"
2011
% tcp_server.socket.getsockname())
3644
log.info("Now listening on address %r, port %d, flowinfo %d,"
3645
" scope_id %d", *tcp_server.socket.getsockname())
2013
logger.info("Now listening on address %r, port %d"
2014
% tcp_server.socket.getsockname())
2016
#service.interface = tcp_server.socket.getsockname()[3]
3647
log.info("Now listening on address %r, port %d",
3648
*tcp_server.socket.getsockname())
3650
# service.interface = tcp_server.socket.getsockname()[3]
2019
# From the Avahi example code
2022
except dbus.exceptions.DBusException, error:
2023
logger.critical("DBusException: %s", error)
2026
# End of Avahi example code
2028
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2029
lambda *args, **kwargs:
2030
(tcp_server.handle_request
2031
(*args[2:], **kwargs) or True))
2033
logger.debug("Starting main loop")
3654
# From the Avahi example code
3657
except dbus.exceptions.DBusException as error:
3658
log.critical("D-Bus Exception", exc_info=error)
3661
# End of Avahi example code
3664
GLib.IOChannel.unix_new(tcp_server.fileno()),
3665
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3666
lambda *args, **kwargs: (tcp_server.handle_request
3667
(*args[2:], **kwargs) or True))
3669
log.debug("Starting main loop")
2034
3670
main_loop.run()
2035
except AvahiError, error:
2036
logger.critical("AvahiError: %s", error)
3671
except AvahiError as error:
3672
log.critical("Avahi Error", exc_info=error)
2039
3675
except KeyboardInterrupt:
2041
3677
print("", file=sys.stderr)
2042
logger.debug("Server received KeyboardInterrupt")
2043
logger.debug("Server exiting")
3678
log.debug("Server received KeyboardInterrupt")
3679
log.debug("Server exiting")
2044
3680
# Must run before the D-Bus bus name gets deregistered
2047
if __name__ == '__main__':
3684
def parse_test_args():
3685
# type: () -> argparse.Namespace
3686
parser = argparse.ArgumentParser(add_help=False)
3687
parser.add_argument("--check", action="store_true")
3688
parser.add_argument("--prefix", )
3689
args, unknown_args = parser.parse_known_args()
3691
# Remove test options from sys.argv
3692
sys.argv[1:] = unknown_args
3695
# Add all tests from doctest strings
3696
def load_tests(loader, tests, none):
3698
tests.addTests(doctest.DocTestSuite())
3701
if __name__ == "__main__":
3702
options = parse_test_args()
3705
extra_test_prefix = options.prefix
3706
if extra_test_prefix is not None:
3707
if not (unittest.main(argv=[""], exit=False)
3708
.result.wasSuccessful()):
3710
class ExtraTestLoader(unittest.TestLoader):
3711
testMethodPrefix = extra_test_prefix
3712
# Call using ./scriptname --test [--verbose]
3713
unittest.main(argv=[""], testLoader=ExtraTestLoader())
3715
unittest.main(argv=[""])
3723
# (lambda (&optional extra)
3724
# (if (not (funcall run-tests-in-test-buffer default-directory
3726
# (funcall show-test-buffer-in-test-window)
3727
# (funcall remove-test-window)
3728
# (if extra (message "Extra tests run successfully!"))))
3729
# run-tests-in-test-buffer:
3730
# (lambda (dir &optional extra)
3731
# (with-current-buffer (get-buffer-create "*Test*")
3732
# (setq buffer-read-only nil
3733
# default-directory dir)
3735
# (compilation-mode))
3736
# (let ((process-result
3737
# (let ((inhibit-read-only t))
3738
# (process-file-shell-command
3739
# (funcall get-command-line extra) nil "*Test*"))))
3740
# (and (numberp process-result)
3741
# (= process-result 0))))
3743
# (lambda (&optional extra)
3744
# (let ((quoted-script
3745
# (shell-quote-argument (funcall get-script-name))))
3747
# (concat "%s --check" (if extra " --prefix=atest" ""))
3751
# (if (fboundp 'file-local-name)
3752
# (file-local-name (buffer-file-name))
3753
# (or (file-remote-p (buffer-file-name) 'localname)
3754
# (buffer-file-name))))
3755
# remove-test-window:
3757
# (let ((test-window (get-buffer-window "*Test*")))
3758
# (if test-window (delete-window test-window))))
3759
# show-test-buffer-in-test-window:
3761
# (when (not (get-buffer-window-list "*Test*"))
3762
# (setq next-error-last-buffer (get-buffer "*Test*"))
3763
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3764
# (display-buffer-overriding-action
3765
# `((display-buffer-in-side-window) (side . ,side)
3766
# (window-height . fit-window-to-buffer)
3767
# (window-width . fit-window-to-buffer))))
3768
# (display-buffer "*Test*"))))
3771
# (let* ((run-extra-tests (lambda () (interactive)
3772
# (funcall run-tests t)))
3773
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3774
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
3775
# (setq minor-mode-overriding-map-alist
3776
# (cons `(run-tests . ,outer-keymap)
3777
# minor-mode-overriding-map-alist)))
3778
# (add-hook 'after-save-hook run-tests 90 t))