/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: 2023-02-07 23:45:43 UTC
  • mfrom: (237.7.819 trunk)
  • Revision ID: teddy@recompile.se-20230207234543-z9xxymrxhsncmfus
Merge from trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
 
1
#!/usr/bin/python3 -bI
 
2
# -*- coding: utf-8; lexical-binding: t -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
5
#
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2019 Teddy Hogeborn
15
 
# Copyright © 2008-2019 Björn Påhlsson
 
14
# Copyright © 2008-2022 Teddy Hogeborn
 
15
# Copyright © 2008-2022 Björn Påhlsson
16
16
#
17
17
# This file is part of Mandos.
18
18
#
31
31
#
32
32
# Contact the authors at <mandos@recompile.se>.
33
33
#
34
 
 
35
34
from __future__ import (division, absolute_import, print_function,
36
35
                        unicode_literals)
37
36
 
40
39
except ImportError:
41
40
    pass
42
41
 
 
42
import sys
 
43
import unittest
 
44
import argparse
 
45
import logging
 
46
import os
43
47
try:
44
48
    import SocketServer as socketserver
45
49
except ImportError:
46
50
    import socketserver
47
51
import socket
48
 
import argparse
49
52
import datetime
50
53
import errno
51
54
try:
52
55
    import ConfigParser as configparser
53
56
except ImportError:
54
57
    import configparser
55
 
import sys
56
58
import re
57
 
import os
58
59
import signal
59
60
import subprocess
60
61
import atexit
61
62
import stat
62
 
import logging
63
63
import logging.handlers
64
64
import pwd
65
65
import contextlib
77
77
import itertools
78
78
import collections
79
79
import codecs
 
80
import random
 
81
import shlex
80
82
 
81
83
import dbus
82
84
import dbus.service
88
90
import xml.dom.minidom
89
91
import inspect
90
92
 
 
93
if sys.version_info.major == 2:
 
94
    __metaclass__ = type
 
95
    str = unicode
 
96
    input = raw_input
 
97
 
 
98
# Add collections.abc.Callable if it does not exist
 
99
try:
 
100
    collections.abc.Callable
 
101
except AttributeError:
 
102
    class abc:
 
103
        Callable = collections.Callable
 
104
    collections.abc = abc
 
105
    del abc
 
106
 
 
107
# Add shlex.quote if it does not exist
 
108
try:
 
109
    shlex.quote
 
110
except AttributeError:
 
111
    shlex.quote = re.escape
 
112
 
 
113
# Show warnings by default
 
114
if not sys.warnoptions:
 
115
    import warnings
 
116
    warnings.simplefilter("default")
 
117
 
91
118
# Try to find the value of SO_BINDTODEVICE:
92
119
try:
93
120
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
113
140
            # No value found
114
141
            SO_BINDTODEVICE = None
115
142
 
116
 
if sys.version_info.major == 2:
117
 
    str = unicode
118
 
 
119
143
if sys.version_info < (3, 2):
120
144
    configparser.Configparser = configparser.SafeConfigParser
121
145
 
122
 
version = "1.8.7"
 
146
version = "1.8.15"
123
147
stored_state_file = "clients.pickle"
124
148
 
125
 
logger = logging.getLogger()
 
149
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
150
logging.captureWarnings(True)   # Show warnings via the logging system
126
151
syslogger = None
127
152
 
128
153
try:
164
189
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
165
190
        address="/dev/log"))
166
191
    syslogger.setFormatter(logging.Formatter
167
 
                           ('Mandos [%(process)d]: %(levelname)s:'
168
 
                            ' %(message)s'))
169
 
    logger.addHandler(syslogger)
 
192
                           ("Mandos [%(process)d]: %(levelname)s:"
 
193
                            " %(message)s"))
 
194
    log.addHandler(syslogger)
170
195
 
171
196
    if debug:
172
197
        console = logging.StreamHandler()
173
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
174
 
                                               ' [%(process)d]:'
175
 
                                               ' %(levelname)s:'
176
 
                                               ' %(message)s'))
177
 
        logger.addHandler(console)
178
 
    logger.setLevel(level)
 
198
        console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
 
199
                                               " [%(process)d]:"
 
200
                                               " %(levelname)s:"
 
201
                                               " %(message)s"))
 
202
        log.addHandler(console)
 
203
    log.setLevel(level)
179
204
 
180
205
 
181
206
class PGPError(Exception):
183
208
    pass
184
209
 
185
210
 
186
 
class PGPEngine(object):
 
211
class PGPEngine:
187
212
    """A simple class for OpenPGP symmetric encryption & decryption"""
188
213
 
189
214
    def __init__(self):
193
218
            output = subprocess.check_output(["gpgconf"])
194
219
            for line in output.splitlines():
195
220
                name, text, path = line.split(b":")
196
 
                if name == "gpg":
 
221
                if name == b"gpg":
197
222
                    self.gpg = path
198
223
                    break
199
224
        except OSError as e:
200
225
            if e.errno != errno.ENOENT:
201
226
                raise
202
 
        self.gnupgargs = ['--batch',
203
 
                          '--homedir', self.tempdir,
204
 
                          '--force-mdc',
205
 
                          '--quiet']
 
227
        self.gnupgargs = ["--batch",
 
228
                          "--homedir", self.tempdir,
 
229
                          "--force-mdc",
 
230
                          "--quiet"]
206
231
        # Only GPG version 1 has the --no-use-agent option.
207
 
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
232
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
208
233
            self.gnupgargs.append("--no-use-agent")
209
234
 
210
235
    def __enter__(self):
247
272
                dir=self.tempdir) as passfile:
248
273
            passfile.write(passphrase)
249
274
            passfile.flush()
250
 
            proc = subprocess.Popen([self.gpg, '--symmetric',
251
 
                                     '--passphrase-file',
 
275
            proc = subprocess.Popen([self.gpg, "--symmetric",
 
276
                                     "--passphrase-file",
252
277
                                     passfile.name]
253
278
                                    + self.gnupgargs,
254
279
                                    stdin=subprocess.PIPE,
265
290
                dir=self.tempdir) as passfile:
266
291
            passfile.write(passphrase)
267
292
            passfile.flush()
268
 
            proc = subprocess.Popen([self.gpg, '--decrypt',
269
 
                                     '--passphrase-file',
 
293
            proc = subprocess.Popen([self.gpg, "--decrypt",
 
294
                                     "--passphrase-file",
270
295
                                     passfile.name]
271
296
                                    + self.gnupgargs,
272
297
                                    stdin=subprocess.PIPE,
279
304
 
280
305
 
281
306
# Pretend that we have an Avahi module
282
 
class avahi(object):
 
307
class avahi:
283
308
    """This isn't so much a class as it is a module-like namespace."""
284
309
    IF_UNSPEC = -1               # avahi-common/address.h
285
310
    PROTO_UNSPEC = -1            # avahi-common/address.h
319
344
    pass
320
345
 
321
346
 
322
 
class AvahiService(object):
 
347
class AvahiService:
323
348
    """An Avahi (Zeroconf) service.
324
349
 
325
350
    Attributes:
326
351
    interface: integer; avahi.IF_UNSPEC or an interface index.
327
352
               Used to optionally bind to the specified interface.
328
 
    name: string; Example: 'Mandos'
329
 
    type: string; Example: '_mandos._tcp'.
 
353
    name: string; Example: "Mandos"
 
354
    type: string; Example: "_mandos._tcp".
330
355
     See <https://www.iana.org/assignments/service-names-port-numbers>
331
356
    port: integer; what port to announce
332
357
    TXT: list of strings; TXT record for the service
369
394
    def rename(self, remove=True):
370
395
        """Derived from the Avahi example code"""
371
396
        if self.rename_count >= self.max_renames:
372
 
            logger.critical("No suitable Zeroconf service name found"
373
 
                            " after %i retries, exiting.",
374
 
                            self.rename_count)
 
397
            log.critical("No suitable Zeroconf service name found"
 
398
                         " after %i retries, exiting.",
 
399
                         self.rename_count)
375
400
            raise AvahiServiceError("Too many renames")
376
401
        self.name = str(
377
402
            self.server.GetAlternativeServiceName(self.name))
378
403
        self.rename_count += 1
379
 
        logger.info("Changing Zeroconf service name to %r ...",
380
 
                    self.name)
 
404
        log.info("Changing Zeroconf service name to %r ...",
 
405
                 self.name)
381
406
        if remove:
382
407
            self.remove()
383
408
        try:
385
410
        except dbus.exceptions.DBusException as error:
386
411
            if (error.get_dbus_name()
387
412
                == "org.freedesktop.Avahi.CollisionError"):
388
 
                logger.info("Local Zeroconf service name collision.")
 
413
                log.info("Local Zeroconf service name collision.")
389
414
                return self.rename(remove=False)
390
415
            else:
391
 
                logger.critical("D-Bus Exception", exc_info=error)
 
416
                log.critical("D-Bus Exception", exc_info=error)
392
417
                self.cleanup()
393
418
                os._exit(1)
394
419
 
410
435
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
411
436
        self.entry_group_state_changed_match = (
412
437
            self.group.connect_to_signal(
413
 
                'StateChanged', self.entry_group_state_changed))
414
 
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
415
 
                     self.name, self.type)
 
438
                "StateChanged", self.entry_group_state_changed))
 
439
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
440
                  self.name, self.type)
416
441
        self.group.AddService(
417
442
            self.interface,
418
443
            self.protocol,
425
450
 
426
451
    def entry_group_state_changed(self, state, error):
427
452
        """Derived from the Avahi example code"""
428
 
        logger.debug("Avahi entry group state change: %i", state)
 
453
        log.debug("Avahi entry group state change: %i", state)
429
454
 
430
455
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
431
 
            logger.debug("Zeroconf service established.")
 
456
            log.debug("Zeroconf service established.")
432
457
        elif state == avahi.ENTRY_GROUP_COLLISION:
433
 
            logger.info("Zeroconf service name collision.")
 
458
            log.info("Zeroconf service name collision.")
434
459
            self.rename()
435
460
        elif state == avahi.ENTRY_GROUP_FAILURE:
436
 
            logger.critical("Avahi: Error in group state changed %s",
437
 
                            str(error))
 
461
            log.critical("Avahi: Error in group state changed %s",
 
462
                         str(error))
438
463
            raise AvahiGroupError("State changed: {!s}".format(error))
439
464
 
440
465
    def cleanup(self):
450
475
 
451
476
    def server_state_changed(self, state, error=None):
452
477
        """Derived from the Avahi example code"""
453
 
        logger.debug("Avahi server state change: %i", state)
 
478
        log.debug("Avahi server state change: %i", state)
454
479
        bad_states = {
455
480
            avahi.SERVER_INVALID: "Zeroconf server invalid",
456
481
            avahi.SERVER_REGISTERING: None,
460
485
        if state in bad_states:
461
486
            if bad_states[state] is not None:
462
487
                if error is None:
463
 
                    logger.error(bad_states[state])
 
488
                    log.error(bad_states[state])
464
489
                else:
465
 
                    logger.error(bad_states[state] + ": %r", error)
 
490
                    log.error(bad_states[state] + ": %r", error)
466
491
            self.cleanup()
467
492
        elif state == avahi.SERVER_RUNNING:
468
493
            try:
470
495
            except dbus.exceptions.DBusException as error:
471
496
                if (error.get_dbus_name()
472
497
                    == "org.freedesktop.Avahi.CollisionError"):
473
 
                    logger.info("Local Zeroconf service name"
474
 
                                " collision.")
 
498
                    log.info("Local Zeroconf service name collision.")
475
499
                    return self.rename(remove=False)
476
500
                else:
477
 
                    logger.critical("D-Bus Exception", exc_info=error)
 
501
                    log.critical("D-Bus Exception", exc_info=error)
478
502
                    self.cleanup()
479
503
                    os._exit(1)
480
504
        else:
481
505
            if error is None:
482
 
                logger.debug("Unknown state: %r", state)
 
506
                log.debug("Unknown state: %r", state)
483
507
            else:
484
 
                logger.debug("Unknown state: %r: %r", state, error)
 
508
                log.debug("Unknown state: %r: %r", state, error)
485
509
 
486
510
    def activate(self):
487
511
        """Derived from the Avahi example code"""
499
523
class AvahiServiceToSyslog(AvahiService):
500
524
    def rename(self, *args, **kwargs):
501
525
        """Add the new name to the syslog messages"""
502
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
526
        ret = super(AvahiServiceToSyslog, self).rename(*args,
 
527
                                                       **kwargs)
503
528
        syslogger.setFormatter(logging.Formatter(
504
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
529
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
505
530
            .format(self.name)))
506
531
        return ret
507
532
 
508
533
 
509
534
# Pretend that we have a GnuTLS module
510
 
class gnutls(object):
 
535
class gnutls:
511
536
    """This isn't so much a class as it is a module-like namespace."""
512
537
 
513
538
    library = ctypes.util.find_library("gnutls")
537
562
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
538
563
 
539
564
    # Types
540
 
    class session_int(ctypes.Structure):
 
565
    class _session_int(ctypes.Structure):
541
566
        _fields_ = []
542
 
    session_t = ctypes.POINTER(session_int)
 
567
    session_t = ctypes.POINTER(_session_int)
543
568
 
544
569
    class certificate_credentials_st(ctypes.Structure):
545
570
        _fields_ = []
548
573
    certificate_type_t = ctypes.c_int
549
574
 
550
575
    class datum_t(ctypes.Structure):
551
 
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
 
                    ('size', ctypes.c_uint)]
 
576
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
 
577
                    ("size", ctypes.c_uint)]
553
578
 
554
 
    class openpgp_crt_int(ctypes.Structure):
 
579
    class _openpgp_crt_int(ctypes.Structure):
555
580
        _fields_ = []
556
 
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
581
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
557
582
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
558
583
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
584
    credentials_type_t = ctypes.c_int
568
593
            # gnutls.strerror()
569
594
            self.code = code
570
595
            if message is None and code is not None:
571
 
                message = gnutls.strerror(code)
 
596
                message = gnutls.strerror(code).decode(
 
597
                    "utf-8", errors="replace")
572
598
            return super(gnutls.Error, self).__init__(
573
599
                message, *args)
574
600
 
575
601
    class CertificateSecurityError(Error):
576
602
        pass
577
603
 
 
604
    class PointerTo:
 
605
        def __init__(self, cls):
 
606
            self.cls = cls
 
607
 
 
608
        def from_param(self, obj):
 
609
            if not isinstance(obj, self.cls):
 
610
                raise TypeError("Not of type {}: {!r}"
 
611
                                .format(self.cls.__name__, obj))
 
612
            return ctypes.byref(obj.from_param(obj))
 
613
 
 
614
    class CastToVoidPointer:
 
615
        def __init__(self, cls):
 
616
            self.cls = cls
 
617
 
 
618
        def from_param(self, obj):
 
619
            if not isinstance(obj, self.cls):
 
620
                raise TypeError("Not of type {}: {!r}"
 
621
                                .format(self.cls.__name__, obj))
 
622
            return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
 
623
 
 
624
    class With_from_param:
 
625
        @classmethod
 
626
        def from_param(cls, obj):
 
627
            return obj._as_parameter_
 
628
 
578
629
    # Classes
579
 
    class Credentials(object):
 
630
    class Credentials(With_from_param):
580
631
        def __init__(self):
581
 
            self._c_object = gnutls.certificate_credentials_t()
582
 
            gnutls.certificate_allocate_credentials(
583
 
                ctypes.byref(self._c_object))
 
632
            self._as_parameter_ = gnutls.certificate_credentials_t()
 
633
            gnutls.certificate_allocate_credentials(self)
584
634
            self.type = gnutls.CRD_CERTIFICATE
585
635
 
586
636
        def __del__(self):
587
 
            gnutls.certificate_free_credentials(self._c_object)
 
637
            gnutls.certificate_free_credentials(self)
588
638
 
589
 
    class ClientSession(object):
 
639
    class ClientSession(With_from_param):
590
640
        def __init__(self, socket, credentials=None):
591
 
            self._c_object = gnutls.session_t()
 
641
            self._as_parameter_ = gnutls.session_t()
592
642
            gnutls_flags = gnutls.CLIENT
593
643
            if gnutls.check_version(b"3.5.6"):
594
644
                gnutls_flags |= gnutls.NO_TICKETS
595
645
            if gnutls.has_rawpk:
596
646
                gnutls_flags |= gnutls.ENABLE_RAWPK
597
 
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
 
647
            gnutls.init(self, gnutls_flags)
598
648
            del gnutls_flags
599
 
            gnutls.set_default_priority(self._c_object)
600
 
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
601
 
            gnutls.handshake_set_private_extensions(self._c_object,
602
 
                                                    True)
 
649
            gnutls.set_default_priority(self)
 
650
            gnutls.transport_set_ptr(self, socket.fileno())
 
651
            gnutls.handshake_set_private_extensions(self, True)
603
652
            self.socket = socket
604
653
            if credentials is None:
605
654
                credentials = gnutls.Credentials()
606
 
            gnutls.credentials_set(self._c_object, credentials.type,
607
 
                                   ctypes.cast(credentials._c_object,
608
 
                                               ctypes.c_void_p))
 
655
            gnutls.credentials_set(self, credentials.type,
 
656
                                   credentials)
609
657
            self.credentials = credentials
610
658
 
611
659
        def __del__(self):
612
 
            gnutls.deinit(self._c_object)
 
660
            gnutls.deinit(self)
613
661
 
614
662
        def handshake(self):
615
 
            return gnutls.handshake(self._c_object)
 
663
            return gnutls.handshake(self)
616
664
 
617
665
        def send(self, data):
618
666
            data = bytes(data)
619
667
            data_len = len(data)
620
668
            while data_len > 0:
621
 
                data_len -= gnutls.record_send(self._c_object,
622
 
                                               data[-data_len:],
 
669
                data_len -= gnutls.record_send(self, data[-data_len:],
623
670
                                               data_len)
624
671
 
625
672
        def bye(self):
626
 
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
673
            return gnutls.bye(self, gnutls.SHUT_RDWR)
627
674
 
628
675
    # Error handling functions
629
676
    def _error_code(result):
630
677
        """A function to raise exceptions on errors, suitable
631
 
        for the 'restype' attribute on ctypes functions"""
632
 
        if result >= 0:
 
678
        for the "restype" attribute on ctypes functions"""
 
679
        if result >= gnutls.E_SUCCESS:
633
680
            return result
634
681
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
635
682
            raise gnutls.CertificateSecurityError(code=result)
636
683
        raise gnutls.Error(code=result)
637
684
 
638
 
    def _retry_on_error(result, func, arguments):
 
685
    def _retry_on_error(result, func, arguments,
 
686
                        _error_code=_error_code):
639
687
        """A function to retry on some errors, suitable
640
 
        for the 'errcheck' attribute on ctypes functions"""
641
 
        while result < 0:
 
688
        for the "errcheck" attribute on ctypes functions"""
 
689
        while result < gnutls.E_SUCCESS:
642
690
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
643
691
                return _error_code(result)
644
692
            result = func(*arguments)
649
697
 
650
698
    # Functions
651
699
    priority_set_direct = _library.gnutls_priority_set_direct
652
 
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
700
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
653
701
                                    ctypes.POINTER(ctypes.c_char_p)]
654
702
    priority_set_direct.restype = _error_code
655
703
 
656
704
    init = _library.gnutls_init
657
 
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
705
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
658
706
    init.restype = _error_code
659
707
 
660
708
    set_default_priority = _library.gnutls_set_default_priority
661
 
    set_default_priority.argtypes = [session_t]
 
709
    set_default_priority.argtypes = [ClientSession]
662
710
    set_default_priority.restype = _error_code
663
711
 
664
712
    record_send = _library.gnutls_record_send
665
 
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
713
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
666
714
                            ctypes.c_size_t]
667
715
    record_send.restype = ctypes.c_ssize_t
668
716
    record_send.errcheck = _retry_on_error
670
718
    certificate_allocate_credentials = (
671
719
        _library.gnutls_certificate_allocate_credentials)
672
720
    certificate_allocate_credentials.argtypes = [
673
 
        ctypes.POINTER(certificate_credentials_t)]
 
721
        PointerTo(Credentials)]
674
722
    certificate_allocate_credentials.restype = _error_code
675
723
 
676
724
    certificate_free_credentials = (
677
725
        _library.gnutls_certificate_free_credentials)
678
 
    certificate_free_credentials.argtypes = [
679
 
        certificate_credentials_t]
 
726
    certificate_free_credentials.argtypes = [Credentials]
680
727
    certificate_free_credentials.restype = None
681
728
 
682
729
    handshake_set_private_extensions = (
683
730
        _library.gnutls_handshake_set_private_extensions)
684
 
    handshake_set_private_extensions.argtypes = [session_t,
 
731
    handshake_set_private_extensions.argtypes = [ClientSession,
685
732
                                                 ctypes.c_int]
686
733
    handshake_set_private_extensions.restype = None
687
734
 
688
735
    credentials_set = _library.gnutls_credentials_set
689
 
    credentials_set.argtypes = [session_t, credentials_type_t,
690
 
                                ctypes.c_void_p]
 
736
    credentials_set.argtypes = [ClientSession, credentials_type_t,
 
737
                                CastToVoidPointer(Credentials)]
691
738
    credentials_set.restype = _error_code
692
739
 
693
740
    strerror = _library.gnutls_strerror
695
742
    strerror.restype = ctypes.c_char_p
696
743
 
697
744
    certificate_type_get = _library.gnutls_certificate_type_get
698
 
    certificate_type_get.argtypes = [session_t]
 
745
    certificate_type_get.argtypes = [ClientSession]
699
746
    certificate_type_get.restype = _error_code
700
747
 
701
748
    certificate_get_peers = _library.gnutls_certificate_get_peers
702
 
    certificate_get_peers.argtypes = [session_t,
 
749
    certificate_get_peers.argtypes = [ClientSession,
703
750
                                      ctypes.POINTER(ctypes.c_uint)]
704
751
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
705
752
 
712
759
    global_set_log_function.restype = None
713
760
 
714
761
    deinit = _library.gnutls_deinit
715
 
    deinit.argtypes = [session_t]
 
762
    deinit.argtypes = [ClientSession]
716
763
    deinit.restype = None
717
764
 
718
765
    handshake = _library.gnutls_handshake
719
 
    handshake.argtypes = [session_t]
720
 
    handshake.restype = _error_code
 
766
    handshake.argtypes = [ClientSession]
 
767
    handshake.restype = ctypes.c_int
721
768
    handshake.errcheck = _retry_on_error
722
769
 
723
770
    transport_set_ptr = _library.gnutls_transport_set_ptr
724
 
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
771
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
725
772
    transport_set_ptr.restype = None
726
773
 
727
774
    bye = _library.gnutls_bye
728
 
    bye.argtypes = [session_t, close_request_t]
729
 
    bye.restype = _error_code
 
775
    bye.argtypes = [ClientSession, close_request_t]
 
776
    bye.restype = ctypes.c_int
730
777
    bye.errcheck = _retry_on_error
731
778
 
732
779
    check_version = _library.gnutls_check_version
749
796
 
750
797
        x509_crt_fmt_t = ctypes.c_int
751
798
 
752
 
        # All the function declarations below are from gnutls/abstract.h
 
799
        # All the function declarations below are from
 
800
        # gnutls/abstract.h
753
801
        pubkey_init = _library.gnutls_pubkey_init
754
802
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
755
803
        pubkey_init.restype = _error_code
769
817
        pubkey_deinit.argtypes = [pubkey_t]
770
818
        pubkey_deinit.restype = None
771
819
    else:
772
 
        # All the function declarations below are from gnutls/openpgp.h
 
820
        # All the function declarations below are from
 
821
        # gnutls/openpgp.h
773
822
 
774
823
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
775
824
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
781
830
                                       openpgp_crt_fmt_t]
782
831
        openpgp_crt_import.restype = _error_code
783
832
 
784
 
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
785
 
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
786
 
                                            ctypes.POINTER(ctypes.c_uint)]
 
833
        openpgp_crt_verify_self = \
 
834
            _library.gnutls_openpgp_crt_verify_self
 
835
        openpgp_crt_verify_self.argtypes = [
 
836
            openpgp_crt_t,
 
837
            ctypes.c_uint,
 
838
            ctypes.POINTER(ctypes.c_uint),
 
839
        ]
787
840
        openpgp_crt_verify_self.restype = _error_code
788
841
 
789
842
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
800
853
 
801
854
    if check_version(b"3.6.4"):
802
855
        certificate_type_get2 = _library.gnutls_certificate_type_get2
803
 
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
 
856
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
804
857
        certificate_type_get2.restype = _error_code
805
858
 
806
859
    # Remove non-public functions
818
871
    connection.close()
819
872
 
820
873
 
821
 
class Client(object):
 
874
class Client:
822
875
    """A representation of a client host served by this server.
823
876
 
824
877
    Attributes:
825
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
878
    approved:   bool(); None if not yet approved/disapproved
826
879
    approval_delay: datetime.timedelta(); Time to wait for approval
827
880
    approval_duration: datetime.timedelta(); Duration of one approval
828
881
    checker: multiprocessing.Process(); a running checker process used
829
 
             to see if the client lives. 'None' if no process is
 
882
             to see if the client lives. None if no process is
830
883
             running.
831
884
    checker_callback_tag: a GLib event source tag, or None
832
885
    checker_command: string; External command which is run to check
956
1009
            self.last_enabled = None
957
1010
            self.expires = None
958
1011
 
959
 
        logger.debug("Creating client %r", self.name)
960
 
        logger.debug("  Key ID: %s", self.key_id)
961
 
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
1012
        log.debug("Creating client %r", self.name)
 
1013
        log.debug("  Key ID: %s", self.key_id)
 
1014
        log.debug("  Fingerprint: %s", self.fingerprint)
962
1015
        self.created = settings.get("created",
963
1016
                                    datetime.datetime.utcnow())
964
1017
 
992
1045
        if getattr(self, "enabled", False):
993
1046
            # Already enabled
994
1047
            return
995
 
        self.expires = datetime.datetime.utcnow() + self.timeout
996
1048
        self.enabled = True
997
1049
        self.last_enabled = datetime.datetime.utcnow()
998
1050
        self.init_checker()
1003
1055
        if not getattr(self, "enabled", False):
1004
1056
            return False
1005
1057
        if not quiet:
1006
 
            logger.info("Disabling client %s", self.name)
 
1058
            log.info("Disabling client %s", self.name)
1007
1059
        if getattr(self, "disable_initiator_tag", None) is not None:
1008
1060
            GLib.source_remove(self.disable_initiator_tag)
1009
1061
            self.disable_initiator_tag = None
1021
1073
    def __del__(self):
1022
1074
        self.disable()
1023
1075
 
1024
 
    def init_checker(self):
1025
 
        # Schedule a new checker to be started an 'interval' from now,
1026
 
        # and every interval from then on.
 
1076
    def init_checker(self, randomize_start=False):
 
1077
        # Schedule a new checker to be started a randomly selected
 
1078
        # time (a fraction of 'interval') from now.  This spreads out
 
1079
        # the startup of checkers over time when the server is
 
1080
        # started.
1027
1081
        if self.checker_initiator_tag is not None:
1028
1082
            GLib.source_remove(self.checker_initiator_tag)
 
1083
        interval_milliseconds = int(self.interval.total_seconds()
 
1084
                                    * 1000)
 
1085
        if randomize_start:
 
1086
            delay_milliseconds = random.randrange(
 
1087
                interval_milliseconds + 1)
 
1088
        else:
 
1089
            delay_milliseconds = interval_milliseconds
1029
1090
        self.checker_initiator_tag = GLib.timeout_add(
1030
 
            int(self.interval.total_seconds() * 1000),
1031
 
            self.start_checker)
1032
 
        # Schedule a disable() when 'timeout' has passed
 
1091
            delay_milliseconds, self.start_checker, randomize_start)
 
1092
        delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
 
1093
        # A checker might take up to an 'interval' of time, so we can
 
1094
        # expire at the soonest one interval after a checker was
 
1095
        # started.  Since the initial checker is delayed, the expire
 
1096
        # time might have to be extended.
 
1097
        now = datetime.datetime.utcnow()
 
1098
        self.expires = now + delay + self.interval
 
1099
        # Schedule a disable() at expire time
1033
1100
        if self.disable_initiator_tag is not None:
1034
1101
            GLib.source_remove(self.disable_initiator_tag)
1035
1102
        self.disable_initiator_tag = GLib.timeout_add(
1036
 
            int(self.timeout.total_seconds() * 1000), self.disable)
1037
 
        # Also start a new checker *right now*.
1038
 
        self.start_checker()
 
1103
            int((self.expires - now).total_seconds() * 1000),
 
1104
            self.disable)
1039
1105
 
1040
1106
    def checker_callback(self, source, condition, connection,
1041
1107
                         command):
1043
1109
        # Read return code from connection (see call_pipe)
1044
1110
        returncode = connection.recv()
1045
1111
        connection.close()
1046
 
        self.checker.join()
 
1112
        if self.checker is not None:
 
1113
            self.checker.join()
1047
1114
        self.checker_callback_tag = None
1048
1115
        self.checker = None
1049
1116
 
1051
1118
            self.last_checker_status = returncode
1052
1119
            self.last_checker_signal = None
1053
1120
            if self.last_checker_status == 0:
1054
 
                logger.info("Checker for %(name)s succeeded",
1055
 
                            vars(self))
 
1121
                log.info("Checker for %(name)s succeeded", vars(self))
1056
1122
                self.checked_ok()
1057
1123
            else:
1058
 
                logger.info("Checker for %(name)s failed", vars(self))
 
1124
                log.info("Checker for %(name)s failed", vars(self))
1059
1125
        else:
1060
1126
            self.last_checker_status = -1
1061
1127
            self.last_checker_signal = -returncode
1062
 
            logger.warning("Checker for %(name)s crashed?",
1063
 
                           vars(self))
 
1128
            log.warning("Checker for %(name)s crashed?", vars(self))
1064
1129
        return False
1065
1130
 
1066
1131
    def checked_ok(self):
1085
1150
    def need_approval(self):
1086
1151
        self.last_approval_request = datetime.datetime.utcnow()
1087
1152
 
1088
 
    def start_checker(self):
 
1153
    def start_checker(self, start_was_randomized=False):
1089
1154
        """Start a new checker subprocess if one is not running.
1090
1155
 
1091
1156
        If a checker already exists, leave it running and do
1100
1165
        # should be.
1101
1166
 
1102
1167
        if self.checker is not None and not self.checker.is_alive():
1103
 
            logger.warning("Checker was not alive; joining")
 
1168
            log.warning("Checker was not alive; joining")
1104
1169
            self.checker.join()
1105
1170
            self.checker = None
1106
1171
        # Start a new checker if needed
1107
1172
        if self.checker is None:
1108
1173
            # Escape attributes for the shell
1109
1174
            escaped_attrs = {
1110
 
                attr: re.escape(str(getattr(self, attr)))
 
1175
                attr: shlex.quote(str(getattr(self, attr)))
1111
1176
                for attr in self.runtime_expansions}
1112
1177
            try:
1113
1178
                command = self.checker_command % escaped_attrs
1114
1179
            except TypeError as error:
1115
 
                logger.error('Could not format string "%s"',
1116
 
                             self.checker_command,
1117
 
                             exc_info=error)
 
1180
                log.error('Could not format string "%s"',
 
1181
                          self.checker_command, exc_info=error)
1118
1182
                return True     # Try again later
1119
1183
            self.current_checker_command = command
1120
 
            logger.info("Starting checker %r for %s", command,
1121
 
                        self.name)
 
1184
            log.info("Starting checker %r for %s", command, self.name)
1122
1185
            # We don't need to redirect stdout and stderr, since
1123
1186
            # in normal mode, that is already done by daemon(),
1124
1187
            # and in debug mode we don't want to.  (Stdin is
1140
1203
                kwargs=popen_args)
1141
1204
            self.checker.start()
1142
1205
            self.checker_callback_tag = GLib.io_add_watch(
1143
 
                pipe[0].fileno(), GLib.IO_IN,
 
1206
                GLib.IOChannel.unix_new(pipe[0].fileno()),
 
1207
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1144
1208
                self.checker_callback, pipe[0], command)
 
1209
        if start_was_randomized:
 
1210
            # We were started after a random delay; Schedule a new
 
1211
            # checker to be started an 'interval' from now, and every
 
1212
            # interval from then on.
 
1213
            now = datetime.datetime.utcnow()
 
1214
            self.checker_initiator_tag = GLib.timeout_add(
 
1215
                int(self.interval.total_seconds() * 1000),
 
1216
                self.start_checker)
 
1217
            self.expires = max(self.expires, now + self.interval)
 
1218
            # Don't start a new checker again after same random delay
 
1219
            return False
1145
1220
        # Re-run this periodically if run by GLib.timeout_add
1146
1221
        return True
1147
1222
 
1152
1227
            self.checker_callback_tag = None
1153
1228
        if getattr(self, "checker", None) is None:
1154
1229
            return
1155
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
1230
        log.debug("Stopping checker for %(name)s", vars(self))
1156
1231
        self.checker.terminate()
1157
1232
        self.checker = None
1158
1233
 
1185
1260
        func._dbus_name = func.__name__
1186
1261
        if func._dbus_name.endswith("_dbus_property"):
1187
1262
            func._dbus_name = func._dbus_name[:-14]
1188
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
 
1263
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
1189
1264
        return func
1190
1265
 
1191
1266
    return decorator
1280
1355
 
1281
1356
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1282
1357
                         out_signature="s",
1283
 
                         path_keyword='object_path',
1284
 
                         connection_keyword='connection')
 
1358
                         path_keyword="object_path",
 
1359
                         connection_keyword="connection")
1285
1360
    def Introspect(self, object_path, connection):
1286
1361
        """Overloading of standard D-Bus method.
1287
1362
 
1336
1411
            document.unlink()
1337
1412
        except (AttributeError, xml.dom.DOMException,
1338
1413
                xml.parsers.expat.ExpatError) as error:
1339
 
            logger.error("Failed to override Introspection method",
1340
 
                         exc_info=error)
 
1414
            log.error("Failed to override Introspection method",
 
1415
                      exc_info=error)
1341
1416
        return xmlstring
1342
1417
 
1343
1418
 
1401
1476
                raise ValueError("Byte arrays not supported for non-"
1402
1477
                                 "'ay' signature {!r}"
1403
1478
                                 .format(prop._dbus_signature))
1404
 
            value = dbus.ByteArray(b''.join(chr(byte)
1405
 
                                            for byte in value))
 
1479
            value = dbus.ByteArray(bytes(value))
1406
1480
        prop(value)
1407
1481
 
1408
1482
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1441
1515
 
1442
1516
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1443
1517
                         out_signature="s",
1444
 
                         path_keyword='object_path',
1445
 
                         connection_keyword='connection')
 
1518
                         path_keyword="object_path",
 
1519
                         connection_keyword="connection")
1446
1520
    def Introspect(self, object_path, connection):
1447
1521
        """Overloading of standard D-Bus method.
1448
1522
 
1504
1578
            document.unlink()
1505
1579
        except (AttributeError, xml.dom.DOMException,
1506
1580
                xml.parsers.expat.ExpatError) as error:
1507
 
            logger.error("Failed to override Introspection method",
1508
 
                         exc_info=error)
 
1581
            log.error("Failed to override Introspection method",
 
1582
                      exc_info=error)
1509
1583
        return xmlstring
1510
1584
 
1511
1585
 
1543
1617
 
1544
1618
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1545
1619
                         out_signature="s",
1546
 
                         path_keyword='object_path',
1547
 
                         connection_keyword='connection')
 
1620
                         path_keyword="object_path",
 
1621
                         connection_keyword="connection")
1548
1622
    def Introspect(self, object_path, connection):
1549
1623
        """Overloading of standard D-Bus method.
1550
1624
 
1575
1649
            document.unlink()
1576
1650
        except (AttributeError, xml.dom.DOMException,
1577
1651
                xml.parsers.expat.ExpatError) as error:
1578
 
            logger.error("Failed to override Introspection method",
1579
 
                         exc_info=error)
 
1652
            log.error("Failed to override Introspection method",
 
1653
                      exc_info=error)
1580
1654
        return xmlstring
1581
1655
 
1582
1656
 
2213
2287
    del _interface
2214
2288
 
2215
2289
 
2216
 
class ProxyClient(object):
 
2290
class ProxyClient:
2217
2291
    def __init__(self, child_pipe, key_id, fpr, address):
2218
2292
        self._pipe = child_pipe
2219
 
        self._pipe.send(('init', key_id, fpr, address))
 
2293
        self._pipe.send(("init", key_id, fpr, address))
2220
2294
        if not self._pipe.recv():
2221
2295
            raise KeyError(key_id or fpr)
2222
2296
 
2223
2297
    def __getattribute__(self, name):
2224
 
        if name == '_pipe':
 
2298
        if name == "_pipe":
2225
2299
            return super(ProxyClient, self).__getattribute__(name)
2226
 
        self._pipe.send(('getattr', name))
 
2300
        self._pipe.send(("getattr", name))
2227
2301
        data = self._pipe.recv()
2228
 
        if data[0] == 'data':
 
2302
        if data[0] == "data":
2229
2303
            return data[1]
2230
 
        if data[0] == 'function':
 
2304
        if data[0] == "function":
2231
2305
 
2232
2306
            def func(*args, **kwargs):
2233
 
                self._pipe.send(('funcall', name, args, kwargs))
 
2307
                self._pipe.send(("funcall", name, args, kwargs))
2234
2308
                return self._pipe.recv()[1]
2235
2309
 
2236
2310
            return func
2237
2311
 
2238
2312
    def __setattr__(self, name, value):
2239
 
        if name == '_pipe':
 
2313
        if name == "_pipe":
2240
2314
            return super(ProxyClient, self).__setattr__(name, value)
2241
 
        self._pipe.send(('setattr', name, value))
 
2315
        self._pipe.send(("setattr", name, value))
2242
2316
 
2243
2317
 
2244
2318
class ClientHandler(socketserver.BaseRequestHandler, object):
2249
2323
 
2250
2324
    def handle(self):
2251
2325
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2252
 
            logger.info("TCP connection from: %s",
2253
 
                        str(self.client_address))
2254
 
            logger.debug("Pipe FD: %d",
2255
 
                         self.server.child_pipe.fileno())
 
2326
            log.info("TCP connection from: %s",
 
2327
                     str(self.client_address))
 
2328
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2256
2329
 
2257
2330
            session = gnutls.ClientSession(self.request)
2258
2331
 
2259
 
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2332
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
2260
2333
            #                       "+AES-256-CBC", "+SHA1",
2261
2334
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2262
2335
            #                       "+DHE-DSS"))
2264
2337
            priority = self.server.gnutls_priority
2265
2338
            if priority is None:
2266
2339
                priority = "NORMAL"
2267
 
            gnutls.priority_set_direct(session._c_object,
2268
 
                                       priority.encode("utf-8"),
2269
 
                                       None)
 
2340
            gnutls.priority_set_direct(session,
 
2341
                                       priority.encode("utf-8"), None)
2270
2342
 
2271
2343
            # Start communication using the Mandos protocol
2272
2344
            # Get protocol number
2273
2345
            line = self.request.makefile().readline()
2274
 
            logger.debug("Protocol version: %r", line)
 
2346
            log.debug("Protocol version: %r", line)
2275
2347
            try:
2276
2348
                if int(line.strip().split()[0]) > 1:
2277
2349
                    raise RuntimeError(line)
2278
2350
            except (ValueError, IndexError, RuntimeError) as error:
2279
 
                logger.error("Unknown protocol version: %s", error)
 
2351
                log.error("Unknown protocol version: %s", error)
2280
2352
                return
2281
2353
 
2282
2354
            # Start GnuTLS connection
2283
2355
            try:
2284
2356
                session.handshake()
2285
2357
            except gnutls.Error as error:
2286
 
                logger.warning("Handshake failed: %s", error)
 
2358
                log.warning("Handshake failed: %s", error)
2287
2359
                # Do not run session.bye() here: the session is not
2288
2360
                # established.  Just abandon the request.
2289
2361
                return
2290
 
            logger.debug("Handshake succeeded")
 
2362
            log.debug("Handshake succeeded")
2291
2363
 
2292
2364
            approval_required = False
2293
2365
            try:
2297
2369
                        key_id = self.key_id(
2298
2370
                            self.peer_certificate(session))
2299
2371
                    except (TypeError, gnutls.Error) as error:
2300
 
                        logger.warning("Bad certificate: %s", error)
 
2372
                        log.warning("Bad certificate: %s", error)
2301
2373
                        return
2302
 
                    logger.debug("Key ID: %s", key_id)
 
2374
                    log.debug("Key ID: %s",
 
2375
                              key_id.decode("utf-8",
 
2376
                                            errors="replace"))
2303
2377
 
2304
2378
                else:
2305
2379
                    key_id = b""
2307
2381
                        fpr = self.fingerprint(
2308
2382
                            self.peer_certificate(session))
2309
2383
                    except (TypeError, gnutls.Error) as error:
2310
 
                        logger.warning("Bad certificate: %s", error)
 
2384
                        log.warning("Bad certificate: %s", error)
2311
2385
                        return
2312
 
                    logger.debug("Fingerprint: %s", fpr)
 
2386
                    log.debug("Fingerprint: %s", fpr)
2313
2387
 
2314
2388
                try:
2315
2389
                    client = ProxyClient(child_pipe, key_id, fpr,
2324
2398
 
2325
2399
                while True:
2326
2400
                    if not client.enabled:
2327
 
                        logger.info("Client %s is disabled",
2328
 
                                    client.name)
 
2401
                        log.info("Client %s is disabled", client.name)
2329
2402
                        if self.server.use_dbus:
2330
2403
                            # Emit D-Bus signal
2331
2404
                            client.Rejected("Disabled")
2335
2408
                        # We are approved or approval is disabled
2336
2409
                        break
2337
2410
                    elif client.approved is None:
2338
 
                        logger.info("Client %s needs approval",
2339
 
                                    client.name)
 
2411
                        log.info("Client %s needs approval",
 
2412
                                 client.name)
2340
2413
                        if self.server.use_dbus:
2341
2414
                            # Emit D-Bus signal
2342
2415
                            client.NeedApproval(
2343
2416
                                client.approval_delay.total_seconds()
2344
2417
                                * 1000, client.approved_by_default)
2345
2418
                    else:
2346
 
                        logger.warning("Client %s was not approved",
2347
 
                                       client.name)
 
2419
                        log.warning("Client %s was not approved",
 
2420
                                    client.name)
2348
2421
                        if self.server.use_dbus:
2349
2422
                            # Emit D-Bus signal
2350
2423
                            client.Rejected("Denied")
2358
2431
                    time2 = datetime.datetime.now()
2359
2432
                    if (time2 - time) >= delay:
2360
2433
                        if not client.approved_by_default:
2361
 
                            logger.warning("Client %s timed out while"
2362
 
                                           " waiting for approval",
2363
 
                                           client.name)
 
2434
                            log.warning("Client %s timed out while"
 
2435
                                        " waiting for approval",
 
2436
                                        client.name)
2364
2437
                            if self.server.use_dbus:
2365
2438
                                # Emit D-Bus signal
2366
2439
                                client.Rejected("Approval timed out")
2373
2446
                try:
2374
2447
                    session.send(client.secret)
2375
2448
                except gnutls.Error as error:
2376
 
                    logger.warning("gnutls send failed",
2377
 
                                   exc_info=error)
 
2449
                    log.warning("gnutls send failed", exc_info=error)
2378
2450
                    return
2379
2451
 
2380
 
                logger.info("Sending secret to %s", client.name)
 
2452
                log.info("Sending secret to %s", client.name)
2381
2453
                # bump the timeout using extended_timeout
2382
2454
                client.bump_timeout(client.extended_timeout)
2383
2455
                if self.server.use_dbus:
2390
2462
                try:
2391
2463
                    session.bye()
2392
2464
                except gnutls.Error as error:
2393
 
                    logger.warning("GnuTLS bye failed",
2394
 
                                   exc_info=error)
 
2465
                    log.warning("GnuTLS bye failed", exc_info=error)
2395
2466
 
2396
2467
    @staticmethod
2397
2468
    def peer_certificate(session):
2398
2469
        "Return the peer's certificate as a bytestring"
2399
2470
        try:
2400
 
            cert_type = gnutls.certificate_type_get2(session._c_object,
2401
 
                                                     gnutls.CTYPE_PEERS)
 
2471
            cert_type = gnutls.certificate_type_get2(
 
2472
                session, gnutls.CTYPE_PEERS)
2402
2473
        except AttributeError:
2403
 
            cert_type = gnutls.certificate_type_get(session._c_object)
 
2474
            cert_type = gnutls.certificate_type_get(session)
2404
2475
        if gnutls.has_rawpk:
2405
2476
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2406
2477
        else:
2407
2478
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2408
2479
        # If not a valid certificate type...
2409
2480
        if cert_type not in valid_cert_types:
2410
 
            logger.info("Cert type %r not in %r", cert_type,
2411
 
                        valid_cert_types)
 
2481
            log.info("Cert type %r not in %r", cert_type,
 
2482
                     valid_cert_types)
2412
2483
            # ...return invalid data
2413
2484
            return b""
2414
2485
        list_size = ctypes.c_uint(1)
2415
2486
        cert_list = (gnutls.certificate_get_peers
2416
 
                     (session._c_object, ctypes.byref(list_size)))
 
2487
                     (session, ctypes.byref(list_size)))
2417
2488
        if not bool(cert_list) and list_size.value != 0:
2418
2489
            raise gnutls.Error("error getting peer certificate")
2419
2490
        if list_size.value == 0:
2441
2512
        buf = ctypes.create_string_buffer(32)
2442
2513
        buf_len = ctypes.c_size_t(len(buf))
2443
2514
        # Get the key ID from the raw public key into the buffer
2444
 
        gnutls.pubkey_get_key_id(pubkey,
2445
 
                                 gnutls.KEYID_USE_SHA256,
2446
 
                                 ctypes.cast(ctypes.byref(buf),
2447
 
                                             ctypes.POINTER(ctypes.c_ubyte)),
2448
 
                                 ctypes.byref(buf_len))
 
2515
        gnutls.pubkey_get_key_id(
 
2516
            pubkey,
 
2517
            gnutls.KEYID_USE_SHA256,
 
2518
            ctypes.cast(ctypes.byref(buf),
 
2519
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2520
            ctypes.byref(buf_len))
2449
2521
        # Deinit the certificate
2450
2522
        gnutls.pubkey_deinit(pubkey)
2451
2523
 
2492
2564
        return hex_fpr
2493
2565
 
2494
2566
 
2495
 
class MultiprocessingMixIn(object):
 
2567
class MultiprocessingMixIn:
2496
2568
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2497
2569
 
2498
2570
    def sub_process_main(self, request, address):
2510
2582
        return proc
2511
2583
 
2512
2584
 
2513
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
2585
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2514
2586
    """ adds a pipe to the MixIn """
2515
2587
 
2516
2588
    def process_request(self, request, client_address):
2531
2603
 
2532
2604
 
2533
2605
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2534
 
                     socketserver.TCPServer, object):
2535
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
2606
                     socketserver.TCPServer):
 
2607
    """IPv6-capable TCP server.  Accepts None as address and/or port
2536
2608
 
2537
2609
    Attributes:
2538
2610
        enabled:        Boolean; whether this server is activated yet
2589
2661
            if SO_BINDTODEVICE is None:
2590
2662
                # Fall back to a hard-coded value which seems to be
2591
2663
                # common enough.
2592
 
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2664
                log.warning("SO_BINDTODEVICE not found, trying 25")
2593
2665
                SO_BINDTODEVICE = 25
2594
2666
            try:
2595
2667
                self.socket.setsockopt(
2597
2669
                    (self.interface + "\0").encode("utf-8"))
2598
2670
            except socket.error as error:
2599
2671
                if error.errno == errno.EPERM:
2600
 
                    logger.error("No permission to bind to"
2601
 
                                 " interface %s", self.interface)
 
2672
                    log.error("No permission to bind to interface %s",
 
2673
                              self.interface)
2602
2674
                elif error.errno == errno.ENOPROTOOPT:
2603
 
                    logger.error("SO_BINDTODEVICE not available;"
2604
 
                                 " cannot bind to interface %s",
2605
 
                                 self.interface)
 
2675
                    log.error("SO_BINDTODEVICE not available; cannot"
 
2676
                              " bind to interface %s", self.interface)
2606
2677
                elif error.errno == errno.ENODEV:
2607
 
                    logger.error("Interface %s does not exist,"
2608
 
                                 " cannot bind", self.interface)
 
2678
                    log.error("Interface %s does not exist, cannot"
 
2679
                              " bind", self.interface)
2609
2680
                else:
2610
2681
                    raise
2611
2682
        # Only bind(2) the socket if we really need to.
2670
2741
    def add_pipe(self, parent_pipe, proc):
2671
2742
        # Call "handle_ipc" for both data and EOF events
2672
2743
        GLib.io_add_watch(
2673
 
            parent_pipe.fileno(),
2674
 
            GLib.IO_IN | GLib.IO_HUP,
 
2744
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2745
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2675
2746
            functools.partial(self.handle_ipc,
2676
2747
                              parent_pipe=parent_pipe,
2677
2748
                              proc=proc))
2690
2761
        request = parent_pipe.recv()
2691
2762
        command = request[0]
2692
2763
 
2693
 
        if command == 'init':
 
2764
        if command == "init":
2694
2765
            key_id = request[1].decode("ascii")
2695
2766
            fpr = request[2].decode("ascii")
2696
2767
            address = request[3]
2697
2768
 
2698
2769
            for c in self.clients.values():
2699
 
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
 
2770
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
 
2771
                              "27AE41E4649B934CA495991B7852B855"):
2700
2772
                    continue
2701
2773
                if key_id and c.key_id == key_id:
2702
2774
                    client = c
2705
2777
                    client = c
2706
2778
                    break
2707
2779
            else:
2708
 
                logger.info("Client not found for key ID: %s, address"
2709
 
                            ": %s", key_id or fpr, address)
 
2780
                log.info("Client not found for key ID: %s, address:"
 
2781
                         " %s", key_id or fpr, address)
2710
2782
                if self.use_dbus:
2711
2783
                    # Emit D-Bus signal
2712
2784
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2715
2787
                return False
2716
2788
 
2717
2789
            GLib.io_add_watch(
2718
 
                parent_pipe.fileno(),
2719
 
                GLib.IO_IN | GLib.IO_HUP,
 
2790
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2791
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2720
2792
                functools.partial(self.handle_ipc,
2721
2793
                                  parent_pipe=parent_pipe,
2722
2794
                                  proc=proc,
2725
2797
            # remove the old hook in favor of the new above hook on
2726
2798
            # same fileno
2727
2799
            return False
2728
 
        if command == 'funcall':
 
2800
        if command == "funcall":
2729
2801
            funcname = request[1]
2730
2802
            args = request[2]
2731
2803
            kwargs = request[3]
2732
2804
 
2733
 
            parent_pipe.send(('data', getattr(client_object,
 
2805
            parent_pipe.send(("data", getattr(client_object,
2734
2806
                                              funcname)(*args,
2735
2807
                                                        **kwargs)))
2736
2808
 
2737
 
        if command == 'getattr':
 
2809
        if command == "getattr":
2738
2810
            attrname = request[1]
2739
2811
            if isinstance(client_object.__getattribute__(attrname),
2740
 
                          collections.Callable):
2741
 
                parent_pipe.send(('function', ))
 
2812
                          collections.abc.Callable):
 
2813
                parent_pipe.send(("function", ))
2742
2814
            else:
2743
2815
                parent_pipe.send((
2744
 
                    'data', client_object.__getattribute__(attrname)))
 
2816
                    "data", client_object.__getattribute__(attrname)))
2745
2817
 
2746
 
        if command == 'setattr':
 
2818
        if command == "setattr":
2747
2819
            attrname = request[1]
2748
2820
            value = request[2]
2749
2821
            setattr(client_object, attrname, value)
2754
2826
def rfc3339_duration_to_delta(duration):
2755
2827
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2756
2828
 
2757
 
    >>> rfc3339_duration_to_delta("P7D")
2758
 
    datetime.timedelta(7)
2759
 
    >>> rfc3339_duration_to_delta("PT60S")
2760
 
    datetime.timedelta(0, 60)
2761
 
    >>> rfc3339_duration_to_delta("PT60M")
2762
 
    datetime.timedelta(0, 3600)
2763
 
    >>> rfc3339_duration_to_delta("PT24H")
2764
 
    datetime.timedelta(1)
2765
 
    >>> rfc3339_duration_to_delta("P1W")
2766
 
    datetime.timedelta(7)
2767
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2768
 
    datetime.timedelta(0, 330)
2769
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2770
 
    datetime.timedelta(1, 200)
 
2829
    >>> timedelta = datetime.timedelta
 
2830
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
 
2831
    True
 
2832
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
 
2833
    True
 
2834
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
 
2835
    True
 
2836
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
 
2837
    True
 
2838
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
 
2839
    True
 
2840
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
 
2841
    True
 
2842
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
 
2843
    True
 
2844
    >>> del timedelta
2771
2845
    """
2772
2846
 
2773
2847
    # Parsing an RFC 3339 duration with regular expressions is not
2853
2927
def string_to_delta(interval):
2854
2928
    """Parse a string and return a datetime.timedelta
2855
2929
 
2856
 
    >>> string_to_delta('7d')
2857
 
    datetime.timedelta(7)
2858
 
    >>> string_to_delta('60s')
2859
 
    datetime.timedelta(0, 60)
2860
 
    >>> string_to_delta('60m')
2861
 
    datetime.timedelta(0, 3600)
2862
 
    >>> string_to_delta('24h')
2863
 
    datetime.timedelta(1)
2864
 
    >>> string_to_delta('1w')
2865
 
    datetime.timedelta(7)
2866
 
    >>> string_to_delta('5m 30s')
2867
 
    datetime.timedelta(0, 330)
 
2930
    >>> string_to_delta("7d") == datetime.timedelta(7)
 
2931
    True
 
2932
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
 
2933
    True
 
2934
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
 
2935
    True
 
2936
    >>> string_to_delta("24h") == datetime.timedelta(1)
 
2937
    True
 
2938
    >>> string_to_delta("1w") == datetime.timedelta(7)
 
2939
    True
 
2940
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
 
2941
    True
2868
2942
    """
2869
2943
 
2870
2944
    try:
2972
3046
 
2973
3047
    options = parser.parse_args()
2974
3048
 
2975
 
    if options.check:
2976
 
        import doctest
2977
 
        fail_count, test_count = doctest.testmod()
2978
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2979
 
 
2980
3049
    # Default values for config file for server-global settings
2981
3050
    if gnutls.has_rawpk:
2982
3051
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3078
3147
 
3079
3148
    if server_settings["servicename"] != "Mandos":
3080
3149
        syslogger.setFormatter(
3081
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
3082
 
                              ' %(levelname)s: %(message)s'.format(
 
3150
            logging.Formatter("Mandos ({}) [%(process)d]:"
 
3151
                              " %(levelname)s: %(message)s".format(
3083
3152
                                  server_settings["servicename"])))
3084
3153
 
3085
3154
    # Parse config file with clients
3109
3178
        try:
3110
3179
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3111
3180
        except IOError as e:
3112
 
            logger.error("Could not open file %r", pidfilename,
3113
 
                         exc_info=e)
 
3181
            log.error("Could not open file %r", pidfilename,
 
3182
                      exc_info=e)
3114
3183
 
3115
3184
    for name, group in (("_mandos", "_mandos"),
3116
3185
                        ("mandos", "mandos"),
3127
3196
    try:
3128
3197
        os.setgid(gid)
3129
3198
        os.setuid(uid)
3130
 
        if debug:
3131
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3132
 
                                                             gid))
 
3199
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
3133
3200
    except OSError as error:
3134
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
3135
 
                       .format(uid, gid, os.strerror(error.errno)))
 
3201
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
 
3202
                    os.strerror(error.errno))
3136
3203
        if error.errno != errno.EPERM:
3137
3204
            raise
3138
3205
 
3145
3212
 
3146
3213
        @gnutls.log_func
3147
3214
        def debug_gnutls(level, string):
3148
 
            logger.debug("GnuTLS: %s", string[:-1])
 
3215
            log.debug("GnuTLS: %s",
 
3216
                      string[:-1].decode("utf-8", errors="replace"))
3149
3217
 
3150
3218
        gnutls.global_set_log_function(debug_gnutls)
3151
3219
 
3180
3248
                "se.bsnet.fukt.Mandos", bus,
3181
3249
                do_not_queue=True)
3182
3250
        except dbus.exceptions.DBusException as e:
3183
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
3251
            log.error("Disabling D-Bus:", exc_info=e)
3184
3252
            use_dbus = False
3185
3253
            server_settings["use_dbus"] = False
3186
3254
            tcp_server.use_dbus = False
3245
3313
                             if isinstance(s, bytes)
3246
3314
                             else s) for s in
3247
3315
                            value["client_structure"]]
3248
 
                        # .name & .host
3249
 
                        for k in ("name", "host"):
 
3316
                        # .name, .host, and .checker_command
 
3317
                        for k in ("name", "host", "checker_command"):
3250
3318
                            if isinstance(value[k], bytes):
3251
3319
                                value[k] = value[k].decode("utf-8")
3252
3320
                        if "key_id" not in value:
3262
3330
                        for key, value in
3263
3331
                        bytes_old_client_settings.items()}
3264
3332
                    del bytes_old_client_settings
3265
 
                    # .host
 
3333
                    # .host and .checker_command
3266
3334
                    for value in old_client_settings.values():
3267
 
                        if isinstance(value["host"], bytes):
3268
 
                            value["host"] = (value["host"]
3269
 
                                             .decode("utf-8"))
 
3335
                        for attribute in ("host", "checker_command"):
 
3336
                            if isinstance(value[attribute], bytes):
 
3337
                                value[attribute] = (value[attribute]
 
3338
                                                    .decode("utf-8"))
3270
3339
            os.remove(stored_state_path)
3271
3340
        except IOError as e:
3272
3341
            if e.errno == errno.ENOENT:
3273
 
                logger.warning("Could not load persistent state:"
3274
 
                               " {}".format(os.strerror(e.errno)))
 
3342
                log.warning("Could not load persistent state:"
 
3343
                            " %s", os.strerror(e.errno))
3275
3344
            else:
3276
 
                logger.critical("Could not load persistent state:",
3277
 
                                exc_info=e)
 
3345
                log.critical("Could not load persistent state:",
 
3346
                             exc_info=e)
3278
3347
                raise
3279
3348
        except EOFError as e:
3280
 
            logger.warning("Could not load persistent state: "
3281
 
                           "EOFError:",
3282
 
                           exc_info=e)
 
3349
            log.warning("Could not load persistent state: EOFError:",
 
3350
                        exc_info=e)
3283
3351
 
3284
3352
    with PGPEngine() as pgp:
3285
3353
        for client_name, client in clients_data.items():
3312
3380
            if client["enabled"]:
3313
3381
                if datetime.datetime.utcnow() >= client["expires"]:
3314
3382
                    if not client["last_checked_ok"]:
3315
 
                        logger.warning(
3316
 
                            "disabling client {} - Client never "
3317
 
                            "performed a successful checker".format(
3318
 
                                client_name))
 
3383
                        log.warning("disabling client %s - Client"
 
3384
                                    " never performed a successful"
 
3385
                                    " checker", client_name)
3319
3386
                        client["enabled"] = False
3320
3387
                    elif client["last_checker_status"] != 0:
3321
 
                        logger.warning(
3322
 
                            "disabling client {} - Client last"
3323
 
                            " checker failed with error code"
3324
 
                            " {}".format(
3325
 
                                client_name,
3326
 
                                client["last_checker_status"]))
 
3388
                        log.warning("disabling client %s - Client"
 
3389
                                    " last checker failed with error"
 
3390
                                    " code %s", client_name,
 
3391
                                    client["last_checker_status"])
3327
3392
                        client["enabled"] = False
3328
3393
                    else:
3329
3394
                        client["expires"] = (
3330
3395
                            datetime.datetime.utcnow()
3331
3396
                            + client["timeout"])
3332
 
                        logger.debug("Last checker succeeded,"
3333
 
                                     " keeping {} enabled".format(
3334
 
                                         client_name))
 
3397
                        log.debug("Last checker succeeded, keeping %s"
 
3398
                                  " enabled", client_name)
3335
3399
            try:
3336
3400
                client["secret"] = pgp.decrypt(
3337
3401
                    client["encrypted_secret"],
3338
3402
                    client_settings[client_name]["secret"])
3339
3403
            except PGPError:
3340
3404
                # If decryption fails, we use secret from new settings
3341
 
                logger.debug("Failed to decrypt {} old secret".format(
3342
 
                    client_name))
 
3405
                log.debug("Failed to decrypt %s old secret",
 
3406
                          client_name)
3343
3407
                client["secret"] = (client_settings[client_name]
3344
3408
                                    ["secret"])
3345
3409
 
3359
3423
            server_settings=server_settings)
3360
3424
 
3361
3425
    if not tcp_server.clients:
3362
 
        logger.warning("No clients defined")
 
3426
        log.warning("No clients defined")
3363
3427
 
3364
3428
    if not foreground:
3365
3429
        if pidfile is not None:
3368
3432
                with pidfile:
3369
3433
                    print(pid, file=pidfile)
3370
3434
            except IOError:
3371
 
                logger.error("Could not write to file %r with PID %d",
3372
 
                             pidfilename, pid)
 
3435
                log.error("Could not write to file %r with PID %d",
 
3436
                          pidfilename, pid)
3373
3437
        del pidfile
3374
3438
        del pidfilename
3375
3439
 
3525
3589
 
3526
3590
        try:
3527
3591
            with tempfile.NamedTemporaryFile(
3528
 
                    mode='wb',
 
3592
                    mode="wb",
3529
3593
                    suffix=".pickle",
3530
 
                    prefix='clients-',
 
3594
                    prefix="clients-",
3531
3595
                    dir=os.path.dirname(stored_state_path),
3532
3596
                    delete=False) as stored_state:
3533
3597
                pickle.dump((clients, client_settings), stored_state,
3541
3605
                except NameError:
3542
3606
                    pass
3543
3607
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3544
 
                logger.warning("Could not save persistent state: {}"
3545
 
                               .format(os.strerror(e.errno)))
 
3608
                log.warning("Could not save persistent state: %s",
 
3609
                            os.strerror(e.errno))
3546
3610
            else:
3547
 
                logger.warning("Could not save persistent state:",
3548
 
                               exc_info=e)
 
3611
                log.warning("Could not save persistent state:",
 
3612
                            exc_info=e)
3549
3613
                raise
3550
3614
 
3551
3615
        # Delete all clients, and settings from config
3568
3632
            mandos_dbus_service.client_added_signal(client)
3569
3633
        # Need to initiate checking of clients
3570
3634
        if client.enabled:
3571
 
            client.init_checker()
 
3635
            client.init_checker(randomize_start=True)
3572
3636
 
3573
3637
    tcp_server.enable()
3574
3638
    tcp_server.server_activate()
3577
3641
    if zeroconf:
3578
3642
        service.port = tcp_server.socket.getsockname()[1]
3579
3643
    if use_ipv6:
3580
 
        logger.info("Now listening on address %r, port %d,"
3581
 
                    " flowinfo %d, scope_id %d",
3582
 
                    *tcp_server.socket.getsockname())
 
3644
        log.info("Now listening on address %r, port %d, flowinfo %d,"
 
3645
                 " scope_id %d", *tcp_server.socket.getsockname())
3583
3646
    else:                       # IPv4
3584
 
        logger.info("Now listening on address %r, port %d",
3585
 
                    *tcp_server.socket.getsockname())
 
3647
        log.info("Now listening on address %r, port %d",
 
3648
                 *tcp_server.socket.getsockname())
3586
3649
 
3587
3650
    # service.interface = tcp_server.socket.getsockname()[3]
3588
3651
 
3592
3655
            try:
3593
3656
                service.activate()
3594
3657
            except dbus.exceptions.DBusException as error:
3595
 
                logger.critical("D-Bus Exception", exc_info=error)
 
3658
                log.critical("D-Bus Exception", exc_info=error)
3596
3659
                cleanup()
3597
3660
                sys.exit(1)
3598
3661
            # End of Avahi example code
3599
3662
 
3600
 
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3601
 
                          lambda *args, **kwargs:
3602
 
                          (tcp_server.handle_request
3603
 
                           (*args[2:], **kwargs) or True))
 
3663
        GLib.io_add_watch(
 
3664
            GLib.IOChannel.unix_new(tcp_server.fileno()),
 
3665
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
3666
            lambda *args, **kwargs: (tcp_server.handle_request
 
3667
                                     (*args[2:], **kwargs) or True))
3604
3668
 
3605
 
        logger.debug("Starting main loop")
 
3669
        log.debug("Starting main loop")
3606
3670
        main_loop.run()
3607
3671
    except AvahiError as error:
3608
 
        logger.critical("Avahi Error", exc_info=error)
 
3672
        log.critical("Avahi Error", exc_info=error)
3609
3673
        cleanup()
3610
3674
        sys.exit(1)
3611
3675
    except KeyboardInterrupt:
3612
3676
        if debug:
3613
3677
            print("", file=sys.stderr)
3614
 
        logger.debug("Server received KeyboardInterrupt")
3615
 
    logger.debug("Server exiting")
 
3678
        log.debug("Server received KeyboardInterrupt")
 
3679
    log.debug("Server exiting")
3616
3680
    # Must run before the D-Bus bus name gets deregistered
3617
3681
    cleanup()
3618
3682
 
3619
 
 
3620
 
if __name__ == '__main__':
3621
 
    main()
 
3683
 
 
3684
def parse_test_args():
 
3685
    # type: () -> argparse.Namespace
 
3686
    parser = argparse.ArgumentParser(add_help=False)
 
3687
    parser.add_argument("--check", action="store_true")
 
3688
    parser.add_argument("--prefix", )
 
3689
    args, unknown_args = parser.parse_known_args()
 
3690
    if args.check:
 
3691
        # Remove test options from sys.argv
 
3692
        sys.argv[1:] = unknown_args
 
3693
    return args
 
3694
 
 
3695
# Add all tests from doctest strings
 
3696
def load_tests(loader, tests, none):
 
3697
    import doctest
 
3698
    tests.addTests(doctest.DocTestSuite())
 
3699
    return tests
 
3700
 
 
3701
if __name__ == "__main__":
 
3702
    options = parse_test_args()
 
3703
    try:
 
3704
        if options.check:
 
3705
            extra_test_prefix = options.prefix
 
3706
            if extra_test_prefix is not None:
 
3707
                if not (unittest.main(argv=[""], exit=False)
 
3708
                        .result.wasSuccessful()):
 
3709
                    sys.exit(1)
 
3710
                class ExtraTestLoader(unittest.TestLoader):
 
3711
                    testMethodPrefix = extra_test_prefix
 
3712
                # Call using ./scriptname --test [--verbose]
 
3713
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
 
3714
            else:
 
3715
                unittest.main(argv=[""])
 
3716
        else:
 
3717
            main()
 
3718
    finally:
 
3719
        logging.shutdown()
 
3720
 
 
3721
# Local Variables:
 
3722
# run-tests:
 
3723
# (lambda (&optional extra)
 
3724
#   (if (not (funcall run-tests-in-test-buffer default-directory
 
3725
#             extra))
 
3726
#       (funcall show-test-buffer-in-test-window)
 
3727
#     (funcall remove-test-window)
 
3728
#     (if extra (message "Extra tests run successfully!"))))
 
3729
# run-tests-in-test-buffer:
 
3730
# (lambda (dir &optional extra)
 
3731
#   (with-current-buffer (get-buffer-create "*Test*")
 
3732
#     (setq buffer-read-only nil
 
3733
#           default-directory dir)
 
3734
#     (erase-buffer)
 
3735
#     (compilation-mode))
 
3736
#   (let ((process-result
 
3737
#          (let ((inhibit-read-only t))
 
3738
#            (process-file-shell-command
 
3739
#             (funcall get-command-line extra) nil "*Test*"))))
 
3740
#     (and (numberp process-result)
 
3741
#          (= process-result 0))))
 
3742
# get-command-line:
 
3743
# (lambda (&optional extra)
 
3744
#   (let ((quoted-script
 
3745
#          (shell-quote-argument (funcall get-script-name))))
 
3746
#     (format
 
3747
#      (concat "%s --check" (if extra " --prefix=atest" ""))
 
3748
#      quoted-script)))
 
3749
# get-script-name:
 
3750
# (lambda ()
 
3751
#   (if (fboundp 'file-local-name)
 
3752
#       (file-local-name (buffer-file-name))
 
3753
#     (or (file-remote-p (buffer-file-name) 'localname)
 
3754
#         (buffer-file-name))))
 
3755
# remove-test-window:
 
3756
# (lambda ()
 
3757
#   (let ((test-window (get-buffer-window "*Test*")))
 
3758
#     (if test-window (delete-window test-window))))
 
3759
# show-test-buffer-in-test-window:
 
3760
# (lambda ()
 
3761
#   (when (not (get-buffer-window-list "*Test*"))
 
3762
#     (setq next-error-last-buffer (get-buffer "*Test*"))
 
3763
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
 
3764
#            (display-buffer-overriding-action
 
3765
#             `((display-buffer-in-side-window) (side . ,side)
 
3766
#               (window-height . fit-window-to-buffer)
 
3767
#               (window-width . fit-window-to-buffer))))
 
3768
#       (display-buffer "*Test*"))))
 
3769
# eval:
 
3770
# (progn
 
3771
#   (let* ((run-extra-tests (lambda () (interactive)
 
3772
#                             (funcall run-tests t)))
 
3773
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
 
3774
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
 
3775
#     (setq minor-mode-overriding-map-alist
 
3776
#           (cons `(run-tests . ,outer-keymap)
 
3777
#                 minor-mode-overriding-map-alist)))
 
3778
#   (add-hook 'after-save-hook run-tests 90 t))
 
3779
# End: