/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: 2019-08-30 21:46:16 UTC
  • Revision ID: teddy@recompile.se-20190830214616-t1yhgfjz3bdggjd9
Use Python 3 by default

* INSTALL: Document Python 3 dependency.
* debian/control: Change both of "python (>= 2.7), python (<< 3)" to
                  "python (>= 3)" and change all python-* dependencies
                  to be python3-* instead.
* mandos: Change first line to use "python3" instead of "python".
* mandos-ctl: - '' -
* mandos-monitor: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python3 -bI
2
 
# -*- coding: utf-8; lexical-binding: t -*-
 
1
#!/usr/bin/python3 -b
 
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
92
91
 
93
92
if sys.version_info.major == 2:
94
93
    __metaclass__ = type
95
 
    str = unicode
96
 
    input = raw_input
97
 
 
98
 
# Add collections.abc.Callable if it does not exist
99
 
try:
100
 
    collections.abc.Callable
101
 
except AttributeError:
102
 
    class abc:
103
 
        Callable = collections.Callable
104
 
    collections.abc = abc
105
 
    del abc
106
 
 
107
 
# Add shlex.quote if it does not exist
108
 
try:
109
 
    shlex.quote
110
 
except AttributeError:
111
 
    shlex.quote = re.escape
112
94
 
113
95
# Show warnings by default
114
96
if not sys.warnoptions:
140
122
            # No value found
141
123
            SO_BINDTODEVICE = None
142
124
 
 
125
if sys.version_info.major == 2:
 
126
    str = unicode
 
127
 
143
128
if sys.version_info < (3, 2):
144
129
    configparser.Configparser = configparser.SafeConfigParser
145
130
 
146
 
version = "1.8.15"
 
131
version = "1.8.8"
147
132
stored_state_file = "clients.pickle"
148
133
 
149
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
134
logger = logging.getLogger()
150
135
logging.captureWarnings(True)   # Show warnings via the logging system
151
136
syslogger = None
152
137
 
189
174
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
190
175
        address="/dev/log"))
191
176
    syslogger.setFormatter(logging.Formatter
192
 
                           ("Mandos [%(process)d]: %(levelname)s:"
193
 
                            " %(message)s"))
194
 
    log.addHandler(syslogger)
 
177
                           ('Mandos [%(process)d]: %(levelname)s:'
 
178
                            ' %(message)s'))
 
179
    logger.addHandler(syslogger)
195
180
 
196
181
    if debug:
197
182
        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)
 
183
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
184
                                               ' [%(process)d]:'
 
185
                                               ' %(levelname)s:'
 
186
                                               ' %(message)s'))
 
187
        logger.addHandler(console)
 
188
    logger.setLevel(level)
204
189
 
205
190
 
206
191
class PGPError(Exception):
218
203
            output = subprocess.check_output(["gpgconf"])
219
204
            for line in output.splitlines():
220
205
                name, text, path = line.split(b":")
221
 
                if name == b"gpg":
 
206
                if name == "gpg":
222
207
                    self.gpg = path
223
208
                    break
224
209
        except OSError as e:
225
210
            if e.errno != errno.ENOENT:
226
211
                raise
227
 
        self.gnupgargs = ["--batch",
228
 
                          "--homedir", self.tempdir,
229
 
                          "--force-mdc",
230
 
                          "--quiet"]
 
212
        self.gnupgargs = ['--batch',
 
213
                          '--homedir', self.tempdir,
 
214
                          '--force-mdc',
 
215
                          '--quiet']
231
216
        # Only GPG version 1 has the --no-use-agent option.
232
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
217
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
233
218
            self.gnupgargs.append("--no-use-agent")
234
219
 
235
220
    def __enter__(self):
272
257
                dir=self.tempdir) as passfile:
273
258
            passfile.write(passphrase)
274
259
            passfile.flush()
275
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
276
 
                                     "--passphrase-file",
 
260
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
261
                                     '--passphrase-file',
277
262
                                     passfile.name]
278
263
                                    + self.gnupgargs,
279
264
                                    stdin=subprocess.PIPE,
290
275
                dir=self.tempdir) as passfile:
291
276
            passfile.write(passphrase)
292
277
            passfile.flush()
293
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
294
 
                                     "--passphrase-file",
 
278
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
279
                                     '--passphrase-file',
295
280
                                     passfile.name]
296
281
                                    + self.gnupgargs,
297
282
                                    stdin=subprocess.PIPE,
350
335
    Attributes:
351
336
    interface: integer; avahi.IF_UNSPEC or an interface index.
352
337
               Used to optionally bind to the specified interface.
353
 
    name: string; Example: "Mandos"
354
 
    type: string; Example: "_mandos._tcp".
 
338
    name: string; Example: 'Mandos'
 
339
    type: string; Example: '_mandos._tcp'.
355
340
     See <https://www.iana.org/assignments/service-names-port-numbers>
356
341
    port: integer; what port to announce
357
342
    TXT: list of strings; TXT record for the service
394
379
    def rename(self, remove=True):
395
380
        """Derived from the Avahi example code"""
396
381
        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)
 
382
            logger.critical("No suitable Zeroconf service name found"
 
383
                            " after %i retries, exiting.",
 
384
                            self.rename_count)
400
385
            raise AvahiServiceError("Too many renames")
401
386
        self.name = str(
402
387
            self.server.GetAlternativeServiceName(self.name))
403
388
        self.rename_count += 1
404
 
        log.info("Changing Zeroconf service name to %r ...",
405
 
                 self.name)
 
389
        logger.info("Changing Zeroconf service name to %r ...",
 
390
                    self.name)
406
391
        if remove:
407
392
            self.remove()
408
393
        try:
410
395
        except dbus.exceptions.DBusException as error:
411
396
            if (error.get_dbus_name()
412
397
                == "org.freedesktop.Avahi.CollisionError"):
413
 
                log.info("Local Zeroconf service name collision.")
 
398
                logger.info("Local Zeroconf service name collision.")
414
399
                return self.rename(remove=False)
415
400
            else:
416
 
                log.critical("D-Bus Exception", exc_info=error)
 
401
                logger.critical("D-Bus Exception", exc_info=error)
417
402
                self.cleanup()
418
403
                os._exit(1)
419
404
 
435
420
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
421
        self.entry_group_state_changed_match = (
437
422
            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)
 
423
                'StateChanged', self.entry_group_state_changed))
 
424
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
425
                     self.name, self.type)
441
426
        self.group.AddService(
442
427
            self.interface,
443
428
            self.protocol,
450
435
 
451
436
    def entry_group_state_changed(self, state, error):
452
437
        """Derived from the Avahi example code"""
453
 
        log.debug("Avahi entry group state change: %i", state)
 
438
        logger.debug("Avahi entry group state change: %i", state)
454
439
 
455
440
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
 
            log.debug("Zeroconf service established.")
 
441
            logger.debug("Zeroconf service established.")
457
442
        elif state == avahi.ENTRY_GROUP_COLLISION:
458
 
            log.info("Zeroconf service name collision.")
 
443
            logger.info("Zeroconf service name collision.")
459
444
            self.rename()
460
445
        elif state == avahi.ENTRY_GROUP_FAILURE:
461
 
            log.critical("Avahi: Error in group state changed %s",
462
 
                         str(error))
 
446
            logger.critical("Avahi: Error in group state changed %s",
 
447
                            str(error))
463
448
            raise AvahiGroupError("State changed: {!s}".format(error))
464
449
 
465
450
    def cleanup(self):
475
460
 
476
461
    def server_state_changed(self, state, error=None):
477
462
        """Derived from the Avahi example code"""
478
 
        log.debug("Avahi server state change: %i", state)
 
463
        logger.debug("Avahi server state change: %i", state)
479
464
        bad_states = {
480
465
            avahi.SERVER_INVALID: "Zeroconf server invalid",
481
466
            avahi.SERVER_REGISTERING: None,
485
470
        if state in bad_states:
486
471
            if bad_states[state] is not None:
487
472
                if error is None:
488
 
                    log.error(bad_states[state])
 
473
                    logger.error(bad_states[state])
489
474
                else:
490
 
                    log.error(bad_states[state] + ": %r", error)
 
475
                    logger.error(bad_states[state] + ": %r", error)
491
476
            self.cleanup()
492
477
        elif state == avahi.SERVER_RUNNING:
493
478
            try:
495
480
            except dbus.exceptions.DBusException as error:
496
481
                if (error.get_dbus_name()
497
482
                    == "org.freedesktop.Avahi.CollisionError"):
498
 
                    log.info("Local Zeroconf service name collision.")
 
483
                    logger.info("Local Zeroconf service name"
 
484
                                " collision.")
499
485
                    return self.rename(remove=False)
500
486
                else:
501
 
                    log.critical("D-Bus Exception", exc_info=error)
 
487
                    logger.critical("D-Bus Exception", exc_info=error)
502
488
                    self.cleanup()
503
489
                    os._exit(1)
504
490
        else:
505
491
            if error is None:
506
 
                log.debug("Unknown state: %r", state)
 
492
                logger.debug("Unknown state: %r", state)
507
493
            else:
508
 
                log.debug("Unknown state: %r: %r", state, error)
 
494
                logger.debug("Unknown state: %r: %r", state, error)
509
495
 
510
496
    def activate(self):
511
497
        """Derived from the Avahi example code"""
523
509
class AvahiServiceToSyslog(AvahiService):
524
510
    def rename(self, *args, **kwargs):
525
511
        """Add the new name to the syslog messages"""
526
 
        ret = super(AvahiServiceToSyslog, self).rename(*args,
527
 
                                                       **kwargs)
 
512
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
528
513
        syslogger.setFormatter(logging.Formatter(
529
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
514
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
530
515
            .format(self.name)))
531
516
        return ret
532
517
 
562
547
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
563
548
 
564
549
    # Types
565
 
    class _session_int(ctypes.Structure):
 
550
    class session_int(ctypes.Structure):
566
551
        _fields_ = []
567
 
    session_t = ctypes.POINTER(_session_int)
 
552
    session_t = ctypes.POINTER(session_int)
568
553
 
569
554
    class certificate_credentials_st(ctypes.Structure):
570
555
        _fields_ = []
573
558
    certificate_type_t = ctypes.c_int
574
559
 
575
560
    class datum_t(ctypes.Structure):
576
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
 
                    ("size", ctypes.c_uint)]
 
561
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
562
                    ('size', ctypes.c_uint)]
578
563
 
579
 
    class _openpgp_crt_int(ctypes.Structure):
 
564
    class openpgp_crt_int(ctypes.Structure):
580
565
        _fields_ = []
581
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
566
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
567
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
583
568
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
569
    credentials_type_t = ctypes.c_int
593
578
            # gnutls.strerror()
594
579
            self.code = code
595
580
            if message is None and code is not None:
596
 
                message = gnutls.strerror(code).decode(
597
 
                    "utf-8", errors="replace")
 
581
                message = gnutls.strerror(code)
598
582
            return super(gnutls.Error, self).__init__(
599
583
                message, *args)
600
584
 
601
585
    class CertificateSecurityError(Error):
602
586
        pass
603
587
 
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
588
    # Classes
630
 
    class Credentials(With_from_param):
 
589
    class Credentials:
631
590
        def __init__(self):
632
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
633
 
            gnutls.certificate_allocate_credentials(self)
 
591
            self._c_object = gnutls.certificate_credentials_t()
 
592
            gnutls.certificate_allocate_credentials(
 
593
                ctypes.byref(self._c_object))
634
594
            self.type = gnutls.CRD_CERTIFICATE
635
595
 
636
596
        def __del__(self):
637
 
            gnutls.certificate_free_credentials(self)
 
597
            gnutls.certificate_free_credentials(self._c_object)
638
598
 
639
 
    class ClientSession(With_from_param):
 
599
    class ClientSession:
640
600
        def __init__(self, socket, credentials=None):
641
 
            self._as_parameter_ = gnutls.session_t()
 
601
            self._c_object = gnutls.session_t()
642
602
            gnutls_flags = gnutls.CLIENT
643
603
            if gnutls.check_version(b"3.5.6"):
644
604
                gnutls_flags |= gnutls.NO_TICKETS
645
605
            if gnutls.has_rawpk:
646
606
                gnutls_flags |= gnutls.ENABLE_RAWPK
647
 
            gnutls.init(self, gnutls_flags)
 
607
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
648
608
            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)
 
609
            gnutls.set_default_priority(self._c_object)
 
610
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
611
            gnutls.handshake_set_private_extensions(self._c_object,
 
612
                                                    True)
652
613
            self.socket = socket
653
614
            if credentials is None:
654
615
                credentials = gnutls.Credentials()
655
 
            gnutls.credentials_set(self, credentials.type,
656
 
                                   credentials)
 
616
            gnutls.credentials_set(self._c_object, credentials.type,
 
617
                                   ctypes.cast(credentials._c_object,
 
618
                                               ctypes.c_void_p))
657
619
            self.credentials = credentials
658
620
 
659
621
        def __del__(self):
660
 
            gnutls.deinit(self)
 
622
            gnutls.deinit(self._c_object)
661
623
 
662
624
        def handshake(self):
663
 
            return gnutls.handshake(self)
 
625
            return gnutls.handshake(self._c_object)
664
626
 
665
627
        def send(self, data):
666
628
            data = bytes(data)
667
629
            data_len = len(data)
668
630
            while data_len > 0:
669
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
631
                data_len -= gnutls.record_send(self._c_object,
 
632
                                               data[-data_len:],
670
633
                                               data_len)
671
634
 
672
635
        def bye(self):
673
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
636
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
674
637
 
675
638
    # Error handling functions
676
639
    def _error_code(result):
677
640
        """A function to raise exceptions on errors, suitable
678
 
        for the "restype" attribute on ctypes functions"""
679
 
        if result >= gnutls.E_SUCCESS:
 
641
        for the 'restype' attribute on ctypes functions"""
 
642
        if result >= 0:
680
643
            return result
681
644
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
645
            raise gnutls.CertificateSecurityError(code=result)
683
646
        raise gnutls.Error(code=result)
684
647
 
685
 
    def _retry_on_error(result, func, arguments,
686
 
                        _error_code=_error_code):
 
648
    def _retry_on_error(result, func, arguments):
687
649
        """A function to retry on some errors, suitable
688
 
        for the "errcheck" attribute on ctypes functions"""
689
 
        while result < gnutls.E_SUCCESS:
 
650
        for the 'errcheck' attribute on ctypes functions"""
 
651
        while result < 0:
690
652
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
653
                return _error_code(result)
692
654
            result = func(*arguments)
697
659
 
698
660
    # Functions
699
661
    priority_set_direct = _library.gnutls_priority_set_direct
700
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
662
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
701
663
                                    ctypes.POINTER(ctypes.c_char_p)]
702
664
    priority_set_direct.restype = _error_code
703
665
 
704
666
    init = _library.gnutls_init
705
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
667
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
706
668
    init.restype = _error_code
707
669
 
708
670
    set_default_priority = _library.gnutls_set_default_priority
709
 
    set_default_priority.argtypes = [ClientSession]
 
671
    set_default_priority.argtypes = [session_t]
710
672
    set_default_priority.restype = _error_code
711
673
 
712
674
    record_send = _library.gnutls_record_send
713
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
675
    record_send.argtypes = [session_t, ctypes.c_void_p,
714
676
                            ctypes.c_size_t]
715
677
    record_send.restype = ctypes.c_ssize_t
716
678
    record_send.errcheck = _retry_on_error
718
680
    certificate_allocate_credentials = (
719
681
        _library.gnutls_certificate_allocate_credentials)
720
682
    certificate_allocate_credentials.argtypes = [
721
 
        PointerTo(Credentials)]
 
683
        ctypes.POINTER(certificate_credentials_t)]
722
684
    certificate_allocate_credentials.restype = _error_code
723
685
 
724
686
    certificate_free_credentials = (
725
687
        _library.gnutls_certificate_free_credentials)
726
 
    certificate_free_credentials.argtypes = [Credentials]
 
688
    certificate_free_credentials.argtypes = [
 
689
        certificate_credentials_t]
727
690
    certificate_free_credentials.restype = None
728
691
 
729
692
    handshake_set_private_extensions = (
730
693
        _library.gnutls_handshake_set_private_extensions)
731
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
694
    handshake_set_private_extensions.argtypes = [session_t,
732
695
                                                 ctypes.c_int]
733
696
    handshake_set_private_extensions.restype = None
734
697
 
735
698
    credentials_set = _library.gnutls_credentials_set
736
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
737
 
                                CastToVoidPointer(Credentials)]
 
699
    credentials_set.argtypes = [session_t, credentials_type_t,
 
700
                                ctypes.c_void_p]
738
701
    credentials_set.restype = _error_code
739
702
 
740
703
    strerror = _library.gnutls_strerror
742
705
    strerror.restype = ctypes.c_char_p
743
706
 
744
707
    certificate_type_get = _library.gnutls_certificate_type_get
745
 
    certificate_type_get.argtypes = [ClientSession]
 
708
    certificate_type_get.argtypes = [session_t]
746
709
    certificate_type_get.restype = _error_code
747
710
 
748
711
    certificate_get_peers = _library.gnutls_certificate_get_peers
749
 
    certificate_get_peers.argtypes = [ClientSession,
 
712
    certificate_get_peers.argtypes = [session_t,
750
713
                                      ctypes.POINTER(ctypes.c_uint)]
751
714
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
752
715
 
759
722
    global_set_log_function.restype = None
760
723
 
761
724
    deinit = _library.gnutls_deinit
762
 
    deinit.argtypes = [ClientSession]
 
725
    deinit.argtypes = [session_t]
763
726
    deinit.restype = None
764
727
 
765
728
    handshake = _library.gnutls_handshake
766
 
    handshake.argtypes = [ClientSession]
767
 
    handshake.restype = ctypes.c_int
 
729
    handshake.argtypes = [session_t]
 
730
    handshake.restype = _error_code
768
731
    handshake.errcheck = _retry_on_error
769
732
 
770
733
    transport_set_ptr = _library.gnutls_transport_set_ptr
771
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
734
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
772
735
    transport_set_ptr.restype = None
773
736
 
774
737
    bye = _library.gnutls_bye
775
 
    bye.argtypes = [ClientSession, close_request_t]
776
 
    bye.restype = ctypes.c_int
 
738
    bye.argtypes = [session_t, close_request_t]
 
739
    bye.restype = _error_code
777
740
    bye.errcheck = _retry_on_error
778
741
 
779
742
    check_version = _library.gnutls_check_version
796
759
 
797
760
        x509_crt_fmt_t = ctypes.c_int
798
761
 
799
 
        # All the function declarations below are from
800
 
        # gnutls/abstract.h
 
762
        # All the function declarations below are from gnutls/abstract.h
801
763
        pubkey_init = _library.gnutls_pubkey_init
802
764
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
803
765
        pubkey_init.restype = _error_code
817
779
        pubkey_deinit.argtypes = [pubkey_t]
818
780
        pubkey_deinit.restype = None
819
781
    else:
820
 
        # All the function declarations below are from
821
 
        # gnutls/openpgp.h
 
782
        # All the function declarations below are from gnutls/openpgp.h
822
783
 
823
784
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
824
785
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
830
791
                                       openpgp_crt_fmt_t]
831
792
        openpgp_crt_import.restype = _error_code
832
793
 
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
 
        ]
 
794
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
795
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
796
                                            ctypes.POINTER(ctypes.c_uint)]
840
797
        openpgp_crt_verify_self.restype = _error_code
841
798
 
842
799
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
853
810
 
854
811
    if check_version(b"3.6.4"):
855
812
        certificate_type_get2 = _library.gnutls_certificate_type_get2
856
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
813
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
857
814
        certificate_type_get2.restype = _error_code
858
815
 
859
816
    # Remove non-public functions
875
832
    """A representation of a client host served by this server.
876
833
 
877
834
    Attributes:
878
 
    approved:   bool(); None if not yet approved/disapproved
 
835
    approved:   bool(); 'None' if not yet approved/disapproved
879
836
    approval_delay: datetime.timedelta(); Time to wait for approval
880
837
    approval_duration: datetime.timedelta(); Duration of one approval
881
838
    checker: multiprocessing.Process(); a running checker process used
882
 
             to see if the client lives. None if no process is
 
839
             to see if the client lives. 'None' if no process is
883
840
             running.
884
841
    checker_callback_tag: a GLib event source tag, or None
885
842
    checker_command: string; External command which is run to check
1009
966
            self.last_enabled = None
1010
967
            self.expires = None
1011
968
 
1012
 
        log.debug("Creating client %r", self.name)
1013
 
        log.debug("  Key ID: %s", self.key_id)
1014
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
969
        logger.debug("Creating client %r", self.name)
 
970
        logger.debug("  Key ID: %s", self.key_id)
 
971
        logger.debug("  Fingerprint: %s", self.fingerprint)
1015
972
        self.created = settings.get("created",
1016
973
                                    datetime.datetime.utcnow())
1017
974
 
1056
1013
        if not getattr(self, "enabled", False):
1057
1014
            return False
1058
1015
        if not quiet:
1059
 
            log.info("Disabling client %s", self.name)
 
1016
            logger.info("Disabling client %s", self.name)
1060
1017
        if getattr(self, "disable_initiator_tag", None) is not None:
1061
1018
            GLib.source_remove(self.disable_initiator_tag)
1062
1019
            self.disable_initiator_tag = None
1080
1037
        if self.checker_initiator_tag is not None:
1081
1038
            GLib.source_remove(self.checker_initiator_tag)
1082
1039
        self.checker_initiator_tag = GLib.timeout_add(
1083
 
            random.randrange(int(self.interval.total_seconds() * 1000
1084
 
                                 + 1)),
 
1040
            int(self.interval.total_seconds() * 1000),
1085
1041
            self.start_checker)
1086
1042
        # Schedule a disable() when 'timeout' has passed
1087
1043
        if self.disable_initiator_tag is not None:
1097
1053
        # Read return code from connection (see call_pipe)
1098
1054
        returncode = connection.recv()
1099
1055
        connection.close()
1100
 
        if self.checker is not None:
1101
 
            self.checker.join()
 
1056
        self.checker.join()
1102
1057
        self.checker_callback_tag = None
1103
1058
        self.checker = None
1104
1059
 
1106
1061
            self.last_checker_status = returncode
1107
1062
            self.last_checker_signal = None
1108
1063
            if self.last_checker_status == 0:
1109
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1064
                logger.info("Checker for %(name)s succeeded",
 
1065
                            vars(self))
1110
1066
                self.checked_ok()
1111
1067
            else:
1112
 
                log.info("Checker for %(name)s failed", vars(self))
 
1068
                logger.info("Checker for %(name)s failed", vars(self))
1113
1069
        else:
1114
1070
            self.last_checker_status = -1
1115
1071
            self.last_checker_signal = -returncode
1116
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1072
            logger.warning("Checker for %(name)s crashed?",
 
1073
                           vars(self))
1117
1074
        return False
1118
1075
 
1119
1076
    def checked_ok(self):
1153
1110
        # should be.
1154
1111
 
1155
1112
        if self.checker is not None and not self.checker.is_alive():
1156
 
            log.warning("Checker was not alive; joining")
 
1113
            logger.warning("Checker was not alive; joining")
1157
1114
            self.checker.join()
1158
1115
            self.checker = None
1159
1116
        # Start a new checker if needed
1160
1117
        if self.checker is None:
1161
1118
            # Escape attributes for the shell
1162
1119
            escaped_attrs = {
1163
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1120
                attr: re.escape(str(getattr(self, attr)))
1164
1121
                for attr in self.runtime_expansions}
1165
1122
            try:
1166
1123
                command = self.checker_command % escaped_attrs
1167
1124
            except TypeError as error:
1168
 
                log.error('Could not format string "%s"',
1169
 
                          self.checker_command, exc_info=error)
 
1125
                logger.error('Could not format string "%s"',
 
1126
                             self.checker_command,
 
1127
                             exc_info=error)
1170
1128
                return True     # Try again later
1171
1129
            self.current_checker_command = command
1172
 
            log.info("Starting checker %r for %s", command, self.name)
 
1130
            logger.info("Starting checker %r for %s", command,
 
1131
                        self.name)
1173
1132
            # We don't need to redirect stdout and stderr, since
1174
1133
            # in normal mode, that is already done by daemon(),
1175
1134
            # and in debug mode we don't want to.  (Stdin is
1204
1163
            self.checker_callback_tag = None
1205
1164
        if getattr(self, "checker", None) is None:
1206
1165
            return
1207
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1166
        logger.debug("Stopping checker for %(name)s", vars(self))
1208
1167
        self.checker.terminate()
1209
1168
        self.checker = None
1210
1169
 
1237
1196
        func._dbus_name = func.__name__
1238
1197
        if func._dbus_name.endswith("_dbus_property"):
1239
1198
            func._dbus_name = func._dbus_name[:-14]
1240
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1199
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1241
1200
        return func
1242
1201
 
1243
1202
    return decorator
1332
1291
 
1333
1292
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1334
1293
                         out_signature="s",
1335
 
                         path_keyword="object_path",
1336
 
                         connection_keyword="connection")
 
1294
                         path_keyword='object_path',
 
1295
                         connection_keyword='connection')
1337
1296
    def Introspect(self, object_path, connection):
1338
1297
        """Overloading of standard D-Bus method.
1339
1298
 
1388
1347
            document.unlink()
1389
1348
        except (AttributeError, xml.dom.DOMException,
1390
1349
                xml.parsers.expat.ExpatError) as error:
1391
 
            log.error("Failed to override Introspection method",
1392
 
                      exc_info=error)
 
1350
            logger.error("Failed to override Introspection method",
 
1351
                         exc_info=error)
1393
1352
        return xmlstring
1394
1353
 
1395
1354
 
1453
1412
                raise ValueError("Byte arrays not supported for non-"
1454
1413
                                 "'ay' signature {!r}"
1455
1414
                                 .format(prop._dbus_signature))
1456
 
            value = dbus.ByteArray(bytes(value))
 
1415
            value = dbus.ByteArray(b''.join(chr(byte)
 
1416
                                            for byte in value))
1457
1417
        prop(value)
1458
1418
 
1459
1419
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1492
1452
 
1493
1453
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1494
1454
                         out_signature="s",
1495
 
                         path_keyword="object_path",
1496
 
                         connection_keyword="connection")
 
1455
                         path_keyword='object_path',
 
1456
                         connection_keyword='connection')
1497
1457
    def Introspect(self, object_path, connection):
1498
1458
        """Overloading of standard D-Bus method.
1499
1459
 
1555
1515
            document.unlink()
1556
1516
        except (AttributeError, xml.dom.DOMException,
1557
1517
                xml.parsers.expat.ExpatError) as error:
1558
 
            log.error("Failed to override Introspection method",
1559
 
                      exc_info=error)
 
1518
            logger.error("Failed to override Introspection method",
 
1519
                         exc_info=error)
1560
1520
        return xmlstring
1561
1521
 
1562
1522
 
1594
1554
 
1595
1555
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1596
1556
                         out_signature="s",
1597
 
                         path_keyword="object_path",
1598
 
                         connection_keyword="connection")
 
1557
                         path_keyword='object_path',
 
1558
                         connection_keyword='connection')
1599
1559
    def Introspect(self, object_path, connection):
1600
1560
        """Overloading of standard D-Bus method.
1601
1561
 
1626
1586
            document.unlink()
1627
1587
        except (AttributeError, xml.dom.DOMException,
1628
1588
                xml.parsers.expat.ExpatError) as error:
1629
 
            log.error("Failed to override Introspection method",
1630
 
                      exc_info=error)
 
1589
            logger.error("Failed to override Introspection method",
 
1590
                         exc_info=error)
1631
1591
        return xmlstring
1632
1592
 
1633
1593
 
2267
2227
class ProxyClient:
2268
2228
    def __init__(self, child_pipe, key_id, fpr, address):
2269
2229
        self._pipe = child_pipe
2270
 
        self._pipe.send(("init", key_id, fpr, address))
 
2230
        self._pipe.send(('init', key_id, fpr, address))
2271
2231
        if not self._pipe.recv():
2272
2232
            raise KeyError(key_id or fpr)
2273
2233
 
2274
2234
    def __getattribute__(self, name):
2275
 
        if name == "_pipe":
 
2235
        if name == '_pipe':
2276
2236
            return super(ProxyClient, self).__getattribute__(name)
2277
 
        self._pipe.send(("getattr", name))
 
2237
        self._pipe.send(('getattr', name))
2278
2238
        data = self._pipe.recv()
2279
 
        if data[0] == "data":
 
2239
        if data[0] == 'data':
2280
2240
            return data[1]
2281
 
        if data[0] == "function":
 
2241
        if data[0] == 'function':
2282
2242
 
2283
2243
            def func(*args, **kwargs):
2284
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2244
                self._pipe.send(('funcall', name, args, kwargs))
2285
2245
                return self._pipe.recv()[1]
2286
2246
 
2287
2247
            return func
2288
2248
 
2289
2249
    def __setattr__(self, name, value):
2290
 
        if name == "_pipe":
 
2250
        if name == '_pipe':
2291
2251
            return super(ProxyClient, self).__setattr__(name, value)
2292
 
        self._pipe.send(("setattr", name, value))
 
2252
        self._pipe.send(('setattr', name, value))
2293
2253
 
2294
2254
 
2295
2255
class ClientHandler(socketserver.BaseRequestHandler, object):
2300
2260
 
2301
2261
    def handle(self):
2302
2262
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2303
 
            log.info("TCP connection from: %s",
2304
 
                     str(self.client_address))
2305
 
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
 
2263
            logger.info("TCP connection from: %s",
 
2264
                        str(self.client_address))
 
2265
            logger.debug("Pipe FD: %d",
 
2266
                         self.server.child_pipe.fileno())
2306
2267
 
2307
2268
            session = gnutls.ClientSession(self.request)
2308
2269
 
2309
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2270
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2310
2271
            #                       "+AES-256-CBC", "+SHA1",
2311
2272
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2312
2273
            #                       "+DHE-DSS"))
2314
2275
            priority = self.server.gnutls_priority
2315
2276
            if priority is None:
2316
2277
                priority = "NORMAL"
2317
 
            gnutls.priority_set_direct(session,
2318
 
                                       priority.encode("utf-8"), None)
 
2278
            gnutls.priority_set_direct(session._c_object,
 
2279
                                       priority.encode("utf-8"),
 
2280
                                       None)
2319
2281
 
2320
2282
            # Start communication using the Mandos protocol
2321
2283
            # Get protocol number
2322
2284
            line = self.request.makefile().readline()
2323
 
            log.debug("Protocol version: %r", line)
 
2285
            logger.debug("Protocol version: %r", line)
2324
2286
            try:
2325
2287
                if int(line.strip().split()[0]) > 1:
2326
2288
                    raise RuntimeError(line)
2327
2289
            except (ValueError, IndexError, RuntimeError) as error:
2328
 
                log.error("Unknown protocol version: %s", error)
 
2290
                logger.error("Unknown protocol version: %s", error)
2329
2291
                return
2330
2292
 
2331
2293
            # Start GnuTLS connection
2332
2294
            try:
2333
2295
                session.handshake()
2334
2296
            except gnutls.Error as error:
2335
 
                log.warning("Handshake failed: %s", error)
 
2297
                logger.warning("Handshake failed: %s", error)
2336
2298
                # Do not run session.bye() here: the session is not
2337
2299
                # established.  Just abandon the request.
2338
2300
                return
2339
 
            log.debug("Handshake succeeded")
 
2301
            logger.debug("Handshake succeeded")
2340
2302
 
2341
2303
            approval_required = False
2342
2304
            try:
2346
2308
                        key_id = self.key_id(
2347
2309
                            self.peer_certificate(session))
2348
2310
                    except (TypeError, gnutls.Error) as error:
2349
 
                        log.warning("Bad certificate: %s", error)
 
2311
                        logger.warning("Bad certificate: %s", error)
2350
2312
                        return
2351
 
                    log.debug("Key ID: %s",
2352
 
                              key_id.decode("utf-8",
2353
 
                                            errors="replace"))
 
2313
                    logger.debug("Key ID: %s", key_id)
2354
2314
 
2355
2315
                else:
2356
2316
                    key_id = b""
2358
2318
                        fpr = self.fingerprint(
2359
2319
                            self.peer_certificate(session))
2360
2320
                    except (TypeError, gnutls.Error) as error:
2361
 
                        log.warning("Bad certificate: %s", error)
 
2321
                        logger.warning("Bad certificate: %s", error)
2362
2322
                        return
2363
 
                    log.debug("Fingerprint: %s", fpr)
 
2323
                    logger.debug("Fingerprint: %s", fpr)
2364
2324
 
2365
2325
                try:
2366
2326
                    client = ProxyClient(child_pipe, key_id, fpr,
2375
2335
 
2376
2336
                while True:
2377
2337
                    if not client.enabled:
2378
 
                        log.info("Client %s is disabled", client.name)
 
2338
                        logger.info("Client %s is disabled",
 
2339
                                    client.name)
2379
2340
                        if self.server.use_dbus:
2380
2341
                            # Emit D-Bus signal
2381
2342
                            client.Rejected("Disabled")
2385
2346
                        # We are approved or approval is disabled
2386
2347
                        break
2387
2348
                    elif client.approved is None:
2388
 
                        log.info("Client %s needs approval",
2389
 
                                 client.name)
 
2349
                        logger.info("Client %s needs approval",
 
2350
                                    client.name)
2390
2351
                        if self.server.use_dbus:
2391
2352
                            # Emit D-Bus signal
2392
2353
                            client.NeedApproval(
2393
2354
                                client.approval_delay.total_seconds()
2394
2355
                                * 1000, client.approved_by_default)
2395
2356
                    else:
2396
 
                        log.warning("Client %s was not approved",
2397
 
                                    client.name)
 
2357
                        logger.warning("Client %s was not approved",
 
2358
                                       client.name)
2398
2359
                        if self.server.use_dbus:
2399
2360
                            # Emit D-Bus signal
2400
2361
                            client.Rejected("Denied")
2408
2369
                    time2 = datetime.datetime.now()
2409
2370
                    if (time2 - time) >= delay:
2410
2371
                        if not client.approved_by_default:
2411
 
                            log.warning("Client %s timed out while"
2412
 
                                        " waiting for approval",
2413
 
                                        client.name)
 
2372
                            logger.warning("Client %s timed out while"
 
2373
                                           " waiting for approval",
 
2374
                                           client.name)
2414
2375
                            if self.server.use_dbus:
2415
2376
                                # Emit D-Bus signal
2416
2377
                                client.Rejected("Approval timed out")
2423
2384
                try:
2424
2385
                    session.send(client.secret)
2425
2386
                except gnutls.Error as error:
2426
 
                    log.warning("gnutls send failed", exc_info=error)
 
2387
                    logger.warning("gnutls send failed",
 
2388
                                   exc_info=error)
2427
2389
                    return
2428
2390
 
2429
 
                log.info("Sending secret to %s", client.name)
 
2391
                logger.info("Sending secret to %s", client.name)
2430
2392
                # bump the timeout using extended_timeout
2431
2393
                client.bump_timeout(client.extended_timeout)
2432
2394
                if self.server.use_dbus:
2439
2401
                try:
2440
2402
                    session.bye()
2441
2403
                except gnutls.Error as error:
2442
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2404
                    logger.warning("GnuTLS bye failed",
 
2405
                                   exc_info=error)
2443
2406
 
2444
2407
    @staticmethod
2445
2408
    def peer_certificate(session):
2446
2409
        "Return the peer's certificate as a bytestring"
2447
2410
        try:
2448
 
            cert_type = gnutls.certificate_type_get2(
2449
 
                session, gnutls.CTYPE_PEERS)
 
2411
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2412
                                                     gnutls.CTYPE_PEERS)
2450
2413
        except AttributeError:
2451
 
            cert_type = gnutls.certificate_type_get(session)
 
2414
            cert_type = gnutls.certificate_type_get(session._c_object)
2452
2415
        if gnutls.has_rawpk:
2453
2416
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2454
2417
        else:
2455
2418
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2456
2419
        # If not a valid certificate type...
2457
2420
        if cert_type not in valid_cert_types:
2458
 
            log.info("Cert type %r not in %r", cert_type,
2459
 
                     valid_cert_types)
 
2421
            logger.info("Cert type %r not in %r", cert_type,
 
2422
                        valid_cert_types)
2460
2423
            # ...return invalid data
2461
2424
            return b""
2462
2425
        list_size = ctypes.c_uint(1)
2463
2426
        cert_list = (gnutls.certificate_get_peers
2464
 
                     (session, ctypes.byref(list_size)))
 
2427
                     (session._c_object, ctypes.byref(list_size)))
2465
2428
        if not bool(cert_list) and list_size.value != 0:
2466
2429
            raise gnutls.Error("error getting peer certificate")
2467
2430
        if list_size.value == 0:
2489
2452
        buf = ctypes.create_string_buffer(32)
2490
2453
        buf_len = ctypes.c_size_t(len(buf))
2491
2454
        # Get the key ID from the raw public key into the buffer
2492
 
        gnutls.pubkey_get_key_id(
2493
 
            pubkey,
2494
 
            gnutls.KEYID_USE_SHA256,
2495
 
            ctypes.cast(ctypes.byref(buf),
2496
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2497
 
            ctypes.byref(buf_len))
 
2455
        gnutls.pubkey_get_key_id(pubkey,
 
2456
                                 gnutls.KEYID_USE_SHA256,
 
2457
                                 ctypes.cast(ctypes.byref(buf),
 
2458
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2459
                                 ctypes.byref(buf_len))
2498
2460
        # Deinit the certificate
2499
2461
        gnutls.pubkey_deinit(pubkey)
2500
2462
 
2581
2543
 
2582
2544
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2583
2545
                     socketserver.TCPServer):
2584
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2546
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2585
2547
 
2586
2548
    Attributes:
2587
2549
        enabled:        Boolean; whether this server is activated yet
2638
2600
            if SO_BINDTODEVICE is None:
2639
2601
                # Fall back to a hard-coded value which seems to be
2640
2602
                # common enough.
2641
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2603
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2642
2604
                SO_BINDTODEVICE = 25
2643
2605
            try:
2644
2606
                self.socket.setsockopt(
2646
2608
                    (self.interface + "\0").encode("utf-8"))
2647
2609
            except socket.error as error:
2648
2610
                if error.errno == errno.EPERM:
2649
 
                    log.error("No permission to bind to interface %s",
2650
 
                              self.interface)
 
2611
                    logger.error("No permission to bind to"
 
2612
                                 " interface %s", self.interface)
2651
2613
                elif error.errno == errno.ENOPROTOOPT:
2652
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2653
 
                              " bind to interface %s", self.interface)
 
2614
                    logger.error("SO_BINDTODEVICE not available;"
 
2615
                                 " cannot bind to interface %s",
 
2616
                                 self.interface)
2654
2617
                elif error.errno == errno.ENODEV:
2655
 
                    log.error("Interface %s does not exist, cannot"
2656
 
                              " bind", self.interface)
 
2618
                    logger.error("Interface %s does not exist,"
 
2619
                                 " cannot bind", self.interface)
2657
2620
                else:
2658
2621
                    raise
2659
2622
        # Only bind(2) the socket if we really need to.
2738
2701
        request = parent_pipe.recv()
2739
2702
        command = request[0]
2740
2703
 
2741
 
        if command == "init":
 
2704
        if command == 'init':
2742
2705
            key_id = request[1].decode("ascii")
2743
2706
            fpr = request[2].decode("ascii")
2744
2707
            address = request[3]
2745
2708
 
2746
2709
            for c in self.clients.values():
2747
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2748
 
                              "27AE41E4649B934CA495991B7852B855"):
 
2710
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2749
2711
                    continue
2750
2712
                if key_id and c.key_id == key_id:
2751
2713
                    client = c
2754
2716
                    client = c
2755
2717
                    break
2756
2718
            else:
2757
 
                log.info("Client not found for key ID: %s, address:"
2758
 
                         " %s", key_id or fpr, address)
 
2719
                logger.info("Client not found for key ID: %s, address"
 
2720
                            ": %s", key_id or fpr, address)
2759
2721
                if self.use_dbus:
2760
2722
                    # Emit D-Bus signal
2761
2723
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2774
2736
            # remove the old hook in favor of the new above hook on
2775
2737
            # same fileno
2776
2738
            return False
2777
 
        if command == "funcall":
 
2739
        if command == 'funcall':
2778
2740
            funcname = request[1]
2779
2741
            args = request[2]
2780
2742
            kwargs = request[3]
2781
2743
 
2782
 
            parent_pipe.send(("data", getattr(client_object,
 
2744
            parent_pipe.send(('data', getattr(client_object,
2783
2745
                                              funcname)(*args,
2784
2746
                                                        **kwargs)))
2785
2747
 
2786
 
        if command == "getattr":
 
2748
        if command == 'getattr':
2787
2749
            attrname = request[1]
2788
2750
            if isinstance(client_object.__getattribute__(attrname),
2789
 
                          collections.abc.Callable):
2790
 
                parent_pipe.send(("function", ))
 
2751
                          collections.Callable):
 
2752
                parent_pipe.send(('function', ))
2791
2753
            else:
2792
2754
                parent_pipe.send((
2793
 
                    "data", client_object.__getattribute__(attrname)))
 
2755
                    'data', client_object.__getattribute__(attrname)))
2794
2756
 
2795
 
        if command == "setattr":
 
2757
        if command == 'setattr':
2796
2758
            attrname = request[1]
2797
2759
            value = request[2]
2798
2760
            setattr(client_object, attrname, value)
2803
2765
def rfc3339_duration_to_delta(duration):
2804
2766
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2805
2767
 
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
 
2768
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
 
2769
    True
 
2770
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
 
2771
    True
 
2772
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
 
2773
    True
 
2774
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
 
2775
    True
 
2776
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
 
2777
    True
 
2778
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
 
2779
    True
 
2780
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
 
2781
    True
2822
2782
    """
2823
2783
 
2824
2784
    # Parsing an RFC 3339 duration with regular expressions is not
2904
2864
def string_to_delta(interval):
2905
2865
    """Parse a string and return a datetime.timedelta
2906
2866
 
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)
 
2867
    >>> string_to_delta('7d') == datetime.timedelta(7)
 
2868
    True
 
2869
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
 
2870
    True
 
2871
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
 
2872
    True
 
2873
    >>> string_to_delta('24h') == datetime.timedelta(1)
 
2874
    True
 
2875
    >>> string_to_delta('1w') == datetime.timedelta(7)
 
2876
    True
 
2877
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2918
2878
    True
2919
2879
    """
2920
2880
 
3124
3084
 
3125
3085
    if server_settings["servicename"] != "Mandos":
3126
3086
        syslogger.setFormatter(
3127
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3128
 
                              " %(levelname)s: %(message)s".format(
 
3087
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3088
                              ' %(levelname)s: %(message)s'.format(
3129
3089
                                  server_settings["servicename"])))
3130
3090
 
3131
3091
    # Parse config file with clients
3155
3115
        try:
3156
3116
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3157
3117
        except IOError as e:
3158
 
            log.error("Could not open file %r", pidfilename,
3159
 
                      exc_info=e)
 
3118
            logger.error("Could not open file %r", pidfilename,
 
3119
                         exc_info=e)
3160
3120
 
3161
3121
    for name, group in (("_mandos", "_mandos"),
3162
3122
                        ("mandos", "mandos"),
3173
3133
    try:
3174
3134
        os.setgid(gid)
3175
3135
        os.setuid(uid)
3176
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3136
        if debug:
 
3137
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3138
                                                             gid))
3177
3139
    except OSError as error:
3178
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3179
 
                    os.strerror(error.errno))
 
3140
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3141
                       .format(uid, gid, os.strerror(error.errno)))
3180
3142
        if error.errno != errno.EPERM:
3181
3143
            raise
3182
3144
 
3189
3151
 
3190
3152
        @gnutls.log_func
3191
3153
        def debug_gnutls(level, string):
3192
 
            log.debug("GnuTLS: %s",
3193
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3154
            logger.debug("GnuTLS: %s", string[:-1])
3194
3155
 
3195
3156
        gnutls.global_set_log_function(debug_gnutls)
3196
3157
 
3225
3186
                "se.bsnet.fukt.Mandos", bus,
3226
3187
                do_not_queue=True)
3227
3188
        except dbus.exceptions.DBusException as e:
3228
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3189
            logger.error("Disabling D-Bus:", exc_info=e)
3229
3190
            use_dbus = False
3230
3191
            server_settings["use_dbus"] = False
3231
3192
            tcp_server.use_dbus = False
3290
3251
                             if isinstance(s, bytes)
3291
3252
                             else s) for s in
3292
3253
                            value["client_structure"]]
3293
 
                        # .name, .host, and .checker_command
3294
 
                        for k in ("name", "host", "checker_command"):
 
3254
                        # .name & .host
 
3255
                        for k in ("name", "host"):
3295
3256
                            if isinstance(value[k], bytes):
3296
3257
                                value[k] = value[k].decode("utf-8")
3297
3258
                        if "key_id" not in value:
3307
3268
                        for key, value in
3308
3269
                        bytes_old_client_settings.items()}
3309
3270
                    del bytes_old_client_settings
3310
 
                    # .host and .checker_command
 
3271
                    # .host
3311
3272
                    for value in old_client_settings.values():
3312
 
                        for attribute in ("host", "checker_command"):
3313
 
                            if isinstance(value[attribute], bytes):
3314
 
                                value[attribute] = (value[attribute]
3315
 
                                                    .decode("utf-8"))
 
3273
                        if isinstance(value["host"], bytes):
 
3274
                            value["host"] = (value["host"]
 
3275
                                             .decode("utf-8"))
3316
3276
            os.remove(stored_state_path)
3317
3277
        except IOError as e:
3318
3278
            if e.errno == errno.ENOENT:
3319
 
                log.warning("Could not load persistent state:"
3320
 
                            " %s", os.strerror(e.errno))
 
3279
                logger.warning("Could not load persistent state:"
 
3280
                               " {}".format(os.strerror(e.errno)))
3321
3281
            else:
3322
 
                log.critical("Could not load persistent state:",
3323
 
                             exc_info=e)
 
3282
                logger.critical("Could not load persistent state:",
 
3283
                                exc_info=e)
3324
3284
                raise
3325
3285
        except EOFError as e:
3326
 
            log.warning("Could not load persistent state: EOFError:",
3327
 
                        exc_info=e)
 
3286
            logger.warning("Could not load persistent state: "
 
3287
                           "EOFError:",
 
3288
                           exc_info=e)
3328
3289
 
3329
3290
    with PGPEngine() as pgp:
3330
3291
        for client_name, client in clients_data.items():
3357
3318
            if client["enabled"]:
3358
3319
                if datetime.datetime.utcnow() >= client["expires"]:
3359
3320
                    if not client["last_checked_ok"]:
3360
 
                        log.warning("disabling client %s - Client"
3361
 
                                    " never performed a successful"
3362
 
                                    " checker", client_name)
 
3321
                        logger.warning(
 
3322
                            "disabling client {} - Client never "
 
3323
                            "performed a successful checker".format(
 
3324
                                client_name))
3363
3325
                        client["enabled"] = False
3364
3326
                    elif client["last_checker_status"] != 0:
3365
 
                        log.warning("disabling client %s - Client"
3366
 
                                    " last checker failed with error"
3367
 
                                    " code %s", client_name,
3368
 
                                    client["last_checker_status"])
 
3327
                        logger.warning(
 
3328
                            "disabling client {} - Client last"
 
3329
                            " checker failed with error code"
 
3330
                            " {}".format(
 
3331
                                client_name,
 
3332
                                client["last_checker_status"]))
3369
3333
                        client["enabled"] = False
3370
3334
                    else:
3371
3335
                        client["expires"] = (
3372
3336
                            datetime.datetime.utcnow()
3373
3337
                            + client["timeout"])
3374
 
                        log.debug("Last checker succeeded, keeping %s"
3375
 
                                  " enabled", client_name)
 
3338
                        logger.debug("Last checker succeeded,"
 
3339
                                     " keeping {} enabled".format(
 
3340
                                         client_name))
3376
3341
            try:
3377
3342
                client["secret"] = pgp.decrypt(
3378
3343
                    client["encrypted_secret"],
3379
3344
                    client_settings[client_name]["secret"])
3380
3345
            except PGPError:
3381
3346
                # If decryption fails, we use secret from new settings
3382
 
                log.debug("Failed to decrypt %s old secret",
3383
 
                          client_name)
 
3347
                logger.debug("Failed to decrypt {} old secret".format(
 
3348
                    client_name))
3384
3349
                client["secret"] = (client_settings[client_name]
3385
3350
                                    ["secret"])
3386
3351
 
3400
3365
            server_settings=server_settings)
3401
3366
 
3402
3367
    if not tcp_server.clients:
3403
 
        log.warning("No clients defined")
 
3368
        logger.warning("No clients defined")
3404
3369
 
3405
3370
    if not foreground:
3406
3371
        if pidfile is not None:
3409
3374
                with pidfile:
3410
3375
                    print(pid, file=pidfile)
3411
3376
            except IOError:
3412
 
                log.error("Could not write to file %r with PID %d",
3413
 
                          pidfilename, pid)
 
3377
                logger.error("Could not write to file %r with PID %d",
 
3378
                             pidfilename, pid)
3414
3379
        del pidfile
3415
3380
        del pidfilename
3416
3381
 
3566
3531
 
3567
3532
        try:
3568
3533
            with tempfile.NamedTemporaryFile(
3569
 
                    mode="wb",
 
3534
                    mode='wb',
3570
3535
                    suffix=".pickle",
3571
 
                    prefix="clients-",
 
3536
                    prefix='clients-',
3572
3537
                    dir=os.path.dirname(stored_state_path),
3573
3538
                    delete=False) as stored_state:
3574
3539
                pickle.dump((clients, client_settings), stored_state,
3582
3547
                except NameError:
3583
3548
                    pass
3584
3549
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3585
 
                log.warning("Could not save persistent state: %s",
3586
 
                            os.strerror(e.errno))
 
3550
                logger.warning("Could not save persistent state: {}"
 
3551
                               .format(os.strerror(e.errno)))
3587
3552
            else:
3588
 
                log.warning("Could not save persistent state:",
3589
 
                            exc_info=e)
 
3553
                logger.warning("Could not save persistent state:",
 
3554
                               exc_info=e)
3590
3555
                raise
3591
3556
 
3592
3557
        # Delete all clients, and settings from config
3618
3583
    if zeroconf:
3619
3584
        service.port = tcp_server.socket.getsockname()[1]
3620
3585
    if use_ipv6:
3621
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3622
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3586
        logger.info("Now listening on address %r, port %d,"
 
3587
                    " flowinfo %d, scope_id %d",
 
3588
                    *tcp_server.socket.getsockname())
3623
3589
    else:                       # IPv4
3624
 
        log.info("Now listening on address %r, port %d",
3625
 
                 *tcp_server.socket.getsockname())
 
3590
        logger.info("Now listening on address %r, port %d",
 
3591
                    *tcp_server.socket.getsockname())
3626
3592
 
3627
3593
    # service.interface = tcp_server.socket.getsockname()[3]
3628
3594
 
3632
3598
            try:
3633
3599
                service.activate()
3634
3600
            except dbus.exceptions.DBusException as error:
3635
 
                log.critical("D-Bus Exception", exc_info=error)
 
3601
                logger.critical("D-Bus Exception", exc_info=error)
3636
3602
                cleanup()
3637
3603
                sys.exit(1)
3638
3604
            # End of Avahi example code
3643
3609
            lambda *args, **kwargs: (tcp_server.handle_request
3644
3610
                                     (*args[2:], **kwargs) or True))
3645
3611
 
3646
 
        log.debug("Starting main loop")
 
3612
        logger.debug("Starting main loop")
3647
3613
        main_loop.run()
3648
3614
    except AvahiError as error:
3649
 
        log.critical("Avahi Error", exc_info=error)
 
3615
        logger.critical("Avahi Error", exc_info=error)
3650
3616
        cleanup()
3651
3617
        sys.exit(1)
3652
3618
    except KeyboardInterrupt:
3653
3619
        if debug:
3654
3620
            print("", file=sys.stderr)
3655
 
        log.debug("Server received KeyboardInterrupt")
3656
 
    log.debug("Server exiting")
 
3621
        logger.debug("Server received KeyboardInterrupt")
 
3622
    logger.debug("Server exiting")
3657
3623
    # Must run before the D-Bus bus name gets deregistered
3658
3624
    cleanup()
3659
3625
 
3660
3626
 
3661
 
def parse_test_args():
3662
 
    # type: () -> argparse.Namespace
 
3627
def should_only_run_tests():
3663
3628
    parser = argparse.ArgumentParser(add_help=False)
3664
 
    parser.add_argument("--check", action="store_true")
3665
 
    parser.add_argument("--prefix", )
 
3629
    parser.add_argument("--check", action='store_true')
3666
3630
    args, unknown_args = parser.parse_known_args()
3667
 
    if args.check:
3668
 
        # Remove test options from sys.argv
 
3631
    run_tests = args.check
 
3632
    if run_tests:
 
3633
        # Remove --check argument from sys.argv
3669
3634
        sys.argv[1:] = unknown_args
3670
 
    return args
 
3635
    return run_tests
3671
3636
 
3672
3637
# Add all tests from doctest strings
3673
3638
def load_tests(loader, tests, none):
3675
3640
    tests.addTests(doctest.DocTestSuite())
3676
3641
    return tests
3677
3642
 
3678
 
if __name__ == "__main__":
3679
 
    options = parse_test_args()
 
3643
if __name__ == '__main__':
3680
3644
    try:
3681
 
        if options.check:
3682
 
            extra_test_prefix = options.prefix
3683
 
            if extra_test_prefix is not None:
3684
 
                if not (unittest.main(argv=[""], exit=False)
3685
 
                        .result.wasSuccessful()):
3686
 
                    sys.exit(1)
3687
 
                class ExtraTestLoader(unittest.TestLoader):
3688
 
                    testMethodPrefix = extra_test_prefix
3689
 
                # Call using ./scriptname --test [--verbose]
3690
 
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
3691
 
            else:
3692
 
                unittest.main(argv=[""])
 
3645
        if should_only_run_tests():
 
3646
            # Call using ./mandos --check [--verbose]
 
3647
            unittest.main()
3693
3648
        else:
3694
3649
            main()
3695
3650
    finally:
3696
3651
        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: