/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: 2022-04-23 21:14:38 UTC
  • Revision ID: teddy@recompile.se-20220423211438-qadwdpyodk1zfra5
Debian package: Client: Update Lintian override file

* debian/mandos-client.lintian-overrides: Remove all empty commented
  lines.  Re-word text to avoid negation.  Rename "setuid-binary" tag
  to "elevated-privileges".

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python3 -bI
2
 
# -*- coding: utf-8; lexical-binding: t -*-
 
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 -*-
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-2022 Teddy Hogeborn
15
 
# Copyright © 2008-2022 Björn Påhlsson
 
14
# Copyright © 2008-2020 Teddy Hogeborn
 
15
# Copyright © 2008-2020 Björn Påhlsson
16
16
#
17
17
# This file is part of Mandos.
18
18
#
31
31
#
32
32
# Contact the authors at <mandos@recompile.se>.
33
33
#
 
34
 
34
35
from __future__ import (division, absolute_import, print_function,
35
36
                        unicode_literals)
36
37
 
39
40
except ImportError:
40
41
    pass
41
42
 
42
 
import sys
43
 
import unittest
44
 
import argparse
45
 
import logging
46
 
import os
47
43
try:
48
44
    import SocketServer as socketserver
49
45
except ImportError:
50
46
    import socketserver
51
47
import socket
 
48
import argparse
52
49
import datetime
53
50
import errno
54
51
try:
55
52
    import ConfigParser as configparser
56
53
except ImportError:
57
54
    import configparser
 
55
import sys
58
56
import re
 
57
import os
59
58
import signal
60
59
import subprocess
61
60
import atexit
62
61
import stat
 
62
import logging
63
63
import logging.handlers
64
64
import pwd
65
65
import contextlib
77
77
import itertools
78
78
import collections
79
79
import codecs
 
80
import unittest
80
81
import random
81
82
import shlex
82
83
 
93
94
if sys.version_info.major == 2:
94
95
    __metaclass__ = type
95
96
    str = unicode
96
 
    input = raw_input
97
97
 
98
98
# Add collections.abc.Callable if it does not exist
99
99
try:
146
146
version = "1.8.14"
147
147
stored_state_file = "clients.pickle"
148
148
 
149
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
149
logger = logging.getLogger()
150
150
logging.captureWarnings(True)   # Show warnings via the logging system
151
151
syslogger = None
152
152
 
189
189
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
190
190
        address="/dev/log"))
191
191
    syslogger.setFormatter(logging.Formatter
192
 
                           ("Mandos [%(process)d]: %(levelname)s:"
193
 
                            " %(message)s"))
194
 
    log.addHandler(syslogger)
 
192
                           ('Mandos [%(process)d]: %(levelname)s:'
 
193
                            ' %(message)s'))
 
194
    logger.addHandler(syslogger)
195
195
 
196
196
    if debug:
197
197
        console = logging.StreamHandler()
198
 
        console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
199
 
                                               " [%(process)d]:"
200
 
                                               " %(levelname)s:"
201
 
                                               " %(message)s"))
202
 
        log.addHandler(console)
203
 
    log.setLevel(level)
 
198
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
199
                                               ' [%(process)d]:'
 
200
                                               ' %(levelname)s:'
 
201
                                               ' %(message)s'))
 
202
        logger.addHandler(console)
 
203
    logger.setLevel(level)
204
204
 
205
205
 
206
206
class PGPError(Exception):
224
224
        except OSError as e:
225
225
            if e.errno != errno.ENOENT:
226
226
                raise
227
 
        self.gnupgargs = ["--batch",
228
 
                          "--homedir", self.tempdir,
229
 
                          "--force-mdc",
230
 
                          "--quiet"]
 
227
        self.gnupgargs = ['--batch',
 
228
                          '--homedir', self.tempdir,
 
229
                          '--force-mdc',
 
230
                          '--quiet']
231
231
        # Only GPG version 1 has the --no-use-agent option.
232
232
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
233
233
            self.gnupgargs.append("--no-use-agent")
272
272
                dir=self.tempdir) as passfile:
273
273
            passfile.write(passphrase)
274
274
            passfile.flush()
275
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
276
 
                                     "--passphrase-file",
 
275
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
276
                                     '--passphrase-file',
277
277
                                     passfile.name]
278
278
                                    + self.gnupgargs,
279
279
                                    stdin=subprocess.PIPE,
290
290
                dir=self.tempdir) as passfile:
291
291
            passfile.write(passphrase)
292
292
            passfile.flush()
293
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
294
 
                                     "--passphrase-file",
 
293
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
294
                                     '--passphrase-file',
295
295
                                     passfile.name]
296
296
                                    + self.gnupgargs,
297
297
                                    stdin=subprocess.PIPE,
350
350
    Attributes:
351
351
    interface: integer; avahi.IF_UNSPEC or an interface index.
352
352
               Used to optionally bind to the specified interface.
353
 
    name: string; Example: "Mandos"
354
 
    type: string; Example: "_mandos._tcp".
 
353
    name: string; Example: 'Mandos'
 
354
    type: string; Example: '_mandos._tcp'.
355
355
     See <https://www.iana.org/assignments/service-names-port-numbers>
356
356
    port: integer; what port to announce
357
357
    TXT: list of strings; TXT record for the service
394
394
    def rename(self, remove=True):
395
395
        """Derived from the Avahi example code"""
396
396
        if self.rename_count >= self.max_renames:
397
 
            log.critical("No suitable Zeroconf service name found"
398
 
                         " after %i retries, exiting.",
399
 
                         self.rename_count)
 
397
            logger.critical("No suitable Zeroconf service name found"
 
398
                            " after %i retries, exiting.",
 
399
                            self.rename_count)
400
400
            raise AvahiServiceError("Too many renames")
401
401
        self.name = str(
402
402
            self.server.GetAlternativeServiceName(self.name))
403
403
        self.rename_count += 1
404
 
        log.info("Changing Zeroconf service name to %r ...",
405
 
                 self.name)
 
404
        logger.info("Changing Zeroconf service name to %r ...",
 
405
                    self.name)
406
406
        if remove:
407
407
            self.remove()
408
408
        try:
410
410
        except dbus.exceptions.DBusException as error:
411
411
            if (error.get_dbus_name()
412
412
                == "org.freedesktop.Avahi.CollisionError"):
413
 
                log.info("Local Zeroconf service name collision.")
 
413
                logger.info("Local Zeroconf service name collision.")
414
414
                return self.rename(remove=False)
415
415
            else:
416
 
                log.critical("D-Bus Exception", exc_info=error)
 
416
                logger.critical("D-Bus Exception", exc_info=error)
417
417
                self.cleanup()
418
418
                os._exit(1)
419
419
 
435
435
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
436
        self.entry_group_state_changed_match = (
437
437
            self.group.connect_to_signal(
438
 
                "StateChanged", self.entry_group_state_changed))
439
 
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
440
 
                  self.name, self.type)
 
438
                'StateChanged', self.entry_group_state_changed))
 
439
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
440
                     self.name, self.type)
441
441
        self.group.AddService(
442
442
            self.interface,
443
443
            self.protocol,
450
450
 
451
451
    def entry_group_state_changed(self, state, error):
452
452
        """Derived from the Avahi example code"""
453
 
        log.debug("Avahi entry group state change: %i", state)
 
453
        logger.debug("Avahi entry group state change: %i", state)
454
454
 
455
455
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
 
            log.debug("Zeroconf service established.")
 
456
            logger.debug("Zeroconf service established.")
457
457
        elif state == avahi.ENTRY_GROUP_COLLISION:
458
 
            log.info("Zeroconf service name collision.")
 
458
            logger.info("Zeroconf service name collision.")
459
459
            self.rename()
460
460
        elif state == avahi.ENTRY_GROUP_FAILURE:
461
 
            log.critical("Avahi: Error in group state changed %s",
462
 
                         str(error))
 
461
            logger.critical("Avahi: Error in group state changed %s",
 
462
                            str(error))
463
463
            raise AvahiGroupError("State changed: {!s}".format(error))
464
464
 
465
465
    def cleanup(self):
475
475
 
476
476
    def server_state_changed(self, state, error=None):
477
477
        """Derived from the Avahi example code"""
478
 
        log.debug("Avahi server state change: %i", state)
 
478
        logger.debug("Avahi server state change: %i", state)
479
479
        bad_states = {
480
480
            avahi.SERVER_INVALID: "Zeroconf server invalid",
481
481
            avahi.SERVER_REGISTERING: None,
485
485
        if state in bad_states:
486
486
            if bad_states[state] is not None:
487
487
                if error is None:
488
 
                    log.error(bad_states[state])
 
488
                    logger.error(bad_states[state])
489
489
                else:
490
 
                    log.error(bad_states[state] + ": %r", error)
 
490
                    logger.error(bad_states[state] + ": %r", error)
491
491
            self.cleanup()
492
492
        elif state == avahi.SERVER_RUNNING:
493
493
            try:
495
495
            except dbus.exceptions.DBusException as error:
496
496
                if (error.get_dbus_name()
497
497
                    == "org.freedesktop.Avahi.CollisionError"):
498
 
                    log.info("Local Zeroconf service name collision.")
 
498
                    logger.info("Local Zeroconf service name"
 
499
                                " collision.")
499
500
                    return self.rename(remove=False)
500
501
                else:
501
 
                    log.critical("D-Bus Exception", exc_info=error)
 
502
                    logger.critical("D-Bus Exception", exc_info=error)
502
503
                    self.cleanup()
503
504
                    os._exit(1)
504
505
        else:
505
506
            if error is None:
506
 
                log.debug("Unknown state: %r", state)
 
507
                logger.debug("Unknown state: %r", state)
507
508
            else:
508
 
                log.debug("Unknown state: %r: %r", state, error)
 
509
                logger.debug("Unknown state: %r: %r", state, error)
509
510
 
510
511
    def activate(self):
511
512
        """Derived from the Avahi example code"""
526
527
        ret = super(AvahiServiceToSyslog, self).rename(*args,
527
528
                                                       **kwargs)
528
529
        syslogger.setFormatter(logging.Formatter(
529
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
530
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
530
531
            .format(self.name)))
531
532
        return ret
532
533
 
573
574
    certificate_type_t = ctypes.c_int
574
575
 
575
576
    class datum_t(ctypes.Structure):
576
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
 
                    ("size", ctypes.c_uint)]
 
577
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
578
                    ('size', ctypes.c_uint)]
578
579
 
579
580
    class _openpgp_crt_int(ctypes.Structure):
580
581
        _fields_ = []
675
676
    # Error handling functions
676
677
    def _error_code(result):
677
678
        """A function to raise exceptions on errors, suitable
678
 
        for the "restype" attribute on ctypes functions"""
 
679
        for the 'restype' attribute on ctypes functions"""
679
680
        if result >= gnutls.E_SUCCESS:
680
681
            return result
681
682
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
685
686
    def _retry_on_error(result, func, arguments,
686
687
                        _error_code=_error_code):
687
688
        """A function to retry on some errors, suitable
688
 
        for the "errcheck" attribute on ctypes functions"""
 
689
        for the 'errcheck' attribute on ctypes functions"""
689
690
        while result < gnutls.E_SUCCESS:
690
691
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
692
                return _error_code(result)
875
876
    """A representation of a client host served by this server.
876
877
 
877
878
    Attributes:
878
 
    approved:   bool(); None if not yet approved/disapproved
 
879
    approved:   bool(); 'None' if not yet approved/disapproved
879
880
    approval_delay: datetime.timedelta(); Time to wait for approval
880
881
    approval_duration: datetime.timedelta(); Duration of one approval
881
882
    checker: multiprocessing.Process(); a running checker process used
882
 
             to see if the client lives. None if no process is
 
883
             to see if the client lives. 'None' if no process is
883
884
             running.
884
885
    checker_callback_tag: a GLib event source tag, or None
885
886
    checker_command: string; External command which is run to check
1009
1010
            self.last_enabled = None
1010
1011
            self.expires = None
1011
1012
 
1012
 
        log.debug("Creating client %r", self.name)
1013
 
        log.debug("  Key ID: %s", self.key_id)
1014
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
1013
        logger.debug("Creating client %r", self.name)
 
1014
        logger.debug("  Key ID: %s", self.key_id)
 
1015
        logger.debug("  Fingerprint: %s", self.fingerprint)
1015
1016
        self.created = settings.get("created",
1016
1017
                                    datetime.datetime.utcnow())
1017
1018
 
1056
1057
        if not getattr(self, "enabled", False):
1057
1058
            return False
1058
1059
        if not quiet:
1059
 
            log.info("Disabling client %s", self.name)
 
1060
            logger.info("Disabling client %s", self.name)
1060
1061
        if getattr(self, "disable_initiator_tag", None) is not None:
1061
1062
            GLib.source_remove(self.disable_initiator_tag)
1062
1063
            self.disable_initiator_tag = None
1106
1107
            self.last_checker_status = returncode
1107
1108
            self.last_checker_signal = None
1108
1109
            if self.last_checker_status == 0:
1109
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1110
                logger.info("Checker for %(name)s succeeded",
 
1111
                            vars(self))
1110
1112
                self.checked_ok()
1111
1113
            else:
1112
 
                log.info("Checker for %(name)s failed", vars(self))
 
1114
                logger.info("Checker for %(name)s failed", vars(self))
1113
1115
        else:
1114
1116
            self.last_checker_status = -1
1115
1117
            self.last_checker_signal = -returncode
1116
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1118
            logger.warning("Checker for %(name)s crashed?",
 
1119
                           vars(self))
1117
1120
        return False
1118
1121
 
1119
1122
    def checked_ok(self):
1153
1156
        # should be.
1154
1157
 
1155
1158
        if self.checker is not None and not self.checker.is_alive():
1156
 
            log.warning("Checker was not alive; joining")
 
1159
            logger.warning("Checker was not alive; joining")
1157
1160
            self.checker.join()
1158
1161
            self.checker = None
1159
1162
        # Start a new checker if needed
1165
1168
            try:
1166
1169
                command = self.checker_command % escaped_attrs
1167
1170
            except TypeError as error:
1168
 
                log.error('Could not format string "%s"',
1169
 
                          self.checker_command, exc_info=error)
 
1171
                logger.error('Could not format string "%s"',
 
1172
                             self.checker_command,
 
1173
                             exc_info=error)
1170
1174
                return True     # Try again later
1171
1175
            self.current_checker_command = command
1172
 
            log.info("Starting checker %r for %s", command, self.name)
 
1176
            logger.info("Starting checker %r for %s", command,
 
1177
                        self.name)
1173
1178
            # We don't need to redirect stdout and stderr, since
1174
1179
            # in normal mode, that is already done by daemon(),
1175
1180
            # and in debug mode we don't want to.  (Stdin is
1204
1209
            self.checker_callback_tag = None
1205
1210
        if getattr(self, "checker", None) is None:
1206
1211
            return
1207
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1212
        logger.debug("Stopping checker for %(name)s", vars(self))
1208
1213
        self.checker.terminate()
1209
1214
        self.checker = None
1210
1215
 
1237
1242
        func._dbus_name = func.__name__
1238
1243
        if func._dbus_name.endswith("_dbus_property"):
1239
1244
            func._dbus_name = func._dbus_name[:-14]
1240
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1245
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1241
1246
        return func
1242
1247
 
1243
1248
    return decorator
1332
1337
 
1333
1338
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1334
1339
                         out_signature="s",
1335
 
                         path_keyword="object_path",
1336
 
                         connection_keyword="connection")
 
1340
                         path_keyword='object_path',
 
1341
                         connection_keyword='connection')
1337
1342
    def Introspect(self, object_path, connection):
1338
1343
        """Overloading of standard D-Bus method.
1339
1344
 
1388
1393
            document.unlink()
1389
1394
        except (AttributeError, xml.dom.DOMException,
1390
1395
                xml.parsers.expat.ExpatError) as error:
1391
 
            log.error("Failed to override Introspection method",
1392
 
                      exc_info=error)
 
1396
            logger.error("Failed to override Introspection method",
 
1397
                         exc_info=error)
1393
1398
        return xmlstring
1394
1399
 
1395
1400
 
1492
1497
 
1493
1498
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1494
1499
                         out_signature="s",
1495
 
                         path_keyword="object_path",
1496
 
                         connection_keyword="connection")
 
1500
                         path_keyword='object_path',
 
1501
                         connection_keyword='connection')
1497
1502
    def Introspect(self, object_path, connection):
1498
1503
        """Overloading of standard D-Bus method.
1499
1504
 
1555
1560
            document.unlink()
1556
1561
        except (AttributeError, xml.dom.DOMException,
1557
1562
                xml.parsers.expat.ExpatError) as error:
1558
 
            log.error("Failed to override Introspection method",
1559
 
                      exc_info=error)
 
1563
            logger.error("Failed to override Introspection method",
 
1564
                         exc_info=error)
1560
1565
        return xmlstring
1561
1566
 
1562
1567
 
1594
1599
 
1595
1600
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1596
1601
                         out_signature="s",
1597
 
                         path_keyword="object_path",
1598
 
                         connection_keyword="connection")
 
1602
                         path_keyword='object_path',
 
1603
                         connection_keyword='connection')
1599
1604
    def Introspect(self, object_path, connection):
1600
1605
        """Overloading of standard D-Bus method.
1601
1606
 
1626
1631
            document.unlink()
1627
1632
        except (AttributeError, xml.dom.DOMException,
1628
1633
                xml.parsers.expat.ExpatError) as error:
1629
 
            log.error("Failed to override Introspection method",
1630
 
                      exc_info=error)
 
1634
            logger.error("Failed to override Introspection method",
 
1635
                         exc_info=error)
1631
1636
        return xmlstring
1632
1637
 
1633
1638
 
2267
2272
class ProxyClient:
2268
2273
    def __init__(self, child_pipe, key_id, fpr, address):
2269
2274
        self._pipe = child_pipe
2270
 
        self._pipe.send(("init", key_id, fpr, address))
 
2275
        self._pipe.send(('init', key_id, fpr, address))
2271
2276
        if not self._pipe.recv():
2272
2277
            raise KeyError(key_id or fpr)
2273
2278
 
2274
2279
    def __getattribute__(self, name):
2275
 
        if name == "_pipe":
 
2280
        if name == '_pipe':
2276
2281
            return super(ProxyClient, self).__getattribute__(name)
2277
 
        self._pipe.send(("getattr", name))
 
2282
        self._pipe.send(('getattr', name))
2278
2283
        data = self._pipe.recv()
2279
 
        if data[0] == "data":
 
2284
        if data[0] == 'data':
2280
2285
            return data[1]
2281
 
        if data[0] == "function":
 
2286
        if data[0] == 'function':
2282
2287
 
2283
2288
            def func(*args, **kwargs):
2284
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2289
                self._pipe.send(('funcall', name, args, kwargs))
2285
2290
                return self._pipe.recv()[1]
2286
2291
 
2287
2292
            return func
2288
2293
 
2289
2294
    def __setattr__(self, name, value):
2290
 
        if name == "_pipe":
 
2295
        if name == '_pipe':
2291
2296
            return super(ProxyClient, self).__setattr__(name, value)
2292
 
        self._pipe.send(("setattr", name, value))
 
2297
        self._pipe.send(('setattr', name, value))
2293
2298
 
2294
2299
 
2295
2300
class ClientHandler(socketserver.BaseRequestHandler, object):
2300
2305
 
2301
2306
    def handle(self):
2302
2307
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2303
 
            log.info("TCP connection from: %s",
2304
 
                     str(self.client_address))
2305
 
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
 
2308
            logger.info("TCP connection from: %s",
 
2309
                        str(self.client_address))
 
2310
            logger.debug("Pipe FD: %d",
 
2311
                         self.server.child_pipe.fileno())
2306
2312
 
2307
2313
            session = gnutls.ClientSession(self.request)
2308
2314
 
2309
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2315
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2310
2316
            #                       "+AES-256-CBC", "+SHA1",
2311
2317
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2312
2318
            #                       "+DHE-DSS"))
2320
2326
            # Start communication using the Mandos protocol
2321
2327
            # Get protocol number
2322
2328
            line = self.request.makefile().readline()
2323
 
            log.debug("Protocol version: %r", line)
 
2329
            logger.debug("Protocol version: %r", line)
2324
2330
            try:
2325
2331
                if int(line.strip().split()[0]) > 1:
2326
2332
                    raise RuntimeError(line)
2327
2333
            except (ValueError, IndexError, RuntimeError) as error:
2328
 
                log.error("Unknown protocol version: %s", error)
 
2334
                logger.error("Unknown protocol version: %s", error)
2329
2335
                return
2330
2336
 
2331
2337
            # Start GnuTLS connection
2332
2338
            try:
2333
2339
                session.handshake()
2334
2340
            except gnutls.Error as error:
2335
 
                log.warning("Handshake failed: %s", error)
 
2341
                logger.warning("Handshake failed: %s", error)
2336
2342
                # Do not run session.bye() here: the session is not
2337
2343
                # established.  Just abandon the request.
2338
2344
                return
2339
 
            log.debug("Handshake succeeded")
 
2345
            logger.debug("Handshake succeeded")
2340
2346
 
2341
2347
            approval_required = False
2342
2348
            try:
2346
2352
                        key_id = self.key_id(
2347
2353
                            self.peer_certificate(session))
2348
2354
                    except (TypeError, gnutls.Error) as error:
2349
 
                        log.warning("Bad certificate: %s", error)
 
2355
                        logger.warning("Bad certificate: %s", error)
2350
2356
                        return
2351
 
                    log.debug("Key ID: %s",
2352
 
                              key_id.decode("utf-8",
2353
 
                                            errors="replace"))
 
2357
                    logger.debug("Key ID: %s",
 
2358
                                 key_id.decode("utf-8",
 
2359
                                               errors="replace"))
2354
2360
 
2355
2361
                else:
2356
2362
                    key_id = b""
2358
2364
                        fpr = self.fingerprint(
2359
2365
                            self.peer_certificate(session))
2360
2366
                    except (TypeError, gnutls.Error) as error:
2361
 
                        log.warning("Bad certificate: %s", error)
 
2367
                        logger.warning("Bad certificate: %s", error)
2362
2368
                        return
2363
 
                    log.debug("Fingerprint: %s", fpr)
 
2369
                    logger.debug("Fingerprint: %s", fpr)
2364
2370
 
2365
2371
                try:
2366
2372
                    client = ProxyClient(child_pipe, key_id, fpr,
2375
2381
 
2376
2382
                while True:
2377
2383
                    if not client.enabled:
2378
 
                        log.info("Client %s is disabled", client.name)
 
2384
                        logger.info("Client %s is disabled",
 
2385
                                    client.name)
2379
2386
                        if self.server.use_dbus:
2380
2387
                            # Emit D-Bus signal
2381
2388
                            client.Rejected("Disabled")
2385
2392
                        # We are approved or approval is disabled
2386
2393
                        break
2387
2394
                    elif client.approved is None:
2388
 
                        log.info("Client %s needs approval",
2389
 
                                 client.name)
 
2395
                        logger.info("Client %s needs approval",
 
2396
                                    client.name)
2390
2397
                        if self.server.use_dbus:
2391
2398
                            # Emit D-Bus signal
2392
2399
                            client.NeedApproval(
2393
2400
                                client.approval_delay.total_seconds()
2394
2401
                                * 1000, client.approved_by_default)
2395
2402
                    else:
2396
 
                        log.warning("Client %s was not approved",
2397
 
                                    client.name)
 
2403
                        logger.warning("Client %s was not approved",
 
2404
                                       client.name)
2398
2405
                        if self.server.use_dbus:
2399
2406
                            # Emit D-Bus signal
2400
2407
                            client.Rejected("Denied")
2408
2415
                    time2 = datetime.datetime.now()
2409
2416
                    if (time2 - time) >= delay:
2410
2417
                        if not client.approved_by_default:
2411
 
                            log.warning("Client %s timed out while"
2412
 
                                        " waiting for approval",
2413
 
                                        client.name)
 
2418
                            logger.warning("Client %s timed out while"
 
2419
                                           " waiting for approval",
 
2420
                                           client.name)
2414
2421
                            if self.server.use_dbus:
2415
2422
                                # Emit D-Bus signal
2416
2423
                                client.Rejected("Approval timed out")
2423
2430
                try:
2424
2431
                    session.send(client.secret)
2425
2432
                except gnutls.Error as error:
2426
 
                    log.warning("gnutls send failed", exc_info=error)
 
2433
                    logger.warning("gnutls send failed",
 
2434
                                   exc_info=error)
2427
2435
                    return
2428
2436
 
2429
 
                log.info("Sending secret to %s", client.name)
 
2437
                logger.info("Sending secret to %s", client.name)
2430
2438
                # bump the timeout using extended_timeout
2431
2439
                client.bump_timeout(client.extended_timeout)
2432
2440
                if self.server.use_dbus:
2439
2447
                try:
2440
2448
                    session.bye()
2441
2449
                except gnutls.Error as error:
2442
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2450
                    logger.warning("GnuTLS bye failed",
 
2451
                                   exc_info=error)
2443
2452
 
2444
2453
    @staticmethod
2445
2454
    def peer_certificate(session):
2455
2464
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2456
2465
        # If not a valid certificate type...
2457
2466
        if cert_type not in valid_cert_types:
2458
 
            log.info("Cert type %r not in %r", cert_type,
2459
 
                     valid_cert_types)
 
2467
            logger.info("Cert type %r not in %r", cert_type,
 
2468
                        valid_cert_types)
2460
2469
            # ...return invalid data
2461
2470
            return b""
2462
2471
        list_size = ctypes.c_uint(1)
2581
2590
 
2582
2591
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2583
2592
                     socketserver.TCPServer):
2584
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2593
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2585
2594
 
2586
2595
    Attributes:
2587
2596
        enabled:        Boolean; whether this server is activated yet
2638
2647
            if SO_BINDTODEVICE is None:
2639
2648
                # Fall back to a hard-coded value which seems to be
2640
2649
                # common enough.
2641
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2650
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2642
2651
                SO_BINDTODEVICE = 25
2643
2652
            try:
2644
2653
                self.socket.setsockopt(
2646
2655
                    (self.interface + "\0").encode("utf-8"))
2647
2656
            except socket.error as error:
2648
2657
                if error.errno == errno.EPERM:
2649
 
                    log.error("No permission to bind to interface %s",
2650
 
                              self.interface)
 
2658
                    logger.error("No permission to bind to"
 
2659
                                 " interface %s", self.interface)
2651
2660
                elif error.errno == errno.ENOPROTOOPT:
2652
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2653
 
                              " bind to interface %s", self.interface)
 
2661
                    logger.error("SO_BINDTODEVICE not available;"
 
2662
                                 " cannot bind to interface %s",
 
2663
                                 self.interface)
2654
2664
                elif error.errno == errno.ENODEV:
2655
 
                    log.error("Interface %s does not exist, cannot"
2656
 
                              " bind", self.interface)
 
2665
                    logger.error("Interface %s does not exist,"
 
2666
                                 " cannot bind", self.interface)
2657
2667
                else:
2658
2668
                    raise
2659
2669
        # Only bind(2) the socket if we really need to.
2738
2748
        request = parent_pipe.recv()
2739
2749
        command = request[0]
2740
2750
 
2741
 
        if command == "init":
 
2751
        if command == 'init':
2742
2752
            key_id = request[1].decode("ascii")
2743
2753
            fpr = request[2].decode("ascii")
2744
2754
            address = request[3]
2754
2764
                    client = c
2755
2765
                    break
2756
2766
            else:
2757
 
                log.info("Client not found for key ID: %s, address:"
2758
 
                         " %s", key_id or fpr, address)
 
2767
                logger.info("Client not found for key ID: %s, address"
 
2768
                            ": %s", key_id or fpr, address)
2759
2769
                if self.use_dbus:
2760
2770
                    # Emit D-Bus signal
2761
2771
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2774
2784
            # remove the old hook in favor of the new above hook on
2775
2785
            # same fileno
2776
2786
            return False
2777
 
        if command == "funcall":
 
2787
        if command == 'funcall':
2778
2788
            funcname = request[1]
2779
2789
            args = request[2]
2780
2790
            kwargs = request[3]
2781
2791
 
2782
 
            parent_pipe.send(("data", getattr(client_object,
 
2792
            parent_pipe.send(('data', getattr(client_object,
2783
2793
                                              funcname)(*args,
2784
2794
                                                        **kwargs)))
2785
2795
 
2786
 
        if command == "getattr":
 
2796
        if command == 'getattr':
2787
2797
            attrname = request[1]
2788
2798
            if isinstance(client_object.__getattribute__(attrname),
2789
2799
                          collections.abc.Callable):
2790
 
                parent_pipe.send(("function", ))
 
2800
                parent_pipe.send(('function', ))
2791
2801
            else:
2792
2802
                parent_pipe.send((
2793
 
                    "data", client_object.__getattribute__(attrname)))
 
2803
                    'data', client_object.__getattribute__(attrname)))
2794
2804
 
2795
 
        if command == "setattr":
 
2805
        if command == 'setattr':
2796
2806
            attrname = request[1]
2797
2807
            value = request[2]
2798
2808
            setattr(client_object, attrname, value)
2904
2914
def string_to_delta(interval):
2905
2915
    """Parse a string and return a datetime.timedelta
2906
2916
 
2907
 
    >>> string_to_delta("7d") == datetime.timedelta(7)
2908
 
    True
2909
 
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
2910
 
    True
2911
 
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2912
 
    True
2913
 
    >>> string_to_delta("24h") == datetime.timedelta(1)
2914
 
    True
2915
 
    >>> string_to_delta("1w") == datetime.timedelta(7)
2916
 
    True
2917
 
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
 
2917
    >>> string_to_delta('7d') == datetime.timedelta(7)
 
2918
    True
 
2919
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
 
2920
    True
 
2921
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
 
2922
    True
 
2923
    >>> string_to_delta('24h') == datetime.timedelta(1)
 
2924
    True
 
2925
    >>> string_to_delta('1w') == datetime.timedelta(7)
 
2926
    True
 
2927
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2918
2928
    True
2919
2929
    """
2920
2930
 
3124
3134
 
3125
3135
    if server_settings["servicename"] != "Mandos":
3126
3136
        syslogger.setFormatter(
3127
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3128
 
                              " %(levelname)s: %(message)s".format(
 
3137
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3138
                              ' %(levelname)s: %(message)s'.format(
3129
3139
                                  server_settings["servicename"])))
3130
3140
 
3131
3141
    # Parse config file with clients
3155
3165
        try:
3156
3166
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3157
3167
        except IOError as e:
3158
 
            log.error("Could not open file %r", pidfilename,
3159
 
                      exc_info=e)
 
3168
            logger.error("Could not open file %r", pidfilename,
 
3169
                         exc_info=e)
3160
3170
 
3161
3171
    for name, group in (("_mandos", "_mandos"),
3162
3172
                        ("mandos", "mandos"),
3173
3183
    try:
3174
3184
        os.setgid(gid)
3175
3185
        os.setuid(uid)
3176
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3186
        if debug:
 
3187
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3188
                                                             gid))
3177
3189
    except OSError as error:
3178
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3179
 
                    os.strerror(error.errno))
 
3190
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3191
                       .format(uid, gid, os.strerror(error.errno)))
3180
3192
        if error.errno != errno.EPERM:
3181
3193
            raise
3182
3194
 
3189
3201
 
3190
3202
        @gnutls.log_func
3191
3203
        def debug_gnutls(level, string):
3192
 
            log.debug("GnuTLS: %s",
3193
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3204
            logger.debug("GnuTLS: %s",
 
3205
                         string[:-1].decode("utf-8",
 
3206
                                            errors="replace"))
3194
3207
 
3195
3208
        gnutls.global_set_log_function(debug_gnutls)
3196
3209
 
3225
3238
                "se.bsnet.fukt.Mandos", bus,
3226
3239
                do_not_queue=True)
3227
3240
        except dbus.exceptions.DBusException as e:
3228
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3241
            logger.error("Disabling D-Bus:", exc_info=e)
3229
3242
            use_dbus = False
3230
3243
            server_settings["use_dbus"] = False
3231
3244
            tcp_server.use_dbus = False
3316
3329
            os.remove(stored_state_path)
3317
3330
        except IOError as e:
3318
3331
            if e.errno == errno.ENOENT:
3319
 
                log.warning("Could not load persistent state:"
3320
 
                            " %s", os.strerror(e.errno))
 
3332
                logger.warning("Could not load persistent state:"
 
3333
                               " {}".format(os.strerror(e.errno)))
3321
3334
            else:
3322
 
                log.critical("Could not load persistent state:",
3323
 
                             exc_info=e)
 
3335
                logger.critical("Could not load persistent state:",
 
3336
                                exc_info=e)
3324
3337
                raise
3325
3338
        except EOFError as e:
3326
 
            log.warning("Could not load persistent state: EOFError:",
3327
 
                        exc_info=e)
 
3339
            logger.warning("Could not load persistent state: "
 
3340
                           "EOFError:",
 
3341
                           exc_info=e)
3328
3342
 
3329
3343
    with PGPEngine() as pgp:
3330
3344
        for client_name, client in clients_data.items():
3357
3371
            if client["enabled"]:
3358
3372
                if datetime.datetime.utcnow() >= client["expires"]:
3359
3373
                    if not client["last_checked_ok"]:
3360
 
                        log.warning("disabling client %s - Client"
3361
 
                                    " never performed a successful"
3362
 
                                    " checker", client_name)
 
3374
                        logger.warning(
 
3375
                            "disabling client {} - Client never "
 
3376
                            "performed a successful checker".format(
 
3377
                                client_name))
3363
3378
                        client["enabled"] = False
3364
3379
                    elif client["last_checker_status"] != 0:
3365
 
                        log.warning("disabling client %s - Client"
3366
 
                                    " last checker failed with error"
3367
 
                                    " code %s", client_name,
3368
 
                                    client["last_checker_status"])
 
3380
                        logger.warning(
 
3381
                            "disabling client {} - Client last"
 
3382
                            " checker failed with error code"
 
3383
                            " {}".format(
 
3384
                                client_name,
 
3385
                                client["last_checker_status"]))
3369
3386
                        client["enabled"] = False
3370
3387
                    else:
3371
3388
                        client["expires"] = (
3372
3389
                            datetime.datetime.utcnow()
3373
3390
                            + client["timeout"])
3374
 
                        log.debug("Last checker succeeded, keeping %s"
3375
 
                                  " enabled", client_name)
 
3391
                        logger.debug("Last checker succeeded,"
 
3392
                                     " keeping {} enabled".format(
 
3393
                                         client_name))
3376
3394
            try:
3377
3395
                client["secret"] = pgp.decrypt(
3378
3396
                    client["encrypted_secret"],
3379
3397
                    client_settings[client_name]["secret"])
3380
3398
            except PGPError:
3381
3399
                # If decryption fails, we use secret from new settings
3382
 
                log.debug("Failed to decrypt %s old secret",
3383
 
                          client_name)
 
3400
                logger.debug("Failed to decrypt {} old secret".format(
 
3401
                    client_name))
3384
3402
                client["secret"] = (client_settings[client_name]
3385
3403
                                    ["secret"])
3386
3404
 
3400
3418
            server_settings=server_settings)
3401
3419
 
3402
3420
    if not tcp_server.clients:
3403
 
        log.warning("No clients defined")
 
3421
        logger.warning("No clients defined")
3404
3422
 
3405
3423
    if not foreground:
3406
3424
        if pidfile is not None:
3409
3427
                with pidfile:
3410
3428
                    print(pid, file=pidfile)
3411
3429
            except IOError:
3412
 
                log.error("Could not write to file %r with PID %d",
3413
 
                          pidfilename, pid)
 
3430
                logger.error("Could not write to file %r with PID %d",
 
3431
                             pidfilename, pid)
3414
3432
        del pidfile
3415
3433
        del pidfilename
3416
3434
 
3566
3584
 
3567
3585
        try:
3568
3586
            with tempfile.NamedTemporaryFile(
3569
 
                    mode="wb",
 
3587
                    mode='wb',
3570
3588
                    suffix=".pickle",
3571
 
                    prefix="clients-",
 
3589
                    prefix='clients-',
3572
3590
                    dir=os.path.dirname(stored_state_path),
3573
3591
                    delete=False) as stored_state:
3574
3592
                pickle.dump((clients, client_settings), stored_state,
3582
3600
                except NameError:
3583
3601
                    pass
3584
3602
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3585
 
                log.warning("Could not save persistent state: %s",
3586
 
                            os.strerror(e.errno))
 
3603
                logger.warning("Could not save persistent state: {}"
 
3604
                               .format(os.strerror(e.errno)))
3587
3605
            else:
3588
 
                log.warning("Could not save persistent state:",
3589
 
                            exc_info=e)
 
3606
                logger.warning("Could not save persistent state:",
 
3607
                               exc_info=e)
3590
3608
                raise
3591
3609
 
3592
3610
        # Delete all clients, and settings from config
3618
3636
    if zeroconf:
3619
3637
        service.port = tcp_server.socket.getsockname()[1]
3620
3638
    if use_ipv6:
3621
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3622
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3639
        logger.info("Now listening on address %r, port %d,"
 
3640
                    " flowinfo %d, scope_id %d",
 
3641
                    *tcp_server.socket.getsockname())
3623
3642
    else:                       # IPv4
3624
 
        log.info("Now listening on address %r, port %d",
3625
 
                 *tcp_server.socket.getsockname())
 
3643
        logger.info("Now listening on address %r, port %d",
 
3644
                    *tcp_server.socket.getsockname())
3626
3645
 
3627
3646
    # service.interface = tcp_server.socket.getsockname()[3]
3628
3647
 
3632
3651
            try:
3633
3652
                service.activate()
3634
3653
            except dbus.exceptions.DBusException as error:
3635
 
                log.critical("D-Bus Exception", exc_info=error)
 
3654
                logger.critical("D-Bus Exception", exc_info=error)
3636
3655
                cleanup()
3637
3656
                sys.exit(1)
3638
3657
            # End of Avahi example code
3643
3662
            lambda *args, **kwargs: (tcp_server.handle_request
3644
3663
                                     (*args[2:], **kwargs) or True))
3645
3664
 
3646
 
        log.debug("Starting main loop")
 
3665
        logger.debug("Starting main loop")
3647
3666
        main_loop.run()
3648
3667
    except AvahiError as error:
3649
 
        log.critical("Avahi Error", exc_info=error)
 
3668
        logger.critical("Avahi Error", exc_info=error)
3650
3669
        cleanup()
3651
3670
        sys.exit(1)
3652
3671
    except KeyboardInterrupt:
3653
3672
        if debug:
3654
3673
            print("", file=sys.stderr)
3655
 
        log.debug("Server received KeyboardInterrupt")
3656
 
    log.debug("Server exiting")
 
3674
        logger.debug("Server received KeyboardInterrupt")
 
3675
    logger.debug("Server exiting")
3657
3676
    # Must run before the D-Bus bus name gets deregistered
3658
3677
    cleanup()
3659
3678
 
3660
3679
 
3661
 
def parse_test_args():
3662
 
    # type: () -> argparse.Namespace
 
3680
def should_only_run_tests():
3663
3681
    parser = argparse.ArgumentParser(add_help=False)
3664
 
    parser.add_argument("--check", action="store_true")
3665
 
    parser.add_argument("--prefix", )
 
3682
    parser.add_argument("--check", action='store_true')
3666
3683
    args, unknown_args = parser.parse_known_args()
3667
 
    if args.check:
3668
 
        # Remove test options from sys.argv
 
3684
    run_tests = args.check
 
3685
    if run_tests:
 
3686
        # Remove --check argument from sys.argv
3669
3687
        sys.argv[1:] = unknown_args
3670
 
    return args
 
3688
    return run_tests
3671
3689
 
3672
3690
# Add all tests from doctest strings
3673
3691
def load_tests(loader, tests, none):
3675
3693
    tests.addTests(doctest.DocTestSuite())
3676
3694
    return tests
3677
3695
 
3678
 
if __name__ == "__main__":
3679
 
    options = parse_test_args()
 
3696
if __name__ == '__main__':
3680
3697
    try:
3681
 
        if options.check:
3682
 
            extra_test_prefix = options.prefix
3683
 
            if extra_test_prefix is not None:
3684
 
                if not (unittest.main(argv=[""], exit=False)
3685
 
                        .result.wasSuccessful()):
3686
 
                    sys.exit(1)
3687
 
                class ExtraTestLoader(unittest.TestLoader):
3688
 
                    testMethodPrefix = extra_test_prefix
3689
 
                # Call using ./scriptname --test [--verbose]
3690
 
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
3691
 
            else:
3692
 
                unittest.main(argv=[""])
 
3698
        if should_only_run_tests():
 
3699
            # Call using ./mandos --check [--verbose]
 
3700
            unittest.main()
3693
3701
        else:
3694
3702
            main()
3695
3703
    finally:
3696
3704
        logging.shutdown()
3697
 
 
3698
 
# Local Variables:
3699
 
# run-tests:
3700
 
# (lambda (&optional extra)
3701
 
#   (if (not (funcall run-tests-in-test-buffer default-directory
3702
 
#             extra))
3703
 
#       (funcall show-test-buffer-in-test-window)
3704
 
#     (funcall remove-test-window)
3705
 
#     (if extra (message "Extra tests run successfully!"))))
3706
 
# run-tests-in-test-buffer:
3707
 
# (lambda (dir &optional extra)
3708
 
#   (with-current-buffer (get-buffer-create "*Test*")
3709
 
#     (setq buffer-read-only nil
3710
 
#           default-directory dir)
3711
 
#     (erase-buffer)
3712
 
#     (compilation-mode))
3713
 
#   (let ((process-result
3714
 
#          (let ((inhibit-read-only t))
3715
 
#            (process-file-shell-command
3716
 
#             (funcall get-command-line extra) nil "*Test*"))))
3717
 
#     (and (numberp process-result)
3718
 
#          (= process-result 0))))
3719
 
# get-command-line:
3720
 
# (lambda (&optional extra)
3721
 
#   (let ((quoted-script
3722
 
#          (shell-quote-argument (funcall get-script-name))))
3723
 
#     (format
3724
 
#      (concat "%s --check" (if extra " --prefix=atest" ""))
3725
 
#      quoted-script)))
3726
 
# get-script-name:
3727
 
# (lambda ()
3728
 
#   (if (fboundp 'file-local-name)
3729
 
#       (file-local-name (buffer-file-name))
3730
 
#     (or (file-remote-p (buffer-file-name) 'localname)
3731
 
#         (buffer-file-name))))
3732
 
# remove-test-window:
3733
 
# (lambda ()
3734
 
#   (let ((test-window (get-buffer-window "*Test*")))
3735
 
#     (if test-window (delete-window test-window))))
3736
 
# show-test-buffer-in-test-window:
3737
 
# (lambda ()
3738
 
#   (when (not (get-buffer-window-list "*Test*"))
3739
 
#     (setq next-error-last-buffer (get-buffer "*Test*"))
3740
 
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3741
 
#            (display-buffer-overriding-action
3742
 
#             `((display-buffer-in-side-window) (side . ,side)
3743
 
#               (window-height . fit-window-to-buffer)
3744
 
#               (window-width . fit-window-to-buffer))))
3745
 
#       (display-buffer "*Test*"))))
3746
 
# eval:
3747
 
# (progn
3748
 
#   (let* ((run-extra-tests (lambda () (interactive)
3749
 
#                             (funcall run-tests t)))
3750
 
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3751
 
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
3752
 
#     (setq minor-mode-overriding-map-alist
3753
 
#           (cons `(run-tests . ,outer-keymap)
3754
 
#                 minor-mode-overriding-map-alist)))
3755
 
#   (add-hook 'after-save-hook run-tests 90 t))
3756
 
# End: