/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: 2015-07-06 20:09:47 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150706200947-w21u4eq74efgl6r5
Fix minor bugs and typos and add some more debug output.

* Makefile (install-client-nokey): Create plugin-helpers directory and
                                   the mandos-client-iprouteadddel
                                   helper program.
* initramfs-tools-hook (PLUGINHELPERDIR): Fix typo.
* plugins.d/mandos-client.c: Change terminology; routes are "deleted",
                             not "removed".  All occurences changed.
  (add_remove_local_route): Renamed to "add_delete_local_route".  All
                            callers changed.  Also pass "--debug" flag
                            to helper if in debug mode.
  (add_local_route): Add debugging output.
  (remove_local_route): Renamed to "delete_local_route".  All callers
                        changed.  Also pass "--debug" flag to helper
                        if in debug mode.
  (start_mandos_communication): Add debug output when adding route.

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
if sys.version_info.major == 2:
 
92
    str = unicode
 
93
 
 
94
version = "1.6.9"
92
95
stored_state_file = "clients.pickle"
93
96
 
94
97
logger = logging.getLogger()
95
 
syslogger = (logging.handlers.SysLogHandler
96
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
 
              address = str("/dev/log")))
 
98
syslogger = None
98
99
 
99
100
try:
100
101
    if_nametoindex = (ctypes.cdll.LoadLibrary
106
107
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
107
108
        with contextlib.closing(socket.socket()) as s:
108
109
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
109
 
                                struct.pack(str("16s16x"),
110
 
                                            interface))
111
 
        interface_index = struct.unpack(str("I"),
112
 
                                        ifreq[16:20])[0]
 
110
                                struct.pack(b"16s16x", interface))
 
111
        interface_index = struct.unpack("I", ifreq[16:20])[0]
113
112
        return interface_index
114
113
 
115
114
 
116
115
def initlogger(debug, level=logging.WARNING):
117
116
    """init logger and add loglevel"""
118
117
    
 
118
    global syslogger
 
119
    syslogger = (logging.handlers.SysLogHandler
 
120
                 (facility =
 
121
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
122
                  address = "/dev/log"))
119
123
    syslogger.setFormatter(logging.Formatter
120
124
                           ('Mandos [%(process)d]: %(levelname)s:'
121
125
                            ' %(message)s'))
139
143
class PGPEngine(object):
140
144
    """A simple class for OpenPGP symmetric encryption & decryption"""
141
145
    def __init__(self):
142
 
        self.gnupg = GnuPGInterface.GnuPG()
143
146
        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'])
 
147
        self.gnupgargs = ['--batch',
 
148
                          '--home', self.tempdir,
 
149
                          '--force-mdc',
 
150
                          '--quiet',
 
151
                          '--no-use-agent']
150
152
    
151
153
    def __enter__(self):
152
154
        return self
153
155
    
154
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
156
    def __exit__(self, exc_type, exc_value, traceback):
155
157
        self._cleanup()
156
158
        return False
157
159
    
174
176
    def password_encode(self, password):
175
177
        # Passphrase can not be empty and can not contain newlines or
176
178
        # NUL bytes.  So we prefix it and hex encode it.
177
 
        return b"mandos" + binascii.hexlify(password)
 
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
178
186
    
179
187
    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
 
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)
194
203
        return ciphertext
195
204
    
196
205
    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
 
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)
211
222
        return decrypted_plaintext
212
223
 
213
224
 
214
225
class AvahiError(Exception):
215
226
    def __init__(self, value, *args, **kwargs):
216
227
        self.value = value
217
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
218
 
    def __unicode__(self):
219
 
        return unicode(repr(self.value))
 
228
        return super(AvahiError, self).__init__(value, *args,
 
229
                                                **kwargs)
220
230
 
221
231
class AvahiServiceError(AvahiError):
222
232
    pass
233
243
               Used to optionally bind to the specified interface.
234
244
    name: string; Example: 'Mandos'
235
245
    type: string; Example: '_mandos._tcp'.
236
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
246
     See <https://www.iana.org/assignments/service-names-port-numbers>
237
247
    port: integer; what port to announce
238
248
    TXT: list of strings; TXT record for the service
239
249
    domain: string; Domain to publish on, default to .local if empty.
265
275
        self.bus = bus
266
276
        self.entry_group_state_changed_match = None
267
277
    
268
 
    def rename(self):
 
278
    def rename(self, remove=True):
269
279
        """Derived from the Avahi example code"""
270
280
        if self.rename_count >= self.max_renames:
271
281
            logger.critical("No suitable Zeroconf service name found"
272
282
                            " after %i retries, exiting.",
273
283
                            self.rename_count)
274
284
            raise AvahiServiceError("Too many renames")
275
 
        self.name = unicode(self.server
276
 
                            .GetAlternativeServiceName(self.name))
 
285
        self.name = str(self.server
 
286
                        .GetAlternativeServiceName(self.name))
 
287
        self.rename_count += 1
277
288
        logger.info("Changing Zeroconf service name to %r ...",
278
289
                    self.name)
279
 
        self.remove()
 
290
        if remove:
 
291
            self.remove()
280
292
        try:
281
293
            self.add()
282
294
        except dbus.exceptions.DBusException as error:
283
 
            logger.critical("D-Bus Exception", exc_info=error)
284
 
            self.cleanup()
285
 
            os._exit(1)
286
 
        self.rename_count += 1
 
295
            if (error.get_dbus_name()
 
296
                == "org.freedesktop.Avahi.CollisionError"):
 
297
                logger.info("Local Zeroconf service name collision.")
 
298
                return self.rename(remove=False)
 
299
            else:
 
300
                logger.critical("D-Bus Exception", exc_info=error)
 
301
                self.cleanup()
 
302
                os._exit(1)
287
303
    
288
304
    def remove(self):
289
305
        """Derived from the Avahi example code"""
327
343
            self.rename()
328
344
        elif state == avahi.ENTRY_GROUP_FAILURE:
329
345
            logger.critical("Avahi: Error in group state changed %s",
330
 
                            unicode(error))
331
 
            raise AvahiGroupError("State changed: {0!s}"
 
346
                            str(error))
 
347
            raise AvahiGroupError("State changed: {!s}"
332
348
                                  .format(error))
333
349
    
334
350
    def cleanup(self):
379
395
                                 self.server_state_changed)
380
396
        self.server_state_changed(self.server.GetState())
381
397
 
 
398
 
382
399
class AvahiServiceToSyslog(AvahiService):
383
 
    def rename(self):
 
400
    def rename(self, *args, **kwargs):
384
401
        """Add the new name to the syslog messages"""
385
 
        ret = AvahiService.rename(self)
 
402
        ret = AvahiService.rename(self, *args, **kwargs)
386
403
        syslogger.setFormatter(logging.Formatter
387
 
                               ('Mandos ({0}) [%(process)d]:'
 
404
                               ('Mandos ({}) [%(process)d]:'
388
405
                                ' %(levelname)s: %(message)s'
389
406
                                .format(self.name)))
390
407
        return ret
391
408
 
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
409
 
398
410
class Client(object):
399
411
    """A representation of a client host served by this server.
436
448
    runtime_expansions: Allowed attributes for runtime expansion.
437
449
    expires:    datetime.datetime(); time (UTC) when a client will be
438
450
                disabled, or None
 
451
    server_settings: The server_settings dict from main()
439
452
    """
440
453
    
441
454
    runtime_expansions = ("approval_delay", "approval_duration",
442
 
                          "created", "enabled", "fingerprint",
443
 
                          "host", "interval", "last_checked_ok",
 
455
                          "created", "enabled", "expires",
 
456
                          "fingerprint", "host", "interval",
 
457
                          "last_approval_request", "last_checked_ok",
444
458
                          "last_enabled", "name", "timeout")
445
 
    client_defaults = { "timeout": "5m",
446
 
                        "extended_timeout": "15m",
447
 
                        "interval": "2m",
 
459
    client_defaults = { "timeout": "PT5M",
 
460
                        "extended_timeout": "PT15M",
 
461
                        "interval": "PT2M",
448
462
                        "checker": "fping -q -- %%(host)s",
449
463
                        "host": "",
450
 
                        "approval_delay": "0s",
451
 
                        "approval_duration": "1s",
 
464
                        "approval_delay": "PT0S",
 
465
                        "approval_duration": "PT1S",
452
466
                        "approved_by_default": "True",
453
467
                        "enabled": "True",
454
468
                        }
455
469
    
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
470
    @staticmethod
472
471
    def config_parser(config):
473
472
        """Construct a new dict of client settings of this form:
498
497
                          "rb") as secfile:
499
498
                    client["secret"] = secfile.read()
500
499
            else:
501
 
                raise TypeError("No secret or secfile for section {0}"
 
500
                raise TypeError("No secret or secfile for section {}"
502
501
                                .format(section))
503
502
            client["timeout"] = string_to_delta(section["timeout"])
504
503
            client["extended_timeout"] = string_to_delta(
515
514
        
516
515
        return settings
517
516
    
518
 
    def __init__(self, settings, name = None):
 
517
    def __init__(self, settings, name = None, server_settings=None):
519
518
        self.name = name
 
519
        if server_settings is None:
 
520
            server_settings = {}
 
521
        self.server_settings = server_settings
520
522
        # adding all client settings
521
 
        for setting, value in settings.iteritems():
 
523
        for setting, value in settings.items():
522
524
            setattr(self, setting, value)
523
525
        
524
526
        if self.enabled:
572
574
        if getattr(self, "enabled", False):
573
575
            # Already enabled
574
576
            return
575
 
        self.send_changedstate()
576
577
        self.expires = datetime.datetime.utcnow() + self.timeout
577
578
        self.enabled = True
578
579
        self.last_enabled = datetime.datetime.utcnow()
579
580
        self.init_checker()
 
581
        self.send_changedstate()
580
582
    
581
583
    def disable(self, quiet=True):
582
584
        """Disable this client."""
583
585
        if not getattr(self, "enabled", False):
584
586
            return False
585
587
        if not quiet:
586
 
            self.send_changedstate()
587
 
        if not quiet:
588
588
            logger.info("Disabling client %s", self.name)
589
 
        if getattr(self, "disable_initiator_tag", False):
 
589
        if getattr(self, "disable_initiator_tag", None) is not None:
590
590
            gobject.source_remove(self.disable_initiator_tag)
591
591
            self.disable_initiator_tag = None
592
592
        self.expires = None
593
 
        if getattr(self, "checker_initiator_tag", False):
 
593
        if getattr(self, "checker_initiator_tag", None) is not None:
594
594
            gobject.source_remove(self.checker_initiator_tag)
595
595
            self.checker_initiator_tag = None
596
596
        self.stop_checker()
597
597
        self.enabled = False
 
598
        if not quiet:
 
599
            self.send_changedstate()
598
600
        # Do not run this again if called by a gobject.timeout_add
599
601
        return False
600
602
    
604
606
    def init_checker(self):
605
607
        # Schedule a new checker to be started an 'interval' from now,
606
608
        # and every interval from then on.
 
609
        if self.checker_initiator_tag is not None:
 
610
            gobject.source_remove(self.checker_initiator_tag)
607
611
        self.checker_initiator_tag = (gobject.timeout_add
608
 
                                      (self.interval_milliseconds(),
 
612
                                      (int(self.interval
 
613
                                           .total_seconds() * 1000),
609
614
                                       self.start_checker))
610
615
        # Schedule a disable() when 'timeout' has passed
 
616
        if self.disable_initiator_tag is not None:
 
617
            gobject.source_remove(self.disable_initiator_tag)
611
618
        self.disable_initiator_tag = (gobject.timeout_add
612
 
                                   (self.timeout_milliseconds(),
613
 
                                    self.disable))
 
619
                                      (int(self.timeout
 
620
                                           .total_seconds() * 1000),
 
621
                                       self.disable))
614
622
        # Also start a new checker *right now*.
615
623
        self.start_checker()
616
624
    
644
652
            timeout = self.timeout
645
653
        if self.disable_initiator_tag is not None:
646
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
            self.disable_initiator_tag = None
647
656
        if getattr(self, "enabled", False):
648
657
            self.disable_initiator_tag = (gobject.timeout_add
649
 
                                          (timedelta_to_milliseconds
650
 
                                           (timeout), self.disable))
 
658
                                          (int(timeout.total_seconds()
 
659
                                               * 1000), self.disable))
651
660
            self.expires = datetime.datetime.utcnow() + timeout
652
661
    
653
662
    def need_approval(self):
670
679
        # If a checker exists, make sure it is not a zombie
671
680
        try:
672
681
            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
 
682
        except AttributeError:
 
683
            pass
 
684
        except OSError as error:
 
685
            if error.errno != errno.ECHILD:
 
686
                raise
677
687
        else:
678
688
            if pid:
679
689
                logger.warning("Checker was a zombie")
682
692
                                      self.current_checker_command)
683
693
        # Start a new checker if needed
684
694
        if self.checker is None:
 
695
            # Escape attributes for the shell
 
696
            escaped_attrs = { attr:
 
697
                                  re.escape(str(getattr(self, attr)))
 
698
                              for attr in self.runtime_expansions }
685
699
            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
 
700
                command = self.checker_command % escaped_attrs
 
701
            except TypeError as error:
 
702
                logger.error('Could not format string "%s"',
 
703
                             self.checker_command, exc_info=error)
 
704
                return True # Try again later
704
705
            self.current_checker_command = command
705
706
            try:
706
707
                logger.info("Starting checker %r for %s",
709
710
                # in normal mode, that is already done by daemon(),
710
711
                # and in debug mode we don't want to.  (Stdin is
711
712
                # always replaced by /dev/null.)
 
713
                # The exception is when not debugging but nevertheless
 
714
                # running in the foreground; use the previously
 
715
                # created wnull.
 
716
                popen_args = {}
 
717
                if (not self.server_settings["debug"]
 
718
                    and self.server_settings["foreground"]):
 
719
                    popen_args.update({"stdout": wnull,
 
720
                                       "stderr": wnull })
712
721
                self.checker = subprocess.Popen(command,
713
722
                                                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)
 
723
                                                shell=True, cwd="/",
 
724
                                                **popen_args)
725
725
            except OSError as error:
726
726
                logger.error("Failed to start subprocess",
727
727
                             exc_info=error)
 
728
                return True
 
729
            self.checker_callback_tag = (gobject.child_watch_add
 
730
                                         (self.checker.pid,
 
731
                                          self.checker_callback,
 
732
                                          data=command))
 
733
            # The checker may have completed before the gobject
 
734
            # watch was added.  Check for this.
 
735
            try:
 
736
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
737
            except OSError as error:
 
738
                if error.errno == errno.ECHILD:
 
739
                    # This should never happen
 
740
                    logger.error("Child process vanished",
 
741
                                 exc_info=error)
 
742
                    return True
 
743
                raise
 
744
            if pid:
 
745
                gobject.source_remove(self.checker_callback_tag)
 
746
                self.checker_callback(pid, status, command)
728
747
        # Re-run this periodically if run by gobject.timeout_add
729
748
        return True
730
749
    
763
782
    # "Set" method, so we fail early here:
764
783
    if byte_arrays and signature != "ay":
765
784
        raise ValueError("Byte arrays not supported for non-'ay'"
766
 
                         " signature {0!r}".format(signature))
 
785
                         " signature {!r}".format(signature))
767
786
    def decorator(func):
768
787
        func._dbus_is_property = True
769
788
        func._dbus_interface = dbus_interface
800
819
    """Decorator to annotate D-Bus methods, signals or properties
801
820
    Usage:
802
821
    
 
822
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
823
                       "org.freedesktop.DBus.Property."
 
824
                       "EmitsChangedSignal": "false"})
803
825
    @dbus_service_property("org.example.Interface", signature="b",
804
826
                           access="r")
805
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
806
 
                        "org.freedesktop.DBus.Property."
807
 
                        "EmitsChangedSignal": "false"})
808
827
    def Property_dbus_property(self):
809
828
        return dbus.Boolean(False)
810
829
    """
817
836
class DBusPropertyException(dbus.exceptions.DBusException):
818
837
    """A base class for D-Bus property-related exceptions
819
838
    """
820
 
    def __unicode__(self):
821
 
        return unicode(str(self))
822
 
 
 
839
    pass
823
840
 
824
841
class DBusPropertyAccessException(DBusPropertyException):
825
842
    """A property's access permissions disallows an operation.
848
865
        If called like _is_dbus_thing("method") it returns a function
849
866
        suitable for use as predicate to inspect.getmembers().
850
867
        """
851
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
868
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
852
869
                                   False)
853
870
    
854
871
    def _get_all_dbus_things(self, thing):
903
920
            # The byte_arrays option is not supported yet on
904
921
            # signatures other than "ay".
905
922
            if prop._dbus_signature != "ay":
906
 
                raise ValueError
 
923
                raise ValueError("Byte arrays not supported for non-"
 
924
                                 "'ay' signature {!r}"
 
925
                                 .format(prop._dbus_signature))
907
926
            value = dbus.ByteArray(b''.join(chr(byte)
908
927
                                            for byte in value))
909
928
        prop(value)
933
952
                                           value.variant_level+1)
934
953
        return dbus.Dictionary(properties, signature="sv")
935
954
    
 
955
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
956
    def PropertiesChanged(self, interface_name, changed_properties,
 
957
                          invalidated_properties):
 
958
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
959
        standard.
 
960
        """
 
961
        pass
 
962
    
936
963
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
937
964
                         out_signature="s",
938
965
                         path_keyword='object_path',
973
1000
                                              (prop,
974
1001
                                               "_dbus_annotations",
975
1002
                                               {}))
976
 
                        for name, value in annots.iteritems():
 
1003
                        for name, value in annots.items():
977
1004
                            ann_tag = document.createElement(
978
1005
                                "annotation")
979
1006
                            ann_tag.setAttribute("name", name)
982
1009
                # Add interface annotation tags
983
1010
                for annotation, value in dict(
984
1011
                    itertools.chain.from_iterable(
985
 
                        annotations().iteritems()
 
1012
                        annotations().items()
986
1013
                        for name, annotations in
987
1014
                        self._get_all_dbus_things("interface")
988
1015
                        if name == if_tag.getAttribute("name")
989
 
                        )).iteritems():
 
1016
                        )).items():
990
1017
                    ann_tag = document.createElement("annotation")
991
1018
                    ann_tag.setAttribute("name", annotation)
992
1019
                    ann_tag.setAttribute("value", value)
1015
1042
        return xmlstring
1016
1043
 
1017
1044
 
1018
 
def datetime_to_dbus (dt, variant_level=0):
 
1045
def datetime_to_dbus(dt, variant_level=0):
1019
1046
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1020
1047
    if dt is None:
1021
1048
        return dbus.String("", variant_level = variant_level)
1029
1056
    interface names according to the "alt_interface_names" mapping.
1030
1057
    Usage:
1031
1058
    
1032
 
    @alternate_dbus_names({"org.example.Interface":
1033
 
                               "net.example.AlternateInterface"})
 
1059
    @alternate_dbus_interfaces({"org.example.Interface":
 
1060
                                    "net.example.AlternateInterface"})
1034
1061
    class SampleDBusObject(dbus.service.Object):
1035
1062
        @dbus.service.method("org.example.Interface")
1036
1063
        def SampleDBusMethod():
1048
1075
    """
1049
1076
    def wrapper(cls):
1050
1077
        for orig_interface_name, alt_interface_name in (
1051
 
            alt_interface_names.iteritems()):
 
1078
            alt_interface_names.items()):
1052
1079
            attr = {}
1053
1080
            interface_names = set()
1054
1081
            # Go though all attributes of the class
1067
1094
                interface_names.add(alt_interface)
1068
1095
                # Is this a D-Bus signal?
1069
1096
                if getattr(attribute, "_dbus_is_signal", False):
1070
 
                    # Extract the original non-method function by
1071
 
                    # black magic
 
1097
                    # Extract the original non-method undecorated
 
1098
                    # function by black magic
1072
1099
                    nonmethod_func = (dict(
1073
1100
                            zip(attribute.func_code.co_freevars,
1074
1101
                                attribute.__closure__))["func"]
1171
1198
                                        attribute.func_closure)))
1172
1199
            if deprecate:
1173
1200
                # Deprecate all alternate interfaces
1174
 
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1201
                iname="_AlternateDBusNames_interface_annotation{}"
1175
1202
                for interface_name in interface_names:
1176
1203
                    @dbus_interface_annotations(interface_name)
1177
1204
                    def func(self):
1186
1213
            if interface_names:
1187
1214
                # Replace the class with a new subclass of it with
1188
1215
                # methods, signals, etc. as created above.
1189
 
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1216
                cls = type(b"{}Alternate".format(cls.__name__),
1190
1217
                           (cls,), attr)
1191
1218
        return cls
1192
1219
    return wrapper
1205
1232
    runtime_expansions = (Client.runtime_expansions
1206
1233
                          + ("dbus_object_path",))
1207
1234
    
 
1235
    _interface = "se.recompile.Mandos.Client"
 
1236
    
1208
1237
    # dbus.service.Object doesn't use super(), so we can't either.
1209
1238
    
1210
1239
    def __init__(self, bus = None, *args, **kwargs):
1212
1241
        Client.__init__(self, *args, **kwargs)
1213
1242
        # Only now, when this client is initialized, can it show up on
1214
1243
        # the D-Bus
1215
 
        client_object_name = unicode(self.name).translate(
 
1244
        client_object_name = str(self.name).translate(
1216
1245
            {ord("."): ord("_"),
1217
1246
             ord("-"): ord("_")})
1218
1247
        self.dbus_object_path = (dbus.ObjectPath
1222
1251
    
1223
1252
    def notifychangeproperty(transform_func,
1224
1253
                             dbus_name, type_func=lambda x: x,
1225
 
                             variant_level=1):
 
1254
                             variant_level=1, invalidate_only=False,
 
1255
                             _interface=_interface):
1226
1256
        """ Modify a variable so that it's a property which announces
1227
1257
        its changes to DBus.
1228
1258
        
1233
1263
                   to the D-Bus.  Default: no transform
1234
1264
        variant_level: D-Bus variant level.  Default: 1
1235
1265
        """
1236
 
        attrname = "_{0}".format(dbus_name)
 
1266
        attrname = "_{}".format(dbus_name)
1237
1267
        def setter(self, value):
1238
1268
            if hasattr(self, "dbus_object_path"):
1239
1269
                if (not hasattr(self, attrname) or
1240
1270
                    type_func(getattr(self, attrname, None))
1241
1271
                    != type_func(value)):
1242
 
                    dbus_value = transform_func(type_func(value),
1243
 
                                                variant_level
1244
 
                                                =variant_level)
1245
 
                    self.PropertyChanged(dbus.String(dbus_name),
1246
 
                                         dbus_value)
 
1272
                    if invalidate_only:
 
1273
                        self.PropertiesChanged(_interface,
 
1274
                                               dbus.Dictionary(),
 
1275
                                               dbus.Array
 
1276
                                               ((dbus_name,)))
 
1277
                    else:
 
1278
                        dbus_value = transform_func(type_func(value),
 
1279
                                                    variant_level
 
1280
                                                    =variant_level)
 
1281
                        self.PropertyChanged(dbus.String(dbus_name),
 
1282
                                             dbus_value)
 
1283
                        self.PropertiesChanged(_interface,
 
1284
                                               dbus.Dictionary({
 
1285
                                    dbus.String(dbus_name):
 
1286
                                        dbus_value }), dbus.Array())
1247
1287
            setattr(self, attrname, value)
1248
1288
        
1249
1289
        return property(lambda self: getattr(self, attrname), setter)
1269
1309
    approval_delay = notifychangeproperty(dbus.UInt64,
1270
1310
                                          "ApprovalDelay",
1271
1311
                                          type_func =
1272
 
                                          timedelta_to_milliseconds)
 
1312
                                          lambda td: td.total_seconds()
 
1313
                                          * 1000)
1273
1314
    approval_duration = notifychangeproperty(
1274
1315
        dbus.UInt64, "ApprovalDuration",
1275
 
        type_func = timedelta_to_milliseconds)
 
1316
        type_func = lambda td: td.total_seconds() * 1000)
1276
1317
    host = notifychangeproperty(dbus.String, "Host")
1277
1318
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1278
 
                                   type_func =
1279
 
                                   timedelta_to_milliseconds)
 
1319
                                   type_func = lambda td:
 
1320
                                       td.total_seconds() * 1000)
1280
1321
    extended_timeout = notifychangeproperty(
1281
1322
        dbus.UInt64, "ExtendedTimeout",
1282
 
        type_func = timedelta_to_milliseconds)
 
1323
        type_func = lambda td: td.total_seconds() * 1000)
1283
1324
    interval = notifychangeproperty(dbus.UInt64,
1284
1325
                                    "Interval",
1285
1326
                                    type_func =
1286
 
                                    timedelta_to_milliseconds)
 
1327
                                    lambda td: td.total_seconds()
 
1328
                                    * 1000)
1287
1329
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1330
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1331
                                  invalidate_only=True)
1288
1332
    
1289
1333
    del notifychangeproperty
1290
1334
    
1317
1361
                                       *args, **kwargs)
1318
1362
    
1319
1363
    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
 
1364
        old_checker_pid = getattr(self.checker, "pid", None)
1325
1365
        r = Client.start_checker(self, *args, **kwargs)
1326
1366
        # Only if new checker process was started
1327
1367
        if (self.checker is not None
1335
1375
        return False
1336
1376
    
1337
1377
    def approve(self, value=True):
1338
 
        self.send_changedstate()
1339
1378
        self.approved = value
1340
 
        gobject.timeout_add(timedelta_to_milliseconds
1341
 
                            (self.approval_duration),
1342
 
                            self._reset_approved)
 
1379
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1380
                                * 1000), self._reset_approved)
 
1381
        self.send_changedstate()
1343
1382
    
1344
1383
    ## D-Bus methods, signals & properties
1345
 
    _interface = "se.recompile.Mandos.Client"
1346
1384
    
1347
1385
    ## Interfaces
1348
1386
    
1349
 
    @dbus_interface_annotations(_interface)
1350
 
    def _foo(self):
1351
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1352
 
                     "false"}
1353
 
    
1354
1387
    ## Signals
1355
1388
    
1356
1389
    # CheckerCompleted - signal
1366
1399
        pass
1367
1400
    
1368
1401
    # PropertyChanged - signal
 
1402
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1369
1403
    @dbus.service.signal(_interface, signature="sv")
1370
1404
    def PropertyChanged(self, property, value):
1371
1405
        "D-Bus signal"
1447
1481
                           access="readwrite")
1448
1482
    def ApprovalDelay_dbus_property(self, value=None):
1449
1483
        if value is None:       # get
1450
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1484
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1485
                               * 1000)
1451
1486
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1452
1487
    
1453
1488
    # ApprovalDuration - property
1455
1490
                           access="readwrite")
1456
1491
    def ApprovalDuration_dbus_property(self, value=None):
1457
1492
        if value is None:       # get
1458
 
            return dbus.UInt64(timedelta_to_milliseconds(
1459
 
                    self.approval_duration))
 
1493
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1494
                               * 1000)
1460
1495
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1461
1496
    
1462
1497
    # Name - property
1475
1510
    def Host_dbus_property(self, value=None):
1476
1511
        if value is None:       # get
1477
1512
            return dbus.String(self.host)
1478
 
        self.host = unicode(value)
 
1513
        self.host = str(value)
1479
1514
    
1480
1515
    # Created - property
1481
1516
    @dbus_service_property(_interface, signature="s", access="read")
1528
1563
                           access="readwrite")
1529
1564
    def Timeout_dbus_property(self, value=None):
1530
1565
        if value is None:       # get
1531
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1566
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1567
        old_timeout = self.timeout
1532
1568
        self.timeout = datetime.timedelta(0, 0, 0, value)
1533
 
        # Reschedule timeout
 
1569
        # Reschedule disabling
1534
1570
        if self.enabled:
1535
1571
            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:
 
1572
            self.expires += self.timeout - old_timeout
 
1573
            if self.expires <= now:
1539
1574
                # The timeout has passed
1540
1575
                self.disable()
1541
1576
            else:
1542
 
                self.expires = (now +
1543
 
                                datetime.timedelta(milliseconds =
1544
 
                                                   time_to_die))
1545
1577
                if (getattr(self, "disable_initiator_tag", None)
1546
1578
                    is None):
1547
1579
                    return
1548
1580
                gobject.source_remove(self.disable_initiator_tag)
1549
 
                self.disable_initiator_tag = (gobject.timeout_add
1550
 
                                              (time_to_die,
1551
 
                                               self.disable))
 
1581
                self.disable_initiator_tag = (
 
1582
                    gobject.timeout_add(
 
1583
                        int((self.expires - now).total_seconds()
 
1584
                            * 1000), self.disable))
1552
1585
    
1553
1586
    # ExtendedTimeout - property
1554
1587
    @dbus_service_property(_interface, signature="t",
1555
1588
                           access="readwrite")
1556
1589
    def ExtendedTimeout_dbus_property(self, value=None):
1557
1590
        if value is None:       # get
1558
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1591
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1592
                               * 1000)
1559
1593
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1560
1594
    
1561
1595
    # Interval - property
1563
1597
                           access="readwrite")
1564
1598
    def Interval_dbus_property(self, value=None):
1565
1599
        if value is None:       # get
1566
 
            return dbus.UInt64(self.interval_milliseconds())
 
1600
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1567
1601
        self.interval = datetime.timedelta(0, 0, 0, value)
1568
1602
        if getattr(self, "checker_initiator_tag", None) is None:
1569
1603
            return
1580
1614
    def Checker_dbus_property(self, value=None):
1581
1615
        if value is None:       # get
1582
1616
            return dbus.String(self.checker_command)
1583
 
        self.checker_command = unicode(value)
 
1617
        self.checker_command = str(value)
1584
1618
    
1585
1619
    # CheckerRunning - property
1586
1620
    @dbus_service_property(_interface, signature="b",
1602
1636
    @dbus_service_property(_interface, signature="ay",
1603
1637
                           access="write", byte_arrays=True)
1604
1638
    def Secret_dbus_property(self, value):
1605
 
        self.secret = str(value)
 
1639
        self.secret = bytes(value)
1606
1640
    
1607
1641
    del _interface
1608
1642
 
1642
1676
    def handle(self):
1643
1677
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1644
1678
            logger.info("TCP connection from: %s",
1645
 
                        unicode(self.client_address))
 
1679
                        str(self.client_address))
1646
1680
            logger.debug("Pipe FD: %d",
1647
1681
                         self.server.child_pipe.fileno())
1648
1682
            
1674
1708
            logger.debug("Protocol version: %r", line)
1675
1709
            try:
1676
1710
                if int(line.strip().split()[0]) > 1:
1677
 
                    raise RuntimeError
 
1711
                    raise RuntimeError(line)
1678
1712
            except (ValueError, IndexError, RuntimeError) as error:
1679
1713
                logger.error("Unknown protocol version: %s", error)
1680
1714
                return
1729
1763
                        if self.server.use_dbus:
1730
1764
                            # Emit D-Bus signal
1731
1765
                            client.NeedApproval(
1732
 
                                client.approval_delay_milliseconds(),
1733
 
                                client.approved_by_default)
 
1766
                                client.approval_delay.total_seconds()
 
1767
                                * 1000, client.approved_by_default)
1734
1768
                    else:
1735
1769
                        logger.warning("Client %s was not approved",
1736
1770
                                       client.name)
1742
1776
                    #wait until timeout or approved
1743
1777
                    time = datetime.datetime.now()
1744
1778
                    client.changedstate.acquire()
1745
 
                    (client.changedstate.wait
1746
 
                     (float(client.timedelta_to_milliseconds(delay)
1747
 
                            / 1000)))
 
1779
                    client.changedstate.wait(delay.total_seconds())
1748
1780
                    client.changedstate.release()
1749
1781
                    time2 = datetime.datetime.now()
1750
1782
                    if (time2 - time) >= delay:
1887
1919
    
1888
1920
    def add_pipe(self, parent_pipe, proc):
1889
1921
        """Dummy function; override as necessary"""
1890
 
        raise NotImplementedError
 
1922
        raise NotImplementedError()
1891
1923
 
1892
1924
 
1893
1925
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1900
1932
        use_ipv6:       Boolean; to use IPv6 or not
1901
1933
    """
1902
1934
    def __init__(self, server_address, RequestHandlerClass,
1903
 
                 interface=None, use_ipv6=True):
 
1935
                 interface=None, use_ipv6=True, socketfd=None):
 
1936
        """If socketfd is set, use that file descriptor instead of
 
1937
        creating a new one with socket.socket().
 
1938
        """
1904
1939
        self.interface = interface
1905
1940
        if use_ipv6:
1906
1941
            self.address_family = socket.AF_INET6
 
1942
        if socketfd is not None:
 
1943
            # Save the file descriptor
 
1944
            self.socketfd = socketfd
 
1945
            # Save the original socket.socket() function
 
1946
            self.socket_socket = socket.socket
 
1947
            # To implement --socket, we monkey patch socket.socket.
 
1948
            # 
 
1949
            # (When socketserver.TCPServer is a new-style class, we
 
1950
            # could make self.socket into a property instead of monkey
 
1951
            # patching socket.socket.)
 
1952
            # 
 
1953
            # Create a one-time-only replacement for socket.socket()
 
1954
            @functools.wraps(socket.socket)
 
1955
            def socket_wrapper(*args, **kwargs):
 
1956
                # Restore original function so subsequent calls are
 
1957
                # not affected.
 
1958
                socket.socket = self.socket_socket
 
1959
                del self.socket_socket
 
1960
                # This time only, return a new socket object from the
 
1961
                # saved file descriptor.
 
1962
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1963
            # Replace socket.socket() function with wrapper
 
1964
            socket.socket = socket_wrapper
 
1965
        # The socketserver.TCPServer.__init__ will call
 
1966
        # socket.socket(), which might be our replacement,
 
1967
        # socket_wrapper(), if socketfd was set.
1907
1968
        socketserver.TCPServer.__init__(self, server_address,
1908
1969
                                        RequestHandlerClass)
 
1970
    
1909
1971
    def server_bind(self):
1910
1972
        """This overrides the normal server_bind() function
1911
1973
        to bind to an interface if one was specified, and also NOT to
1919
1981
                try:
1920
1982
                    self.socket.setsockopt(socket.SOL_SOCKET,
1921
1983
                                           SO_BINDTODEVICE,
1922
 
                                           str(self.interface
1923
 
                                               + '\0'))
 
1984
                                           (self.interface + "\0")
 
1985
                                           .encode("utf-8"))
1924
1986
                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:
 
1987
                    if error.errno == errno.EPERM:
 
1988
                        logger.error("No permission to bind to"
 
1989
                                     " interface %s", self.interface)
 
1990
                    elif error.errno == errno.ENOPROTOOPT:
1930
1991
                        logger.error("SO_BINDTODEVICE not available;"
1931
1992
                                     " cannot bind to interface %s",
1932
1993
                                     self.interface)
 
1994
                    elif error.errno == errno.ENODEV:
 
1995
                        logger.error("Interface %s does not exist,"
 
1996
                                     " cannot bind", self.interface)
1933
1997
                    else:
1934
1998
                        raise
1935
1999
        # Only bind(2) the socket if we really need to.
1938
2002
                if self.address_family == socket.AF_INET6:
1939
2003
                    any_address = "::" # in6addr_any
1940
2004
                else:
1941
 
                    any_address = socket.INADDR_ANY
 
2005
                    any_address = "0.0.0.0" # INADDR_ANY
1942
2006
                self.server_address = (any_address,
1943
2007
                                       self.server_address[1])
1944
2008
            elif not self.server_address[1]:
1965
2029
    """
1966
2030
    def __init__(self, server_address, RequestHandlerClass,
1967
2031
                 interface=None, use_ipv6=True, clients=None,
1968
 
                 gnutls_priority=None, use_dbus=True):
 
2032
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1969
2033
        self.enabled = False
1970
2034
        self.clients = clients
1971
2035
        if self.clients is None:
1975
2039
        IPv6_TCPServer.__init__(self, server_address,
1976
2040
                                RequestHandlerClass,
1977
2041
                                interface = interface,
1978
 
                                use_ipv6 = use_ipv6)
 
2042
                                use_ipv6 = use_ipv6,
 
2043
                                socketfd = socketfd)
1979
2044
    def server_activate(self):
1980
2045
        if self.enabled:
1981
2046
            return socketserver.TCPServer.server_activate(self)
2059
2124
        return True
2060
2125
 
2061
2126
 
 
2127
def rfc3339_duration_to_delta(duration):
 
2128
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2129
    
 
2130
    >>> rfc3339_duration_to_delta("P7D")
 
2131
    datetime.timedelta(7)
 
2132
    >>> rfc3339_duration_to_delta("PT60S")
 
2133
    datetime.timedelta(0, 60)
 
2134
    >>> rfc3339_duration_to_delta("PT60M")
 
2135
    datetime.timedelta(0, 3600)
 
2136
    >>> rfc3339_duration_to_delta("PT24H")
 
2137
    datetime.timedelta(1)
 
2138
    >>> rfc3339_duration_to_delta("P1W")
 
2139
    datetime.timedelta(7)
 
2140
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2141
    datetime.timedelta(0, 330)
 
2142
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2143
    datetime.timedelta(1, 200)
 
2144
    """
 
2145
    
 
2146
    # Parsing an RFC 3339 duration with regular expressions is not
 
2147
    # possible - there would have to be multiple places for the same
 
2148
    # values, like seconds.  The current code, while more esoteric, is
 
2149
    # cleaner without depending on a parsing library.  If Python had a
 
2150
    # built-in library for parsing we would use it, but we'd like to
 
2151
    # avoid excessive use of external libraries.
 
2152
    
 
2153
    # New type for defining tokens, syntax, and semantics all-in-one
 
2154
    Token = collections.namedtuple("Token",
 
2155
                                   ("regexp", # To match token; if
 
2156
                                              # "value" is not None,
 
2157
                                              # must have a "group"
 
2158
                                              # containing digits
 
2159
                                    "value",  # datetime.timedelta or
 
2160
                                              # None
 
2161
                                    "followers")) # Tokens valid after
 
2162
                                                  # this token
 
2163
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2164
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2165
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2166
    token_second = Token(re.compile(r"(\d+)S"),
 
2167
                         datetime.timedelta(seconds=1),
 
2168
                         frozenset((token_end,)))
 
2169
    token_minute = Token(re.compile(r"(\d+)M"),
 
2170
                         datetime.timedelta(minutes=1),
 
2171
                         frozenset((token_second, token_end)))
 
2172
    token_hour = Token(re.compile(r"(\d+)H"),
 
2173
                       datetime.timedelta(hours=1),
 
2174
                       frozenset((token_minute, token_end)))
 
2175
    token_time = Token(re.compile(r"T"),
 
2176
                       None,
 
2177
                       frozenset((token_hour, token_minute,
 
2178
                                  token_second)))
 
2179
    token_day = Token(re.compile(r"(\d+)D"),
 
2180
                      datetime.timedelta(days=1),
 
2181
                      frozenset((token_time, token_end)))
 
2182
    token_month = Token(re.compile(r"(\d+)M"),
 
2183
                        datetime.timedelta(weeks=4),
 
2184
                        frozenset((token_day, token_end)))
 
2185
    token_year = Token(re.compile(r"(\d+)Y"),
 
2186
                       datetime.timedelta(weeks=52),
 
2187
                       frozenset((token_month, token_end)))
 
2188
    token_week = Token(re.compile(r"(\d+)W"),
 
2189
                       datetime.timedelta(weeks=1),
 
2190
                       frozenset((token_end,)))
 
2191
    token_duration = Token(re.compile(r"P"), None,
 
2192
                           frozenset((token_year, token_month,
 
2193
                                      token_day, token_time,
 
2194
                                      token_week)))
 
2195
    # Define starting values
 
2196
    value = datetime.timedelta() # Value so far
 
2197
    found_token = None
 
2198
    followers = frozenset((token_duration,)) # Following valid tokens
 
2199
    s = duration                # String left to parse
 
2200
    # Loop until end token is found
 
2201
    while found_token is not token_end:
 
2202
        # Search for any currently valid tokens
 
2203
        for token in followers:
 
2204
            match = token.regexp.match(s)
 
2205
            if match is not None:
 
2206
                # Token found
 
2207
                if token.value is not None:
 
2208
                    # Value found, parse digits
 
2209
                    factor = int(match.group(1), 10)
 
2210
                    # Add to value so far
 
2211
                    value += factor * token.value
 
2212
                # Strip token from string
 
2213
                s = token.regexp.sub("", s, 1)
 
2214
                # Go to found token
 
2215
                found_token = token
 
2216
                # Set valid next tokens
 
2217
                followers = found_token.followers
 
2218
                break
 
2219
        else:
 
2220
            # No currently valid tokens were found
 
2221
            raise ValueError("Invalid RFC 3339 duration")
 
2222
    # End token found
 
2223
    return value
 
2224
 
 
2225
 
2062
2226
def string_to_delta(interval):
2063
2227
    """Parse a string and return a datetime.timedelta
2064
2228
    
2075
2239
    >>> string_to_delta('5m 30s')
2076
2240
    datetime.timedelta(0, 330)
2077
2241
    """
 
2242
    
 
2243
    try:
 
2244
        return rfc3339_duration_to_delta(interval)
 
2245
    except ValueError:
 
2246
        pass
 
2247
    
2078
2248
    timevalue = datetime.timedelta(0)
2079
2249
    for s in interval.split():
2080
2250
        try:
2081
 
            suffix = unicode(s[-1])
 
2251
            suffix = s[-1]
2082
2252
            value = int(s[:-1])
2083
2253
            if suffix == "d":
2084
2254
                delta = datetime.timedelta(value)
2091
2261
            elif suffix == "w":
2092
2262
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2093
2263
            else:
2094
 
                raise ValueError("Unknown suffix {0!r}"
 
2264
                raise ValueError("Unknown suffix {!r}"
2095
2265
                                 .format(suffix))
2096
 
        except (ValueError, IndexError) as e:
 
2266
        except IndexError as e:
2097
2267
            raise ValueError(*(e.args))
2098
2268
        timevalue += delta
2099
2269
    return timevalue
2114
2284
        # Close all standard open file descriptors
2115
2285
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2116
2286
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2117
 
            raise OSError(errno.ENODEV,
2118
 
                          "{0} not a character device"
 
2287
            raise OSError(errno.ENODEV, "{} not a character device"
2119
2288
                          .format(os.devnull))
2120
2289
        os.dup2(null, sys.stdin.fileno())
2121
2290
        os.dup2(null, sys.stdout.fileno())
2131
2300
    
2132
2301
    parser = argparse.ArgumentParser()
2133
2302
    parser.add_argument("-v", "--version", action="version",
2134
 
                        version = "%(prog)s {0}".format(version),
 
2303
                        version = "%(prog)s {}".format(version),
2135
2304
                        help="show version number and exit")
2136
2305
    parser.add_argument("-i", "--interface", metavar="IF",
2137
2306
                        help="Bind to interface IF")
2143
2312
                        help="Run self-test")
2144
2313
    parser.add_argument("--debug", action="store_true",
2145
2314
                        help="Debug mode; run in foreground and log"
2146
 
                        " to terminal")
 
2315
                        " to terminal", default=None)
2147
2316
    parser.add_argument("--debuglevel", metavar="LEVEL",
2148
2317
                        help="Debug level for stdout output")
2149
2318
    parser.add_argument("--priority", help="GnuTLS"
2156
2325
                        " files")
2157
2326
    parser.add_argument("--no-dbus", action="store_false",
2158
2327
                        dest="use_dbus", help="Do not provide D-Bus"
2159
 
                        " system bus interface")
 
2328
                        " system bus interface", default=None)
2160
2329
    parser.add_argument("--no-ipv6", action="store_false",
2161
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2330
                        dest="use_ipv6", help="Do not use IPv6",
 
2331
                        default=None)
2162
2332
    parser.add_argument("--no-restore", action="store_false",
2163
2333
                        dest="restore", help="Do not restore stored"
2164
 
                        " state")
 
2334
                        " state", default=None)
 
2335
    parser.add_argument("--socket", type=int,
 
2336
                        help="Specify a file descriptor to a network"
 
2337
                        " socket to use instead of creating one")
2165
2338
    parser.add_argument("--statedir", metavar="DIR",
2166
2339
                        help="Directory to save/restore state in")
 
2340
    parser.add_argument("--foreground", action="store_true",
 
2341
                        help="Run in foreground", default=None)
 
2342
    parser.add_argument("--no-zeroconf", action="store_false",
 
2343
                        dest="zeroconf", help="Do not use Zeroconf",
 
2344
                        default=None)
2167
2345
    
2168
2346
    options = parser.parse_args()
2169
2347
    
2170
2348
    if options.check:
2171
2349
        import doctest
2172
 
        doctest.testmod()
2173
 
        sys.exit()
 
2350
        fail_count, test_count = doctest.testmod()
 
2351
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2174
2352
    
2175
2353
    # Default values for config file for server-global settings
2176
2354
    server_defaults = { "interface": "",
2178
2356
                        "port": "",
2179
2357
                        "debug": "False",
2180
2358
                        "priority":
2181
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2359
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2182
2360
                        "servicename": "Mandos",
2183
2361
                        "use_dbus": "True",
2184
2362
                        "use_ipv6": "True",
2185
2363
                        "debuglevel": "",
2186
2364
                        "restore": "True",
2187
 
                        "statedir": "/var/lib/mandos"
 
2365
                        "socket": "",
 
2366
                        "statedir": "/var/lib/mandos",
 
2367
                        "foreground": "False",
 
2368
                        "zeroconf": "True",
2188
2369
                        }
2189
2370
    
2190
2371
    # Parse config file for server-global settings
2195
2376
    # Convert the SafeConfigParser object to a dict
2196
2377
    server_settings = server_config.defaults()
2197
2378
    # Use the appropriate methods on the non-string config options
2198
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2379
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2199
2380
        server_settings[option] = server_config.getboolean("DEFAULT",
2200
2381
                                                           option)
2201
2382
    if server_settings["port"]:
2202
2383
        server_settings["port"] = server_config.getint("DEFAULT",
2203
2384
                                                       "port")
 
2385
    if server_settings["socket"]:
 
2386
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2387
                                                         "socket")
 
2388
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2389
        # over with an opened os.devnull.  But we don't want this to
 
2390
        # happen with a supplied network socket.
 
2391
        if 0 <= server_settings["socket"] <= 2:
 
2392
            server_settings["socket"] = os.dup(server_settings
 
2393
                                               ["socket"])
2204
2394
    del server_config
2205
2395
    
2206
2396
    # Override the settings from the config file with command line
2208
2398
    for option in ("interface", "address", "port", "debug",
2209
2399
                   "priority", "servicename", "configdir",
2210
2400
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2211
 
                   "statedir"):
 
2401
                   "statedir", "socket", "foreground", "zeroconf"):
2212
2402
        value = getattr(options, option)
2213
2403
        if value is not None:
2214
2404
            server_settings[option] = value
2215
2405
    del options
2216
2406
    # Force all strings to be unicode
2217
2407
    for option in server_settings.keys():
2218
 
        if type(server_settings[option]) is str:
2219
 
            server_settings[option] = unicode(server_settings[option])
 
2408
        if isinstance(server_settings[option], bytes):
 
2409
            server_settings[option] = (server_settings[option]
 
2410
                                       .decode("utf-8"))
 
2411
    # Force all boolean options to be boolean
 
2412
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2413
                   "foreground", "zeroconf"):
 
2414
        server_settings[option] = bool(server_settings[option])
 
2415
    # Debug implies foreground
 
2416
    if server_settings["debug"]:
 
2417
        server_settings["foreground"] = True
2220
2418
    # Now we have our good server settings in "server_settings"
2221
2419
    
2222
2420
    ##################################################################
2223
2421
    
 
2422
    if (not server_settings["zeroconf"] and
 
2423
        not (server_settings["port"]
 
2424
             or server_settings["socket"] != "")):
 
2425
            parser.error("Needs port or socket to work without"
 
2426
                         " Zeroconf")
 
2427
    
2224
2428
    # For convenience
2225
2429
    debug = server_settings["debug"]
2226
2430
    debuglevel = server_settings["debuglevel"]
2228
2432
    use_ipv6 = server_settings["use_ipv6"]
2229
2433
    stored_state_path = os.path.join(server_settings["statedir"],
2230
2434
                                     stored_state_file)
 
2435
    foreground = server_settings["foreground"]
 
2436
    zeroconf = server_settings["zeroconf"]
2231
2437
    
2232
2438
    if debug:
2233
2439
        initlogger(debug, logging.DEBUG)
2240
2446
    
2241
2447
    if server_settings["servicename"] != "Mandos":
2242
2448
        syslogger.setFormatter(logging.Formatter
2243
 
                               ('Mandos ({0}) [%(process)d]:'
 
2449
                               ('Mandos ({}) [%(process)d]:'
2244
2450
                                ' %(levelname)s: %(message)s'
2245
2451
                                .format(server_settings
2246
2452
                                        ["servicename"])))
2254
2460
    global mandos_dbus_service
2255
2461
    mandos_dbus_service = None
2256
2462
    
 
2463
    socketfd = None
 
2464
    if server_settings["socket"] != "":
 
2465
        socketfd = server_settings["socket"]
2257
2466
    tcp_server = MandosServer((server_settings["address"],
2258
2467
                               server_settings["port"]),
2259
2468
                              ClientHandler,
2262
2471
                              use_ipv6=use_ipv6,
2263
2472
                              gnutls_priority=
2264
2473
                              server_settings["priority"],
2265
 
                              use_dbus=use_dbus)
2266
 
    if not debug:
2267
 
        pidfilename = "/var/run/mandos.pid"
 
2474
                              use_dbus=use_dbus,
 
2475
                              socketfd=socketfd)
 
2476
    if not foreground:
 
2477
        pidfilename = "/run/mandos.pid"
 
2478
        if not os.path.isdir("/run/."):
 
2479
            pidfilename = "/var/run/mandos.pid"
 
2480
        pidfile = None
2268
2481
        try:
2269
2482
            pidfile = open(pidfilename, "w")
2270
2483
        except IOError as e:
2285
2498
        os.setgid(gid)
2286
2499
        os.setuid(uid)
2287
2500
    except OSError as error:
2288
 
        if error[0] != errno.EPERM:
2289
 
            raise error
 
2501
        if error.errno != errno.EPERM:
 
2502
            raise
2290
2503
    
2291
2504
    if debug:
2292
2505
        # Enable all possible GnuTLS debugging
2309
2522
            os.close(null)
2310
2523
    
2311
2524
    # Need to fork before connecting to D-Bus
2312
 
    if not debug:
 
2525
    if not foreground:
2313
2526
        # Close all input and output, do double fork, etc.
2314
2527
        daemon()
2315
2528
    
 
2529
    # multiprocessing will use threads, so before we use gobject we
 
2530
    # need to inform gobject that threads will be used.
2316
2531
    gobject.threads_init()
2317
2532
    
2318
2533
    global main_loop
2333
2548
            use_dbus = False
2334
2549
            server_settings["use_dbus"] = False
2335
2550
            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"])))
 
2551
    if zeroconf:
 
2552
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2553
        service = AvahiServiceToSyslog(name =
 
2554
                                       server_settings["servicename"],
 
2555
                                       servicetype = "_mandos._tcp",
 
2556
                                       protocol = protocol, bus = bus)
 
2557
        if server_settings["interface"]:
 
2558
            service.interface = (if_nametoindex
 
2559
                                 (server_settings["interface"]
 
2560
                                  .encode("utf-8")))
2344
2561
    
2345
2562
    global multiprocessing_manager
2346
2563
    multiprocessing_manager = multiprocessing.Manager()
2353
2570
    old_client_settings = {}
2354
2571
    clients_data = {}
2355
2572
    
 
2573
    # This is used to redirect stdout and stderr for checker processes
 
2574
    global wnull
 
2575
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2576
    # Only used if server is running in foreground but not in debug
 
2577
    # mode
 
2578
    if debug or not foreground:
 
2579
        wnull.close()
 
2580
    
2356
2581
    # Get client data and settings from last running state.
2357
2582
    if server_settings["restore"]:
2358
2583
        try:
2362
2587
            os.remove(stored_state_path)
2363
2588
        except IOError as e:
2364
2589
            if e.errno == errno.ENOENT:
2365
 
                logger.warning("Could not load persistent state: {0}"
 
2590
                logger.warning("Could not load persistent state: {}"
2366
2591
                                .format(os.strerror(e.errno)))
2367
2592
            else:
2368
2593
                logger.critical("Could not load persistent state:",
2373
2598
                           "EOFError:", exc_info=e)
2374
2599
    
2375
2600
    with PGPEngine() as pgp:
2376
 
        for client_name, client in clients_data.iteritems():
 
2601
        for client_name, client in clients_data.items():
 
2602
            # Skip removed clients
 
2603
            if client_name not in client_settings:
 
2604
                continue
 
2605
            
2377
2606
            # Decide which value to use after restoring saved state.
2378
2607
            # We have three different values: Old config file,
2379
2608
            # new config file, and saved state.
2400
2629
                if datetime.datetime.utcnow() >= client["expires"]:
2401
2630
                    if not client["last_checked_ok"]:
2402
2631
                        logger.warning(
2403
 
                            "disabling client {0} - Client never "
 
2632
                            "disabling client {} - Client never "
2404
2633
                            "performed a successful checker"
2405
2634
                            .format(client_name))
2406
2635
                        client["enabled"] = False
2407
2636
                    elif client["last_checker_status"] != 0:
2408
2637
                        logger.warning(
2409
 
                            "disabling client {0} - Client "
2410
 
                            "last checker failed with error code {1}"
 
2638
                            "disabling client {} - Client last"
 
2639
                            " checker failed with error code {}"
2411
2640
                            .format(client_name,
2412
2641
                                    client["last_checker_status"]))
2413
2642
                        client["enabled"] = False
2416
2645
                                             .utcnow()
2417
2646
                                             + client["timeout"])
2418
2647
                        logger.debug("Last checker succeeded,"
2419
 
                                     " keeping {0} enabled"
 
2648
                                     " keeping {} enabled"
2420
2649
                                     .format(client_name))
2421
2650
            try:
2422
2651
                client["secret"] = (
2425
2654
                                ["secret"]))
2426
2655
            except PGPError:
2427
2656
                # If decryption fails, we use secret from new settings
2428
 
                logger.debug("Failed to decrypt {0} old secret"
 
2657
                logger.debug("Failed to decrypt {} old secret"
2429
2658
                             .format(client_name))
2430
2659
                client["secret"] = (
2431
2660
                    client_settings[client_name]["secret"])
2439
2668
        clients_data[client_name] = client_settings[client_name]
2440
2669
    
2441
2670
    # Create all client objects
2442
 
    for client_name, client in clients_data.iteritems():
 
2671
    for client_name, client in clients_data.items():
2443
2672
        tcp_server.clients[client_name] = client_class(
2444
 
            name = client_name, settings = client)
 
2673
            name = client_name, settings = client,
 
2674
            server_settings = server_settings)
2445
2675
    
2446
2676
    if not tcp_server.clients:
2447
2677
        logger.warning("No clients defined")
2448
2678
    
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
 
2679
    if not foreground:
 
2680
        if pidfile is not None:
 
2681
            try:
 
2682
                with pidfile:
 
2683
                    pid = os.getpid()
 
2684
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
 
2685
            except IOError:
 
2686
                logger.error("Could not write to file %r with PID %d",
 
2687
                             pidfilename, pid)
 
2688
        del pidfile
2461
2689
        del pidfilename
2462
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2463
2690
    
2464
2691
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2465
2692
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2506
2733
            def GetAllClientsWithProperties(self):
2507
2734
                "D-Bus method"
2508
2735
                return dbus.Dictionary(
2509
 
                    ((c.dbus_object_path, c.GetAll(""))
2510
 
                     for c in tcp_server.clients.itervalues()),
 
2736
                    { c.dbus_object_path: c.GetAll("")
 
2737
                      for c in tcp_server.clients.itervalues() },
2511
2738
                    signature="oa{sv}")
2512
2739
            
2513
2740
            @dbus.service.method(_interface, in_signature="o")
2530
2757
    
2531
2758
    def cleanup():
2532
2759
        "Cleanup function; run on exit"
2533
 
        service.cleanup()
 
2760
        if zeroconf:
 
2761
            service.cleanup()
2534
2762
        
2535
2763
        multiprocessing.active_children()
 
2764
        wnull.close()
2536
2765
        if not (tcp_server.clients or client_settings):
2537
2766
            return
2538
2767
        
2549
2778
                
2550
2779
                # A list of attributes that can not be pickled
2551
2780
                # + secret.
2552
 
                exclude = set(("bus", "changedstate", "secret",
2553
 
                               "checker"))
 
2781
                exclude = { "bus", "changedstate", "secret",
 
2782
                            "checker", "server_settings" }
2554
2783
                for name, typ in (inspect.getmembers
2555
2784
                                  (dbus.service.Object)):
2556
2785
                    exclude.add(name)
2579
2808
                except NameError:
2580
2809
                    pass
2581
2810
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2582
 
                logger.warning("Could not save persistent state: {0}"
 
2811
                logger.warning("Could not save persistent state: {}"
2583
2812
                               .format(os.strerror(e.errno)))
2584
2813
            else:
2585
2814
                logger.warning("Could not save persistent state:",
2586
2815
                               exc_info=e)
2587
 
                raise e
 
2816
                raise
2588
2817
        
2589
2818
        # Delete all clients, and settings from config
2590
2819
        while tcp_server.clients:
2614
2843
    tcp_server.server_activate()
2615
2844
    
2616
2845
    # Find out what port we got
2617
 
    service.port = tcp_server.socket.getsockname()[1]
 
2846
    if zeroconf:
 
2847
        service.port = tcp_server.socket.getsockname()[1]
2618
2848
    if use_ipv6:
2619
2849
        logger.info("Now listening on address %r, port %d,"
2620
2850
                    " flowinfo %d, scope_id %d",
2626
2856
    #service.interface = tcp_server.socket.getsockname()[3]
2627
2857
    
2628
2858
    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
 
2859
        if zeroconf:
 
2860
            # From the Avahi example code
 
2861
            try:
 
2862
                service.activate()
 
2863
            except dbus.exceptions.DBusException as error:
 
2864
                logger.critical("D-Bus Exception", exc_info=error)
 
2865
                cleanup()
 
2866
                sys.exit(1)
 
2867
            # End of Avahi example code
2637
2868
        
2638
2869
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2639
2870
                             lambda *args, **kwargs: