/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
 
    str = unicode
95
 
 
96
 
# Show warnings by default
97
 
if not sys.warnoptions:
98
 
    import warnings
99
 
    warnings.simplefilter("default")
100
 
 
101
90
# Try to find the value of SO_BINDTODEVICE:
102
91
try:
103
92
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
123
112
            # No value found
124
113
            SO_BINDTODEVICE = None
125
114
 
126
 
if sys.version_info < (3, 2):
127
 
    configparser.Configparser = configparser.SafeConfigParser
 
115
if sys.version_info.major == 2:
 
116
    str = unicode
128
117
 
129
 
version = "1.8.9"
 
118
version = "1.8.4"
130
119
stored_state_file = "clients.pickle"
131
120
 
132
121
logger = logging.getLogger()
133
 
logging.captureWarnings(True)   # Show warnings via the logging system
134
122
syslogger = None
135
123
 
136
124
try:
191
179
    pass
192
180
 
193
181
 
194
 
class PGPEngine:
 
182
class PGPEngine(object):
195
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
196
184
 
197
185
    def __init__(self):
201
189
            output = subprocess.check_output(["gpgconf"])
202
190
            for line in output.splitlines():
203
191
                name, text, path = line.split(b":")
204
 
                if name == b"gpg":
 
192
                if name == "gpg":
205
193
                    self.gpg = path
206
194
                    break
207
195
        except OSError as e:
212
200
                          '--force-mdc',
213
201
                          '--quiet']
214
202
        # Only GPG version 1 has the --no-use-agent option.
215
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
203
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
216
204
            self.gnupgargs.append("--no-use-agent")
217
205
 
218
206
    def __enter__(self):
287
275
 
288
276
 
289
277
# Pretend that we have an Avahi module
290
 
class avahi:
 
278
class avahi(object):
291
279
    """This isn't so much a class as it is a module-like namespace."""
292
280
    IF_UNSPEC = -1               # avahi-common/address.h
293
281
    PROTO_UNSPEC = -1            # avahi-common/address.h
327
315
    pass
328
316
 
329
317
 
330
 
class AvahiService:
 
318
class AvahiService(object):
331
319
    """An Avahi (Zeroconf) service.
332
320
 
333
321
    Attributes:
515
503
 
516
504
 
517
505
# Pretend that we have a GnuTLS module
518
 
class gnutls:
 
506
class gnutls(object):
519
507
    """This isn't so much a class as it is a module-like namespace."""
520
508
 
521
509
    library = ctypes.util.find_library("gnutls")
584
572
        pass
585
573
 
586
574
    # Classes
587
 
    class Credentials:
 
575
    class Credentials(object):
588
576
        def __init__(self):
589
577
            self._c_object = gnutls.certificate_credentials_t()
590
578
            gnutls.certificate_allocate_credentials(
594
582
        def __del__(self):
595
583
            gnutls.certificate_free_credentials(self._c_object)
596
584
 
597
 
    class ClientSession:
 
585
    class ClientSession(object):
598
586
        def __init__(self, socket, credentials=None):
599
587
            self._c_object = gnutls.session_t()
600
588
            gnutls_flags = gnutls.CLIENT
601
 
            if gnutls.check_version(b"3.5.6"):
 
589
            if gnutls.check_version("3.5.6"):
602
590
                gnutls_flags |= gnutls.NO_TICKETS
603
591
            if gnutls.has_rawpk:
604
592
                gnutls_flags |= gnutls.ENABLE_RAWPK
806
794
                                                    ctypes.c_size_t)]
807
795
        openpgp_crt_get_fingerprint.restype = _error_code
808
796
 
809
 
    if check_version(b"3.6.4"):
 
797
    if check_version("3.6.4"):
810
798
        certificate_type_get2 = _library.gnutls_certificate_type_get2
811
799
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
812
800
        certificate_type_get2.restype = _error_code
826
814
    connection.close()
827
815
 
828
816
 
829
 
class Client:
 
817
class Client(object):
830
818
    """A representation of a client host served by this server.
831
819
 
832
820
    Attributes:
833
821
    approved:   bool(); 'None' if not yet approved/disapproved
834
822
    approval_delay: datetime.timedelta(); Time to wait for approval
835
823
    approval_duration: datetime.timedelta(); Duration of one approval
836
 
    checker: multiprocessing.Process(); a running checker process used
837
 
             to see if the client lives. 'None' if no process is
838
 
             running.
 
824
    checker:    subprocess.Popen(); a running checker process used
 
825
                                    to see if the client lives.
 
826
                                    'None' if no process is running.
839
827
    checker_callback_tag: a GLib event source tag, or None
840
828
    checker_command: string; External command which is run to check
841
829
                     if client lives.  %() expansions are done at
1048
1036
    def checker_callback(self, source, condition, connection,
1049
1037
                         command):
1050
1038
        """The checker has completed, so take appropriate actions."""
 
1039
        self.checker_callback_tag = None
 
1040
        self.checker = None
1051
1041
        # Read return code from connection (see call_pipe)
1052
1042
        returncode = connection.recv()
1053
1043
        connection.close()
1054
 
        if self.checker is not None:
1055
 
            self.checker.join()
1056
 
        self.checker_callback_tag = None
1057
 
        self.checker = None
1058
1044
 
1059
1045
        if returncode >= 0:
1060
1046
            self.last_checker_status = returncode
1149
1135
                kwargs=popen_args)
1150
1136
            self.checker.start()
1151
1137
            self.checker_callback_tag = GLib.io_add_watch(
1152
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1153
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1138
                pipe[0].fileno(), GLib.IO_IN,
1154
1139
                self.checker_callback, pipe[0], command)
1155
1140
        # Re-run this periodically if run by GLib.timeout_add
1156
1141
        return True
1411
1396
                raise ValueError("Byte arrays not supported for non-"
1412
1397
                                 "'ay' signature {!r}"
1413
1398
                                 .format(prop._dbus_signature))
1414
 
            value = dbus.ByteArray(bytes(value))
 
1399
            value = dbus.ByteArray(b''.join(chr(byte)
 
1400
                                            for byte in value))
1415
1401
        prop(value)
1416
1402
 
1417
1403
    @dbus.service.method(dbus.PROPERTIES_IFACE,
2222
2208
    del _interface
2223
2209
 
2224
2210
 
2225
 
class ProxyClient:
 
2211
class ProxyClient(object):
2226
2212
    def __init__(self, child_pipe, key_id, fpr, address):
2227
2213
        self._pipe = child_pipe
2228
2214
        self._pipe.send(('init', key_id, fpr, address))
2301
2287
            approval_required = False
2302
2288
            try:
2303
2289
                if gnutls.has_rawpk:
2304
 
                    fpr = b""
 
2290
                    fpr = ""
2305
2291
                    try:
2306
2292
                        key_id = self.key_id(
2307
2293
                            self.peer_certificate(session))
2311
2297
                    logger.debug("Key ID: %s", key_id)
2312
2298
 
2313
2299
                else:
2314
 
                    key_id = b""
 
2300
                    key_id = ""
2315
2301
                    try:
2316
2302
                        fpr = self.fingerprint(
2317
2303
                            self.peer_certificate(session))
2501
2487
        return hex_fpr
2502
2488
 
2503
2489
 
2504
 
class MultiprocessingMixIn:
 
2490
class MultiprocessingMixIn(object):
2505
2491
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2506
2492
 
2507
2493
    def sub_process_main(self, request, address):
2519
2505
        return proc
2520
2506
 
2521
2507
 
2522
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2508
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2523
2509
    """ adds a pipe to the MixIn """
2524
2510
 
2525
2511
    def process_request(self, request, client_address):
2540
2526
 
2541
2527
 
2542
2528
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2543
 
                     socketserver.TCPServer):
 
2529
                     socketserver.TCPServer, object):
2544
2530
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2545
2531
 
2546
2532
    Attributes:
2619
2605
                    raise
2620
2606
        # Only bind(2) the socket if we really need to.
2621
2607
        if self.server_address[0] or self.server_address[1]:
2622
 
            if self.server_address[1]:
2623
 
                self.allow_reuse_address = True
2624
2608
            if not self.server_address[0]:
2625
2609
                if self.address_family == socket.AF_INET6:
2626
2610
                    any_address = "::"  # in6addr_any
2679
2663
    def add_pipe(self, parent_pipe, proc):
2680
2664
        # Call "handle_ipc" for both data and EOF events
2681
2665
        GLib.io_add_watch(
2682
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2683
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2666
            parent_pipe.fileno(),
 
2667
            GLib.IO_IN | GLib.IO_HUP,
2684
2668
            functools.partial(self.handle_ipc,
2685
2669
                              parent_pipe=parent_pipe,
2686
2670
                              proc=proc))
2724
2708
                return False
2725
2709
 
2726
2710
            GLib.io_add_watch(
2727
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2728
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2711
                parent_pipe.fileno(),
 
2712
                GLib.IO_IN | GLib.IO_HUP,
2729
2713
                functools.partial(self.handle_ipc,
2730
2714
                                  parent_pipe=parent_pipe,
2731
2715
                                  proc=proc,
2763
2747
def rfc3339_duration_to_delta(duration):
2764
2748
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2765
2749
 
2766
 
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2767
 
    True
2768
 
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2769
 
    True
2770
 
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2771
 
    True
2772
 
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2773
 
    True
2774
 
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2775
 
    True
2776
 
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2777
 
    True
2778
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2779
 
    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)
2780
2764
    """
2781
2765
 
2782
2766
    # Parsing an RFC 3339 duration with regular expressions is not
2862
2846
def string_to_delta(interval):
2863
2847
    """Parse a string and return a datetime.timedelta
2864
2848
 
2865
 
    >>> string_to_delta('7d') == datetime.timedelta(7)
2866
 
    True
2867
 
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
2868
 
    True
2869
 
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2870
 
    True
2871
 
    >>> string_to_delta('24h') == datetime.timedelta(1)
2872
 
    True
2873
 
    >>> string_to_delta('1w') == datetime.timedelta(7)
2874
 
    True
2875
 
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2876
 
    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)
2877
2861
    """
2878
2862
 
2879
2863
    try:
2981
2965
 
2982
2966
    options = parser.parse_args()
2983
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
 
2984
2973
    # Default values for config file for server-global settings
2985
2974
    if gnutls.has_rawpk:
2986
2975
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3006
2995
    del priority
3007
2996
 
3008
2997
    # Parse config file for server-global settings
3009
 
    server_config = configparser.ConfigParser(server_defaults)
 
2998
    server_config = configparser.SafeConfigParser(server_defaults)
3010
2999
    del server_defaults
3011
3000
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3012
 
    # Convert the ConfigParser object to a dict
 
3001
    # Convert the SafeConfigParser object to a dict
3013
3002
    server_settings = server_config.defaults()
3014
3003
    # Use the appropriate methods on the non-string config options
3015
3004
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3087
3076
                                  server_settings["servicename"])))
3088
3077
 
3089
3078
    # Parse config file with clients
3090
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
3079
    client_config = configparser.SafeConfigParser(Client
 
3080
                                                  .client_defaults)
3091
3081
    client_config.read(os.path.join(server_settings["configdir"],
3092
3082
                                    "clients.conf"))
3093
3083
 
3164
3154
        # Close all input and output, do double fork, etc.
3165
3155
        daemon()
3166
3156
 
3167
 
    if gi.version_info < (3, 10, 2):
3168
 
        # multiprocessing will use threads, so before we use GLib we
3169
 
        # need to inform GLib that threads will be used.
3170
 
        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()
3171
3160
 
3172
3161
    global main_loop
3173
3162
    # From the Avahi example code
3249
3238
                             if isinstance(s, bytes)
3250
3239
                             else s) for s in
3251
3240
                            value["client_structure"]]
3252
 
                        # .name, .host, and .checker_command
3253
 
                        for k in ("name", "host", "checker_command"):
 
3241
                        # .name & .host
 
3242
                        for k in ("name", "host"):
3254
3243
                            if isinstance(value[k], bytes):
3255
3244
                                value[k] = value[k].decode("utf-8")
3256
 
                        if "key_id" not in value:
 
3245
                        if not value.has_key("key_id"):
3257
3246
                            value["key_id"] = ""
3258
 
                        elif "fingerprint" not in value:
 
3247
                        elif not value.has_key("fingerprint"):
3259
3248
                            value["fingerprint"] = ""
3260
3249
                    #  old_client_settings
3261
3250
                    # .keys()
3266
3255
                        for key, value in
3267
3256
                        bytes_old_client_settings.items()}
3268
3257
                    del bytes_old_client_settings
3269
 
                    # .host and .checker_command
 
3258
                    # .host
3270
3259
                    for value in old_client_settings.values():
3271
 
                        for attribute in ("host", "checker_command"):
3272
 
                            if isinstance(value[attribute], bytes):
3273
 
                                value[attribute] = (value[attribute]
3274
 
                                                    .decode("utf-8"))
 
3260
                        if isinstance(value["host"], bytes):
 
3261
                            value["host"] = (value["host"]
 
3262
                                             .decode("utf-8"))
3275
3263
            os.remove(stored_state_path)
3276
3264
        except IOError as e:
3277
3265
            if e.errno == errno.ENOENT:
3602
3590
                sys.exit(1)
3603
3591
            # End of Avahi example code
3604
3592
 
3605
 
        GLib.io_add_watch(
3606
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3607
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3608
 
            lambda *args, **kwargs: (tcp_server.handle_request
3609
 
                                     (*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))
3610
3597
 
3611
3598
        logger.debug("Starting main loop")
3612
3599
        main_loop.run()
3622
3609
    # Must run before the D-Bus bus name gets deregistered
3623
3610
    cleanup()
3624
3611
 
3625
 
 
3626
 
def should_only_run_tests():
3627
 
    parser = argparse.ArgumentParser(add_help=False)
3628
 
    parser.add_argument("--check", action='store_true')
3629
 
    args, unknown_args = parser.parse_known_args()
3630
 
    run_tests = args.check
3631
 
    if run_tests:
3632
 
        # Remove --check argument from sys.argv
3633
 
        sys.argv[1:] = unknown_args
3634
 
    return run_tests
3635
 
 
3636
 
# Add all tests from doctest strings
3637
 
def load_tests(loader, tests, none):
3638
 
    import doctest
3639
 
    tests.addTests(doctest.DocTestSuite())
3640
 
    return tests
3641
3612
 
3642
3613
if __name__ == '__main__':
3643
 
    try:
3644
 
        if should_only_run_tests():
3645
 
            # Call using ./mandos --check [--verbose]
3646
 
            unittest.main()
3647
 
        else:
3648
 
            main()
3649
 
    finally:
3650
 
        logging.shutdown()
 
3614
    main()