/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-08-31 01:50:02 UTC
  • mto: This revision was merged to the branch mainline in revision 392.
  • Revision ID: teddy@recompile.se-20190831015002-fe1go9fb7jf66bcn
Fix bug in Debian package dependencies

* debian/control: Change both of "python (>= 3)" to "python3 (>= 3)".

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python3 -bI
2
 
# -*- coding: utf-8; lexical-binding: t -*-
 
1
#!/usr/bin/python3 -b
 
2
# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
5
#
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2022 Teddy Hogeborn
15
 
# Copyright © 2008-2022 Björn Påhlsson
 
14
# Copyright © 2008-2019 Teddy Hogeborn
 
15
# Copyright © 2008-2019 Björn Påhlsson
16
16
#
17
17
# This file is part of Mandos.
18
18
#
31
31
#
32
32
# Contact the authors at <mandos@recompile.se>.
33
33
#
 
34
 
34
35
from __future__ import (division, absolute_import, print_function,
35
36
                        unicode_literals)
36
37
 
39
40
except ImportError:
40
41
    pass
41
42
 
42
 
import sys
43
 
import unittest
44
 
import argparse
45
 
import logging
46
 
import os
47
43
try:
48
44
    import SocketServer as socketserver
49
45
except ImportError:
50
46
    import socketserver
51
47
import socket
 
48
import argparse
52
49
import datetime
53
50
import errno
54
51
try:
55
52
    import ConfigParser as configparser
56
53
except ImportError:
57
54
    import configparser
 
55
import sys
58
56
import re
 
57
import os
59
58
import signal
60
59
import subprocess
61
60
import atexit
62
61
import stat
 
62
import logging
63
63
import logging.handlers
64
64
import pwd
65
65
import contextlib
77
77
import itertools
78
78
import collections
79
79
import codecs
80
 
import random
81
 
import shlex
 
80
import unittest
82
81
 
83
82
import dbus
84
83
import dbus.service
92
91
 
93
92
if sys.version_info.major == 2:
94
93
    __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
 
# Add os.set_inheritable if it does not exist
114
 
try:
115
 
    os.set_inheritable
116
 
except AttributeError:
117
 
    def set_inheritable(fd, inheritable):
118
 
        flags = fcntl.fcntl(fd, fcntl.F_GETFD)
119
 
        if inheritable and ((flags & fcntl.FD_CLOEXEC) != 0):
120
 
            fcntl.fcntl(fd, fcntl.F_SETFL, flags & ~fcntl.FD_CLOEXEC)
121
 
        elif (not inheritable) and ((flags & fcntl.FD_CLOEXEC) == 0):
122
 
            fcntl.fcntl(fd, fcntl.F_SETFL, flags | fcntl.FD_CLOEXEC)
123
 
    os.set_inheritable = set_inheritable
124
 
    del set_inheritable
125
94
 
126
95
# Show warnings by default
127
96
if not sys.warnoptions:
153
122
            # No value found
154
123
            SO_BINDTODEVICE = None
155
124
 
 
125
if sys.version_info.major == 2:
 
126
    str = unicode
 
127
 
156
128
if sys.version_info < (3, 2):
157
129
    configparser.Configparser = configparser.SafeConfigParser
158
130
 
159
 
version = "1.8.17"
 
131
version = "1.8.8"
160
132
stored_state_file = "clients.pickle"
161
133
 
162
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
134
logger = logging.getLogger()
163
135
logging.captureWarnings(True)   # Show warnings via the logging system
164
136
syslogger = None
165
137
 
202
174
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
203
175
        address="/dev/log"))
204
176
    syslogger.setFormatter(logging.Formatter
205
 
                           ("Mandos [%(process)d]: %(levelname)s:"
206
 
                            " %(message)s"))
207
 
    log.addHandler(syslogger)
 
177
                           ('Mandos [%(process)d]: %(levelname)s:'
 
178
                            ' %(message)s'))
 
179
    logger.addHandler(syslogger)
208
180
 
209
181
    if debug:
210
182
        console = logging.StreamHandler()
211
 
        console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
212
 
                                               " [%(process)d]:"
213
 
                                               " %(levelname)s:"
214
 
                                               " %(message)s"))
215
 
        log.addHandler(console)
216
 
    log.setLevel(level)
 
183
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
184
                                               ' [%(process)d]:'
 
185
                                               ' %(levelname)s:'
 
186
                                               ' %(message)s'))
 
187
        logger.addHandler(console)
 
188
    logger.setLevel(level)
217
189
 
218
190
 
219
191
class PGPError(Exception):
231
203
            output = subprocess.check_output(["gpgconf"])
232
204
            for line in output.splitlines():
233
205
                name, text, path = line.split(b":")
234
 
                if name == b"gpg":
 
206
                if name == "gpg":
235
207
                    self.gpg = path
236
208
                    break
237
209
        except OSError as e:
238
210
            if e.errno != errno.ENOENT:
239
211
                raise
240
 
        self.gnupgargs = ["--batch",
241
 
                          "--homedir", self.tempdir,
242
 
                          "--force-mdc",
243
 
                          "--quiet"]
 
212
        self.gnupgargs = ['--batch',
 
213
                          '--homedir', self.tempdir,
 
214
                          '--force-mdc',
 
215
                          '--quiet']
244
216
        # Only GPG version 1 has the --no-use-agent option.
245
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
217
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
246
218
            self.gnupgargs.append("--no-use-agent")
247
219
 
248
220
    def __enter__(self):
285
257
                dir=self.tempdir) as passfile:
286
258
            passfile.write(passphrase)
287
259
            passfile.flush()
288
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
289
 
                                     "--passphrase-file",
 
260
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
261
                                     '--passphrase-file',
290
262
                                     passfile.name]
291
263
                                    + self.gnupgargs,
292
264
                                    stdin=subprocess.PIPE,
303
275
                dir=self.tempdir) as passfile:
304
276
            passfile.write(passphrase)
305
277
            passfile.flush()
306
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
307
 
                                     "--passphrase-file",
 
278
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
279
                                     '--passphrase-file',
308
280
                                     passfile.name]
309
281
                                    + self.gnupgargs,
310
282
                                    stdin=subprocess.PIPE,
363
335
    Attributes:
364
336
    interface: integer; avahi.IF_UNSPEC or an interface index.
365
337
               Used to optionally bind to the specified interface.
366
 
    name: string; Example: "Mandos"
367
 
    type: string; Example: "_mandos._tcp".
 
338
    name: string; Example: 'Mandos'
 
339
    type: string; Example: '_mandos._tcp'.
368
340
     See <https://www.iana.org/assignments/service-names-port-numbers>
369
341
    port: integer; what port to announce
370
342
    TXT: list of strings; TXT record for the service
407
379
    def rename(self, remove=True):
408
380
        """Derived from the Avahi example code"""
409
381
        if self.rename_count >= self.max_renames:
410
 
            log.critical("No suitable Zeroconf service name found"
411
 
                         " after %i retries, exiting.",
412
 
                         self.rename_count)
 
382
            logger.critical("No suitable Zeroconf service name found"
 
383
                            " after %i retries, exiting.",
 
384
                            self.rename_count)
413
385
            raise AvahiServiceError("Too many renames")
414
386
        self.name = str(
415
387
            self.server.GetAlternativeServiceName(self.name))
416
388
        self.rename_count += 1
417
 
        log.info("Changing Zeroconf service name to %r ...",
418
 
                 self.name)
 
389
        logger.info("Changing Zeroconf service name to %r ...",
 
390
                    self.name)
419
391
        if remove:
420
392
            self.remove()
421
393
        try:
423
395
        except dbus.exceptions.DBusException as error:
424
396
            if (error.get_dbus_name()
425
397
                == "org.freedesktop.Avahi.CollisionError"):
426
 
                log.info("Local Zeroconf service name collision.")
 
398
                logger.info("Local Zeroconf service name collision.")
427
399
                return self.rename(remove=False)
428
400
            else:
429
 
                log.critical("D-Bus Exception", exc_info=error)
 
401
                logger.critical("D-Bus Exception", exc_info=error)
430
402
                self.cleanup()
431
403
                os._exit(1)
432
404
 
448
420
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
449
421
        self.entry_group_state_changed_match = (
450
422
            self.group.connect_to_signal(
451
 
                "StateChanged", self.entry_group_state_changed))
452
 
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
453
 
                  self.name, self.type)
 
423
                'StateChanged', self.entry_group_state_changed))
 
424
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
425
                     self.name, self.type)
454
426
        self.group.AddService(
455
427
            self.interface,
456
428
            self.protocol,
463
435
 
464
436
    def entry_group_state_changed(self, state, error):
465
437
        """Derived from the Avahi example code"""
466
 
        log.debug("Avahi entry group state change: %i", state)
 
438
        logger.debug("Avahi entry group state change: %i", state)
467
439
 
468
440
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
469
 
            log.debug("Zeroconf service established.")
 
441
            logger.debug("Zeroconf service established.")
470
442
        elif state == avahi.ENTRY_GROUP_COLLISION:
471
 
            log.info("Zeroconf service name collision.")
 
443
            logger.info("Zeroconf service name collision.")
472
444
            self.rename()
473
445
        elif state == avahi.ENTRY_GROUP_FAILURE:
474
 
            log.critical("Avahi: Error in group state changed %s",
475
 
                         str(error))
 
446
            logger.critical("Avahi: Error in group state changed %s",
 
447
                            str(error))
476
448
            raise AvahiGroupError("State changed: {!s}".format(error))
477
449
 
478
450
    def cleanup(self):
488
460
 
489
461
    def server_state_changed(self, state, error=None):
490
462
        """Derived from the Avahi example code"""
491
 
        log.debug("Avahi server state change: %i", state)
 
463
        logger.debug("Avahi server state change: %i", state)
492
464
        bad_states = {
493
465
            avahi.SERVER_INVALID: "Zeroconf server invalid",
494
466
            avahi.SERVER_REGISTERING: None,
498
470
        if state in bad_states:
499
471
            if bad_states[state] is not None:
500
472
                if error is None:
501
 
                    log.error(bad_states[state])
 
473
                    logger.error(bad_states[state])
502
474
                else:
503
 
                    log.error(bad_states[state] + ": %r", error)
 
475
                    logger.error(bad_states[state] + ": %r", error)
504
476
            self.cleanup()
505
477
        elif state == avahi.SERVER_RUNNING:
506
478
            try:
508
480
            except dbus.exceptions.DBusException as error:
509
481
                if (error.get_dbus_name()
510
482
                    == "org.freedesktop.Avahi.CollisionError"):
511
 
                    log.info("Local Zeroconf service name collision.")
 
483
                    logger.info("Local Zeroconf service name"
 
484
                                " collision.")
512
485
                    return self.rename(remove=False)
513
486
                else:
514
 
                    log.critical("D-Bus Exception", exc_info=error)
 
487
                    logger.critical("D-Bus Exception", exc_info=error)
515
488
                    self.cleanup()
516
489
                    os._exit(1)
517
490
        else:
518
491
            if error is None:
519
 
                log.debug("Unknown state: %r", state)
 
492
                logger.debug("Unknown state: %r", state)
520
493
            else:
521
 
                log.debug("Unknown state: %r: %r", state, error)
 
494
                logger.debug("Unknown state: %r: %r", state, error)
522
495
 
523
496
    def activate(self):
524
497
        """Derived from the Avahi example code"""
536
509
class AvahiServiceToSyslog(AvahiService):
537
510
    def rename(self, *args, **kwargs):
538
511
        """Add the new name to the syslog messages"""
539
 
        ret = super(AvahiServiceToSyslog, self).rename(*args,
540
 
                                                       **kwargs)
 
512
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
541
513
        syslogger.setFormatter(logging.Formatter(
542
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
514
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
543
515
            .format(self.name)))
544
516
        return ret
545
517
 
575
547
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
576
548
 
577
549
    # Types
578
 
    class _session_int(ctypes.Structure):
 
550
    class session_int(ctypes.Structure):
579
551
        _fields_ = []
580
 
    session_t = ctypes.POINTER(_session_int)
 
552
    session_t = ctypes.POINTER(session_int)
581
553
 
582
554
    class certificate_credentials_st(ctypes.Structure):
583
555
        _fields_ = []
586
558
    certificate_type_t = ctypes.c_int
587
559
 
588
560
    class datum_t(ctypes.Structure):
589
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
590
 
                    ("size", ctypes.c_uint)]
 
561
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
562
                    ('size', ctypes.c_uint)]
591
563
 
592
 
    class _openpgp_crt_int(ctypes.Structure):
 
564
    class openpgp_crt_int(ctypes.Structure):
593
565
        _fields_ = []
594
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
566
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
595
567
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
596
568
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
597
569
    credentials_type_t = ctypes.c_int
606
578
            # gnutls.strerror()
607
579
            self.code = code
608
580
            if message is None and code is not None:
609
 
                message = gnutls.strerror(code).decode(
610
 
                    "utf-8", errors="replace")
 
581
                message = gnutls.strerror(code)
611
582
            return super(gnutls.Error, self).__init__(
612
583
                message, *args)
613
584
 
614
585
    class CertificateSecurityError(Error):
615
586
        pass
616
587
 
617
 
    class PointerTo:
618
 
        def __init__(self, cls):
619
 
            self.cls = cls
620
 
 
621
 
        def from_param(self, obj):
622
 
            if not isinstance(obj, self.cls):
623
 
                raise TypeError("Not of type {}: {!r}"
624
 
                                .format(self.cls.__name__, obj))
625
 
            return ctypes.byref(obj.from_param(obj))
626
 
 
627
 
    class CastToVoidPointer:
628
 
        def __init__(self, cls):
629
 
            self.cls = cls
630
 
 
631
 
        def from_param(self, obj):
632
 
            if not isinstance(obj, self.cls):
633
 
                raise TypeError("Not of type {}: {!r}"
634
 
                                .format(self.cls.__name__, obj))
635
 
            return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
636
 
 
637
 
    class With_from_param:
638
 
        @classmethod
639
 
        def from_param(cls, obj):
640
 
            return obj._as_parameter_
641
 
 
642
588
    # Classes
643
 
    class Credentials(With_from_param):
 
589
    class Credentials:
644
590
        def __init__(self):
645
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
646
 
            gnutls.certificate_allocate_credentials(self)
 
591
            self._c_object = gnutls.certificate_credentials_t()
 
592
            gnutls.certificate_allocate_credentials(
 
593
                ctypes.byref(self._c_object))
647
594
            self.type = gnutls.CRD_CERTIFICATE
648
595
 
649
596
        def __del__(self):
650
 
            gnutls.certificate_free_credentials(self)
 
597
            gnutls.certificate_free_credentials(self._c_object)
651
598
 
652
 
    class ClientSession(With_from_param):
 
599
    class ClientSession:
653
600
        def __init__(self, socket, credentials=None):
654
 
            self._as_parameter_ = gnutls.session_t()
 
601
            self._c_object = gnutls.session_t()
655
602
            gnutls_flags = gnutls.CLIENT
656
603
            if gnutls.check_version(b"3.5.6"):
657
604
                gnutls_flags |= gnutls.NO_TICKETS
658
605
            if gnutls.has_rawpk:
659
606
                gnutls_flags |= gnutls.ENABLE_RAWPK
660
 
            gnutls.init(self, gnutls_flags)
 
607
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
661
608
            del gnutls_flags
662
 
            gnutls.set_default_priority(self)
663
 
            gnutls.transport_set_ptr(self, socket.fileno())
664
 
            gnutls.handshake_set_private_extensions(self, True)
 
609
            gnutls.set_default_priority(self._c_object)
 
610
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
611
            gnutls.handshake_set_private_extensions(self._c_object,
 
612
                                                    True)
665
613
            self.socket = socket
666
614
            if credentials is None:
667
615
                credentials = gnutls.Credentials()
668
 
            gnutls.credentials_set(self, credentials.type,
669
 
                                   credentials)
 
616
            gnutls.credentials_set(self._c_object, credentials.type,
 
617
                                   ctypes.cast(credentials._c_object,
 
618
                                               ctypes.c_void_p))
670
619
            self.credentials = credentials
671
620
 
672
621
        def __del__(self):
673
 
            gnutls.deinit(self)
 
622
            gnutls.deinit(self._c_object)
674
623
 
675
624
        def handshake(self):
676
 
            return gnutls.handshake(self)
 
625
            return gnutls.handshake(self._c_object)
677
626
 
678
627
        def send(self, data):
679
628
            data = bytes(data)
680
629
            data_len = len(data)
681
630
            while data_len > 0:
682
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
631
                data_len -= gnutls.record_send(self._c_object,
 
632
                                               data[-data_len:],
683
633
                                               data_len)
684
634
 
685
635
        def bye(self):
686
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
636
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
687
637
 
688
638
    # Error handling functions
689
639
    def _error_code(result):
690
640
        """A function to raise exceptions on errors, suitable
691
 
        for the "restype" attribute on ctypes functions"""
692
 
        if result >= gnutls.E_SUCCESS:
 
641
        for the 'restype' attribute on ctypes functions"""
 
642
        if result >= 0:
693
643
            return result
694
644
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
695
645
            raise gnutls.CertificateSecurityError(code=result)
696
646
        raise gnutls.Error(code=result)
697
647
 
698
 
    def _retry_on_error(result, func, arguments,
699
 
                        _error_code=_error_code):
 
648
    def _retry_on_error(result, func, arguments):
700
649
        """A function to retry on some errors, suitable
701
 
        for the "errcheck" attribute on ctypes functions"""
702
 
        while result < gnutls.E_SUCCESS:
 
650
        for the 'errcheck' attribute on ctypes functions"""
 
651
        while result < 0:
703
652
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
704
653
                return _error_code(result)
705
654
            result = func(*arguments)
710
659
 
711
660
    # Functions
712
661
    priority_set_direct = _library.gnutls_priority_set_direct
713
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
662
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
714
663
                                    ctypes.POINTER(ctypes.c_char_p)]
715
664
    priority_set_direct.restype = _error_code
716
665
 
717
666
    init = _library.gnutls_init
718
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
667
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
719
668
    init.restype = _error_code
720
669
 
721
670
    set_default_priority = _library.gnutls_set_default_priority
722
 
    set_default_priority.argtypes = [ClientSession]
 
671
    set_default_priority.argtypes = [session_t]
723
672
    set_default_priority.restype = _error_code
724
673
 
725
674
    record_send = _library.gnutls_record_send
726
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
675
    record_send.argtypes = [session_t, ctypes.c_void_p,
727
676
                            ctypes.c_size_t]
728
677
    record_send.restype = ctypes.c_ssize_t
729
678
    record_send.errcheck = _retry_on_error
731
680
    certificate_allocate_credentials = (
732
681
        _library.gnutls_certificate_allocate_credentials)
733
682
    certificate_allocate_credentials.argtypes = [
734
 
        PointerTo(Credentials)]
 
683
        ctypes.POINTER(certificate_credentials_t)]
735
684
    certificate_allocate_credentials.restype = _error_code
736
685
 
737
686
    certificate_free_credentials = (
738
687
        _library.gnutls_certificate_free_credentials)
739
 
    certificate_free_credentials.argtypes = [Credentials]
 
688
    certificate_free_credentials.argtypes = [
 
689
        certificate_credentials_t]
740
690
    certificate_free_credentials.restype = None
741
691
 
742
692
    handshake_set_private_extensions = (
743
693
        _library.gnutls_handshake_set_private_extensions)
744
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
694
    handshake_set_private_extensions.argtypes = [session_t,
745
695
                                                 ctypes.c_int]
746
696
    handshake_set_private_extensions.restype = None
747
697
 
748
698
    credentials_set = _library.gnutls_credentials_set
749
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
750
 
                                CastToVoidPointer(Credentials)]
 
699
    credentials_set.argtypes = [session_t, credentials_type_t,
 
700
                                ctypes.c_void_p]
751
701
    credentials_set.restype = _error_code
752
702
 
753
703
    strerror = _library.gnutls_strerror
755
705
    strerror.restype = ctypes.c_char_p
756
706
 
757
707
    certificate_type_get = _library.gnutls_certificate_type_get
758
 
    certificate_type_get.argtypes = [ClientSession]
 
708
    certificate_type_get.argtypes = [session_t]
759
709
    certificate_type_get.restype = _error_code
760
710
 
761
711
    certificate_get_peers = _library.gnutls_certificate_get_peers
762
 
    certificate_get_peers.argtypes = [ClientSession,
 
712
    certificate_get_peers.argtypes = [session_t,
763
713
                                      ctypes.POINTER(ctypes.c_uint)]
764
714
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
765
715
 
772
722
    global_set_log_function.restype = None
773
723
 
774
724
    deinit = _library.gnutls_deinit
775
 
    deinit.argtypes = [ClientSession]
 
725
    deinit.argtypes = [session_t]
776
726
    deinit.restype = None
777
727
 
778
728
    handshake = _library.gnutls_handshake
779
 
    handshake.argtypes = [ClientSession]
780
 
    handshake.restype = ctypes.c_int
 
729
    handshake.argtypes = [session_t]
 
730
    handshake.restype = _error_code
781
731
    handshake.errcheck = _retry_on_error
782
732
 
783
733
    transport_set_ptr = _library.gnutls_transport_set_ptr
784
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
734
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
785
735
    transport_set_ptr.restype = None
786
736
 
787
737
    bye = _library.gnutls_bye
788
 
    bye.argtypes = [ClientSession, close_request_t]
789
 
    bye.restype = ctypes.c_int
 
738
    bye.argtypes = [session_t, close_request_t]
 
739
    bye.restype = _error_code
790
740
    bye.errcheck = _retry_on_error
791
741
 
792
742
    check_version = _library.gnutls_check_version
809
759
 
810
760
        x509_crt_fmt_t = ctypes.c_int
811
761
 
812
 
        # All the function declarations below are from
813
 
        # gnutls/abstract.h
 
762
        # All the function declarations below are from gnutls/abstract.h
814
763
        pubkey_init = _library.gnutls_pubkey_init
815
764
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
816
765
        pubkey_init.restype = _error_code
830
779
        pubkey_deinit.argtypes = [pubkey_t]
831
780
        pubkey_deinit.restype = None
832
781
    else:
833
 
        # All the function declarations below are from
834
 
        # gnutls/openpgp.h
 
782
        # All the function declarations below are from gnutls/openpgp.h
835
783
 
836
784
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
837
785
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
843
791
                                       openpgp_crt_fmt_t]
844
792
        openpgp_crt_import.restype = _error_code
845
793
 
846
 
        openpgp_crt_verify_self = \
847
 
            _library.gnutls_openpgp_crt_verify_self
848
 
        openpgp_crt_verify_self.argtypes = [
849
 
            openpgp_crt_t,
850
 
            ctypes.c_uint,
851
 
            ctypes.POINTER(ctypes.c_uint),
852
 
        ]
 
794
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
795
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
796
                                            ctypes.POINTER(ctypes.c_uint)]
853
797
        openpgp_crt_verify_self.restype = _error_code
854
798
 
855
799
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
866
810
 
867
811
    if check_version(b"3.6.4"):
868
812
        certificate_type_get2 = _library.gnutls_certificate_type_get2
869
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
813
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
870
814
        certificate_type_get2.restype = _error_code
871
815
 
872
816
    # Remove non-public functions
888
832
    """A representation of a client host served by this server.
889
833
 
890
834
    Attributes:
891
 
    approved:   bool(); None if not yet approved/disapproved
 
835
    approved:   bool(); 'None' if not yet approved/disapproved
892
836
    approval_delay: datetime.timedelta(); Time to wait for approval
893
837
    approval_duration: datetime.timedelta(); Duration of one approval
894
838
    checker: multiprocessing.Process(); a running checker process used
895
 
             to see if the client lives. None if no process is
 
839
             to see if the client lives. 'None' if no process is
896
840
             running.
897
841
    checker_callback_tag: a GLib event source tag, or None
898
842
    checker_command: string; External command which is run to check
974
918
            # key_id() and fingerprint() functions
975
919
            client["key_id"] = (section.get("key_id", "").upper()
976
920
                                .replace(" ", ""))
977
 
            client["fingerprint"] = (section.get("fingerprint",
978
 
                                                 "").upper()
 
921
            client["fingerprint"] = (section["fingerprint"].upper()
979
922
                                     .replace(" ", ""))
980
 
            if not (client["key_id"] or client["fingerprint"]):
981
 
                log.error("Skipping client %s without key_id or"
982
 
                          " fingerprint", client_name)
983
 
                del settings[client_name]
984
 
                continue
985
923
            if "secret" in section:
986
924
                client["secret"] = codecs.decode(section["secret"]
987
925
                                                 .encode("utf-8"),
1028
966
            self.last_enabled = None
1029
967
            self.expires = None
1030
968
 
1031
 
        log.debug("Creating client %r", self.name)
1032
 
        log.debug("  Key ID: %s", self.key_id)
1033
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
969
        logger.debug("Creating client %r", self.name)
 
970
        logger.debug("  Key ID: %s", self.key_id)
 
971
        logger.debug("  Fingerprint: %s", self.fingerprint)
1034
972
        self.created = settings.get("created",
1035
973
                                    datetime.datetime.utcnow())
1036
974
 
1064
1002
        if getattr(self, "enabled", False):
1065
1003
            # Already enabled
1066
1004
            return
 
1005
        self.expires = datetime.datetime.utcnow() + self.timeout
1067
1006
        self.enabled = True
1068
1007
        self.last_enabled = datetime.datetime.utcnow()
1069
1008
        self.init_checker()
1074
1013
        if not getattr(self, "enabled", False):
1075
1014
            return False
1076
1015
        if not quiet:
1077
 
            log.info("Disabling client %s", self.name)
 
1016
            logger.info("Disabling client %s", self.name)
1078
1017
        if getattr(self, "disable_initiator_tag", None) is not None:
1079
1018
            GLib.source_remove(self.disable_initiator_tag)
1080
1019
            self.disable_initiator_tag = None
1092
1031
    def __del__(self):
1093
1032
        self.disable()
1094
1033
 
1095
 
    def init_checker(self, randomize_start=False):
1096
 
        # Schedule a new checker to be started a randomly selected
1097
 
        # time (a fraction of 'interval') from now.  This spreads out
1098
 
        # the startup of checkers over time when the server is
1099
 
        # started.
 
1034
    def init_checker(self):
 
1035
        # Schedule a new checker to be started an 'interval' from now,
 
1036
        # and every interval from then on.
1100
1037
        if self.checker_initiator_tag is not None:
1101
1038
            GLib.source_remove(self.checker_initiator_tag)
1102
 
        interval_milliseconds = int(self.interval.total_seconds()
1103
 
                                    * 1000)
1104
 
        if randomize_start:
1105
 
            delay_milliseconds = random.randrange(
1106
 
                interval_milliseconds + 1)
1107
 
        else:
1108
 
            delay_milliseconds = interval_milliseconds
1109
1039
        self.checker_initiator_tag = GLib.timeout_add(
1110
 
            delay_milliseconds, self.start_checker, randomize_start)
1111
 
        delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1112
 
        # A checker might take up to an 'interval' of time, so we can
1113
 
        # expire at the soonest one interval after a checker was
1114
 
        # started.  Since the initial checker is delayed, the expire
1115
 
        # time might have to be extended.
1116
 
        now = datetime.datetime.utcnow()
1117
 
        self.expires = now + delay + self.interval
1118
 
        # Schedule a disable() at expire time
 
1040
            int(self.interval.total_seconds() * 1000),
 
1041
            self.start_checker)
 
1042
        # Schedule a disable() when 'timeout' has passed
1119
1043
        if self.disable_initiator_tag is not None:
1120
1044
            GLib.source_remove(self.disable_initiator_tag)
1121
1045
        self.disable_initiator_tag = GLib.timeout_add(
1122
 
            int((self.expires - now).total_seconds() * 1000),
1123
 
            self.disable)
 
1046
            int(self.timeout.total_seconds() * 1000), self.disable)
 
1047
        # Also start a new checker *right now*.
 
1048
        self.start_checker()
1124
1049
 
1125
1050
    def checker_callback(self, source, condition, connection,
1126
1051
                         command):
1128
1053
        # Read return code from connection (see call_pipe)
1129
1054
        returncode = connection.recv()
1130
1055
        connection.close()
1131
 
        if self.checker is not None:
1132
 
            self.checker.join()
 
1056
        self.checker.join()
1133
1057
        self.checker_callback_tag = None
1134
1058
        self.checker = None
1135
1059
 
1137
1061
            self.last_checker_status = returncode
1138
1062
            self.last_checker_signal = None
1139
1063
            if self.last_checker_status == 0:
1140
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1064
                logger.info("Checker for %(name)s succeeded",
 
1065
                            vars(self))
1141
1066
                self.checked_ok()
1142
1067
            else:
1143
 
                log.info("Checker for %(name)s failed", vars(self))
 
1068
                logger.info("Checker for %(name)s failed", vars(self))
1144
1069
        else:
1145
1070
            self.last_checker_status = -1
1146
1071
            self.last_checker_signal = -returncode
1147
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1072
            logger.warning("Checker for %(name)s crashed?",
 
1073
                           vars(self))
1148
1074
        return False
1149
1075
 
1150
1076
    def checked_ok(self):
1169
1095
    def need_approval(self):
1170
1096
        self.last_approval_request = datetime.datetime.utcnow()
1171
1097
 
1172
 
    def start_checker(self, start_was_randomized=False):
 
1098
    def start_checker(self):
1173
1099
        """Start a new checker subprocess if one is not running.
1174
1100
 
1175
1101
        If a checker already exists, leave it running and do
1184
1110
        # should be.
1185
1111
 
1186
1112
        if self.checker is not None and not self.checker.is_alive():
1187
 
            log.warning("Checker was not alive; joining")
 
1113
            logger.warning("Checker was not alive; joining")
1188
1114
            self.checker.join()
1189
1115
            self.checker = None
1190
1116
        # Start a new checker if needed
1191
1117
        if self.checker is None:
1192
1118
            # Escape attributes for the shell
1193
1119
            escaped_attrs = {
1194
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1120
                attr: re.escape(str(getattr(self, attr)))
1195
1121
                for attr in self.runtime_expansions}
1196
1122
            try:
1197
1123
                command = self.checker_command % escaped_attrs
1198
1124
            except TypeError as error:
1199
 
                log.error('Could not format string "%s"',
1200
 
                          self.checker_command, exc_info=error)
 
1125
                logger.error('Could not format string "%s"',
 
1126
                             self.checker_command,
 
1127
                             exc_info=error)
1201
1128
                return True     # Try again later
1202
1129
            self.current_checker_command = command
1203
 
            log.info("Starting checker %r for %s", command, self.name)
 
1130
            logger.info("Starting checker %r for %s", command,
 
1131
                        self.name)
1204
1132
            # We don't need to redirect stdout and stderr, since
1205
1133
            # in normal mode, that is already done by daemon(),
1206
1134
            # and in debug mode we don't want to.  (Stdin is
1225
1153
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1226
1154
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1227
1155
                self.checker_callback, pipe[0], command)
1228
 
        if start_was_randomized:
1229
 
            # We were started after a random delay; Schedule a new
1230
 
            # checker to be started an 'interval' from now, and every
1231
 
            # interval from then on.
1232
 
            now = datetime.datetime.utcnow()
1233
 
            self.checker_initiator_tag = GLib.timeout_add(
1234
 
                int(self.interval.total_seconds() * 1000),
1235
 
                self.start_checker)
1236
 
            self.expires = max(self.expires, now + self.interval)
1237
 
            # Don't start a new checker again after same random delay
1238
 
            return False
1239
1156
        # Re-run this periodically if run by GLib.timeout_add
1240
1157
        return True
1241
1158
 
1246
1163
            self.checker_callback_tag = None
1247
1164
        if getattr(self, "checker", None) is None:
1248
1165
            return
1249
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1166
        logger.debug("Stopping checker for %(name)s", vars(self))
1250
1167
        self.checker.terminate()
1251
1168
        self.checker = None
1252
1169
 
1279
1196
        func._dbus_name = func.__name__
1280
1197
        if func._dbus_name.endswith("_dbus_property"):
1281
1198
            func._dbus_name = func._dbus_name[:-14]
1282
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1199
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1283
1200
        return func
1284
1201
 
1285
1202
    return decorator
1374
1291
 
1375
1292
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1376
1293
                         out_signature="s",
1377
 
                         path_keyword="object_path",
1378
 
                         connection_keyword="connection")
 
1294
                         path_keyword='object_path',
 
1295
                         connection_keyword='connection')
1379
1296
    def Introspect(self, object_path, connection):
1380
1297
        """Overloading of standard D-Bus method.
1381
1298
 
1430
1347
            document.unlink()
1431
1348
        except (AttributeError, xml.dom.DOMException,
1432
1349
                xml.parsers.expat.ExpatError) as error:
1433
 
            log.error("Failed to override Introspection method",
1434
 
                      exc_info=error)
 
1350
            logger.error("Failed to override Introspection method",
 
1351
                         exc_info=error)
1435
1352
        return xmlstring
1436
1353
 
1437
1354
 
1495
1412
                raise ValueError("Byte arrays not supported for non-"
1496
1413
                                 "'ay' signature {!r}"
1497
1414
                                 .format(prop._dbus_signature))
1498
 
            value = dbus.ByteArray(bytes(value))
 
1415
            value = dbus.ByteArray(b''.join(chr(byte)
 
1416
                                            for byte in value))
1499
1417
        prop(value)
1500
1418
 
1501
1419
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1534
1452
 
1535
1453
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1536
1454
                         out_signature="s",
1537
 
                         path_keyword="object_path",
1538
 
                         connection_keyword="connection")
 
1455
                         path_keyword='object_path',
 
1456
                         connection_keyword='connection')
1539
1457
    def Introspect(self, object_path, connection):
1540
1458
        """Overloading of standard D-Bus method.
1541
1459
 
1597
1515
            document.unlink()
1598
1516
        except (AttributeError, xml.dom.DOMException,
1599
1517
                xml.parsers.expat.ExpatError) as error:
1600
 
            log.error("Failed to override Introspection method",
1601
 
                      exc_info=error)
 
1518
            logger.error("Failed to override Introspection method",
 
1519
                         exc_info=error)
1602
1520
        return xmlstring
1603
1521
 
1604
1522
 
1636
1554
 
1637
1555
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1638
1556
                         out_signature="s",
1639
 
                         path_keyword="object_path",
1640
 
                         connection_keyword="connection")
 
1557
                         path_keyword='object_path',
 
1558
                         connection_keyword='connection')
1641
1559
    def Introspect(self, object_path, connection):
1642
1560
        """Overloading of standard D-Bus method.
1643
1561
 
1668
1586
            document.unlink()
1669
1587
        except (AttributeError, xml.dom.DOMException,
1670
1588
                xml.parsers.expat.ExpatError) as error:
1671
 
            log.error("Failed to override Introspection method",
1672
 
                      exc_info=error)
 
1589
            logger.error("Failed to override Introspection method",
 
1590
                         exc_info=error)
1673
1591
        return xmlstring
1674
1592
 
1675
1593
 
2309
2227
class ProxyClient:
2310
2228
    def __init__(self, child_pipe, key_id, fpr, address):
2311
2229
        self._pipe = child_pipe
2312
 
        self._pipe.send(("init", key_id, fpr, address))
 
2230
        self._pipe.send(('init', key_id, fpr, address))
2313
2231
        if not self._pipe.recv():
2314
2232
            raise KeyError(key_id or fpr)
2315
2233
 
2316
2234
    def __getattribute__(self, name):
2317
 
        if name == "_pipe":
 
2235
        if name == '_pipe':
2318
2236
            return super(ProxyClient, self).__getattribute__(name)
2319
 
        self._pipe.send(("getattr", name))
 
2237
        self._pipe.send(('getattr', name))
2320
2238
        data = self._pipe.recv()
2321
 
        if data[0] == "data":
 
2239
        if data[0] == 'data':
2322
2240
            return data[1]
2323
 
        if data[0] == "function":
 
2241
        if data[0] == 'function':
2324
2242
 
2325
2243
            def func(*args, **kwargs):
2326
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2244
                self._pipe.send(('funcall', name, args, kwargs))
2327
2245
                return self._pipe.recv()[1]
2328
2246
 
2329
2247
            return func
2330
2248
 
2331
2249
    def __setattr__(self, name, value):
2332
 
        if name == "_pipe":
 
2250
        if name == '_pipe':
2333
2251
            return super(ProxyClient, self).__setattr__(name, value)
2334
 
        self._pipe.send(("setattr", name, value))
 
2252
        self._pipe.send(('setattr', name, value))
2335
2253
 
2336
2254
 
2337
2255
class ClientHandler(socketserver.BaseRequestHandler, object):
2342
2260
 
2343
2261
    def handle(self):
2344
2262
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2345
 
            log.info("TCP connection from: %s",
2346
 
                     str(self.client_address))
2347
 
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
 
2263
            logger.info("TCP connection from: %s",
 
2264
                        str(self.client_address))
 
2265
            logger.debug("Pipe FD: %d",
 
2266
                         self.server.child_pipe.fileno())
2348
2267
 
2349
2268
            session = gnutls.ClientSession(self.request)
2350
2269
 
2351
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2270
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2352
2271
            #                       "+AES-256-CBC", "+SHA1",
2353
2272
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2354
2273
            #                       "+DHE-DSS"))
2356
2275
            priority = self.server.gnutls_priority
2357
2276
            if priority is None:
2358
2277
                priority = "NORMAL"
2359
 
            gnutls.priority_set_direct(session,
2360
 
                                       priority.encode("utf-8"), None)
 
2278
            gnutls.priority_set_direct(session._c_object,
 
2279
                                       priority.encode("utf-8"),
 
2280
                                       None)
2361
2281
 
2362
2282
            # Start communication using the Mandos protocol
2363
2283
            # Get protocol number
2364
2284
            line = self.request.makefile().readline()
2365
 
            log.debug("Protocol version: %r", line)
 
2285
            logger.debug("Protocol version: %r", line)
2366
2286
            try:
2367
2287
                if int(line.strip().split()[0]) > 1:
2368
2288
                    raise RuntimeError(line)
2369
2289
            except (ValueError, IndexError, RuntimeError) as error:
2370
 
                log.error("Unknown protocol version: %s", error)
 
2290
                logger.error("Unknown protocol version: %s", error)
2371
2291
                return
2372
2292
 
2373
2293
            # Start GnuTLS connection
2374
2294
            try:
2375
2295
                session.handshake()
2376
2296
            except gnutls.Error as error:
2377
 
                log.warning("Handshake failed: %s", error)
 
2297
                logger.warning("Handshake failed: %s", error)
2378
2298
                # Do not run session.bye() here: the session is not
2379
2299
                # established.  Just abandon the request.
2380
2300
                return
2381
 
            log.debug("Handshake succeeded")
 
2301
            logger.debug("Handshake succeeded")
2382
2302
 
2383
2303
            approval_required = False
2384
2304
            try:
2388
2308
                        key_id = self.key_id(
2389
2309
                            self.peer_certificate(session))
2390
2310
                    except (TypeError, gnutls.Error) as error:
2391
 
                        log.warning("Bad certificate: %s", error)
 
2311
                        logger.warning("Bad certificate: %s", error)
2392
2312
                        return
2393
 
                    log.debug("Key ID: %s",
2394
 
                              key_id.decode("utf-8",
2395
 
                                            errors="replace"))
 
2313
                    logger.debug("Key ID: %s", key_id)
2396
2314
 
2397
2315
                else:
2398
2316
                    key_id = b""
2400
2318
                        fpr = self.fingerprint(
2401
2319
                            self.peer_certificate(session))
2402
2320
                    except (TypeError, gnutls.Error) as error:
2403
 
                        log.warning("Bad certificate: %s", error)
 
2321
                        logger.warning("Bad certificate: %s", error)
2404
2322
                        return
2405
 
                    log.debug("Fingerprint: %s", fpr)
 
2323
                    logger.debug("Fingerprint: %s", fpr)
2406
2324
 
2407
2325
                try:
2408
2326
                    client = ProxyClient(child_pipe, key_id, fpr,
2417
2335
 
2418
2336
                while True:
2419
2337
                    if not client.enabled:
2420
 
                        log.info("Client %s is disabled", client.name)
 
2338
                        logger.info("Client %s is disabled",
 
2339
                                    client.name)
2421
2340
                        if self.server.use_dbus:
2422
2341
                            # Emit D-Bus signal
2423
2342
                            client.Rejected("Disabled")
2427
2346
                        # We are approved or approval is disabled
2428
2347
                        break
2429
2348
                    elif client.approved is None:
2430
 
                        log.info("Client %s needs approval",
2431
 
                                 client.name)
 
2349
                        logger.info("Client %s needs approval",
 
2350
                                    client.name)
2432
2351
                        if self.server.use_dbus:
2433
2352
                            # Emit D-Bus signal
2434
2353
                            client.NeedApproval(
2435
2354
                                client.approval_delay.total_seconds()
2436
2355
                                * 1000, client.approved_by_default)
2437
2356
                    else:
2438
 
                        log.warning("Client %s was not approved",
2439
 
                                    client.name)
 
2357
                        logger.warning("Client %s was not approved",
 
2358
                                       client.name)
2440
2359
                        if self.server.use_dbus:
2441
2360
                            # Emit D-Bus signal
2442
2361
                            client.Rejected("Denied")
2450
2369
                    time2 = datetime.datetime.now()
2451
2370
                    if (time2 - time) >= delay:
2452
2371
                        if not client.approved_by_default:
2453
 
                            log.warning("Client %s timed out while"
2454
 
                                        " waiting for approval",
2455
 
                                        client.name)
 
2372
                            logger.warning("Client %s timed out while"
 
2373
                                           " waiting for approval",
 
2374
                                           client.name)
2456
2375
                            if self.server.use_dbus:
2457
2376
                                # Emit D-Bus signal
2458
2377
                                client.Rejected("Approval timed out")
2465
2384
                try:
2466
2385
                    session.send(client.secret)
2467
2386
                except gnutls.Error as error:
2468
 
                    log.warning("gnutls send failed", exc_info=error)
 
2387
                    logger.warning("gnutls send failed",
 
2388
                                   exc_info=error)
2469
2389
                    return
2470
2390
 
2471
 
                log.info("Sending secret to %s", client.name)
 
2391
                logger.info("Sending secret to %s", client.name)
2472
2392
                # bump the timeout using extended_timeout
2473
2393
                client.bump_timeout(client.extended_timeout)
2474
2394
                if self.server.use_dbus:
2481
2401
                try:
2482
2402
                    session.bye()
2483
2403
                except gnutls.Error as error:
2484
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2404
                    logger.warning("GnuTLS bye failed",
 
2405
                                   exc_info=error)
2485
2406
 
2486
2407
    @staticmethod
2487
2408
    def peer_certificate(session):
2488
2409
        "Return the peer's certificate as a bytestring"
2489
2410
        try:
2490
 
            cert_type = gnutls.certificate_type_get2(
2491
 
                session, gnutls.CTYPE_PEERS)
 
2411
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2412
                                                     gnutls.CTYPE_PEERS)
2492
2413
        except AttributeError:
2493
 
            cert_type = gnutls.certificate_type_get(session)
 
2414
            cert_type = gnutls.certificate_type_get(session._c_object)
2494
2415
        if gnutls.has_rawpk:
2495
2416
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2496
2417
        else:
2497
2418
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2498
2419
        # If not a valid certificate type...
2499
2420
        if cert_type not in valid_cert_types:
2500
 
            log.info("Cert type %r not in %r", cert_type,
2501
 
                     valid_cert_types)
 
2421
            logger.info("Cert type %r not in %r", cert_type,
 
2422
                        valid_cert_types)
2502
2423
            # ...return invalid data
2503
2424
            return b""
2504
2425
        list_size = ctypes.c_uint(1)
2505
2426
        cert_list = (gnutls.certificate_get_peers
2506
 
                     (session, ctypes.byref(list_size)))
 
2427
                     (session._c_object, ctypes.byref(list_size)))
2507
2428
        if not bool(cert_list) and list_size.value != 0:
2508
2429
            raise gnutls.Error("error getting peer certificate")
2509
2430
        if list_size.value == 0:
2531
2452
        buf = ctypes.create_string_buffer(32)
2532
2453
        buf_len = ctypes.c_size_t(len(buf))
2533
2454
        # Get the key ID from the raw public key into the buffer
2534
 
        gnutls.pubkey_get_key_id(
2535
 
            pubkey,
2536
 
            gnutls.KEYID_USE_SHA256,
2537
 
            ctypes.cast(ctypes.byref(buf),
2538
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2539
 
            ctypes.byref(buf_len))
 
2455
        gnutls.pubkey_get_key_id(pubkey,
 
2456
                                 gnutls.KEYID_USE_SHA256,
 
2457
                                 ctypes.cast(ctypes.byref(buf),
 
2458
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2459
                                 ctypes.byref(buf_len))
2540
2460
        # Deinit the certificate
2541
2461
        gnutls.pubkey_deinit(pubkey)
2542
2462
 
2623
2543
 
2624
2544
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2625
2545
                     socketserver.TCPServer):
2626
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2546
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2627
2547
 
2628
2548
    Attributes:
2629
2549
        enabled:        Boolean; whether this server is activated yet
2680
2600
            if SO_BINDTODEVICE is None:
2681
2601
                # Fall back to a hard-coded value which seems to be
2682
2602
                # common enough.
2683
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2603
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2684
2604
                SO_BINDTODEVICE = 25
2685
2605
            try:
2686
2606
                self.socket.setsockopt(
2688
2608
                    (self.interface + "\0").encode("utf-8"))
2689
2609
            except socket.error as error:
2690
2610
                if error.errno == errno.EPERM:
2691
 
                    log.error("No permission to bind to interface %s",
2692
 
                              self.interface)
 
2611
                    logger.error("No permission to bind to"
 
2612
                                 " interface %s", self.interface)
2693
2613
                elif error.errno == errno.ENOPROTOOPT:
2694
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2695
 
                              " bind to interface %s", self.interface)
 
2614
                    logger.error("SO_BINDTODEVICE not available;"
 
2615
                                 " cannot bind to interface %s",
 
2616
                                 self.interface)
2696
2617
                elif error.errno == errno.ENODEV:
2697
 
                    log.error("Interface %s does not exist, cannot"
2698
 
                              " bind", self.interface)
 
2618
                    logger.error("Interface %s does not exist,"
 
2619
                                 " cannot bind", self.interface)
2699
2620
                else:
2700
2621
                    raise
2701
2622
        # Only bind(2) the socket if we really need to.
2780
2701
        request = parent_pipe.recv()
2781
2702
        command = request[0]
2782
2703
 
2783
 
        if command == "init":
 
2704
        if command == 'init':
2784
2705
            key_id = request[1].decode("ascii")
2785
2706
            fpr = request[2].decode("ascii")
2786
2707
            address = request[3]
2787
2708
 
2788
2709
            for c in self.clients.values():
2789
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2790
 
                              "27AE41E4649B934CA495991B7852B855"):
 
2710
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2791
2711
                    continue
2792
2712
                if key_id and c.key_id == key_id:
2793
2713
                    client = c
2796
2716
                    client = c
2797
2717
                    break
2798
2718
            else:
2799
 
                log.info("Client not found for key ID: %s, address:"
2800
 
                         " %s", key_id or fpr, address)
 
2719
                logger.info("Client not found for key ID: %s, address"
 
2720
                            ": %s", key_id or fpr, address)
2801
2721
                if self.use_dbus:
2802
2722
                    # Emit D-Bus signal
2803
2723
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2816
2736
            # remove the old hook in favor of the new above hook on
2817
2737
            # same fileno
2818
2738
            return False
2819
 
        if command == "funcall":
 
2739
        if command == 'funcall':
2820
2740
            funcname = request[1]
2821
2741
            args = request[2]
2822
2742
            kwargs = request[3]
2823
2743
 
2824
 
            parent_pipe.send(("data", getattr(client_object,
 
2744
            parent_pipe.send(('data', getattr(client_object,
2825
2745
                                              funcname)(*args,
2826
2746
                                                        **kwargs)))
2827
2747
 
2828
 
        if command == "getattr":
 
2748
        if command == 'getattr':
2829
2749
            attrname = request[1]
2830
2750
            if isinstance(client_object.__getattribute__(attrname),
2831
 
                          collections.abc.Callable):
2832
 
                parent_pipe.send(("function", ))
 
2751
                          collections.Callable):
 
2752
                parent_pipe.send(('function', ))
2833
2753
            else:
2834
2754
                parent_pipe.send((
2835
 
                    "data", client_object.__getattribute__(attrname)))
 
2755
                    'data', client_object.__getattribute__(attrname)))
2836
2756
 
2837
 
        if command == "setattr":
 
2757
        if command == 'setattr':
2838
2758
            attrname = request[1]
2839
2759
            value = request[2]
2840
2760
            setattr(client_object, attrname, value)
2845
2765
def rfc3339_duration_to_delta(duration):
2846
2766
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2847
2767
 
2848
 
    >>> timedelta = datetime.timedelta
2849
 
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2850
 
    True
2851
 
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2852
 
    True
2853
 
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2854
 
    True
2855
 
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2856
 
    True
2857
 
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2858
 
    True
2859
 
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2860
 
    True
2861
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2862
 
    True
2863
 
    >>> del timedelta
 
2768
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
 
2769
    True
 
2770
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
 
2771
    True
 
2772
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
 
2773
    True
 
2774
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
 
2775
    True
 
2776
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
 
2777
    True
 
2778
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
 
2779
    True
 
2780
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
 
2781
    True
2864
2782
    """
2865
2783
 
2866
2784
    # Parsing an RFC 3339 duration with regular expressions is not
2946
2864
def string_to_delta(interval):
2947
2865
    """Parse a string and return a datetime.timedelta
2948
2866
 
2949
 
    >>> string_to_delta("7d") == datetime.timedelta(7)
2950
 
    True
2951
 
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
2952
 
    True
2953
 
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2954
 
    True
2955
 
    >>> string_to_delta("24h") == datetime.timedelta(1)
2956
 
    True
2957
 
    >>> string_to_delta("1w") == datetime.timedelta(7)
2958
 
    True
2959
 
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
 
2867
    >>> string_to_delta('7d') == datetime.timedelta(7)
 
2868
    True
 
2869
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
 
2870
    True
 
2871
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
 
2872
    True
 
2873
    >>> string_to_delta('24h') == datetime.timedelta(1)
 
2874
    True
 
2875
    >>> string_to_delta('1w') == datetime.timedelta(7)
 
2876
    True
 
2877
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2960
2878
    True
2961
2879
    """
2962
2880
 
3109
3027
        # Later, stdin will, and stdout and stderr might, be dup'ed
3110
3028
        # over with an opened os.devnull.  But we don't want this to
3111
3029
        # happen with a supplied network socket.
3112
 
        while 0 <= server_settings["socket"] <= 2:
 
3030
        if 0 <= server_settings["socket"] <= 2:
3113
3031
            server_settings["socket"] = os.dup(server_settings
3114
3032
                                               ["socket"])
3115
 
        os.set_inheritable(server_settings["socket"], False)
3116
3033
    del server_config
3117
3034
 
3118
3035
    # Override the settings from the config file with command line
3167
3084
 
3168
3085
    if server_settings["servicename"] != "Mandos":
3169
3086
        syslogger.setFormatter(
3170
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3171
 
                              " %(levelname)s: %(message)s".format(
 
3087
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3088
                              ' %(levelname)s: %(message)s'.format(
3172
3089
                                  server_settings["servicename"])))
3173
3090
 
3174
3091
    # Parse config file with clients
3198
3115
        try:
3199
3116
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3200
3117
        except IOError as e:
3201
 
            log.error("Could not open file %r", pidfilename,
3202
 
                      exc_info=e)
 
3118
            logger.error("Could not open file %r", pidfilename,
 
3119
                         exc_info=e)
3203
3120
 
3204
3121
    for name, group in (("_mandos", "_mandos"),
3205
3122
                        ("mandos", "mandos"),
3216
3133
    try:
3217
3134
        os.setgid(gid)
3218
3135
        os.setuid(uid)
3219
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3136
        if debug:
 
3137
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3138
                                                             gid))
3220
3139
    except OSError as error:
3221
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3222
 
                    os.strerror(error.errno))
 
3140
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3141
                       .format(uid, gid, os.strerror(error.errno)))
3223
3142
        if error.errno != errno.EPERM:
3224
3143
            raise
3225
3144
 
3232
3151
 
3233
3152
        @gnutls.log_func
3234
3153
        def debug_gnutls(level, string):
3235
 
            log.debug("GnuTLS: %s",
3236
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3154
            logger.debug("GnuTLS: %s", string[:-1])
3237
3155
 
3238
3156
        gnutls.global_set_log_function(debug_gnutls)
3239
3157
 
3257
3175
    # From the Avahi example code
3258
3176
    DBusGMainLoop(set_as_default=True)
3259
3177
    main_loop = GLib.MainLoop()
3260
 
    if use_dbus or zeroconf:
3261
 
        bus = dbus.SystemBus()
 
3178
    bus = dbus.SystemBus()
3262
3179
    # End of Avahi example code
3263
3180
    if use_dbus:
3264
3181
        try:
3269
3186
                "se.bsnet.fukt.Mandos", bus,
3270
3187
                do_not_queue=True)
3271
3188
        except dbus.exceptions.DBusException as e:
3272
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3189
            logger.error("Disabling D-Bus:", exc_info=e)
3273
3190
            use_dbus = False
3274
3191
            server_settings["use_dbus"] = False
3275
3192
            tcp_server.use_dbus = False
3334
3251
                             if isinstance(s, bytes)
3335
3252
                             else s) for s in
3336
3253
                            value["client_structure"]]
3337
 
                        # .name, .host, and .checker_command
3338
 
                        for k in ("name", "host", "checker_command"):
 
3254
                        # .name & .host
 
3255
                        for k in ("name", "host"):
3339
3256
                            if isinstance(value[k], bytes):
3340
3257
                                value[k] = value[k].decode("utf-8")
3341
3258
                        if "key_id" not in value:
3351
3268
                        for key, value in
3352
3269
                        bytes_old_client_settings.items()}
3353
3270
                    del bytes_old_client_settings
3354
 
                    # .host and .checker_command
 
3271
                    # .host
3355
3272
                    for value in old_client_settings.values():
3356
 
                        for attribute in ("host", "checker_command"):
3357
 
                            if isinstance(value[attribute], bytes):
3358
 
                                value[attribute] = (value[attribute]
3359
 
                                                    .decode("utf-8"))
 
3273
                        if isinstance(value["host"], bytes):
 
3274
                            value["host"] = (value["host"]
 
3275
                                             .decode("utf-8"))
3360
3276
            os.remove(stored_state_path)
3361
3277
        except IOError as e:
3362
3278
            if e.errno == errno.ENOENT:
3363
 
                log.warning("Could not load persistent state:"
3364
 
                            " %s", os.strerror(e.errno))
 
3279
                logger.warning("Could not load persistent state:"
 
3280
                               " {}".format(os.strerror(e.errno)))
3365
3281
            else:
3366
 
                log.critical("Could not load persistent state:",
3367
 
                             exc_info=e)
 
3282
                logger.critical("Could not load persistent state:",
 
3283
                                exc_info=e)
3368
3284
                raise
3369
3285
        except EOFError as e:
3370
 
            log.warning("Could not load persistent state: EOFError:",
3371
 
                        exc_info=e)
 
3286
            logger.warning("Could not load persistent state: "
 
3287
                           "EOFError:",
 
3288
                           exc_info=e)
3372
3289
 
3373
3290
    with PGPEngine() as pgp:
3374
3291
        for client_name, client in clients_data.items():
3401
3318
            if client["enabled"]:
3402
3319
                if datetime.datetime.utcnow() >= client["expires"]:
3403
3320
                    if not client["last_checked_ok"]:
3404
 
                        log.warning("disabling client %s - Client"
3405
 
                                    " never performed a successful"
3406
 
                                    " checker", client_name)
 
3321
                        logger.warning(
 
3322
                            "disabling client {} - Client never "
 
3323
                            "performed a successful checker".format(
 
3324
                                client_name))
3407
3325
                        client["enabled"] = False
3408
3326
                    elif client["last_checker_status"] != 0:
3409
 
                        log.warning("disabling client %s - Client"
3410
 
                                    " last checker failed with error"
3411
 
                                    " code %s", client_name,
3412
 
                                    client["last_checker_status"])
 
3327
                        logger.warning(
 
3328
                            "disabling client {} - Client last"
 
3329
                            " checker failed with error code"
 
3330
                            " {}".format(
 
3331
                                client_name,
 
3332
                                client["last_checker_status"]))
3413
3333
                        client["enabled"] = False
3414
3334
                    else:
3415
3335
                        client["expires"] = (
3416
3336
                            datetime.datetime.utcnow()
3417
3337
                            + client["timeout"])
3418
 
                        log.debug("Last checker succeeded, keeping %s"
3419
 
                                  " enabled", client_name)
 
3338
                        logger.debug("Last checker succeeded,"
 
3339
                                     " keeping {} enabled".format(
 
3340
                                         client_name))
3420
3341
            try:
3421
3342
                client["secret"] = pgp.decrypt(
3422
3343
                    client["encrypted_secret"],
3423
3344
                    client_settings[client_name]["secret"])
3424
3345
            except PGPError:
3425
3346
                # If decryption fails, we use secret from new settings
3426
 
                log.debug("Failed to decrypt %s old secret",
3427
 
                          client_name)
 
3347
                logger.debug("Failed to decrypt {} old secret".format(
 
3348
                    client_name))
3428
3349
                client["secret"] = (client_settings[client_name]
3429
3350
                                    ["secret"])
3430
3351
 
3444
3365
            server_settings=server_settings)
3445
3366
 
3446
3367
    if not tcp_server.clients:
3447
 
        log.warning("No clients defined")
 
3368
        logger.warning("No clients defined")
3448
3369
 
3449
3370
    if not foreground:
3450
3371
        if pidfile is not None:
3453
3374
                with pidfile:
3454
3375
                    print(pid, file=pidfile)
3455
3376
            except IOError:
3456
 
                log.error("Could not write to file %r with PID %d",
3457
 
                          pidfilename, pid)
 
3377
                logger.error("Could not write to file %r with PID %d",
 
3378
                             pidfilename, pid)
3458
3379
        del pidfile
3459
3380
        del pidfilename
3460
3381
 
3610
3531
 
3611
3532
        try:
3612
3533
            with tempfile.NamedTemporaryFile(
3613
 
                    mode="wb",
 
3534
                    mode='wb',
3614
3535
                    suffix=".pickle",
3615
 
                    prefix="clients-",
 
3536
                    prefix='clients-',
3616
3537
                    dir=os.path.dirname(stored_state_path),
3617
3538
                    delete=False) as stored_state:
3618
3539
                pickle.dump((clients, client_settings), stored_state,
3626
3547
                except NameError:
3627
3548
                    pass
3628
3549
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3629
 
                log.warning("Could not save persistent state: %s",
3630
 
                            os.strerror(e.errno))
 
3550
                logger.warning("Could not save persistent state: {}"
 
3551
                               .format(os.strerror(e.errno)))
3631
3552
            else:
3632
 
                log.warning("Could not save persistent state:",
3633
 
                            exc_info=e)
 
3553
                logger.warning("Could not save persistent state:",
 
3554
                               exc_info=e)
3634
3555
                raise
3635
3556
 
3636
3557
        # Delete all clients, and settings from config
3653
3574
            mandos_dbus_service.client_added_signal(client)
3654
3575
        # Need to initiate checking of clients
3655
3576
        if client.enabled:
3656
 
            client.init_checker(randomize_start=True)
 
3577
            client.init_checker()
3657
3578
 
3658
3579
    tcp_server.enable()
3659
3580
    tcp_server.server_activate()
3662
3583
    if zeroconf:
3663
3584
        service.port = tcp_server.socket.getsockname()[1]
3664
3585
    if use_ipv6:
3665
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3666
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3586
        logger.info("Now listening on address %r, port %d,"
 
3587
                    " flowinfo %d, scope_id %d",
 
3588
                    *tcp_server.socket.getsockname())
3667
3589
    else:                       # IPv4
3668
 
        log.info("Now listening on address %r, port %d",
3669
 
                 *tcp_server.socket.getsockname())
 
3590
        logger.info("Now listening on address %r, port %d",
 
3591
                    *tcp_server.socket.getsockname())
3670
3592
 
3671
3593
    # service.interface = tcp_server.socket.getsockname()[3]
3672
3594
 
3676
3598
            try:
3677
3599
                service.activate()
3678
3600
            except dbus.exceptions.DBusException as error:
3679
 
                log.critical("D-Bus Exception", exc_info=error)
 
3601
                logger.critical("D-Bus Exception", exc_info=error)
3680
3602
                cleanup()
3681
3603
                sys.exit(1)
3682
3604
            # End of Avahi example code
3687
3609
            lambda *args, **kwargs: (tcp_server.handle_request
3688
3610
                                     (*args[2:], **kwargs) or True))
3689
3611
 
3690
 
        log.debug("Starting main loop")
 
3612
        logger.debug("Starting main loop")
3691
3613
        main_loop.run()
3692
3614
    except AvahiError as error:
3693
 
        log.critical("Avahi Error", exc_info=error)
 
3615
        logger.critical("Avahi Error", exc_info=error)
3694
3616
        cleanup()
3695
3617
        sys.exit(1)
3696
3618
    except KeyboardInterrupt:
3697
3619
        if debug:
3698
3620
            print("", file=sys.stderr)
3699
 
        log.debug("Server received KeyboardInterrupt")
3700
 
    log.debug("Server exiting")
 
3621
        logger.debug("Server received KeyboardInterrupt")
 
3622
    logger.debug("Server exiting")
3701
3623
    # Must run before the D-Bus bus name gets deregistered
3702
3624
    cleanup()
3703
3625
 
3704
3626
 
3705
 
def parse_test_args():
3706
 
    # type: () -> argparse.Namespace
 
3627
def should_only_run_tests():
3707
3628
    parser = argparse.ArgumentParser(add_help=False)
3708
 
    parser.add_argument("--check", action="store_true")
3709
 
    parser.add_argument("--prefix", )
 
3629
    parser.add_argument("--check", action='store_true')
3710
3630
    args, unknown_args = parser.parse_known_args()
3711
 
    if args.check:
3712
 
        # Remove test options from sys.argv
 
3631
    run_tests = args.check
 
3632
    if run_tests:
 
3633
        # Remove --check argument from sys.argv
3713
3634
        sys.argv[1:] = unknown_args
3714
 
    return args
 
3635
    return run_tests
3715
3636
 
3716
3637
# Add all tests from doctest strings
3717
3638
def load_tests(loader, tests, none):
3719
3640
    tests.addTests(doctest.DocTestSuite())
3720
3641
    return tests
3721
3642
 
3722
 
if __name__ == "__main__":
3723
 
    options = parse_test_args()
 
3643
if __name__ == '__main__':
3724
3644
    try:
3725
 
        if options.check:
3726
 
            extra_test_prefix = options.prefix
3727
 
            if extra_test_prefix is not None:
3728
 
                if not (unittest.main(argv=[""], exit=False)
3729
 
                        .result.wasSuccessful()):
3730
 
                    sys.exit(1)
3731
 
                class ExtraTestLoader(unittest.TestLoader):
3732
 
                    testMethodPrefix = extra_test_prefix
3733
 
                # Call using ./scriptname --test [--verbose]
3734
 
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
3735
 
            else:
3736
 
                unittest.main(argv=[""])
 
3645
        if should_only_run_tests():
 
3646
            # Call using ./mandos --check [--verbose]
 
3647
            unittest.main()
3737
3648
        else:
3738
3649
            main()
3739
3650
    finally:
3740
3651
        logging.shutdown()
3741
 
 
3742
 
# Local Variables:
3743
 
# run-tests:
3744
 
# (lambda (&optional extra)
3745
 
#   (if (not (funcall run-tests-in-test-buffer default-directory
3746
 
#             extra))
3747
 
#       (funcall show-test-buffer-in-test-window)
3748
 
#     (funcall remove-test-window)
3749
 
#     (if extra (message "Extra tests run successfully!"))))
3750
 
# run-tests-in-test-buffer:
3751
 
# (lambda (dir &optional extra)
3752
 
#   (with-current-buffer (get-buffer-create "*Test*")
3753
 
#     (setq buffer-read-only nil
3754
 
#           default-directory dir)
3755
 
#     (erase-buffer)
3756
 
#     (compilation-mode))
3757
 
#   (let ((process-result
3758
 
#          (let ((inhibit-read-only t))
3759
 
#            (process-file-shell-command
3760
 
#             (funcall get-command-line extra) nil "*Test*"))))
3761
 
#     (and (numberp process-result)
3762
 
#          (= process-result 0))))
3763
 
# get-command-line:
3764
 
# (lambda (&optional extra)
3765
 
#   (let ((quoted-script
3766
 
#          (shell-quote-argument (funcall get-script-name))))
3767
 
#     (format
3768
 
#      (concat "%s --check" (if extra " --prefix=atest" ""))
3769
 
#      quoted-script)))
3770
 
# get-script-name:
3771
 
# (lambda ()
3772
 
#   (if (fboundp 'file-local-name)
3773
 
#       (file-local-name (buffer-file-name))
3774
 
#     (or (file-remote-p (buffer-file-name) 'localname)
3775
 
#         (buffer-file-name))))
3776
 
# remove-test-window:
3777
 
# (lambda ()
3778
 
#   (let ((test-window (get-buffer-window "*Test*")))
3779
 
#     (if test-window (delete-window test-window))))
3780
 
# show-test-buffer-in-test-window:
3781
 
# (lambda ()
3782
 
#   (when (not (get-buffer-window-list "*Test*"))
3783
 
#     (setq next-error-last-buffer (get-buffer "*Test*"))
3784
 
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3785
 
#            (display-buffer-overriding-action
3786
 
#             `((display-buffer-in-side-window) (side . ,side)
3787
 
#               (window-height . fit-window-to-buffer)
3788
 
#               (window-width . fit-window-to-buffer))))
3789
 
#       (display-buffer "*Test*"))))
3790
 
# eval:
3791
 
# (progn
3792
 
#   (let* ((run-extra-tests (lambda () (interactive)
3793
 
#                             (funcall run-tests t)))
3794
 
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3795
 
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
3796
 
#     (setq minor-mode-overriding-map-alist
3797
 
#           (cons `(run-tests . ,outer-keymap)
3798
 
#                 minor-mode-overriding-map-alist)))
3799
 
#   (add-hook 'after-save-hook run-tests 90 t))
3800
 
# End: