/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-18 00:42:22 UTC
  • Revision ID: teddy@recompile.se-20190818004222-lfrgtnmqz766a08e
Client: Use the systemd sysusers.d mechanism, if present

* Makefile (install-client-nokey): Also install sysusers.d file, if
                                   $(SYSUSERS) exists.
* sysusers.d-mandos.conf: Adjust comment to match reality.

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/python
 
2
# -*- mode: python; 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
82
80
 
83
81
import dbus
84
82
import dbus.service
92
90
 
93
91
if sys.version_info.major == 2:
94
92
    __metaclass__ = type
95
 
    str = unicode
96
 
    input = raw_input
97
 
 
98
 
# Add collections.abc.Callable if it does not exist
99
 
try:
100
 
    collections.abc.Callable
101
 
except AttributeError:
102
 
    class abc:
103
 
        Callable = collections.Callable
104
 
    collections.abc = abc
105
 
    del abc
106
 
 
107
 
# Add shlex.quote if it does not exist
108
 
try:
109
 
    shlex.quote
110
 
except AttributeError:
111
 
    shlex.quote = re.escape
112
 
 
113
 
# Show warnings by default
114
 
if not sys.warnoptions:
115
 
    import warnings
116
 
    warnings.simplefilter("default")
117
93
 
118
94
# Try to find the value of SO_BINDTODEVICE:
119
95
try:
140
116
            # No value found
141
117
            SO_BINDTODEVICE = None
142
118
 
 
119
if sys.version_info.major == 2:
 
120
    str = unicode
 
121
 
143
122
if sys.version_info < (3, 2):
144
123
    configparser.Configparser = configparser.SafeConfigParser
145
124
 
146
 
version = "1.8.14"
 
125
version = "1.8.7"
147
126
stored_state_file = "clients.pickle"
148
127
 
149
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
150
 
logging.captureWarnings(True)   # Show warnings via the logging system
 
128
logger = logging.getLogger()
151
129
syslogger = None
152
130
 
153
131
try:
189
167
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
190
168
        address="/dev/log"))
191
169
    syslogger.setFormatter(logging.Formatter
192
 
                           ("Mandos [%(process)d]: %(levelname)s:"
193
 
                            " %(message)s"))
194
 
    log.addHandler(syslogger)
 
170
                           ('Mandos [%(process)d]: %(levelname)s:'
 
171
                            ' %(message)s'))
 
172
    logger.addHandler(syslogger)
195
173
 
196
174
    if debug:
197
175
        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)
 
176
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
177
                                               ' [%(process)d]:'
 
178
                                               ' %(levelname)s:'
 
179
                                               ' %(message)s'))
 
180
        logger.addHandler(console)
 
181
    logger.setLevel(level)
204
182
 
205
183
 
206
184
class PGPError(Exception):
218
196
            output = subprocess.check_output(["gpgconf"])
219
197
            for line in output.splitlines():
220
198
                name, text, path = line.split(b":")
221
 
                if name == b"gpg":
 
199
                if name == "gpg":
222
200
                    self.gpg = path
223
201
                    break
224
202
        except OSError as e:
225
203
            if e.errno != errno.ENOENT:
226
204
                raise
227
 
        self.gnupgargs = ["--batch",
228
 
                          "--homedir", self.tempdir,
229
 
                          "--force-mdc",
230
 
                          "--quiet"]
 
205
        self.gnupgargs = ['--batch',
 
206
                          '--homedir', self.tempdir,
 
207
                          '--force-mdc',
 
208
                          '--quiet']
231
209
        # Only GPG version 1 has the --no-use-agent option.
232
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
210
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
233
211
            self.gnupgargs.append("--no-use-agent")
234
212
 
235
213
    def __enter__(self):
272
250
                dir=self.tempdir) as passfile:
273
251
            passfile.write(passphrase)
274
252
            passfile.flush()
275
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
276
 
                                     "--passphrase-file",
 
253
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
254
                                     '--passphrase-file',
277
255
                                     passfile.name]
278
256
                                    + self.gnupgargs,
279
257
                                    stdin=subprocess.PIPE,
290
268
                dir=self.tempdir) as passfile:
291
269
            passfile.write(passphrase)
292
270
            passfile.flush()
293
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
294
 
                                     "--passphrase-file",
 
271
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
272
                                     '--passphrase-file',
295
273
                                     passfile.name]
296
274
                                    + self.gnupgargs,
297
275
                                    stdin=subprocess.PIPE,
350
328
    Attributes:
351
329
    interface: integer; avahi.IF_UNSPEC or an interface index.
352
330
               Used to optionally bind to the specified interface.
353
 
    name: string; Example: "Mandos"
354
 
    type: string; Example: "_mandos._tcp".
 
331
    name: string; Example: 'Mandos'
 
332
    type: string; Example: '_mandos._tcp'.
355
333
     See <https://www.iana.org/assignments/service-names-port-numbers>
356
334
    port: integer; what port to announce
357
335
    TXT: list of strings; TXT record for the service
394
372
    def rename(self, remove=True):
395
373
        """Derived from the Avahi example code"""
396
374
        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)
 
375
            logger.critical("No suitable Zeroconf service name found"
 
376
                            " after %i retries, exiting.",
 
377
                            self.rename_count)
400
378
            raise AvahiServiceError("Too many renames")
401
379
        self.name = str(
402
380
            self.server.GetAlternativeServiceName(self.name))
403
381
        self.rename_count += 1
404
 
        log.info("Changing Zeroconf service name to %r ...",
405
 
                 self.name)
 
382
        logger.info("Changing Zeroconf service name to %r ...",
 
383
                    self.name)
406
384
        if remove:
407
385
            self.remove()
408
386
        try:
410
388
        except dbus.exceptions.DBusException as error:
411
389
            if (error.get_dbus_name()
412
390
                == "org.freedesktop.Avahi.CollisionError"):
413
 
                log.info("Local Zeroconf service name collision.")
 
391
                logger.info("Local Zeroconf service name collision.")
414
392
                return self.rename(remove=False)
415
393
            else:
416
 
                log.critical("D-Bus Exception", exc_info=error)
 
394
                logger.critical("D-Bus Exception", exc_info=error)
417
395
                self.cleanup()
418
396
                os._exit(1)
419
397
 
435
413
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
414
        self.entry_group_state_changed_match = (
437
415
            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)
 
416
                'StateChanged', self.entry_group_state_changed))
 
417
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
418
                     self.name, self.type)
441
419
        self.group.AddService(
442
420
            self.interface,
443
421
            self.protocol,
450
428
 
451
429
    def entry_group_state_changed(self, state, error):
452
430
        """Derived from the Avahi example code"""
453
 
        log.debug("Avahi entry group state change: %i", state)
 
431
        logger.debug("Avahi entry group state change: %i", state)
454
432
 
455
433
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
 
            log.debug("Zeroconf service established.")
 
434
            logger.debug("Zeroconf service established.")
457
435
        elif state == avahi.ENTRY_GROUP_COLLISION:
458
 
            log.info("Zeroconf service name collision.")
 
436
            logger.info("Zeroconf service name collision.")
459
437
            self.rename()
460
438
        elif state == avahi.ENTRY_GROUP_FAILURE:
461
 
            log.critical("Avahi: Error in group state changed %s",
462
 
                         str(error))
 
439
            logger.critical("Avahi: Error in group state changed %s",
 
440
                            str(error))
463
441
            raise AvahiGroupError("State changed: {!s}".format(error))
464
442
 
465
443
    def cleanup(self):
475
453
 
476
454
    def server_state_changed(self, state, error=None):
477
455
        """Derived from the Avahi example code"""
478
 
        log.debug("Avahi server state change: %i", state)
 
456
        logger.debug("Avahi server state change: %i", state)
479
457
        bad_states = {
480
458
            avahi.SERVER_INVALID: "Zeroconf server invalid",
481
459
            avahi.SERVER_REGISTERING: None,
485
463
        if state in bad_states:
486
464
            if bad_states[state] is not None:
487
465
                if error is None:
488
 
                    log.error(bad_states[state])
 
466
                    logger.error(bad_states[state])
489
467
                else:
490
 
                    log.error(bad_states[state] + ": %r", error)
 
468
                    logger.error(bad_states[state] + ": %r", error)
491
469
            self.cleanup()
492
470
        elif state == avahi.SERVER_RUNNING:
493
471
            try:
495
473
            except dbus.exceptions.DBusException as error:
496
474
                if (error.get_dbus_name()
497
475
                    == "org.freedesktop.Avahi.CollisionError"):
498
 
                    log.info("Local Zeroconf service name collision.")
 
476
                    logger.info("Local Zeroconf service name"
 
477
                                " collision.")
499
478
                    return self.rename(remove=False)
500
479
                else:
501
 
                    log.critical("D-Bus Exception", exc_info=error)
 
480
                    logger.critical("D-Bus Exception", exc_info=error)
502
481
                    self.cleanup()
503
482
                    os._exit(1)
504
483
        else:
505
484
            if error is None:
506
 
                log.debug("Unknown state: %r", state)
 
485
                logger.debug("Unknown state: %r", state)
507
486
            else:
508
 
                log.debug("Unknown state: %r: %r", state, error)
 
487
                logger.debug("Unknown state: %r: %r", state, error)
509
488
 
510
489
    def activate(self):
511
490
        """Derived from the Avahi example code"""
523
502
class AvahiServiceToSyslog(AvahiService):
524
503
    def rename(self, *args, **kwargs):
525
504
        """Add the new name to the syslog messages"""
526
 
        ret = super(AvahiServiceToSyslog, self).rename(*args,
527
 
                                                       **kwargs)
 
505
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
528
506
        syslogger.setFormatter(logging.Formatter(
529
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
507
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
530
508
            .format(self.name)))
531
509
        return ret
532
510
 
562
540
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
563
541
 
564
542
    # Types
565
 
    class _session_int(ctypes.Structure):
 
543
    class session_int(ctypes.Structure):
566
544
        _fields_ = []
567
 
    session_t = ctypes.POINTER(_session_int)
 
545
    session_t = ctypes.POINTER(session_int)
568
546
 
569
547
    class certificate_credentials_st(ctypes.Structure):
570
548
        _fields_ = []
573
551
    certificate_type_t = ctypes.c_int
574
552
 
575
553
    class datum_t(ctypes.Structure):
576
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
 
                    ("size", ctypes.c_uint)]
 
554
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
555
                    ('size', ctypes.c_uint)]
578
556
 
579
 
    class _openpgp_crt_int(ctypes.Structure):
 
557
    class openpgp_crt_int(ctypes.Structure):
580
558
        _fields_ = []
581
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
559
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
560
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
583
561
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
562
    credentials_type_t = ctypes.c_int
593
571
            # gnutls.strerror()
594
572
            self.code = code
595
573
            if message is None and code is not None:
596
 
                message = gnutls.strerror(code).decode(
597
 
                    "utf-8", errors="replace")
 
574
                message = gnutls.strerror(code)
598
575
            return super(gnutls.Error, self).__init__(
599
576
                message, *args)
600
577
 
601
578
    class CertificateSecurityError(Error):
602
579
        pass
603
580
 
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
581
    # Classes
630
 
    class Credentials(With_from_param):
 
582
    class Credentials:
631
583
        def __init__(self):
632
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
633
 
            gnutls.certificate_allocate_credentials(self)
 
584
            self._c_object = gnutls.certificate_credentials_t()
 
585
            gnutls.certificate_allocate_credentials(
 
586
                ctypes.byref(self._c_object))
634
587
            self.type = gnutls.CRD_CERTIFICATE
635
588
 
636
589
        def __del__(self):
637
 
            gnutls.certificate_free_credentials(self)
 
590
            gnutls.certificate_free_credentials(self._c_object)
638
591
 
639
 
    class ClientSession(With_from_param):
 
592
    class ClientSession:
640
593
        def __init__(self, socket, credentials=None):
641
 
            self._as_parameter_ = gnutls.session_t()
 
594
            self._c_object = gnutls.session_t()
642
595
            gnutls_flags = gnutls.CLIENT
643
596
            if gnutls.check_version(b"3.5.6"):
644
597
                gnutls_flags |= gnutls.NO_TICKETS
645
598
            if gnutls.has_rawpk:
646
599
                gnutls_flags |= gnutls.ENABLE_RAWPK
647
 
            gnutls.init(self, gnutls_flags)
 
600
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
648
601
            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)
 
602
            gnutls.set_default_priority(self._c_object)
 
603
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
604
            gnutls.handshake_set_private_extensions(self._c_object,
 
605
                                                    True)
652
606
            self.socket = socket
653
607
            if credentials is None:
654
608
                credentials = gnutls.Credentials()
655
 
            gnutls.credentials_set(self, credentials.type,
656
 
                                   credentials)
 
609
            gnutls.credentials_set(self._c_object, credentials.type,
 
610
                                   ctypes.cast(credentials._c_object,
 
611
                                               ctypes.c_void_p))
657
612
            self.credentials = credentials
658
613
 
659
614
        def __del__(self):
660
 
            gnutls.deinit(self)
 
615
            gnutls.deinit(self._c_object)
661
616
 
662
617
        def handshake(self):
663
 
            return gnutls.handshake(self)
 
618
            return gnutls.handshake(self._c_object)
664
619
 
665
620
        def send(self, data):
666
621
            data = bytes(data)
667
622
            data_len = len(data)
668
623
            while data_len > 0:
669
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
624
                data_len -= gnutls.record_send(self._c_object,
 
625
                                               data[-data_len:],
670
626
                                               data_len)
671
627
 
672
628
        def bye(self):
673
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
629
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
674
630
 
675
631
    # Error handling functions
676
632
    def _error_code(result):
677
633
        """A function to raise exceptions on errors, suitable
678
 
        for the "restype" attribute on ctypes functions"""
679
 
        if result >= gnutls.E_SUCCESS:
 
634
        for the 'restype' attribute on ctypes functions"""
 
635
        if result >= 0:
680
636
            return result
681
637
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
638
            raise gnutls.CertificateSecurityError(code=result)
683
639
        raise gnutls.Error(code=result)
684
640
 
685
 
    def _retry_on_error(result, func, arguments,
686
 
                        _error_code=_error_code):
 
641
    def _retry_on_error(result, func, arguments):
687
642
        """A function to retry on some errors, suitable
688
 
        for the "errcheck" attribute on ctypes functions"""
689
 
        while result < gnutls.E_SUCCESS:
 
643
        for the 'errcheck' attribute on ctypes functions"""
 
644
        while result < 0:
690
645
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
646
                return _error_code(result)
692
647
            result = func(*arguments)
697
652
 
698
653
    # Functions
699
654
    priority_set_direct = _library.gnutls_priority_set_direct
700
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
655
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
701
656
                                    ctypes.POINTER(ctypes.c_char_p)]
702
657
    priority_set_direct.restype = _error_code
703
658
 
704
659
    init = _library.gnutls_init
705
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
660
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
706
661
    init.restype = _error_code
707
662
 
708
663
    set_default_priority = _library.gnutls_set_default_priority
709
 
    set_default_priority.argtypes = [ClientSession]
 
664
    set_default_priority.argtypes = [session_t]
710
665
    set_default_priority.restype = _error_code
711
666
 
712
667
    record_send = _library.gnutls_record_send
713
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
668
    record_send.argtypes = [session_t, ctypes.c_void_p,
714
669
                            ctypes.c_size_t]
715
670
    record_send.restype = ctypes.c_ssize_t
716
671
    record_send.errcheck = _retry_on_error
718
673
    certificate_allocate_credentials = (
719
674
        _library.gnutls_certificate_allocate_credentials)
720
675
    certificate_allocate_credentials.argtypes = [
721
 
        PointerTo(Credentials)]
 
676
        ctypes.POINTER(certificate_credentials_t)]
722
677
    certificate_allocate_credentials.restype = _error_code
723
678
 
724
679
    certificate_free_credentials = (
725
680
        _library.gnutls_certificate_free_credentials)
726
 
    certificate_free_credentials.argtypes = [Credentials]
 
681
    certificate_free_credentials.argtypes = [
 
682
        certificate_credentials_t]
727
683
    certificate_free_credentials.restype = None
728
684
 
729
685
    handshake_set_private_extensions = (
730
686
        _library.gnutls_handshake_set_private_extensions)
731
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
687
    handshake_set_private_extensions.argtypes = [session_t,
732
688
                                                 ctypes.c_int]
733
689
    handshake_set_private_extensions.restype = None
734
690
 
735
691
    credentials_set = _library.gnutls_credentials_set
736
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
737
 
                                CastToVoidPointer(Credentials)]
 
692
    credentials_set.argtypes = [session_t, credentials_type_t,
 
693
                                ctypes.c_void_p]
738
694
    credentials_set.restype = _error_code
739
695
 
740
696
    strerror = _library.gnutls_strerror
742
698
    strerror.restype = ctypes.c_char_p
743
699
 
744
700
    certificate_type_get = _library.gnutls_certificate_type_get
745
 
    certificate_type_get.argtypes = [ClientSession]
 
701
    certificate_type_get.argtypes = [session_t]
746
702
    certificate_type_get.restype = _error_code
747
703
 
748
704
    certificate_get_peers = _library.gnutls_certificate_get_peers
749
 
    certificate_get_peers.argtypes = [ClientSession,
 
705
    certificate_get_peers.argtypes = [session_t,
750
706
                                      ctypes.POINTER(ctypes.c_uint)]
751
707
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
752
708
 
759
715
    global_set_log_function.restype = None
760
716
 
761
717
    deinit = _library.gnutls_deinit
762
 
    deinit.argtypes = [ClientSession]
 
718
    deinit.argtypes = [session_t]
763
719
    deinit.restype = None
764
720
 
765
721
    handshake = _library.gnutls_handshake
766
 
    handshake.argtypes = [ClientSession]
767
 
    handshake.restype = ctypes.c_int
 
722
    handshake.argtypes = [session_t]
 
723
    handshake.restype = _error_code
768
724
    handshake.errcheck = _retry_on_error
769
725
 
770
726
    transport_set_ptr = _library.gnutls_transport_set_ptr
771
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
727
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
772
728
    transport_set_ptr.restype = None
773
729
 
774
730
    bye = _library.gnutls_bye
775
 
    bye.argtypes = [ClientSession, close_request_t]
776
 
    bye.restype = ctypes.c_int
 
731
    bye.argtypes = [session_t, close_request_t]
 
732
    bye.restype = _error_code
777
733
    bye.errcheck = _retry_on_error
778
734
 
779
735
    check_version = _library.gnutls_check_version
796
752
 
797
753
        x509_crt_fmt_t = ctypes.c_int
798
754
 
799
 
        # All the function declarations below are from
800
 
        # gnutls/abstract.h
 
755
        # All the function declarations below are from gnutls/abstract.h
801
756
        pubkey_init = _library.gnutls_pubkey_init
802
757
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
803
758
        pubkey_init.restype = _error_code
817
772
        pubkey_deinit.argtypes = [pubkey_t]
818
773
        pubkey_deinit.restype = None
819
774
    else:
820
 
        # All the function declarations below are from
821
 
        # gnutls/openpgp.h
 
775
        # All the function declarations below are from gnutls/openpgp.h
822
776
 
823
777
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
824
778
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
830
784
                                       openpgp_crt_fmt_t]
831
785
        openpgp_crt_import.restype = _error_code
832
786
 
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
 
        ]
 
787
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
788
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
789
                                            ctypes.POINTER(ctypes.c_uint)]
840
790
        openpgp_crt_verify_self.restype = _error_code
841
791
 
842
792
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
853
803
 
854
804
    if check_version(b"3.6.4"):
855
805
        certificate_type_get2 = _library.gnutls_certificate_type_get2
856
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
806
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
857
807
        certificate_type_get2.restype = _error_code
858
808
 
859
809
    # Remove non-public functions
875
825
    """A representation of a client host served by this server.
876
826
 
877
827
    Attributes:
878
 
    approved:   bool(); None if not yet approved/disapproved
 
828
    approved:   bool(); 'None' if not yet approved/disapproved
879
829
    approval_delay: datetime.timedelta(); Time to wait for approval
880
830
    approval_duration: datetime.timedelta(); Duration of one approval
881
831
    checker: multiprocessing.Process(); a running checker process used
882
 
             to see if the client lives. None if no process is
 
832
             to see if the client lives. 'None' if no process is
883
833
             running.
884
834
    checker_callback_tag: a GLib event source tag, or None
885
835
    checker_command: string; External command which is run to check
1009
959
            self.last_enabled = None
1010
960
            self.expires = None
1011
961
 
1012
 
        log.debug("Creating client %r", self.name)
1013
 
        log.debug("  Key ID: %s", self.key_id)
1014
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
962
        logger.debug("Creating client %r", self.name)
 
963
        logger.debug("  Key ID: %s", self.key_id)
 
964
        logger.debug("  Fingerprint: %s", self.fingerprint)
1015
965
        self.created = settings.get("created",
1016
966
                                    datetime.datetime.utcnow())
1017
967
 
1056
1006
        if not getattr(self, "enabled", False):
1057
1007
            return False
1058
1008
        if not quiet:
1059
 
            log.info("Disabling client %s", self.name)
 
1009
            logger.info("Disabling client %s", self.name)
1060
1010
        if getattr(self, "disable_initiator_tag", None) is not None:
1061
1011
            GLib.source_remove(self.disable_initiator_tag)
1062
1012
            self.disable_initiator_tag = None
1080
1030
        if self.checker_initiator_tag is not None:
1081
1031
            GLib.source_remove(self.checker_initiator_tag)
1082
1032
        self.checker_initiator_tag = GLib.timeout_add(
1083
 
            random.randrange(int(self.interval.total_seconds() * 1000
1084
 
                                 + 1)),
 
1033
            int(self.interval.total_seconds() * 1000),
1085
1034
            self.start_checker)
1086
1035
        # Schedule a disable() when 'timeout' has passed
1087
1036
        if self.disable_initiator_tag is not None:
1097
1046
        # Read return code from connection (see call_pipe)
1098
1047
        returncode = connection.recv()
1099
1048
        connection.close()
1100
 
        if self.checker is not None:
1101
 
            self.checker.join()
 
1049
        self.checker.join()
1102
1050
        self.checker_callback_tag = None
1103
1051
        self.checker = None
1104
1052
 
1106
1054
            self.last_checker_status = returncode
1107
1055
            self.last_checker_signal = None
1108
1056
            if self.last_checker_status == 0:
1109
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1057
                logger.info("Checker for %(name)s succeeded",
 
1058
                            vars(self))
1110
1059
                self.checked_ok()
1111
1060
            else:
1112
 
                log.info("Checker for %(name)s failed", vars(self))
 
1061
                logger.info("Checker for %(name)s failed", vars(self))
1113
1062
        else:
1114
1063
            self.last_checker_status = -1
1115
1064
            self.last_checker_signal = -returncode
1116
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1065
            logger.warning("Checker for %(name)s crashed?",
 
1066
                           vars(self))
1117
1067
        return False
1118
1068
 
1119
1069
    def checked_ok(self):
1153
1103
        # should be.
1154
1104
 
1155
1105
        if self.checker is not None and not self.checker.is_alive():
1156
 
            log.warning("Checker was not alive; joining")
 
1106
            logger.warning("Checker was not alive; joining")
1157
1107
            self.checker.join()
1158
1108
            self.checker = None
1159
1109
        # Start a new checker if needed
1160
1110
        if self.checker is None:
1161
1111
            # Escape attributes for the shell
1162
1112
            escaped_attrs = {
1163
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1113
                attr: re.escape(str(getattr(self, attr)))
1164
1114
                for attr in self.runtime_expansions}
1165
1115
            try:
1166
1116
                command = self.checker_command % escaped_attrs
1167
1117
            except TypeError as error:
1168
 
                log.error('Could not format string "%s"',
1169
 
                          self.checker_command, exc_info=error)
 
1118
                logger.error('Could not format string "%s"',
 
1119
                             self.checker_command,
 
1120
                             exc_info=error)
1170
1121
                return True     # Try again later
1171
1122
            self.current_checker_command = command
1172
 
            log.info("Starting checker %r for %s", command, self.name)
 
1123
            logger.info("Starting checker %r for %s", command,
 
1124
                        self.name)
1173
1125
            # We don't need to redirect stdout and stderr, since
1174
1126
            # in normal mode, that is already done by daemon(),
1175
1127
            # and in debug mode we don't want to.  (Stdin is
1191
1143
                kwargs=popen_args)
1192
1144
            self.checker.start()
1193
1145
            self.checker_callback_tag = GLib.io_add_watch(
1194
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1195
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1146
                pipe[0].fileno(), GLib.IO_IN,
1196
1147
                self.checker_callback, pipe[0], command)
1197
1148
        # Re-run this periodically if run by GLib.timeout_add
1198
1149
        return True
1204
1155
            self.checker_callback_tag = None
1205
1156
        if getattr(self, "checker", None) is None:
1206
1157
            return
1207
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1158
        logger.debug("Stopping checker for %(name)s", vars(self))
1208
1159
        self.checker.terminate()
1209
1160
        self.checker = None
1210
1161
 
1237
1188
        func._dbus_name = func.__name__
1238
1189
        if func._dbus_name.endswith("_dbus_property"):
1239
1190
            func._dbus_name = func._dbus_name[:-14]
1240
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1191
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1241
1192
        return func
1242
1193
 
1243
1194
    return decorator
1332
1283
 
1333
1284
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1334
1285
                         out_signature="s",
1335
 
                         path_keyword="object_path",
1336
 
                         connection_keyword="connection")
 
1286
                         path_keyword='object_path',
 
1287
                         connection_keyword='connection')
1337
1288
    def Introspect(self, object_path, connection):
1338
1289
        """Overloading of standard D-Bus method.
1339
1290
 
1388
1339
            document.unlink()
1389
1340
        except (AttributeError, xml.dom.DOMException,
1390
1341
                xml.parsers.expat.ExpatError) as error:
1391
 
            log.error("Failed to override Introspection method",
1392
 
                      exc_info=error)
 
1342
            logger.error("Failed to override Introspection method",
 
1343
                         exc_info=error)
1393
1344
        return xmlstring
1394
1345
 
1395
1346
 
1453
1404
                raise ValueError("Byte arrays not supported for non-"
1454
1405
                                 "'ay' signature {!r}"
1455
1406
                                 .format(prop._dbus_signature))
1456
 
            value = dbus.ByteArray(bytes(value))
 
1407
            value = dbus.ByteArray(b''.join(chr(byte)
 
1408
                                            for byte in value))
1457
1409
        prop(value)
1458
1410
 
1459
1411
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1492
1444
 
1493
1445
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1494
1446
                         out_signature="s",
1495
 
                         path_keyword="object_path",
1496
 
                         connection_keyword="connection")
 
1447
                         path_keyword='object_path',
 
1448
                         connection_keyword='connection')
1497
1449
    def Introspect(self, object_path, connection):
1498
1450
        """Overloading of standard D-Bus method.
1499
1451
 
1555
1507
            document.unlink()
1556
1508
        except (AttributeError, xml.dom.DOMException,
1557
1509
                xml.parsers.expat.ExpatError) as error:
1558
 
            log.error("Failed to override Introspection method",
1559
 
                      exc_info=error)
 
1510
            logger.error("Failed to override Introspection method",
 
1511
                         exc_info=error)
1560
1512
        return xmlstring
1561
1513
 
1562
1514
 
1594
1546
 
1595
1547
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1596
1548
                         out_signature="s",
1597
 
                         path_keyword="object_path",
1598
 
                         connection_keyword="connection")
 
1549
                         path_keyword='object_path',
 
1550
                         connection_keyword='connection')
1599
1551
    def Introspect(self, object_path, connection):
1600
1552
        """Overloading of standard D-Bus method.
1601
1553
 
1626
1578
            document.unlink()
1627
1579
        except (AttributeError, xml.dom.DOMException,
1628
1580
                xml.parsers.expat.ExpatError) as error:
1629
 
            log.error("Failed to override Introspection method",
1630
 
                      exc_info=error)
 
1581
            logger.error("Failed to override Introspection method",
 
1582
                         exc_info=error)
1631
1583
        return xmlstring
1632
1584
 
1633
1585
 
2267
2219
class ProxyClient:
2268
2220
    def __init__(self, child_pipe, key_id, fpr, address):
2269
2221
        self._pipe = child_pipe
2270
 
        self._pipe.send(("init", key_id, fpr, address))
 
2222
        self._pipe.send(('init', key_id, fpr, address))
2271
2223
        if not self._pipe.recv():
2272
2224
            raise KeyError(key_id or fpr)
2273
2225
 
2274
2226
    def __getattribute__(self, name):
2275
 
        if name == "_pipe":
 
2227
        if name == '_pipe':
2276
2228
            return super(ProxyClient, self).__getattribute__(name)
2277
 
        self._pipe.send(("getattr", name))
 
2229
        self._pipe.send(('getattr', name))
2278
2230
        data = self._pipe.recv()
2279
 
        if data[0] == "data":
 
2231
        if data[0] == 'data':
2280
2232
            return data[1]
2281
 
        if data[0] == "function":
 
2233
        if data[0] == 'function':
2282
2234
 
2283
2235
            def func(*args, **kwargs):
2284
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2236
                self._pipe.send(('funcall', name, args, kwargs))
2285
2237
                return self._pipe.recv()[1]
2286
2238
 
2287
2239
            return func
2288
2240
 
2289
2241
    def __setattr__(self, name, value):
2290
 
        if name == "_pipe":
 
2242
        if name == '_pipe':
2291
2243
            return super(ProxyClient, self).__setattr__(name, value)
2292
 
        self._pipe.send(("setattr", name, value))
 
2244
        self._pipe.send(('setattr', name, value))
2293
2245
 
2294
2246
 
2295
2247
class ClientHandler(socketserver.BaseRequestHandler, object):
2300
2252
 
2301
2253
    def handle(self):
2302
2254
        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())
 
2255
            logger.info("TCP connection from: %s",
 
2256
                        str(self.client_address))
 
2257
            logger.debug("Pipe FD: %d",
 
2258
                         self.server.child_pipe.fileno())
2306
2259
 
2307
2260
            session = gnutls.ClientSession(self.request)
2308
2261
 
2309
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2262
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2310
2263
            #                       "+AES-256-CBC", "+SHA1",
2311
2264
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2312
2265
            #                       "+DHE-DSS"))
2314
2267
            priority = self.server.gnutls_priority
2315
2268
            if priority is None:
2316
2269
                priority = "NORMAL"
2317
 
            gnutls.priority_set_direct(session,
2318
 
                                       priority.encode("utf-8"), None)
 
2270
            gnutls.priority_set_direct(session._c_object,
 
2271
                                       priority.encode("utf-8"),
 
2272
                                       None)
2319
2273
 
2320
2274
            # Start communication using the Mandos protocol
2321
2275
            # Get protocol number
2322
2276
            line = self.request.makefile().readline()
2323
 
            log.debug("Protocol version: %r", line)
 
2277
            logger.debug("Protocol version: %r", line)
2324
2278
            try:
2325
2279
                if int(line.strip().split()[0]) > 1:
2326
2280
                    raise RuntimeError(line)
2327
2281
            except (ValueError, IndexError, RuntimeError) as error:
2328
 
                log.error("Unknown protocol version: %s", error)
 
2282
                logger.error("Unknown protocol version: %s", error)
2329
2283
                return
2330
2284
 
2331
2285
            # Start GnuTLS connection
2332
2286
            try:
2333
2287
                session.handshake()
2334
2288
            except gnutls.Error as error:
2335
 
                log.warning("Handshake failed: %s", error)
 
2289
                logger.warning("Handshake failed: %s", error)
2336
2290
                # Do not run session.bye() here: the session is not
2337
2291
                # established.  Just abandon the request.
2338
2292
                return
2339
 
            log.debug("Handshake succeeded")
 
2293
            logger.debug("Handshake succeeded")
2340
2294
 
2341
2295
            approval_required = False
2342
2296
            try:
2346
2300
                        key_id = self.key_id(
2347
2301
                            self.peer_certificate(session))
2348
2302
                    except (TypeError, gnutls.Error) as error:
2349
 
                        log.warning("Bad certificate: %s", error)
 
2303
                        logger.warning("Bad certificate: %s", error)
2350
2304
                        return
2351
 
                    log.debug("Key ID: %s",
2352
 
                              key_id.decode("utf-8",
2353
 
                                            errors="replace"))
 
2305
                    logger.debug("Key ID: %s", key_id)
2354
2306
 
2355
2307
                else:
2356
2308
                    key_id = b""
2358
2310
                        fpr = self.fingerprint(
2359
2311
                            self.peer_certificate(session))
2360
2312
                    except (TypeError, gnutls.Error) as error:
2361
 
                        log.warning("Bad certificate: %s", error)
 
2313
                        logger.warning("Bad certificate: %s", error)
2362
2314
                        return
2363
 
                    log.debug("Fingerprint: %s", fpr)
 
2315
                    logger.debug("Fingerprint: %s", fpr)
2364
2316
 
2365
2317
                try:
2366
2318
                    client = ProxyClient(child_pipe, key_id, fpr,
2375
2327
 
2376
2328
                while True:
2377
2329
                    if not client.enabled:
2378
 
                        log.info("Client %s is disabled", client.name)
 
2330
                        logger.info("Client %s is disabled",
 
2331
                                    client.name)
2379
2332
                        if self.server.use_dbus:
2380
2333
                            # Emit D-Bus signal
2381
2334
                            client.Rejected("Disabled")
2385
2338
                        # We are approved or approval is disabled
2386
2339
                        break
2387
2340
                    elif client.approved is None:
2388
 
                        log.info("Client %s needs approval",
2389
 
                                 client.name)
 
2341
                        logger.info("Client %s needs approval",
 
2342
                                    client.name)
2390
2343
                        if self.server.use_dbus:
2391
2344
                            # Emit D-Bus signal
2392
2345
                            client.NeedApproval(
2393
2346
                                client.approval_delay.total_seconds()
2394
2347
                                * 1000, client.approved_by_default)
2395
2348
                    else:
2396
 
                        log.warning("Client %s was not approved",
2397
 
                                    client.name)
 
2349
                        logger.warning("Client %s was not approved",
 
2350
                                       client.name)
2398
2351
                        if self.server.use_dbus:
2399
2352
                            # Emit D-Bus signal
2400
2353
                            client.Rejected("Denied")
2408
2361
                    time2 = datetime.datetime.now()
2409
2362
                    if (time2 - time) >= delay:
2410
2363
                        if not client.approved_by_default:
2411
 
                            log.warning("Client %s timed out while"
2412
 
                                        " waiting for approval",
2413
 
                                        client.name)
 
2364
                            logger.warning("Client %s timed out while"
 
2365
                                           " waiting for approval",
 
2366
                                           client.name)
2414
2367
                            if self.server.use_dbus:
2415
2368
                                # Emit D-Bus signal
2416
2369
                                client.Rejected("Approval timed out")
2423
2376
                try:
2424
2377
                    session.send(client.secret)
2425
2378
                except gnutls.Error as error:
2426
 
                    log.warning("gnutls send failed", exc_info=error)
 
2379
                    logger.warning("gnutls send failed",
 
2380
                                   exc_info=error)
2427
2381
                    return
2428
2382
 
2429
 
                log.info("Sending secret to %s", client.name)
 
2383
                logger.info("Sending secret to %s", client.name)
2430
2384
                # bump the timeout using extended_timeout
2431
2385
                client.bump_timeout(client.extended_timeout)
2432
2386
                if self.server.use_dbus:
2439
2393
                try:
2440
2394
                    session.bye()
2441
2395
                except gnutls.Error as error:
2442
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2396
                    logger.warning("GnuTLS bye failed",
 
2397
                                   exc_info=error)
2443
2398
 
2444
2399
    @staticmethod
2445
2400
    def peer_certificate(session):
2446
2401
        "Return the peer's certificate as a bytestring"
2447
2402
        try:
2448
 
            cert_type = gnutls.certificate_type_get2(
2449
 
                session, gnutls.CTYPE_PEERS)
 
2403
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2404
                                                     gnutls.CTYPE_PEERS)
2450
2405
        except AttributeError:
2451
 
            cert_type = gnutls.certificate_type_get(session)
 
2406
            cert_type = gnutls.certificate_type_get(session._c_object)
2452
2407
        if gnutls.has_rawpk:
2453
2408
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2454
2409
        else:
2455
2410
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2456
2411
        # If not a valid certificate type...
2457
2412
        if cert_type not in valid_cert_types:
2458
 
            log.info("Cert type %r not in %r", cert_type,
2459
 
                     valid_cert_types)
 
2413
            logger.info("Cert type %r not in %r", cert_type,
 
2414
                        valid_cert_types)
2460
2415
            # ...return invalid data
2461
2416
            return b""
2462
2417
        list_size = ctypes.c_uint(1)
2463
2418
        cert_list = (gnutls.certificate_get_peers
2464
 
                     (session, ctypes.byref(list_size)))
 
2419
                     (session._c_object, ctypes.byref(list_size)))
2465
2420
        if not bool(cert_list) and list_size.value != 0:
2466
2421
            raise gnutls.Error("error getting peer certificate")
2467
2422
        if list_size.value == 0:
2489
2444
        buf = ctypes.create_string_buffer(32)
2490
2445
        buf_len = ctypes.c_size_t(len(buf))
2491
2446
        # 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))
 
2447
        gnutls.pubkey_get_key_id(pubkey,
 
2448
                                 gnutls.KEYID_USE_SHA256,
 
2449
                                 ctypes.cast(ctypes.byref(buf),
 
2450
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2451
                                 ctypes.byref(buf_len))
2498
2452
        # Deinit the certificate
2499
2453
        gnutls.pubkey_deinit(pubkey)
2500
2454
 
2581
2535
 
2582
2536
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2583
2537
                     socketserver.TCPServer):
2584
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2538
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2585
2539
 
2586
2540
    Attributes:
2587
2541
        enabled:        Boolean; whether this server is activated yet
2638
2592
            if SO_BINDTODEVICE is None:
2639
2593
                # Fall back to a hard-coded value which seems to be
2640
2594
                # common enough.
2641
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2595
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2642
2596
                SO_BINDTODEVICE = 25
2643
2597
            try:
2644
2598
                self.socket.setsockopt(
2646
2600
                    (self.interface + "\0").encode("utf-8"))
2647
2601
            except socket.error as error:
2648
2602
                if error.errno == errno.EPERM:
2649
 
                    log.error("No permission to bind to interface %s",
2650
 
                              self.interface)
 
2603
                    logger.error("No permission to bind to"
 
2604
                                 " interface %s", self.interface)
2651
2605
                elif error.errno == errno.ENOPROTOOPT:
2652
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2653
 
                              " bind to interface %s", self.interface)
 
2606
                    logger.error("SO_BINDTODEVICE not available;"
 
2607
                                 " cannot bind to interface %s",
 
2608
                                 self.interface)
2654
2609
                elif error.errno == errno.ENODEV:
2655
 
                    log.error("Interface %s does not exist, cannot"
2656
 
                              " bind", self.interface)
 
2610
                    logger.error("Interface %s does not exist,"
 
2611
                                 " cannot bind", self.interface)
2657
2612
                else:
2658
2613
                    raise
2659
2614
        # Only bind(2) the socket if we really need to.
2718
2673
    def add_pipe(self, parent_pipe, proc):
2719
2674
        # Call "handle_ipc" for both data and EOF events
2720
2675
        GLib.io_add_watch(
2721
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2722
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2676
            parent_pipe.fileno(),
 
2677
            GLib.IO_IN | GLib.IO_HUP,
2723
2678
            functools.partial(self.handle_ipc,
2724
2679
                              parent_pipe=parent_pipe,
2725
2680
                              proc=proc))
2738
2693
        request = parent_pipe.recv()
2739
2694
        command = request[0]
2740
2695
 
2741
 
        if command == "init":
 
2696
        if command == 'init':
2742
2697
            key_id = request[1].decode("ascii")
2743
2698
            fpr = request[2].decode("ascii")
2744
2699
            address = request[3]
2745
2700
 
2746
2701
            for c in self.clients.values():
2747
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2748
 
                              "27AE41E4649B934CA495991B7852B855"):
 
2702
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2749
2703
                    continue
2750
2704
                if key_id and c.key_id == key_id:
2751
2705
                    client = c
2754
2708
                    client = c
2755
2709
                    break
2756
2710
            else:
2757
 
                log.info("Client not found for key ID: %s, address:"
2758
 
                         " %s", key_id or fpr, address)
 
2711
                logger.info("Client not found for key ID: %s, address"
 
2712
                            ": %s", key_id or fpr, address)
2759
2713
                if self.use_dbus:
2760
2714
                    # Emit D-Bus signal
2761
2715
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2764
2718
                return False
2765
2719
 
2766
2720
            GLib.io_add_watch(
2767
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2768
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2721
                parent_pipe.fileno(),
 
2722
                GLib.IO_IN | GLib.IO_HUP,
2769
2723
                functools.partial(self.handle_ipc,
2770
2724
                                  parent_pipe=parent_pipe,
2771
2725
                                  proc=proc,
2774
2728
            # remove the old hook in favor of the new above hook on
2775
2729
            # same fileno
2776
2730
            return False
2777
 
        if command == "funcall":
 
2731
        if command == 'funcall':
2778
2732
            funcname = request[1]
2779
2733
            args = request[2]
2780
2734
            kwargs = request[3]
2781
2735
 
2782
 
            parent_pipe.send(("data", getattr(client_object,
 
2736
            parent_pipe.send(('data', getattr(client_object,
2783
2737
                                              funcname)(*args,
2784
2738
                                                        **kwargs)))
2785
2739
 
2786
 
        if command == "getattr":
 
2740
        if command == 'getattr':
2787
2741
            attrname = request[1]
2788
2742
            if isinstance(client_object.__getattribute__(attrname),
2789
 
                          collections.abc.Callable):
2790
 
                parent_pipe.send(("function", ))
 
2743
                          collections.Callable):
 
2744
                parent_pipe.send(('function', ))
2791
2745
            else:
2792
2746
                parent_pipe.send((
2793
 
                    "data", client_object.__getattribute__(attrname)))
 
2747
                    'data', client_object.__getattribute__(attrname)))
2794
2748
 
2795
 
        if command == "setattr":
 
2749
        if command == 'setattr':
2796
2750
            attrname = request[1]
2797
2751
            value = request[2]
2798
2752
            setattr(client_object, attrname, value)
2803
2757
def rfc3339_duration_to_delta(duration):
2804
2758
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2805
2759
 
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
 
2760
    >>> rfc3339_duration_to_delta("P7D")
 
2761
    datetime.timedelta(7)
 
2762
    >>> rfc3339_duration_to_delta("PT60S")
 
2763
    datetime.timedelta(0, 60)
 
2764
    >>> rfc3339_duration_to_delta("PT60M")
 
2765
    datetime.timedelta(0, 3600)
 
2766
    >>> rfc3339_duration_to_delta("PT24H")
 
2767
    datetime.timedelta(1)
 
2768
    >>> rfc3339_duration_to_delta("P1W")
 
2769
    datetime.timedelta(7)
 
2770
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2771
    datetime.timedelta(0, 330)
 
2772
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2773
    datetime.timedelta(1, 200)
2822
2774
    """
2823
2775
 
2824
2776
    # Parsing an RFC 3339 duration with regular expressions is not
2904
2856
def string_to_delta(interval):
2905
2857
    """Parse a string and return a datetime.timedelta
2906
2858
 
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)
2918
 
    True
 
2859
    >>> string_to_delta('7d')
 
2860
    datetime.timedelta(7)
 
2861
    >>> string_to_delta('60s')
 
2862
    datetime.timedelta(0, 60)
 
2863
    >>> string_to_delta('60m')
 
2864
    datetime.timedelta(0, 3600)
 
2865
    >>> string_to_delta('24h')
 
2866
    datetime.timedelta(1)
 
2867
    >>> string_to_delta('1w')
 
2868
    datetime.timedelta(7)
 
2869
    >>> string_to_delta('5m 30s')
 
2870
    datetime.timedelta(0, 330)
2919
2871
    """
2920
2872
 
2921
2873
    try:
3023
2975
 
3024
2976
    options = parser.parse_args()
3025
2977
 
 
2978
    if options.check:
 
2979
        import doctest
 
2980
        fail_count, test_count = doctest.testmod()
 
2981
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2982
 
3026
2983
    # Default values for config file for server-global settings
3027
2984
    if gnutls.has_rawpk:
3028
2985
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3124
3081
 
3125
3082
    if server_settings["servicename"] != "Mandos":
3126
3083
        syslogger.setFormatter(
3127
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3128
 
                              " %(levelname)s: %(message)s".format(
 
3084
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3085
                              ' %(levelname)s: %(message)s'.format(
3129
3086
                                  server_settings["servicename"])))
3130
3087
 
3131
3088
    # Parse config file with clients
3155
3112
        try:
3156
3113
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3157
3114
        except IOError as e:
3158
 
            log.error("Could not open file %r", pidfilename,
3159
 
                      exc_info=e)
 
3115
            logger.error("Could not open file %r", pidfilename,
 
3116
                         exc_info=e)
3160
3117
 
3161
3118
    for name, group in (("_mandos", "_mandos"),
3162
3119
                        ("mandos", "mandos"),
3173
3130
    try:
3174
3131
        os.setgid(gid)
3175
3132
        os.setuid(uid)
3176
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3133
        if debug:
 
3134
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3135
                                                             gid))
3177
3136
    except OSError as error:
3178
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3179
 
                    os.strerror(error.errno))
 
3137
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3138
                       .format(uid, gid, os.strerror(error.errno)))
3180
3139
        if error.errno != errno.EPERM:
3181
3140
            raise
3182
3141
 
3189
3148
 
3190
3149
        @gnutls.log_func
3191
3150
        def debug_gnutls(level, string):
3192
 
            log.debug("GnuTLS: %s",
3193
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3151
            logger.debug("GnuTLS: %s", string[:-1])
3194
3152
 
3195
3153
        gnutls.global_set_log_function(debug_gnutls)
3196
3154
 
3225
3183
                "se.bsnet.fukt.Mandos", bus,
3226
3184
                do_not_queue=True)
3227
3185
        except dbus.exceptions.DBusException as e:
3228
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3186
            logger.error("Disabling D-Bus:", exc_info=e)
3229
3187
            use_dbus = False
3230
3188
            server_settings["use_dbus"] = False
3231
3189
            tcp_server.use_dbus = False
3290
3248
                             if isinstance(s, bytes)
3291
3249
                             else s) for s in
3292
3250
                            value["client_structure"]]
3293
 
                        # .name, .host, and .checker_command
3294
 
                        for k in ("name", "host", "checker_command"):
 
3251
                        # .name & .host
 
3252
                        for k in ("name", "host"):
3295
3253
                            if isinstance(value[k], bytes):
3296
3254
                                value[k] = value[k].decode("utf-8")
3297
3255
                        if "key_id" not in value:
3307
3265
                        for key, value in
3308
3266
                        bytes_old_client_settings.items()}
3309
3267
                    del bytes_old_client_settings
3310
 
                    # .host and .checker_command
 
3268
                    # .host
3311
3269
                    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"))
 
3270
                        if isinstance(value["host"], bytes):
 
3271
                            value["host"] = (value["host"]
 
3272
                                             .decode("utf-8"))
3316
3273
            os.remove(stored_state_path)
3317
3274
        except IOError as e:
3318
3275
            if e.errno == errno.ENOENT:
3319
 
                log.warning("Could not load persistent state:"
3320
 
                            " %s", os.strerror(e.errno))
 
3276
                logger.warning("Could not load persistent state:"
 
3277
                               " {}".format(os.strerror(e.errno)))
3321
3278
            else:
3322
 
                log.critical("Could not load persistent state:",
3323
 
                             exc_info=e)
 
3279
                logger.critical("Could not load persistent state:",
 
3280
                                exc_info=e)
3324
3281
                raise
3325
3282
        except EOFError as e:
3326
 
            log.warning("Could not load persistent state: EOFError:",
3327
 
                        exc_info=e)
 
3283
            logger.warning("Could not load persistent state: "
 
3284
                           "EOFError:",
 
3285
                           exc_info=e)
3328
3286
 
3329
3287
    with PGPEngine() as pgp:
3330
3288
        for client_name, client in clients_data.items():
3357
3315
            if client["enabled"]:
3358
3316
                if datetime.datetime.utcnow() >= client["expires"]:
3359
3317
                    if not client["last_checked_ok"]:
3360
 
                        log.warning("disabling client %s - Client"
3361
 
                                    " never performed a successful"
3362
 
                                    " checker", client_name)
 
3318
                        logger.warning(
 
3319
                            "disabling client {} - Client never "
 
3320
                            "performed a successful checker".format(
 
3321
                                client_name))
3363
3322
                        client["enabled"] = False
3364
3323
                    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"])
 
3324
                        logger.warning(
 
3325
                            "disabling client {} - Client last"
 
3326
                            " checker failed with error code"
 
3327
                            " {}".format(
 
3328
                                client_name,
 
3329
                                client["last_checker_status"]))
3369
3330
                        client["enabled"] = False
3370
3331
                    else:
3371
3332
                        client["expires"] = (
3372
3333
                            datetime.datetime.utcnow()
3373
3334
                            + client["timeout"])
3374
 
                        log.debug("Last checker succeeded, keeping %s"
3375
 
                                  " enabled", client_name)
 
3335
                        logger.debug("Last checker succeeded,"
 
3336
                                     " keeping {} enabled".format(
 
3337
                                         client_name))
3376
3338
            try:
3377
3339
                client["secret"] = pgp.decrypt(
3378
3340
                    client["encrypted_secret"],
3379
3341
                    client_settings[client_name]["secret"])
3380
3342
            except PGPError:
3381
3343
                # If decryption fails, we use secret from new settings
3382
 
                log.debug("Failed to decrypt %s old secret",
3383
 
                          client_name)
 
3344
                logger.debug("Failed to decrypt {} old secret".format(
 
3345
                    client_name))
3384
3346
                client["secret"] = (client_settings[client_name]
3385
3347
                                    ["secret"])
3386
3348
 
3400
3362
            server_settings=server_settings)
3401
3363
 
3402
3364
    if not tcp_server.clients:
3403
 
        log.warning("No clients defined")
 
3365
        logger.warning("No clients defined")
3404
3366
 
3405
3367
    if not foreground:
3406
3368
        if pidfile is not None:
3409
3371
                with pidfile:
3410
3372
                    print(pid, file=pidfile)
3411
3373
            except IOError:
3412
 
                log.error("Could not write to file %r with PID %d",
3413
 
                          pidfilename, pid)
 
3374
                logger.error("Could not write to file %r with PID %d",
 
3375
                             pidfilename, pid)
3414
3376
        del pidfile
3415
3377
        del pidfilename
3416
3378
 
3566
3528
 
3567
3529
        try:
3568
3530
            with tempfile.NamedTemporaryFile(
3569
 
                    mode="wb",
 
3531
                    mode='wb',
3570
3532
                    suffix=".pickle",
3571
 
                    prefix="clients-",
 
3533
                    prefix='clients-',
3572
3534
                    dir=os.path.dirname(stored_state_path),
3573
3535
                    delete=False) as stored_state:
3574
3536
                pickle.dump((clients, client_settings), stored_state,
3582
3544
                except NameError:
3583
3545
                    pass
3584
3546
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3585
 
                log.warning("Could not save persistent state: %s",
3586
 
                            os.strerror(e.errno))
 
3547
                logger.warning("Could not save persistent state: {}"
 
3548
                               .format(os.strerror(e.errno)))
3587
3549
            else:
3588
 
                log.warning("Could not save persistent state:",
3589
 
                            exc_info=e)
 
3550
                logger.warning("Could not save persistent state:",
 
3551
                               exc_info=e)
3590
3552
                raise
3591
3553
 
3592
3554
        # Delete all clients, and settings from config
3618
3580
    if zeroconf:
3619
3581
        service.port = tcp_server.socket.getsockname()[1]
3620
3582
    if use_ipv6:
3621
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3622
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3583
        logger.info("Now listening on address %r, port %d,"
 
3584
                    " flowinfo %d, scope_id %d",
 
3585
                    *tcp_server.socket.getsockname())
3623
3586
    else:                       # IPv4
3624
 
        log.info("Now listening on address %r, port %d",
3625
 
                 *tcp_server.socket.getsockname())
 
3587
        logger.info("Now listening on address %r, port %d",
 
3588
                    *tcp_server.socket.getsockname())
3626
3589
 
3627
3590
    # service.interface = tcp_server.socket.getsockname()[3]
3628
3591
 
3632
3595
            try:
3633
3596
                service.activate()
3634
3597
            except dbus.exceptions.DBusException as error:
3635
 
                log.critical("D-Bus Exception", exc_info=error)
 
3598
                logger.critical("D-Bus Exception", exc_info=error)
3636
3599
                cleanup()
3637
3600
                sys.exit(1)
3638
3601
            # End of Avahi example code
3639
3602
 
3640
 
        GLib.io_add_watch(
3641
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3642
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3643
 
            lambda *args, **kwargs: (tcp_server.handle_request
3644
 
                                     (*args[2:], **kwargs) or True))
 
3603
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3604
                          lambda *args, **kwargs:
 
3605
                          (tcp_server.handle_request
 
3606
                           (*args[2:], **kwargs) or True))
3645
3607
 
3646
 
        log.debug("Starting main loop")
 
3608
        logger.debug("Starting main loop")
3647
3609
        main_loop.run()
3648
3610
    except AvahiError as error:
3649
 
        log.critical("Avahi Error", exc_info=error)
 
3611
        logger.critical("Avahi Error", exc_info=error)
3650
3612
        cleanup()
3651
3613
        sys.exit(1)
3652
3614
    except KeyboardInterrupt:
3653
3615
        if debug:
3654
3616
            print("", file=sys.stderr)
3655
 
        log.debug("Server received KeyboardInterrupt")
3656
 
    log.debug("Server exiting")
 
3617
        logger.debug("Server received KeyboardInterrupt")
 
3618
    logger.debug("Server exiting")
3657
3619
    # Must run before the D-Bus bus name gets deregistered
3658
3620
    cleanup()
3659
3621
 
3660
 
 
3661
 
def parse_test_args():
3662
 
    # type: () -> argparse.Namespace
3663
 
    parser = argparse.ArgumentParser(add_help=False)
3664
 
    parser.add_argument("--check", action="store_true")
3665
 
    parser.add_argument("--prefix", )
3666
 
    args, unknown_args = parser.parse_known_args()
3667
 
    if args.check:
3668
 
        # Remove test options from sys.argv
3669
 
        sys.argv[1:] = unknown_args
3670
 
    return args
3671
 
 
3672
 
# Add all tests from doctest strings
3673
 
def load_tests(loader, tests, none):
3674
 
    import doctest
3675
 
    tests.addTests(doctest.DocTestSuite())
3676
 
    return tests
3677
 
 
3678
 
if __name__ == "__main__":
3679
 
    options = parse_test_args()
3680
 
    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=[""])
3693
 
        else:
3694
 
            main()
3695
 
    finally:
3696
 
        logging.shutdown()
3697
 
 
3698
 
# Local Variables:
3699
 
# run-tests:
3700
 
# (lambda (&optional extra)
3701
 
#   (if (not (funcall run-tests-in-test-buffer default-directory
3702
 
#             extra))
3703
 
#       (funcall show-test-buffer-in-test-window)
3704
 
#     (funcall remove-test-window)
3705
 
#     (if extra (message "Extra tests run successfully!"))))
3706
 
# run-tests-in-test-buffer:
3707
 
# (lambda (dir &optional extra)
3708
 
#   (with-current-buffer (get-buffer-create "*Test*")
3709
 
#     (setq buffer-read-only nil
3710
 
#           default-directory dir)
3711
 
#     (erase-buffer)
3712
 
#     (compilation-mode))
3713
 
#   (let ((process-result
3714
 
#          (let ((inhibit-read-only t))
3715
 
#            (process-file-shell-command
3716
 
#             (funcall get-command-line extra) nil "*Test*"))))
3717
 
#     (and (numberp process-result)
3718
 
#          (= process-result 0))))
3719
 
# get-command-line:
3720
 
# (lambda (&optional extra)
3721
 
#   (let ((quoted-script
3722
 
#          (shell-quote-argument (funcall get-script-name))))
3723
 
#     (format
3724
 
#      (concat "%s --check" (if extra " --prefix=atest" ""))
3725
 
#      quoted-script)))
3726
 
# get-script-name:
3727
 
# (lambda ()
3728
 
#   (if (fboundp 'file-local-name)
3729
 
#       (file-local-name (buffer-file-name))
3730
 
#     (or (file-remote-p (buffer-file-name) 'localname)
3731
 
#         (buffer-file-name))))
3732
 
# remove-test-window:
3733
 
# (lambda ()
3734
 
#   (let ((test-window (get-buffer-window "*Test*")))
3735
 
#     (if test-window (delete-window test-window))))
3736
 
# show-test-buffer-in-test-window:
3737
 
# (lambda ()
3738
 
#   (when (not (get-buffer-window-list "*Test*"))
3739
 
#     (setq next-error-last-buffer (get-buffer "*Test*"))
3740
 
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3741
 
#            (display-buffer-overriding-action
3742
 
#             `((display-buffer-in-side-window) (side . ,side)
3743
 
#               (window-height . fit-window-to-buffer)
3744
 
#               (window-width . fit-window-to-buffer))))
3745
 
#       (display-buffer "*Test*"))))
3746
 
# eval:
3747
 
# (progn
3748
 
#   (let* ((run-extra-tests (lambda () (interactive)
3749
 
#                             (funcall run-tests t)))
3750
 
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3751
 
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
3752
 
#     (setq minor-mode-overriding-map-alist
3753
 
#           (cons `(run-tests . ,outer-keymap)
3754
 
#                 minor-mode-overriding-map-alist)))
3755
 
#   (add-hook 'after-save-hook run-tests 90 t))
3756
 
# End:
 
3622
 
 
3623
if __name__ == '__main__':
 
3624
    main()