/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-03-28 22:32:21 UTC
  • Revision ID: teddy@recompile.se-20140328223221-w579qlvlex5if3dn
Fix location and format of signing key file.

* debian/upstream/signing-key.asc: Added.
* debian/upstream-signing-key.pgp: Removed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2012 Teddy Hogeborn
15
 
# Copyright © 2008-2012 Björn Påhlsson
 
14
# Copyright © 2008-2014 Teddy Hogeborn
 
15
# Copyright © 2008-2014 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
 
37
from future_builtins import *
 
38
 
37
39
import SocketServer as socketserver
38
40
import socket
39
41
import argparse
66
68
import binascii
67
69
import tempfile
68
70
import itertools
 
71
import collections
69
72
 
70
73
import dbus
71
74
import dbus.service
76
79
import ctypes.util
77
80
import xml.dom.minidom
78
81
import inspect
79
 
import GnuPGInterface
80
82
 
81
83
try:
82
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
86
88
    except ImportError:
87
89
        SO_BINDTODEVICE = None
88
90
 
89
 
version = "1.5.3"
 
91
version = "1.6.4"
90
92
stored_state_file = "clients.pickle"
91
93
 
92
94
logger = logging.getLogger()
93
 
syslogger = (logging.handlers.SysLogHandler
94
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
 
              address = str("/dev/log")))
 
95
syslogger = None
96
96
 
97
97
try:
98
98
    if_nametoindex = (ctypes.cdll.LoadLibrary
114
114
def initlogger(debug, level=logging.WARNING):
115
115
    """init logger and add loglevel"""
116
116
    
 
117
    syslogger = (logging.handlers.SysLogHandler
 
118
                 (facility =
 
119
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
120
                  address = str("/dev/log")))
117
121
    syslogger.setFormatter(logging.Formatter
118
122
                           ('Mandos [%(process)d]: %(levelname)s:'
119
123
                            ' %(message)s'))
137
141
class PGPEngine(object):
138
142
    """A simple class for OpenPGP symmetric encryption & decryption"""
139
143
    def __init__(self):
140
 
        self.gnupg = GnuPGInterface.GnuPG()
141
144
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
142
 
        self.gnupg = GnuPGInterface.GnuPG()
143
 
        self.gnupg.options.meta_interactive = False
144
 
        self.gnupg.options.homedir = self.tempdir
145
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
146
 
                                              '--quiet',
147
 
                                              '--no-use-agent'])
 
145
        self.gnupgargs = ['--batch',
 
146
                          '--home', self.tempdir,
 
147
                          '--force-mdc',
 
148
                          '--quiet',
 
149
                          '--no-use-agent']
148
150
    
149
151
    def __enter__(self):
150
152
        return self
151
153
    
152
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
154
    def __exit__(self, exc_type, exc_value, traceback):
153
155
        self._cleanup()
154
156
        return False
155
157
    
172
174
    def password_encode(self, password):
173
175
        # Passphrase can not be empty and can not contain newlines or
174
176
        # NUL bytes.  So we prefix it and hex encode it.
175
 
        return b"mandos" + binascii.hexlify(password)
 
177
        encoded = b"mandos" + binascii.hexlify(password)
 
178
        if len(encoded) > 2048:
 
179
            # GnuPG can't handle long passwords, so encode differently
 
180
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
181
                       .replace(b"\n", b"\\n")
 
182
                       .replace(b"\0", b"\\x00"))
 
183
        return encoded
176
184
    
177
185
    def encrypt(self, data, password):
178
 
        self.gnupg.passphrase = self.password_encode(password)
179
 
        with open(os.devnull, "w") as devnull:
180
 
            try:
181
 
                proc = self.gnupg.run(['--symmetric'],
182
 
                                      create_fhs=['stdin', 'stdout'],
183
 
                                      attach_fhs={'stderr': devnull})
184
 
                with contextlib.closing(proc.handles['stdin']) as f:
185
 
                    f.write(data)
186
 
                with contextlib.closing(proc.handles['stdout']) as f:
187
 
                    ciphertext = f.read()
188
 
                proc.wait()
189
 
            except IOError as e:
190
 
                raise PGPError(e)
191
 
        self.gnupg.passphrase = None
 
186
        passphrase = self.password_encode(password)
 
187
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
188
                                         ) as passfile:
 
189
            passfile.write(passphrase)
 
190
            passfile.flush()
 
191
            proc = subprocess.Popen(['gpg', '--symmetric',
 
192
                                     '--passphrase-file',
 
193
                                     passfile.name]
 
194
                                    + self.gnupgargs,
 
195
                                    stdin = subprocess.PIPE,
 
196
                                    stdout = subprocess.PIPE,
 
197
                                    stderr = subprocess.PIPE)
 
198
            ciphertext, err = proc.communicate(input = data)
 
199
        if proc.returncode != 0:
 
200
            raise PGPError(err)
192
201
        return ciphertext
193
202
    
194
203
    def decrypt(self, data, password):
195
 
        self.gnupg.passphrase = self.password_encode(password)
196
 
        with open(os.devnull, "w") as devnull:
197
 
            try:
198
 
                proc = self.gnupg.run(['--decrypt'],
199
 
                                      create_fhs=['stdin', 'stdout'],
200
 
                                      attach_fhs={'stderr': devnull})
201
 
                with contextlib.closing(proc.handles['stdin']) as f:
202
 
                    f.write(data)
203
 
                with contextlib.closing(proc.handles['stdout']) as f:
204
 
                    decrypted_plaintext = f.read()
205
 
                proc.wait()
206
 
            except IOError as e:
207
 
                raise PGPError(e)
208
 
        self.gnupg.passphrase = None
 
204
        passphrase = self.password_encode(password)
 
205
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
206
                                         ) as passfile:
 
207
            passfile.write(passphrase)
 
208
            passfile.flush()
 
209
            proc = subprocess.Popen(['gpg', '--decrypt',
 
210
                                     '--passphrase-file',
 
211
                                     passfile.name]
 
212
                                    + self.gnupgargs,
 
213
                                    stdin = subprocess.PIPE,
 
214
                                    stdout = subprocess.PIPE,
 
215
                                    stderr = subprocess.PIPE)
 
216
            decrypted_plaintext, err = proc.communicate(input
 
217
                                                        = data)
 
218
        if proc.returncode != 0:
 
219
            raise PGPError(err)
209
220
        return decrypted_plaintext
210
221
 
211
222
 
231
242
               Used to optionally bind to the specified interface.
232
243
    name: string; Example: 'Mandos'
233
244
    type: string; Example: '_mandos._tcp'.
234
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
245
     See <https://www.iana.org/assignments/service-names-port-numbers>
235
246
    port: integer; what port to announce
236
247
    TXT: list of strings; TXT record for the service
237
248
    domain: string; Domain to publish on, default to .local if empty.
377
388
                                 self.server_state_changed)
378
389
        self.server_state_changed(self.server.GetState())
379
390
 
 
391
 
380
392
class AvahiServiceToSyslog(AvahiService):
381
393
    def rename(self):
382
394
        """Add the new name to the syslog messages"""
387
399
                                .format(self.name)))
388
400
        return ret
389
401
 
 
402
 
390
403
def timedelta_to_milliseconds(td):
391
404
    "Convert a datetime.timedelta() to milliseconds"
392
405
    return ((td.days * 24 * 60 * 60 * 1000)
393
406
            + (td.seconds * 1000)
394
407
            + (td.microseconds // 1000))
395
408
 
 
409
 
396
410
class Client(object):
397
411
    """A representation of a client host served by this server.
398
412
    
434
448
    runtime_expansions: Allowed attributes for runtime expansion.
435
449
    expires:    datetime.datetime(); time (UTC) when a client will be
436
450
                disabled, or None
 
451
    server_settings: The server_settings dict from main()
437
452
    """
438
453
    
439
454
    runtime_expansions = ("approval_delay", "approval_duration",
440
 
                          "created", "enabled", "fingerprint",
441
 
                          "host", "interval", "last_checked_ok",
 
455
                          "created", "enabled", "expires",
 
456
                          "fingerprint", "host", "interval",
 
457
                          "last_approval_request", "last_checked_ok",
442
458
                          "last_enabled", "name", "timeout")
443
 
    client_defaults = { "timeout": "5m",
444
 
                        "extended_timeout": "15m",
445
 
                        "interval": "2m",
 
459
    client_defaults = { "timeout": "PT5M",
 
460
                        "extended_timeout": "PT15M",
 
461
                        "interval": "PT2M",
446
462
                        "checker": "fping -q -- %%(host)s",
447
463
                        "host": "",
448
 
                        "approval_delay": "0s",
449
 
                        "approval_duration": "1s",
 
464
                        "approval_delay": "PT0S",
 
465
                        "approval_duration": "PT1S",
450
466
                        "approved_by_default": "True",
451
467
                        "enabled": "True",
452
468
                        }
513
529
        
514
530
        return settings
515
531
    
516
 
    def __init__(self, settings, name = None):
 
532
    def __init__(self, settings, name = None, server_settings=None):
517
533
        self.name = name
 
534
        if server_settings is None:
 
535
            server_settings = {}
 
536
        self.server_settings = server_settings
518
537
        # adding all client settings
519
538
        for setting, value in settings.iteritems():
520
539
            setattr(self, setting, value)
570
589
        if getattr(self, "enabled", False):
571
590
            # Already enabled
572
591
            return
573
 
        self.send_changedstate()
574
592
        self.expires = datetime.datetime.utcnow() + self.timeout
575
593
        self.enabled = True
576
594
        self.last_enabled = datetime.datetime.utcnow()
577
595
        self.init_checker()
 
596
        self.send_changedstate()
578
597
    
579
598
    def disable(self, quiet=True):
580
599
        """Disable this client."""
581
600
        if not getattr(self, "enabled", False):
582
601
            return False
583
602
        if not quiet:
584
 
            self.send_changedstate()
585
 
        if not quiet:
586
603
            logger.info("Disabling client %s", self.name)
587
 
        if getattr(self, "disable_initiator_tag", False):
 
604
        if getattr(self, "disable_initiator_tag", None) is not None:
588
605
            gobject.source_remove(self.disable_initiator_tag)
589
606
            self.disable_initiator_tag = None
590
607
        self.expires = None
591
 
        if getattr(self, "checker_initiator_tag", False):
 
608
        if getattr(self, "checker_initiator_tag", None) is not None:
592
609
            gobject.source_remove(self.checker_initiator_tag)
593
610
            self.checker_initiator_tag = None
594
611
        self.stop_checker()
595
612
        self.enabled = False
 
613
        if not quiet:
 
614
            self.send_changedstate()
596
615
        # Do not run this again if called by a gobject.timeout_add
597
616
        return False
598
617
    
602
621
    def init_checker(self):
603
622
        # Schedule a new checker to be started an 'interval' from now,
604
623
        # and every interval from then on.
 
624
        if self.checker_initiator_tag is not None:
 
625
            gobject.source_remove(self.checker_initiator_tag)
605
626
        self.checker_initiator_tag = (gobject.timeout_add
606
627
                                      (self.interval_milliseconds(),
607
628
                                       self.start_checker))
608
629
        # Schedule a disable() when 'timeout' has passed
 
630
        if self.disable_initiator_tag is not None:
 
631
            gobject.source_remove(self.disable_initiator_tag)
609
632
        self.disable_initiator_tag = (gobject.timeout_add
610
633
                                   (self.timeout_milliseconds(),
611
634
                                    self.disable))
642
665
            timeout = self.timeout
643
666
        if self.disable_initiator_tag is not None:
644
667
            gobject.source_remove(self.disable_initiator_tag)
 
668
            self.disable_initiator_tag = None
645
669
        if getattr(self, "enabled", False):
646
670
            self.disable_initiator_tag = (gobject.timeout_add
647
671
                                          (timedelta_to_milliseconds
657
681
        If a checker already exists, leave it running and do
658
682
        nothing."""
659
683
        # The reason for not killing a running checker is that if we
660
 
        # did that, then if a checker (for some reason) started
661
 
        # running slowly and taking more than 'interval' time, the
662
 
        # client would inevitably timeout, since no checker would get
663
 
        # a chance to run to completion.  If we instead leave running
 
684
        # did that, and if a checker (for some reason) started running
 
685
        # slowly and taking more than 'interval' time, then the client
 
686
        # would inevitably timeout, since no checker would get a
 
687
        # chance to run to completion.  If we instead leave running
664
688
        # checkers alone, the checker would have to take more time
665
689
        # than 'timeout' for the client to be disabled, which is as it
666
690
        # should be.
668
692
        # If a checker exists, make sure it is not a zombie
669
693
        try:
670
694
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
671
 
        except (AttributeError, OSError) as error:
672
 
            if (isinstance(error, OSError)
673
 
                and error.errno != errno.ECHILD):
674
 
                raise error
 
695
        except AttributeError:
 
696
            pass
 
697
        except OSError as error:
 
698
            if error.errno != errno.ECHILD:
 
699
                raise
675
700
        else:
676
701
            if pid:
677
702
                logger.warning("Checker was a zombie")
680
705
                                      self.current_checker_command)
681
706
        # Start a new checker if needed
682
707
        if self.checker is None:
 
708
            # Escape attributes for the shell
 
709
            escaped_attrs = dict(
 
710
                (attr, re.escape(unicode(getattr(self, attr))))
 
711
                for attr in
 
712
                self.runtime_expansions)
683
713
            try:
684
 
                # In case checker_command has exactly one % operator
685
 
                command = self.checker_command % self.host
686
 
            except TypeError:
687
 
                # Escape attributes for the shell
688
 
                escaped_attrs = dict(
689
 
                    (attr,
690
 
                     re.escape(unicode(str(getattr(self, attr, "")),
691
 
                                       errors=
692
 
                                       'replace')))
693
 
                    for attr in
694
 
                    self.runtime_expansions)
695
 
                
696
 
                try:
697
 
                    command = self.checker_command % escaped_attrs
698
 
                except TypeError as error:
699
 
                    logger.error('Could not format string "%s"',
700
 
                                 self.checker_command, exc_info=error)
701
 
                    return True # Try again later
 
714
                command = self.checker_command % escaped_attrs
 
715
            except TypeError as error:
 
716
                logger.error('Could not format string "%s"',
 
717
                             self.checker_command, exc_info=error)
 
718
                return True # Try again later
702
719
            self.current_checker_command = command
703
720
            try:
704
721
                logger.info("Starting checker %r for %s",
707
724
                # in normal mode, that is already done by daemon(),
708
725
                # and in debug mode we don't want to.  (Stdin is
709
726
                # always replaced by /dev/null.)
 
727
                # The exception is when not debugging but nevertheless
 
728
                # running in the foreground; use the previously
 
729
                # created wnull.
 
730
                popen_args = {}
 
731
                if (not self.server_settings["debug"]
 
732
                    and self.server_settings["foreground"]):
 
733
                    popen_args.update({"stdout": wnull,
 
734
                                       "stderr": wnull })
710
735
                self.checker = subprocess.Popen(command,
711
736
                                                close_fds=True,
712
 
                                                shell=True, cwd="/")
713
 
                self.checker_callback_tag = (gobject.child_watch_add
714
 
                                             (self.checker.pid,
715
 
                                              self.checker_callback,
716
 
                                              data=command))
717
 
                # The checker may have completed before the gobject
718
 
                # watch was added.  Check for this.
719
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
720
 
                if pid:
721
 
                    gobject.source_remove(self.checker_callback_tag)
722
 
                    self.checker_callback(pid, status, command)
 
737
                                                shell=True, cwd="/",
 
738
                                                **popen_args)
723
739
            except OSError as error:
724
740
                logger.error("Failed to start subprocess",
725
741
                             exc_info=error)
 
742
                return True
 
743
            self.checker_callback_tag = (gobject.child_watch_add
 
744
                                         (self.checker.pid,
 
745
                                          self.checker_callback,
 
746
                                          data=command))
 
747
            # The checker may have completed before the gobject
 
748
            # watch was added.  Check for this.
 
749
            try:
 
750
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
751
            except OSError as error:
 
752
                if error.errno == errno.ECHILD:
 
753
                    # This should never happen
 
754
                    logger.error("Child process vanished",
 
755
                                 exc_info=error)
 
756
                    return True
 
757
                raise
 
758
            if pid:
 
759
                gobject.source_remove(self.checker_callback_tag)
 
760
                self.checker_callback(pid, status, command)
726
761
        # Re-run this periodically if run by gobject.timeout_add
727
762
        return True
728
763
    
901
936
            # The byte_arrays option is not supported yet on
902
937
            # signatures other than "ay".
903
938
            if prop._dbus_signature != "ay":
904
 
                raise ValueError
 
939
                raise ValueError("Byte arrays not supported for non-"
 
940
                                 "'ay' signature {0!r}"
 
941
                                 .format(prop._dbus_signature))
905
942
            value = dbus.ByteArray(b''.join(chr(byte)
906
943
                                            for byte in value))
907
944
        prop(value)
979
1016
                            tag.appendChild(ann_tag)
980
1017
                # Add interface annotation tags
981
1018
                for annotation, value in dict(
982
 
                    itertools.chain(
983
 
                        *(annotations().iteritems()
984
 
                          for name, annotations in
985
 
                          self._get_all_dbus_things("interface")
986
 
                          if name == if_tag.getAttribute("name")
987
 
                          ))).iteritems():
 
1019
                    itertools.chain.from_iterable(
 
1020
                        annotations().iteritems()
 
1021
                        for name, annotations in
 
1022
                        self._get_all_dbus_things("interface")
 
1023
                        if name == if_tag.getAttribute("name")
 
1024
                        )).iteritems():
988
1025
                    ann_tag = document.createElement("annotation")
989
1026
                    ann_tag.setAttribute("name", annotation)
990
1027
                    ann_tag.setAttribute("value", value)
1013
1050
        return xmlstring
1014
1051
 
1015
1052
 
1016
 
def datetime_to_dbus (dt, variant_level=0):
 
1053
def datetime_to_dbus(dt, variant_level=0):
1017
1054
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1018
1055
    if dt is None:
1019
1056
        return dbus.String("", variant_level = variant_level)
1027
1064
    interface names according to the "alt_interface_names" mapping.
1028
1065
    Usage:
1029
1066
    
1030
 
    @alternate_dbus_names({"org.example.Interface":
1031
 
                               "net.example.AlternateInterface"})
 
1067
    @alternate_dbus_interfaces({"org.example.Interface":
 
1068
                                    "net.example.AlternateInterface"})
1032
1069
    class SampleDBusObject(dbus.service.Object):
1033
1070
        @dbus.service.method("org.example.Interface")
1034
1071
        def SampleDBusMethod():
1065
1102
                interface_names.add(alt_interface)
1066
1103
                # Is this a D-Bus signal?
1067
1104
                if getattr(attribute, "_dbus_is_signal", False):
1068
 
                    # Extract the original non-method function by
1069
 
                    # black magic
 
1105
                    # Extract the original non-method undecorated
 
1106
                    # function by black magic
1070
1107
                    nonmethod_func = (dict(
1071
1108
                            zip(attribute.func_code.co_freevars,
1072
1109
                                attribute.__closure__))["func"]
1315
1352
                                       *args, **kwargs)
1316
1353
    
1317
1354
    def start_checker(self, *args, **kwargs):
1318
 
        old_checker = self.checker
1319
 
        if self.checker is not None:
1320
 
            old_checker_pid = self.checker.pid
1321
 
        else:
1322
 
            old_checker_pid = None
 
1355
        old_checker_pid = getattr(self.checker, "pid", None)
1323
1356
        r = Client.start_checker(self, *args, **kwargs)
1324
1357
        # Only if new checker process was started
1325
1358
        if (self.checker is not None
1333
1366
        return False
1334
1367
    
1335
1368
    def approve(self, value=True):
1336
 
        self.send_changedstate()
1337
1369
        self.approved = value
1338
1370
        gobject.timeout_add(timedelta_to_milliseconds
1339
1371
                            (self.approval_duration),
1340
1372
                            self._reset_approved)
 
1373
        self.send_changedstate()
1341
1374
    
1342
1375
    ## D-Bus methods, signals & properties
1343
1376
    _interface = "se.recompile.Mandos.Client"
1527
1560
    def Timeout_dbus_property(self, value=None):
1528
1561
        if value is None:       # get
1529
1562
            return dbus.UInt64(self.timeout_milliseconds())
 
1563
        old_timeout = self.timeout
1530
1564
        self.timeout = datetime.timedelta(0, 0, 0, value)
1531
 
        # Reschedule timeout
 
1565
        # Reschedule disabling
1532
1566
        if self.enabled:
1533
1567
            now = datetime.datetime.utcnow()
1534
 
            time_to_die = timedelta_to_milliseconds(
1535
 
                (self.last_checked_ok + self.timeout) - now)
1536
 
            if time_to_die <= 0:
 
1568
            self.expires += self.timeout - old_timeout
 
1569
            if self.expires <= now:
1537
1570
                # The timeout has passed
1538
1571
                self.disable()
1539
1572
            else:
1540
 
                self.expires = (now +
1541
 
                                datetime.timedelta(milliseconds =
1542
 
                                                   time_to_die))
1543
1573
                if (getattr(self, "disable_initiator_tag", None)
1544
1574
                    is None):
1545
1575
                    return
1546
1576
                gobject.source_remove(self.disable_initiator_tag)
1547
 
                self.disable_initiator_tag = (gobject.timeout_add
1548
 
                                              (time_to_die,
1549
 
                                               self.disable))
 
1577
                self.disable_initiator_tag = (
 
1578
                    gobject.timeout_add(
 
1579
                        timedelta_to_milliseconds(self.expires - now),
 
1580
                        self.disable))
1550
1581
    
1551
1582
    # ExtendedTimeout - property
1552
1583
    @dbus_service_property(_interface, signature="t",
1672
1703
            logger.debug("Protocol version: %r", line)
1673
1704
            try:
1674
1705
                if int(line.strip().split()[0]) > 1:
1675
 
                    raise RuntimeError
 
1706
                    raise RuntimeError(line)
1676
1707
            except (ValueError, IndexError, RuntimeError) as error:
1677
1708
                logger.error("Unknown protocol version: %s", error)
1678
1709
                return
1740
1771
                    #wait until timeout or approved
1741
1772
                    time = datetime.datetime.now()
1742
1773
                    client.changedstate.acquire()
1743
 
                    (client.changedstate.wait
1744
 
                     (float(client.timedelta_to_milliseconds(delay)
1745
 
                            / 1000)))
 
1774
                    client.changedstate.wait(
 
1775
                        float(timedelta_to_milliseconds(delay)
 
1776
                              / 1000))
1746
1777
                    client.changedstate.release()
1747
1778
                    time2 = datetime.datetime.now()
1748
1779
                    if (time2 - time) >= delay:
1864
1895
    def process_request(self, request, address):
1865
1896
        """Start a new process to process the request."""
1866
1897
        proc = multiprocessing.Process(target = self.sub_process_main,
1867
 
                                       args = (request,
1868
 
                                               address))
 
1898
                                       args = (request, address))
1869
1899
        proc.start()
1870
1900
        return proc
1871
1901
 
1886
1916
    
1887
1917
    def add_pipe(self, parent_pipe, proc):
1888
1918
        """Dummy function; override as necessary"""
1889
 
        raise NotImplementedError
 
1919
        raise NotImplementedError()
1890
1920
 
1891
1921
 
1892
1922
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1899
1929
        use_ipv6:       Boolean; to use IPv6 or not
1900
1930
    """
1901
1931
    def __init__(self, server_address, RequestHandlerClass,
1902
 
                 interface=None, use_ipv6=True):
 
1932
                 interface=None, use_ipv6=True, socketfd=None):
 
1933
        """If socketfd is set, use that file descriptor instead of
 
1934
        creating a new one with socket.socket().
 
1935
        """
1903
1936
        self.interface = interface
1904
1937
        if use_ipv6:
1905
1938
            self.address_family = socket.AF_INET6
 
1939
        if socketfd is not None:
 
1940
            # Save the file descriptor
 
1941
            self.socketfd = socketfd
 
1942
            # Save the original socket.socket() function
 
1943
            self.socket_socket = socket.socket
 
1944
            # To implement --socket, we monkey patch socket.socket.
 
1945
            # 
 
1946
            # (When socketserver.TCPServer is a new-style class, we
 
1947
            # could make self.socket into a property instead of monkey
 
1948
            # patching socket.socket.)
 
1949
            # 
 
1950
            # Create a one-time-only replacement for socket.socket()
 
1951
            @functools.wraps(socket.socket)
 
1952
            def socket_wrapper(*args, **kwargs):
 
1953
                # Restore original function so subsequent calls are
 
1954
                # not affected.
 
1955
                socket.socket = self.socket_socket
 
1956
                del self.socket_socket
 
1957
                # This time only, return a new socket object from the
 
1958
                # saved file descriptor.
 
1959
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1960
            # Replace socket.socket() function with wrapper
 
1961
            socket.socket = socket_wrapper
 
1962
        # The socketserver.TCPServer.__init__ will call
 
1963
        # socket.socket(), which might be our replacement,
 
1964
        # socket_wrapper(), if socketfd was set.
1906
1965
        socketserver.TCPServer.__init__(self, server_address,
1907
1966
                                        RequestHandlerClass)
 
1967
    
1908
1968
    def server_bind(self):
1909
1969
        """This overrides the normal server_bind() function
1910
1970
        to bind to an interface if one was specified, and also NOT to
1918
1978
                try:
1919
1979
                    self.socket.setsockopt(socket.SOL_SOCKET,
1920
1980
                                           SO_BINDTODEVICE,
1921
 
                                           str(self.interface
1922
 
                                               + '\0'))
 
1981
                                           str(self.interface + '\0'))
1923
1982
                except socket.error as error:
1924
 
                    if error[0] == errno.EPERM:
1925
 
                        logger.error("No permission to"
1926
 
                                     " bind to interface %s",
1927
 
                                     self.interface)
1928
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1983
                    if error.errno == errno.EPERM:
 
1984
                        logger.error("No permission to bind to"
 
1985
                                     " interface %s", self.interface)
 
1986
                    elif error.errno == errno.ENOPROTOOPT:
1929
1987
                        logger.error("SO_BINDTODEVICE not available;"
1930
1988
                                     " cannot bind to interface %s",
1931
1989
                                     self.interface)
 
1990
                    elif error.errno == errno.ENODEV:
 
1991
                        logger.error("Interface %s does not exist,"
 
1992
                                     " cannot bind", self.interface)
1932
1993
                    else:
1933
1994
                        raise
1934
1995
        # Only bind(2) the socket if we really need to.
1937
1998
                if self.address_family == socket.AF_INET6:
1938
1999
                    any_address = "::" # in6addr_any
1939
2000
                else:
1940
 
                    any_address = socket.INADDR_ANY
 
2001
                    any_address = "0.0.0.0" # INADDR_ANY
1941
2002
                self.server_address = (any_address,
1942
2003
                                       self.server_address[1])
1943
2004
            elif not self.server_address[1]:
1964
2025
    """
1965
2026
    def __init__(self, server_address, RequestHandlerClass,
1966
2027
                 interface=None, use_ipv6=True, clients=None,
1967
 
                 gnutls_priority=None, use_dbus=True):
 
2028
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1968
2029
        self.enabled = False
1969
2030
        self.clients = clients
1970
2031
        if self.clients is None:
1974
2035
        IPv6_TCPServer.__init__(self, server_address,
1975
2036
                                RequestHandlerClass,
1976
2037
                                interface = interface,
1977
 
                                use_ipv6 = use_ipv6)
 
2038
                                use_ipv6 = use_ipv6,
 
2039
                                socketfd = socketfd)
1978
2040
    def server_activate(self):
1979
2041
        if self.enabled:
1980
2042
            return socketserver.TCPServer.server_activate(self)
1993
2055
    
1994
2056
    def handle_ipc(self, source, condition, parent_pipe=None,
1995
2057
                   proc = None, client_object=None):
1996
 
        condition_names = {
1997
 
            gobject.IO_IN: "IN",   # There is data to read.
1998
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1999
 
                                    # blocking).
2000
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
2001
 
            gobject.IO_ERR: "ERR", # Error condition.
2002
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
2003
 
                                    # broken, usually for pipes and
2004
 
                                    # sockets).
2005
 
            }
2006
 
        conditions_string = ' | '.join(name
2007
 
                                       for cond, name in
2008
 
                                       condition_names.iteritems()
2009
 
                                       if cond & condition)
2010
2058
        # error, or the other end of multiprocessing.Pipe has closed
2011
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2059
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2012
2060
            # Wait for other process to exit
2013
2061
            proc.join()
2014
2062
            return False
2072
2120
        return True
2073
2121
 
2074
2122
 
 
2123
def rfc3339_duration_to_delta(duration):
 
2124
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2125
    
 
2126
    >>> rfc3339_duration_to_delta("P7D")
 
2127
    datetime.timedelta(7)
 
2128
    >>> rfc3339_duration_to_delta("PT60S")
 
2129
    datetime.timedelta(0, 60)
 
2130
    >>> rfc3339_duration_to_delta("PT60M")
 
2131
    datetime.timedelta(0, 3600)
 
2132
    >>> rfc3339_duration_to_delta("PT24H")
 
2133
    datetime.timedelta(1)
 
2134
    >>> rfc3339_duration_to_delta("P1W")
 
2135
    datetime.timedelta(7)
 
2136
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2137
    datetime.timedelta(0, 330)
 
2138
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2139
    datetime.timedelta(1, 200)
 
2140
    """
 
2141
    
 
2142
    # Parsing an RFC 3339 duration with regular expressions is not
 
2143
    # possible - there would have to be multiple places for the same
 
2144
    # values, like seconds.  The current code, while more esoteric, is
 
2145
    # cleaner without depending on a parsing library.  If Python had a
 
2146
    # built-in library for parsing we would use it, but we'd like to
 
2147
    # avoid excessive use of external libraries.
 
2148
    
 
2149
    # New type for defining tokens, syntax, and semantics all-in-one
 
2150
    Token = collections.namedtuple("Token",
 
2151
                                   ("regexp", # To match token; if
 
2152
                                              # "value" is not None,
 
2153
                                              # must have a "group"
 
2154
                                              # containing digits
 
2155
                                    "value",  # datetime.timedelta or
 
2156
                                              # None
 
2157
                                    "followers")) # Tokens valid after
 
2158
                                                  # this token
 
2159
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2160
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2161
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2162
    token_second = Token(re.compile(r"(\d+)S"),
 
2163
                         datetime.timedelta(seconds=1),
 
2164
                         frozenset((token_end,)))
 
2165
    token_minute = Token(re.compile(r"(\d+)M"),
 
2166
                         datetime.timedelta(minutes=1),
 
2167
                         frozenset((token_second, token_end)))
 
2168
    token_hour = Token(re.compile(r"(\d+)H"),
 
2169
                       datetime.timedelta(hours=1),
 
2170
                       frozenset((token_minute, token_end)))
 
2171
    token_time = Token(re.compile(r"T"),
 
2172
                       None,
 
2173
                       frozenset((token_hour, token_minute,
 
2174
                                  token_second)))
 
2175
    token_day = Token(re.compile(r"(\d+)D"),
 
2176
                      datetime.timedelta(days=1),
 
2177
                      frozenset((token_time, token_end)))
 
2178
    token_month = Token(re.compile(r"(\d+)M"),
 
2179
                        datetime.timedelta(weeks=4),
 
2180
                        frozenset((token_day, token_end)))
 
2181
    token_year = Token(re.compile(r"(\d+)Y"),
 
2182
                       datetime.timedelta(weeks=52),
 
2183
                       frozenset((token_month, token_end)))
 
2184
    token_week = Token(re.compile(r"(\d+)W"),
 
2185
                       datetime.timedelta(weeks=1),
 
2186
                       frozenset((token_end,)))
 
2187
    token_duration = Token(re.compile(r"P"), None,
 
2188
                           frozenset((token_year, token_month,
 
2189
                                      token_day, token_time,
 
2190
                                      token_week))),
 
2191
    # Define starting values
 
2192
    value = datetime.timedelta() # Value so far
 
2193
    found_token = None
 
2194
    followers = frozenset(token_duration,) # Following valid tokens
 
2195
    s = duration                # String left to parse
 
2196
    # Loop until end token is found
 
2197
    while found_token is not token_end:
 
2198
        # Search for any currently valid tokens
 
2199
        for token in followers:
 
2200
            match = token.regexp.match(s)
 
2201
            if match is not None:
 
2202
                # Token found
 
2203
                if token.value is not None:
 
2204
                    # Value found, parse digits
 
2205
                    factor = int(match.group(1), 10)
 
2206
                    # Add to value so far
 
2207
                    value += factor * token.value
 
2208
                # Strip token from string
 
2209
                s = token.regexp.sub("", s, 1)
 
2210
                # Go to found token
 
2211
                found_token = token
 
2212
                # Set valid next tokens
 
2213
                followers = found_token.followers
 
2214
                break
 
2215
        else:
 
2216
            # No currently valid tokens were found
 
2217
            raise ValueError("Invalid RFC 3339 duration")
 
2218
    # End token found
 
2219
    return value
 
2220
 
 
2221
 
2075
2222
def string_to_delta(interval):
2076
2223
    """Parse a string and return a datetime.timedelta
2077
2224
    
2088
2235
    >>> string_to_delta('5m 30s')
2089
2236
    datetime.timedelta(0, 330)
2090
2237
    """
 
2238
    
 
2239
    try:
 
2240
        return rfc3339_duration_to_delta(interval)
 
2241
    except ValueError:
 
2242
        pass
 
2243
    
2091
2244
    timevalue = datetime.timedelta(0)
2092
2245
    for s in interval.split():
2093
2246
        try:
2106
2259
            else:
2107
2260
                raise ValueError("Unknown suffix {0!r}"
2108
2261
                                 .format(suffix))
2109
 
        except (ValueError, IndexError) as e:
 
2262
        except IndexError as e:
2110
2263
            raise ValueError(*(e.args))
2111
2264
        timevalue += delta
2112
2265
    return timevalue
2156
2309
                        help="Run self-test")
2157
2310
    parser.add_argument("--debug", action="store_true",
2158
2311
                        help="Debug mode; run in foreground and log"
2159
 
                        " to terminal")
 
2312
                        " to terminal", default=None)
2160
2313
    parser.add_argument("--debuglevel", metavar="LEVEL",
2161
2314
                        help="Debug level for stdout output")
2162
2315
    parser.add_argument("--priority", help="GnuTLS"
2169
2322
                        " files")
2170
2323
    parser.add_argument("--no-dbus", action="store_false",
2171
2324
                        dest="use_dbus", help="Do not provide D-Bus"
2172
 
                        " system bus interface")
 
2325
                        " system bus interface", default=None)
2173
2326
    parser.add_argument("--no-ipv6", action="store_false",
2174
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2327
                        dest="use_ipv6", help="Do not use IPv6",
 
2328
                        default=None)
2175
2329
    parser.add_argument("--no-restore", action="store_false",
2176
2330
                        dest="restore", help="Do not restore stored"
2177
 
                        " state")
 
2331
                        " state", default=None)
 
2332
    parser.add_argument("--socket", type=int,
 
2333
                        help="Specify a file descriptor to a network"
 
2334
                        " socket to use instead of creating one")
2178
2335
    parser.add_argument("--statedir", metavar="DIR",
2179
2336
                        help="Directory to save/restore state in")
 
2337
    parser.add_argument("--foreground", action="store_true",
 
2338
                        help="Run in foreground", default=None)
2180
2339
    
2181
2340
    options = parser.parse_args()
2182
2341
    
2183
2342
    if options.check:
2184
2343
        import doctest
2185
 
        doctest.testmod()
2186
 
        sys.exit()
 
2344
        fail_count, test_count = doctest.testmod()
 
2345
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2187
2346
    
2188
2347
    # Default values for config file for server-global settings
2189
2348
    server_defaults = { "interface": "",
2191
2350
                        "port": "",
2192
2351
                        "debug": "False",
2193
2352
                        "priority":
2194
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2353
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2195
2354
                        "servicename": "Mandos",
2196
2355
                        "use_dbus": "True",
2197
2356
                        "use_ipv6": "True",
2198
2357
                        "debuglevel": "",
2199
2358
                        "restore": "True",
2200
 
                        "statedir": "/var/lib/mandos"
 
2359
                        "socket": "",
 
2360
                        "statedir": "/var/lib/mandos",
 
2361
                        "foreground": "False",
2201
2362
                        }
2202
2363
    
2203
2364
    # Parse config file for server-global settings
2208
2369
    # Convert the SafeConfigParser object to a dict
2209
2370
    server_settings = server_config.defaults()
2210
2371
    # Use the appropriate methods on the non-string config options
2211
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2372
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2212
2373
        server_settings[option] = server_config.getboolean("DEFAULT",
2213
2374
                                                           option)
2214
2375
    if server_settings["port"]:
2215
2376
        server_settings["port"] = server_config.getint("DEFAULT",
2216
2377
                                                       "port")
 
2378
    if server_settings["socket"]:
 
2379
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2380
                                                         "socket")
 
2381
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2382
        # over with an opened os.devnull.  But we don't want this to
 
2383
        # happen with a supplied network socket.
 
2384
        if 0 <= server_settings["socket"] <= 2:
 
2385
            server_settings["socket"] = os.dup(server_settings
 
2386
                                               ["socket"])
2217
2387
    del server_config
2218
2388
    
2219
2389
    # Override the settings from the config file with command line
2221
2391
    for option in ("interface", "address", "port", "debug",
2222
2392
                   "priority", "servicename", "configdir",
2223
2393
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2224
 
                   "statedir"):
 
2394
                   "statedir", "socket", "foreground"):
2225
2395
        value = getattr(options, option)
2226
2396
        if value is not None:
2227
2397
            server_settings[option] = value
2230
2400
    for option in server_settings.keys():
2231
2401
        if type(server_settings[option]) is str:
2232
2402
            server_settings[option] = unicode(server_settings[option])
 
2403
    # Force all boolean options to be boolean
 
2404
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2405
                   "foreground"):
 
2406
        server_settings[option] = bool(server_settings[option])
 
2407
    # Debug implies foreground
 
2408
    if server_settings["debug"]:
 
2409
        server_settings["foreground"] = True
2233
2410
    # Now we have our good server settings in "server_settings"
2234
2411
    
2235
2412
    ##################################################################
2241
2418
    use_ipv6 = server_settings["use_ipv6"]
2242
2419
    stored_state_path = os.path.join(server_settings["statedir"],
2243
2420
                                     stored_state_file)
 
2421
    foreground = server_settings["foreground"]
2244
2422
    
2245
2423
    if debug:
2246
2424
        initlogger(debug, logging.DEBUG)
2275
2453
                              use_ipv6=use_ipv6,
2276
2454
                              gnutls_priority=
2277
2455
                              server_settings["priority"],
2278
 
                              use_dbus=use_dbus)
2279
 
    if not debug:
2280
 
        pidfilename = "/var/run/mandos.pid"
 
2456
                              use_dbus=use_dbus,
 
2457
                              socketfd=(server_settings["socket"]
 
2458
                                        or None))
 
2459
    if not foreground:
 
2460
        pidfilename = "/run/mandos.pid"
 
2461
        if not os.path.isdir("/run/."):
 
2462
            pidfilename = "/var/run/mandos.pid"
 
2463
        pidfile = None
2281
2464
        try:
2282
2465
            pidfile = open(pidfilename, "w")
2283
2466
        except IOError as e:
2298
2481
        os.setgid(gid)
2299
2482
        os.setuid(uid)
2300
2483
    except OSError as error:
2301
 
        if error[0] != errno.EPERM:
2302
 
            raise error
 
2484
        if error.errno != errno.EPERM:
 
2485
            raise
2303
2486
    
2304
2487
    if debug:
2305
2488
        # Enable all possible GnuTLS debugging
2322
2505
            os.close(null)
2323
2506
    
2324
2507
    # Need to fork before connecting to D-Bus
2325
 
    if not debug:
 
2508
    if not foreground:
2326
2509
        # Close all input and output, do double fork, etc.
2327
2510
        daemon()
2328
2511
    
 
2512
    # multiprocessing will use threads, so before we use gobject we
 
2513
    # need to inform gobject that threads will be used.
2329
2514
    gobject.threads_init()
2330
2515
    
2331
2516
    global main_loop
2366
2551
    old_client_settings = {}
2367
2552
    clients_data = {}
2368
2553
    
 
2554
    # This is used to redirect stdout and stderr for checker processes
 
2555
    global wnull
 
2556
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2557
    # Only used if server is running in foreground but not in debug
 
2558
    # mode
 
2559
    if debug or not foreground:
 
2560
        wnull.close()
 
2561
    
2369
2562
    # Get client data and settings from last running state.
2370
2563
    if server_settings["restore"]:
2371
2564
        try:
2387
2580
    
2388
2581
    with PGPEngine() as pgp:
2389
2582
        for client_name, client in clients_data.iteritems():
 
2583
            # Skip removed clients
 
2584
            if client_name not in client_settings:
 
2585
                continue
 
2586
            
2390
2587
            # Decide which value to use after restoring saved state.
2391
2588
            # We have three different values: Old config file,
2392
2589
            # new config file, and saved state.
2454
2651
    # Create all client objects
2455
2652
    for client_name, client in clients_data.iteritems():
2456
2653
        tcp_server.clients[client_name] = client_class(
2457
 
            name = client_name, settings = client)
 
2654
            name = client_name, settings = client,
 
2655
            server_settings = server_settings)
2458
2656
    
2459
2657
    if not tcp_server.clients:
2460
2658
        logger.warning("No clients defined")
2461
2659
    
2462
 
    if not debug:
2463
 
        try:
2464
 
            with pidfile:
2465
 
                pid = os.getpid()
2466
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2467
 
            del pidfile
2468
 
        except IOError:
2469
 
            logger.error("Could not write to file %r with PID %d",
2470
 
                         pidfilename, pid)
2471
 
        except NameError:
2472
 
            # "pidfile" was never created
2473
 
            pass
 
2660
    if not foreground:
 
2661
        if pidfile is not None:
 
2662
            try:
 
2663
                with pidfile:
 
2664
                    pid = os.getpid()
 
2665
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2666
            except IOError:
 
2667
                logger.error("Could not write to file %r with PID %d",
 
2668
                             pidfilename, pid)
 
2669
        del pidfile
2474
2670
        del pidfilename
2475
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2476
2671
    
2477
2672
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2478
2673
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2546
2741
        service.cleanup()
2547
2742
        
2548
2743
        multiprocessing.active_children()
 
2744
        wnull.close()
2549
2745
        if not (tcp_server.clients or client_settings):
2550
2746
            return
2551
2747
        
2563
2759
                # A list of attributes that can not be pickled
2564
2760
                # + secret.
2565
2761
                exclude = set(("bus", "changedstate", "secret",
2566
 
                               "checker"))
 
2762
                               "checker", "server_settings"))
2567
2763
                for name, typ in (inspect.getmembers
2568
2764
                                  (dbus.service.Object)):
2569
2765
                    exclude.add(name)
2578
2774
                del client_settings[client.name]["secret"]
2579
2775
        
2580
2776
        try:
2581
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2582
 
                                                prefix="clients-",
2583
 
                                                dir=os.path.dirname
2584
 
                                                (stored_state_path))
2585
 
            with os.fdopen(tempfd, "wb") as stored_state:
 
2777
            with (tempfile.NamedTemporaryFile
 
2778
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2779
                   dir=os.path.dirname(stored_state_path),
 
2780
                   delete=False)) as stored_state:
2586
2781
                pickle.dump((clients, client_settings), stored_state)
 
2782
                tempname=stored_state.name
2587
2783
            os.rename(tempname, stored_state_path)
2588
2784
        except (IOError, OSError) as e:
2589
2785
            if not debug:
2597
2793
            else:
2598
2794
                logger.warning("Could not save persistent state:",
2599
2795
                               exc_info=e)
2600
 
                raise e
 
2796
                raise
2601
2797
        
2602
2798
        # Delete all clients, and settings from config
2603
2799
        while tcp_server.clients: