/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

* mandos: Use all new builtins.
* mandos-ctl: - '' -
* mandos-monitor: - '' -

Show diffs side-by-side

added added

removed removed

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