/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
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.8"
 
118
version = "1.8.4"
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:
 
278
class avahi(object):
293
279
    """This isn't so much a class as it is a module-like namespace."""
294
280
    IF_UNSPEC = -1               # avahi-common/address.h
295
281
    PROTO_UNSPEC = -1            # avahi-common/address.h
329
315
    pass
330
316
 
331
317
 
332
 
class AvahiService:
 
318
class AvahiService(object):
333
319
    """An Avahi (Zeroconf) service.
334
320
 
335
321
    Attributes:
517
503
 
518
504
 
519
505
# Pretend that we have a GnuTLS module
520
 
class gnutls:
 
506
class gnutls(object):
521
507
    """This isn't so much a class as it is a module-like namespace."""
522
508
 
523
509
    library = ctypes.util.find_library("gnutls")
586
572
        pass
587
573
 
588
574
    # Classes
589
 
    class Credentials:
 
575
    class Credentials(object):
590
576
        def __init__(self):
591
577
            self._c_object = gnutls.certificate_credentials_t()
592
578
            gnutls.certificate_allocate_credentials(
596
582
        def __del__(self):
597
583
            gnutls.certificate_free_credentials(self._c_object)
598
584
 
599
 
    class ClientSession:
 
585
    class ClientSession(object):
600
586
        def __init__(self, socket, credentials=None):
601
587
            self._c_object = gnutls.session_t()
602
588
            gnutls_flags = gnutls.CLIENT
828
814
    connection.close()
829
815
 
830
816
 
831
 
class Client:
 
817
class Client(object):
832
818
    """A representation of a client host served by this server.
833
819
 
834
820
    Attributes:
835
821
    approved:   bool(); 'None' if not yet approved/disapproved
836
822
    approval_delay: datetime.timedelta(); Time to wait for approval
837
823
    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.
 
824
    checker:    subprocess.Popen(); a running checker process used
 
825
                                    to see if the client lives.
 
826
                                    'None' if no process is running.
841
827
    checker_callback_tag: a GLib event source tag, or None
842
828
    checker_command: string; External command which is run to check
843
829
                     if client lives.  %() expansions are done at
1050
1036
    def checker_callback(self, source, condition, connection,
1051
1037
                         command):
1052
1038
        """The checker has completed, so take appropriate actions."""
 
1039
        self.checker_callback_tag = None
 
1040
        self.checker = None
1053
1041
        # Read return code from connection (see call_pipe)
1054
1042
        returncode = connection.recv()
1055
1043
        connection.close()
1056
 
        self.checker.join()
1057
 
        self.checker_callback_tag = None
1058
 
        self.checker = None
1059
1044
 
1060
1045
        if returncode >= 0:
1061
1046
            self.last_checker_status = returncode
1150
1135
                kwargs=popen_args)
1151
1136
            self.checker.start()
1152
1137
            self.checker_callback_tag = GLib.io_add_watch(
1153
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1154
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1138
                pipe[0].fileno(), GLib.IO_IN,
1155
1139
                self.checker_callback, pipe[0], command)
1156
1140
        # Re-run this periodically if run by GLib.timeout_add
1157
1141
        return True
2224
2208
    del _interface
2225
2209
 
2226
2210
 
2227
 
class ProxyClient:
 
2211
class ProxyClient(object):
2228
2212
    def __init__(self, child_pipe, key_id, fpr, address):
2229
2213
        self._pipe = child_pipe
2230
2214
        self._pipe.send(('init', key_id, fpr, address))
2503
2487
        return hex_fpr
2504
2488
 
2505
2489
 
2506
 
class MultiprocessingMixIn:
 
2490
class MultiprocessingMixIn(object):
2507
2491
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2508
2492
 
2509
2493
    def sub_process_main(self, request, address):
2521
2505
        return proc
2522
2506
 
2523
2507
 
2524
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2508
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2525
2509
    """ adds a pipe to the MixIn """
2526
2510
 
2527
2511
    def process_request(self, request, client_address):
2542
2526
 
2543
2527
 
2544
2528
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2545
 
                     socketserver.TCPServer):
 
2529
                     socketserver.TCPServer, object):
2546
2530
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2547
2531
 
2548
2532
    Attributes:
2681
2665
    def add_pipe(self, parent_pipe, proc):
2682
2666
        # Call "handle_ipc" for both data and EOF events
2683
2667
        GLib.io_add_watch(
2684
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2685
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2668
            parent_pipe.fileno(),
 
2669
            GLib.IO_IN | GLib.IO_HUP,
2686
2670
            functools.partial(self.handle_ipc,
2687
2671
                              parent_pipe=parent_pipe,
2688
2672
                              proc=proc))
2726
2710
                return False
2727
2711
 
2728
2712
            GLib.io_add_watch(
2729
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2730
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2713
                parent_pipe.fileno(),
 
2714
                GLib.IO_IN | GLib.IO_HUP,
2731
2715
                functools.partial(self.handle_ipc,
2732
2716
                                  parent_pipe=parent_pipe,
2733
2717
                                  proc=proc,
2765
2749
def rfc3339_duration_to_delta(duration):
2766
2750
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2767
2751
 
2768
 
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2769
 
    True
2770
 
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2771
 
    True
2772
 
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2773
 
    True
2774
 
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2775
 
    True
2776
 
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2777
 
    True
2778
 
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2779
 
    True
2780
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2781
 
    True
 
2752
    >>> rfc3339_duration_to_delta("P7D")
 
2753
    datetime.timedelta(7)
 
2754
    >>> rfc3339_duration_to_delta("PT60S")
 
2755
    datetime.timedelta(0, 60)
 
2756
    >>> rfc3339_duration_to_delta("PT60M")
 
2757
    datetime.timedelta(0, 3600)
 
2758
    >>> rfc3339_duration_to_delta("PT24H")
 
2759
    datetime.timedelta(1)
 
2760
    >>> rfc3339_duration_to_delta("P1W")
 
2761
    datetime.timedelta(7)
 
2762
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2763
    datetime.timedelta(0, 330)
 
2764
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2765
    datetime.timedelta(1, 200)
2782
2766
    """
2783
2767
 
2784
2768
    # Parsing an RFC 3339 duration with regular expressions is not
2864
2848
def string_to_delta(interval):
2865
2849
    """Parse a string and return a datetime.timedelta
2866
2850
 
2867
 
    >>> string_to_delta('7d') == datetime.timedelta(7)
2868
 
    True
2869
 
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
2870
 
    True
2871
 
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2872
 
    True
2873
 
    >>> string_to_delta('24h') == datetime.timedelta(1)
2874
 
    True
2875
 
    >>> string_to_delta('1w') == datetime.timedelta(7)
2876
 
    True
2877
 
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2878
 
    True
 
2851
    >>> string_to_delta('7d')
 
2852
    datetime.timedelta(7)
 
2853
    >>> string_to_delta('60s')
 
2854
    datetime.timedelta(0, 60)
 
2855
    >>> string_to_delta('60m')
 
2856
    datetime.timedelta(0, 3600)
 
2857
    >>> string_to_delta('24h')
 
2858
    datetime.timedelta(1)
 
2859
    >>> string_to_delta('1w')
 
2860
    datetime.timedelta(7)
 
2861
    >>> string_to_delta('5m 30s')
 
2862
    datetime.timedelta(0, 330)
2879
2863
    """
2880
2864
 
2881
2865
    try:
2983
2967
 
2984
2968
    options = parser.parse_args()
2985
2969
 
 
2970
    if options.check:
 
2971
        import doctest
 
2972
        fail_count, test_count = doctest.testmod()
 
2973
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2974
 
2986
2975
    # Default values for config file for server-global settings
2987
2976
    if gnutls.has_rawpk:
2988
2977
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3008
2997
    del priority
3009
2998
 
3010
2999
    # Parse config file for server-global settings
3011
 
    server_config = configparser.ConfigParser(server_defaults)
 
3000
    server_config = configparser.SafeConfigParser(server_defaults)
3012
3001
    del server_defaults
3013
3002
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3014
 
    # Convert the ConfigParser object to a dict
 
3003
    # Convert the SafeConfigParser object to a dict
3015
3004
    server_settings = server_config.defaults()
3016
3005
    # Use the appropriate methods on the non-string config options
3017
3006
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3089
3078
                                  server_settings["servicename"])))
3090
3079
 
3091
3080
    # Parse config file with clients
3092
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
3081
    client_config = configparser.SafeConfigParser(Client
 
3082
                                                  .client_defaults)
3093
3083
    client_config.read(os.path.join(server_settings["configdir"],
3094
3084
                                    "clients.conf"))
3095
3085
 
3166
3156
        # Close all input and output, do double fork, etc.
3167
3157
        daemon()
3168
3158
 
3169
 
    if gi.version_info < (3, 10, 2):
3170
 
        # multiprocessing will use threads, so before we use GLib we
3171
 
        # need to inform GLib that threads will be used.
3172
 
        GLib.threads_init()
 
3159
    # multiprocessing will use threads, so before we use GLib we need
 
3160
    # to inform GLib that threads will be used.
 
3161
    GLib.threads_init()
3173
3162
 
3174
3163
    global main_loop
3175
3164
    # From the Avahi example code
3251
3240
                             if isinstance(s, bytes)
3252
3241
                             else s) for s in
3253
3242
                            value["client_structure"]]
3254
 
                        # .name, .host, and .checker_command
3255
 
                        for k in ("name", "host", "checker_command"):
 
3243
                        # .name & .host
 
3244
                        for k in ("name", "host"):
3256
3245
                            if isinstance(value[k], bytes):
3257
3246
                                value[k] = value[k].decode("utf-8")
3258
3247
                        if "key_id" not in value:
3268
3257
                        for key, value in
3269
3258
                        bytes_old_client_settings.items()}
3270
3259
                    del bytes_old_client_settings
3271
 
                    # .host and .checker_command
 
3260
                    # .host
3272
3261
                    for value in old_client_settings.values():
3273
 
                        for attribute in ("host", "checker_command"):
3274
 
                            if isinstance(value[attribute], bytes):
3275
 
                                value[attribute] = (value[attribute]
3276
 
                                                    .decode("utf-8"))
 
3262
                        if isinstance(value["host"], bytes):
 
3263
                            value["host"] = (value["host"]
 
3264
                                             .decode("utf-8"))
3277
3265
            os.remove(stored_state_path)
3278
3266
        except IOError as e:
3279
3267
            if e.errno == errno.ENOENT:
3604
3592
                sys.exit(1)
3605
3593
            # End of Avahi example code
3606
3594
 
3607
 
        GLib.io_add_watch(
3608
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3609
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3610
 
            lambda *args, **kwargs: (tcp_server.handle_request
3611
 
                                     (*args[2:], **kwargs) or True))
 
3595
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3596
                          lambda *args, **kwargs:
 
3597
                          (tcp_server.handle_request
 
3598
                           (*args[2:], **kwargs) or True))
3612
3599
 
3613
3600
        logger.debug("Starting main loop")
3614
3601
        main_loop.run()
3624
3611
    # Must run before the D-Bus bus name gets deregistered
3625
3612
    cleanup()
3626
3613
 
3627
 
 
3628
 
def should_only_run_tests():
3629
 
    parser = argparse.ArgumentParser(add_help=False)
3630
 
    parser.add_argument("--check", action='store_true')
3631
 
    args, unknown_args = parser.parse_known_args()
3632
 
    run_tests = args.check
3633
 
    if run_tests:
3634
 
        # Remove --check argument from sys.argv
3635
 
        sys.argv[1:] = unknown_args
3636
 
    return run_tests
3637
 
 
3638
 
# Add all tests from doctest strings
3639
 
def load_tests(loader, tests, none):
3640
 
    import doctest
3641
 
    tests.addTests(doctest.DocTestSuite())
3642
 
    return tests
3643
3614
 
3644
3615
if __name__ == '__main__':
3645
 
    try:
3646
 
        if should_only_run_tests():
3647
 
            # Call using ./mandos --check [--verbose]
3648
 
            unittest.main()
3649
 
        else:
3650
 
            main()
3651
 
    finally:
3652
 
        logging.shutdown()
 
3616
    main()