/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2014 Teddy Hogeborn
15
 
# Copyright © 2008-2014 Björn Påhlsson
 
14
# Copyright © 2008-2012 Teddy Hogeborn
 
15
# Copyright © 2008-2012 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
68
68
import binascii
69
69
import tempfile
70
70
import itertools
71
 
import collections
72
71
 
73
72
import dbus
74
73
import dbus.service
79
78
import ctypes.util
80
79
import xml.dom.minidom
81
80
import inspect
 
81
import GnuPGInterface
82
82
 
83
83
try:
84
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
88
    except ImportError:
89
89
        SO_BINDTODEVICE = None
90
90
 
91
 
version = "1.6.7"
 
91
version = "1.5.3"
92
92
stored_state_file = "clients.pickle"
93
93
 
94
94
logger = logging.getLogger()
95
 
syslogger = None
 
95
syslogger = (logging.handlers.SysLogHandler
 
96
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
97
              address = str("/dev/log")))
96
98
 
97
99
try:
98
100
    if_nametoindex = (ctypes.cdll.LoadLibrary
114
116
def initlogger(debug, level=logging.WARNING):
115
117
    """init logger and add loglevel"""
116
118
    
117
 
    global syslogger
118
 
    syslogger = (logging.handlers.SysLogHandler
119
 
                 (facility =
120
 
                  logging.handlers.SysLogHandler.LOG_DAEMON,
121
 
                  address = str("/dev/log")))
122
119
    syslogger.setFormatter(logging.Formatter
123
120
                           ('Mandos [%(process)d]: %(levelname)s:'
124
121
                            ' %(message)s'))
142
139
class PGPEngine(object):
143
140
    """A simple class for OpenPGP symmetric encryption & decryption"""
144
141
    def __init__(self):
 
142
        self.gnupg = GnuPGInterface.GnuPG()
145
143
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
146
 
        self.gnupgargs = ['--batch',
147
 
                          '--home', self.tempdir,
148
 
                          '--force-mdc',
149
 
                          '--quiet',
150
 
                          '--no-use-agent']
 
144
        self.gnupg = GnuPGInterface.GnuPG()
 
145
        self.gnupg.options.meta_interactive = False
 
146
        self.gnupg.options.homedir = self.tempdir
 
147
        self.gnupg.options.extra_args.extend(['--force-mdc',
 
148
                                              '--quiet',
 
149
                                              '--no-use-agent'])
151
150
    
152
151
    def __enter__(self):
153
152
        return self
154
153
    
155
 
    def __exit__(self, exc_type, exc_value, traceback):
 
154
    def __exit__ (self, exc_type, exc_value, traceback):
156
155
        self._cleanup()
157
156
        return False
158
157
    
175
174
    def password_encode(self, password):
176
175
        # Passphrase can not be empty and can not contain newlines or
177
176
        # NUL bytes.  So we prefix it and hex encode it.
178
 
        encoded = b"mandos" + binascii.hexlify(password)
179
 
        if len(encoded) > 2048:
180
 
            # GnuPG can't handle long passwords, so encode differently
181
 
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
182
 
                       .replace(b"\n", b"\\n")
183
 
                       .replace(b"\0", b"\\x00"))
184
 
        return encoded
 
177
        return b"mandos" + binascii.hexlify(password)
185
178
    
186
179
    def encrypt(self, data, password):
187
 
        passphrase = self.password_encode(password)
188
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
189
 
                                         ) as passfile:
190
 
            passfile.write(passphrase)
191
 
            passfile.flush()
192
 
            proc = subprocess.Popen(['gpg', '--symmetric',
193
 
                                     '--passphrase-file',
194
 
                                     passfile.name]
195
 
                                    + self.gnupgargs,
196
 
                                    stdin = subprocess.PIPE,
197
 
                                    stdout = subprocess.PIPE,
198
 
                                    stderr = subprocess.PIPE)
199
 
            ciphertext, err = proc.communicate(input = data)
200
 
        if proc.returncode != 0:
201
 
            raise PGPError(err)
 
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
202
194
        return ciphertext
203
195
    
204
196
    def decrypt(self, data, password):
205
 
        passphrase = self.password_encode(password)
206
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
207
 
                                         ) as passfile:
208
 
            passfile.write(passphrase)
209
 
            passfile.flush()
210
 
            proc = subprocess.Popen(['gpg', '--decrypt',
211
 
                                     '--passphrase-file',
212
 
                                     passfile.name]
213
 
                                    + self.gnupgargs,
214
 
                                    stdin = subprocess.PIPE,
215
 
                                    stdout = subprocess.PIPE,
216
 
                                    stderr = subprocess.PIPE)
217
 
            decrypted_plaintext, err = proc.communicate(input
218
 
                                                        = data)
219
 
        if proc.returncode != 0:
220
 
            raise PGPError(err)
 
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
221
211
        return decrypted_plaintext
222
212
 
223
213
 
243
233
               Used to optionally bind to the specified interface.
244
234
    name: string; Example: 'Mandos'
245
235
    type: string; Example: '_mandos._tcp'.
246
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
236
                  See <http://www.dns-sd.org/ServiceTypes.html>
247
237
    port: integer; what port to announce
248
238
    TXT: list of strings; TXT record for the service
249
239
    domain: string; Domain to publish on, default to .local if empty.
389
379
                                 self.server_state_changed)
390
380
        self.server_state_changed(self.server.GetState())
391
381
 
392
 
 
393
382
class AvahiServiceToSyslog(AvahiService):
394
383
    def rename(self):
395
384
        """Add the new name to the syslog messages"""
400
389
                                .format(self.name)))
401
390
        return ret
402
391
 
403
 
 
404
392
def timedelta_to_milliseconds(td):
405
393
    "Convert a datetime.timedelta() to milliseconds"
406
394
    return ((td.days * 24 * 60 * 60 * 1000)
407
395
            + (td.seconds * 1000)
408
396
            + (td.microseconds // 1000))
409
397
 
410
 
 
411
398
class Client(object):
412
399
    """A representation of a client host served by this server.
413
400
    
449
436
    runtime_expansions: Allowed attributes for runtime expansion.
450
437
    expires:    datetime.datetime(); time (UTC) when a client will be
451
438
                disabled, or None
452
 
    server_settings: The server_settings dict from main()
453
439
    """
454
440
    
455
441
    runtime_expansions = ("approval_delay", "approval_duration",
456
 
                          "created", "enabled", "expires",
457
 
                          "fingerprint", "host", "interval",
458
 
                          "last_approval_request", "last_checked_ok",
 
442
                          "created", "enabled", "fingerprint",
 
443
                          "host", "interval", "last_checked_ok",
459
444
                          "last_enabled", "name", "timeout")
460
 
    client_defaults = { "timeout": "PT5M",
461
 
                        "extended_timeout": "PT15M",
462
 
                        "interval": "PT2M",
 
445
    client_defaults = { "timeout": "5m",
 
446
                        "extended_timeout": "15m",
 
447
                        "interval": "2m",
463
448
                        "checker": "fping -q -- %%(host)s",
464
449
                        "host": "",
465
 
                        "approval_delay": "PT0S",
466
 
                        "approval_duration": "PT1S",
 
450
                        "approval_delay": "0s",
 
451
                        "approval_duration": "1s",
467
452
                        "approved_by_default": "True",
468
453
                        "enabled": "True",
469
454
                        }
530
515
        
531
516
        return settings
532
517
    
533
 
    def __init__(self, settings, name = None, server_settings=None):
 
518
    def __init__(self, settings, name = None):
534
519
        self.name = name
535
 
        if server_settings is None:
536
 
            server_settings = {}
537
 
        self.server_settings = server_settings
538
520
        # adding all client settings
539
521
        for setting, value in settings.iteritems():
540
522
            setattr(self, setting, value)
590
572
        if getattr(self, "enabled", False):
591
573
            # Already enabled
592
574
            return
 
575
        self.send_changedstate()
593
576
        self.expires = datetime.datetime.utcnow() + self.timeout
594
577
        self.enabled = True
595
578
        self.last_enabled = datetime.datetime.utcnow()
596
579
        self.init_checker()
597
 
        self.send_changedstate()
598
580
    
599
581
    def disable(self, quiet=True):
600
582
        """Disable this client."""
601
583
        if not getattr(self, "enabled", False):
602
584
            return False
603
585
        if not quiet:
 
586
            self.send_changedstate()
 
587
        if not quiet:
604
588
            logger.info("Disabling client %s", self.name)
605
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
589
        if getattr(self, "disable_initiator_tag", False):
606
590
            gobject.source_remove(self.disable_initiator_tag)
607
591
            self.disable_initiator_tag = None
608
592
        self.expires = None
609
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
593
        if getattr(self, "checker_initiator_tag", False):
610
594
            gobject.source_remove(self.checker_initiator_tag)
611
595
            self.checker_initiator_tag = None
612
596
        self.stop_checker()
613
597
        self.enabled = False
614
 
        if not quiet:
615
 
            self.send_changedstate()
616
598
        # Do not run this again if called by a gobject.timeout_add
617
599
        return False
618
600
    
622
604
    def init_checker(self):
623
605
        # Schedule a new checker to be started an 'interval' from now,
624
606
        # and every interval from then on.
625
 
        if self.checker_initiator_tag is not None:
626
 
            gobject.source_remove(self.checker_initiator_tag)
627
607
        self.checker_initiator_tag = (gobject.timeout_add
628
608
                                      (self.interval_milliseconds(),
629
609
                                       self.start_checker))
630
610
        # Schedule a disable() when 'timeout' has passed
631
 
        if self.disable_initiator_tag is not None:
632
 
            gobject.source_remove(self.disable_initiator_tag)
633
611
        self.disable_initiator_tag = (gobject.timeout_add
634
612
                                   (self.timeout_milliseconds(),
635
613
                                    self.disable))
666
644
            timeout = self.timeout
667
645
        if self.disable_initiator_tag is not None:
668
646
            gobject.source_remove(self.disable_initiator_tag)
669
 
            self.disable_initiator_tag = None
670
647
        if getattr(self, "enabled", False):
671
648
            self.disable_initiator_tag = (gobject.timeout_add
672
649
                                          (timedelta_to_milliseconds
693
670
        # If a checker exists, make sure it is not a zombie
694
671
        try:
695
672
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
696
 
        except AttributeError:
697
 
            pass
698
 
        except OSError as error:
699
 
            if error.errno != errno.ECHILD:
700
 
                raise
 
673
        except (AttributeError, OSError) as error:
 
674
            if (isinstance(error, OSError)
 
675
                and error.errno != errno.ECHILD):
 
676
                raise error
701
677
        else:
702
678
            if pid:
703
679
                logger.warning("Checker was a zombie")
706
682
                                      self.current_checker_command)
707
683
        # Start a new checker if needed
708
684
        if self.checker is None:
709
 
            # Escape attributes for the shell
710
 
            escaped_attrs = dict(
711
 
                (attr, re.escape(unicode(getattr(self, attr))))
712
 
                for attr in
713
 
                self.runtime_expansions)
714
685
            try:
715
 
                command = self.checker_command % escaped_attrs
716
 
            except TypeError as error:
717
 
                logger.error('Could not format string "%s"',
718
 
                             self.checker_command, exc_info=error)
719
 
                return True # Try again later
 
686
                # In case checker_command has exactly one % operator
 
687
                command = self.checker_command % self.host
 
688
            except TypeError:
 
689
                # Escape attributes for the shell
 
690
                escaped_attrs = dict(
 
691
                    (attr,
 
692
                     re.escape(unicode(str(getattr(self, attr, "")),
 
693
                                       errors=
 
694
                                       'replace')))
 
695
                    for attr in
 
696
                    self.runtime_expansions)
 
697
                
 
698
                try:
 
699
                    command = self.checker_command % escaped_attrs
 
700
                except TypeError as error:
 
701
                    logger.error('Could not format string "%s"',
 
702
                                 self.checker_command, exc_info=error)
 
703
                    return True # Try again later
720
704
            self.current_checker_command = command
721
705
            try:
722
706
                logger.info("Starting checker %r for %s",
725
709
                # in normal mode, that is already done by daemon(),
726
710
                # and in debug mode we don't want to.  (Stdin is
727
711
                # always replaced by /dev/null.)
728
 
                # The exception is when not debugging but nevertheless
729
 
                # running in the foreground; use the previously
730
 
                # created wnull.
731
 
                popen_args = {}
732
 
                if (not self.server_settings["debug"]
733
 
                    and self.server_settings["foreground"]):
734
 
                    popen_args.update({"stdout": wnull,
735
 
                                       "stderr": wnull })
736
712
                self.checker = subprocess.Popen(command,
737
713
                                                close_fds=True,
738
 
                                                shell=True, cwd="/",
739
 
                                                **popen_args)
 
714
                                                shell=True, cwd="/")
 
715
                self.checker_callback_tag = (gobject.child_watch_add
 
716
                                             (self.checker.pid,
 
717
                                              self.checker_callback,
 
718
                                              data=command))
 
719
                # The checker may have completed before the gobject
 
720
                # watch was added.  Check for this.
 
721
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
722
                if pid:
 
723
                    gobject.source_remove(self.checker_callback_tag)
 
724
                    self.checker_callback(pid, status, command)
740
725
            except OSError as error:
741
726
                logger.error("Failed to start subprocess",
742
727
                             exc_info=error)
743
 
                return True
744
 
            self.checker_callback_tag = (gobject.child_watch_add
745
 
                                         (self.checker.pid,
746
 
                                          self.checker_callback,
747
 
                                          data=command))
748
 
            # The checker may have completed before the gobject
749
 
            # watch was added.  Check for this.
750
 
            try:
751
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
752
 
            except OSError as error:
753
 
                if error.errno == errno.ECHILD:
754
 
                    # This should never happen
755
 
                    logger.error("Child process vanished",
756
 
                                 exc_info=error)
757
 
                    return True
758
 
                raise
759
 
            if pid:
760
 
                gobject.source_remove(self.checker_callback_tag)
761
 
                self.checker_callback(pid, status, command)
762
728
        # Re-run this periodically if run by gobject.timeout_add
763
729
        return True
764
730
    
937
903
            # The byte_arrays option is not supported yet on
938
904
            # signatures other than "ay".
939
905
            if prop._dbus_signature != "ay":
940
 
                raise ValueError("Byte arrays not supported for non-"
941
 
                                 "'ay' signature {0!r}"
942
 
                                 .format(prop._dbus_signature))
 
906
                raise ValueError
943
907
            value = dbus.ByteArray(b''.join(chr(byte)
944
908
                                            for byte in value))
945
909
        prop(value)
1051
1015
        return xmlstring
1052
1016
 
1053
1017
 
1054
 
def datetime_to_dbus(dt, variant_level=0):
 
1018
def datetime_to_dbus (dt, variant_level=0):
1055
1019
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1056
1020
    if dt is None:
1057
1021
        return dbus.String("", variant_level = variant_level)
1065
1029
    interface names according to the "alt_interface_names" mapping.
1066
1030
    Usage:
1067
1031
    
1068
 
    @alternate_dbus_interfaces({"org.example.Interface":
1069
 
                                    "net.example.AlternateInterface"})
 
1032
    @alternate_dbus_names({"org.example.Interface":
 
1033
                               "net.example.AlternateInterface"})
1070
1034
    class SampleDBusObject(dbus.service.Object):
1071
1035
        @dbus.service.method("org.example.Interface")
1072
1036
        def SampleDBusMethod():
1103
1067
                interface_names.add(alt_interface)
1104
1068
                # Is this a D-Bus signal?
1105
1069
                if getattr(attribute, "_dbus_is_signal", False):
1106
 
                    # Extract the original non-method undecorated
1107
 
                    # function by black magic
 
1070
                    # Extract the original non-method function by
 
1071
                    # black magic
1108
1072
                    nonmethod_func = (dict(
1109
1073
                            zip(attribute.func_code.co_freevars,
1110
1074
                                attribute.__closure__))["func"]
1353
1317
                                       *args, **kwargs)
1354
1318
    
1355
1319
    def start_checker(self, *args, **kwargs):
1356
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
1320
        old_checker = self.checker
 
1321
        if self.checker is not None:
 
1322
            old_checker_pid = self.checker.pid
 
1323
        else:
 
1324
            old_checker_pid = None
1357
1325
        r = Client.start_checker(self, *args, **kwargs)
1358
1326
        # Only if new checker process was started
1359
1327
        if (self.checker is not None
1367
1335
        return False
1368
1336
    
1369
1337
    def approve(self, value=True):
 
1338
        self.send_changedstate()
1370
1339
        self.approved = value
1371
1340
        gobject.timeout_add(timedelta_to_milliseconds
1372
1341
                            (self.approval_duration),
1373
1342
                            self._reset_approved)
1374
 
        self.send_changedstate()
1375
1343
    
1376
1344
    ## D-Bus methods, signals & properties
1377
1345
    _interface = "se.recompile.Mandos.Client"
1561
1529
    def Timeout_dbus_property(self, value=None):
1562
1530
        if value is None:       # get
1563
1531
            return dbus.UInt64(self.timeout_milliseconds())
1564
 
        old_timeout = self.timeout
1565
1532
        self.timeout = datetime.timedelta(0, 0, 0, value)
1566
 
        # Reschedule disabling
 
1533
        # Reschedule timeout
1567
1534
        if self.enabled:
1568
1535
            now = datetime.datetime.utcnow()
1569
 
            self.expires += self.timeout - old_timeout
1570
 
            if self.expires <= now:
 
1536
            time_to_die = timedelta_to_milliseconds(
 
1537
                (self.last_checked_ok + self.timeout) - now)
 
1538
            if time_to_die <= 0:
1571
1539
                # The timeout has passed
1572
1540
                self.disable()
1573
1541
            else:
 
1542
                self.expires = (now +
 
1543
                                datetime.timedelta(milliseconds =
 
1544
                                                   time_to_die))
1574
1545
                if (getattr(self, "disable_initiator_tag", None)
1575
1546
                    is None):
1576
1547
                    return
1577
1548
                gobject.source_remove(self.disable_initiator_tag)
1578
 
                self.disable_initiator_tag = (
1579
 
                    gobject.timeout_add(
1580
 
                        timedelta_to_milliseconds(self.expires - now),
1581
 
                        self.disable))
 
1549
                self.disable_initiator_tag = (gobject.timeout_add
 
1550
                                              (time_to_die,
 
1551
                                               self.disable))
1582
1552
    
1583
1553
    # ExtendedTimeout - property
1584
1554
    @dbus_service_property(_interface, signature="t",
1704
1674
            logger.debug("Protocol version: %r", line)
1705
1675
            try:
1706
1676
                if int(line.strip().split()[0]) > 1:
1707
 
                    raise RuntimeError(line)
 
1677
                    raise RuntimeError
1708
1678
            except (ValueError, IndexError, RuntimeError) as error:
1709
1679
                logger.error("Unknown protocol version: %s", error)
1710
1680
                return
1772
1742
                    #wait until timeout or approved
1773
1743
                    time = datetime.datetime.now()
1774
1744
                    client.changedstate.acquire()
1775
 
                    client.changedstate.wait(
1776
 
                        float(timedelta_to_milliseconds(delay)
1777
 
                              / 1000))
 
1745
                    (client.changedstate.wait
 
1746
                     (float(client.timedelta_to_milliseconds(delay)
 
1747
                            / 1000)))
1778
1748
                    client.changedstate.release()
1779
1749
                    time2 = datetime.datetime.now()
1780
1750
                    if (time2 - time) >= delay:
1917
1887
    
1918
1888
    def add_pipe(self, parent_pipe, proc):
1919
1889
        """Dummy function; override as necessary"""
1920
 
        raise NotImplementedError()
 
1890
        raise NotImplementedError
1921
1891
 
1922
1892
 
1923
1893
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1930
1900
        use_ipv6:       Boolean; to use IPv6 or not
1931
1901
    """
1932
1902
    def __init__(self, server_address, RequestHandlerClass,
1933
 
                 interface=None, use_ipv6=True, socketfd=None):
1934
 
        """If socketfd is set, use that file descriptor instead of
1935
 
        creating a new one with socket.socket().
1936
 
        """
 
1903
                 interface=None, use_ipv6=True):
1937
1904
        self.interface = interface
1938
1905
        if use_ipv6:
1939
1906
            self.address_family = socket.AF_INET6
1940
 
        if socketfd is not None:
1941
 
            # Save the file descriptor
1942
 
            self.socketfd = socketfd
1943
 
            # Save the original socket.socket() function
1944
 
            self.socket_socket = socket.socket
1945
 
            # To implement --socket, we monkey patch socket.socket.
1946
 
            # 
1947
 
            # (When socketserver.TCPServer is a new-style class, we
1948
 
            # could make self.socket into a property instead of monkey
1949
 
            # patching socket.socket.)
1950
 
            # 
1951
 
            # Create a one-time-only replacement for socket.socket()
1952
 
            @functools.wraps(socket.socket)
1953
 
            def socket_wrapper(*args, **kwargs):
1954
 
                # Restore original function so subsequent calls are
1955
 
                # not affected.
1956
 
                socket.socket = self.socket_socket
1957
 
                del self.socket_socket
1958
 
                # This time only, return a new socket object from the
1959
 
                # saved file descriptor.
1960
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
1961
 
            # Replace socket.socket() function with wrapper
1962
 
            socket.socket = socket_wrapper
1963
 
        # The socketserver.TCPServer.__init__ will call
1964
 
        # socket.socket(), which might be our replacement,
1965
 
        # socket_wrapper(), if socketfd was set.
1966
1907
        socketserver.TCPServer.__init__(self, server_address,
1967
1908
                                        RequestHandlerClass)
1968
 
    
1969
1909
    def server_bind(self):
1970
1910
        """This overrides the normal server_bind() function
1971
1911
        to bind to an interface if one was specified, and also NOT to
1979
1919
                try:
1980
1920
                    self.socket.setsockopt(socket.SOL_SOCKET,
1981
1921
                                           SO_BINDTODEVICE,
1982
 
                                           str(self.interface + '\0'))
 
1922
                                           str(self.interface
 
1923
                                               + '\0'))
1983
1924
                except socket.error as error:
1984
 
                    if error.errno == errno.EPERM:
1985
 
                        logger.error("No permission to bind to"
1986
 
                                     " interface %s", self.interface)
1987
 
                    elif error.errno == errno.ENOPROTOOPT:
 
1925
                    if error[0] == errno.EPERM:
 
1926
                        logger.error("No permission to"
 
1927
                                     " bind to interface %s",
 
1928
                                     self.interface)
 
1929
                    elif error[0] == errno.ENOPROTOOPT:
1988
1930
                        logger.error("SO_BINDTODEVICE not available;"
1989
1931
                                     " cannot bind to interface %s",
1990
1932
                                     self.interface)
1991
 
                    elif error.errno == errno.ENODEV:
1992
 
                        logger.error("Interface %s does not exist,"
1993
 
                                     " cannot bind", self.interface)
1994
1933
                    else:
1995
1934
                        raise
1996
1935
        # Only bind(2) the socket if we really need to.
1999
1938
                if self.address_family == socket.AF_INET6:
2000
1939
                    any_address = "::" # in6addr_any
2001
1940
                else:
2002
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1941
                    any_address = socket.INADDR_ANY
2003
1942
                self.server_address = (any_address,
2004
1943
                                       self.server_address[1])
2005
1944
            elif not self.server_address[1]:
2026
1965
    """
2027
1966
    def __init__(self, server_address, RequestHandlerClass,
2028
1967
                 interface=None, use_ipv6=True, clients=None,
2029
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
1968
                 gnutls_priority=None, use_dbus=True):
2030
1969
        self.enabled = False
2031
1970
        self.clients = clients
2032
1971
        if self.clients is None:
2036
1975
        IPv6_TCPServer.__init__(self, server_address,
2037
1976
                                RequestHandlerClass,
2038
1977
                                interface = interface,
2039
 
                                use_ipv6 = use_ipv6,
2040
 
                                socketfd = socketfd)
 
1978
                                use_ipv6 = use_ipv6)
2041
1979
    def server_activate(self):
2042
1980
        if self.enabled:
2043
1981
            return socketserver.TCPServer.server_activate(self)
2121
2059
        return True
2122
2060
 
2123
2061
 
2124
 
def rfc3339_duration_to_delta(duration):
2125
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2126
 
    
2127
 
    >>> rfc3339_duration_to_delta("P7D")
2128
 
    datetime.timedelta(7)
2129
 
    >>> rfc3339_duration_to_delta("PT60S")
2130
 
    datetime.timedelta(0, 60)
2131
 
    >>> rfc3339_duration_to_delta("PT60M")
2132
 
    datetime.timedelta(0, 3600)
2133
 
    >>> rfc3339_duration_to_delta("PT24H")
2134
 
    datetime.timedelta(1)
2135
 
    >>> rfc3339_duration_to_delta("P1W")
2136
 
    datetime.timedelta(7)
2137
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2138
 
    datetime.timedelta(0, 330)
2139
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2140
 
    datetime.timedelta(1, 200)
2141
 
    """
2142
 
    
2143
 
    # Parsing an RFC 3339 duration with regular expressions is not
2144
 
    # possible - there would have to be multiple places for the same
2145
 
    # values, like seconds.  The current code, while more esoteric, is
2146
 
    # cleaner without depending on a parsing library.  If Python had a
2147
 
    # built-in library for parsing we would use it, but we'd like to
2148
 
    # avoid excessive use of external libraries.
2149
 
    
2150
 
    # New type for defining tokens, syntax, and semantics all-in-one
2151
 
    Token = collections.namedtuple("Token",
2152
 
                                   ("regexp", # To match token; if
2153
 
                                              # "value" is not None,
2154
 
                                              # must have a "group"
2155
 
                                              # containing digits
2156
 
                                    "value",  # datetime.timedelta or
2157
 
                                              # None
2158
 
                                    "followers")) # Tokens valid after
2159
 
                                                  # this token
2160
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2161
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2162
 
    token_end = Token(re.compile(r"$"), None, frozenset())
2163
 
    token_second = Token(re.compile(r"(\d+)S"),
2164
 
                         datetime.timedelta(seconds=1),
2165
 
                         frozenset((token_end,)))
2166
 
    token_minute = Token(re.compile(r"(\d+)M"),
2167
 
                         datetime.timedelta(minutes=1),
2168
 
                         frozenset((token_second, token_end)))
2169
 
    token_hour = Token(re.compile(r"(\d+)H"),
2170
 
                       datetime.timedelta(hours=1),
2171
 
                       frozenset((token_minute, token_end)))
2172
 
    token_time = Token(re.compile(r"T"),
2173
 
                       None,
2174
 
                       frozenset((token_hour, token_minute,
2175
 
                                  token_second)))
2176
 
    token_day = Token(re.compile(r"(\d+)D"),
2177
 
                      datetime.timedelta(days=1),
2178
 
                      frozenset((token_time, token_end)))
2179
 
    token_month = Token(re.compile(r"(\d+)M"),
2180
 
                        datetime.timedelta(weeks=4),
2181
 
                        frozenset((token_day, token_end)))
2182
 
    token_year = Token(re.compile(r"(\d+)Y"),
2183
 
                       datetime.timedelta(weeks=52),
2184
 
                       frozenset((token_month, token_end)))
2185
 
    token_week = Token(re.compile(r"(\d+)W"),
2186
 
                       datetime.timedelta(weeks=1),
2187
 
                       frozenset((token_end,)))
2188
 
    token_duration = Token(re.compile(r"P"), None,
2189
 
                           frozenset((token_year, token_month,
2190
 
                                      token_day, token_time,
2191
 
                                      token_week))),
2192
 
    # Define starting values
2193
 
    value = datetime.timedelta() # Value so far
2194
 
    found_token = None
2195
 
    followers = frozenset(token_duration,) # Following valid tokens
2196
 
    s = duration                # String left to parse
2197
 
    # Loop until end token is found
2198
 
    while found_token is not token_end:
2199
 
        # Search for any currently valid tokens
2200
 
        for token in followers:
2201
 
            match = token.regexp.match(s)
2202
 
            if match is not None:
2203
 
                # Token found
2204
 
                if token.value is not None:
2205
 
                    # Value found, parse digits
2206
 
                    factor = int(match.group(1), 10)
2207
 
                    # Add to value so far
2208
 
                    value += factor * token.value
2209
 
                # Strip token from string
2210
 
                s = token.regexp.sub("", s, 1)
2211
 
                # Go to found token
2212
 
                found_token = token
2213
 
                # Set valid next tokens
2214
 
                followers = found_token.followers
2215
 
                break
2216
 
        else:
2217
 
            # No currently valid tokens were found
2218
 
            raise ValueError("Invalid RFC 3339 duration")
2219
 
    # End token found
2220
 
    return value
2221
 
 
2222
 
 
2223
2062
def string_to_delta(interval):
2224
2063
    """Parse a string and return a datetime.timedelta
2225
2064
    
2236
2075
    >>> string_to_delta('5m 30s')
2237
2076
    datetime.timedelta(0, 330)
2238
2077
    """
2239
 
    
2240
 
    try:
2241
 
        return rfc3339_duration_to_delta(interval)
2242
 
    except ValueError:
2243
 
        pass
2244
 
    
2245
2078
    timevalue = datetime.timedelta(0)
2246
2079
    for s in interval.split():
2247
2080
        try:
2260
2093
            else:
2261
2094
                raise ValueError("Unknown suffix {0!r}"
2262
2095
                                 .format(suffix))
2263
 
        except IndexError as e:
 
2096
        except (ValueError, IndexError) as e:
2264
2097
            raise ValueError(*(e.args))
2265
2098
        timevalue += delta
2266
2099
    return timevalue
2310
2143
                        help="Run self-test")
2311
2144
    parser.add_argument("--debug", action="store_true",
2312
2145
                        help="Debug mode; run in foreground and log"
2313
 
                        " to terminal", default=None)
 
2146
                        " to terminal")
2314
2147
    parser.add_argument("--debuglevel", metavar="LEVEL",
2315
2148
                        help="Debug level for stdout output")
2316
2149
    parser.add_argument("--priority", help="GnuTLS"
2323
2156
                        " files")
2324
2157
    parser.add_argument("--no-dbus", action="store_false",
2325
2158
                        dest="use_dbus", help="Do not provide D-Bus"
2326
 
                        " system bus interface", default=None)
 
2159
                        " system bus interface")
2327
2160
    parser.add_argument("--no-ipv6", action="store_false",
2328
 
                        dest="use_ipv6", help="Do not use IPv6",
2329
 
                        default=None)
 
2161
                        dest="use_ipv6", help="Do not use IPv6")
2330
2162
    parser.add_argument("--no-restore", action="store_false",
2331
2163
                        dest="restore", help="Do not restore stored"
2332
 
                        " state", default=None)
2333
 
    parser.add_argument("--socket", type=int,
2334
 
                        help="Specify a file descriptor to a network"
2335
 
                        " socket to use instead of creating one")
 
2164
                        " state")
2336
2165
    parser.add_argument("--statedir", metavar="DIR",
2337
2166
                        help="Directory to save/restore state in")
2338
 
    parser.add_argument("--foreground", action="store_true",
2339
 
                        help="Run in foreground", default=None)
2340
 
    parser.add_argument("--no-zeroconf", action="store_false",
2341
 
                        dest="zeroconf", help="Do not use Zeroconf",
2342
 
                        default=None)
2343
2167
    
2344
2168
    options = parser.parse_args()
2345
2169
    
2346
2170
    if options.check:
2347
2171
        import doctest
2348
 
        fail_count, test_count = doctest.testmod()
2349
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2172
        doctest.testmod()
 
2173
        sys.exit()
2350
2174
    
2351
2175
    # Default values for config file for server-global settings
2352
2176
    server_defaults = { "interface": "",
2354
2178
                        "port": "",
2355
2179
                        "debug": "False",
2356
2180
                        "priority":
2357
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2181
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2358
2182
                        "servicename": "Mandos",
2359
2183
                        "use_dbus": "True",
2360
2184
                        "use_ipv6": "True",
2361
2185
                        "debuglevel": "",
2362
2186
                        "restore": "True",
2363
 
                        "socket": "",
2364
 
                        "statedir": "/var/lib/mandos",
2365
 
                        "foreground": "False",
2366
 
                        "zeroconf": "True",
 
2187
                        "statedir": "/var/lib/mandos"
2367
2188
                        }
2368
2189
    
2369
2190
    # Parse config file for server-global settings
2374
2195
    # Convert the SafeConfigParser object to a dict
2375
2196
    server_settings = server_config.defaults()
2376
2197
    # Use the appropriate methods on the non-string config options
2377
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
2198
    for option in ("debug", "use_dbus", "use_ipv6"):
2378
2199
        server_settings[option] = server_config.getboolean("DEFAULT",
2379
2200
                                                           option)
2380
2201
    if server_settings["port"]:
2381
2202
        server_settings["port"] = server_config.getint("DEFAULT",
2382
2203
                                                       "port")
2383
 
    if server_settings["socket"]:
2384
 
        server_settings["socket"] = server_config.getint("DEFAULT",
2385
 
                                                         "socket")
2386
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
2387
 
        # over with an opened os.devnull.  But we don't want this to
2388
 
        # happen with a supplied network socket.
2389
 
        if 0 <= server_settings["socket"] <= 2:
2390
 
            server_settings["socket"] = os.dup(server_settings
2391
 
                                               ["socket"])
2392
2204
    del server_config
2393
2205
    
2394
2206
    # Override the settings from the config file with command line
2396
2208
    for option in ("interface", "address", "port", "debug",
2397
2209
                   "priority", "servicename", "configdir",
2398
2210
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2399
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
2211
                   "statedir"):
2400
2212
        value = getattr(options, option)
2401
2213
        if value is not None:
2402
2214
            server_settings[option] = value
2405
2217
    for option in server_settings.keys():
2406
2218
        if type(server_settings[option]) is str:
2407
2219
            server_settings[option] = unicode(server_settings[option])
2408
 
    # Force all boolean options to be boolean
2409
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2410
 
                   "foreground", "zeroconf"):
2411
 
        server_settings[option] = bool(server_settings[option])
2412
 
    # Debug implies foreground
2413
 
    if server_settings["debug"]:
2414
 
        server_settings["foreground"] = True
2415
2220
    # Now we have our good server settings in "server_settings"
2416
2221
    
2417
2222
    ##################################################################
2418
2223
    
2419
 
    if (not server_settings["zeroconf"] and
2420
 
        not (server_settings["port"]
2421
 
             or server_settings["socket"] != "")):
2422
 
            parser.error("Needs port or socket to work without"
2423
 
                         " Zeroconf")
2424
 
    
2425
2224
    # For convenience
2426
2225
    debug = server_settings["debug"]
2427
2226
    debuglevel = server_settings["debuglevel"]
2429
2228
    use_ipv6 = server_settings["use_ipv6"]
2430
2229
    stored_state_path = os.path.join(server_settings["statedir"],
2431
2230
                                     stored_state_file)
2432
 
    foreground = server_settings["foreground"]
2433
 
    zeroconf = server_settings["zeroconf"]
2434
2231
    
2435
2232
    if debug:
2436
2233
        initlogger(debug, logging.DEBUG)
2457
2254
    global mandos_dbus_service
2458
2255
    mandos_dbus_service = None
2459
2256
    
2460
 
    socketfd = None
2461
 
    if server_settings["socket"] != "":
2462
 
        socketfd = server_settings["socket"]
2463
2257
    tcp_server = MandosServer((server_settings["address"],
2464
2258
                               server_settings["port"]),
2465
2259
                              ClientHandler,
2468
2262
                              use_ipv6=use_ipv6,
2469
2263
                              gnutls_priority=
2470
2264
                              server_settings["priority"],
2471
 
                              use_dbus=use_dbus,
2472
 
                              socketfd=socketfd)
2473
 
    if not foreground:
2474
 
        pidfilename = "/run/mandos.pid"
2475
 
        if not os.path.isdir("/run/."):
2476
 
            pidfilename = "/var/run/mandos.pid"
2477
 
        pidfile = None
 
2265
                              use_dbus=use_dbus)
 
2266
    if not debug:
 
2267
        pidfilename = "/var/run/mandos.pid"
2478
2268
        try:
2479
2269
            pidfile = open(pidfilename, "w")
2480
2270
        except IOError as e:
2495
2285
        os.setgid(gid)
2496
2286
        os.setuid(uid)
2497
2287
    except OSError as error:
2498
 
        if error.errno != errno.EPERM:
2499
 
            raise
 
2288
        if error[0] != errno.EPERM:
 
2289
            raise error
2500
2290
    
2501
2291
    if debug:
2502
2292
        # Enable all possible GnuTLS debugging
2519
2309
            os.close(null)
2520
2310
    
2521
2311
    # Need to fork before connecting to D-Bus
2522
 
    if not foreground:
 
2312
    if not debug:
2523
2313
        # Close all input and output, do double fork, etc.
2524
2314
        daemon()
2525
2315
    
2526
 
    # multiprocessing will use threads, so before we use gobject we
2527
 
    # need to inform gobject that threads will be used.
2528
2316
    gobject.threads_init()
2529
2317
    
2530
2318
    global main_loop
2545
2333
            use_dbus = False
2546
2334
            server_settings["use_dbus"] = False
2547
2335
            tcp_server.use_dbus = False
2548
 
    if zeroconf:
2549
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2550
 
        service = AvahiServiceToSyslog(name =
2551
 
                                       server_settings["servicename"],
2552
 
                                       servicetype = "_mandos._tcp",
2553
 
                                       protocol = protocol, bus = bus)
2554
 
        if server_settings["interface"]:
2555
 
            service.interface = (if_nametoindex
2556
 
                                 (str(server_settings["interface"])))
 
2336
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2337
    service = AvahiServiceToSyslog(name =
 
2338
                                   server_settings["servicename"],
 
2339
                                   servicetype = "_mandos._tcp",
 
2340
                                   protocol = protocol, bus = bus)
 
2341
    if server_settings["interface"]:
 
2342
        service.interface = (if_nametoindex
 
2343
                             (str(server_settings["interface"])))
2557
2344
    
2558
2345
    global multiprocessing_manager
2559
2346
    multiprocessing_manager = multiprocessing.Manager()
2566
2353
    old_client_settings = {}
2567
2354
    clients_data = {}
2568
2355
    
2569
 
    # This is used to redirect stdout and stderr for checker processes
2570
 
    global wnull
2571
 
    wnull = open(os.devnull, "w") # A writable /dev/null
2572
 
    # Only used if server is running in foreground but not in debug
2573
 
    # mode
2574
 
    if debug or not foreground:
2575
 
        wnull.close()
2576
 
    
2577
2356
    # Get client data and settings from last running state.
2578
2357
    if server_settings["restore"]:
2579
2358
        try:
2595
2374
    
2596
2375
    with PGPEngine() as pgp:
2597
2376
        for client_name, client in clients_data.iteritems():
2598
 
            # Skip removed clients
2599
 
            if client_name not in client_settings:
2600
 
                continue
2601
 
            
2602
2377
            # Decide which value to use after restoring saved state.
2603
2378
            # We have three different values: Old config file,
2604
2379
            # new config file, and saved state.
2666
2441
    # Create all client objects
2667
2442
    for client_name, client in clients_data.iteritems():
2668
2443
        tcp_server.clients[client_name] = client_class(
2669
 
            name = client_name, settings = client,
2670
 
            server_settings = server_settings)
 
2444
            name = client_name, settings = client)
2671
2445
    
2672
2446
    if not tcp_server.clients:
2673
2447
        logger.warning("No clients defined")
2674
2448
    
2675
 
    if not foreground:
2676
 
        if pidfile is not None:
2677
 
            try:
2678
 
                with pidfile:
2679
 
                    pid = os.getpid()
2680
 
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
2681
 
            except IOError:
2682
 
                logger.error("Could not write to file %r with PID %d",
2683
 
                             pidfilename, pid)
2684
 
        del pidfile
 
2449
    if not debug:
 
2450
        try:
 
2451
            with pidfile:
 
2452
                pid = os.getpid()
 
2453
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2454
            del pidfile
 
2455
        except IOError:
 
2456
            logger.error("Could not write to file %r with PID %d",
 
2457
                         pidfilename, pid)
 
2458
        except NameError:
 
2459
            # "pidfile" was never created
 
2460
            pass
2685
2461
        del pidfilename
 
2462
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2686
2463
    
2687
2464
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2688
2465
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2753
2530
    
2754
2531
    def cleanup():
2755
2532
        "Cleanup function; run on exit"
2756
 
        if zeroconf:
2757
 
            service.cleanup()
 
2533
        service.cleanup()
2758
2534
        
2759
2535
        multiprocessing.active_children()
2760
 
        wnull.close()
2761
2536
        if not (tcp_server.clients or client_settings):
2762
2537
            return
2763
2538
        
2775
2550
                # A list of attributes that can not be pickled
2776
2551
                # + secret.
2777
2552
                exclude = set(("bus", "changedstate", "secret",
2778
 
                               "checker", "server_settings"))
 
2553
                               "checker"))
2779
2554
                for name, typ in (inspect.getmembers
2780
2555
                                  (dbus.service.Object)):
2781
2556
                    exclude.add(name)
2809
2584
            else:
2810
2585
                logger.warning("Could not save persistent state:",
2811
2586
                               exc_info=e)
2812
 
                raise
 
2587
                raise e
2813
2588
        
2814
2589
        # Delete all clients, and settings from config
2815
2590
        while tcp_server.clients:
2839
2614
    tcp_server.server_activate()
2840
2615
    
2841
2616
    # Find out what port we got
2842
 
    if zeroconf:
2843
 
        service.port = tcp_server.socket.getsockname()[1]
 
2617
    service.port = tcp_server.socket.getsockname()[1]
2844
2618
    if use_ipv6:
2845
2619
        logger.info("Now listening on address %r, port %d,"
2846
2620
                    " flowinfo %d, scope_id %d",
2852
2626
    #service.interface = tcp_server.socket.getsockname()[3]
2853
2627
    
2854
2628
    try:
2855
 
        if zeroconf:
2856
 
            # From the Avahi example code
2857
 
            try:
2858
 
                service.activate()
2859
 
            except dbus.exceptions.DBusException as error:
2860
 
                logger.critical("D-Bus Exception", exc_info=error)
2861
 
                cleanup()
2862
 
                sys.exit(1)
2863
 
            # End of Avahi example code
 
2629
        # From the Avahi example code
 
2630
        try:
 
2631
            service.activate()
 
2632
        except dbus.exceptions.DBusException as error:
 
2633
            logger.critical("D-Bus Exception", exc_info=error)
 
2634
            cleanup()
 
2635
            sys.exit(1)
 
2636
        # End of Avahi example code
2864
2637
        
2865
2638
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2866
2639
                             lambda *args, **kwargs: