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