/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: 2014-08-09 13:12:55 UTC
  • Revision ID: teddy@recompile.se-20140809131255-lp31j98u2pl0xpe6
mandos: Stop using str() and remove unnecessary unicode() calls.

* mandos (if_nametoindex): Use "bytes" literal instead of str().
  (initlogger): Use a unicode string for log device.
  (AvahiError.__unicode__): Removed.
  (DBusPropertyException.__unicode__): - '' -
  (ClientDBus.Secret_dbus_property): Use bytes() instead of str().
  (IPv6_TCPServer.server_bind): Use .encode() instead of str().
  (string_to_delta): Removed unnecessary unicode() call.
  (main): Use "isinstance(x, bytes)" instead of "type(x) is str", use
          .decode() instead of unicode(), and use .encode() instead of
          str().

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
 
1
#!/usr/bin/python2.7
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2012 Teddy Hogeborn
15
 
# Copyright © 2008-2012 Björn Påhlsson
 
14
# Copyright © 2008-2014 Teddy Hogeborn
 
15
# Copyright © 2008-2014 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
 
37
from future_builtins import *
 
38
 
37
39
import SocketServer as socketserver
38
40
import socket
39
41
import argparse
66
68
import binascii
67
69
import tempfile
68
70
import itertools
 
71
import collections
69
72
 
70
73
import dbus
71
74
import dbus.service
76
79
import ctypes.util
77
80
import xml.dom.minidom
78
81
import inspect
79
 
import GnuPGInterface
80
82
 
81
83
try:
82
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
86
88
    except ImportError:
87
89
        SO_BINDTODEVICE = None
88
90
 
89
 
version = "1.5.3"
 
91
version = "1.6.8"
90
92
stored_state_file = "clients.pickle"
91
93
 
92
94
logger = logging.getLogger()
93
 
syslogger = (logging.handlers.SysLogHandler
94
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
 
              address = str("/dev/log")))
 
95
syslogger = None
96
96
 
97
97
try:
98
98
    if_nametoindex = (ctypes.cdll.LoadLibrary
104
104
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
105
105
        with contextlib.closing(socket.socket()) as s:
106
106
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
 
                                struct.pack(str("16s16x"),
108
 
                                            interface))
109
 
        interface_index = struct.unpack(str("I"),
110
 
                                        ifreq[16:20])[0]
 
107
                                struct.pack(b"16s16x", interface))
 
108
        interface_index = struct.unpack("I", ifreq[16:20])[0]
111
109
        return interface_index
112
110
 
113
111
 
114
112
def initlogger(debug, level=logging.WARNING):
115
113
    """init logger and add loglevel"""
116
114
    
 
115
    global syslogger
 
116
    syslogger = (logging.handlers.SysLogHandler
 
117
                 (facility =
 
118
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
119
                  address = "/dev/log"))
117
120
    syslogger.setFormatter(logging.Formatter
118
121
                           ('Mandos [%(process)d]: %(levelname)s:'
119
122
                            ' %(message)s'))
137
140
class PGPEngine(object):
138
141
    """A simple class for OpenPGP symmetric encryption & decryption"""
139
142
    def __init__(self):
140
 
        self.gnupg = GnuPGInterface.GnuPG()
141
143
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
142
 
        self.gnupg = GnuPGInterface.GnuPG()
143
 
        self.gnupg.options.meta_interactive = False
144
 
        self.gnupg.options.homedir = self.tempdir
145
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
146
 
                                              '--quiet',
147
 
                                              '--no-use-agent'])
 
144
        self.gnupgargs = ['--batch',
 
145
                          '--home', self.tempdir,
 
146
                          '--force-mdc',
 
147
                          '--quiet',
 
148
                          '--no-use-agent']
148
149
    
149
150
    def __enter__(self):
150
151
        return self
151
152
    
152
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
153
    def __exit__(self, exc_type, exc_value, traceback):
153
154
        self._cleanup()
154
155
        return False
155
156
    
172
173
    def password_encode(self, password):
173
174
        # Passphrase can not be empty and can not contain newlines or
174
175
        # NUL bytes.  So we prefix it and hex encode it.
175
 
        return b"mandos" + binascii.hexlify(password)
 
176
        encoded = b"mandos" + binascii.hexlify(password)
 
177
        if len(encoded) > 2048:
 
178
            # GnuPG can't handle long passwords, so encode differently
 
179
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
180
                       .replace(b"\n", b"\\n")
 
181
                       .replace(b"\0", b"\\x00"))
 
182
        return encoded
176
183
    
177
184
    def encrypt(self, data, password):
178
 
        self.gnupg.passphrase = self.password_encode(password)
179
 
        with open(os.devnull, "w") as devnull:
180
 
            try:
181
 
                proc = self.gnupg.run(['--symmetric'],
182
 
                                      create_fhs=['stdin', 'stdout'],
183
 
                                      attach_fhs={'stderr': devnull})
184
 
                with contextlib.closing(proc.handles['stdin']) as f:
185
 
                    f.write(data)
186
 
                with contextlib.closing(proc.handles['stdout']) as f:
187
 
                    ciphertext = f.read()
188
 
                proc.wait()
189
 
            except IOError as e:
190
 
                raise PGPError(e)
191
 
        self.gnupg.passphrase = None
 
185
        passphrase = self.password_encode(password)
 
186
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
187
                                         ) as passfile:
 
188
            passfile.write(passphrase)
 
189
            passfile.flush()
 
190
            proc = subprocess.Popen(['gpg', '--symmetric',
 
191
                                     '--passphrase-file',
 
192
                                     passfile.name]
 
193
                                    + self.gnupgargs,
 
194
                                    stdin = subprocess.PIPE,
 
195
                                    stdout = subprocess.PIPE,
 
196
                                    stderr = subprocess.PIPE)
 
197
            ciphertext, err = proc.communicate(input = data)
 
198
        if proc.returncode != 0:
 
199
            raise PGPError(err)
192
200
        return ciphertext
193
201
    
194
202
    def decrypt(self, data, password):
195
 
        self.gnupg.passphrase = self.password_encode(password)
196
 
        with open(os.devnull, "w") as devnull:
197
 
            try:
198
 
                proc = self.gnupg.run(['--decrypt'],
199
 
                                      create_fhs=['stdin', 'stdout'],
200
 
                                      attach_fhs={'stderr': devnull})
201
 
                with contextlib.closing(proc.handles['stdin']) as f:
202
 
                    f.write(data)
203
 
                with contextlib.closing(proc.handles['stdout']) as f:
204
 
                    decrypted_plaintext = f.read()
205
 
                proc.wait()
206
 
            except IOError as e:
207
 
                raise PGPError(e)
208
 
        self.gnupg.passphrase = None
 
203
        passphrase = self.password_encode(password)
 
204
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
205
                                         ) as passfile:
 
206
            passfile.write(passphrase)
 
207
            passfile.flush()
 
208
            proc = subprocess.Popen(['gpg', '--decrypt',
 
209
                                     '--passphrase-file',
 
210
                                     passfile.name]
 
211
                                    + self.gnupgargs,
 
212
                                    stdin = subprocess.PIPE,
 
213
                                    stdout = subprocess.PIPE,
 
214
                                    stderr = subprocess.PIPE)
 
215
            decrypted_plaintext, err = proc.communicate(input
 
216
                                                        = data)
 
217
        if proc.returncode != 0:
 
218
            raise PGPError(err)
209
219
        return decrypted_plaintext
210
220
 
211
221
 
212
222
class AvahiError(Exception):
213
223
    def __init__(self, value, *args, **kwargs):
214
224
        self.value = value
215
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
216
 
    def __unicode__(self):
217
 
        return unicode(repr(self.value))
 
225
        return super(AvahiError, self).__init__(value, *args,
 
226
                                                **kwargs)
218
227
 
219
228
class AvahiServiceError(AvahiError):
220
229
    pass
231
240
               Used to optionally bind to the specified interface.
232
241
    name: string; Example: 'Mandos'
233
242
    type: string; Example: '_mandos._tcp'.
234
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
243
     See <https://www.iana.org/assignments/service-names-port-numbers>
235
244
    port: integer; what port to announce
236
245
    TXT: list of strings; TXT record for the service
237
246
    domain: string; Domain to publish on, default to .local if empty.
326
335
        elif state == avahi.ENTRY_GROUP_FAILURE:
327
336
            logger.critical("Avahi: Error in group state changed %s",
328
337
                            unicode(error))
329
 
            raise AvahiGroupError("State changed: {0!s}"
 
338
            raise AvahiGroupError("State changed: {!s}"
330
339
                                  .format(error))
331
340
    
332
341
    def cleanup(self):
377
386
                                 self.server_state_changed)
378
387
        self.server_state_changed(self.server.GetState())
379
388
 
 
389
 
380
390
class AvahiServiceToSyslog(AvahiService):
381
391
    def rename(self):
382
392
        """Add the new name to the syslog messages"""
383
393
        ret = AvahiService.rename(self)
384
394
        syslogger.setFormatter(logging.Formatter
385
 
                               ('Mandos ({0}) [%(process)d]:'
 
395
                               ('Mandos ({}) [%(process)d]:'
386
396
                                ' %(levelname)s: %(message)s'
387
397
                                .format(self.name)))
388
398
        return ret
389
399
 
390
 
def timedelta_to_milliseconds(td):
391
 
    "Convert a datetime.timedelta() to milliseconds"
392
 
    return ((td.days * 24 * 60 * 60 * 1000)
393
 
            + (td.seconds * 1000)
394
 
            + (td.microseconds // 1000))
395
400
 
396
401
class Client(object):
397
402
    """A representation of a client host served by this server.
434
439
    runtime_expansions: Allowed attributes for runtime expansion.
435
440
    expires:    datetime.datetime(); time (UTC) when a client will be
436
441
                disabled, or None
 
442
    server_settings: The server_settings dict from main()
437
443
    """
438
444
    
439
445
    runtime_expansions = ("approval_delay", "approval_duration",
440
 
                          "created", "enabled", "fingerprint",
441
 
                          "host", "interval", "last_checked_ok",
 
446
                          "created", "enabled", "expires",
 
447
                          "fingerprint", "host", "interval",
 
448
                          "last_approval_request", "last_checked_ok",
442
449
                          "last_enabled", "name", "timeout")
443
 
    client_defaults = { "timeout": "5m",
444
 
                        "extended_timeout": "15m",
445
 
                        "interval": "2m",
 
450
    client_defaults = { "timeout": "PT5M",
 
451
                        "extended_timeout": "PT15M",
 
452
                        "interval": "PT2M",
446
453
                        "checker": "fping -q -- %%(host)s",
447
454
                        "host": "",
448
 
                        "approval_delay": "0s",
449
 
                        "approval_duration": "1s",
 
455
                        "approval_delay": "PT0S",
 
456
                        "approval_duration": "PT1S",
450
457
                        "approved_by_default": "True",
451
458
                        "enabled": "True",
452
459
                        }
453
460
    
454
 
    def timeout_milliseconds(self):
455
 
        "Return the 'timeout' attribute in milliseconds"
456
 
        return timedelta_to_milliseconds(self.timeout)
457
 
    
458
 
    def extended_timeout_milliseconds(self):
459
 
        "Return the 'extended_timeout' attribute in milliseconds"
460
 
        return timedelta_to_milliseconds(self.extended_timeout)
461
 
    
462
 
    def interval_milliseconds(self):
463
 
        "Return the 'interval' attribute in milliseconds"
464
 
        return timedelta_to_milliseconds(self.interval)
465
 
    
466
 
    def approval_delay_milliseconds(self):
467
 
        return timedelta_to_milliseconds(self.approval_delay)
468
 
    
469
461
    @staticmethod
470
462
    def config_parser(config):
471
463
        """Construct a new dict of client settings of this form:
496
488
                          "rb") as secfile:
497
489
                    client["secret"] = secfile.read()
498
490
            else:
499
 
                raise TypeError("No secret or secfile for section {0}"
 
491
                raise TypeError("No secret or secfile for section {}"
500
492
                                .format(section))
501
493
            client["timeout"] = string_to_delta(section["timeout"])
502
494
            client["extended_timeout"] = string_to_delta(
513
505
        
514
506
        return settings
515
507
    
516
 
    def __init__(self, settings, name = None):
 
508
    def __init__(self, settings, name = None, server_settings=None):
517
509
        self.name = name
 
510
        if server_settings is None:
 
511
            server_settings = {}
 
512
        self.server_settings = server_settings
518
513
        # adding all client settings
519
 
        for setting, value in settings.iteritems():
 
514
        for setting, value in settings.items():
520
515
            setattr(self, setting, value)
521
516
        
522
517
        if self.enabled:
570
565
        if getattr(self, "enabled", False):
571
566
            # Already enabled
572
567
            return
573
 
        self.send_changedstate()
574
568
        self.expires = datetime.datetime.utcnow() + self.timeout
575
569
        self.enabled = True
576
570
        self.last_enabled = datetime.datetime.utcnow()
577
571
        self.init_checker()
 
572
        self.send_changedstate()
578
573
    
579
574
    def disable(self, quiet=True):
580
575
        """Disable this client."""
581
576
        if not getattr(self, "enabled", False):
582
577
            return False
583
578
        if not quiet:
584
 
            self.send_changedstate()
585
 
        if not quiet:
586
579
            logger.info("Disabling client %s", self.name)
587
 
        if getattr(self, "disable_initiator_tag", False):
 
580
        if getattr(self, "disable_initiator_tag", None) is not None:
588
581
            gobject.source_remove(self.disable_initiator_tag)
589
582
            self.disable_initiator_tag = None
590
583
        self.expires = None
591
 
        if getattr(self, "checker_initiator_tag", False):
 
584
        if getattr(self, "checker_initiator_tag", None) is not None:
592
585
            gobject.source_remove(self.checker_initiator_tag)
593
586
            self.checker_initiator_tag = None
594
587
        self.stop_checker()
595
588
        self.enabled = False
 
589
        if not quiet:
 
590
            self.send_changedstate()
596
591
        # Do not run this again if called by a gobject.timeout_add
597
592
        return False
598
593
    
602
597
    def init_checker(self):
603
598
        # Schedule a new checker to be started an 'interval' from now,
604
599
        # and every interval from then on.
 
600
        if self.checker_initiator_tag is not None:
 
601
            gobject.source_remove(self.checker_initiator_tag)
605
602
        self.checker_initiator_tag = (gobject.timeout_add
606
 
                                      (self.interval_milliseconds(),
 
603
                                      (int(self.interval
 
604
                                           .total_seconds() * 1000),
607
605
                                       self.start_checker))
608
606
        # Schedule a disable() when 'timeout' has passed
 
607
        if self.disable_initiator_tag is not None:
 
608
            gobject.source_remove(self.disable_initiator_tag)
609
609
        self.disable_initiator_tag = (gobject.timeout_add
610
 
                                   (self.timeout_milliseconds(),
611
 
                                    self.disable))
 
610
                                      (int(self.timeout
 
611
                                           .total_seconds() * 1000),
 
612
                                       self.disable))
612
613
        # Also start a new checker *right now*.
613
614
        self.start_checker()
614
615
    
642
643
            timeout = self.timeout
643
644
        if self.disable_initiator_tag is not None:
644
645
            gobject.source_remove(self.disable_initiator_tag)
 
646
            self.disable_initiator_tag = None
645
647
        if getattr(self, "enabled", False):
646
648
            self.disable_initiator_tag = (gobject.timeout_add
647
 
                                          (timedelta_to_milliseconds
648
 
                                           (timeout), self.disable))
 
649
                                          (int(timeout.total_seconds()
 
650
                                               * 1000), self.disable))
649
651
            self.expires = datetime.datetime.utcnow() + timeout
650
652
    
651
653
    def need_approval(self):
668
670
        # If a checker exists, make sure it is not a zombie
669
671
        try:
670
672
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
671
 
        except (AttributeError, OSError) as error:
672
 
            if (isinstance(error, OSError)
673
 
                and error.errno != errno.ECHILD):
674
 
                raise error
 
673
        except AttributeError:
 
674
            pass
 
675
        except OSError as error:
 
676
            if error.errno != errno.ECHILD:
 
677
                raise
675
678
        else:
676
679
            if pid:
677
680
                logger.warning("Checker was a zombie")
680
683
                                      self.current_checker_command)
681
684
        # Start a new checker if needed
682
685
        if self.checker is None:
 
686
            # Escape attributes for the shell
 
687
            escaped_attrs = { attr:
 
688
                                  re.escape(unicode(getattr(self,
 
689
                                                            attr)))
 
690
                              for attr in self.runtime_expansions }
683
691
            try:
684
 
                # In case checker_command has exactly one % operator
685
 
                command = self.checker_command % self.host
686
 
            except TypeError:
687
 
                # Escape attributes for the shell
688
 
                escaped_attrs = dict(
689
 
                    (attr,
690
 
                     re.escape(unicode(str(getattr(self, attr, "")),
691
 
                                       errors=
692
 
                                       'replace')))
693
 
                    for attr in
694
 
                    self.runtime_expansions)
695
 
                
696
 
                try:
697
 
                    command = self.checker_command % escaped_attrs
698
 
                except TypeError as error:
699
 
                    logger.error('Could not format string "%s"',
700
 
                                 self.checker_command, exc_info=error)
701
 
                    return True # Try again later
 
692
                command = self.checker_command % escaped_attrs
 
693
            except TypeError as error:
 
694
                logger.error('Could not format string "%s"',
 
695
                             self.checker_command, exc_info=error)
 
696
                return True # Try again later
702
697
            self.current_checker_command = command
703
698
            try:
704
699
                logger.info("Starting checker %r for %s",
707
702
                # in normal mode, that is already done by daemon(),
708
703
                # and in debug mode we don't want to.  (Stdin is
709
704
                # always replaced by /dev/null.)
 
705
                # The exception is when not debugging but nevertheless
 
706
                # running in the foreground; use the previously
 
707
                # created wnull.
 
708
                popen_args = {}
 
709
                if (not self.server_settings["debug"]
 
710
                    and self.server_settings["foreground"]):
 
711
                    popen_args.update({"stdout": wnull,
 
712
                                       "stderr": wnull })
710
713
                self.checker = subprocess.Popen(command,
711
714
                                                close_fds=True,
712
 
                                                shell=True, cwd="/")
713
 
                self.checker_callback_tag = (gobject.child_watch_add
714
 
                                             (self.checker.pid,
715
 
                                              self.checker_callback,
716
 
                                              data=command))
717
 
                # The checker may have completed before the gobject
718
 
                # watch was added.  Check for this.
719
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
720
 
                if pid:
721
 
                    gobject.source_remove(self.checker_callback_tag)
722
 
                    self.checker_callback(pid, status, command)
 
715
                                                shell=True, cwd="/",
 
716
                                                **popen_args)
723
717
            except OSError as error:
724
718
                logger.error("Failed to start subprocess",
725
719
                             exc_info=error)
 
720
                return True
 
721
            self.checker_callback_tag = (gobject.child_watch_add
 
722
                                         (self.checker.pid,
 
723
                                          self.checker_callback,
 
724
                                          data=command))
 
725
            # The checker may have completed before the gobject
 
726
            # watch was added.  Check for this.
 
727
            try:
 
728
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
729
            except OSError as error:
 
730
                if error.errno == errno.ECHILD:
 
731
                    # This should never happen
 
732
                    logger.error("Child process vanished",
 
733
                                 exc_info=error)
 
734
                    return True
 
735
                raise
 
736
            if pid:
 
737
                gobject.source_remove(self.checker_callback_tag)
 
738
                self.checker_callback(pid, status, command)
726
739
        # Re-run this periodically if run by gobject.timeout_add
727
740
        return True
728
741
    
761
774
    # "Set" method, so we fail early here:
762
775
    if byte_arrays and signature != "ay":
763
776
        raise ValueError("Byte arrays not supported for non-'ay'"
764
 
                         " signature {0!r}".format(signature))
 
777
                         " signature {!r}".format(signature))
765
778
    def decorator(func):
766
779
        func._dbus_is_property = True
767
780
        func._dbus_interface = dbus_interface
815
828
class DBusPropertyException(dbus.exceptions.DBusException):
816
829
    """A base class for D-Bus property-related exceptions
817
830
    """
818
 
    def __unicode__(self):
819
 
        return unicode(str(self))
820
 
 
 
831
    pass
821
832
 
822
833
class DBusPropertyAccessException(DBusPropertyException):
823
834
    """A property's access permissions disallows an operation.
846
857
        If called like _is_dbus_thing("method") it returns a function
847
858
        suitable for use as predicate to inspect.getmembers().
848
859
        """
849
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
860
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
850
861
                                   False)
851
862
    
852
863
    def _get_all_dbus_things(self, thing):
901
912
            # The byte_arrays option is not supported yet on
902
913
            # signatures other than "ay".
903
914
            if prop._dbus_signature != "ay":
904
 
                raise ValueError
 
915
                raise ValueError("Byte arrays not supported for non-"
 
916
                                 "'ay' signature {!r}"
 
917
                                 .format(prop._dbus_signature))
905
918
            value = dbus.ByteArray(b''.join(chr(byte)
906
919
                                            for byte in value))
907
920
        prop(value)
971
984
                                              (prop,
972
985
                                               "_dbus_annotations",
973
986
                                               {}))
974
 
                        for name, value in annots.iteritems():
 
987
                        for name, value in annots.items():
975
988
                            ann_tag = document.createElement(
976
989
                                "annotation")
977
990
                            ann_tag.setAttribute("name", name)
980
993
                # Add interface annotation tags
981
994
                for annotation, value in dict(
982
995
                    itertools.chain.from_iterable(
983
 
                        annotations().iteritems()
 
996
                        annotations().items()
984
997
                        for name, annotations in
985
998
                        self._get_all_dbus_things("interface")
986
999
                        if name == if_tag.getAttribute("name")
987
 
                        )).iteritems():
 
1000
                        )).items():
988
1001
                    ann_tag = document.createElement("annotation")
989
1002
                    ann_tag.setAttribute("name", annotation)
990
1003
                    ann_tag.setAttribute("value", value)
1013
1026
        return xmlstring
1014
1027
 
1015
1028
 
1016
 
def datetime_to_dbus (dt, variant_level=0):
 
1029
def datetime_to_dbus(dt, variant_level=0):
1017
1030
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1018
1031
    if dt is None:
1019
1032
        return dbus.String("", variant_level = variant_level)
1027
1040
    interface names according to the "alt_interface_names" mapping.
1028
1041
    Usage:
1029
1042
    
1030
 
    @alternate_dbus_names({"org.example.Interface":
1031
 
                               "net.example.AlternateInterface"})
 
1043
    @alternate_dbus_interfaces({"org.example.Interface":
 
1044
                                    "net.example.AlternateInterface"})
1032
1045
    class SampleDBusObject(dbus.service.Object):
1033
1046
        @dbus.service.method("org.example.Interface")
1034
1047
        def SampleDBusMethod():
1046
1059
    """
1047
1060
    def wrapper(cls):
1048
1061
        for orig_interface_name, alt_interface_name in (
1049
 
            alt_interface_names.iteritems()):
 
1062
            alt_interface_names.items()):
1050
1063
            attr = {}
1051
1064
            interface_names = set()
1052
1065
            # Go though all attributes of the class
1065
1078
                interface_names.add(alt_interface)
1066
1079
                # Is this a D-Bus signal?
1067
1080
                if getattr(attribute, "_dbus_is_signal", False):
1068
 
                    # Extract the original non-method function by
1069
 
                    # black magic
 
1081
                    # Extract the original non-method undecorated
 
1082
                    # function by black magic
1070
1083
                    nonmethod_func = (dict(
1071
1084
                            zip(attribute.func_code.co_freevars,
1072
1085
                                attribute.__closure__))["func"]
1169
1182
                                        attribute.func_closure)))
1170
1183
            if deprecate:
1171
1184
                # Deprecate all alternate interfaces
1172
 
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1185
                iname="_AlternateDBusNames_interface_annotation{}"
1173
1186
                for interface_name in interface_names:
1174
1187
                    @dbus_interface_annotations(interface_name)
1175
1188
                    def func(self):
1184
1197
            if interface_names:
1185
1198
                # Replace the class with a new subclass of it with
1186
1199
                # methods, signals, etc. as created above.
1187
 
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1200
                cls = type(b"{}Alternate".format(cls.__name__),
1188
1201
                           (cls,), attr)
1189
1202
        return cls
1190
1203
    return wrapper
1231
1244
                   to the D-Bus.  Default: no transform
1232
1245
        variant_level: D-Bus variant level.  Default: 1
1233
1246
        """
1234
 
        attrname = "_{0}".format(dbus_name)
 
1247
        attrname = "_{}".format(dbus_name)
1235
1248
        def setter(self, value):
1236
1249
            if hasattr(self, "dbus_object_path"):
1237
1250
                if (not hasattr(self, attrname) or
1267
1280
    approval_delay = notifychangeproperty(dbus.UInt64,
1268
1281
                                          "ApprovalDelay",
1269
1282
                                          type_func =
1270
 
                                          timedelta_to_milliseconds)
 
1283
                                          lambda td: td.total_seconds()
 
1284
                                          * 1000)
1271
1285
    approval_duration = notifychangeproperty(
1272
1286
        dbus.UInt64, "ApprovalDuration",
1273
 
        type_func = timedelta_to_milliseconds)
 
1287
        type_func = lambda td: td.total_seconds() * 1000)
1274
1288
    host = notifychangeproperty(dbus.String, "Host")
1275
1289
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1276
 
                                   type_func =
1277
 
                                   timedelta_to_milliseconds)
 
1290
                                   type_func = lambda td:
 
1291
                                       td.total_seconds() * 1000)
1278
1292
    extended_timeout = notifychangeproperty(
1279
1293
        dbus.UInt64, "ExtendedTimeout",
1280
 
        type_func = timedelta_to_milliseconds)
 
1294
        type_func = lambda td: td.total_seconds() * 1000)
1281
1295
    interval = notifychangeproperty(dbus.UInt64,
1282
1296
                                    "Interval",
1283
1297
                                    type_func =
1284
 
                                    timedelta_to_milliseconds)
 
1298
                                    lambda td: td.total_seconds()
 
1299
                                    * 1000)
1285
1300
    checker_command = notifychangeproperty(dbus.String, "Checker")
1286
1301
    
1287
1302
    del notifychangeproperty
1315
1330
                                       *args, **kwargs)
1316
1331
    
1317
1332
    def start_checker(self, *args, **kwargs):
1318
 
        old_checker = self.checker
1319
 
        if self.checker is not None:
1320
 
            old_checker_pid = self.checker.pid
1321
 
        else:
1322
 
            old_checker_pid = None
 
1333
        old_checker_pid = getattr(self.checker, "pid", None)
1323
1334
        r = Client.start_checker(self, *args, **kwargs)
1324
1335
        # Only if new checker process was started
1325
1336
        if (self.checker is not None
1333
1344
        return False
1334
1345
    
1335
1346
    def approve(self, value=True):
1336
 
        self.send_changedstate()
1337
1347
        self.approved = value
1338
 
        gobject.timeout_add(timedelta_to_milliseconds
1339
 
                            (self.approval_duration),
1340
 
                            self._reset_approved)
 
1348
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1349
                                * 1000), self._reset_approved)
 
1350
        self.send_changedstate()
1341
1351
    
1342
1352
    ## D-Bus methods, signals & properties
1343
1353
    _interface = "se.recompile.Mandos.Client"
1445
1455
                           access="readwrite")
1446
1456
    def ApprovalDelay_dbus_property(self, value=None):
1447
1457
        if value is None:       # get
1448
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1458
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1459
                               * 1000)
1449
1460
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1450
1461
    
1451
1462
    # ApprovalDuration - property
1453
1464
                           access="readwrite")
1454
1465
    def ApprovalDuration_dbus_property(self, value=None):
1455
1466
        if value is None:       # get
1456
 
            return dbus.UInt64(timedelta_to_milliseconds(
1457
 
                    self.approval_duration))
 
1467
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1468
                               * 1000)
1458
1469
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1459
1470
    
1460
1471
    # Name - property
1526
1537
                           access="readwrite")
1527
1538
    def Timeout_dbus_property(self, value=None):
1528
1539
        if value is None:       # get
1529
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1540
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1541
        old_timeout = self.timeout
1530
1542
        self.timeout = datetime.timedelta(0, 0, 0, value)
1531
 
        # Reschedule timeout
 
1543
        # Reschedule disabling
1532
1544
        if self.enabled:
1533
1545
            now = datetime.datetime.utcnow()
1534
 
            time_to_die = timedelta_to_milliseconds(
1535
 
                (self.last_checked_ok + self.timeout) - now)
1536
 
            if time_to_die <= 0:
 
1546
            self.expires += self.timeout - old_timeout
 
1547
            if self.expires <= now:
1537
1548
                # The timeout has passed
1538
1549
                self.disable()
1539
1550
            else:
1540
 
                self.expires = (now +
1541
 
                                datetime.timedelta(milliseconds =
1542
 
                                                   time_to_die))
1543
1551
                if (getattr(self, "disable_initiator_tag", None)
1544
1552
                    is None):
1545
1553
                    return
1546
1554
                gobject.source_remove(self.disable_initiator_tag)
1547
 
                self.disable_initiator_tag = (gobject.timeout_add
1548
 
                                              (time_to_die,
1549
 
                                               self.disable))
 
1555
                self.disable_initiator_tag = (
 
1556
                    gobject.timeout_add(
 
1557
                        int((self.expires - now).total_seconds()
 
1558
                            * 1000), self.disable))
1550
1559
    
1551
1560
    # ExtendedTimeout - property
1552
1561
    @dbus_service_property(_interface, signature="t",
1553
1562
                           access="readwrite")
1554
1563
    def ExtendedTimeout_dbus_property(self, value=None):
1555
1564
        if value is None:       # get
1556
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1565
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1566
                               * 1000)
1557
1567
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1558
1568
    
1559
1569
    # Interval - property
1561
1571
                           access="readwrite")
1562
1572
    def Interval_dbus_property(self, value=None):
1563
1573
        if value is None:       # get
1564
 
            return dbus.UInt64(self.interval_milliseconds())
 
1574
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1565
1575
        self.interval = datetime.timedelta(0, 0, 0, value)
1566
1576
        if getattr(self, "checker_initiator_tag", None) is None:
1567
1577
            return
1600
1610
    @dbus_service_property(_interface, signature="ay",
1601
1611
                           access="write", byte_arrays=True)
1602
1612
    def Secret_dbus_property(self, value):
1603
 
        self.secret = str(value)
 
1613
        self.secret = bytes(value)
1604
1614
    
1605
1615
    del _interface
1606
1616
 
1672
1682
            logger.debug("Protocol version: %r", line)
1673
1683
            try:
1674
1684
                if int(line.strip().split()[0]) > 1:
1675
 
                    raise RuntimeError
 
1685
                    raise RuntimeError(line)
1676
1686
            except (ValueError, IndexError, RuntimeError) as error:
1677
1687
                logger.error("Unknown protocol version: %s", error)
1678
1688
                return
1727
1737
                        if self.server.use_dbus:
1728
1738
                            # Emit D-Bus signal
1729
1739
                            client.NeedApproval(
1730
 
                                client.approval_delay_milliseconds(),
1731
 
                                client.approved_by_default)
 
1740
                                client.approval_delay.total_seconds()
 
1741
                                * 1000, client.approved_by_default)
1732
1742
                    else:
1733
1743
                        logger.warning("Client %s was not approved",
1734
1744
                                       client.name)
1740
1750
                    #wait until timeout or approved
1741
1751
                    time = datetime.datetime.now()
1742
1752
                    client.changedstate.acquire()
1743
 
                    (client.changedstate.wait
1744
 
                     (float(client.timedelta_to_milliseconds(delay)
1745
 
                            / 1000)))
 
1753
                    client.changedstate.wait(delay.total_seconds())
1746
1754
                    client.changedstate.release()
1747
1755
                    time2 = datetime.datetime.now()
1748
1756
                    if (time2 - time) >= delay:
1864
1872
    def process_request(self, request, address):
1865
1873
        """Start a new process to process the request."""
1866
1874
        proc = multiprocessing.Process(target = self.sub_process_main,
1867
 
                                       args = (request,
1868
 
                                               address))
 
1875
                                       args = (request, address))
1869
1876
        proc.start()
1870
1877
        return proc
1871
1878
 
1886
1893
    
1887
1894
    def add_pipe(self, parent_pipe, proc):
1888
1895
        """Dummy function; override as necessary"""
1889
 
        raise NotImplementedError
 
1896
        raise NotImplementedError()
1890
1897
 
1891
1898
 
1892
1899
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1899
1906
        use_ipv6:       Boolean; to use IPv6 or not
1900
1907
    """
1901
1908
    def __init__(self, server_address, RequestHandlerClass,
1902
 
                 interface=None, use_ipv6=True):
 
1909
                 interface=None, use_ipv6=True, socketfd=None):
 
1910
        """If socketfd is set, use that file descriptor instead of
 
1911
        creating a new one with socket.socket().
 
1912
        """
1903
1913
        self.interface = interface
1904
1914
        if use_ipv6:
1905
1915
            self.address_family = socket.AF_INET6
 
1916
        if socketfd is not None:
 
1917
            # Save the file descriptor
 
1918
            self.socketfd = socketfd
 
1919
            # Save the original socket.socket() function
 
1920
            self.socket_socket = socket.socket
 
1921
            # To implement --socket, we monkey patch socket.socket.
 
1922
            # 
 
1923
            # (When socketserver.TCPServer is a new-style class, we
 
1924
            # could make self.socket into a property instead of monkey
 
1925
            # patching socket.socket.)
 
1926
            # 
 
1927
            # Create a one-time-only replacement for socket.socket()
 
1928
            @functools.wraps(socket.socket)
 
1929
            def socket_wrapper(*args, **kwargs):
 
1930
                # Restore original function so subsequent calls are
 
1931
                # not affected.
 
1932
                socket.socket = self.socket_socket
 
1933
                del self.socket_socket
 
1934
                # This time only, return a new socket object from the
 
1935
                # saved file descriptor.
 
1936
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1937
            # Replace socket.socket() function with wrapper
 
1938
            socket.socket = socket_wrapper
 
1939
        # The socketserver.TCPServer.__init__ will call
 
1940
        # socket.socket(), which might be our replacement,
 
1941
        # socket_wrapper(), if socketfd was set.
1906
1942
        socketserver.TCPServer.__init__(self, server_address,
1907
1943
                                        RequestHandlerClass)
 
1944
    
1908
1945
    def server_bind(self):
1909
1946
        """This overrides the normal server_bind() function
1910
1947
        to bind to an interface if one was specified, and also NOT to
1918
1955
                try:
1919
1956
                    self.socket.setsockopt(socket.SOL_SOCKET,
1920
1957
                                           SO_BINDTODEVICE,
1921
 
                                           str(self.interface
1922
 
                                               + '\0'))
 
1958
                                           (self.interface + "\0")
 
1959
                                           .encode("utf-8"))
1923
1960
                except socket.error as error:
1924
 
                    if error[0] == errno.EPERM:
1925
 
                        logger.error("No permission to"
1926
 
                                     " bind to interface %s",
1927
 
                                     self.interface)
1928
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1961
                    if error.errno == errno.EPERM:
 
1962
                        logger.error("No permission to bind to"
 
1963
                                     " interface %s", self.interface)
 
1964
                    elif error.errno == errno.ENOPROTOOPT:
1929
1965
                        logger.error("SO_BINDTODEVICE not available;"
1930
1966
                                     " cannot bind to interface %s",
1931
1967
                                     self.interface)
 
1968
                    elif error.errno == errno.ENODEV:
 
1969
                        logger.error("Interface %s does not exist,"
 
1970
                                     " cannot bind", self.interface)
1932
1971
                    else:
1933
1972
                        raise
1934
1973
        # Only bind(2) the socket if we really need to.
1937
1976
                if self.address_family == socket.AF_INET6:
1938
1977
                    any_address = "::" # in6addr_any
1939
1978
                else:
1940
 
                    any_address = socket.INADDR_ANY
 
1979
                    any_address = "0.0.0.0" # INADDR_ANY
1941
1980
                self.server_address = (any_address,
1942
1981
                                       self.server_address[1])
1943
1982
            elif not self.server_address[1]:
1964
2003
    """
1965
2004
    def __init__(self, server_address, RequestHandlerClass,
1966
2005
                 interface=None, use_ipv6=True, clients=None,
1967
 
                 gnutls_priority=None, use_dbus=True):
 
2006
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1968
2007
        self.enabled = False
1969
2008
        self.clients = clients
1970
2009
        if self.clients is None:
1974
2013
        IPv6_TCPServer.__init__(self, server_address,
1975
2014
                                RequestHandlerClass,
1976
2015
                                interface = interface,
1977
 
                                use_ipv6 = use_ipv6)
 
2016
                                use_ipv6 = use_ipv6,
 
2017
                                socketfd = socketfd)
1978
2018
    def server_activate(self):
1979
2019
        if self.enabled:
1980
2020
            return socketserver.TCPServer.server_activate(self)
2058
2098
        return True
2059
2099
 
2060
2100
 
 
2101
def rfc3339_duration_to_delta(duration):
 
2102
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2103
    
 
2104
    >>> rfc3339_duration_to_delta("P7D")
 
2105
    datetime.timedelta(7)
 
2106
    >>> rfc3339_duration_to_delta("PT60S")
 
2107
    datetime.timedelta(0, 60)
 
2108
    >>> rfc3339_duration_to_delta("PT60M")
 
2109
    datetime.timedelta(0, 3600)
 
2110
    >>> rfc3339_duration_to_delta("PT24H")
 
2111
    datetime.timedelta(1)
 
2112
    >>> rfc3339_duration_to_delta("P1W")
 
2113
    datetime.timedelta(7)
 
2114
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2115
    datetime.timedelta(0, 330)
 
2116
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2117
    datetime.timedelta(1, 200)
 
2118
    """
 
2119
    
 
2120
    # Parsing an RFC 3339 duration with regular expressions is not
 
2121
    # possible - there would have to be multiple places for the same
 
2122
    # values, like seconds.  The current code, while more esoteric, is
 
2123
    # cleaner without depending on a parsing library.  If Python had a
 
2124
    # built-in library for parsing we would use it, but we'd like to
 
2125
    # avoid excessive use of external libraries.
 
2126
    
 
2127
    # New type for defining tokens, syntax, and semantics all-in-one
 
2128
    Token = collections.namedtuple("Token",
 
2129
                                   ("regexp", # To match token; if
 
2130
                                              # "value" is not None,
 
2131
                                              # must have a "group"
 
2132
                                              # containing digits
 
2133
                                    "value",  # datetime.timedelta or
 
2134
                                              # None
 
2135
                                    "followers")) # Tokens valid after
 
2136
                                                  # this token
 
2137
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2138
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2139
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2140
    token_second = Token(re.compile(r"(\d+)S"),
 
2141
                         datetime.timedelta(seconds=1),
 
2142
                         frozenset((token_end,)))
 
2143
    token_minute = Token(re.compile(r"(\d+)M"),
 
2144
                         datetime.timedelta(minutes=1),
 
2145
                         frozenset((token_second, token_end)))
 
2146
    token_hour = Token(re.compile(r"(\d+)H"),
 
2147
                       datetime.timedelta(hours=1),
 
2148
                       frozenset((token_minute, token_end)))
 
2149
    token_time = Token(re.compile(r"T"),
 
2150
                       None,
 
2151
                       frozenset((token_hour, token_minute,
 
2152
                                  token_second)))
 
2153
    token_day = Token(re.compile(r"(\d+)D"),
 
2154
                      datetime.timedelta(days=1),
 
2155
                      frozenset((token_time, token_end)))
 
2156
    token_month = Token(re.compile(r"(\d+)M"),
 
2157
                        datetime.timedelta(weeks=4),
 
2158
                        frozenset((token_day, token_end)))
 
2159
    token_year = Token(re.compile(r"(\d+)Y"),
 
2160
                       datetime.timedelta(weeks=52),
 
2161
                       frozenset((token_month, token_end)))
 
2162
    token_week = Token(re.compile(r"(\d+)W"),
 
2163
                       datetime.timedelta(weeks=1),
 
2164
                       frozenset((token_end,)))
 
2165
    token_duration = Token(re.compile(r"P"), None,
 
2166
                           frozenset((token_year, token_month,
 
2167
                                      token_day, token_time,
 
2168
                                      token_week)))
 
2169
    # Define starting values
 
2170
    value = datetime.timedelta() # Value so far
 
2171
    found_token = None
 
2172
    followers = frozenset((token_duration,)) # Following valid tokens
 
2173
    s = duration                # String left to parse
 
2174
    # Loop until end token is found
 
2175
    while found_token is not token_end:
 
2176
        # Search for any currently valid tokens
 
2177
        for token in followers:
 
2178
            match = token.regexp.match(s)
 
2179
            if match is not None:
 
2180
                # Token found
 
2181
                if token.value is not None:
 
2182
                    # Value found, parse digits
 
2183
                    factor = int(match.group(1), 10)
 
2184
                    # Add to value so far
 
2185
                    value += factor * token.value
 
2186
                # Strip token from string
 
2187
                s = token.regexp.sub("", s, 1)
 
2188
                # Go to found token
 
2189
                found_token = token
 
2190
                # Set valid next tokens
 
2191
                followers = found_token.followers
 
2192
                break
 
2193
        else:
 
2194
            # No currently valid tokens were found
 
2195
            raise ValueError("Invalid RFC 3339 duration")
 
2196
    # End token found
 
2197
    return value
 
2198
 
 
2199
 
2061
2200
def string_to_delta(interval):
2062
2201
    """Parse a string and return a datetime.timedelta
2063
2202
    
2074
2213
    >>> string_to_delta('5m 30s')
2075
2214
    datetime.timedelta(0, 330)
2076
2215
    """
 
2216
    
 
2217
    try:
 
2218
        return rfc3339_duration_to_delta(interval)
 
2219
    except ValueError:
 
2220
        pass
 
2221
    
2077
2222
    timevalue = datetime.timedelta(0)
2078
2223
    for s in interval.split():
2079
2224
        try:
2080
 
            suffix = unicode(s[-1])
 
2225
            suffix = s[-1]
2081
2226
            value = int(s[:-1])
2082
2227
            if suffix == "d":
2083
2228
                delta = datetime.timedelta(value)
2090
2235
            elif suffix == "w":
2091
2236
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2092
2237
            else:
2093
 
                raise ValueError("Unknown suffix {0!r}"
 
2238
                raise ValueError("Unknown suffix {!r}"
2094
2239
                                 .format(suffix))
2095
 
        except (ValueError, IndexError) as e:
 
2240
        except IndexError as e:
2096
2241
            raise ValueError(*(e.args))
2097
2242
        timevalue += delta
2098
2243
    return timevalue
2113
2258
        # Close all standard open file descriptors
2114
2259
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2115
2260
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2116
 
            raise OSError(errno.ENODEV,
2117
 
                          "{0} not a character device"
 
2261
            raise OSError(errno.ENODEV, "{} not a character device"
2118
2262
                          .format(os.devnull))
2119
2263
        os.dup2(null, sys.stdin.fileno())
2120
2264
        os.dup2(null, sys.stdout.fileno())
2130
2274
    
2131
2275
    parser = argparse.ArgumentParser()
2132
2276
    parser.add_argument("-v", "--version", action="version",
2133
 
                        version = "%(prog)s {0}".format(version),
 
2277
                        version = "%(prog)s {}".format(version),
2134
2278
                        help="show version number and exit")
2135
2279
    parser.add_argument("-i", "--interface", metavar="IF",
2136
2280
                        help="Bind to interface IF")
2142
2286
                        help="Run self-test")
2143
2287
    parser.add_argument("--debug", action="store_true",
2144
2288
                        help="Debug mode; run in foreground and log"
2145
 
                        " to terminal")
 
2289
                        " to terminal", default=None)
2146
2290
    parser.add_argument("--debuglevel", metavar="LEVEL",
2147
2291
                        help="Debug level for stdout output")
2148
2292
    parser.add_argument("--priority", help="GnuTLS"
2155
2299
                        " files")
2156
2300
    parser.add_argument("--no-dbus", action="store_false",
2157
2301
                        dest="use_dbus", help="Do not provide D-Bus"
2158
 
                        " system bus interface")
 
2302
                        " system bus interface", default=None)
2159
2303
    parser.add_argument("--no-ipv6", action="store_false",
2160
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2304
                        dest="use_ipv6", help="Do not use IPv6",
 
2305
                        default=None)
2161
2306
    parser.add_argument("--no-restore", action="store_false",
2162
2307
                        dest="restore", help="Do not restore stored"
2163
 
                        " state")
 
2308
                        " state", default=None)
 
2309
    parser.add_argument("--socket", type=int,
 
2310
                        help="Specify a file descriptor to a network"
 
2311
                        " socket to use instead of creating one")
2164
2312
    parser.add_argument("--statedir", metavar="DIR",
2165
2313
                        help="Directory to save/restore state in")
 
2314
    parser.add_argument("--foreground", action="store_true",
 
2315
                        help="Run in foreground", default=None)
 
2316
    parser.add_argument("--no-zeroconf", action="store_false",
 
2317
                        dest="zeroconf", help="Do not use Zeroconf",
 
2318
                        default=None)
2166
2319
    
2167
2320
    options = parser.parse_args()
2168
2321
    
2169
2322
    if options.check:
2170
2323
        import doctest
2171
 
        doctest.testmod()
2172
 
        sys.exit()
 
2324
        fail_count, test_count = doctest.testmod()
 
2325
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2173
2326
    
2174
2327
    # Default values for config file for server-global settings
2175
2328
    server_defaults = { "interface": "",
2177
2330
                        "port": "",
2178
2331
                        "debug": "False",
2179
2332
                        "priority":
2180
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2333
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2181
2334
                        "servicename": "Mandos",
2182
2335
                        "use_dbus": "True",
2183
2336
                        "use_ipv6": "True",
2184
2337
                        "debuglevel": "",
2185
2338
                        "restore": "True",
2186
 
                        "statedir": "/var/lib/mandos"
 
2339
                        "socket": "",
 
2340
                        "statedir": "/var/lib/mandos",
 
2341
                        "foreground": "False",
 
2342
                        "zeroconf": "True",
2187
2343
                        }
2188
2344
    
2189
2345
    # Parse config file for server-global settings
2194
2350
    # Convert the SafeConfigParser object to a dict
2195
2351
    server_settings = server_config.defaults()
2196
2352
    # Use the appropriate methods on the non-string config options
2197
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2353
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2198
2354
        server_settings[option] = server_config.getboolean("DEFAULT",
2199
2355
                                                           option)
2200
2356
    if server_settings["port"]:
2201
2357
        server_settings["port"] = server_config.getint("DEFAULT",
2202
2358
                                                       "port")
 
2359
    if server_settings["socket"]:
 
2360
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2361
                                                         "socket")
 
2362
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2363
        # over with an opened os.devnull.  But we don't want this to
 
2364
        # happen with a supplied network socket.
 
2365
        if 0 <= server_settings["socket"] <= 2:
 
2366
            server_settings["socket"] = os.dup(server_settings
 
2367
                                               ["socket"])
2203
2368
    del server_config
2204
2369
    
2205
2370
    # Override the settings from the config file with command line
2207
2372
    for option in ("interface", "address", "port", "debug",
2208
2373
                   "priority", "servicename", "configdir",
2209
2374
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2210
 
                   "statedir"):
 
2375
                   "statedir", "socket", "foreground", "zeroconf"):
2211
2376
        value = getattr(options, option)
2212
2377
        if value is not None:
2213
2378
            server_settings[option] = value
2214
2379
    del options
2215
2380
    # Force all strings to be unicode
2216
2381
    for option in server_settings.keys():
2217
 
        if type(server_settings[option]) is str:
2218
 
            server_settings[option] = unicode(server_settings[option])
 
2382
        if isinstance(server_settings[option], bytes):
 
2383
            server_settings[option] = (server_settings[option]
 
2384
                                       .decode("utf-8"))
 
2385
    # Force all boolean options to be boolean
 
2386
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2387
                   "foreground", "zeroconf"):
 
2388
        server_settings[option] = bool(server_settings[option])
 
2389
    # Debug implies foreground
 
2390
    if server_settings["debug"]:
 
2391
        server_settings["foreground"] = True
2219
2392
    # Now we have our good server settings in "server_settings"
2220
2393
    
2221
2394
    ##################################################################
2222
2395
    
 
2396
    if (not server_settings["zeroconf"] and
 
2397
        not (server_settings["port"]
 
2398
             or server_settings["socket"] != "")):
 
2399
            parser.error("Needs port or socket to work without"
 
2400
                         " Zeroconf")
 
2401
    
2223
2402
    # For convenience
2224
2403
    debug = server_settings["debug"]
2225
2404
    debuglevel = server_settings["debuglevel"]
2227
2406
    use_ipv6 = server_settings["use_ipv6"]
2228
2407
    stored_state_path = os.path.join(server_settings["statedir"],
2229
2408
                                     stored_state_file)
 
2409
    foreground = server_settings["foreground"]
 
2410
    zeroconf = server_settings["zeroconf"]
2230
2411
    
2231
2412
    if debug:
2232
2413
        initlogger(debug, logging.DEBUG)
2239
2420
    
2240
2421
    if server_settings["servicename"] != "Mandos":
2241
2422
        syslogger.setFormatter(logging.Formatter
2242
 
                               ('Mandos ({0}) [%(process)d]:'
 
2423
                               ('Mandos ({}) [%(process)d]:'
2243
2424
                                ' %(levelname)s: %(message)s'
2244
2425
                                .format(server_settings
2245
2426
                                        ["servicename"])))
2253
2434
    global mandos_dbus_service
2254
2435
    mandos_dbus_service = None
2255
2436
    
 
2437
    socketfd = None
 
2438
    if server_settings["socket"] != "":
 
2439
        socketfd = server_settings["socket"]
2256
2440
    tcp_server = MandosServer((server_settings["address"],
2257
2441
                               server_settings["port"]),
2258
2442
                              ClientHandler,
2261
2445
                              use_ipv6=use_ipv6,
2262
2446
                              gnutls_priority=
2263
2447
                              server_settings["priority"],
2264
 
                              use_dbus=use_dbus)
2265
 
    if not debug:
2266
 
        pidfilename = "/var/run/mandos.pid"
 
2448
                              use_dbus=use_dbus,
 
2449
                              socketfd=socketfd)
 
2450
    if not foreground:
 
2451
        pidfilename = "/run/mandos.pid"
 
2452
        if not os.path.isdir("/run/."):
 
2453
            pidfilename = "/var/run/mandos.pid"
 
2454
        pidfile = None
2267
2455
        try:
2268
2456
            pidfile = open(pidfilename, "w")
2269
2457
        except IOError as e:
2284
2472
        os.setgid(gid)
2285
2473
        os.setuid(uid)
2286
2474
    except OSError as error:
2287
 
        if error[0] != errno.EPERM:
2288
 
            raise error
 
2475
        if error.errno != errno.EPERM:
 
2476
            raise
2289
2477
    
2290
2478
    if debug:
2291
2479
        # Enable all possible GnuTLS debugging
2308
2496
            os.close(null)
2309
2497
    
2310
2498
    # Need to fork before connecting to D-Bus
2311
 
    if not debug:
 
2499
    if not foreground:
2312
2500
        # Close all input and output, do double fork, etc.
2313
2501
        daemon()
2314
2502
    
 
2503
    # multiprocessing will use threads, so before we use gobject we
 
2504
    # need to inform gobject that threads will be used.
2315
2505
    gobject.threads_init()
2316
2506
    
2317
2507
    global main_loop
2332
2522
            use_dbus = False
2333
2523
            server_settings["use_dbus"] = False
2334
2524
            tcp_server.use_dbus = False
2335
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2336
 
    service = AvahiServiceToSyslog(name =
2337
 
                                   server_settings["servicename"],
2338
 
                                   servicetype = "_mandos._tcp",
2339
 
                                   protocol = protocol, bus = bus)
2340
 
    if server_settings["interface"]:
2341
 
        service.interface = (if_nametoindex
2342
 
                             (str(server_settings["interface"])))
 
2525
    if zeroconf:
 
2526
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2527
        service = AvahiServiceToSyslog(name =
 
2528
                                       server_settings["servicename"],
 
2529
                                       servicetype = "_mandos._tcp",
 
2530
                                       protocol = protocol, bus = bus)
 
2531
        if server_settings["interface"]:
 
2532
            service.interface = (if_nametoindex
 
2533
                                 (server_settings["interface"]
 
2534
                                  .encode("utf-8")))
2343
2535
    
2344
2536
    global multiprocessing_manager
2345
2537
    multiprocessing_manager = multiprocessing.Manager()
2352
2544
    old_client_settings = {}
2353
2545
    clients_data = {}
2354
2546
    
 
2547
    # This is used to redirect stdout and stderr for checker processes
 
2548
    global wnull
 
2549
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2550
    # Only used if server is running in foreground but not in debug
 
2551
    # mode
 
2552
    if debug or not foreground:
 
2553
        wnull.close()
 
2554
    
2355
2555
    # Get client data and settings from last running state.
2356
2556
    if server_settings["restore"]:
2357
2557
        try:
2361
2561
            os.remove(stored_state_path)
2362
2562
        except IOError as e:
2363
2563
            if e.errno == errno.ENOENT:
2364
 
                logger.warning("Could not load persistent state: {0}"
 
2564
                logger.warning("Could not load persistent state: {}"
2365
2565
                                .format(os.strerror(e.errno)))
2366
2566
            else:
2367
2567
                logger.critical("Could not load persistent state:",
2372
2572
                           "EOFError:", exc_info=e)
2373
2573
    
2374
2574
    with PGPEngine() as pgp:
2375
 
        for client_name, client in clients_data.iteritems():
 
2575
        for client_name, client in clients_data.items():
 
2576
            # Skip removed clients
 
2577
            if client_name not in client_settings:
 
2578
                continue
 
2579
            
2376
2580
            # Decide which value to use after restoring saved state.
2377
2581
            # We have three different values: Old config file,
2378
2582
            # new config file, and saved state.
2399
2603
                if datetime.datetime.utcnow() >= client["expires"]:
2400
2604
                    if not client["last_checked_ok"]:
2401
2605
                        logger.warning(
2402
 
                            "disabling client {0} - Client never "
 
2606
                            "disabling client {} - Client never "
2403
2607
                            "performed a successful checker"
2404
2608
                            .format(client_name))
2405
2609
                        client["enabled"] = False
2406
2610
                    elif client["last_checker_status"] != 0:
2407
2611
                        logger.warning(
2408
 
                            "disabling client {0} - Client "
2409
 
                            "last checker failed with error code {1}"
 
2612
                            "disabling client {} - Client last"
 
2613
                            " checker failed with error code {}"
2410
2614
                            .format(client_name,
2411
2615
                                    client["last_checker_status"]))
2412
2616
                        client["enabled"] = False
2415
2619
                                             .utcnow()
2416
2620
                                             + client["timeout"])
2417
2621
                        logger.debug("Last checker succeeded,"
2418
 
                                     " keeping {0} enabled"
 
2622
                                     " keeping {} enabled"
2419
2623
                                     .format(client_name))
2420
2624
            try:
2421
2625
                client["secret"] = (
2424
2628
                                ["secret"]))
2425
2629
            except PGPError:
2426
2630
                # If decryption fails, we use secret from new settings
2427
 
                logger.debug("Failed to decrypt {0} old secret"
 
2631
                logger.debug("Failed to decrypt {} old secret"
2428
2632
                             .format(client_name))
2429
2633
                client["secret"] = (
2430
2634
                    client_settings[client_name]["secret"])
2438
2642
        clients_data[client_name] = client_settings[client_name]
2439
2643
    
2440
2644
    # Create all client objects
2441
 
    for client_name, client in clients_data.iteritems():
 
2645
    for client_name, client in clients_data.items():
2442
2646
        tcp_server.clients[client_name] = client_class(
2443
 
            name = client_name, settings = client)
 
2647
            name = client_name, settings = client,
 
2648
            server_settings = server_settings)
2444
2649
    
2445
2650
    if not tcp_server.clients:
2446
2651
        logger.warning("No clients defined")
2447
2652
    
2448
 
    if not debug:
2449
 
        try:
2450
 
            with pidfile:
2451
 
                pid = os.getpid()
2452
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2453
 
            del pidfile
2454
 
        except IOError:
2455
 
            logger.error("Could not write to file %r with PID %d",
2456
 
                         pidfilename, pid)
2457
 
        except NameError:
2458
 
            # "pidfile" was never created
2459
 
            pass
 
2653
    if not foreground:
 
2654
        if pidfile is not None:
 
2655
            try:
 
2656
                with pidfile:
 
2657
                    pid = os.getpid()
 
2658
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
 
2659
            except IOError:
 
2660
                logger.error("Could not write to file %r with PID %d",
 
2661
                             pidfilename, pid)
 
2662
        del pidfile
2460
2663
        del pidfilename
2461
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2462
2664
    
2463
2665
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2464
2666
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2529
2731
    
2530
2732
    def cleanup():
2531
2733
        "Cleanup function; run on exit"
2532
 
        service.cleanup()
 
2734
        if zeroconf:
 
2735
            service.cleanup()
2533
2736
        
2534
2737
        multiprocessing.active_children()
 
2738
        wnull.close()
2535
2739
        if not (tcp_server.clients or client_settings):
2536
2740
            return
2537
2741
        
2548
2752
                
2549
2753
                # A list of attributes that can not be pickled
2550
2754
                # + secret.
2551
 
                exclude = set(("bus", "changedstate", "secret",
2552
 
                               "checker"))
 
2755
                exclude = { "bus", "changedstate", "secret",
 
2756
                            "checker", "server_settings" }
2553
2757
                for name, typ in (inspect.getmembers
2554
2758
                                  (dbus.service.Object)):
2555
2759
                    exclude.add(name)
2564
2768
                del client_settings[client.name]["secret"]
2565
2769
        
2566
2770
        try:
2567
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2568
 
                                                prefix="clients-",
2569
 
                                                dir=os.path.dirname
2570
 
                                                (stored_state_path))
2571
 
            with os.fdopen(tempfd, "wb") as stored_state:
 
2771
            with (tempfile.NamedTemporaryFile
 
2772
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2773
                   dir=os.path.dirname(stored_state_path),
 
2774
                   delete=False)) as stored_state:
2572
2775
                pickle.dump((clients, client_settings), stored_state)
 
2776
                tempname=stored_state.name
2573
2777
            os.rename(tempname, stored_state_path)
2574
2778
        except (IOError, OSError) as e:
2575
2779
            if not debug:
2578
2782
                except NameError:
2579
2783
                    pass
2580
2784
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2581
 
                logger.warning("Could not save persistent state: {0}"
 
2785
                logger.warning("Could not save persistent state: {}"
2582
2786
                               .format(os.strerror(e.errno)))
2583
2787
            else:
2584
2788
                logger.warning("Could not save persistent state:",
2585
2789
                               exc_info=e)
2586
 
                raise e
 
2790
                raise
2587
2791
        
2588
2792
        # Delete all clients, and settings from config
2589
2793
        while tcp_server.clients:
2613
2817
    tcp_server.server_activate()
2614
2818
    
2615
2819
    # Find out what port we got
2616
 
    service.port = tcp_server.socket.getsockname()[1]
 
2820
    if zeroconf:
 
2821
        service.port = tcp_server.socket.getsockname()[1]
2617
2822
    if use_ipv6:
2618
2823
        logger.info("Now listening on address %r, port %d,"
2619
2824
                    " flowinfo %d, scope_id %d",
2625
2830
    #service.interface = tcp_server.socket.getsockname()[3]
2626
2831
    
2627
2832
    try:
2628
 
        # From the Avahi example code
2629
 
        try:
2630
 
            service.activate()
2631
 
        except dbus.exceptions.DBusException as error:
2632
 
            logger.critical("D-Bus Exception", exc_info=error)
2633
 
            cleanup()
2634
 
            sys.exit(1)
2635
 
        # End of Avahi example code
 
2833
        if zeroconf:
 
2834
            # From the Avahi example code
 
2835
            try:
 
2836
                service.activate()
 
2837
            except dbus.exceptions.DBusException as error:
 
2838
                logger.critical("D-Bus Exception", exc_info=error)
 
2839
                cleanup()
 
2840
                sys.exit(1)
 
2841
            # End of Avahi example code
2636
2842
        
2637
2843
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2638
2844
                             lambda *args, **kwargs: