/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:
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
 
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.9"
 
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:
532
507
 
533
508
 
534
509
# Pretend that we have a GnuTLS module
535
 
class gnutls:
 
510
class gnutls(object):
536
511
    """This isn't so much a class as it is a module-like namespace."""
537
512
 
538
513
    library = ctypes.util.find_library("gnutls")
601
576
        pass
602
577
 
603
578
    # Classes
604
 
    class Credentials:
 
579
    class Credentials(object):
605
580
        def __init__(self):
606
581
            self._c_object = gnutls.certificate_credentials_t()
607
582
            gnutls.certificate_allocate_credentials(
611
586
        def __del__(self):
612
587
            gnutls.certificate_free_credentials(self._c_object)
613
588
 
614
 
    class ClientSession:
 
589
    class ClientSession(object):
615
590
        def __init__(self, socket, credentials=None):
616
591
            self._c_object = gnutls.session_t()
617
592
            gnutls_flags = gnutls.CLIENT
843
818
    connection.close()
844
819
 
845
820
 
846
 
class Client:
 
821
class Client(object):
847
822
    """A representation of a client host served by this server.
848
823
 
849
824
    Attributes:
1052
1027
        if self.checker_initiator_tag is not None:
1053
1028
            GLib.source_remove(self.checker_initiator_tag)
1054
1029
        self.checker_initiator_tag = GLib.timeout_add(
1055
 
            random.randrange(int(self.interval.total_seconds() * 1000
1056
 
                                 + 1)),
 
1030
            int(self.interval.total_seconds() * 1000),
1057
1031
            self.start_checker)
1058
1032
        # Schedule a disable() when 'timeout' has passed
1059
1033
        if self.disable_initiator_tag is not None:
1069
1043
        # Read return code from connection (see call_pipe)
1070
1044
        returncode = connection.recv()
1071
1045
        connection.close()
1072
 
        if self.checker is not None:
1073
 
            self.checker.join()
 
1046
        self.checker.join()
1074
1047
        self.checker_callback_tag = None
1075
1048
        self.checker = None
1076
1049
 
1134
1107
        if self.checker is None:
1135
1108
            # Escape attributes for the shell
1136
1109
            escaped_attrs = {
1137
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1110
                attr: re.escape(str(getattr(self, attr)))
1138
1111
                for attr in self.runtime_expansions}
1139
1112
            try:
1140
1113
                command = self.checker_command % escaped_attrs
1167
1140
                kwargs=popen_args)
1168
1141
            self.checker.start()
1169
1142
            self.checker_callback_tag = GLib.io_add_watch(
1170
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1171
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1143
                pipe[0].fileno(), GLib.IO_IN,
1172
1144
                self.checker_callback, pipe[0], command)
1173
1145
        # Re-run this periodically if run by GLib.timeout_add
1174
1146
        return True
1429
1401
                raise ValueError("Byte arrays not supported for non-"
1430
1402
                                 "'ay' signature {!r}"
1431
1403
                                 .format(prop._dbus_signature))
1432
 
            value = dbus.ByteArray(bytes(value))
 
1404
            value = dbus.ByteArray(b''.join(chr(byte)
 
1405
                                            for byte in value))
1433
1406
        prop(value)
1434
1407
 
1435
1408
    @dbus.service.method(dbus.PROPERTIES_IFACE,
2240
2213
    del _interface
2241
2214
 
2242
2215
 
2243
 
class ProxyClient:
 
2216
class ProxyClient(object):
2244
2217
    def __init__(self, child_pipe, key_id, fpr, address):
2245
2218
        self._pipe = child_pipe
2246
2219
        self._pipe.send(('init', key_id, fpr, address))
2519
2492
        return hex_fpr
2520
2493
 
2521
2494
 
2522
 
class MultiprocessingMixIn:
 
2495
class MultiprocessingMixIn(object):
2523
2496
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2524
2497
 
2525
2498
    def sub_process_main(self, request, address):
2537
2510
        return proc
2538
2511
 
2539
2512
 
2540
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2513
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2541
2514
    """ adds a pipe to the MixIn """
2542
2515
 
2543
2516
    def process_request(self, request, client_address):
2558
2531
 
2559
2532
 
2560
2533
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2561
 
                     socketserver.TCPServer):
 
2534
                     socketserver.TCPServer, object):
2562
2535
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2563
2536
 
2564
2537
    Attributes:
2697
2670
    def add_pipe(self, parent_pipe, proc):
2698
2671
        # Call "handle_ipc" for both data and EOF events
2699
2672
        GLib.io_add_watch(
2700
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2701
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2673
            parent_pipe.fileno(),
 
2674
            GLib.IO_IN | GLib.IO_HUP,
2702
2675
            functools.partial(self.handle_ipc,
2703
2676
                              parent_pipe=parent_pipe,
2704
2677
                              proc=proc))
2742
2715
                return False
2743
2716
 
2744
2717
            GLib.io_add_watch(
2745
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2746
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2718
                parent_pipe.fileno(),
 
2719
                GLib.IO_IN | GLib.IO_HUP,
2747
2720
                functools.partial(self.handle_ipc,
2748
2721
                                  parent_pipe=parent_pipe,
2749
2722
                                  proc=proc,
2764
2737
        if command == 'getattr':
2765
2738
            attrname = request[1]
2766
2739
            if isinstance(client_object.__getattribute__(attrname),
2767
 
                          collections.abc.Callable):
 
2740
                          collections.Callable):
2768
2741
                parent_pipe.send(('function', ))
2769
2742
            else:
2770
2743
                parent_pipe.send((
2781
2754
def rfc3339_duration_to_delta(duration):
2782
2755
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2783
2756
 
2784
 
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2785
 
    True
2786
 
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2787
 
    True
2788
 
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2789
 
    True
2790
 
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2791
 
    True
2792
 
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2793
 
    True
2794
 
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2795
 
    True
2796
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2797
 
    True
 
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)
2798
2771
    """
2799
2772
 
2800
2773
    # Parsing an RFC 3339 duration with regular expressions is not
2880
2853
def string_to_delta(interval):
2881
2854
    """Parse a string and return a datetime.timedelta
2882
2855
 
2883
 
    >>> string_to_delta('7d') == datetime.timedelta(7)
2884
 
    True
2885
 
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
2886
 
    True
2887
 
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2888
 
    True
2889
 
    >>> string_to_delta('24h') == datetime.timedelta(1)
2890
 
    True
2891
 
    >>> string_to_delta('1w') == datetime.timedelta(7)
2892
 
    True
2893
 
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2894
 
    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)
2895
2868
    """
2896
2869
 
2897
2870
    try:
2999
2972
 
3000
2973
    options = parser.parse_args()
3001
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
 
3002
2980
    # Default values for config file for server-global settings
3003
2981
    if gnutls.has_rawpk:
3004
2982
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3267
3245
                             if isinstance(s, bytes)
3268
3246
                             else s) for s in
3269
3247
                            value["client_structure"]]
3270
 
                        # .name, .host, and .checker_command
3271
 
                        for k in ("name", "host", "checker_command"):
 
3248
                        # .name & .host
 
3249
                        for k in ("name", "host"):
3272
3250
                            if isinstance(value[k], bytes):
3273
3251
                                value[k] = value[k].decode("utf-8")
3274
3252
                        if "key_id" not in value:
3284
3262
                        for key, value in
3285
3263
                        bytes_old_client_settings.items()}
3286
3264
                    del bytes_old_client_settings
3287
 
                    # .host and .checker_command
 
3265
                    # .host
3288
3266
                    for value in old_client_settings.values():
3289
 
                        for attribute in ("host", "checker_command"):
3290
 
                            if isinstance(value[attribute], bytes):
3291
 
                                value[attribute] = (value[attribute]
3292
 
                                                    .decode("utf-8"))
 
3267
                        if isinstance(value["host"], bytes):
 
3268
                            value["host"] = (value["host"]
 
3269
                                             .decode("utf-8"))
3293
3270
            os.remove(stored_state_path)
3294
3271
        except IOError as e:
3295
3272
            if e.errno == errno.ENOENT:
3620
3597
                sys.exit(1)
3621
3598
            # End of Avahi example code
3622
3599
 
3623
 
        GLib.io_add_watch(
3624
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3625
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3626
 
            lambda *args, **kwargs: (tcp_server.handle_request
3627
 
                                     (*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))
3628
3604
 
3629
3605
        logger.debug("Starting main loop")
3630
3606
        main_loop.run()
3640
3616
    # Must run before the D-Bus bus name gets deregistered
3641
3617
    cleanup()
3642
3618
 
3643
 
 
3644
 
def should_only_run_tests():
3645
 
    parser = argparse.ArgumentParser(add_help=False)
3646
 
    parser.add_argument("--check", action='store_true')
3647
 
    args, unknown_args = parser.parse_known_args()
3648
 
    run_tests = args.check
3649
 
    if run_tests:
3650
 
        # Remove --check argument from sys.argv
3651
 
        sys.argv[1:] = unknown_args
3652
 
    return run_tests
3653
 
 
3654
 
# Add all tests from doctest strings
3655
 
def load_tests(loader, tests, none):
3656
 
    import doctest
3657
 
    tests.addTests(doctest.DocTestSuite())
3658
 
    return tests
3659
3619
 
3660
3620
if __name__ == '__main__':
3661
 
    try:
3662
 
        if should_only_run_tests():
3663
 
            # Call using ./mandos --check [--verbose]
3664
 
            unittest.main()
3665
 
        else:
3666
 
            main()
3667
 
    finally:
3668
 
        logging.shutdown()
 
3621
    main()