2
# -*- coding: utf-8; lexical-binding: t -*-
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos server - give out binary blobs to connecting clients.
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
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-2020 Teddy Hogeborn
15
# Copyright © 2008-2020 Björn Påhlsson
17
# This file is part of Mandos.
19
# Mandos is free software: you can redistribute it and/or modify it
20
# under the terms of the GNU General Public License as published by
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 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
21
19
# the Free Software Foundation, either version 3 of the License, or
22
20
# (at your option) any later version.
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
26
24
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27
25
# GNU General Public License for more details.
29
27
# You should have received a copy of the GNU General Public License
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
32
31
# Contact the authors at <mandos@recompile.se>.
34
34
from __future__ import (division, absolute_import, print_function,
38
from future_builtins import *
37
import SocketServer as socketserver
48
import SocketServer as socketserver
55
import ConfigParser as configparser
43
import gnutls.connection
45
import gnutls.library.functions
46
import gnutls.library.constants
47
import gnutls.library.types
48
import ConfigParser as configparser
63
57
import logging.handlers
70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
84
69
import dbus.service
86
from gi.repository import GLib
87
72
from dbus.mainloop.glib import DBusGMainLoop
90
75
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
import Crypto.Cipher.AES
122
80
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
123
81
except AttributeError:
125
# This is where SO_BINDTODEVICE was up to and including Python
127
83
from IN import SO_BINDTODEVICE
128
84
except ImportError:
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):
85
SO_BINDTODEVICE = None
89
stored_state_path = "/var/lib/mandos/clients.pickle"
91
logger = logging.getLogger()
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
96
def initlogger(level=logging.WARNING):
185
97
"""init logger and add loglevel"""
188
syslogger = (logging.handlers.SysLogHandler(
189
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
191
99
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
100
('Mandos [%(process)d]: %(levelname)s:'
102
logger.addHandler(syslogger)
104
console = logging.StreamHandler()
105
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
109
logger.addHandler(console)
110
logger.setLevel(level)
332
113
class AvahiError(Exception):
333
114
def __init__(self, value, *args, **kwargs):
334
115
self.value = value
335
return super(AvahiError, self).__init__(value, *args,
116
super(AvahiError, self).__init__(value, *args, **kwargs)
117
def __unicode__(self):
118
return unicode(repr(self.value))
339
120
class AvahiServiceError(AvahiError):
343
123
class AvahiGroupError(AvahiError):
127
class AvahiService(object):
348
128
"""An Avahi (Zeroconf) service.
351
131
interface: integer; avahi.IF_UNSPEC or an interface index.
352
132
Used to optionally bind to the specified interface.
353
name: string; Example: "Mandos"
354
type: string; Example: "_mandos._tcp".
355
See <https://www.iana.org/assignments/service-names-port-numbers>
133
name: string; Example: 'Mandos'
134
type: string; Example: '_mandos._tcp'.
135
See <http://www.dns-sd.org/ServiceTypes.html>
356
136
port: integer; what port to announce
357
137
TXT: list of strings; TXT record for the service
358
138
domain: string; Domain to publish on, default to .local if empty.
516
267
follow_name_owner_changes=True),
517
268
avahi.DBUS_INTERFACE_SERVER)
518
269
self.server.connect_to_signal("StateChanged",
519
self.server_state_changed)
270
self.server_state_changed)
520
271
self.server_state_changed(self.server.GetState())
523
273
class AvahiServiceToSyslog(AvahiService):
524
def rename(self, *args, **kwargs):
525
275
"""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"
276
ret = AvahiService.rename(self)
277
syslogger.setFormatter(logging.Formatter
278
('Mandos (%s) [%%(process)d]:'
279
' %%(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))
283
def _timedelta_to_milliseconds(td):
284
"Convert a datetime.timedelta() to milliseconds"
285
return ((td.days * 24 * 60 * 60 * 1000)
286
+ (td.seconds * 1000)
287
+ (td.microseconds // 1000))
289
class Client(object):
875
290
"""A representation of a client host served by this server.
878
approved: bool(); None if not yet approved/disapproved
293
_approved: bool(); 'None' if not yet approved/disapproved
879
294
approval_delay: datetime.timedelta(); Time to wait for approval
880
295
approval_duration: datetime.timedelta(); Duration of one approval
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
296
checker: subprocess.Popen(); a running checker process used
297
to see if the client lives.
298
'None' if no process is running.
299
checker_callback_tag: a gobject event source tag, or None
885
300
checker_command: string; External command which is run to check
886
301
if client lives. %() expansions are done at
887
302
runtime with vars(self) as dict, so that for
888
303
instance %(name)s can be used in the command.
889
checker_initiator_tag: a GLib event source tag, or None
304
checker_initiator_tag: a gobject event source tag, or None
890
305
created: datetime.datetime(); (UTC) object creation
891
306
client_structure: Object describing what attributes a client has
892
307
and is used for storing the client at exit
893
308
current_checker_command: string; current running checker_command
894
disable_initiator_tag: a GLib event source tag, or None
309
disable_initiator_tag: a gobject event source tag, or None
896
311
fingerprint: string (40 or 32 hexadecimal digits); used to
897
uniquely identify an OpenPGP client
898
key_id: string (64 hexadecimal digits); used to uniquely identify
899
a client using raw public keys
312
uniquely identify the client
900
313
host: string; available for use by the checker command
901
314
interval: datetime.timedelta(); How often to start a new checker
902
315
last_approval_request: datetime.datetime(); (UTC) or None
903
316
last_checked_ok: datetime.datetime(); (UTC) or None
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
317
last_checker_status: integer between 0 and 255 reflecting exit status
318
of last checker. -1 reflect crashed checker,
320
last_enabled: datetime.datetime(); (UTC)
910
321
name: string; from the config file, used in log messages and
911
322
D-Bus identifiers
912
323
secret: bytestring; sent verbatim (over TLS) to client
913
324
timeout: datetime.timedelta(); How long from last_checked_ok
914
325
until this client is disabled
915
extended_timeout: extra long timeout when secret has been sent
326
extended_timeout: extra long timeout when password has been sent
916
327
runtime_expansions: Allowed attributes for runtime expansion.
917
328
expires: datetime.datetime(); time (UTC) when a client will be
918
329
disabled, or None
919
server_settings: The server_settings dict from main()
922
332
runtime_expansions = ("approval_delay", "approval_duration",
923
"created", "enabled", "expires", "key_id",
924
"fingerprint", "host", "interval",
925
"last_approval_request", "last_checked_ok",
333
"created", "enabled", "fingerprint",
334
"host", "interval", "last_checked_ok",
926
335
"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",
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):
337
def timeout_milliseconds(self):
338
"Return the 'timeout' attribute in milliseconds"
339
return _timedelta_to_milliseconds(self.timeout)
341
def extended_timeout_milliseconds(self):
342
"Return the 'extended_timeout' attribute in milliseconds"
343
return _timedelta_to_milliseconds(self.extended_timeout)
345
def interval_milliseconds(self):
346
"Return the 'interval' attribute in milliseconds"
347
return _timedelta_to_milliseconds(self.interval)
349
def approval_delay_milliseconds(self):
350
return _timedelta_to_milliseconds(self.approval_delay)
352
def __init__(self, name = None, config=None):
353
"""Note: the 'checker' key in 'config' sets the
354
'checker_command' attribute and *not* the 'checker'
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()
359
logger.debug("Creating client %r", self.name)
360
# Uppercase and remove spaces from fingerprint for later
361
# comparison purposes with return value from the fingerprint()
363
self.fingerprint = (config["fingerprint"].upper()
365
logger.debug(" Fingerprint: %s", self.fingerprint)
366
if "secret" in config:
367
self.secret = config["secret"].decode("base64")
368
elif "secfile" in config:
369
with open(os.path.expanduser(os.path.expandvars
370
(config["secfile"])),
372
self.secret = secfile.read()
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
374
raise TypeError("No secret or secfile for client %s"
376
self.host = config.get("host", "")
377
self.created = datetime.datetime.utcnow()
379
self.last_approval_request = None
380
self.last_enabled = datetime.datetime.utcnow()
381
self.last_checked_ok = None
382
self.last_checker_status = None
383
self.timeout = string_to_delta(config["timeout"])
384
self.extended_timeout = string_to_delta(config
385
["extended_timeout"])
386
self.interval = string_to_delta(config["interval"])
1019
387
self.checker = None
1020
388
self.checker_initiator_tag = None
1021
389
self.disable_initiator_tag = None
390
self.expires = datetime.datetime.utcnow() + self.timeout
1022
391
self.checker_callback_tag = None
392
self.checker_command = config["checker"]
1023
393
self.current_checker_command = None
1024
self.approved = None
394
self._approved = None
395
self.approved_by_default = config.get("approved_by_default",
1025
397
self.approvals_pending = 0
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("_")]
398
self.approval_delay = string_to_delta(
399
config["approval_delay"])
400
self.approval_duration = string_to_delta(
401
config["approval_duration"])
402
self.changedstate = (multiprocessing_manager
403
.Condition(multiprocessing_manager
405
self.client_structure = [attr for attr in self.__dict__.iterkeys() if not attr.startswith("_")]
1031
406
self.client_structure.append("client_structure")
1033
for name, t in inspect.getmembers(
1034
type(self), lambda obj: isinstance(obj, property)):
409
for name, t in inspect.getmembers(type(self),
410
lambda obj: isinstance(obj, property)):
1035
411
if not name.startswith("_"):
1036
412
self.client_structure.append(name)
1038
414
# Send notice to process children that client state has changed
1039
415
def send_changedstate(self):
1040
416
with self.changedstate:
1041
417
self.changedstate.notify_all()
1043
419
def enable(self):
1044
420
"""Start this client's checker and timeout hooks"""
1045
421
if getattr(self, "enabled", False):
1046
422
# Already enabled
424
self.send_changedstate()
1048
425
self.expires = datetime.datetime.utcnow() + self.timeout
1049
426
self.enabled = True
1050
427
self.last_enabled = datetime.datetime.utcnow()
1051
428
self.init_checker()
1052
self.send_changedstate()
1054
430
def disable(self, quiet=True):
1055
431
"""Disable this client."""
1056
432
if not getattr(self, "enabled", False):
1059
log.info("Disabling client %s", self.name)
1060
if getattr(self, "disable_initiator_tag", None) is not None:
1061
GLib.source_remove(self.disable_initiator_tag)
435
self.send_changedstate()
437
logger.info("Disabling client %s", self.name)
438
if getattr(self, "disable_initiator_tag", False):
439
gobject.source_remove(self.disable_initiator_tag)
1062
440
self.disable_initiator_tag = None
1063
441
self.expires = None
1064
if getattr(self, "checker_initiator_tag", None) is not None:
1065
GLib.source_remove(self.checker_initiator_tag)
442
if getattr(self, "checker_initiator_tag", False):
443
gobject.source_remove(self.checker_initiator_tag)
1066
444
self.checker_initiator_tag = None
1067
445
self.stop_checker()
1068
446
self.enabled = False
1070
self.send_changedstate()
1071
# Do not run this again if called by a GLib.timeout_add
447
# Do not run this again if called by a gobject.timeout_add
1074
450
def __del__(self):
1077
453
def init_checker(self):
1078
454
# Schedule a new checker to be started an 'interval' from now,
1079
455
# and every interval from then on.
1080
if self.checker_initiator_tag is not None:
1081
GLib.source_remove(self.checker_initiator_tag)
1082
self.checker_initiator_tag = GLib.timeout_add(
1083
random.randrange(int(self.interval.total_seconds() * 1000
456
self.checker_initiator_tag = (gobject.timeout_add
457
(self.interval_milliseconds(),
1086
459
# Schedule a disable() when 'timeout' has passed
1087
if self.disable_initiator_tag is not None:
1088
GLib.source_remove(self.disable_initiator_tag)
1089
self.disable_initiator_tag = GLib.timeout_add(
1090
int(self.timeout.total_seconds() * 1000), self.disable)
460
self.disable_initiator_tag = (gobject.timeout_add
461
(self.timeout_milliseconds(),
1091
463
# Also start a new checker *right now*.
1092
464
self.start_checker()
1094
def checker_callback(self, source, condition, connection,
467
def checker_callback(self, pid, condition, command):
1096
468
"""The checker has completed, so take appropriate actions."""
1097
# Read return code from connection (see call_pipe)
1098
returncode = connection.recv()
1100
if self.checker is not None:
1102
469
self.checker_callback_tag = None
1103
470
self.checker = None
1106
self.last_checker_status = returncode
1107
self.last_checker_signal = None
471
if os.WIFEXITED(condition):
472
self.last_checker_status = os.WEXITSTATUS(condition)
1108
473
if self.last_checker_status == 0:
1109
log.info("Checker for %(name)s succeeded", vars(self))
474
logger.info("Checker for %(name)s succeeded",
1110
476
self.checked_ok()
1112
log.info("Checker for %(name)s failed", vars(self))
478
logger.info("Checker for %(name)s failed",
1114
481
self.last_checker_status = -1
1115
self.last_checker_signal = -returncode
1116
log.warning("Checker for %(name)s crashed?", vars(self))
1119
def checked_ok(self):
1120
"""Assert that the client has been seen, alive and well."""
1121
self.last_checked_ok = datetime.datetime.utcnow()
1122
self.last_checker_status = 0
1123
self.last_checker_signal = None
1126
def bump_timeout(self, timeout=None):
1127
"""Bump up the timeout for this client."""
482
logger.warning("Checker for %(name)s crashed?",
485
def checked_ok(self, timeout=None):
486
"""Bump up the timeout for this client.
488
This should only be called when the client has been seen,
1128
491
if timeout is None:
1129
492
timeout = self.timeout
493
self.last_checked_ok = datetime.datetime.utcnow()
1130
494
if self.disable_initiator_tag is not None:
1131
GLib.source_remove(self.disable_initiator_tag)
1132
self.disable_initiator_tag = None
495
gobject.source_remove(self.disable_initiator_tag)
1133
496
if getattr(self, "enabled", False):
1134
self.disable_initiator_tag = GLib.timeout_add(
1135
int(timeout.total_seconds() * 1000), self.disable)
497
self.disable_initiator_tag = (gobject.timeout_add
498
(_timedelta_to_milliseconds
499
(timeout), self.disable))
1136
500
self.expires = datetime.datetime.utcnow() + timeout
1138
502
def need_approval(self):
1139
503
self.last_approval_request = datetime.datetime.utcnow()
1141
505
def start_checker(self):
1142
506
"""Start a new checker subprocess if one is not running.
1144
508
If a checker already exists, leave it running and do
1146
510
# The reason for not killing a running checker is that if we
1147
# did that, and if a checker (for some reason) started running
1148
# slowly and taking more than 'interval' time, then the client
1149
# would inevitably timeout, since no checker would get a
1150
# chance to run to completion. If we instead leave running
511
# did that, then if a checker (for some reason) started
512
# running slowly and taking more than 'interval' time, the
513
# client would inevitably timeout, since no checker would get
514
# a chance to run to completion. If we instead leave running
1151
515
# checkers alone, the checker would have to take more time
1152
516
# than 'timeout' for the client to be disabled, which is as it
1155
if self.checker is not None and not self.checker.is_alive():
1156
log.warning("Checker was not alive; joining")
519
# If a checker exists, make sure it is not a zombie
521
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
522
except (AttributeError, OSError) as error:
523
if (isinstance(error, OSError)
524
and error.errno != errno.ECHILD):
528
logger.warning("Checker was a zombie")
529
gobject.source_remove(self.checker_callback_tag)
530
self.checker_callback(pid, status,
531
self.current_checker_command)
1159
532
# Start a new checker if needed
1160
533
if self.checker is None:
1161
# Escape attributes for the shell
1163
attr: shlex.quote(str(getattr(self, attr)))
1164
for attr in self.runtime_expansions}
1166
command = self.checker_command % escaped_attrs
1167
except TypeError as error:
1168
log.error('Could not format string "%s"',
1169
self.checker_command, exc_info=error)
1170
return True # Try again later
535
# In case checker_command has exactly one % operator
536
command = self.checker_command % self.host
538
# Escape attributes for the shell
539
escaped_attrs = dict(
541
re.escape(unicode(str(getattr(self, attr, "")),
545
self.runtime_expansions)
548
command = self.checker_command % escaped_attrs
549
except TypeError as error:
550
logger.error('Could not format string "%s":'
551
' %s', self.checker_command, error)
552
return True # Try again later
1171
553
self.current_checker_command = command
1172
log.info("Starting checker %r for %s", command, self.name)
1173
# We don't need to redirect stdout and stderr, since
1174
# in normal mode, that is already done by daemon(),
1175
# and in debug mode we don't want to. (Stdin is
1176
# always replaced by /dev/null.)
1177
# The exception is when not debugging but nevertheless
1178
# running in the foreground; use the previously
1180
popen_args = {"close_fds": True,
1183
if (not self.server_settings["debug"]
1184
and self.server_settings["foreground"]):
1185
popen_args.update({"stdout": wnull,
1187
pipe = multiprocessing.Pipe(duplex=False)
1188
self.checker = multiprocessing.Process(
1190
args=(pipe[1], subprocess.call, command),
1192
self.checker.start()
1193
self.checker_callback_tag = GLib.io_add_watch(
1194
GLib.IOChannel.unix_new(pipe[0].fileno()),
1195
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1196
self.checker_callback, pipe[0], command)
1197
# Re-run this periodically if run by GLib.timeout_add
555
logger.info("Starting checker %r for %s",
557
# We don't need to redirect stdout and stderr, since
558
# in normal mode, that is already done by daemon(),
559
# and in debug mode we don't want to. (Stdin is
560
# always replaced by /dev/null.)
561
self.checker = subprocess.Popen(command,
564
self.checker_callback_tag = (gobject.child_watch_add
566
self.checker_callback,
568
# The checker may have completed before the gobject
569
# watch was added. Check for this.
570
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
572
gobject.source_remove(self.checker_callback_tag)
573
self.checker_callback(pid, status, command)
574
except OSError as error:
575
logger.error("Failed to start subprocess: %s",
577
# Re-run this periodically if run by gobject.timeout_add
1200
580
def stop_checker(self):
1201
581
"""Force the checker process, if any, to stop."""
1202
582
if self.checker_callback_tag:
1203
GLib.source_remove(self.checker_callback_tag)
583
gobject.source_remove(self.checker_callback_tag)
1204
584
self.checker_callback_tag = None
1205
585
if getattr(self, "checker", None) is None:
1207
log.debug("Stopping checker for %(name)s", vars(self))
1208
self.checker.terminate()
587
logger.debug("Stopping checker for %(name)s", vars(self))
589
os.kill(self.checker.pid, signal.SIGTERM)
591
#if self.checker.poll() is None:
592
# os.kill(self.checker.pid, signal.SIGKILL)
593
except OSError as error:
594
if error.errno != errno.ESRCH: # No such process
1209
596
self.checker = None
1212
def dbus_service_property(dbus_interface,
598
# Encrypts a client secret and stores it in a varible encrypted_secret
599
def encrypt_secret(self, key):
600
# Encryption-key need to be of a specific size, so we hash inputed key
601
hasheng = hashlib.sha256()
603
encryptionkey = hasheng.digest()
605
# Create validation hash so we know at decryption if it was sucessful
606
hasheng = hashlib.sha256()
607
hasheng.update(self.secret)
608
validationhash = hasheng.digest()
611
iv = os.urandom(Crypto.Cipher.AES.block_size)
612
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
613
Crypto.Cipher.AES.MODE_CFB, iv)
614
ciphertext = ciphereng.encrypt(validationhash+self.secret)
615
self.encrypted_secret = (ciphertext, iv)
617
# Decrypt a encrypted client secret
618
def decrypt_secret(self, key):
619
# Decryption-key need to be of a specific size, so we hash inputed key
620
hasheng = hashlib.sha256()
622
encryptionkey = hasheng.digest()
624
# Decrypt encrypted secret
625
ciphertext, iv = self.encrypted_secret
626
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
627
Crypto.Cipher.AES.MODE_CFB, iv)
628
plain = ciphereng.decrypt(ciphertext)
630
# Validate decrypted secret to know if it was succesful
631
hasheng = hashlib.sha256()
632
validationhash = plain[:hasheng.digest_size]
633
secret = plain[hasheng.digest_size:]
634
hasheng.update(secret)
636
# if validation fails, we use key as new secret. Otherwhise, we use
637
# the decrypted secret
638
if hasheng.digest() == validationhash:
642
del self.encrypted_secret
645
def dbus_service_property(dbus_interface, signature="v",
646
access="readwrite", byte_arrays=False):
1216
647
"""Decorators for marking methods of a DBusObjectWithProperties to
1217
648
become properties on the D-Bus.
1219
650
The decorated method will be called with no arguments by "Get"
1220
651
and with one argument by "Set".
1222
653
The parameters, where they are supported, are the same as
1223
654
dbus.service.method, except there is only "signature", since the
1224
655
type from Get() and the type sent to Set() is the same.
1555
824
document.unlink()
1556
825
except (AttributeError, xml.dom.DOMException,
1557
826
xml.parsers.expat.ExpatError) as error:
1558
log.error("Failed to override Introspection method",
1564
dbus.OBJECT_MANAGER_IFACE
1565
except AttributeError:
1566
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1569
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1570
"""A D-Bus object with an ObjectManager.
1572
Classes inheriting from this exposes the standard
1573
GetManagedObjects call and the InterfacesAdded and
1574
InterfacesRemoved signals on the standard
1575
"org.freedesktop.DBus.ObjectManager" interface.
1577
Note: No signals are sent automatically; they must be sent
1580
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1581
out_signature="a{oa{sa{sv}}}")
1582
def GetManagedObjects(self):
1583
"""This function must be overridden"""
1584
raise NotImplementedError()
1586
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1587
signature="oa{sa{sv}}")
1588
def InterfacesAdded(self, object_path, interfaces_and_properties):
1591
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1592
def InterfacesRemoved(self, object_path, interfaces):
1595
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1597
path_keyword="object_path",
1598
connection_keyword="connection")
1599
def Introspect(self, object_path, connection):
1600
"""Overloading of standard D-Bus method.
1602
Override return argument name of GetManagedObjects to be
1603
"objpath_interfaces_and_properties"
1605
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1609
document = xml.dom.minidom.parseString(xmlstring)
1611
for if_tag in document.getElementsByTagName("interface"):
1612
# Fix argument name for the GetManagedObjects method
1613
if (if_tag.getAttribute("name")
1614
== dbus.OBJECT_MANAGER_IFACE):
1615
for cn in if_tag.getElementsByTagName("method"):
1616
if (cn.getAttribute("name")
1617
== "GetManagedObjects"):
1618
for arg in cn.getElementsByTagName("arg"):
1619
if (arg.getAttribute("direction")
1623
"objpath_interfaces"
1625
xmlstring = document.toxml("utf-8")
1627
except (AttributeError, xml.dom.DOMException,
1628
xml.parsers.expat.ExpatError) as error:
1629
log.error("Failed to override Introspection method",
1634
def datetime_to_dbus(dt, variant_level=0):
827
logger.error("Failed to override Introspection method",
832
def datetime_to_dbus (dt, variant_level=0):
1635
833
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1637
return dbus.String("", variant_level=variant_level)
1638
return dbus.String(dt.isoformat(), variant_level=variant_level)
1641
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1642
"""A class decorator; applied to a subclass of
1643
dbus.service.Object, it will add alternate D-Bus attributes with
1644
interface names according to the "alt_interface_names" mapping.
1647
@alternate_dbus_interfaces({"org.example.Interface":
1648
"net.example.AlternateInterface"})
1649
class SampleDBusObject(dbus.service.Object):
1650
@dbus.service.method("org.example.Interface")
1651
def SampleDBusMethod():
1654
The above "SampleDBusMethod" on "SampleDBusObject" will be
1655
reachable via two interfaces: "org.example.Interface" and
1656
"net.example.AlternateInterface", the latter of which will have
1657
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1658
"true", unless "deprecate" is passed with a False value.
1660
This works for methods and signals, and also for D-Bus properties
1661
(from DBusObjectWithProperties) and interfaces (from the
1662
dbus_interface_annotations decorator).
835
return dbus.String("", variant_level = variant_level)
836
return dbus.String(dt.isoformat(),
837
variant_level=variant_level)
839
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
841
"""Applied to an empty subclass of a D-Bus object, this metaclass
842
will add additional D-Bus attributes matching a certain pattern.
1666
for orig_interface_name, alt_interface_name in (
1667
alt_interface_names.items()):
1669
interface_names = set()
1670
# Go though all attributes of the class
1671
for attrname, attribute in inspect.getmembers(cls):
844
def __new__(mcs, name, bases, attr):
845
# Go through all the base classes which could have D-Bus
846
# methods, signals, or properties in them
847
for base in (b for b in bases
848
if issubclass(b, dbus.service.Object)):
849
# Go though all attributes of the base class
850
for attrname, attribute in inspect.getmembers(base):
1672
851
# Ignore non-D-Bus attributes, and D-Bus attributes
1673
852
# with the wrong interface name
1674
853
if (not hasattr(attribute, "_dbus_interface")
1675
or not attribute._dbus_interface.startswith(
1676
orig_interface_name)):
854
or not attribute._dbus_interface
855
.startswith("se.recompile.Mandos")):
1678
857
# Create an alternate D-Bus interface name based on
1679
858
# the current name
1680
alt_interface = attribute._dbus_interface.replace(
1681
orig_interface_name, alt_interface_name)
1682
interface_names.add(alt_interface)
859
alt_interface = (attribute._dbus_interface
860
.replace("se.recompile.Mandos",
861
"se.bsnet.fukt.Mandos"))
1683
862
# Is this a D-Bus signal?
1684
863
if getattr(attribute, "_dbus_is_signal", False):
1685
# Extract the original non-method undecorated
1686
# function by black magic
1687
if sys.version_info.major == 2:
1688
nonmethod_func = (dict(
864
# Extract the original non-method function by
866
nonmethod_func = (dict(
1689
867
zip(attribute.func_code.co_freevars,
1690
attribute.__closure__))
1691
["func"].cell_contents)
1693
nonmethod_func = (dict(
1694
zip(attribute.__code__.co_freevars,
1695
attribute.__closure__))
1696
["func"].cell_contents)
868
attribute.__closure__))["func"]
1697
870
# Create a new, but exactly alike, function
1698
871
# object, and decorate it to be a new D-Bus signal
1699
872
# with the alternate D-Bus interface name
1700
new_function = copy_function(nonmethod_func)
1701
new_function = (dbus.service.signal(
1703
attribute._dbus_signature)(new_function))
1704
# Copy annotations, if any
1706
new_function._dbus_annotations = dict(
1707
attribute._dbus_annotations)
1708
except AttributeError:
873
new_function = (dbus.service.signal
875
attribute._dbus_signature)
877
nonmethod_func.func_code,
878
nonmethod_func.func_globals,
879
nonmethod_func.func_name,
880
nonmethod_func.func_defaults,
881
nonmethod_func.func_closure)))
1711
882
# Define a creator of a function to call both the
1712
# original and alternate functions, so both the
1713
# original and alternate signals gets sent when
1714
# the function is called
883
# old and new functions, so both the old and new
884
# signals gets sent when the function is called
1715
885
def fixscope(func1, func2):
1716
886
"""This function is a scope container to pass
1717
887
func1 and func2 to the "call_both" function
1718
888
outside of its arguments"""
1720
@functools.wraps(func2)
1721
889
def call_both(*args, **kwargs):
1722
890
"""This function will emit two D-Bus
1723
891
signals by calling func1 and func2"""
1724
892
func1(*args, **kwargs)
1725
893
func2(*args, **kwargs)
1726
# Make wrapper function look like a D-Bus
1728
for name, attr in inspect.getmembers(func2):
1729
if name.startswith("_dbus_"):
1730
setattr(call_both, name, attr)
1732
894
return call_both
1733
895
# Create the "call_both" function and add it to
1735
attr[attrname] = fixscope(attribute, new_function)
897
attr[attrname] = fixscope(attribute,
1736
899
# Is this a D-Bus method?
1737
900
elif getattr(attribute, "_dbus_is_method", False):
1738
901
# Create a new, but exactly alike, function
1739
902
# object. Decorate it to be a new D-Bus method
1740
903
# with the alternate D-Bus interface name. Add it
1743
dbus.service.method(
1745
attribute._dbus_in_signature,
1746
attribute._dbus_out_signature)
1747
(copy_function(attribute)))
1748
# Copy annotations, if any
1750
attr[attrname]._dbus_annotations = dict(
1751
attribute._dbus_annotations)
1752
except AttributeError:
905
attr[attrname] = (dbus.service.method
907
attribute._dbus_in_signature,
908
attribute._dbus_out_signature)
910
(attribute.func_code,
911
attribute.func_globals,
913
attribute.func_defaults,
914
attribute.func_closure)))
1754
915
# Is this a D-Bus property?
1755
916
elif getattr(attribute, "_dbus_is_property", False):
1756
917
# Create a new, but exactly alike, function
1757
918
# object, and decorate it to be a new D-Bus
1758
919
# property with the alternate D-Bus interface
1759
920
# name. Add it to the class.
1760
attr[attrname] = (dbus_service_property(
1761
alt_interface, attribute._dbus_signature,
1762
attribute._dbus_access,
1763
attribute._dbus_get_args_options
1765
(copy_function(attribute)))
1766
# Copy annotations, if any
1768
attr[attrname]._dbus_annotations = dict(
1769
attribute._dbus_annotations)
1770
except AttributeError:
1772
# Is this a D-Bus interface?
1773
elif getattr(attribute, "_dbus_is_interface", False):
1774
# Create a new, but exactly alike, function
1775
# object. Decorate it to be a new D-Bus interface
1776
# with the alternate D-Bus interface name. Add it
1779
dbus_interface_annotations(alt_interface)
1780
(copy_function(attribute)))
1782
# Deprecate all alternate interfaces
1783
iname = "_AlternateDBusNames_interface_annotation{}"
1784
for interface_name in interface_names:
1786
@dbus_interface_annotations(interface_name)
1788
return {"org.freedesktop.DBus.Deprecated":
1790
# Find an unused name
1791
for aname in (iname.format(i)
1792
for i in itertools.count()):
1793
if aname not in attr:
1797
# Replace the class with a new subclass of it with
1798
# methods, signals, etc. as created above.
1799
if sys.version_info.major == 2:
1800
cls = type(b"{}Alternate".format(cls.__name__),
1803
cls = type("{}Alternate".format(cls.__name__),
1810
@alternate_dbus_interfaces({"se.recompile.Mandos":
1811
"se.bsnet.fukt.Mandos"})
921
attr[attrname] = (dbus_service_property
923
attribute._dbus_signature,
924
attribute._dbus_access,
926
._dbus_get_args_options
929
(attribute.func_code,
930
attribute.func_globals,
932
attribute.func_defaults,
933
attribute.func_closure)))
934
return type.__new__(mcs, name, bases, attr)
1812
936
class ClientDBus(Client, DBusObjectWithProperties):
1813
937
"""A Client class using D-Bus
1816
940
dbus_object_path: dbus.ObjectPath
1817
941
bus: dbus.SystemBus()
1820
944
runtime_expansions = (Client.runtime_expansions
1821
+ ("dbus_object_path", ))
1823
_interface = "se.recompile.Mandos.Client"
945
+ ("dbus_object_path",))
1825
947
# dbus.service.Object doesn't use super(), so we can't either.
1827
def __init__(self, bus=None, *args, **kwargs):
949
def __init__(self, bus = None, *args, **kwargs):
1829
951
Client.__init__(self, *args, **kwargs)
953
self._approvals_pending = 0
1830
954
# Only now, when this client is initialized, can it show up on
1832
client_object_name = str(self.name).translate(
956
client_object_name = unicode(self.name).translate(
1833
957
{ord("."): ord("_"),
1834
958
ord("-"): ord("_")})
1835
self.dbus_object_path = dbus.ObjectPath(
1836
"/clients/" + client_object_name)
959
self.dbus_object_path = (dbus.ObjectPath
960
("/clients/" + client_object_name))
1837
961
DBusObjectWithProperties.__init__(self, self.bus,
1838
962
self.dbus_object_path)
1840
def notifychangeproperty(transform_func, dbus_name,
1841
type_func=lambda x: x,
1843
invalidate_only=False,
1844
_interface=_interface):
964
def notifychangeproperty(transform_func,
965
dbus_name, type_func=lambda x: x,
1845
967
""" Modify a variable so that it's a property which announces
1846
968
its changes to DBus.
2241
1328
self.start_checker()
2243
1330
self.stop_checker()
2245
1332
# ObjectPath - property
2247
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2248
"org.freedesktop.DBus.Deprecated": "true"})
2249
1333
@dbus_service_property(_interface, signature="o", access="read")
2250
1334
def ObjectPath_dbus_property(self):
2251
return self.dbus_object_path # is already a dbus.ObjectPath
1335
return self.dbus_object_path # is already a dbus.ObjectPath
2253
1337
# Secret = property
2255
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2257
@dbus_service_property(_interface,
1338
@dbus_service_property(_interface, signature="ay",
1339
access="write", byte_arrays=True)
2261
1340
def Secret_dbus_property(self, value):
2262
self.secret = bytes(value)
1341
self.secret = str(value)
2268
def __init__(self, child_pipe, key_id, fpr, address):
1346
class ProxyClient(object):
1347
def __init__(self, child_pipe, fpr, address):
2269
1348
self._pipe = child_pipe
2270
self._pipe.send(("init", key_id, fpr, address))
1349
self._pipe.send(('init', fpr, address))
2271
1350
if not self._pipe.recv():
2272
raise KeyError(key_id or fpr)
2274
1353
def __getattribute__(self, name):
1354
if(name == '_pipe'):
2276
1355
return super(ProxyClient, self).__getattribute__(name)
2277
self._pipe.send(("getattr", name))
1356
self._pipe.send(('getattr', name))
2278
1357
data = self._pipe.recv()
2279
if data[0] == "data":
1358
if data[0] == 'data':
2281
if data[0] == "function":
1360
if data[0] == 'function':
2283
1361
def func(*args, **kwargs):
2284
self._pipe.send(("funcall", name, args, kwargs))
1362
self._pipe.send(('funcall', name, args, kwargs))
2285
1363
return self._pipe.recv()[1]
2289
1366
def __setattr__(self, name, value):
1367
if(name == '_pipe'):
2291
1368
return super(ProxyClient, self).__setattr__(name, value)
2292
self._pipe.send(("setattr", name, value))
1369
self._pipe.send(('setattr', name, value))
1371
class ClientDBusTransitional(ClientDBus):
1372
__metaclass__ = AlternateDBusNamesMetaclass
2295
1374
class ClientHandler(socketserver.BaseRequestHandler, object):
2296
1375
"""A class to handle client connections.
2298
1377
Instantiated once for each connection to handle it.
2299
1378
Note: This will run in its own forked process."""
2301
1380
def handle(self):
2302
1381
with contextlib.closing(self.server.child_pipe) as child_pipe:
2303
log.info("TCP connection from: %s",
2304
str(self.client_address))
2305
log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2307
session = gnutls.ClientSession(self.request)
2309
# priority = ":".join(("NONE", "+VERS-TLS1.1",
2310
# "+AES-256-CBC", "+SHA1",
2311
# "+COMP-NULL", "+CTYPE-OPENPGP",
1382
logger.info("TCP connection from: %s",
1383
unicode(self.client_address))
1384
logger.debug("Pipe FD: %d",
1385
self.server.child_pipe.fileno())
1387
session = (gnutls.connection
1388
.ClientSession(self.request,
1390
.X509Credentials()))
1392
# Note: gnutls.connection.X509Credentials is really a
1393
# generic GnuTLS certificate credentials object so long as
1394
# no X.509 keys are added to it. Therefore, we can use it
1395
# here despite using OpenPGP certificates.
1397
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1398
# "+AES-256-CBC", "+SHA1",
1399
# "+COMP-NULL", "+CTYPE-OPENPGP",
2313
1401
# Use a fallback default, since this MUST be set.
2314
1402
priority = self.server.gnutls_priority
2315
1403
if priority is None:
2316
1404
priority = "NORMAL"
2317
gnutls.priority_set_direct(session,
2318
priority.encode("utf-8"), None)
1405
(gnutls.library.functions
1406
.gnutls_priority_set_direct(session._c_object,
2320
1409
# Start communication using the Mandos protocol
2321
1410
# Get protocol number
2322
1411
line = self.request.makefile().readline()
2323
log.debug("Protocol version: %r", line)
1412
logger.debug("Protocol version: %r", line)
2325
1414
if int(line.strip().split()[0]) > 1:
2326
raise RuntimeError(line)
2327
1416
except (ValueError, IndexError, RuntimeError) as error:
2328
log.error("Unknown protocol version: %s", error)
1417
logger.error("Unknown protocol version: %s", error)
2331
1420
# Start GnuTLS connection
2333
1422
session.handshake()
2334
except gnutls.Error as error:
2335
log.warning("Handshake failed: %s", error)
1423
except gnutls.errors.GNUTLSError as error:
1424
logger.warning("Handshake failed: %s", error)
2336
1425
# Do not run session.bye() here: the session is not
2337
1426
# established. Just abandon the request.
2339
log.debug("Handshake succeeded")
1428
logger.debug("Handshake succeeded")
2341
1430
approval_required = False
2343
if gnutls.has_rawpk:
2346
key_id = self.key_id(
2347
self.peer_certificate(session))
2348
except (TypeError, gnutls.Error) as error:
2349
log.warning("Bad certificate: %s", error)
2351
log.debug("Key ID: %s",
2352
key_id.decode("utf-8",
2358
fpr = self.fingerprint(
2359
self.peer_certificate(session))
2360
except (TypeError, gnutls.Error) as error:
2361
log.warning("Bad certificate: %s", error)
2363
log.debug("Fingerprint: %s", fpr)
2366
client = ProxyClient(child_pipe, key_id, fpr,
1433
fpr = self.fingerprint(self.peer_certificate
1436
gnutls.errors.GNUTLSError) as error:
1437
logger.warning("Bad certificate: %s", error)
1439
logger.debug("Fingerprint: %s", fpr)
1440
if self.server.use_dbus:
1442
client.NewRequest(str(self.client_address))
1445
client = ProxyClient(child_pipe, fpr,
2367
1446
self.client_address)
2368
1447
except KeyError:
2371
1450
if client.approval_delay:
2372
1451
delay = client.approval_delay
2373
1452
client.approvals_pending += 1
2374
1453
approval_required = True
2377
1456
if not client.enabled:
2378
log.info("Client %s is disabled", client.name)
1457
logger.info("Client %s is disabled",
2379
1459
if self.server.use_dbus:
2380
1460
# Emit D-Bus signal
2381
1461
client.Rejected("Disabled")
2384
if client.approved or not client.approval_delay:
2385
# We are approved or approval is disabled
1464
if client._approved or not client.approval_delay:
1465
#We are approved or approval is disabled
2387
elif client.approved is None:
2388
log.info("Client %s needs approval",
1467
elif client._approved is None:
1468
logger.info("Client %s needs approval",
2390
1470
if self.server.use_dbus:
2391
1471
# Emit D-Bus signal
2392
1472
client.NeedApproval(
2393
client.approval_delay.total_seconds()
2394
* 1000, client.approved_by_default)
1473
client.approval_delay_milliseconds(),
1474
client.approved_by_default)
2396
log.warning("Client %s was not approved",
1476
logger.warning("Client %s was not approved",
2398
1478
if self.server.use_dbus:
2399
1479
# Emit D-Bus signal
2400
1480
client.Rejected("Denied")
2403
# wait until timeout or approved
1483
#wait until timeout or approved
2404
1484
time = datetime.datetime.now()
2405
1485
client.changedstate.acquire()
2406
client.changedstate.wait(delay.total_seconds())
1486
(client.changedstate.wait
1487
(float(client._timedelta_to_milliseconds(delay)
2407
1489
client.changedstate.release()
2408
1490
time2 = datetime.datetime.now()
2409
1491
if (time2 - time) >= delay:
2410
1492
if not client.approved_by_default:
2411
log.warning("Client %s timed out while"
2412
" waiting for approval",
1493
logger.warning("Client %s timed out while"
1494
" waiting for approval",
2414
1496
if self.server.use_dbus:
2415
1497
# Emit D-Bus signal
2416
1498
client.Rejected("Approval timed out")
2421
1503
delay -= time2 - time
2424
session.send(client.secret)
2425
except gnutls.Error as error:
2426
log.warning("gnutls send failed", exc_info=error)
2429
log.info("Sending secret to %s", client.name)
1506
while sent_size < len(client.secret):
1508
sent = session.send(client.secret[sent_size:])
1509
except gnutls.errors.GNUTLSError as error:
1510
logger.warning("gnutls send failed")
1512
logger.debug("Sent: %d, remaining: %d",
1513
sent, len(client.secret)
1514
- (sent_size + sent))
1517
logger.info("Sending secret to %s", client.name)
2430
1518
# bump the timeout using extended_timeout
2431
client.bump_timeout(client.extended_timeout)
1519
client.checked_ok(client.extended_timeout)
2432
1520
if self.server.use_dbus:
2433
1521
# Emit D-Bus signal
2434
1522
client.GotSecret()
2437
1525
if approval_required:
2438
1526
client.approvals_pending -= 1
2441
except gnutls.Error as error:
2442
log.warning("GnuTLS bye failed", exc_info=error)
1529
except gnutls.errors.GNUTLSError as error:
1530
logger.warning("GnuTLS bye failed")
2445
1533
def peer_certificate(session):
2446
"Return the peer's certificate as a bytestring"
2448
cert_type = gnutls.certificate_type_get2(
2449
session, gnutls.CTYPE_PEERS)
2450
except AttributeError:
2451
cert_type = gnutls.certificate_type_get(session)
2452
if gnutls.has_rawpk:
2453
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2455
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2456
# If not a valid certificate type...
2457
if cert_type not in valid_cert_types:
2458
log.info("Cert type %r not in %r", cert_type,
2460
# ...return invalid data
1534
"Return the peer's OpenPGP certificate as a bytestring"
1535
# If not an OpenPGP certificate...
1536
if (gnutls.library.functions
1537
.gnutls_certificate_type_get(session._c_object)
1538
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1539
# ...do the normal thing
1540
return session.peer_certificate
2462
1541
list_size = ctypes.c_uint(1)
2463
cert_list = (gnutls.certificate_get_peers
2464
(session, ctypes.byref(list_size)))
1542
cert_list = (gnutls.library.functions
1543
.gnutls_certificate_get_peers
1544
(session._c_object, ctypes.byref(list_size)))
2465
1545
if not bool(cert_list) and list_size.value != 0:
2466
raise gnutls.Error("error getting peer certificate")
1546
raise gnutls.errors.GNUTLSError("error getting peer"
2467
1548
if list_size.value == 0:
2469
1550
cert = cert_list[0]
2470
1551
return ctypes.string_at(cert.data, cert.size)
2473
def key_id(certificate):
2474
"Convert a certificate bytestring to a hexdigit key ID"
2475
# New GnuTLS "datum" with the public key
2476
datum = gnutls.datum_t(
2477
ctypes.cast(ctypes.c_char_p(certificate),
2478
ctypes.POINTER(ctypes.c_ubyte)),
2479
ctypes.c_uint(len(certificate)))
2480
# XXX all these need to be created in the gnutls "module"
2481
# New empty GnuTLS certificate
2482
pubkey = gnutls.pubkey_t()
2483
gnutls.pubkey_init(ctypes.byref(pubkey))
2484
# Import the raw public key into the certificate
2485
gnutls.pubkey_import(pubkey,
2486
ctypes.byref(datum),
2487
gnutls.X509_FMT_DER)
2488
# New buffer for the key ID
2489
buf = ctypes.create_string_buffer(32)
2490
buf_len = ctypes.c_size_t(len(buf))
2491
# Get the key ID from the raw public key into the buffer
2492
gnutls.pubkey_get_key_id(
2494
gnutls.KEYID_USE_SHA256,
2495
ctypes.cast(ctypes.byref(buf),
2496
ctypes.POINTER(ctypes.c_ubyte)),
2497
ctypes.byref(buf_len))
2498
# Deinit the certificate
2499
gnutls.pubkey_deinit(pubkey)
2501
# Convert the buffer to a Python bytestring
2502
key_id = ctypes.string_at(buf, buf_len.value)
2503
# Convert the bytestring to hexadecimal notation
2504
hex_key_id = binascii.hexlify(key_id).upper()
2508
1554
def fingerprint(openpgp):
2509
1555
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2510
1556
# New GnuTLS "datum" with the OpenPGP public key
2511
datum = gnutls.datum_t(
2512
ctypes.cast(ctypes.c_char_p(openpgp),
2513
ctypes.POINTER(ctypes.c_ubyte)),
2514
ctypes.c_uint(len(openpgp)))
1557
datum = (gnutls.library.types
1558
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1561
ctypes.c_uint(len(openpgp))))
2515
1562
# New empty GnuTLS certificate
2516
crt = gnutls.openpgp_crt_t()
2517
gnutls.openpgp_crt_init(ctypes.byref(crt))
1563
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1564
(gnutls.library.functions
1565
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2518
1566
# Import the OpenPGP public key into the certificate
2519
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2520
gnutls.OPENPGP_FMT_RAW)
1567
(gnutls.library.functions
1568
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1569
gnutls.library.constants
1570
.GNUTLS_OPENPGP_FMT_RAW))
2521
1571
# Verify the self signature in the key
2522
1572
crtverify = ctypes.c_uint()
2523
gnutls.openpgp_crt_verify_self(crt, 0,
2524
ctypes.byref(crtverify))
1573
(gnutls.library.functions
1574
.gnutls_openpgp_crt_verify_self(crt, 0,
1575
ctypes.byref(crtverify)))
2525
1576
if crtverify.value != 0:
2526
gnutls.openpgp_crt_deinit(crt)
2527
raise gnutls.CertificateSecurityError(code
1577
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1578
raise (gnutls.errors.CertificateSecurityError
2529
1580
# New buffer for the fingerprint
2530
1581
buf = ctypes.create_string_buffer(20)
2531
1582
buf_len = ctypes.c_size_t()
2532
1583
# Get the fingerprint from the certificate into the buffer
2533
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2534
ctypes.byref(buf_len))
1584
(gnutls.library.functions
1585
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1586
ctypes.byref(buf_len)))
2535
1587
# Deinit the certificate
2536
gnutls.openpgp_crt_deinit(crt)
1588
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2537
1589
# Convert the buffer to a Python bytestring
2538
1590
fpr = ctypes.string_at(buf, buf_len.value)
2539
1591
# Convert the bytestring to hexadecimal notation
2540
hex_fpr = binascii.hexlify(fpr).upper()
1592
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2544
class MultiprocessingMixIn:
1596
class MultiprocessingMixIn(object):
2545
1597
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2547
1598
def sub_process_main(self, request, address):
2549
1600
self.finish_request(request, address)
2551
1602
self.handle_error(request, address)
2552
1603
self.close_request(request)
2554
1605
def process_request(self, request, address):
2555
1606
"""Start a new process to process the request."""
2556
proc = multiprocessing.Process(target=self.sub_process_main,
2557
args=(request, address))
1607
proc = multiprocessing.Process(target = self.sub_process_main,
2562
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1614
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2563
1615
""" adds a pipe to the MixIn """
2565
1616
def process_request(self, request, client_address):
2566
1617
"""Overrides and wraps the original process_request().
2568
1619
This function creates a new pipe in self.pipe
2570
1621
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2572
1623
proc = MultiprocessingMixIn.process_request(self, request,
2573
1624
client_address)
2574
1625
self.child_pipe.close()
2575
1626
self.add_pipe(parent_pipe, proc)
2577
1628
def add_pipe(self, parent_pipe, proc):
2578
1629
"""Dummy function; override as necessary"""
2579
raise NotImplementedError()
1630
raise NotImplementedError
2582
1633
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2583
socketserver.TCPServer):
2584
"""IPv6-capable TCP server. Accepts None as address and/or port
1634
socketserver.TCPServer, object):
1635
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2587
1638
enabled: Boolean; whether this server is activated yet
2588
1639
interface: None or a network interface name (string)
2589
1640
use_ipv6: Boolean; to use IPv6 or not
2592
1642
def __init__(self, server_address, RequestHandlerClass,
2596
"""If socketfd is set, use that file descriptor instead of
2597
creating a new one with socket.socket().
1643
interface=None, use_ipv6=True):
2599
1644
self.interface = interface
2601
1646
self.address_family = socket.AF_INET6
2602
if socketfd is not None:
2603
# Save the file descriptor
2604
self.socketfd = socketfd
2605
# Save the original socket.socket() function
2606
self.socket_socket = socket.socket
2608
# To implement --socket, we monkey patch socket.socket.
2610
# (When socketserver.TCPServer is a new-style class, we
2611
# could make self.socket into a property instead of monkey
2612
# patching socket.socket.)
2614
# Create a one-time-only replacement for socket.socket()
2615
@functools.wraps(socket.socket)
2616
def socket_wrapper(*args, **kwargs):
2617
# Restore original function so subsequent calls are
2619
socket.socket = self.socket_socket
2620
del self.socket_socket
2621
# This time only, return a new socket object from the
2622
# saved file descriptor.
2623
return socket.fromfd(self.socketfd, *args, **kwargs)
2624
# Replace socket.socket() function with wrapper
2625
socket.socket = socket_wrapper
2626
# The socketserver.TCPServer.__init__ will call
2627
# socket.socket(), which might be our replacement,
2628
# socket_wrapper(), if socketfd was set.
2629
1647
socketserver.TCPServer.__init__(self, server_address,
2630
1648
RequestHandlerClass)
2632
1649
def server_bind(self):
2633
1650
"""This overrides the normal server_bind() function
2634
1651
to bind to an interface if one was specified, and also NOT to
2635
1652
bind to an address or port if they were not specified."""
2636
global SO_BINDTODEVICE
2637
1653
if self.interface is not None:
2638
1654
if SO_BINDTODEVICE is None:
2639
# Fall back to a hard-coded value which seems to be
2641
log.warning("SO_BINDTODEVICE not found, trying 25")
2642
SO_BINDTODEVICE = 25
2644
self.socket.setsockopt(
2645
socket.SOL_SOCKET, SO_BINDTODEVICE,
2646
(self.interface + "\0").encode("utf-8"))
2647
except socket.error as error:
2648
if error.errno == errno.EPERM:
2649
log.error("No permission to bind to interface %s",
2651
elif error.errno == errno.ENOPROTOOPT:
2652
log.error("SO_BINDTODEVICE not available; cannot"
2653
" bind to interface %s", self.interface)
2654
elif error.errno == errno.ENODEV:
2655
log.error("Interface %s does not exist, cannot"
2656
" bind", self.interface)
1655
logger.error("SO_BINDTODEVICE does not exist;"
1656
" cannot bind to interface %s",
1660
self.socket.setsockopt(socket.SOL_SOCKET,
1664
except socket.error as error:
1665
if error[0] == errno.EPERM:
1666
logger.error("No permission to"
1667
" bind to interface %s",
1669
elif error[0] == errno.ENOPROTOOPT:
1670
logger.error("SO_BINDTODEVICE not available;"
1671
" cannot bind to interface %s",
2659
1675
# Only bind(2) the socket if we really need to.
2660
1676
if self.server_address[0] or self.server_address[1]:
2661
if self.server_address[1]:
2662
self.allow_reuse_address = True
2663
1677
if not self.server_address[0]:
2664
1678
if self.address_family == socket.AF_INET6:
2665
any_address = "::" # in6addr_any
1679
any_address = "::" # in6addr_any
2667
any_address = "0.0.0.0" # INADDR_ANY
1681
any_address = socket.INADDR_ANY
2668
1682
self.server_address = (any_address,
2669
1683
self.server_address[1])
2670
1684
elif not self.server_address[1]:
2671
self.server_address = (self.server_address[0], 0)
1685
self.server_address = (self.server_address[0],
2672
1687
# if self.interface:
2673
1688
# self.server_address = (self.server_address[0],
2704
1714
self.gnutls_priority = gnutls_priority
2705
1715
IPv6_TCPServer.__init__(self, server_address,
2706
1716
RequestHandlerClass,
2707
interface=interface,
1717
interface = interface,
1718
use_ipv6 = use_ipv6)
2711
1719
def server_activate(self):
2712
1720
if self.enabled:
2713
1721
return socketserver.TCPServer.server_activate(self)
2715
1723
def enable(self):
2716
1724
self.enabled = True
2718
1726
def add_pipe(self, parent_pipe, proc):
2719
1727
# Call "handle_ipc" for both data and EOF events
2721
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2722
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2723
functools.partial(self.handle_ipc,
2724
parent_pipe=parent_pipe,
2727
def handle_ipc(self, source, condition,
2730
client_object=None):
1728
gobject.io_add_watch(parent_pipe.fileno(),
1729
gobject.IO_IN | gobject.IO_HUP,
1730
functools.partial(self.handle_ipc,
1735
def handle_ipc(self, source, condition, parent_pipe=None,
1736
proc = None, client_object=None):
1738
gobject.IO_IN: "IN", # There is data to read.
1739
gobject.IO_OUT: "OUT", # Data can be written (without
1741
gobject.IO_PRI: "PRI", # There is urgent data to read.
1742
gobject.IO_ERR: "ERR", # Error condition.
1743
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1744
# broken, usually for pipes and
1747
conditions_string = ' | '.join(name
1749
condition_names.iteritems()
1750
if cond & condition)
2731
1751
# error, or the other end of multiprocessing.Pipe has closed
2732
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1752
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2733
1753
# Wait for other process to exit
2737
1757
# Read a request from the child
2738
1758
request = parent_pipe.recv()
2739
1759
command = request[0]
2741
if command == "init":
2742
key_id = request[1].decode("ascii")
2743
fpr = request[2].decode("ascii")
2744
address = request[3]
2746
for c in self.clients.values():
2747
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2748
"27AE41E4649B934CA495991B7852B855"):
2750
if key_id and c.key_id == key_id:
2753
if fpr and c.fingerprint == fpr:
1761
if command == 'init':
1763
address = request[2]
1765
for c in self.clients.itervalues():
1766
if c.fingerprint == fpr:
2757
log.info("Client not found for key ID: %s, address:"
2758
" %s", key_id or fpr, address)
1770
logger.info("Client not found for fingerprint: %s, ad"
1771
"dress: %s", fpr, address)
2759
1772
if self.use_dbus:
2760
1773
# Emit D-Bus signal
2761
mandos_dbus_service.ClientNotFound(key_id or fpr,
1774
mandos_dbus_service.ClientNotFound(fpr,
2763
1776
parent_pipe.send(False)
2767
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2768
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2769
functools.partial(self.handle_ipc,
2770
parent_pipe=parent_pipe,
2772
client_object=client))
1779
gobject.io_add_watch(parent_pipe.fileno(),
1780
gobject.IO_IN | gobject.IO_HUP,
1781
functools.partial(self.handle_ipc,
2773
1787
parent_pipe.send(True)
2774
1788
# remove the old hook in favor of the new above hook on
2777
if command == "funcall":
1791
if command == 'funcall':
2778
1792
funcname = request[1]
2779
1793
args = request[2]
2780
1794
kwargs = request[3]
2782
parent_pipe.send(("data", getattr(client_object,
1796
parent_pipe.send(('data', getattr(client_object,
2783
1797
funcname)(*args,
2786
if command == "getattr":
1800
if command == 'getattr':
2787
1801
attrname = request[1]
2788
if isinstance(client_object.__getattribute__(attrname),
2789
collections.abc.Callable):
2790
parent_pipe.send(("function", ))
1802
if callable(client_object.__getattribute__(attrname)):
1803
parent_pipe.send(('function',))
2793
"data", client_object.__getattribute__(attrname)))
2795
if command == "setattr":
1805
parent_pipe.send(('data', client_object
1806
.__getattribute__(attrname)))
1808
if command == 'setattr':
2796
1809
attrname = request[1]
2797
1810
value = request[2]
2798
1811
setattr(client_object, attrname, value)
2803
def rfc3339_duration_to_delta(duration):
2804
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2806
>>> timedelta = datetime.timedelta
2807
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2809
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2811
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2813
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2815
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2817
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2819
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2824
# Parsing an RFC 3339 duration with regular expressions is not
2825
# possible - there would have to be multiple places for the same
2826
# values, like seconds. The current code, while more esoteric, is
2827
# cleaner without depending on a parsing library. If Python had a
2828
# built-in library for parsing we would use it, but we'd like to
2829
# avoid excessive use of external libraries.
2831
# New type for defining tokens, syntax, and semantics all-in-one
2832
Token = collections.namedtuple("Token", (
2833
"regexp", # To match token; if "value" is not None, must have
2834
# a "group" containing digits
2835
"value", # datetime.timedelta or None
2836
"followers")) # Tokens valid after this token
2837
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2838
# the "duration" ABNF definition in RFC 3339, Appendix A.
2839
token_end = Token(re.compile(r"$"), None, frozenset())
2840
token_second = Token(re.compile(r"(\d+)S"),
2841
datetime.timedelta(seconds=1),
2842
frozenset((token_end, )))
2843
token_minute = Token(re.compile(r"(\d+)M"),
2844
datetime.timedelta(minutes=1),
2845
frozenset((token_second, token_end)))
2846
token_hour = Token(re.compile(r"(\d+)H"),
2847
datetime.timedelta(hours=1),
2848
frozenset((token_minute, token_end)))
2849
token_time = Token(re.compile(r"T"),
2851
frozenset((token_hour, token_minute,
2853
token_day = Token(re.compile(r"(\d+)D"),
2854
datetime.timedelta(days=1),
2855
frozenset((token_time, token_end)))
2856
token_month = Token(re.compile(r"(\d+)M"),
2857
datetime.timedelta(weeks=4),
2858
frozenset((token_day, token_end)))
2859
token_year = Token(re.compile(r"(\d+)Y"),
2860
datetime.timedelta(weeks=52),
2861
frozenset((token_month, token_end)))
2862
token_week = Token(re.compile(r"(\d+)W"),
2863
datetime.timedelta(weeks=1),
2864
frozenset((token_end, )))
2865
token_duration = Token(re.compile(r"P"), None,
2866
frozenset((token_year, token_month,
2867
token_day, token_time,
2869
# Define starting values:
2871
value = datetime.timedelta()
2873
# Following valid tokens
2874
followers = frozenset((token_duration, ))
2875
# String left to parse
2877
# Loop until end token is found
2878
while found_token is not token_end:
2879
# Search for any currently valid tokens
2880
for token in followers:
2881
match = token.regexp.match(s)
2882
if match is not None:
2884
if token.value is not None:
2885
# Value found, parse digits
2886
factor = int(match.group(1), 10)
2887
# Add to value so far
2888
value += factor * token.value
2889
# Strip token from string
2890
s = token.regexp.sub("", s, 1)
2893
# Set valid next tokens
2894
followers = found_token.followers
2897
# No currently valid tokens were found
2898
raise ValueError("Invalid RFC 3339 duration: {!r}"
2904
1816
def string_to_delta(interval):
2905
1817
"""Parse a string and return a datetime.timedelta
2907
>>> string_to_delta("7d") == datetime.timedelta(7)
2909
>>> string_to_delta("60s") == datetime.timedelta(0, 60)
2911
>>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2913
>>> string_to_delta("24h") == datetime.timedelta(1)
2915
>>> string_to_delta("1w") == datetime.timedelta(7)
2917
>>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
1819
>>> string_to_delta('7d')
1820
datetime.timedelta(7)
1821
>>> string_to_delta('60s')
1822
datetime.timedelta(0, 60)
1823
>>> string_to_delta('60m')
1824
datetime.timedelta(0, 3600)
1825
>>> string_to_delta('24h')
1826
datetime.timedelta(1)
1827
>>> string_to_delta('1w')
1828
datetime.timedelta(7)
1829
>>> string_to_delta('5m 30s')
1830
datetime.timedelta(0, 330)
2922
return rfc3339_duration_to_delta(interval)
2926
1832
timevalue = datetime.timedelta(0)
2927
1833
for s in interval.split():
1835
suffix = unicode(s[-1])
2930
1836
value = int(s[:-1])
2931
1837
if suffix == "d":
2932
1838
delta = datetime.timedelta(value)
3004
1934
parser.add_argument("--no-dbus", action="store_false",
3005
1935
dest="use_dbus", help="Do not provide D-Bus"
3006
" system bus interface", default=None)
1936
" system bus interface")
3007
1937
parser.add_argument("--no-ipv6", action="store_false",
3008
dest="use_ipv6", help="Do not use IPv6",
1938
dest="use_ipv6", help="Do not use IPv6")
3010
1939
parser.add_argument("--no-restore", action="store_false",
3011
dest="restore", help="Do not restore stored"
3012
" state", default=None)
3013
parser.add_argument("--socket", type=int,
3014
help="Specify a file descriptor to a network"
3015
" socket to use instead of creating one")
3016
parser.add_argument("--statedir", metavar="DIR",
3017
help="Directory to save/restore state in")
3018
parser.add_argument("--foreground", action="store_true",
3019
help="Run in foreground", default=None)
3020
parser.add_argument("--no-zeroconf", action="store_false",
3021
dest="zeroconf", help="Do not use Zeroconf",
1940
dest="restore", help="Do not restore stored state",
3024
1943
options = parser.parse_args()
3026
1950
# Default values for config file for server-global settings
3027
if gnutls.has_rawpk:
3028
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3029
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3031
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3032
":+SIGN-DSA-SHA256")
3033
server_defaults = {"interface": "",
3037
"priority": priority,
3038
"servicename": "Mandos",
3044
"statedir": "/var/lib/mandos",
3045
"foreground": "False",
1951
server_defaults = { "interface": "",
1956
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1957
"servicename": "Mandos",
3050
1963
# Parse config file for server-global settings
3051
server_config = configparser.ConfigParser(server_defaults)
1964
server_config = configparser.SafeConfigParser(server_defaults)
3052
1965
del server_defaults
3053
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3054
# Convert the ConfigParser object to a dict
1966
server_config.read(os.path.join(options.configdir,
1968
# Convert the SafeConfigParser object to a dict
3055
1969
server_settings = server_config.defaults()
3056
1970
# Use the appropriate methods on the non-string config options
3057
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3058
"foreground", "zeroconf"):
1971
for option in ("debug", "use_dbus", "use_ipv6"):
3059
1972
server_settings[option] = server_config.getboolean("DEFAULT",
3061
1974
if server_settings["port"]:
3062
1975
server_settings["port"] = server_config.getint("DEFAULT",
3064
if server_settings["socket"]:
3065
server_settings["socket"] = server_config.getint("DEFAULT",
3067
# Later, stdin will, and stdout and stderr might, be dup'ed
3068
# over with an opened os.devnull. But we don't want this to
3069
# happen with a supplied network socket.
3070
if 0 <= server_settings["socket"] <= 2:
3071
server_settings["socket"] = os.dup(server_settings
3073
1977
del server_config
3075
1979
# Override the settings from the config file with command line
3076
1980
# options, if set.
3077
1981
for option in ("interface", "address", "port", "debug",
3078
"priority", "servicename", "configdir", "use_dbus",
3079
"use_ipv6", "debuglevel", "restore", "statedir",
3080
"socket", "foreground", "zeroconf"):
1982
"priority", "servicename", "configdir",
1983
"use_dbus", "use_ipv6", "debuglevel", "restore"):
3081
1984
value = getattr(options, option)
3082
1985
if value is not None:
3083
1986
server_settings[option] = value
3085
1988
# Force all strings to be unicode
3086
1989
for option in server_settings.keys():
3087
if isinstance(server_settings[option], bytes):
3088
server_settings[option] = (server_settings[option]
3090
# Force all boolean options to be boolean
3091
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3092
"foreground", "zeroconf"):
3093
server_settings[option] = bool(server_settings[option])
3094
# Debug implies foreground
3095
if server_settings["debug"]:
3096
server_settings["foreground"] = True
1990
if type(server_settings[option]) is str:
1991
server_settings[option] = unicode(server_settings[option])
3097
1992
# Now we have our good server settings in "server_settings"
3099
1994
##################################################################
3101
if (not server_settings["zeroconf"]
3102
and not (server_settings["port"]
3103
or server_settings["socket"] != "")):
3104
parser.error("Needs port or socket to work without Zeroconf")
3106
1996
# For convenience
3107
1997
debug = server_settings["debug"]
3108
1998
debuglevel = server_settings["debuglevel"]
3109
1999
use_dbus = server_settings["use_dbus"]
3110
2000
use_ipv6 = server_settings["use_ipv6"]
3111
stored_state_path = os.path.join(server_settings["statedir"],
3113
foreground = server_settings["foreground"]
3114
zeroconf = server_settings["zeroconf"]
3117
initlogger(debug, logging.DEBUG)
2003
initlogger(logging.DEBUG)
3119
2005
if not debuglevel:
3122
2008
level = getattr(logging, debuglevel.upper())
3123
initlogger(debug, level)
3125
2011
if server_settings["servicename"] != "Mandos":
3126
syslogger.setFormatter(
3127
logging.Formatter("Mandos ({}) [%(process)d]:"
3128
" %(levelname)s: %(message)s".format(
3129
server_settings["servicename"])))
2012
syslogger.setFormatter(logging.Formatter
2013
('Mandos (%s) [%%(process)d]:'
2014
' %%(levelname)s: %%(message)s'
2015
% server_settings["servicename"]))
3131
2017
# Parse config file with clients
3132
client_config = configparser.ConfigParser(Client.client_defaults)
2018
client_defaults = { "timeout": "5m",
2019
"extended_timeout": "15m",
2021
"checker": "fping -q -- %%(host)s",
2023
"approval_delay": "0s",
2024
"approval_duration": "1s",
2026
client_config = configparser.SafeConfigParser(client_defaults)
3133
2027
client_config.read(os.path.join(server_settings["configdir"],
3134
2028
"clients.conf"))
3136
2030
global mandos_dbus_service
3137
2031
mandos_dbus_service = None
3140
if server_settings["socket"] != "":
3141
socketfd = server_settings["socket"]
3142
tcp_server = MandosServer(
3143
(server_settings["address"], server_settings["port"]),
3145
interface=(server_settings["interface"] or None),
3147
gnutls_priority=server_settings["priority"],
3151
pidfilename = "/run/mandos.pid"
3152
if not os.path.isdir("/run/."):
3153
pidfilename = "/var/run/mandos.pid"
3156
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3157
except IOError as e:
3158
log.error("Could not open file %r", pidfilename,
3161
for name, group in (("_mandos", "_mandos"),
3162
("mandos", "mandos"),
3163
("nobody", "nogroup")):
3165
uid = pwd.getpwnam(name).pw_uid
3166
gid = pwd.getpwnam(group).pw_gid
2033
tcp_server = MandosServer((server_settings["address"],
2034
server_settings["port"]),
2036
interface=(server_settings["interface"]
2040
server_settings["priority"],
2043
pidfilename = "/var/run/mandos.pid"
2045
pidfile = open(pidfilename, "w")
2047
logger.error("Could not open file %r", pidfilename)
2050
uid = pwd.getpwnam("_mandos").pw_uid
2051
gid = pwd.getpwnam("_mandos").pw_gid
2054
uid = pwd.getpwnam("mandos").pw_uid
2055
gid = pwd.getpwnam("mandos").pw_gid
3168
2056
except KeyError:
2058
uid = pwd.getpwnam("nobody").pw_uid
2059
gid = pwd.getpwnam("nobody").pw_gid
3176
log.debug("Did setuid/setgid to %s:%s", uid, gid)
3177
2066
except OSError as error:
3178
log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3179
os.strerror(error.errno))
3180
if error.errno != errno.EPERM:
2067
if error[0] != errno.EPERM:
3184
2071
# Enable all possible GnuTLS debugging
3186
2073
# "Use a log level over 10 to enable all debugging options."
3187
2074
# - GnuTLS manual
3188
gnutls.global_set_log_level(11)
2075
gnutls.library.functions.gnutls_global_set_log_level(11)
2077
@gnutls.library.types.gnutls_log_func
3191
2078
def debug_gnutls(level, string):
3192
log.debug("GnuTLS: %s",
3193
string[:-1].decode("utf-8", errors="replace"))
3195
gnutls.global_set_log_function(debug_gnutls)
2079
logger.debug("GnuTLS: %s", string[:-1])
2081
(gnutls.library.functions
2082
.gnutls_global_set_log_function(debug_gnutls))
3197
2084
# Redirect stdin so all checkers get /dev/null
3198
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2085
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3199
2086
os.dup2(null, sys.stdin.fileno())
2090
# No console logging
2091
logger.removeHandler(console)
3203
2093
# Need to fork before connecting to D-Bus
3205
2095
# Close all input and output, do double fork, etc.
3208
if gi.version_info < (3, 10, 2):
3209
# multiprocessing will use threads, so before we use GLib we
3210
# need to inform GLib that threads will be used.
3213
2098
global main_loop
3214
2099
# From the Avahi example code
3215
DBusGMainLoop(set_as_default=True)
3216
main_loop = GLib.MainLoop()
2100
DBusGMainLoop(set_as_default=True )
2101
main_loop = gobject.MainLoop()
3217
2102
bus = dbus.SystemBus()
3218
2103
# End of Avahi example code
3221
2106
bus_name = dbus.service.BusName("se.recompile.Mandos",
3224
old_bus_name = dbus.service.BusName(
3225
"se.bsnet.fukt.Mandos", bus,
3227
except dbus.exceptions.DBusException as e:
3228
log.error("Disabling D-Bus:", exc_info=e)
2107
bus, do_not_queue=True)
2108
old_bus_name = (dbus.service.BusName
2109
("se.bsnet.fukt.Mandos", bus,
2111
except dbus.exceptions.NameExistsException as e:
2112
logger.error(unicode(e) + ", disabling D-Bus")
3229
2113
use_dbus = False
3230
2114
server_settings["use_dbus"] = False
3231
2115
tcp_server.use_dbus = False
3233
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3234
service = AvahiServiceToSyslog(
3235
name=server_settings["servicename"],
3236
servicetype="_mandos._tcp",
3239
if server_settings["interface"]:
3240
service.interface = if_nametoindex(
3241
server_settings["interface"].encode("utf-8"))
2116
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2117
service = AvahiServiceToSyslog(name =
2118
server_settings["servicename"],
2119
servicetype = "_mandos._tcp",
2120
protocol = protocol, bus = bus)
2121
if server_settings["interface"]:
2122
service.interface = (if_nametoindex
2123
(str(server_settings["interface"])))
3243
2125
global multiprocessing_manager
3244
2126
multiprocessing_manager = multiprocessing.Manager()
3246
2128
client_class = Client
3248
client_class = functools.partial(ClientDBus, bus=bus)
3250
client_settings = Client.config_parser(client_config)
2130
client_class = functools.partial(ClientDBusTransitional,
2133
special_settings = {
2134
# Some settings need to be accessd by special methods;
2135
# booleans need .getboolean(), etc. Here is a list of them:
2136
"approved_by_default":
2138
client_config.getboolean(section, "approved_by_default"),
2140
# Construct a new dict of client settings of this form:
2141
# { client_name: {setting_name: value, ...}, ...}
2142
# with exceptions for any special settings as defined above
2143
client_settings = dict((clientname,
2145
(value if setting not in special_settings
2146
else special_settings[setting](clientname)))
2147
for setting, value in client_config.items(clientname)))
2148
for clientname in client_config.sections())
3251
2150
old_client_settings = {}
3254
# This is used to redirect stdout and stderr for checker processes
3256
wnull = open(os.devnull, "w") # A writable /dev/null
3257
# Only used if server is running in foreground but not in debug
3259
if debug or not foreground:
3262
# Get client data and settings from last running state.
2153
# Get client data and settings from last running state.
3263
2154
if server_settings["restore"]:
3265
2156
with open(stored_state_path, "rb") as stored_state:
3266
if sys.version_info.major == 2:
3267
clients_data, old_client_settings = pickle.load(
3270
bytes_clients_data, bytes_old_client_settings = (
3271
pickle.load(stored_state, encoding="bytes"))
3272
# Fix bytes to strings
3275
clients_data = {(key.decode("utf-8")
3276
if isinstance(key, bytes)
3279
bytes_clients_data.items()}
3280
del bytes_clients_data
3281
for key in clients_data:
3282
value = {(k.decode("utf-8")
3283
if isinstance(k, bytes) else k): v
3285
clients_data[key].items()}
3286
clients_data[key] = value
3288
value["client_structure"] = [
3290
if isinstance(s, bytes)
3292
value["client_structure"]]
3293
# .name, .host, and .checker_command
3294
for k in ("name", "host", "checker_command"):
3295
if isinstance(value[k], bytes):
3296
value[k] = value[k].decode("utf-8")
3297
if "key_id" not in value:
3298
value["key_id"] = ""
3299
elif "fingerprint" not in value:
3300
value["fingerprint"] = ""
3301
# old_client_settings
3303
old_client_settings = {
3304
(key.decode("utf-8")
3305
if isinstance(key, bytes)
3308
bytes_old_client_settings.items()}
3309
del bytes_old_client_settings
3310
# .host and .checker_command
3311
for value in old_client_settings.values():
3312
for attribute in ("host", "checker_command"):
3313
if isinstance(value[attribute], bytes):
3314
value[attribute] = (value[attribute]
2157
clients_data, old_client_settings = pickle.load(stored_state)
3316
2158
os.remove(stored_state_path)
3317
2159
except IOError as e:
3318
if e.errno == errno.ENOENT:
3319
log.warning("Could not load persistent state:"
3320
" %s", os.strerror(e.errno))
3322
log.critical("Could not load persistent state:",
2160
logger.warning("Could not load persistant state: {0}".format(e))
2161
if e.errno != errno.ENOENT:
3325
except EOFError as e:
3326
log.warning("Could not load persistent state: EOFError:",
3329
with PGPEngine() as pgp:
3330
for client_name, client in clients_data.items():
3331
# Skip removed clients
3332
if client_name not in client_settings:
3335
# Decide which value to use after restoring saved state.
3336
# We have three different values: Old config file,
3337
# new config file, and saved state.
3338
# New config value takes precedence if it differs from old
3339
# config value, otherwise use saved state.
3340
for name, value in client_settings[client_name].items():
3342
# For each value in new config, check if it
3343
# differs from the old config value (Except for
3344
# the "secret" attribute)
3345
if (name != "secret"
3347
old_client_settings[client_name][name])):
3348
client[name] = value
3352
# Clients who has passed its expire date can still be
3353
# enabled if its last checker was successful. A Client
3354
# whose checker succeeded before we stored its state is
3355
# assumed to have successfully run all checkers during
3357
if client["enabled"]:
3358
if datetime.datetime.utcnow() >= client["expires"]:
3359
if not client["last_checked_ok"]:
3360
log.warning("disabling client %s - Client"
3361
" never performed a successful"
3362
" checker", client_name)
3363
client["enabled"] = False
3364
elif client["last_checker_status"] != 0:
3365
log.warning("disabling client %s - Client"
3366
" last checker failed with error"
3367
" code %s", client_name,
3368
client["last_checker_status"])
3369
client["enabled"] = False
3371
client["expires"] = (
3372
datetime.datetime.utcnow()
3373
+ client["timeout"])
3374
log.debug("Last checker succeeded, keeping %s"
3375
" enabled", client_name)
2164
for client in clients_data:
2165
client_name = client["name"]
2167
# Decide which value to use after restoring saved state.
2168
# We have three different values: Old config file,
2169
# new config file, and saved state.
2170
# New config value takes precedence if it differs from old
2171
# config value, otherwise use saved state.
2172
for name, value in client_settings[client_name].items():
3377
client["secret"] = pgp.decrypt(
3378
client["encrypted_secret"],
3379
client_settings[client_name]["secret"])
3381
# If decryption fails, we use secret from new settings
3382
log.debug("Failed to decrypt %s old secret",
3384
client["secret"] = (client_settings[client_name]
3387
# Add/remove clients based on new changes made to config
3388
for client_name in (set(old_client_settings)
3389
- set(client_settings)):
3390
del clients_data[client_name]
3391
for client_name in (set(client_settings)
3392
- set(old_client_settings)):
3393
clients_data[client_name] = client_settings[client_name]
3395
# Create all client objects
3396
for client_name, client in clients_data.items():
3397
tcp_server.clients[client_name] = client_class(
3400
server_settings=server_settings)
2174
# For each value in new config, check if it differs
2175
# from the old config value (Except for the "secret"
2177
if name != "secret" and value != old_client_settings[client_name][name]:
2178
setattr(client, name, value)
2182
# Clients who has passed its expire date, can still be enabled if its
2183
# last checker was sucessful. Clients who checkers failed before we
2184
# stored it state is asumed to had failed checker during downtime.
2185
if client["enabled"] and client["last_checked_ok"]:
2186
if ((datetime.datetime.utcnow() - client["last_checked_ok"])
2187
> client["interval"]):
2188
if client["last_checker_status"] != 0:
2189
client["enabled"] = False
2191
client["expires"] = datetime.datetime.utcnow() + client["timeout"]
2193
client["changedstate"] = (multiprocessing_manager
2194
.Condition(multiprocessing_manager
2197
new_client = ClientDBusTransitional.__new__(ClientDBusTransitional)
2198
tcp_server.clients[client_name] = new_client
2199
new_client.bus = bus
2200
for name, value in client.iteritems():
2201
setattr(new_client, name, value)
2202
client_object_name = unicode(client_name).translate(
2203
{ord("."): ord("_"),
2204
ord("-"): ord("_")})
2205
new_client.dbus_object_path = (dbus.ObjectPath
2206
("/clients/" + client_object_name))
2207
DBusObjectWithProperties.__init__(new_client,
2209
new_client.dbus_object_path)
2211
tcp_server.clients[client_name] = Client.__new__(Client)
2212
for name, value in client.iteritems():
2213
setattr(tcp_server.clients[client_name], name, value)
2215
tcp_server.clients[client_name].decrypt_secret(
2216
client_settings[client_name]["secret"])
2218
# Create/remove clients based on new changes made to config
2219
for clientname in set(old_client_settings) - set(client_settings):
2220
del tcp_server.clients[clientname]
2221
for clientname in set(client_settings) - set(old_client_settings):
2222
tcp_server.clients[clientname] = (client_class(name = clientname,
3402
2228
if not tcp_server.clients:
3403
log.warning("No clients defined")
3406
if pidfile is not None:
3410
print(pid, file=pidfile)
3412
log.error("Could not write to file %r with PID %d",
2229
logger.warning("No clients defined")
2235
pidfile.write(str(pid) + "\n".encode("utf-8"))
2238
logger.error("Could not write to file %r with PID %d",
2241
# "pidfile" was never created
3415
2243
del pidfilename
3417
for termsig in (signal.SIGHUP, signal.SIGTERM):
3418
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3419
lambda: main_loop.quit() and False)
2245
signal.signal(signal.SIGINT, signal.SIG_IGN)
2247
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2248
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3423
@alternate_dbus_interfaces(
3424
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3425
class MandosDBusService(DBusObjectWithObjectManager):
2251
class MandosDBusService(dbus.service.Object):
3426
2252
"""A D-Bus proxy object"""
3428
2253
def __init__(self):
3429
2254
dbus.service.Object.__init__(self, bus, "/")
3431
2255
_interface = "se.recompile.Mandos"
3433
2257
@dbus.service.signal(_interface, signature="o")
3434
2258
def ClientAdded(self, objpath):
3438
2262
@dbus.service.signal(_interface, signature="ss")
3439
def ClientNotFound(self, key_id, address):
2263
def ClientNotFound(self, fingerprint, address):
3443
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3445
2267
@dbus.service.signal(_interface, signature="os")
3446
2268
def ClientRemoved(self, objpath, name):
3450
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3452
2272
@dbus.service.method(_interface, out_signature="ao")
3453
2273
def GetAllClients(self):
3455
return dbus.Array(c.dbus_object_path for c in
3456
tcp_server.clients.values())
3458
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2275
return dbus.Array(c.dbus_object_path
2277
tcp_server.clients.itervalues())
3460
2279
@dbus.service.method(_interface,
3461
2280
out_signature="a{oa{sv}}")
3462
2281
def GetAllClientsWithProperties(self):
3464
2283
return dbus.Dictionary(
3465
{c.dbus_object_path: c.GetAll(
3466
"se.recompile.Mandos.Client")
3467
for c in tcp_server.clients.values()},
2284
((c.dbus_object_path, c.GetAll(""))
2285
for c in tcp_server.clients.itervalues()),
3468
2286
signature="oa{sv}")
3470
2288
@dbus.service.method(_interface, in_signature="o")
3471
2289
def RemoveClient(self, object_path):
3473
for c in tcp_server.clients.values():
2291
for c in tcp_server.clients.itervalues():
3474
2292
if c.dbus_object_path == object_path:
3475
2293
del tcp_server.clients[c.name]
3476
2294
c.remove_from_connection()
3477
# Don't signal the disabling
2295
# Don't signal anything except ClientRemoved
3478
2296
c.disable(quiet=True)
3479
# Emit D-Bus signal for removal
3480
self.client_removed_signal(c)
2298
self.ClientRemoved(object_path, c.name)
3482
2300
raise KeyError(object_path)
3486
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3487
out_signature="a{oa{sa{sv}}}")
3488
def GetManagedObjects(self):
3490
return dbus.Dictionary(
3491
{client.dbus_object_path:
3493
{interface: client.GetAll(interface)
3495
client._get_all_interface_names()})
3496
for client in tcp_server.clients.values()})
3498
def client_added_signal(self, client):
3499
"""Send the new standard signal and the old signal"""
3501
# New standard signal
3502
self.InterfacesAdded(
3503
client.dbus_object_path,
3505
{interface: client.GetAll(interface)
3507
client._get_all_interface_names()}))
3509
self.ClientAdded(client.dbus_object_path)
3511
def client_removed_signal(self, client):
3512
"""Send the new standard signal and the old signal"""
3514
# New standard signal
3515
self.InterfacesRemoved(
3516
client.dbus_object_path,
3517
client._get_all_interface_names())
3519
self.ClientRemoved(client.dbus_object_path,
3522
mandos_dbus_service = MandosDBusService()
3524
# Save modules to variables to exempt the modules from being
3525
# unloaded before the function registered with atexit() is run.
3526
mp = multiprocessing
2304
class MandosDBusServiceTransitional(MandosDBusService):
2305
__metaclass__ = AlternateDBusNamesMetaclass
2306
mandos_dbus_service = MandosDBusServiceTransitional()
3530
2309
"Cleanup function; run on exit"
3534
mp.active_children()
2312
multiprocessing.active_children()
3536
2313
if not (tcp_server.clients or client_settings):
3539
# Store client before exiting. Secrets are encrypted with key
3540
# based on what config file has. If config file is
3541
# removed/edited, old secret will thus be unrecovable.
3543
with PGPEngine() as pgp:
3544
for client in tcp_server.clients.values():
3545
key = client_settings[client.name]["secret"]
3546
client.encrypted_secret = pgp.encrypt(client.secret,
3550
# A list of attributes that can not be pickled
3552
exclude = {"bus", "changedstate", "secret",
3553
"checker", "server_settings"}
3554
for name, typ in inspect.getmembers(dbus.service
3558
client_dict["encrypted_secret"] = (client
3560
for attr in client.client_structure:
3561
if attr not in exclude:
3562
client_dict[attr] = getattr(client, attr)
3564
clients[client.name] = client_dict
3565
del client_settings[client.name]["secret"]
2316
# Store client before exiting. Secrets are encrypted with key based
2317
# on what config file has. If config file is removed/edited, old
2318
# secret will thus be unrecovable.
2320
for client in tcp_server.clients.itervalues():
2321
client.encrypt_secret(client_settings[client.name]["secret"])
2325
# A list of attributes that will not be stored when shuting down.
2326
exclude = set(("bus", "changedstate", "secret"))
2327
for name, typ in inspect.getmembers(dbus.service.Object):
2330
client_dict["encrypted_secret"] = client.encrypted_secret
2331
for attr in client.client_structure:
2332
if attr not in exclude:
2333
client_dict[attr] = getattr(client, attr)
2335
clients.append(client_dict)
2336
del client_settings[client.name]["secret"]
3568
with tempfile.NamedTemporaryFile(
3572
dir=os.path.dirname(stored_state_path),
3573
delete=False) as stored_state:
3574
pickle.dump((clients, client_settings), stored_state,
3576
tempname = stored_state.name
3577
os.rename(tempname, stored_state_path)
3578
except (IOError, OSError) as e:
3584
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3585
log.warning("Could not save persistent state: %s",
3586
os.strerror(e.errno))
3588
log.warning("Could not save persistent state:",
2339
with os.fdopen(os.open(stored_state_path, os.O_CREAT|os.O_WRONLY|os.O_TRUNC, 0600), "wb") as stored_state:
2340
pickle.dump((clients, client_settings), stored_state)
2341
except IOError as e:
2342
logger.warning("Could not save persistant state: {0}".format(e))
2343
if e.errno != errno.ENOENT:
3592
2346
# Delete all clients, and settings from config