/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-03-03 16:20:02 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190303162002-y0ezr98f71d0jfro
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients

* mandos-ctl (Test_TableOfClients): Removed.
  (TestCmd): New abstract class for tests for command classes.
  (TestPrintTableCmd): New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python3 -b
2
 
# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
 
1
#!/usr/bin/python
 
2
# -*- mode: python; coding: utf-8 -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
5
#
77
77
import itertools
78
78
import collections
79
79
import codecs
80
 
import unittest
81
80
 
82
81
import dbus
83
82
import dbus.service
84
 
import gi
85
83
from gi.repository import GLib
86
84
from dbus.mainloop.glib import DBusGMainLoop
87
85
import ctypes
89
87
import xml.dom.minidom
90
88
import inspect
91
89
 
92
 
if sys.version_info.major == 2:
93
 
    __metaclass__ = type
94
 
 
95
 
# Show warnings by default
96
 
if not sys.warnoptions:
97
 
    import warnings
98
 
    warnings.simplefilter("default")
99
 
 
100
90
# Try to find the value of SO_BINDTODEVICE:
101
91
try:
102
92
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
125
115
if sys.version_info.major == 2:
126
116
    str = unicode
127
117
 
128
 
if sys.version_info < (3, 2):
129
 
    configparser.Configparser = configparser.SafeConfigParser
130
 
 
131
 
version = "1.8.9"
 
118
version = "1.8.3"
132
119
stored_state_file = "clients.pickle"
133
120
 
134
121
logger = logging.getLogger()
135
 
logging.captureWarnings(True)   # Show warnings via the logging system
136
122
syslogger = None
137
123
 
138
124
try:
193
179
    pass
194
180
 
195
181
 
196
 
class PGPEngine:
 
182
class PGPEngine(object):
197
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
198
184
 
199
185
    def __init__(self):
203
189
            output = subprocess.check_output(["gpgconf"])
204
190
            for line in output.splitlines():
205
191
                name, text, path = line.split(b":")
206
 
                if name == b"gpg":
 
192
                if name == "gpg":
207
193
                    self.gpg = path
208
194
                    break
209
195
        except OSError as e:
214
200
                          '--force-mdc',
215
201
                          '--quiet']
216
202
        # Only GPG version 1 has the --no-use-agent option.
217
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
203
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
218
204
            self.gnupgargs.append("--no-use-agent")
219
205
 
220
206
    def __enter__(self):
289
275
 
290
276
 
291
277
# Pretend that we have an Avahi module
292
 
class avahi:
293
 
    """This isn't so much a class as it is a module-like namespace."""
 
278
class Avahi(object):
 
279
    """This isn't so much a class as it is a module-like namespace.
 
280
    It is instantiated once, and simulates having an Avahi module."""
294
281
    IF_UNSPEC = -1               # avahi-common/address.h
295
282
    PROTO_UNSPEC = -1            # avahi-common/address.h
296
283
    PROTO_INET = 0               # avahi-common/address.h
300
287
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
301
288
    DBUS_PATH_SERVER = "/"
302
289
 
303
 
    @staticmethod
304
 
    def string_array_to_txt_array(t):
 
290
    def string_array_to_txt_array(self, t):
305
291
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
306
292
                           for s in t), signature="ay")
307
293
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
312
298
    SERVER_RUNNING = 2           # avahi-common/defs.h
313
299
    SERVER_COLLISION = 3         # avahi-common/defs.h
314
300
    SERVER_FAILURE = 4           # avahi-common/defs.h
 
301
avahi = Avahi()
315
302
 
316
303
 
317
304
class AvahiError(Exception):
329
316
    pass
330
317
 
331
318
 
332
 
class AvahiService:
 
319
class AvahiService(object):
333
320
    """An Avahi (Zeroconf) service.
334
321
 
335
322
    Attributes:
517
504
 
518
505
 
519
506
# Pretend that we have a GnuTLS module
520
 
class gnutls:
521
 
    """This isn't so much a class as it is a module-like namespace."""
 
507
class GnuTLS(object):
 
508
    """This isn't so much a class as it is a module-like namespace.
 
509
    It is instantiated once, and simulates having a GnuTLS module."""
522
510
 
523
511
    library = ctypes.util.find_library("gnutls")
524
512
    if library is None:
525
513
        library = ctypes.util.find_library("gnutls-deb0")
526
514
    _library = ctypes.cdll.LoadLibrary(library)
527
515
    del library
 
516
    _need_version = b"3.3.0"
 
517
    _tls_rawpk_version = b"3.6.6"
 
518
 
 
519
    def __init__(self):
 
520
        # Need to use "self" here, since this method is called before
 
521
        # the assignment to the "gnutls" global variable happens.
 
522
        if self.check_version(self._need_version) is None:
 
523
            raise self.Error("Needs GnuTLS {} or later"
 
524
                             .format(self._need_version))
528
525
 
529
526
    # Unless otherwise indicated, the constants and types below are
530
527
    # all from the gnutls/gnutls.h C header file.
572
569
 
573
570
    # Exceptions
574
571
    class Error(Exception):
 
572
        # We need to use the class name "GnuTLS" here, since this
 
573
        # exception might be raised from within GnuTLS.__init__,
 
574
        # which is called before the assignment to the "gnutls"
 
575
        # global variable has happened.
575
576
        def __init__(self, message=None, code=None, args=()):
576
577
            # Default usage is by a message string, but if a return
577
578
            # code is passed, convert it to a string with
578
579
            # gnutls.strerror()
579
580
            self.code = code
580
581
            if message is None and code is not None:
581
 
                message = gnutls.strerror(code)
582
 
            return super(gnutls.Error, self).__init__(
 
582
                message = GnuTLS.strerror(code)
 
583
            return super(GnuTLS.Error, self).__init__(
583
584
                message, *args)
584
585
 
585
586
    class CertificateSecurityError(Error):
586
587
        pass
587
588
 
588
589
    # Classes
589
 
    class Credentials:
 
590
    class Credentials(object):
590
591
        def __init__(self):
591
592
            self._c_object = gnutls.certificate_credentials_t()
592
593
            gnutls.certificate_allocate_credentials(
596
597
        def __del__(self):
597
598
            gnutls.certificate_free_credentials(self._c_object)
598
599
 
599
 
    class ClientSession:
 
600
    class ClientSession(object):
600
601
        def __init__(self, socket, credentials=None):
601
602
            self._c_object = gnutls.session_t()
602
603
            gnutls_flags = gnutls.CLIENT
603
 
            if gnutls.check_version(b"3.5.6"):
 
604
            if gnutls.check_version("3.5.6"):
604
605
                gnutls_flags |= gnutls.NO_TICKETS
605
606
            if gnutls.has_rawpk:
606
607
                gnutls_flags |= gnutls.ENABLE_RAWPK
743
744
    check_version.argtypes = [ctypes.c_char_p]
744
745
    check_version.restype = ctypes.c_char_p
745
746
 
746
 
    _need_version = b"3.3.0"
747
 
    if check_version(_need_version) is None:
748
 
        raise self.Error("Needs GnuTLS {} or later"
749
 
                         .format(_need_version))
750
 
 
751
 
    _tls_rawpk_version = b"3.6.6"
752
747
    has_rawpk = bool(check_version(_tls_rawpk_version))
753
748
 
754
749
    if has_rawpk:
808
803
                                                    ctypes.c_size_t)]
809
804
        openpgp_crt_get_fingerprint.restype = _error_code
810
805
 
811
 
    if check_version(b"3.6.4"):
 
806
    if check_version("3.6.4"):
812
807
        certificate_type_get2 = _library.gnutls_certificate_type_get2
813
808
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
814
809
        certificate_type_get2.restype = _error_code
815
810
 
816
811
    # Remove non-public functions
817
812
    del _error_code, _retry_on_error
 
813
# Create the global "gnutls" object, simulating a module
 
814
gnutls = GnuTLS()
818
815
 
819
816
 
820
817
def call_pipe(connection,       # : multiprocessing.Connection
828
825
    connection.close()
829
826
 
830
827
 
831
 
class Client:
 
828
class Client(object):
832
829
    """A representation of a client host served by this server.
833
830
 
834
831
    Attributes:
835
832
    approved:   bool(); 'None' if not yet approved/disapproved
836
833
    approval_delay: datetime.timedelta(); Time to wait for approval
837
834
    approval_duration: datetime.timedelta(); Duration of one approval
838
 
    checker: multiprocessing.Process(); a running checker process used
839
 
             to see if the client lives. 'None' if no process is
840
 
             running.
 
835
    checker:    subprocess.Popen(); a running checker process used
 
836
                                    to see if the client lives.
 
837
                                    'None' if no process is running.
841
838
    checker_callback_tag: a GLib event source tag, or None
842
839
    checker_command: string; External command which is run to check
843
840
                     if client lives.  %() expansions are done at
1050
1047
    def checker_callback(self, source, condition, connection,
1051
1048
                         command):
1052
1049
        """The checker has completed, so take appropriate actions."""
 
1050
        self.checker_callback_tag = None
 
1051
        self.checker = None
1053
1052
        # Read return code from connection (see call_pipe)
1054
1053
        returncode = connection.recv()
1055
1054
        connection.close()
1056
 
        if self.checker is not None:
1057
 
            self.checker.join()
1058
 
        self.checker_callback_tag = None
1059
 
        self.checker = None
1060
1055
 
1061
1056
        if returncode >= 0:
1062
1057
            self.last_checker_status = returncode
1151
1146
                kwargs=popen_args)
1152
1147
            self.checker.start()
1153
1148
            self.checker_callback_tag = GLib.io_add_watch(
1154
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1155
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1149
                pipe[0].fileno(), GLib.IO_IN,
1156
1150
                self.checker_callback, pipe[0], command)
1157
1151
        # Re-run this periodically if run by GLib.timeout_add
1158
1152
        return True
2225
2219
    del _interface
2226
2220
 
2227
2221
 
2228
 
class ProxyClient:
 
2222
class ProxyClient(object):
2229
2223
    def __init__(self, child_pipe, key_id, fpr, address):
2230
2224
        self._pipe = child_pipe
2231
2225
        self._pipe.send(('init', key_id, fpr, address))
2304
2298
            approval_required = False
2305
2299
            try:
2306
2300
                if gnutls.has_rawpk:
2307
 
                    fpr = b""
 
2301
                    fpr = ""
2308
2302
                    try:
2309
2303
                        key_id = self.key_id(
2310
2304
                            self.peer_certificate(session))
2314
2308
                    logger.debug("Key ID: %s", key_id)
2315
2309
 
2316
2310
                else:
2317
 
                    key_id = b""
 
2311
                    key_id = ""
2318
2312
                    try:
2319
2313
                        fpr = self.fingerprint(
2320
2314
                            self.peer_certificate(session))
2504
2498
        return hex_fpr
2505
2499
 
2506
2500
 
2507
 
class MultiprocessingMixIn:
 
2501
class MultiprocessingMixIn(object):
2508
2502
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2509
2503
 
2510
2504
    def sub_process_main(self, request, address):
2522
2516
        return proc
2523
2517
 
2524
2518
 
2525
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2519
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2526
2520
    """ adds a pipe to the MixIn """
2527
2521
 
2528
2522
    def process_request(self, request, client_address):
2543
2537
 
2544
2538
 
2545
2539
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2546
 
                     socketserver.TCPServer):
 
2540
                     socketserver.TCPServer, object):
2547
2541
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2548
2542
 
2549
2543
    Attributes:
2622
2616
                    raise
2623
2617
        # Only bind(2) the socket if we really need to.
2624
2618
        if self.server_address[0] or self.server_address[1]:
2625
 
            if self.server_address[1]:
2626
 
                self.allow_reuse_address = True
2627
2619
            if not self.server_address[0]:
2628
2620
                if self.address_family == socket.AF_INET6:
2629
2621
                    any_address = "::"  # in6addr_any
2682
2674
    def add_pipe(self, parent_pipe, proc):
2683
2675
        # Call "handle_ipc" for both data and EOF events
2684
2676
        GLib.io_add_watch(
2685
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2686
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2677
            parent_pipe.fileno(),
 
2678
            GLib.IO_IN | GLib.IO_HUP,
2687
2679
            functools.partial(self.handle_ipc,
2688
2680
                              parent_pipe=parent_pipe,
2689
2681
                              proc=proc))
2727
2719
                return False
2728
2720
 
2729
2721
            GLib.io_add_watch(
2730
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2731
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2722
                parent_pipe.fileno(),
 
2723
                GLib.IO_IN | GLib.IO_HUP,
2732
2724
                functools.partial(self.handle_ipc,
2733
2725
                                  parent_pipe=parent_pipe,
2734
2726
                                  proc=proc,
2766
2758
def rfc3339_duration_to_delta(duration):
2767
2759
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2768
2760
 
2769
 
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2770
 
    True
2771
 
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2772
 
    True
2773
 
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2774
 
    True
2775
 
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2776
 
    True
2777
 
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2778
 
    True
2779
 
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2780
 
    True
2781
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2782
 
    True
 
2761
    >>> rfc3339_duration_to_delta("P7D")
 
2762
    datetime.timedelta(7)
 
2763
    >>> rfc3339_duration_to_delta("PT60S")
 
2764
    datetime.timedelta(0, 60)
 
2765
    >>> rfc3339_duration_to_delta("PT60M")
 
2766
    datetime.timedelta(0, 3600)
 
2767
    >>> rfc3339_duration_to_delta("PT24H")
 
2768
    datetime.timedelta(1)
 
2769
    >>> rfc3339_duration_to_delta("P1W")
 
2770
    datetime.timedelta(7)
 
2771
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2772
    datetime.timedelta(0, 330)
 
2773
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2774
    datetime.timedelta(1, 200)
2783
2775
    """
2784
2776
 
2785
2777
    # Parsing an RFC 3339 duration with regular expressions is not
2865
2857
def string_to_delta(interval):
2866
2858
    """Parse a string and return a datetime.timedelta
2867
2859
 
2868
 
    >>> string_to_delta('7d') == datetime.timedelta(7)
2869
 
    True
2870
 
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
2871
 
    True
2872
 
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2873
 
    True
2874
 
    >>> string_to_delta('24h') == datetime.timedelta(1)
2875
 
    True
2876
 
    >>> string_to_delta('1w') == datetime.timedelta(7)
2877
 
    True
2878
 
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2879
 
    True
 
2860
    >>> string_to_delta('7d')
 
2861
    datetime.timedelta(7)
 
2862
    >>> string_to_delta('60s')
 
2863
    datetime.timedelta(0, 60)
 
2864
    >>> string_to_delta('60m')
 
2865
    datetime.timedelta(0, 3600)
 
2866
    >>> string_to_delta('24h')
 
2867
    datetime.timedelta(1)
 
2868
    >>> string_to_delta('1w')
 
2869
    datetime.timedelta(7)
 
2870
    >>> string_to_delta('5m 30s')
 
2871
    datetime.timedelta(0, 330)
2880
2872
    """
2881
2873
 
2882
2874
    try:
2984
2976
 
2985
2977
    options = parser.parse_args()
2986
2978
 
 
2979
    if options.check:
 
2980
        import doctest
 
2981
        fail_count, test_count = doctest.testmod()
 
2982
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2983
 
2987
2984
    # Default values for config file for server-global settings
2988
2985
    if gnutls.has_rawpk:
2989
2986
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3009
3006
    del priority
3010
3007
 
3011
3008
    # Parse config file for server-global settings
3012
 
    server_config = configparser.ConfigParser(server_defaults)
 
3009
    server_config = configparser.SafeConfigParser(server_defaults)
3013
3010
    del server_defaults
3014
3011
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3015
 
    # Convert the ConfigParser object to a dict
 
3012
    # Convert the SafeConfigParser object to a dict
3016
3013
    server_settings = server_config.defaults()
3017
3014
    # Use the appropriate methods on the non-string config options
3018
3015
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3090
3087
                                  server_settings["servicename"])))
3091
3088
 
3092
3089
    # Parse config file with clients
3093
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
3090
    client_config = configparser.SafeConfigParser(Client
 
3091
                                                  .client_defaults)
3094
3092
    client_config.read(os.path.join(server_settings["configdir"],
3095
3093
                                    "clients.conf"))
3096
3094
 
3167
3165
        # Close all input and output, do double fork, etc.
3168
3166
        daemon()
3169
3167
 
3170
 
    if gi.version_info < (3, 10, 2):
3171
 
        # multiprocessing will use threads, so before we use GLib we
3172
 
        # need to inform GLib that threads will be used.
3173
 
        GLib.threads_init()
 
3168
    # multiprocessing will use threads, so before we use GLib we need
 
3169
    # to inform GLib that threads will be used.
 
3170
    GLib.threads_init()
3174
3171
 
3175
3172
    global main_loop
3176
3173
    # From the Avahi example code
3252
3249
                             if isinstance(s, bytes)
3253
3250
                             else s) for s in
3254
3251
                            value["client_structure"]]
3255
 
                        # .name, .host, and .checker_command
3256
 
                        for k in ("name", "host", "checker_command"):
 
3252
                        # .name & .host
 
3253
                        for k in ("name", "host"):
3257
3254
                            if isinstance(value[k], bytes):
3258
3255
                                value[k] = value[k].decode("utf-8")
3259
 
                        if "key_id" not in value:
 
3256
                        if not value.has_key("key_id"):
3260
3257
                            value["key_id"] = ""
3261
 
                        elif "fingerprint" not in value:
 
3258
                        elif not value.has_key("fingerprint"):
3262
3259
                            value["fingerprint"] = ""
3263
3260
                    #  old_client_settings
3264
3261
                    # .keys()
3269
3266
                        for key, value in
3270
3267
                        bytes_old_client_settings.items()}
3271
3268
                    del bytes_old_client_settings
3272
 
                    # .host and .checker_command
 
3269
                    # .host
3273
3270
                    for value in old_client_settings.values():
3274
 
                        for attribute in ("host", "checker_command"):
3275
 
                            if isinstance(value[attribute], bytes):
3276
 
                                value[attribute] = (value[attribute]
3277
 
                                                    .decode("utf-8"))
 
3271
                        if isinstance(value["host"], bytes):
 
3272
                            value["host"] = (value["host"]
 
3273
                                             .decode("utf-8"))
3278
3274
            os.remove(stored_state_path)
3279
3275
        except IOError as e:
3280
3276
            if e.errno == errno.ENOENT:
3605
3601
                sys.exit(1)
3606
3602
            # End of Avahi example code
3607
3603
 
3608
 
        GLib.io_add_watch(
3609
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3610
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3611
 
            lambda *args, **kwargs: (tcp_server.handle_request
3612
 
                                     (*args[2:], **kwargs) or True))
 
3604
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3605
                          lambda *args, **kwargs:
 
3606
                          (tcp_server.handle_request
 
3607
                           (*args[2:], **kwargs) or True))
3613
3608
 
3614
3609
        logger.debug("Starting main loop")
3615
3610
        main_loop.run()
3625
3620
    # Must run before the D-Bus bus name gets deregistered
3626
3621
    cleanup()
3627
3622
 
3628
 
 
3629
 
def should_only_run_tests():
3630
 
    parser = argparse.ArgumentParser(add_help=False)
3631
 
    parser.add_argument("--check", action='store_true')
3632
 
    args, unknown_args = parser.parse_known_args()
3633
 
    run_tests = args.check
3634
 
    if run_tests:
3635
 
        # Remove --check argument from sys.argv
3636
 
        sys.argv[1:] = unknown_args
3637
 
    return run_tests
3638
 
 
3639
 
# Add all tests from doctest strings
3640
 
def load_tests(loader, tests, none):
3641
 
    import doctest
3642
 
    tests.addTests(doctest.DocTestSuite())
3643
 
    return tests
3644
3623
 
3645
3624
if __name__ == '__main__':
3646
 
    try:
3647
 
        if should_only_run_tests():
3648
 
            # Call using ./mandos --check [--verbose]
3649
 
            unittest.main()
3650
 
        else:
3651
 
            main()
3652
 
    finally:
3653
 
        logging.shutdown()
 
3625
    main()