/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: 2023-02-11 06:58:15 UTC
  • Revision ID: teddy@recompile.se-20230211065815-jtffi61tbdrgr875
Suppress warnings

Suppress warnings about mlock()ing uninitialized memory and reading an
ievent struct.

* dracut-module/password-agent.c (send_password_to_socket): Suppress
  "-Wmaybe-uninitialized" when mlock()ing password send buffer.
  (test_read_inotify_event_IN_DELETE_badname): When reading from
    a struct ievent, suppress "-Wstringop-overread".

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
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 -*-
 
2
# -*- coding: utf-8; lexical-binding: t -*-
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-2022 Teddy Hogeborn
 
15
# Copyright © 2008-2022 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
 
 
35
34
from __future__ import (division, absolute_import, print_function,
36
35
                        unicode_literals)
37
36
 
40
39
except ImportError:
41
40
    pass
42
41
 
 
42
import sys
 
43
import unittest
 
44
import argparse
 
45
import logging
 
46
import os
43
47
try:
44
48
    import SocketServer as socketserver
45
49
except ImportError:
46
50
    import socketserver
47
51
import socket
48
 
import argparse
49
52
import datetime
50
53
import errno
51
54
try:
52
55
    import ConfigParser as configparser
53
56
except ImportError:
54
57
    import configparser
55
 
import sys
56
58
import re
57
 
import os
58
59
import signal
59
60
import subprocess
60
61
import atexit
61
62
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
81
80
import random
82
81
import shlex
83
82
 
94
93
if sys.version_info.major == 2:
95
94
    __metaclass__ = type
96
95
    str = unicode
 
96
    input = raw_input
97
97
 
98
98
# Add collections.abc.Callable if it does not exist
99
99
try:
143
143
if sys.version_info < (3, 2):
144
144
    configparser.Configparser = configparser.SafeConfigParser
145
145
 
146
 
version = "1.8.14"
 
146
version = "1.8.16"
147
147
stored_state_file = "clients.pickle"
148
148
 
149
 
logger = logging.getLogger()
 
149
log = logging.getLogger(os.path.basename(sys.argv[0]))
150
150
logging.captureWarnings(True)   # Show warnings via the logging system
151
151
syslogger = None
152
152
 
191
191
    syslogger.setFormatter(logging.Formatter
192
192
                           ("Mandos [%(process)d]: %(levelname)s:"
193
193
                            " %(message)s"))
194
 
    logger.addHandler(syslogger)
 
194
    log.addHandler(syslogger)
195
195
 
196
196
    if debug:
197
197
        console = logging.StreamHandler()
199
199
                                               " [%(process)d]:"
200
200
                                               " %(levelname)s:"
201
201
                                               " %(message)s"))
202
 
        logger.addHandler(console)
203
 
    logger.setLevel(level)
 
202
        log.addHandler(console)
 
203
    log.setLevel(level)
204
204
 
205
205
 
206
206
class PGPError(Exception):
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
 
            logger.critical("No suitable Zeroconf service name found"
398
 
                            " after %i retries, exiting.",
399
 
                            self.rename_count)
 
397
            log.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
 
        logger.info("Changing Zeroconf service name to %r ...",
405
 
                    self.name)
 
404
        log.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
 
                logger.info("Local Zeroconf service name collision.")
 
413
                log.info("Local Zeroconf service name collision.")
414
414
                return self.rename(remove=False)
415
415
            else:
416
 
                logger.critical("D-Bus Exception", exc_info=error)
 
416
                log.critical("D-Bus Exception", exc_info=error)
417
417
                self.cleanup()
418
418
                os._exit(1)
419
419
 
436
436
        self.entry_group_state_changed_match = (
437
437
            self.group.connect_to_signal(
438
438
                "StateChanged", self.entry_group_state_changed))
439
 
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
440
 
                     self.name, self.type)
 
439
        log.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
 
        logger.debug("Avahi entry group state change: %i", state)
 
453
        log.debug("Avahi entry group state change: %i", state)
454
454
 
455
455
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
 
            logger.debug("Zeroconf service established.")
 
456
            log.debug("Zeroconf service established.")
457
457
        elif state == avahi.ENTRY_GROUP_COLLISION:
458
 
            logger.info("Zeroconf service name collision.")
 
458
            log.info("Zeroconf service name collision.")
459
459
            self.rename()
460
460
        elif state == avahi.ENTRY_GROUP_FAILURE:
461
 
            logger.critical("Avahi: Error in group state changed %s",
462
 
                            str(error))
 
461
            log.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
 
        logger.debug("Avahi server state change: %i", state)
 
478
        log.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
 
                    logger.error(bad_states[state])
 
488
                    log.error(bad_states[state])
489
489
                else:
490
 
                    logger.error(bad_states[state] + ": %r", error)
 
490
                    log.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
 
                    logger.info("Local Zeroconf service name"
499
 
                                " collision.")
 
498
                    log.info("Local Zeroconf service name collision.")
500
499
                    return self.rename(remove=False)
501
500
                else:
502
 
                    logger.critical("D-Bus Exception", exc_info=error)
 
501
                    log.critical("D-Bus Exception", exc_info=error)
503
502
                    self.cleanup()
504
503
                    os._exit(1)
505
504
        else:
506
505
            if error is None:
507
 
                logger.debug("Unknown state: %r", state)
 
506
                log.debug("Unknown state: %r", state)
508
507
            else:
509
 
                logger.debug("Unknown state: %r: %r", state, error)
 
508
                log.debug("Unknown state: %r: %r", state, error)
510
509
 
511
510
    def activate(self):
512
511
        """Derived from the Avahi example code"""
1010
1009
            self.last_enabled = None
1011
1010
            self.expires = None
1012
1011
 
1013
 
        logger.debug("Creating client %r", self.name)
1014
 
        logger.debug("  Key ID: %s", self.key_id)
1015
 
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
1012
        log.debug("Creating client %r", self.name)
 
1013
        log.debug("  Key ID: %s", self.key_id)
 
1014
        log.debug("  Fingerprint: %s", self.fingerprint)
1016
1015
        self.created = settings.get("created",
1017
1016
                                    datetime.datetime.utcnow())
1018
1017
 
1046
1045
        if getattr(self, "enabled", False):
1047
1046
            # Already enabled
1048
1047
            return
1049
 
        self.expires = datetime.datetime.utcnow() + self.timeout
1050
1048
        self.enabled = True
1051
1049
        self.last_enabled = datetime.datetime.utcnow()
1052
1050
        self.init_checker()
1057
1055
        if not getattr(self, "enabled", False):
1058
1056
            return False
1059
1057
        if not quiet:
1060
 
            logger.info("Disabling client %s", self.name)
 
1058
            log.info("Disabling client %s", self.name)
1061
1059
        if getattr(self, "disable_initiator_tag", None) is not None:
1062
1060
            GLib.source_remove(self.disable_initiator_tag)
1063
1061
            self.disable_initiator_tag = None
1075
1073
    def __del__(self):
1076
1074
        self.disable()
1077
1075
 
1078
 
    def init_checker(self):
1079
 
        # Schedule a new checker to be started an 'interval' from now,
1080
 
        # and every interval from then on.
 
1076
    def init_checker(self, randomize_start=False):
 
1077
        # Schedule a new checker to be started a randomly selected
 
1078
        # time (a fraction of 'interval') from now.  This spreads out
 
1079
        # the startup of checkers over time when the server is
 
1080
        # started.
1081
1081
        if self.checker_initiator_tag is not None:
1082
1082
            GLib.source_remove(self.checker_initiator_tag)
 
1083
        interval_milliseconds = int(self.interval.total_seconds()
 
1084
                                    * 1000)
 
1085
        if randomize_start:
 
1086
            delay_milliseconds = random.randrange(
 
1087
                interval_milliseconds + 1)
 
1088
        else:
 
1089
            delay_milliseconds = interval_milliseconds
1083
1090
        self.checker_initiator_tag = GLib.timeout_add(
1084
 
            random.randrange(int(self.interval.total_seconds() * 1000
1085
 
                                 + 1)),
1086
 
            self.start_checker)
1087
 
        # Schedule a disable() when 'timeout' has passed
 
1091
            delay_milliseconds, self.start_checker, randomize_start)
 
1092
        delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
 
1093
        # A checker might take up to an 'interval' of time, so we can
 
1094
        # expire at the soonest one interval after a checker was
 
1095
        # started.  Since the initial checker is delayed, the expire
 
1096
        # time might have to be extended.
 
1097
        now = datetime.datetime.utcnow()
 
1098
        self.expires = now + delay + self.interval
 
1099
        # Schedule a disable() at expire time
1088
1100
        if self.disable_initiator_tag is not None:
1089
1101
            GLib.source_remove(self.disable_initiator_tag)
1090
1102
        self.disable_initiator_tag = GLib.timeout_add(
1091
 
            int(self.timeout.total_seconds() * 1000), self.disable)
1092
 
        # Also start a new checker *right now*.
1093
 
        self.start_checker()
 
1103
            int((self.expires - now).total_seconds() * 1000),
 
1104
            self.disable)
1094
1105
 
1095
1106
    def checker_callback(self, source, condition, connection,
1096
1107
                         command):
1107
1118
            self.last_checker_status = returncode
1108
1119
            self.last_checker_signal = None
1109
1120
            if self.last_checker_status == 0:
1110
 
                logger.info("Checker for %(name)s succeeded",
1111
 
                            vars(self))
 
1121
                log.info("Checker for %(name)s succeeded", vars(self))
1112
1122
                self.checked_ok()
1113
1123
            else:
1114
 
                logger.info("Checker for %(name)s failed", vars(self))
 
1124
                log.info("Checker for %(name)s failed", vars(self))
1115
1125
        else:
1116
1126
            self.last_checker_status = -1
1117
1127
            self.last_checker_signal = -returncode
1118
 
            logger.warning("Checker for %(name)s crashed?",
1119
 
                           vars(self))
 
1128
            log.warning("Checker for %(name)s crashed?", vars(self))
1120
1129
        return False
1121
1130
 
1122
1131
    def checked_ok(self):
1141
1150
    def need_approval(self):
1142
1151
        self.last_approval_request = datetime.datetime.utcnow()
1143
1152
 
1144
 
    def start_checker(self):
 
1153
    def start_checker(self, start_was_randomized=False):
1145
1154
        """Start a new checker subprocess if one is not running.
1146
1155
 
1147
1156
        If a checker already exists, leave it running and do
1156
1165
        # should be.
1157
1166
 
1158
1167
        if self.checker is not None and not self.checker.is_alive():
1159
 
            logger.warning("Checker was not alive; joining")
 
1168
            log.warning("Checker was not alive; joining")
1160
1169
            self.checker.join()
1161
1170
            self.checker = None
1162
1171
        # Start a new checker if needed
1168
1177
            try:
1169
1178
                command = self.checker_command % escaped_attrs
1170
1179
            except TypeError as error:
1171
 
                logger.error('Could not format string "%s"',
1172
 
                             self.checker_command,
1173
 
                             exc_info=error)
 
1180
                log.error('Could not format string "%s"',
 
1181
                          self.checker_command, exc_info=error)
1174
1182
                return True     # Try again later
1175
1183
            self.current_checker_command = command
1176
 
            logger.info("Starting checker %r for %s", command,
1177
 
                        self.name)
 
1184
            log.info("Starting checker %r for %s", command, self.name)
1178
1185
            # We don't need to redirect stdout and stderr, since
1179
1186
            # in normal mode, that is already done by daemon(),
1180
1187
            # and in debug mode we don't want to.  (Stdin is
1199
1206
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1200
1207
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1201
1208
                self.checker_callback, pipe[0], command)
 
1209
        if start_was_randomized:
 
1210
            # We were started after a random delay; Schedule a new
 
1211
            # checker to be started an 'interval' from now, and every
 
1212
            # interval from then on.
 
1213
            now = datetime.datetime.utcnow()
 
1214
            self.checker_initiator_tag = GLib.timeout_add(
 
1215
                int(self.interval.total_seconds() * 1000),
 
1216
                self.start_checker)
 
1217
            self.expires = max(self.expires, now + self.interval)
 
1218
            # Don't start a new checker again after same random delay
 
1219
            return False
1202
1220
        # Re-run this periodically if run by GLib.timeout_add
1203
1221
        return True
1204
1222
 
1209
1227
            self.checker_callback_tag = None
1210
1228
        if getattr(self, "checker", None) is None:
1211
1229
            return
1212
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
1230
        log.debug("Stopping checker for %(name)s", vars(self))
1213
1231
        self.checker.terminate()
1214
1232
        self.checker = None
1215
1233
 
1393
1411
            document.unlink()
1394
1412
        except (AttributeError, xml.dom.DOMException,
1395
1413
                xml.parsers.expat.ExpatError) as error:
1396
 
            logger.error("Failed to override Introspection method",
1397
 
                         exc_info=error)
 
1414
            log.error("Failed to override Introspection method",
 
1415
                      exc_info=error)
1398
1416
        return xmlstring
1399
1417
 
1400
1418
 
1560
1578
            document.unlink()
1561
1579
        except (AttributeError, xml.dom.DOMException,
1562
1580
                xml.parsers.expat.ExpatError) as error:
1563
 
            logger.error("Failed to override Introspection method",
1564
 
                         exc_info=error)
 
1581
            log.error("Failed to override Introspection method",
 
1582
                      exc_info=error)
1565
1583
        return xmlstring
1566
1584
 
1567
1585
 
1631
1649
            document.unlink()
1632
1650
        except (AttributeError, xml.dom.DOMException,
1633
1651
                xml.parsers.expat.ExpatError) as error:
1634
 
            logger.error("Failed to override Introspection method",
1635
 
                         exc_info=error)
 
1652
            log.error("Failed to override Introspection method",
 
1653
                      exc_info=error)
1636
1654
        return xmlstring
1637
1655
 
1638
1656
 
2305
2323
 
2306
2324
    def handle(self):
2307
2325
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2308
 
            logger.info("TCP connection from: %s",
2309
 
                        str(self.client_address))
2310
 
            logger.debug("Pipe FD: %d",
2311
 
                         self.server.child_pipe.fileno())
 
2326
            log.info("TCP connection from: %s",
 
2327
                     str(self.client_address))
 
2328
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2312
2329
 
2313
2330
            session = gnutls.ClientSession(self.request)
2314
2331
 
2326
2343
            # Start communication using the Mandos protocol
2327
2344
            # Get protocol number
2328
2345
            line = self.request.makefile().readline()
2329
 
            logger.debug("Protocol version: %r", line)
 
2346
            log.debug("Protocol version: %r", line)
2330
2347
            try:
2331
2348
                if int(line.strip().split()[0]) > 1:
2332
2349
                    raise RuntimeError(line)
2333
2350
            except (ValueError, IndexError, RuntimeError) as error:
2334
 
                logger.error("Unknown protocol version: %s", error)
 
2351
                log.error("Unknown protocol version: %s", error)
2335
2352
                return
2336
2353
 
2337
2354
            # Start GnuTLS connection
2338
2355
            try:
2339
2356
                session.handshake()
2340
2357
            except gnutls.Error as error:
2341
 
                logger.warning("Handshake failed: %s", error)
 
2358
                log.warning("Handshake failed: %s", error)
2342
2359
                # Do not run session.bye() here: the session is not
2343
2360
                # established.  Just abandon the request.
2344
2361
                return
2345
 
            logger.debug("Handshake succeeded")
 
2362
            log.debug("Handshake succeeded")
2346
2363
 
2347
2364
            approval_required = False
2348
2365
            try:
2352
2369
                        key_id = self.key_id(
2353
2370
                            self.peer_certificate(session))
2354
2371
                    except (TypeError, gnutls.Error) as error:
2355
 
                        logger.warning("Bad certificate: %s", error)
 
2372
                        log.warning("Bad certificate: %s", error)
2356
2373
                        return
2357
 
                    logger.debug("Key ID: %s",
2358
 
                                 key_id.decode("utf-8",
2359
 
                                               errors="replace"))
 
2374
                    log.debug("Key ID: %s",
 
2375
                              key_id.decode("utf-8",
 
2376
                                            errors="replace"))
2360
2377
 
2361
2378
                else:
2362
2379
                    key_id = b""
2364
2381
                        fpr = self.fingerprint(
2365
2382
                            self.peer_certificate(session))
2366
2383
                    except (TypeError, gnutls.Error) as error:
2367
 
                        logger.warning("Bad certificate: %s", error)
 
2384
                        log.warning("Bad certificate: %s", error)
2368
2385
                        return
2369
 
                    logger.debug("Fingerprint: %s", fpr)
 
2386
                    log.debug("Fingerprint: %s", fpr)
2370
2387
 
2371
2388
                try:
2372
2389
                    client = ProxyClient(child_pipe, key_id, fpr,
2381
2398
 
2382
2399
                while True:
2383
2400
                    if not client.enabled:
2384
 
                        logger.info("Client %s is disabled",
2385
 
                                    client.name)
 
2401
                        log.info("Client %s is disabled", client.name)
2386
2402
                        if self.server.use_dbus:
2387
2403
                            # Emit D-Bus signal
2388
2404
                            client.Rejected("Disabled")
2392
2408
                        # We are approved or approval is disabled
2393
2409
                        break
2394
2410
                    elif client.approved is None:
2395
 
                        logger.info("Client %s needs approval",
2396
 
                                    client.name)
 
2411
                        log.info("Client %s needs approval",
 
2412
                                 client.name)
2397
2413
                        if self.server.use_dbus:
2398
2414
                            # Emit D-Bus signal
2399
2415
                            client.NeedApproval(
2400
2416
                                client.approval_delay.total_seconds()
2401
2417
                                * 1000, client.approved_by_default)
2402
2418
                    else:
2403
 
                        logger.warning("Client %s was not approved",
2404
 
                                       client.name)
 
2419
                        log.warning("Client %s was not approved",
 
2420
                                    client.name)
2405
2421
                        if self.server.use_dbus:
2406
2422
                            # Emit D-Bus signal
2407
2423
                            client.Rejected("Denied")
2415
2431
                    time2 = datetime.datetime.now()
2416
2432
                    if (time2 - time) >= delay:
2417
2433
                        if not client.approved_by_default:
2418
 
                            logger.warning("Client %s timed out while"
2419
 
                                           " waiting for approval",
2420
 
                                           client.name)
 
2434
                            log.warning("Client %s timed out while"
 
2435
                                        " waiting for approval",
 
2436
                                        client.name)
2421
2437
                            if self.server.use_dbus:
2422
2438
                                # Emit D-Bus signal
2423
2439
                                client.Rejected("Approval timed out")
2430
2446
                try:
2431
2447
                    session.send(client.secret)
2432
2448
                except gnutls.Error as error:
2433
 
                    logger.warning("gnutls send failed",
2434
 
                                   exc_info=error)
 
2449
                    log.warning("gnutls send failed", exc_info=error)
2435
2450
                    return
2436
2451
 
2437
 
                logger.info("Sending secret to %s", client.name)
 
2452
                log.info("Sending secret to %s", client.name)
2438
2453
                # bump the timeout using extended_timeout
2439
2454
                client.bump_timeout(client.extended_timeout)
2440
2455
                if self.server.use_dbus:
2447
2462
                try:
2448
2463
                    session.bye()
2449
2464
                except gnutls.Error as error:
2450
 
                    logger.warning("GnuTLS bye failed",
2451
 
                                   exc_info=error)
 
2465
                    log.warning("GnuTLS bye failed", exc_info=error)
2452
2466
 
2453
2467
    @staticmethod
2454
2468
    def peer_certificate(session):
2464
2478
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2465
2479
        # If not a valid certificate type...
2466
2480
        if cert_type not in valid_cert_types:
2467
 
            logger.info("Cert type %r not in %r", cert_type,
2468
 
                        valid_cert_types)
 
2481
            log.info("Cert type %r not in %r", cert_type,
 
2482
                     valid_cert_types)
2469
2483
            # ...return invalid data
2470
2484
            return b""
2471
2485
        list_size = ctypes.c_uint(1)
2647
2661
            if SO_BINDTODEVICE is None:
2648
2662
                # Fall back to a hard-coded value which seems to be
2649
2663
                # common enough.
2650
 
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2664
                log.warning("SO_BINDTODEVICE not found, trying 25")
2651
2665
                SO_BINDTODEVICE = 25
2652
2666
            try:
2653
2667
                self.socket.setsockopt(
2655
2669
                    (self.interface + "\0").encode("utf-8"))
2656
2670
            except socket.error as error:
2657
2671
                if error.errno == errno.EPERM:
2658
 
                    logger.error("No permission to bind to"
2659
 
                                 " interface %s", self.interface)
 
2672
                    log.error("No permission to bind to interface %s",
 
2673
                              self.interface)
2660
2674
                elif error.errno == errno.ENOPROTOOPT:
2661
 
                    logger.error("SO_BINDTODEVICE not available;"
2662
 
                                 " cannot bind to interface %s",
2663
 
                                 self.interface)
 
2675
                    log.error("SO_BINDTODEVICE not available; cannot"
 
2676
                              " bind to interface %s", self.interface)
2664
2677
                elif error.errno == errno.ENODEV:
2665
 
                    logger.error("Interface %s does not exist,"
2666
 
                                 " cannot bind", self.interface)
 
2678
                    log.error("Interface %s does not exist, cannot"
 
2679
                              " bind", self.interface)
2667
2680
                else:
2668
2681
                    raise
2669
2682
        # Only bind(2) the socket if we really need to.
2764
2777
                    client = c
2765
2778
                    break
2766
2779
            else:
2767
 
                logger.info("Client not found for key ID: %s, address"
2768
 
                            ": %s", key_id or fpr, address)
 
2780
                log.info("Client not found for key ID: %s, address:"
 
2781
                         " %s", key_id or fpr, address)
2769
2782
                if self.use_dbus:
2770
2783
                    # Emit D-Bus signal
2771
2784
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
3165
3178
        try:
3166
3179
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3167
3180
        except IOError as e:
3168
 
            logger.error("Could not open file %r", pidfilename,
3169
 
                         exc_info=e)
 
3181
            log.error("Could not open file %r", pidfilename,
 
3182
                      exc_info=e)
3170
3183
 
3171
3184
    for name, group in (("_mandos", "_mandos"),
3172
3185
                        ("mandos", "mandos"),
3183
3196
    try:
3184
3197
        os.setgid(gid)
3185
3198
        os.setuid(uid)
3186
 
        if debug:
3187
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3188
 
                                                             gid))
 
3199
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
3189
3200
    except OSError as error:
3190
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
3191
 
                       .format(uid, gid, os.strerror(error.errno)))
 
3201
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
 
3202
                    os.strerror(error.errno))
3192
3203
        if error.errno != errno.EPERM:
3193
3204
            raise
3194
3205
 
3201
3212
 
3202
3213
        @gnutls.log_func
3203
3214
        def debug_gnutls(level, string):
3204
 
            logger.debug("GnuTLS: %s",
3205
 
                         string[:-1].decode("utf-8",
3206
 
                                            errors="replace"))
 
3215
            log.debug("GnuTLS: %s",
 
3216
                      string[:-1].decode("utf-8", errors="replace"))
3207
3217
 
3208
3218
        gnutls.global_set_log_function(debug_gnutls)
3209
3219
 
3238
3248
                "se.bsnet.fukt.Mandos", bus,
3239
3249
                do_not_queue=True)
3240
3250
        except dbus.exceptions.DBusException as e:
3241
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
3251
            log.error("Disabling D-Bus:", exc_info=e)
3242
3252
            use_dbus = False
3243
3253
            server_settings["use_dbus"] = False
3244
3254
            tcp_server.use_dbus = False
3329
3339
            os.remove(stored_state_path)
3330
3340
        except IOError as e:
3331
3341
            if e.errno == errno.ENOENT:
3332
 
                logger.warning("Could not load persistent state:"
3333
 
                               " {}".format(os.strerror(e.errno)))
 
3342
                log.warning("Could not load persistent state:"
 
3343
                            " %s", os.strerror(e.errno))
3334
3344
            else:
3335
 
                logger.critical("Could not load persistent state:",
3336
 
                                exc_info=e)
 
3345
                log.critical("Could not load persistent state:",
 
3346
                             exc_info=e)
3337
3347
                raise
3338
3348
        except EOFError as e:
3339
 
            logger.warning("Could not load persistent state: "
3340
 
                           "EOFError:",
3341
 
                           exc_info=e)
 
3349
            log.warning("Could not load persistent state: EOFError:",
 
3350
                        exc_info=e)
3342
3351
 
3343
3352
    with PGPEngine() as pgp:
3344
3353
        for client_name, client in clients_data.items():
3371
3380
            if client["enabled"]:
3372
3381
                if datetime.datetime.utcnow() >= client["expires"]:
3373
3382
                    if not client["last_checked_ok"]:
3374
 
                        logger.warning(
3375
 
                            "disabling client {} - Client never "
3376
 
                            "performed a successful checker".format(
3377
 
                                client_name))
 
3383
                        log.warning("disabling client %s - Client"
 
3384
                                    " never performed a successful"
 
3385
                                    " checker", client_name)
3378
3386
                        client["enabled"] = False
3379
3387
                    elif client["last_checker_status"] != 0:
3380
 
                        logger.warning(
3381
 
                            "disabling client {} - Client last"
3382
 
                            " checker failed with error code"
3383
 
                            " {}".format(
3384
 
                                client_name,
3385
 
                                client["last_checker_status"]))
 
3388
                        log.warning("disabling client %s - Client"
 
3389
                                    " last checker failed with error"
 
3390
                                    " code %s", client_name,
 
3391
                                    client["last_checker_status"])
3386
3392
                        client["enabled"] = False
3387
3393
                    else:
3388
3394
                        client["expires"] = (
3389
3395
                            datetime.datetime.utcnow()
3390
3396
                            + client["timeout"])
3391
 
                        logger.debug("Last checker succeeded,"
3392
 
                                     " keeping {} enabled".format(
3393
 
                                         client_name))
 
3397
                        log.debug("Last checker succeeded, keeping %s"
 
3398
                                  " enabled", client_name)
3394
3399
            try:
3395
3400
                client["secret"] = pgp.decrypt(
3396
3401
                    client["encrypted_secret"],
3397
3402
                    client_settings[client_name]["secret"])
3398
3403
            except PGPError:
3399
3404
                # If decryption fails, we use secret from new settings
3400
 
                logger.debug("Failed to decrypt {} old secret".format(
3401
 
                    client_name))
 
3405
                log.debug("Failed to decrypt %s old secret",
 
3406
                          client_name)
3402
3407
                client["secret"] = (client_settings[client_name]
3403
3408
                                    ["secret"])
3404
3409
 
3418
3423
            server_settings=server_settings)
3419
3424
 
3420
3425
    if not tcp_server.clients:
3421
 
        logger.warning("No clients defined")
 
3426
        log.warning("No clients defined")
3422
3427
 
3423
3428
    if not foreground:
3424
3429
        if pidfile is not None:
3427
3432
                with pidfile:
3428
3433
                    print(pid, file=pidfile)
3429
3434
            except IOError:
3430
 
                logger.error("Could not write to file %r with PID %d",
3431
 
                             pidfilename, pid)
 
3435
                log.error("Could not write to file %r with PID %d",
 
3436
                          pidfilename, pid)
3432
3437
        del pidfile
3433
3438
        del pidfilename
3434
3439
 
3600
3605
                except NameError:
3601
3606
                    pass
3602
3607
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3603
 
                logger.warning("Could not save persistent state: {}"
3604
 
                               .format(os.strerror(e.errno)))
 
3608
                log.warning("Could not save persistent state: %s",
 
3609
                            os.strerror(e.errno))
3605
3610
            else:
3606
 
                logger.warning("Could not save persistent state:",
3607
 
                               exc_info=e)
 
3611
                log.warning("Could not save persistent state:",
 
3612
                            exc_info=e)
3608
3613
                raise
3609
3614
 
3610
3615
        # Delete all clients, and settings from config
3627
3632
            mandos_dbus_service.client_added_signal(client)
3628
3633
        # Need to initiate checking of clients
3629
3634
        if client.enabled:
3630
 
            client.init_checker()
 
3635
            client.init_checker(randomize_start=True)
3631
3636
 
3632
3637
    tcp_server.enable()
3633
3638
    tcp_server.server_activate()
3636
3641
    if zeroconf:
3637
3642
        service.port = tcp_server.socket.getsockname()[1]
3638
3643
    if use_ipv6:
3639
 
        logger.info("Now listening on address %r, port %d,"
3640
 
                    " flowinfo %d, scope_id %d",
3641
 
                    *tcp_server.socket.getsockname())
 
3644
        log.info("Now listening on address %r, port %d, flowinfo %d,"
 
3645
                 " scope_id %d", *tcp_server.socket.getsockname())
3642
3646
    else:                       # IPv4
3643
 
        logger.info("Now listening on address %r, port %d",
3644
 
                    *tcp_server.socket.getsockname())
 
3647
        log.info("Now listening on address %r, port %d",
 
3648
                 *tcp_server.socket.getsockname())
3645
3649
 
3646
3650
    # service.interface = tcp_server.socket.getsockname()[3]
3647
3651
 
3651
3655
            try:
3652
3656
                service.activate()
3653
3657
            except dbus.exceptions.DBusException as error:
3654
 
                logger.critical("D-Bus Exception", exc_info=error)
 
3658
                log.critical("D-Bus Exception", exc_info=error)
3655
3659
                cleanup()
3656
3660
                sys.exit(1)
3657
3661
            # End of Avahi example code
3662
3666
            lambda *args, **kwargs: (tcp_server.handle_request
3663
3667
                                     (*args[2:], **kwargs) or True))
3664
3668
 
3665
 
        logger.debug("Starting main loop")
 
3669
        log.debug("Starting main loop")
3666
3670
        main_loop.run()
3667
3671
    except AvahiError as error:
3668
 
        logger.critical("Avahi Error", exc_info=error)
 
3672
        log.critical("Avahi Error", exc_info=error)
3669
3673
        cleanup()
3670
3674
        sys.exit(1)
3671
3675
    except KeyboardInterrupt:
3672
3676
        if debug:
3673
3677
            print("", file=sys.stderr)
3674
 
        logger.debug("Server received KeyboardInterrupt")
3675
 
    logger.debug("Server exiting")
 
3678
        log.debug("Server received KeyboardInterrupt")
 
3679
    log.debug("Server exiting")
3676
3680
    # Must run before the D-Bus bus name gets deregistered
3677
3681
    cleanup()
3678
3682
 
3679
3683
 
3680
 
def should_only_run_tests():
 
3684
def parse_test_args():
 
3685
    # type: () -> argparse.Namespace
3681
3686
    parser = argparse.ArgumentParser(add_help=False)
3682
3687
    parser.add_argument("--check", action="store_true")
 
3688
    parser.add_argument("--prefix", )
3683
3689
    args, unknown_args = parser.parse_known_args()
3684
 
    run_tests = args.check
3685
 
    if run_tests:
3686
 
        # Remove --check argument from sys.argv
 
3690
    if args.check:
 
3691
        # Remove test options from sys.argv
3687
3692
        sys.argv[1:] = unknown_args
3688
 
    return run_tests
 
3693
    return args
3689
3694
 
3690
3695
# Add all tests from doctest strings
3691
3696
def load_tests(loader, tests, none):
3694
3699
    return tests
3695
3700
 
3696
3701
if __name__ == "__main__":
 
3702
    options = parse_test_args()
3697
3703
    try:
3698
 
        if should_only_run_tests():
3699
 
            # Call using ./mandos --check [--verbose]
3700
 
            unittest.main()
 
3704
        if options.check:
 
3705
            extra_test_prefix = options.prefix
 
3706
            if extra_test_prefix is not None:
 
3707
                if not (unittest.main(argv=[""], exit=False)
 
3708
                        .result.wasSuccessful()):
 
3709
                    sys.exit(1)
 
3710
                class ExtraTestLoader(unittest.TestLoader):
 
3711
                    testMethodPrefix = extra_test_prefix
 
3712
                # Call using ./scriptname --test [--verbose]
 
3713
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
 
3714
            else:
 
3715
                unittest.main(argv=[""])
3701
3716
        else:
3702
3717
            main()
3703
3718
    finally:
3704
3719
        logging.shutdown()
 
3720
 
 
3721
# Local Variables:
 
3722
# run-tests:
 
3723
# (lambda (&optional extra)
 
3724
#   (if (not (funcall run-tests-in-test-buffer default-directory
 
3725
#             extra))
 
3726
#       (funcall show-test-buffer-in-test-window)
 
3727
#     (funcall remove-test-window)
 
3728
#     (if extra (message "Extra tests run successfully!"))))
 
3729
# run-tests-in-test-buffer:
 
3730
# (lambda (dir &optional extra)
 
3731
#   (with-current-buffer (get-buffer-create "*Test*")
 
3732
#     (setq buffer-read-only nil
 
3733
#           default-directory dir)
 
3734
#     (erase-buffer)
 
3735
#     (compilation-mode))
 
3736
#   (let ((process-result
 
3737
#          (let ((inhibit-read-only t))
 
3738
#            (process-file-shell-command
 
3739
#             (funcall get-command-line extra) nil "*Test*"))))
 
3740
#     (and (numberp process-result)
 
3741
#          (= process-result 0))))
 
3742
# get-command-line:
 
3743
# (lambda (&optional extra)
 
3744
#   (let ((quoted-script
 
3745
#          (shell-quote-argument (funcall get-script-name))))
 
3746
#     (format
 
3747
#      (concat "%s --check" (if extra " --prefix=atest" ""))
 
3748
#      quoted-script)))
 
3749
# get-script-name:
 
3750
# (lambda ()
 
3751
#   (if (fboundp 'file-local-name)
 
3752
#       (file-local-name (buffer-file-name))
 
3753
#     (or (file-remote-p (buffer-file-name) 'localname)
 
3754
#         (buffer-file-name))))
 
3755
# remove-test-window:
 
3756
# (lambda ()
 
3757
#   (let ((test-window (get-buffer-window "*Test*")))
 
3758
#     (if test-window (delete-window test-window))))
 
3759
# show-test-buffer-in-test-window:
 
3760
# (lambda ()
 
3761
#   (when (not (get-buffer-window-list "*Test*"))
 
3762
#     (setq next-error-last-buffer (get-buffer "*Test*"))
 
3763
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
 
3764
#            (display-buffer-overriding-action
 
3765
#             `((display-buffer-in-side-window) (side . ,side)
 
3766
#               (window-height . fit-window-to-buffer)
 
3767
#               (window-width . fit-window-to-buffer))))
 
3768
#       (display-buffer "*Test*"))))
 
3769
# eval:
 
3770
# (progn
 
3771
#   (let* ((run-extra-tests (lambda () (interactive)
 
3772
#                             (funcall run-tests t)))
 
3773
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
 
3774
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
 
3775
#     (setq minor-mode-overriding-map-alist
 
3776
#           (cons `(run-tests . ,outer-keymap)
 
3777
#                 minor-mode-overriding-map-alist)))
 
3778
#   (add-hook 'after-save-hook run-tests 90 t))
 
3779
# End: