/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-08-16 19:32:47 UTC
  • Revision ID: teddy@recompile.se-20190816193247-3swy47ofqe7cr1i0
From: Grégoire Scano <gregoire.scano@malloc.fr>

Add French debconf translation

* debian/po/fr.po: New.

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

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/python
 
2
# -*- mode: python; 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
82
80
 
83
81
import dbus
84
82
import dbus.service
92
90
 
93
91
if sys.version_info.major == 2:
94
92
    __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
 
 
126
 
# Show warnings by default
127
 
if not sys.warnoptions:
128
 
    import warnings
129
 
    warnings.simplefilter("default")
130
93
 
131
94
# Try to find the value of SO_BINDTODEVICE:
132
95
try:
153
116
            # No value found
154
117
            SO_BINDTODEVICE = None
155
118
 
 
119
if sys.version_info.major == 2:
 
120
    str = unicode
 
121
 
156
122
if sys.version_info < (3, 2):
157
123
    configparser.Configparser = configparser.SafeConfigParser
158
124
 
159
 
version = "1.8.17"
 
125
version = "1.8.7"
160
126
stored_state_file = "clients.pickle"
161
127
 
162
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
163
 
logging.captureWarnings(True)   # Show warnings via the logging system
 
128
logger = logging.getLogger()
164
129
syslogger = None
165
130
 
166
131
try:
202
167
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
203
168
        address="/dev/log"))
204
169
    syslogger.setFormatter(logging.Formatter
205
 
                           ("Mandos [%(process)d]: %(levelname)s:"
206
 
                            " %(message)s"))
207
 
    log.addHandler(syslogger)
 
170
                           ('Mandos [%(process)d]: %(levelname)s:'
 
171
                            ' %(message)s'))
 
172
    logger.addHandler(syslogger)
208
173
 
209
174
    if debug:
210
175
        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)
 
176
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
177
                                               ' [%(process)d]:'
 
178
                                               ' %(levelname)s:'
 
179
                                               ' %(message)s'))
 
180
        logger.addHandler(console)
 
181
    logger.setLevel(level)
217
182
 
218
183
 
219
184
class PGPError(Exception):
231
196
            output = subprocess.check_output(["gpgconf"])
232
197
            for line in output.splitlines():
233
198
                name, text, path = line.split(b":")
234
 
                if name == b"gpg":
 
199
                if name == "gpg":
235
200
                    self.gpg = path
236
201
                    break
237
202
        except OSError as e:
238
203
            if e.errno != errno.ENOENT:
239
204
                raise
240
 
        self.gnupgargs = ["--batch",
241
 
                          "--homedir", self.tempdir,
242
 
                          "--force-mdc",
243
 
                          "--quiet"]
 
205
        self.gnupgargs = ['--batch',
 
206
                          '--homedir', self.tempdir,
 
207
                          '--force-mdc',
 
208
                          '--quiet']
244
209
        # Only GPG version 1 has the --no-use-agent option.
245
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
210
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
246
211
            self.gnupgargs.append("--no-use-agent")
247
212
 
248
213
    def __enter__(self):
285
250
                dir=self.tempdir) as passfile:
286
251
            passfile.write(passphrase)
287
252
            passfile.flush()
288
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
289
 
                                     "--passphrase-file",
 
253
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
254
                                     '--passphrase-file',
290
255
                                     passfile.name]
291
256
                                    + self.gnupgargs,
292
257
                                    stdin=subprocess.PIPE,
303
268
                dir=self.tempdir) as passfile:
304
269
            passfile.write(passphrase)
305
270
            passfile.flush()
306
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
307
 
                                     "--passphrase-file",
 
271
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
272
                                     '--passphrase-file',
308
273
                                     passfile.name]
309
274
                                    + self.gnupgargs,
310
275
                                    stdin=subprocess.PIPE,
363
328
    Attributes:
364
329
    interface: integer; avahi.IF_UNSPEC or an interface index.
365
330
               Used to optionally bind to the specified interface.
366
 
    name: string; Example: "Mandos"
367
 
    type: string; Example: "_mandos._tcp".
 
331
    name: string; Example: 'Mandos'
 
332
    type: string; Example: '_mandos._tcp'.
368
333
     See <https://www.iana.org/assignments/service-names-port-numbers>
369
334
    port: integer; what port to announce
370
335
    TXT: list of strings; TXT record for the service
407
372
    def rename(self, remove=True):
408
373
        """Derived from the Avahi example code"""
409
374
        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)
 
375
            logger.critical("No suitable Zeroconf service name found"
 
376
                            " after %i retries, exiting.",
 
377
                            self.rename_count)
413
378
            raise AvahiServiceError("Too many renames")
414
379
        self.name = str(
415
380
            self.server.GetAlternativeServiceName(self.name))
416
381
        self.rename_count += 1
417
 
        log.info("Changing Zeroconf service name to %r ...",
418
 
                 self.name)
 
382
        logger.info("Changing Zeroconf service name to %r ...",
 
383
                    self.name)
419
384
        if remove:
420
385
            self.remove()
421
386
        try:
423
388
        except dbus.exceptions.DBusException as error:
424
389
            if (error.get_dbus_name()
425
390
                == "org.freedesktop.Avahi.CollisionError"):
426
 
                log.info("Local Zeroconf service name collision.")
 
391
                logger.info("Local Zeroconf service name collision.")
427
392
                return self.rename(remove=False)
428
393
            else:
429
 
                log.critical("D-Bus Exception", exc_info=error)
 
394
                logger.critical("D-Bus Exception", exc_info=error)
430
395
                self.cleanup()
431
396
                os._exit(1)
432
397
 
448
413
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
449
414
        self.entry_group_state_changed_match = (
450
415
            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)
 
416
                'StateChanged', self.entry_group_state_changed))
 
417
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
418
                     self.name, self.type)
454
419
        self.group.AddService(
455
420
            self.interface,
456
421
            self.protocol,
463
428
 
464
429
    def entry_group_state_changed(self, state, error):
465
430
        """Derived from the Avahi example code"""
466
 
        log.debug("Avahi entry group state change: %i", state)
 
431
        logger.debug("Avahi entry group state change: %i", state)
467
432
 
468
433
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
469
 
            log.debug("Zeroconf service established.")
 
434
            logger.debug("Zeroconf service established.")
470
435
        elif state == avahi.ENTRY_GROUP_COLLISION:
471
 
            log.info("Zeroconf service name collision.")
 
436
            logger.info("Zeroconf service name collision.")
472
437
            self.rename()
473
438
        elif state == avahi.ENTRY_GROUP_FAILURE:
474
 
            log.critical("Avahi: Error in group state changed %s",
475
 
                         str(error))
 
439
            logger.critical("Avahi: Error in group state changed %s",
 
440
                            str(error))
476
441
            raise AvahiGroupError("State changed: {!s}".format(error))
477
442
 
478
443
    def cleanup(self):
488
453
 
489
454
    def server_state_changed(self, state, error=None):
490
455
        """Derived from the Avahi example code"""
491
 
        log.debug("Avahi server state change: %i", state)
 
456
        logger.debug("Avahi server state change: %i", state)
492
457
        bad_states = {
493
458
            avahi.SERVER_INVALID: "Zeroconf server invalid",
494
459
            avahi.SERVER_REGISTERING: None,
498
463
        if state in bad_states:
499
464
            if bad_states[state] is not None:
500
465
                if error is None:
501
 
                    log.error(bad_states[state])
 
466
                    logger.error(bad_states[state])
502
467
                else:
503
 
                    log.error(bad_states[state] + ": %r", error)
 
468
                    logger.error(bad_states[state] + ": %r", error)
504
469
            self.cleanup()
505
470
        elif state == avahi.SERVER_RUNNING:
506
471
            try:
508
473
            except dbus.exceptions.DBusException as error:
509
474
                if (error.get_dbus_name()
510
475
                    == "org.freedesktop.Avahi.CollisionError"):
511
 
                    log.info("Local Zeroconf service name collision.")
 
476
                    logger.info("Local Zeroconf service name"
 
477
                                " collision.")
512
478
                    return self.rename(remove=False)
513
479
                else:
514
 
                    log.critical("D-Bus Exception", exc_info=error)
 
480
                    logger.critical("D-Bus Exception", exc_info=error)
515
481
                    self.cleanup()
516
482
                    os._exit(1)
517
483
        else:
518
484
            if error is None:
519
 
                log.debug("Unknown state: %r", state)
 
485
                logger.debug("Unknown state: %r", state)
520
486
            else:
521
 
                log.debug("Unknown state: %r: %r", state, error)
 
487
                logger.debug("Unknown state: %r: %r", state, error)
522
488
 
523
489
    def activate(self):
524
490
        """Derived from the Avahi example code"""
536
502
class AvahiServiceToSyslog(AvahiService):
537
503
    def rename(self, *args, **kwargs):
538
504
        """Add the new name to the syslog messages"""
539
 
        ret = super(AvahiServiceToSyslog, self).rename(*args,
540
 
                                                       **kwargs)
 
505
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
541
506
        syslogger.setFormatter(logging.Formatter(
542
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
507
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
543
508
            .format(self.name)))
544
509
        return ret
545
510
 
575
540
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
576
541
 
577
542
    # Types
578
 
    class _session_int(ctypes.Structure):
 
543
    class session_int(ctypes.Structure):
579
544
        _fields_ = []
580
 
    session_t = ctypes.POINTER(_session_int)
 
545
    session_t = ctypes.POINTER(session_int)
581
546
 
582
547
    class certificate_credentials_st(ctypes.Structure):
583
548
        _fields_ = []
586
551
    certificate_type_t = ctypes.c_int
587
552
 
588
553
    class datum_t(ctypes.Structure):
589
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
590
 
                    ("size", ctypes.c_uint)]
 
554
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
555
                    ('size', ctypes.c_uint)]
591
556
 
592
 
    class _openpgp_crt_int(ctypes.Structure):
 
557
    class openpgp_crt_int(ctypes.Structure):
593
558
        _fields_ = []
594
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
559
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
595
560
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
596
561
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
597
562
    credentials_type_t = ctypes.c_int
606
571
            # gnutls.strerror()
607
572
            self.code = code
608
573
            if message is None and code is not None:
609
 
                message = gnutls.strerror(code).decode(
610
 
                    "utf-8", errors="replace")
 
574
                message = gnutls.strerror(code)
611
575
            return super(gnutls.Error, self).__init__(
612
576
                message, *args)
613
577
 
614
578
    class CertificateSecurityError(Error):
615
579
        pass
616
580
 
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
581
    # Classes
643
 
    class Credentials(With_from_param):
 
582
    class Credentials:
644
583
        def __init__(self):
645
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
646
 
            gnutls.certificate_allocate_credentials(self)
 
584
            self._c_object = gnutls.certificate_credentials_t()
 
585
            gnutls.certificate_allocate_credentials(
 
586
                ctypes.byref(self._c_object))
647
587
            self.type = gnutls.CRD_CERTIFICATE
648
588
 
649
589
        def __del__(self):
650
 
            gnutls.certificate_free_credentials(self)
 
590
            gnutls.certificate_free_credentials(self._c_object)
651
591
 
652
 
    class ClientSession(With_from_param):
 
592
    class ClientSession:
653
593
        def __init__(self, socket, credentials=None):
654
 
            self._as_parameter_ = gnutls.session_t()
 
594
            self._c_object = gnutls.session_t()
655
595
            gnutls_flags = gnutls.CLIENT
656
596
            if gnutls.check_version(b"3.5.6"):
657
597
                gnutls_flags |= gnutls.NO_TICKETS
658
598
            if gnutls.has_rawpk:
659
599
                gnutls_flags |= gnutls.ENABLE_RAWPK
660
 
            gnutls.init(self, gnutls_flags)
 
600
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
661
601
            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)
 
602
            gnutls.set_default_priority(self._c_object)
 
603
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
604
            gnutls.handshake_set_private_extensions(self._c_object,
 
605
                                                    True)
665
606
            self.socket = socket
666
607
            if credentials is None:
667
608
                credentials = gnutls.Credentials()
668
 
            gnutls.credentials_set(self, credentials.type,
669
 
                                   credentials)
 
609
            gnutls.credentials_set(self._c_object, credentials.type,
 
610
                                   ctypes.cast(credentials._c_object,
 
611
                                               ctypes.c_void_p))
670
612
            self.credentials = credentials
671
613
 
672
614
        def __del__(self):
673
 
            gnutls.deinit(self)
 
615
            gnutls.deinit(self._c_object)
674
616
 
675
617
        def handshake(self):
676
 
            return gnutls.handshake(self)
 
618
            return gnutls.handshake(self._c_object)
677
619
 
678
620
        def send(self, data):
679
621
            data = bytes(data)
680
622
            data_len = len(data)
681
623
            while data_len > 0:
682
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
624
                data_len -= gnutls.record_send(self._c_object,
 
625
                                               data[-data_len:],
683
626
                                               data_len)
684
627
 
685
628
        def bye(self):
686
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
629
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
687
630
 
688
631
    # Error handling functions
689
632
    def _error_code(result):
690
633
        """A function to raise exceptions on errors, suitable
691
 
        for the "restype" attribute on ctypes functions"""
692
 
        if result >= gnutls.E_SUCCESS:
 
634
        for the 'restype' attribute on ctypes functions"""
 
635
        if result >= 0:
693
636
            return result
694
637
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
695
638
            raise gnutls.CertificateSecurityError(code=result)
696
639
        raise gnutls.Error(code=result)
697
640
 
698
 
    def _retry_on_error(result, func, arguments,
699
 
                        _error_code=_error_code):
 
641
    def _retry_on_error(result, func, arguments):
700
642
        """A function to retry on some errors, suitable
701
 
        for the "errcheck" attribute on ctypes functions"""
702
 
        while result < gnutls.E_SUCCESS:
 
643
        for the 'errcheck' attribute on ctypes functions"""
 
644
        while result < 0:
703
645
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
704
646
                return _error_code(result)
705
647
            result = func(*arguments)
710
652
 
711
653
    # Functions
712
654
    priority_set_direct = _library.gnutls_priority_set_direct
713
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
655
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
714
656
                                    ctypes.POINTER(ctypes.c_char_p)]
715
657
    priority_set_direct.restype = _error_code
716
658
 
717
659
    init = _library.gnutls_init
718
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
660
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
719
661
    init.restype = _error_code
720
662
 
721
663
    set_default_priority = _library.gnutls_set_default_priority
722
 
    set_default_priority.argtypes = [ClientSession]
 
664
    set_default_priority.argtypes = [session_t]
723
665
    set_default_priority.restype = _error_code
724
666
 
725
667
    record_send = _library.gnutls_record_send
726
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
668
    record_send.argtypes = [session_t, ctypes.c_void_p,
727
669
                            ctypes.c_size_t]
728
670
    record_send.restype = ctypes.c_ssize_t
729
671
    record_send.errcheck = _retry_on_error
731
673
    certificate_allocate_credentials = (
732
674
        _library.gnutls_certificate_allocate_credentials)
733
675
    certificate_allocate_credentials.argtypes = [
734
 
        PointerTo(Credentials)]
 
676
        ctypes.POINTER(certificate_credentials_t)]
735
677
    certificate_allocate_credentials.restype = _error_code
736
678
 
737
679
    certificate_free_credentials = (
738
680
        _library.gnutls_certificate_free_credentials)
739
 
    certificate_free_credentials.argtypes = [Credentials]
 
681
    certificate_free_credentials.argtypes = [
 
682
        certificate_credentials_t]
740
683
    certificate_free_credentials.restype = None
741
684
 
742
685
    handshake_set_private_extensions = (
743
686
        _library.gnutls_handshake_set_private_extensions)
744
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
687
    handshake_set_private_extensions.argtypes = [session_t,
745
688
                                                 ctypes.c_int]
746
689
    handshake_set_private_extensions.restype = None
747
690
 
748
691
    credentials_set = _library.gnutls_credentials_set
749
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
750
 
                                CastToVoidPointer(Credentials)]
 
692
    credentials_set.argtypes = [session_t, credentials_type_t,
 
693
                                ctypes.c_void_p]
751
694
    credentials_set.restype = _error_code
752
695
 
753
696
    strerror = _library.gnutls_strerror
755
698
    strerror.restype = ctypes.c_char_p
756
699
 
757
700
    certificate_type_get = _library.gnutls_certificate_type_get
758
 
    certificate_type_get.argtypes = [ClientSession]
 
701
    certificate_type_get.argtypes = [session_t]
759
702
    certificate_type_get.restype = _error_code
760
703
 
761
704
    certificate_get_peers = _library.gnutls_certificate_get_peers
762
 
    certificate_get_peers.argtypes = [ClientSession,
 
705
    certificate_get_peers.argtypes = [session_t,
763
706
                                      ctypes.POINTER(ctypes.c_uint)]
764
707
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
765
708
 
772
715
    global_set_log_function.restype = None
773
716
 
774
717
    deinit = _library.gnutls_deinit
775
 
    deinit.argtypes = [ClientSession]
 
718
    deinit.argtypes = [session_t]
776
719
    deinit.restype = None
777
720
 
778
721
    handshake = _library.gnutls_handshake
779
 
    handshake.argtypes = [ClientSession]
780
 
    handshake.restype = ctypes.c_int
 
722
    handshake.argtypes = [session_t]
 
723
    handshake.restype = _error_code
781
724
    handshake.errcheck = _retry_on_error
782
725
 
783
726
    transport_set_ptr = _library.gnutls_transport_set_ptr
784
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
727
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
785
728
    transport_set_ptr.restype = None
786
729
 
787
730
    bye = _library.gnutls_bye
788
 
    bye.argtypes = [ClientSession, close_request_t]
789
 
    bye.restype = ctypes.c_int
 
731
    bye.argtypes = [session_t, close_request_t]
 
732
    bye.restype = _error_code
790
733
    bye.errcheck = _retry_on_error
791
734
 
792
735
    check_version = _library.gnutls_check_version
809
752
 
810
753
        x509_crt_fmt_t = ctypes.c_int
811
754
 
812
 
        # All the function declarations below are from
813
 
        # gnutls/abstract.h
 
755
        # All the function declarations below are from gnutls/abstract.h
814
756
        pubkey_init = _library.gnutls_pubkey_init
815
757
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
816
758
        pubkey_init.restype = _error_code
830
772
        pubkey_deinit.argtypes = [pubkey_t]
831
773
        pubkey_deinit.restype = None
832
774
    else:
833
 
        # All the function declarations below are from
834
 
        # gnutls/openpgp.h
 
775
        # All the function declarations below are from gnutls/openpgp.h
835
776
 
836
777
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
837
778
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
843
784
                                       openpgp_crt_fmt_t]
844
785
        openpgp_crt_import.restype = _error_code
845
786
 
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
 
        ]
 
787
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
788
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
789
                                            ctypes.POINTER(ctypes.c_uint)]
853
790
        openpgp_crt_verify_self.restype = _error_code
854
791
 
855
792
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
866
803
 
867
804
    if check_version(b"3.6.4"):
868
805
        certificate_type_get2 = _library.gnutls_certificate_type_get2
869
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
806
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
870
807
        certificate_type_get2.restype = _error_code
871
808
 
872
809
    # Remove non-public functions
888
825
    """A representation of a client host served by this server.
889
826
 
890
827
    Attributes:
891
 
    approved:   bool(); None if not yet approved/disapproved
 
828
    approved:   bool(); 'None' if not yet approved/disapproved
892
829
    approval_delay: datetime.timedelta(); Time to wait for approval
893
830
    approval_duration: datetime.timedelta(); Duration of one approval
894
831
    checker: multiprocessing.Process(); a running checker process used
895
 
             to see if the client lives. None if no process is
 
832
             to see if the client lives. 'None' if no process is
896
833
             running.
897
834
    checker_callback_tag: a GLib event source tag, or None
898
835
    checker_command: string; External command which is run to check
974
911
            # key_id() and fingerprint() functions
975
912
            client["key_id"] = (section.get("key_id", "").upper()
976
913
                                .replace(" ", ""))
977
 
            client["fingerprint"] = (section.get("fingerprint",
978
 
                                                 "").upper()
 
914
            client["fingerprint"] = (section["fingerprint"].upper()
979
915
                                     .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
916
            if "secret" in section:
986
917
                client["secret"] = codecs.decode(section["secret"]
987
918
                                                 .encode("utf-8"),
1028
959
            self.last_enabled = None
1029
960
            self.expires = None
1030
961
 
1031
 
        log.debug("Creating client %r", self.name)
1032
 
        log.debug("  Key ID: %s", self.key_id)
1033
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
962
        logger.debug("Creating client %r", self.name)
 
963
        logger.debug("  Key ID: %s", self.key_id)
 
964
        logger.debug("  Fingerprint: %s", self.fingerprint)
1034
965
        self.created = settings.get("created",
1035
966
                                    datetime.datetime.utcnow())
1036
967
 
1064
995
        if getattr(self, "enabled", False):
1065
996
            # Already enabled
1066
997
            return
 
998
        self.expires = datetime.datetime.utcnow() + self.timeout
1067
999
        self.enabled = True
1068
1000
        self.last_enabled = datetime.datetime.utcnow()
1069
1001
        self.init_checker()
1074
1006
        if not getattr(self, "enabled", False):
1075
1007
            return False
1076
1008
        if not quiet:
1077
 
            log.info("Disabling client %s", self.name)
 
1009
            logger.info("Disabling client %s", self.name)
1078
1010
        if getattr(self, "disable_initiator_tag", None) is not None:
1079
1011
            GLib.source_remove(self.disable_initiator_tag)
1080
1012
            self.disable_initiator_tag = None
1092
1024
    def __del__(self):
1093
1025
        self.disable()
1094
1026
 
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.
 
1027
    def init_checker(self):
 
1028
        # Schedule a new checker to be started an 'interval' from now,
 
1029
        # and every interval from then on.
1100
1030
        if self.checker_initiator_tag is not None:
1101
1031
            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
1032
        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
 
1033
            int(self.interval.total_seconds() * 1000),
 
1034
            self.start_checker)
 
1035
        # Schedule a disable() when 'timeout' has passed
1119
1036
        if self.disable_initiator_tag is not None:
1120
1037
            GLib.source_remove(self.disable_initiator_tag)
1121
1038
        self.disable_initiator_tag = GLib.timeout_add(
1122
 
            int((self.expires - now).total_seconds() * 1000),
1123
 
            self.disable)
 
1039
            int(self.timeout.total_seconds() * 1000), self.disable)
 
1040
        # Also start a new checker *right now*.
 
1041
        self.start_checker()
1124
1042
 
1125
1043
    def checker_callback(self, source, condition, connection,
1126
1044
                         command):
1128
1046
        # Read return code from connection (see call_pipe)
1129
1047
        returncode = connection.recv()
1130
1048
        connection.close()
1131
 
        if self.checker is not None:
1132
 
            self.checker.join()
 
1049
        self.checker.join()
1133
1050
        self.checker_callback_tag = None
1134
1051
        self.checker = None
1135
1052
 
1137
1054
            self.last_checker_status = returncode
1138
1055
            self.last_checker_signal = None
1139
1056
            if self.last_checker_status == 0:
1140
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1057
                logger.info("Checker for %(name)s succeeded",
 
1058
                            vars(self))
1141
1059
                self.checked_ok()
1142
1060
            else:
1143
 
                log.info("Checker for %(name)s failed", vars(self))
 
1061
                logger.info("Checker for %(name)s failed", vars(self))
1144
1062
        else:
1145
1063
            self.last_checker_status = -1
1146
1064
            self.last_checker_signal = -returncode
1147
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1065
            logger.warning("Checker for %(name)s crashed?",
 
1066
                           vars(self))
1148
1067
        return False
1149
1068
 
1150
1069
    def checked_ok(self):
1169
1088
    def need_approval(self):
1170
1089
        self.last_approval_request = datetime.datetime.utcnow()
1171
1090
 
1172
 
    def start_checker(self, start_was_randomized=False):
 
1091
    def start_checker(self):
1173
1092
        """Start a new checker subprocess if one is not running.
1174
1093
 
1175
1094
        If a checker already exists, leave it running and do
1184
1103
        # should be.
1185
1104
 
1186
1105
        if self.checker is not None and not self.checker.is_alive():
1187
 
            log.warning("Checker was not alive; joining")
 
1106
            logger.warning("Checker was not alive; joining")
1188
1107
            self.checker.join()
1189
1108
            self.checker = None
1190
1109
        # Start a new checker if needed
1191
1110
        if self.checker is None:
1192
1111
            # Escape attributes for the shell
1193
1112
            escaped_attrs = {
1194
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1113
                attr: re.escape(str(getattr(self, attr)))
1195
1114
                for attr in self.runtime_expansions}
1196
1115
            try:
1197
1116
                command = self.checker_command % escaped_attrs
1198
1117
            except TypeError as error:
1199
 
                log.error('Could not format string "%s"',
1200
 
                          self.checker_command, exc_info=error)
 
1118
                logger.error('Could not format string "%s"',
 
1119
                             self.checker_command,
 
1120
                             exc_info=error)
1201
1121
                return True     # Try again later
1202
1122
            self.current_checker_command = command
1203
 
            log.info("Starting checker %r for %s", command, self.name)
 
1123
            logger.info("Starting checker %r for %s", command,
 
1124
                        self.name)
1204
1125
            # We don't need to redirect stdout and stderr, since
1205
1126
            # in normal mode, that is already done by daemon(),
1206
1127
            # and in debug mode we don't want to.  (Stdin is
1222
1143
                kwargs=popen_args)
1223
1144
            self.checker.start()
1224
1145
            self.checker_callback_tag = GLib.io_add_watch(
1225
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1226
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1146
                pipe[0].fileno(), GLib.IO_IN,
1227
1147
                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
1148
        # Re-run this periodically if run by GLib.timeout_add
1240
1149
        return True
1241
1150
 
1246
1155
            self.checker_callback_tag = None
1247
1156
        if getattr(self, "checker", None) is None:
1248
1157
            return
1249
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1158
        logger.debug("Stopping checker for %(name)s", vars(self))
1250
1159
        self.checker.terminate()
1251
1160
        self.checker = None
1252
1161
 
1279
1188
        func._dbus_name = func.__name__
1280
1189
        if func._dbus_name.endswith("_dbus_property"):
1281
1190
            func._dbus_name = func._dbus_name[:-14]
1282
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1191
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1283
1192
        return func
1284
1193
 
1285
1194
    return decorator
1374
1283
 
1375
1284
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1376
1285
                         out_signature="s",
1377
 
                         path_keyword="object_path",
1378
 
                         connection_keyword="connection")
 
1286
                         path_keyword='object_path',
 
1287
                         connection_keyword='connection')
1379
1288
    def Introspect(self, object_path, connection):
1380
1289
        """Overloading of standard D-Bus method.
1381
1290
 
1430
1339
            document.unlink()
1431
1340
        except (AttributeError, xml.dom.DOMException,
1432
1341
                xml.parsers.expat.ExpatError) as error:
1433
 
            log.error("Failed to override Introspection method",
1434
 
                      exc_info=error)
 
1342
            logger.error("Failed to override Introspection method",
 
1343
                         exc_info=error)
1435
1344
        return xmlstring
1436
1345
 
1437
1346
 
1495
1404
                raise ValueError("Byte arrays not supported for non-"
1496
1405
                                 "'ay' signature {!r}"
1497
1406
                                 .format(prop._dbus_signature))
1498
 
            value = dbus.ByteArray(bytes(value))
 
1407
            value = dbus.ByteArray(b''.join(chr(byte)
 
1408
                                            for byte in value))
1499
1409
        prop(value)
1500
1410
 
1501
1411
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1534
1444
 
1535
1445
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1536
1446
                         out_signature="s",
1537
 
                         path_keyword="object_path",
1538
 
                         connection_keyword="connection")
 
1447
                         path_keyword='object_path',
 
1448
                         connection_keyword='connection')
1539
1449
    def Introspect(self, object_path, connection):
1540
1450
        """Overloading of standard D-Bus method.
1541
1451
 
1597
1507
            document.unlink()
1598
1508
        except (AttributeError, xml.dom.DOMException,
1599
1509
                xml.parsers.expat.ExpatError) as error:
1600
 
            log.error("Failed to override Introspection method",
1601
 
                      exc_info=error)
 
1510
            logger.error("Failed to override Introspection method",
 
1511
                         exc_info=error)
1602
1512
        return xmlstring
1603
1513
 
1604
1514
 
1636
1546
 
1637
1547
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1638
1548
                         out_signature="s",
1639
 
                         path_keyword="object_path",
1640
 
                         connection_keyword="connection")
 
1549
                         path_keyword='object_path',
 
1550
                         connection_keyword='connection')
1641
1551
    def Introspect(self, object_path, connection):
1642
1552
        """Overloading of standard D-Bus method.
1643
1553
 
1668
1578
            document.unlink()
1669
1579
        except (AttributeError, xml.dom.DOMException,
1670
1580
                xml.parsers.expat.ExpatError) as error:
1671
 
            log.error("Failed to override Introspection method",
1672
 
                      exc_info=error)
 
1581
            logger.error("Failed to override Introspection method",
 
1582
                         exc_info=error)
1673
1583
        return xmlstring
1674
1584
 
1675
1585
 
2309
2219
class ProxyClient:
2310
2220
    def __init__(self, child_pipe, key_id, fpr, address):
2311
2221
        self._pipe = child_pipe
2312
 
        self._pipe.send(("init", key_id, fpr, address))
 
2222
        self._pipe.send(('init', key_id, fpr, address))
2313
2223
        if not self._pipe.recv():
2314
2224
            raise KeyError(key_id or fpr)
2315
2225
 
2316
2226
    def __getattribute__(self, name):
2317
 
        if name == "_pipe":
 
2227
        if name == '_pipe':
2318
2228
            return super(ProxyClient, self).__getattribute__(name)
2319
 
        self._pipe.send(("getattr", name))
 
2229
        self._pipe.send(('getattr', name))
2320
2230
        data = self._pipe.recv()
2321
 
        if data[0] == "data":
 
2231
        if data[0] == 'data':
2322
2232
            return data[1]
2323
 
        if data[0] == "function":
 
2233
        if data[0] == 'function':
2324
2234
 
2325
2235
            def func(*args, **kwargs):
2326
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2236
                self._pipe.send(('funcall', name, args, kwargs))
2327
2237
                return self._pipe.recv()[1]
2328
2238
 
2329
2239
            return func
2330
2240
 
2331
2241
    def __setattr__(self, name, value):
2332
 
        if name == "_pipe":
 
2242
        if name == '_pipe':
2333
2243
            return super(ProxyClient, self).__setattr__(name, value)
2334
 
        self._pipe.send(("setattr", name, value))
 
2244
        self._pipe.send(('setattr', name, value))
2335
2245
 
2336
2246
 
2337
2247
class ClientHandler(socketserver.BaseRequestHandler, object):
2342
2252
 
2343
2253
    def handle(self):
2344
2254
        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())
 
2255
            logger.info("TCP connection from: %s",
 
2256
                        str(self.client_address))
 
2257
            logger.debug("Pipe FD: %d",
 
2258
                         self.server.child_pipe.fileno())
2348
2259
 
2349
2260
            session = gnutls.ClientSession(self.request)
2350
2261
 
2351
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2262
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2352
2263
            #                       "+AES-256-CBC", "+SHA1",
2353
2264
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2354
2265
            #                       "+DHE-DSS"))
2356
2267
            priority = self.server.gnutls_priority
2357
2268
            if priority is None:
2358
2269
                priority = "NORMAL"
2359
 
            gnutls.priority_set_direct(session,
2360
 
                                       priority.encode("utf-8"), None)
 
2270
            gnutls.priority_set_direct(session._c_object,
 
2271
                                       priority.encode("utf-8"),
 
2272
                                       None)
2361
2273
 
2362
2274
            # Start communication using the Mandos protocol
2363
2275
            # Get protocol number
2364
2276
            line = self.request.makefile().readline()
2365
 
            log.debug("Protocol version: %r", line)
 
2277
            logger.debug("Protocol version: %r", line)
2366
2278
            try:
2367
2279
                if int(line.strip().split()[0]) > 1:
2368
2280
                    raise RuntimeError(line)
2369
2281
            except (ValueError, IndexError, RuntimeError) as error:
2370
 
                log.error("Unknown protocol version: %s", error)
 
2282
                logger.error("Unknown protocol version: %s", error)
2371
2283
                return
2372
2284
 
2373
2285
            # Start GnuTLS connection
2374
2286
            try:
2375
2287
                session.handshake()
2376
2288
            except gnutls.Error as error:
2377
 
                log.warning("Handshake failed: %s", error)
 
2289
                logger.warning("Handshake failed: %s", error)
2378
2290
                # Do not run session.bye() here: the session is not
2379
2291
                # established.  Just abandon the request.
2380
2292
                return
2381
 
            log.debug("Handshake succeeded")
 
2293
            logger.debug("Handshake succeeded")
2382
2294
 
2383
2295
            approval_required = False
2384
2296
            try:
2388
2300
                        key_id = self.key_id(
2389
2301
                            self.peer_certificate(session))
2390
2302
                    except (TypeError, gnutls.Error) as error:
2391
 
                        log.warning("Bad certificate: %s", error)
 
2303
                        logger.warning("Bad certificate: %s", error)
2392
2304
                        return
2393
 
                    log.debug("Key ID: %s",
2394
 
                              key_id.decode("utf-8",
2395
 
                                            errors="replace"))
 
2305
                    logger.debug("Key ID: %s", key_id)
2396
2306
 
2397
2307
                else:
2398
2308
                    key_id = b""
2400
2310
                        fpr = self.fingerprint(
2401
2311
                            self.peer_certificate(session))
2402
2312
                    except (TypeError, gnutls.Error) as error:
2403
 
                        log.warning("Bad certificate: %s", error)
 
2313
                        logger.warning("Bad certificate: %s", error)
2404
2314
                        return
2405
 
                    log.debug("Fingerprint: %s", fpr)
 
2315
                    logger.debug("Fingerprint: %s", fpr)
2406
2316
 
2407
2317
                try:
2408
2318
                    client = ProxyClient(child_pipe, key_id, fpr,
2417
2327
 
2418
2328
                while True:
2419
2329
                    if not client.enabled:
2420
 
                        log.info("Client %s is disabled", client.name)
 
2330
                        logger.info("Client %s is disabled",
 
2331
                                    client.name)
2421
2332
                        if self.server.use_dbus:
2422
2333
                            # Emit D-Bus signal
2423
2334
                            client.Rejected("Disabled")
2427
2338
                        # We are approved or approval is disabled
2428
2339
                        break
2429
2340
                    elif client.approved is None:
2430
 
                        log.info("Client %s needs approval",
2431
 
                                 client.name)
 
2341
                        logger.info("Client %s needs approval",
 
2342
                                    client.name)
2432
2343
                        if self.server.use_dbus:
2433
2344
                            # Emit D-Bus signal
2434
2345
                            client.NeedApproval(
2435
2346
                                client.approval_delay.total_seconds()
2436
2347
                                * 1000, client.approved_by_default)
2437
2348
                    else:
2438
 
                        log.warning("Client %s was not approved",
2439
 
                                    client.name)
 
2349
                        logger.warning("Client %s was not approved",
 
2350
                                       client.name)
2440
2351
                        if self.server.use_dbus:
2441
2352
                            # Emit D-Bus signal
2442
2353
                            client.Rejected("Denied")
2450
2361
                    time2 = datetime.datetime.now()
2451
2362
                    if (time2 - time) >= delay:
2452
2363
                        if not client.approved_by_default:
2453
 
                            log.warning("Client %s timed out while"
2454
 
                                        " waiting for approval",
2455
 
                                        client.name)
 
2364
                            logger.warning("Client %s timed out while"
 
2365
                                           " waiting for approval",
 
2366
                                           client.name)
2456
2367
                            if self.server.use_dbus:
2457
2368
                                # Emit D-Bus signal
2458
2369
                                client.Rejected("Approval timed out")
2465
2376
                try:
2466
2377
                    session.send(client.secret)
2467
2378
                except gnutls.Error as error:
2468
 
                    log.warning("gnutls send failed", exc_info=error)
 
2379
                    logger.warning("gnutls send failed",
 
2380
                                   exc_info=error)
2469
2381
                    return
2470
2382
 
2471
 
                log.info("Sending secret to %s", client.name)
 
2383
                logger.info("Sending secret to %s", client.name)
2472
2384
                # bump the timeout using extended_timeout
2473
2385
                client.bump_timeout(client.extended_timeout)
2474
2386
                if self.server.use_dbus:
2481
2393
                try:
2482
2394
                    session.bye()
2483
2395
                except gnutls.Error as error:
2484
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2396
                    logger.warning("GnuTLS bye failed",
 
2397
                                   exc_info=error)
2485
2398
 
2486
2399
    @staticmethod
2487
2400
    def peer_certificate(session):
2488
2401
        "Return the peer's certificate as a bytestring"
2489
2402
        try:
2490
 
            cert_type = gnutls.certificate_type_get2(
2491
 
                session, gnutls.CTYPE_PEERS)
 
2403
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2404
                                                     gnutls.CTYPE_PEERS)
2492
2405
        except AttributeError:
2493
 
            cert_type = gnutls.certificate_type_get(session)
 
2406
            cert_type = gnutls.certificate_type_get(session._c_object)
2494
2407
        if gnutls.has_rawpk:
2495
2408
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2496
2409
        else:
2497
2410
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2498
2411
        # If not a valid certificate type...
2499
2412
        if cert_type not in valid_cert_types:
2500
 
            log.info("Cert type %r not in %r", cert_type,
2501
 
                     valid_cert_types)
 
2413
            logger.info("Cert type %r not in %r", cert_type,
 
2414
                        valid_cert_types)
2502
2415
            # ...return invalid data
2503
2416
            return b""
2504
2417
        list_size = ctypes.c_uint(1)
2505
2418
        cert_list = (gnutls.certificate_get_peers
2506
 
                     (session, ctypes.byref(list_size)))
 
2419
                     (session._c_object, ctypes.byref(list_size)))
2507
2420
        if not bool(cert_list) and list_size.value != 0:
2508
2421
            raise gnutls.Error("error getting peer certificate")
2509
2422
        if list_size.value == 0:
2531
2444
        buf = ctypes.create_string_buffer(32)
2532
2445
        buf_len = ctypes.c_size_t(len(buf))
2533
2446
        # 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))
 
2447
        gnutls.pubkey_get_key_id(pubkey,
 
2448
                                 gnutls.KEYID_USE_SHA256,
 
2449
                                 ctypes.cast(ctypes.byref(buf),
 
2450
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2451
                                 ctypes.byref(buf_len))
2540
2452
        # Deinit the certificate
2541
2453
        gnutls.pubkey_deinit(pubkey)
2542
2454
 
2623
2535
 
2624
2536
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2625
2537
                     socketserver.TCPServer):
2626
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2538
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2627
2539
 
2628
2540
    Attributes:
2629
2541
        enabled:        Boolean; whether this server is activated yet
2680
2592
            if SO_BINDTODEVICE is None:
2681
2593
                # Fall back to a hard-coded value which seems to be
2682
2594
                # common enough.
2683
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2595
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2684
2596
                SO_BINDTODEVICE = 25
2685
2597
            try:
2686
2598
                self.socket.setsockopt(
2688
2600
                    (self.interface + "\0").encode("utf-8"))
2689
2601
            except socket.error as error:
2690
2602
                if error.errno == errno.EPERM:
2691
 
                    log.error("No permission to bind to interface %s",
2692
 
                              self.interface)
 
2603
                    logger.error("No permission to bind to"
 
2604
                                 " interface %s", self.interface)
2693
2605
                elif error.errno == errno.ENOPROTOOPT:
2694
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2695
 
                              " bind to interface %s", self.interface)
 
2606
                    logger.error("SO_BINDTODEVICE not available;"
 
2607
                                 " cannot bind to interface %s",
 
2608
                                 self.interface)
2696
2609
                elif error.errno == errno.ENODEV:
2697
 
                    log.error("Interface %s does not exist, cannot"
2698
 
                              " bind", self.interface)
 
2610
                    logger.error("Interface %s does not exist,"
 
2611
                                 " cannot bind", self.interface)
2699
2612
                else:
2700
2613
                    raise
2701
2614
        # Only bind(2) the socket if we really need to.
2760
2673
    def add_pipe(self, parent_pipe, proc):
2761
2674
        # Call "handle_ipc" for both data and EOF events
2762
2675
        GLib.io_add_watch(
2763
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2764
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2676
            parent_pipe.fileno(),
 
2677
            GLib.IO_IN | GLib.IO_HUP,
2765
2678
            functools.partial(self.handle_ipc,
2766
2679
                              parent_pipe=parent_pipe,
2767
2680
                              proc=proc))
2780
2693
        request = parent_pipe.recv()
2781
2694
        command = request[0]
2782
2695
 
2783
 
        if command == "init":
 
2696
        if command == 'init':
2784
2697
            key_id = request[1].decode("ascii")
2785
2698
            fpr = request[2].decode("ascii")
2786
2699
            address = request[3]
2787
2700
 
2788
2701
            for c in self.clients.values():
2789
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2790
 
                              "27AE41E4649B934CA495991B7852B855"):
 
2702
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2791
2703
                    continue
2792
2704
                if key_id and c.key_id == key_id:
2793
2705
                    client = c
2796
2708
                    client = c
2797
2709
                    break
2798
2710
            else:
2799
 
                log.info("Client not found for key ID: %s, address:"
2800
 
                         " %s", key_id or fpr, address)
 
2711
                logger.info("Client not found for key ID: %s, address"
 
2712
                            ": %s", key_id or fpr, address)
2801
2713
                if self.use_dbus:
2802
2714
                    # Emit D-Bus signal
2803
2715
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2806
2718
                return False
2807
2719
 
2808
2720
            GLib.io_add_watch(
2809
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2810
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2721
                parent_pipe.fileno(),
 
2722
                GLib.IO_IN | GLib.IO_HUP,
2811
2723
                functools.partial(self.handle_ipc,
2812
2724
                                  parent_pipe=parent_pipe,
2813
2725
                                  proc=proc,
2816
2728
            # remove the old hook in favor of the new above hook on
2817
2729
            # same fileno
2818
2730
            return False
2819
 
        if command == "funcall":
 
2731
        if command == 'funcall':
2820
2732
            funcname = request[1]
2821
2733
            args = request[2]
2822
2734
            kwargs = request[3]
2823
2735
 
2824
 
            parent_pipe.send(("data", getattr(client_object,
 
2736
            parent_pipe.send(('data', getattr(client_object,
2825
2737
                                              funcname)(*args,
2826
2738
                                                        **kwargs)))
2827
2739
 
2828
 
        if command == "getattr":
 
2740
        if command == 'getattr':
2829
2741
            attrname = request[1]
2830
2742
            if isinstance(client_object.__getattribute__(attrname),
2831
 
                          collections.abc.Callable):
2832
 
                parent_pipe.send(("function", ))
 
2743
                          collections.Callable):
 
2744
                parent_pipe.send(('function', ))
2833
2745
            else:
2834
2746
                parent_pipe.send((
2835
 
                    "data", client_object.__getattribute__(attrname)))
 
2747
                    'data', client_object.__getattribute__(attrname)))
2836
2748
 
2837
 
        if command == "setattr":
 
2749
        if command == 'setattr':
2838
2750
            attrname = request[1]
2839
2751
            value = request[2]
2840
2752
            setattr(client_object, attrname, value)
2845
2757
def rfc3339_duration_to_delta(duration):
2846
2758
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2847
2759
 
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
 
2760
    >>> rfc3339_duration_to_delta("P7D")
 
2761
    datetime.timedelta(7)
 
2762
    >>> rfc3339_duration_to_delta("PT60S")
 
2763
    datetime.timedelta(0, 60)
 
2764
    >>> rfc3339_duration_to_delta("PT60M")
 
2765
    datetime.timedelta(0, 3600)
 
2766
    >>> rfc3339_duration_to_delta("PT24H")
 
2767
    datetime.timedelta(1)
 
2768
    >>> rfc3339_duration_to_delta("P1W")
 
2769
    datetime.timedelta(7)
 
2770
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2771
    datetime.timedelta(0, 330)
 
2772
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2773
    datetime.timedelta(1, 200)
2864
2774
    """
2865
2775
 
2866
2776
    # Parsing an RFC 3339 duration with regular expressions is not
2946
2856
def string_to_delta(interval):
2947
2857
    """Parse a string and return a datetime.timedelta
2948
2858
 
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)
2960
 
    True
 
2859
    >>> string_to_delta('7d')
 
2860
    datetime.timedelta(7)
 
2861
    >>> string_to_delta('60s')
 
2862
    datetime.timedelta(0, 60)
 
2863
    >>> string_to_delta('60m')
 
2864
    datetime.timedelta(0, 3600)
 
2865
    >>> string_to_delta('24h')
 
2866
    datetime.timedelta(1)
 
2867
    >>> string_to_delta('1w')
 
2868
    datetime.timedelta(7)
 
2869
    >>> string_to_delta('5m 30s')
 
2870
    datetime.timedelta(0, 330)
2961
2871
    """
2962
2872
 
2963
2873
    try:
3065
2975
 
3066
2976
    options = parser.parse_args()
3067
2977
 
 
2978
    if options.check:
 
2979
        import doctest
 
2980
        fail_count, test_count = doctest.testmod()
 
2981
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2982
 
3068
2983
    # Default values for config file for server-global settings
3069
2984
    if gnutls.has_rawpk:
3070
2985
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3109
3024
        # Later, stdin will, and stdout and stderr might, be dup'ed
3110
3025
        # over with an opened os.devnull.  But we don't want this to
3111
3026
        # happen with a supplied network socket.
3112
 
        while 0 <= server_settings["socket"] <= 2:
 
3027
        if 0 <= server_settings["socket"] <= 2:
3113
3028
            server_settings["socket"] = os.dup(server_settings
3114
3029
                                               ["socket"])
3115
 
        os.set_inheritable(server_settings["socket"], False)
3116
3030
    del server_config
3117
3031
 
3118
3032
    # Override the settings from the config file with command line
3167
3081
 
3168
3082
    if server_settings["servicename"] != "Mandos":
3169
3083
        syslogger.setFormatter(
3170
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3171
 
                              " %(levelname)s: %(message)s".format(
 
3084
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3085
                              ' %(levelname)s: %(message)s'.format(
3172
3086
                                  server_settings["servicename"])))
3173
3087
 
3174
3088
    # Parse config file with clients
3198
3112
        try:
3199
3113
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3200
3114
        except IOError as e:
3201
 
            log.error("Could not open file %r", pidfilename,
3202
 
                      exc_info=e)
 
3115
            logger.error("Could not open file %r", pidfilename,
 
3116
                         exc_info=e)
3203
3117
 
3204
3118
    for name, group in (("_mandos", "_mandos"),
3205
3119
                        ("mandos", "mandos"),
3216
3130
    try:
3217
3131
        os.setgid(gid)
3218
3132
        os.setuid(uid)
3219
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3133
        if debug:
 
3134
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3135
                                                             gid))
3220
3136
    except OSError as error:
3221
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3222
 
                    os.strerror(error.errno))
 
3137
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3138
                       .format(uid, gid, os.strerror(error.errno)))
3223
3139
        if error.errno != errno.EPERM:
3224
3140
            raise
3225
3141
 
3232
3148
 
3233
3149
        @gnutls.log_func
3234
3150
        def debug_gnutls(level, string):
3235
 
            log.debug("GnuTLS: %s",
3236
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3151
            logger.debug("GnuTLS: %s", string[:-1])
3237
3152
 
3238
3153
        gnutls.global_set_log_function(debug_gnutls)
3239
3154
 
3257
3172
    # From the Avahi example code
3258
3173
    DBusGMainLoop(set_as_default=True)
3259
3174
    main_loop = GLib.MainLoop()
3260
 
    if use_dbus or zeroconf:
3261
 
        bus = dbus.SystemBus()
 
3175
    bus = dbus.SystemBus()
3262
3176
    # End of Avahi example code
3263
3177
    if use_dbus:
3264
3178
        try:
3269
3183
                "se.bsnet.fukt.Mandos", bus,
3270
3184
                do_not_queue=True)
3271
3185
        except dbus.exceptions.DBusException as e:
3272
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3186
            logger.error("Disabling D-Bus:", exc_info=e)
3273
3187
            use_dbus = False
3274
3188
            server_settings["use_dbus"] = False
3275
3189
            tcp_server.use_dbus = False
3334
3248
                             if isinstance(s, bytes)
3335
3249
                             else s) for s in
3336
3250
                            value["client_structure"]]
3337
 
                        # .name, .host, and .checker_command
3338
 
                        for k in ("name", "host", "checker_command"):
 
3251
                        # .name & .host
 
3252
                        for k in ("name", "host"):
3339
3253
                            if isinstance(value[k], bytes):
3340
3254
                                value[k] = value[k].decode("utf-8")
3341
3255
                        if "key_id" not in value:
3351
3265
                        for key, value in
3352
3266
                        bytes_old_client_settings.items()}
3353
3267
                    del bytes_old_client_settings
3354
 
                    # .host and .checker_command
 
3268
                    # .host
3355
3269
                    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"))
 
3270
                        if isinstance(value["host"], bytes):
 
3271
                            value["host"] = (value["host"]
 
3272
                                             .decode("utf-8"))
3360
3273
            os.remove(stored_state_path)
3361
3274
        except IOError as e:
3362
3275
            if e.errno == errno.ENOENT:
3363
 
                log.warning("Could not load persistent state:"
3364
 
                            " %s", os.strerror(e.errno))
 
3276
                logger.warning("Could not load persistent state:"
 
3277
                               " {}".format(os.strerror(e.errno)))
3365
3278
            else:
3366
 
                log.critical("Could not load persistent state:",
3367
 
                             exc_info=e)
 
3279
                logger.critical("Could not load persistent state:",
 
3280
                                exc_info=e)
3368
3281
                raise
3369
3282
        except EOFError as e:
3370
 
            log.warning("Could not load persistent state: EOFError:",
3371
 
                        exc_info=e)
 
3283
            logger.warning("Could not load persistent state: "
 
3284
                           "EOFError:",
 
3285
                           exc_info=e)
3372
3286
 
3373
3287
    with PGPEngine() as pgp:
3374
3288
        for client_name, client in clients_data.items():
3401
3315
            if client["enabled"]:
3402
3316
                if datetime.datetime.utcnow() >= client["expires"]:
3403
3317
                    if not client["last_checked_ok"]:
3404
 
                        log.warning("disabling client %s - Client"
3405
 
                                    " never performed a successful"
3406
 
                                    " checker", client_name)
 
3318
                        logger.warning(
 
3319
                            "disabling client {} - Client never "
 
3320
                            "performed a successful checker".format(
 
3321
                                client_name))
3407
3322
                        client["enabled"] = False
3408
3323
                    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"])
 
3324
                        logger.warning(
 
3325
                            "disabling client {} - Client last"
 
3326
                            " checker failed with error code"
 
3327
                            " {}".format(
 
3328
                                client_name,
 
3329
                                client["last_checker_status"]))
3413
3330
                        client["enabled"] = False
3414
3331
                    else:
3415
3332
                        client["expires"] = (
3416
3333
                            datetime.datetime.utcnow()
3417
3334
                            + client["timeout"])
3418
 
                        log.debug("Last checker succeeded, keeping %s"
3419
 
                                  " enabled", client_name)
 
3335
                        logger.debug("Last checker succeeded,"
 
3336
                                     " keeping {} enabled".format(
 
3337
                                         client_name))
3420
3338
            try:
3421
3339
                client["secret"] = pgp.decrypt(
3422
3340
                    client["encrypted_secret"],
3423
3341
                    client_settings[client_name]["secret"])
3424
3342
            except PGPError:
3425
3343
                # If decryption fails, we use secret from new settings
3426
 
                log.debug("Failed to decrypt %s old secret",
3427
 
                          client_name)
 
3344
                logger.debug("Failed to decrypt {} old secret".format(
 
3345
                    client_name))
3428
3346
                client["secret"] = (client_settings[client_name]
3429
3347
                                    ["secret"])
3430
3348
 
3444
3362
            server_settings=server_settings)
3445
3363
 
3446
3364
    if not tcp_server.clients:
3447
 
        log.warning("No clients defined")
 
3365
        logger.warning("No clients defined")
3448
3366
 
3449
3367
    if not foreground:
3450
3368
        if pidfile is not None:
3453
3371
                with pidfile:
3454
3372
                    print(pid, file=pidfile)
3455
3373
            except IOError:
3456
 
                log.error("Could not write to file %r with PID %d",
3457
 
                          pidfilename, pid)
 
3374
                logger.error("Could not write to file %r with PID %d",
 
3375
                             pidfilename, pid)
3458
3376
        del pidfile
3459
3377
        del pidfilename
3460
3378
 
3610
3528
 
3611
3529
        try:
3612
3530
            with tempfile.NamedTemporaryFile(
3613
 
                    mode="wb",
 
3531
                    mode='wb',
3614
3532
                    suffix=".pickle",
3615
 
                    prefix="clients-",
 
3533
                    prefix='clients-',
3616
3534
                    dir=os.path.dirname(stored_state_path),
3617
3535
                    delete=False) as stored_state:
3618
3536
                pickle.dump((clients, client_settings), stored_state,
3626
3544
                except NameError:
3627
3545
                    pass
3628
3546
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3629
 
                log.warning("Could not save persistent state: %s",
3630
 
                            os.strerror(e.errno))
 
3547
                logger.warning("Could not save persistent state: {}"
 
3548
                               .format(os.strerror(e.errno)))
3631
3549
            else:
3632
 
                log.warning("Could not save persistent state:",
3633
 
                            exc_info=e)
 
3550
                logger.warning("Could not save persistent state:",
 
3551
                               exc_info=e)
3634
3552
                raise
3635
3553
 
3636
3554
        # Delete all clients, and settings from config
3653
3571
            mandos_dbus_service.client_added_signal(client)
3654
3572
        # Need to initiate checking of clients
3655
3573
        if client.enabled:
3656
 
            client.init_checker(randomize_start=True)
 
3574
            client.init_checker()
3657
3575
 
3658
3576
    tcp_server.enable()
3659
3577
    tcp_server.server_activate()
3662
3580
    if zeroconf:
3663
3581
        service.port = tcp_server.socket.getsockname()[1]
3664
3582
    if use_ipv6:
3665
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3666
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3583
        logger.info("Now listening on address %r, port %d,"
 
3584
                    " flowinfo %d, scope_id %d",
 
3585
                    *tcp_server.socket.getsockname())
3667
3586
    else:                       # IPv4
3668
 
        log.info("Now listening on address %r, port %d",
3669
 
                 *tcp_server.socket.getsockname())
 
3587
        logger.info("Now listening on address %r, port %d",
 
3588
                    *tcp_server.socket.getsockname())
3670
3589
 
3671
3590
    # service.interface = tcp_server.socket.getsockname()[3]
3672
3591
 
3676
3595
            try:
3677
3596
                service.activate()
3678
3597
            except dbus.exceptions.DBusException as error:
3679
 
                log.critical("D-Bus Exception", exc_info=error)
 
3598
                logger.critical("D-Bus Exception", exc_info=error)
3680
3599
                cleanup()
3681
3600
                sys.exit(1)
3682
3601
            # End of Avahi example code
3683
3602
 
3684
 
        GLib.io_add_watch(
3685
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3686
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3687
 
            lambda *args, **kwargs: (tcp_server.handle_request
3688
 
                                     (*args[2:], **kwargs) or True))
 
3603
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3604
                          lambda *args, **kwargs:
 
3605
                          (tcp_server.handle_request
 
3606
                           (*args[2:], **kwargs) or True))
3689
3607
 
3690
 
        log.debug("Starting main loop")
 
3608
        logger.debug("Starting main loop")
3691
3609
        main_loop.run()
3692
3610
    except AvahiError as error:
3693
 
        log.critical("Avahi Error", exc_info=error)
 
3611
        logger.critical("Avahi Error", exc_info=error)
3694
3612
        cleanup()
3695
3613
        sys.exit(1)
3696
3614
    except KeyboardInterrupt:
3697
3615
        if debug:
3698
3616
            print("", file=sys.stderr)
3699
 
        log.debug("Server received KeyboardInterrupt")
3700
 
    log.debug("Server exiting")
 
3617
        logger.debug("Server received KeyboardInterrupt")
 
3618
    logger.debug("Server exiting")
3701
3619
    # Must run before the D-Bus bus name gets deregistered
3702
3620
    cleanup()
3703
3621
 
3704
 
 
3705
 
def parse_test_args():
3706
 
    # type: () -> argparse.Namespace
3707
 
    parser = argparse.ArgumentParser(add_help=False)
3708
 
    parser.add_argument("--check", action="store_true")
3709
 
    parser.add_argument("--prefix", )
3710
 
    args, unknown_args = parser.parse_known_args()
3711
 
    if args.check:
3712
 
        # Remove test options from sys.argv
3713
 
        sys.argv[1:] = unknown_args
3714
 
    return args
3715
 
 
3716
 
# Add all tests from doctest strings
3717
 
def load_tests(loader, tests, none):
3718
 
    import doctest
3719
 
    tests.addTests(doctest.DocTestSuite())
3720
 
    return tests
3721
 
 
3722
 
if __name__ == "__main__":
3723
 
    options = parse_test_args()
3724
 
    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=[""])
3737
 
        else:
3738
 
            main()
3739
 
    finally:
3740
 
        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:
 
3622
 
 
3623
if __name__ == '__main__':
 
3624
    main()