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-2022 Teddy Hogeborn
15
# Copyright © 2008-2022 Björn Påhlsson
17
# This file is part of Mandos.
19
# Mandos is free software: you can redistribute it and/or modify it
20
# under the terms of the GNU General Public License as published by
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
68
import dbus.service
86
from gi.repository import GLib
87
71
from dbus.mainloop.glib import DBusGMainLoop
90
74
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:
122
78
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
123
79
except AttributeError:
125
# This is where SO_BINDTODEVICE was up to and including Python
127
81
from IN import SO_BINDTODEVICE
128
82
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):
185
"""init logger and add loglevel"""
188
syslogger = (logging.handlers.SysLogHandler(
189
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
191
syslogger.setFormatter(logging.Formatter
192
("Mandos [%(process)d]: %(levelname)s:"
194
log.addHandler(syslogger)
197
console = logging.StreamHandler()
198
console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
202
log.addHandler(console)
206
class PGPError(Exception):
207
"""Exception if encryption/decryption fails"""
212
"""A simple class for OpenPGP symmetric encryption & decryption"""
215
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
218
output = subprocess.check_output(["gpgconf"])
219
for line in output.splitlines():
220
name, text, path = line.split(b":")
225
if e.errno != errno.ENOENT:
227
self.gnupgargs = ["--batch",
228
"--homedir", self.tempdir,
231
# Only GPG version 1 has the --no-use-agent option.
232
if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
233
self.gnupgargs.append("--no-use-agent")
238
def __exit__(self, exc_type, exc_value, traceback):
246
if self.tempdir is not None:
247
# Delete contents of tempdir
248
for root, dirs, files in os.walk(self.tempdir,
250
for filename in files:
251
os.remove(os.path.join(root, filename))
253
os.rmdir(os.path.join(root, dirname))
255
os.rmdir(self.tempdir)
258
def password_encode(self, password):
259
# Passphrase can not be empty and can not contain newlines or
260
# NUL bytes. So we prefix it and hex encode it.
261
encoded = b"mandos" + binascii.hexlify(password)
262
if len(encoded) > 2048:
263
# GnuPG can't handle long passwords, so encode differently
264
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
265
.replace(b"\n", b"\\n")
266
.replace(b"\0", b"\\x00"))
269
def encrypt(self, data, password):
270
passphrase = self.password_encode(password)
271
with tempfile.NamedTemporaryFile(
272
dir=self.tempdir) as passfile:
273
passfile.write(passphrase)
275
proc = subprocess.Popen([self.gpg, "--symmetric",
279
stdin=subprocess.PIPE,
280
stdout=subprocess.PIPE,
281
stderr=subprocess.PIPE)
282
ciphertext, err = proc.communicate(input=data)
283
if proc.returncode != 0:
287
def decrypt(self, data, password):
288
passphrase = self.password_encode(password)
289
with tempfile.NamedTemporaryFile(
290
dir=self.tempdir) as passfile:
291
passfile.write(passphrase)
293
proc = subprocess.Popen([self.gpg, "--decrypt",
297
stdin=subprocess.PIPE,
298
stdout=subprocess.PIPE,
299
stderr=subprocess.PIPE)
300
decrypted_plaintext, err = proc.communicate(input=data)
301
if proc.returncode != 0:
303
return decrypted_plaintext
306
# Pretend that we have an Avahi module
308
"""This isn't so much a class as it is a module-like namespace."""
309
IF_UNSPEC = -1 # avahi-common/address.h
310
PROTO_UNSPEC = -1 # avahi-common/address.h
311
PROTO_INET = 0 # avahi-common/address.h
312
PROTO_INET6 = 1 # avahi-common/address.h
313
DBUS_NAME = "org.freedesktop.Avahi"
314
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
315
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
316
DBUS_PATH_SERVER = "/"
319
def string_array_to_txt_array(t):
320
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
321
for s in t), signature="ay")
322
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
323
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
324
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
325
SERVER_INVALID = 0 # avahi-common/defs.h
326
SERVER_REGISTERING = 1 # avahi-common/defs.h
327
SERVER_RUNNING = 2 # avahi-common/defs.h
328
SERVER_COLLISION = 3 # avahi-common/defs.h
329
SERVER_FAILURE = 4 # avahi-common/defs.h
83
SO_BINDTODEVICE = None
88
#logger = logging.getLogger('mandos')
89
logger = logging.Logger('mandos')
90
syslogger = (logging.handlers.SysLogHandler
91
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
address = str("/dev/log")))
93
syslogger.setFormatter(logging.Formatter
94
('Mandos [%(process)d]: %(levelname)s:'
96
logger.addHandler(syslogger)
98
console = logging.StreamHandler()
99
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
102
logger.addHandler(console)
332
104
class AvahiError(Exception):
333
105
def __init__(self, value, *args, **kwargs):
334
106
self.value = value
335
return super(AvahiError, self).__init__(value, *args,
107
super(AvahiError, self).__init__(value, *args, **kwargs)
108
def __unicode__(self):
109
return unicode(repr(self.value))
339
111
class AvahiServiceError(AvahiError):
343
114
class AvahiGroupError(AvahiError):
118
class AvahiService(object):
348
119
"""An Avahi (Zeroconf) service.
351
122
interface: integer; avahi.IF_UNSPEC or an interface index.
352
123
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>
124
name: string; Example: 'Mandos'
125
type: string; Example: '_mandos._tcp'.
126
See <http://www.dns-sd.org/ServiceTypes.html>
356
127
port: integer; what port to announce
357
128
TXT: list of strings; TXT record for the service
358
129
domain: string; Domain to publish on, default to .local if empty.
516
262
follow_name_owner_changes=True),
517
263
avahi.DBUS_INTERFACE_SERVER)
518
264
self.server.connect_to_signal("StateChanged",
519
self.server_state_changed)
265
self.server_state_changed)
520
266
self.server_state_changed(self.server.GetState())
523
class AvahiServiceToSyslog(AvahiService):
524
def rename(self, *args, **kwargs):
525
"""Add the new name to the syslog messages"""
526
ret = super(AvahiServiceToSyslog, self).rename(*args,
528
syslogger.setFormatter(logging.Formatter(
529
"Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
534
# Pretend that we have a GnuTLS module
536
"""This isn't so much a class as it is a module-like namespace."""
538
library = ctypes.util.find_library("gnutls")
540
library = ctypes.util.find_library("gnutls-deb0")
541
_library = ctypes.cdll.LoadLibrary(library)
544
# Unless otherwise indicated, the constants and types below are
545
# all from the gnutls/gnutls.h C header file.
556
E_NO_CERTIFICATE_FOUND = -49
561
KEYID_USE_SHA256 = 1 # gnutls/x509.h
562
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
565
class _session_int(ctypes.Structure):
567
session_t = ctypes.POINTER(_session_int)
569
class certificate_credentials_st(ctypes.Structure):
571
certificate_credentials_t = ctypes.POINTER(
572
certificate_credentials_st)
573
certificate_type_t = ctypes.c_int
575
class datum_t(ctypes.Structure):
576
_fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
("size", ctypes.c_uint)]
579
class _openpgp_crt_int(ctypes.Structure):
581
openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
582
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
583
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
credentials_type_t = ctypes.c_int
585
transport_ptr_t = ctypes.c_void_p
586
close_request_t = ctypes.c_int
589
class Error(Exception):
590
def __init__(self, message=None, code=None, args=()):
591
# Default usage is by a message string, but if a return
592
# code is passed, convert it to a string with
595
if message is None and code is not None:
596
message = gnutls.strerror(code).decode(
597
"utf-8", errors="replace")
598
return super(gnutls.Error, self).__init__(
601
class CertificateSecurityError(Error):
605
def __init__(self, cls):
608
def from_param(self, obj):
609
if not isinstance(obj, self.cls):
610
raise TypeError("Not of type {}: {!r}"
611
.format(self.cls.__name__, obj))
612
return ctypes.byref(obj.from_param(obj))
614
class CastToVoidPointer:
615
def __init__(self, cls):
618
def from_param(self, obj):
619
if not isinstance(obj, self.cls):
620
raise TypeError("Not of type {}: {!r}"
621
.format(self.cls.__name__, obj))
622
return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
624
class With_from_param:
626
def from_param(cls, obj):
627
return obj._as_parameter_
630
class Credentials(With_from_param):
632
self._as_parameter_ = gnutls.certificate_credentials_t()
633
gnutls.certificate_allocate_credentials(self)
634
self.type = gnutls.CRD_CERTIFICATE
637
gnutls.certificate_free_credentials(self)
639
class ClientSession(With_from_param):
640
def __init__(self, socket, credentials=None):
641
self._as_parameter_ = gnutls.session_t()
642
gnutls_flags = gnutls.CLIENT
643
if gnutls.check_version(b"3.5.6"):
644
gnutls_flags |= gnutls.NO_TICKETS
646
gnutls_flags |= gnutls.ENABLE_RAWPK
647
gnutls.init(self, gnutls_flags)
649
gnutls.set_default_priority(self)
650
gnutls.transport_set_ptr(self, socket.fileno())
651
gnutls.handshake_set_private_extensions(self, True)
653
if credentials is None:
654
credentials = gnutls.Credentials()
655
gnutls.credentials_set(self, credentials.type,
657
self.credentials = credentials
663
return gnutls.handshake(self)
665
def send(self, data):
669
data_len -= gnutls.record_send(self, data[-data_len:],
673
return gnutls.bye(self, gnutls.SHUT_RDWR)
675
# Error handling functions
676
def _error_code(result):
677
"""A function to raise exceptions on errors, suitable
678
for the "restype" attribute on ctypes functions"""
679
if result >= gnutls.E_SUCCESS:
681
if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
raise gnutls.CertificateSecurityError(code=result)
683
raise gnutls.Error(code=result)
685
def _retry_on_error(result, func, arguments,
686
_error_code=_error_code):
687
"""A function to retry on some errors, suitable
688
for the "errcheck" attribute on ctypes functions"""
689
while result < gnutls.E_SUCCESS:
690
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
return _error_code(result)
692
result = func(*arguments)
695
# Unless otherwise indicated, the function declarations below are
696
# all from the gnutls/gnutls.h C header file.
699
priority_set_direct = _library.gnutls_priority_set_direct
700
priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
701
ctypes.POINTER(ctypes.c_char_p)]
702
priority_set_direct.restype = _error_code
704
init = _library.gnutls_init
705
init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
706
init.restype = _error_code
708
set_default_priority = _library.gnutls_set_default_priority
709
set_default_priority.argtypes = [ClientSession]
710
set_default_priority.restype = _error_code
712
record_send = _library.gnutls_record_send
713
record_send.argtypes = [ClientSession, ctypes.c_void_p,
715
record_send.restype = ctypes.c_ssize_t
716
record_send.errcheck = _retry_on_error
718
certificate_allocate_credentials = (
719
_library.gnutls_certificate_allocate_credentials)
720
certificate_allocate_credentials.argtypes = [
721
PointerTo(Credentials)]
722
certificate_allocate_credentials.restype = _error_code
724
certificate_free_credentials = (
725
_library.gnutls_certificate_free_credentials)
726
certificate_free_credentials.argtypes = [Credentials]
727
certificate_free_credentials.restype = None
729
handshake_set_private_extensions = (
730
_library.gnutls_handshake_set_private_extensions)
731
handshake_set_private_extensions.argtypes = [ClientSession,
733
handshake_set_private_extensions.restype = None
735
credentials_set = _library.gnutls_credentials_set
736
credentials_set.argtypes = [ClientSession, credentials_type_t,
737
CastToVoidPointer(Credentials)]
738
credentials_set.restype = _error_code
740
strerror = _library.gnutls_strerror
741
strerror.argtypes = [ctypes.c_int]
742
strerror.restype = ctypes.c_char_p
744
certificate_type_get = _library.gnutls_certificate_type_get
745
certificate_type_get.argtypes = [ClientSession]
746
certificate_type_get.restype = _error_code
748
certificate_get_peers = _library.gnutls_certificate_get_peers
749
certificate_get_peers.argtypes = [ClientSession,
750
ctypes.POINTER(ctypes.c_uint)]
751
certificate_get_peers.restype = ctypes.POINTER(datum_t)
753
global_set_log_level = _library.gnutls_global_set_log_level
754
global_set_log_level.argtypes = [ctypes.c_int]
755
global_set_log_level.restype = None
757
global_set_log_function = _library.gnutls_global_set_log_function
758
global_set_log_function.argtypes = [log_func]
759
global_set_log_function.restype = None
761
deinit = _library.gnutls_deinit
762
deinit.argtypes = [ClientSession]
763
deinit.restype = None
765
handshake = _library.gnutls_handshake
766
handshake.argtypes = [ClientSession]
767
handshake.restype = ctypes.c_int
768
handshake.errcheck = _retry_on_error
770
transport_set_ptr = _library.gnutls_transport_set_ptr
771
transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
772
transport_set_ptr.restype = None
774
bye = _library.gnutls_bye
775
bye.argtypes = [ClientSession, close_request_t]
776
bye.restype = ctypes.c_int
777
bye.errcheck = _retry_on_error
779
check_version = _library.gnutls_check_version
780
check_version.argtypes = [ctypes.c_char_p]
781
check_version.restype = ctypes.c_char_p
783
_need_version = b"3.3.0"
784
if check_version(_need_version) is None:
785
raise self.Error("Needs GnuTLS {} or later"
786
.format(_need_version))
788
_tls_rawpk_version = b"3.6.6"
789
has_rawpk = bool(check_version(_tls_rawpk_version))
793
class pubkey_st(ctypes.Structure):
795
pubkey_t = ctypes.POINTER(pubkey_st)
797
x509_crt_fmt_t = ctypes.c_int
799
# All the function declarations below are from
801
pubkey_init = _library.gnutls_pubkey_init
802
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
803
pubkey_init.restype = _error_code
805
pubkey_import = _library.gnutls_pubkey_import
806
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
808
pubkey_import.restype = _error_code
810
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
811
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
812
ctypes.POINTER(ctypes.c_ubyte),
813
ctypes.POINTER(ctypes.c_size_t)]
814
pubkey_get_key_id.restype = _error_code
816
pubkey_deinit = _library.gnutls_pubkey_deinit
817
pubkey_deinit.argtypes = [pubkey_t]
818
pubkey_deinit.restype = None
820
# All the function declarations below are from
823
openpgp_crt_init = _library.gnutls_openpgp_crt_init
824
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
825
openpgp_crt_init.restype = _error_code
827
openpgp_crt_import = _library.gnutls_openpgp_crt_import
828
openpgp_crt_import.argtypes = [openpgp_crt_t,
829
ctypes.POINTER(datum_t),
831
openpgp_crt_import.restype = _error_code
833
openpgp_crt_verify_self = \
834
_library.gnutls_openpgp_crt_verify_self
835
openpgp_crt_verify_self.argtypes = [
838
ctypes.POINTER(ctypes.c_uint),
840
openpgp_crt_verify_self.restype = _error_code
842
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
843
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
844
openpgp_crt_deinit.restype = None
846
openpgp_crt_get_fingerprint = (
847
_library.gnutls_openpgp_crt_get_fingerprint)
848
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
852
openpgp_crt_get_fingerprint.restype = _error_code
854
if check_version(b"3.6.4"):
855
certificate_type_get2 = _library.gnutls_certificate_type_get2
856
certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
857
certificate_type_get2.restype = _error_code
859
# Remove non-public functions
860
del _error_code, _retry_on_error
863
def call_pipe(connection, # : multiprocessing.Connection
864
func, *args, **kwargs):
865
"""This function is meant to be called by multiprocessing.Process
867
This function runs func(*args, **kwargs), and writes the resulting
868
return value on the provided multiprocessing.Connection.
870
connection.send(func(*args, **kwargs))
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
275
class Client(object):
875
276
"""A representation of a client host served by this server.
878
approved: bool(); None if not yet approved/disapproved
279
_approved: bool(); 'None' if not yet approved/disapproved
879
280
approval_delay: datetime.timedelta(); Time to wait for approval
880
281
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
282
checker: subprocess.Popen(); a running checker process used
283
to see if the client lives.
284
'None' if no process is running.
285
checker_callback_tag: a gobject event source tag, or None
885
286
checker_command: string; External command which is run to check
886
287
if client lives. %() expansions are done at
887
288
runtime with vars(self) as dict, so that for
888
289
instance %(name)s can be used in the command.
889
checker_initiator_tag: a GLib event source tag, or None
290
checker_initiator_tag: a gobject event source tag, or None
890
291
created: datetime.datetime(); (UTC) object creation
891
client_structure: Object describing what attributes a client has
892
and is used for storing the client at exit
893
292
current_checker_command: string; current running checker_command
894
disable_initiator_tag: a GLib event source tag, or None
293
disable_hook: If set, called by disable() as disable_hook(self)
294
disable_initiator_tag: a gobject event source tag, or None
896
296
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
297
uniquely identify the client
900
298
host: string; available for use by the checker command
901
299
interval: datetime.timedelta(); How often to start a new checker
902
300
last_approval_request: datetime.datetime(); (UTC) or None
903
301
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
302
last_enabled: datetime.datetime(); (UTC)
910
303
name: string; from the config file, used in log messages and
911
304
D-Bus identifiers
912
305
secret: bytestring; sent verbatim (over TLS) to client
913
306
timeout: datetime.timedelta(); How long from last_checked_ok
914
307
until this client is disabled
915
extended_timeout: extra long timeout when secret has been sent
308
extended_timeout: extra long timeout when password has been sent
916
309
runtime_expansions: Allowed attributes for runtime expansion.
917
310
expires: datetime.datetime(); time (UTC) when a client will be
918
311
disabled, or None
919
server_settings: The server_settings dict from main()
922
314
runtime_expansions = ("approval_delay", "approval_duration",
923
"created", "enabled", "expires", "key_id",
924
"fingerprint", "host", "interval",
925
"last_approval_request", "last_checked_ok",
315
"created", "enabled", "fingerprint",
316
"host", "interval", "last_checked_ok",
926
317
"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):
319
def timeout_milliseconds(self):
320
"Return the 'timeout' attribute in milliseconds"
321
return _timedelta_to_milliseconds(self.timeout)
323
def extended_timeout_milliseconds(self):
324
"Return the 'extended_timeout' attribute in milliseconds"
325
return _timedelta_to_milliseconds(self.extended_timeout)
327
def interval_milliseconds(self):
328
"Return the 'interval' attribute in milliseconds"
329
return _timedelta_to_milliseconds(self.interval)
331
def approval_delay_milliseconds(self):
332
return _timedelta_to_milliseconds(self.approval_delay)
334
def __init__(self, name = None, disable_hook=None, config=None):
335
"""Note: the 'checker' key in 'config' sets the
336
'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()
341
logger.debug("Creating client %r", self.name)
342
# Uppercase and remove spaces from fingerprint for later
343
# comparison purposes with return value from the fingerprint()
345
self.fingerprint = (config["fingerprint"].upper()
347
logger.debug(" Fingerprint: %s", self.fingerprint)
348
if "secret" in config:
349
self.secret = config["secret"].decode("base64")
350
elif "secfile" in config:
351
with open(os.path.expanduser(os.path.expandvars
352
(config["secfile"])),
354
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
356
raise TypeError("No secret or secfile for client %s"
358
self.host = config.get("host", "")
359
self.created = datetime.datetime.utcnow()
361
self.last_approval_request = None
362
self.last_enabled = None
363
self.last_checked_ok = None
364
self.timeout = string_to_delta(config["timeout"])
365
self.extended_timeout = string_to_delta(config
366
["extended_timeout"])
367
self.interval = string_to_delta(config["interval"])
368
self.disable_hook = disable_hook
1019
369
self.checker = None
1020
370
self.checker_initiator_tag = None
1021
371
self.disable_initiator_tag = None
1022
373
self.checker_callback_tag = None
374
self.checker_command = config["checker"]
1023
375
self.current_checker_command = None
1024
self.approved = None
376
self.last_connect = None
377
self._approved = None
378
self.approved_by_default = config.get("approved_by_default",
1025
380
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("_")]
1031
self.client_structure.append("client_structure")
1033
for name, t in inspect.getmembers(
1034
type(self), lambda obj: isinstance(obj, property)):
1035
if not name.startswith("_"):
1036
self.client_structure.append(name)
1038
# Send notice to process children that client state has changed
381
self.approval_delay = string_to_delta(
382
config["approval_delay"])
383
self.approval_duration = string_to_delta(
384
config["approval_duration"])
385
self.changedstate = (multiprocessing_manager
386
.Condition(multiprocessing_manager
1039
389
def send_changedstate(self):
1040
with self.changedstate:
1041
self.changedstate.notify_all()
390
self.changedstate.acquire()
391
self.changedstate.notify_all()
392
self.changedstate.release()
1043
394
def enable(self):
1044
395
"""Start this client's checker and timeout hooks"""
1045
396
if getattr(self, "enabled", False):
1046
397
# Already enabled
399
self.send_changedstate()
400
# Schedule a new checker to be started an 'interval' from now,
401
# and every interval from then on.
402
self.checker_initiator_tag = (gobject.timeout_add
403
(self.interval_milliseconds(),
405
# Schedule a disable() when 'timeout' has passed
1048
406
self.expires = datetime.datetime.utcnow() + self.timeout
407
self.disable_initiator_tag = (gobject.timeout_add
408
(self.timeout_milliseconds(),
1049
410
self.enabled = True
1050
411
self.last_enabled = datetime.datetime.utcnow()
1052
self.send_changedstate()
412
# Also start a new checker *right now*.
1054
415
def disable(self, quiet=True):
1055
416
"""Disable this client."""
1056
417
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)
420
self.send_changedstate()
422
logger.info("Disabling client %s", self.name)
423
if getattr(self, "disable_initiator_tag", False):
424
gobject.source_remove(self.disable_initiator_tag)
1062
425
self.disable_initiator_tag = None
1063
426
self.expires = None
1064
if getattr(self, "checker_initiator_tag", None) is not None:
1065
GLib.source_remove(self.checker_initiator_tag)
427
if getattr(self, "checker_initiator_tag", False):
428
gobject.source_remove(self.checker_initiator_tag)
1066
429
self.checker_initiator_tag = None
1067
430
self.stop_checker()
431
if self.disable_hook:
432
self.disable_hook(self)
1068
433
self.enabled = False
1070
self.send_changedstate()
1071
# Do not run this again if called by a GLib.timeout_add
434
# Do not run this again if called by a gobject.timeout_add
1074
437
def __del__(self):
438
self.disable_hook = None
1077
def init_checker(self):
1078
# Schedule a new checker to be started an 'interval' from now,
1079
# 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
1086
# 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)
1091
# Also start a new checker *right now*.
1092
self.start_checker()
1094
def checker_callback(self, source, condition, connection,
441
def checker_callback(self, pid, condition, command):
1096
442
"""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
443
self.checker_callback_tag = None
1103
444
self.checker = None
1106
self.last_checker_status = returncode
1107
self.last_checker_signal = None
1108
if self.last_checker_status == 0:
1109
log.info("Checker for %(name)s succeeded", vars(self))
445
if os.WIFEXITED(condition):
446
exitstatus = os.WEXITSTATUS(condition)
448
logger.info("Checker for %(name)s succeeded",
1110
450
self.checked_ok()
1112
log.info("Checker for %(name)s failed", vars(self))
452
logger.info("Checker for %(name)s failed",
1114
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."""
455
logger.warning("Checker for %(name)s crashed?",
458
def checked_ok(self, timeout=None):
459
"""Bump up the timeout for this client.
461
This should only be called when the client has been seen,
1128
464
if timeout is None:
1129
465
timeout = self.timeout
1130
if self.disable_initiator_tag is not None:
1131
GLib.source_remove(self.disable_initiator_tag)
1132
self.disable_initiator_tag = None
1133
if getattr(self, "enabled", False):
1134
self.disable_initiator_tag = GLib.timeout_add(
1135
int(timeout.total_seconds() * 1000), self.disable)
1136
self.expires = datetime.datetime.utcnow() + timeout
466
self.last_checked_ok = datetime.datetime.utcnow()
467
gobject.source_remove(self.disable_initiator_tag)
468
self.disable_initiator_tag = (gobject.timeout_add
469
(_timedelta_to_milliseconds
470
(timeout), self.disable))
471
self.expires = datetime.datetime.utcnow() + timeout
1138
473
def need_approval(self):
1139
474
self.last_approval_request = datetime.datetime.utcnow()
1141
476
def start_checker(self):
1142
477
"""Start a new checker subprocess if one is not running.
1144
479
If a checker already exists, leave it running and do
1146
481
# 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
482
# did that, then if a checker (for some reason) started
483
# running slowly and taking more than 'interval' time, the
484
# client would inevitably timeout, since no checker would get
485
# a chance to run to completion. If we instead leave running
1151
486
# checkers alone, the checker would have to take more time
1152
487
# 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")
490
# If a checker exists, make sure it is not a zombie
492
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
493
except (AttributeError, OSError) as error:
494
if (isinstance(error, OSError)
495
and error.errno != errno.ECHILD):
499
logger.warning("Checker was a zombie")
500
gobject.source_remove(self.checker_callback_tag)
501
self.checker_callback(pid, status,
502
self.current_checker_command)
1159
503
# Start a new checker if needed
1160
504
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
506
# In case checker_command has exactly one % operator
507
command = self.checker_command % self.host
509
# Escape attributes for the shell
510
escaped_attrs = dict(
512
re.escape(unicode(str(getattr(self, attr, "")),
516
self.runtime_expansions)
519
command = self.checker_command % escaped_attrs
520
except TypeError as error:
521
logger.error('Could not format string "%s":'
522
' %s', self.checker_command, error)
523
return True # Try again later
1171
524
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
526
logger.info("Starting checker %r for %s",
528
# We don't need to redirect stdout and stderr, since
529
# in normal mode, that is already done by daemon(),
530
# and in debug mode we don't want to. (Stdin is
531
# always replaced by /dev/null.)
532
self.checker = subprocess.Popen(command,
535
self.checker_callback_tag = (gobject.child_watch_add
537
self.checker_callback,
539
# The checker may have completed before the gobject
540
# watch was added. Check for this.
541
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
543
gobject.source_remove(self.checker_callback_tag)
544
self.checker_callback(pid, status, command)
545
except OSError as error:
546
logger.error("Failed to start subprocess: %s",
548
# Re-run this periodically if run by gobject.timeout_add
1200
551
def stop_checker(self):
1201
552
"""Force the checker process, if any, to stop."""
1202
553
if self.checker_callback_tag:
1203
GLib.source_remove(self.checker_callback_tag)
554
gobject.source_remove(self.checker_callback_tag)
1204
555
self.checker_callback_tag = None
1205
556
if getattr(self, "checker", None) is None:
1207
log.debug("Stopping checker for %(name)s", vars(self))
1208
self.checker.terminate()
558
logger.debug("Stopping checker for %(name)s", vars(self))
560
os.kill(self.checker.pid, signal.SIGTERM)
562
#if self.checker.poll() is None:
563
# os.kill(self.checker.pid, signal.SIGKILL)
564
except OSError as error:
565
if error.errno != errno.ESRCH: # No such process
1209
567
self.checker = None
1212
def dbus_service_property(dbus_interface,
570
def dbus_service_property(dbus_interface, signature="v",
571
access="readwrite", byte_arrays=False):
1216
572
"""Decorators for marking methods of a DBusObjectWithProperties to
1217
573
become properties on the D-Bus.
1219
575
The decorated method will be called with no arguments by "Get"
1220
576
and with one argument by "Set".
1222
578
The parameters, where they are supported, are the same as
1223
579
dbus.service.method, except there is only "signature", since the
1224
580
type from Get() and the type sent to Set() is the same.
1555
749
document.unlink()
1556
750
except (AttributeError, xml.dom.DOMException,
1557
751
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):
752
logger.error("Failed to override Introspection method",
757
def datetime_to_dbus (dt, variant_level=0):
1635
758
"""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).
760
return dbus.String("", variant_level = variant_level)
761
return dbus.String(dt.isoformat(),
762
variant_level=variant_level)
764
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
766
"""Applied to an empty subclass of a D-Bus object, this metaclass
767
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):
769
def __new__(mcs, name, bases, attr):
770
# Go through all the base classes which could have D-Bus
771
# methods, signals, or properties in them
772
for base in (b for b in bases
773
if issubclass(b, dbus.service.Object)):
774
# Go though all attributes of the base class
775
for attrname, attribute in inspect.getmembers(base):
1672
776
# Ignore non-D-Bus attributes, and D-Bus attributes
1673
777
# with the wrong interface name
1674
778
if (not hasattr(attribute, "_dbus_interface")
1675
or not attribute._dbus_interface.startswith(
1676
orig_interface_name)):
779
or not attribute._dbus_interface
780
.startswith("se.recompile.Mandos")):
1678
782
# Create an alternate D-Bus interface name based on
1679
783
# the current name
1680
alt_interface = attribute._dbus_interface.replace(
1681
orig_interface_name, alt_interface_name)
1682
interface_names.add(alt_interface)
784
alt_interface = (attribute._dbus_interface
785
.replace("se.recompile.Mandos",
786
"se.bsnet.fukt.Mandos"))
1683
787
# Is this a D-Bus signal?
1684
788
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(
789
# Extract the original non-method function by
791
nonmethod_func = (dict(
1689
792
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)
793
attribute.__closure__))["func"]
1697
795
# Create a new, but exactly alike, function
1698
796
# object, and decorate it to be a new D-Bus signal
1699
797
# 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:
798
new_function = (dbus.service.signal
800
attribute._dbus_signature)
802
nonmethod_func.func_code,
803
nonmethod_func.func_globals,
804
nonmethod_func.func_name,
805
nonmethod_func.func_defaults,
806
nonmethod_func.func_closure)))
1711
807
# 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
808
# old and new functions, so both the old and new
809
# signals gets sent when the function is called
1715
810
def fixscope(func1, func2):
1716
811
"""This function is a scope container to pass
1717
812
func1 and func2 to the "call_both" function
1718
813
outside of its arguments"""
1720
@functools.wraps(func2)
1721
814
def call_both(*args, **kwargs):
1722
815
"""This function will emit two D-Bus
1723
816
signals by calling func1 and func2"""
1724
817
func1(*args, **kwargs)
1725
818
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
819
return call_both
1733
820
# Create the "call_both" function and add it to
1735
attr[attrname] = fixscope(attribute, new_function)
822
attr[attrname] = fixscope(attribute,
1736
824
# Is this a D-Bus method?
1737
825
elif getattr(attribute, "_dbus_is_method", False):
1738
826
# Create a new, but exactly alike, function
1739
827
# object. Decorate it to be a new D-Bus method
1740
828
# 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:
830
attr[attrname] = (dbus.service.method
832
attribute._dbus_in_signature,
833
attribute._dbus_out_signature)
835
(attribute.func_code,
836
attribute.func_globals,
838
attribute.func_defaults,
839
attribute.func_closure)))
1754
840
# Is this a D-Bus property?
1755
841
elif getattr(attribute, "_dbus_is_property", False):
1756
842
# Create a new, but exactly alike, function
1757
843
# object, and decorate it to be a new D-Bus
1758
844
# property with the alternate D-Bus interface
1759
845
# 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"})
846
attr[attrname] = (dbus_service_property
848
attribute._dbus_signature,
849
attribute._dbus_access,
851
._dbus_get_args_options
854
(attribute.func_code,
855
attribute.func_globals,
857
attribute.func_defaults,
858
attribute.func_closure)))
859
return type.__new__(mcs, name, bases, attr)
1812
861
class ClientDBus(Client, DBusObjectWithProperties):
1813
862
"""A Client class using D-Bus
1816
865
dbus_object_path: dbus.ObjectPath
1817
866
bus: dbus.SystemBus()
1820
869
runtime_expansions = (Client.runtime_expansions
1821
+ ("dbus_object_path", ))
1823
_interface = "se.recompile.Mandos.Client"
870
+ ("dbus_object_path",))
1825
872
# dbus.service.Object doesn't use super(), so we can't either.
1827
def __init__(self, bus=None, *args, **kwargs):
874
def __init__(self, bus = None, *args, **kwargs):
875
self._approvals_pending = 0
1829
877
Client.__init__(self, *args, **kwargs)
1830
878
# Only now, when this client is initialized, can it show up on
1832
client_object_name = str(self.name).translate(
880
client_object_name = unicode(self.name).translate(
1833
881
{ord("."): ord("_"),
1834
882
ord("-"): ord("_")})
1835
self.dbus_object_path = dbus.ObjectPath(
1836
"/clients/" + client_object_name)
883
self.dbus_object_path = (dbus.ObjectPath
884
("/clients/" + client_object_name))
1837
885
DBusObjectWithProperties.__init__(self, self.bus,
1838
886
self.dbus_object_path)
1840
def notifychangeproperty(transform_func, dbus_name,
1841
type_func=lambda x: x,
1843
invalidate_only=False,
1844
_interface=_interface):
888
def notifychangeproperty(transform_func,
889
dbus_name, type_func=lambda x: x,
1845
891
""" Modify a variable so that it's a property which announces
1846
892
its changes to DBus.
1848
transform_fun: Function that takes a value and a variant_level
1849
and transforms it to a D-Bus type.
894
transform_fun: Function that takes a value and transforms it
1850
896
dbus_name: D-Bus name of the variable
1851
897
type_func: Function that transform the value before sending it
1852
898
to the D-Bus. Default: no transform
1853
899
variant_level: D-Bus variant level. Default: 1
1855
attrname = "_{}".format(dbus_name)
901
attrname = "_{0}".format(dbus_name)
1857
902
def setter(self, value):
1858
903
if hasattr(self, "dbus_object_path"):
1859
904
if (not hasattr(self, attrname) or
1860
905
type_func(getattr(self, attrname, None))
1861
906
!= type_func(value)):
1863
self.PropertiesChanged(
1864
_interface, dbus.Dictionary(),
1865
dbus.Array((dbus_name, )))
1867
dbus_value = transform_func(
1869
variant_level=variant_level)
1870
self.PropertyChanged(dbus.String(dbus_name),
1872
self.PropertiesChanged(
1874
dbus.Dictionary({dbus.String(dbus_name):
907
dbus_value = transform_func(type_func(value),
909
self.PropertyChanged(dbus.String(dbus_name),
1877
911
setattr(self, attrname, value)
1879
913
return property(lambda self: getattr(self, attrname), setter)
1881
916
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1882
917
approvals_pending = notifychangeproperty(dbus.Boolean,
1883
918
"ApprovalPending",
1885
920
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1886
921
last_enabled = notifychangeproperty(datetime_to_dbus,
1888
checker = notifychangeproperty(
1889
dbus.Boolean, "CheckerRunning",
1890
type_func=lambda checker: checker is not None)
923
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
924
type_func = lambda checker:
1891
926
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1892
927
"LastCheckedOK")
1893
last_checker_status = notifychangeproperty(dbus.Int16,
1894
"LastCheckerStatus")
1895
928
last_approval_request = notifychangeproperty(
1896
929
datetime_to_dbus, "LastApprovalRequest")
1897
930
approved_by_default = notifychangeproperty(dbus.Boolean,
1898
931
"ApprovedByDefault")
1899
approval_delay = notifychangeproperty(
1900
dbus.UInt64, "ApprovalDelay",
1901
type_func=lambda td: td.total_seconds() * 1000)
932
approval_delay = notifychangeproperty(dbus.UInt16,
935
_timedelta_to_milliseconds)
1902
936
approval_duration = notifychangeproperty(
1903
dbus.UInt64, "ApprovalDuration",
1904
type_func=lambda td: td.total_seconds() * 1000)
937
dbus.UInt16, "ApprovalDuration",
938
type_func = _timedelta_to_milliseconds)
1905
939
host = notifychangeproperty(dbus.String, "Host")
1906
timeout = notifychangeproperty(
1907
dbus.UInt64, "Timeout",
1908
type_func=lambda td: td.total_seconds() * 1000)
940
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
942
_timedelta_to_milliseconds)
1909
943
extended_timeout = notifychangeproperty(
1910
dbus.UInt64, "ExtendedTimeout",
1911
type_func=lambda td: td.total_seconds() * 1000)
1912
interval = notifychangeproperty(
1913
dbus.UInt64, "Interval",
1914
type_func=lambda td: td.total_seconds() * 1000)
944
dbus.UInt16, "ExtendedTimeout",
945
type_func = _timedelta_to_milliseconds)
946
interval = notifychangeproperty(dbus.UInt16,
949
_timedelta_to_milliseconds)
1915
950
checker_command = notifychangeproperty(dbus.String, "Checker")
1916
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1917
invalidate_only=True)
1919
952
del notifychangeproperty
1921
954
def __del__(self, *args, **kwargs):
1923
956
self.remove_from_connection()
2241
1244
self.start_checker()
2243
1246
self.stop_checker()
2245
1248
# ObjectPath - property
2247
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2248
"org.freedesktop.DBus.Deprecated": "true"})
2249
1249
@dbus_service_property(_interface, signature="o", access="read")
2250
1250
def ObjectPath_dbus_property(self):
2251
return self.dbus_object_path # is already a dbus.ObjectPath
1251
return self.dbus_object_path # is already a dbus.ObjectPath
2253
1253
# Secret = property
2255
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2257
@dbus_service_property(_interface,
1254
@dbus_service_property(_interface, signature="ay",
1255
access="write", byte_arrays=True)
2261
1256
def Secret_dbus_property(self, value):
2262
self.secret = bytes(value)
1257
self.secret = str(value)
2268
def __init__(self, child_pipe, key_id, fpr, address):
1262
class ProxyClient(object):
1263
def __init__(self, child_pipe, fpr, address):
2269
1264
self._pipe = child_pipe
2270
self._pipe.send(("init", key_id, fpr, address))
1265
self._pipe.send(('init', fpr, address))
2271
1266
if not self._pipe.recv():
2272
raise KeyError(key_id or fpr)
2274
1269
def __getattribute__(self, name):
1270
if(name == '_pipe'):
2276
1271
return super(ProxyClient, self).__getattribute__(name)
2277
self._pipe.send(("getattr", name))
1272
self._pipe.send(('getattr', name))
2278
1273
data = self._pipe.recv()
2279
if data[0] == "data":
1274
if data[0] == 'data':
2281
if data[0] == "function":
1276
if data[0] == 'function':
2283
1277
def func(*args, **kwargs):
2284
self._pipe.send(("funcall", name, args, kwargs))
1278
self._pipe.send(('funcall', name, args, kwargs))
2285
1279
return self._pipe.recv()[1]
2289
1282
def __setattr__(self, name, value):
1283
if(name == '_pipe'):
2291
1284
return super(ProxyClient, self).__setattr__(name, value)
2292
self._pipe.send(("setattr", name, value))
1285
self._pipe.send(('setattr', name, value))
1287
class ClientDBusTransitional(ClientDBus):
1288
__metaclass__ = AlternateDBusNamesMetaclass
2295
1290
class ClientHandler(socketserver.BaseRequestHandler, object):
2296
1291
"""A class to handle client connections.
2298
1293
Instantiated once for each connection to handle it.
2299
1294
Note: This will run in its own forked process."""
2301
1296
def handle(self):
2302
1297
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",
1298
logger.info("TCP connection from: %s",
1299
unicode(self.client_address))
1300
logger.debug("Pipe FD: %d",
1301
self.server.child_pipe.fileno())
1303
session = (gnutls.connection
1304
.ClientSession(self.request,
1306
.X509Credentials()))
1308
# Note: gnutls.connection.X509Credentials is really a
1309
# generic GnuTLS certificate credentials object so long as
1310
# no X.509 keys are added to it. Therefore, we can use it
1311
# here despite using OpenPGP certificates.
1313
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1314
# "+AES-256-CBC", "+SHA1",
1315
# "+COMP-NULL", "+CTYPE-OPENPGP",
2313
1317
# Use a fallback default, since this MUST be set.
2314
1318
priority = self.server.gnutls_priority
2315
1319
if priority is None:
2316
1320
priority = "NORMAL"
2317
gnutls.priority_set_direct(session,
2318
priority.encode("utf-8"), None)
1321
(gnutls.library.functions
1322
.gnutls_priority_set_direct(session._c_object,
2320
1325
# Start communication using the Mandos protocol
2321
1326
# Get protocol number
2322
1327
line = self.request.makefile().readline()
2323
log.debug("Protocol version: %r", line)
1328
logger.debug("Protocol version: %r", line)
2325
1330
if int(line.strip().split()[0]) > 1:
2326
raise RuntimeError(line)
2327
1332
except (ValueError, IndexError, RuntimeError) as error:
2328
log.error("Unknown protocol version: %s", error)
1333
logger.error("Unknown protocol version: %s", error)
2331
1336
# Start GnuTLS connection
2333
1338
session.handshake()
2334
except gnutls.Error as error:
2335
log.warning("Handshake failed: %s", error)
1339
except gnutls.errors.GNUTLSError as error:
1340
logger.warning("Handshake failed: %s", error)
2336
1341
# Do not run session.bye() here: the session is not
2337
1342
# established. Just abandon the request.
2339
log.debug("Handshake succeeded")
1344
logger.debug("Handshake succeeded")
2341
1346
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,
1349
fpr = self.fingerprint(self.peer_certificate
1352
gnutls.errors.GNUTLSError) as error:
1353
logger.warning("Bad certificate: %s", error)
1355
logger.debug("Fingerprint: %s", fpr)
1358
client = ProxyClient(child_pipe, fpr,
2367
1359
self.client_address)
2368
1360
except KeyError:
2371
1363
if client.approval_delay:
2372
1364
delay = client.approval_delay
2373
1365
client.approvals_pending += 1
2374
1366
approval_required = True
2377
1369
if not client.enabled:
2378
log.info("Client %s is disabled", client.name)
1370
logger.info("Client %s is disabled",
2379
1372
if self.server.use_dbus:
2380
1373
# Emit D-Bus signal
2381
1374
client.Rejected("Disabled")
2384
if client.approved or not client.approval_delay:
2385
# We are approved or approval is disabled
1377
if client._approved or not client.approval_delay:
1378
#We are approved or approval is disabled
2387
elif client.approved is None:
2388
log.info("Client %s needs approval",
1380
elif client._approved is None:
1381
logger.info("Client %s needs approval",
2390
1383
if self.server.use_dbus:
2391
1384
# Emit D-Bus signal
2392
1385
client.NeedApproval(
2393
client.approval_delay.total_seconds()
2394
* 1000, client.approved_by_default)
1386
client.approval_delay_milliseconds(),
1387
client.approved_by_default)
2396
log.warning("Client %s was not approved",
1389
logger.warning("Client %s was not approved",
2398
1391
if self.server.use_dbus:
2399
1392
# Emit D-Bus signal
2400
1393
client.Rejected("Denied")
2403
# wait until timeout or approved
1396
#wait until timeout or approved
2404
1397
time = datetime.datetime.now()
2405
1398
client.changedstate.acquire()
2406
client.changedstate.wait(delay.total_seconds())
1399
(client.changedstate.wait
1400
(float(client._timedelta_to_milliseconds(delay)
2407
1402
client.changedstate.release()
2408
1403
time2 = datetime.datetime.now()
2409
1404
if (time2 - time) >= delay:
2410
1405
if not client.approved_by_default:
2411
log.warning("Client %s timed out while"
2412
" waiting for approval",
1406
logger.warning("Client %s timed out while"
1407
" waiting for approval",
2414
1409
if self.server.use_dbus:
2415
1410
# Emit D-Bus signal
2416
1411
client.Rejected("Approval timed out")
2421
1416
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)
2430
# bump the timeout using extended_timeout
2431
client.bump_timeout(client.extended_timeout)
1419
while sent_size < len(client.secret):
1421
sent = session.send(client.secret[sent_size:])
1422
except gnutls.errors.GNUTLSError as error:
1423
logger.warning("gnutls send failed")
1425
logger.debug("Sent: %d, remaining: %d",
1426
sent, len(client.secret)
1427
- (sent_size + sent))
1430
logger.info("Sending secret to %s", client.name)
1431
# bump the timeout as if seen
1432
client.checked_ok(client.extended_timeout)
2432
1433
if self.server.use_dbus:
2433
1434
# Emit D-Bus signal
2434
1435
client.GotSecret()
2437
1438
if approval_required:
2438
1439
client.approvals_pending -= 1
2441
except gnutls.Error as error:
2442
log.warning("GnuTLS bye failed", exc_info=error)
1442
except gnutls.errors.GNUTLSError as error:
1443
logger.warning("GnuTLS bye failed")
2445
1446
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
1447
"Return the peer's OpenPGP certificate as a bytestring"
1448
# If not an OpenPGP certificate...
1449
if (gnutls.library.functions
1450
.gnutls_certificate_type_get(session._c_object)
1451
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1452
# ...do the normal thing
1453
return session.peer_certificate
2462
1454
list_size = ctypes.c_uint(1)
2463
cert_list = (gnutls.certificate_get_peers
2464
(session, ctypes.byref(list_size)))
1455
cert_list = (gnutls.library.functions
1456
.gnutls_certificate_get_peers
1457
(session._c_object, ctypes.byref(list_size)))
2465
1458
if not bool(cert_list) and list_size.value != 0:
2466
raise gnutls.Error("error getting peer certificate")
1459
raise gnutls.errors.GNUTLSError("error getting peer"
2467
1461
if list_size.value == 0:
2469
1463
cert = cert_list[0]
2470
1464
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
1467
def fingerprint(openpgp):
2509
1468
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2510
1469
# 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)))
1470
datum = (gnutls.library.types
1471
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1474
ctypes.c_uint(len(openpgp))))
2515
1475
# New empty GnuTLS certificate
2516
crt = gnutls.openpgp_crt_t()
2517
gnutls.openpgp_crt_init(ctypes.byref(crt))
1476
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1477
(gnutls.library.functions
1478
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2518
1479
# Import the OpenPGP public key into the certificate
2519
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2520
gnutls.OPENPGP_FMT_RAW)
1480
(gnutls.library.functions
1481
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1482
gnutls.library.constants
1483
.GNUTLS_OPENPGP_FMT_RAW))
2521
1484
# Verify the self signature in the key
2522
1485
crtverify = ctypes.c_uint()
2523
gnutls.openpgp_crt_verify_self(crt, 0,
2524
ctypes.byref(crtverify))
1486
(gnutls.library.functions
1487
.gnutls_openpgp_crt_verify_self(crt, 0,
1488
ctypes.byref(crtverify)))
2525
1489
if crtverify.value != 0:
2526
gnutls.openpgp_crt_deinit(crt)
2527
raise gnutls.CertificateSecurityError(code
1490
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1491
raise (gnutls.errors.CertificateSecurityError
2529
1493
# New buffer for the fingerprint
2530
1494
buf = ctypes.create_string_buffer(20)
2531
1495
buf_len = ctypes.c_size_t()
2532
1496
# Get the fingerprint from the certificate into the buffer
2533
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2534
ctypes.byref(buf_len))
1497
(gnutls.library.functions
1498
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1499
ctypes.byref(buf_len)))
2535
1500
# Deinit the certificate
2536
gnutls.openpgp_crt_deinit(crt)
1501
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2537
1502
# Convert the buffer to a Python bytestring
2538
1503
fpr = ctypes.string_at(buf, buf_len.value)
2539
1504
# Convert the bytestring to hexadecimal notation
2540
hex_fpr = binascii.hexlify(fpr).upper()
1505
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2544
class MultiprocessingMixIn:
1509
class MultiprocessingMixIn(object):
2545
1510
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2547
1511
def sub_process_main(self, request, address):
2549
1513
self.finish_request(request, address)
2551
1515
self.handle_error(request, address)
2552
1516
self.close_request(request)
2554
1518
def process_request(self, request, address):
2555
1519
"""Start a new process to process the request."""
2556
proc = multiprocessing.Process(target=self.sub_process_main,
2557
args=(request, address))
1520
proc = multiprocessing.Process(target = self.sub_process_main,
2562
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1527
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2563
1528
""" adds a pipe to the MixIn """
2565
1529
def process_request(self, request, client_address):
2566
1530
"""Overrides and wraps the original process_request().
2568
1532
This function creates a new pipe in self.pipe
2570
1534
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2572
1536
proc = MultiprocessingMixIn.process_request(self, request,
2573
1537
client_address)
2574
1538
self.child_pipe.close()
2575
1539
self.add_pipe(parent_pipe, proc)
2577
1541
def add_pipe(self, parent_pipe, proc):
2578
1542
"""Dummy function; override as necessary"""
2579
raise NotImplementedError()
1543
raise NotImplementedError
2582
1546
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2583
socketserver.TCPServer):
2584
"""IPv6-capable TCP server. Accepts None as address and/or port
1547
socketserver.TCPServer, object):
1548
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2587
1551
enabled: Boolean; whether this server is activated yet
2588
1552
interface: None or a network interface name (string)
2589
1553
use_ipv6: Boolean; to use IPv6 or not
2592
1555
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().
1556
interface=None, use_ipv6=True):
2599
1557
self.interface = interface
2601
1559
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
1560
socketserver.TCPServer.__init__(self, server_address,
2630
1561
RequestHandlerClass)
2632
1562
def server_bind(self):
2633
1563
"""This overrides the normal server_bind() function
2634
1564
to bind to an interface if one was specified, and also NOT to
2635
1565
bind to an address or port if they were not specified."""
2636
global SO_BINDTODEVICE
2637
1566
if self.interface is not None:
2638
1567
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)
1568
logger.error("SO_BINDTODEVICE does not exist;"
1569
" cannot bind to interface %s",
1573
self.socket.setsockopt(socket.SOL_SOCKET,
1577
except socket.error as error:
1578
if error[0] == errno.EPERM:
1579
logger.error("No permission to"
1580
" bind to interface %s",
1582
elif error[0] == errno.ENOPROTOOPT:
1583
logger.error("SO_BINDTODEVICE not available;"
1584
" cannot bind to interface %s",
2659
1588
# Only bind(2) the socket if we really need to.
2660
1589
if self.server_address[0] or self.server_address[1]:
2661
if self.server_address[1]:
2662
self.allow_reuse_address = True
2663
1590
if not self.server_address[0]:
2664
1591
if self.address_family == socket.AF_INET6:
2665
any_address = "::" # in6addr_any
1592
any_address = "::" # in6addr_any
2667
any_address = "0.0.0.0" # INADDR_ANY
1594
any_address = socket.INADDR_ANY
2668
1595
self.server_address = (any_address,
2669
1596
self.server_address[1])
2670
1597
elif not self.server_address[1]:
2671
self.server_address = (self.server_address[0], 0)
1598
self.server_address = (self.server_address[0],
2672
1600
# if self.interface:
2673
1601
# self.server_address = (self.server_address[0],
2681
1609
class MandosServer(IPv6_TCPServer):
2682
1610
"""Mandos server.
2685
1613
clients: set of Client objects
2686
1614
gnutls_priority GnuTLS priority string
2687
1615
use_dbus: Boolean; to emit D-Bus signals or not
2689
Assumes a GLib.MainLoop event loop.
1617
Assumes a gobject.MainLoop event loop.
2692
1619
def __init__(self, server_address, RequestHandlerClass,
2696
gnutls_priority=None,
1620
interface=None, use_ipv6=True, clients=None,
1621
gnutls_priority=None, use_dbus=True):
2699
1622
self.enabled = False
2700
1623
self.clients = clients
2701
1624
if self.clients is None:
1625
self.clients = set()
2703
1626
self.use_dbus = use_dbus
2704
1627
self.gnutls_priority = gnutls_priority
2705
1628
IPv6_TCPServer.__init__(self, server_address,
2706
1629
RequestHandlerClass,
2707
interface=interface,
1630
interface = interface,
1631
use_ipv6 = use_ipv6)
2711
1632
def server_activate(self):
2712
1633
if self.enabled:
2713
1634
return socketserver.TCPServer.server_activate(self)
2715
1636
def enable(self):
2716
1637
self.enabled = True
2718
1639
def add_pipe(self, parent_pipe, proc):
2719
1640
# 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):
2731
# error, or the other end of multiprocessing.Pipe has closed
2732
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2733
# Wait for other process to exit
1641
gobject.io_add_watch(parent_pipe.fileno(),
1642
gobject.IO_IN | gobject.IO_HUP,
1643
functools.partial(self.handle_ipc,
1648
def handle_ipc(self, source, condition, parent_pipe=None,
1649
proc = None, client_object=None):
1651
gobject.IO_IN: "IN", # There is data to read.
1652
gobject.IO_OUT: "OUT", # Data can be written (without
1654
gobject.IO_PRI: "PRI", # There is urgent data to read.
1655
gobject.IO_ERR: "ERR", # Error condition.
1656
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1657
# broken, usually for pipes and
1660
conditions_string = ' | '.join(name
1662
condition_names.iteritems()
1663
if cond & condition)
1664
# error or the other end of multiprocessing.Pipe has closed
1665
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2737
1669
# Read a request from the child
2738
1670
request = parent_pipe.recv()
2739
1671
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:
1673
if command == 'init':
1675
address = request[2]
1677
for c in self.clients:
1678
if c.fingerprint == fpr:
2757
log.info("Client not found for key ID: %s, address:"
2758
" %s", key_id or fpr, address)
1682
logger.info("Client not found for fingerprint: %s, ad"
1683
"dress: %s", fpr, address)
2759
1684
if self.use_dbus:
2760
1685
# Emit D-Bus signal
2761
mandos_dbus_service.ClientNotFound(key_id or fpr,
1686
mandos_dbus_service.ClientNotFound(fpr,
2763
1688
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))
1691
gobject.io_add_watch(parent_pipe.fileno(),
1692
gobject.IO_IN | gobject.IO_HUP,
1693
functools.partial(self.handle_ipc,
2773
1699
parent_pipe.send(True)
2774
1700
# remove the old hook in favor of the new above hook on
2777
if command == "funcall":
1703
if command == 'funcall':
2778
1704
funcname = request[1]
2779
1705
args = request[2]
2780
1706
kwargs = request[3]
2782
parent_pipe.send(("data", getattr(client_object,
1708
parent_pipe.send(('data', getattr(client_object,
2783
1709
funcname)(*args,
2786
if command == "getattr":
1712
if command == 'getattr':
2787
1713
attrname = request[1]
2788
if isinstance(client_object.__getattribute__(attrname),
2789
collections.abc.Callable):
2790
parent_pipe.send(("function", ))
1714
if callable(client_object.__getattribute__(attrname)):
1715
parent_pipe.send(('function',))
2793
"data", client_object.__getattribute__(attrname)))
2795
if command == "setattr":
1717
parent_pipe.send(('data', client_object
1718
.__getattribute__(attrname)))
1720
if command == 'setattr':
2796
1721
attrname = request[1]
2797
1722
value = request[2]
2798
1723
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
1728
def string_to_delta(interval):
2905
1729
"""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)
1731
>>> string_to_delta('7d')
1732
datetime.timedelta(7)
1733
>>> string_to_delta('60s')
1734
datetime.timedelta(0, 60)
1735
>>> string_to_delta('60m')
1736
datetime.timedelta(0, 3600)
1737
>>> string_to_delta('24h')
1738
datetime.timedelta(1)
1739
>>> string_to_delta('1w')
1740
datetime.timedelta(7)
1741
>>> string_to_delta('5m 30s')
1742
datetime.timedelta(0, 330)
2922
return rfc3339_duration_to_delta(interval)
2926
1744
timevalue = datetime.timedelta(0)
2927
1745
for s in interval.split():
1747
suffix = unicode(s[-1])
2930
1748
value = int(s[:-1])
2931
1749
if suffix == "d":
2932
1750
delta = datetime.timedelta(value)
3004
1846
parser.add_argument("--no-dbus", action="store_false",
3005
1847
dest="use_dbus", help="Do not provide D-Bus"
3006
" system bus interface", default=None)
1848
" system bus interface")
3007
1849
parser.add_argument("--no-ipv6", action="store_false",
3008
dest="use_ipv6", help="Do not use IPv6",
3010
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",
1850
dest="use_ipv6", help="Do not use IPv6")
3024
1851
options = parser.parse_args()
3026
1858
# 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",
1859
server_defaults = { "interface": "",
1864
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1865
"servicename": "Mandos",
3050
1871
# Parse config file for server-global settings
3051
server_config = configparser.ConfigParser(server_defaults)
1872
server_config = configparser.SafeConfigParser(server_defaults)
3052
1873
del server_defaults
3053
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3054
# Convert the ConfigParser object to a dict
1874
server_config.read(os.path.join(options.configdir,
1876
# Convert the SafeConfigParser object to a dict
3055
1877
server_settings = server_config.defaults()
3056
1878
# Use the appropriate methods on the non-string config options
3057
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3058
"foreground", "zeroconf"):
1879
for option in ("debug", "use_dbus", "use_ipv6"):
3059
1880
server_settings[option] = server_config.getboolean("DEFAULT",
3061
1882
if server_settings["port"]:
3062
1883
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
1885
del server_config
3075
1887
# Override the settings from the config file with command line
3076
1888
# options, if set.
3077
1889
for option in ("interface", "address", "port", "debug",
3078
"priority", "servicename", "configdir", "use_dbus",
3079
"use_ipv6", "debuglevel", "restore", "statedir",
3080
"socket", "foreground", "zeroconf"):
1890
"priority", "servicename", "configdir",
1891
"use_dbus", "use_ipv6", "debuglevel"):
3081
1892
value = getattr(options, option)
3082
1893
if value is not None:
3083
1894
server_settings[option] = value
3085
1896
# Force all strings to be unicode
3086
1897
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
1898
if type(server_settings[option]) is str:
1899
server_settings[option] = unicode(server_settings[option])
3097
1900
# Now we have our good server settings in "server_settings"
3099
1902
##################################################################
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
1904
# For convenience
3107
1905
debug = server_settings["debug"]
3108
1906
debuglevel = server_settings["debuglevel"]
3109
1907
use_dbus = server_settings["use_dbus"]
3110
1908
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)
3122
level = getattr(logging, debuglevel.upper())
3123
initlogger(debug, level)
3125
1910
if server_settings["servicename"] != "Mandos":
3126
syslogger.setFormatter(
3127
logging.Formatter("Mandos ({}) [%(process)d]:"
3128
" %(levelname)s: %(message)s".format(
3129
server_settings["servicename"])))
1911
syslogger.setFormatter(logging.Formatter
1912
('Mandos (%s) [%%(process)d]:'
1913
' %%(levelname)s: %%(message)s'
1914
% server_settings["servicename"]))
3131
1916
# Parse config file with clients
3132
client_config = configparser.ConfigParser(Client.client_defaults)
1917
client_defaults = { "timeout": "5m",
1918
"extended_timeout": "15m",
1920
"checker": "fping -q -- %%(host)s",
1922
"approval_delay": "0s",
1923
"approval_duration": "1s",
1925
client_config = configparser.SafeConfigParser(client_defaults)
3133
1926
client_config.read(os.path.join(server_settings["configdir"],
3134
1927
"clients.conf"))
3136
1929
global mandos_dbus_service
3137
1930
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
1932
tcp_server = MandosServer((server_settings["address"],
1933
server_settings["port"]),
1935
interface=(server_settings["interface"]
1939
server_settings["priority"],
1942
pidfilename = "/var/run/mandos.pid"
1944
pidfile = open(pidfilename, "w")
1946
logger.error("Could not open file %r", pidfilename)
1949
uid = pwd.getpwnam("_mandos").pw_uid
1950
gid = pwd.getpwnam("_mandos").pw_gid
1953
uid = pwd.getpwnam("mandos").pw_uid
1954
gid = pwd.getpwnam("mandos").pw_gid
3168
1955
except KeyError:
1957
uid = pwd.getpwnam("nobody").pw_uid
1958
gid = pwd.getpwnam("nobody").pw_gid
3176
log.debug("Did setuid/setgid to %s:%s", uid, gid)
3177
1965
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:
1966
if error[0] != errno.EPERM:
1969
if not debug and not debuglevel:
1970
syslogger.setLevel(logging.WARNING)
1971
console.setLevel(logging.WARNING)
1973
level = getattr(logging, debuglevel.upper())
1974
syslogger.setLevel(level)
1975
console.setLevel(level)
3184
1978
# Enable all possible GnuTLS debugging
3186
1980
# "Use a log level over 10 to enable all debugging options."
3187
1981
# - GnuTLS manual
3188
gnutls.global_set_log_level(11)
1982
gnutls.library.functions.gnutls_global_set_log_level(11)
1984
@gnutls.library.types.gnutls_log_func
3191
1985
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)
1986
logger.debug("GnuTLS: %s", string[:-1])
1988
(gnutls.library.functions
1989
.gnutls_global_set_log_function(debug_gnutls))
3197
1991
# Redirect stdin so all checkers get /dev/null
3198
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1992
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3199
1993
os.dup2(null, sys.stdin.fileno())
1997
# No console logging
1998
logger.removeHandler(console)
3203
2000
# Need to fork before connecting to D-Bus
3205
2002
# 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
2005
global main_loop
3214
2006
# From the Avahi example code
3215
DBusGMainLoop(set_as_default=True)
3216
main_loop = GLib.MainLoop()
2007
DBusGMainLoop(set_as_default=True )
2008
main_loop = gobject.MainLoop()
3217
2009
bus = dbus.SystemBus()
3218
2010
# End of Avahi example code
3221
2013
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)
2014
bus, do_not_queue=True)
2015
old_bus_name = (dbus.service.BusName
2016
("se.bsnet.fukt.Mandos", bus,
2018
except dbus.exceptions.NameExistsException as e:
2019
logger.error(unicode(e) + ", disabling D-Bus")
3229
2020
use_dbus = False
3230
2021
server_settings["use_dbus"] = False
3231
2022
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"))
2023
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2024
service = AvahiService(name = server_settings["servicename"],
2025
servicetype = "_mandos._tcp",
2026
protocol = protocol, bus = bus)
2027
if server_settings["interface"]:
2028
service.interface = (if_nametoindex
2029
(str(server_settings["interface"])))
3243
2031
global multiprocessing_manager
3244
2032
multiprocessing_manager = multiprocessing.Manager()
3246
2034
client_class = Client
3248
client_class = functools.partial(ClientDBus, bus=bus)
3250
client_settings = Client.config_parser(client_config)
3251
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.
3263
if server_settings["restore"]:
3265
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]
3316
os.remove(stored_state_path)
3317
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:",
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)
2036
client_class = functools.partial(ClientDBusTransitional,
2038
def client_config_items(config, section):
2039
special_settings = {
2040
"approved_by_default":
2041
lambda: config.getboolean(section,
2042
"approved_by_default"),
2044
for name, value in config.items(section):
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)
2046
yield (name, special_settings[name]())
2050
tcp_server.clients.update(set(
2051
client_class(name = section,
2052
config= dict(client_config_items(
2053
client_config, section)))
2054
for section in client_config.sections()))
3402
2055
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",
2056
logger.warning("No clients defined")
2062
pidfile.write(str(pid) + "\n".encode("utf-8"))
2065
logger.error("Could not write to file %r with PID %d",
2068
# "pidfile" was never created
3415
2070
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)
2072
signal.signal(signal.SIGINT, signal.SIG_IGN)
2074
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2075
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):
2078
class MandosDBusService(dbus.service.Object):
3426
2079
"""A D-Bus proxy object"""
3428
2080
def __init__(self):
3429
2081
dbus.service.Object.__init__(self, bus, "/")
3431
2082
_interface = "se.recompile.Mandos"
3433
2084
@dbus.service.signal(_interface, signature="o")
3434
2085
def ClientAdded(self, objpath):
3438
2089
@dbus.service.signal(_interface, signature="ss")
3439
def ClientNotFound(self, key_id, address):
2090
def ClientNotFound(self, fingerprint, address):
3443
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3445
2094
@dbus.service.signal(_interface, signature="os")
3446
2095
def ClientRemoved(self, objpath, name):
3450
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3452
2099
@dbus.service.method(_interface, out_signature="ao")
3453
2100
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":
2102
return dbus.Array(c.dbus_object_path
2103
for c in tcp_server.clients)
3460
2105
@dbus.service.method(_interface,
3461
2106
out_signature="a{oa{sv}}")
3462
2107
def GetAllClientsWithProperties(self):
3464
2109
return dbus.Dictionary(
3465
{c.dbus_object_path: c.GetAll(
3466
"se.recompile.Mandos.Client")
3467
for c in tcp_server.clients.values()},
2110
((c.dbus_object_path, c.GetAll(""))
2111
for c in tcp_server.clients),
3468
2112
signature="oa{sv}")
3470
2114
@dbus.service.method(_interface, in_signature="o")
3471
2115
def RemoveClient(self, object_path):
3473
for c in tcp_server.clients.values():
2117
for c in tcp_server.clients:
3474
2118
if c.dbus_object_path == object_path:
3475
del tcp_server.clients[c.name]
2119
tcp_server.clients.remove(c)
3476
2120
c.remove_from_connection()
3477
# Don't signal the disabling
2121
# Don't signal anything except ClientRemoved
3478
2122
c.disable(quiet=True)
3479
# Emit D-Bus signal for removal
3480
self.client_removed_signal(c)
2124
self.ClientRemoved(object_path, c.name)
3482
2126
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
2130
class MandosDBusServiceTransitional(MandosDBusService):
2131
__metaclass__ = AlternateDBusNamesMetaclass
2132
mandos_dbus_service = MandosDBusServiceTransitional()
3530
2135
"Cleanup function; run on exit"
3534
mp.active_children()
3536
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"]
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:",
3592
# Delete all clients, and settings from config
2138
multiprocessing.active_children()
3593
2139
while tcp_server.clients:
3594
name, client = tcp_server.clients.popitem()
2140
client = tcp_server.clients.pop()
3596
2142
client.remove_from_connection()
3597
# Don't signal the disabling
2143
client.disable_hook = None
2144
# Don't signal anything except ClientRemoved
3598
2145
client.disable(quiet=True)
3599
# Emit D-Bus signal for removal
3601
mandos_dbus_service.client_removed_signal(client)
3602
client_settings.clear()
2148
mandos_dbus_service.ClientRemoved(client
3604
2152
atexit.register(cleanup)
3606
for client in tcp_server.clients.values():
2154
for client in tcp_server.clients:
3608
# Emit D-Bus signal for adding
3609
mandos_dbus_service.client_added_signal(client)
3610
# Need to initiate checking of clients
3612
client.init_checker()
2157
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3614
2160
tcp_server.enable()
3615
2161
tcp_server.server_activate()
3617
2163
# Find out what port we got
3619
service.port = tcp_server.socket.getsockname()[1]
2164
service.port = tcp_server.socket.getsockname()[1]
3621
log.info("Now listening on address %r, port %d, flowinfo %d,"
3622
" scope_id %d", *tcp_server.socket.getsockname())
2166
logger.info("Now listening on address %r, port %d,"
2167
" flowinfo %d, scope_id %d"
2168
% tcp_server.socket.getsockname())
3624
log.info("Now listening on address %r, port %d",
3625
*tcp_server.socket.getsockname())
3627
# service.interface = tcp_server.socket.getsockname()[3]
2170
logger.info("Now listening on address %r, port %d"
2171
% tcp_server.socket.getsockname())
2173
#service.interface = tcp_server.socket.getsockname()[3]
3631
# From the Avahi example code
3634
except dbus.exceptions.DBusException as error:
3635
log.critical("D-Bus Exception", exc_info=error)
3638
# End of Avahi example code
3641
GLib.IOChannel.unix_new(tcp_server.fileno()),
3642
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3643
lambda *args, **kwargs: (tcp_server.handle_request
3644
(*args[2:], **kwargs) or True))
3646
log.debug("Starting main loop")
2176
# From the Avahi example code
2179
except dbus.exceptions.DBusException as error:
2180
logger.critical("DBusException: %s", error)
2183
# End of Avahi example code
2185
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2186
lambda *args, **kwargs:
2187
(tcp_server.handle_request
2188
(*args[2:], **kwargs) or True))
2190
logger.debug("Starting main loop")
3647
2191
main_loop.run()
3648
2192
except AvahiError as error:
3649
log.critical("Avahi Error", exc_info=error)
2193
logger.critical("AvahiError: %s", error)
3652
2196
except KeyboardInterrupt:
3654
2198
print("", file=sys.stderr)
3655
log.debug("Server received KeyboardInterrupt")
3656
log.debug("Server exiting")
2199
logger.debug("Server received KeyboardInterrupt")
2200
logger.debug("Server exiting")
3657
2201
# Must run before the D-Bus bus name gets deregistered
3661
def parse_test_args():
3662
# type: () -> argparse.Namespace
3663
parser = argparse.ArgumentParser(add_help=False)
3664
parser.add_argument("--check", action="store_true")
3665
parser.add_argument("--prefix", )
3666
args, unknown_args = parser.parse_known_args()
3668
# Remove test options from sys.argv
3669
sys.argv[1:] = unknown_args
3672
# Add all tests from doctest strings
3673
def load_tests(loader, tests, none):
3675
tests.addTests(doctest.DocTestSuite())
3678
if __name__ == "__main__":
3679
options = parse_test_args()
3682
extra_test_prefix = options.prefix
3683
if extra_test_prefix is not None:
3684
if not (unittest.main(argv=[""], exit=False)
3685
.result.wasSuccessful()):
3687
class ExtraTestLoader(unittest.TestLoader):
3688
testMethodPrefix = extra_test_prefix
3689
# Call using ./scriptname --test [--verbose]
3690
unittest.main(argv=[""], testLoader=ExtraTestLoader())
3692
unittest.main(argv=[""])
3700
# (lambda (&optional extra)
3701
# (if (not (funcall run-tests-in-test-buffer default-directory
3703
# (funcall show-test-buffer-in-test-window)
3704
# (funcall remove-test-window)
3705
# (if extra (message "Extra tests run successfully!"))))
3706
# run-tests-in-test-buffer:
3707
# (lambda (dir &optional extra)
3708
# (with-current-buffer (get-buffer-create "*Test*")
3709
# (setq buffer-read-only nil
3710
# default-directory dir)
3712
# (compilation-mode))
3713
# (let ((process-result
3714
# (let ((inhibit-read-only t))
3715
# (process-file-shell-command
3716
# (funcall get-command-line extra) nil "*Test*"))))
3717
# (and (numberp process-result)
3718
# (= process-result 0))))
3720
# (lambda (&optional extra)
3721
# (let ((quoted-script
3722
# (shell-quote-argument (funcall get-script-name))))
3724
# (concat "%s --check" (if extra " --prefix=atest" ""))
3728
# (if (fboundp 'file-local-name)
3729
# (file-local-name (buffer-file-name))
3730
# (or (file-remote-p (buffer-file-name) 'localname)
3731
# (buffer-file-name))))
3732
# remove-test-window:
3734
# (let ((test-window (get-buffer-window "*Test*")))
3735
# (if test-window (delete-window test-window))))
3736
# show-test-buffer-in-test-window:
3738
# (when (not (get-buffer-window-list "*Test*"))
3739
# (setq next-error-last-buffer (get-buffer "*Test*"))
3740
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3741
# (display-buffer-overriding-action
3742
# `((display-buffer-in-side-window) (side . ,side)
3743
# (window-height . fit-window-to-buffer)
3744
# (window-width . fit-window-to-buffer))))
3745
# (display-buffer "*Test*"))))
3748
# (let* ((run-extra-tests (lambda () (interactive)
3749
# (funcall run-tests t)))
3750
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3751
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
3752
# (setq minor-mode-overriding-map-alist
3753
# (cons `(run-tests . ,outer-keymap)
3754
# minor-mode-overriding-map-alist)))
3755
# (add-hook 'after-save-hook run-tests 90 t))
2205
if __name__ == '__main__':