/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: 2024-09-08 17:40:26 UTC
  • Revision ID: teddy@recompile.se-20240908174026-yk98lyrpr0phsck1
Fix minor deprecated syntax issue in debian/control

The << syntax should be preferred to the deprecated < notation.

* debian/control (Source: mandos/Build-Depends): Change from having
  "systemd (< 256~rc2-1)" to "systemd (<< 256~rc2-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
90
92
 
91
93
if sys.version_info.major == 2:
92
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")
93
117
 
94
118
# Try to find the value of SO_BINDTODEVICE:
95
119
try:
116
140
            # No value found
117
141
            SO_BINDTODEVICE = None
118
142
 
119
 
if sys.version_info.major == 2:
120
 
    str = unicode
121
 
 
122
143
if sys.version_info < (3, 2):
123
144
    configparser.Configparser = configparser.SafeConfigParser
124
145
 
125
 
version = "1.8.7"
 
146
version = "1.8.16"
126
147
stored_state_file = "clients.pickle"
127
148
 
128
 
logger = logging.getLogger()
 
149
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
150
logging.captureWarnings(True)   # Show warnings via the logging system
129
151
syslogger = None
130
152
 
131
153
try:
167
189
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
168
190
        address="/dev/log"))
169
191
    syslogger.setFormatter(logging.Formatter
170
 
                           ('Mandos [%(process)d]: %(levelname)s:'
171
 
                            ' %(message)s'))
172
 
    logger.addHandler(syslogger)
 
192
                           ("Mandos [%(process)d]: %(levelname)s:"
 
193
                            " %(message)s"))
 
194
    log.addHandler(syslogger)
173
195
 
174
196
    if debug:
175
197
        console = logging.StreamHandler()
176
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
177
 
                                               ' [%(process)d]:'
178
 
                                               ' %(levelname)s:'
179
 
                                               ' %(message)s'))
180
 
        logger.addHandler(console)
181
 
    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)
182
204
 
183
205
 
184
206
class PGPError(Exception):
196
218
            output = subprocess.check_output(["gpgconf"])
197
219
            for line in output.splitlines():
198
220
                name, text, path = line.split(b":")
199
 
                if name == "gpg":
 
221
                if name == b"gpg":
200
222
                    self.gpg = path
201
223
                    break
202
224
        except OSError as e:
203
225
            if e.errno != errno.ENOENT:
204
226
                raise
205
 
        self.gnupgargs = ['--batch',
206
 
                          '--homedir', self.tempdir,
207
 
                          '--force-mdc',
208
 
                          '--quiet']
 
227
        self.gnupgargs = ["--batch",
 
228
                          "--homedir", self.tempdir,
 
229
                          "--force-mdc",
 
230
                          "--quiet"]
209
231
        # Only GPG version 1 has the --no-use-agent option.
210
 
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
232
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
211
233
            self.gnupgargs.append("--no-use-agent")
212
234
 
213
235
    def __enter__(self):
250
272
                dir=self.tempdir) as passfile:
251
273
            passfile.write(passphrase)
252
274
            passfile.flush()
253
 
            proc = subprocess.Popen([self.gpg, '--symmetric',
254
 
                                     '--passphrase-file',
 
275
            proc = subprocess.Popen([self.gpg, "--symmetric",
 
276
                                     "--passphrase-file",
255
277
                                     passfile.name]
256
278
                                    + self.gnupgargs,
257
279
                                    stdin=subprocess.PIPE,
268
290
                dir=self.tempdir) as passfile:
269
291
            passfile.write(passphrase)
270
292
            passfile.flush()
271
 
            proc = subprocess.Popen([self.gpg, '--decrypt',
272
 
                                     '--passphrase-file',
 
293
            proc = subprocess.Popen([self.gpg, "--decrypt",
 
294
                                     "--passphrase-file",
273
295
                                     passfile.name]
274
296
                                    + self.gnupgargs,
275
297
                                    stdin=subprocess.PIPE,
328
350
    Attributes:
329
351
    interface: integer; avahi.IF_UNSPEC or an interface index.
330
352
               Used to optionally bind to the specified interface.
331
 
    name: string; Example: 'Mandos'
332
 
    type: string; Example: '_mandos._tcp'.
 
353
    name: string; Example: "Mandos"
 
354
    type: string; Example: "_mandos._tcp".
333
355
     See <https://www.iana.org/assignments/service-names-port-numbers>
334
356
    port: integer; what port to announce
335
357
    TXT: list of strings; TXT record for the service
372
394
    def rename(self, remove=True):
373
395
        """Derived from the Avahi example code"""
374
396
        if self.rename_count >= self.max_renames:
375
 
            logger.critical("No suitable Zeroconf service name found"
376
 
                            " after %i retries, exiting.",
377
 
                            self.rename_count)
 
397
            log.critical("No suitable Zeroconf service name found"
 
398
                         " after %i retries, exiting.",
 
399
                         self.rename_count)
378
400
            raise AvahiServiceError("Too many renames")
379
401
        self.name = str(
380
402
            self.server.GetAlternativeServiceName(self.name))
381
403
        self.rename_count += 1
382
 
        logger.info("Changing Zeroconf service name to %r ...",
383
 
                    self.name)
 
404
        log.info("Changing Zeroconf service name to %r ...",
 
405
                 self.name)
384
406
        if remove:
385
407
            self.remove()
386
408
        try:
388
410
        except dbus.exceptions.DBusException as error:
389
411
            if (error.get_dbus_name()
390
412
                == "org.freedesktop.Avahi.CollisionError"):
391
 
                logger.info("Local Zeroconf service name collision.")
 
413
                log.info("Local Zeroconf service name collision.")
392
414
                return self.rename(remove=False)
393
415
            else:
394
 
                logger.critical("D-Bus Exception", exc_info=error)
 
416
                log.critical("D-Bus Exception", exc_info=error)
395
417
                self.cleanup()
396
418
                os._exit(1)
397
419
 
413
435
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
414
436
        self.entry_group_state_changed_match = (
415
437
            self.group.connect_to_signal(
416
 
                'StateChanged', self.entry_group_state_changed))
417
 
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
418
 
                     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)
419
441
        self.group.AddService(
420
442
            self.interface,
421
443
            self.protocol,
428
450
 
429
451
    def entry_group_state_changed(self, state, error):
430
452
        """Derived from the Avahi example code"""
431
 
        logger.debug("Avahi entry group state change: %i", state)
 
453
        log.debug("Avahi entry group state change: %i", state)
432
454
 
433
455
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
434
 
            logger.debug("Zeroconf service established.")
 
456
            log.debug("Zeroconf service established.")
435
457
        elif state == avahi.ENTRY_GROUP_COLLISION:
436
 
            logger.info("Zeroconf service name collision.")
 
458
            log.info("Zeroconf service name collision.")
437
459
            self.rename()
438
460
        elif state == avahi.ENTRY_GROUP_FAILURE:
439
 
            logger.critical("Avahi: Error in group state changed %s",
440
 
                            str(error))
 
461
            log.critical("Avahi: Error in group state changed %s",
 
462
                         str(error))
441
463
            raise AvahiGroupError("State changed: {!s}".format(error))
442
464
 
443
465
    def cleanup(self):
453
475
 
454
476
    def server_state_changed(self, state, error=None):
455
477
        """Derived from the Avahi example code"""
456
 
        logger.debug("Avahi server state change: %i", state)
 
478
        log.debug("Avahi server state change: %i", state)
457
479
        bad_states = {
458
480
            avahi.SERVER_INVALID: "Zeroconf server invalid",
459
481
            avahi.SERVER_REGISTERING: None,
463
485
        if state in bad_states:
464
486
            if bad_states[state] is not None:
465
487
                if error is None:
466
 
                    logger.error(bad_states[state])
 
488
                    log.error(bad_states[state])
467
489
                else:
468
 
                    logger.error(bad_states[state] + ": %r", error)
 
490
                    log.error(bad_states[state] + ": %r", error)
469
491
            self.cleanup()
470
492
        elif state == avahi.SERVER_RUNNING:
471
493
            try:
473
495
            except dbus.exceptions.DBusException as error:
474
496
                if (error.get_dbus_name()
475
497
                    == "org.freedesktop.Avahi.CollisionError"):
476
 
                    logger.info("Local Zeroconf service name"
477
 
                                " collision.")
 
498
                    log.info("Local Zeroconf service name collision.")
478
499
                    return self.rename(remove=False)
479
500
                else:
480
 
                    logger.critical("D-Bus Exception", exc_info=error)
 
501
                    log.critical("D-Bus Exception", exc_info=error)
481
502
                    self.cleanup()
482
503
                    os._exit(1)
483
504
        else:
484
505
            if error is None:
485
 
                logger.debug("Unknown state: %r", state)
 
506
                log.debug("Unknown state: %r", state)
486
507
            else:
487
 
                logger.debug("Unknown state: %r: %r", state, error)
 
508
                log.debug("Unknown state: %r: %r", state, error)
488
509
 
489
510
    def activate(self):
490
511
        """Derived from the Avahi example code"""
502
523
class AvahiServiceToSyslog(AvahiService):
503
524
    def rename(self, *args, **kwargs):
504
525
        """Add the new name to the syslog messages"""
505
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
526
        ret = super(AvahiServiceToSyslog, self).rename(*args,
 
527
                                                       **kwargs)
506
528
        syslogger.setFormatter(logging.Formatter(
507
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
529
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
508
530
            .format(self.name)))
509
531
        return ret
510
532
 
540
562
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
541
563
 
542
564
    # Types
543
 
    class session_int(ctypes.Structure):
 
565
    class _session_int(ctypes.Structure):
544
566
        _fields_ = []
545
 
    session_t = ctypes.POINTER(session_int)
 
567
    session_t = ctypes.POINTER(_session_int)
546
568
 
547
569
    class certificate_credentials_st(ctypes.Structure):
548
570
        _fields_ = []
551
573
    certificate_type_t = ctypes.c_int
552
574
 
553
575
    class datum_t(ctypes.Structure):
554
 
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
555
 
                    ('size', ctypes.c_uint)]
 
576
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
 
577
                    ("size", ctypes.c_uint)]
556
578
 
557
 
    class openpgp_crt_int(ctypes.Structure):
 
579
    class _openpgp_crt_int(ctypes.Structure):
558
580
        _fields_ = []
559
 
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
581
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
560
582
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
561
583
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
562
584
    credentials_type_t = ctypes.c_int
571
593
            # gnutls.strerror()
572
594
            self.code = code
573
595
            if message is None and code is not None:
574
 
                message = gnutls.strerror(code)
 
596
                message = gnutls.strerror(code).decode(
 
597
                    "utf-8", errors="replace")
575
598
            return super(gnutls.Error, self).__init__(
576
599
                message, *args)
577
600
 
578
601
    class CertificateSecurityError(Error):
579
602
        pass
580
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
 
581
629
    # Classes
582
 
    class Credentials:
 
630
    class Credentials(With_from_param):
583
631
        def __init__(self):
584
 
            self._c_object = gnutls.certificate_credentials_t()
585
 
            gnutls.certificate_allocate_credentials(
586
 
                ctypes.byref(self._c_object))
 
632
            self._as_parameter_ = gnutls.certificate_credentials_t()
 
633
            gnutls.certificate_allocate_credentials(self)
587
634
            self.type = gnutls.CRD_CERTIFICATE
588
635
 
589
636
        def __del__(self):
590
 
            gnutls.certificate_free_credentials(self._c_object)
 
637
            gnutls.certificate_free_credentials(self)
591
638
 
592
 
    class ClientSession:
 
639
    class ClientSession(With_from_param):
593
640
        def __init__(self, socket, credentials=None):
594
 
            self._c_object = gnutls.session_t()
 
641
            self._as_parameter_ = gnutls.session_t()
595
642
            gnutls_flags = gnutls.CLIENT
596
643
            if gnutls.check_version(b"3.5.6"):
597
644
                gnutls_flags |= gnutls.NO_TICKETS
598
645
            if gnutls.has_rawpk:
599
646
                gnutls_flags |= gnutls.ENABLE_RAWPK
600
 
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
 
647
            gnutls.init(self, gnutls_flags)
601
648
            del gnutls_flags
602
 
            gnutls.set_default_priority(self._c_object)
603
 
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
604
 
            gnutls.handshake_set_private_extensions(self._c_object,
605
 
                                                    True)
 
649
            gnutls.set_default_priority(self)
 
650
            gnutls.transport_set_ptr(self, socket.fileno())
 
651
            gnutls.handshake_set_private_extensions(self, True)
606
652
            self.socket = socket
607
653
            if credentials is None:
608
654
                credentials = gnutls.Credentials()
609
 
            gnutls.credentials_set(self._c_object, credentials.type,
610
 
                                   ctypes.cast(credentials._c_object,
611
 
                                               ctypes.c_void_p))
 
655
            gnutls.credentials_set(self, credentials.type,
 
656
                                   credentials)
612
657
            self.credentials = credentials
613
658
 
614
659
        def __del__(self):
615
 
            gnutls.deinit(self._c_object)
 
660
            gnutls.deinit(self)
616
661
 
617
662
        def handshake(self):
618
 
            return gnutls.handshake(self._c_object)
 
663
            return gnutls.handshake(self)
619
664
 
620
665
        def send(self, data):
621
666
            data = bytes(data)
622
667
            data_len = len(data)
623
668
            while data_len > 0:
624
 
                data_len -= gnutls.record_send(self._c_object,
625
 
                                               data[-data_len:],
 
669
                data_len -= gnutls.record_send(self, data[-data_len:],
626
670
                                               data_len)
627
671
 
628
672
        def bye(self):
629
 
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
673
            return gnutls.bye(self, gnutls.SHUT_RDWR)
630
674
 
631
675
    # Error handling functions
632
676
    def _error_code(result):
633
677
        """A function to raise exceptions on errors, suitable
634
 
        for the 'restype' attribute on ctypes functions"""
635
 
        if result >= 0:
 
678
        for the "restype" attribute on ctypes functions"""
 
679
        if result >= gnutls.E_SUCCESS:
636
680
            return result
637
681
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
638
682
            raise gnutls.CertificateSecurityError(code=result)
639
683
        raise gnutls.Error(code=result)
640
684
 
641
 
    def _retry_on_error(result, func, arguments):
 
685
    def _retry_on_error(result, func, arguments,
 
686
                        _error_code=_error_code):
642
687
        """A function to retry on some errors, suitable
643
 
        for the 'errcheck' attribute on ctypes functions"""
644
 
        while result < 0:
 
688
        for the "errcheck" attribute on ctypes functions"""
 
689
        while result < gnutls.E_SUCCESS:
645
690
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
646
691
                return _error_code(result)
647
692
            result = func(*arguments)
652
697
 
653
698
    # Functions
654
699
    priority_set_direct = _library.gnutls_priority_set_direct
655
 
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
700
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
656
701
                                    ctypes.POINTER(ctypes.c_char_p)]
657
702
    priority_set_direct.restype = _error_code
658
703
 
659
704
    init = _library.gnutls_init
660
 
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
705
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
661
706
    init.restype = _error_code
662
707
 
663
708
    set_default_priority = _library.gnutls_set_default_priority
664
 
    set_default_priority.argtypes = [session_t]
 
709
    set_default_priority.argtypes = [ClientSession]
665
710
    set_default_priority.restype = _error_code
666
711
 
667
712
    record_send = _library.gnutls_record_send
668
 
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
713
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
669
714
                            ctypes.c_size_t]
670
715
    record_send.restype = ctypes.c_ssize_t
671
716
    record_send.errcheck = _retry_on_error
673
718
    certificate_allocate_credentials = (
674
719
        _library.gnutls_certificate_allocate_credentials)
675
720
    certificate_allocate_credentials.argtypes = [
676
 
        ctypes.POINTER(certificate_credentials_t)]
 
721
        PointerTo(Credentials)]
677
722
    certificate_allocate_credentials.restype = _error_code
678
723
 
679
724
    certificate_free_credentials = (
680
725
        _library.gnutls_certificate_free_credentials)
681
 
    certificate_free_credentials.argtypes = [
682
 
        certificate_credentials_t]
 
726
    certificate_free_credentials.argtypes = [Credentials]
683
727
    certificate_free_credentials.restype = None
684
728
 
685
729
    handshake_set_private_extensions = (
686
730
        _library.gnutls_handshake_set_private_extensions)
687
 
    handshake_set_private_extensions.argtypes = [session_t,
 
731
    handshake_set_private_extensions.argtypes = [ClientSession,
688
732
                                                 ctypes.c_int]
689
733
    handshake_set_private_extensions.restype = None
690
734
 
691
735
    credentials_set = _library.gnutls_credentials_set
692
 
    credentials_set.argtypes = [session_t, credentials_type_t,
693
 
                                ctypes.c_void_p]
 
736
    credentials_set.argtypes = [ClientSession, credentials_type_t,
 
737
                                CastToVoidPointer(Credentials)]
694
738
    credentials_set.restype = _error_code
695
739
 
696
740
    strerror = _library.gnutls_strerror
698
742
    strerror.restype = ctypes.c_char_p
699
743
 
700
744
    certificate_type_get = _library.gnutls_certificate_type_get
701
 
    certificate_type_get.argtypes = [session_t]
 
745
    certificate_type_get.argtypes = [ClientSession]
702
746
    certificate_type_get.restype = _error_code
703
747
 
704
748
    certificate_get_peers = _library.gnutls_certificate_get_peers
705
 
    certificate_get_peers.argtypes = [session_t,
 
749
    certificate_get_peers.argtypes = [ClientSession,
706
750
                                      ctypes.POINTER(ctypes.c_uint)]
707
751
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
708
752
 
715
759
    global_set_log_function.restype = None
716
760
 
717
761
    deinit = _library.gnutls_deinit
718
 
    deinit.argtypes = [session_t]
 
762
    deinit.argtypes = [ClientSession]
719
763
    deinit.restype = None
720
764
 
721
765
    handshake = _library.gnutls_handshake
722
 
    handshake.argtypes = [session_t]
723
 
    handshake.restype = _error_code
 
766
    handshake.argtypes = [ClientSession]
 
767
    handshake.restype = ctypes.c_int
724
768
    handshake.errcheck = _retry_on_error
725
769
 
726
770
    transport_set_ptr = _library.gnutls_transport_set_ptr
727
 
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
771
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
728
772
    transport_set_ptr.restype = None
729
773
 
730
774
    bye = _library.gnutls_bye
731
 
    bye.argtypes = [session_t, close_request_t]
732
 
    bye.restype = _error_code
 
775
    bye.argtypes = [ClientSession, close_request_t]
 
776
    bye.restype = ctypes.c_int
733
777
    bye.errcheck = _retry_on_error
734
778
 
735
779
    check_version = _library.gnutls_check_version
752
796
 
753
797
        x509_crt_fmt_t = ctypes.c_int
754
798
 
755
 
        # All the function declarations below are from gnutls/abstract.h
 
799
        # All the function declarations below are from
 
800
        # gnutls/abstract.h
756
801
        pubkey_init = _library.gnutls_pubkey_init
757
802
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
758
803
        pubkey_init.restype = _error_code
772
817
        pubkey_deinit.argtypes = [pubkey_t]
773
818
        pubkey_deinit.restype = None
774
819
    else:
775
 
        # All the function declarations below are from gnutls/openpgp.h
 
820
        # All the function declarations below are from
 
821
        # gnutls/openpgp.h
776
822
 
777
823
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
778
824
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
784
830
                                       openpgp_crt_fmt_t]
785
831
        openpgp_crt_import.restype = _error_code
786
832
 
787
 
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
788
 
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
789
 
                                            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
        ]
790
840
        openpgp_crt_verify_self.restype = _error_code
791
841
 
792
842
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
803
853
 
804
854
    if check_version(b"3.6.4"):
805
855
        certificate_type_get2 = _library.gnutls_certificate_type_get2
806
 
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
 
856
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
807
857
        certificate_type_get2.restype = _error_code
808
858
 
809
859
    # Remove non-public functions
825
875
    """A representation of a client host served by this server.
826
876
 
827
877
    Attributes:
828
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
878
    approved:   bool(); None if not yet approved/disapproved
829
879
    approval_delay: datetime.timedelta(); Time to wait for approval
830
880
    approval_duration: datetime.timedelta(); Duration of one approval
831
881
    checker: multiprocessing.Process(); a running checker process used
832
 
             to see if the client lives. 'None' if no process is
 
882
             to see if the client lives. None if no process is
833
883
             running.
834
884
    checker_callback_tag: a GLib event source tag, or None
835
885
    checker_command: string; External command which is run to check
911
961
            # key_id() and fingerprint() functions
912
962
            client["key_id"] = (section.get("key_id", "").upper()
913
963
                                .replace(" ", ""))
914
 
            client["fingerprint"] = (section["fingerprint"].upper()
 
964
            client["fingerprint"] = (section.get("fingerprint",
 
965
                                                 "").upper()
915
966
                                     .replace(" ", ""))
 
967
            if not (client["key_id"] or client["fingerprint"]):
 
968
                log.error("Skipping client %s without key_id or"
 
969
                          " fingerprint", client_name)
 
970
                del settings[client_name]
 
971
                continue
916
972
            if "secret" in section:
917
973
                client["secret"] = codecs.decode(section["secret"]
918
974
                                                 .encode("utf-8"),
959
1015
            self.last_enabled = None
960
1016
            self.expires = None
961
1017
 
962
 
        logger.debug("Creating client %r", self.name)
963
 
        logger.debug("  Key ID: %s", self.key_id)
964
 
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
1018
        log.debug("Creating client %r", self.name)
 
1019
        log.debug("  Key ID: %s", self.key_id)
 
1020
        log.debug("  Fingerprint: %s", self.fingerprint)
965
1021
        self.created = settings.get("created",
966
1022
                                    datetime.datetime.utcnow())
967
1023
 
995
1051
        if getattr(self, "enabled", False):
996
1052
            # Already enabled
997
1053
            return
998
 
        self.expires = datetime.datetime.utcnow() + self.timeout
999
1054
        self.enabled = True
1000
1055
        self.last_enabled = datetime.datetime.utcnow()
1001
1056
        self.init_checker()
1006
1061
        if not getattr(self, "enabled", False):
1007
1062
            return False
1008
1063
        if not quiet:
1009
 
            logger.info("Disabling client %s", self.name)
 
1064
            log.info("Disabling client %s", self.name)
1010
1065
        if getattr(self, "disable_initiator_tag", None) is not None:
1011
1066
            GLib.source_remove(self.disable_initiator_tag)
1012
1067
            self.disable_initiator_tag = None
1024
1079
    def __del__(self):
1025
1080
        self.disable()
1026
1081
 
1027
 
    def init_checker(self):
1028
 
        # Schedule a new checker to be started an 'interval' from now,
1029
 
        # and every interval from then on.
 
1082
    def init_checker(self, randomize_start=False):
 
1083
        # Schedule a new checker to be started a randomly selected
 
1084
        # time (a fraction of 'interval') from now.  This spreads out
 
1085
        # the startup of checkers over time when the server is
 
1086
        # started.
1030
1087
        if self.checker_initiator_tag is not None:
1031
1088
            GLib.source_remove(self.checker_initiator_tag)
 
1089
        interval_milliseconds = int(self.interval.total_seconds()
 
1090
                                    * 1000)
 
1091
        if randomize_start:
 
1092
            delay_milliseconds = random.randrange(
 
1093
                interval_milliseconds + 1)
 
1094
        else:
 
1095
            delay_milliseconds = interval_milliseconds
1032
1096
        self.checker_initiator_tag = GLib.timeout_add(
1033
 
            int(self.interval.total_seconds() * 1000),
1034
 
            self.start_checker)
1035
 
        # Schedule a disable() when 'timeout' has passed
 
1097
            delay_milliseconds, self.start_checker, randomize_start)
 
1098
        delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
 
1099
        # A checker might take up to an 'interval' of time, so we can
 
1100
        # expire at the soonest one interval after a checker was
 
1101
        # started.  Since the initial checker is delayed, the expire
 
1102
        # time might have to be extended.
 
1103
        now = datetime.datetime.utcnow()
 
1104
        self.expires = now + delay + self.interval
 
1105
        # Schedule a disable() at expire time
1036
1106
        if self.disable_initiator_tag is not None:
1037
1107
            GLib.source_remove(self.disable_initiator_tag)
1038
1108
        self.disable_initiator_tag = GLib.timeout_add(
1039
 
            int(self.timeout.total_seconds() * 1000), self.disable)
1040
 
        # Also start a new checker *right now*.
1041
 
        self.start_checker()
 
1109
            int((self.expires - now).total_seconds() * 1000),
 
1110
            self.disable)
1042
1111
 
1043
1112
    def checker_callback(self, source, condition, connection,
1044
1113
                         command):
1046
1115
        # Read return code from connection (see call_pipe)
1047
1116
        returncode = connection.recv()
1048
1117
        connection.close()
1049
 
        self.checker.join()
 
1118
        if self.checker is not None:
 
1119
            self.checker.join()
1050
1120
        self.checker_callback_tag = None
1051
1121
        self.checker = None
1052
1122
 
1054
1124
            self.last_checker_status = returncode
1055
1125
            self.last_checker_signal = None
1056
1126
            if self.last_checker_status == 0:
1057
 
                logger.info("Checker for %(name)s succeeded",
1058
 
                            vars(self))
 
1127
                log.info("Checker for %(name)s succeeded", vars(self))
1059
1128
                self.checked_ok()
1060
1129
            else:
1061
 
                logger.info("Checker for %(name)s failed", vars(self))
 
1130
                log.info("Checker for %(name)s failed", vars(self))
1062
1131
        else:
1063
1132
            self.last_checker_status = -1
1064
1133
            self.last_checker_signal = -returncode
1065
 
            logger.warning("Checker for %(name)s crashed?",
1066
 
                           vars(self))
 
1134
            log.warning("Checker for %(name)s crashed?", vars(self))
1067
1135
        return False
1068
1136
 
1069
1137
    def checked_ok(self):
1088
1156
    def need_approval(self):
1089
1157
        self.last_approval_request = datetime.datetime.utcnow()
1090
1158
 
1091
 
    def start_checker(self):
 
1159
    def start_checker(self, start_was_randomized=False):
1092
1160
        """Start a new checker subprocess if one is not running.
1093
1161
 
1094
1162
        If a checker already exists, leave it running and do
1103
1171
        # should be.
1104
1172
 
1105
1173
        if self.checker is not None and not self.checker.is_alive():
1106
 
            logger.warning("Checker was not alive; joining")
 
1174
            log.warning("Checker was not alive; joining")
1107
1175
            self.checker.join()
1108
1176
            self.checker = None
1109
1177
        # Start a new checker if needed
1110
1178
        if self.checker is None:
1111
1179
            # Escape attributes for the shell
1112
1180
            escaped_attrs = {
1113
 
                attr: re.escape(str(getattr(self, attr)))
 
1181
                attr: shlex.quote(str(getattr(self, attr)))
1114
1182
                for attr in self.runtime_expansions}
1115
1183
            try:
1116
1184
                command = self.checker_command % escaped_attrs
1117
1185
            except TypeError as error:
1118
 
                logger.error('Could not format string "%s"',
1119
 
                             self.checker_command,
1120
 
                             exc_info=error)
 
1186
                log.error('Could not format string "%s"',
 
1187
                          self.checker_command, exc_info=error)
1121
1188
                return True     # Try again later
1122
1189
            self.current_checker_command = command
1123
 
            logger.info("Starting checker %r for %s", command,
1124
 
                        self.name)
 
1190
            log.info("Starting checker %r for %s", command, self.name)
1125
1191
            # We don't need to redirect stdout and stderr, since
1126
1192
            # in normal mode, that is already done by daemon(),
1127
1193
            # and in debug mode we don't want to.  (Stdin is
1143
1209
                kwargs=popen_args)
1144
1210
            self.checker.start()
1145
1211
            self.checker_callback_tag = GLib.io_add_watch(
1146
 
                pipe[0].fileno(), GLib.IO_IN,
 
1212
                GLib.IOChannel.unix_new(pipe[0].fileno()),
 
1213
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1147
1214
                self.checker_callback, pipe[0], command)
 
1215
        if start_was_randomized:
 
1216
            # We were started after a random delay; Schedule a new
 
1217
            # checker to be started an 'interval' from now, and every
 
1218
            # interval from then on.
 
1219
            now = datetime.datetime.utcnow()
 
1220
            self.checker_initiator_tag = GLib.timeout_add(
 
1221
                int(self.interval.total_seconds() * 1000),
 
1222
                self.start_checker)
 
1223
            self.expires = max(self.expires, now + self.interval)
 
1224
            # Don't start a new checker again after same random delay
 
1225
            return False
1148
1226
        # Re-run this periodically if run by GLib.timeout_add
1149
1227
        return True
1150
1228
 
1155
1233
            self.checker_callback_tag = None
1156
1234
        if getattr(self, "checker", None) is None:
1157
1235
            return
1158
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
1236
        log.debug("Stopping checker for %(name)s", vars(self))
1159
1237
        self.checker.terminate()
1160
1238
        self.checker = None
1161
1239
 
1188
1266
        func._dbus_name = func.__name__
1189
1267
        if func._dbus_name.endswith("_dbus_property"):
1190
1268
            func._dbus_name = func._dbus_name[:-14]
1191
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
 
1269
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
1192
1270
        return func
1193
1271
 
1194
1272
    return decorator
1283
1361
 
1284
1362
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1285
1363
                         out_signature="s",
1286
 
                         path_keyword='object_path',
1287
 
                         connection_keyword='connection')
 
1364
                         path_keyword="object_path",
 
1365
                         connection_keyword="connection")
1288
1366
    def Introspect(self, object_path, connection):
1289
1367
        """Overloading of standard D-Bus method.
1290
1368
 
1339
1417
            document.unlink()
1340
1418
        except (AttributeError, xml.dom.DOMException,
1341
1419
                xml.parsers.expat.ExpatError) as error:
1342
 
            logger.error("Failed to override Introspection method",
1343
 
                         exc_info=error)
 
1420
            log.error("Failed to override Introspection method",
 
1421
                      exc_info=error)
1344
1422
        return xmlstring
1345
1423
 
1346
1424
 
1404
1482
                raise ValueError("Byte arrays not supported for non-"
1405
1483
                                 "'ay' signature {!r}"
1406
1484
                                 .format(prop._dbus_signature))
1407
 
            value = dbus.ByteArray(b''.join(chr(byte)
1408
 
                                            for byte in value))
 
1485
            value = dbus.ByteArray(bytes(value))
1409
1486
        prop(value)
1410
1487
 
1411
1488
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1444
1521
 
1445
1522
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1446
1523
                         out_signature="s",
1447
 
                         path_keyword='object_path',
1448
 
                         connection_keyword='connection')
 
1524
                         path_keyword="object_path",
 
1525
                         connection_keyword="connection")
1449
1526
    def Introspect(self, object_path, connection):
1450
1527
        """Overloading of standard D-Bus method.
1451
1528
 
1507
1584
            document.unlink()
1508
1585
        except (AttributeError, xml.dom.DOMException,
1509
1586
                xml.parsers.expat.ExpatError) as error:
1510
 
            logger.error("Failed to override Introspection method",
1511
 
                         exc_info=error)
 
1587
            log.error("Failed to override Introspection method",
 
1588
                      exc_info=error)
1512
1589
        return xmlstring
1513
1590
 
1514
1591
 
1546
1623
 
1547
1624
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1548
1625
                         out_signature="s",
1549
 
                         path_keyword='object_path',
1550
 
                         connection_keyword='connection')
 
1626
                         path_keyword="object_path",
 
1627
                         connection_keyword="connection")
1551
1628
    def Introspect(self, object_path, connection):
1552
1629
        """Overloading of standard D-Bus method.
1553
1630
 
1578
1655
            document.unlink()
1579
1656
        except (AttributeError, xml.dom.DOMException,
1580
1657
                xml.parsers.expat.ExpatError) as error:
1581
 
            logger.error("Failed to override Introspection method",
1582
 
                         exc_info=error)
 
1658
            log.error("Failed to override Introspection method",
 
1659
                      exc_info=error)
1583
1660
        return xmlstring
1584
1661
 
1585
1662
 
2219
2296
class ProxyClient:
2220
2297
    def __init__(self, child_pipe, key_id, fpr, address):
2221
2298
        self._pipe = child_pipe
2222
 
        self._pipe.send(('init', key_id, fpr, address))
 
2299
        self._pipe.send(("init", key_id, fpr, address))
2223
2300
        if not self._pipe.recv():
2224
2301
            raise KeyError(key_id or fpr)
2225
2302
 
2226
2303
    def __getattribute__(self, name):
2227
 
        if name == '_pipe':
 
2304
        if name == "_pipe":
2228
2305
            return super(ProxyClient, self).__getattribute__(name)
2229
 
        self._pipe.send(('getattr', name))
 
2306
        self._pipe.send(("getattr", name))
2230
2307
        data = self._pipe.recv()
2231
 
        if data[0] == 'data':
 
2308
        if data[0] == "data":
2232
2309
            return data[1]
2233
 
        if data[0] == 'function':
 
2310
        if data[0] == "function":
2234
2311
 
2235
2312
            def func(*args, **kwargs):
2236
 
                self._pipe.send(('funcall', name, args, kwargs))
 
2313
                self._pipe.send(("funcall", name, args, kwargs))
2237
2314
                return self._pipe.recv()[1]
2238
2315
 
2239
2316
            return func
2240
2317
 
2241
2318
    def __setattr__(self, name, value):
2242
 
        if name == '_pipe':
 
2319
        if name == "_pipe":
2243
2320
            return super(ProxyClient, self).__setattr__(name, value)
2244
 
        self._pipe.send(('setattr', name, value))
 
2321
        self._pipe.send(("setattr", name, value))
2245
2322
 
2246
2323
 
2247
2324
class ClientHandler(socketserver.BaseRequestHandler, object):
2252
2329
 
2253
2330
    def handle(self):
2254
2331
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2255
 
            logger.info("TCP connection from: %s",
2256
 
                        str(self.client_address))
2257
 
            logger.debug("Pipe FD: %d",
2258
 
                         self.server.child_pipe.fileno())
 
2332
            log.info("TCP connection from: %s",
 
2333
                     str(self.client_address))
 
2334
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2259
2335
 
2260
2336
            session = gnutls.ClientSession(self.request)
2261
2337
 
2262
 
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2338
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
2263
2339
            #                       "+AES-256-CBC", "+SHA1",
2264
2340
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2265
2341
            #                       "+DHE-DSS"))
2267
2343
            priority = self.server.gnutls_priority
2268
2344
            if priority is None:
2269
2345
                priority = "NORMAL"
2270
 
            gnutls.priority_set_direct(session._c_object,
2271
 
                                       priority.encode("utf-8"),
2272
 
                                       None)
 
2346
            gnutls.priority_set_direct(session,
 
2347
                                       priority.encode("utf-8"), None)
2273
2348
 
2274
2349
            # Start communication using the Mandos protocol
2275
2350
            # Get protocol number
2276
2351
            line = self.request.makefile().readline()
2277
 
            logger.debug("Protocol version: %r", line)
 
2352
            log.debug("Protocol version: %r", line)
2278
2353
            try:
2279
2354
                if int(line.strip().split()[0]) > 1:
2280
2355
                    raise RuntimeError(line)
2281
2356
            except (ValueError, IndexError, RuntimeError) as error:
2282
 
                logger.error("Unknown protocol version: %s", error)
 
2357
                log.error("Unknown protocol version: %s", error)
2283
2358
                return
2284
2359
 
2285
2360
            # Start GnuTLS connection
2286
2361
            try:
2287
2362
                session.handshake()
2288
2363
            except gnutls.Error as error:
2289
 
                logger.warning("Handshake failed: %s", error)
 
2364
                log.warning("Handshake failed: %s", error)
2290
2365
                # Do not run session.bye() here: the session is not
2291
2366
                # established.  Just abandon the request.
2292
2367
                return
2293
 
            logger.debug("Handshake succeeded")
 
2368
            log.debug("Handshake succeeded")
2294
2369
 
2295
2370
            approval_required = False
2296
2371
            try:
2300
2375
                        key_id = self.key_id(
2301
2376
                            self.peer_certificate(session))
2302
2377
                    except (TypeError, gnutls.Error) as error:
2303
 
                        logger.warning("Bad certificate: %s", error)
 
2378
                        log.warning("Bad certificate: %s", error)
2304
2379
                        return
2305
 
                    logger.debug("Key ID: %s", key_id)
 
2380
                    log.debug("Key ID: %s",
 
2381
                              key_id.decode("utf-8",
 
2382
                                            errors="replace"))
2306
2383
 
2307
2384
                else:
2308
2385
                    key_id = b""
2310
2387
                        fpr = self.fingerprint(
2311
2388
                            self.peer_certificate(session))
2312
2389
                    except (TypeError, gnutls.Error) as error:
2313
 
                        logger.warning("Bad certificate: %s", error)
 
2390
                        log.warning("Bad certificate: %s", error)
2314
2391
                        return
2315
 
                    logger.debug("Fingerprint: %s", fpr)
 
2392
                    log.debug("Fingerprint: %s", fpr)
2316
2393
 
2317
2394
                try:
2318
2395
                    client = ProxyClient(child_pipe, key_id, fpr,
2327
2404
 
2328
2405
                while True:
2329
2406
                    if not client.enabled:
2330
 
                        logger.info("Client %s is disabled",
2331
 
                                    client.name)
 
2407
                        log.info("Client %s is disabled", client.name)
2332
2408
                        if self.server.use_dbus:
2333
2409
                            # Emit D-Bus signal
2334
2410
                            client.Rejected("Disabled")
2338
2414
                        # We are approved or approval is disabled
2339
2415
                        break
2340
2416
                    elif client.approved is None:
2341
 
                        logger.info("Client %s needs approval",
2342
 
                                    client.name)
 
2417
                        log.info("Client %s needs approval",
 
2418
                                 client.name)
2343
2419
                        if self.server.use_dbus:
2344
2420
                            # Emit D-Bus signal
2345
2421
                            client.NeedApproval(
2346
2422
                                client.approval_delay.total_seconds()
2347
2423
                                * 1000, client.approved_by_default)
2348
2424
                    else:
2349
 
                        logger.warning("Client %s was not approved",
2350
 
                                       client.name)
 
2425
                        log.warning("Client %s was not approved",
 
2426
                                    client.name)
2351
2427
                        if self.server.use_dbus:
2352
2428
                            # Emit D-Bus signal
2353
2429
                            client.Rejected("Denied")
2361
2437
                    time2 = datetime.datetime.now()
2362
2438
                    if (time2 - time) >= delay:
2363
2439
                        if not client.approved_by_default:
2364
 
                            logger.warning("Client %s timed out while"
2365
 
                                           " waiting for approval",
2366
 
                                           client.name)
 
2440
                            log.warning("Client %s timed out while"
 
2441
                                        " waiting for approval",
 
2442
                                        client.name)
2367
2443
                            if self.server.use_dbus:
2368
2444
                                # Emit D-Bus signal
2369
2445
                                client.Rejected("Approval timed out")
2376
2452
                try:
2377
2453
                    session.send(client.secret)
2378
2454
                except gnutls.Error as error:
2379
 
                    logger.warning("gnutls send failed",
2380
 
                                   exc_info=error)
 
2455
                    log.warning("gnutls send failed", exc_info=error)
2381
2456
                    return
2382
2457
 
2383
 
                logger.info("Sending secret to %s", client.name)
 
2458
                log.info("Sending secret to %s", client.name)
2384
2459
                # bump the timeout using extended_timeout
2385
2460
                client.bump_timeout(client.extended_timeout)
2386
2461
                if self.server.use_dbus:
2393
2468
                try:
2394
2469
                    session.bye()
2395
2470
                except gnutls.Error as error:
2396
 
                    logger.warning("GnuTLS bye failed",
2397
 
                                   exc_info=error)
 
2471
                    log.warning("GnuTLS bye failed", exc_info=error)
2398
2472
 
2399
2473
    @staticmethod
2400
2474
    def peer_certificate(session):
2401
2475
        "Return the peer's certificate as a bytestring"
2402
2476
        try:
2403
 
            cert_type = gnutls.certificate_type_get2(session._c_object,
2404
 
                                                     gnutls.CTYPE_PEERS)
 
2477
            cert_type = gnutls.certificate_type_get2(
 
2478
                session, gnutls.CTYPE_PEERS)
2405
2479
        except AttributeError:
2406
 
            cert_type = gnutls.certificate_type_get(session._c_object)
 
2480
            cert_type = gnutls.certificate_type_get(session)
2407
2481
        if gnutls.has_rawpk:
2408
2482
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2409
2483
        else:
2410
2484
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2411
2485
        # If not a valid certificate type...
2412
2486
        if cert_type not in valid_cert_types:
2413
 
            logger.info("Cert type %r not in %r", cert_type,
2414
 
                        valid_cert_types)
 
2487
            log.info("Cert type %r not in %r", cert_type,
 
2488
                     valid_cert_types)
2415
2489
            # ...return invalid data
2416
2490
            return b""
2417
2491
        list_size = ctypes.c_uint(1)
2418
2492
        cert_list = (gnutls.certificate_get_peers
2419
 
                     (session._c_object, ctypes.byref(list_size)))
 
2493
                     (session, ctypes.byref(list_size)))
2420
2494
        if not bool(cert_list) and list_size.value != 0:
2421
2495
            raise gnutls.Error("error getting peer certificate")
2422
2496
        if list_size.value == 0:
2444
2518
        buf = ctypes.create_string_buffer(32)
2445
2519
        buf_len = ctypes.c_size_t(len(buf))
2446
2520
        # Get the key ID from the raw public key into the buffer
2447
 
        gnutls.pubkey_get_key_id(pubkey,
2448
 
                                 gnutls.KEYID_USE_SHA256,
2449
 
                                 ctypes.cast(ctypes.byref(buf),
2450
 
                                             ctypes.POINTER(ctypes.c_ubyte)),
2451
 
                                 ctypes.byref(buf_len))
 
2521
        gnutls.pubkey_get_key_id(
 
2522
            pubkey,
 
2523
            gnutls.KEYID_USE_SHA256,
 
2524
            ctypes.cast(ctypes.byref(buf),
 
2525
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2526
            ctypes.byref(buf_len))
2452
2527
        # Deinit the certificate
2453
2528
        gnutls.pubkey_deinit(pubkey)
2454
2529
 
2535
2610
 
2536
2611
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2537
2612
                     socketserver.TCPServer):
2538
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
2613
    """IPv6-capable TCP server.  Accepts None as address and/or port
2539
2614
 
2540
2615
    Attributes:
2541
2616
        enabled:        Boolean; whether this server is activated yet
2592
2667
            if SO_BINDTODEVICE is None:
2593
2668
                # Fall back to a hard-coded value which seems to be
2594
2669
                # common enough.
2595
 
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2670
                log.warning("SO_BINDTODEVICE not found, trying 25")
2596
2671
                SO_BINDTODEVICE = 25
2597
2672
            try:
2598
2673
                self.socket.setsockopt(
2600
2675
                    (self.interface + "\0").encode("utf-8"))
2601
2676
            except socket.error as error:
2602
2677
                if error.errno == errno.EPERM:
2603
 
                    logger.error("No permission to bind to"
2604
 
                                 " interface %s", self.interface)
 
2678
                    log.error("No permission to bind to interface %s",
 
2679
                              self.interface)
2605
2680
                elif error.errno == errno.ENOPROTOOPT:
2606
 
                    logger.error("SO_BINDTODEVICE not available;"
2607
 
                                 " cannot bind to interface %s",
2608
 
                                 self.interface)
 
2681
                    log.error("SO_BINDTODEVICE not available; cannot"
 
2682
                              " bind to interface %s", self.interface)
2609
2683
                elif error.errno == errno.ENODEV:
2610
 
                    logger.error("Interface %s does not exist,"
2611
 
                                 " cannot bind", self.interface)
 
2684
                    log.error("Interface %s does not exist, cannot"
 
2685
                              " bind", self.interface)
2612
2686
                else:
2613
2687
                    raise
2614
2688
        # Only bind(2) the socket if we really need to.
2673
2747
    def add_pipe(self, parent_pipe, proc):
2674
2748
        # Call "handle_ipc" for both data and EOF events
2675
2749
        GLib.io_add_watch(
2676
 
            parent_pipe.fileno(),
2677
 
            GLib.IO_IN | GLib.IO_HUP,
 
2750
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2751
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2678
2752
            functools.partial(self.handle_ipc,
2679
2753
                              parent_pipe=parent_pipe,
2680
2754
                              proc=proc))
2693
2767
        request = parent_pipe.recv()
2694
2768
        command = request[0]
2695
2769
 
2696
 
        if command == 'init':
 
2770
        if command == "init":
2697
2771
            key_id = request[1].decode("ascii")
2698
2772
            fpr = request[2].decode("ascii")
2699
2773
            address = request[3]
2700
2774
 
2701
2775
            for c in self.clients.values():
2702
 
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
 
2776
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
 
2777
                              "27AE41E4649B934CA495991B7852B855"):
2703
2778
                    continue
2704
2779
                if key_id and c.key_id == key_id:
2705
2780
                    client = c
2708
2783
                    client = c
2709
2784
                    break
2710
2785
            else:
2711
 
                logger.info("Client not found for key ID: %s, address"
2712
 
                            ": %s", key_id or fpr, address)
 
2786
                log.info("Client not found for key ID: %s, address:"
 
2787
                         " %s", key_id or fpr, address)
2713
2788
                if self.use_dbus:
2714
2789
                    # Emit D-Bus signal
2715
2790
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2718
2793
                return False
2719
2794
 
2720
2795
            GLib.io_add_watch(
2721
 
                parent_pipe.fileno(),
2722
 
                GLib.IO_IN | GLib.IO_HUP,
 
2796
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2797
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2723
2798
                functools.partial(self.handle_ipc,
2724
2799
                                  parent_pipe=parent_pipe,
2725
2800
                                  proc=proc,
2728
2803
            # remove the old hook in favor of the new above hook on
2729
2804
            # same fileno
2730
2805
            return False
2731
 
        if command == 'funcall':
 
2806
        if command == "funcall":
2732
2807
            funcname = request[1]
2733
2808
            args = request[2]
2734
2809
            kwargs = request[3]
2735
2810
 
2736
 
            parent_pipe.send(('data', getattr(client_object,
 
2811
            parent_pipe.send(("data", getattr(client_object,
2737
2812
                                              funcname)(*args,
2738
2813
                                                        **kwargs)))
2739
2814
 
2740
 
        if command == 'getattr':
 
2815
        if command == "getattr":
2741
2816
            attrname = request[1]
2742
2817
            if isinstance(client_object.__getattribute__(attrname),
2743
 
                          collections.Callable):
2744
 
                parent_pipe.send(('function', ))
 
2818
                          collections.abc.Callable):
 
2819
                parent_pipe.send(("function", ))
2745
2820
            else:
2746
2821
                parent_pipe.send((
2747
 
                    'data', client_object.__getattribute__(attrname)))
 
2822
                    "data", client_object.__getattribute__(attrname)))
2748
2823
 
2749
 
        if command == 'setattr':
 
2824
        if command == "setattr":
2750
2825
            attrname = request[1]
2751
2826
            value = request[2]
2752
2827
            setattr(client_object, attrname, value)
2757
2832
def rfc3339_duration_to_delta(duration):
2758
2833
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2759
2834
 
2760
 
    >>> rfc3339_duration_to_delta("P7D")
2761
 
    datetime.timedelta(7)
2762
 
    >>> rfc3339_duration_to_delta("PT60S")
2763
 
    datetime.timedelta(0, 60)
2764
 
    >>> rfc3339_duration_to_delta("PT60M")
2765
 
    datetime.timedelta(0, 3600)
2766
 
    >>> rfc3339_duration_to_delta("PT24H")
2767
 
    datetime.timedelta(1)
2768
 
    >>> rfc3339_duration_to_delta("P1W")
2769
 
    datetime.timedelta(7)
2770
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2771
 
    datetime.timedelta(0, 330)
2772
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2773
 
    datetime.timedelta(1, 200)
 
2835
    >>> timedelta = datetime.timedelta
 
2836
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
 
2837
    True
 
2838
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
 
2839
    True
 
2840
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
 
2841
    True
 
2842
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
 
2843
    True
 
2844
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
 
2845
    True
 
2846
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
 
2847
    True
 
2848
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
 
2849
    True
 
2850
    >>> del timedelta
2774
2851
    """
2775
2852
 
2776
2853
    # Parsing an RFC 3339 duration with regular expressions is not
2856
2933
def string_to_delta(interval):
2857
2934
    """Parse a string and return a datetime.timedelta
2858
2935
 
2859
 
    >>> string_to_delta('7d')
2860
 
    datetime.timedelta(7)
2861
 
    >>> string_to_delta('60s')
2862
 
    datetime.timedelta(0, 60)
2863
 
    >>> string_to_delta('60m')
2864
 
    datetime.timedelta(0, 3600)
2865
 
    >>> string_to_delta('24h')
2866
 
    datetime.timedelta(1)
2867
 
    >>> string_to_delta('1w')
2868
 
    datetime.timedelta(7)
2869
 
    >>> string_to_delta('5m 30s')
2870
 
    datetime.timedelta(0, 330)
 
2936
    >>> string_to_delta("7d") == datetime.timedelta(7)
 
2937
    True
 
2938
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
 
2939
    True
 
2940
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
 
2941
    True
 
2942
    >>> string_to_delta("24h") == datetime.timedelta(1)
 
2943
    True
 
2944
    >>> string_to_delta("1w") == datetime.timedelta(7)
 
2945
    True
 
2946
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
 
2947
    True
2871
2948
    """
2872
2949
 
2873
2950
    try:
2975
3052
 
2976
3053
    options = parser.parse_args()
2977
3054
 
2978
 
    if options.check:
2979
 
        import doctest
2980
 
        fail_count, test_count = doctest.testmod()
2981
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2982
 
 
2983
3055
    # Default values for config file for server-global settings
2984
3056
    if gnutls.has_rawpk:
2985
3057
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3081
3153
 
3082
3154
    if server_settings["servicename"] != "Mandos":
3083
3155
        syslogger.setFormatter(
3084
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
3085
 
                              ' %(levelname)s: %(message)s'.format(
 
3156
            logging.Formatter("Mandos ({}) [%(process)d]:"
 
3157
                              " %(levelname)s: %(message)s".format(
3086
3158
                                  server_settings["servicename"])))
3087
3159
 
3088
3160
    # Parse config file with clients
3112
3184
        try:
3113
3185
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3114
3186
        except IOError as e:
3115
 
            logger.error("Could not open file %r", pidfilename,
3116
 
                         exc_info=e)
 
3187
            log.error("Could not open file %r", pidfilename,
 
3188
                      exc_info=e)
3117
3189
 
3118
3190
    for name, group in (("_mandos", "_mandos"),
3119
3191
                        ("mandos", "mandos"),
3130
3202
    try:
3131
3203
        os.setgid(gid)
3132
3204
        os.setuid(uid)
3133
 
        if debug:
3134
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3135
 
                                                             gid))
 
3205
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
3136
3206
    except OSError as error:
3137
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
3138
 
                       .format(uid, gid, os.strerror(error.errno)))
 
3207
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
 
3208
                    os.strerror(error.errno))
3139
3209
        if error.errno != errno.EPERM:
3140
3210
            raise
3141
3211
 
3148
3218
 
3149
3219
        @gnutls.log_func
3150
3220
        def debug_gnutls(level, string):
3151
 
            logger.debug("GnuTLS: %s", string[:-1])
 
3221
            log.debug("GnuTLS: %s",
 
3222
                      string[:-1].decode("utf-8", errors="replace"))
3152
3223
 
3153
3224
        gnutls.global_set_log_function(debug_gnutls)
3154
3225
 
3183
3254
                "se.bsnet.fukt.Mandos", bus,
3184
3255
                do_not_queue=True)
3185
3256
        except dbus.exceptions.DBusException as e:
3186
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
3257
            log.error("Disabling D-Bus:", exc_info=e)
3187
3258
            use_dbus = False
3188
3259
            server_settings["use_dbus"] = False
3189
3260
            tcp_server.use_dbus = False
3248
3319
                             if isinstance(s, bytes)
3249
3320
                             else s) for s in
3250
3321
                            value["client_structure"]]
3251
 
                        # .name & .host
3252
 
                        for k in ("name", "host"):
 
3322
                        # .name, .host, and .checker_command
 
3323
                        for k in ("name", "host", "checker_command"):
3253
3324
                            if isinstance(value[k], bytes):
3254
3325
                                value[k] = value[k].decode("utf-8")
3255
3326
                        if "key_id" not in value:
3265
3336
                        for key, value in
3266
3337
                        bytes_old_client_settings.items()}
3267
3338
                    del bytes_old_client_settings
3268
 
                    # .host
 
3339
                    # .host and .checker_command
3269
3340
                    for value in old_client_settings.values():
3270
 
                        if isinstance(value["host"], bytes):
3271
 
                            value["host"] = (value["host"]
3272
 
                                             .decode("utf-8"))
 
3341
                        for attribute in ("host", "checker_command"):
 
3342
                            if isinstance(value[attribute], bytes):
 
3343
                                value[attribute] = (value[attribute]
 
3344
                                                    .decode("utf-8"))
3273
3345
            os.remove(stored_state_path)
3274
3346
        except IOError as e:
3275
3347
            if e.errno == errno.ENOENT:
3276
 
                logger.warning("Could not load persistent state:"
3277
 
                               " {}".format(os.strerror(e.errno)))
 
3348
                log.warning("Could not load persistent state:"
 
3349
                            " %s", os.strerror(e.errno))
3278
3350
            else:
3279
 
                logger.critical("Could not load persistent state:",
3280
 
                                exc_info=e)
 
3351
                log.critical("Could not load persistent state:",
 
3352
                             exc_info=e)
3281
3353
                raise
3282
3354
        except EOFError as e:
3283
 
            logger.warning("Could not load persistent state: "
3284
 
                           "EOFError:",
3285
 
                           exc_info=e)
 
3355
            log.warning("Could not load persistent state: EOFError:",
 
3356
                        exc_info=e)
3286
3357
 
3287
3358
    with PGPEngine() as pgp:
3288
3359
        for client_name, client in clients_data.items():
3315
3386
            if client["enabled"]:
3316
3387
                if datetime.datetime.utcnow() >= client["expires"]:
3317
3388
                    if not client["last_checked_ok"]:
3318
 
                        logger.warning(
3319
 
                            "disabling client {} - Client never "
3320
 
                            "performed a successful checker".format(
3321
 
                                client_name))
 
3389
                        log.warning("disabling client %s - Client"
 
3390
                                    " never performed a successful"
 
3391
                                    " checker", client_name)
3322
3392
                        client["enabled"] = False
3323
3393
                    elif client["last_checker_status"] != 0:
3324
 
                        logger.warning(
3325
 
                            "disabling client {} - Client last"
3326
 
                            " checker failed with error code"
3327
 
                            " {}".format(
3328
 
                                client_name,
3329
 
                                client["last_checker_status"]))
 
3394
                        log.warning("disabling client %s - Client"
 
3395
                                    " last checker failed with error"
 
3396
                                    " code %s", client_name,
 
3397
                                    client["last_checker_status"])
3330
3398
                        client["enabled"] = False
3331
3399
                    else:
3332
3400
                        client["expires"] = (
3333
3401
                            datetime.datetime.utcnow()
3334
3402
                            + client["timeout"])
3335
 
                        logger.debug("Last checker succeeded,"
3336
 
                                     " keeping {} enabled".format(
3337
 
                                         client_name))
 
3403
                        log.debug("Last checker succeeded, keeping %s"
 
3404
                                  " enabled", client_name)
3338
3405
            try:
3339
3406
                client["secret"] = pgp.decrypt(
3340
3407
                    client["encrypted_secret"],
3341
3408
                    client_settings[client_name]["secret"])
3342
3409
            except PGPError:
3343
3410
                # If decryption fails, we use secret from new settings
3344
 
                logger.debug("Failed to decrypt {} old secret".format(
3345
 
                    client_name))
 
3411
                log.debug("Failed to decrypt %s old secret",
 
3412
                          client_name)
3346
3413
                client["secret"] = (client_settings[client_name]
3347
3414
                                    ["secret"])
3348
3415
 
3362
3429
            server_settings=server_settings)
3363
3430
 
3364
3431
    if not tcp_server.clients:
3365
 
        logger.warning("No clients defined")
 
3432
        log.warning("No clients defined")
3366
3433
 
3367
3434
    if not foreground:
3368
3435
        if pidfile is not None:
3371
3438
                with pidfile:
3372
3439
                    print(pid, file=pidfile)
3373
3440
            except IOError:
3374
 
                logger.error("Could not write to file %r with PID %d",
3375
 
                             pidfilename, pid)
 
3441
                log.error("Could not write to file %r with PID %d",
 
3442
                          pidfilename, pid)
3376
3443
        del pidfile
3377
3444
        del pidfilename
3378
3445
 
3528
3595
 
3529
3596
        try:
3530
3597
            with tempfile.NamedTemporaryFile(
3531
 
                    mode='wb',
 
3598
                    mode="wb",
3532
3599
                    suffix=".pickle",
3533
 
                    prefix='clients-',
 
3600
                    prefix="clients-",
3534
3601
                    dir=os.path.dirname(stored_state_path),
3535
3602
                    delete=False) as stored_state:
3536
3603
                pickle.dump((clients, client_settings), stored_state,
3544
3611
                except NameError:
3545
3612
                    pass
3546
3613
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3547
 
                logger.warning("Could not save persistent state: {}"
3548
 
                               .format(os.strerror(e.errno)))
 
3614
                log.warning("Could not save persistent state: %s",
 
3615
                            os.strerror(e.errno))
3549
3616
            else:
3550
 
                logger.warning("Could not save persistent state:",
3551
 
                               exc_info=e)
 
3617
                log.warning("Could not save persistent state:",
 
3618
                            exc_info=e)
3552
3619
                raise
3553
3620
 
3554
3621
        # Delete all clients, and settings from config
3571
3638
            mandos_dbus_service.client_added_signal(client)
3572
3639
        # Need to initiate checking of clients
3573
3640
        if client.enabled:
3574
 
            client.init_checker()
 
3641
            client.init_checker(randomize_start=True)
3575
3642
 
3576
3643
    tcp_server.enable()
3577
3644
    tcp_server.server_activate()
3580
3647
    if zeroconf:
3581
3648
        service.port = tcp_server.socket.getsockname()[1]
3582
3649
    if use_ipv6:
3583
 
        logger.info("Now listening on address %r, port %d,"
3584
 
                    " flowinfo %d, scope_id %d",
3585
 
                    *tcp_server.socket.getsockname())
 
3650
        log.info("Now listening on address %r, port %d, flowinfo %d,"
 
3651
                 " scope_id %d", *tcp_server.socket.getsockname())
3586
3652
    else:                       # IPv4
3587
 
        logger.info("Now listening on address %r, port %d",
3588
 
                    *tcp_server.socket.getsockname())
 
3653
        log.info("Now listening on address %r, port %d",
 
3654
                 *tcp_server.socket.getsockname())
3589
3655
 
3590
3656
    # service.interface = tcp_server.socket.getsockname()[3]
3591
3657
 
3595
3661
            try:
3596
3662
                service.activate()
3597
3663
            except dbus.exceptions.DBusException as error:
3598
 
                logger.critical("D-Bus Exception", exc_info=error)
 
3664
                log.critical("D-Bus Exception", exc_info=error)
3599
3665
                cleanup()
3600
3666
                sys.exit(1)
3601
3667
            # End of Avahi example code
3602
3668
 
3603
 
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3604
 
                          lambda *args, **kwargs:
3605
 
                          (tcp_server.handle_request
3606
 
                           (*args[2:], **kwargs) or True))
 
3669
        GLib.io_add_watch(
 
3670
            GLib.IOChannel.unix_new(tcp_server.fileno()),
 
3671
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
3672
            lambda *args, **kwargs: (tcp_server.handle_request
 
3673
                                     (*args[2:], **kwargs) or True))
3607
3674
 
3608
 
        logger.debug("Starting main loop")
 
3675
        log.debug("Starting main loop")
3609
3676
        main_loop.run()
3610
3677
    except AvahiError as error:
3611
 
        logger.critical("Avahi Error", exc_info=error)
 
3678
        log.critical("Avahi Error", exc_info=error)
3612
3679
        cleanup()
3613
3680
        sys.exit(1)
3614
3681
    except KeyboardInterrupt:
3615
3682
        if debug:
3616
3683
            print("", file=sys.stderr)
3617
 
        logger.debug("Server received KeyboardInterrupt")
3618
 
    logger.debug("Server exiting")
 
3684
        log.debug("Server received KeyboardInterrupt")
 
3685
    log.debug("Server exiting")
3619
3686
    # Must run before the D-Bus bus name gets deregistered
3620
3687
    cleanup()
3621
3688
 
3622
 
 
3623
 
if __name__ == '__main__':
3624
 
    main()
 
3689
 
 
3690
def parse_test_args():
 
3691
    # type: () -> argparse.Namespace
 
3692
    parser = argparse.ArgumentParser(add_help=False)
 
3693
    parser.add_argument("--check", action="store_true")
 
3694
    parser.add_argument("--prefix", )
 
3695
    args, unknown_args = parser.parse_known_args()
 
3696
    if args.check:
 
3697
        # Remove test options from sys.argv
 
3698
        sys.argv[1:] = unknown_args
 
3699
    return args
 
3700
 
 
3701
# Add all tests from doctest strings
 
3702
def load_tests(loader, tests, none):
 
3703
    import doctest
 
3704
    tests.addTests(doctest.DocTestSuite())
 
3705
    return tests
 
3706
 
 
3707
if __name__ == "__main__":
 
3708
    options = parse_test_args()
 
3709
    try:
 
3710
        if options.check:
 
3711
            extra_test_prefix = options.prefix
 
3712
            if extra_test_prefix is not None:
 
3713
                if not (unittest.main(argv=[""], exit=False)
 
3714
                        .result.wasSuccessful()):
 
3715
                    sys.exit(1)
 
3716
                class ExtraTestLoader(unittest.TestLoader):
 
3717
                    testMethodPrefix = extra_test_prefix
 
3718
                # Call using ./scriptname --test [--verbose]
 
3719
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
 
3720
            else:
 
3721
                unittest.main(argv=[""])
 
3722
        else:
 
3723
            main()
 
3724
    finally:
 
3725
        logging.shutdown()
 
3726
 
 
3727
# Local Variables:
 
3728
# run-tests:
 
3729
# (lambda (&optional extra)
 
3730
#   (if (not (funcall run-tests-in-test-buffer default-directory
 
3731
#             extra))
 
3732
#       (funcall show-test-buffer-in-test-window)
 
3733
#     (funcall remove-test-window)
 
3734
#     (if extra (message "Extra tests run successfully!"))))
 
3735
# run-tests-in-test-buffer:
 
3736
# (lambda (dir &optional extra)
 
3737
#   (with-current-buffer (get-buffer-create "*Test*")
 
3738
#     (setq buffer-read-only nil
 
3739
#           default-directory dir)
 
3740
#     (erase-buffer)
 
3741
#     (compilation-mode))
 
3742
#   (let ((process-result
 
3743
#          (let ((inhibit-read-only t))
 
3744
#            (process-file-shell-command
 
3745
#             (funcall get-command-line extra) nil "*Test*"))))
 
3746
#     (and (numberp process-result)
 
3747
#          (= process-result 0))))
 
3748
# get-command-line:
 
3749
# (lambda (&optional extra)
 
3750
#   (let ((quoted-script
 
3751
#          (shell-quote-argument (funcall get-script-name))))
 
3752
#     (format
 
3753
#      (concat "%s --check" (if extra " --prefix=atest" ""))
 
3754
#      quoted-script)))
 
3755
# get-script-name:
 
3756
# (lambda ()
 
3757
#   (if (fboundp 'file-local-name)
 
3758
#       (file-local-name (buffer-file-name))
 
3759
#     (or (file-remote-p (buffer-file-name) 'localname)
 
3760
#         (buffer-file-name))))
 
3761
# remove-test-window:
 
3762
# (lambda ()
 
3763
#   (let ((test-window (get-buffer-window "*Test*")))
 
3764
#     (if test-window (delete-window test-window))))
 
3765
# show-test-buffer-in-test-window:
 
3766
# (lambda ()
 
3767
#   (when (not (get-buffer-window-list "*Test*"))
 
3768
#     (setq next-error-last-buffer (get-buffer "*Test*"))
 
3769
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
 
3770
#            (display-buffer-overriding-action
 
3771
#             `((display-buffer-in-side-window) (side . ,side)
 
3772
#               (window-height . fit-window-to-buffer)
 
3773
#               (window-width . fit-window-to-buffer))))
 
3774
#       (display-buffer "*Test*"))))
 
3775
# eval:
 
3776
# (progn
 
3777
#   (let* ((run-extra-tests (lambda () (interactive)
 
3778
#                             (funcall run-tests t)))
 
3779
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
 
3780
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
 
3781
#     (setq minor-mode-overriding-map-alist
 
3782
#           (cons `(run-tests . ,outer-keymap)
 
3783
#                 minor-mode-overriding-map-alist)))
 
3784
#   (add-hook 'after-save-hook run-tests 90 t))
 
3785
# End: