/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

  • Committer: Teddy Hogeborn
  • Date: 2014-07-25 23:44:04 UTC
  • mfrom: (237.23.7 python27)
  • mto: (237.7.304 trunk)
  • mto: This revision was merged to the branch mainline in revision 321.
  • Revision ID: teddy@recompile.se-20140725234404-m6c733af4i3zs0la
Merge from Python 2.7 branch.

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.5"
 
91
version = "1.6.7"
92
92
stored_state_file = "clients.pickle"
93
93
 
94
94
logger = logging.getLogger()
95
 
syslogger = (logging.handlers.SysLogHandler
96
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
 
              address = str("/dev/log")))
 
95
syslogger = None
98
96
 
99
97
try:
100
98
    if_nametoindex = (ctypes.cdll.LoadLibrary
116
114
def initlogger(debug, level=logging.WARNING):
117
115
    """init logger and add loglevel"""
118
116
    
 
117
    global syslogger
 
118
    syslogger = (logging.handlers.SysLogHandler
 
119
                 (facility =
 
120
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
121
                  address = str("/dev/log")))
119
122
    syslogger.setFormatter(logging.Formatter
120
123
                           ('Mandos [%(process)d]: %(levelname)s:'
121
124
                            ' %(message)s'))
139
142
class PGPEngine(object):
140
143
    """A simple class for OpenPGP symmetric encryption & decryption"""
141
144
    def __init__(self):
142
 
        self.gnupg = GnuPGInterface.GnuPG()
143
145
        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'])
 
146
        self.gnupgargs = ['--batch',
 
147
                          '--home', self.tempdir,
 
148
                          '--force-mdc',
 
149
                          '--quiet',
 
150
                          '--no-use-agent']
150
151
    
151
152
    def __enter__(self):
152
153
        return self
174
175
    def password_encode(self, password):
175
176
        # Passphrase can not be empty and can not contain newlines or
176
177
        # NUL bytes.  So we prefix it and hex encode it.
177
 
        return b"mandos" + binascii.hexlify(password)
 
178
        encoded = b"mandos" + binascii.hexlify(password)
 
179
        if len(encoded) > 2048:
 
180
            # GnuPG can't handle long passwords, so encode differently
 
181
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
182
                       .replace(b"\n", b"\\n")
 
183
                       .replace(b"\0", b"\\x00"))
 
184
        return encoded
178
185
    
179
186
    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
 
187
        passphrase = self.password_encode(password)
 
188
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
189
                                         ) as passfile:
 
190
            passfile.write(passphrase)
 
191
            passfile.flush()
 
192
            proc = subprocess.Popen(['gpg', '--symmetric',
 
193
                                     '--passphrase-file',
 
194
                                     passfile.name]
 
195
                                    + self.gnupgargs,
 
196
                                    stdin = subprocess.PIPE,
 
197
                                    stdout = subprocess.PIPE,
 
198
                                    stderr = subprocess.PIPE)
 
199
            ciphertext, err = proc.communicate(input = data)
 
200
        if proc.returncode != 0:
 
201
            raise PGPError(err)
194
202
        return ciphertext
195
203
    
196
204
    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
 
205
        passphrase = self.password_encode(password)
 
206
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
207
                                         ) as passfile:
 
208
            passfile.write(passphrase)
 
209
            passfile.flush()
 
210
            proc = subprocess.Popen(['gpg', '--decrypt',
 
211
                                     '--passphrase-file',
 
212
                                     passfile.name]
 
213
                                    + self.gnupgargs,
 
214
                                    stdin = subprocess.PIPE,
 
215
                                    stdout = subprocess.PIPE,
 
216
                                    stderr = subprocess.PIPE)
 
217
            decrypted_plaintext, err = proc.communicate(input
 
218
                                                        = data)
 
219
        if proc.returncode != 0:
 
220
            raise PGPError(err)
211
221
        return decrypted_plaintext
212
222
 
213
223
 
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.
328
338
        elif state == avahi.ENTRY_GROUP_FAILURE:
329
339
            logger.critical("Avahi: Error in group state changed %s",
330
340
                            unicode(error))
331
 
            raise AvahiGroupError("State changed: {0!s}"
 
341
            raise AvahiGroupError("State changed: {!s}"
332
342
                                  .format(error))
333
343
    
334
344
    def cleanup(self):
385
395
        """Add the new name to the syslog messages"""
386
396
        ret = AvahiService.rename(self)
387
397
        syslogger.setFormatter(logging.Formatter
388
 
                               ('Mandos ({0}) [%(process)d]:'
 
398
                               ('Mandos ({}) [%(process)d]:'
389
399
                                ' %(levelname)s: %(message)s'
390
400
                                .format(self.name)))
391
401
        return ret
392
402
 
393
403
 
394
 
def timedelta_to_milliseconds(td):
395
 
    "Convert a datetime.timedelta() to milliseconds"
396
 
    return ((td.days * 24 * 60 * 60 * 1000)
397
 
            + (td.seconds * 1000)
398
 
            + (td.microseconds // 1000))
399
 
 
400
 
 
401
404
class Client(object):
402
405
    """A representation of a client host served by this server.
403
406
    
439
442
    runtime_expansions: Allowed attributes for runtime expansion.
440
443
    expires:    datetime.datetime(); time (UTC) when a client will be
441
444
                disabled, or None
 
445
    server_settings: The server_settings dict from main()
442
446
    """
443
447
    
444
448
    runtime_expansions = ("approval_delay", "approval_duration",
446
450
                          "fingerprint", "host", "interval",
447
451
                          "last_approval_request", "last_checked_ok",
448
452
                          "last_enabled", "name", "timeout")
449
 
    client_defaults = { "timeout": "5m",
450
 
                        "extended_timeout": "15m",
451
 
                        "interval": "2m",
 
453
    client_defaults = { "timeout": "PT5M",
 
454
                        "extended_timeout": "PT15M",
 
455
                        "interval": "PT2M",
452
456
                        "checker": "fping -q -- %%(host)s",
453
457
                        "host": "",
454
 
                        "approval_delay": "0s",
455
 
                        "approval_duration": "1s",
 
458
                        "approval_delay": "PT0S",
 
459
                        "approval_duration": "PT1S",
456
460
                        "approved_by_default": "True",
457
461
                        "enabled": "True",
458
462
                        }
459
463
    
460
 
    def timeout_milliseconds(self):
461
 
        "Return the 'timeout' attribute in milliseconds"
462
 
        return timedelta_to_milliseconds(self.timeout)
463
 
    
464
 
    def extended_timeout_milliseconds(self):
465
 
        "Return the 'extended_timeout' attribute in milliseconds"
466
 
        return timedelta_to_milliseconds(self.extended_timeout)
467
 
    
468
 
    def interval_milliseconds(self):
469
 
        "Return the 'interval' attribute in milliseconds"
470
 
        return timedelta_to_milliseconds(self.interval)
471
 
    
472
 
    def approval_delay_milliseconds(self):
473
 
        return timedelta_to_milliseconds(self.approval_delay)
474
 
    
475
464
    @staticmethod
476
465
    def config_parser(config):
477
466
        """Construct a new dict of client settings of this form:
502
491
                          "rb") as secfile:
503
492
                    client["secret"] = secfile.read()
504
493
            else:
505
 
                raise TypeError("No secret or secfile for section {0}"
 
494
                raise TypeError("No secret or secfile for section {}"
506
495
                                .format(section))
507
496
            client["timeout"] = string_to_delta(section["timeout"])
508
497
            client["extended_timeout"] = string_to_delta(
519
508
        
520
509
        return settings
521
510
    
522
 
    def __init__(self, settings, name = None):
 
511
    def __init__(self, settings, name = None, server_settings=None):
523
512
        self.name = name
 
513
        if server_settings is None:
 
514
            server_settings = {}
 
515
        self.server_settings = server_settings
524
516
        # adding all client settings
525
 
        for setting, value in settings.iteritems():
 
517
        for setting, value in settings.items():
526
518
            setattr(self, setting, value)
527
519
        
528
520
        if self.enabled:
611
603
        if self.checker_initiator_tag is not None:
612
604
            gobject.source_remove(self.checker_initiator_tag)
613
605
        self.checker_initiator_tag = (gobject.timeout_add
614
 
                                      (self.interval_milliseconds(),
 
606
                                      (int(self.interval
 
607
                                           .total_seconds() * 1000),
615
608
                                       self.start_checker))
616
609
        # Schedule a disable() when 'timeout' has passed
617
610
        if self.disable_initiator_tag is not None:
618
611
            gobject.source_remove(self.disable_initiator_tag)
619
612
        self.disable_initiator_tag = (gobject.timeout_add
620
 
                                   (self.timeout_milliseconds(),
621
 
                                    self.disable))
 
613
                                      (int(self.timeout
 
614
                                           .total_seconds() * 1000),
 
615
                                       self.disable))
622
616
        # Also start a new checker *right now*.
623
617
        self.start_checker()
624
618
    
655
649
            self.disable_initiator_tag = None
656
650
        if getattr(self, "enabled", False):
657
651
            self.disable_initiator_tag = (gobject.timeout_add
658
 
                                          (timedelta_to_milliseconds
659
 
                                           (timeout), self.disable))
 
652
                                          (int(timeout.total_seconds()
 
653
                                               * 1000), self.disable))
660
654
            self.expires = datetime.datetime.utcnow() + timeout
661
655
    
662
656
    def need_approval(self):
679
673
        # If a checker exists, make sure it is not a zombie
680
674
        try:
681
675
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
682
 
        except (AttributeError, OSError) as error:
683
 
            if (isinstance(error, OSError)
684
 
                and error.errno != errno.ECHILD):
685
 
                raise error
 
676
        except AttributeError:
 
677
            pass
 
678
        except OSError as error:
 
679
            if error.errno != errno.ECHILD:
 
680
                raise
686
681
        else:
687
682
            if pid:
688
683
                logger.warning("Checker was a zombie")
692
687
        # Start a new checker if needed
693
688
        if self.checker is None:
694
689
            # Escape attributes for the shell
695
 
            escaped_attrs = dict(
696
 
                (attr, re.escape(unicode(getattr(self, attr))))
697
 
                for attr in
698
 
                self.runtime_expansions)
 
690
            escaped_attrs = { attr:
 
691
                                  re.escape(unicode(getattr(self,
 
692
                                                            attr)))
 
693
                              for attr in self.runtime_expansions }
699
694
            try:
700
695
                command = self.checker_command % escaped_attrs
701
696
            except TypeError as error:
710
705
                # in normal mode, that is already done by daemon(),
711
706
                # and in debug mode we don't want to.  (Stdin is
712
707
                # always replaced by /dev/null.)
 
708
                # The exception is when not debugging but nevertheless
 
709
                # running in the foreground; use the previously
 
710
                # created wnull.
 
711
                popen_args = {}
 
712
                if (not self.server_settings["debug"]
 
713
                    and self.server_settings["foreground"]):
 
714
                    popen_args.update({"stdout": wnull,
 
715
                                       "stderr": wnull })
713
716
                self.checker = subprocess.Popen(command,
714
717
                                                close_fds=True,
715
 
                                                shell=True, cwd="/")
 
718
                                                shell=True, cwd="/",
 
719
                                                **popen_args)
716
720
            except OSError as error:
717
721
                logger.error("Failed to start subprocess",
718
722
                             exc_info=error)
 
723
                return True
719
724
            self.checker_callback_tag = (gobject.child_watch_add
720
725
                                         (self.checker.pid,
721
726
                                          self.checker_callback,
722
727
                                          data=command))
723
728
            # The checker may have completed before the gobject
724
729
            # watch was added.  Check for this.
725
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
730
            try:
 
731
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
732
            except OSError as error:
 
733
                if error.errno == errno.ECHILD:
 
734
                    # This should never happen
 
735
                    logger.error("Child process vanished",
 
736
                                 exc_info=error)
 
737
                    return True
 
738
                raise
726
739
            if pid:
727
740
                gobject.source_remove(self.checker_callback_tag)
728
741
                self.checker_callback(pid, status, command)
764
777
    # "Set" method, so we fail early here:
765
778
    if byte_arrays and signature != "ay":
766
779
        raise ValueError("Byte arrays not supported for non-'ay'"
767
 
                         " signature {0!r}".format(signature))
 
780
                         " signature {!r}".format(signature))
768
781
    def decorator(func):
769
782
        func._dbus_is_property = True
770
783
        func._dbus_interface = dbus_interface
849
862
        If called like _is_dbus_thing("method") it returns a function
850
863
        suitable for use as predicate to inspect.getmembers().
851
864
        """
852
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
865
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
853
866
                                   False)
854
867
    
855
868
    def _get_all_dbus_things(self, thing):
904
917
            # The byte_arrays option is not supported yet on
905
918
            # signatures other than "ay".
906
919
            if prop._dbus_signature != "ay":
907
 
                raise ValueError
 
920
                raise ValueError("Byte arrays not supported for non-"
 
921
                                 "'ay' signature {!r}"
 
922
                                 .format(prop._dbus_signature))
908
923
            value = dbus.ByteArray(b''.join(chr(byte)
909
924
                                            for byte in value))
910
925
        prop(value)
974
989
                                              (prop,
975
990
                                               "_dbus_annotations",
976
991
                                               {}))
977
 
                        for name, value in annots.iteritems():
 
992
                        for name, value in annots.items():
978
993
                            ann_tag = document.createElement(
979
994
                                "annotation")
980
995
                            ann_tag.setAttribute("name", name)
983
998
                # Add interface annotation tags
984
999
                for annotation, value in dict(
985
1000
                    itertools.chain.from_iterable(
986
 
                        annotations().iteritems()
 
1001
                        annotations().items()
987
1002
                        for name, annotations in
988
1003
                        self._get_all_dbus_things("interface")
989
1004
                        if name == if_tag.getAttribute("name")
990
 
                        )).iteritems():
 
1005
                        )).items():
991
1006
                    ann_tag = document.createElement("annotation")
992
1007
                    ann_tag.setAttribute("name", annotation)
993
1008
                    ann_tag.setAttribute("value", value)
1049
1064
    """
1050
1065
    def wrapper(cls):
1051
1066
        for orig_interface_name, alt_interface_name in (
1052
 
            alt_interface_names.iteritems()):
 
1067
            alt_interface_names.items()):
1053
1068
            attr = {}
1054
1069
            interface_names = set()
1055
1070
            # Go though all attributes of the class
1068
1083
                interface_names.add(alt_interface)
1069
1084
                # Is this a D-Bus signal?
1070
1085
                if getattr(attribute, "_dbus_is_signal", False):
1071
 
                    # Extract the original non-method function by
1072
 
                    # black magic
 
1086
                    # Extract the original non-method undecorated
 
1087
                    # function by black magic
1073
1088
                    nonmethod_func = (dict(
1074
1089
                            zip(attribute.func_code.co_freevars,
1075
1090
                                attribute.__closure__))["func"]
1172
1187
                                        attribute.func_closure)))
1173
1188
            if deprecate:
1174
1189
                # Deprecate all alternate interfaces
1175
 
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1190
                iname="_AlternateDBusNames_interface_annotation{}"
1176
1191
                for interface_name in interface_names:
1177
1192
                    @dbus_interface_annotations(interface_name)
1178
1193
                    def func(self):
1187
1202
            if interface_names:
1188
1203
                # Replace the class with a new subclass of it with
1189
1204
                # methods, signals, etc. as created above.
1190
 
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1205
                cls = type(b"{}Alternate".format(cls.__name__),
1191
1206
                           (cls,), attr)
1192
1207
        return cls
1193
1208
    return wrapper
1234
1249
                   to the D-Bus.  Default: no transform
1235
1250
        variant_level: D-Bus variant level.  Default: 1
1236
1251
        """
1237
 
        attrname = "_{0}".format(dbus_name)
 
1252
        attrname = "_{}".format(dbus_name)
1238
1253
        def setter(self, value):
1239
1254
            if hasattr(self, "dbus_object_path"):
1240
1255
                if (not hasattr(self, attrname) or
1270
1285
    approval_delay = notifychangeproperty(dbus.UInt64,
1271
1286
                                          "ApprovalDelay",
1272
1287
                                          type_func =
1273
 
                                          timedelta_to_milliseconds)
 
1288
                                          lambda td: td.total_seconds()
 
1289
                                          * 1000)
1274
1290
    approval_duration = notifychangeproperty(
1275
1291
        dbus.UInt64, "ApprovalDuration",
1276
 
        type_func = timedelta_to_milliseconds)
 
1292
        type_func = lambda td: td.total_seconds() * 1000)
1277
1293
    host = notifychangeproperty(dbus.String, "Host")
1278
1294
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1279
 
                                   type_func =
1280
 
                                   timedelta_to_milliseconds)
 
1295
                                   type_func = lambda td:
 
1296
                                       td.total_seconds() * 1000)
1281
1297
    extended_timeout = notifychangeproperty(
1282
1298
        dbus.UInt64, "ExtendedTimeout",
1283
 
        type_func = timedelta_to_milliseconds)
 
1299
        type_func = lambda td: td.total_seconds() * 1000)
1284
1300
    interval = notifychangeproperty(dbus.UInt64,
1285
1301
                                    "Interval",
1286
1302
                                    type_func =
1287
 
                                    timedelta_to_milliseconds)
 
1303
                                    lambda td: td.total_seconds()
 
1304
                                    * 1000)
1288
1305
    checker_command = notifychangeproperty(dbus.String, "Checker")
1289
1306
    
1290
1307
    del notifychangeproperty
1318
1335
                                       *args, **kwargs)
1319
1336
    
1320
1337
    def start_checker(self, *args, **kwargs):
1321
 
        old_checker = self.checker
1322
 
        if self.checker is not None:
1323
 
            old_checker_pid = self.checker.pid
1324
 
        else:
1325
 
            old_checker_pid = None
 
1338
        old_checker_pid = getattr(self.checker, "pid", None)
1326
1339
        r = Client.start_checker(self, *args, **kwargs)
1327
1340
        # Only if new checker process was started
1328
1341
        if (self.checker is not None
1337
1350
    
1338
1351
    def approve(self, value=True):
1339
1352
        self.approved = value
1340
 
        gobject.timeout_add(timedelta_to_milliseconds
1341
 
                            (self.approval_duration),
1342
 
                            self._reset_approved)
 
1353
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1354
                                * 1000), self._reset_approved)
1343
1355
        self.send_changedstate()
1344
1356
    
1345
1357
    ## D-Bus methods, signals & properties
1448
1460
                           access="readwrite")
1449
1461
    def ApprovalDelay_dbus_property(self, value=None):
1450
1462
        if value is None:       # get
1451
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1463
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1464
                               * 1000)
1452
1465
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1453
1466
    
1454
1467
    # ApprovalDuration - property
1456
1469
                           access="readwrite")
1457
1470
    def ApprovalDuration_dbus_property(self, value=None):
1458
1471
        if value is None:       # get
1459
 
            return dbus.UInt64(timedelta_to_milliseconds(
1460
 
                    self.approval_duration))
 
1472
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1473
                               * 1000)
1461
1474
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1462
1475
    
1463
1476
    # Name - property
1529
1542
                           access="readwrite")
1530
1543
    def Timeout_dbus_property(self, value=None):
1531
1544
        if value is None:       # get
1532
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1545
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1533
1546
        old_timeout = self.timeout
1534
1547
        self.timeout = datetime.timedelta(0, 0, 0, value)
1535
1548
        # Reschedule disabling
1546
1559
                gobject.source_remove(self.disable_initiator_tag)
1547
1560
                self.disable_initiator_tag = (
1548
1561
                    gobject.timeout_add(
1549
 
                        timedelta_to_milliseconds(self.expires - now),
1550
 
                        self.disable))
 
1562
                        int((self.expires - now).total_seconds()
 
1563
                            * 1000), self.disable))
1551
1564
    
1552
1565
    # ExtendedTimeout - property
1553
1566
    @dbus_service_property(_interface, signature="t",
1554
1567
                           access="readwrite")
1555
1568
    def ExtendedTimeout_dbus_property(self, value=None):
1556
1569
        if value is None:       # get
1557
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1570
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1571
                               * 1000)
1558
1572
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1559
1573
    
1560
1574
    # Interval - property
1562
1576
                           access="readwrite")
1563
1577
    def Interval_dbus_property(self, value=None):
1564
1578
        if value is None:       # get
1565
 
            return dbus.UInt64(self.interval_milliseconds())
 
1579
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1566
1580
        self.interval = datetime.timedelta(0, 0, 0, value)
1567
1581
        if getattr(self, "checker_initiator_tag", None) is None:
1568
1582
            return
1673
1687
            logger.debug("Protocol version: %r", line)
1674
1688
            try:
1675
1689
                if int(line.strip().split()[0]) > 1:
1676
 
                    raise RuntimeError
 
1690
                    raise RuntimeError(line)
1677
1691
            except (ValueError, IndexError, RuntimeError) as error:
1678
1692
                logger.error("Unknown protocol version: %s", error)
1679
1693
                return
1728
1742
                        if self.server.use_dbus:
1729
1743
                            # Emit D-Bus signal
1730
1744
                            client.NeedApproval(
1731
 
                                client.approval_delay_milliseconds(),
1732
 
                                client.approved_by_default)
 
1745
                                client.approval_delay.total_seconds()
 
1746
                                * 1000, client.approved_by_default)
1733
1747
                    else:
1734
1748
                        logger.warning("Client %s was not approved",
1735
1749
                                       client.name)
1741
1755
                    #wait until timeout or approved
1742
1756
                    time = datetime.datetime.now()
1743
1757
                    client.changedstate.acquire()
1744
 
                    client.changedstate.wait(
1745
 
                        float(timedelta_to_milliseconds(delay)
1746
 
                              / 1000))
 
1758
                    client.changedstate.wait(delay.total_seconds())
1747
1759
                    client.changedstate.release()
1748
1760
                    time2 = datetime.datetime.now()
1749
1761
                    if (time2 - time) >= delay:
1886
1898
    
1887
1899
    def add_pipe(self, parent_pipe, proc):
1888
1900
        """Dummy function; override as necessary"""
1889
 
        raise NotImplementedError
 
1901
        raise NotImplementedError()
1890
1902
 
1891
1903
 
1892
1904
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1968
1980
                if self.address_family == socket.AF_INET6:
1969
1981
                    any_address = "::" # in6addr_any
1970
1982
                else:
1971
 
                    any_address = socket.INADDR_ANY
 
1983
                    any_address = "0.0.0.0" # INADDR_ANY
1972
1984
                self.server_address = (any_address,
1973
1985
                                       self.server_address[1])
1974
1986
            elif not self.server_address[1]:
2090
2102
        return True
2091
2103
 
2092
2104
 
 
2105
def rfc3339_duration_to_delta(duration):
 
2106
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2107
    
 
2108
    >>> rfc3339_duration_to_delta("P7D")
 
2109
    datetime.timedelta(7)
 
2110
    >>> rfc3339_duration_to_delta("PT60S")
 
2111
    datetime.timedelta(0, 60)
 
2112
    >>> rfc3339_duration_to_delta("PT60M")
 
2113
    datetime.timedelta(0, 3600)
 
2114
    >>> rfc3339_duration_to_delta("PT24H")
 
2115
    datetime.timedelta(1)
 
2116
    >>> rfc3339_duration_to_delta("P1W")
 
2117
    datetime.timedelta(7)
 
2118
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2119
    datetime.timedelta(0, 330)
 
2120
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2121
    datetime.timedelta(1, 200)
 
2122
    """
 
2123
    
 
2124
    # Parsing an RFC 3339 duration with regular expressions is not
 
2125
    # possible - there would have to be multiple places for the same
 
2126
    # values, like seconds.  The current code, while more esoteric, is
 
2127
    # cleaner without depending on a parsing library.  If Python had a
 
2128
    # built-in library for parsing we would use it, but we'd like to
 
2129
    # avoid excessive use of external libraries.
 
2130
    
 
2131
    # New type for defining tokens, syntax, and semantics all-in-one
 
2132
    Token = collections.namedtuple("Token",
 
2133
                                   ("regexp", # To match token; if
 
2134
                                              # "value" is not None,
 
2135
                                              # must have a "group"
 
2136
                                              # containing digits
 
2137
                                    "value",  # datetime.timedelta or
 
2138
                                              # None
 
2139
                                    "followers")) # Tokens valid after
 
2140
                                                  # this token
 
2141
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2142
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2143
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2144
    token_second = Token(re.compile(r"(\d+)S"),
 
2145
                         datetime.timedelta(seconds=1),
 
2146
                         frozenset((token_end,)))
 
2147
    token_minute = Token(re.compile(r"(\d+)M"),
 
2148
                         datetime.timedelta(minutes=1),
 
2149
                         frozenset((token_second, token_end)))
 
2150
    token_hour = Token(re.compile(r"(\d+)H"),
 
2151
                       datetime.timedelta(hours=1),
 
2152
                       frozenset((token_minute, token_end)))
 
2153
    token_time = Token(re.compile(r"T"),
 
2154
                       None,
 
2155
                       frozenset((token_hour, token_minute,
 
2156
                                  token_second)))
 
2157
    token_day = Token(re.compile(r"(\d+)D"),
 
2158
                      datetime.timedelta(days=1),
 
2159
                      frozenset((token_time, token_end)))
 
2160
    token_month = Token(re.compile(r"(\d+)M"),
 
2161
                        datetime.timedelta(weeks=4),
 
2162
                        frozenset((token_day, token_end)))
 
2163
    token_year = Token(re.compile(r"(\d+)Y"),
 
2164
                       datetime.timedelta(weeks=52),
 
2165
                       frozenset((token_month, token_end)))
 
2166
    token_week = Token(re.compile(r"(\d+)W"),
 
2167
                       datetime.timedelta(weeks=1),
 
2168
                       frozenset((token_end,)))
 
2169
    token_duration = Token(re.compile(r"P"), None,
 
2170
                           frozenset((token_year, token_month,
 
2171
                                      token_day, token_time,
 
2172
                                      token_week)))
 
2173
    # Define starting values
 
2174
    value = datetime.timedelta() # Value so far
 
2175
    found_token = None
 
2176
    followers = frozenset((token_duration,)) # Following valid tokens
 
2177
    s = duration                # String left to parse
 
2178
    # Loop until end token is found
 
2179
    while found_token is not token_end:
 
2180
        # Search for any currently valid tokens
 
2181
        for token in followers:
 
2182
            match = token.regexp.match(s)
 
2183
            if match is not None:
 
2184
                # Token found
 
2185
                if token.value is not None:
 
2186
                    # Value found, parse digits
 
2187
                    factor = int(match.group(1), 10)
 
2188
                    # Add to value so far
 
2189
                    value += factor * token.value
 
2190
                # Strip token from string
 
2191
                s = token.regexp.sub("", s, 1)
 
2192
                # Go to found token
 
2193
                found_token = token
 
2194
                # Set valid next tokens
 
2195
                followers = found_token.followers
 
2196
                break
 
2197
        else:
 
2198
            # No currently valid tokens were found
 
2199
            raise ValueError("Invalid RFC 3339 duration")
 
2200
    # End token found
 
2201
    return value
 
2202
 
 
2203
 
2093
2204
def string_to_delta(interval):
2094
2205
    """Parse a string and return a datetime.timedelta
2095
2206
    
2106
2217
    >>> string_to_delta('5m 30s')
2107
2218
    datetime.timedelta(0, 330)
2108
2219
    """
 
2220
    
 
2221
    try:
 
2222
        return rfc3339_duration_to_delta(interval)
 
2223
    except ValueError:
 
2224
        pass
 
2225
    
2109
2226
    timevalue = datetime.timedelta(0)
2110
2227
    for s in interval.split():
2111
2228
        try:
2122
2239
            elif suffix == "w":
2123
2240
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2124
2241
            else:
2125
 
                raise ValueError("Unknown suffix {0!r}"
 
2242
                raise ValueError("Unknown suffix {!r}"
2126
2243
                                 .format(suffix))
2127
 
        except (ValueError, IndexError) as e:
 
2244
        except IndexError as e:
2128
2245
            raise ValueError(*(e.args))
2129
2246
        timevalue += delta
2130
2247
    return timevalue
2145
2262
        # Close all standard open file descriptors
2146
2263
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2147
2264
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2148
 
            raise OSError(errno.ENODEV,
2149
 
                          "{0} not a character device"
 
2265
            raise OSError(errno.ENODEV, "{} not a character device"
2150
2266
                          .format(os.devnull))
2151
2267
        os.dup2(null, sys.stdin.fileno())
2152
2268
        os.dup2(null, sys.stdout.fileno())
2162
2278
    
2163
2279
    parser = argparse.ArgumentParser()
2164
2280
    parser.add_argument("-v", "--version", action="version",
2165
 
                        version = "%(prog)s {0}".format(version),
 
2281
                        version = "%(prog)s {}".format(version),
2166
2282
                        help="show version number and exit")
2167
2283
    parser.add_argument("-i", "--interface", metavar="IF",
2168
2284
                        help="Bind to interface IF")
2174
2290
                        help="Run self-test")
2175
2291
    parser.add_argument("--debug", action="store_true",
2176
2292
                        help="Debug mode; run in foreground and log"
2177
 
                        " to terminal")
 
2293
                        " to terminal", default=None)
2178
2294
    parser.add_argument("--debuglevel", metavar="LEVEL",
2179
2295
                        help="Debug level for stdout output")
2180
2296
    parser.add_argument("--priority", help="GnuTLS"
2187
2303
                        " files")
2188
2304
    parser.add_argument("--no-dbus", action="store_false",
2189
2305
                        dest="use_dbus", help="Do not provide D-Bus"
2190
 
                        " system bus interface")
 
2306
                        " system bus interface", default=None)
2191
2307
    parser.add_argument("--no-ipv6", action="store_false",
2192
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2308
                        dest="use_ipv6", help="Do not use IPv6",
 
2309
                        default=None)
2193
2310
    parser.add_argument("--no-restore", action="store_false",
2194
2311
                        dest="restore", help="Do not restore stored"
2195
 
                        " state")
 
2312
                        " state", default=None)
2196
2313
    parser.add_argument("--socket", type=int,
2197
2314
                        help="Specify a file descriptor to a network"
2198
2315
                        " socket to use instead of creating one")
2199
2316
    parser.add_argument("--statedir", metavar="DIR",
2200
2317
                        help="Directory to save/restore state in")
2201
2318
    parser.add_argument("--foreground", action="store_true",
2202
 
                        help="Run in foreground")
 
2319
                        help="Run in foreground", default=None)
 
2320
    parser.add_argument("--no-zeroconf", action="store_false",
 
2321
                        dest="zeroconf", help="Do not use Zeroconf",
 
2322
                        default=None)
2203
2323
    
2204
2324
    options = parser.parse_args()
2205
2325
    
2206
2326
    if options.check:
2207
2327
        import doctest
2208
 
        doctest.testmod()
2209
 
        sys.exit()
 
2328
        fail_count, test_count = doctest.testmod()
 
2329
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2210
2330
    
2211
2331
    # Default values for config file for server-global settings
2212
2332
    server_defaults = { "interface": "",
2214
2334
                        "port": "",
2215
2335
                        "debug": "False",
2216
2336
                        "priority":
2217
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2337
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2218
2338
                        "servicename": "Mandos",
2219
2339
                        "use_dbus": "True",
2220
2340
                        "use_ipv6": "True",
2223
2343
                        "socket": "",
2224
2344
                        "statedir": "/var/lib/mandos",
2225
2345
                        "foreground": "False",
 
2346
                        "zeroconf": "True",
2226
2347
                        }
2227
2348
    
2228
2349
    # Parse config file for server-global settings
2255
2376
    for option in ("interface", "address", "port", "debug",
2256
2377
                   "priority", "servicename", "configdir",
2257
2378
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2258
 
                   "statedir", "socket", "foreground"):
 
2379
                   "statedir", "socket", "foreground", "zeroconf"):
2259
2380
        value = getattr(options, option)
2260
2381
        if value is not None:
2261
2382
            server_settings[option] = value
2264
2385
    for option in server_settings.keys():
2265
2386
        if type(server_settings[option]) is str:
2266
2387
            server_settings[option] = unicode(server_settings[option])
 
2388
    # Force all boolean options to be boolean
 
2389
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2390
                   "foreground", "zeroconf"):
 
2391
        server_settings[option] = bool(server_settings[option])
2267
2392
    # Debug implies foreground
2268
2393
    if server_settings["debug"]:
2269
2394
        server_settings["foreground"] = True
2271
2396
    
2272
2397
    ##################################################################
2273
2398
    
 
2399
    if (not server_settings["zeroconf"] and
 
2400
        not (server_settings["port"]
 
2401
             or server_settings["socket"] != "")):
 
2402
            parser.error("Needs port or socket to work without"
 
2403
                         " Zeroconf")
 
2404
    
2274
2405
    # For convenience
2275
2406
    debug = server_settings["debug"]
2276
2407
    debuglevel = server_settings["debuglevel"]
2279
2410
    stored_state_path = os.path.join(server_settings["statedir"],
2280
2411
                                     stored_state_file)
2281
2412
    foreground = server_settings["foreground"]
 
2413
    zeroconf = server_settings["zeroconf"]
2282
2414
    
2283
2415
    if debug:
2284
2416
        initlogger(debug, logging.DEBUG)
2291
2423
    
2292
2424
    if server_settings["servicename"] != "Mandos":
2293
2425
        syslogger.setFormatter(logging.Formatter
2294
 
                               ('Mandos ({0}) [%(process)d]:'
 
2426
                               ('Mandos ({}) [%(process)d]:'
2295
2427
                                ' %(levelname)s: %(message)s'
2296
2428
                                .format(server_settings
2297
2429
                                        ["servicename"])))
2305
2437
    global mandos_dbus_service
2306
2438
    mandos_dbus_service = None
2307
2439
    
 
2440
    socketfd = None
 
2441
    if server_settings["socket"] != "":
 
2442
        socketfd = server_settings["socket"]
2308
2443
    tcp_server = MandosServer((server_settings["address"],
2309
2444
                               server_settings["port"]),
2310
2445
                              ClientHandler,
2314
2449
                              gnutls_priority=
2315
2450
                              server_settings["priority"],
2316
2451
                              use_dbus=use_dbus,
2317
 
                              socketfd=(server_settings["socket"]
2318
 
                                        or None))
 
2452
                              socketfd=socketfd)
2319
2453
    if not foreground:
2320
 
        pidfilename = "/var/run/mandos.pid"
 
2454
        pidfilename = "/run/mandos.pid"
 
2455
        if not os.path.isdir("/run/."):
 
2456
            pidfilename = "/var/run/mandos.pid"
2321
2457
        pidfile = None
2322
2458
        try:
2323
2459
            pidfile = open(pidfilename, "w")
2340
2476
        os.setuid(uid)
2341
2477
    except OSError as error:
2342
2478
        if error.errno != errno.EPERM:
2343
 
            raise error
 
2479
            raise
2344
2480
    
2345
2481
    if debug:
2346
2482
        # Enable all possible GnuTLS debugging
2389
2525
            use_dbus = False
2390
2526
            server_settings["use_dbus"] = False
2391
2527
            tcp_server.use_dbus = False
2392
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2393
 
    service = AvahiServiceToSyslog(name =
2394
 
                                   server_settings["servicename"],
2395
 
                                   servicetype = "_mandos._tcp",
2396
 
                                   protocol = protocol, bus = bus)
2397
 
    if server_settings["interface"]:
2398
 
        service.interface = (if_nametoindex
2399
 
                             (str(server_settings["interface"])))
 
2528
    if zeroconf:
 
2529
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2530
        service = AvahiServiceToSyslog(name =
 
2531
                                       server_settings["servicename"],
 
2532
                                       servicetype = "_mandos._tcp",
 
2533
                                       protocol = protocol, bus = bus)
 
2534
        if server_settings["interface"]:
 
2535
            service.interface = (if_nametoindex
 
2536
                                 (str(server_settings["interface"])))
2400
2537
    
2401
2538
    global multiprocessing_manager
2402
2539
    multiprocessing_manager = multiprocessing.Manager()
2409
2546
    old_client_settings = {}
2410
2547
    clients_data = {}
2411
2548
    
 
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
    
2412
2557
    # Get client data and settings from last running state.
2413
2558
    if server_settings["restore"]:
2414
2559
        try:
2418
2563
            os.remove(stored_state_path)
2419
2564
        except IOError as e:
2420
2565
            if e.errno == errno.ENOENT:
2421
 
                logger.warning("Could not load persistent state: {0}"
 
2566
                logger.warning("Could not load persistent state: {}"
2422
2567
                                .format(os.strerror(e.errno)))
2423
2568
            else:
2424
2569
                logger.critical("Could not load persistent state:",
2429
2574
                           "EOFError:", exc_info=e)
2430
2575
    
2431
2576
    with PGPEngine() as pgp:
2432
 
        for client_name, client in clients_data.iteritems():
 
2577
        for client_name, client in clients_data.items():
 
2578
            # Skip removed clients
 
2579
            if client_name not in client_settings:
 
2580
                continue
 
2581
            
2433
2582
            # Decide which value to use after restoring saved state.
2434
2583
            # We have three different values: Old config file,
2435
2584
            # new config file, and saved state.
2456
2605
                if datetime.datetime.utcnow() >= client["expires"]:
2457
2606
                    if not client["last_checked_ok"]:
2458
2607
                        logger.warning(
2459
 
                            "disabling client {0} - Client never "
 
2608
                            "disabling client {} - Client never "
2460
2609
                            "performed a successful checker"
2461
2610
                            .format(client_name))
2462
2611
                        client["enabled"] = False
2463
2612
                    elif client["last_checker_status"] != 0:
2464
2613
                        logger.warning(
2465
 
                            "disabling client {0} - Client "
2466
 
                            "last checker failed with error code {1}"
 
2614
                            "disabling client {} - Client last"
 
2615
                            " checker failed with error code {}"
2467
2616
                            .format(client_name,
2468
2617
                                    client["last_checker_status"]))
2469
2618
                        client["enabled"] = False
2472
2621
                                             .utcnow()
2473
2622
                                             + client["timeout"])
2474
2623
                        logger.debug("Last checker succeeded,"
2475
 
                                     " keeping {0} enabled"
 
2624
                                     " keeping {} enabled"
2476
2625
                                     .format(client_name))
2477
2626
            try:
2478
2627
                client["secret"] = (
2481
2630
                                ["secret"]))
2482
2631
            except PGPError:
2483
2632
                # If decryption fails, we use secret from new settings
2484
 
                logger.debug("Failed to decrypt {0} old secret"
 
2633
                logger.debug("Failed to decrypt {} old secret"
2485
2634
                             .format(client_name))
2486
2635
                client["secret"] = (
2487
2636
                    client_settings[client_name]["secret"])
2495
2644
        clients_data[client_name] = client_settings[client_name]
2496
2645
    
2497
2646
    # Create all client objects
2498
 
    for client_name, client in clients_data.iteritems():
 
2647
    for client_name, client in clients_data.items():
2499
2648
        tcp_server.clients[client_name] = client_class(
2500
 
            name = client_name, settings = client)
 
2649
            name = client_name, settings = client,
 
2650
            server_settings = server_settings)
2501
2651
    
2502
2652
    if not tcp_server.clients:
2503
2653
        logger.warning("No clients defined")
2583
2733
    
2584
2734
    def cleanup():
2585
2735
        "Cleanup function; run on exit"
2586
 
        service.cleanup()
 
2736
        if zeroconf:
 
2737
            service.cleanup()
2587
2738
        
2588
2739
        multiprocessing.active_children()
 
2740
        wnull.close()
2589
2741
        if not (tcp_server.clients or client_settings):
2590
2742
            return
2591
2743
        
2602
2754
                
2603
2755
                # A list of attributes that can not be pickled
2604
2756
                # + secret.
2605
 
                exclude = set(("bus", "changedstate", "secret",
2606
 
                               "checker"))
 
2757
                exclude = { "bus", "changedstate", "secret",
 
2758
                            "checker", "server_settings" }
2607
2759
                for name, typ in (inspect.getmembers
2608
2760
                                  (dbus.service.Object)):
2609
2761
                    exclude.add(name)
2632
2784
                except NameError:
2633
2785
                    pass
2634
2786
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2635
 
                logger.warning("Could not save persistent state: {0}"
 
2787
                logger.warning("Could not save persistent state: {}"
2636
2788
                               .format(os.strerror(e.errno)))
2637
2789
            else:
2638
2790
                logger.warning("Could not save persistent state:",
2639
2791
                               exc_info=e)
2640
 
                raise e
 
2792
                raise
2641
2793
        
2642
2794
        # Delete all clients, and settings from config
2643
2795
        while tcp_server.clients:
2667
2819
    tcp_server.server_activate()
2668
2820
    
2669
2821
    # Find out what port we got
2670
 
    service.port = tcp_server.socket.getsockname()[1]
 
2822
    if zeroconf:
 
2823
        service.port = tcp_server.socket.getsockname()[1]
2671
2824
    if use_ipv6:
2672
2825
        logger.info("Now listening on address %r, port %d,"
2673
2826
                    " flowinfo %d, scope_id %d",
2679
2832
    #service.interface = tcp_server.socket.getsockname()[3]
2680
2833
    
2681
2834
    try:
2682
 
        # From the Avahi example code
2683
 
        try:
2684
 
            service.activate()
2685
 
        except dbus.exceptions.DBusException as error:
2686
 
            logger.critical("D-Bus Exception", exc_info=error)
2687
 
            cleanup()
2688
 
            sys.exit(1)
2689
 
        # End of Avahi example code
 
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
2690
2844
        
2691
2845
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2692
2846
                             lambda *args, **kwargs: