/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 at recompile
  • Date: 2019-12-04 23:52:20 UTC
  • Revision ID: teddy@recompile.se-20191204235220-yn88brp0scmqwy2t
Remove non-project-specific pattern from .bzrignore

Only project-specific patterns should be in the .bzrignore file.
Other generic patterns should be in the ~/.config/breezy/ignore and
~/.bazaar/ignore files.

* .bzrignore (.tramp_history): Remove.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python3 -bI
2
 
# -*- coding: utf-8; lexical-binding: t -*-
 
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 -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
5
#
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2022 Teddy Hogeborn
15
 
# Copyright © 2008-2022 Björn Påhlsson
 
14
# Copyright © 2008-2019 Teddy Hogeborn
 
15
# Copyright © 2008-2019 Björn Påhlsson
16
16
#
17
17
# This file is part of Mandos.
18
18
#
31
31
#
32
32
# Contact the authors at <mandos@recompile.se>.
33
33
#
 
34
 
34
35
from __future__ import (division, absolute_import, print_function,
35
36
                        unicode_literals)
36
37
 
39
40
except ImportError:
40
41
    pass
41
42
 
42
 
import sys
43
 
import unittest
44
 
import argparse
45
 
import logging
46
 
import os
47
43
try:
48
44
    import SocketServer as socketserver
49
45
except ImportError:
50
46
    import socketserver
51
47
import socket
 
48
import argparse
52
49
import datetime
53
50
import errno
54
51
try:
55
52
    import ConfigParser as configparser
56
53
except ImportError:
57
54
    import configparser
 
55
import sys
58
56
import re
 
57
import os
59
58
import signal
60
59
import subprocess
61
60
import atexit
62
61
import stat
 
62
import logging
63
63
import logging.handlers
64
64
import pwd
65
65
import contextlib
77
77
import itertools
78
78
import collections
79
79
import codecs
80
 
import random
81
 
import shlex
 
80
import unittest
82
81
 
83
82
import dbus
84
83
import dbus.service
93
92
if sys.version_info.major == 2:
94
93
    __metaclass__ = type
95
94
    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
95
 
113
96
# Show warnings by default
114
97
if not sys.warnoptions:
143
126
if sys.version_info < (3, 2):
144
127
    configparser.Configparser = configparser.SafeConfigParser
145
128
 
146
 
version = "1.8.16"
 
129
version = "1.8.9"
147
130
stored_state_file = "clients.pickle"
148
131
 
149
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
132
logger = logging.getLogger()
150
133
logging.captureWarnings(True)   # Show warnings via the logging system
151
134
syslogger = None
152
135
 
189
172
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
190
173
        address="/dev/log"))
191
174
    syslogger.setFormatter(logging.Formatter
192
 
                           ("Mandos [%(process)d]: %(levelname)s:"
193
 
                            " %(message)s"))
194
 
    log.addHandler(syslogger)
 
175
                           ('Mandos [%(process)d]: %(levelname)s:'
 
176
                            ' %(message)s'))
 
177
    logger.addHandler(syslogger)
195
178
 
196
179
    if debug:
197
180
        console = logging.StreamHandler()
198
 
        console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
199
 
                                               " [%(process)d]:"
200
 
                                               " %(levelname)s:"
201
 
                                               " %(message)s"))
202
 
        log.addHandler(console)
203
 
    log.setLevel(level)
 
181
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
182
                                               ' [%(process)d]:'
 
183
                                               ' %(levelname)s:'
 
184
                                               ' %(message)s'))
 
185
        logger.addHandler(console)
 
186
    logger.setLevel(level)
204
187
 
205
188
 
206
189
class PGPError(Exception):
224
207
        except OSError as e:
225
208
            if e.errno != errno.ENOENT:
226
209
                raise
227
 
        self.gnupgargs = ["--batch",
228
 
                          "--homedir", self.tempdir,
229
 
                          "--force-mdc",
230
 
                          "--quiet"]
 
210
        self.gnupgargs = ['--batch',
 
211
                          '--homedir', self.tempdir,
 
212
                          '--force-mdc',
 
213
                          '--quiet']
231
214
        # Only GPG version 1 has the --no-use-agent option.
232
215
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
233
216
            self.gnupgargs.append("--no-use-agent")
272
255
                dir=self.tempdir) as passfile:
273
256
            passfile.write(passphrase)
274
257
            passfile.flush()
275
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
276
 
                                     "--passphrase-file",
 
258
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
259
                                     '--passphrase-file',
277
260
                                     passfile.name]
278
261
                                    + self.gnupgargs,
279
262
                                    stdin=subprocess.PIPE,
290
273
                dir=self.tempdir) as passfile:
291
274
            passfile.write(passphrase)
292
275
            passfile.flush()
293
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
294
 
                                     "--passphrase-file",
 
276
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
277
                                     '--passphrase-file',
295
278
                                     passfile.name]
296
279
                                    + self.gnupgargs,
297
280
                                    stdin=subprocess.PIPE,
350
333
    Attributes:
351
334
    interface: integer; avahi.IF_UNSPEC or an interface index.
352
335
               Used to optionally bind to the specified interface.
353
 
    name: string; Example: "Mandos"
354
 
    type: string; Example: "_mandos._tcp".
 
336
    name: string; Example: 'Mandos'
 
337
    type: string; Example: '_mandos._tcp'.
355
338
     See <https://www.iana.org/assignments/service-names-port-numbers>
356
339
    port: integer; what port to announce
357
340
    TXT: list of strings; TXT record for the service
394
377
    def rename(self, remove=True):
395
378
        """Derived from the Avahi example code"""
396
379
        if self.rename_count >= self.max_renames:
397
 
            log.critical("No suitable Zeroconf service name found"
398
 
                         " after %i retries, exiting.",
399
 
                         self.rename_count)
 
380
            logger.critical("No suitable Zeroconf service name found"
 
381
                            " after %i retries, exiting.",
 
382
                            self.rename_count)
400
383
            raise AvahiServiceError("Too many renames")
401
384
        self.name = str(
402
385
            self.server.GetAlternativeServiceName(self.name))
403
386
        self.rename_count += 1
404
 
        log.info("Changing Zeroconf service name to %r ...",
405
 
                 self.name)
 
387
        logger.info("Changing Zeroconf service name to %r ...",
 
388
                    self.name)
406
389
        if remove:
407
390
            self.remove()
408
391
        try:
410
393
        except dbus.exceptions.DBusException as error:
411
394
            if (error.get_dbus_name()
412
395
                == "org.freedesktop.Avahi.CollisionError"):
413
 
                log.info("Local Zeroconf service name collision.")
 
396
                logger.info("Local Zeroconf service name collision.")
414
397
                return self.rename(remove=False)
415
398
            else:
416
 
                log.critical("D-Bus Exception", exc_info=error)
 
399
                logger.critical("D-Bus Exception", exc_info=error)
417
400
                self.cleanup()
418
401
                os._exit(1)
419
402
 
435
418
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
419
        self.entry_group_state_changed_match = (
437
420
            self.group.connect_to_signal(
438
 
                "StateChanged", self.entry_group_state_changed))
439
 
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
440
 
                  self.name, self.type)
 
421
                'StateChanged', self.entry_group_state_changed))
 
422
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
423
                     self.name, self.type)
441
424
        self.group.AddService(
442
425
            self.interface,
443
426
            self.protocol,
450
433
 
451
434
    def entry_group_state_changed(self, state, error):
452
435
        """Derived from the Avahi example code"""
453
 
        log.debug("Avahi entry group state change: %i", state)
 
436
        logger.debug("Avahi entry group state change: %i", state)
454
437
 
455
438
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
 
            log.debug("Zeroconf service established.")
 
439
            logger.debug("Zeroconf service established.")
457
440
        elif state == avahi.ENTRY_GROUP_COLLISION:
458
 
            log.info("Zeroconf service name collision.")
 
441
            logger.info("Zeroconf service name collision.")
459
442
            self.rename()
460
443
        elif state == avahi.ENTRY_GROUP_FAILURE:
461
 
            log.critical("Avahi: Error in group state changed %s",
462
 
                         str(error))
 
444
            logger.critical("Avahi: Error in group state changed %s",
 
445
                            str(error))
463
446
            raise AvahiGroupError("State changed: {!s}".format(error))
464
447
 
465
448
    def cleanup(self):
475
458
 
476
459
    def server_state_changed(self, state, error=None):
477
460
        """Derived from the Avahi example code"""
478
 
        log.debug("Avahi server state change: %i", state)
 
461
        logger.debug("Avahi server state change: %i", state)
479
462
        bad_states = {
480
463
            avahi.SERVER_INVALID: "Zeroconf server invalid",
481
464
            avahi.SERVER_REGISTERING: None,
485
468
        if state in bad_states:
486
469
            if bad_states[state] is not None:
487
470
                if error is None:
488
 
                    log.error(bad_states[state])
 
471
                    logger.error(bad_states[state])
489
472
                else:
490
 
                    log.error(bad_states[state] + ": %r", error)
 
473
                    logger.error(bad_states[state] + ": %r", error)
491
474
            self.cleanup()
492
475
        elif state == avahi.SERVER_RUNNING:
493
476
            try:
495
478
            except dbus.exceptions.DBusException as error:
496
479
                if (error.get_dbus_name()
497
480
                    == "org.freedesktop.Avahi.CollisionError"):
498
 
                    log.info("Local Zeroconf service name collision.")
 
481
                    logger.info("Local Zeroconf service name"
 
482
                                " collision.")
499
483
                    return self.rename(remove=False)
500
484
                else:
501
 
                    log.critical("D-Bus Exception", exc_info=error)
 
485
                    logger.critical("D-Bus Exception", exc_info=error)
502
486
                    self.cleanup()
503
487
                    os._exit(1)
504
488
        else:
505
489
            if error is None:
506
 
                log.debug("Unknown state: %r", state)
 
490
                logger.debug("Unknown state: %r", state)
507
491
            else:
508
 
                log.debug("Unknown state: %r: %r", state, error)
 
492
                logger.debug("Unknown state: %r: %r", state, error)
509
493
 
510
494
    def activate(self):
511
495
        """Derived from the Avahi example code"""
523
507
class AvahiServiceToSyslog(AvahiService):
524
508
    def rename(self, *args, **kwargs):
525
509
        """Add the new name to the syslog messages"""
526
 
        ret = super(AvahiServiceToSyslog, self).rename(*args,
527
 
                                                       **kwargs)
 
510
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
528
511
        syslogger.setFormatter(logging.Formatter(
529
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
512
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
530
513
            .format(self.name)))
531
514
        return ret
532
515
 
562
545
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
563
546
 
564
547
    # Types
565
 
    class _session_int(ctypes.Structure):
 
548
    class session_int(ctypes.Structure):
566
549
        _fields_ = []
567
 
    session_t = ctypes.POINTER(_session_int)
 
550
    session_t = ctypes.POINTER(session_int)
568
551
 
569
552
    class certificate_credentials_st(ctypes.Structure):
570
553
        _fields_ = []
573
556
    certificate_type_t = ctypes.c_int
574
557
 
575
558
    class datum_t(ctypes.Structure):
576
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
 
                    ("size", ctypes.c_uint)]
 
559
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
560
                    ('size', ctypes.c_uint)]
578
561
 
579
 
    class _openpgp_crt_int(ctypes.Structure):
 
562
    class openpgp_crt_int(ctypes.Structure):
580
563
        _fields_ = []
581
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
564
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
565
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
583
566
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
567
    credentials_type_t = ctypes.c_int
593
576
            # gnutls.strerror()
594
577
            self.code = code
595
578
            if message is None and code is not None:
596
 
                message = gnutls.strerror(code).decode(
597
 
                    "utf-8", errors="replace")
 
579
                message = gnutls.strerror(code)
598
580
            return super(gnutls.Error, self).__init__(
599
581
                message, *args)
600
582
 
601
583
    class CertificateSecurityError(Error):
602
584
        pass
603
585
 
604
 
    class PointerTo:
605
 
        def __init__(self, cls):
606
 
            self.cls = cls
607
 
 
608
 
        def from_param(self, obj):
609
 
            if not isinstance(obj, self.cls):
610
 
                raise TypeError("Not of type {}: {!r}"
611
 
                                .format(self.cls.__name__, obj))
612
 
            return ctypes.byref(obj.from_param(obj))
613
 
 
614
 
    class CastToVoidPointer:
615
 
        def __init__(self, cls):
616
 
            self.cls = cls
617
 
 
618
 
        def from_param(self, obj):
619
 
            if not isinstance(obj, self.cls):
620
 
                raise TypeError("Not of type {}: {!r}"
621
 
                                .format(self.cls.__name__, obj))
622
 
            return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
623
 
 
624
 
    class With_from_param:
625
 
        @classmethod
626
 
        def from_param(cls, obj):
627
 
            return obj._as_parameter_
628
 
 
629
586
    # Classes
630
 
    class Credentials(With_from_param):
 
587
    class Credentials:
631
588
        def __init__(self):
632
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
633
 
            gnutls.certificate_allocate_credentials(self)
 
589
            self._c_object = gnutls.certificate_credentials_t()
 
590
            gnutls.certificate_allocate_credentials(
 
591
                ctypes.byref(self._c_object))
634
592
            self.type = gnutls.CRD_CERTIFICATE
635
593
 
636
594
        def __del__(self):
637
 
            gnutls.certificate_free_credentials(self)
 
595
            gnutls.certificate_free_credentials(self._c_object)
638
596
 
639
 
    class ClientSession(With_from_param):
 
597
    class ClientSession:
640
598
        def __init__(self, socket, credentials=None):
641
 
            self._as_parameter_ = gnutls.session_t()
 
599
            self._c_object = gnutls.session_t()
642
600
            gnutls_flags = gnutls.CLIENT
643
601
            if gnutls.check_version(b"3.5.6"):
644
602
                gnutls_flags |= gnutls.NO_TICKETS
645
603
            if gnutls.has_rawpk:
646
604
                gnutls_flags |= gnutls.ENABLE_RAWPK
647
 
            gnutls.init(self, gnutls_flags)
 
605
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
648
606
            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)
 
607
            gnutls.set_default_priority(self._c_object)
 
608
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
609
            gnutls.handshake_set_private_extensions(self._c_object,
 
610
                                                    True)
652
611
            self.socket = socket
653
612
            if credentials is None:
654
613
                credentials = gnutls.Credentials()
655
 
            gnutls.credentials_set(self, credentials.type,
656
 
                                   credentials)
 
614
            gnutls.credentials_set(self._c_object, credentials.type,
 
615
                                   ctypes.cast(credentials._c_object,
 
616
                                               ctypes.c_void_p))
657
617
            self.credentials = credentials
658
618
 
659
619
        def __del__(self):
660
 
            gnutls.deinit(self)
 
620
            gnutls.deinit(self._c_object)
661
621
 
662
622
        def handshake(self):
663
 
            return gnutls.handshake(self)
 
623
            return gnutls.handshake(self._c_object)
664
624
 
665
625
        def send(self, data):
666
626
            data = bytes(data)
667
627
            data_len = len(data)
668
628
            while data_len > 0:
669
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
629
                data_len -= gnutls.record_send(self._c_object,
 
630
                                               data[-data_len:],
670
631
                                               data_len)
671
632
 
672
633
        def bye(self):
673
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
634
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
674
635
 
675
636
    # Error handling functions
676
637
    def _error_code(result):
677
638
        """A function to raise exceptions on errors, suitable
678
 
        for the "restype" attribute on ctypes functions"""
679
 
        if result >= gnutls.E_SUCCESS:
 
639
        for the 'restype' attribute on ctypes functions"""
 
640
        if result >= 0:
680
641
            return result
681
642
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
643
            raise gnutls.CertificateSecurityError(code=result)
683
644
        raise gnutls.Error(code=result)
684
645
 
685
 
    def _retry_on_error(result, func, arguments,
686
 
                        _error_code=_error_code):
 
646
    def _retry_on_error(result, func, arguments):
687
647
        """A function to retry on some errors, suitable
688
 
        for the "errcheck" attribute on ctypes functions"""
689
 
        while result < gnutls.E_SUCCESS:
 
648
        for the 'errcheck' attribute on ctypes functions"""
 
649
        while result < 0:
690
650
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
651
                return _error_code(result)
692
652
            result = func(*arguments)
697
657
 
698
658
    # Functions
699
659
    priority_set_direct = _library.gnutls_priority_set_direct
700
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
660
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
701
661
                                    ctypes.POINTER(ctypes.c_char_p)]
702
662
    priority_set_direct.restype = _error_code
703
663
 
704
664
    init = _library.gnutls_init
705
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
665
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
706
666
    init.restype = _error_code
707
667
 
708
668
    set_default_priority = _library.gnutls_set_default_priority
709
 
    set_default_priority.argtypes = [ClientSession]
 
669
    set_default_priority.argtypes = [session_t]
710
670
    set_default_priority.restype = _error_code
711
671
 
712
672
    record_send = _library.gnutls_record_send
713
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
673
    record_send.argtypes = [session_t, ctypes.c_void_p,
714
674
                            ctypes.c_size_t]
715
675
    record_send.restype = ctypes.c_ssize_t
716
676
    record_send.errcheck = _retry_on_error
718
678
    certificate_allocate_credentials = (
719
679
        _library.gnutls_certificate_allocate_credentials)
720
680
    certificate_allocate_credentials.argtypes = [
721
 
        PointerTo(Credentials)]
 
681
        ctypes.POINTER(certificate_credentials_t)]
722
682
    certificate_allocate_credentials.restype = _error_code
723
683
 
724
684
    certificate_free_credentials = (
725
685
        _library.gnutls_certificate_free_credentials)
726
 
    certificate_free_credentials.argtypes = [Credentials]
 
686
    certificate_free_credentials.argtypes = [
 
687
        certificate_credentials_t]
727
688
    certificate_free_credentials.restype = None
728
689
 
729
690
    handshake_set_private_extensions = (
730
691
        _library.gnutls_handshake_set_private_extensions)
731
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
692
    handshake_set_private_extensions.argtypes = [session_t,
732
693
                                                 ctypes.c_int]
733
694
    handshake_set_private_extensions.restype = None
734
695
 
735
696
    credentials_set = _library.gnutls_credentials_set
736
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
737
 
                                CastToVoidPointer(Credentials)]
 
697
    credentials_set.argtypes = [session_t, credentials_type_t,
 
698
                                ctypes.c_void_p]
738
699
    credentials_set.restype = _error_code
739
700
 
740
701
    strerror = _library.gnutls_strerror
742
703
    strerror.restype = ctypes.c_char_p
743
704
 
744
705
    certificate_type_get = _library.gnutls_certificate_type_get
745
 
    certificate_type_get.argtypes = [ClientSession]
 
706
    certificate_type_get.argtypes = [session_t]
746
707
    certificate_type_get.restype = _error_code
747
708
 
748
709
    certificate_get_peers = _library.gnutls_certificate_get_peers
749
 
    certificate_get_peers.argtypes = [ClientSession,
 
710
    certificate_get_peers.argtypes = [session_t,
750
711
                                      ctypes.POINTER(ctypes.c_uint)]
751
712
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
752
713
 
759
720
    global_set_log_function.restype = None
760
721
 
761
722
    deinit = _library.gnutls_deinit
762
 
    deinit.argtypes = [ClientSession]
 
723
    deinit.argtypes = [session_t]
763
724
    deinit.restype = None
764
725
 
765
726
    handshake = _library.gnutls_handshake
766
 
    handshake.argtypes = [ClientSession]
767
 
    handshake.restype = ctypes.c_int
 
727
    handshake.argtypes = [session_t]
 
728
    handshake.restype = _error_code
768
729
    handshake.errcheck = _retry_on_error
769
730
 
770
731
    transport_set_ptr = _library.gnutls_transport_set_ptr
771
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
732
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
772
733
    transport_set_ptr.restype = None
773
734
 
774
735
    bye = _library.gnutls_bye
775
 
    bye.argtypes = [ClientSession, close_request_t]
776
 
    bye.restype = ctypes.c_int
 
736
    bye.argtypes = [session_t, close_request_t]
 
737
    bye.restype = _error_code
777
738
    bye.errcheck = _retry_on_error
778
739
 
779
740
    check_version = _library.gnutls_check_version
796
757
 
797
758
        x509_crt_fmt_t = ctypes.c_int
798
759
 
799
 
        # All the function declarations below are from
800
 
        # gnutls/abstract.h
 
760
        # All the function declarations below are from gnutls/abstract.h
801
761
        pubkey_init = _library.gnutls_pubkey_init
802
762
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
803
763
        pubkey_init.restype = _error_code
817
777
        pubkey_deinit.argtypes = [pubkey_t]
818
778
        pubkey_deinit.restype = None
819
779
    else:
820
 
        # All the function declarations below are from
821
 
        # gnutls/openpgp.h
 
780
        # All the function declarations below are from gnutls/openpgp.h
822
781
 
823
782
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
824
783
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
830
789
                                       openpgp_crt_fmt_t]
831
790
        openpgp_crt_import.restype = _error_code
832
791
 
833
 
        openpgp_crt_verify_self = \
834
 
            _library.gnutls_openpgp_crt_verify_self
835
 
        openpgp_crt_verify_self.argtypes = [
836
 
            openpgp_crt_t,
837
 
            ctypes.c_uint,
838
 
            ctypes.POINTER(ctypes.c_uint),
839
 
        ]
 
792
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
793
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
794
                                            ctypes.POINTER(ctypes.c_uint)]
840
795
        openpgp_crt_verify_self.restype = _error_code
841
796
 
842
797
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
853
808
 
854
809
    if check_version(b"3.6.4"):
855
810
        certificate_type_get2 = _library.gnutls_certificate_type_get2
856
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
811
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
857
812
        certificate_type_get2.restype = _error_code
858
813
 
859
814
    # Remove non-public functions
875
830
    """A representation of a client host served by this server.
876
831
 
877
832
    Attributes:
878
 
    approved:   bool(); None if not yet approved/disapproved
 
833
    approved:   bool(); 'None' if not yet approved/disapproved
879
834
    approval_delay: datetime.timedelta(); Time to wait for approval
880
835
    approval_duration: datetime.timedelta(); Duration of one approval
881
836
    checker: multiprocessing.Process(); a running checker process used
882
 
             to see if the client lives. None if no process is
 
837
             to see if the client lives. 'None' if no process is
883
838
             running.
884
839
    checker_callback_tag: a GLib event source tag, or None
885
840
    checker_command: string; External command which is run to check
1009
964
            self.last_enabled = None
1010
965
            self.expires = None
1011
966
 
1012
 
        log.debug("Creating client %r", self.name)
1013
 
        log.debug("  Key ID: %s", self.key_id)
1014
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
967
        logger.debug("Creating client %r", self.name)
 
968
        logger.debug("  Key ID: %s", self.key_id)
 
969
        logger.debug("  Fingerprint: %s", self.fingerprint)
1015
970
        self.created = settings.get("created",
1016
971
                                    datetime.datetime.utcnow())
1017
972
 
1045
1000
        if getattr(self, "enabled", False):
1046
1001
            # Already enabled
1047
1002
            return
 
1003
        self.expires = datetime.datetime.utcnow() + self.timeout
1048
1004
        self.enabled = True
1049
1005
        self.last_enabled = datetime.datetime.utcnow()
1050
1006
        self.init_checker()
1055
1011
        if not getattr(self, "enabled", False):
1056
1012
            return False
1057
1013
        if not quiet:
1058
 
            log.info("Disabling client %s", self.name)
 
1014
            logger.info("Disabling client %s", self.name)
1059
1015
        if getattr(self, "disable_initiator_tag", None) is not None:
1060
1016
            GLib.source_remove(self.disable_initiator_tag)
1061
1017
            self.disable_initiator_tag = None
1073
1029
    def __del__(self):
1074
1030
        self.disable()
1075
1031
 
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.
 
1032
    def init_checker(self):
 
1033
        # Schedule a new checker to be started an 'interval' from now,
 
1034
        # and every interval from then on.
1081
1035
        if self.checker_initiator_tag is not None:
1082
1036
            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
1090
1037
        self.checker_initiator_tag = GLib.timeout_add(
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
 
1038
            int(self.interval.total_seconds() * 1000),
 
1039
            self.start_checker)
 
1040
        # Schedule a disable() when 'timeout' has passed
1100
1041
        if self.disable_initiator_tag is not None:
1101
1042
            GLib.source_remove(self.disable_initiator_tag)
1102
1043
        self.disable_initiator_tag = GLib.timeout_add(
1103
 
            int((self.expires - now).total_seconds() * 1000),
1104
 
            self.disable)
 
1044
            int(self.timeout.total_seconds() * 1000), self.disable)
 
1045
        # Also start a new checker *right now*.
 
1046
        self.start_checker()
1105
1047
 
1106
1048
    def checker_callback(self, source, condition, connection,
1107
1049
                         command):
1118
1060
            self.last_checker_status = returncode
1119
1061
            self.last_checker_signal = None
1120
1062
            if self.last_checker_status == 0:
1121
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1063
                logger.info("Checker for %(name)s succeeded",
 
1064
                            vars(self))
1122
1065
                self.checked_ok()
1123
1066
            else:
1124
 
                log.info("Checker for %(name)s failed", vars(self))
 
1067
                logger.info("Checker for %(name)s failed", vars(self))
1125
1068
        else:
1126
1069
            self.last_checker_status = -1
1127
1070
            self.last_checker_signal = -returncode
1128
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1071
            logger.warning("Checker for %(name)s crashed?",
 
1072
                           vars(self))
1129
1073
        return False
1130
1074
 
1131
1075
    def checked_ok(self):
1150
1094
    def need_approval(self):
1151
1095
        self.last_approval_request = datetime.datetime.utcnow()
1152
1096
 
1153
 
    def start_checker(self, start_was_randomized=False):
 
1097
    def start_checker(self):
1154
1098
        """Start a new checker subprocess if one is not running.
1155
1099
 
1156
1100
        If a checker already exists, leave it running and do
1165
1109
        # should be.
1166
1110
 
1167
1111
        if self.checker is not None and not self.checker.is_alive():
1168
 
            log.warning("Checker was not alive; joining")
 
1112
            logger.warning("Checker was not alive; joining")
1169
1113
            self.checker.join()
1170
1114
            self.checker = None
1171
1115
        # Start a new checker if needed
1172
1116
        if self.checker is None:
1173
1117
            # Escape attributes for the shell
1174
1118
            escaped_attrs = {
1175
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1119
                attr: re.escape(str(getattr(self, attr)))
1176
1120
                for attr in self.runtime_expansions}
1177
1121
            try:
1178
1122
                command = self.checker_command % escaped_attrs
1179
1123
            except TypeError as error:
1180
 
                log.error('Could not format string "%s"',
1181
 
                          self.checker_command, exc_info=error)
 
1124
                logger.error('Could not format string "%s"',
 
1125
                             self.checker_command,
 
1126
                             exc_info=error)
1182
1127
                return True     # Try again later
1183
1128
            self.current_checker_command = command
1184
 
            log.info("Starting checker %r for %s", command, self.name)
 
1129
            logger.info("Starting checker %r for %s", command,
 
1130
                        self.name)
1185
1131
            # We don't need to redirect stdout and stderr, since
1186
1132
            # in normal mode, that is already done by daemon(),
1187
1133
            # and in debug mode we don't want to.  (Stdin is
1206
1152
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1207
1153
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1208
1154
                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
1220
1155
        # Re-run this periodically if run by GLib.timeout_add
1221
1156
        return True
1222
1157
 
1227
1162
            self.checker_callback_tag = None
1228
1163
        if getattr(self, "checker", None) is None:
1229
1164
            return
1230
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1165
        logger.debug("Stopping checker for %(name)s", vars(self))
1231
1166
        self.checker.terminate()
1232
1167
        self.checker = None
1233
1168
 
1260
1195
        func._dbus_name = func.__name__
1261
1196
        if func._dbus_name.endswith("_dbus_property"):
1262
1197
            func._dbus_name = func._dbus_name[:-14]
1263
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1198
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1264
1199
        return func
1265
1200
 
1266
1201
    return decorator
1355
1290
 
1356
1291
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1357
1292
                         out_signature="s",
1358
 
                         path_keyword="object_path",
1359
 
                         connection_keyword="connection")
 
1293
                         path_keyword='object_path',
 
1294
                         connection_keyword='connection')
1360
1295
    def Introspect(self, object_path, connection):
1361
1296
        """Overloading of standard D-Bus method.
1362
1297
 
1411
1346
            document.unlink()
1412
1347
        except (AttributeError, xml.dom.DOMException,
1413
1348
                xml.parsers.expat.ExpatError) as error:
1414
 
            log.error("Failed to override Introspection method",
1415
 
                      exc_info=error)
 
1349
            logger.error("Failed to override Introspection method",
 
1350
                         exc_info=error)
1416
1351
        return xmlstring
1417
1352
 
1418
1353
 
1515
1450
 
1516
1451
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1517
1452
                         out_signature="s",
1518
 
                         path_keyword="object_path",
1519
 
                         connection_keyword="connection")
 
1453
                         path_keyword='object_path',
 
1454
                         connection_keyword='connection')
1520
1455
    def Introspect(self, object_path, connection):
1521
1456
        """Overloading of standard D-Bus method.
1522
1457
 
1578
1513
            document.unlink()
1579
1514
        except (AttributeError, xml.dom.DOMException,
1580
1515
                xml.parsers.expat.ExpatError) as error:
1581
 
            log.error("Failed to override Introspection method",
1582
 
                      exc_info=error)
 
1516
            logger.error("Failed to override Introspection method",
 
1517
                         exc_info=error)
1583
1518
        return xmlstring
1584
1519
 
1585
1520
 
1617
1552
 
1618
1553
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1619
1554
                         out_signature="s",
1620
 
                         path_keyword="object_path",
1621
 
                         connection_keyword="connection")
 
1555
                         path_keyword='object_path',
 
1556
                         connection_keyword='connection')
1622
1557
    def Introspect(self, object_path, connection):
1623
1558
        """Overloading of standard D-Bus method.
1624
1559
 
1649
1584
            document.unlink()
1650
1585
        except (AttributeError, xml.dom.DOMException,
1651
1586
                xml.parsers.expat.ExpatError) as error:
1652
 
            log.error("Failed to override Introspection method",
1653
 
                      exc_info=error)
 
1587
            logger.error("Failed to override Introspection method",
 
1588
                         exc_info=error)
1654
1589
        return xmlstring
1655
1590
 
1656
1591
 
2290
2225
class ProxyClient:
2291
2226
    def __init__(self, child_pipe, key_id, fpr, address):
2292
2227
        self._pipe = child_pipe
2293
 
        self._pipe.send(("init", key_id, fpr, address))
 
2228
        self._pipe.send(('init', key_id, fpr, address))
2294
2229
        if not self._pipe.recv():
2295
2230
            raise KeyError(key_id or fpr)
2296
2231
 
2297
2232
    def __getattribute__(self, name):
2298
 
        if name == "_pipe":
 
2233
        if name == '_pipe':
2299
2234
            return super(ProxyClient, self).__getattribute__(name)
2300
 
        self._pipe.send(("getattr", name))
 
2235
        self._pipe.send(('getattr', name))
2301
2236
        data = self._pipe.recv()
2302
 
        if data[0] == "data":
 
2237
        if data[0] == 'data':
2303
2238
            return data[1]
2304
 
        if data[0] == "function":
 
2239
        if data[0] == 'function':
2305
2240
 
2306
2241
            def func(*args, **kwargs):
2307
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2242
                self._pipe.send(('funcall', name, args, kwargs))
2308
2243
                return self._pipe.recv()[1]
2309
2244
 
2310
2245
            return func
2311
2246
 
2312
2247
    def __setattr__(self, name, value):
2313
 
        if name == "_pipe":
 
2248
        if name == '_pipe':
2314
2249
            return super(ProxyClient, self).__setattr__(name, value)
2315
 
        self._pipe.send(("setattr", name, value))
 
2250
        self._pipe.send(('setattr', name, value))
2316
2251
 
2317
2252
 
2318
2253
class ClientHandler(socketserver.BaseRequestHandler, object):
2323
2258
 
2324
2259
    def handle(self):
2325
2260
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2326
 
            log.info("TCP connection from: %s",
2327
 
                     str(self.client_address))
2328
 
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
 
2261
            logger.info("TCP connection from: %s",
 
2262
                        str(self.client_address))
 
2263
            logger.debug("Pipe FD: %d",
 
2264
                         self.server.child_pipe.fileno())
2329
2265
 
2330
2266
            session = gnutls.ClientSession(self.request)
2331
2267
 
2332
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2268
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2333
2269
            #                       "+AES-256-CBC", "+SHA1",
2334
2270
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2335
2271
            #                       "+DHE-DSS"))
2337
2273
            priority = self.server.gnutls_priority
2338
2274
            if priority is None:
2339
2275
                priority = "NORMAL"
2340
 
            gnutls.priority_set_direct(session,
2341
 
                                       priority.encode("utf-8"), None)
 
2276
            gnutls.priority_set_direct(session._c_object,
 
2277
                                       priority.encode("utf-8"),
 
2278
                                       None)
2342
2279
 
2343
2280
            # Start communication using the Mandos protocol
2344
2281
            # Get protocol number
2345
2282
            line = self.request.makefile().readline()
2346
 
            log.debug("Protocol version: %r", line)
 
2283
            logger.debug("Protocol version: %r", line)
2347
2284
            try:
2348
2285
                if int(line.strip().split()[0]) > 1:
2349
2286
                    raise RuntimeError(line)
2350
2287
            except (ValueError, IndexError, RuntimeError) as error:
2351
 
                log.error("Unknown protocol version: %s", error)
 
2288
                logger.error("Unknown protocol version: %s", error)
2352
2289
                return
2353
2290
 
2354
2291
            # Start GnuTLS connection
2355
2292
            try:
2356
2293
                session.handshake()
2357
2294
            except gnutls.Error as error:
2358
 
                log.warning("Handshake failed: %s", error)
 
2295
                logger.warning("Handshake failed: %s", error)
2359
2296
                # Do not run session.bye() here: the session is not
2360
2297
                # established.  Just abandon the request.
2361
2298
                return
2362
 
            log.debug("Handshake succeeded")
 
2299
            logger.debug("Handshake succeeded")
2363
2300
 
2364
2301
            approval_required = False
2365
2302
            try:
2369
2306
                        key_id = self.key_id(
2370
2307
                            self.peer_certificate(session))
2371
2308
                    except (TypeError, gnutls.Error) as error:
2372
 
                        log.warning("Bad certificate: %s", error)
 
2309
                        logger.warning("Bad certificate: %s", error)
2373
2310
                        return
2374
 
                    log.debug("Key ID: %s",
2375
 
                              key_id.decode("utf-8",
2376
 
                                            errors="replace"))
 
2311
                    logger.debug("Key ID: %s", key_id)
2377
2312
 
2378
2313
                else:
2379
2314
                    key_id = b""
2381
2316
                        fpr = self.fingerprint(
2382
2317
                            self.peer_certificate(session))
2383
2318
                    except (TypeError, gnutls.Error) as error:
2384
 
                        log.warning("Bad certificate: %s", error)
 
2319
                        logger.warning("Bad certificate: %s", error)
2385
2320
                        return
2386
 
                    log.debug("Fingerprint: %s", fpr)
 
2321
                    logger.debug("Fingerprint: %s", fpr)
2387
2322
 
2388
2323
                try:
2389
2324
                    client = ProxyClient(child_pipe, key_id, fpr,
2398
2333
 
2399
2334
                while True:
2400
2335
                    if not client.enabled:
2401
 
                        log.info("Client %s is disabled", client.name)
 
2336
                        logger.info("Client %s is disabled",
 
2337
                                    client.name)
2402
2338
                        if self.server.use_dbus:
2403
2339
                            # Emit D-Bus signal
2404
2340
                            client.Rejected("Disabled")
2408
2344
                        # We are approved or approval is disabled
2409
2345
                        break
2410
2346
                    elif client.approved is None:
2411
 
                        log.info("Client %s needs approval",
2412
 
                                 client.name)
 
2347
                        logger.info("Client %s needs approval",
 
2348
                                    client.name)
2413
2349
                        if self.server.use_dbus:
2414
2350
                            # Emit D-Bus signal
2415
2351
                            client.NeedApproval(
2416
2352
                                client.approval_delay.total_seconds()
2417
2353
                                * 1000, client.approved_by_default)
2418
2354
                    else:
2419
 
                        log.warning("Client %s was not approved",
2420
 
                                    client.name)
 
2355
                        logger.warning("Client %s was not approved",
 
2356
                                       client.name)
2421
2357
                        if self.server.use_dbus:
2422
2358
                            # Emit D-Bus signal
2423
2359
                            client.Rejected("Denied")
2431
2367
                    time2 = datetime.datetime.now()
2432
2368
                    if (time2 - time) >= delay:
2433
2369
                        if not client.approved_by_default:
2434
 
                            log.warning("Client %s timed out while"
2435
 
                                        " waiting for approval",
2436
 
                                        client.name)
 
2370
                            logger.warning("Client %s timed out while"
 
2371
                                           " waiting for approval",
 
2372
                                           client.name)
2437
2373
                            if self.server.use_dbus:
2438
2374
                                # Emit D-Bus signal
2439
2375
                                client.Rejected("Approval timed out")
2446
2382
                try:
2447
2383
                    session.send(client.secret)
2448
2384
                except gnutls.Error as error:
2449
 
                    log.warning("gnutls send failed", exc_info=error)
 
2385
                    logger.warning("gnutls send failed",
 
2386
                                   exc_info=error)
2450
2387
                    return
2451
2388
 
2452
 
                log.info("Sending secret to %s", client.name)
 
2389
                logger.info("Sending secret to %s", client.name)
2453
2390
                # bump the timeout using extended_timeout
2454
2391
                client.bump_timeout(client.extended_timeout)
2455
2392
                if self.server.use_dbus:
2462
2399
                try:
2463
2400
                    session.bye()
2464
2401
                except gnutls.Error as error:
2465
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2402
                    logger.warning("GnuTLS bye failed",
 
2403
                                   exc_info=error)
2466
2404
 
2467
2405
    @staticmethod
2468
2406
    def peer_certificate(session):
2469
2407
        "Return the peer's certificate as a bytestring"
2470
2408
        try:
2471
 
            cert_type = gnutls.certificate_type_get2(
2472
 
                session, gnutls.CTYPE_PEERS)
 
2409
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2410
                                                     gnutls.CTYPE_PEERS)
2473
2411
        except AttributeError:
2474
 
            cert_type = gnutls.certificate_type_get(session)
 
2412
            cert_type = gnutls.certificate_type_get(session._c_object)
2475
2413
        if gnutls.has_rawpk:
2476
2414
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2477
2415
        else:
2478
2416
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2479
2417
        # If not a valid certificate type...
2480
2418
        if cert_type not in valid_cert_types:
2481
 
            log.info("Cert type %r not in %r", cert_type,
2482
 
                     valid_cert_types)
 
2419
            logger.info("Cert type %r not in %r", cert_type,
 
2420
                        valid_cert_types)
2483
2421
            # ...return invalid data
2484
2422
            return b""
2485
2423
        list_size = ctypes.c_uint(1)
2486
2424
        cert_list = (gnutls.certificate_get_peers
2487
 
                     (session, ctypes.byref(list_size)))
 
2425
                     (session._c_object, ctypes.byref(list_size)))
2488
2426
        if not bool(cert_list) and list_size.value != 0:
2489
2427
            raise gnutls.Error("error getting peer certificate")
2490
2428
        if list_size.value == 0:
2512
2450
        buf = ctypes.create_string_buffer(32)
2513
2451
        buf_len = ctypes.c_size_t(len(buf))
2514
2452
        # 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))
 
2453
        gnutls.pubkey_get_key_id(pubkey,
 
2454
                                 gnutls.KEYID_USE_SHA256,
 
2455
                                 ctypes.cast(ctypes.byref(buf),
 
2456
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2457
                                 ctypes.byref(buf_len))
2521
2458
        # Deinit the certificate
2522
2459
        gnutls.pubkey_deinit(pubkey)
2523
2460
 
2604
2541
 
2605
2542
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2606
2543
                     socketserver.TCPServer):
2607
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2544
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2608
2545
 
2609
2546
    Attributes:
2610
2547
        enabled:        Boolean; whether this server is activated yet
2661
2598
            if SO_BINDTODEVICE is None:
2662
2599
                # Fall back to a hard-coded value which seems to be
2663
2600
                # common enough.
2664
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2601
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2665
2602
                SO_BINDTODEVICE = 25
2666
2603
            try:
2667
2604
                self.socket.setsockopt(
2669
2606
                    (self.interface + "\0").encode("utf-8"))
2670
2607
            except socket.error as error:
2671
2608
                if error.errno == errno.EPERM:
2672
 
                    log.error("No permission to bind to interface %s",
2673
 
                              self.interface)
 
2609
                    logger.error("No permission to bind to"
 
2610
                                 " interface %s", self.interface)
2674
2611
                elif error.errno == errno.ENOPROTOOPT:
2675
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2676
 
                              " bind to interface %s", self.interface)
 
2612
                    logger.error("SO_BINDTODEVICE not available;"
 
2613
                                 " cannot bind to interface %s",
 
2614
                                 self.interface)
2677
2615
                elif error.errno == errno.ENODEV:
2678
 
                    log.error("Interface %s does not exist, cannot"
2679
 
                              " bind", self.interface)
 
2616
                    logger.error("Interface %s does not exist,"
 
2617
                                 " cannot bind", self.interface)
2680
2618
                else:
2681
2619
                    raise
2682
2620
        # Only bind(2) the socket if we really need to.
2761
2699
        request = parent_pipe.recv()
2762
2700
        command = request[0]
2763
2701
 
2764
 
        if command == "init":
 
2702
        if command == 'init':
2765
2703
            key_id = request[1].decode("ascii")
2766
2704
            fpr = request[2].decode("ascii")
2767
2705
            address = request[3]
2768
2706
 
2769
2707
            for c in self.clients.values():
2770
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2771
 
                              "27AE41E4649B934CA495991B7852B855"):
 
2708
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2772
2709
                    continue
2773
2710
                if key_id and c.key_id == key_id:
2774
2711
                    client = c
2777
2714
                    client = c
2778
2715
                    break
2779
2716
            else:
2780
 
                log.info("Client not found for key ID: %s, address:"
2781
 
                         " %s", key_id or fpr, address)
 
2717
                logger.info("Client not found for key ID: %s, address"
 
2718
                            ": %s", key_id or fpr, address)
2782
2719
                if self.use_dbus:
2783
2720
                    # Emit D-Bus signal
2784
2721
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2797
2734
            # remove the old hook in favor of the new above hook on
2798
2735
            # same fileno
2799
2736
            return False
2800
 
        if command == "funcall":
 
2737
        if command == 'funcall':
2801
2738
            funcname = request[1]
2802
2739
            args = request[2]
2803
2740
            kwargs = request[3]
2804
2741
 
2805
 
            parent_pipe.send(("data", getattr(client_object,
 
2742
            parent_pipe.send(('data', getattr(client_object,
2806
2743
                                              funcname)(*args,
2807
2744
                                                        **kwargs)))
2808
2745
 
2809
 
        if command == "getattr":
 
2746
        if command == 'getattr':
2810
2747
            attrname = request[1]
2811
2748
            if isinstance(client_object.__getattribute__(attrname),
2812
 
                          collections.abc.Callable):
2813
 
                parent_pipe.send(("function", ))
 
2749
                          collections.Callable):
 
2750
                parent_pipe.send(('function', ))
2814
2751
            else:
2815
2752
                parent_pipe.send((
2816
 
                    "data", client_object.__getattribute__(attrname)))
 
2753
                    'data', client_object.__getattribute__(attrname)))
2817
2754
 
2818
 
        if command == "setattr":
 
2755
        if command == 'setattr':
2819
2756
            attrname = request[1]
2820
2757
            value = request[2]
2821
2758
            setattr(client_object, attrname, value)
2826
2763
def rfc3339_duration_to_delta(duration):
2827
2764
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2828
2765
 
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
 
2766
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
 
2767
    True
 
2768
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
 
2769
    True
 
2770
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
 
2771
    True
 
2772
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
 
2773
    True
 
2774
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
 
2775
    True
 
2776
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
 
2777
    True
 
2778
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
 
2779
    True
2845
2780
    """
2846
2781
 
2847
2782
    # Parsing an RFC 3339 duration with regular expressions is not
2927
2862
def string_to_delta(interval):
2928
2863
    """Parse a string and return a datetime.timedelta
2929
2864
 
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)
 
2865
    >>> string_to_delta('7d') == datetime.timedelta(7)
 
2866
    True
 
2867
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
 
2868
    True
 
2869
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
 
2870
    True
 
2871
    >>> string_to_delta('24h') == datetime.timedelta(1)
 
2872
    True
 
2873
    >>> string_to_delta('1w') == datetime.timedelta(7)
 
2874
    True
 
2875
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2941
2876
    True
2942
2877
    """
2943
2878
 
3147
3082
 
3148
3083
    if server_settings["servicename"] != "Mandos":
3149
3084
        syslogger.setFormatter(
3150
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3151
 
                              " %(levelname)s: %(message)s".format(
 
3085
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3086
                              ' %(levelname)s: %(message)s'.format(
3152
3087
                                  server_settings["servicename"])))
3153
3088
 
3154
3089
    # Parse config file with clients
3178
3113
        try:
3179
3114
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3180
3115
        except IOError as e:
3181
 
            log.error("Could not open file %r", pidfilename,
3182
 
                      exc_info=e)
 
3116
            logger.error("Could not open file %r", pidfilename,
 
3117
                         exc_info=e)
3183
3118
 
3184
3119
    for name, group in (("_mandos", "_mandos"),
3185
3120
                        ("mandos", "mandos"),
3196
3131
    try:
3197
3132
        os.setgid(gid)
3198
3133
        os.setuid(uid)
3199
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3134
        if debug:
 
3135
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3136
                                                             gid))
3200
3137
    except OSError as error:
3201
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3202
 
                    os.strerror(error.errno))
 
3138
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3139
                       .format(uid, gid, os.strerror(error.errno)))
3203
3140
        if error.errno != errno.EPERM:
3204
3141
            raise
3205
3142
 
3212
3149
 
3213
3150
        @gnutls.log_func
3214
3151
        def debug_gnutls(level, string):
3215
 
            log.debug("GnuTLS: %s",
3216
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3152
            logger.debug("GnuTLS: %s", string[:-1])
3217
3153
 
3218
3154
        gnutls.global_set_log_function(debug_gnutls)
3219
3155
 
3248
3184
                "se.bsnet.fukt.Mandos", bus,
3249
3185
                do_not_queue=True)
3250
3186
        except dbus.exceptions.DBusException as e:
3251
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3187
            logger.error("Disabling D-Bus:", exc_info=e)
3252
3188
            use_dbus = False
3253
3189
            server_settings["use_dbus"] = False
3254
3190
            tcp_server.use_dbus = False
3339
3275
            os.remove(stored_state_path)
3340
3276
        except IOError as e:
3341
3277
            if e.errno == errno.ENOENT:
3342
 
                log.warning("Could not load persistent state:"
3343
 
                            " %s", os.strerror(e.errno))
 
3278
                logger.warning("Could not load persistent state:"
 
3279
                               " {}".format(os.strerror(e.errno)))
3344
3280
            else:
3345
 
                log.critical("Could not load persistent state:",
3346
 
                             exc_info=e)
 
3281
                logger.critical("Could not load persistent state:",
 
3282
                                exc_info=e)
3347
3283
                raise
3348
3284
        except EOFError as e:
3349
 
            log.warning("Could not load persistent state: EOFError:",
3350
 
                        exc_info=e)
 
3285
            logger.warning("Could not load persistent state: "
 
3286
                           "EOFError:",
 
3287
                           exc_info=e)
3351
3288
 
3352
3289
    with PGPEngine() as pgp:
3353
3290
        for client_name, client in clients_data.items():
3380
3317
            if client["enabled"]:
3381
3318
                if datetime.datetime.utcnow() >= client["expires"]:
3382
3319
                    if not client["last_checked_ok"]:
3383
 
                        log.warning("disabling client %s - Client"
3384
 
                                    " never performed a successful"
3385
 
                                    " checker", client_name)
 
3320
                        logger.warning(
 
3321
                            "disabling client {} - Client never "
 
3322
                            "performed a successful checker".format(
 
3323
                                client_name))
3386
3324
                        client["enabled"] = False
3387
3325
                    elif client["last_checker_status"] != 0:
3388
 
                        log.warning("disabling client %s - Client"
3389
 
                                    " last checker failed with error"
3390
 
                                    " code %s", client_name,
3391
 
                                    client["last_checker_status"])
 
3326
                        logger.warning(
 
3327
                            "disabling client {} - Client last"
 
3328
                            " checker failed with error code"
 
3329
                            " {}".format(
 
3330
                                client_name,
 
3331
                                client["last_checker_status"]))
3392
3332
                        client["enabled"] = False
3393
3333
                    else:
3394
3334
                        client["expires"] = (
3395
3335
                            datetime.datetime.utcnow()
3396
3336
                            + client["timeout"])
3397
 
                        log.debug("Last checker succeeded, keeping %s"
3398
 
                                  " enabled", client_name)
 
3337
                        logger.debug("Last checker succeeded,"
 
3338
                                     " keeping {} enabled".format(
 
3339
                                         client_name))
3399
3340
            try:
3400
3341
                client["secret"] = pgp.decrypt(
3401
3342
                    client["encrypted_secret"],
3402
3343
                    client_settings[client_name]["secret"])
3403
3344
            except PGPError:
3404
3345
                # If decryption fails, we use secret from new settings
3405
 
                log.debug("Failed to decrypt %s old secret",
3406
 
                          client_name)
 
3346
                logger.debug("Failed to decrypt {} old secret".format(
 
3347
                    client_name))
3407
3348
                client["secret"] = (client_settings[client_name]
3408
3349
                                    ["secret"])
3409
3350
 
3423
3364
            server_settings=server_settings)
3424
3365
 
3425
3366
    if not tcp_server.clients:
3426
 
        log.warning("No clients defined")
 
3367
        logger.warning("No clients defined")
3427
3368
 
3428
3369
    if not foreground:
3429
3370
        if pidfile is not None:
3432
3373
                with pidfile:
3433
3374
                    print(pid, file=pidfile)
3434
3375
            except IOError:
3435
 
                log.error("Could not write to file %r with PID %d",
3436
 
                          pidfilename, pid)
 
3376
                logger.error("Could not write to file %r with PID %d",
 
3377
                             pidfilename, pid)
3437
3378
        del pidfile
3438
3379
        del pidfilename
3439
3380
 
3589
3530
 
3590
3531
        try:
3591
3532
            with tempfile.NamedTemporaryFile(
3592
 
                    mode="wb",
 
3533
                    mode='wb',
3593
3534
                    suffix=".pickle",
3594
 
                    prefix="clients-",
 
3535
                    prefix='clients-',
3595
3536
                    dir=os.path.dirname(stored_state_path),
3596
3537
                    delete=False) as stored_state:
3597
3538
                pickle.dump((clients, client_settings), stored_state,
3605
3546
                except NameError:
3606
3547
                    pass
3607
3548
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3608
 
                log.warning("Could not save persistent state: %s",
3609
 
                            os.strerror(e.errno))
 
3549
                logger.warning("Could not save persistent state: {}"
 
3550
                               .format(os.strerror(e.errno)))
3610
3551
            else:
3611
 
                log.warning("Could not save persistent state:",
3612
 
                            exc_info=e)
 
3552
                logger.warning("Could not save persistent state:",
 
3553
                               exc_info=e)
3613
3554
                raise
3614
3555
 
3615
3556
        # Delete all clients, and settings from config
3632
3573
            mandos_dbus_service.client_added_signal(client)
3633
3574
        # Need to initiate checking of clients
3634
3575
        if client.enabled:
3635
 
            client.init_checker(randomize_start=True)
 
3576
            client.init_checker()
3636
3577
 
3637
3578
    tcp_server.enable()
3638
3579
    tcp_server.server_activate()
3641
3582
    if zeroconf:
3642
3583
        service.port = tcp_server.socket.getsockname()[1]
3643
3584
    if use_ipv6:
3644
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3645
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3585
        logger.info("Now listening on address %r, port %d,"
 
3586
                    " flowinfo %d, scope_id %d",
 
3587
                    *tcp_server.socket.getsockname())
3646
3588
    else:                       # IPv4
3647
 
        log.info("Now listening on address %r, port %d",
3648
 
                 *tcp_server.socket.getsockname())
 
3589
        logger.info("Now listening on address %r, port %d",
 
3590
                    *tcp_server.socket.getsockname())
3649
3591
 
3650
3592
    # service.interface = tcp_server.socket.getsockname()[3]
3651
3593
 
3655
3597
            try:
3656
3598
                service.activate()
3657
3599
            except dbus.exceptions.DBusException as error:
3658
 
                log.critical("D-Bus Exception", exc_info=error)
 
3600
                logger.critical("D-Bus Exception", exc_info=error)
3659
3601
                cleanup()
3660
3602
                sys.exit(1)
3661
3603
            # End of Avahi example code
3666
3608
            lambda *args, **kwargs: (tcp_server.handle_request
3667
3609
                                     (*args[2:], **kwargs) or True))
3668
3610
 
3669
 
        log.debug("Starting main loop")
 
3611
        logger.debug("Starting main loop")
3670
3612
        main_loop.run()
3671
3613
    except AvahiError as error:
3672
 
        log.critical("Avahi Error", exc_info=error)
 
3614
        logger.critical("Avahi Error", exc_info=error)
3673
3615
        cleanup()
3674
3616
        sys.exit(1)
3675
3617
    except KeyboardInterrupt:
3676
3618
        if debug:
3677
3619
            print("", file=sys.stderr)
3678
 
        log.debug("Server received KeyboardInterrupt")
3679
 
    log.debug("Server exiting")
 
3620
        logger.debug("Server received KeyboardInterrupt")
 
3621
    logger.debug("Server exiting")
3680
3622
    # Must run before the D-Bus bus name gets deregistered
3681
3623
    cleanup()
3682
3624
 
3683
3625
 
3684
 
def parse_test_args():
3685
 
    # type: () -> argparse.Namespace
 
3626
def should_only_run_tests():
3686
3627
    parser = argparse.ArgumentParser(add_help=False)
3687
 
    parser.add_argument("--check", action="store_true")
3688
 
    parser.add_argument("--prefix", )
 
3628
    parser.add_argument("--check", action='store_true')
3689
3629
    args, unknown_args = parser.parse_known_args()
3690
 
    if args.check:
3691
 
        # Remove test options from sys.argv
 
3630
    run_tests = args.check
 
3631
    if run_tests:
 
3632
        # Remove --check argument from sys.argv
3692
3633
        sys.argv[1:] = unknown_args
3693
 
    return args
 
3634
    return run_tests
3694
3635
 
3695
3636
# Add all tests from doctest strings
3696
3637
def load_tests(loader, tests, none):
3698
3639
    tests.addTests(doctest.DocTestSuite())
3699
3640
    return tests
3700
3641
 
3701
 
if __name__ == "__main__":
3702
 
    options = parse_test_args()
 
3642
if __name__ == '__main__':
3703
3643
    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=[""])
 
3644
        if should_only_run_tests():
 
3645
            # Call using ./mandos --check [--verbose]
 
3646
            unittest.main()
3716
3647
        else:
3717
3648
            main()
3718
3649
    finally:
3719
3650
        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: