/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: 2021-02-03 08:33:43 UTC
  • Revision ID: teddy@recompile.se-20210203083343-spdbhxgd5v8e3lv9
Update copyright year

* debian/copyright: Update copyright year to 2021.
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: Update copyright year to 2020.
* intro.xml: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: Update copyright year
  to 2021.
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

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-2020 Teddy Hogeborn
 
15
# Copyright © 2008-2020 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 unittest
80
81
import random
81
82
import shlex
82
83
 
93
94
if sys.version_info.major == 2:
94
95
    __metaclass__ = type
95
96
    str = unicode
96
 
    input = raw_input
97
97
 
98
98
# Add collections.abc.Callable if it does not exist
99
99
try:
110
110
except AttributeError:
111
111
    shlex.quote = re.escape
112
112
 
113
 
# Add os.set_inheritable if it does not exist
114
 
try:
115
 
    os.set_inheritable
116
 
except AttributeError:
117
 
    def set_inheritable(fd, inheritable):
118
 
        flags = fcntl.fcntl(fd, fcntl.F_GETFD)
119
 
        if inheritable and ((flags & fcntl.FD_CLOEXEC) != 0):
120
 
            fcntl.fcntl(fd, fcntl.F_SETFL, flags & ~fcntl.FD_CLOEXEC)
121
 
        elif (not inheritable) and ((flags & fcntl.FD_CLOEXEC) == 0):
122
 
            fcntl.fcntl(fd, fcntl.F_SETFL, flags | fcntl.FD_CLOEXEC)
123
 
    os.set_inheritable = set_inheritable
124
 
    del set_inheritable
125
 
 
126
113
# Show warnings by default
127
114
if not sys.warnoptions:
128
115
    import warnings
156
143
if sys.version_info < (3, 2):
157
144
    configparser.Configparser = configparser.SafeConfigParser
158
145
 
159
 
version = "1.8.18"
 
146
version = "1.8.13"
160
147
stored_state_file = "clients.pickle"
161
148
 
162
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
149
logger = logging.getLogger()
163
150
logging.captureWarnings(True)   # Show warnings via the logging system
164
151
syslogger = None
165
152
 
202
189
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
203
190
        address="/dev/log"))
204
191
    syslogger.setFormatter(logging.Formatter
205
 
                           ("Mandos [%(process)d]: %(levelname)s:"
206
 
                            " %(message)s"))
207
 
    log.addHandler(syslogger)
 
192
                           ('Mandos [%(process)d]: %(levelname)s:'
 
193
                            ' %(message)s'))
 
194
    logger.addHandler(syslogger)
208
195
 
209
196
    if debug:
210
197
        console = logging.StreamHandler()
211
 
        console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
212
 
                                               " [%(process)d]:"
213
 
                                               " %(levelname)s:"
214
 
                                               " %(message)s"))
215
 
        log.addHandler(console)
216
 
    log.setLevel(level)
 
198
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
199
                                               ' [%(process)d]:'
 
200
                                               ' %(levelname)s:'
 
201
                                               ' %(message)s'))
 
202
        logger.addHandler(console)
 
203
    logger.setLevel(level)
217
204
 
218
205
 
219
206
class PGPError(Exception):
237
224
        except OSError as e:
238
225
            if e.errno != errno.ENOENT:
239
226
                raise
240
 
        self.gnupgargs = ["--batch",
241
 
                          "--homedir", self.tempdir,
242
 
                          "--force-mdc",
243
 
                          "--quiet"]
 
227
        self.gnupgargs = ['--batch',
 
228
                          '--homedir', self.tempdir,
 
229
                          '--force-mdc',
 
230
                          '--quiet']
244
231
        # Only GPG version 1 has the --no-use-agent option.
245
232
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
246
233
            self.gnupgargs.append("--no-use-agent")
285
272
                dir=self.tempdir) as passfile:
286
273
            passfile.write(passphrase)
287
274
            passfile.flush()
288
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
289
 
                                     "--passphrase-file",
 
275
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
276
                                     '--passphrase-file',
290
277
                                     passfile.name]
291
278
                                    + self.gnupgargs,
292
279
                                    stdin=subprocess.PIPE,
303
290
                dir=self.tempdir) as passfile:
304
291
            passfile.write(passphrase)
305
292
            passfile.flush()
306
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
307
 
                                     "--passphrase-file",
 
293
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
294
                                     '--passphrase-file',
308
295
                                     passfile.name]
309
296
                                    + self.gnupgargs,
310
297
                                    stdin=subprocess.PIPE,
363
350
    Attributes:
364
351
    interface: integer; avahi.IF_UNSPEC or an interface index.
365
352
               Used to optionally bind to the specified interface.
366
 
    name: string; Example: "Mandos"
367
 
    type: string; Example: "_mandos._tcp".
 
353
    name: string; Example: 'Mandos'
 
354
    type: string; Example: '_mandos._tcp'.
368
355
     See <https://www.iana.org/assignments/service-names-port-numbers>
369
356
    port: integer; what port to announce
370
357
    TXT: list of strings; TXT record for the service
407
394
    def rename(self, remove=True):
408
395
        """Derived from the Avahi example code"""
409
396
        if self.rename_count >= self.max_renames:
410
 
            log.critical("No suitable Zeroconf service name found"
411
 
                         " after %i retries, exiting.",
412
 
                         self.rename_count)
 
397
            logger.critical("No suitable Zeroconf service name found"
 
398
                            " after %i retries, exiting.",
 
399
                            self.rename_count)
413
400
            raise AvahiServiceError("Too many renames")
414
401
        self.name = str(
415
402
            self.server.GetAlternativeServiceName(self.name))
416
403
        self.rename_count += 1
417
 
        log.info("Changing Zeroconf service name to %r ...",
418
 
                 self.name)
 
404
        logger.info("Changing Zeroconf service name to %r ...",
 
405
                    self.name)
419
406
        if remove:
420
407
            self.remove()
421
408
        try:
423
410
        except dbus.exceptions.DBusException as error:
424
411
            if (error.get_dbus_name()
425
412
                == "org.freedesktop.Avahi.CollisionError"):
426
 
                log.info("Local Zeroconf service name collision.")
 
413
                logger.info("Local Zeroconf service name collision.")
427
414
                return self.rename(remove=False)
428
415
            else:
429
 
                log.critical("D-Bus Exception", exc_info=error)
 
416
                logger.critical("D-Bus Exception", exc_info=error)
430
417
                self.cleanup()
431
418
                os._exit(1)
432
419
 
448
435
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
449
436
        self.entry_group_state_changed_match = (
450
437
            self.group.connect_to_signal(
451
 
                "StateChanged", self.entry_group_state_changed))
452
 
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
453
 
                  self.name, self.type)
 
438
                'StateChanged', self.entry_group_state_changed))
 
439
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
440
                     self.name, self.type)
454
441
        self.group.AddService(
455
442
            self.interface,
456
443
            self.protocol,
463
450
 
464
451
    def entry_group_state_changed(self, state, error):
465
452
        """Derived from the Avahi example code"""
466
 
        log.debug("Avahi entry group state change: %i", state)
 
453
        logger.debug("Avahi entry group state change: %i", state)
467
454
 
468
455
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
469
 
            log.debug("Zeroconf service established.")
 
456
            logger.debug("Zeroconf service established.")
470
457
        elif state == avahi.ENTRY_GROUP_COLLISION:
471
 
            log.info("Zeroconf service name collision.")
 
458
            logger.info("Zeroconf service name collision.")
472
459
            self.rename()
473
460
        elif state == avahi.ENTRY_GROUP_FAILURE:
474
 
            log.critical("Avahi: Error in group state changed %s",
475
 
                         str(error))
 
461
            logger.critical("Avahi: Error in group state changed %s",
 
462
                            str(error))
476
463
            raise AvahiGroupError("State changed: {!s}".format(error))
477
464
 
478
465
    def cleanup(self):
488
475
 
489
476
    def server_state_changed(self, state, error=None):
490
477
        """Derived from the Avahi example code"""
491
 
        log.debug("Avahi server state change: %i", state)
 
478
        logger.debug("Avahi server state change: %i", state)
492
479
        bad_states = {
493
480
            avahi.SERVER_INVALID: "Zeroconf server invalid",
494
481
            avahi.SERVER_REGISTERING: None,
498
485
        if state in bad_states:
499
486
            if bad_states[state] is not None:
500
487
                if error is None:
501
 
                    log.error(bad_states[state])
 
488
                    logger.error(bad_states[state])
502
489
                else:
503
 
                    log.error(bad_states[state] + ": %r", error)
 
490
                    logger.error(bad_states[state] + ": %r", error)
504
491
            self.cleanup()
505
492
        elif state == avahi.SERVER_RUNNING:
506
493
            try:
508
495
            except dbus.exceptions.DBusException as error:
509
496
                if (error.get_dbus_name()
510
497
                    == "org.freedesktop.Avahi.CollisionError"):
511
 
                    log.info("Local Zeroconf service name collision.")
 
498
                    logger.info("Local Zeroconf service name"
 
499
                                " collision.")
512
500
                    return self.rename(remove=False)
513
501
                else:
514
 
                    log.critical("D-Bus Exception", exc_info=error)
 
502
                    logger.critical("D-Bus Exception", exc_info=error)
515
503
                    self.cleanup()
516
504
                    os._exit(1)
517
505
        else:
518
506
            if error is None:
519
 
                log.debug("Unknown state: %r", state)
 
507
                logger.debug("Unknown state: %r", state)
520
508
            else:
521
 
                log.debug("Unknown state: %r: %r", state, error)
 
509
                logger.debug("Unknown state: %r: %r", state, error)
522
510
 
523
511
    def activate(self):
524
512
        """Derived from the Avahi example code"""
539
527
        ret = super(AvahiServiceToSyslog, self).rename(*args,
540
528
                                                       **kwargs)
541
529
        syslogger.setFormatter(logging.Formatter(
542
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
530
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
543
531
            .format(self.name)))
544
532
        return ret
545
533
 
575
563
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
576
564
 
577
565
    # Types
578
 
    class _session_int(ctypes.Structure):
 
566
    class session_int(ctypes.Structure):
579
567
        _fields_ = []
580
 
    session_t = ctypes.POINTER(_session_int)
 
568
    session_t = ctypes.POINTER(session_int)
581
569
 
582
570
    class certificate_credentials_st(ctypes.Structure):
583
571
        _fields_ = []
586
574
    certificate_type_t = ctypes.c_int
587
575
 
588
576
    class datum_t(ctypes.Structure):
589
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
590
 
                    ("size", ctypes.c_uint)]
 
577
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
578
                    ('size', ctypes.c_uint)]
591
579
 
592
 
    class _openpgp_crt_int(ctypes.Structure):
 
580
    class openpgp_crt_int(ctypes.Structure):
593
581
        _fields_ = []
594
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
582
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
595
583
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
596
584
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
597
585
    credentials_type_t = ctypes.c_int
606
594
            # gnutls.strerror()
607
595
            self.code = code
608
596
            if message is None and code is not None:
609
 
                message = gnutls.strerror(code).decode(
610
 
                    "utf-8", errors="replace")
 
597
                message = gnutls.strerror(code)
611
598
            return super(gnutls.Error, self).__init__(
612
599
                message, *args)
613
600
 
614
601
    class CertificateSecurityError(Error):
615
602
        pass
616
603
 
617
 
    class PointerTo:
618
 
        def __init__(self, cls):
619
 
            self.cls = cls
620
 
 
621
 
        def from_param(self, obj):
622
 
            if not isinstance(obj, self.cls):
623
 
                raise TypeError("Not of type {}: {!r}"
624
 
                                .format(self.cls.__name__, obj))
625
 
            return ctypes.byref(obj.from_param(obj))
626
 
 
627
 
    class CastToVoidPointer:
628
 
        def __init__(self, cls):
629
 
            self.cls = cls
630
 
 
631
 
        def from_param(self, obj):
632
 
            if not isinstance(obj, self.cls):
633
 
                raise TypeError("Not of type {}: {!r}"
634
 
                                .format(self.cls.__name__, obj))
635
 
            return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
636
 
 
637
 
    class With_from_param:
638
 
        @classmethod
639
 
        def from_param(cls, obj):
640
 
            return obj._as_parameter_
641
 
 
642
604
    # Classes
643
 
    class Credentials(With_from_param):
 
605
    class Credentials:
644
606
        def __init__(self):
645
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
646
 
            gnutls.certificate_allocate_credentials(self)
 
607
            self._c_object = gnutls.certificate_credentials_t()
 
608
            gnutls.certificate_allocate_credentials(
 
609
                ctypes.byref(self._c_object))
647
610
            self.type = gnutls.CRD_CERTIFICATE
648
611
 
649
612
        def __del__(self):
650
 
            gnutls.certificate_free_credentials(self)
 
613
            gnutls.certificate_free_credentials(self._c_object)
651
614
 
652
 
    class ClientSession(With_from_param):
 
615
    class ClientSession:
653
616
        def __init__(self, socket, credentials=None):
654
 
            self._as_parameter_ = gnutls.session_t()
 
617
            self._c_object = gnutls.session_t()
655
618
            gnutls_flags = gnutls.CLIENT
656
619
            if gnutls.check_version(b"3.5.6"):
657
620
                gnutls_flags |= gnutls.NO_TICKETS
658
621
            if gnutls.has_rawpk:
659
622
                gnutls_flags |= gnutls.ENABLE_RAWPK
660
 
            gnutls.init(self, gnutls_flags)
 
623
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
661
624
            del gnutls_flags
662
 
            gnutls.set_default_priority(self)
663
 
            gnutls.transport_set_ptr(self, socket.fileno())
664
 
            gnutls.handshake_set_private_extensions(self, True)
 
625
            gnutls.set_default_priority(self._c_object)
 
626
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
627
            gnutls.handshake_set_private_extensions(self._c_object,
 
628
                                                    True)
665
629
            self.socket = socket
666
630
            if credentials is None:
667
631
                credentials = gnutls.Credentials()
668
 
            gnutls.credentials_set(self, credentials.type,
669
 
                                   credentials)
 
632
            gnutls.credentials_set(self._c_object, credentials.type,
 
633
                                   ctypes.cast(credentials._c_object,
 
634
                                               ctypes.c_void_p))
670
635
            self.credentials = credentials
671
636
 
672
637
        def __del__(self):
673
 
            gnutls.deinit(self)
 
638
            gnutls.deinit(self._c_object)
674
639
 
675
640
        def handshake(self):
676
 
            return gnutls.handshake(self)
 
641
            return gnutls.handshake(self._c_object)
677
642
 
678
643
        def send(self, data):
679
644
            data = bytes(data)
680
645
            data_len = len(data)
681
646
            while data_len > 0:
682
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
647
                data_len -= gnutls.record_send(self._c_object,
 
648
                                               data[-data_len:],
683
649
                                               data_len)
684
650
 
685
651
        def bye(self):
686
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
652
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
687
653
 
688
654
    # Error handling functions
689
655
    def _error_code(result):
690
656
        """A function to raise exceptions on errors, suitable
691
 
        for the "restype" attribute on ctypes functions"""
692
 
        if result >= gnutls.E_SUCCESS:
 
657
        for the 'restype' attribute on ctypes functions"""
 
658
        if result >= 0:
693
659
            return result
694
660
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
695
661
            raise gnutls.CertificateSecurityError(code=result)
696
662
        raise gnutls.Error(code=result)
697
663
 
698
 
    def _retry_on_error(result, func, arguments,
699
 
                        _error_code=_error_code):
 
664
    def _retry_on_error(result, func, arguments):
700
665
        """A function to retry on some errors, suitable
701
 
        for the "errcheck" attribute on ctypes functions"""
702
 
        while result < gnutls.E_SUCCESS:
 
666
        for the 'errcheck' attribute on ctypes functions"""
 
667
        while result < 0:
703
668
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
704
669
                return _error_code(result)
705
670
            result = func(*arguments)
710
675
 
711
676
    # Functions
712
677
    priority_set_direct = _library.gnutls_priority_set_direct
713
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
678
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
714
679
                                    ctypes.POINTER(ctypes.c_char_p)]
715
680
    priority_set_direct.restype = _error_code
716
681
 
717
682
    init = _library.gnutls_init
718
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
683
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
719
684
    init.restype = _error_code
720
685
 
721
686
    set_default_priority = _library.gnutls_set_default_priority
722
 
    set_default_priority.argtypes = [ClientSession]
 
687
    set_default_priority.argtypes = [session_t]
723
688
    set_default_priority.restype = _error_code
724
689
 
725
690
    record_send = _library.gnutls_record_send
726
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
691
    record_send.argtypes = [session_t, ctypes.c_void_p,
727
692
                            ctypes.c_size_t]
728
693
    record_send.restype = ctypes.c_ssize_t
729
694
    record_send.errcheck = _retry_on_error
731
696
    certificate_allocate_credentials = (
732
697
        _library.gnutls_certificate_allocate_credentials)
733
698
    certificate_allocate_credentials.argtypes = [
734
 
        PointerTo(Credentials)]
 
699
        ctypes.POINTER(certificate_credentials_t)]
735
700
    certificate_allocate_credentials.restype = _error_code
736
701
 
737
702
    certificate_free_credentials = (
738
703
        _library.gnutls_certificate_free_credentials)
739
 
    certificate_free_credentials.argtypes = [Credentials]
 
704
    certificate_free_credentials.argtypes = [
 
705
        certificate_credentials_t]
740
706
    certificate_free_credentials.restype = None
741
707
 
742
708
    handshake_set_private_extensions = (
743
709
        _library.gnutls_handshake_set_private_extensions)
744
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
710
    handshake_set_private_extensions.argtypes = [session_t,
745
711
                                                 ctypes.c_int]
746
712
    handshake_set_private_extensions.restype = None
747
713
 
748
714
    credentials_set = _library.gnutls_credentials_set
749
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
750
 
                                CastToVoidPointer(Credentials)]
 
715
    credentials_set.argtypes = [session_t, credentials_type_t,
 
716
                                ctypes.c_void_p]
751
717
    credentials_set.restype = _error_code
752
718
 
753
719
    strerror = _library.gnutls_strerror
755
721
    strerror.restype = ctypes.c_char_p
756
722
 
757
723
    certificate_type_get = _library.gnutls_certificate_type_get
758
 
    certificate_type_get.argtypes = [ClientSession]
 
724
    certificate_type_get.argtypes = [session_t]
759
725
    certificate_type_get.restype = _error_code
760
726
 
761
727
    certificate_get_peers = _library.gnutls_certificate_get_peers
762
 
    certificate_get_peers.argtypes = [ClientSession,
 
728
    certificate_get_peers.argtypes = [session_t,
763
729
                                      ctypes.POINTER(ctypes.c_uint)]
764
730
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
765
731
 
772
738
    global_set_log_function.restype = None
773
739
 
774
740
    deinit = _library.gnutls_deinit
775
 
    deinit.argtypes = [ClientSession]
 
741
    deinit.argtypes = [session_t]
776
742
    deinit.restype = None
777
743
 
778
744
    handshake = _library.gnutls_handshake
779
 
    handshake.argtypes = [ClientSession]
780
 
    handshake.restype = ctypes.c_int
 
745
    handshake.argtypes = [session_t]
 
746
    handshake.restype = _error_code
781
747
    handshake.errcheck = _retry_on_error
782
748
 
783
749
    transport_set_ptr = _library.gnutls_transport_set_ptr
784
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
750
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
785
751
    transport_set_ptr.restype = None
786
752
 
787
753
    bye = _library.gnutls_bye
788
 
    bye.argtypes = [ClientSession, close_request_t]
789
 
    bye.restype = ctypes.c_int
 
754
    bye.argtypes = [session_t, close_request_t]
 
755
    bye.restype = _error_code
790
756
    bye.errcheck = _retry_on_error
791
757
 
792
758
    check_version = _library.gnutls_check_version
866
832
 
867
833
    if check_version(b"3.6.4"):
868
834
        certificate_type_get2 = _library.gnutls_certificate_type_get2
869
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
835
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
870
836
        certificate_type_get2.restype = _error_code
871
837
 
872
838
    # Remove non-public functions
888
854
    """A representation of a client host served by this server.
889
855
 
890
856
    Attributes:
891
 
    approved:   bool(); None if not yet approved/disapproved
 
857
    approved:   bool(); 'None' if not yet approved/disapproved
892
858
    approval_delay: datetime.timedelta(); Time to wait for approval
893
859
    approval_duration: datetime.timedelta(); Duration of one approval
894
860
    checker: multiprocessing.Process(); a running checker process used
895
 
             to see if the client lives. None if no process is
 
861
             to see if the client lives. 'None' if no process is
896
862
             running.
897
863
    checker_callback_tag: a GLib event source tag, or None
898
864
    checker_command: string; External command which is run to check
974
940
            # key_id() and fingerprint() functions
975
941
            client["key_id"] = (section.get("key_id", "").upper()
976
942
                                .replace(" ", ""))
977
 
            client["fingerprint"] = (section.get("fingerprint",
978
 
                                                 "").upper()
 
943
            client["fingerprint"] = (section["fingerprint"].upper()
979
944
                                     .replace(" ", ""))
980
 
            if not (client["key_id"] or client["fingerprint"]):
981
 
                log.error("Skipping client %s without key_id or"
982
 
                          " fingerprint", client_name)
983
 
                del settings[client_name]
984
 
                continue
985
945
            if "secret" in section:
986
946
                client["secret"] = codecs.decode(section["secret"]
987
947
                                                 .encode("utf-8"),
1028
988
            self.last_enabled = None
1029
989
            self.expires = None
1030
990
 
1031
 
        log.debug("Creating client %r", self.name)
1032
 
        log.debug("  Key ID: %s", self.key_id)
1033
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
991
        logger.debug("Creating client %r", self.name)
 
992
        logger.debug("  Key ID: %s", self.key_id)
 
993
        logger.debug("  Fingerprint: %s", self.fingerprint)
1034
994
        self.created = settings.get("created",
1035
995
                                    datetime.datetime.utcnow())
1036
996
 
1064
1024
        if getattr(self, "enabled", False):
1065
1025
            # Already enabled
1066
1026
            return
 
1027
        self.expires = datetime.datetime.utcnow() + self.timeout
1067
1028
        self.enabled = True
1068
1029
        self.last_enabled = datetime.datetime.utcnow()
1069
1030
        self.init_checker()
1074
1035
        if not getattr(self, "enabled", False):
1075
1036
            return False
1076
1037
        if not quiet:
1077
 
            log.info("Disabling client %s", self.name)
 
1038
            logger.info("Disabling client %s", self.name)
1078
1039
        if getattr(self, "disable_initiator_tag", None) is not None:
1079
1040
            GLib.source_remove(self.disable_initiator_tag)
1080
1041
            self.disable_initiator_tag = None
1092
1053
    def __del__(self):
1093
1054
        self.disable()
1094
1055
 
1095
 
    def init_checker(self, randomize_start=False):
1096
 
        # Schedule a new checker to be started a randomly selected
1097
 
        # time (a fraction of 'interval') from now.  This spreads out
1098
 
        # the startup of checkers over time when the server is
1099
 
        # started.
 
1056
    def init_checker(self):
 
1057
        # Schedule a new checker to be started an 'interval' from now,
 
1058
        # and every interval from then on.
1100
1059
        if self.checker_initiator_tag is not None:
1101
1060
            GLib.source_remove(self.checker_initiator_tag)
1102
 
        interval_milliseconds = int(self.interval.total_seconds()
1103
 
                                    * 1000)
1104
 
        if randomize_start:
1105
 
            delay_milliseconds = random.randrange(
1106
 
                interval_milliseconds + 1)
1107
 
        else:
1108
 
            delay_milliseconds = interval_milliseconds
1109
1061
        self.checker_initiator_tag = GLib.timeout_add(
1110
 
            delay_milliseconds, self.start_checker, randomize_start)
1111
 
        delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1112
 
        # A checker might take up to an 'interval' of time, so we can
1113
 
        # expire at the soonest one interval after a checker was
1114
 
        # started.  Since the initial checker is delayed, the expire
1115
 
        # time might have to be extended.
1116
 
        now = datetime.datetime.utcnow()
1117
 
        self.expires = now + delay + self.interval
1118
 
        # Schedule a disable() at expire time
 
1062
            random.randrange(int(self.interval.total_seconds() * 1000
 
1063
                                 + 1)),
 
1064
            self.start_checker)
 
1065
        # Schedule a disable() when 'timeout' has passed
1119
1066
        if self.disable_initiator_tag is not None:
1120
1067
            GLib.source_remove(self.disable_initiator_tag)
1121
1068
        self.disable_initiator_tag = GLib.timeout_add(
1122
 
            int((self.expires - now).total_seconds() * 1000),
1123
 
            self.disable)
 
1069
            int(self.timeout.total_seconds() * 1000), self.disable)
 
1070
        # Also start a new checker *right now*.
 
1071
        self.start_checker()
1124
1072
 
1125
1073
    def checker_callback(self, source, condition, connection,
1126
1074
                         command):
1137
1085
            self.last_checker_status = returncode
1138
1086
            self.last_checker_signal = None
1139
1087
            if self.last_checker_status == 0:
1140
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1088
                logger.info("Checker for %(name)s succeeded",
 
1089
                            vars(self))
1141
1090
                self.checked_ok()
1142
1091
            else:
1143
 
                log.info("Checker for %(name)s failed", vars(self))
 
1092
                logger.info("Checker for %(name)s failed", vars(self))
1144
1093
        else:
1145
1094
            self.last_checker_status = -1
1146
1095
            self.last_checker_signal = -returncode
1147
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1096
            logger.warning("Checker for %(name)s crashed?",
 
1097
                           vars(self))
1148
1098
        return False
1149
1099
 
1150
1100
    def checked_ok(self):
1169
1119
    def need_approval(self):
1170
1120
        self.last_approval_request = datetime.datetime.utcnow()
1171
1121
 
1172
 
    def start_checker(self, start_was_randomized=False):
 
1122
    def start_checker(self):
1173
1123
        """Start a new checker subprocess if one is not running.
1174
1124
 
1175
1125
        If a checker already exists, leave it running and do
1184
1134
        # should be.
1185
1135
 
1186
1136
        if self.checker is not None and not self.checker.is_alive():
1187
 
            log.warning("Checker was not alive; joining")
 
1137
            logger.warning("Checker was not alive; joining")
1188
1138
            self.checker.join()
1189
1139
            self.checker = None
1190
1140
        # Start a new checker if needed
1196
1146
            try:
1197
1147
                command = self.checker_command % escaped_attrs
1198
1148
            except TypeError as error:
1199
 
                log.error('Could not format string "%s"',
1200
 
                          self.checker_command, exc_info=error)
 
1149
                logger.error('Could not format string "%s"',
 
1150
                             self.checker_command,
 
1151
                             exc_info=error)
1201
1152
                return True     # Try again later
1202
1153
            self.current_checker_command = command
1203
 
            log.info("Starting checker %r for %s", command, self.name)
 
1154
            logger.info("Starting checker %r for %s", command,
 
1155
                        self.name)
1204
1156
            # We don't need to redirect stdout and stderr, since
1205
1157
            # in normal mode, that is already done by daemon(),
1206
1158
            # and in debug mode we don't want to.  (Stdin is
1225
1177
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1226
1178
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1227
1179
                self.checker_callback, pipe[0], command)
1228
 
        if start_was_randomized:
1229
 
            # We were started after a random delay; Schedule a new
1230
 
            # checker to be started an 'interval' from now, and every
1231
 
            # interval from then on.
1232
 
            now = datetime.datetime.utcnow()
1233
 
            self.checker_initiator_tag = GLib.timeout_add(
1234
 
                int(self.interval.total_seconds() * 1000),
1235
 
                self.start_checker)
1236
 
            self.expires = max(self.expires, now + self.interval)
1237
 
            # Don't start a new checker again after same random delay
1238
 
            return False
1239
1180
        # Re-run this periodically if run by GLib.timeout_add
1240
1181
        return True
1241
1182
 
1246
1187
            self.checker_callback_tag = None
1247
1188
        if getattr(self, "checker", None) is None:
1248
1189
            return
1249
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1190
        logger.debug("Stopping checker for %(name)s", vars(self))
1250
1191
        self.checker.terminate()
1251
1192
        self.checker = None
1252
1193
 
1279
1220
        func._dbus_name = func.__name__
1280
1221
        if func._dbus_name.endswith("_dbus_property"):
1281
1222
            func._dbus_name = func._dbus_name[:-14]
1282
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1223
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1283
1224
        return func
1284
1225
 
1285
1226
    return decorator
1374
1315
 
1375
1316
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1376
1317
                         out_signature="s",
1377
 
                         path_keyword="object_path",
1378
 
                         connection_keyword="connection")
 
1318
                         path_keyword='object_path',
 
1319
                         connection_keyword='connection')
1379
1320
    def Introspect(self, object_path, connection):
1380
1321
        """Overloading of standard D-Bus method.
1381
1322
 
1430
1371
            document.unlink()
1431
1372
        except (AttributeError, xml.dom.DOMException,
1432
1373
                xml.parsers.expat.ExpatError) as error:
1433
 
            log.error("Failed to override Introspection method",
1434
 
                      exc_info=error)
 
1374
            logger.error("Failed to override Introspection method",
 
1375
                         exc_info=error)
1435
1376
        return xmlstring
1436
1377
 
1437
1378
 
1534
1475
 
1535
1476
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1536
1477
                         out_signature="s",
1537
 
                         path_keyword="object_path",
1538
 
                         connection_keyword="connection")
 
1478
                         path_keyword='object_path',
 
1479
                         connection_keyword='connection')
1539
1480
    def Introspect(self, object_path, connection):
1540
1481
        """Overloading of standard D-Bus method.
1541
1482
 
1597
1538
            document.unlink()
1598
1539
        except (AttributeError, xml.dom.DOMException,
1599
1540
                xml.parsers.expat.ExpatError) as error:
1600
 
            log.error("Failed to override Introspection method",
1601
 
                      exc_info=error)
 
1541
            logger.error("Failed to override Introspection method",
 
1542
                         exc_info=error)
1602
1543
        return xmlstring
1603
1544
 
1604
1545
 
1636
1577
 
1637
1578
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1638
1579
                         out_signature="s",
1639
 
                         path_keyword="object_path",
1640
 
                         connection_keyword="connection")
 
1580
                         path_keyword='object_path',
 
1581
                         connection_keyword='connection')
1641
1582
    def Introspect(self, object_path, connection):
1642
1583
        """Overloading of standard D-Bus method.
1643
1584
 
1668
1609
            document.unlink()
1669
1610
        except (AttributeError, xml.dom.DOMException,
1670
1611
                xml.parsers.expat.ExpatError) as error:
1671
 
            log.error("Failed to override Introspection method",
1672
 
                      exc_info=error)
 
1612
            logger.error("Failed to override Introspection method",
 
1613
                         exc_info=error)
1673
1614
        return xmlstring
1674
1615
 
1675
1616
 
2309
2250
class ProxyClient:
2310
2251
    def __init__(self, child_pipe, key_id, fpr, address):
2311
2252
        self._pipe = child_pipe
2312
 
        self._pipe.send(("init", key_id, fpr, address))
 
2253
        self._pipe.send(('init', key_id, fpr, address))
2313
2254
        if not self._pipe.recv():
2314
2255
            raise KeyError(key_id or fpr)
2315
2256
 
2316
2257
    def __getattribute__(self, name):
2317
 
        if name == "_pipe":
 
2258
        if name == '_pipe':
2318
2259
            return super(ProxyClient, self).__getattribute__(name)
2319
 
        self._pipe.send(("getattr", name))
 
2260
        self._pipe.send(('getattr', name))
2320
2261
        data = self._pipe.recv()
2321
 
        if data[0] == "data":
 
2262
        if data[0] == 'data':
2322
2263
            return data[1]
2323
 
        if data[0] == "function":
 
2264
        if data[0] == 'function':
2324
2265
 
2325
2266
            def func(*args, **kwargs):
2326
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2267
                self._pipe.send(('funcall', name, args, kwargs))
2327
2268
                return self._pipe.recv()[1]
2328
2269
 
2329
2270
            return func
2330
2271
 
2331
2272
    def __setattr__(self, name, value):
2332
 
        if name == "_pipe":
 
2273
        if name == '_pipe':
2333
2274
            return super(ProxyClient, self).__setattr__(name, value)
2334
 
        self._pipe.send(("setattr", name, value))
 
2275
        self._pipe.send(('setattr', name, value))
2335
2276
 
2336
2277
 
2337
2278
class ClientHandler(socketserver.BaseRequestHandler, object):
2342
2283
 
2343
2284
    def handle(self):
2344
2285
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2345
 
            log.info("TCP connection from: %s",
2346
 
                     str(self.client_address))
2347
 
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
 
2286
            logger.info("TCP connection from: %s",
 
2287
                        str(self.client_address))
 
2288
            logger.debug("Pipe FD: %d",
 
2289
                         self.server.child_pipe.fileno())
2348
2290
 
2349
2291
            session = gnutls.ClientSession(self.request)
2350
2292
 
2351
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2293
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2352
2294
            #                       "+AES-256-CBC", "+SHA1",
2353
2295
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2354
2296
            #                       "+DHE-DSS"))
2356
2298
            priority = self.server.gnutls_priority
2357
2299
            if priority is None:
2358
2300
                priority = "NORMAL"
2359
 
            gnutls.priority_set_direct(session,
2360
 
                                       priority.encode("utf-8"), None)
 
2301
            gnutls.priority_set_direct(session._c_object,
 
2302
                                       priority.encode("utf-8"),
 
2303
                                       None)
2361
2304
 
2362
2305
            # Start communication using the Mandos protocol
2363
2306
            # Get protocol number
2364
2307
            line = self.request.makefile().readline()
2365
 
            log.debug("Protocol version: %r", line)
 
2308
            logger.debug("Protocol version: %r", line)
2366
2309
            try:
2367
2310
                if int(line.strip().split()[0]) > 1:
2368
2311
                    raise RuntimeError(line)
2369
2312
            except (ValueError, IndexError, RuntimeError) as error:
2370
 
                log.error("Unknown protocol version: %s", error)
 
2313
                logger.error("Unknown protocol version: %s", error)
2371
2314
                return
2372
2315
 
2373
2316
            # Start GnuTLS connection
2374
2317
            try:
2375
2318
                session.handshake()
2376
2319
            except gnutls.Error as error:
2377
 
                log.warning("Handshake failed: %s", error)
 
2320
                logger.warning("Handshake failed: %s", error)
2378
2321
                # Do not run session.bye() here: the session is not
2379
2322
                # established.  Just abandon the request.
2380
2323
                return
2381
 
            log.debug("Handshake succeeded")
 
2324
            logger.debug("Handshake succeeded")
2382
2325
 
2383
2326
            approval_required = False
2384
2327
            try:
2388
2331
                        key_id = self.key_id(
2389
2332
                            self.peer_certificate(session))
2390
2333
                    except (TypeError, gnutls.Error) as error:
2391
 
                        log.warning("Bad certificate: %s", error)
 
2334
                        logger.warning("Bad certificate: %s", error)
2392
2335
                        return
2393
 
                    log.debug("Key ID: %s",
2394
 
                              key_id.decode("utf-8",
2395
 
                                            errors="replace"))
 
2336
                    logger.debug("Key ID: %s", key_id)
2396
2337
 
2397
2338
                else:
2398
2339
                    key_id = b""
2400
2341
                        fpr = self.fingerprint(
2401
2342
                            self.peer_certificate(session))
2402
2343
                    except (TypeError, gnutls.Error) as error:
2403
 
                        log.warning("Bad certificate: %s", error)
 
2344
                        logger.warning("Bad certificate: %s", error)
2404
2345
                        return
2405
 
                    log.debug("Fingerprint: %s", fpr)
 
2346
                    logger.debug("Fingerprint: %s", fpr)
2406
2347
 
2407
2348
                try:
2408
2349
                    client = ProxyClient(child_pipe, key_id, fpr,
2417
2358
 
2418
2359
                while True:
2419
2360
                    if not client.enabled:
2420
 
                        log.info("Client %s is disabled", client.name)
 
2361
                        logger.info("Client %s is disabled",
 
2362
                                    client.name)
2421
2363
                        if self.server.use_dbus:
2422
2364
                            # Emit D-Bus signal
2423
2365
                            client.Rejected("Disabled")
2427
2369
                        # We are approved or approval is disabled
2428
2370
                        break
2429
2371
                    elif client.approved is None:
2430
 
                        log.info("Client %s needs approval",
2431
 
                                 client.name)
 
2372
                        logger.info("Client %s needs approval",
 
2373
                                    client.name)
2432
2374
                        if self.server.use_dbus:
2433
2375
                            # Emit D-Bus signal
2434
2376
                            client.NeedApproval(
2435
2377
                                client.approval_delay.total_seconds()
2436
2378
                                * 1000, client.approved_by_default)
2437
2379
                    else:
2438
 
                        log.warning("Client %s was not approved",
2439
 
                                    client.name)
 
2380
                        logger.warning("Client %s was not approved",
 
2381
                                       client.name)
2440
2382
                        if self.server.use_dbus:
2441
2383
                            # Emit D-Bus signal
2442
2384
                            client.Rejected("Denied")
2450
2392
                    time2 = datetime.datetime.now()
2451
2393
                    if (time2 - time) >= delay:
2452
2394
                        if not client.approved_by_default:
2453
 
                            log.warning("Client %s timed out while"
2454
 
                                        " waiting for approval",
2455
 
                                        client.name)
 
2395
                            logger.warning("Client %s timed out while"
 
2396
                                           " waiting for approval",
 
2397
                                           client.name)
2456
2398
                            if self.server.use_dbus:
2457
2399
                                # Emit D-Bus signal
2458
2400
                                client.Rejected("Approval timed out")
2465
2407
                try:
2466
2408
                    session.send(client.secret)
2467
2409
                except gnutls.Error as error:
2468
 
                    log.warning("gnutls send failed", exc_info=error)
 
2410
                    logger.warning("gnutls send failed",
 
2411
                                   exc_info=error)
2469
2412
                    return
2470
2413
 
2471
 
                log.info("Sending secret to %s", client.name)
 
2414
                logger.info("Sending secret to %s", client.name)
2472
2415
                # bump the timeout using extended_timeout
2473
2416
                client.bump_timeout(client.extended_timeout)
2474
2417
                if self.server.use_dbus:
2481
2424
                try:
2482
2425
                    session.bye()
2483
2426
                except gnutls.Error as error:
2484
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2427
                    logger.warning("GnuTLS bye failed",
 
2428
                                   exc_info=error)
2485
2429
 
2486
2430
    @staticmethod
2487
2431
    def peer_certificate(session):
2488
2432
        "Return the peer's certificate as a bytestring"
2489
2433
        try:
2490
 
            cert_type = gnutls.certificate_type_get2(
2491
 
                session, gnutls.CTYPE_PEERS)
 
2434
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2435
                                                     gnutls.CTYPE_PEERS)
2492
2436
        except AttributeError:
2493
 
            cert_type = gnutls.certificate_type_get(session)
 
2437
            cert_type = gnutls.certificate_type_get(session._c_object)
2494
2438
        if gnutls.has_rawpk:
2495
2439
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2496
2440
        else:
2497
2441
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2498
2442
        # If not a valid certificate type...
2499
2443
        if cert_type not in valid_cert_types:
2500
 
            log.info("Cert type %r not in %r", cert_type,
2501
 
                     valid_cert_types)
 
2444
            logger.info("Cert type %r not in %r", cert_type,
 
2445
                        valid_cert_types)
2502
2446
            # ...return invalid data
2503
2447
            return b""
2504
2448
        list_size = ctypes.c_uint(1)
2505
2449
        cert_list = (gnutls.certificate_get_peers
2506
 
                     (session, ctypes.byref(list_size)))
 
2450
                     (session._c_object, ctypes.byref(list_size)))
2507
2451
        if not bool(cert_list) and list_size.value != 0:
2508
2452
            raise gnutls.Error("error getting peer certificate")
2509
2453
        if list_size.value == 0:
2623
2567
 
2624
2568
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2625
2569
                     socketserver.TCPServer):
2626
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2570
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2627
2571
 
2628
2572
    Attributes:
2629
2573
        enabled:        Boolean; whether this server is activated yet
2680
2624
            if SO_BINDTODEVICE is None:
2681
2625
                # Fall back to a hard-coded value which seems to be
2682
2626
                # common enough.
2683
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2627
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2684
2628
                SO_BINDTODEVICE = 25
2685
2629
            try:
2686
2630
                self.socket.setsockopt(
2688
2632
                    (self.interface + "\0").encode("utf-8"))
2689
2633
            except socket.error as error:
2690
2634
                if error.errno == errno.EPERM:
2691
 
                    log.error("No permission to bind to interface %s",
2692
 
                              self.interface)
 
2635
                    logger.error("No permission to bind to"
 
2636
                                 " interface %s", self.interface)
2693
2637
                elif error.errno == errno.ENOPROTOOPT:
2694
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2695
 
                              " bind to interface %s", self.interface)
 
2638
                    logger.error("SO_BINDTODEVICE not available;"
 
2639
                                 " cannot bind to interface %s",
 
2640
                                 self.interface)
2696
2641
                elif error.errno == errno.ENODEV:
2697
 
                    log.error("Interface %s does not exist, cannot"
2698
 
                              " bind", self.interface)
 
2642
                    logger.error("Interface %s does not exist,"
 
2643
                                 " cannot bind", self.interface)
2699
2644
                else:
2700
2645
                    raise
2701
2646
        # Only bind(2) the socket if we really need to.
2780
2725
        request = parent_pipe.recv()
2781
2726
        command = request[0]
2782
2727
 
2783
 
        if command == "init":
 
2728
        if command == 'init':
2784
2729
            key_id = request[1].decode("ascii")
2785
2730
            fpr = request[2].decode("ascii")
2786
2731
            address = request[3]
2796
2741
                    client = c
2797
2742
                    break
2798
2743
            else:
2799
 
                log.info("Client not found for key ID: %s, address:"
2800
 
                         " %s", key_id or fpr, address)
 
2744
                logger.info("Client not found for key ID: %s, address"
 
2745
                            ": %s", key_id or fpr, address)
2801
2746
                if self.use_dbus:
2802
2747
                    # Emit D-Bus signal
2803
2748
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2816
2761
            # remove the old hook in favor of the new above hook on
2817
2762
            # same fileno
2818
2763
            return False
2819
 
        if command == "funcall":
 
2764
        if command == 'funcall':
2820
2765
            funcname = request[1]
2821
2766
            args = request[2]
2822
2767
            kwargs = request[3]
2823
2768
 
2824
 
            parent_pipe.send(("data", getattr(client_object,
 
2769
            parent_pipe.send(('data', getattr(client_object,
2825
2770
                                              funcname)(*args,
2826
2771
                                                        **kwargs)))
2827
2772
 
2828
 
        if command == "getattr":
 
2773
        if command == 'getattr':
2829
2774
            attrname = request[1]
2830
2775
            if isinstance(client_object.__getattribute__(attrname),
2831
2776
                          collections.abc.Callable):
2832
 
                parent_pipe.send(("function", ))
 
2777
                parent_pipe.send(('function', ))
2833
2778
            else:
2834
2779
                parent_pipe.send((
2835
 
                    "data", client_object.__getattribute__(attrname)))
 
2780
                    'data', client_object.__getattribute__(attrname)))
2836
2781
 
2837
 
        if command == "setattr":
 
2782
        if command == 'setattr':
2838
2783
            attrname = request[1]
2839
2784
            value = request[2]
2840
2785
            setattr(client_object, attrname, value)
2946
2891
def string_to_delta(interval):
2947
2892
    """Parse a string and return a datetime.timedelta
2948
2893
 
2949
 
    >>> string_to_delta("7d") == datetime.timedelta(7)
2950
 
    True
2951
 
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
2952
 
    True
2953
 
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2954
 
    True
2955
 
    >>> string_to_delta("24h") == datetime.timedelta(1)
2956
 
    True
2957
 
    >>> string_to_delta("1w") == datetime.timedelta(7)
2958
 
    True
2959
 
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
 
2894
    >>> string_to_delta('7d') == datetime.timedelta(7)
 
2895
    True
 
2896
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
 
2897
    True
 
2898
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
 
2899
    True
 
2900
    >>> string_to_delta('24h') == datetime.timedelta(1)
 
2901
    True
 
2902
    >>> string_to_delta('1w') == datetime.timedelta(7)
 
2903
    True
 
2904
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2960
2905
    True
2961
2906
    """
2962
2907
 
3109
3054
        # Later, stdin will, and stdout and stderr might, be dup'ed
3110
3055
        # over with an opened os.devnull.  But we don't want this to
3111
3056
        # happen with a supplied network socket.
3112
 
        while 0 <= server_settings["socket"] <= 2:
 
3057
        if 0 <= server_settings["socket"] <= 2:
3113
3058
            server_settings["socket"] = os.dup(server_settings
3114
3059
                                               ["socket"])
3115
 
        os.set_inheritable(server_settings["socket"], False)
3116
3060
    del server_config
3117
3061
 
3118
3062
    # Override the settings from the config file with command line
3167
3111
 
3168
3112
    if server_settings["servicename"] != "Mandos":
3169
3113
        syslogger.setFormatter(
3170
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3171
 
                              " %(levelname)s: %(message)s".format(
 
3114
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3115
                              ' %(levelname)s: %(message)s'.format(
3172
3116
                                  server_settings["servicename"])))
3173
3117
 
3174
3118
    # Parse config file with clients
3198
3142
        try:
3199
3143
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3200
3144
        except IOError as e:
3201
 
            log.error("Could not open file %r", pidfilename,
3202
 
                      exc_info=e)
 
3145
            logger.error("Could not open file %r", pidfilename,
 
3146
                         exc_info=e)
3203
3147
 
3204
3148
    for name, group in (("_mandos", "_mandos"),
3205
3149
                        ("mandos", "mandos"),
3216
3160
    try:
3217
3161
        os.setgid(gid)
3218
3162
        os.setuid(uid)
3219
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3163
        if debug:
 
3164
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3165
                                                             gid))
3220
3166
    except OSError as error:
3221
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3222
 
                    os.strerror(error.errno))
 
3167
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3168
                       .format(uid, gid, os.strerror(error.errno)))
3223
3169
        if error.errno != errno.EPERM:
3224
3170
            raise
3225
3171
 
3232
3178
 
3233
3179
        @gnutls.log_func
3234
3180
        def debug_gnutls(level, string):
3235
 
            log.debug("GnuTLS: %s",
3236
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3181
            logger.debug("GnuTLS: %s", string[:-1])
3237
3182
 
3238
3183
        gnutls.global_set_log_function(debug_gnutls)
3239
3184
 
3257
3202
    # From the Avahi example code
3258
3203
    DBusGMainLoop(set_as_default=True)
3259
3204
    main_loop = GLib.MainLoop()
3260
 
    if use_dbus or zeroconf:
3261
 
        bus = dbus.SystemBus()
 
3205
    bus = dbus.SystemBus()
3262
3206
    # End of Avahi example code
3263
3207
    if use_dbus:
3264
3208
        try:
3269
3213
                "se.bsnet.fukt.Mandos", bus,
3270
3214
                do_not_queue=True)
3271
3215
        except dbus.exceptions.DBusException as e:
3272
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3216
            logger.error("Disabling D-Bus:", exc_info=e)
3273
3217
            use_dbus = False
3274
3218
            server_settings["use_dbus"] = False
3275
3219
            tcp_server.use_dbus = False
3360
3304
            os.remove(stored_state_path)
3361
3305
        except IOError as e:
3362
3306
            if e.errno == errno.ENOENT:
3363
 
                log.warning("Could not load persistent state:"
3364
 
                            " %s", os.strerror(e.errno))
 
3307
                logger.warning("Could not load persistent state:"
 
3308
                               " {}".format(os.strerror(e.errno)))
3365
3309
            else:
3366
 
                log.critical("Could not load persistent state:",
3367
 
                             exc_info=e)
 
3310
                logger.critical("Could not load persistent state:",
 
3311
                                exc_info=e)
3368
3312
                raise
3369
3313
        except EOFError as e:
3370
 
            log.warning("Could not load persistent state: EOFError:",
3371
 
                        exc_info=e)
 
3314
            logger.warning("Could not load persistent state: "
 
3315
                           "EOFError:",
 
3316
                           exc_info=e)
3372
3317
 
3373
3318
    with PGPEngine() as pgp:
3374
3319
        for client_name, client in clients_data.items():
3401
3346
            if client["enabled"]:
3402
3347
                if datetime.datetime.utcnow() >= client["expires"]:
3403
3348
                    if not client["last_checked_ok"]:
3404
 
                        log.warning("disabling client %s - Client"
3405
 
                                    " never performed a successful"
3406
 
                                    " checker", client_name)
 
3349
                        logger.warning(
 
3350
                            "disabling client {} - Client never "
 
3351
                            "performed a successful checker".format(
 
3352
                                client_name))
3407
3353
                        client["enabled"] = False
3408
3354
                    elif client["last_checker_status"] != 0:
3409
 
                        log.warning("disabling client %s - Client"
3410
 
                                    " last checker failed with error"
3411
 
                                    " code %s", client_name,
3412
 
                                    client["last_checker_status"])
 
3355
                        logger.warning(
 
3356
                            "disabling client {} - Client last"
 
3357
                            " checker failed with error code"
 
3358
                            " {}".format(
 
3359
                                client_name,
 
3360
                                client["last_checker_status"]))
3413
3361
                        client["enabled"] = False
3414
3362
                    else:
3415
3363
                        client["expires"] = (
3416
3364
                            datetime.datetime.utcnow()
3417
3365
                            + client["timeout"])
3418
 
                        log.debug("Last checker succeeded, keeping %s"
3419
 
                                  " enabled", client_name)
 
3366
                        logger.debug("Last checker succeeded,"
 
3367
                                     " keeping {} enabled".format(
 
3368
                                         client_name))
3420
3369
            try:
3421
3370
                client["secret"] = pgp.decrypt(
3422
3371
                    client["encrypted_secret"],
3423
3372
                    client_settings[client_name]["secret"])
3424
3373
            except PGPError:
3425
3374
                # If decryption fails, we use secret from new settings
3426
 
                log.debug("Failed to decrypt %s old secret",
3427
 
                          client_name)
 
3375
                logger.debug("Failed to decrypt {} old secret".format(
 
3376
                    client_name))
3428
3377
                client["secret"] = (client_settings[client_name]
3429
3378
                                    ["secret"])
3430
3379
 
3444
3393
            server_settings=server_settings)
3445
3394
 
3446
3395
    if not tcp_server.clients:
3447
 
        log.warning("No clients defined")
 
3396
        logger.warning("No clients defined")
3448
3397
 
3449
3398
    if not foreground:
3450
3399
        if pidfile is not None:
3453
3402
                with pidfile:
3454
3403
                    print(pid, file=pidfile)
3455
3404
            except IOError:
3456
 
                log.error("Could not write to file %r with PID %d",
3457
 
                          pidfilename, pid)
 
3405
                logger.error("Could not write to file %r with PID %d",
 
3406
                             pidfilename, pid)
3458
3407
        del pidfile
3459
3408
        del pidfilename
3460
3409
 
3610
3559
 
3611
3560
        try:
3612
3561
            with tempfile.NamedTemporaryFile(
3613
 
                    mode="wb",
 
3562
                    mode='wb',
3614
3563
                    suffix=".pickle",
3615
 
                    prefix="clients-",
 
3564
                    prefix='clients-',
3616
3565
                    dir=os.path.dirname(stored_state_path),
3617
3566
                    delete=False) as stored_state:
3618
3567
                pickle.dump((clients, client_settings), stored_state,
3626
3575
                except NameError:
3627
3576
                    pass
3628
3577
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3629
 
                log.warning("Could not save persistent state: %s",
3630
 
                            os.strerror(e.errno))
 
3578
                logger.warning("Could not save persistent state: {}"
 
3579
                               .format(os.strerror(e.errno)))
3631
3580
            else:
3632
 
                log.warning("Could not save persistent state:",
3633
 
                            exc_info=e)
 
3581
                logger.warning("Could not save persistent state:",
 
3582
                               exc_info=e)
3634
3583
                raise
3635
3584
 
3636
3585
        # Delete all clients, and settings from config
3653
3602
            mandos_dbus_service.client_added_signal(client)
3654
3603
        # Need to initiate checking of clients
3655
3604
        if client.enabled:
3656
 
            client.init_checker(randomize_start=True)
 
3605
            client.init_checker()
3657
3606
 
3658
3607
    tcp_server.enable()
3659
3608
    tcp_server.server_activate()
3662
3611
    if zeroconf:
3663
3612
        service.port = tcp_server.socket.getsockname()[1]
3664
3613
    if use_ipv6:
3665
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3666
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3614
        logger.info("Now listening on address %r, port %d,"
 
3615
                    " flowinfo %d, scope_id %d",
 
3616
                    *tcp_server.socket.getsockname())
3667
3617
    else:                       # IPv4
3668
 
        log.info("Now listening on address %r, port %d",
3669
 
                 *tcp_server.socket.getsockname())
 
3618
        logger.info("Now listening on address %r, port %d",
 
3619
                    *tcp_server.socket.getsockname())
3670
3620
 
3671
3621
    # service.interface = tcp_server.socket.getsockname()[3]
3672
3622
 
3676
3626
            try:
3677
3627
                service.activate()
3678
3628
            except dbus.exceptions.DBusException as error:
3679
 
                log.critical("D-Bus Exception", exc_info=error)
 
3629
                logger.critical("D-Bus Exception", exc_info=error)
3680
3630
                cleanup()
3681
3631
                sys.exit(1)
3682
3632
            # End of Avahi example code
3687
3637
            lambda *args, **kwargs: (tcp_server.handle_request
3688
3638
                                     (*args[2:], **kwargs) or True))
3689
3639
 
3690
 
        log.debug("Starting main loop")
 
3640
        logger.debug("Starting main loop")
3691
3641
        main_loop.run()
3692
3642
    except AvahiError as error:
3693
 
        log.critical("Avahi Error", exc_info=error)
 
3643
        logger.critical("Avahi Error", exc_info=error)
3694
3644
        cleanup()
3695
3645
        sys.exit(1)
3696
3646
    except KeyboardInterrupt:
3697
3647
        if debug:
3698
3648
            print("", file=sys.stderr)
3699
 
        log.debug("Server received KeyboardInterrupt")
3700
 
    log.debug("Server exiting")
 
3649
        logger.debug("Server received KeyboardInterrupt")
 
3650
    logger.debug("Server exiting")
3701
3651
    # Must run before the D-Bus bus name gets deregistered
3702
3652
    cleanup()
3703
3653
 
3704
3654
 
3705
 
def parse_test_args():
3706
 
    # type: () -> argparse.Namespace
 
3655
def should_only_run_tests():
3707
3656
    parser = argparse.ArgumentParser(add_help=False)
3708
 
    parser.add_argument("--check", action="store_true")
3709
 
    parser.add_argument("--prefix", )
 
3657
    parser.add_argument("--check", action='store_true')
3710
3658
    args, unknown_args = parser.parse_known_args()
3711
 
    if args.check:
3712
 
        # Remove test options from sys.argv
 
3659
    run_tests = args.check
 
3660
    if run_tests:
 
3661
        # Remove --check argument from sys.argv
3713
3662
        sys.argv[1:] = unknown_args
3714
 
    return args
 
3663
    return run_tests
3715
3664
 
3716
3665
# Add all tests from doctest strings
3717
3666
def load_tests(loader, tests, none):
3719
3668
    tests.addTests(doctest.DocTestSuite())
3720
3669
    return tests
3721
3670
 
3722
 
if __name__ == "__main__":
3723
 
    options = parse_test_args()
 
3671
if __name__ == '__main__':
3724
3672
    try:
3725
 
        if options.check:
3726
 
            extra_test_prefix = options.prefix
3727
 
            if extra_test_prefix is not None:
3728
 
                if not (unittest.main(argv=[""], exit=False)
3729
 
                        .result.wasSuccessful()):
3730
 
                    sys.exit(1)
3731
 
                class ExtraTestLoader(unittest.TestLoader):
3732
 
                    testMethodPrefix = extra_test_prefix
3733
 
                # Call using ./scriptname --test [--verbose]
3734
 
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
3735
 
            else:
3736
 
                unittest.main(argv=[""])
 
3673
        if should_only_run_tests():
 
3674
            # Call using ./mandos --check [--verbose]
 
3675
            unittest.main()
3737
3676
        else:
3738
3677
            main()
3739
3678
    finally:
3740
3679
        logging.shutdown()
3741
 
 
3742
 
# Local Variables:
3743
 
# run-tests:
3744
 
# (lambda (&optional extra)
3745
 
#   (if (not (funcall run-tests-in-test-buffer default-directory
3746
 
#             extra))
3747
 
#       (funcall show-test-buffer-in-test-window)
3748
 
#     (funcall remove-test-window)
3749
 
#     (if extra (message "Extra tests run successfully!"))))
3750
 
# run-tests-in-test-buffer:
3751
 
# (lambda (dir &optional extra)
3752
 
#   (with-current-buffer (get-buffer-create "*Test*")
3753
 
#     (setq buffer-read-only nil
3754
 
#           default-directory dir)
3755
 
#     (erase-buffer)
3756
 
#     (compilation-mode))
3757
 
#   (let ((process-result
3758
 
#          (let ((inhibit-read-only t))
3759
 
#            (process-file-shell-command
3760
 
#             (funcall get-command-line extra) nil "*Test*"))))
3761
 
#     (and (numberp process-result)
3762
 
#          (= process-result 0))))
3763
 
# get-command-line:
3764
 
# (lambda (&optional extra)
3765
 
#   (let ((quoted-script
3766
 
#          (shell-quote-argument (funcall get-script-name))))
3767
 
#     (format
3768
 
#      (concat "%s --check" (if extra " --prefix=atest" ""))
3769
 
#      quoted-script)))
3770
 
# get-script-name:
3771
 
# (lambda ()
3772
 
#   (if (fboundp 'file-local-name)
3773
 
#       (file-local-name (buffer-file-name))
3774
 
#     (or (file-remote-p (buffer-file-name) 'localname)
3775
 
#         (buffer-file-name))))
3776
 
# remove-test-window:
3777
 
# (lambda ()
3778
 
#   (let ((test-window (get-buffer-window "*Test*")))
3779
 
#     (if test-window (delete-window test-window))))
3780
 
# show-test-buffer-in-test-window:
3781
 
# (lambda ()
3782
 
#   (when (not (get-buffer-window-list "*Test*"))
3783
 
#     (setq next-error-last-buffer (get-buffer "*Test*"))
3784
 
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3785
 
#            (display-buffer-overriding-action
3786
 
#             `((display-buffer-in-side-window) (side . ,side)
3787
 
#               (window-height . fit-window-to-buffer)
3788
 
#               (window-width . fit-window-to-buffer))))
3789
 
#       (display-buffer "*Test*"))))
3790
 
# eval:
3791
 
# (progn
3792
 
#   (let* ((run-extra-tests (lambda () (interactive)
3793
 
#                             (funcall run-tests t)))
3794
 
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3795
 
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
3796
 
#     (setq minor-mode-overriding-map-alist
3797
 
#           (cons `(run-tests . ,outer-keymap)
3798
 
#                 minor-mode-overriding-map-alist)))
3799
 
#   (add-hook 'after-save-hook run-tests 90 t))
3800
 
# End: