/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2023-02-07 19:11:25 UTC
  • Revision ID: teddy@recompile.se-20230207191125-u7wl4mshb7cl3xi2
White space fixes only

* mandos-keygen: Reformat; remove white space from empty lines.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python3 -bI
2
 
# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
 
2
# -*- coding: utf-8; lexical-binding: t -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
5
#
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2019 Teddy Hogeborn
15
 
# Copyright © 2008-2019 Björn Påhlsson
 
14
# Copyright © 2008-2022 Teddy Hogeborn
 
15
# Copyright © 2008-2022 Björn Påhlsson
16
16
#
17
17
# This file is part of Mandos.
18
18
#
31
31
#
32
32
# Contact the authors at <mandos@recompile.se>.
33
33
#
34
 
 
35
34
from __future__ import (division, absolute_import, print_function,
36
35
                        unicode_literals)
37
36
 
40
39
except ImportError:
41
40
    pass
42
41
 
 
42
import sys
 
43
import unittest
 
44
import argparse
 
45
import logging
 
46
import os
43
47
try:
44
48
    import SocketServer as socketserver
45
49
except ImportError:
46
50
    import socketserver
47
51
import socket
48
 
import argparse
49
52
import datetime
50
53
import errno
51
54
try:
52
55
    import ConfigParser as configparser
53
56
except ImportError:
54
57
    import configparser
55
 
import sys
56
58
import re
57
 
import os
58
59
import signal
59
60
import subprocess
60
61
import atexit
61
62
import stat
62
 
import logging
63
63
import logging.handlers
64
64
import pwd
65
65
import contextlib
77
77
import itertools
78
78
import collections
79
79
import codecs
80
 
import unittest
81
80
import random
 
81
import shlex
82
82
 
83
83
import dbus
84
84
import dbus.service
93
93
if sys.version_info.major == 2:
94
94
    __metaclass__ = type
95
95
    str = unicode
 
96
    input = raw_input
96
97
 
97
98
# Add collections.abc.Callable if it does not exist
98
99
try:
103
104
    collections.abc = abc
104
105
    del abc
105
106
 
 
107
# Add shlex.quote if it does not exist
 
108
try:
 
109
    shlex.quote
 
110
except AttributeError:
 
111
    shlex.quote = re.escape
 
112
 
106
113
# Show warnings by default
107
114
if not sys.warnoptions:
108
115
    import warnings
136
143
if sys.version_info < (3, 2):
137
144
    configparser.Configparser = configparser.SafeConfigParser
138
145
 
139
 
version = "1.8.9"
 
146
version = "1.8.15"
140
147
stored_state_file = "clients.pickle"
141
148
 
142
 
logger = logging.getLogger()
 
149
log = logging.getLogger(os.path.basename(sys.argv[0]))
143
150
logging.captureWarnings(True)   # Show warnings via the logging system
144
151
syslogger = None
145
152
 
182
189
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
183
190
        address="/dev/log"))
184
191
    syslogger.setFormatter(logging.Formatter
185
 
                           ('Mandos [%(process)d]: %(levelname)s:'
186
 
                            ' %(message)s'))
187
 
    logger.addHandler(syslogger)
 
192
                           ("Mandos [%(process)d]: %(levelname)s:"
 
193
                            " %(message)s"))
 
194
    log.addHandler(syslogger)
188
195
 
189
196
    if debug:
190
197
        console = logging.StreamHandler()
191
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
192
 
                                               ' [%(process)d]:'
193
 
                                               ' %(levelname)s:'
194
 
                                               ' %(message)s'))
195
 
        logger.addHandler(console)
196
 
    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)
197
204
 
198
205
 
199
206
class PGPError(Exception):
217
224
        except OSError as e:
218
225
            if e.errno != errno.ENOENT:
219
226
                raise
220
 
        self.gnupgargs = ['--batch',
221
 
                          '--homedir', self.tempdir,
222
 
                          '--force-mdc',
223
 
                          '--quiet']
 
227
        self.gnupgargs = ["--batch",
 
228
                          "--homedir", self.tempdir,
 
229
                          "--force-mdc",
 
230
                          "--quiet"]
224
231
        # Only GPG version 1 has the --no-use-agent option.
225
232
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
226
233
            self.gnupgargs.append("--no-use-agent")
265
272
                dir=self.tempdir) as passfile:
266
273
            passfile.write(passphrase)
267
274
            passfile.flush()
268
 
            proc = subprocess.Popen([self.gpg, '--symmetric',
269
 
                                     '--passphrase-file',
 
275
            proc = subprocess.Popen([self.gpg, "--symmetric",
 
276
                                     "--passphrase-file",
270
277
                                     passfile.name]
271
278
                                    + self.gnupgargs,
272
279
                                    stdin=subprocess.PIPE,
283
290
                dir=self.tempdir) as passfile:
284
291
            passfile.write(passphrase)
285
292
            passfile.flush()
286
 
            proc = subprocess.Popen([self.gpg, '--decrypt',
287
 
                                     '--passphrase-file',
 
293
            proc = subprocess.Popen([self.gpg, "--decrypt",
 
294
                                     "--passphrase-file",
288
295
                                     passfile.name]
289
296
                                    + self.gnupgargs,
290
297
                                    stdin=subprocess.PIPE,
343
350
    Attributes:
344
351
    interface: integer; avahi.IF_UNSPEC or an interface index.
345
352
               Used to optionally bind to the specified interface.
346
 
    name: string; Example: 'Mandos'
347
 
    type: string; Example: '_mandos._tcp'.
 
353
    name: string; Example: "Mandos"
 
354
    type: string; Example: "_mandos._tcp".
348
355
     See <https://www.iana.org/assignments/service-names-port-numbers>
349
356
    port: integer; what port to announce
350
357
    TXT: list of strings; TXT record for the service
387
394
    def rename(self, remove=True):
388
395
        """Derived from the Avahi example code"""
389
396
        if self.rename_count >= self.max_renames:
390
 
            logger.critical("No suitable Zeroconf service name found"
391
 
                            " after %i retries, exiting.",
392
 
                            self.rename_count)
 
397
            log.critical("No suitable Zeroconf service name found"
 
398
                         " after %i retries, exiting.",
 
399
                         self.rename_count)
393
400
            raise AvahiServiceError("Too many renames")
394
401
        self.name = str(
395
402
            self.server.GetAlternativeServiceName(self.name))
396
403
        self.rename_count += 1
397
 
        logger.info("Changing Zeroconf service name to %r ...",
398
 
                    self.name)
 
404
        log.info("Changing Zeroconf service name to %r ...",
 
405
                 self.name)
399
406
        if remove:
400
407
            self.remove()
401
408
        try:
403
410
        except dbus.exceptions.DBusException as error:
404
411
            if (error.get_dbus_name()
405
412
                == "org.freedesktop.Avahi.CollisionError"):
406
 
                logger.info("Local Zeroconf service name collision.")
 
413
                log.info("Local Zeroconf service name collision.")
407
414
                return self.rename(remove=False)
408
415
            else:
409
 
                logger.critical("D-Bus Exception", exc_info=error)
 
416
                log.critical("D-Bus Exception", exc_info=error)
410
417
                self.cleanup()
411
418
                os._exit(1)
412
419
 
428
435
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
429
436
        self.entry_group_state_changed_match = (
430
437
            self.group.connect_to_signal(
431
 
                'StateChanged', self.entry_group_state_changed))
432
 
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
433
 
                     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)
434
441
        self.group.AddService(
435
442
            self.interface,
436
443
            self.protocol,
443
450
 
444
451
    def entry_group_state_changed(self, state, error):
445
452
        """Derived from the Avahi example code"""
446
 
        logger.debug("Avahi entry group state change: %i", state)
 
453
        log.debug("Avahi entry group state change: %i", state)
447
454
 
448
455
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
449
 
            logger.debug("Zeroconf service established.")
 
456
            log.debug("Zeroconf service established.")
450
457
        elif state == avahi.ENTRY_GROUP_COLLISION:
451
 
            logger.info("Zeroconf service name collision.")
 
458
            log.info("Zeroconf service name collision.")
452
459
            self.rename()
453
460
        elif state == avahi.ENTRY_GROUP_FAILURE:
454
 
            logger.critical("Avahi: Error in group state changed %s",
455
 
                            str(error))
 
461
            log.critical("Avahi: Error in group state changed %s",
 
462
                         str(error))
456
463
            raise AvahiGroupError("State changed: {!s}".format(error))
457
464
 
458
465
    def cleanup(self):
468
475
 
469
476
    def server_state_changed(self, state, error=None):
470
477
        """Derived from the Avahi example code"""
471
 
        logger.debug("Avahi server state change: %i", state)
 
478
        log.debug("Avahi server state change: %i", state)
472
479
        bad_states = {
473
480
            avahi.SERVER_INVALID: "Zeroconf server invalid",
474
481
            avahi.SERVER_REGISTERING: None,
478
485
        if state in bad_states:
479
486
            if bad_states[state] is not None:
480
487
                if error is None:
481
 
                    logger.error(bad_states[state])
 
488
                    log.error(bad_states[state])
482
489
                else:
483
 
                    logger.error(bad_states[state] + ": %r", error)
 
490
                    log.error(bad_states[state] + ": %r", error)
484
491
            self.cleanup()
485
492
        elif state == avahi.SERVER_RUNNING:
486
493
            try:
488
495
            except dbus.exceptions.DBusException as error:
489
496
                if (error.get_dbus_name()
490
497
                    == "org.freedesktop.Avahi.CollisionError"):
491
 
                    logger.info("Local Zeroconf service name"
492
 
                                " collision.")
 
498
                    log.info("Local Zeroconf service name collision.")
493
499
                    return self.rename(remove=False)
494
500
                else:
495
 
                    logger.critical("D-Bus Exception", exc_info=error)
 
501
                    log.critical("D-Bus Exception", exc_info=error)
496
502
                    self.cleanup()
497
503
                    os._exit(1)
498
504
        else:
499
505
            if error is None:
500
 
                logger.debug("Unknown state: %r", state)
 
506
                log.debug("Unknown state: %r", state)
501
507
            else:
502
 
                logger.debug("Unknown state: %r: %r", state, error)
 
508
                log.debug("Unknown state: %r: %r", state, error)
503
509
 
504
510
    def activate(self):
505
511
        """Derived from the Avahi example code"""
517
523
class AvahiServiceToSyslog(AvahiService):
518
524
    def rename(self, *args, **kwargs):
519
525
        """Add the new name to the syslog messages"""
520
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
526
        ret = super(AvahiServiceToSyslog, self).rename(*args,
 
527
                                                       **kwargs)
521
528
        syslogger.setFormatter(logging.Formatter(
522
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
529
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
523
530
            .format(self.name)))
524
531
        return ret
525
532
 
555
562
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
556
563
 
557
564
    # Types
558
 
    class session_int(ctypes.Structure):
 
565
    class _session_int(ctypes.Structure):
559
566
        _fields_ = []
560
 
    session_t = ctypes.POINTER(session_int)
 
567
    session_t = ctypes.POINTER(_session_int)
561
568
 
562
569
    class certificate_credentials_st(ctypes.Structure):
563
570
        _fields_ = []
566
573
    certificate_type_t = ctypes.c_int
567
574
 
568
575
    class datum_t(ctypes.Structure):
569
 
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
570
 
                    ('size', ctypes.c_uint)]
 
576
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
 
577
                    ("size", ctypes.c_uint)]
571
578
 
572
 
    class openpgp_crt_int(ctypes.Structure):
 
579
    class _openpgp_crt_int(ctypes.Structure):
573
580
        _fields_ = []
574
 
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
581
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
575
582
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
576
583
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
577
584
    credentials_type_t = ctypes.c_int
586
593
            # gnutls.strerror()
587
594
            self.code = code
588
595
            if message is None and code is not None:
589
 
                message = gnutls.strerror(code)
 
596
                message = gnutls.strerror(code).decode(
 
597
                    "utf-8", errors="replace")
590
598
            return super(gnutls.Error, self).__init__(
591
599
                message, *args)
592
600
 
593
601
    class CertificateSecurityError(Error):
594
602
        pass
595
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
 
596
629
    # Classes
597
 
    class Credentials:
 
630
    class Credentials(With_from_param):
598
631
        def __init__(self):
599
 
            self._c_object = gnutls.certificate_credentials_t()
600
 
            gnutls.certificate_allocate_credentials(
601
 
                ctypes.byref(self._c_object))
 
632
            self._as_parameter_ = gnutls.certificate_credentials_t()
 
633
            gnutls.certificate_allocate_credentials(self)
602
634
            self.type = gnutls.CRD_CERTIFICATE
603
635
 
604
636
        def __del__(self):
605
 
            gnutls.certificate_free_credentials(self._c_object)
 
637
            gnutls.certificate_free_credentials(self)
606
638
 
607
 
    class ClientSession:
 
639
    class ClientSession(With_from_param):
608
640
        def __init__(self, socket, credentials=None):
609
 
            self._c_object = gnutls.session_t()
 
641
            self._as_parameter_ = gnutls.session_t()
610
642
            gnutls_flags = gnutls.CLIENT
611
643
            if gnutls.check_version(b"3.5.6"):
612
644
                gnutls_flags |= gnutls.NO_TICKETS
613
645
            if gnutls.has_rawpk:
614
646
                gnutls_flags |= gnutls.ENABLE_RAWPK
615
 
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
 
647
            gnutls.init(self, gnutls_flags)
616
648
            del gnutls_flags
617
 
            gnutls.set_default_priority(self._c_object)
618
 
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
619
 
            gnutls.handshake_set_private_extensions(self._c_object,
620
 
                                                    True)
 
649
            gnutls.set_default_priority(self)
 
650
            gnutls.transport_set_ptr(self, socket.fileno())
 
651
            gnutls.handshake_set_private_extensions(self, True)
621
652
            self.socket = socket
622
653
            if credentials is None:
623
654
                credentials = gnutls.Credentials()
624
 
            gnutls.credentials_set(self._c_object, credentials.type,
625
 
                                   ctypes.cast(credentials._c_object,
626
 
                                               ctypes.c_void_p))
 
655
            gnutls.credentials_set(self, credentials.type,
 
656
                                   credentials)
627
657
            self.credentials = credentials
628
658
 
629
659
        def __del__(self):
630
 
            gnutls.deinit(self._c_object)
 
660
            gnutls.deinit(self)
631
661
 
632
662
        def handshake(self):
633
 
            return gnutls.handshake(self._c_object)
 
663
            return gnutls.handshake(self)
634
664
 
635
665
        def send(self, data):
636
666
            data = bytes(data)
637
667
            data_len = len(data)
638
668
            while data_len > 0:
639
 
                data_len -= gnutls.record_send(self._c_object,
640
 
                                               data[-data_len:],
 
669
                data_len -= gnutls.record_send(self, data[-data_len:],
641
670
                                               data_len)
642
671
 
643
672
        def bye(self):
644
 
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
673
            return gnutls.bye(self, gnutls.SHUT_RDWR)
645
674
 
646
675
    # Error handling functions
647
676
    def _error_code(result):
648
677
        """A function to raise exceptions on errors, suitable
649
 
        for the 'restype' attribute on ctypes functions"""
650
 
        if result >= 0:
 
678
        for the "restype" attribute on ctypes functions"""
 
679
        if result >= gnutls.E_SUCCESS:
651
680
            return result
652
681
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
653
682
            raise gnutls.CertificateSecurityError(code=result)
654
683
        raise gnutls.Error(code=result)
655
684
 
656
 
    def _retry_on_error(result, func, arguments):
 
685
    def _retry_on_error(result, func, arguments,
 
686
                        _error_code=_error_code):
657
687
        """A function to retry on some errors, suitable
658
 
        for the 'errcheck' attribute on ctypes functions"""
659
 
        while result < 0:
 
688
        for the "errcheck" attribute on ctypes functions"""
 
689
        while result < gnutls.E_SUCCESS:
660
690
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
661
691
                return _error_code(result)
662
692
            result = func(*arguments)
667
697
 
668
698
    # Functions
669
699
    priority_set_direct = _library.gnutls_priority_set_direct
670
 
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
700
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
671
701
                                    ctypes.POINTER(ctypes.c_char_p)]
672
702
    priority_set_direct.restype = _error_code
673
703
 
674
704
    init = _library.gnutls_init
675
 
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
705
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
676
706
    init.restype = _error_code
677
707
 
678
708
    set_default_priority = _library.gnutls_set_default_priority
679
 
    set_default_priority.argtypes = [session_t]
 
709
    set_default_priority.argtypes = [ClientSession]
680
710
    set_default_priority.restype = _error_code
681
711
 
682
712
    record_send = _library.gnutls_record_send
683
 
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
713
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
684
714
                            ctypes.c_size_t]
685
715
    record_send.restype = ctypes.c_ssize_t
686
716
    record_send.errcheck = _retry_on_error
688
718
    certificate_allocate_credentials = (
689
719
        _library.gnutls_certificate_allocate_credentials)
690
720
    certificate_allocate_credentials.argtypes = [
691
 
        ctypes.POINTER(certificate_credentials_t)]
 
721
        PointerTo(Credentials)]
692
722
    certificate_allocate_credentials.restype = _error_code
693
723
 
694
724
    certificate_free_credentials = (
695
725
        _library.gnutls_certificate_free_credentials)
696
 
    certificate_free_credentials.argtypes = [
697
 
        certificate_credentials_t]
 
726
    certificate_free_credentials.argtypes = [Credentials]
698
727
    certificate_free_credentials.restype = None
699
728
 
700
729
    handshake_set_private_extensions = (
701
730
        _library.gnutls_handshake_set_private_extensions)
702
 
    handshake_set_private_extensions.argtypes = [session_t,
 
731
    handshake_set_private_extensions.argtypes = [ClientSession,
703
732
                                                 ctypes.c_int]
704
733
    handshake_set_private_extensions.restype = None
705
734
 
706
735
    credentials_set = _library.gnutls_credentials_set
707
 
    credentials_set.argtypes = [session_t, credentials_type_t,
708
 
                                ctypes.c_void_p]
 
736
    credentials_set.argtypes = [ClientSession, credentials_type_t,
 
737
                                CastToVoidPointer(Credentials)]
709
738
    credentials_set.restype = _error_code
710
739
 
711
740
    strerror = _library.gnutls_strerror
713
742
    strerror.restype = ctypes.c_char_p
714
743
 
715
744
    certificate_type_get = _library.gnutls_certificate_type_get
716
 
    certificate_type_get.argtypes = [session_t]
 
745
    certificate_type_get.argtypes = [ClientSession]
717
746
    certificate_type_get.restype = _error_code
718
747
 
719
748
    certificate_get_peers = _library.gnutls_certificate_get_peers
720
 
    certificate_get_peers.argtypes = [session_t,
 
749
    certificate_get_peers.argtypes = [ClientSession,
721
750
                                      ctypes.POINTER(ctypes.c_uint)]
722
751
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
723
752
 
730
759
    global_set_log_function.restype = None
731
760
 
732
761
    deinit = _library.gnutls_deinit
733
 
    deinit.argtypes = [session_t]
 
762
    deinit.argtypes = [ClientSession]
734
763
    deinit.restype = None
735
764
 
736
765
    handshake = _library.gnutls_handshake
737
 
    handshake.argtypes = [session_t]
738
 
    handshake.restype = _error_code
 
766
    handshake.argtypes = [ClientSession]
 
767
    handshake.restype = ctypes.c_int
739
768
    handshake.errcheck = _retry_on_error
740
769
 
741
770
    transport_set_ptr = _library.gnutls_transport_set_ptr
742
 
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
771
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
743
772
    transport_set_ptr.restype = None
744
773
 
745
774
    bye = _library.gnutls_bye
746
 
    bye.argtypes = [session_t, close_request_t]
747
 
    bye.restype = _error_code
 
775
    bye.argtypes = [ClientSession, close_request_t]
 
776
    bye.restype = ctypes.c_int
748
777
    bye.errcheck = _retry_on_error
749
778
 
750
779
    check_version = _library.gnutls_check_version
767
796
 
768
797
        x509_crt_fmt_t = ctypes.c_int
769
798
 
770
 
        # All the function declarations below are from gnutls/abstract.h
 
799
        # All the function declarations below are from
 
800
        # gnutls/abstract.h
771
801
        pubkey_init = _library.gnutls_pubkey_init
772
802
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
773
803
        pubkey_init.restype = _error_code
787
817
        pubkey_deinit.argtypes = [pubkey_t]
788
818
        pubkey_deinit.restype = None
789
819
    else:
790
 
        # All the function declarations below are from gnutls/openpgp.h
 
820
        # All the function declarations below are from
 
821
        # gnutls/openpgp.h
791
822
 
792
823
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
793
824
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
799
830
                                       openpgp_crt_fmt_t]
800
831
        openpgp_crt_import.restype = _error_code
801
832
 
802
 
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
803
 
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
804
 
                                            ctypes.POINTER(ctypes.c_uint)]
 
833
        openpgp_crt_verify_self = \
 
834
            _library.gnutls_openpgp_crt_verify_self
 
835
        openpgp_crt_verify_self.argtypes = [
 
836
            openpgp_crt_t,
 
837
            ctypes.c_uint,
 
838
            ctypes.POINTER(ctypes.c_uint),
 
839
        ]
805
840
        openpgp_crt_verify_self.restype = _error_code
806
841
 
807
842
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
818
853
 
819
854
    if check_version(b"3.6.4"):
820
855
        certificate_type_get2 = _library.gnutls_certificate_type_get2
821
 
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
 
856
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
822
857
        certificate_type_get2.restype = _error_code
823
858
 
824
859
    # Remove non-public functions
840
875
    """A representation of a client host served by this server.
841
876
 
842
877
    Attributes:
843
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
878
    approved:   bool(); None if not yet approved/disapproved
844
879
    approval_delay: datetime.timedelta(); Time to wait for approval
845
880
    approval_duration: datetime.timedelta(); Duration of one approval
846
881
    checker: multiprocessing.Process(); a running checker process used
847
 
             to see if the client lives. 'None' if no process is
 
882
             to see if the client lives. None if no process is
848
883
             running.
849
884
    checker_callback_tag: a GLib event source tag, or None
850
885
    checker_command: string; External command which is run to check
974
1009
            self.last_enabled = None
975
1010
            self.expires = None
976
1011
 
977
 
        logger.debug("Creating client %r", self.name)
978
 
        logger.debug("  Key ID: %s", self.key_id)
979
 
        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)
980
1015
        self.created = settings.get("created",
981
1016
                                    datetime.datetime.utcnow())
982
1017
 
1021
1056
        if not getattr(self, "enabled", False):
1022
1057
            return False
1023
1058
        if not quiet:
1024
 
            logger.info("Disabling client %s", self.name)
 
1059
            log.info("Disabling client %s", self.name)
1025
1060
        if getattr(self, "disable_initiator_tag", None) is not None:
1026
1061
            GLib.source_remove(self.disable_initiator_tag)
1027
1062
            self.disable_initiator_tag = None
1071
1106
            self.last_checker_status = returncode
1072
1107
            self.last_checker_signal = None
1073
1108
            if self.last_checker_status == 0:
1074
 
                logger.info("Checker for %(name)s succeeded",
1075
 
                            vars(self))
 
1109
                log.info("Checker for %(name)s succeeded", vars(self))
1076
1110
                self.checked_ok()
1077
1111
            else:
1078
 
                logger.info("Checker for %(name)s failed", vars(self))
 
1112
                log.info("Checker for %(name)s failed", vars(self))
1079
1113
        else:
1080
1114
            self.last_checker_status = -1
1081
1115
            self.last_checker_signal = -returncode
1082
 
            logger.warning("Checker for %(name)s crashed?",
1083
 
                           vars(self))
 
1116
            log.warning("Checker for %(name)s crashed?", vars(self))
1084
1117
        return False
1085
1118
 
1086
1119
    def checked_ok(self):
1120
1153
        # should be.
1121
1154
 
1122
1155
        if self.checker is not None and not self.checker.is_alive():
1123
 
            logger.warning("Checker was not alive; joining")
 
1156
            log.warning("Checker was not alive; joining")
1124
1157
            self.checker.join()
1125
1158
            self.checker = None
1126
1159
        # Start a new checker if needed
1127
1160
        if self.checker is None:
1128
1161
            # Escape attributes for the shell
1129
1162
            escaped_attrs = {
1130
 
                attr: re.escape(str(getattr(self, attr)))
 
1163
                attr: shlex.quote(str(getattr(self, attr)))
1131
1164
                for attr in self.runtime_expansions}
1132
1165
            try:
1133
1166
                command = self.checker_command % escaped_attrs
1134
1167
            except TypeError as error:
1135
 
                logger.error('Could not format string "%s"',
1136
 
                             self.checker_command,
1137
 
                             exc_info=error)
 
1168
                log.error('Could not format string "%s"',
 
1169
                          self.checker_command, exc_info=error)
1138
1170
                return True     # Try again later
1139
1171
            self.current_checker_command = command
1140
 
            logger.info("Starting checker %r for %s", command,
1141
 
                        self.name)
 
1172
            log.info("Starting checker %r for %s", command, self.name)
1142
1173
            # We don't need to redirect stdout and stderr, since
1143
1174
            # in normal mode, that is already done by daemon(),
1144
1175
            # and in debug mode we don't want to.  (Stdin is
1173
1204
            self.checker_callback_tag = None
1174
1205
        if getattr(self, "checker", None) is None:
1175
1206
            return
1176
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
1207
        log.debug("Stopping checker for %(name)s", vars(self))
1177
1208
        self.checker.terminate()
1178
1209
        self.checker = None
1179
1210
 
1206
1237
        func._dbus_name = func.__name__
1207
1238
        if func._dbus_name.endswith("_dbus_property"):
1208
1239
            func._dbus_name = func._dbus_name[:-14]
1209
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
 
1240
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
1210
1241
        return func
1211
1242
 
1212
1243
    return decorator
1301
1332
 
1302
1333
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1303
1334
                         out_signature="s",
1304
 
                         path_keyword='object_path',
1305
 
                         connection_keyword='connection')
 
1335
                         path_keyword="object_path",
 
1336
                         connection_keyword="connection")
1306
1337
    def Introspect(self, object_path, connection):
1307
1338
        """Overloading of standard D-Bus method.
1308
1339
 
1357
1388
            document.unlink()
1358
1389
        except (AttributeError, xml.dom.DOMException,
1359
1390
                xml.parsers.expat.ExpatError) as error:
1360
 
            logger.error("Failed to override Introspection method",
1361
 
                         exc_info=error)
 
1391
            log.error("Failed to override Introspection method",
 
1392
                      exc_info=error)
1362
1393
        return xmlstring
1363
1394
 
1364
1395
 
1461
1492
 
1462
1493
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1463
1494
                         out_signature="s",
1464
 
                         path_keyword='object_path',
1465
 
                         connection_keyword='connection')
 
1495
                         path_keyword="object_path",
 
1496
                         connection_keyword="connection")
1466
1497
    def Introspect(self, object_path, connection):
1467
1498
        """Overloading of standard D-Bus method.
1468
1499
 
1524
1555
            document.unlink()
1525
1556
        except (AttributeError, xml.dom.DOMException,
1526
1557
                xml.parsers.expat.ExpatError) as error:
1527
 
            logger.error("Failed to override Introspection method",
1528
 
                         exc_info=error)
 
1558
            log.error("Failed to override Introspection method",
 
1559
                      exc_info=error)
1529
1560
        return xmlstring
1530
1561
 
1531
1562
 
1563
1594
 
1564
1595
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1565
1596
                         out_signature="s",
1566
 
                         path_keyword='object_path',
1567
 
                         connection_keyword='connection')
 
1597
                         path_keyword="object_path",
 
1598
                         connection_keyword="connection")
1568
1599
    def Introspect(self, object_path, connection):
1569
1600
        """Overloading of standard D-Bus method.
1570
1601
 
1595
1626
            document.unlink()
1596
1627
        except (AttributeError, xml.dom.DOMException,
1597
1628
                xml.parsers.expat.ExpatError) as error:
1598
 
            logger.error("Failed to override Introspection method",
1599
 
                         exc_info=error)
 
1629
            log.error("Failed to override Introspection method",
 
1630
                      exc_info=error)
1600
1631
        return xmlstring
1601
1632
 
1602
1633
 
2236
2267
class ProxyClient:
2237
2268
    def __init__(self, child_pipe, key_id, fpr, address):
2238
2269
        self._pipe = child_pipe
2239
 
        self._pipe.send(('init', key_id, fpr, address))
 
2270
        self._pipe.send(("init", key_id, fpr, address))
2240
2271
        if not self._pipe.recv():
2241
2272
            raise KeyError(key_id or fpr)
2242
2273
 
2243
2274
    def __getattribute__(self, name):
2244
 
        if name == '_pipe':
 
2275
        if name == "_pipe":
2245
2276
            return super(ProxyClient, self).__getattribute__(name)
2246
 
        self._pipe.send(('getattr', name))
 
2277
        self._pipe.send(("getattr", name))
2247
2278
        data = self._pipe.recv()
2248
 
        if data[0] == 'data':
 
2279
        if data[0] == "data":
2249
2280
            return data[1]
2250
 
        if data[0] == 'function':
 
2281
        if data[0] == "function":
2251
2282
 
2252
2283
            def func(*args, **kwargs):
2253
 
                self._pipe.send(('funcall', name, args, kwargs))
 
2284
                self._pipe.send(("funcall", name, args, kwargs))
2254
2285
                return self._pipe.recv()[1]
2255
2286
 
2256
2287
            return func
2257
2288
 
2258
2289
    def __setattr__(self, name, value):
2259
 
        if name == '_pipe':
 
2290
        if name == "_pipe":
2260
2291
            return super(ProxyClient, self).__setattr__(name, value)
2261
 
        self._pipe.send(('setattr', name, value))
 
2292
        self._pipe.send(("setattr", name, value))
2262
2293
 
2263
2294
 
2264
2295
class ClientHandler(socketserver.BaseRequestHandler, object):
2269
2300
 
2270
2301
    def handle(self):
2271
2302
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2272
 
            logger.info("TCP connection from: %s",
2273
 
                        str(self.client_address))
2274
 
            logger.debug("Pipe FD: %d",
2275
 
                         self.server.child_pipe.fileno())
 
2303
            log.info("TCP connection from: %s",
 
2304
                     str(self.client_address))
 
2305
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2276
2306
 
2277
2307
            session = gnutls.ClientSession(self.request)
2278
2308
 
2279
 
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2309
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
2280
2310
            #                       "+AES-256-CBC", "+SHA1",
2281
2311
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2282
2312
            #                       "+DHE-DSS"))
2284
2314
            priority = self.server.gnutls_priority
2285
2315
            if priority is None:
2286
2316
                priority = "NORMAL"
2287
 
            gnutls.priority_set_direct(session._c_object,
2288
 
                                       priority.encode("utf-8"),
2289
 
                                       None)
 
2317
            gnutls.priority_set_direct(session,
 
2318
                                       priority.encode("utf-8"), None)
2290
2319
 
2291
2320
            # Start communication using the Mandos protocol
2292
2321
            # Get protocol number
2293
2322
            line = self.request.makefile().readline()
2294
 
            logger.debug("Protocol version: %r", line)
 
2323
            log.debug("Protocol version: %r", line)
2295
2324
            try:
2296
2325
                if int(line.strip().split()[0]) > 1:
2297
2326
                    raise RuntimeError(line)
2298
2327
            except (ValueError, IndexError, RuntimeError) as error:
2299
 
                logger.error("Unknown protocol version: %s", error)
 
2328
                log.error("Unknown protocol version: %s", error)
2300
2329
                return
2301
2330
 
2302
2331
            # Start GnuTLS connection
2303
2332
            try:
2304
2333
                session.handshake()
2305
2334
            except gnutls.Error as error:
2306
 
                logger.warning("Handshake failed: %s", error)
 
2335
                log.warning("Handshake failed: %s", error)
2307
2336
                # Do not run session.bye() here: the session is not
2308
2337
                # established.  Just abandon the request.
2309
2338
                return
2310
 
            logger.debug("Handshake succeeded")
 
2339
            log.debug("Handshake succeeded")
2311
2340
 
2312
2341
            approval_required = False
2313
2342
            try:
2317
2346
                        key_id = self.key_id(
2318
2347
                            self.peer_certificate(session))
2319
2348
                    except (TypeError, gnutls.Error) as error:
2320
 
                        logger.warning("Bad certificate: %s", error)
 
2349
                        log.warning("Bad certificate: %s", error)
2321
2350
                        return
2322
 
                    logger.debug("Key ID: %s", key_id)
 
2351
                    log.debug("Key ID: %s",
 
2352
                              key_id.decode("utf-8",
 
2353
                                            errors="replace"))
2323
2354
 
2324
2355
                else:
2325
2356
                    key_id = b""
2327
2358
                        fpr = self.fingerprint(
2328
2359
                            self.peer_certificate(session))
2329
2360
                    except (TypeError, gnutls.Error) as error:
2330
 
                        logger.warning("Bad certificate: %s", error)
 
2361
                        log.warning("Bad certificate: %s", error)
2331
2362
                        return
2332
 
                    logger.debug("Fingerprint: %s", fpr)
 
2363
                    log.debug("Fingerprint: %s", fpr)
2333
2364
 
2334
2365
                try:
2335
2366
                    client = ProxyClient(child_pipe, key_id, fpr,
2344
2375
 
2345
2376
                while True:
2346
2377
                    if not client.enabled:
2347
 
                        logger.info("Client %s is disabled",
2348
 
                                    client.name)
 
2378
                        log.info("Client %s is disabled", client.name)
2349
2379
                        if self.server.use_dbus:
2350
2380
                            # Emit D-Bus signal
2351
2381
                            client.Rejected("Disabled")
2355
2385
                        # We are approved or approval is disabled
2356
2386
                        break
2357
2387
                    elif client.approved is None:
2358
 
                        logger.info("Client %s needs approval",
2359
 
                                    client.name)
 
2388
                        log.info("Client %s needs approval",
 
2389
                                 client.name)
2360
2390
                        if self.server.use_dbus:
2361
2391
                            # Emit D-Bus signal
2362
2392
                            client.NeedApproval(
2363
2393
                                client.approval_delay.total_seconds()
2364
2394
                                * 1000, client.approved_by_default)
2365
2395
                    else:
2366
 
                        logger.warning("Client %s was not approved",
2367
 
                                       client.name)
 
2396
                        log.warning("Client %s was not approved",
 
2397
                                    client.name)
2368
2398
                        if self.server.use_dbus:
2369
2399
                            # Emit D-Bus signal
2370
2400
                            client.Rejected("Denied")
2378
2408
                    time2 = datetime.datetime.now()
2379
2409
                    if (time2 - time) >= delay:
2380
2410
                        if not client.approved_by_default:
2381
 
                            logger.warning("Client %s timed out while"
2382
 
                                           " waiting for approval",
2383
 
                                           client.name)
 
2411
                            log.warning("Client %s timed out while"
 
2412
                                        " waiting for approval",
 
2413
                                        client.name)
2384
2414
                            if self.server.use_dbus:
2385
2415
                                # Emit D-Bus signal
2386
2416
                                client.Rejected("Approval timed out")
2393
2423
                try:
2394
2424
                    session.send(client.secret)
2395
2425
                except gnutls.Error as error:
2396
 
                    logger.warning("gnutls send failed",
2397
 
                                   exc_info=error)
 
2426
                    log.warning("gnutls send failed", exc_info=error)
2398
2427
                    return
2399
2428
 
2400
 
                logger.info("Sending secret to %s", client.name)
 
2429
                log.info("Sending secret to %s", client.name)
2401
2430
                # bump the timeout using extended_timeout
2402
2431
                client.bump_timeout(client.extended_timeout)
2403
2432
                if self.server.use_dbus:
2410
2439
                try:
2411
2440
                    session.bye()
2412
2441
                except gnutls.Error as error:
2413
 
                    logger.warning("GnuTLS bye failed",
2414
 
                                   exc_info=error)
 
2442
                    log.warning("GnuTLS bye failed", exc_info=error)
2415
2443
 
2416
2444
    @staticmethod
2417
2445
    def peer_certificate(session):
2418
2446
        "Return the peer's certificate as a bytestring"
2419
2447
        try:
2420
 
            cert_type = gnutls.certificate_type_get2(session._c_object,
2421
 
                                                     gnutls.CTYPE_PEERS)
 
2448
            cert_type = gnutls.certificate_type_get2(
 
2449
                session, gnutls.CTYPE_PEERS)
2422
2450
        except AttributeError:
2423
 
            cert_type = gnutls.certificate_type_get(session._c_object)
 
2451
            cert_type = gnutls.certificate_type_get(session)
2424
2452
        if gnutls.has_rawpk:
2425
2453
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2426
2454
        else:
2427
2455
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2428
2456
        # If not a valid certificate type...
2429
2457
        if cert_type not in valid_cert_types:
2430
 
            logger.info("Cert type %r not in %r", cert_type,
2431
 
                        valid_cert_types)
 
2458
            log.info("Cert type %r not in %r", cert_type,
 
2459
                     valid_cert_types)
2432
2460
            # ...return invalid data
2433
2461
            return b""
2434
2462
        list_size = ctypes.c_uint(1)
2435
2463
        cert_list = (gnutls.certificate_get_peers
2436
 
                     (session._c_object, ctypes.byref(list_size)))
 
2464
                     (session, ctypes.byref(list_size)))
2437
2465
        if not bool(cert_list) and list_size.value != 0:
2438
2466
            raise gnutls.Error("error getting peer certificate")
2439
2467
        if list_size.value == 0:
2461
2489
        buf = ctypes.create_string_buffer(32)
2462
2490
        buf_len = ctypes.c_size_t(len(buf))
2463
2491
        # Get the key ID from the raw public key into the buffer
2464
 
        gnutls.pubkey_get_key_id(pubkey,
2465
 
                                 gnutls.KEYID_USE_SHA256,
2466
 
                                 ctypes.cast(ctypes.byref(buf),
2467
 
                                             ctypes.POINTER(ctypes.c_ubyte)),
2468
 
                                 ctypes.byref(buf_len))
 
2492
        gnutls.pubkey_get_key_id(
 
2493
            pubkey,
 
2494
            gnutls.KEYID_USE_SHA256,
 
2495
            ctypes.cast(ctypes.byref(buf),
 
2496
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2497
            ctypes.byref(buf_len))
2469
2498
        # Deinit the certificate
2470
2499
        gnutls.pubkey_deinit(pubkey)
2471
2500
 
2552
2581
 
2553
2582
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2554
2583
                     socketserver.TCPServer):
2555
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
2584
    """IPv6-capable TCP server.  Accepts None as address and/or port
2556
2585
 
2557
2586
    Attributes:
2558
2587
        enabled:        Boolean; whether this server is activated yet
2609
2638
            if SO_BINDTODEVICE is None:
2610
2639
                # Fall back to a hard-coded value which seems to be
2611
2640
                # common enough.
2612
 
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2641
                log.warning("SO_BINDTODEVICE not found, trying 25")
2613
2642
                SO_BINDTODEVICE = 25
2614
2643
            try:
2615
2644
                self.socket.setsockopt(
2617
2646
                    (self.interface + "\0").encode("utf-8"))
2618
2647
            except socket.error as error:
2619
2648
                if error.errno == errno.EPERM:
2620
 
                    logger.error("No permission to bind to"
2621
 
                                 " interface %s", self.interface)
 
2649
                    log.error("No permission to bind to interface %s",
 
2650
                              self.interface)
2622
2651
                elif error.errno == errno.ENOPROTOOPT:
2623
 
                    logger.error("SO_BINDTODEVICE not available;"
2624
 
                                 " cannot bind to interface %s",
2625
 
                                 self.interface)
 
2652
                    log.error("SO_BINDTODEVICE not available; cannot"
 
2653
                              " bind to interface %s", self.interface)
2626
2654
                elif error.errno == errno.ENODEV:
2627
 
                    logger.error("Interface %s does not exist,"
2628
 
                                 " cannot bind", self.interface)
 
2655
                    log.error("Interface %s does not exist, cannot"
 
2656
                              " bind", self.interface)
2629
2657
                else:
2630
2658
                    raise
2631
2659
        # Only bind(2) the socket if we really need to.
2710
2738
        request = parent_pipe.recv()
2711
2739
        command = request[0]
2712
2740
 
2713
 
        if command == 'init':
 
2741
        if command == "init":
2714
2742
            key_id = request[1].decode("ascii")
2715
2743
            fpr = request[2].decode("ascii")
2716
2744
            address = request[3]
2717
2745
 
2718
2746
            for c in self.clients.values():
2719
 
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
 
2747
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
 
2748
                              "27AE41E4649B934CA495991B7852B855"):
2720
2749
                    continue
2721
2750
                if key_id and c.key_id == key_id:
2722
2751
                    client = c
2725
2754
                    client = c
2726
2755
                    break
2727
2756
            else:
2728
 
                logger.info("Client not found for key ID: %s, address"
2729
 
                            ": %s", key_id or fpr, address)
 
2757
                log.info("Client not found for key ID: %s, address:"
 
2758
                         " %s", key_id or fpr, address)
2730
2759
                if self.use_dbus:
2731
2760
                    # Emit D-Bus signal
2732
2761
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2745
2774
            # remove the old hook in favor of the new above hook on
2746
2775
            # same fileno
2747
2776
            return False
2748
 
        if command == 'funcall':
 
2777
        if command == "funcall":
2749
2778
            funcname = request[1]
2750
2779
            args = request[2]
2751
2780
            kwargs = request[3]
2752
2781
 
2753
 
            parent_pipe.send(('data', getattr(client_object,
 
2782
            parent_pipe.send(("data", getattr(client_object,
2754
2783
                                              funcname)(*args,
2755
2784
                                                        **kwargs)))
2756
2785
 
2757
 
        if command == 'getattr':
 
2786
        if command == "getattr":
2758
2787
            attrname = request[1]
2759
2788
            if isinstance(client_object.__getattribute__(attrname),
2760
2789
                          collections.abc.Callable):
2761
 
                parent_pipe.send(('function', ))
 
2790
                parent_pipe.send(("function", ))
2762
2791
            else:
2763
2792
                parent_pipe.send((
2764
 
                    'data', client_object.__getattribute__(attrname)))
 
2793
                    "data", client_object.__getattribute__(attrname)))
2765
2794
 
2766
 
        if command == 'setattr':
 
2795
        if command == "setattr":
2767
2796
            attrname = request[1]
2768
2797
            value = request[2]
2769
2798
            setattr(client_object, attrname, value)
2774
2803
def rfc3339_duration_to_delta(duration):
2775
2804
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2776
2805
 
2777
 
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2778
 
    True
2779
 
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2780
 
    True
2781
 
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2782
 
    True
2783
 
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2784
 
    True
2785
 
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2786
 
    True
2787
 
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2788
 
    True
2789
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2790
 
    True
 
2806
    >>> timedelta = datetime.timedelta
 
2807
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
 
2808
    True
 
2809
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
 
2810
    True
 
2811
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
 
2812
    True
 
2813
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
 
2814
    True
 
2815
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
 
2816
    True
 
2817
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
 
2818
    True
 
2819
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
 
2820
    True
 
2821
    >>> del timedelta
2791
2822
    """
2792
2823
 
2793
2824
    # Parsing an RFC 3339 duration with regular expressions is not
2873
2904
def string_to_delta(interval):
2874
2905
    """Parse a string and return a datetime.timedelta
2875
2906
 
2876
 
    >>> string_to_delta('7d') == datetime.timedelta(7)
2877
 
    True
2878
 
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
2879
 
    True
2880
 
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2881
 
    True
2882
 
    >>> string_to_delta('24h') == datetime.timedelta(1)
2883
 
    True
2884
 
    >>> string_to_delta('1w') == datetime.timedelta(7)
2885
 
    True
2886
 
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
 
2907
    >>> string_to_delta("7d") == datetime.timedelta(7)
 
2908
    True
 
2909
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
 
2910
    True
 
2911
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
 
2912
    True
 
2913
    >>> string_to_delta("24h") == datetime.timedelta(1)
 
2914
    True
 
2915
    >>> string_to_delta("1w") == datetime.timedelta(7)
 
2916
    True
 
2917
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2887
2918
    True
2888
2919
    """
2889
2920
 
3093
3124
 
3094
3125
    if server_settings["servicename"] != "Mandos":
3095
3126
        syslogger.setFormatter(
3096
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
3097
 
                              ' %(levelname)s: %(message)s'.format(
 
3127
            logging.Formatter("Mandos ({}) [%(process)d]:"
 
3128
                              " %(levelname)s: %(message)s".format(
3098
3129
                                  server_settings["servicename"])))
3099
3130
 
3100
3131
    # Parse config file with clients
3124
3155
        try:
3125
3156
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3126
3157
        except IOError as e:
3127
 
            logger.error("Could not open file %r", pidfilename,
3128
 
                         exc_info=e)
 
3158
            log.error("Could not open file %r", pidfilename,
 
3159
                      exc_info=e)
3129
3160
 
3130
3161
    for name, group in (("_mandos", "_mandos"),
3131
3162
                        ("mandos", "mandos"),
3142
3173
    try:
3143
3174
        os.setgid(gid)
3144
3175
        os.setuid(uid)
3145
 
        if debug:
3146
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3147
 
                                                             gid))
 
3176
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
3148
3177
    except OSError as error:
3149
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
3150
 
                       .format(uid, gid, os.strerror(error.errno)))
 
3178
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
 
3179
                    os.strerror(error.errno))
3151
3180
        if error.errno != errno.EPERM:
3152
3181
            raise
3153
3182
 
3160
3189
 
3161
3190
        @gnutls.log_func
3162
3191
        def debug_gnutls(level, string):
3163
 
            logger.debug("GnuTLS: %s", string[:-1])
 
3192
            log.debug("GnuTLS: %s",
 
3193
                      string[:-1].decode("utf-8", errors="replace"))
3164
3194
 
3165
3195
        gnutls.global_set_log_function(debug_gnutls)
3166
3196
 
3195
3225
                "se.bsnet.fukt.Mandos", bus,
3196
3226
                do_not_queue=True)
3197
3227
        except dbus.exceptions.DBusException as e:
3198
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
3228
            log.error("Disabling D-Bus:", exc_info=e)
3199
3229
            use_dbus = False
3200
3230
            server_settings["use_dbus"] = False
3201
3231
            tcp_server.use_dbus = False
3286
3316
            os.remove(stored_state_path)
3287
3317
        except IOError as e:
3288
3318
            if e.errno == errno.ENOENT:
3289
 
                logger.warning("Could not load persistent state:"
3290
 
                               " {}".format(os.strerror(e.errno)))
 
3319
                log.warning("Could not load persistent state:"
 
3320
                            " %s", os.strerror(e.errno))
3291
3321
            else:
3292
 
                logger.critical("Could not load persistent state:",
3293
 
                                exc_info=e)
 
3322
                log.critical("Could not load persistent state:",
 
3323
                             exc_info=e)
3294
3324
                raise
3295
3325
        except EOFError as e:
3296
 
            logger.warning("Could not load persistent state: "
3297
 
                           "EOFError:",
3298
 
                           exc_info=e)
 
3326
            log.warning("Could not load persistent state: EOFError:",
 
3327
                        exc_info=e)
3299
3328
 
3300
3329
    with PGPEngine() as pgp:
3301
3330
        for client_name, client in clients_data.items():
3328
3357
            if client["enabled"]:
3329
3358
                if datetime.datetime.utcnow() >= client["expires"]:
3330
3359
                    if not client["last_checked_ok"]:
3331
 
                        logger.warning(
3332
 
                            "disabling client {} - Client never "
3333
 
                            "performed a successful checker".format(
3334
 
                                client_name))
 
3360
                        log.warning("disabling client %s - Client"
 
3361
                                    " never performed a successful"
 
3362
                                    " checker", client_name)
3335
3363
                        client["enabled"] = False
3336
3364
                    elif client["last_checker_status"] != 0:
3337
 
                        logger.warning(
3338
 
                            "disabling client {} - Client last"
3339
 
                            " checker failed with error code"
3340
 
                            " {}".format(
3341
 
                                client_name,
3342
 
                                client["last_checker_status"]))
 
3365
                        log.warning("disabling client %s - Client"
 
3366
                                    " last checker failed with error"
 
3367
                                    " code %s", client_name,
 
3368
                                    client["last_checker_status"])
3343
3369
                        client["enabled"] = False
3344
3370
                    else:
3345
3371
                        client["expires"] = (
3346
3372
                            datetime.datetime.utcnow()
3347
3373
                            + client["timeout"])
3348
 
                        logger.debug("Last checker succeeded,"
3349
 
                                     " keeping {} enabled".format(
3350
 
                                         client_name))
 
3374
                        log.debug("Last checker succeeded, keeping %s"
 
3375
                                  " enabled", client_name)
3351
3376
            try:
3352
3377
                client["secret"] = pgp.decrypt(
3353
3378
                    client["encrypted_secret"],
3354
3379
                    client_settings[client_name]["secret"])
3355
3380
            except PGPError:
3356
3381
                # If decryption fails, we use secret from new settings
3357
 
                logger.debug("Failed to decrypt {} old secret".format(
3358
 
                    client_name))
 
3382
                log.debug("Failed to decrypt %s old secret",
 
3383
                          client_name)
3359
3384
                client["secret"] = (client_settings[client_name]
3360
3385
                                    ["secret"])
3361
3386
 
3375
3400
            server_settings=server_settings)
3376
3401
 
3377
3402
    if not tcp_server.clients:
3378
 
        logger.warning("No clients defined")
 
3403
        log.warning("No clients defined")
3379
3404
 
3380
3405
    if not foreground:
3381
3406
        if pidfile is not None:
3384
3409
                with pidfile:
3385
3410
                    print(pid, file=pidfile)
3386
3411
            except IOError:
3387
 
                logger.error("Could not write to file %r with PID %d",
3388
 
                             pidfilename, pid)
 
3412
                log.error("Could not write to file %r with PID %d",
 
3413
                          pidfilename, pid)
3389
3414
        del pidfile
3390
3415
        del pidfilename
3391
3416
 
3541
3566
 
3542
3567
        try:
3543
3568
            with tempfile.NamedTemporaryFile(
3544
 
                    mode='wb',
 
3569
                    mode="wb",
3545
3570
                    suffix=".pickle",
3546
 
                    prefix='clients-',
 
3571
                    prefix="clients-",
3547
3572
                    dir=os.path.dirname(stored_state_path),
3548
3573
                    delete=False) as stored_state:
3549
3574
                pickle.dump((clients, client_settings), stored_state,
3557
3582
                except NameError:
3558
3583
                    pass
3559
3584
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3560
 
                logger.warning("Could not save persistent state: {}"
3561
 
                               .format(os.strerror(e.errno)))
 
3585
                log.warning("Could not save persistent state: %s",
 
3586
                            os.strerror(e.errno))
3562
3587
            else:
3563
 
                logger.warning("Could not save persistent state:",
3564
 
                               exc_info=e)
 
3588
                log.warning("Could not save persistent state:",
 
3589
                            exc_info=e)
3565
3590
                raise
3566
3591
 
3567
3592
        # Delete all clients, and settings from config
3593
3618
    if zeroconf:
3594
3619
        service.port = tcp_server.socket.getsockname()[1]
3595
3620
    if use_ipv6:
3596
 
        logger.info("Now listening on address %r, port %d,"
3597
 
                    " flowinfo %d, scope_id %d",
3598
 
                    *tcp_server.socket.getsockname())
 
3621
        log.info("Now listening on address %r, port %d, flowinfo %d,"
 
3622
                 " scope_id %d", *tcp_server.socket.getsockname())
3599
3623
    else:                       # IPv4
3600
 
        logger.info("Now listening on address %r, port %d",
3601
 
                    *tcp_server.socket.getsockname())
 
3624
        log.info("Now listening on address %r, port %d",
 
3625
                 *tcp_server.socket.getsockname())
3602
3626
 
3603
3627
    # service.interface = tcp_server.socket.getsockname()[3]
3604
3628
 
3608
3632
            try:
3609
3633
                service.activate()
3610
3634
            except dbus.exceptions.DBusException as error:
3611
 
                logger.critical("D-Bus Exception", exc_info=error)
 
3635
                log.critical("D-Bus Exception", exc_info=error)
3612
3636
                cleanup()
3613
3637
                sys.exit(1)
3614
3638
            # End of Avahi example code
3619
3643
            lambda *args, **kwargs: (tcp_server.handle_request
3620
3644
                                     (*args[2:], **kwargs) or True))
3621
3645
 
3622
 
        logger.debug("Starting main loop")
 
3646
        log.debug("Starting main loop")
3623
3647
        main_loop.run()
3624
3648
    except AvahiError as error:
3625
 
        logger.critical("Avahi Error", exc_info=error)
 
3649
        log.critical("Avahi Error", exc_info=error)
3626
3650
        cleanup()
3627
3651
        sys.exit(1)
3628
3652
    except KeyboardInterrupt:
3629
3653
        if debug:
3630
3654
            print("", file=sys.stderr)
3631
 
        logger.debug("Server received KeyboardInterrupt")
3632
 
    logger.debug("Server exiting")
 
3655
        log.debug("Server received KeyboardInterrupt")
 
3656
    log.debug("Server exiting")
3633
3657
    # Must run before the D-Bus bus name gets deregistered
3634
3658
    cleanup()
3635
3659
 
3636
3660
 
3637
 
def should_only_run_tests():
 
3661
def parse_test_args():
 
3662
    # type: () -> argparse.Namespace
3638
3663
    parser = argparse.ArgumentParser(add_help=False)
3639
 
    parser.add_argument("--check", action='store_true')
 
3664
    parser.add_argument("--check", action="store_true")
 
3665
    parser.add_argument("--prefix", )
3640
3666
    args, unknown_args = parser.parse_known_args()
3641
 
    run_tests = args.check
3642
 
    if run_tests:
3643
 
        # Remove --check argument from sys.argv
 
3667
    if args.check:
 
3668
        # Remove test options from sys.argv
3644
3669
        sys.argv[1:] = unknown_args
3645
 
    return run_tests
 
3670
    return args
3646
3671
 
3647
3672
# Add all tests from doctest strings
3648
3673
def load_tests(loader, tests, none):
3650
3675
    tests.addTests(doctest.DocTestSuite())
3651
3676
    return tests
3652
3677
 
3653
 
if __name__ == '__main__':
 
3678
if __name__ == "__main__":
 
3679
    options = parse_test_args()
3654
3680
    try:
3655
 
        if should_only_run_tests():
3656
 
            # Call using ./mandos --check [--verbose]
3657
 
            unittest.main()
 
3681
        if options.check:
 
3682
            extra_test_prefix = options.prefix
 
3683
            if extra_test_prefix is not None:
 
3684
                if not (unittest.main(argv=[""], exit=False)
 
3685
                        .result.wasSuccessful()):
 
3686
                    sys.exit(1)
 
3687
                class ExtraTestLoader(unittest.TestLoader):
 
3688
                    testMethodPrefix = extra_test_prefix
 
3689
                # Call using ./scriptname --test [--verbose]
 
3690
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
 
3691
            else:
 
3692
                unittest.main(argv=[""])
3658
3693
        else:
3659
3694
            main()
3660
3695
    finally:
3661
3696
        logging.shutdown()
 
3697
 
 
3698
# Local Variables:
 
3699
# run-tests:
 
3700
# (lambda (&optional extra)
 
3701
#   (if (not (funcall run-tests-in-test-buffer default-directory
 
3702
#             extra))
 
3703
#       (funcall show-test-buffer-in-test-window)
 
3704
#     (funcall remove-test-window)
 
3705
#     (if extra (message "Extra tests run successfully!"))))
 
3706
# run-tests-in-test-buffer:
 
3707
# (lambda (dir &optional extra)
 
3708
#   (with-current-buffer (get-buffer-create "*Test*")
 
3709
#     (setq buffer-read-only nil
 
3710
#           default-directory dir)
 
3711
#     (erase-buffer)
 
3712
#     (compilation-mode))
 
3713
#   (let ((process-result
 
3714
#          (let ((inhibit-read-only t))
 
3715
#            (process-file-shell-command
 
3716
#             (funcall get-command-line extra) nil "*Test*"))))
 
3717
#     (and (numberp process-result)
 
3718
#          (= process-result 0))))
 
3719
# get-command-line:
 
3720
# (lambda (&optional extra)
 
3721
#   (let ((quoted-script
 
3722
#          (shell-quote-argument (funcall get-script-name))))
 
3723
#     (format
 
3724
#      (concat "%s --check" (if extra " --prefix=atest" ""))
 
3725
#      quoted-script)))
 
3726
# get-script-name:
 
3727
# (lambda ()
 
3728
#   (if (fboundp 'file-local-name)
 
3729
#       (file-local-name (buffer-file-name))
 
3730
#     (or (file-remote-p (buffer-file-name) 'localname)
 
3731
#         (buffer-file-name))))
 
3732
# remove-test-window:
 
3733
# (lambda ()
 
3734
#   (let ((test-window (get-buffer-window "*Test*")))
 
3735
#     (if test-window (delete-window test-window))))
 
3736
# show-test-buffer-in-test-window:
 
3737
# (lambda ()
 
3738
#   (when (not (get-buffer-window-list "*Test*"))
 
3739
#     (setq next-error-last-buffer (get-buffer "*Test*"))
 
3740
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
 
3741
#            (display-buffer-overriding-action
 
3742
#             `((display-buffer-in-side-window) (side . ,side)
 
3743
#               (window-height . fit-window-to-buffer)
 
3744
#               (window-width . fit-window-to-buffer))))
 
3745
#       (display-buffer "*Test*"))))
 
3746
# eval:
 
3747
# (progn
 
3748
#   (let* ((run-extra-tests (lambda () (interactive)
 
3749
#                             (funcall run-tests t)))
 
3750
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
 
3751
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
 
3752
#     (setq minor-mode-overriding-map-alist
 
3753
#           (cons `(run-tests . ,outer-keymap)
 
3754
#                 minor-mode-overriding-map-alist)))
 
3755
#   (add-hook 'after-save-hook run-tests 90 t))
 
3756
# End: