/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: 2023-02-07 19:29:28 UTC
  • Revision ID: teddy@recompile.se-20230207192928-ueasjbsufb92o6ud
Clarify documentation and a comment about GnuTLS versions

* clients.conf ([foo]/secret): In the comment for the example client's
  "secret" setting, clarify GnuTLS version conditions.
* mandos-clients.conf.xml (OPTIONS/fingerprint, OPTIONS/key_id):
  Clarify required/optional status under different GnuTLS versions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
 
1
#!/usr/bin/python3 -bI
 
2
# -*- coding: utf-8; lexical-binding: t -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
5
#
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2019 Teddy Hogeborn
15
 
# Copyright © 2008-2019 Björn Påhlsson
 
14
# Copyright © 2008-2022 Teddy Hogeborn
 
15
# Copyright © 2008-2022 Björn Påhlsson
16
16
#
17
17
# This file is part of Mandos.
18
18
#
31
31
#
32
32
# Contact the authors at <mandos@recompile.se>.
33
33
#
34
 
 
35
34
from __future__ import (division, absolute_import, print_function,
36
35
                        unicode_literals)
37
36
 
40
39
except ImportError:
41
40
    pass
42
41
 
 
42
import sys
 
43
import unittest
 
44
import argparse
 
45
import logging
 
46
import os
43
47
try:
44
48
    import SocketServer as socketserver
45
49
except ImportError:
46
50
    import socketserver
47
51
import socket
48
 
import argparse
49
52
import datetime
50
53
import errno
51
54
try:
52
55
    import ConfigParser as configparser
53
56
except ImportError:
54
57
    import configparser
55
 
import sys
56
58
import re
57
 
import os
58
59
import signal
59
60
import subprocess
60
61
import atexit
61
62
import stat
62
 
import logging
63
63
import logging.handlers
64
64
import pwd
65
65
import contextlib
77
77
import itertools
78
78
import collections
79
79
import codecs
 
80
import random
 
81
import shlex
80
82
 
81
83
import dbus
82
84
import dbus.service
 
85
import gi
83
86
from gi.repository import GLib
84
87
from dbus.mainloop.glib import DBusGMainLoop
85
88
import ctypes
87
90
import xml.dom.minidom
88
91
import inspect
89
92
 
 
93
if sys.version_info.major == 2:
 
94
    __metaclass__ = type
 
95
    str = unicode
 
96
    input = raw_input
 
97
 
 
98
# Add collections.abc.Callable if it does not exist
 
99
try:
 
100
    collections.abc.Callable
 
101
except AttributeError:
 
102
    class abc:
 
103
        Callable = collections.Callable
 
104
    collections.abc = abc
 
105
    del abc
 
106
 
 
107
# Add shlex.quote if it does not exist
 
108
try:
 
109
    shlex.quote
 
110
except AttributeError:
 
111
    shlex.quote = re.escape
 
112
 
 
113
# Show warnings by default
 
114
if not sys.warnoptions:
 
115
    import warnings
 
116
    warnings.simplefilter("default")
 
117
 
90
118
# Try to find the value of SO_BINDTODEVICE:
91
119
try:
92
120
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
112
140
            # No value found
113
141
            SO_BINDTODEVICE = None
114
142
 
115
 
if sys.version_info.major == 2:
116
 
    str = unicode
 
143
if sys.version_info < (3, 2):
 
144
    configparser.Configparser = configparser.SafeConfigParser
117
145
 
118
 
version = "1.7.20"
 
146
version = "1.8.15"
119
147
stored_state_file = "clients.pickle"
120
148
 
121
 
logger = logging.getLogger()
 
149
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
150
logging.captureWarnings(True)   # Show warnings via the logging system
122
151
syslogger = None
123
152
 
124
153
try:
160
189
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
161
190
        address="/dev/log"))
162
191
    syslogger.setFormatter(logging.Formatter
163
 
                           ('Mandos [%(process)d]: %(levelname)s:'
164
 
                            ' %(message)s'))
165
 
    logger.addHandler(syslogger)
 
192
                           ("Mandos [%(process)d]: %(levelname)s:"
 
193
                            " %(message)s"))
 
194
    log.addHandler(syslogger)
166
195
 
167
196
    if debug:
168
197
        console = logging.StreamHandler()
169
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
170
 
                                               ' [%(process)d]:'
171
 
                                               ' %(levelname)s:'
172
 
                                               ' %(message)s'))
173
 
        logger.addHandler(console)
174
 
    logger.setLevel(level)
 
198
        console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
 
199
                                               " [%(process)d]:"
 
200
                                               " %(levelname)s:"
 
201
                                               " %(message)s"))
 
202
        log.addHandler(console)
 
203
    log.setLevel(level)
175
204
 
176
205
 
177
206
class PGPError(Exception):
179
208
    pass
180
209
 
181
210
 
182
 
class PGPEngine(object):
 
211
class PGPEngine:
183
212
    """A simple class for OpenPGP symmetric encryption & decryption"""
184
213
 
185
214
    def __init__(self):
189
218
            output = subprocess.check_output(["gpgconf"])
190
219
            for line in output.splitlines():
191
220
                name, text, path = line.split(b":")
192
 
                if name == "gpg":
 
221
                if name == b"gpg":
193
222
                    self.gpg = path
194
223
                    break
195
224
        except OSError as e:
196
225
            if e.errno != errno.ENOENT:
197
226
                raise
198
 
        self.gnupgargs = ['--batch',
199
 
                          '--homedir', self.tempdir,
200
 
                          '--force-mdc',
201
 
                          '--quiet']
 
227
        self.gnupgargs = ["--batch",
 
228
                          "--homedir", self.tempdir,
 
229
                          "--force-mdc",
 
230
                          "--quiet"]
202
231
        # Only GPG version 1 has the --no-use-agent option.
203
 
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
232
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
204
233
            self.gnupgargs.append("--no-use-agent")
205
234
 
206
235
    def __enter__(self):
243
272
                dir=self.tempdir) as passfile:
244
273
            passfile.write(passphrase)
245
274
            passfile.flush()
246
 
            proc = subprocess.Popen([self.gpg, '--symmetric',
247
 
                                     '--passphrase-file',
 
275
            proc = subprocess.Popen([self.gpg, "--symmetric",
 
276
                                     "--passphrase-file",
248
277
                                     passfile.name]
249
278
                                    + self.gnupgargs,
250
279
                                    stdin=subprocess.PIPE,
261
290
                dir=self.tempdir) as passfile:
262
291
            passfile.write(passphrase)
263
292
            passfile.flush()
264
 
            proc = subprocess.Popen([self.gpg, '--decrypt',
265
 
                                     '--passphrase-file',
 
293
            proc = subprocess.Popen([self.gpg, "--decrypt",
 
294
                                     "--passphrase-file",
266
295
                                     passfile.name]
267
296
                                    + self.gnupgargs,
268
297
                                    stdin=subprocess.PIPE,
275
304
 
276
305
 
277
306
# Pretend that we have an Avahi module
278
 
class Avahi(object):
279
 
    """This isn't so much a class as it is a module-like namespace.
280
 
    It is instantiated once, and simulates having an Avahi module."""
 
307
class avahi:
 
308
    """This isn't so much a class as it is a module-like namespace."""
281
309
    IF_UNSPEC = -1               # avahi-common/address.h
282
310
    PROTO_UNSPEC = -1            # avahi-common/address.h
283
311
    PROTO_INET = 0               # avahi-common/address.h
287
315
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
288
316
    DBUS_PATH_SERVER = "/"
289
317
 
290
 
    def string_array_to_txt_array(self, t):
 
318
    @staticmethod
 
319
    def string_array_to_txt_array(t):
291
320
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
292
321
                           for s in t), signature="ay")
293
322
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
298
327
    SERVER_RUNNING = 2           # avahi-common/defs.h
299
328
    SERVER_COLLISION = 3         # avahi-common/defs.h
300
329
    SERVER_FAILURE = 4           # avahi-common/defs.h
301
 
avahi = Avahi()
302
330
 
303
331
 
304
332
class AvahiError(Exception):
316
344
    pass
317
345
 
318
346
 
319
 
class AvahiService(object):
 
347
class AvahiService:
320
348
    """An Avahi (Zeroconf) service.
321
349
 
322
350
    Attributes:
323
351
    interface: integer; avahi.IF_UNSPEC or an interface index.
324
352
               Used to optionally bind to the specified interface.
325
 
    name: string; Example: 'Mandos'
326
 
    type: string; Example: '_mandos._tcp'.
 
353
    name: string; Example: "Mandos"
 
354
    type: string; Example: "_mandos._tcp".
327
355
     See <https://www.iana.org/assignments/service-names-port-numbers>
328
356
    port: integer; what port to announce
329
357
    TXT: list of strings; TXT record for the service
366
394
    def rename(self, remove=True):
367
395
        """Derived from the Avahi example code"""
368
396
        if self.rename_count >= self.max_renames:
369
 
            logger.critical("No suitable Zeroconf service name found"
370
 
                            " after %i retries, exiting.",
371
 
                            self.rename_count)
 
397
            log.critical("No suitable Zeroconf service name found"
 
398
                         " after %i retries, exiting.",
 
399
                         self.rename_count)
372
400
            raise AvahiServiceError("Too many renames")
373
401
        self.name = str(
374
402
            self.server.GetAlternativeServiceName(self.name))
375
403
        self.rename_count += 1
376
 
        logger.info("Changing Zeroconf service name to %r ...",
377
 
                    self.name)
 
404
        log.info("Changing Zeroconf service name to %r ...",
 
405
                 self.name)
378
406
        if remove:
379
407
            self.remove()
380
408
        try:
382
410
        except dbus.exceptions.DBusException as error:
383
411
            if (error.get_dbus_name()
384
412
                == "org.freedesktop.Avahi.CollisionError"):
385
 
                logger.info("Local Zeroconf service name collision.")
 
413
                log.info("Local Zeroconf service name collision.")
386
414
                return self.rename(remove=False)
387
415
            else:
388
 
                logger.critical("D-Bus Exception", exc_info=error)
 
416
                log.critical("D-Bus Exception", exc_info=error)
389
417
                self.cleanup()
390
418
                os._exit(1)
391
419
 
407
435
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
408
436
        self.entry_group_state_changed_match = (
409
437
            self.group.connect_to_signal(
410
 
                'StateChanged', self.entry_group_state_changed))
411
 
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
412
 
                     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)
413
441
        self.group.AddService(
414
442
            self.interface,
415
443
            self.protocol,
422
450
 
423
451
    def entry_group_state_changed(self, state, error):
424
452
        """Derived from the Avahi example code"""
425
 
        logger.debug("Avahi entry group state change: %i", state)
 
453
        log.debug("Avahi entry group state change: %i", state)
426
454
 
427
455
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
428
 
            logger.debug("Zeroconf service established.")
 
456
            log.debug("Zeroconf service established.")
429
457
        elif state == avahi.ENTRY_GROUP_COLLISION:
430
 
            logger.info("Zeroconf service name collision.")
 
458
            log.info("Zeroconf service name collision.")
431
459
            self.rename()
432
460
        elif state == avahi.ENTRY_GROUP_FAILURE:
433
 
            logger.critical("Avahi: Error in group state changed %s",
434
 
                            str(error))
 
461
            log.critical("Avahi: Error in group state changed %s",
 
462
                         str(error))
435
463
            raise AvahiGroupError("State changed: {!s}".format(error))
436
464
 
437
465
    def cleanup(self):
447
475
 
448
476
    def server_state_changed(self, state, error=None):
449
477
        """Derived from the Avahi example code"""
450
 
        logger.debug("Avahi server state change: %i", state)
 
478
        log.debug("Avahi server state change: %i", state)
451
479
        bad_states = {
452
480
            avahi.SERVER_INVALID: "Zeroconf server invalid",
453
481
            avahi.SERVER_REGISTERING: None,
457
485
        if state in bad_states:
458
486
            if bad_states[state] is not None:
459
487
                if error is None:
460
 
                    logger.error(bad_states[state])
 
488
                    log.error(bad_states[state])
461
489
                else:
462
 
                    logger.error(bad_states[state] + ": %r", error)
 
490
                    log.error(bad_states[state] + ": %r", error)
463
491
            self.cleanup()
464
492
        elif state == avahi.SERVER_RUNNING:
465
493
            try:
467
495
            except dbus.exceptions.DBusException as error:
468
496
                if (error.get_dbus_name()
469
497
                    == "org.freedesktop.Avahi.CollisionError"):
470
 
                    logger.info("Local Zeroconf service name"
471
 
                                " collision.")
 
498
                    log.info("Local Zeroconf service name collision.")
472
499
                    return self.rename(remove=False)
473
500
                else:
474
 
                    logger.critical("D-Bus Exception", exc_info=error)
 
501
                    log.critical("D-Bus Exception", exc_info=error)
475
502
                    self.cleanup()
476
503
                    os._exit(1)
477
504
        else:
478
505
            if error is None:
479
 
                logger.debug("Unknown state: %r", state)
 
506
                log.debug("Unknown state: %r", state)
480
507
            else:
481
 
                logger.debug("Unknown state: %r: %r", state, error)
 
508
                log.debug("Unknown state: %r: %r", state, error)
482
509
 
483
510
    def activate(self):
484
511
        """Derived from the Avahi example code"""
496
523
class AvahiServiceToSyslog(AvahiService):
497
524
    def rename(self, *args, **kwargs):
498
525
        """Add the new name to the syslog messages"""
499
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
526
        ret = super(AvahiServiceToSyslog, self).rename(*args,
 
527
                                                       **kwargs)
500
528
        syslogger.setFormatter(logging.Formatter(
501
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
529
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
502
530
            .format(self.name)))
503
531
        return ret
504
532
 
505
533
 
506
534
# Pretend that we have a GnuTLS module
507
 
class GnuTLS(object):
508
 
    """This isn't so much a class as it is a module-like namespace.
509
 
    It is instantiated once, and simulates having a GnuTLS module."""
 
535
class gnutls:
 
536
    """This isn't so much a class as it is a module-like namespace."""
510
537
 
511
538
    library = ctypes.util.find_library("gnutls")
512
539
    if library is None:
513
540
        library = ctypes.util.find_library("gnutls-deb0")
514
541
    _library = ctypes.cdll.LoadLibrary(library)
515
542
    del library
516
 
    _need_version = b"3.3.0"
517
 
    _tls_rawpk_version = b"3.6.6"
518
 
 
519
 
    def __init__(self):
520
 
        # Need to use "self" here, since this method is called before
521
 
        # the assignment to the "gnutls" global variable happens.
522
 
        if self.check_version(self._need_version) is None:
523
 
            raise self.Error("Needs GnuTLS {} or later"
524
 
                             .format(self._need_version))
525
543
 
526
544
    # Unless otherwise indicated, the constants and types below are
527
545
    # all from the gnutls/gnutls.h C header file.
544
562
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
545
563
 
546
564
    # Types
547
 
    class session_int(ctypes.Structure):
 
565
    class _session_int(ctypes.Structure):
548
566
        _fields_ = []
549
 
    session_t = ctypes.POINTER(session_int)
 
567
    session_t = ctypes.POINTER(_session_int)
550
568
 
551
569
    class certificate_credentials_st(ctypes.Structure):
552
570
        _fields_ = []
555
573
    certificate_type_t = ctypes.c_int
556
574
 
557
575
    class datum_t(ctypes.Structure):
558
 
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
559
 
                    ('size', ctypes.c_uint)]
 
576
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
 
577
                    ("size", ctypes.c_uint)]
560
578
 
561
 
    class openpgp_crt_int(ctypes.Structure):
 
579
    class _openpgp_crt_int(ctypes.Structure):
562
580
        _fields_ = []
563
 
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
581
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
564
582
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
565
583
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
566
584
    credentials_type_t = ctypes.c_int
569
587
 
570
588
    # Exceptions
571
589
    class Error(Exception):
572
 
        # We need to use the class name "GnuTLS" here, since this
573
 
        # exception might be raised from within GnuTLS.__init__,
574
 
        # which is called before the assignment to the "gnutls"
575
 
        # global variable has happened.
576
590
        def __init__(self, message=None, code=None, args=()):
577
591
            # Default usage is by a message string, but if a return
578
592
            # code is passed, convert it to a string with
579
593
            # gnutls.strerror()
580
594
            self.code = code
581
595
            if message is None and code is not None:
582
 
                message = GnuTLS.strerror(code)
583
 
            return super(GnuTLS.Error, self).__init__(
 
596
                message = gnutls.strerror(code).decode(
 
597
                    "utf-8", errors="replace")
 
598
            return super(gnutls.Error, self).__init__(
584
599
                message, *args)
585
600
 
586
601
    class CertificateSecurityError(Error):
587
602
        pass
588
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
 
589
629
    # Classes
590
 
    class Credentials(object):
 
630
    class Credentials(With_from_param):
591
631
        def __init__(self):
592
 
            self._c_object = gnutls.certificate_credentials_t()
593
 
            gnutls.certificate_allocate_credentials(
594
 
                ctypes.byref(self._c_object))
 
632
            self._as_parameter_ = gnutls.certificate_credentials_t()
 
633
            gnutls.certificate_allocate_credentials(self)
595
634
            self.type = gnutls.CRD_CERTIFICATE
596
635
 
597
636
        def __del__(self):
598
 
            gnutls.certificate_free_credentials(self._c_object)
 
637
            gnutls.certificate_free_credentials(self)
599
638
 
600
 
    class ClientSession(object):
 
639
    class ClientSession(With_from_param):
601
640
        def __init__(self, socket, credentials=None):
602
 
            self._c_object = gnutls.session_t()
 
641
            self._as_parameter_ = gnutls.session_t()
603
642
            gnutls_flags = gnutls.CLIENT
604
 
            if gnutls.check_version("3.5.6"):
 
643
            if gnutls.check_version(b"3.5.6"):
605
644
                gnutls_flags |= gnutls.NO_TICKETS
606
645
            if gnutls.has_rawpk:
607
646
                gnutls_flags |= gnutls.ENABLE_RAWPK
608
 
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
 
647
            gnutls.init(self, gnutls_flags)
609
648
            del gnutls_flags
610
 
            gnutls.set_default_priority(self._c_object)
611
 
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
612
 
            gnutls.handshake_set_private_extensions(self._c_object,
613
 
                                                    True)
 
649
            gnutls.set_default_priority(self)
 
650
            gnutls.transport_set_ptr(self, socket.fileno())
 
651
            gnutls.handshake_set_private_extensions(self, True)
614
652
            self.socket = socket
615
653
            if credentials is None:
616
654
                credentials = gnutls.Credentials()
617
 
            gnutls.credentials_set(self._c_object, credentials.type,
618
 
                                   ctypes.cast(credentials._c_object,
619
 
                                               ctypes.c_void_p))
 
655
            gnutls.credentials_set(self, credentials.type,
 
656
                                   credentials)
620
657
            self.credentials = credentials
621
658
 
622
659
        def __del__(self):
623
 
            gnutls.deinit(self._c_object)
 
660
            gnutls.deinit(self)
624
661
 
625
662
        def handshake(self):
626
 
            return gnutls.handshake(self._c_object)
 
663
            return gnutls.handshake(self)
627
664
 
628
665
        def send(self, data):
629
666
            data = bytes(data)
630
667
            data_len = len(data)
631
668
            while data_len > 0:
632
 
                data_len -= gnutls.record_send(self._c_object,
633
 
                                               data[-data_len:],
 
669
                data_len -= gnutls.record_send(self, data[-data_len:],
634
670
                                               data_len)
635
671
 
636
672
        def bye(self):
637
 
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
673
            return gnutls.bye(self, gnutls.SHUT_RDWR)
638
674
 
639
675
    # Error handling functions
640
676
    def _error_code(result):
641
677
        """A function to raise exceptions on errors, suitable
642
 
        for the 'restype' attribute on ctypes functions"""
643
 
        if result >= 0:
 
678
        for the "restype" attribute on ctypes functions"""
 
679
        if result >= gnutls.E_SUCCESS:
644
680
            return result
645
681
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
646
682
            raise gnutls.CertificateSecurityError(code=result)
647
683
        raise gnutls.Error(code=result)
648
684
 
649
 
    def _retry_on_error(result, func, arguments):
 
685
    def _retry_on_error(result, func, arguments,
 
686
                        _error_code=_error_code):
650
687
        """A function to retry on some errors, suitable
651
 
        for the 'errcheck' attribute on ctypes functions"""
652
 
        while result < 0:
 
688
        for the "errcheck" attribute on ctypes functions"""
 
689
        while result < gnutls.E_SUCCESS:
653
690
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
654
691
                return _error_code(result)
655
692
            result = func(*arguments)
660
697
 
661
698
    # Functions
662
699
    priority_set_direct = _library.gnutls_priority_set_direct
663
 
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
700
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
664
701
                                    ctypes.POINTER(ctypes.c_char_p)]
665
702
    priority_set_direct.restype = _error_code
666
703
 
667
704
    init = _library.gnutls_init
668
 
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
705
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
669
706
    init.restype = _error_code
670
707
 
671
708
    set_default_priority = _library.gnutls_set_default_priority
672
 
    set_default_priority.argtypes = [session_t]
 
709
    set_default_priority.argtypes = [ClientSession]
673
710
    set_default_priority.restype = _error_code
674
711
 
675
712
    record_send = _library.gnutls_record_send
676
 
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
713
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
677
714
                            ctypes.c_size_t]
678
715
    record_send.restype = ctypes.c_ssize_t
679
716
    record_send.errcheck = _retry_on_error
681
718
    certificate_allocate_credentials = (
682
719
        _library.gnutls_certificate_allocate_credentials)
683
720
    certificate_allocate_credentials.argtypes = [
684
 
        ctypes.POINTER(certificate_credentials_t)]
 
721
        PointerTo(Credentials)]
685
722
    certificate_allocate_credentials.restype = _error_code
686
723
 
687
724
    certificate_free_credentials = (
688
725
        _library.gnutls_certificate_free_credentials)
689
 
    certificate_free_credentials.argtypes = [
690
 
        certificate_credentials_t]
 
726
    certificate_free_credentials.argtypes = [Credentials]
691
727
    certificate_free_credentials.restype = None
692
728
 
693
729
    handshake_set_private_extensions = (
694
730
        _library.gnutls_handshake_set_private_extensions)
695
 
    handshake_set_private_extensions.argtypes = [session_t,
 
731
    handshake_set_private_extensions.argtypes = [ClientSession,
696
732
                                                 ctypes.c_int]
697
733
    handshake_set_private_extensions.restype = None
698
734
 
699
735
    credentials_set = _library.gnutls_credentials_set
700
 
    credentials_set.argtypes = [session_t, credentials_type_t,
701
 
                                ctypes.c_void_p]
 
736
    credentials_set.argtypes = [ClientSession, credentials_type_t,
 
737
                                CastToVoidPointer(Credentials)]
702
738
    credentials_set.restype = _error_code
703
739
 
704
740
    strerror = _library.gnutls_strerror
706
742
    strerror.restype = ctypes.c_char_p
707
743
 
708
744
    certificate_type_get = _library.gnutls_certificate_type_get
709
 
    certificate_type_get.argtypes = [session_t]
 
745
    certificate_type_get.argtypes = [ClientSession]
710
746
    certificate_type_get.restype = _error_code
711
747
 
712
748
    certificate_get_peers = _library.gnutls_certificate_get_peers
713
 
    certificate_get_peers.argtypes = [session_t,
 
749
    certificate_get_peers.argtypes = [ClientSession,
714
750
                                      ctypes.POINTER(ctypes.c_uint)]
715
751
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
716
752
 
723
759
    global_set_log_function.restype = None
724
760
 
725
761
    deinit = _library.gnutls_deinit
726
 
    deinit.argtypes = [session_t]
 
762
    deinit.argtypes = [ClientSession]
727
763
    deinit.restype = None
728
764
 
729
765
    handshake = _library.gnutls_handshake
730
 
    handshake.argtypes = [session_t]
731
 
    handshake.restype = _error_code
 
766
    handshake.argtypes = [ClientSession]
 
767
    handshake.restype = ctypes.c_int
732
768
    handshake.errcheck = _retry_on_error
733
769
 
734
770
    transport_set_ptr = _library.gnutls_transport_set_ptr
735
 
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
771
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
736
772
    transport_set_ptr.restype = None
737
773
 
738
774
    bye = _library.gnutls_bye
739
 
    bye.argtypes = [session_t, close_request_t]
740
 
    bye.restype = _error_code
 
775
    bye.argtypes = [ClientSession, close_request_t]
 
776
    bye.restype = ctypes.c_int
741
777
    bye.errcheck = _retry_on_error
742
778
 
743
779
    check_version = _library.gnutls_check_version
744
780
    check_version.argtypes = [ctypes.c_char_p]
745
781
    check_version.restype = ctypes.c_char_p
746
782
 
 
783
    _need_version = b"3.3.0"
 
784
    if check_version(_need_version) is None:
 
785
        raise self.Error("Needs GnuTLS {} or later"
 
786
                         .format(_need_version))
 
787
 
 
788
    _tls_rawpk_version = b"3.6.6"
747
789
    has_rawpk = bool(check_version(_tls_rawpk_version))
748
790
 
749
791
    if has_rawpk:
754
796
 
755
797
        x509_crt_fmt_t = ctypes.c_int
756
798
 
757
 
        # All the function declarations below are from gnutls/abstract.h
 
799
        # All the function declarations below are from
 
800
        # gnutls/abstract.h
758
801
        pubkey_init = _library.gnutls_pubkey_init
759
802
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
760
803
        pubkey_init.restype = _error_code
774
817
        pubkey_deinit.argtypes = [pubkey_t]
775
818
        pubkey_deinit.restype = None
776
819
    else:
777
 
        # All the function declarations below are from gnutls/openpgp.h
 
820
        # All the function declarations below are from
 
821
        # gnutls/openpgp.h
778
822
 
779
823
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
780
824
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
786
830
                                       openpgp_crt_fmt_t]
787
831
        openpgp_crt_import.restype = _error_code
788
832
 
789
 
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
790
 
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
791
 
                                            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
        ]
792
840
        openpgp_crt_verify_self.restype = _error_code
793
841
 
794
842
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
803
851
                                                    ctypes.c_size_t)]
804
852
        openpgp_crt_get_fingerprint.restype = _error_code
805
853
 
806
 
    if check_version("3.6.4"):
 
854
    if check_version(b"3.6.4"):
807
855
        certificate_type_get2 = _library.gnutls_certificate_type_get2
808
 
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
 
856
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
809
857
        certificate_type_get2.restype = _error_code
810
858
 
811
859
    # Remove non-public functions
812
860
    del _error_code, _retry_on_error
813
 
# Create the global "gnutls" object, simulating a module
814
 
gnutls = GnuTLS()
815
861
 
816
862
 
817
863
def call_pipe(connection,       # : multiprocessing.Connection
825
871
    connection.close()
826
872
 
827
873
 
828
 
class Client(object):
 
874
class Client:
829
875
    """A representation of a client host served by this server.
830
876
 
831
877
    Attributes:
832
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
878
    approved:   bool(); None if not yet approved/disapproved
833
879
    approval_delay: datetime.timedelta(); Time to wait for approval
834
880
    approval_duration: datetime.timedelta(); Duration of one approval
835
 
    checker:    subprocess.Popen(); a running checker process used
836
 
                                    to see if the client lives.
837
 
                                    'None' if no process is running.
 
881
    checker: multiprocessing.Process(); a running checker process used
 
882
             to see if the client lives. None if no process is
 
883
             running.
838
884
    checker_callback_tag: a GLib event source tag, or None
839
885
    checker_command: string; External command which is run to check
840
886
                     if client lives.  %() expansions are done at
963
1009
            self.last_enabled = None
964
1010
            self.expires = None
965
1011
 
966
 
        logger.debug("Creating client %r", self.name)
967
 
        logger.debug("  Key ID: %s", self.key_id)
968
 
        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)
969
1015
        self.created = settings.get("created",
970
1016
                                    datetime.datetime.utcnow())
971
1017
 
1010
1056
        if not getattr(self, "enabled", False):
1011
1057
            return False
1012
1058
        if not quiet:
1013
 
            logger.info("Disabling client %s", self.name)
 
1059
            log.info("Disabling client %s", self.name)
1014
1060
        if getattr(self, "disable_initiator_tag", None) is not None:
1015
1061
            GLib.source_remove(self.disable_initiator_tag)
1016
1062
            self.disable_initiator_tag = None
1034
1080
        if self.checker_initiator_tag is not None:
1035
1081
            GLib.source_remove(self.checker_initiator_tag)
1036
1082
        self.checker_initiator_tag = GLib.timeout_add(
1037
 
            int(self.interval.total_seconds() * 1000),
 
1083
            random.randrange(int(self.interval.total_seconds() * 1000
 
1084
                                 + 1)),
1038
1085
            self.start_checker)
1039
1086
        # Schedule a disable() when 'timeout' has passed
1040
1087
        if self.disable_initiator_tag is not None:
1047
1094
    def checker_callback(self, source, condition, connection,
1048
1095
                         command):
1049
1096
        """The checker has completed, so take appropriate actions."""
1050
 
        self.checker_callback_tag = None
1051
 
        self.checker = None
1052
1097
        # Read return code from connection (see call_pipe)
1053
1098
        returncode = connection.recv()
1054
1099
        connection.close()
 
1100
        if self.checker is not None:
 
1101
            self.checker.join()
 
1102
        self.checker_callback_tag = None
 
1103
        self.checker = None
1055
1104
 
1056
1105
        if returncode >= 0:
1057
1106
            self.last_checker_status = returncode
1058
1107
            self.last_checker_signal = None
1059
1108
            if self.last_checker_status == 0:
1060
 
                logger.info("Checker for %(name)s succeeded",
1061
 
                            vars(self))
 
1109
                log.info("Checker for %(name)s succeeded", vars(self))
1062
1110
                self.checked_ok()
1063
1111
            else:
1064
 
                logger.info("Checker for %(name)s failed", vars(self))
 
1112
                log.info("Checker for %(name)s failed", vars(self))
1065
1113
        else:
1066
1114
            self.last_checker_status = -1
1067
1115
            self.last_checker_signal = -returncode
1068
 
            logger.warning("Checker for %(name)s crashed?",
1069
 
                           vars(self))
 
1116
            log.warning("Checker for %(name)s crashed?", vars(self))
1070
1117
        return False
1071
1118
 
1072
1119
    def checked_ok(self):
1106
1153
        # should be.
1107
1154
 
1108
1155
        if self.checker is not None and not self.checker.is_alive():
1109
 
            logger.warning("Checker was not alive; joining")
 
1156
            log.warning("Checker was not alive; joining")
1110
1157
            self.checker.join()
1111
1158
            self.checker = None
1112
1159
        # Start a new checker if needed
1113
1160
        if self.checker is None:
1114
1161
            # Escape attributes for the shell
1115
1162
            escaped_attrs = {
1116
 
                attr: re.escape(str(getattr(self, attr)))
 
1163
                attr: shlex.quote(str(getattr(self, attr)))
1117
1164
                for attr in self.runtime_expansions}
1118
1165
            try:
1119
1166
                command = self.checker_command % escaped_attrs
1120
1167
            except TypeError as error:
1121
 
                logger.error('Could not format string "%s"',
1122
 
                             self.checker_command,
1123
 
                             exc_info=error)
 
1168
                log.error('Could not format string "%s"',
 
1169
                          self.checker_command, exc_info=error)
1124
1170
                return True     # Try again later
1125
1171
            self.current_checker_command = command
1126
 
            logger.info("Starting checker %r for %s", command,
1127
 
                        self.name)
 
1172
            log.info("Starting checker %r for %s", command, self.name)
1128
1173
            # We don't need to redirect stdout and stderr, since
1129
1174
            # in normal mode, that is already done by daemon(),
1130
1175
            # and in debug mode we don't want to.  (Stdin is
1146
1191
                kwargs=popen_args)
1147
1192
            self.checker.start()
1148
1193
            self.checker_callback_tag = GLib.io_add_watch(
1149
 
                pipe[0].fileno(), GLib.IO_IN,
 
1194
                GLib.IOChannel.unix_new(pipe[0].fileno()),
 
1195
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1150
1196
                self.checker_callback, pipe[0], command)
1151
1197
        # Re-run this periodically if run by GLib.timeout_add
1152
1198
        return True
1158
1204
            self.checker_callback_tag = None
1159
1205
        if getattr(self, "checker", None) is None:
1160
1206
            return
1161
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
1207
        log.debug("Stopping checker for %(name)s", vars(self))
1162
1208
        self.checker.terminate()
1163
1209
        self.checker = None
1164
1210
 
1191
1237
        func._dbus_name = func.__name__
1192
1238
        if func._dbus_name.endswith("_dbus_property"):
1193
1239
            func._dbus_name = func._dbus_name[:-14]
1194
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
 
1240
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
1195
1241
        return func
1196
1242
 
1197
1243
    return decorator
1286
1332
 
1287
1333
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1288
1334
                         out_signature="s",
1289
 
                         path_keyword='object_path',
1290
 
                         connection_keyword='connection')
 
1335
                         path_keyword="object_path",
 
1336
                         connection_keyword="connection")
1291
1337
    def Introspect(self, object_path, connection):
1292
1338
        """Overloading of standard D-Bus method.
1293
1339
 
1342
1388
            document.unlink()
1343
1389
        except (AttributeError, xml.dom.DOMException,
1344
1390
                xml.parsers.expat.ExpatError) as error:
1345
 
            logger.error("Failed to override Introspection method",
1346
 
                         exc_info=error)
 
1391
            log.error("Failed to override Introspection method",
 
1392
                      exc_info=error)
1347
1393
        return xmlstring
1348
1394
 
1349
1395
 
1407
1453
                raise ValueError("Byte arrays not supported for non-"
1408
1454
                                 "'ay' signature {!r}"
1409
1455
                                 .format(prop._dbus_signature))
1410
 
            value = dbus.ByteArray(b''.join(chr(byte)
1411
 
                                            for byte in value))
 
1456
            value = dbus.ByteArray(bytes(value))
1412
1457
        prop(value)
1413
1458
 
1414
1459
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1447
1492
 
1448
1493
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1449
1494
                         out_signature="s",
1450
 
                         path_keyword='object_path',
1451
 
                         connection_keyword='connection')
 
1495
                         path_keyword="object_path",
 
1496
                         connection_keyword="connection")
1452
1497
    def Introspect(self, object_path, connection):
1453
1498
        """Overloading of standard D-Bus method.
1454
1499
 
1510
1555
            document.unlink()
1511
1556
        except (AttributeError, xml.dom.DOMException,
1512
1557
                xml.parsers.expat.ExpatError) as error:
1513
 
            logger.error("Failed to override Introspection method",
1514
 
                         exc_info=error)
 
1558
            log.error("Failed to override Introspection method",
 
1559
                      exc_info=error)
1515
1560
        return xmlstring
1516
1561
 
1517
1562
 
1549
1594
 
1550
1595
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1551
1596
                         out_signature="s",
1552
 
                         path_keyword='object_path',
1553
 
                         connection_keyword='connection')
 
1597
                         path_keyword="object_path",
 
1598
                         connection_keyword="connection")
1554
1599
    def Introspect(self, object_path, connection):
1555
1600
        """Overloading of standard D-Bus method.
1556
1601
 
1581
1626
            document.unlink()
1582
1627
        except (AttributeError, xml.dom.DOMException,
1583
1628
                xml.parsers.expat.ExpatError) as error:
1584
 
            logger.error("Failed to override Introspection method",
1585
 
                         exc_info=error)
 
1629
            log.error("Failed to override Introspection method",
 
1630
                      exc_info=error)
1586
1631
        return xmlstring
1587
1632
 
1588
1633
 
2219
2264
    del _interface
2220
2265
 
2221
2266
 
2222
 
class ProxyClient(object):
 
2267
class ProxyClient:
2223
2268
    def __init__(self, child_pipe, key_id, fpr, address):
2224
2269
        self._pipe = child_pipe
2225
 
        self._pipe.send(('init', key_id, fpr, address))
 
2270
        self._pipe.send(("init", key_id, fpr, address))
2226
2271
        if not self._pipe.recv():
2227
2272
            raise KeyError(key_id or fpr)
2228
2273
 
2229
2274
    def __getattribute__(self, name):
2230
 
        if name == '_pipe':
 
2275
        if name == "_pipe":
2231
2276
            return super(ProxyClient, self).__getattribute__(name)
2232
 
        self._pipe.send(('getattr', name))
 
2277
        self._pipe.send(("getattr", name))
2233
2278
        data = self._pipe.recv()
2234
 
        if data[0] == 'data':
 
2279
        if data[0] == "data":
2235
2280
            return data[1]
2236
 
        if data[0] == 'function':
 
2281
        if data[0] == "function":
2237
2282
 
2238
2283
            def func(*args, **kwargs):
2239
 
                self._pipe.send(('funcall', name, args, kwargs))
 
2284
                self._pipe.send(("funcall", name, args, kwargs))
2240
2285
                return self._pipe.recv()[1]
2241
2286
 
2242
2287
            return func
2243
2288
 
2244
2289
    def __setattr__(self, name, value):
2245
 
        if name == '_pipe':
 
2290
        if name == "_pipe":
2246
2291
            return super(ProxyClient, self).__setattr__(name, value)
2247
 
        self._pipe.send(('setattr', name, value))
 
2292
        self._pipe.send(("setattr", name, value))
2248
2293
 
2249
2294
 
2250
2295
class ClientHandler(socketserver.BaseRequestHandler, object):
2255
2300
 
2256
2301
    def handle(self):
2257
2302
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2258
 
            logger.info("TCP connection from: %s",
2259
 
                        str(self.client_address))
2260
 
            logger.debug("Pipe FD: %d",
2261
 
                         self.server.child_pipe.fileno())
 
2303
            log.info("TCP connection from: %s",
 
2304
                     str(self.client_address))
 
2305
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2262
2306
 
2263
2307
            session = gnutls.ClientSession(self.request)
2264
2308
 
2265
 
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2309
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
2266
2310
            #                       "+AES-256-CBC", "+SHA1",
2267
2311
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2268
2312
            #                       "+DHE-DSS"))
2270
2314
            priority = self.server.gnutls_priority
2271
2315
            if priority is None:
2272
2316
                priority = "NORMAL"
2273
 
            gnutls.priority_set_direct(session._c_object,
2274
 
                                       priority.encode("utf-8"),
2275
 
                                       None)
 
2317
            gnutls.priority_set_direct(session,
 
2318
                                       priority.encode("utf-8"), None)
2276
2319
 
2277
2320
            # Start communication using the Mandos protocol
2278
2321
            # Get protocol number
2279
2322
            line = self.request.makefile().readline()
2280
 
            logger.debug("Protocol version: %r", line)
 
2323
            log.debug("Protocol version: %r", line)
2281
2324
            try:
2282
2325
                if int(line.strip().split()[0]) > 1:
2283
2326
                    raise RuntimeError(line)
2284
2327
            except (ValueError, IndexError, RuntimeError) as error:
2285
 
                logger.error("Unknown protocol version: %s", error)
 
2328
                log.error("Unknown protocol version: %s", error)
2286
2329
                return
2287
2330
 
2288
2331
            # Start GnuTLS connection
2289
2332
            try:
2290
2333
                session.handshake()
2291
2334
            except gnutls.Error as error:
2292
 
                logger.warning("Handshake failed: %s", error)
 
2335
                log.warning("Handshake failed: %s", error)
2293
2336
                # Do not run session.bye() here: the session is not
2294
2337
                # established.  Just abandon the request.
2295
2338
                return
2296
 
            logger.debug("Handshake succeeded")
 
2339
            log.debug("Handshake succeeded")
2297
2340
 
2298
2341
            approval_required = False
2299
2342
            try:
2300
2343
                if gnutls.has_rawpk:
2301
 
                    fpr = ""
 
2344
                    fpr = b""
2302
2345
                    try:
2303
2346
                        key_id = self.key_id(
2304
2347
                            self.peer_certificate(session))
2305
2348
                    except (TypeError, gnutls.Error) as error:
2306
 
                        logger.warning("Bad certificate: %s", error)
 
2349
                        log.warning("Bad certificate: %s", error)
2307
2350
                        return
2308
 
                    logger.debug("Key ID: %s", key_id)
 
2351
                    log.debug("Key ID: %s",
 
2352
                              key_id.decode("utf-8",
 
2353
                                            errors="replace"))
2309
2354
 
2310
2355
                else:
2311
 
                    key_id = ""
 
2356
                    key_id = b""
2312
2357
                    try:
2313
2358
                        fpr = self.fingerprint(
2314
2359
                            self.peer_certificate(session))
2315
2360
                    except (TypeError, gnutls.Error) as error:
2316
 
                        logger.warning("Bad certificate: %s", error)
 
2361
                        log.warning("Bad certificate: %s", error)
2317
2362
                        return
2318
 
                    logger.debug("Fingerprint: %s", fpr)
 
2363
                    log.debug("Fingerprint: %s", fpr)
2319
2364
 
2320
2365
                try:
2321
2366
                    client = ProxyClient(child_pipe, key_id, fpr,
2330
2375
 
2331
2376
                while True:
2332
2377
                    if not client.enabled:
2333
 
                        logger.info("Client %s is disabled",
2334
 
                                    client.name)
 
2378
                        log.info("Client %s is disabled", client.name)
2335
2379
                        if self.server.use_dbus:
2336
2380
                            # Emit D-Bus signal
2337
2381
                            client.Rejected("Disabled")
2341
2385
                        # We are approved or approval is disabled
2342
2386
                        break
2343
2387
                    elif client.approved is None:
2344
 
                        logger.info("Client %s needs approval",
2345
 
                                    client.name)
 
2388
                        log.info("Client %s needs approval",
 
2389
                                 client.name)
2346
2390
                        if self.server.use_dbus:
2347
2391
                            # Emit D-Bus signal
2348
2392
                            client.NeedApproval(
2349
2393
                                client.approval_delay.total_seconds()
2350
2394
                                * 1000, client.approved_by_default)
2351
2395
                    else:
2352
 
                        logger.warning("Client %s was not approved",
2353
 
                                       client.name)
 
2396
                        log.warning("Client %s was not approved",
 
2397
                                    client.name)
2354
2398
                        if self.server.use_dbus:
2355
2399
                            # Emit D-Bus signal
2356
2400
                            client.Rejected("Denied")
2364
2408
                    time2 = datetime.datetime.now()
2365
2409
                    if (time2 - time) >= delay:
2366
2410
                        if not client.approved_by_default:
2367
 
                            logger.warning("Client %s timed out while"
2368
 
                                           " waiting for approval",
2369
 
                                           client.name)
 
2411
                            log.warning("Client %s timed out while"
 
2412
                                        " waiting for approval",
 
2413
                                        client.name)
2370
2414
                            if self.server.use_dbus:
2371
2415
                                # Emit D-Bus signal
2372
2416
                                client.Rejected("Approval timed out")
2379
2423
                try:
2380
2424
                    session.send(client.secret)
2381
2425
                except gnutls.Error as error:
2382
 
                    logger.warning("gnutls send failed",
2383
 
                                   exc_info=error)
 
2426
                    log.warning("gnutls send failed", exc_info=error)
2384
2427
                    return
2385
2428
 
2386
 
                logger.info("Sending secret to %s", client.name)
 
2429
                log.info("Sending secret to %s", client.name)
2387
2430
                # bump the timeout using extended_timeout
2388
2431
                client.bump_timeout(client.extended_timeout)
2389
2432
                if self.server.use_dbus:
2396
2439
                try:
2397
2440
                    session.bye()
2398
2441
                except gnutls.Error as error:
2399
 
                    logger.warning("GnuTLS bye failed",
2400
 
                                   exc_info=error)
 
2442
                    log.warning("GnuTLS bye failed", exc_info=error)
2401
2443
 
2402
2444
    @staticmethod
2403
2445
    def peer_certificate(session):
2404
2446
        "Return the peer's certificate as a bytestring"
2405
2447
        try:
2406
 
            cert_type = gnutls.certificate_type_get2(session._c_object,
2407
 
                                                     gnutls.CTYPE_PEERS)
 
2448
            cert_type = gnutls.certificate_type_get2(
 
2449
                session, gnutls.CTYPE_PEERS)
2408
2450
        except AttributeError:
2409
 
            cert_type = gnutls.certificate_type_get(session._c_object)
 
2451
            cert_type = gnutls.certificate_type_get(session)
2410
2452
        if gnutls.has_rawpk:
2411
2453
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2412
2454
        else:
2413
2455
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2414
2456
        # If not a valid certificate type...
2415
2457
        if cert_type not in valid_cert_types:
2416
 
            logger.info("Cert type %r not in %r", cert_type,
2417
 
                        valid_cert_types)
 
2458
            log.info("Cert type %r not in %r", cert_type,
 
2459
                     valid_cert_types)
2418
2460
            # ...return invalid data
2419
2461
            return b""
2420
2462
        list_size = ctypes.c_uint(1)
2421
2463
        cert_list = (gnutls.certificate_get_peers
2422
 
                     (session._c_object, ctypes.byref(list_size)))
 
2464
                     (session, ctypes.byref(list_size)))
2423
2465
        if not bool(cert_list) and list_size.value != 0:
2424
2466
            raise gnutls.Error("error getting peer certificate")
2425
2467
        if list_size.value == 0:
2447
2489
        buf = ctypes.create_string_buffer(32)
2448
2490
        buf_len = ctypes.c_size_t(len(buf))
2449
2491
        # Get the key ID from the raw public key into the buffer
2450
 
        gnutls.pubkey_get_key_id(pubkey,
2451
 
                                 gnutls.KEYID_USE_SHA256,
2452
 
                                 ctypes.cast(ctypes.byref(buf),
2453
 
                                             ctypes.POINTER(ctypes.c_ubyte)),
2454
 
                                 ctypes.byref(buf_len))
 
2492
        gnutls.pubkey_get_key_id(
 
2493
            pubkey,
 
2494
            gnutls.KEYID_USE_SHA256,
 
2495
            ctypes.cast(ctypes.byref(buf),
 
2496
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2497
            ctypes.byref(buf_len))
2455
2498
        # Deinit the certificate
2456
2499
        gnutls.pubkey_deinit(pubkey)
2457
2500
 
2498
2541
        return hex_fpr
2499
2542
 
2500
2543
 
2501
 
class MultiprocessingMixIn(object):
 
2544
class MultiprocessingMixIn:
2502
2545
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2503
2546
 
2504
2547
    def sub_process_main(self, request, address):
2516
2559
        return proc
2517
2560
 
2518
2561
 
2519
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
2562
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2520
2563
    """ adds a pipe to the MixIn """
2521
2564
 
2522
2565
    def process_request(self, request, client_address):
2537
2580
 
2538
2581
 
2539
2582
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2540
 
                     socketserver.TCPServer, object):
2541
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
2583
                     socketserver.TCPServer):
 
2584
    """IPv6-capable TCP server.  Accepts None as address and/or port
2542
2585
 
2543
2586
    Attributes:
2544
2587
        enabled:        Boolean; whether this server is activated yet
2595
2638
            if SO_BINDTODEVICE is None:
2596
2639
                # Fall back to a hard-coded value which seems to be
2597
2640
                # common enough.
2598
 
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2641
                log.warning("SO_BINDTODEVICE not found, trying 25")
2599
2642
                SO_BINDTODEVICE = 25
2600
2643
            try:
2601
2644
                self.socket.setsockopt(
2603
2646
                    (self.interface + "\0").encode("utf-8"))
2604
2647
            except socket.error as error:
2605
2648
                if error.errno == errno.EPERM:
2606
 
                    logger.error("No permission to bind to"
2607
 
                                 " interface %s", self.interface)
 
2649
                    log.error("No permission to bind to interface %s",
 
2650
                              self.interface)
2608
2651
                elif error.errno == errno.ENOPROTOOPT:
2609
 
                    logger.error("SO_BINDTODEVICE not available;"
2610
 
                                 " cannot bind to interface %s",
2611
 
                                 self.interface)
 
2652
                    log.error("SO_BINDTODEVICE not available; cannot"
 
2653
                              " bind to interface %s", self.interface)
2612
2654
                elif error.errno == errno.ENODEV:
2613
 
                    logger.error("Interface %s does not exist,"
2614
 
                                 " cannot bind", self.interface)
 
2655
                    log.error("Interface %s does not exist, cannot"
 
2656
                              " bind", self.interface)
2615
2657
                else:
2616
2658
                    raise
2617
2659
        # Only bind(2) the socket if we really need to.
2618
2660
        if self.server_address[0] or self.server_address[1]:
 
2661
            if self.server_address[1]:
 
2662
                self.allow_reuse_address = True
2619
2663
            if not self.server_address[0]:
2620
2664
                if self.address_family == socket.AF_INET6:
2621
2665
                    any_address = "::"  # in6addr_any
2674
2718
    def add_pipe(self, parent_pipe, proc):
2675
2719
        # Call "handle_ipc" for both data and EOF events
2676
2720
        GLib.io_add_watch(
2677
 
            parent_pipe.fileno(),
2678
 
            GLib.IO_IN | GLib.IO_HUP,
 
2721
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2722
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2679
2723
            functools.partial(self.handle_ipc,
2680
2724
                              parent_pipe=parent_pipe,
2681
2725
                              proc=proc))
2694
2738
        request = parent_pipe.recv()
2695
2739
        command = request[0]
2696
2740
 
2697
 
        if command == 'init':
 
2741
        if command == "init":
2698
2742
            key_id = request[1].decode("ascii")
2699
2743
            fpr = request[2].decode("ascii")
2700
2744
            address = request[3]
2701
2745
 
2702
2746
            for c in self.clients.values():
 
2747
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
 
2748
                              "27AE41E4649B934CA495991B7852B855"):
 
2749
                    continue
2703
2750
                if key_id and c.key_id == key_id:
2704
2751
                    client = c
2705
2752
                    break
2707
2754
                    client = c
2708
2755
                    break
2709
2756
            else:
2710
 
                logger.info("Client not found for key ID: %s, address"
2711
 
                            ": %s", key_id or fpr, address)
 
2757
                log.info("Client not found for key ID: %s, address:"
 
2758
                         " %s", key_id or fpr, address)
2712
2759
                if self.use_dbus:
2713
2760
                    # Emit D-Bus signal
2714
2761
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2717
2764
                return False
2718
2765
 
2719
2766
            GLib.io_add_watch(
2720
 
                parent_pipe.fileno(),
2721
 
                GLib.IO_IN | GLib.IO_HUP,
 
2767
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2768
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2722
2769
                functools.partial(self.handle_ipc,
2723
2770
                                  parent_pipe=parent_pipe,
2724
2771
                                  proc=proc,
2727
2774
            # remove the old hook in favor of the new above hook on
2728
2775
            # same fileno
2729
2776
            return False
2730
 
        if command == 'funcall':
 
2777
        if command == "funcall":
2731
2778
            funcname = request[1]
2732
2779
            args = request[2]
2733
2780
            kwargs = request[3]
2734
2781
 
2735
 
            parent_pipe.send(('data', getattr(client_object,
 
2782
            parent_pipe.send(("data", getattr(client_object,
2736
2783
                                              funcname)(*args,
2737
2784
                                                        **kwargs)))
2738
2785
 
2739
 
        if command == 'getattr':
 
2786
        if command == "getattr":
2740
2787
            attrname = request[1]
2741
2788
            if isinstance(client_object.__getattribute__(attrname),
2742
 
                          collections.Callable):
2743
 
                parent_pipe.send(('function', ))
 
2789
                          collections.abc.Callable):
 
2790
                parent_pipe.send(("function", ))
2744
2791
            else:
2745
2792
                parent_pipe.send((
2746
 
                    'data', client_object.__getattribute__(attrname)))
 
2793
                    "data", client_object.__getattribute__(attrname)))
2747
2794
 
2748
 
        if command == 'setattr':
 
2795
        if command == "setattr":
2749
2796
            attrname = request[1]
2750
2797
            value = request[2]
2751
2798
            setattr(client_object, attrname, value)
2756
2803
def rfc3339_duration_to_delta(duration):
2757
2804
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2758
2805
 
2759
 
    >>> rfc3339_duration_to_delta("P7D")
2760
 
    datetime.timedelta(7)
2761
 
    >>> rfc3339_duration_to_delta("PT60S")
2762
 
    datetime.timedelta(0, 60)
2763
 
    >>> rfc3339_duration_to_delta("PT60M")
2764
 
    datetime.timedelta(0, 3600)
2765
 
    >>> rfc3339_duration_to_delta("PT24H")
2766
 
    datetime.timedelta(1)
2767
 
    >>> rfc3339_duration_to_delta("P1W")
2768
 
    datetime.timedelta(7)
2769
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2770
 
    datetime.timedelta(0, 330)
2771
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2772
 
    datetime.timedelta(1, 200)
 
2806
    >>> timedelta = datetime.timedelta
 
2807
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
 
2808
    True
 
2809
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
 
2810
    True
 
2811
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
 
2812
    True
 
2813
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
 
2814
    True
 
2815
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
 
2816
    True
 
2817
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
 
2818
    True
 
2819
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
 
2820
    True
 
2821
    >>> del timedelta
2773
2822
    """
2774
2823
 
2775
2824
    # Parsing an RFC 3339 duration with regular expressions is not
2855
2904
def string_to_delta(interval):
2856
2905
    """Parse a string and return a datetime.timedelta
2857
2906
 
2858
 
    >>> string_to_delta('7d')
2859
 
    datetime.timedelta(7)
2860
 
    >>> string_to_delta('60s')
2861
 
    datetime.timedelta(0, 60)
2862
 
    >>> string_to_delta('60m')
2863
 
    datetime.timedelta(0, 3600)
2864
 
    >>> string_to_delta('24h')
2865
 
    datetime.timedelta(1)
2866
 
    >>> string_to_delta('1w')
2867
 
    datetime.timedelta(7)
2868
 
    >>> string_to_delta('5m 30s')
2869
 
    datetime.timedelta(0, 330)
 
2907
    >>> string_to_delta("7d") == datetime.timedelta(7)
 
2908
    True
 
2909
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
 
2910
    True
 
2911
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
 
2912
    True
 
2913
    >>> string_to_delta("24h") == datetime.timedelta(1)
 
2914
    True
 
2915
    >>> string_to_delta("1w") == datetime.timedelta(7)
 
2916
    True
 
2917
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
 
2918
    True
2870
2919
    """
2871
2920
 
2872
2921
    try:
2974
3023
 
2975
3024
    options = parser.parse_args()
2976
3025
 
2977
 
    if options.check:
2978
 
        import doctest
2979
 
        fail_count, test_count = doctest.testmod()
2980
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2981
 
 
2982
3026
    # Default values for config file for server-global settings
2983
3027
    if gnutls.has_rawpk:
2984
3028
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3004
3048
    del priority
3005
3049
 
3006
3050
    # Parse config file for server-global settings
3007
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
3051
    server_config = configparser.ConfigParser(server_defaults)
3008
3052
    del server_defaults
3009
3053
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3010
 
    # Convert the SafeConfigParser object to a dict
 
3054
    # Convert the ConfigParser object to a dict
3011
3055
    server_settings = server_config.defaults()
3012
3056
    # Use the appropriate methods on the non-string config options
3013
3057
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3080
3124
 
3081
3125
    if server_settings["servicename"] != "Mandos":
3082
3126
        syslogger.setFormatter(
3083
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
3084
 
                              ' %(levelname)s: %(message)s'.format(
 
3127
            logging.Formatter("Mandos ({}) [%(process)d]:"
 
3128
                              " %(levelname)s: %(message)s".format(
3085
3129
                                  server_settings["servicename"])))
3086
3130
 
3087
3131
    # Parse config file with clients
3088
 
    client_config = configparser.SafeConfigParser(Client
3089
 
                                                  .client_defaults)
 
3132
    client_config = configparser.ConfigParser(Client.client_defaults)
3090
3133
    client_config.read(os.path.join(server_settings["configdir"],
3091
3134
                                    "clients.conf"))
3092
3135
 
3112
3155
        try:
3113
3156
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3114
3157
        except IOError as e:
3115
 
            logger.error("Could not open file %r", pidfilename,
3116
 
                         exc_info=e)
 
3158
            log.error("Could not open file %r", pidfilename,
 
3159
                      exc_info=e)
3117
3160
 
3118
3161
    for name, group in (("_mandos", "_mandos"),
3119
3162
                        ("mandos", "mandos"),
3130
3173
    try:
3131
3174
        os.setgid(gid)
3132
3175
        os.setuid(uid)
3133
 
        if debug:
3134
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3135
 
                                                             gid))
 
3176
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
3136
3177
    except OSError as error:
3137
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
3138
 
                       .format(uid, gid, os.strerror(error.errno)))
 
3178
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
 
3179
                    os.strerror(error.errno))
3139
3180
        if error.errno != errno.EPERM:
3140
3181
            raise
3141
3182
 
3148
3189
 
3149
3190
        @gnutls.log_func
3150
3191
        def debug_gnutls(level, string):
3151
 
            logger.debug("GnuTLS: %s", string[:-1])
 
3192
            log.debug("GnuTLS: %s",
 
3193
                      string[:-1].decode("utf-8", errors="replace"))
3152
3194
 
3153
3195
        gnutls.global_set_log_function(debug_gnutls)
3154
3196
 
3163
3205
        # Close all input and output, do double fork, etc.
3164
3206
        daemon()
3165
3207
 
3166
 
    # multiprocessing will use threads, so before we use GLib we need
3167
 
    # to inform GLib that threads will be used.
3168
 
    GLib.threads_init()
 
3208
    if gi.version_info < (3, 10, 2):
 
3209
        # multiprocessing will use threads, so before we use GLib we
 
3210
        # need to inform GLib that threads will be used.
 
3211
        GLib.threads_init()
3169
3212
 
3170
3213
    global main_loop
3171
3214
    # From the Avahi example code
3182
3225
                "se.bsnet.fukt.Mandos", bus,
3183
3226
                do_not_queue=True)
3184
3227
        except dbus.exceptions.DBusException as e:
3185
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
3228
            log.error("Disabling D-Bus:", exc_info=e)
3186
3229
            use_dbus = False
3187
3230
            server_settings["use_dbus"] = False
3188
3231
            tcp_server.use_dbus = False
3247
3290
                             if isinstance(s, bytes)
3248
3291
                             else s) for s in
3249
3292
                            value["client_structure"]]
3250
 
                        # .name & .host
3251
 
                        for k in ("name", "host"):
 
3293
                        # .name, .host, and .checker_command
 
3294
                        for k in ("name", "host", "checker_command"):
3252
3295
                            if isinstance(value[k], bytes):
3253
3296
                                value[k] = value[k].decode("utf-8")
3254
 
                        if not value.has_key("key_id"):
 
3297
                        if "key_id" not in value:
3255
3298
                            value["key_id"] = ""
3256
 
                        elif not value.has_key("fingerprint"):
 
3299
                        elif "fingerprint" not in value:
3257
3300
                            value["fingerprint"] = ""
3258
3301
                    #  old_client_settings
3259
3302
                    # .keys()
3264
3307
                        for key, value in
3265
3308
                        bytes_old_client_settings.items()}
3266
3309
                    del bytes_old_client_settings
3267
 
                    # .host
 
3310
                    # .host and .checker_command
3268
3311
                    for value in old_client_settings.values():
3269
 
                        if isinstance(value["host"], bytes):
3270
 
                            value["host"] = (value["host"]
3271
 
                                             .decode("utf-8"))
 
3312
                        for attribute in ("host", "checker_command"):
 
3313
                            if isinstance(value[attribute], bytes):
 
3314
                                value[attribute] = (value[attribute]
 
3315
                                                    .decode("utf-8"))
3272
3316
            os.remove(stored_state_path)
3273
3317
        except IOError as e:
3274
3318
            if e.errno == errno.ENOENT:
3275
 
                logger.warning("Could not load persistent state:"
3276
 
                               " {}".format(os.strerror(e.errno)))
 
3319
                log.warning("Could not load persistent state:"
 
3320
                            " %s", os.strerror(e.errno))
3277
3321
            else:
3278
 
                logger.critical("Could not load persistent state:",
3279
 
                                exc_info=e)
 
3322
                log.critical("Could not load persistent state:",
 
3323
                             exc_info=e)
3280
3324
                raise
3281
3325
        except EOFError as e:
3282
 
            logger.warning("Could not load persistent state: "
3283
 
                           "EOFError:",
3284
 
                           exc_info=e)
 
3326
            log.warning("Could not load persistent state: EOFError:",
 
3327
                        exc_info=e)
3285
3328
 
3286
3329
    with PGPEngine() as pgp:
3287
3330
        for client_name, client in clients_data.items():
3314
3357
            if client["enabled"]:
3315
3358
                if datetime.datetime.utcnow() >= client["expires"]:
3316
3359
                    if not client["last_checked_ok"]:
3317
 
                        logger.warning(
3318
 
                            "disabling client {} - Client never "
3319
 
                            "performed a successful checker".format(
3320
 
                                client_name))
 
3360
                        log.warning("disabling client %s - Client"
 
3361
                                    " never performed a successful"
 
3362
                                    " checker", client_name)
3321
3363
                        client["enabled"] = False
3322
3364
                    elif client["last_checker_status"] != 0:
3323
 
                        logger.warning(
3324
 
                            "disabling client {} - Client last"
3325
 
                            " checker failed with error code"
3326
 
                            " {}".format(
3327
 
                                client_name,
3328
 
                                client["last_checker_status"]))
 
3365
                        log.warning("disabling client %s - Client"
 
3366
                                    " last checker failed with error"
 
3367
                                    " code %s", client_name,
 
3368
                                    client["last_checker_status"])
3329
3369
                        client["enabled"] = False
3330
3370
                    else:
3331
3371
                        client["expires"] = (
3332
3372
                            datetime.datetime.utcnow()
3333
3373
                            + client["timeout"])
3334
 
                        logger.debug("Last checker succeeded,"
3335
 
                                     " keeping {} enabled".format(
3336
 
                                         client_name))
 
3374
                        log.debug("Last checker succeeded, keeping %s"
 
3375
                                  " enabled", client_name)
3337
3376
            try:
3338
3377
                client["secret"] = pgp.decrypt(
3339
3378
                    client["encrypted_secret"],
3340
3379
                    client_settings[client_name]["secret"])
3341
3380
            except PGPError:
3342
3381
                # If decryption fails, we use secret from new settings
3343
 
                logger.debug("Failed to decrypt {} old secret".format(
3344
 
                    client_name))
 
3382
                log.debug("Failed to decrypt %s old secret",
 
3383
                          client_name)
3345
3384
                client["secret"] = (client_settings[client_name]
3346
3385
                                    ["secret"])
3347
3386
 
3361
3400
            server_settings=server_settings)
3362
3401
 
3363
3402
    if not tcp_server.clients:
3364
 
        logger.warning("No clients defined")
 
3403
        log.warning("No clients defined")
3365
3404
 
3366
3405
    if not foreground:
3367
3406
        if pidfile is not None:
3370
3409
                with pidfile:
3371
3410
                    print(pid, file=pidfile)
3372
3411
            except IOError:
3373
 
                logger.error("Could not write to file %r with PID %d",
3374
 
                             pidfilename, pid)
 
3412
                log.error("Could not write to file %r with PID %d",
 
3413
                          pidfilename, pid)
3375
3414
        del pidfile
3376
3415
        del pidfilename
3377
3416
 
3527
3566
 
3528
3567
        try:
3529
3568
            with tempfile.NamedTemporaryFile(
3530
 
                    mode='wb',
 
3569
                    mode="wb",
3531
3570
                    suffix=".pickle",
3532
 
                    prefix='clients-',
 
3571
                    prefix="clients-",
3533
3572
                    dir=os.path.dirname(stored_state_path),
3534
3573
                    delete=False) as stored_state:
3535
3574
                pickle.dump((clients, client_settings), stored_state,
3543
3582
                except NameError:
3544
3583
                    pass
3545
3584
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3546
 
                logger.warning("Could not save persistent state: {}"
3547
 
                               .format(os.strerror(e.errno)))
 
3585
                log.warning("Could not save persistent state: %s",
 
3586
                            os.strerror(e.errno))
3548
3587
            else:
3549
 
                logger.warning("Could not save persistent state:",
3550
 
                               exc_info=e)
 
3588
                log.warning("Could not save persistent state:",
 
3589
                            exc_info=e)
3551
3590
                raise
3552
3591
 
3553
3592
        # Delete all clients, and settings from config
3579
3618
    if zeroconf:
3580
3619
        service.port = tcp_server.socket.getsockname()[1]
3581
3620
    if use_ipv6:
3582
 
        logger.info("Now listening on address %r, port %d,"
3583
 
                    " flowinfo %d, scope_id %d",
3584
 
                    *tcp_server.socket.getsockname())
 
3621
        log.info("Now listening on address %r, port %d, flowinfo %d,"
 
3622
                 " scope_id %d", *tcp_server.socket.getsockname())
3585
3623
    else:                       # IPv4
3586
 
        logger.info("Now listening on address %r, port %d",
3587
 
                    *tcp_server.socket.getsockname())
 
3624
        log.info("Now listening on address %r, port %d",
 
3625
                 *tcp_server.socket.getsockname())
3588
3626
 
3589
3627
    # service.interface = tcp_server.socket.getsockname()[3]
3590
3628
 
3594
3632
            try:
3595
3633
                service.activate()
3596
3634
            except dbus.exceptions.DBusException as error:
3597
 
                logger.critical("D-Bus Exception", exc_info=error)
 
3635
                log.critical("D-Bus Exception", exc_info=error)
3598
3636
                cleanup()
3599
3637
                sys.exit(1)
3600
3638
            # End of Avahi example code
3601
3639
 
3602
 
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3603
 
                          lambda *args, **kwargs:
3604
 
                          (tcp_server.handle_request
3605
 
                           (*args[2:], **kwargs) or True))
 
3640
        GLib.io_add_watch(
 
3641
            GLib.IOChannel.unix_new(tcp_server.fileno()),
 
3642
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
3643
            lambda *args, **kwargs: (tcp_server.handle_request
 
3644
                                     (*args[2:], **kwargs) or True))
3606
3645
 
3607
 
        logger.debug("Starting main loop")
 
3646
        log.debug("Starting main loop")
3608
3647
        main_loop.run()
3609
3648
    except AvahiError as error:
3610
 
        logger.critical("Avahi Error", exc_info=error)
 
3649
        log.critical("Avahi Error", exc_info=error)
3611
3650
        cleanup()
3612
3651
        sys.exit(1)
3613
3652
    except KeyboardInterrupt:
3614
3653
        if debug:
3615
3654
            print("", file=sys.stderr)
3616
 
        logger.debug("Server received KeyboardInterrupt")
3617
 
    logger.debug("Server exiting")
 
3655
        log.debug("Server received KeyboardInterrupt")
 
3656
    log.debug("Server exiting")
3618
3657
    # Must run before the D-Bus bus name gets deregistered
3619
3658
    cleanup()
3620
3659
 
3621
 
 
3622
 
if __name__ == '__main__':
3623
 
    main()
 
3660
 
 
3661
def parse_test_args():
 
3662
    # type: () -> argparse.Namespace
 
3663
    parser = argparse.ArgumentParser(add_help=False)
 
3664
    parser.add_argument("--check", action="store_true")
 
3665
    parser.add_argument("--prefix", )
 
3666
    args, unknown_args = parser.parse_known_args()
 
3667
    if args.check:
 
3668
        # Remove test options from sys.argv
 
3669
        sys.argv[1:] = unknown_args
 
3670
    return args
 
3671
 
 
3672
# Add all tests from doctest strings
 
3673
def load_tests(loader, tests, none):
 
3674
    import doctest
 
3675
    tests.addTests(doctest.DocTestSuite())
 
3676
    return tests
 
3677
 
 
3678
if __name__ == "__main__":
 
3679
    options = parse_test_args()
 
3680
    try:
 
3681
        if options.check:
 
3682
            extra_test_prefix = options.prefix
 
3683
            if extra_test_prefix is not None:
 
3684
                if not (unittest.main(argv=[""], exit=False)
 
3685
                        .result.wasSuccessful()):
 
3686
                    sys.exit(1)
 
3687
                class ExtraTestLoader(unittest.TestLoader):
 
3688
                    testMethodPrefix = extra_test_prefix
 
3689
                # Call using ./scriptname --test [--verbose]
 
3690
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
 
3691
            else:
 
3692
                unittest.main(argv=[""])
 
3693
        else:
 
3694
            main()
 
3695
    finally:
 
3696
        logging.shutdown()
 
3697
 
 
3698
# Local Variables:
 
3699
# run-tests:
 
3700
# (lambda (&optional extra)
 
3701
#   (if (not (funcall run-tests-in-test-buffer default-directory
 
3702
#             extra))
 
3703
#       (funcall show-test-buffer-in-test-window)
 
3704
#     (funcall remove-test-window)
 
3705
#     (if extra (message "Extra tests run successfully!"))))
 
3706
# run-tests-in-test-buffer:
 
3707
# (lambda (dir &optional extra)
 
3708
#   (with-current-buffer (get-buffer-create "*Test*")
 
3709
#     (setq buffer-read-only nil
 
3710
#           default-directory dir)
 
3711
#     (erase-buffer)
 
3712
#     (compilation-mode))
 
3713
#   (let ((process-result
 
3714
#          (let ((inhibit-read-only t))
 
3715
#            (process-file-shell-command
 
3716
#             (funcall get-command-line extra) nil "*Test*"))))
 
3717
#     (and (numberp process-result)
 
3718
#          (= process-result 0))))
 
3719
# get-command-line:
 
3720
# (lambda (&optional extra)
 
3721
#   (let ((quoted-script
 
3722
#          (shell-quote-argument (funcall get-script-name))))
 
3723
#     (format
 
3724
#      (concat "%s --check" (if extra " --prefix=atest" ""))
 
3725
#      quoted-script)))
 
3726
# get-script-name:
 
3727
# (lambda ()
 
3728
#   (if (fboundp 'file-local-name)
 
3729
#       (file-local-name (buffer-file-name))
 
3730
#     (or (file-remote-p (buffer-file-name) 'localname)
 
3731
#         (buffer-file-name))))
 
3732
# remove-test-window:
 
3733
# (lambda ()
 
3734
#   (let ((test-window (get-buffer-window "*Test*")))
 
3735
#     (if test-window (delete-window test-window))))
 
3736
# show-test-buffer-in-test-window:
 
3737
# (lambda ()
 
3738
#   (when (not (get-buffer-window-list "*Test*"))
 
3739
#     (setq next-error-last-buffer (get-buffer "*Test*"))
 
3740
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
 
3741
#            (display-buffer-overriding-action
 
3742
#             `((display-buffer-in-side-window) (side . ,side)
 
3743
#               (window-height . fit-window-to-buffer)
 
3744
#               (window-width . fit-window-to-buffer))))
 
3745
#       (display-buffer "*Test*"))))
 
3746
# eval:
 
3747
# (progn
 
3748
#   (let* ((run-extra-tests (lambda () (interactive)
 
3749
#                             (funcall run-tests t)))
 
3750
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
 
3751
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
 
3752
#     (setq minor-mode-overriding-map-alist
 
3753
#           (cons `(run-tests . ,outer-keymap)
 
3754
#                 minor-mode-overriding-map-alist)))
 
3755
#   (add-hook 'after-save-hook run-tests 90 t))
 
3756
# End: