/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2023-02-11 06:58:15 UTC
  • Revision ID: teddy@recompile.se-20230211065815-jtffi61tbdrgr875
Suppress warnings

Suppress warnings about mlock()ing uninitialized memory and reading an
ievent struct.

* dracut-module/password-agent.c (send_password_to_socket): Suppress
  "-Wmaybe-uninitialized" when mlock()ing password send buffer.
  (test_read_inotify_event_IN_DELETE_badname): When reading from
    a struct ievent, suppress "-Wstringop-overread".

Show diffs side-by-side

added added

removed removed

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