2
# -*- mode: python; coding: utf-8 -*-
2
# -*- coding: utf-8; lexical-binding: t -*-
4
4
# Mandos server - give out binary blobs to connecting clients.
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
13
13
# Everything else is
14
# Copyright © 2008-2015 Teddy Hogeborn
15
# Copyright © 2008-2015 Björn Påhlsson
17
# This program is free software: you can redistribute it and/or modify
18
# it under the terms of the GNU General Public License as published by
14
# Copyright © 2008-2022 Teddy Hogeborn
15
# Copyright © 2008-2022 Björn Påhlsson
17
# This file is part of Mandos.
19
# Mandos is free software: you can redistribute it and/or modify it
20
# under the terms of the GNU General Public License as published by
19
21
# the Free Software Foundation, either version 3 of the License, or
20
22
# (at your option) any later version.
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
24
26
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25
27
# GNU General Public License for more details.
27
29
# You should have received a copy of the GNU General Public License
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
31
32
# Contact the authors at <mandos@recompile.se>.
34
34
from __future__ import (division, absolute_import, print_function,
37
from future_builtins import *
38
from future_builtins import *
39
import SocketServer as socketserver
48
import SocketServer as socketserver
45
import gnutls.connection
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
55
import ConfigParser as configparser
59
63
import logging.handlers
65
import cPickle as pickle
70
import cPickle as pickle
66
73
import multiprocessing
74
84
import dbus.service
86
from gi.repository import GLib
77
87
from dbus.mainloop.glib import DBusGMainLoop
80
90
import xml.dom.minidom
93
if sys.version_info.major == 2:
98
# Add collections.abc.Callable if it does not exist
100
collections.abc.Callable
101
except AttributeError:
103
Callable = collections.Callable
104
collections.abc = abc
107
# Add shlex.quote if it does not exist
110
except AttributeError:
111
shlex.quote = re.escape
113
# Show warnings by default
114
if not sys.warnoptions:
116
warnings.simplefilter("default")
118
# Try to find the value of SO_BINDTODEVICE:
120
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
121
# newer, and it is also the most natural place for it:
84
122
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
123
except AttributeError:
125
# This is where SO_BINDTODEVICE was up to and including Python
87
127
from IN import SO_BINDTODEVICE
88
128
except ImportError:
89
SO_BINDTODEVICE = None
91
if sys.version_info.major == 2:
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
95
147
stored_state_file = "clients.pickle"
97
logger = logging.getLogger()
149
log = logging.getLogger(os.path.basename(sys.argv[0]))
150
logging.captureWarnings(True) # Show warnings via the logging system
101
154
if_nametoindex = ctypes.cdll.LoadLibrary(
102
155
ctypes.util.find_library("c")).if_nametoindex
103
156
except (OSError, AttributeError):
105
158
def if_nametoindex(interface):
106
159
"Get an interface index the hard way, i.e. using fcntl()"
107
160
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
183
265
.replace(b"\n", b"\\n")
184
266
.replace(b"\0", b"\\x00"))
187
269
def encrypt(self, data, password):
188
270
passphrase = self.password_encode(password)
189
271
with tempfile.NamedTemporaryFile(
190
272
dir=self.tempdir) as passfile:
191
273
passfile.write(passphrase)
193
proc = subprocess.Popen(['gpg', '--symmetric',
275
proc = subprocess.Popen([self.gpg, "--symmetric",
196
278
+ self.gnupgargs,
197
stdin = subprocess.PIPE,
198
stdout = subprocess.PIPE,
199
stderr = subprocess.PIPE)
200
ciphertext, err = proc.communicate(input = data)
279
stdin=subprocess.PIPE,
280
stdout=subprocess.PIPE,
281
stderr=subprocess.PIPE)
282
ciphertext, err = proc.communicate(input=data)
201
283
if proc.returncode != 0:
202
284
raise PGPError(err)
203
285
return ciphertext
205
287
def decrypt(self, data, password):
206
288
passphrase = self.password_encode(password)
207
289
with tempfile.NamedTemporaryFile(
208
dir = self.tempdir) as passfile:
290
dir=self.tempdir) as passfile:
209
291
passfile.write(passphrase)
211
proc = subprocess.Popen(['gpg', '--decrypt',
293
proc = subprocess.Popen([self.gpg, "--decrypt",
214
296
+ self.gnupgargs,
215
stdin = subprocess.PIPE,
216
stdout = subprocess.PIPE,
217
stderr = subprocess.PIPE)
218
decrypted_plaintext, err = proc.communicate(input = data)
297
stdin=subprocess.PIPE,
298
stdout=subprocess.PIPE,
299
stderr=subprocess.PIPE)
300
decrypted_plaintext, err = proc.communicate(input=data)
219
301
if proc.returncode != 0:
220
302
raise PGPError(err)
221
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
224
332
class AvahiError(Exception):
225
333
def __init__(self, value, *args, **kwargs):
226
334
self.value = value
405
523
class AvahiServiceToSyslog(AvahiService):
406
524
def rename(self, *args, **kwargs):
407
525
"""Add the new name to the syslog messages"""
408
ret = AvahiService.rename(self, *args, **kwargs)
526
ret = super(AvahiServiceToSyslog, self).rename(*args,
409
528
syslogger.setFormatter(logging.Formatter(
410
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
529
"Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
411
530
.format(self.name)))
415
class Client(object):
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))
416
875
"""A representation of a client host served by this server.
419
approved: bool(); 'None' if not yet approved/disapproved
878
approved: bool(); None if not yet approved/disapproved
420
879
approval_delay: datetime.timedelta(); Time to wait for approval
421
880
approval_duration: datetime.timedelta(); Duration of one approval
422
checker: subprocess.Popen(); a running checker process used
423
to see if the client lives.
424
'None' if no process is running.
425
checker_callback_tag: a gobject event source tag, or None
881
checker: multiprocessing.Process(); a running checker process used
882
to see if the client lives. None if no process is
884
checker_callback_tag: a GLib event source tag, or None
426
885
checker_command: string; External command which is run to check
427
886
if client lives. %() expansions are done at
428
887
runtime with vars(self) as dict, so that for
429
888
instance %(name)s can be used in the command.
430
checker_initiator_tag: a gobject event source tag, or None
889
checker_initiator_tag: a GLib event source tag, or None
431
890
created: datetime.datetime(); (UTC) object creation
432
891
client_structure: Object describing what attributes a client has
433
892
and is used for storing the client at exit
434
893
current_checker_command: string; current running checker_command
435
disable_initiator_tag: a gobject event source tag, or None
894
disable_initiator_tag: a GLib event source tag, or None
437
896
fingerprint: string (40 or 32 hexadecimal digits); used to
438
uniquely identify the client
897
uniquely identify an OpenPGP client
898
key_id: string (64 hexadecimal digits); used to uniquely identify
899
a client using raw public keys
439
900
host: string; available for use by the checker command
440
901
interval: datetime.timedelta(); How often to start a new checker
441
902
last_approval_request: datetime.datetime(); (UTC) or None
582
1050
self.last_enabled = datetime.datetime.utcnow()
583
1051
self.init_checker()
584
1052
self.send_changedstate()
586
1054
def disable(self, quiet=True):
587
1055
"""Disable this client."""
588
1056
if not getattr(self, "enabled", False):
591
logger.info("Disabling client %s", self.name)
1059
log.info("Disabling client %s", self.name)
592
1060
if getattr(self, "disable_initiator_tag", None) is not None:
593
gobject.source_remove(self.disable_initiator_tag)
1061
GLib.source_remove(self.disable_initiator_tag)
594
1062
self.disable_initiator_tag = None
595
1063
self.expires = None
596
1064
if getattr(self, "checker_initiator_tag", None) is not None:
597
gobject.source_remove(self.checker_initiator_tag)
1065
GLib.source_remove(self.checker_initiator_tag)
598
1066
self.checker_initiator_tag = None
599
1067
self.stop_checker()
600
1068
self.enabled = False
602
1070
self.send_changedstate()
603
# Do not run this again if called by a gobject.timeout_add
1071
# Do not run this again if called by a GLib.timeout_add
606
1074
def __del__(self):
609
1077
def init_checker(self):
610
1078
# Schedule a new checker to be started an 'interval' from now,
611
1079
# and every interval from then on.
612
1080
if self.checker_initiator_tag is not None:
613
gobject.source_remove(self.checker_initiator_tag)
614
self.checker_initiator_tag = gobject.timeout_add(
615
int(self.interval.total_seconds() * 1000),
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
616
1085
self.start_checker)
617
1086
# Schedule a disable() when 'timeout' has passed
618
1087
if self.disable_initiator_tag is not None:
619
gobject.source_remove(self.disable_initiator_tag)
620
self.disable_initiator_tag = gobject.timeout_add(
1088
GLib.source_remove(self.disable_initiator_tag)
1089
self.disable_initiator_tag = GLib.timeout_add(
621
1090
int(self.timeout.total_seconds() * 1000), self.disable)
622
1091
# Also start a new checker *right now*.
623
1092
self.start_checker()
625
def checker_callback(self, pid, condition, command):
1094
def checker_callback(self, source, condition, connection,
626
1096
"""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:
627
1102
self.checker_callback_tag = None
628
1103
self.checker = None
629
if os.WIFEXITED(condition):
630
self.last_checker_status = os.WEXITSTATUS(condition)
1106
self.last_checker_status = returncode
1107
self.last_checker_signal = None
631
1108
if self.last_checker_status == 0:
632
logger.info("Checker for %(name)s succeeded",
1109
log.info("Checker for %(name)s succeeded", vars(self))
634
1110
self.checked_ok()
636
logger.info("Checker for %(name)s failed", vars(self))
1112
log.info("Checker for %(name)s failed", vars(self))
638
1114
self.last_checker_status = -1
639
logger.warning("Checker for %(name)s crashed?",
1115
self.last_checker_signal = -returncode
1116
log.warning("Checker for %(name)s crashed?", vars(self))
642
1119
def checked_ok(self):
643
1120
"""Assert that the client has been seen, alive and well."""
644
1121
self.last_checked_ok = datetime.datetime.utcnow()
645
1122
self.last_checker_status = 0
1123
self.last_checker_signal = None
646
1124
self.bump_timeout()
648
1126
def bump_timeout(self, timeout=None):
649
1127
"""Bump up the timeout for this client."""
650
1128
if timeout is None:
651
1129
timeout = self.timeout
652
1130
if self.disable_initiator_tag is not None:
653
gobject.source_remove(self.disable_initiator_tag)
1131
GLib.source_remove(self.disable_initiator_tag)
654
1132
self.disable_initiator_tag = None
655
1133
if getattr(self, "enabled", False):
656
self.disable_initiator_tag = gobject.timeout_add(
1134
self.disable_initiator_tag = GLib.timeout_add(
657
1135
int(timeout.total_seconds() * 1000), self.disable)
658
1136
self.expires = datetime.datetime.utcnow() + timeout
660
1138
def need_approval(self):
661
1139
self.last_approval_request = datetime.datetime.utcnow()
663
1141
def start_checker(self):
664
1142
"""Start a new checker subprocess if one is not running.
666
1144
If a checker already exists, leave it running and do
668
1146
# The reason for not killing a running checker is that if we
673
1151
# checkers alone, the checker would have to take more time
674
1152
# than 'timeout' for the client to be disabled, which is as it
677
# If a checker exists, make sure it is not a zombie
679
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
680
except AttributeError:
682
except OSError as error:
683
if error.errno != errno.ECHILD:
687
logger.warning("Checker was a zombie")
688
gobject.source_remove(self.checker_callback_tag)
689
self.checker_callback(pid, status,
690
self.current_checker_command)
1155
if self.checker is not None and not self.checker.is_alive():
1156
log.warning("Checker was not alive; joining")
691
1159
# Start a new checker if needed
692
1160
if self.checker is None:
693
1161
# Escape attributes for the shell
694
1162
escaped_attrs = {
695
attr: re.escape(str(getattr(self, attr)))
696
for attr in self.runtime_expansions }
1163
attr: shlex.quote(str(getattr(self, attr)))
1164
for attr in self.runtime_expansions}
698
1166
command = self.checker_command % escaped_attrs
699
1167
except TypeError as error:
700
logger.error('Could not format string "%s"',
701
self.checker_command,
1168
log.error('Could not format string "%s"',
1169
self.checker_command, exc_info=error)
703
1170
return True # Try again later
704
1171
self.current_checker_command = command
706
logger.info("Starting checker %r for %s", command,
708
# We don't need to redirect stdout and stderr, since
709
# in normal mode, that is already done by daemon(),
710
# and in debug mode we don't want to. (Stdin is
711
# always replaced by /dev/null.)
712
# The exception is when not debugging but nevertheless
713
# running in the foreground; use the previously
716
if (not self.server_settings["debug"]
717
and self.server_settings["foreground"]):
718
popen_args.update({"stdout": wnull,
720
self.checker = subprocess.Popen(command,
725
except OSError as error:
726
logger.error("Failed to start subprocess",
729
self.checker_callback_tag = gobject.child_watch_add(
730
self.checker.pid, self.checker_callback, data=command)
731
# The checker may have completed before the gobject
732
# watch was added. Check for this.
734
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
735
except OSError as error:
736
if error.errno == errno.ECHILD:
737
# This should never happen
738
logger.error("Child process vanished",
743
gobject.source_remove(self.checker_callback_tag)
744
self.checker_callback(pid, status, command)
745
# Re-run this periodically if run by gobject.timeout_add
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
748
1200
def stop_checker(self):
749
1201
"""Force the checker process, if any, to stop."""
750
1202
if self.checker_callback_tag:
751
gobject.source_remove(self.checker_callback_tag)
1203
GLib.source_remove(self.checker_callback_tag)
752
1204
self.checker_callback_tag = None
753
1205
if getattr(self, "checker", None) is None:
755
logger.debug("Stopping checker for %(name)s", vars(self))
757
self.checker.terminate()
759
#if self.checker.poll() is None:
760
# self.checker.kill()
761
except OSError as error:
762
if error.errno != errno.ESRCH: # No such process
1207
log.debug("Stopping checker for %(name)s", vars(self))
1208
self.checker.terminate()
764
1209
self.checker = None
883
1329
for cls in self.__class__.__mro__
884
1330
for name, athing in
885
1331
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1333
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1335
path_keyword="object_path",
1336
connection_keyword="connection")
1337
def Introspect(self, object_path, connection):
1338
"""Overloading of standard D-Bus method.
1340
Inserts annotation tags on methods and signals.
1342
xmlstring = dbus.service.Object.Introspect(self, object_path,
1345
document = xml.dom.minidom.parseString(xmlstring)
1347
for if_tag in document.getElementsByTagName("interface"):
1348
# Add annotation tags
1349
for typ in ("method", "signal"):
1350
for tag in if_tag.getElementsByTagName(typ):
1352
for name, prop in (self.
1353
_get_all_dbus_things(typ)):
1354
if (name == tag.getAttribute("name")
1355
and prop._dbus_interface
1356
== if_tag.getAttribute("name")):
1357
annots.update(getattr(
1358
prop, "_dbus_annotations", {}))
1359
for name, value in annots.items():
1360
ann_tag = document.createElement(
1362
ann_tag.setAttribute("name", name)
1363
ann_tag.setAttribute("value", value)
1364
tag.appendChild(ann_tag)
1365
# Add interface annotation tags
1366
for annotation, value in dict(
1367
itertools.chain.from_iterable(
1368
annotations().items()
1369
for name, annotations
1370
in self._get_all_dbus_things("interface")
1371
if name == if_tag.getAttribute("name")
1373
ann_tag = document.createElement("annotation")
1374
ann_tag.setAttribute("name", annotation)
1375
ann_tag.setAttribute("value", value)
1376
if_tag.appendChild(ann_tag)
1377
# Fix argument name for the Introspect method itself
1378
if (if_tag.getAttribute("name")
1379
== dbus.INTROSPECTABLE_IFACE):
1380
for cn in if_tag.getElementsByTagName("method"):
1381
if cn.getAttribute("name") == "Introspect":
1382
for arg in cn.getElementsByTagName("arg"):
1383
if (arg.getAttribute("direction")
1385
arg.setAttribute("name",
1387
xmlstring = document.toxml("utf-8")
1389
except (AttributeError, xml.dom.DOMException,
1390
xml.parsers.expat.ExpatError) as error:
1391
log.error("Failed to override Introspection method",
1396
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1397
"""A D-Bus object with properties.
1399
Classes inheriting from this can use the dbus_service_property
1400
decorator to expose methods as D-Bus properties. It exposes the
1401
standard Get(), Set(), and GetAll() methods on the D-Bus.
887
1404
def _get_dbus_property(self, interface_name, property_name):
888
1405
"""Returns a bound method if one exists which is a D-Bus
889
1406
property with the specified name and interface.
1042
1555
document.unlink()
1043
1556
except (AttributeError, xml.dom.DOMException,
1044
1557
xml.parsers.expat.ExpatError) as error:
1045
logger.error("Failed to override Introspection method",
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",
1047
1631
return xmlstring
1050
1634
def datetime_to_dbus(dt, variant_level=0):
1051
1635
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1053
return dbus.String("", variant_level = variant_level)
1637
return dbus.String("", variant_level=variant_level)
1054
1638
return dbus.String(dt.isoformat(), variant_level=variant_level)
1637
2241
self.start_checker()
1639
2243
self.stop_checker()
1641
2245
# ObjectPath - property
2247
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2248
"org.freedesktop.DBus.Deprecated": "true"})
1642
2249
@dbus_service_property(_interface, signature="o", access="read")
1643
2250
def ObjectPath_dbus_property(self):
1644
return self.dbus_object_path # is already a dbus.ObjectPath
2251
return self.dbus_object_path # is already a dbus.ObjectPath
1646
2253
# Secret = property
2255
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
1647
2257
@dbus_service_property(_interface,
1648
2258
signature="ay",
1649
2259
access="write",
1650
2260
byte_arrays=True)
1651
2261
def Secret_dbus_property(self, value):
1652
2262
self.secret = bytes(value)
1657
class ProxyClient(object):
1658
def __init__(self, child_pipe, fpr, address):
2268
def __init__(self, child_pipe, key_id, fpr, address):
1659
2269
self._pipe = child_pipe
1660
self._pipe.send(('init', fpr, address))
2270
self._pipe.send(("init", key_id, fpr, address))
1661
2271
if not self._pipe.recv():
2272
raise KeyError(key_id or fpr)
1664
2274
def __getattribute__(self, name):
1666
2276
return super(ProxyClient, self).__getattribute__(name)
1667
self._pipe.send(('getattr', name))
2277
self._pipe.send(("getattr", name))
1668
2278
data = self._pipe.recv()
1669
if data[0] == 'data':
2279
if data[0] == "data":
1671
if data[0] == 'function':
2281
if data[0] == "function":
1673
2283
def func(*args, **kwargs):
1674
self._pipe.send(('funcall', name, args, kwargs))
2284
self._pipe.send(("funcall", name, args, kwargs))
1675
2285
return self._pipe.recv()[1]
1679
2289
def __setattr__(self, name, value):
1681
2291
return super(ProxyClient, self).__setattr__(name, value)
1682
self._pipe.send(('setattr', name, value))
2292
self._pipe.send(("setattr", name, value))
1685
2295
class ClientHandler(socketserver.BaseRequestHandler, object):
1686
2296
"""A class to handle client connections.
1688
2298
Instantiated once for each connection to handle it.
1689
2299
Note: This will run in its own forked process."""
1691
2301
def handle(self):
1692
2302
with contextlib.closing(self.server.child_pipe) as child_pipe:
1693
logger.info("TCP connection from: %s",
1694
str(self.client_address))
1695
logger.debug("Pipe FD: %d",
1696
self.server.child_pipe.fileno())
1698
session = gnutls.connection.ClientSession(
1699
self.request, gnutls.connection .X509Credentials())
1701
# Note: gnutls.connection.X509Credentials is really a
1702
# generic GnuTLS certificate credentials object so long as
1703
# no X.509 keys are added to it. Therefore, we can use it
1704
# here despite using OpenPGP certificates.
1706
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1707
# "+AES-256-CBC", "+SHA1",
1708
# "+COMP-NULL", "+CTYPE-OPENPGP",
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",
1710
2313
# Use a fallback default, since this MUST be set.
1711
2314
priority = self.server.gnutls_priority
1712
2315
if priority is None:
1713
2316
priority = "NORMAL"
1714
gnutls.library.functions.gnutls_priority_set_direct(
1715
session._c_object, priority, None)
2317
gnutls.priority_set_direct(session,
2318
priority.encode("utf-8"), None)
1717
2320
# Start communication using the Mandos protocol
1718
2321
# Get protocol number
1719
2322
line = self.request.makefile().readline()
1720
logger.debug("Protocol version: %r", line)
2323
log.debug("Protocol version: %r", line)
1722
2325
if int(line.strip().split()[0]) > 1:
1723
2326
raise RuntimeError(line)
1724
2327
except (ValueError, IndexError, RuntimeError) as error:
1725
logger.error("Unknown protocol version: %s", error)
2328
log.error("Unknown protocol version: %s", error)
1728
2331
# Start GnuTLS connection
1730
2333
session.handshake()
1731
except gnutls.errors.GNUTLSError as error:
1732
logger.warning("Handshake failed: %s", error)
2334
except gnutls.Error as error:
2335
log.warning("Handshake failed: %s", error)
1733
2336
# Do not run session.bye() here: the session is not
1734
2337
# established. Just abandon the request.
1736
logger.debug("Handshake succeeded")
2339
log.debug("Handshake succeeded")
1738
2341
approval_required = False
1741
fpr = self.fingerprint(
1742
self.peer_certificate(session))
1744
gnutls.errors.GNUTLSError) as error:
1745
logger.warning("Bad certificate: %s", error)
1747
logger.debug("Fingerprint: %s", fpr)
1750
client = ProxyClient(child_pipe, fpr,
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,
1751
2367
self.client_address)
1752
2368
except KeyError:
1755
2371
if client.approval_delay:
1756
2372
delay = client.approval_delay
1757
2373
client.approvals_pending += 1
1758
2374
approval_required = True
1761
2377
if not client.enabled:
1762
logger.info("Client %s is disabled",
2378
log.info("Client %s is disabled", client.name)
1764
2379
if self.server.use_dbus:
1765
2380
# Emit D-Bus signal
1766
2381
client.Rejected("Disabled")
1769
2384
if client.approved or not client.approval_delay:
1770
#We are approved or approval is disabled
2385
# We are approved or approval is disabled
1772
2387
elif client.approved is None:
1773
logger.info("Client %s needs approval",
2388
log.info("Client %s needs approval",
1775
2390
if self.server.use_dbus:
1776
2391
# Emit D-Bus signal
1777
2392
client.NeedApproval(
1778
2393
client.approval_delay.total_seconds()
1779
2394
* 1000, client.approved_by_default)
1781
logger.warning("Client %s was not approved",
2396
log.warning("Client %s was not approved",
1783
2398
if self.server.use_dbus:
1784
2399
# Emit D-Bus signal
1785
2400
client.Rejected("Denied")
1788
#wait until timeout or approved
2403
# wait until timeout or approved
1789
2404
time = datetime.datetime.now()
1790
2405
client.changedstate.acquire()
1791
2406
client.changedstate.wait(delay.total_seconds())
1806
2421
delay -= time2 - time
1809
while sent_size < len(client.secret):
1811
sent = session.send(client.secret[sent_size:])
1812
except gnutls.errors.GNUTLSError as error:
1813
logger.warning("gnutls send failed",
1816
logger.debug("Sent: %d, remaining: %d", sent,
1817
len(client.secret) - (sent_size
1821
logger.info("Sending secret to %s", client.name)
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)
1822
2430
# bump the timeout using extended_timeout
1823
2431
client.bump_timeout(client.extended_timeout)
1824
2432
if self.server.use_dbus:
1825
2433
# Emit D-Bus signal
1826
2434
client.GotSecret()
1829
2437
if approval_required:
1830
2438
client.approvals_pending -= 1
1833
except gnutls.errors.GNUTLSError as error:
1834
logger.warning("GnuTLS bye failed",
2441
except gnutls.Error as error:
2442
log.warning("GnuTLS bye failed", exc_info=error)
1838
2445
def peer_certificate(session):
1839
"Return the peer's OpenPGP certificate as a bytestring"
1840
# If not an OpenPGP certificate...
1841
if (gnutls.library.functions.gnutls_certificate_type_get(
1843
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1844
# ...do the normal thing
1845
return session.peer_certificate
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
1846
2462
list_size = ctypes.c_uint(1)
1847
cert_list = (gnutls.library.functions
1848
.gnutls_certificate_get_peers
1849
(session._c_object, ctypes.byref(list_size)))
2463
cert_list = (gnutls.certificate_get_peers
2464
(session, ctypes.byref(list_size)))
1850
2465
if not bool(cert_list) and list_size.value != 0:
1851
raise gnutls.errors.GNUTLSError("error getting peer"
2466
raise gnutls.Error("error getting peer certificate")
1853
2467
if list_size.value == 0:
1855
2469
cert = cert_list[0]
1856
2470
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()
1859
2508
def fingerprint(openpgp):
1860
2509
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1861
2510
# New GnuTLS "datum" with the OpenPGP public key
1862
datum = gnutls.library.types.gnutls_datum_t(
2511
datum = gnutls.datum_t(
1863
2512
ctypes.cast(ctypes.c_char_p(openpgp),
1864
2513
ctypes.POINTER(ctypes.c_ubyte)),
1865
2514
ctypes.c_uint(len(openpgp)))
1866
2515
# New empty GnuTLS certificate
1867
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1868
gnutls.library.functions.gnutls_openpgp_crt_init(
2516
crt = gnutls.openpgp_crt_t()
2517
gnutls.openpgp_crt_init(ctypes.byref(crt))
1870
2518
# Import the OpenPGP public key into the certificate
1871
gnutls.library.functions.gnutls_openpgp_crt_import(
1872
crt, ctypes.byref(datum),
1873
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
2519
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2520
gnutls.OPENPGP_FMT_RAW)
1874
2521
# Verify the self signature in the key
1875
2522
crtverify = ctypes.c_uint()
1876
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1877
crt, 0, ctypes.byref(crtverify))
2523
gnutls.openpgp_crt_verify_self(crt, 0,
2524
ctypes.byref(crtverify))
1878
2525
if crtverify.value != 0:
1879
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1880
raise gnutls.errors.CertificateSecurityError(
2526
gnutls.openpgp_crt_deinit(crt)
2527
raise gnutls.CertificateSecurityError(code
1882
2529
# New buffer for the fingerprint
1883
2530
buf = ctypes.create_string_buffer(20)
1884
2531
buf_len = ctypes.c_size_t()
1885
2532
# Get the fingerprint from the certificate into the buffer
1886
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1887
crt, ctypes.byref(buf), ctypes.byref(buf_len))
2533
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2534
ctypes.byref(buf_len))
1888
2535
# Deinit the certificate
1889
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2536
gnutls.openpgp_crt_deinit(crt)
1890
2537
# Convert the buffer to a Python bytestring
1891
2538
fpr = ctypes.string_at(buf, buf_len.value)
1892
2539
# Convert the bytestring to hexadecimal notation
1980
2628
# socket_wrapper(), if socketfd was set.
1981
2629
socketserver.TCPServer.__init__(self, server_address,
1982
2630
RequestHandlerClass)
1984
2632
def server_bind(self):
1985
2633
"""This overrides the normal server_bind() function
1986
2634
to bind to an interface if one was specified, and also NOT to
1987
2635
bind to an address or port if they were not specified."""
2636
global SO_BINDTODEVICE
1988
2637
if self.interface is not None:
1989
2638
if SO_BINDTODEVICE is None:
1990
logger.error("SO_BINDTODEVICE does not exist;"
1991
" cannot bind to interface %s",
1995
self.socket.setsockopt(
1996
socket.SOL_SOCKET, SO_BINDTODEVICE,
1997
(self.interface + "\0").encode("utf-8"))
1998
except socket.error as error:
1999
if error.errno == errno.EPERM:
2000
logger.error("No permission to bind to"
2001
" interface %s", self.interface)
2002
elif error.errno == errno.ENOPROTOOPT:
2003
logger.error("SO_BINDTODEVICE not available;"
2004
" cannot bind to interface %s",
2006
elif error.errno == errno.ENODEV:
2007
logger.error("Interface %s does not exist,"
2008
" cannot bind", self.interface)
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)
2011
2659
# Only bind(2) the socket if we really need to.
2012
2660
if self.server_address[0] or self.server_address[1]:
2661
if self.server_address[1]:
2662
self.allow_reuse_address = True
2013
2663
if not self.server_address[0]:
2014
2664
if self.address_family == socket.AF_INET6:
2015
any_address = "::" # in6addr_any
2665
any_address = "::" # in6addr_any
2017
any_address = "0.0.0.0" # INADDR_ANY
2667
any_address = "0.0.0.0" # INADDR_ANY
2018
2668
self.server_address = (any_address,
2019
2669
self.server_address[1])
2020
2670
elif not self.server_address[1]:
2054
2704
self.gnutls_priority = gnutls_priority
2055
2705
IPv6_TCPServer.__init__(self, server_address,
2056
2706
RequestHandlerClass,
2057
interface = interface,
2058
use_ipv6 = use_ipv6,
2059
socketfd = socketfd)
2707
interface=interface,
2061
2711
def server_activate(self):
2062
2712
if self.enabled:
2063
2713
return socketserver.TCPServer.server_activate(self)
2065
2715
def enable(self):
2066
2716
self.enabled = True
2068
2718
def add_pipe(self, parent_pipe, proc):
2069
2719
# Call "handle_ipc" for both data and EOF events
2070
gobject.io_add_watch(
2071
parent_pipe.fileno(),
2072
gobject.IO_IN | gobject.IO_HUP,
2721
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2722
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2073
2723
functools.partial(self.handle_ipc,
2074
parent_pipe = parent_pipe,
2724
parent_pipe=parent_pipe,
2077
2727
def handle_ipc(self, source, condition,
2078
2728
parent_pipe=None,
2080
2730
client_object=None):
2081
2731
# error, or the other end of multiprocessing.Pipe has closed
2082
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2732
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2083
2733
# Wait for other process to exit
2087
2737
# Read a request from the child
2088
2738
request = parent_pipe.recv()
2089
2739
command = request[0]
2091
if command == 'init':
2093
address = request[2]
2095
for c in self.clients.itervalues():
2096
if c.fingerprint == fpr:
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:
2100
logger.info("Client not found for fingerprint: %s, ad"
2101
"dress: %s", fpr, address)
2757
log.info("Client not found for key ID: %s, address:"
2758
" %s", key_id or fpr, address)
2102
2759
if self.use_dbus:
2103
2760
# Emit D-Bus signal
2104
mandos_dbus_service.ClientNotFound(fpr,
2761
mandos_dbus_service.ClientNotFound(key_id or fpr,
2106
2763
parent_pipe.send(False)
2109
gobject.io_add_watch(
2110
parent_pipe.fileno(),
2111
gobject.IO_IN | gobject.IO_HUP,
2767
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2768
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2112
2769
functools.partial(self.handle_ipc,
2113
parent_pipe = parent_pipe,
2115
client_object = client))
2770
parent_pipe=parent_pipe,
2772
client_object=client))
2116
2773
parent_pipe.send(True)
2117
2774
# remove the old hook in favor of the new above hook on
2120
if command == 'funcall':
2777
if command == "funcall":
2121
2778
funcname = request[1]
2122
2779
args = request[2]
2123
2780
kwargs = request[3]
2125
parent_pipe.send(('data', getattr(client_object,
2782
parent_pipe.send(("data", getattr(client_object,
2126
2783
funcname)(*args,
2129
if command == 'getattr':
2786
if command == "getattr":
2130
2787
attrname = request[1]
2131
if callable(client_object.__getattribute__(attrname)):
2132
parent_pipe.send(('function', ))
2788
if isinstance(client_object.__getattribute__(attrname),
2789
collections.abc.Callable):
2790
parent_pipe.send(("function", ))
2134
2792
parent_pipe.send((
2135
'data', client_object.__getattribute__(attrname)))
2137
if command == 'setattr':
2793
"data", client_object.__getattribute__(attrname)))
2795
if command == "setattr":
2138
2796
attrname = request[1]
2139
2797
value = request[2]
2140
2798
setattr(client_object, attrname, value)
2145
2803
def rfc3339_duration_to_delta(duration):
2146
2804
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2148
>>> rfc3339_duration_to_delta("P7D")
2149
datetime.timedelta(7)
2150
>>> rfc3339_duration_to_delta("PT60S")
2151
datetime.timedelta(0, 60)
2152
>>> rfc3339_duration_to_delta("PT60M")
2153
datetime.timedelta(0, 3600)
2154
>>> rfc3339_duration_to_delta("PT24H")
2155
datetime.timedelta(1)
2156
>>> rfc3339_duration_to_delta("P1W")
2157
datetime.timedelta(7)
2158
>>> rfc3339_duration_to_delta("PT5M30S")
2159
datetime.timedelta(0, 330)
2160
>>> rfc3339_duration_to_delta("P1DT3M20S")
2161
datetime.timedelta(1, 200)
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)
2164
2824
# Parsing an RFC 3339 duration with regular expressions is not
2165
2825
# possible - there would have to be multiple places for the same
2166
2826
# values, like seconds. The current code, while more esoteric, is
2167
2827
# cleaner without depending on a parsing library. If Python had a
2168
2828
# built-in library for parsing we would use it, but we'd like to
2169
2829
# avoid excessive use of external libraries.
2171
2831
# New type for defining tokens, syntax, and semantics all-in-one
2172
Token = collections.namedtuple("Token",
2173
("regexp", # To match token; if
2174
# "value" is not None,
2175
# must have a "group"
2177
"value", # datetime.timedelta or
2179
"followers")) # Tokens valid after
2181
2832
Token = collections.namedtuple("Token", (
2182
2833
"regexp", # To match token; if "value" is not None, must have
2183
2834
# a "group" containing digits
2563
3224
old_bus_name = dbus.service.BusName(
2564
3225
"se.bsnet.fukt.Mandos", bus,
2565
3226
do_not_queue=True)
2566
except dbus.exceptions.NameExistsException as e:
2567
logger.error("Disabling D-Bus:", exc_info=e)
3227
except dbus.exceptions.DBusException as e:
3228
log.error("Disabling D-Bus:", exc_info=e)
2568
3229
use_dbus = False
2569
3230
server_settings["use_dbus"] = False
2570
3231
tcp_server.use_dbus = False
2572
3233
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2573
3234
service = AvahiServiceToSyslog(
2574
name = server_settings["servicename"],
2575
servicetype = "_mandos._tcp",
2576
protocol = protocol,
3235
name=server_settings["servicename"],
3236
servicetype="_mandos._tcp",
2578
3239
if server_settings["interface"]:
2579
3240
service.interface = if_nametoindex(
2580
3241
server_settings["interface"].encode("utf-8"))
2582
3243
global multiprocessing_manager
2583
3244
multiprocessing_manager = multiprocessing.Manager()
2585
3246
client_class = Client
2587
client_class = functools.partial(ClientDBus, bus = bus)
3248
client_class = functools.partial(ClientDBus, bus=bus)
2589
3250
client_settings = Client.config_parser(client_config)
2590
3251
old_client_settings = {}
2591
3252
clients_data = {}
2593
3254
# This is used to redirect stdout and stderr for checker processes
2595
wnull = open(os.devnull, "w") # A writable /dev/null
3256
wnull = open(os.devnull, "w") # A writable /dev/null
2596
3257
# Only used if server is running in foreground but not in debug
2598
3259
if debug or not foreground:
2601
3262
# Get client data and settings from last running state.
2602
3263
if server_settings["restore"]:
2604
3265
with open(stored_state_path, "rb") as stored_state:
2605
clients_data, old_client_settings = pickle.load(
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]
2607
3316
os.remove(stored_state_path)
2608
3317
except IOError as e:
2609
3318
if e.errno == errno.ENOENT:
2610
logger.warning("Could not load persistent state:"
2611
" {}".format(os.strerror(e.errno)))
3319
log.warning("Could not load persistent state:"
3320
" %s", os.strerror(e.errno))
2613
logger.critical("Could not load persistent state:",
3322
log.critical("Could not load persistent state:",
2616
3325
except EOFError as e:
2617
logger.warning("Could not load persistent state: "
3326
log.warning("Could not load persistent state: EOFError:",
2621
3329
with PGPEngine() as pgp:
2622
3330
for client_name, client in clients_data.items():
2623
3331
# Skip removed clients
2624
3332
if client_name not in client_settings:
2627
3335
# Decide which value to use after restoring saved state.
2628
3336
# We have three different values: Old config file,
2629
3337
# new config file, and saved state.
2687
3391
for client_name in (set(client_settings)
2688
3392
- set(old_client_settings)):
2689
3393
clients_data[client_name] = client_settings[client_name]
2691
3395
# Create all client objects
2692
3396
for client_name, client in clients_data.items():
2693
3397
tcp_server.clients[client_name] = client_class(
2696
server_settings = server_settings)
3400
server_settings=server_settings)
2698
3402
if not tcp_server.clients:
2699
logger.warning("No clients defined")
3403
log.warning("No clients defined")
2701
3405
if not foreground:
2702
3406
if pidfile is not None:
2706
pidfile.write("{}\n".format(pid).encode("utf-8"))
3410
print(pid, file=pidfile)
2707
3411
except IOError:
2708
logger.error("Could not write to file %r with PID %d",
3412
log.error("Could not write to file %r with PID %d",
2711
3415
del pidfilename
2713
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2714
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3417
for termsig in (signal.SIGHUP, signal.SIGTERM):
3418
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3419
lambda: main_loop.quit() and False)
2718
3423
@alternate_dbus_interfaces(
2719
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2720
class MandosDBusService(DBusObjectWithProperties):
3424
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3425
class MandosDBusService(DBusObjectWithObjectManager):
2721
3426
"""A D-Bus proxy object"""
2723
3428
def __init__(self):
2724
3429
dbus.service.Object.__init__(self, bus, "/")
2726
3431
_interface = "se.recompile.Mandos"
2728
@dbus_interface_annotations(_interface)
2731
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2734
3433
@dbus.service.signal(_interface, signature="o")
2735
3434
def ClientAdded(self, objpath):
2739
3438
@dbus.service.signal(_interface, signature="ss")
2740
def ClientNotFound(self, fingerprint, address):
3439
def ClientNotFound(self, key_id, address):
3443
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2744
3445
@dbus.service.signal(_interface, signature="os")
2745
3446
def ClientRemoved(self, objpath, name):
3450
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2749
3452
@dbus.service.method(_interface, out_signature="ao")
2750
3453
def GetAllClients(self):
2752
3455
return dbus.Array(c.dbus_object_path for c in
2753
tcp_server.clients.itervalues())
3456
tcp_server.clients.values())
3458
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2755
3460
@dbus.service.method(_interface,
2756
3461
out_signature="a{oa{sv}}")
2757
3462
def GetAllClientsWithProperties(self):
2759
3464
return dbus.Dictionary(
2760
{ c.dbus_object_path: c.GetAll("")
2761
for c in tcp_server.clients.itervalues() },
3465
{c.dbus_object_path: c.GetAll(
3466
"se.recompile.Mandos.Client")
3467
for c in tcp_server.clients.values()},
2762
3468
signature="oa{sv}")
2764
3470
@dbus.service.method(_interface, in_signature="o")
2765
3471
def RemoveClient(self, object_path):
2767
for c in tcp_server.clients.itervalues():
3473
for c in tcp_server.clients.values():
2768
3474
if c.dbus_object_path == object_path:
2769
3475
del tcp_server.clients[c.name]
2770
3476
c.remove_from_connection()
2771
# Don't signal anything except ClientRemoved
3477
# Don't signal the disabling
2772
3478
c.disable(quiet=True)
2774
self.ClientRemoved(object_path, c.name)
3479
# Emit D-Bus signal for removal
3480
self.client_removed_signal(c)
2776
3482
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,
2780
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
2783
3530
"Cleanup function; run on exit"
2785
3532
service.cleanup()
2787
multiprocessing.active_children()
3534
mp.active_children()
2789
3536
if not (tcp_server.clients or client_settings):
2792
3539
# Store client before exiting. Secrets are encrypted with key
2793
3540
# based on what config file has. If config file is
2794
3541
# removed/edited, old secret will thus be unrecovable.
2796
3543
with PGPEngine() as pgp:
2797
for client in tcp_server.clients.itervalues():
3544
for client in tcp_server.clients.values():
2798
3545
key = client_settings[client.name]["secret"]
2799
3546
client.encrypted_secret = pgp.encrypt(client.secret,
2801
3548
client_dict = {}
2803
3550
# A list of attributes that can not be pickled
2805
exclude = { "bus", "changedstate", "secret",
2806
"checker", "server_settings" }
3552
exclude = {"bus", "changedstate", "secret",
3553
"checker", "server_settings"}
2807
3554
for name, typ in inspect.getmembers(dbus.service
2809
3556
exclude.add(name)
2811
3558
client_dict["encrypted_secret"] = (client
2812
3559
.encrypted_secret)
2813
3560
for attr in client.client_structure:
2814
3561
if attr not in exclude:
2815
3562
client_dict[attr] = getattr(client, attr)
2817
3564
clients[client.name] = client_dict
2818
3565
del client_settings[client.name]["secret"]
2821
3568
with tempfile.NamedTemporaryFile(
2823
3570
suffix=".pickle",
2825
3572
dir=os.path.dirname(stored_state_path),
2826
3573
delete=False) as stored_state:
2827
pickle.dump((clients, client_settings), stored_state)
3574
pickle.dump((clients, client_settings), stored_state,
2828
3576
tempname = stored_state.name
2829
3577
os.rename(tempname, stored_state_path)
2830
3578
except (IOError, OSError) as e:
2834
3582
except NameError:
2836
3584
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2837
logger.warning("Could not save persistent state: {}"
2838
.format(os.strerror(e.errno)))
3585
log.warning("Could not save persistent state: %s",
3586
os.strerror(e.errno))
2840
logger.warning("Could not save persistent state:",
3588
log.warning("Could not save persistent state:",
2844
3592
# Delete all clients, and settings from config
2845
3593
while tcp_server.clients:
2846
3594
name, client = tcp_server.clients.popitem()
2848
3596
client.remove_from_connection()
2849
# Don't signal anything except ClientRemoved
3597
# Don't signal the disabling
2850
3598
client.disable(quiet=True)
3599
# Emit D-Bus signal for removal
2853
mandos_dbus_service.ClientRemoved(
2854
client.dbus_object_path, client.name)
3601
mandos_dbus_service.client_removed_signal(client)
2855
3602
client_settings.clear()
2857
3604
atexit.register(cleanup)
2859
for client in tcp_server.clients.itervalues():
3606
for client in tcp_server.clients.values():
2862
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3608
# Emit D-Bus signal for adding
3609
mandos_dbus_service.client_added_signal(client)
2863
3610
# Need to initiate checking of clients
2864
3611
if client.enabled:
2865
3612
client.init_checker()
2867
3614
tcp_server.enable()
2868
3615
tcp_server.server_activate()
2870
3617
# Find out what port we got
2872
3619
service.port = tcp_server.socket.getsockname()[1]
2874
logger.info("Now listening on address %r, port %d,"
2875
" flowinfo %d, scope_id %d",
2876
*tcp_server.socket.getsockname())
3621
log.info("Now listening on address %r, port %d, flowinfo %d,"
3622
" scope_id %d", *tcp_server.socket.getsockname())
2878
logger.info("Now listening on address %r, port %d",
2879
*tcp_server.socket.getsockname())
2881
#service.interface = tcp_server.socket.getsockname()[3]
3624
log.info("Now listening on address %r, port %d",
3625
*tcp_server.socket.getsockname())
3627
# service.interface = tcp_server.socket.getsockname()[3]
2885
3631
# From the Avahi example code
2887
3633
service.activate()
2888
3634
except dbus.exceptions.DBusException as error:
2889
logger.critical("D-Bus Exception", exc_info=error)
3635
log.critical("D-Bus Exception", exc_info=error)
2892
3638
# End of Avahi example code
2894
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2895
lambda *args, **kwargs:
2896
(tcp_server.handle_request
2897
(*args[2:], **kwargs) or True))
2899
logger.debug("Starting main loop")
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")
2900
3647
main_loop.run()
2901
3648
except AvahiError as error:
2902
logger.critical("Avahi Error", exc_info=error)
3649
log.critical("Avahi Error", exc_info=error)
2905
3652
except KeyboardInterrupt:
2907
3654
print("", file=sys.stderr)
2908
logger.debug("Server received KeyboardInterrupt")
2909
logger.debug("Server exiting")
3655
log.debug("Server received KeyboardInterrupt")
3656
log.debug("Server exiting")
2910
3657
# Must run before the D-Bus bus name gets deregistered
2914
if __name__ == '__main__':
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))