/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: 2016-08-25 17:37:05 UTC
  • Revision ID: teddy@recompile.se-20160825173705-q2v6lban8ph9uw75
PEP8 compliance: mandos

* mandos: Add PEP8 compliance (as per the "pycodestyle" tool).

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
16
 
#
17
 
# This file is part of Mandos.
18
 
#
19
 
# Mandos is free software: you can redistribute it and/or modify it
20
 
# under the terms of the GNU General Public License as published by
 
14
# Copyright © 2008-2016 Teddy Hogeborn
 
15
# Copyright © 2008-2016 Björn Påhlsson
 
16
#
 
17
# This program is free software: you can redistribute it and/or modify
 
18
# it under the terms of the GNU General Public License as published by
21
19
# the Free Software Foundation, either version 3 of the License, or
22
20
# (at your option) any later version.
23
21
#
24
 
#     Mandos is distributed in the hope that it will be useful, but
25
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
22
#     This program is distributed in the hope that it will be useful,
 
23
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
26
24
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27
25
#     GNU General Public License for more details.
28
26
#
29
27
# You should have received a copy of the GNU General Public License
30
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
28
# along with this program.  If not, see
 
29
# <http://www.gnu.org/licenses/>.
31
30
#
32
31
# Contact the authors at <mandos@recompile.se>.
33
32
#
 
33
 
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
39
39
except ImportError:
40
40
    pass
41
41
 
42
 
import sys
43
 
import unittest
44
 
import argparse
45
 
import logging
46
 
import os
47
42
try:
48
43
    import SocketServer as socketserver
49
44
except ImportError:
50
45
    import socketserver
51
46
import socket
 
47
import argparse
52
48
import datetime
53
49
import errno
54
50
try:
55
51
    import ConfigParser as configparser
56
52
except ImportError:
57
53
    import configparser
 
54
import sys
58
55
import re
 
56
import os
59
57
import signal
60
58
import subprocess
61
59
import atexit
62
60
import stat
 
61
import logging
63
62
import logging.handlers
64
63
import pwd
65
64
import contextlib
77
76
import itertools
78
77
import collections
79
78
import codecs
80
 
import random
81
 
import shlex
82
79
 
83
80
import dbus
84
81
import dbus.service
85
 
import gi
86
82
from gi.repository import GLib
87
83
from dbus.mainloop.glib import DBusGMainLoop
88
84
import ctypes
90
86
import xml.dom.minidom
91
87
import inspect
92
88
 
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
 
 
118
89
# Try to find the value of SO_BINDTODEVICE:
119
90
try:
120
91
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
140
111
            # No value found
141
112
            SO_BINDTODEVICE = None
142
113
 
143
 
if sys.version_info < (3, 2):
144
 
    configparser.Configparser = configparser.SafeConfigParser
 
114
if sys.version_info.major == 2:
 
115
    str = unicode
145
116
 
146
 
version = "1.8.17"
 
117
version = "1.7.10"
147
118
stored_state_file = "clients.pickle"
148
119
 
149
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
150
 
logging.captureWarnings(True)   # Show warnings via the logging system
 
120
logger = logging.getLogger()
151
121
syslogger = None
152
122
 
153
123
try:
189
159
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
190
160
        address="/dev/log"))
191
161
    syslogger.setFormatter(logging.Formatter
192
 
                           ("Mandos [%(process)d]: %(levelname)s:"
193
 
                            " %(message)s"))
194
 
    log.addHandler(syslogger)
 
162
                           ('Mandos [%(process)d]: %(levelname)s:'
 
163
                            ' %(message)s'))
 
164
    logger.addHandler(syslogger)
195
165
 
196
166
    if debug:
197
167
        console = logging.StreamHandler()
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)
 
168
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
169
                                               ' [%(process)d]:'
 
170
                                               ' %(levelname)s:'
 
171
                                               ' %(message)s'))
 
172
        logger.addHandler(console)
 
173
    logger.setLevel(level)
204
174
 
205
175
 
206
176
class PGPError(Exception):
208
178
    pass
209
179
 
210
180
 
211
 
class PGPEngine:
 
181
class PGPEngine(object):
212
182
    """A simple class for OpenPGP symmetric encryption & decryption"""
213
183
 
214
184
    def __init__(self):
218
188
            output = subprocess.check_output(["gpgconf"])
219
189
            for line in output.splitlines():
220
190
                name, text, path = line.split(b":")
221
 
                if name == b"gpg":
 
191
                if name == "gpg":
222
192
                    self.gpg = path
223
193
                    break
224
194
        except OSError as e:
225
195
            if e.errno != errno.ENOENT:
226
196
                raise
227
 
        self.gnupgargs = ["--batch",
228
 
                          "--homedir", self.tempdir,
229
 
                          "--force-mdc",
230
 
                          "--quiet"]
 
197
        self.gnupgargs = ['--batch',
 
198
                          '--homedir', self.tempdir,
 
199
                          '--force-mdc',
 
200
                          '--quiet']
231
201
        # Only GPG version 1 has the --no-use-agent option.
232
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
202
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
233
203
            self.gnupgargs.append("--no-use-agent")
234
204
 
235
205
    def __enter__(self):
272
242
                dir=self.tempdir) as passfile:
273
243
            passfile.write(passphrase)
274
244
            passfile.flush()
275
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
276
 
                                     "--passphrase-file",
 
245
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
246
                                     '--passphrase-file',
277
247
                                     passfile.name]
278
248
                                    + self.gnupgargs,
279
249
                                    stdin=subprocess.PIPE,
290
260
                dir=self.tempdir) as passfile:
291
261
            passfile.write(passphrase)
292
262
            passfile.flush()
293
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
294
 
                                     "--passphrase-file",
 
263
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
264
                                     '--passphrase-file',
295
265
                                     passfile.name]
296
266
                                    + self.gnupgargs,
297
267
                                    stdin=subprocess.PIPE,
304
274
 
305
275
 
306
276
# Pretend that we have an Avahi module
307
 
class avahi:
308
 
    """This isn't so much a class as it is a module-like namespace."""
 
277
class Avahi(object):
 
278
    """This isn't so much a class as it is a module-like namespace.
 
279
    It is instantiated once, and simulates having an Avahi module."""
309
280
    IF_UNSPEC = -1               # avahi-common/address.h
310
281
    PROTO_UNSPEC = -1            # avahi-common/address.h
311
282
    PROTO_INET = 0               # avahi-common/address.h
315
286
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
316
287
    DBUS_PATH_SERVER = "/"
317
288
 
318
 
    @staticmethod
319
 
    def string_array_to_txt_array(t):
 
289
    def string_array_to_txt_array(self, t):
320
290
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
321
291
                           for s in t), signature="ay")
322
292
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
327
297
    SERVER_RUNNING = 2           # avahi-common/defs.h
328
298
    SERVER_COLLISION = 3         # avahi-common/defs.h
329
299
    SERVER_FAILURE = 4           # avahi-common/defs.h
 
300
avahi = Avahi()
330
301
 
331
302
 
332
303
class AvahiError(Exception):
344
315
    pass
345
316
 
346
317
 
347
 
class AvahiService:
 
318
class AvahiService(object):
348
319
    """An Avahi (Zeroconf) service.
349
320
 
350
321
    Attributes:
351
322
    interface: integer; avahi.IF_UNSPEC or an interface index.
352
323
               Used to optionally bind to the specified interface.
353
 
    name: string; Example: "Mandos"
354
 
    type: string; Example: "_mandos._tcp".
 
324
    name: string; Example: 'Mandos'
 
325
    type: string; Example: '_mandos._tcp'.
355
326
     See <https://www.iana.org/assignments/service-names-port-numbers>
356
327
    port: integer; what port to announce
357
328
    TXT: list of strings; TXT record for the service
394
365
    def rename(self, remove=True):
395
366
        """Derived from the Avahi example code"""
396
367
        if self.rename_count >= self.max_renames:
397
 
            log.critical("No suitable Zeroconf service name found"
398
 
                         " after %i retries, exiting.",
399
 
                         self.rename_count)
 
368
            logger.critical("No suitable Zeroconf service name found"
 
369
                            " after %i retries, exiting.",
 
370
                            self.rename_count)
400
371
            raise AvahiServiceError("Too many renames")
401
372
        self.name = str(
402
373
            self.server.GetAlternativeServiceName(self.name))
403
374
        self.rename_count += 1
404
 
        log.info("Changing Zeroconf service name to %r ...",
405
 
                 self.name)
 
375
        logger.info("Changing Zeroconf service name to %r ...",
 
376
                    self.name)
406
377
        if remove:
407
378
            self.remove()
408
379
        try:
410
381
        except dbus.exceptions.DBusException as error:
411
382
            if (error.get_dbus_name()
412
383
                == "org.freedesktop.Avahi.CollisionError"):
413
 
                log.info("Local Zeroconf service name collision.")
 
384
                logger.info("Local Zeroconf service name collision.")
414
385
                return self.rename(remove=False)
415
386
            else:
416
 
                log.critical("D-Bus Exception", exc_info=error)
 
387
                logger.critical("D-Bus Exception", exc_info=error)
417
388
                self.cleanup()
418
389
                os._exit(1)
419
390
 
435
406
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
407
        self.entry_group_state_changed_match = (
437
408
            self.group.connect_to_signal(
438
 
                "StateChanged", self.entry_group_state_changed))
439
 
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
440
 
                  self.name, self.type)
 
409
                'StateChanged', self.entry_group_state_changed))
 
410
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
411
                     self.name, self.type)
441
412
        self.group.AddService(
442
413
            self.interface,
443
414
            self.protocol,
450
421
 
451
422
    def entry_group_state_changed(self, state, error):
452
423
        """Derived from the Avahi example code"""
453
 
        log.debug("Avahi entry group state change: %i", state)
 
424
        logger.debug("Avahi entry group state change: %i", state)
454
425
 
455
426
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
 
            log.debug("Zeroconf service established.")
 
427
            logger.debug("Zeroconf service established.")
457
428
        elif state == avahi.ENTRY_GROUP_COLLISION:
458
 
            log.info("Zeroconf service name collision.")
 
429
            logger.info("Zeroconf service name collision.")
459
430
            self.rename()
460
431
        elif state == avahi.ENTRY_GROUP_FAILURE:
461
 
            log.critical("Avahi: Error in group state changed %s",
462
 
                         str(error))
 
432
            logger.critical("Avahi: Error in group state changed %s",
 
433
                            str(error))
463
434
            raise AvahiGroupError("State changed: {!s}".format(error))
464
435
 
465
436
    def cleanup(self):
475
446
 
476
447
    def server_state_changed(self, state, error=None):
477
448
        """Derived from the Avahi example code"""
478
 
        log.debug("Avahi server state change: %i", state)
 
449
        logger.debug("Avahi server state change: %i", state)
479
450
        bad_states = {
480
451
            avahi.SERVER_INVALID: "Zeroconf server invalid",
481
452
            avahi.SERVER_REGISTERING: None,
485
456
        if state in bad_states:
486
457
            if bad_states[state] is not None:
487
458
                if error is None:
488
 
                    log.error(bad_states[state])
 
459
                    logger.error(bad_states[state])
489
460
                else:
490
 
                    log.error(bad_states[state] + ": %r", error)
 
461
                    logger.error(bad_states[state] + ": %r", error)
491
462
            self.cleanup()
492
463
        elif state == avahi.SERVER_RUNNING:
493
464
            try:
495
466
            except dbus.exceptions.DBusException as error:
496
467
                if (error.get_dbus_name()
497
468
                    == "org.freedesktop.Avahi.CollisionError"):
498
 
                    log.info("Local Zeroconf service name collision.")
 
469
                    logger.info("Local Zeroconf service name"
 
470
                                " collision.")
499
471
                    return self.rename(remove=False)
500
472
                else:
501
 
                    log.critical("D-Bus Exception", exc_info=error)
 
473
                    logger.critical("D-Bus Exception", exc_info=error)
502
474
                    self.cleanup()
503
475
                    os._exit(1)
504
476
        else:
505
477
            if error is None:
506
 
                log.debug("Unknown state: %r", state)
 
478
                logger.debug("Unknown state: %r", state)
507
479
            else:
508
 
                log.debug("Unknown state: %r: %r", state, error)
 
480
                logger.debug("Unknown state: %r: %r", state, error)
509
481
 
510
482
    def activate(self):
511
483
        """Derived from the Avahi example code"""
523
495
class AvahiServiceToSyslog(AvahiService):
524
496
    def rename(self, *args, **kwargs):
525
497
        """Add the new name to the syslog messages"""
526
 
        ret = super(AvahiServiceToSyslog, self).rename(*args,
527
 
                                                       **kwargs)
 
498
        ret = AvahiService.rename(self, *args, **kwargs)
528
499
        syslogger.setFormatter(logging.Formatter(
529
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
500
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
530
501
            .format(self.name)))
531
502
        return ret
532
503
 
533
504
 
534
505
# Pretend that we have a GnuTLS module
535
 
class gnutls:
536
 
    """This isn't so much a class as it is a module-like namespace."""
537
 
 
538
 
    library = ctypes.util.find_library("gnutls")
539
 
    if library is None:
540
 
        library = ctypes.util.find_library("gnutls-deb0")
541
 
    _library = ctypes.cdll.LoadLibrary(library)
542
 
    del library
 
506
class GnuTLS(object):
 
507
    """This isn't so much a class as it is a module-like namespace.
 
508
    It is instantiated once, and simulates having a GnuTLS module."""
 
509
 
 
510
    _library = ctypes.cdll.LoadLibrary(
 
511
        ctypes.util.find_library("gnutls"))
 
512
    _need_version = b"3.3.0"
 
513
 
 
514
    def __init__(self):
 
515
        # Need to use class name "GnuTLS" here, since this method is
 
516
        # called before the assignment to the "gnutls" global variable
 
517
        # happens.
 
518
        if GnuTLS.check_version(self._need_version) is None:
 
519
            raise GnuTLS.Error("Needs GnuTLS {} or later"
 
520
                               .format(self._need_version))
543
521
 
544
522
    # Unless otherwise indicated, the constants and types below are
545
523
    # all from the gnutls/gnutls.h C header file.
549
527
    E_INTERRUPTED = -52
550
528
    E_AGAIN = -28
551
529
    CRT_OPENPGP = 2
552
 
    CRT_RAWPK = 3
553
530
    CLIENT = 2
554
531
    SHUT_RDWR = 0
555
532
    CRD_CERTIFICATE = 1
556
533
    E_NO_CERTIFICATE_FOUND = -49
557
 
    X509_FMT_DER = 0
558
 
    NO_TICKETS = 1<<10
559
 
    ENABLE_RAWPK = 1<<18
560
 
    CTYPE_PEERS = 3
561
 
    KEYID_USE_SHA256 = 1        # gnutls/x509.h
562
534
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
563
535
 
564
536
    # Types
565
 
    class _session_int(ctypes.Structure):
 
537
    class session_int(ctypes.Structure):
566
538
        _fields_ = []
567
 
    session_t = ctypes.POINTER(_session_int)
 
539
    session_t = ctypes.POINTER(session_int)
568
540
 
569
541
    class certificate_credentials_st(ctypes.Structure):
570
542
        _fields_ = []
573
545
    certificate_type_t = ctypes.c_int
574
546
 
575
547
    class datum_t(ctypes.Structure):
576
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
 
                    ("size", ctypes.c_uint)]
 
548
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
549
                    ('size', ctypes.c_uint)]
578
550
 
579
 
    class _openpgp_crt_int(ctypes.Structure):
 
551
    class openpgp_crt_int(ctypes.Structure):
580
552
        _fields_ = []
581
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
553
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
554
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
583
555
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
556
    credentials_type_t = ctypes.c_int
587
559
 
588
560
    # Exceptions
589
561
    class Error(Exception):
 
562
        # We need to use the class name "GnuTLS" here, since this
 
563
        # exception might be raised from within GnuTLS.__init__,
 
564
        # which is called before the assignment to the "gnutls"
 
565
        # global variable has happened.
590
566
        def __init__(self, message=None, code=None, args=()):
591
567
            # Default usage is by a message string, but if a return
592
568
            # code is passed, convert it to a string with
593
569
            # gnutls.strerror()
594
570
            self.code = code
595
571
            if message is None and code is not None:
596
 
                message = gnutls.strerror(code).decode(
597
 
                    "utf-8", errors="replace")
598
 
            return super(gnutls.Error, self).__init__(
 
572
                message = GnuTLS.strerror(code)
 
573
            return super(GnuTLS.Error, self).__init__(
599
574
                message, *args)
600
575
 
601
576
    class CertificateSecurityError(Error):
602
577
        pass
603
578
 
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
 
 
629
579
    # Classes
630
 
    class Credentials(With_from_param):
 
580
    class Credentials(object):
631
581
        def __init__(self):
632
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
633
 
            gnutls.certificate_allocate_credentials(self)
 
582
            self._c_object = gnutls.certificate_credentials_t()
 
583
            gnutls.certificate_allocate_credentials(
 
584
                ctypes.byref(self._c_object))
634
585
            self.type = gnutls.CRD_CERTIFICATE
635
586
 
636
587
        def __del__(self):
637
 
            gnutls.certificate_free_credentials(self)
 
588
            gnutls.certificate_free_credentials(self._c_object)
638
589
 
639
 
    class ClientSession(With_from_param):
 
590
    class ClientSession(object):
640
591
        def __init__(self, socket, credentials=None):
641
 
            self._as_parameter_ = gnutls.session_t()
642
 
            gnutls_flags = gnutls.CLIENT
643
 
            if gnutls.check_version(b"3.5.6"):
644
 
                gnutls_flags |= gnutls.NO_TICKETS
645
 
            if gnutls.has_rawpk:
646
 
                gnutls_flags |= gnutls.ENABLE_RAWPK
647
 
            gnutls.init(self, gnutls_flags)
648
 
            del gnutls_flags
649
 
            gnutls.set_default_priority(self)
650
 
            gnutls.transport_set_ptr(self, socket.fileno())
651
 
            gnutls.handshake_set_private_extensions(self, True)
 
592
            self._c_object = gnutls.session_t()
 
593
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
594
            gnutls.set_default_priority(self._c_object)
 
595
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
596
            gnutls.handshake_set_private_extensions(self._c_object,
 
597
                                                    True)
652
598
            self.socket = socket
653
599
            if credentials is None:
654
600
                credentials = gnutls.Credentials()
655
 
            gnutls.credentials_set(self, credentials.type,
656
 
                                   credentials)
 
601
            gnutls.credentials_set(self._c_object, credentials.type,
 
602
                                   ctypes.cast(credentials._c_object,
 
603
                                               ctypes.c_void_p))
657
604
            self.credentials = credentials
658
605
 
659
606
        def __del__(self):
660
 
            gnutls.deinit(self)
 
607
            gnutls.deinit(self._c_object)
661
608
 
662
609
        def handshake(self):
663
 
            return gnutls.handshake(self)
 
610
            return gnutls.handshake(self._c_object)
664
611
 
665
612
        def send(self, data):
666
613
            data = bytes(data)
667
614
            data_len = len(data)
668
615
            while data_len > 0:
669
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
616
                data_len -= gnutls.record_send(self._c_object,
 
617
                                               data[-data_len:],
670
618
                                               data_len)
671
619
 
672
620
        def bye(self):
673
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
621
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
674
622
 
675
623
    # Error handling functions
676
624
    def _error_code(result):
677
625
        """A function to raise exceptions on errors, suitable
678
 
        for the "restype" attribute on ctypes functions"""
679
 
        if result >= gnutls.E_SUCCESS:
 
626
        for the 'restype' attribute on ctypes functions"""
 
627
        if result >= 0:
680
628
            return result
681
629
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
630
            raise gnutls.CertificateSecurityError(code=result)
683
631
        raise gnutls.Error(code=result)
684
632
 
685
 
    def _retry_on_error(result, func, arguments,
686
 
                        _error_code=_error_code):
 
633
    def _retry_on_error(result, func, arguments):
687
634
        """A function to retry on some errors, suitable
688
 
        for the "errcheck" attribute on ctypes functions"""
689
 
        while result < gnutls.E_SUCCESS:
 
635
        for the 'errcheck' attribute on ctypes functions"""
 
636
        while result < 0:
690
637
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
638
                return _error_code(result)
692
639
            result = func(*arguments)
697
644
 
698
645
    # Functions
699
646
    priority_set_direct = _library.gnutls_priority_set_direct
700
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
647
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
701
648
                                    ctypes.POINTER(ctypes.c_char_p)]
702
649
    priority_set_direct.restype = _error_code
703
650
 
704
651
    init = _library.gnutls_init
705
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
652
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
706
653
    init.restype = _error_code
707
654
 
708
655
    set_default_priority = _library.gnutls_set_default_priority
709
 
    set_default_priority.argtypes = [ClientSession]
 
656
    set_default_priority.argtypes = [session_t]
710
657
    set_default_priority.restype = _error_code
711
658
 
712
659
    record_send = _library.gnutls_record_send
713
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
660
    record_send.argtypes = [session_t, ctypes.c_void_p,
714
661
                            ctypes.c_size_t]
715
662
    record_send.restype = ctypes.c_ssize_t
716
663
    record_send.errcheck = _retry_on_error
718
665
    certificate_allocate_credentials = (
719
666
        _library.gnutls_certificate_allocate_credentials)
720
667
    certificate_allocate_credentials.argtypes = [
721
 
        PointerTo(Credentials)]
 
668
        ctypes.POINTER(certificate_credentials_t)]
722
669
    certificate_allocate_credentials.restype = _error_code
723
670
 
724
671
    certificate_free_credentials = (
725
672
        _library.gnutls_certificate_free_credentials)
726
 
    certificate_free_credentials.argtypes = [Credentials]
 
673
    certificate_free_credentials.argtypes = [
 
674
        certificate_credentials_t]
727
675
    certificate_free_credentials.restype = None
728
676
 
729
677
    handshake_set_private_extensions = (
730
678
        _library.gnutls_handshake_set_private_extensions)
731
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
679
    handshake_set_private_extensions.argtypes = [session_t,
732
680
                                                 ctypes.c_int]
733
681
    handshake_set_private_extensions.restype = None
734
682
 
735
683
    credentials_set = _library.gnutls_credentials_set
736
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
737
 
                                CastToVoidPointer(Credentials)]
 
684
    credentials_set.argtypes = [session_t, credentials_type_t,
 
685
                                ctypes.c_void_p]
738
686
    credentials_set.restype = _error_code
739
687
 
740
688
    strerror = _library.gnutls_strerror
742
690
    strerror.restype = ctypes.c_char_p
743
691
 
744
692
    certificate_type_get = _library.gnutls_certificate_type_get
745
 
    certificate_type_get.argtypes = [ClientSession]
 
693
    certificate_type_get.argtypes = [session_t]
746
694
    certificate_type_get.restype = _error_code
747
695
 
748
696
    certificate_get_peers = _library.gnutls_certificate_get_peers
749
 
    certificate_get_peers.argtypes = [ClientSession,
 
697
    certificate_get_peers.argtypes = [session_t,
750
698
                                      ctypes.POINTER(ctypes.c_uint)]
751
699
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
752
700
 
759
707
    global_set_log_function.restype = None
760
708
 
761
709
    deinit = _library.gnutls_deinit
762
 
    deinit.argtypes = [ClientSession]
 
710
    deinit.argtypes = [session_t]
763
711
    deinit.restype = None
764
712
 
765
713
    handshake = _library.gnutls_handshake
766
 
    handshake.argtypes = [ClientSession]
767
 
    handshake.restype = ctypes.c_int
 
714
    handshake.argtypes = [session_t]
 
715
    handshake.restype = _error_code
768
716
    handshake.errcheck = _retry_on_error
769
717
 
770
718
    transport_set_ptr = _library.gnutls_transport_set_ptr
771
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
719
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
772
720
    transport_set_ptr.restype = None
773
721
 
774
722
    bye = _library.gnutls_bye
775
 
    bye.argtypes = [ClientSession, close_request_t]
776
 
    bye.restype = ctypes.c_int
 
723
    bye.argtypes = [session_t, close_request_t]
 
724
    bye.restype = _error_code
777
725
    bye.errcheck = _retry_on_error
778
726
 
779
727
    check_version = _library.gnutls_check_version
780
728
    check_version.argtypes = [ctypes.c_char_p]
781
729
    check_version.restype = ctypes.c_char_p
782
730
 
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"
789
 
    has_rawpk = bool(check_version(_tls_rawpk_version))
790
 
 
791
 
    if has_rawpk:
792
 
        # Types
793
 
        class pubkey_st(ctypes.Structure):
794
 
            _fields = []
795
 
        pubkey_t = ctypes.POINTER(pubkey_st)
796
 
 
797
 
        x509_crt_fmt_t = ctypes.c_int
798
 
 
799
 
        # All the function declarations below are from
800
 
        # gnutls/abstract.h
801
 
        pubkey_init = _library.gnutls_pubkey_init
802
 
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
803
 
        pubkey_init.restype = _error_code
804
 
 
805
 
        pubkey_import = _library.gnutls_pubkey_import
806
 
        pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
807
 
                                  x509_crt_fmt_t]
808
 
        pubkey_import.restype = _error_code
809
 
 
810
 
        pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
811
 
        pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
812
 
                                      ctypes.POINTER(ctypes.c_ubyte),
813
 
                                      ctypes.POINTER(ctypes.c_size_t)]
814
 
        pubkey_get_key_id.restype = _error_code
815
 
 
816
 
        pubkey_deinit = _library.gnutls_pubkey_deinit
817
 
        pubkey_deinit.argtypes = [pubkey_t]
818
 
        pubkey_deinit.restype = None
819
 
    else:
820
 
        # All the function declarations below are from
821
 
        # gnutls/openpgp.h
822
 
 
823
 
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
824
 
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
825
 
        openpgp_crt_init.restype = _error_code
826
 
 
827
 
        openpgp_crt_import = _library.gnutls_openpgp_crt_import
828
 
        openpgp_crt_import.argtypes = [openpgp_crt_t,
829
 
                                       ctypes.POINTER(datum_t),
830
 
                                       openpgp_crt_fmt_t]
831
 
        openpgp_crt_import.restype = _error_code
832
 
 
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
 
        ]
840
 
        openpgp_crt_verify_self.restype = _error_code
841
 
 
842
 
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
843
 
        openpgp_crt_deinit.argtypes = [openpgp_crt_t]
844
 
        openpgp_crt_deinit.restype = None
845
 
 
846
 
        openpgp_crt_get_fingerprint = (
847
 
            _library.gnutls_openpgp_crt_get_fingerprint)
848
 
        openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
849
 
                                                ctypes.c_void_p,
850
 
                                                ctypes.POINTER(
851
 
                                                    ctypes.c_size_t)]
852
 
        openpgp_crt_get_fingerprint.restype = _error_code
853
 
 
854
 
    if check_version(b"3.6.4"):
855
 
        certificate_type_get2 = _library.gnutls_certificate_type_get2
856
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
857
 
        certificate_type_get2.restype = _error_code
 
731
    # All the function declarations below are from gnutls/openpgp.h
 
732
 
 
733
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
734
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
735
    openpgp_crt_init.restype = _error_code
 
736
 
 
737
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
738
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
739
                                   ctypes.POINTER(datum_t),
 
740
                                   openpgp_crt_fmt_t]
 
741
    openpgp_crt_import.restype = _error_code
 
742
 
 
743
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
744
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
745
                                        ctypes.POINTER(ctypes.c_uint)]
 
746
    openpgp_crt_verify_self.restype = _error_code
 
747
 
 
748
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
749
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
750
    openpgp_crt_deinit.restype = None
 
751
 
 
752
    openpgp_crt_get_fingerprint = (
 
753
        _library.gnutls_openpgp_crt_get_fingerprint)
 
754
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
755
                                            ctypes.c_void_p,
 
756
                                            ctypes.POINTER(
 
757
                                                ctypes.c_size_t)]
 
758
    openpgp_crt_get_fingerprint.restype = _error_code
858
759
 
859
760
    # Remove non-public functions
860
761
    del _error_code, _retry_on_error
 
762
# Create the global "gnutls" object, simulating a module
 
763
gnutls = GnuTLS()
861
764
 
862
765
 
863
766
def call_pipe(connection,       # : multiprocessing.Connection
871
774
    connection.close()
872
775
 
873
776
 
874
 
class Client:
 
777
class Client(object):
875
778
    """A representation of a client host served by this server.
876
779
 
877
780
    Attributes:
878
 
    approved:   bool(); None if not yet approved/disapproved
 
781
    approved:   bool(); 'None' if not yet approved/disapproved
879
782
    approval_delay: datetime.timedelta(); Time to wait for approval
880
783
    approval_duration: datetime.timedelta(); Duration of one approval
881
 
    checker: multiprocessing.Process(); a running checker process used
882
 
             to see if the client lives. None if no process is
883
 
             running.
 
784
    checker:    subprocess.Popen(); a running checker process used
 
785
                                    to see if the client lives.
 
786
                                    'None' if no process is running.
884
787
    checker_callback_tag: a GLib event source tag, or None
885
788
    checker_command: string; External command which is run to check
886
789
                     if client lives.  %() expansions are done at
894
797
    disable_initiator_tag: a GLib event source tag, or None
895
798
    enabled:    bool()
896
799
    fingerprint: string (40 or 32 hexadecimal digits); used to
897
 
                 uniquely identify an OpenPGP client
898
 
    key_id: string (64 hexadecimal digits); used to uniquely identify
899
 
            a client using raw public keys
 
800
                 uniquely identify the client
900
801
    host:       string; available for use by the checker command
901
802
    interval:   datetime.timedelta(); How often to start a new checker
902
803
    last_approval_request: datetime.datetime(); (UTC) or None
920
821
    """
921
822
 
922
823
    runtime_expansions = ("approval_delay", "approval_duration",
923
 
                          "created", "enabled", "expires", "key_id",
 
824
                          "created", "enabled", "expires",
924
825
                          "fingerprint", "host", "interval",
925
826
                          "last_approval_request", "last_checked_ok",
926
827
                          "last_enabled", "name", "timeout")
956
857
            client["enabled"] = config.getboolean(client_name,
957
858
                                                  "enabled")
958
859
 
959
 
            # Uppercase and remove spaces from key_id and fingerprint
960
 
            # for later comparison purposes with return value from the
961
 
            # key_id() and fingerprint() functions
962
 
            client["key_id"] = (section.get("key_id", "").upper()
963
 
                                .replace(" ", ""))
964
 
            client["fingerprint"] = (section.get("fingerprint",
965
 
                                                 "").upper()
 
860
            # Uppercase and remove spaces from fingerprint for later
 
861
            # comparison purposes with return value from the
 
862
            # fingerprint() function
 
863
            client["fingerprint"] = (section["fingerprint"].upper()
966
864
                                     .replace(" ", ""))
967
 
            if not (client["key_id"] or client["fingerprint"]):
968
 
                log.error("Skipping client %s without key_id or"
969
 
                          " fingerprint", client_name)
970
 
                del settings[client_name]
971
 
                continue
972
865
            if "secret" in section:
973
866
                client["secret"] = codecs.decode(section["secret"]
974
867
                                                 .encode("utf-8"),
1015
908
            self.last_enabled = None
1016
909
            self.expires = None
1017
910
 
1018
 
        log.debug("Creating client %r", self.name)
1019
 
        log.debug("  Key ID: %s", self.key_id)
1020
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
911
        logger.debug("Creating client %r", self.name)
 
912
        logger.debug("  Fingerprint: %s", self.fingerprint)
1021
913
        self.created = settings.get("created",
1022
914
                                    datetime.datetime.utcnow())
1023
915
 
1051
943
        if getattr(self, "enabled", False):
1052
944
            # Already enabled
1053
945
            return
 
946
        self.expires = datetime.datetime.utcnow() + self.timeout
1054
947
        self.enabled = True
1055
948
        self.last_enabled = datetime.datetime.utcnow()
1056
949
        self.init_checker()
1061
954
        if not getattr(self, "enabled", False):
1062
955
            return False
1063
956
        if not quiet:
1064
 
            log.info("Disabling client %s", self.name)
 
957
            logger.info("Disabling client %s", self.name)
1065
958
        if getattr(self, "disable_initiator_tag", None) is not None:
1066
959
            GLib.source_remove(self.disable_initiator_tag)
1067
960
            self.disable_initiator_tag = None
1079
972
    def __del__(self):
1080
973
        self.disable()
1081
974
 
1082
 
    def init_checker(self, randomize_start=False):
1083
 
        # Schedule a new checker to be started a randomly selected
1084
 
        # time (a fraction of 'interval') from now.  This spreads out
1085
 
        # the startup of checkers over time when the server is
1086
 
        # started.
 
975
    def init_checker(self):
 
976
        # Schedule a new checker to be started an 'interval' from now,
 
977
        # and every interval from then on.
1087
978
        if self.checker_initiator_tag is not None:
1088
979
            GLib.source_remove(self.checker_initiator_tag)
1089
 
        interval_milliseconds = int(self.interval.total_seconds()
1090
 
                                    * 1000)
1091
 
        if randomize_start:
1092
 
            delay_milliseconds = random.randrange(
1093
 
                interval_milliseconds + 1)
1094
 
        else:
1095
 
            delay_milliseconds = interval_milliseconds
1096
980
        self.checker_initiator_tag = GLib.timeout_add(
1097
 
            delay_milliseconds, self.start_checker, randomize_start)
1098
 
        delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1099
 
        # A checker might take up to an 'interval' of time, so we can
1100
 
        # expire at the soonest one interval after a checker was
1101
 
        # started.  Since the initial checker is delayed, the expire
1102
 
        # time might have to be extended.
1103
 
        now = datetime.datetime.utcnow()
1104
 
        self.expires = now + delay + self.interval
1105
 
        # Schedule a disable() at expire time
 
981
            int(self.interval.total_seconds() * 1000),
 
982
            self.start_checker)
 
983
        # Schedule a disable() when 'timeout' has passed
1106
984
        if self.disable_initiator_tag is not None:
1107
985
            GLib.source_remove(self.disable_initiator_tag)
1108
986
        self.disable_initiator_tag = GLib.timeout_add(
1109
 
            int((self.expires - now).total_seconds() * 1000),
1110
 
            self.disable)
 
987
            int(self.timeout.total_seconds() * 1000), self.disable)
 
988
        # Also start a new checker *right now*.
 
989
        self.start_checker()
1111
990
 
1112
991
    def checker_callback(self, source, condition, connection,
1113
992
                         command):
1114
993
        """The checker has completed, so take appropriate actions."""
 
994
        self.checker_callback_tag = None
 
995
        self.checker = None
1115
996
        # Read return code from connection (see call_pipe)
1116
997
        returncode = connection.recv()
1117
998
        connection.close()
1118
 
        if self.checker is not None:
1119
 
            self.checker.join()
1120
 
        self.checker_callback_tag = None
1121
 
        self.checker = None
1122
999
 
1123
1000
        if returncode >= 0:
1124
1001
            self.last_checker_status = returncode
1125
1002
            self.last_checker_signal = None
1126
1003
            if self.last_checker_status == 0:
1127
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1004
                logger.info("Checker for %(name)s succeeded",
 
1005
                            vars(self))
1128
1006
                self.checked_ok()
1129
1007
            else:
1130
 
                log.info("Checker for %(name)s failed", vars(self))
 
1008
                logger.info("Checker for %(name)s failed", vars(self))
1131
1009
        else:
1132
1010
            self.last_checker_status = -1
1133
1011
            self.last_checker_signal = -returncode
1134
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1012
            logger.warning("Checker for %(name)s crashed?",
 
1013
                           vars(self))
1135
1014
        return False
1136
1015
 
1137
1016
    def checked_ok(self):
1156
1035
    def need_approval(self):
1157
1036
        self.last_approval_request = datetime.datetime.utcnow()
1158
1037
 
1159
 
    def start_checker(self, start_was_randomized=False):
 
1038
    def start_checker(self):
1160
1039
        """Start a new checker subprocess if one is not running.
1161
1040
 
1162
1041
        If a checker already exists, leave it running and do
1171
1050
        # should be.
1172
1051
 
1173
1052
        if self.checker is not None and not self.checker.is_alive():
1174
 
            log.warning("Checker was not alive; joining")
 
1053
            logger.warning("Checker was not alive; joining")
1175
1054
            self.checker.join()
1176
1055
            self.checker = None
1177
1056
        # Start a new checker if needed
1178
1057
        if self.checker is None:
1179
1058
            # Escape attributes for the shell
1180
1059
            escaped_attrs = {
1181
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1060
                attr: re.escape(str(getattr(self, attr)))
1182
1061
                for attr in self.runtime_expansions}
1183
1062
            try:
1184
1063
                command = self.checker_command % escaped_attrs
1185
1064
            except TypeError as error:
1186
 
                log.error('Could not format string "%s"',
1187
 
                          self.checker_command, exc_info=error)
 
1065
                logger.error('Could not format string "%s"',
 
1066
                             self.checker_command,
 
1067
                             exc_info=error)
1188
1068
                return True     # Try again later
1189
1069
            self.current_checker_command = command
1190
 
            log.info("Starting checker %r for %s", command, self.name)
 
1070
            logger.info("Starting checker %r for %s", command,
 
1071
                        self.name)
1191
1072
            # We don't need to redirect stdout and stderr, since
1192
1073
            # in normal mode, that is already done by daemon(),
1193
1074
            # and in debug mode we don't want to.  (Stdin is
1209
1090
                kwargs=popen_args)
1210
1091
            self.checker.start()
1211
1092
            self.checker_callback_tag = GLib.io_add_watch(
1212
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1213
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1093
                pipe[0].fileno(), GLib.IO_IN,
1214
1094
                self.checker_callback, pipe[0], command)
1215
 
        if start_was_randomized:
1216
 
            # We were started after a random delay; Schedule a new
1217
 
            # checker to be started an 'interval' from now, and every
1218
 
            # interval from then on.
1219
 
            now = datetime.datetime.utcnow()
1220
 
            self.checker_initiator_tag = GLib.timeout_add(
1221
 
                int(self.interval.total_seconds() * 1000),
1222
 
                self.start_checker)
1223
 
            self.expires = max(self.expires, now + self.interval)
1224
 
            # Don't start a new checker again after same random delay
1225
 
            return False
1226
1095
        # Re-run this periodically if run by GLib.timeout_add
1227
1096
        return True
1228
1097
 
1233
1102
            self.checker_callback_tag = None
1234
1103
        if getattr(self, "checker", None) is None:
1235
1104
            return
1236
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1105
        logger.debug("Stopping checker for %(name)s", vars(self))
1237
1106
        self.checker.terminate()
1238
1107
        self.checker = None
1239
1108
 
1266
1135
        func._dbus_name = func.__name__
1267
1136
        if func._dbus_name.endswith("_dbus_property"):
1268
1137
            func._dbus_name = func._dbus_name[:-14]
1269
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1138
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1270
1139
        return func
1271
1140
 
1272
1141
    return decorator
1361
1230
 
1362
1231
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1363
1232
                         out_signature="s",
1364
 
                         path_keyword="object_path",
1365
 
                         connection_keyword="connection")
 
1233
                         path_keyword='object_path',
 
1234
                         connection_keyword='connection')
1366
1235
    def Introspect(self, object_path, connection):
1367
1236
        """Overloading of standard D-Bus method.
1368
1237
 
1417
1286
            document.unlink()
1418
1287
        except (AttributeError, xml.dom.DOMException,
1419
1288
                xml.parsers.expat.ExpatError) as error:
1420
 
            log.error("Failed to override Introspection method",
1421
 
                      exc_info=error)
 
1289
            logger.error("Failed to override Introspection method",
 
1290
                         exc_info=error)
1422
1291
        return xmlstring
1423
1292
 
1424
1293
 
1482
1351
                raise ValueError("Byte arrays not supported for non-"
1483
1352
                                 "'ay' signature {!r}"
1484
1353
                                 .format(prop._dbus_signature))
1485
 
            value = dbus.ByteArray(bytes(value))
 
1354
            value = dbus.ByteArray(b''.join(chr(byte)
 
1355
                                            for byte in value))
1486
1356
        prop(value)
1487
1357
 
1488
1358
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1521
1391
 
1522
1392
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1523
1393
                         out_signature="s",
1524
 
                         path_keyword="object_path",
1525
 
                         connection_keyword="connection")
 
1394
                         path_keyword='object_path',
 
1395
                         connection_keyword='connection')
1526
1396
    def Introspect(self, object_path, connection):
1527
1397
        """Overloading of standard D-Bus method.
1528
1398
 
1584
1454
            document.unlink()
1585
1455
        except (AttributeError, xml.dom.DOMException,
1586
1456
                xml.parsers.expat.ExpatError) as error:
1587
 
            log.error("Failed to override Introspection method",
1588
 
                      exc_info=error)
 
1457
            logger.error("Failed to override Introspection method",
 
1458
                         exc_info=error)
1589
1459
        return xmlstring
1590
1460
 
1591
 
 
1592
1461
try:
1593
1462
    dbus.OBJECT_MANAGER_IFACE
1594
1463
except AttributeError:
1623
1492
 
1624
1493
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1625
1494
                         out_signature="s",
1626
 
                         path_keyword="object_path",
1627
 
                         connection_keyword="connection")
 
1495
                         path_keyword='object_path',
 
1496
                         connection_keyword='connection')
1628
1497
    def Introspect(self, object_path, connection):
1629
1498
        """Overloading of standard D-Bus method.
1630
1499
 
1655
1524
            document.unlink()
1656
1525
        except (AttributeError, xml.dom.DOMException,
1657
1526
                xml.parsers.expat.ExpatError) as error:
1658
 
            log.error("Failed to override Introspection method",
1659
 
                      exc_info=error)
 
1527
            logger.error("Failed to override Introspection method",
 
1528
                         exc_info=error)
1660
1529
        return xmlstring
1661
1530
 
1662
1531
 
2126
1995
    def Name_dbus_property(self):
2127
1996
        return dbus.String(self.name)
2128
1997
 
2129
 
    # KeyID - property
2130
 
    @dbus_annotations(
2131
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2132
 
    @dbus_service_property(_interface, signature="s", access="read")
2133
 
    def KeyID_dbus_property(self):
2134
 
        return dbus.String(self.key_id)
2135
 
 
2136
1998
    # Fingerprint - property
2137
1999
    @dbus_annotations(
2138
2000
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2293
2155
    del _interface
2294
2156
 
2295
2157
 
2296
 
class ProxyClient:
2297
 
    def __init__(self, child_pipe, key_id, fpr, address):
 
2158
class ProxyClient(object):
 
2159
    def __init__(self, child_pipe, fpr, address):
2298
2160
        self._pipe = child_pipe
2299
 
        self._pipe.send(("init", key_id, fpr, address))
 
2161
        self._pipe.send(('init', fpr, address))
2300
2162
        if not self._pipe.recv():
2301
 
            raise KeyError(key_id or fpr)
 
2163
            raise KeyError(fpr)
2302
2164
 
2303
2165
    def __getattribute__(self, name):
2304
 
        if name == "_pipe":
 
2166
        if name == '_pipe':
2305
2167
            return super(ProxyClient, self).__getattribute__(name)
2306
 
        self._pipe.send(("getattr", name))
 
2168
        self._pipe.send(('getattr', name))
2307
2169
        data = self._pipe.recv()
2308
 
        if data[0] == "data":
 
2170
        if data[0] == 'data':
2309
2171
            return data[1]
2310
 
        if data[0] == "function":
 
2172
        if data[0] == 'function':
2311
2173
 
2312
2174
            def func(*args, **kwargs):
2313
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2175
                self._pipe.send(('funcall', name, args, kwargs))
2314
2176
                return self._pipe.recv()[1]
2315
2177
 
2316
2178
            return func
2317
2179
 
2318
2180
    def __setattr__(self, name, value):
2319
 
        if name == "_pipe":
 
2181
        if name == '_pipe':
2320
2182
            return super(ProxyClient, self).__setattr__(name, value)
2321
 
        self._pipe.send(("setattr", name, value))
 
2183
        self._pipe.send(('setattr', name, value))
2322
2184
 
2323
2185
 
2324
2186
class ClientHandler(socketserver.BaseRequestHandler, object):
2329
2191
 
2330
2192
    def handle(self):
2331
2193
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2332
 
            log.info("TCP connection from: %s",
2333
 
                     str(self.client_address))
2334
 
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
 
2194
            logger.info("TCP connection from: %s",
 
2195
                        str(self.client_address))
 
2196
            logger.debug("Pipe FD: %d",
 
2197
                         self.server.child_pipe.fileno())
2335
2198
 
2336
2199
            session = gnutls.ClientSession(self.request)
2337
2200
 
2338
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2201
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2339
2202
            #                       "+AES-256-CBC", "+SHA1",
2340
2203
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2341
2204
            #                       "+DHE-DSS"))
2343
2206
            priority = self.server.gnutls_priority
2344
2207
            if priority is None:
2345
2208
                priority = "NORMAL"
2346
 
            gnutls.priority_set_direct(session,
2347
 
                                       priority.encode("utf-8"), None)
 
2209
            gnutls.priority_set_direct(session._c_object,
 
2210
                                       priority.encode("utf-8"),
 
2211
                                       None)
2348
2212
 
2349
2213
            # Start communication using the Mandos protocol
2350
2214
            # Get protocol number
2351
2215
            line = self.request.makefile().readline()
2352
 
            log.debug("Protocol version: %r", line)
 
2216
            logger.debug("Protocol version: %r", line)
2353
2217
            try:
2354
2218
                if int(line.strip().split()[0]) > 1:
2355
2219
                    raise RuntimeError(line)
2356
2220
            except (ValueError, IndexError, RuntimeError) as error:
2357
 
                log.error("Unknown protocol version: %s", error)
 
2221
                logger.error("Unknown protocol version: %s", error)
2358
2222
                return
2359
2223
 
2360
2224
            # Start GnuTLS connection
2361
2225
            try:
2362
2226
                session.handshake()
2363
2227
            except gnutls.Error as error:
2364
 
                log.warning("Handshake failed: %s", error)
 
2228
                logger.warning("Handshake failed: %s", error)
2365
2229
                # Do not run session.bye() here: the session is not
2366
2230
                # established.  Just abandon the request.
2367
2231
                return
2368
 
            log.debug("Handshake succeeded")
 
2232
            logger.debug("Handshake succeeded")
2369
2233
 
2370
2234
            approval_required = False
2371
2235
            try:
2372
 
                if gnutls.has_rawpk:
2373
 
                    fpr = b""
2374
 
                    try:
2375
 
                        key_id = self.key_id(
2376
 
                            self.peer_certificate(session))
2377
 
                    except (TypeError, gnutls.Error) as error:
2378
 
                        log.warning("Bad certificate: %s", error)
2379
 
                        return
2380
 
                    log.debug("Key ID: %s",
2381
 
                              key_id.decode("utf-8",
2382
 
                                            errors="replace"))
2383
 
 
2384
 
                else:
2385
 
                    key_id = b""
2386
 
                    try:
2387
 
                        fpr = self.fingerprint(
2388
 
                            self.peer_certificate(session))
2389
 
                    except (TypeError, gnutls.Error) as error:
2390
 
                        log.warning("Bad certificate: %s", error)
2391
 
                        return
2392
 
                    log.debug("Fingerprint: %s", fpr)
2393
 
 
2394
 
                try:
2395
 
                    client = ProxyClient(child_pipe, key_id, fpr,
 
2236
                try:
 
2237
                    fpr = self.fingerprint(
 
2238
                        self.peer_certificate(session))
 
2239
                except (TypeError, gnutls.Error) as error:
 
2240
                    logger.warning("Bad certificate: %s", error)
 
2241
                    return
 
2242
                logger.debug("Fingerprint: %s", fpr)
 
2243
 
 
2244
                try:
 
2245
                    client = ProxyClient(child_pipe, fpr,
2396
2246
                                         self.client_address)
2397
2247
                except KeyError:
2398
2248
                    return
2404
2254
 
2405
2255
                while True:
2406
2256
                    if not client.enabled:
2407
 
                        log.info("Client %s is disabled", client.name)
 
2257
                        logger.info("Client %s is disabled",
 
2258
                                    client.name)
2408
2259
                        if self.server.use_dbus:
2409
2260
                            # Emit D-Bus signal
2410
2261
                            client.Rejected("Disabled")
2414
2265
                        # We are approved or approval is disabled
2415
2266
                        break
2416
2267
                    elif client.approved is None:
2417
 
                        log.info("Client %s needs approval",
2418
 
                                 client.name)
 
2268
                        logger.info("Client %s needs approval",
 
2269
                                    client.name)
2419
2270
                        if self.server.use_dbus:
2420
2271
                            # Emit D-Bus signal
2421
2272
                            client.NeedApproval(
2422
2273
                                client.approval_delay.total_seconds()
2423
2274
                                * 1000, client.approved_by_default)
2424
2275
                    else:
2425
 
                        log.warning("Client %s was not approved",
2426
 
                                    client.name)
 
2276
                        logger.warning("Client %s was not approved",
 
2277
                                       client.name)
2427
2278
                        if self.server.use_dbus:
2428
2279
                            # Emit D-Bus signal
2429
2280
                            client.Rejected("Denied")
2437
2288
                    time2 = datetime.datetime.now()
2438
2289
                    if (time2 - time) >= delay:
2439
2290
                        if not client.approved_by_default:
2440
 
                            log.warning("Client %s timed out while"
2441
 
                                        " waiting for approval",
2442
 
                                        client.name)
 
2291
                            logger.warning("Client %s timed out while"
 
2292
                                           " waiting for approval",
 
2293
                                           client.name)
2443
2294
                            if self.server.use_dbus:
2444
2295
                                # Emit D-Bus signal
2445
2296
                                client.Rejected("Approval timed out")
2452
2303
                try:
2453
2304
                    session.send(client.secret)
2454
2305
                except gnutls.Error as error:
2455
 
                    log.warning("gnutls send failed", exc_info=error)
 
2306
                    logger.warning("gnutls send failed",
 
2307
                                   exc_info=error)
2456
2308
                    return
2457
2309
 
2458
 
                log.info("Sending secret to %s", client.name)
 
2310
                logger.info("Sending secret to %s", client.name)
2459
2311
                # bump the timeout using extended_timeout
2460
2312
                client.bump_timeout(client.extended_timeout)
2461
2313
                if self.server.use_dbus:
2468
2320
                try:
2469
2321
                    session.bye()
2470
2322
                except gnutls.Error as error:
2471
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2323
                    logger.warning("GnuTLS bye failed",
 
2324
                                   exc_info=error)
2472
2325
 
2473
2326
    @staticmethod
2474
2327
    def peer_certificate(session):
2475
 
        "Return the peer's certificate as a bytestring"
2476
 
        try:
2477
 
            cert_type = gnutls.certificate_type_get2(
2478
 
                session, gnutls.CTYPE_PEERS)
2479
 
        except AttributeError:
2480
 
            cert_type = gnutls.certificate_type_get(session)
2481
 
        if gnutls.has_rawpk:
2482
 
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2483
 
        else:
2484
 
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2485
 
        # If not a valid certificate type...
2486
 
        if cert_type not in valid_cert_types:
2487
 
            log.info("Cert type %r not in %r", cert_type,
2488
 
                     valid_cert_types)
 
2328
        "Return the peer's OpenPGP certificate as a bytestring"
 
2329
        # If not an OpenPGP certificate...
 
2330
        if (gnutls.certificate_type_get(session._c_object)
 
2331
            != gnutls.CRT_OPENPGP):
2489
2332
            # ...return invalid data
2490
2333
            return b""
2491
2334
        list_size = ctypes.c_uint(1)
2492
2335
        cert_list = (gnutls.certificate_get_peers
2493
 
                     (session, ctypes.byref(list_size)))
 
2336
                     (session._c_object, ctypes.byref(list_size)))
2494
2337
        if not bool(cert_list) and list_size.value != 0:
2495
2338
            raise gnutls.Error("error getting peer certificate")
2496
2339
        if list_size.value == 0:
2499
2342
        return ctypes.string_at(cert.data, cert.size)
2500
2343
 
2501
2344
    @staticmethod
2502
 
    def key_id(certificate):
2503
 
        "Convert a certificate bytestring to a hexdigit key ID"
2504
 
        # New GnuTLS "datum" with the public key
2505
 
        datum = gnutls.datum_t(
2506
 
            ctypes.cast(ctypes.c_char_p(certificate),
2507
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2508
 
            ctypes.c_uint(len(certificate)))
2509
 
        # XXX all these need to be created in the gnutls "module"
2510
 
        # New empty GnuTLS certificate
2511
 
        pubkey = gnutls.pubkey_t()
2512
 
        gnutls.pubkey_init(ctypes.byref(pubkey))
2513
 
        # Import the raw public key into the certificate
2514
 
        gnutls.pubkey_import(pubkey,
2515
 
                             ctypes.byref(datum),
2516
 
                             gnutls.X509_FMT_DER)
2517
 
        # New buffer for the key ID
2518
 
        buf = ctypes.create_string_buffer(32)
2519
 
        buf_len = ctypes.c_size_t(len(buf))
2520
 
        # Get the key ID from the raw public key into the buffer
2521
 
        gnutls.pubkey_get_key_id(
2522
 
            pubkey,
2523
 
            gnutls.KEYID_USE_SHA256,
2524
 
            ctypes.cast(ctypes.byref(buf),
2525
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2526
 
            ctypes.byref(buf_len))
2527
 
        # Deinit the certificate
2528
 
        gnutls.pubkey_deinit(pubkey)
2529
 
 
2530
 
        # Convert the buffer to a Python bytestring
2531
 
        key_id = ctypes.string_at(buf, buf_len.value)
2532
 
        # Convert the bytestring to hexadecimal notation
2533
 
        hex_key_id = binascii.hexlify(key_id).upper()
2534
 
        return hex_key_id
2535
 
 
2536
 
    @staticmethod
2537
2345
    def fingerprint(openpgp):
2538
2346
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2539
2347
        # New GnuTLS "datum" with the OpenPGP public key
2553
2361
                                       ctypes.byref(crtverify))
2554
2362
        if crtverify.value != 0:
2555
2363
            gnutls.openpgp_crt_deinit(crt)
2556
 
            raise gnutls.CertificateSecurityError(code
2557
 
                                                  =crtverify.value)
 
2364
            raise gnutls.CertificateSecurityError("Verify failed")
2558
2365
        # New buffer for the fingerprint
2559
2366
        buf = ctypes.create_string_buffer(20)
2560
2367
        buf_len = ctypes.c_size_t()
2570
2377
        return hex_fpr
2571
2378
 
2572
2379
 
2573
 
class MultiprocessingMixIn:
 
2380
class MultiprocessingMixIn(object):
2574
2381
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2575
2382
 
2576
2383
    def sub_process_main(self, request, address):
2588
2395
        return proc
2589
2396
 
2590
2397
 
2591
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2398
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2592
2399
    """ adds a pipe to the MixIn """
2593
2400
 
2594
2401
    def process_request(self, request, client_address):
2609
2416
 
2610
2417
 
2611
2418
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2612
 
                     socketserver.TCPServer):
2613
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2419
                     socketserver.TCPServer, object):
 
2420
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2614
2421
 
2615
2422
    Attributes:
2616
2423
        enabled:        Boolean; whether this server is activated yet
2667
2474
            if SO_BINDTODEVICE is None:
2668
2475
                # Fall back to a hard-coded value which seems to be
2669
2476
                # common enough.
2670
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2477
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2671
2478
                SO_BINDTODEVICE = 25
2672
2479
            try:
2673
2480
                self.socket.setsockopt(
2675
2482
                    (self.interface + "\0").encode("utf-8"))
2676
2483
            except socket.error as error:
2677
2484
                if error.errno == errno.EPERM:
2678
 
                    log.error("No permission to bind to interface %s",
2679
 
                              self.interface)
 
2485
                    logger.error("No permission to bind to"
 
2486
                                 " interface %s", self.interface)
2680
2487
                elif error.errno == errno.ENOPROTOOPT:
2681
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2682
 
                              " bind to interface %s", self.interface)
 
2488
                    logger.error("SO_BINDTODEVICE not available;"
 
2489
                                 " cannot bind to interface %s",
 
2490
                                 self.interface)
2683
2491
                elif error.errno == errno.ENODEV:
2684
 
                    log.error("Interface %s does not exist, cannot"
2685
 
                              " bind", self.interface)
 
2492
                    logger.error("Interface %s does not exist,"
 
2493
                                 " cannot bind", self.interface)
2686
2494
                else:
2687
2495
                    raise
2688
2496
        # Only bind(2) the socket if we really need to.
2689
2497
        if self.server_address[0] or self.server_address[1]:
2690
 
            if self.server_address[1]:
2691
 
                self.allow_reuse_address = True
2692
2498
            if not self.server_address[0]:
2693
2499
                if self.address_family == socket.AF_INET6:
2694
2500
                    any_address = "::"  # in6addr_any
2747
2553
    def add_pipe(self, parent_pipe, proc):
2748
2554
        # Call "handle_ipc" for both data and EOF events
2749
2555
        GLib.io_add_watch(
2750
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2751
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2556
            parent_pipe.fileno(),
 
2557
            GLib.IO_IN | GLib.IO_HUP,
2752
2558
            functools.partial(self.handle_ipc,
2753
2559
                              parent_pipe=parent_pipe,
2754
2560
                              proc=proc))
2767
2573
        request = parent_pipe.recv()
2768
2574
        command = request[0]
2769
2575
 
2770
 
        if command == "init":
2771
 
            key_id = request[1].decode("ascii")
2772
 
            fpr = request[2].decode("ascii")
2773
 
            address = request[3]
 
2576
        if command == 'init':
 
2577
            fpr = request[1]
 
2578
            address = request[2]
2774
2579
 
2775
2580
            for c in self.clients.values():
2776
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2777
 
                              "27AE41E4649B934CA495991B7852B855"):
2778
 
                    continue
2779
 
                if key_id and c.key_id == key_id:
2780
 
                    client = c
2781
 
                    break
2782
 
                if fpr and c.fingerprint == fpr:
 
2581
                if c.fingerprint == fpr:
2783
2582
                    client = c
2784
2583
                    break
2785
2584
            else:
2786
 
                log.info("Client not found for key ID: %s, address:"
2787
 
                         " %s", key_id or fpr, address)
 
2585
                logger.info("Client not found for fingerprint: %s, ad"
 
2586
                            "dress: %s", fpr, address)
2788
2587
                if self.use_dbus:
2789
2588
                    # Emit D-Bus signal
2790
 
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
 
2589
                    mandos_dbus_service.ClientNotFound(fpr,
2791
2590
                                                       address[0])
2792
2591
                parent_pipe.send(False)
2793
2592
                return False
2794
2593
 
2795
2594
            GLib.io_add_watch(
2796
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2797
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2595
                parent_pipe.fileno(),
 
2596
                GLib.IO_IN | GLib.IO_HUP,
2798
2597
                functools.partial(self.handle_ipc,
2799
2598
                                  parent_pipe=parent_pipe,
2800
2599
                                  proc=proc,
2803
2602
            # remove the old hook in favor of the new above hook on
2804
2603
            # same fileno
2805
2604
            return False
2806
 
        if command == "funcall":
 
2605
        if command == 'funcall':
2807
2606
            funcname = request[1]
2808
2607
            args = request[2]
2809
2608
            kwargs = request[3]
2810
2609
 
2811
 
            parent_pipe.send(("data", getattr(client_object,
 
2610
            parent_pipe.send(('data', getattr(client_object,
2812
2611
                                              funcname)(*args,
2813
2612
                                                        **kwargs)))
2814
2613
 
2815
 
        if command == "getattr":
 
2614
        if command == 'getattr':
2816
2615
            attrname = request[1]
2817
2616
            if isinstance(client_object.__getattribute__(attrname),
2818
 
                          collections.abc.Callable):
2819
 
                parent_pipe.send(("function", ))
 
2617
                          collections.Callable):
 
2618
                parent_pipe.send(('function', ))
2820
2619
            else:
2821
2620
                parent_pipe.send((
2822
 
                    "data", client_object.__getattribute__(attrname)))
 
2621
                    'data', client_object.__getattribute__(attrname)))
2823
2622
 
2824
 
        if command == "setattr":
 
2623
        if command == 'setattr':
2825
2624
            attrname = request[1]
2826
2625
            value = request[2]
2827
2626
            setattr(client_object, attrname, value)
2832
2631
def rfc3339_duration_to_delta(duration):
2833
2632
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2834
2633
 
2835
 
    >>> timedelta = datetime.timedelta
2836
 
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2837
 
    True
2838
 
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2839
 
    True
2840
 
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2841
 
    True
2842
 
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2843
 
    True
2844
 
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2845
 
    True
2846
 
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2847
 
    True
2848
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2849
 
    True
2850
 
    >>> del timedelta
 
2634
    >>> rfc3339_duration_to_delta("P7D")
 
2635
    datetime.timedelta(7)
 
2636
    >>> rfc3339_duration_to_delta("PT60S")
 
2637
    datetime.timedelta(0, 60)
 
2638
    >>> rfc3339_duration_to_delta("PT60M")
 
2639
    datetime.timedelta(0, 3600)
 
2640
    >>> rfc3339_duration_to_delta("PT24H")
 
2641
    datetime.timedelta(1)
 
2642
    >>> rfc3339_duration_to_delta("P1W")
 
2643
    datetime.timedelta(7)
 
2644
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2645
    datetime.timedelta(0, 330)
 
2646
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2647
    datetime.timedelta(1, 200)
2851
2648
    """
2852
2649
 
2853
2650
    # Parsing an RFC 3339 duration with regular expressions is not
2933
2730
def string_to_delta(interval):
2934
2731
    """Parse a string and return a datetime.timedelta
2935
2732
 
2936
 
    >>> string_to_delta("7d") == datetime.timedelta(7)
2937
 
    True
2938
 
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
2939
 
    True
2940
 
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2941
 
    True
2942
 
    >>> string_to_delta("24h") == datetime.timedelta(1)
2943
 
    True
2944
 
    >>> string_to_delta("1w") == datetime.timedelta(7)
2945
 
    True
2946
 
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2947
 
    True
 
2733
    >>> string_to_delta('7d')
 
2734
    datetime.timedelta(7)
 
2735
    >>> string_to_delta('60s')
 
2736
    datetime.timedelta(0, 60)
 
2737
    >>> string_to_delta('60m')
 
2738
    datetime.timedelta(0, 3600)
 
2739
    >>> string_to_delta('24h')
 
2740
    datetime.timedelta(1)
 
2741
    >>> string_to_delta('1w')
 
2742
    datetime.timedelta(7)
 
2743
    >>> string_to_delta('5m 30s')
 
2744
    datetime.timedelta(0, 330)
2948
2745
    """
2949
2746
 
2950
2747
    try:
3052
2849
 
3053
2850
    options = parser.parse_args()
3054
2851
 
 
2852
    if options.check:
 
2853
        import doctest
 
2854
        fail_count, test_count = doctest.testmod()
 
2855
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2856
 
3055
2857
    # Default values for config file for server-global settings
3056
 
    if gnutls.has_rawpk:
3057
 
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3058
 
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3059
 
    else:
3060
 
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3061
 
                    ":+SIGN-DSA-SHA256")
3062
2858
    server_defaults = {"interface": "",
3063
2859
                       "address": "",
3064
2860
                       "port": "",
3065
2861
                       "debug": "False",
3066
 
                       "priority": priority,
 
2862
                       "priority":
 
2863
                       "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2864
                       ":+SIGN-DSA-SHA256",
3067
2865
                       "servicename": "Mandos",
3068
2866
                       "use_dbus": "True",
3069
2867
                       "use_ipv6": "True",
3074
2872
                       "foreground": "False",
3075
2873
                       "zeroconf": "True",
3076
2874
                       }
3077
 
    del priority
3078
2875
 
3079
2876
    # Parse config file for server-global settings
3080
 
    server_config = configparser.ConfigParser(server_defaults)
 
2877
    server_config = configparser.SafeConfigParser(server_defaults)
3081
2878
    del server_defaults
3082
2879
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3083
 
    # Convert the ConfigParser object to a dict
 
2880
    # Convert the SafeConfigParser object to a dict
3084
2881
    server_settings = server_config.defaults()
3085
2882
    # Use the appropriate methods on the non-string config options
3086
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3087
 
                   "foreground", "zeroconf"):
 
2883
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
3088
2884
        server_settings[option] = server_config.getboolean("DEFAULT",
3089
2885
                                                           option)
3090
2886
    if server_settings["port"]:
3153
2949
 
3154
2950
    if server_settings["servicename"] != "Mandos":
3155
2951
        syslogger.setFormatter(
3156
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3157
 
                              " %(levelname)s: %(message)s".format(
 
2952
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2953
                              ' %(levelname)s: %(message)s'.format(
3158
2954
                                  server_settings["servicename"])))
3159
2955
 
3160
2956
    # Parse config file with clients
3161
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
2957
    client_config = configparser.SafeConfigParser(Client
 
2958
                                                  .client_defaults)
3162
2959
    client_config.read(os.path.join(server_settings["configdir"],
3163
2960
                                    "clients.conf"))
3164
2961
 
3184
2981
        try:
3185
2982
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3186
2983
        except IOError as e:
3187
 
            log.error("Could not open file %r", pidfilename,
3188
 
                      exc_info=e)
 
2984
            logger.error("Could not open file %r", pidfilename,
 
2985
                         exc_info=e)
3189
2986
 
3190
2987
    for name, group in (("_mandos", "_mandos"),
3191
2988
                        ("mandos", "mandos"),
3202
2999
    try:
3203
3000
        os.setgid(gid)
3204
3001
        os.setuid(uid)
3205
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3002
        if debug:
 
3003
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3004
                                                             gid))
3206
3005
    except OSError as error:
3207
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3208
 
                    os.strerror(error.errno))
 
3006
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3007
                       .format(uid, gid, os.strerror(error.errno)))
3209
3008
        if error.errno != errno.EPERM:
3210
3009
            raise
3211
3010
 
3218
3017
 
3219
3018
        @gnutls.log_func
3220
3019
        def debug_gnutls(level, string):
3221
 
            log.debug("GnuTLS: %s",
3222
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3020
            logger.debug("GnuTLS: %s", string[:-1])
3223
3021
 
3224
3022
        gnutls.global_set_log_function(debug_gnutls)
3225
3023
 
3234
3032
        # Close all input and output, do double fork, etc.
3235
3033
        daemon()
3236
3034
 
3237
 
    if gi.version_info < (3, 10, 2):
3238
 
        # multiprocessing will use threads, so before we use GLib we
3239
 
        # need to inform GLib that threads will be used.
3240
 
        GLib.threads_init()
 
3035
    # multiprocessing will use threads, so before we use GLib we need
 
3036
    # to inform GLib that threads will be used.
 
3037
    GLib.threads_init()
3241
3038
 
3242
3039
    global main_loop
3243
3040
    # From the Avahi example code
3244
3041
    DBusGMainLoop(set_as_default=True)
3245
3042
    main_loop = GLib.MainLoop()
3246
 
    if use_dbus or zeroconf:
3247
 
        bus = dbus.SystemBus()
 
3043
    bus = dbus.SystemBus()
3248
3044
    # End of Avahi example code
3249
3045
    if use_dbus:
3250
3046
        try:
3255
3051
                "se.bsnet.fukt.Mandos", bus,
3256
3052
                do_not_queue=True)
3257
3053
        except dbus.exceptions.DBusException as e:
3258
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3054
            logger.error("Disabling D-Bus:", exc_info=e)
3259
3055
            use_dbus = False
3260
3056
            server_settings["use_dbus"] = False
3261
3057
            tcp_server.use_dbus = False
3320
3116
                             if isinstance(s, bytes)
3321
3117
                             else s) for s in
3322
3118
                            value["client_structure"]]
3323
 
                        # .name, .host, and .checker_command
3324
 
                        for k in ("name", "host", "checker_command"):
 
3119
                        # .name & .host
 
3120
                        for k in ("name", "host"):
3325
3121
                            if isinstance(value[k], bytes):
3326
3122
                                value[k] = value[k].decode("utf-8")
3327
 
                        if "key_id" not in value:
3328
 
                            value["key_id"] = ""
3329
 
                        elif "fingerprint" not in value:
3330
 
                            value["fingerprint"] = ""
3331
3123
                    #  old_client_settings
3332
3124
                    # .keys()
3333
3125
                    old_client_settings = {
3337
3129
                        for key, value in
3338
3130
                        bytes_old_client_settings.items()}
3339
3131
                    del bytes_old_client_settings
3340
 
                    # .host and .checker_command
 
3132
                    # .host
3341
3133
                    for value in old_client_settings.values():
3342
 
                        for attribute in ("host", "checker_command"):
3343
 
                            if isinstance(value[attribute], bytes):
3344
 
                                value[attribute] = (value[attribute]
3345
 
                                                    .decode("utf-8"))
 
3134
                        if isinstance(value["host"], bytes):
 
3135
                            value["host"] = (value["host"]
 
3136
                                             .decode("utf-8"))
3346
3137
            os.remove(stored_state_path)
3347
3138
        except IOError as e:
3348
3139
            if e.errno == errno.ENOENT:
3349
 
                log.warning("Could not load persistent state:"
3350
 
                            " %s", os.strerror(e.errno))
 
3140
                logger.warning("Could not load persistent state:"
 
3141
                               " {}".format(os.strerror(e.errno)))
3351
3142
            else:
3352
 
                log.critical("Could not load persistent state:",
3353
 
                             exc_info=e)
 
3143
                logger.critical("Could not load persistent state:",
 
3144
                                exc_info=e)
3354
3145
                raise
3355
3146
        except EOFError as e:
3356
 
            log.warning("Could not load persistent state: EOFError:",
3357
 
                        exc_info=e)
 
3147
            logger.warning("Could not load persistent state: "
 
3148
                           "EOFError:",
 
3149
                           exc_info=e)
3358
3150
 
3359
3151
    with PGPEngine() as pgp:
3360
3152
        for client_name, client in clients_data.items():
3387
3179
            if client["enabled"]:
3388
3180
                if datetime.datetime.utcnow() >= client["expires"]:
3389
3181
                    if not client["last_checked_ok"]:
3390
 
                        log.warning("disabling client %s - Client"
3391
 
                                    " never performed a successful"
3392
 
                                    " checker", client_name)
 
3182
                        logger.warning(
 
3183
                            "disabling client {} - Client never "
 
3184
                            "performed a successful checker".format(
 
3185
                                client_name))
3393
3186
                        client["enabled"] = False
3394
3187
                    elif client["last_checker_status"] != 0:
3395
 
                        log.warning("disabling client %s - Client"
3396
 
                                    " last checker failed with error"
3397
 
                                    " code %s", client_name,
3398
 
                                    client["last_checker_status"])
 
3188
                        logger.warning(
 
3189
                            "disabling client {} - Client last"
 
3190
                            " checker failed with error code"
 
3191
                            " {}".format(
 
3192
                                client_name,
 
3193
                                client["last_checker_status"]))
3399
3194
                        client["enabled"] = False
3400
3195
                    else:
3401
3196
                        client["expires"] = (
3402
3197
                            datetime.datetime.utcnow()
3403
3198
                            + client["timeout"])
3404
 
                        log.debug("Last checker succeeded, keeping %s"
3405
 
                                  " enabled", client_name)
 
3199
                        logger.debug("Last checker succeeded,"
 
3200
                                     " keeping {} enabled".format(
 
3201
                                         client_name))
3406
3202
            try:
3407
3203
                client["secret"] = pgp.decrypt(
3408
3204
                    client["encrypted_secret"],
3409
3205
                    client_settings[client_name]["secret"])
3410
3206
            except PGPError:
3411
3207
                # If decryption fails, we use secret from new settings
3412
 
                log.debug("Failed to decrypt %s old secret",
3413
 
                          client_name)
 
3208
                logger.debug("Failed to decrypt {} old secret".format(
 
3209
                    client_name))
3414
3210
                client["secret"] = (client_settings[client_name]
3415
3211
                                    ["secret"])
3416
3212
 
3430
3226
            server_settings=server_settings)
3431
3227
 
3432
3228
    if not tcp_server.clients:
3433
 
        log.warning("No clients defined")
 
3229
        logger.warning("No clients defined")
3434
3230
 
3435
3231
    if not foreground:
3436
3232
        if pidfile is not None:
3439
3235
                with pidfile:
3440
3236
                    print(pid, file=pidfile)
3441
3237
            except IOError:
3442
 
                log.error("Could not write to file %r with PID %d",
3443
 
                          pidfilename, pid)
 
3238
                logger.error("Could not write to file %r with PID %d",
 
3239
                             pidfilename, pid)
3444
3240
        del pidfile
3445
3241
        del pidfilename
3446
3242
 
3466
3262
                pass
3467
3263
 
3468
3264
            @dbus.service.signal(_interface, signature="ss")
3469
 
            def ClientNotFound(self, key_id, address):
 
3265
            def ClientNotFound(self, fingerprint, address):
3470
3266
                "D-Bus signal"
3471
3267
                pass
3472
3268
 
3596
3392
 
3597
3393
        try:
3598
3394
            with tempfile.NamedTemporaryFile(
3599
 
                    mode="wb",
 
3395
                    mode='wb',
3600
3396
                    suffix=".pickle",
3601
 
                    prefix="clients-",
 
3397
                    prefix='clients-',
3602
3398
                    dir=os.path.dirname(stored_state_path),
3603
3399
                    delete=False) as stored_state:
3604
3400
                pickle.dump((clients, client_settings), stored_state,
3612
3408
                except NameError:
3613
3409
                    pass
3614
3410
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3615
 
                log.warning("Could not save persistent state: %s",
3616
 
                            os.strerror(e.errno))
 
3411
                logger.warning("Could not save persistent state: {}"
 
3412
                               .format(os.strerror(e.errno)))
3617
3413
            else:
3618
 
                log.warning("Could not save persistent state:",
3619
 
                            exc_info=e)
 
3414
                logger.warning("Could not save persistent state:",
 
3415
                               exc_info=e)
3620
3416
                raise
3621
3417
 
3622
3418
        # Delete all clients, and settings from config
3639
3435
            mandos_dbus_service.client_added_signal(client)
3640
3436
        # Need to initiate checking of clients
3641
3437
        if client.enabled:
3642
 
            client.init_checker(randomize_start=True)
 
3438
            client.init_checker()
3643
3439
 
3644
3440
    tcp_server.enable()
3645
3441
    tcp_server.server_activate()
3648
3444
    if zeroconf:
3649
3445
        service.port = tcp_server.socket.getsockname()[1]
3650
3446
    if use_ipv6:
3651
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3652
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3447
        logger.info("Now listening on address %r, port %d,"
 
3448
                    " flowinfo %d, scope_id %d",
 
3449
                    *tcp_server.socket.getsockname())
3653
3450
    else:                       # IPv4
3654
 
        log.info("Now listening on address %r, port %d",
3655
 
                 *tcp_server.socket.getsockname())
 
3451
        logger.info("Now listening on address %r, port %d",
 
3452
                    *tcp_server.socket.getsockname())
3656
3453
 
3657
3454
    # service.interface = tcp_server.socket.getsockname()[3]
3658
3455
 
3662
3459
            try:
3663
3460
                service.activate()
3664
3461
            except dbus.exceptions.DBusException as error:
3665
 
                log.critical("D-Bus Exception", exc_info=error)
 
3462
                logger.critical("D-Bus Exception", exc_info=error)
3666
3463
                cleanup()
3667
3464
                sys.exit(1)
3668
3465
            # End of Avahi example code
3669
3466
 
3670
 
        GLib.io_add_watch(
3671
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3672
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3673
 
            lambda *args, **kwargs: (tcp_server.handle_request
3674
 
                                     (*args[2:], **kwargs) or True))
 
3467
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3468
                          lambda *args, **kwargs:
 
3469
                          (tcp_server.handle_request
 
3470
                           (*args[2:], **kwargs) or True))
3675
3471
 
3676
 
        log.debug("Starting main loop")
 
3472
        logger.debug("Starting main loop")
3677
3473
        main_loop.run()
3678
3474
    except AvahiError as error:
3679
 
        log.critical("Avahi Error", exc_info=error)
 
3475
        logger.critical("Avahi Error", exc_info=error)
3680
3476
        cleanup()
3681
3477
        sys.exit(1)
3682
3478
    except KeyboardInterrupt:
3683
3479
        if debug:
3684
3480
            print("", file=sys.stderr)
3685
 
        log.debug("Server received KeyboardInterrupt")
3686
 
    log.debug("Server exiting")
 
3481
        logger.debug("Server received KeyboardInterrupt")
 
3482
    logger.debug("Server exiting")
3687
3483
    # Must run before the D-Bus bus name gets deregistered
3688
3484
    cleanup()
3689
3485
 
3690
 
 
3691
 
def parse_test_args():
3692
 
    # type: () -> argparse.Namespace
3693
 
    parser = argparse.ArgumentParser(add_help=False)
3694
 
    parser.add_argument("--check", action="store_true")
3695
 
    parser.add_argument("--prefix", )
3696
 
    args, unknown_args = parser.parse_known_args()
3697
 
    if args.check:
3698
 
        # Remove test options from sys.argv
3699
 
        sys.argv[1:] = unknown_args
3700
 
    return args
3701
 
 
3702
 
# Add all tests from doctest strings
3703
 
def load_tests(loader, tests, none):
3704
 
    import doctest
3705
 
    tests.addTests(doctest.DocTestSuite())
3706
 
    return tests
3707
 
 
3708
 
if __name__ == "__main__":
3709
 
    options = parse_test_args()
3710
 
    try:
3711
 
        if options.check:
3712
 
            extra_test_prefix = options.prefix
3713
 
            if extra_test_prefix is not None:
3714
 
                if not (unittest.main(argv=[""], exit=False)
3715
 
                        .result.wasSuccessful()):
3716
 
                    sys.exit(1)
3717
 
                class ExtraTestLoader(unittest.TestLoader):
3718
 
                    testMethodPrefix = extra_test_prefix
3719
 
                # Call using ./scriptname --test [--verbose]
3720
 
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
3721
 
            else:
3722
 
                unittest.main(argv=[""])
3723
 
        else:
3724
 
            main()
3725
 
    finally:
3726
 
        logging.shutdown()
3727
 
 
3728
 
# Local Variables:
3729
 
# run-tests:
3730
 
# (lambda (&optional extra)
3731
 
#   (if (not (funcall run-tests-in-test-buffer default-directory
3732
 
#             extra))
3733
 
#       (funcall show-test-buffer-in-test-window)
3734
 
#     (funcall remove-test-window)
3735
 
#     (if extra (message "Extra tests run successfully!"))))
3736
 
# run-tests-in-test-buffer:
3737
 
# (lambda (dir &optional extra)
3738
 
#   (with-current-buffer (get-buffer-create "*Test*")
3739
 
#     (setq buffer-read-only nil
3740
 
#           default-directory dir)
3741
 
#     (erase-buffer)
3742
 
#     (compilation-mode))
3743
 
#   (let ((process-result
3744
 
#          (let ((inhibit-read-only t))
3745
 
#            (process-file-shell-command
3746
 
#             (funcall get-command-line extra) nil "*Test*"))))
3747
 
#     (and (numberp process-result)
3748
 
#          (= process-result 0))))
3749
 
# get-command-line:
3750
 
# (lambda (&optional extra)
3751
 
#   (let ((quoted-script
3752
 
#          (shell-quote-argument (funcall get-script-name))))
3753
 
#     (format
3754
 
#      (concat "%s --check" (if extra " --prefix=atest" ""))
3755
 
#      quoted-script)))
3756
 
# get-script-name:
3757
 
# (lambda ()
3758
 
#   (if (fboundp 'file-local-name)
3759
 
#       (file-local-name (buffer-file-name))
3760
 
#     (or (file-remote-p (buffer-file-name) 'localname)
3761
 
#         (buffer-file-name))))
3762
 
# remove-test-window:
3763
 
# (lambda ()
3764
 
#   (let ((test-window (get-buffer-window "*Test*")))
3765
 
#     (if test-window (delete-window test-window))))
3766
 
# show-test-buffer-in-test-window:
3767
 
# (lambda ()
3768
 
#   (when (not (get-buffer-window-list "*Test*"))
3769
 
#     (setq next-error-last-buffer (get-buffer "*Test*"))
3770
 
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3771
 
#            (display-buffer-overriding-action
3772
 
#             `((display-buffer-in-side-window) (side . ,side)
3773
 
#               (window-height . fit-window-to-buffer)
3774
 
#               (window-width . fit-window-to-buffer))))
3775
 
#       (display-buffer "*Test*"))))
3776
 
# eval:
3777
 
# (progn
3778
 
#   (let* ((run-extra-tests (lambda () (interactive)
3779
 
#                             (funcall run-tests t)))
3780
 
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3781
 
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
3782
 
#     (setq minor-mode-overriding-map-alist
3783
 
#           (cons `(run-tests . ,outer-keymap)
3784
 
#                 minor-mode-overriding-map-alist)))
3785
 
#   (add-hook 'after-save-hook run-tests 90 t))
3786
 
# End:
 
3486
 
 
3487
if __name__ == '__main__':
 
3488
    main()