/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-25 18:46:48 UTC
  • mto: This revision was merged to the branch mainline in revision 1261.
  • Revision ID: teddy@recompile.se-20220425184648-w9nas5qn94qcllum
Tags: version-1.8.15-1
Version 1.8.15-1

* Makefile (version): Change to "1.8.15".
* NEWS (Version 1.8.15): Add new entry.
* debian/changelog (1.8.15-1): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
 
1
#!/usr/bin/python3 -bI
 
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-2019 Teddy Hogeborn
15
 
# Copyright © 2008-2019 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 random
 
81
import shlex
80
82
 
81
83
import dbus
82
84
import dbus.service
88
90
import xml.dom.minidom
89
91
import inspect
90
92
 
 
93
if sys.version_info.major == 2:
 
94
    __metaclass__ = type
 
95
    str = unicode
 
96
    input = raw_input
 
97
 
 
98
# Add collections.abc.Callable if it does not exist
 
99
try:
 
100
    collections.abc.Callable
 
101
except AttributeError:
 
102
    class abc:
 
103
        Callable = collections.Callable
 
104
    collections.abc = abc
 
105
    del abc
 
106
 
 
107
# Add shlex.quote if it does not exist
 
108
try:
 
109
    shlex.quote
 
110
except AttributeError:
 
111
    shlex.quote = re.escape
 
112
 
 
113
# Show warnings by default
 
114
if not sys.warnoptions:
 
115
    import warnings
 
116
    warnings.simplefilter("default")
 
117
 
91
118
# Try to find the value of SO_BINDTODEVICE:
92
119
try:
93
120
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
113
140
            # No value found
114
141
            SO_BINDTODEVICE = None
115
142
 
116
 
if sys.version_info.major == 2:
117
 
    str = unicode
118
 
 
119
143
if sys.version_info < (3, 2):
120
144
    configparser.Configparser = configparser.SafeConfigParser
121
145
 
122
 
version = "1.8.6"
 
146
version = "1.8.15"
123
147
stored_state_file = "clients.pickle"
124
148
 
125
 
logger = logging.getLogger()
 
149
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
150
logging.captureWarnings(True)   # Show warnings via the logging system
126
151
syslogger = None
127
152
 
128
153
try:
164
189
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
165
190
        address="/dev/log"))
166
191
    syslogger.setFormatter(logging.Formatter
167
 
                           ('Mandos [%(process)d]: %(levelname)s:'
168
 
                            ' %(message)s'))
169
 
    logger.addHandler(syslogger)
 
192
                           ("Mandos [%(process)d]: %(levelname)s:"
 
193
                            " %(message)s"))
 
194
    log.addHandler(syslogger)
170
195
 
171
196
    if debug:
172
197
        console = logging.StreamHandler()
173
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
174
 
                                               ' [%(process)d]:'
175
 
                                               ' %(levelname)s:'
176
 
                                               ' %(message)s'))
177
 
        logger.addHandler(console)
178
 
    logger.setLevel(level)
 
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)
179
204
 
180
205
 
181
206
class PGPError(Exception):
183
208
    pass
184
209
 
185
210
 
186
 
class PGPEngine(object):
 
211
class PGPEngine:
187
212
    """A simple class for OpenPGP symmetric encryption & decryption"""
188
213
 
189
214
    def __init__(self):
193
218
            output = subprocess.check_output(["gpgconf"])
194
219
            for line in output.splitlines():
195
220
                name, text, path = line.split(b":")
196
 
                if name == "gpg":
 
221
                if name == b"gpg":
197
222
                    self.gpg = path
198
223
                    break
199
224
        except OSError as e:
200
225
            if e.errno != errno.ENOENT:
201
226
                raise
202
 
        self.gnupgargs = ['--batch',
203
 
                          '--homedir', self.tempdir,
204
 
                          '--force-mdc',
205
 
                          '--quiet']
 
227
        self.gnupgargs = ["--batch",
 
228
                          "--homedir", self.tempdir,
 
229
                          "--force-mdc",
 
230
                          "--quiet"]
206
231
        # Only GPG version 1 has the --no-use-agent option.
207
 
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
232
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
208
233
            self.gnupgargs.append("--no-use-agent")
209
234
 
210
235
    def __enter__(self):
247
272
                dir=self.tempdir) as passfile:
248
273
            passfile.write(passphrase)
249
274
            passfile.flush()
250
 
            proc = subprocess.Popen([self.gpg, '--symmetric',
251
 
                                     '--passphrase-file',
 
275
            proc = subprocess.Popen([self.gpg, "--symmetric",
 
276
                                     "--passphrase-file",
252
277
                                     passfile.name]
253
278
                                    + self.gnupgargs,
254
279
                                    stdin=subprocess.PIPE,
265
290
                dir=self.tempdir) as passfile:
266
291
            passfile.write(passphrase)
267
292
            passfile.flush()
268
 
            proc = subprocess.Popen([self.gpg, '--decrypt',
269
 
                                     '--passphrase-file',
 
293
            proc = subprocess.Popen([self.gpg, "--decrypt",
 
294
                                     "--passphrase-file",
270
295
                                     passfile.name]
271
296
                                    + self.gnupgargs,
272
297
                                    stdin=subprocess.PIPE,
279
304
 
280
305
 
281
306
# Pretend that we have an Avahi module
282
 
class avahi(object):
 
307
class avahi:
283
308
    """This isn't so much a class as it is a module-like namespace."""
284
309
    IF_UNSPEC = -1               # avahi-common/address.h
285
310
    PROTO_UNSPEC = -1            # avahi-common/address.h
319
344
    pass
320
345
 
321
346
 
322
 
class AvahiService(object):
 
347
class AvahiService:
323
348
    """An Avahi (Zeroconf) service.
324
349
 
325
350
    Attributes:
326
351
    interface: integer; avahi.IF_UNSPEC or an interface index.
327
352
               Used to optionally bind to the specified interface.
328
 
    name: string; Example: 'Mandos'
329
 
    type: string; Example: '_mandos._tcp'.
 
353
    name: string; Example: "Mandos"
 
354
    type: string; Example: "_mandos._tcp".
330
355
     See <https://www.iana.org/assignments/service-names-port-numbers>
331
356
    port: integer; what port to announce
332
357
    TXT: list of strings; TXT record for the service
369
394
    def rename(self, remove=True):
370
395
        """Derived from the Avahi example code"""
371
396
        if self.rename_count >= self.max_renames:
372
 
            logger.critical("No suitable Zeroconf service name found"
373
 
                            " after %i retries, exiting.",
374
 
                            self.rename_count)
 
397
            log.critical("No suitable Zeroconf service name found"
 
398
                         " after %i retries, exiting.",
 
399
                         self.rename_count)
375
400
            raise AvahiServiceError("Too many renames")
376
401
        self.name = str(
377
402
            self.server.GetAlternativeServiceName(self.name))
378
403
        self.rename_count += 1
379
 
        logger.info("Changing Zeroconf service name to %r ...",
380
 
                    self.name)
 
404
        log.info("Changing Zeroconf service name to %r ...",
 
405
                 self.name)
381
406
        if remove:
382
407
            self.remove()
383
408
        try:
385
410
        except dbus.exceptions.DBusException as error:
386
411
            if (error.get_dbus_name()
387
412
                == "org.freedesktop.Avahi.CollisionError"):
388
 
                logger.info("Local Zeroconf service name collision.")
 
413
                log.info("Local Zeroconf service name collision.")
389
414
                return self.rename(remove=False)
390
415
            else:
391
 
                logger.critical("D-Bus Exception", exc_info=error)
 
416
                log.critical("D-Bus Exception", exc_info=error)
392
417
                self.cleanup()
393
418
                os._exit(1)
394
419
 
410
435
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
411
436
        self.entry_group_state_changed_match = (
412
437
            self.group.connect_to_signal(
413
 
                'StateChanged', self.entry_group_state_changed))
414
 
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
415
 
                     self.name, self.type)
 
438
                "StateChanged", self.entry_group_state_changed))
 
439
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
440
                  self.name, self.type)
416
441
        self.group.AddService(
417
442
            self.interface,
418
443
            self.protocol,
425
450
 
426
451
    def entry_group_state_changed(self, state, error):
427
452
        """Derived from the Avahi example code"""
428
 
        logger.debug("Avahi entry group state change: %i", state)
 
453
        log.debug("Avahi entry group state change: %i", state)
429
454
 
430
455
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
431
 
            logger.debug("Zeroconf service established.")
 
456
            log.debug("Zeroconf service established.")
432
457
        elif state == avahi.ENTRY_GROUP_COLLISION:
433
 
            logger.info("Zeroconf service name collision.")
 
458
            log.info("Zeroconf service name collision.")
434
459
            self.rename()
435
460
        elif state == avahi.ENTRY_GROUP_FAILURE:
436
 
            logger.critical("Avahi: Error in group state changed %s",
437
 
                            str(error))
 
461
            log.critical("Avahi: Error in group state changed %s",
 
462
                         str(error))
438
463
            raise AvahiGroupError("State changed: {!s}".format(error))
439
464
 
440
465
    def cleanup(self):
450
475
 
451
476
    def server_state_changed(self, state, error=None):
452
477
        """Derived from the Avahi example code"""
453
 
        logger.debug("Avahi server state change: %i", state)
 
478
        log.debug("Avahi server state change: %i", state)
454
479
        bad_states = {
455
480
            avahi.SERVER_INVALID: "Zeroconf server invalid",
456
481
            avahi.SERVER_REGISTERING: None,
460
485
        if state in bad_states:
461
486
            if bad_states[state] is not None:
462
487
                if error is None:
463
 
                    logger.error(bad_states[state])
 
488
                    log.error(bad_states[state])
464
489
                else:
465
 
                    logger.error(bad_states[state] + ": %r", error)
 
490
                    log.error(bad_states[state] + ": %r", error)
466
491
            self.cleanup()
467
492
        elif state == avahi.SERVER_RUNNING:
468
493
            try:
470
495
            except dbus.exceptions.DBusException as error:
471
496
                if (error.get_dbus_name()
472
497
                    == "org.freedesktop.Avahi.CollisionError"):
473
 
                    logger.info("Local Zeroconf service name"
474
 
                                " collision.")
 
498
                    log.info("Local Zeroconf service name collision.")
475
499
                    return self.rename(remove=False)
476
500
                else:
477
 
                    logger.critical("D-Bus Exception", exc_info=error)
 
501
                    log.critical("D-Bus Exception", exc_info=error)
478
502
                    self.cleanup()
479
503
                    os._exit(1)
480
504
        else:
481
505
            if error is None:
482
 
                logger.debug("Unknown state: %r", state)
 
506
                log.debug("Unknown state: %r", state)
483
507
            else:
484
 
                logger.debug("Unknown state: %r: %r", state, error)
 
508
                log.debug("Unknown state: %r: %r", state, error)
485
509
 
486
510
    def activate(self):
487
511
        """Derived from the Avahi example code"""
499
523
class AvahiServiceToSyslog(AvahiService):
500
524
    def rename(self, *args, **kwargs):
501
525
        """Add the new name to the syslog messages"""
502
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
526
        ret = super(AvahiServiceToSyslog, self).rename(*args,
 
527
                                                       **kwargs)
503
528
        syslogger.setFormatter(logging.Formatter(
504
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
529
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
505
530
            .format(self.name)))
506
531
        return ret
507
532
 
508
533
 
509
534
# Pretend that we have a GnuTLS module
510
 
class gnutls(object):
 
535
class gnutls:
511
536
    """This isn't so much a class as it is a module-like namespace."""
512
537
 
513
538
    library = ctypes.util.find_library("gnutls")
537
562
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
538
563
 
539
564
    # Types
540
 
    class session_int(ctypes.Structure):
 
565
    class _session_int(ctypes.Structure):
541
566
        _fields_ = []
542
 
    session_t = ctypes.POINTER(session_int)
 
567
    session_t = ctypes.POINTER(_session_int)
543
568
 
544
569
    class certificate_credentials_st(ctypes.Structure):
545
570
        _fields_ = []
548
573
    certificate_type_t = ctypes.c_int
549
574
 
550
575
    class datum_t(ctypes.Structure):
551
 
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
 
                    ('size', ctypes.c_uint)]
 
576
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
 
577
                    ("size", ctypes.c_uint)]
553
578
 
554
 
    class openpgp_crt_int(ctypes.Structure):
 
579
    class _openpgp_crt_int(ctypes.Structure):
555
580
        _fields_ = []
556
 
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
581
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
557
582
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
558
583
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
584
    credentials_type_t = ctypes.c_int
568
593
            # gnutls.strerror()
569
594
            self.code = code
570
595
            if message is None and code is not None:
571
 
                message = gnutls.strerror(code)
 
596
                message = gnutls.strerror(code).decode(
 
597
                    "utf-8", errors="replace")
572
598
            return super(gnutls.Error, self).__init__(
573
599
                message, *args)
574
600
 
575
601
    class CertificateSecurityError(Error):
576
602
        pass
577
603
 
 
604
    class PointerTo:
 
605
        def __init__(self, cls):
 
606
            self.cls = cls
 
607
 
 
608
        def from_param(self, obj):
 
609
            if not isinstance(obj, self.cls):
 
610
                raise TypeError("Not of type {}: {!r}"
 
611
                                .format(self.cls.__name__, obj))
 
612
            return ctypes.byref(obj.from_param(obj))
 
613
 
 
614
    class CastToVoidPointer:
 
615
        def __init__(self, cls):
 
616
            self.cls = cls
 
617
 
 
618
        def from_param(self, obj):
 
619
            if not isinstance(obj, self.cls):
 
620
                raise TypeError("Not of type {}: {!r}"
 
621
                                .format(self.cls.__name__, obj))
 
622
            return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
 
623
 
 
624
    class With_from_param:
 
625
        @classmethod
 
626
        def from_param(cls, obj):
 
627
            return obj._as_parameter_
 
628
 
578
629
    # Classes
579
 
    class Credentials(object):
 
630
    class Credentials(With_from_param):
580
631
        def __init__(self):
581
 
            self._c_object = gnutls.certificate_credentials_t()
582
 
            gnutls.certificate_allocate_credentials(
583
 
                ctypes.byref(self._c_object))
 
632
            self._as_parameter_ = gnutls.certificate_credentials_t()
 
633
            gnutls.certificate_allocate_credentials(self)
584
634
            self.type = gnutls.CRD_CERTIFICATE
585
635
 
586
636
        def __del__(self):
587
 
            gnutls.certificate_free_credentials(self._c_object)
 
637
            gnutls.certificate_free_credentials(self)
588
638
 
589
 
    class ClientSession(object):
 
639
    class ClientSession(With_from_param):
590
640
        def __init__(self, socket, credentials=None):
591
 
            self._c_object = gnutls.session_t()
 
641
            self._as_parameter_ = gnutls.session_t()
592
642
            gnutls_flags = gnutls.CLIENT
593
643
            if gnutls.check_version(b"3.5.6"):
594
644
                gnutls_flags |= gnutls.NO_TICKETS
595
645
            if gnutls.has_rawpk:
596
646
                gnutls_flags |= gnutls.ENABLE_RAWPK
597
 
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
 
647
            gnutls.init(self, gnutls_flags)
598
648
            del gnutls_flags
599
 
            gnutls.set_default_priority(self._c_object)
600
 
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
601
 
            gnutls.handshake_set_private_extensions(self._c_object,
602
 
                                                    True)
 
649
            gnutls.set_default_priority(self)
 
650
            gnutls.transport_set_ptr(self, socket.fileno())
 
651
            gnutls.handshake_set_private_extensions(self, True)
603
652
            self.socket = socket
604
653
            if credentials is None:
605
654
                credentials = gnutls.Credentials()
606
 
            gnutls.credentials_set(self._c_object, credentials.type,
607
 
                                   ctypes.cast(credentials._c_object,
608
 
                                               ctypes.c_void_p))
 
655
            gnutls.credentials_set(self, credentials.type,
 
656
                                   credentials)
609
657
            self.credentials = credentials
610
658
 
611
659
        def __del__(self):
612
 
            gnutls.deinit(self._c_object)
 
660
            gnutls.deinit(self)
613
661
 
614
662
        def handshake(self):
615
 
            return gnutls.handshake(self._c_object)
 
663
            return gnutls.handshake(self)
616
664
 
617
665
        def send(self, data):
618
666
            data = bytes(data)
619
667
            data_len = len(data)
620
668
            while data_len > 0:
621
 
                data_len -= gnutls.record_send(self._c_object,
622
 
                                               data[-data_len:],
 
669
                data_len -= gnutls.record_send(self, data[-data_len:],
623
670
                                               data_len)
624
671
 
625
672
        def bye(self):
626
 
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
673
            return gnutls.bye(self, gnutls.SHUT_RDWR)
627
674
 
628
675
    # Error handling functions
629
676
    def _error_code(result):
630
677
        """A function to raise exceptions on errors, suitable
631
 
        for the 'restype' attribute on ctypes functions"""
632
 
        if result >= 0:
 
678
        for the "restype" attribute on ctypes functions"""
 
679
        if result >= gnutls.E_SUCCESS:
633
680
            return result
634
681
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
635
682
            raise gnutls.CertificateSecurityError(code=result)
636
683
        raise gnutls.Error(code=result)
637
684
 
638
 
    def _retry_on_error(result, func, arguments):
 
685
    def _retry_on_error(result, func, arguments,
 
686
                        _error_code=_error_code):
639
687
        """A function to retry on some errors, suitable
640
 
        for the 'errcheck' attribute on ctypes functions"""
641
 
        while result < 0:
 
688
        for the "errcheck" attribute on ctypes functions"""
 
689
        while result < gnutls.E_SUCCESS:
642
690
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
643
691
                return _error_code(result)
644
692
            result = func(*arguments)
649
697
 
650
698
    # Functions
651
699
    priority_set_direct = _library.gnutls_priority_set_direct
652
 
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
700
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
653
701
                                    ctypes.POINTER(ctypes.c_char_p)]
654
702
    priority_set_direct.restype = _error_code
655
703
 
656
704
    init = _library.gnutls_init
657
 
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
705
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
658
706
    init.restype = _error_code
659
707
 
660
708
    set_default_priority = _library.gnutls_set_default_priority
661
 
    set_default_priority.argtypes = [session_t]
 
709
    set_default_priority.argtypes = [ClientSession]
662
710
    set_default_priority.restype = _error_code
663
711
 
664
712
    record_send = _library.gnutls_record_send
665
 
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
713
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
666
714
                            ctypes.c_size_t]
667
715
    record_send.restype = ctypes.c_ssize_t
668
716
    record_send.errcheck = _retry_on_error
670
718
    certificate_allocate_credentials = (
671
719
        _library.gnutls_certificate_allocate_credentials)
672
720
    certificate_allocate_credentials.argtypes = [
673
 
        ctypes.POINTER(certificate_credentials_t)]
 
721
        PointerTo(Credentials)]
674
722
    certificate_allocate_credentials.restype = _error_code
675
723
 
676
724
    certificate_free_credentials = (
677
725
        _library.gnutls_certificate_free_credentials)
678
 
    certificate_free_credentials.argtypes = [
679
 
        certificate_credentials_t]
 
726
    certificate_free_credentials.argtypes = [Credentials]
680
727
    certificate_free_credentials.restype = None
681
728
 
682
729
    handshake_set_private_extensions = (
683
730
        _library.gnutls_handshake_set_private_extensions)
684
 
    handshake_set_private_extensions.argtypes = [session_t,
 
731
    handshake_set_private_extensions.argtypes = [ClientSession,
685
732
                                                 ctypes.c_int]
686
733
    handshake_set_private_extensions.restype = None
687
734
 
688
735
    credentials_set = _library.gnutls_credentials_set
689
 
    credentials_set.argtypes = [session_t, credentials_type_t,
690
 
                                ctypes.c_void_p]
 
736
    credentials_set.argtypes = [ClientSession, credentials_type_t,
 
737
                                CastToVoidPointer(Credentials)]
691
738
    credentials_set.restype = _error_code
692
739
 
693
740
    strerror = _library.gnutls_strerror
695
742
    strerror.restype = ctypes.c_char_p
696
743
 
697
744
    certificate_type_get = _library.gnutls_certificate_type_get
698
 
    certificate_type_get.argtypes = [session_t]
 
745
    certificate_type_get.argtypes = [ClientSession]
699
746
    certificate_type_get.restype = _error_code
700
747
 
701
748
    certificate_get_peers = _library.gnutls_certificate_get_peers
702
 
    certificate_get_peers.argtypes = [session_t,
 
749
    certificate_get_peers.argtypes = [ClientSession,
703
750
                                      ctypes.POINTER(ctypes.c_uint)]
704
751
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
705
752
 
712
759
    global_set_log_function.restype = None
713
760
 
714
761
    deinit = _library.gnutls_deinit
715
 
    deinit.argtypes = [session_t]
 
762
    deinit.argtypes = [ClientSession]
716
763
    deinit.restype = None
717
764
 
718
765
    handshake = _library.gnutls_handshake
719
 
    handshake.argtypes = [session_t]
720
 
    handshake.restype = _error_code
 
766
    handshake.argtypes = [ClientSession]
 
767
    handshake.restype = ctypes.c_int
721
768
    handshake.errcheck = _retry_on_error
722
769
 
723
770
    transport_set_ptr = _library.gnutls_transport_set_ptr
724
 
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
771
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
725
772
    transport_set_ptr.restype = None
726
773
 
727
774
    bye = _library.gnutls_bye
728
 
    bye.argtypes = [session_t, close_request_t]
729
 
    bye.restype = _error_code
 
775
    bye.argtypes = [ClientSession, close_request_t]
 
776
    bye.restype = ctypes.c_int
730
777
    bye.errcheck = _retry_on_error
731
778
 
732
779
    check_version = _library.gnutls_check_version
749
796
 
750
797
        x509_crt_fmt_t = ctypes.c_int
751
798
 
752
 
        # All the function declarations below are from gnutls/abstract.h
 
799
        # All the function declarations below are from
 
800
        # gnutls/abstract.h
753
801
        pubkey_init = _library.gnutls_pubkey_init
754
802
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
755
803
        pubkey_init.restype = _error_code
769
817
        pubkey_deinit.argtypes = [pubkey_t]
770
818
        pubkey_deinit.restype = None
771
819
    else:
772
 
        # All the function declarations below are from gnutls/openpgp.h
 
820
        # All the function declarations below are from
 
821
        # gnutls/openpgp.h
773
822
 
774
823
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
775
824
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
781
830
                                       openpgp_crt_fmt_t]
782
831
        openpgp_crt_import.restype = _error_code
783
832
 
784
 
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
785
 
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
786
 
                                            ctypes.POINTER(ctypes.c_uint)]
 
833
        openpgp_crt_verify_self = \
 
834
            _library.gnutls_openpgp_crt_verify_self
 
835
        openpgp_crt_verify_self.argtypes = [
 
836
            openpgp_crt_t,
 
837
            ctypes.c_uint,
 
838
            ctypes.POINTER(ctypes.c_uint),
 
839
        ]
787
840
        openpgp_crt_verify_self.restype = _error_code
788
841
 
789
842
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
800
853
 
801
854
    if check_version(b"3.6.4"):
802
855
        certificate_type_get2 = _library.gnutls_certificate_type_get2
803
 
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
 
856
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
804
857
        certificate_type_get2.restype = _error_code
805
858
 
806
859
    # Remove non-public functions
818
871
    connection.close()
819
872
 
820
873
 
821
 
class Client(object):
 
874
class Client:
822
875
    """A representation of a client host served by this server.
823
876
 
824
877
    Attributes:
825
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
878
    approved:   bool(); None if not yet approved/disapproved
826
879
    approval_delay: datetime.timedelta(); Time to wait for approval
827
880
    approval_duration: datetime.timedelta(); Duration of one approval
828
881
    checker: multiprocessing.Process(); a running checker process used
829
 
             to see if the client lives. 'None' if no process is
 
882
             to see if the client lives. None if no process is
830
883
             running.
831
884
    checker_callback_tag: a GLib event source tag, or None
832
885
    checker_command: string; External command which is run to check
956
1009
            self.last_enabled = None
957
1010
            self.expires = None
958
1011
 
959
 
        logger.debug("Creating client %r", self.name)
960
 
        logger.debug("  Key ID: %s", self.key_id)
961
 
        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)
962
1015
        self.created = settings.get("created",
963
1016
                                    datetime.datetime.utcnow())
964
1017
 
1003
1056
        if not getattr(self, "enabled", False):
1004
1057
            return False
1005
1058
        if not quiet:
1006
 
            logger.info("Disabling client %s", self.name)
 
1059
            log.info("Disabling client %s", self.name)
1007
1060
        if getattr(self, "disable_initiator_tag", None) is not None:
1008
1061
            GLib.source_remove(self.disable_initiator_tag)
1009
1062
            self.disable_initiator_tag = None
1027
1080
        if self.checker_initiator_tag is not None:
1028
1081
            GLib.source_remove(self.checker_initiator_tag)
1029
1082
        self.checker_initiator_tag = GLib.timeout_add(
1030
 
            int(self.interval.total_seconds() * 1000),
 
1083
            random.randrange(int(self.interval.total_seconds() * 1000
 
1084
                                 + 1)),
1031
1085
            self.start_checker)
1032
1086
        # Schedule a disable() when 'timeout' has passed
1033
1087
        if self.disable_initiator_tag is not None:
1043
1097
        # Read return code from connection (see call_pipe)
1044
1098
        returncode = connection.recv()
1045
1099
        connection.close()
1046
 
        self.checker.join()
 
1100
        if self.checker is not None:
 
1101
            self.checker.join()
1047
1102
        self.checker_callback_tag = None
1048
1103
        self.checker = None
1049
1104
 
1051
1106
            self.last_checker_status = returncode
1052
1107
            self.last_checker_signal = None
1053
1108
            if self.last_checker_status == 0:
1054
 
                logger.info("Checker for %(name)s succeeded",
1055
 
                            vars(self))
 
1109
                log.info("Checker for %(name)s succeeded", vars(self))
1056
1110
                self.checked_ok()
1057
1111
            else:
1058
 
                logger.info("Checker for %(name)s failed", vars(self))
 
1112
                log.info("Checker for %(name)s failed", vars(self))
1059
1113
        else:
1060
1114
            self.last_checker_status = -1
1061
1115
            self.last_checker_signal = -returncode
1062
 
            logger.warning("Checker for %(name)s crashed?",
1063
 
                           vars(self))
 
1116
            log.warning("Checker for %(name)s crashed?", vars(self))
1064
1117
        return False
1065
1118
 
1066
1119
    def checked_ok(self):
1100
1153
        # should be.
1101
1154
 
1102
1155
        if self.checker is not None and not self.checker.is_alive():
1103
 
            logger.warning("Checker was not alive; joining")
 
1156
            log.warning("Checker was not alive; joining")
1104
1157
            self.checker.join()
1105
1158
            self.checker = None
1106
1159
        # Start a new checker if needed
1107
1160
        if self.checker is None:
1108
1161
            # Escape attributes for the shell
1109
1162
            escaped_attrs = {
1110
 
                attr: re.escape(str(getattr(self, attr)))
 
1163
                attr: shlex.quote(str(getattr(self, attr)))
1111
1164
                for attr in self.runtime_expansions}
1112
1165
            try:
1113
1166
                command = self.checker_command % escaped_attrs
1114
1167
            except TypeError as error:
1115
 
                logger.error('Could not format string "%s"',
1116
 
                             self.checker_command,
1117
 
                             exc_info=error)
 
1168
                log.error('Could not format string "%s"',
 
1169
                          self.checker_command, exc_info=error)
1118
1170
                return True     # Try again later
1119
1171
            self.current_checker_command = command
1120
 
            logger.info("Starting checker %r for %s", command,
1121
 
                        self.name)
 
1172
            log.info("Starting checker %r for %s", command, self.name)
1122
1173
            # We don't need to redirect stdout and stderr, since
1123
1174
            # in normal mode, that is already done by daemon(),
1124
1175
            # and in debug mode we don't want to.  (Stdin is
1140
1191
                kwargs=popen_args)
1141
1192
            self.checker.start()
1142
1193
            self.checker_callback_tag = GLib.io_add_watch(
1143
 
                pipe[0].fileno(), GLib.IO_IN,
 
1194
                GLib.IOChannel.unix_new(pipe[0].fileno()),
 
1195
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1144
1196
                self.checker_callback, pipe[0], command)
1145
1197
        # Re-run this periodically if run by GLib.timeout_add
1146
1198
        return True
1152
1204
            self.checker_callback_tag = None
1153
1205
        if getattr(self, "checker", None) is None:
1154
1206
            return
1155
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
1207
        log.debug("Stopping checker for %(name)s", vars(self))
1156
1208
        self.checker.terminate()
1157
1209
        self.checker = None
1158
1210
 
1185
1237
        func._dbus_name = func.__name__
1186
1238
        if func._dbus_name.endswith("_dbus_property"):
1187
1239
            func._dbus_name = func._dbus_name[:-14]
1188
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
 
1240
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
1189
1241
        return func
1190
1242
 
1191
1243
    return decorator
1280
1332
 
1281
1333
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1282
1334
                         out_signature="s",
1283
 
                         path_keyword='object_path',
1284
 
                         connection_keyword='connection')
 
1335
                         path_keyword="object_path",
 
1336
                         connection_keyword="connection")
1285
1337
    def Introspect(self, object_path, connection):
1286
1338
        """Overloading of standard D-Bus method.
1287
1339
 
1336
1388
            document.unlink()
1337
1389
        except (AttributeError, xml.dom.DOMException,
1338
1390
                xml.parsers.expat.ExpatError) as error:
1339
 
            logger.error("Failed to override Introspection method",
1340
 
                         exc_info=error)
 
1391
            log.error("Failed to override Introspection method",
 
1392
                      exc_info=error)
1341
1393
        return xmlstring
1342
1394
 
1343
1395
 
1401
1453
                raise ValueError("Byte arrays not supported for non-"
1402
1454
                                 "'ay' signature {!r}"
1403
1455
                                 .format(prop._dbus_signature))
1404
 
            value = dbus.ByteArray(b''.join(chr(byte)
1405
 
                                            for byte in value))
 
1456
            value = dbus.ByteArray(bytes(value))
1406
1457
        prop(value)
1407
1458
 
1408
1459
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1441
1492
 
1442
1493
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1443
1494
                         out_signature="s",
1444
 
                         path_keyword='object_path',
1445
 
                         connection_keyword='connection')
 
1495
                         path_keyword="object_path",
 
1496
                         connection_keyword="connection")
1446
1497
    def Introspect(self, object_path, connection):
1447
1498
        """Overloading of standard D-Bus method.
1448
1499
 
1504
1555
            document.unlink()
1505
1556
        except (AttributeError, xml.dom.DOMException,
1506
1557
                xml.parsers.expat.ExpatError) as error:
1507
 
            logger.error("Failed to override Introspection method",
1508
 
                         exc_info=error)
 
1558
            log.error("Failed to override Introspection method",
 
1559
                      exc_info=error)
1509
1560
        return xmlstring
1510
1561
 
1511
1562
 
1543
1594
 
1544
1595
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1545
1596
                         out_signature="s",
1546
 
                         path_keyword='object_path',
1547
 
                         connection_keyword='connection')
 
1597
                         path_keyword="object_path",
 
1598
                         connection_keyword="connection")
1548
1599
    def Introspect(self, object_path, connection):
1549
1600
        """Overloading of standard D-Bus method.
1550
1601
 
1575
1626
            document.unlink()
1576
1627
        except (AttributeError, xml.dom.DOMException,
1577
1628
                xml.parsers.expat.ExpatError) as error:
1578
 
            logger.error("Failed to override Introspection method",
1579
 
                         exc_info=error)
 
1629
            log.error("Failed to override Introspection method",
 
1630
                      exc_info=error)
1580
1631
        return xmlstring
1581
1632
 
1582
1633
 
2213
2264
    del _interface
2214
2265
 
2215
2266
 
2216
 
class ProxyClient(object):
 
2267
class ProxyClient:
2217
2268
    def __init__(self, child_pipe, key_id, fpr, address):
2218
2269
        self._pipe = child_pipe
2219
 
        self._pipe.send(('init', key_id, fpr, address))
 
2270
        self._pipe.send(("init", key_id, fpr, address))
2220
2271
        if not self._pipe.recv():
2221
2272
            raise KeyError(key_id or fpr)
2222
2273
 
2223
2274
    def __getattribute__(self, name):
2224
 
        if name == '_pipe':
 
2275
        if name == "_pipe":
2225
2276
            return super(ProxyClient, self).__getattribute__(name)
2226
 
        self._pipe.send(('getattr', name))
 
2277
        self._pipe.send(("getattr", name))
2227
2278
        data = self._pipe.recv()
2228
 
        if data[0] == 'data':
 
2279
        if data[0] == "data":
2229
2280
            return data[1]
2230
 
        if data[0] == 'function':
 
2281
        if data[0] == "function":
2231
2282
 
2232
2283
            def func(*args, **kwargs):
2233
 
                self._pipe.send(('funcall', name, args, kwargs))
 
2284
                self._pipe.send(("funcall", name, args, kwargs))
2234
2285
                return self._pipe.recv()[1]
2235
2286
 
2236
2287
            return func
2237
2288
 
2238
2289
    def __setattr__(self, name, value):
2239
 
        if name == '_pipe':
 
2290
        if name == "_pipe":
2240
2291
            return super(ProxyClient, self).__setattr__(name, value)
2241
 
        self._pipe.send(('setattr', name, value))
 
2292
        self._pipe.send(("setattr", name, value))
2242
2293
 
2243
2294
 
2244
2295
class ClientHandler(socketserver.BaseRequestHandler, object):
2249
2300
 
2250
2301
    def handle(self):
2251
2302
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2252
 
            logger.info("TCP connection from: %s",
2253
 
                        str(self.client_address))
2254
 
            logger.debug("Pipe FD: %d",
2255
 
                         self.server.child_pipe.fileno())
 
2303
            log.info("TCP connection from: %s",
 
2304
                     str(self.client_address))
 
2305
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2256
2306
 
2257
2307
            session = gnutls.ClientSession(self.request)
2258
2308
 
2259
 
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2309
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
2260
2310
            #                       "+AES-256-CBC", "+SHA1",
2261
2311
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2262
2312
            #                       "+DHE-DSS"))
2264
2314
            priority = self.server.gnutls_priority
2265
2315
            if priority is None:
2266
2316
                priority = "NORMAL"
2267
 
            gnutls.priority_set_direct(session._c_object,
2268
 
                                       priority.encode("utf-8"),
2269
 
                                       None)
 
2317
            gnutls.priority_set_direct(session,
 
2318
                                       priority.encode("utf-8"), None)
2270
2319
 
2271
2320
            # Start communication using the Mandos protocol
2272
2321
            # Get protocol number
2273
2322
            line = self.request.makefile().readline()
2274
 
            logger.debug("Protocol version: %r", line)
 
2323
            log.debug("Protocol version: %r", line)
2275
2324
            try:
2276
2325
                if int(line.strip().split()[0]) > 1:
2277
2326
                    raise RuntimeError(line)
2278
2327
            except (ValueError, IndexError, RuntimeError) as error:
2279
 
                logger.error("Unknown protocol version: %s", error)
 
2328
                log.error("Unknown protocol version: %s", error)
2280
2329
                return
2281
2330
 
2282
2331
            # Start GnuTLS connection
2283
2332
            try:
2284
2333
                session.handshake()
2285
2334
            except gnutls.Error as error:
2286
 
                logger.warning("Handshake failed: %s", error)
 
2335
                log.warning("Handshake failed: %s", error)
2287
2336
                # Do not run session.bye() here: the session is not
2288
2337
                # established.  Just abandon the request.
2289
2338
                return
2290
 
            logger.debug("Handshake succeeded")
 
2339
            log.debug("Handshake succeeded")
2291
2340
 
2292
2341
            approval_required = False
2293
2342
            try:
2297
2346
                        key_id = self.key_id(
2298
2347
                            self.peer_certificate(session))
2299
2348
                    except (TypeError, gnutls.Error) as error:
2300
 
                        logger.warning("Bad certificate: %s", error)
 
2349
                        log.warning("Bad certificate: %s", error)
2301
2350
                        return
2302
 
                    logger.debug("Key ID: %s", key_id)
 
2351
                    log.debug("Key ID: %s",
 
2352
                              key_id.decode("utf-8",
 
2353
                                            errors="replace"))
2303
2354
 
2304
2355
                else:
2305
2356
                    key_id = b""
2307
2358
                        fpr = self.fingerprint(
2308
2359
                            self.peer_certificate(session))
2309
2360
                    except (TypeError, gnutls.Error) as error:
2310
 
                        logger.warning("Bad certificate: %s", error)
 
2361
                        log.warning("Bad certificate: %s", error)
2311
2362
                        return
2312
 
                    logger.debug("Fingerprint: %s", fpr)
 
2363
                    log.debug("Fingerprint: %s", fpr)
2313
2364
 
2314
2365
                try:
2315
2366
                    client = ProxyClient(child_pipe, key_id, fpr,
2324
2375
 
2325
2376
                while True:
2326
2377
                    if not client.enabled:
2327
 
                        logger.info("Client %s is disabled",
2328
 
                                    client.name)
 
2378
                        log.info("Client %s is disabled", client.name)
2329
2379
                        if self.server.use_dbus:
2330
2380
                            # Emit D-Bus signal
2331
2381
                            client.Rejected("Disabled")
2335
2385
                        # We are approved or approval is disabled
2336
2386
                        break
2337
2387
                    elif client.approved is None:
2338
 
                        logger.info("Client %s needs approval",
2339
 
                                    client.name)
 
2388
                        log.info("Client %s needs approval",
 
2389
                                 client.name)
2340
2390
                        if self.server.use_dbus:
2341
2391
                            # Emit D-Bus signal
2342
2392
                            client.NeedApproval(
2343
2393
                                client.approval_delay.total_seconds()
2344
2394
                                * 1000, client.approved_by_default)
2345
2395
                    else:
2346
 
                        logger.warning("Client %s was not approved",
2347
 
                                       client.name)
 
2396
                        log.warning("Client %s was not approved",
 
2397
                                    client.name)
2348
2398
                        if self.server.use_dbus:
2349
2399
                            # Emit D-Bus signal
2350
2400
                            client.Rejected("Denied")
2358
2408
                    time2 = datetime.datetime.now()
2359
2409
                    if (time2 - time) >= delay:
2360
2410
                        if not client.approved_by_default:
2361
 
                            logger.warning("Client %s timed out while"
2362
 
                                           " waiting for approval",
2363
 
                                           client.name)
 
2411
                            log.warning("Client %s timed out while"
 
2412
                                        " waiting for approval",
 
2413
                                        client.name)
2364
2414
                            if self.server.use_dbus:
2365
2415
                                # Emit D-Bus signal
2366
2416
                                client.Rejected("Approval timed out")
2373
2423
                try:
2374
2424
                    session.send(client.secret)
2375
2425
                except gnutls.Error as error:
2376
 
                    logger.warning("gnutls send failed",
2377
 
                                   exc_info=error)
 
2426
                    log.warning("gnutls send failed", exc_info=error)
2378
2427
                    return
2379
2428
 
2380
 
                logger.info("Sending secret to %s", client.name)
 
2429
                log.info("Sending secret to %s", client.name)
2381
2430
                # bump the timeout using extended_timeout
2382
2431
                client.bump_timeout(client.extended_timeout)
2383
2432
                if self.server.use_dbus:
2390
2439
                try:
2391
2440
                    session.bye()
2392
2441
                except gnutls.Error as error:
2393
 
                    logger.warning("GnuTLS bye failed",
2394
 
                                   exc_info=error)
 
2442
                    log.warning("GnuTLS bye failed", exc_info=error)
2395
2443
 
2396
2444
    @staticmethod
2397
2445
    def peer_certificate(session):
2398
2446
        "Return the peer's certificate as a bytestring"
2399
2447
        try:
2400
 
            cert_type = gnutls.certificate_type_get2(session._c_object,
2401
 
                                                     gnutls.CTYPE_PEERS)
 
2448
            cert_type = gnutls.certificate_type_get2(
 
2449
                session, gnutls.CTYPE_PEERS)
2402
2450
        except AttributeError:
2403
 
            cert_type = gnutls.certificate_type_get(session._c_object)
 
2451
            cert_type = gnutls.certificate_type_get(session)
2404
2452
        if gnutls.has_rawpk:
2405
2453
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2406
2454
        else:
2407
2455
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2408
2456
        # If not a valid certificate type...
2409
2457
        if cert_type not in valid_cert_types:
2410
 
            logger.info("Cert type %r not in %r", cert_type,
2411
 
                        valid_cert_types)
 
2458
            log.info("Cert type %r not in %r", cert_type,
 
2459
                     valid_cert_types)
2412
2460
            # ...return invalid data
2413
2461
            return b""
2414
2462
        list_size = ctypes.c_uint(1)
2415
2463
        cert_list = (gnutls.certificate_get_peers
2416
 
                     (session._c_object, ctypes.byref(list_size)))
 
2464
                     (session, ctypes.byref(list_size)))
2417
2465
        if not bool(cert_list) and list_size.value != 0:
2418
2466
            raise gnutls.Error("error getting peer certificate")
2419
2467
        if list_size.value == 0:
2441
2489
        buf = ctypes.create_string_buffer(32)
2442
2490
        buf_len = ctypes.c_size_t(len(buf))
2443
2491
        # Get the key ID from the raw public key into the buffer
2444
 
        gnutls.pubkey_get_key_id(pubkey,
2445
 
                                 gnutls.KEYID_USE_SHA256,
2446
 
                                 ctypes.cast(ctypes.byref(buf),
2447
 
                                             ctypes.POINTER(ctypes.c_ubyte)),
2448
 
                                 ctypes.byref(buf_len))
 
2492
        gnutls.pubkey_get_key_id(
 
2493
            pubkey,
 
2494
            gnutls.KEYID_USE_SHA256,
 
2495
            ctypes.cast(ctypes.byref(buf),
 
2496
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2497
            ctypes.byref(buf_len))
2449
2498
        # Deinit the certificate
2450
2499
        gnutls.pubkey_deinit(pubkey)
2451
2500
 
2492
2541
        return hex_fpr
2493
2542
 
2494
2543
 
2495
 
class MultiprocessingMixIn(object):
 
2544
class MultiprocessingMixIn:
2496
2545
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2497
2546
 
2498
2547
    def sub_process_main(self, request, address):
2510
2559
        return proc
2511
2560
 
2512
2561
 
2513
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
2562
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2514
2563
    """ adds a pipe to the MixIn """
2515
2564
 
2516
2565
    def process_request(self, request, client_address):
2531
2580
 
2532
2581
 
2533
2582
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2534
 
                     socketserver.TCPServer, object):
2535
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
2583
                     socketserver.TCPServer):
 
2584
    """IPv6-capable TCP server.  Accepts None as address and/or port
2536
2585
 
2537
2586
    Attributes:
2538
2587
        enabled:        Boolean; whether this server is activated yet
2589
2638
            if SO_BINDTODEVICE is None:
2590
2639
                # Fall back to a hard-coded value which seems to be
2591
2640
                # common enough.
2592
 
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2641
                log.warning("SO_BINDTODEVICE not found, trying 25")
2593
2642
                SO_BINDTODEVICE = 25
2594
2643
            try:
2595
2644
                self.socket.setsockopt(
2597
2646
                    (self.interface + "\0").encode("utf-8"))
2598
2647
            except socket.error as error:
2599
2648
                if error.errno == errno.EPERM:
2600
 
                    logger.error("No permission to bind to"
2601
 
                                 " interface %s", self.interface)
 
2649
                    log.error("No permission to bind to interface %s",
 
2650
                              self.interface)
2602
2651
                elif error.errno == errno.ENOPROTOOPT:
2603
 
                    logger.error("SO_BINDTODEVICE not available;"
2604
 
                                 " cannot bind to interface %s",
2605
 
                                 self.interface)
 
2652
                    log.error("SO_BINDTODEVICE not available; cannot"
 
2653
                              " bind to interface %s", self.interface)
2606
2654
                elif error.errno == errno.ENODEV:
2607
 
                    logger.error("Interface %s does not exist,"
2608
 
                                 " cannot bind", self.interface)
 
2655
                    log.error("Interface %s does not exist, cannot"
 
2656
                              " bind", self.interface)
2609
2657
                else:
2610
2658
                    raise
2611
2659
        # Only bind(2) the socket if we really need to.
2670
2718
    def add_pipe(self, parent_pipe, proc):
2671
2719
        # Call "handle_ipc" for both data and EOF events
2672
2720
        GLib.io_add_watch(
2673
 
            parent_pipe.fileno(),
2674
 
            GLib.IO_IN | GLib.IO_HUP,
 
2721
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2722
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2675
2723
            functools.partial(self.handle_ipc,
2676
2724
                              parent_pipe=parent_pipe,
2677
2725
                              proc=proc))
2690
2738
        request = parent_pipe.recv()
2691
2739
        command = request[0]
2692
2740
 
2693
 
        if command == 'init':
 
2741
        if command == "init":
2694
2742
            key_id = request[1].decode("ascii")
2695
2743
            fpr = request[2].decode("ascii")
2696
2744
            address = request[3]
2697
2745
 
2698
2746
            for c in self.clients.values():
2699
 
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
 
2747
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
 
2748
                              "27AE41E4649B934CA495991B7852B855"):
2700
2749
                    continue
2701
2750
                if key_id and c.key_id == key_id:
2702
2751
                    client = c
2705
2754
                    client = c
2706
2755
                    break
2707
2756
            else:
2708
 
                logger.info("Client not found for key ID: %s, address"
2709
 
                            ": %s", key_id or fpr, address)
 
2757
                log.info("Client not found for key ID: %s, address:"
 
2758
                         " %s", key_id or fpr, address)
2710
2759
                if self.use_dbus:
2711
2760
                    # Emit D-Bus signal
2712
2761
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2715
2764
                return False
2716
2765
 
2717
2766
            GLib.io_add_watch(
2718
 
                parent_pipe.fileno(),
2719
 
                GLib.IO_IN | GLib.IO_HUP,
 
2767
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2768
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2720
2769
                functools.partial(self.handle_ipc,
2721
2770
                                  parent_pipe=parent_pipe,
2722
2771
                                  proc=proc,
2725
2774
            # remove the old hook in favor of the new above hook on
2726
2775
            # same fileno
2727
2776
            return False
2728
 
        if command == 'funcall':
 
2777
        if command == "funcall":
2729
2778
            funcname = request[1]
2730
2779
            args = request[2]
2731
2780
            kwargs = request[3]
2732
2781
 
2733
 
            parent_pipe.send(('data', getattr(client_object,
 
2782
            parent_pipe.send(("data", getattr(client_object,
2734
2783
                                              funcname)(*args,
2735
2784
                                                        **kwargs)))
2736
2785
 
2737
 
        if command == 'getattr':
 
2786
        if command == "getattr":
2738
2787
            attrname = request[1]
2739
2788
            if isinstance(client_object.__getattribute__(attrname),
2740
 
                          collections.Callable):
2741
 
                parent_pipe.send(('function', ))
 
2789
                          collections.abc.Callable):
 
2790
                parent_pipe.send(("function", ))
2742
2791
            else:
2743
2792
                parent_pipe.send((
2744
 
                    'data', client_object.__getattribute__(attrname)))
 
2793
                    "data", client_object.__getattribute__(attrname)))
2745
2794
 
2746
 
        if command == 'setattr':
 
2795
        if command == "setattr":
2747
2796
            attrname = request[1]
2748
2797
            value = request[2]
2749
2798
            setattr(client_object, attrname, value)
2754
2803
def rfc3339_duration_to_delta(duration):
2755
2804
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2756
2805
 
2757
 
    >>> rfc3339_duration_to_delta("P7D")
2758
 
    datetime.timedelta(7)
2759
 
    >>> rfc3339_duration_to_delta("PT60S")
2760
 
    datetime.timedelta(0, 60)
2761
 
    >>> rfc3339_duration_to_delta("PT60M")
2762
 
    datetime.timedelta(0, 3600)
2763
 
    >>> rfc3339_duration_to_delta("PT24H")
2764
 
    datetime.timedelta(1)
2765
 
    >>> rfc3339_duration_to_delta("P1W")
2766
 
    datetime.timedelta(7)
2767
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2768
 
    datetime.timedelta(0, 330)
2769
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2770
 
    datetime.timedelta(1, 200)
 
2806
    >>> timedelta = datetime.timedelta
 
2807
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
 
2808
    True
 
2809
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
 
2810
    True
 
2811
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
 
2812
    True
 
2813
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
 
2814
    True
 
2815
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
 
2816
    True
 
2817
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
 
2818
    True
 
2819
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
 
2820
    True
 
2821
    >>> del timedelta
2771
2822
    """
2772
2823
 
2773
2824
    # Parsing an RFC 3339 duration with regular expressions is not
2853
2904
def string_to_delta(interval):
2854
2905
    """Parse a string and return a datetime.timedelta
2855
2906
 
2856
 
    >>> string_to_delta('7d')
2857
 
    datetime.timedelta(7)
2858
 
    >>> string_to_delta('60s')
2859
 
    datetime.timedelta(0, 60)
2860
 
    >>> string_to_delta('60m')
2861
 
    datetime.timedelta(0, 3600)
2862
 
    >>> string_to_delta('24h')
2863
 
    datetime.timedelta(1)
2864
 
    >>> string_to_delta('1w')
2865
 
    datetime.timedelta(7)
2866
 
    >>> string_to_delta('5m 30s')
2867
 
    datetime.timedelta(0, 330)
 
2907
    >>> 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)
 
2918
    True
2868
2919
    """
2869
2920
 
2870
2921
    try:
2972
3023
 
2973
3024
    options = parser.parse_args()
2974
3025
 
2975
 
    if options.check:
2976
 
        import doctest
2977
 
        fail_count, test_count = doctest.testmod()
2978
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2979
 
 
2980
3026
    # Default values for config file for server-global settings
2981
3027
    if gnutls.has_rawpk:
2982
3028
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3078
3124
 
3079
3125
    if server_settings["servicename"] != "Mandos":
3080
3126
        syslogger.setFormatter(
3081
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
3082
 
                              ' %(levelname)s: %(message)s'.format(
 
3127
            logging.Formatter("Mandos ({}) [%(process)d]:"
 
3128
                              " %(levelname)s: %(message)s".format(
3083
3129
                                  server_settings["servicename"])))
3084
3130
 
3085
3131
    # Parse config file with clients
3109
3155
        try:
3110
3156
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3111
3157
        except IOError as e:
3112
 
            logger.error("Could not open file %r", pidfilename,
3113
 
                         exc_info=e)
 
3158
            log.error("Could not open file %r", pidfilename,
 
3159
                      exc_info=e)
3114
3160
 
3115
3161
    for name, group in (("_mandos", "_mandos"),
3116
3162
                        ("mandos", "mandos"),
3127
3173
    try:
3128
3174
        os.setgid(gid)
3129
3175
        os.setuid(uid)
3130
 
        if debug:
3131
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3132
 
                                                             gid))
 
3176
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
3133
3177
    except OSError as error:
3134
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
3135
 
                       .format(uid, gid, os.strerror(error.errno)))
 
3178
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
 
3179
                    os.strerror(error.errno))
3136
3180
        if error.errno != errno.EPERM:
3137
3181
            raise
3138
3182
 
3145
3189
 
3146
3190
        @gnutls.log_func
3147
3191
        def debug_gnutls(level, string):
3148
 
            logger.debug("GnuTLS: %s", string[:-1])
 
3192
            log.debug("GnuTLS: %s",
 
3193
                      string[:-1].decode("utf-8", errors="replace"))
3149
3194
 
3150
3195
        gnutls.global_set_log_function(debug_gnutls)
3151
3196
 
3180
3225
                "se.bsnet.fukt.Mandos", bus,
3181
3226
                do_not_queue=True)
3182
3227
        except dbus.exceptions.DBusException as e:
3183
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
3228
            log.error("Disabling D-Bus:", exc_info=e)
3184
3229
            use_dbus = False
3185
3230
            server_settings["use_dbus"] = False
3186
3231
            tcp_server.use_dbus = False
3245
3290
                             if isinstance(s, bytes)
3246
3291
                             else s) for s in
3247
3292
                            value["client_structure"]]
3248
 
                        # .name & .host
3249
 
                        for k in ("name", "host"):
 
3293
                        # .name, .host, and .checker_command
 
3294
                        for k in ("name", "host", "checker_command"):
3250
3295
                            if isinstance(value[k], bytes):
3251
3296
                                value[k] = value[k].decode("utf-8")
3252
3297
                        if "key_id" not in value:
3262
3307
                        for key, value in
3263
3308
                        bytes_old_client_settings.items()}
3264
3309
                    del bytes_old_client_settings
3265
 
                    # .host
 
3310
                    # .host and .checker_command
3266
3311
                    for value in old_client_settings.values():
3267
 
                        if isinstance(value["host"], bytes):
3268
 
                            value["host"] = (value["host"]
3269
 
                                             .decode("utf-8"))
 
3312
                        for attribute in ("host", "checker_command"):
 
3313
                            if isinstance(value[attribute], bytes):
 
3314
                                value[attribute] = (value[attribute]
 
3315
                                                    .decode("utf-8"))
3270
3316
            os.remove(stored_state_path)
3271
3317
        except IOError as e:
3272
3318
            if e.errno == errno.ENOENT:
3273
 
                logger.warning("Could not load persistent state:"
3274
 
                               " {}".format(os.strerror(e.errno)))
 
3319
                log.warning("Could not load persistent state:"
 
3320
                            " %s", os.strerror(e.errno))
3275
3321
            else:
3276
 
                logger.critical("Could not load persistent state:",
3277
 
                                exc_info=e)
 
3322
                log.critical("Could not load persistent state:",
 
3323
                             exc_info=e)
3278
3324
                raise
3279
3325
        except EOFError as e:
3280
 
            logger.warning("Could not load persistent state: "
3281
 
                           "EOFError:",
3282
 
                           exc_info=e)
 
3326
            log.warning("Could not load persistent state: EOFError:",
 
3327
                        exc_info=e)
3283
3328
 
3284
3329
    with PGPEngine() as pgp:
3285
3330
        for client_name, client in clients_data.items():
3312
3357
            if client["enabled"]:
3313
3358
                if datetime.datetime.utcnow() >= client["expires"]:
3314
3359
                    if not client["last_checked_ok"]:
3315
 
                        logger.warning(
3316
 
                            "disabling client {} - Client never "
3317
 
                            "performed a successful checker".format(
3318
 
                                client_name))
 
3360
                        log.warning("disabling client %s - Client"
 
3361
                                    " never performed a successful"
 
3362
                                    " checker", client_name)
3319
3363
                        client["enabled"] = False
3320
3364
                    elif client["last_checker_status"] != 0:
3321
 
                        logger.warning(
3322
 
                            "disabling client {} - Client last"
3323
 
                            " checker failed with error code"
3324
 
                            " {}".format(
3325
 
                                client_name,
3326
 
                                client["last_checker_status"]))
 
3365
                        log.warning("disabling client %s - Client"
 
3366
                                    " last checker failed with error"
 
3367
                                    " code %s", client_name,
 
3368
                                    client["last_checker_status"])
3327
3369
                        client["enabled"] = False
3328
3370
                    else:
3329
3371
                        client["expires"] = (
3330
3372
                            datetime.datetime.utcnow()
3331
3373
                            + client["timeout"])
3332
 
                        logger.debug("Last checker succeeded,"
3333
 
                                     " keeping {} enabled".format(
3334
 
                                         client_name))
 
3374
                        log.debug("Last checker succeeded, keeping %s"
 
3375
                                  " enabled", client_name)
3335
3376
            try:
3336
3377
                client["secret"] = pgp.decrypt(
3337
3378
                    client["encrypted_secret"],
3338
3379
                    client_settings[client_name]["secret"])
3339
3380
            except PGPError:
3340
3381
                # If decryption fails, we use secret from new settings
3341
 
                logger.debug("Failed to decrypt {} old secret".format(
3342
 
                    client_name))
 
3382
                log.debug("Failed to decrypt %s old secret",
 
3383
                          client_name)
3343
3384
                client["secret"] = (client_settings[client_name]
3344
3385
                                    ["secret"])
3345
3386
 
3359
3400
            server_settings=server_settings)
3360
3401
 
3361
3402
    if not tcp_server.clients:
3362
 
        logger.warning("No clients defined")
 
3403
        log.warning("No clients defined")
3363
3404
 
3364
3405
    if not foreground:
3365
3406
        if pidfile is not None:
3368
3409
                with pidfile:
3369
3410
                    print(pid, file=pidfile)
3370
3411
            except IOError:
3371
 
                logger.error("Could not write to file %r with PID %d",
3372
 
                             pidfilename, pid)
 
3412
                log.error("Could not write to file %r with PID %d",
 
3413
                          pidfilename, pid)
3373
3414
        del pidfile
3374
3415
        del pidfilename
3375
3416
 
3525
3566
 
3526
3567
        try:
3527
3568
            with tempfile.NamedTemporaryFile(
3528
 
                    mode='wb',
 
3569
                    mode="wb",
3529
3570
                    suffix=".pickle",
3530
 
                    prefix='clients-',
 
3571
                    prefix="clients-",
3531
3572
                    dir=os.path.dirname(stored_state_path),
3532
3573
                    delete=False) as stored_state:
3533
3574
                pickle.dump((clients, client_settings), stored_state,
3541
3582
                except NameError:
3542
3583
                    pass
3543
3584
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3544
 
                logger.warning("Could not save persistent state: {}"
3545
 
                               .format(os.strerror(e.errno)))
 
3585
                log.warning("Could not save persistent state: %s",
 
3586
                            os.strerror(e.errno))
3546
3587
            else:
3547
 
                logger.warning("Could not save persistent state:",
3548
 
                               exc_info=e)
 
3588
                log.warning("Could not save persistent state:",
 
3589
                            exc_info=e)
3549
3590
                raise
3550
3591
 
3551
3592
        # Delete all clients, and settings from config
3577
3618
    if zeroconf:
3578
3619
        service.port = tcp_server.socket.getsockname()[1]
3579
3620
    if use_ipv6:
3580
 
        logger.info("Now listening on address %r, port %d,"
3581
 
                    " flowinfo %d, scope_id %d",
3582
 
                    *tcp_server.socket.getsockname())
 
3621
        log.info("Now listening on address %r, port %d, flowinfo %d,"
 
3622
                 " scope_id %d", *tcp_server.socket.getsockname())
3583
3623
    else:                       # IPv4
3584
 
        logger.info("Now listening on address %r, port %d",
3585
 
                    *tcp_server.socket.getsockname())
 
3624
        log.info("Now listening on address %r, port %d",
 
3625
                 *tcp_server.socket.getsockname())
3586
3626
 
3587
3627
    # service.interface = tcp_server.socket.getsockname()[3]
3588
3628
 
3592
3632
            try:
3593
3633
                service.activate()
3594
3634
            except dbus.exceptions.DBusException as error:
3595
 
                logger.critical("D-Bus Exception", exc_info=error)
 
3635
                log.critical("D-Bus Exception", exc_info=error)
3596
3636
                cleanup()
3597
3637
                sys.exit(1)
3598
3638
            # End of Avahi example code
3599
3639
 
3600
 
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3601
 
                          lambda *args, **kwargs:
3602
 
                          (tcp_server.handle_request
3603
 
                           (*args[2:], **kwargs) or True))
 
3640
        GLib.io_add_watch(
 
3641
            GLib.IOChannel.unix_new(tcp_server.fileno()),
 
3642
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
3643
            lambda *args, **kwargs: (tcp_server.handle_request
 
3644
                                     (*args[2:], **kwargs) or True))
3604
3645
 
3605
 
        logger.debug("Starting main loop")
 
3646
        log.debug("Starting main loop")
3606
3647
        main_loop.run()
3607
3648
    except AvahiError as error:
3608
 
        logger.critical("Avahi Error", exc_info=error)
 
3649
        log.critical("Avahi Error", exc_info=error)
3609
3650
        cleanup()
3610
3651
        sys.exit(1)
3611
3652
    except KeyboardInterrupt:
3612
3653
        if debug:
3613
3654
            print("", file=sys.stderr)
3614
 
        logger.debug("Server received KeyboardInterrupt")
3615
 
    logger.debug("Server exiting")
 
3655
        log.debug("Server received KeyboardInterrupt")
 
3656
    log.debug("Server exiting")
3616
3657
    # Must run before the D-Bus bus name gets deregistered
3617
3658
    cleanup()
3618
3659
 
3619
 
 
3620
 
if __name__ == '__main__':
3621
 
    main()
 
3660
 
 
3661
def parse_test_args():
 
3662
    # type: () -> argparse.Namespace
 
3663
    parser = argparse.ArgumentParser(add_help=False)
 
3664
    parser.add_argument("--check", action="store_true")
 
3665
    parser.add_argument("--prefix", )
 
3666
    args, unknown_args = parser.parse_known_args()
 
3667
    if args.check:
 
3668
        # Remove test options from sys.argv
 
3669
        sys.argv[1:] = unknown_args
 
3670
    return args
 
3671
 
 
3672
# Add all tests from doctest strings
 
3673
def load_tests(loader, tests, none):
 
3674
    import doctest
 
3675
    tests.addTests(doctest.DocTestSuite())
 
3676
    return tests
 
3677
 
 
3678
if __name__ == "__main__":
 
3679
    options = parse_test_args()
 
3680
    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=[""])
 
3693
        else:
 
3694
            main()
 
3695
    finally:
 
3696
        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: