/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: 2012-05-06 16:13:00 UTC
  • Revision ID: teddy@recompile.se-20120506161300-43rls2rr4qub3zhw
* mandos: Use a class decorator instead of a metaclass to provide
          alternate D-Bus interface names on D-Bus object attributes.
  (alternate_dbus_interfaces): New class decorator.
  (AlternateDBusNamesMetaclass, ClientDBusTransitional,
   MandosDBusServiceTransitional): Removed; all users changed.
  (ClientDbus, MandosDBusService): Use new "alternate_dbus_interfaces"
                                   class decorator.

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