/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:28:52 UTC
  • Revision ID: teddy@recompile.se-20220425182852-5y9a2b9oy9rm1ipf
From: Camaleón <noelamac@gmail.com>

Add Spanish debconf translation

* debian/po/es.po: New

Acked-by: Teddy Hogeborn <teddy@recompile.se>

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