/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-01 09:43:10 UTC
  • Revision ID: teddy@recompile.se-20140301094310-c8j8ejchfc4a3bqi
* debian/control (Build-Depends, Build-Depends-Indep): Moved build
  dependencies of "mandos" package to "Build-Depends-Indep".

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
68
68
import binascii
69
69
import tempfile
70
70
import itertools
 
71
import collections
71
72
 
72
73
import dbus
73
74
import dbus.service
78
79
import ctypes.util
79
80
import xml.dom.minidom
80
81
import inspect
81
 
import GnuPGInterface
82
82
 
83
83
try:
84
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
88
    except ImportError:
89
89
        SO_BINDTODEVICE = None
90
90
 
91
 
version = "1.5.3"
 
91
version = "1.6.4"
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
    syslogger = (logging.handlers.SysLogHandler
 
118
                 (facility =
 
119
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
120
                  address = str("/dev/log")))
119
121
    syslogger.setFormatter(logging.Formatter
120
122
                           ('Mandos [%(process)d]: %(levelname)s:'
121
123
                            ' %(message)s'))
139
141
class PGPEngine(object):
140
142
    """A simple class for OpenPGP symmetric encryption & decryption"""
141
143
    def __init__(self):
142
 
        self.gnupg = GnuPGInterface.GnuPG()
143
144
        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'])
 
145
        self.gnupgargs = ['--batch',
 
146
                          '--home', self.tempdir,
 
147
                          '--force-mdc',
 
148
                          '--quiet',
 
149
                          '--no-use-agent']
150
150
    
151
151
    def __enter__(self):
152
152
        return self
153
153
    
154
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
154
    def __exit__(self, exc_type, exc_value, traceback):
155
155
        self._cleanup()
156
156
        return False
157
157
    
174
174
    def password_encode(self, password):
175
175
        # Passphrase can not be empty and can not contain newlines or
176
176
        # NUL bytes.  So we prefix it and hex encode it.
177
 
        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
178
184
    
179
185
    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
 
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)
194
201
        return ciphertext
195
202
    
196
203
    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
 
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)
211
220
        return decrypted_plaintext
212
221
 
213
222
 
233
242
               Used to optionally bind to the specified interface.
234
243
    name: string; Example: 'Mandos'
235
244
    type: string; Example: '_mandos._tcp'.
236
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
245
     See <https://www.iana.org/assignments/service-names-port-numbers>
237
246
    port: integer; what port to announce
238
247
    TXT: list of strings; TXT record for the service
239
248
    domain: string; Domain to publish on, default to .local if empty.
379
388
                                 self.server_state_changed)
380
389
        self.server_state_changed(self.server.GetState())
381
390
 
 
391
 
382
392
class AvahiServiceToSyslog(AvahiService):
383
393
    def rename(self):
384
394
        """Add the new name to the syslog messages"""
389
399
                                .format(self.name)))
390
400
        return ret
391
401
 
 
402
 
392
403
def timedelta_to_milliseconds(td):
393
404
    "Convert a datetime.timedelta() to milliseconds"
394
405
    return ((td.days * 24 * 60 * 60 * 1000)
395
406
            + (td.seconds * 1000)
396
407
            + (td.microseconds // 1000))
397
408
 
 
409
 
398
410
class Client(object):
399
411
    """A representation of a client host served by this server.
400
412
    
436
448
    runtime_expansions: Allowed attributes for runtime expansion.
437
449
    expires:    datetime.datetime(); time (UTC) when a client will be
438
450
                disabled, or None
 
451
    server_settings: The server_settings dict from main()
439
452
    """
440
453
    
441
454
    runtime_expansions = ("approval_delay", "approval_duration",
442
 
                          "created", "enabled", "fingerprint",
443
 
                          "host", "interval", "last_checked_ok",
 
455
                          "created", "enabled", "expires",
 
456
                          "fingerprint", "host", "interval",
 
457
                          "last_approval_request", "last_checked_ok",
444
458
                          "last_enabled", "name", "timeout")
445
 
    client_defaults = { "timeout": "5m",
446
 
                        "extended_timeout": "15m",
447
 
                        "interval": "2m",
 
459
    client_defaults = { "timeout": "PT5M",
 
460
                        "extended_timeout": "PT15M",
 
461
                        "interval": "PT2M",
448
462
                        "checker": "fping -q -- %%(host)s",
449
463
                        "host": "",
450
 
                        "approval_delay": "0s",
451
 
                        "approval_duration": "1s",
 
464
                        "approval_delay": "PT0S",
 
465
                        "approval_duration": "PT1S",
452
466
                        "approved_by_default": "True",
453
467
                        "enabled": "True",
454
468
                        }
515
529
        
516
530
        return settings
517
531
    
518
 
    def __init__(self, settings, name = None):
 
532
    def __init__(self, settings, name = None, server_settings=None):
519
533
        self.name = name
 
534
        if server_settings is None:
 
535
            server_settings = {}
 
536
        self.server_settings = server_settings
520
537
        # adding all client settings
521
538
        for setting, value in settings.iteritems():
522
539
            setattr(self, setting, value)
572
589
        if getattr(self, "enabled", False):
573
590
            # Already enabled
574
591
            return
575
 
        self.send_changedstate()
576
592
        self.expires = datetime.datetime.utcnow() + self.timeout
577
593
        self.enabled = True
578
594
        self.last_enabled = datetime.datetime.utcnow()
579
595
        self.init_checker()
 
596
        self.send_changedstate()
580
597
    
581
598
    def disable(self, quiet=True):
582
599
        """Disable this client."""
583
600
        if not getattr(self, "enabled", False):
584
601
            return False
585
602
        if not quiet:
586
 
            self.send_changedstate()
587
 
        if not quiet:
588
603
            logger.info("Disabling client %s", self.name)
589
 
        if getattr(self, "disable_initiator_tag", False):
 
604
        if getattr(self, "disable_initiator_tag", None) is not None:
590
605
            gobject.source_remove(self.disable_initiator_tag)
591
606
            self.disable_initiator_tag = None
592
607
        self.expires = None
593
 
        if getattr(self, "checker_initiator_tag", False):
 
608
        if getattr(self, "checker_initiator_tag", None) is not None:
594
609
            gobject.source_remove(self.checker_initiator_tag)
595
610
            self.checker_initiator_tag = None
596
611
        self.stop_checker()
597
612
        self.enabled = False
 
613
        if not quiet:
 
614
            self.send_changedstate()
598
615
        # Do not run this again if called by a gobject.timeout_add
599
616
        return False
600
617
    
604
621
    def init_checker(self):
605
622
        # Schedule a new checker to be started an 'interval' from now,
606
623
        # and every interval from then on.
 
624
        if self.checker_initiator_tag is not None:
 
625
            gobject.source_remove(self.checker_initiator_tag)
607
626
        self.checker_initiator_tag = (gobject.timeout_add
608
627
                                      (self.interval_milliseconds(),
609
628
                                       self.start_checker))
610
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)
611
632
        self.disable_initiator_tag = (gobject.timeout_add
612
633
                                   (self.timeout_milliseconds(),
613
634
                                    self.disable))
644
665
            timeout = self.timeout
645
666
        if self.disable_initiator_tag is not None:
646
667
            gobject.source_remove(self.disable_initiator_tag)
 
668
            self.disable_initiator_tag = None
647
669
        if getattr(self, "enabled", False):
648
670
            self.disable_initiator_tag = (gobject.timeout_add
649
671
                                          (timedelta_to_milliseconds
670
692
        # If a checker exists, make sure it is not a zombie
671
693
        try:
672
694
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
673
 
        except (AttributeError, OSError) as error:
674
 
            if (isinstance(error, OSError)
675
 
                and error.errno != errno.ECHILD):
676
 
                raise error
 
695
        except AttributeError:
 
696
            pass
 
697
        except OSError as error:
 
698
            if error.errno != errno.ECHILD:
 
699
                raise
677
700
        else:
678
701
            if pid:
679
702
                logger.warning("Checker was a zombie")
682
705
                                      self.current_checker_command)
683
706
        # Start a new checker if needed
684
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)
685
713
            try:
686
 
                # In case checker_command has exactly one % operator
687
 
                command = self.checker_command % self.host
688
 
            except TypeError:
689
 
                # Escape attributes for the shell
690
 
                escaped_attrs = dict(
691
 
                    (attr,
692
 
                     re.escape(unicode(str(getattr(self, attr, "")),
693
 
                                       errors=
694
 
                                       'replace')))
695
 
                    for attr in
696
 
                    self.runtime_expansions)
697
 
                
698
 
                try:
699
 
                    command = self.checker_command % escaped_attrs
700
 
                except TypeError as error:
701
 
                    logger.error('Could not format string "%s"',
702
 
                                 self.checker_command, exc_info=error)
703
 
                    return True # Try again later
 
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
704
719
            self.current_checker_command = command
705
720
            try:
706
721
                logger.info("Starting checker %r for %s",
709
724
                # in normal mode, that is already done by daemon(),
710
725
                # and in debug mode we don't want to.  (Stdin is
711
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 })
712
735
                self.checker = subprocess.Popen(command,
713
736
                                                close_fds=True,
714
 
                                                shell=True, cwd="/")
715
 
                self.checker_callback_tag = (gobject.child_watch_add
716
 
                                             (self.checker.pid,
717
 
                                              self.checker_callback,
718
 
                                              data=command))
719
 
                # The checker may have completed before the gobject
720
 
                # watch was added.  Check for this.
721
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
722
 
                if pid:
723
 
                    gobject.source_remove(self.checker_callback_tag)
724
 
                    self.checker_callback(pid, status, command)
 
737
                                                shell=True, cwd="/",
 
738
                                                **popen_args)
725
739
            except OSError as error:
726
740
                logger.error("Failed to start subprocess",
727
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)
728
761
        # Re-run this periodically if run by gobject.timeout_add
729
762
        return True
730
763
    
903
936
            # The byte_arrays option is not supported yet on
904
937
            # signatures other than "ay".
905
938
            if prop._dbus_signature != "ay":
906
 
                raise ValueError
 
939
                raise ValueError("Byte arrays not supported for non-"
 
940
                                 "'ay' signature {0!r}"
 
941
                                 .format(prop._dbus_signature))
907
942
            value = dbus.ByteArray(b''.join(chr(byte)
908
943
                                            for byte in value))
909
944
        prop(value)
1015
1050
        return xmlstring
1016
1051
 
1017
1052
 
1018
 
def datetime_to_dbus (dt, variant_level=0):
 
1053
def datetime_to_dbus(dt, variant_level=0):
1019
1054
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1020
1055
    if dt is None:
1021
1056
        return dbus.String("", variant_level = variant_level)
1029
1064
    interface names according to the "alt_interface_names" mapping.
1030
1065
    Usage:
1031
1066
    
1032
 
    @alternate_dbus_names({"org.example.Interface":
1033
 
                               "net.example.AlternateInterface"})
 
1067
    @alternate_dbus_interfaces({"org.example.Interface":
 
1068
                                    "net.example.AlternateInterface"})
1034
1069
    class SampleDBusObject(dbus.service.Object):
1035
1070
        @dbus.service.method("org.example.Interface")
1036
1071
        def SampleDBusMethod():
1067
1102
                interface_names.add(alt_interface)
1068
1103
                # Is this a D-Bus signal?
1069
1104
                if getattr(attribute, "_dbus_is_signal", False):
1070
 
                    # Extract the original non-method function by
1071
 
                    # black magic
 
1105
                    # Extract the original non-method undecorated
 
1106
                    # function by black magic
1072
1107
                    nonmethod_func = (dict(
1073
1108
                            zip(attribute.func_code.co_freevars,
1074
1109
                                attribute.__closure__))["func"]
1317
1352
                                       *args, **kwargs)
1318
1353
    
1319
1354
    def start_checker(self, *args, **kwargs):
1320
 
        old_checker = self.checker
1321
 
        if self.checker is not None:
1322
 
            old_checker_pid = self.checker.pid
1323
 
        else:
1324
 
            old_checker_pid = None
 
1355
        old_checker_pid = getattr(self.checker, "pid", None)
1325
1356
        r = Client.start_checker(self, *args, **kwargs)
1326
1357
        # Only if new checker process was started
1327
1358
        if (self.checker is not None
1335
1366
        return False
1336
1367
    
1337
1368
    def approve(self, value=True):
1338
 
        self.send_changedstate()
1339
1369
        self.approved = value
1340
1370
        gobject.timeout_add(timedelta_to_milliseconds
1341
1371
                            (self.approval_duration),
1342
1372
                            self._reset_approved)
 
1373
        self.send_changedstate()
1343
1374
    
1344
1375
    ## D-Bus methods, signals & properties
1345
1376
    _interface = "se.recompile.Mandos.Client"
1529
1560
    def Timeout_dbus_property(self, value=None):
1530
1561
        if value is None:       # get
1531
1562
            return dbus.UInt64(self.timeout_milliseconds())
 
1563
        old_timeout = self.timeout
1532
1564
        self.timeout = datetime.timedelta(0, 0, 0, value)
1533
 
        # Reschedule timeout
 
1565
        # Reschedule disabling
1534
1566
        if self.enabled:
1535
1567
            now = datetime.datetime.utcnow()
1536
 
            time_to_die = timedelta_to_milliseconds(
1537
 
                (self.last_checked_ok + self.timeout) - now)
1538
 
            if time_to_die <= 0:
 
1568
            self.expires += self.timeout - old_timeout
 
1569
            if self.expires <= now:
1539
1570
                # The timeout has passed
1540
1571
                self.disable()
1541
1572
            else:
1542
 
                self.expires = (now +
1543
 
                                datetime.timedelta(milliseconds =
1544
 
                                                   time_to_die))
1545
1573
                if (getattr(self, "disable_initiator_tag", None)
1546
1574
                    is None):
1547
1575
                    return
1548
1576
                gobject.source_remove(self.disable_initiator_tag)
1549
 
                self.disable_initiator_tag = (gobject.timeout_add
1550
 
                                              (time_to_die,
1551
 
                                               self.disable))
 
1577
                self.disable_initiator_tag = (
 
1578
                    gobject.timeout_add(
 
1579
                        timedelta_to_milliseconds(self.expires - now),
 
1580
                        self.disable))
1552
1581
    
1553
1582
    # ExtendedTimeout - property
1554
1583
    @dbus_service_property(_interface, signature="t",
1674
1703
            logger.debug("Protocol version: %r", line)
1675
1704
            try:
1676
1705
                if int(line.strip().split()[0]) > 1:
1677
 
                    raise RuntimeError
 
1706
                    raise RuntimeError(line)
1678
1707
            except (ValueError, IndexError, RuntimeError) as error:
1679
1708
                logger.error("Unknown protocol version: %s", error)
1680
1709
                return
1742
1771
                    #wait until timeout or approved
1743
1772
                    time = datetime.datetime.now()
1744
1773
                    client.changedstate.acquire()
1745
 
                    (client.changedstate.wait
1746
 
                     (float(client.timedelta_to_milliseconds(delay)
1747
 
                            / 1000)))
 
1774
                    client.changedstate.wait(
 
1775
                        float(timedelta_to_milliseconds(delay)
 
1776
                              / 1000))
1748
1777
                    client.changedstate.release()
1749
1778
                    time2 = datetime.datetime.now()
1750
1779
                    if (time2 - time) >= delay:
1887
1916
    
1888
1917
    def add_pipe(self, parent_pipe, proc):
1889
1918
        """Dummy function; override as necessary"""
1890
 
        raise NotImplementedError
 
1919
        raise NotImplementedError()
1891
1920
 
1892
1921
 
1893
1922
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1900
1929
        use_ipv6:       Boolean; to use IPv6 or not
1901
1930
    """
1902
1931
    def __init__(self, server_address, RequestHandlerClass,
1903
 
                 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
        """
1904
1936
        self.interface = interface
1905
1937
        if use_ipv6:
1906
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.
1907
1965
        socketserver.TCPServer.__init__(self, server_address,
1908
1966
                                        RequestHandlerClass)
 
1967
    
1909
1968
    def server_bind(self):
1910
1969
        """This overrides the normal server_bind() function
1911
1970
        to bind to an interface if one was specified, and also NOT to
1919
1978
                try:
1920
1979
                    self.socket.setsockopt(socket.SOL_SOCKET,
1921
1980
                                           SO_BINDTODEVICE,
1922
 
                                           str(self.interface
1923
 
                                               + '\0'))
 
1981
                                           str(self.interface + '\0'))
1924
1982
                except socket.error as error:
1925
 
                    if error[0] == errno.EPERM:
1926
 
                        logger.error("No permission to"
1927
 
                                     " bind to interface %s",
1928
 
                                     self.interface)
1929
 
                    elif error[0] == errno.ENOPROTOOPT:
 
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:
1930
1987
                        logger.error("SO_BINDTODEVICE not available;"
1931
1988
                                     " cannot bind to interface %s",
1932
1989
                                     self.interface)
 
1990
                    elif error.errno == errno.ENODEV:
 
1991
                        logger.error("Interface %s does not exist,"
 
1992
                                     " cannot bind", self.interface)
1933
1993
                    else:
1934
1994
                        raise
1935
1995
        # Only bind(2) the socket if we really need to.
1938
1998
                if self.address_family == socket.AF_INET6:
1939
1999
                    any_address = "::" # in6addr_any
1940
2000
                else:
1941
 
                    any_address = socket.INADDR_ANY
 
2001
                    any_address = "0.0.0.0" # INADDR_ANY
1942
2002
                self.server_address = (any_address,
1943
2003
                                       self.server_address[1])
1944
2004
            elif not self.server_address[1]:
1965
2025
    """
1966
2026
    def __init__(self, server_address, RequestHandlerClass,
1967
2027
                 interface=None, use_ipv6=True, clients=None,
1968
 
                 gnutls_priority=None, use_dbus=True):
 
2028
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1969
2029
        self.enabled = False
1970
2030
        self.clients = clients
1971
2031
        if self.clients is None:
1975
2035
        IPv6_TCPServer.__init__(self, server_address,
1976
2036
                                RequestHandlerClass,
1977
2037
                                interface = interface,
1978
 
                                use_ipv6 = use_ipv6)
 
2038
                                use_ipv6 = use_ipv6,
 
2039
                                socketfd = socketfd)
1979
2040
    def server_activate(self):
1980
2041
        if self.enabled:
1981
2042
            return socketserver.TCPServer.server_activate(self)
2059
2120
        return True
2060
2121
 
2061
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
 
2062
2222
def string_to_delta(interval):
2063
2223
    """Parse a string and return a datetime.timedelta
2064
2224
    
2075
2235
    >>> string_to_delta('5m 30s')
2076
2236
    datetime.timedelta(0, 330)
2077
2237
    """
 
2238
    
 
2239
    try:
 
2240
        return rfc3339_duration_to_delta(interval)
 
2241
    except ValueError:
 
2242
        pass
 
2243
    
2078
2244
    timevalue = datetime.timedelta(0)
2079
2245
    for s in interval.split():
2080
2246
        try:
2093
2259
            else:
2094
2260
                raise ValueError("Unknown suffix {0!r}"
2095
2261
                                 .format(suffix))
2096
 
        except (ValueError, IndexError) as e:
 
2262
        except IndexError as e:
2097
2263
            raise ValueError(*(e.args))
2098
2264
        timevalue += delta
2099
2265
    return timevalue
2143
2309
                        help="Run self-test")
2144
2310
    parser.add_argument("--debug", action="store_true",
2145
2311
                        help="Debug mode; run in foreground and log"
2146
 
                        " to terminal")
 
2312
                        " to terminal", default=None)
2147
2313
    parser.add_argument("--debuglevel", metavar="LEVEL",
2148
2314
                        help="Debug level for stdout output")
2149
2315
    parser.add_argument("--priority", help="GnuTLS"
2156
2322
                        " files")
2157
2323
    parser.add_argument("--no-dbus", action="store_false",
2158
2324
                        dest="use_dbus", help="Do not provide D-Bus"
2159
 
                        " system bus interface")
 
2325
                        " system bus interface", default=None)
2160
2326
    parser.add_argument("--no-ipv6", action="store_false",
2161
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2327
                        dest="use_ipv6", help="Do not use IPv6",
 
2328
                        default=None)
2162
2329
    parser.add_argument("--no-restore", action="store_false",
2163
2330
                        dest="restore", help="Do not restore stored"
2164
 
                        " 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")
2165
2335
    parser.add_argument("--statedir", metavar="DIR",
2166
2336
                        help="Directory to save/restore state in")
 
2337
    parser.add_argument("--foreground", action="store_true",
 
2338
                        help="Run in foreground", default=None)
2167
2339
    
2168
2340
    options = parser.parse_args()
2169
2341
    
2170
2342
    if options.check:
2171
2343
        import doctest
2172
 
        doctest.testmod()
2173
 
        sys.exit()
 
2344
        fail_count, test_count = doctest.testmod()
 
2345
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2174
2346
    
2175
2347
    # Default values for config file for server-global settings
2176
2348
    server_defaults = { "interface": "",
2178
2350
                        "port": "",
2179
2351
                        "debug": "False",
2180
2352
                        "priority":
2181
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2353
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2182
2354
                        "servicename": "Mandos",
2183
2355
                        "use_dbus": "True",
2184
2356
                        "use_ipv6": "True",
2185
2357
                        "debuglevel": "",
2186
2358
                        "restore": "True",
2187
 
                        "statedir": "/var/lib/mandos"
 
2359
                        "socket": "",
 
2360
                        "statedir": "/var/lib/mandos",
 
2361
                        "foreground": "False",
2188
2362
                        }
2189
2363
    
2190
2364
    # Parse config file for server-global settings
2195
2369
    # Convert the SafeConfigParser object to a dict
2196
2370
    server_settings = server_config.defaults()
2197
2371
    # Use the appropriate methods on the non-string config options
2198
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2372
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2199
2373
        server_settings[option] = server_config.getboolean("DEFAULT",
2200
2374
                                                           option)
2201
2375
    if server_settings["port"]:
2202
2376
        server_settings["port"] = server_config.getint("DEFAULT",
2203
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"])
2204
2387
    del server_config
2205
2388
    
2206
2389
    # Override the settings from the config file with command line
2208
2391
    for option in ("interface", "address", "port", "debug",
2209
2392
                   "priority", "servicename", "configdir",
2210
2393
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2211
 
                   "statedir"):
 
2394
                   "statedir", "socket", "foreground"):
2212
2395
        value = getattr(options, option)
2213
2396
        if value is not None:
2214
2397
            server_settings[option] = value
2217
2400
    for option in server_settings.keys():
2218
2401
        if type(server_settings[option]) is str:
2219
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
2220
2410
    # Now we have our good server settings in "server_settings"
2221
2411
    
2222
2412
    ##################################################################
2228
2418
    use_ipv6 = server_settings["use_ipv6"]
2229
2419
    stored_state_path = os.path.join(server_settings["statedir"],
2230
2420
                                     stored_state_file)
 
2421
    foreground = server_settings["foreground"]
2231
2422
    
2232
2423
    if debug:
2233
2424
        initlogger(debug, logging.DEBUG)
2262
2453
                              use_ipv6=use_ipv6,
2263
2454
                              gnutls_priority=
2264
2455
                              server_settings["priority"],
2265
 
                              use_dbus=use_dbus)
2266
 
    if not debug:
2267
 
        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
2268
2464
        try:
2269
2465
            pidfile = open(pidfilename, "w")
2270
2466
        except IOError as e:
2285
2481
        os.setgid(gid)
2286
2482
        os.setuid(uid)
2287
2483
    except OSError as error:
2288
 
        if error[0] != errno.EPERM:
2289
 
            raise error
 
2484
        if error.errno != errno.EPERM:
 
2485
            raise
2290
2486
    
2291
2487
    if debug:
2292
2488
        # Enable all possible GnuTLS debugging
2309
2505
            os.close(null)
2310
2506
    
2311
2507
    # Need to fork before connecting to D-Bus
2312
 
    if not debug:
 
2508
    if not foreground:
2313
2509
        # Close all input and output, do double fork, etc.
2314
2510
        daemon()
2315
2511
    
 
2512
    # multiprocessing will use threads, so before we use gobject we
 
2513
    # need to inform gobject that threads will be used.
2316
2514
    gobject.threads_init()
2317
2515
    
2318
2516
    global main_loop
2353
2551
    old_client_settings = {}
2354
2552
    clients_data = {}
2355
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
    
2356
2562
    # Get client data and settings from last running state.
2357
2563
    if server_settings["restore"]:
2358
2564
        try:
2374
2580
    
2375
2581
    with PGPEngine() as pgp:
2376
2582
        for client_name, client in clients_data.iteritems():
 
2583
            # Skip removed clients
 
2584
            if client_name not in client_settings:
 
2585
                continue
 
2586
            
2377
2587
            # Decide which value to use after restoring saved state.
2378
2588
            # We have three different values: Old config file,
2379
2589
            # new config file, and saved state.
2441
2651
    # Create all client objects
2442
2652
    for client_name, client in clients_data.iteritems():
2443
2653
        tcp_server.clients[client_name] = client_class(
2444
 
            name = client_name, settings = client)
 
2654
            name = client_name, settings = client,
 
2655
            server_settings = server_settings)
2445
2656
    
2446
2657
    if not tcp_server.clients:
2447
2658
        logger.warning("No clients defined")
2448
2659
    
2449
 
    if not debug:
2450
 
        try:
2451
 
            with pidfile:
2452
 
                pid = os.getpid()
2453
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2454
 
            del pidfile
2455
 
        except IOError:
2456
 
            logger.error("Could not write to file %r with PID %d",
2457
 
                         pidfilename, pid)
2458
 
        except NameError:
2459
 
            # "pidfile" was never created
2460
 
            pass
 
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
2461
2670
        del pidfilename
2462
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2463
2671
    
2464
2672
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2465
2673
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2533
2741
        service.cleanup()
2534
2742
        
2535
2743
        multiprocessing.active_children()
 
2744
        wnull.close()
2536
2745
        if not (tcp_server.clients or client_settings):
2537
2746
            return
2538
2747
        
2550
2759
                # A list of attributes that can not be pickled
2551
2760
                # + secret.
2552
2761
                exclude = set(("bus", "changedstate", "secret",
2553
 
                               "checker"))
 
2762
                               "checker", "server_settings"))
2554
2763
                for name, typ in (inspect.getmembers
2555
2764
                                  (dbus.service.Object)):
2556
2765
                    exclude.add(name)
2584
2793
            else:
2585
2794
                logger.warning("Could not save persistent state:",
2586
2795
                               exc_info=e)
2587
 
                raise e
 
2796
                raise
2588
2797
        
2589
2798
        # Delete all clients, and settings from config
2590
2799
        while tcp_server.clients: