/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-04-10 20:33:13 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190410203313-d3ufer20hfws7i3h
Improve language in intro(8mandos) manual page

* intro.xml (INTRODUCTION): Replace "it" with "the data" to fix bad
                            reference, and clarify that it is the
                            client which continues booting.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
1
 
#!/usr/bin/python3 -bI
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.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
603
 
            if gnutls.check_version(b"3.5.6"):
 
589
            if gnutls.check_version("3.5.6"):
604
590
                gnutls_flags |= gnutls.NO_TICKETS
605
591
            if gnutls.has_rawpk:
606
592
                gnutls_flags |= gnutls.ENABLE_RAWPK
808
794
                                                    ctypes.c_size_t)]
809
795
        openpgp_crt_get_fingerprint.restype = _error_code
810
796
 
811
 
    if check_version(b"3.6.4"):
 
797
    if check_version("3.6.4"):
812
798
        certificate_type_get2 = _library.gnutls_certificate_type_get2
813
799
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
814
800
        certificate_type_get2.restype = _error_code
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
 
        if self.checker is not None:
1057
 
            self.checker.join()
1058
 
        self.checker_callback_tag = None
1059
 
        self.checker = None
1060
1044
 
1061
1045
        if returncode >= 0:
1062
1046
            self.last_checker_status = returncode
1151
1135
                kwargs=popen_args)
1152
1136
            self.checker.start()
1153
1137
            self.checker_callback_tag = GLib.io_add_watch(
1154
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1155
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1138
                pipe[0].fileno(), GLib.IO_IN,
1156
1139
                self.checker_callback, pipe[0], command)
1157
1140
        # Re-run this periodically if run by GLib.timeout_add
1158
1141
        return True
2225
2208
    del _interface
2226
2209
 
2227
2210
 
2228
 
class ProxyClient:
 
2211
class ProxyClient(object):
2229
2212
    def __init__(self, child_pipe, key_id, fpr, address):
2230
2213
        self._pipe = child_pipe
2231
2214
        self._pipe.send(('init', key_id, fpr, address))
2304
2287
            approval_required = False
2305
2288
            try:
2306
2289
                if gnutls.has_rawpk:
2307
 
                    fpr = b""
 
2290
                    fpr = ""
2308
2291
                    try:
2309
2292
                        key_id = self.key_id(
2310
2293
                            self.peer_certificate(session))
2314
2297
                    logger.debug("Key ID: %s", key_id)
2315
2298
 
2316
2299
                else:
2317
 
                    key_id = b""
 
2300
                    key_id = ""
2318
2301
                    try:
2319
2302
                        fpr = self.fingerprint(
2320
2303
                            self.peer_certificate(session))
2504
2487
        return hex_fpr
2505
2488
 
2506
2489
 
2507
 
class MultiprocessingMixIn:
 
2490
class MultiprocessingMixIn(object):
2508
2491
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2509
2492
 
2510
2493
    def sub_process_main(self, request, address):
2522
2505
        return proc
2523
2506
 
2524
2507
 
2525
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2508
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2526
2509
    """ adds a pipe to the MixIn """
2527
2510
 
2528
2511
    def process_request(self, request, client_address):
2543
2526
 
2544
2527
 
2545
2528
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2546
 
                     socketserver.TCPServer):
 
2529
                     socketserver.TCPServer, object):
2547
2530
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2548
2531
 
2549
2532
    Attributes:
2622
2605
                    raise
2623
2606
        # Only bind(2) the socket if we really need to.
2624
2607
        if self.server_address[0] or self.server_address[1]:
2625
 
            if self.server_address[1]:
2626
 
                self.allow_reuse_address = True
2627
2608
            if not self.server_address[0]:
2628
2609
                if self.address_family == socket.AF_INET6:
2629
2610
                    any_address = "::"  # in6addr_any
2682
2663
    def add_pipe(self, parent_pipe, proc):
2683
2664
        # Call "handle_ipc" for both data and EOF events
2684
2665
        GLib.io_add_watch(
2685
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2686
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2666
            parent_pipe.fileno(),
 
2667
            GLib.IO_IN | GLib.IO_HUP,
2687
2668
            functools.partial(self.handle_ipc,
2688
2669
                              parent_pipe=parent_pipe,
2689
2670
                              proc=proc))
2727
2708
                return False
2728
2709
 
2729
2710
            GLib.io_add_watch(
2730
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2731
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2711
                parent_pipe.fileno(),
 
2712
                GLib.IO_IN | GLib.IO_HUP,
2732
2713
                functools.partial(self.handle_ipc,
2733
2714
                                  parent_pipe=parent_pipe,
2734
2715
                                  proc=proc,
2766
2747
def rfc3339_duration_to_delta(duration):
2767
2748
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2768
2749
 
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
 
2750
    >>> rfc3339_duration_to_delta("P7D")
 
2751
    datetime.timedelta(7)
 
2752
    >>> rfc3339_duration_to_delta("PT60S")
 
2753
    datetime.timedelta(0, 60)
 
2754
    >>> rfc3339_duration_to_delta("PT60M")
 
2755
    datetime.timedelta(0, 3600)
 
2756
    >>> rfc3339_duration_to_delta("PT24H")
 
2757
    datetime.timedelta(1)
 
2758
    >>> rfc3339_duration_to_delta("P1W")
 
2759
    datetime.timedelta(7)
 
2760
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2761
    datetime.timedelta(0, 330)
 
2762
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2763
    datetime.timedelta(1, 200)
2783
2764
    """
2784
2765
 
2785
2766
    # Parsing an RFC 3339 duration with regular expressions is not
2865
2846
def string_to_delta(interval):
2866
2847
    """Parse a string and return a datetime.timedelta
2867
2848
 
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
 
2849
    >>> string_to_delta('7d')
 
2850
    datetime.timedelta(7)
 
2851
    >>> string_to_delta('60s')
 
2852
    datetime.timedelta(0, 60)
 
2853
    >>> string_to_delta('60m')
 
2854
    datetime.timedelta(0, 3600)
 
2855
    >>> string_to_delta('24h')
 
2856
    datetime.timedelta(1)
 
2857
    >>> string_to_delta('1w')
 
2858
    datetime.timedelta(7)
 
2859
    >>> string_to_delta('5m 30s')
 
2860
    datetime.timedelta(0, 330)
2880
2861
    """
2881
2862
 
2882
2863
    try:
2984
2965
 
2985
2966
    options = parser.parse_args()
2986
2967
 
 
2968
    if options.check:
 
2969
        import doctest
 
2970
        fail_count, test_count = doctest.testmod()
 
2971
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2972
 
2987
2973
    # Default values for config file for server-global settings
2988
2974
    if gnutls.has_rawpk:
2989
2975
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3009
2995
    del priority
3010
2996
 
3011
2997
    # Parse config file for server-global settings
3012
 
    server_config = configparser.ConfigParser(server_defaults)
 
2998
    server_config = configparser.SafeConfigParser(server_defaults)
3013
2999
    del server_defaults
3014
3000
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3015
 
    # Convert the ConfigParser object to a dict
 
3001
    # Convert the SafeConfigParser object to a dict
3016
3002
    server_settings = server_config.defaults()
3017
3003
    # Use the appropriate methods on the non-string config options
3018
3004
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3090
3076
                                  server_settings["servicename"])))
3091
3077
 
3092
3078
    # Parse config file with clients
3093
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
3079
    client_config = configparser.SafeConfigParser(Client
 
3080
                                                  .client_defaults)
3094
3081
    client_config.read(os.path.join(server_settings["configdir"],
3095
3082
                                    "clients.conf"))
3096
3083
 
3167
3154
        # Close all input and output, do double fork, etc.
3168
3155
        daemon()
3169
3156
 
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()
 
3157
    # multiprocessing will use threads, so before we use GLib we need
 
3158
    # to inform GLib that threads will be used.
 
3159
    GLib.threads_init()
3174
3160
 
3175
3161
    global main_loop
3176
3162
    # From the Avahi example code
3252
3238
                             if isinstance(s, bytes)
3253
3239
                             else s) for s in
3254
3240
                            value["client_structure"]]
3255
 
                        # .name, .host, and .checker_command
3256
 
                        for k in ("name", "host", "checker_command"):
 
3241
                        # .name & .host
 
3242
                        for k in ("name", "host"):
3257
3243
                            if isinstance(value[k], bytes):
3258
3244
                                value[k] = value[k].decode("utf-8")
3259
 
                        if "key_id" not in value:
 
3245
                        if not value.has_key("key_id"):
3260
3246
                            value["key_id"] = ""
3261
 
                        elif "fingerprint" not in value:
 
3247
                        elif not value.has_key("fingerprint"):
3262
3248
                            value["fingerprint"] = ""
3263
3249
                    #  old_client_settings
3264
3250
                    # .keys()
3269
3255
                        for key, value in
3270
3256
                        bytes_old_client_settings.items()}
3271
3257
                    del bytes_old_client_settings
3272
 
                    # .host and .checker_command
 
3258
                    # .host
3273
3259
                    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"))
 
3260
                        if isinstance(value["host"], bytes):
 
3261
                            value["host"] = (value["host"]
 
3262
                                             .decode("utf-8"))
3278
3263
            os.remove(stored_state_path)
3279
3264
        except IOError as e:
3280
3265
            if e.errno == errno.ENOENT:
3605
3590
                sys.exit(1)
3606
3591
            # End of Avahi example code
3607
3592
 
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))
 
3593
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3594
                          lambda *args, **kwargs:
 
3595
                          (tcp_server.handle_request
 
3596
                           (*args[2:], **kwargs) or True))
3613
3597
 
3614
3598
        logger.debug("Starting main loop")
3615
3599
        main_loop.run()
3625
3609
    # Must run before the D-Bus bus name gets deregistered
3626
3610
    cleanup()
3627
3611
 
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
3612
 
3645
3613
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()
 
3614
    main()