/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-08-04 12:42:49 UTC
  • Revision ID: teddy@recompile.se-20190804124249-69cq19d1bgbmm0gh
Describe role of password-agent(8mandos) in intro(8mandos)

Describe the role of password-agent(8mandos) in the intro(8mandos)
manual.

* intro.xml (SYSTEMD): New section.
  (SEE ALSO): Add reference to password-agent(8mandos).

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
#
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2020 Teddy Hogeborn
15
 
# Copyright © 2008-2020 Björn Påhlsson
 
14
# Copyright © 2008-2019 Teddy Hogeborn
 
15
# Copyright © 2008-2019 Björn Påhlsson
16
16
#
17
17
# This file is part of Mandos.
18
18
#
77
77
import itertools
78
78
import collections
79
79
import codecs
80
 
import unittest
81
 
import random
82
 
import shlex
83
80
 
84
81
import dbus
85
82
import dbus.service
91
88
import xml.dom.minidom
92
89
import inspect
93
90
 
94
 
if sys.version_info.major == 2:
95
 
    __metaclass__ = type
96
 
    str = unicode
97
 
 
98
 
# Add collections.abc.Callable if it does not exist
99
 
try:
100
 
    collections.abc.Callable
101
 
except AttributeError:
102
 
    class abc:
103
 
        Callable = collections.Callable
104
 
    collections.abc = abc
105
 
    del abc
106
 
 
107
 
# Add shlex.quote if it does not exist
108
 
try:
109
 
    shlex.quote
110
 
except AttributeError:
111
 
    shlex.quote = re.escape
112
 
 
113
 
# Show warnings by default
114
 
if not sys.warnoptions:
115
 
    import warnings
116
 
    warnings.simplefilter("default")
117
 
 
118
91
# Try to find the value of SO_BINDTODEVICE:
119
92
try:
120
93
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
140
113
            # No value found
141
114
            SO_BINDTODEVICE = None
142
115
 
 
116
if sys.version_info.major == 2:
 
117
    str = unicode
 
118
 
143
119
if sys.version_info < (3, 2):
144
120
    configparser.Configparser = configparser.SafeConfigParser
145
121
 
146
 
version = "1.8.14"
 
122
version = "1.8.6"
147
123
stored_state_file = "clients.pickle"
148
124
 
149
125
logger = logging.getLogger()
150
 
logging.captureWarnings(True)   # Show warnings via the logging system
151
126
syslogger = None
152
127
 
153
128
try:
208
183
    pass
209
184
 
210
185
 
211
 
class PGPEngine:
 
186
class PGPEngine(object):
212
187
    """A simple class for OpenPGP symmetric encryption & decryption"""
213
188
 
214
189
    def __init__(self):
218
193
            output = subprocess.check_output(["gpgconf"])
219
194
            for line in output.splitlines():
220
195
                name, text, path = line.split(b":")
221
 
                if name == b"gpg":
 
196
                if name == "gpg":
222
197
                    self.gpg = path
223
198
                    break
224
199
        except OSError as e:
229
204
                          '--force-mdc',
230
205
                          '--quiet']
231
206
        # Only GPG version 1 has the --no-use-agent option.
232
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
207
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
233
208
            self.gnupgargs.append("--no-use-agent")
234
209
 
235
210
    def __enter__(self):
304
279
 
305
280
 
306
281
# Pretend that we have an Avahi module
307
 
class avahi:
 
282
class avahi(object):
308
283
    """This isn't so much a class as it is a module-like namespace."""
309
284
    IF_UNSPEC = -1               # avahi-common/address.h
310
285
    PROTO_UNSPEC = -1            # avahi-common/address.h
344
319
    pass
345
320
 
346
321
 
347
 
class AvahiService:
 
322
class AvahiService(object):
348
323
    """An Avahi (Zeroconf) service.
349
324
 
350
325
    Attributes:
524
499
class AvahiServiceToSyslog(AvahiService):
525
500
    def rename(self, *args, **kwargs):
526
501
        """Add the new name to the syslog messages"""
527
 
        ret = super(AvahiServiceToSyslog, self).rename(*args,
528
 
                                                       **kwargs)
 
502
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
529
503
        syslogger.setFormatter(logging.Formatter(
530
504
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
531
505
            .format(self.name)))
533
507
 
534
508
 
535
509
# Pretend that we have a GnuTLS module
536
 
class gnutls:
 
510
class gnutls(object):
537
511
    """This isn't so much a class as it is a module-like namespace."""
538
512
 
539
513
    library = ctypes.util.find_library("gnutls")
602
576
        pass
603
577
 
604
578
    # Classes
605
 
    class Credentials:
 
579
    class Credentials(object):
606
580
        def __init__(self):
607
581
            self._c_object = gnutls.certificate_credentials_t()
608
582
            gnutls.certificate_allocate_credentials(
612
586
        def __del__(self):
613
587
            gnutls.certificate_free_credentials(self._c_object)
614
588
 
615
 
    class ClientSession:
 
589
    class ClientSession(object):
616
590
        def __init__(self, socket, credentials=None):
617
591
            self._c_object = gnutls.session_t()
618
592
            gnutls_flags = gnutls.CLIENT
661
635
            raise gnutls.CertificateSecurityError(code=result)
662
636
        raise gnutls.Error(code=result)
663
637
 
664
 
    def _retry_on_error(result, func, arguments,
665
 
                        _error_code=_error_code):
 
638
    def _retry_on_error(result, func, arguments):
666
639
        """A function to retry on some errors, suitable
667
640
        for the 'errcheck' attribute on ctypes functions"""
668
641
        while result < 0:
776
749
 
777
750
        x509_crt_fmt_t = ctypes.c_int
778
751
 
779
 
        # All the function declarations below are from
780
 
        # gnutls/abstract.h
 
752
        # All the function declarations below are from gnutls/abstract.h
781
753
        pubkey_init = _library.gnutls_pubkey_init
782
754
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
783
755
        pubkey_init.restype = _error_code
797
769
        pubkey_deinit.argtypes = [pubkey_t]
798
770
        pubkey_deinit.restype = None
799
771
    else:
800
 
        # All the function declarations below are from
801
 
        # gnutls/openpgp.h
 
772
        # All the function declarations below are from gnutls/openpgp.h
802
773
 
803
774
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
804
775
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
810
781
                                       openpgp_crt_fmt_t]
811
782
        openpgp_crt_import.restype = _error_code
812
783
 
813
 
        openpgp_crt_verify_self = \
814
 
            _library.gnutls_openpgp_crt_verify_self
815
 
        openpgp_crt_verify_self.argtypes = [
816
 
            openpgp_crt_t,
817
 
            ctypes.c_uint,
818
 
            ctypes.POINTER(ctypes.c_uint),
819
 
        ]
 
784
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
785
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
786
                                            ctypes.POINTER(ctypes.c_uint)]
820
787
        openpgp_crt_verify_self.restype = _error_code
821
788
 
822
789
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
851
818
    connection.close()
852
819
 
853
820
 
854
 
class Client:
 
821
class Client(object):
855
822
    """A representation of a client host served by this server.
856
823
 
857
824
    Attributes:
1060
1027
        if self.checker_initiator_tag is not None:
1061
1028
            GLib.source_remove(self.checker_initiator_tag)
1062
1029
        self.checker_initiator_tag = GLib.timeout_add(
1063
 
            random.randrange(int(self.interval.total_seconds() * 1000
1064
 
                                 + 1)),
 
1030
            int(self.interval.total_seconds() * 1000),
1065
1031
            self.start_checker)
1066
1032
        # Schedule a disable() when 'timeout' has passed
1067
1033
        if self.disable_initiator_tag is not None:
1077
1043
        # Read return code from connection (see call_pipe)
1078
1044
        returncode = connection.recv()
1079
1045
        connection.close()
1080
 
        if self.checker is not None:
1081
 
            self.checker.join()
 
1046
        self.checker.join()
1082
1047
        self.checker_callback_tag = None
1083
1048
        self.checker = None
1084
1049
 
1142
1107
        if self.checker is None:
1143
1108
            # Escape attributes for the shell
1144
1109
            escaped_attrs = {
1145
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1110
                attr: re.escape(str(getattr(self, attr)))
1146
1111
                for attr in self.runtime_expansions}
1147
1112
            try:
1148
1113
                command = self.checker_command % escaped_attrs
1175
1140
                kwargs=popen_args)
1176
1141
            self.checker.start()
1177
1142
            self.checker_callback_tag = GLib.io_add_watch(
1178
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1179
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1143
                pipe[0].fileno(), GLib.IO_IN,
1180
1144
                self.checker_callback, pipe[0], command)
1181
1145
        # Re-run this periodically if run by GLib.timeout_add
1182
1146
        return True
1437
1401
                raise ValueError("Byte arrays not supported for non-"
1438
1402
                                 "'ay' signature {!r}"
1439
1403
                                 .format(prop._dbus_signature))
1440
 
            value = dbus.ByteArray(bytes(value))
 
1404
            value = dbus.ByteArray(b''.join(chr(byte)
 
1405
                                            for byte in value))
1441
1406
        prop(value)
1442
1407
 
1443
1408
    @dbus.service.method(dbus.PROPERTIES_IFACE,
2248
2213
    del _interface
2249
2214
 
2250
2215
 
2251
 
class ProxyClient:
 
2216
class ProxyClient(object):
2252
2217
    def __init__(self, child_pipe, key_id, fpr, address):
2253
2218
        self._pipe = child_pipe
2254
2219
        self._pipe.send(('init', key_id, fpr, address))
2476
2441
        buf = ctypes.create_string_buffer(32)
2477
2442
        buf_len = ctypes.c_size_t(len(buf))
2478
2443
        # Get the key ID from the raw public key into the buffer
2479
 
        gnutls.pubkey_get_key_id(
2480
 
            pubkey,
2481
 
            gnutls.KEYID_USE_SHA256,
2482
 
            ctypes.cast(ctypes.byref(buf),
2483
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2484
 
            ctypes.byref(buf_len))
 
2444
        gnutls.pubkey_get_key_id(pubkey,
 
2445
                                 gnutls.KEYID_USE_SHA256,
 
2446
                                 ctypes.cast(ctypes.byref(buf),
 
2447
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2448
                                 ctypes.byref(buf_len))
2485
2449
        # Deinit the certificate
2486
2450
        gnutls.pubkey_deinit(pubkey)
2487
2451
 
2528
2492
        return hex_fpr
2529
2493
 
2530
2494
 
2531
 
class MultiprocessingMixIn:
 
2495
class MultiprocessingMixIn(object):
2532
2496
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2533
2497
 
2534
2498
    def sub_process_main(self, request, address):
2546
2510
        return proc
2547
2511
 
2548
2512
 
2549
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2513
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2550
2514
    """ adds a pipe to the MixIn """
2551
2515
 
2552
2516
    def process_request(self, request, client_address):
2567
2531
 
2568
2532
 
2569
2533
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2570
 
                     socketserver.TCPServer):
 
2534
                     socketserver.TCPServer, object):
2571
2535
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2572
2536
 
2573
2537
    Attributes:
2706
2670
    def add_pipe(self, parent_pipe, proc):
2707
2671
        # Call "handle_ipc" for both data and EOF events
2708
2672
        GLib.io_add_watch(
2709
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2710
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2673
            parent_pipe.fileno(),
 
2674
            GLib.IO_IN | GLib.IO_HUP,
2711
2675
            functools.partial(self.handle_ipc,
2712
2676
                              parent_pipe=parent_pipe,
2713
2677
                              proc=proc))
2732
2696
            address = request[3]
2733
2697
 
2734
2698
            for c in self.clients.values():
2735
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2736
 
                              "27AE41E4649B934CA495991B7852B855"):
 
2699
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2737
2700
                    continue
2738
2701
                if key_id and c.key_id == key_id:
2739
2702
                    client = c
2752
2715
                return False
2753
2716
 
2754
2717
            GLib.io_add_watch(
2755
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2756
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2718
                parent_pipe.fileno(),
 
2719
                GLib.IO_IN | GLib.IO_HUP,
2757
2720
                functools.partial(self.handle_ipc,
2758
2721
                                  parent_pipe=parent_pipe,
2759
2722
                                  proc=proc,
2774
2737
        if command == 'getattr':
2775
2738
            attrname = request[1]
2776
2739
            if isinstance(client_object.__getattribute__(attrname),
2777
 
                          collections.abc.Callable):
 
2740
                          collections.Callable):
2778
2741
                parent_pipe.send(('function', ))
2779
2742
            else:
2780
2743
                parent_pipe.send((
2791
2754
def rfc3339_duration_to_delta(duration):
2792
2755
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2793
2756
 
2794
 
    >>> timedelta = datetime.timedelta
2795
 
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2796
 
    True
2797
 
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2798
 
    True
2799
 
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2800
 
    True
2801
 
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2802
 
    True
2803
 
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2804
 
    True
2805
 
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2806
 
    True
2807
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2808
 
    True
2809
 
    >>> del timedelta
 
2757
    >>> rfc3339_duration_to_delta("P7D")
 
2758
    datetime.timedelta(7)
 
2759
    >>> rfc3339_duration_to_delta("PT60S")
 
2760
    datetime.timedelta(0, 60)
 
2761
    >>> rfc3339_duration_to_delta("PT60M")
 
2762
    datetime.timedelta(0, 3600)
 
2763
    >>> rfc3339_duration_to_delta("PT24H")
 
2764
    datetime.timedelta(1)
 
2765
    >>> rfc3339_duration_to_delta("P1W")
 
2766
    datetime.timedelta(7)
 
2767
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2768
    datetime.timedelta(0, 330)
 
2769
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2770
    datetime.timedelta(1, 200)
2810
2771
    """
2811
2772
 
2812
2773
    # Parsing an RFC 3339 duration with regular expressions is not
2892
2853
def string_to_delta(interval):
2893
2854
    """Parse a string and return a datetime.timedelta
2894
2855
 
2895
 
    >>> string_to_delta('7d') == datetime.timedelta(7)
2896
 
    True
2897
 
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
2898
 
    True
2899
 
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2900
 
    True
2901
 
    >>> string_to_delta('24h') == datetime.timedelta(1)
2902
 
    True
2903
 
    >>> string_to_delta('1w') == datetime.timedelta(7)
2904
 
    True
2905
 
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2906
 
    True
 
2856
    >>> string_to_delta('7d')
 
2857
    datetime.timedelta(7)
 
2858
    >>> string_to_delta('60s')
 
2859
    datetime.timedelta(0, 60)
 
2860
    >>> string_to_delta('60m')
 
2861
    datetime.timedelta(0, 3600)
 
2862
    >>> string_to_delta('24h')
 
2863
    datetime.timedelta(1)
 
2864
    >>> string_to_delta('1w')
 
2865
    datetime.timedelta(7)
 
2866
    >>> string_to_delta('5m 30s')
 
2867
    datetime.timedelta(0, 330)
2907
2868
    """
2908
2869
 
2909
2870
    try:
3011
2972
 
3012
2973
    options = parser.parse_args()
3013
2974
 
 
2975
    if options.check:
 
2976
        import doctest
 
2977
        fail_count, test_count = doctest.testmod()
 
2978
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2979
 
3014
2980
    # Default values for config file for server-global settings
3015
2981
    if gnutls.has_rawpk:
3016
2982
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3279
3245
                             if isinstance(s, bytes)
3280
3246
                             else s) for s in
3281
3247
                            value["client_structure"]]
3282
 
                        # .name, .host, and .checker_command
3283
 
                        for k in ("name", "host", "checker_command"):
 
3248
                        # .name & .host
 
3249
                        for k in ("name", "host"):
3284
3250
                            if isinstance(value[k], bytes):
3285
3251
                                value[k] = value[k].decode("utf-8")
3286
3252
                        if "key_id" not in value:
3296
3262
                        for key, value in
3297
3263
                        bytes_old_client_settings.items()}
3298
3264
                    del bytes_old_client_settings
3299
 
                    # .host and .checker_command
 
3265
                    # .host
3300
3266
                    for value in old_client_settings.values():
3301
 
                        for attribute in ("host", "checker_command"):
3302
 
                            if isinstance(value[attribute], bytes):
3303
 
                                value[attribute] = (value[attribute]
3304
 
                                                    .decode("utf-8"))
 
3267
                        if isinstance(value["host"], bytes):
 
3268
                            value["host"] = (value["host"]
 
3269
                                             .decode("utf-8"))
3305
3270
            os.remove(stored_state_path)
3306
3271
        except IOError as e:
3307
3272
            if e.errno == errno.ENOENT:
3632
3597
                sys.exit(1)
3633
3598
            # End of Avahi example code
3634
3599
 
3635
 
        GLib.io_add_watch(
3636
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3637
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3638
 
            lambda *args, **kwargs: (tcp_server.handle_request
3639
 
                                     (*args[2:], **kwargs) or True))
 
3600
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3601
                          lambda *args, **kwargs:
 
3602
                          (tcp_server.handle_request
 
3603
                           (*args[2:], **kwargs) or True))
3640
3604
 
3641
3605
        logger.debug("Starting main loop")
3642
3606
        main_loop.run()
3652
3616
    # Must run before the D-Bus bus name gets deregistered
3653
3617
    cleanup()
3654
3618
 
3655
 
 
3656
 
def should_only_run_tests():
3657
 
    parser = argparse.ArgumentParser(add_help=False)
3658
 
    parser.add_argument("--check", action='store_true')
3659
 
    args, unknown_args = parser.parse_known_args()
3660
 
    run_tests = args.check
3661
 
    if run_tests:
3662
 
        # Remove --check argument from sys.argv
3663
 
        sys.argv[1:] = unknown_args
3664
 
    return run_tests
3665
 
 
3666
 
# Add all tests from doctest strings
3667
 
def load_tests(loader, tests, none):
3668
 
    import doctest
3669
 
    tests.addTests(doctest.DocTestSuite())
3670
 
    return tests
3671
3619
 
3672
3620
if __name__ == '__main__':
3673
 
    try:
3674
 
        if should_only_run_tests():
3675
 
            # Call using ./mandos --check [--verbose]
3676
 
            unittest.main()
3677
 
        else:
3678
 
            main()
3679
 
    finally:
3680
 
        logging.shutdown()
 
3621
    main()