/mandos/trunk

    """Parse a string and return a datetime.timedelta"""

    """Parse an interval string as documented by Mandos before 1.6.1,

    and return a datetime.timedelta

 

## Classes for commands.

 

# Abstract classes first

class Command(object):

    """Abstract class for commands"""

    def run(self, mandos, clients):

        """Normal commands should implement run_on_one_client(), but

        commands which want to operate on all clients at the same time

        can override this run() method instead."""

        self.mandos = mandos

        for client, properties in clients.items():

            self.run_on_one_client(client, properties)

 

class PrintCmd(Command):

    """Abstract class for commands printing client details"""

    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",

                    "Created", "Interval", "Host", "KeyID",

                    "Fingerprint", "CheckerRunning", "LastEnabled",

                    "ApprovalPending", "ApprovedByDefault",

                    "LastApprovalRequest", "ApprovalDelay",

                    "ApprovalDuration", "Checker", "ExtendedTimeout",

                    "Expires", "LastCheckerStatus")

    def run(self, mandos, clients):

        print(self.output(clients))

 

class PropertyCmd(Command):

    """Abstract class for Actions for setting one client property"""

    def run_on_one_client(self, client, properties):

        """Set the Client's D-Bus property"""

        client.Set(client_interface, self.property, self.value_to_set,

                   dbus_interface=dbus.PROPERTIES_IFACE)

 

class ValueArgumentMixIn(object):

    """Mixin class for commands taking a value as argument"""

    def __init__(self, value):

        self.value_to_set = value

 

class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):

    """Mixin class for commands taking a value argument as

    milliseconds."""

    @property

    def value_to_set(self):

        return self._vts

    @value_to_set.setter

    def value_to_set(self, value):

        """When setting, convert value to a datetime.timedelta"""

        self._vts = string_to_delta(value).total_seconds() * 1000

 

# Actual (non-abstract) command classes

 

class PrintTableCmd(PrintCmd):

    def __init__(self, verbose=False):

        self.verbose = verbose

 

    def output(self, clients):

        if self.verbose:

            keywords = self.all_keywords

        else:

            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")

        return str(self.TableOfClients(clients.values(), keywords))

 

    class TableOfClients(object):

        tableheaders = {

            "Name": "Name",

            "Enabled": "Enabled",

            "Timeout": "Timeout",

            "LastCheckedOK": "Last Successful Check",

            "LastApprovalRequest": "Last Approval Request",

            "Created": "Created",

            "Interval": "Interval",

            "Host": "Host",

            "Fingerprint": "Fingerprint",

            "KeyID": "Key ID",

            "CheckerRunning": "Check Is Running",

            "LastEnabled": "Last Enabled",

            "ApprovalPending": "Approval Is Pending",

            "ApprovedByDefault": "Approved By Default",

            "ApprovalDelay": "Approval Delay",

            "ApprovalDuration": "Approval Duration",

            "Checker": "Checker",

            "ExtendedTimeout": "Extended Timeout",

            "Expires": "Expires",

            "LastCheckerStatus": "Last Checker Status",

        }

 

        def __init__(self, clients, keywords, tableheaders=None):

            self.clients = clients

            self.keywords = keywords

            if tableheaders is not None:

                self.tableheaders = tableheaders

 

            return "\n".join(self.rows())

 

        if sys.version_info.major == 2:

            __unicode__ = __str__

            def __str__(self):

                return str(self).encode(locale.getpreferredencoding())

 

        def rows(self):

            format_string = self.row_formatting_string()

            rows = [self.header_line(format_string)]

            rows.extend(self.client_line(client, format_string)

                        for client in self.clients)

            return rows

 

        def row_formatting_string(self):

            "Format string used to format table rows"

            return " ".join("{{{key}:{width}}}".format(

                width=max(len(self.tableheaders[key]),

                          *(len(self.string_from_client(client, key))

                            for client in self.clients)),

                key=key)

                            for key in self.keywords)

 

        def string_from_client(self, client, key):

            return self.valuetostring(client[key], key)

 

        @staticmethod

        def valuetostring(value, keyword):

            if isinstance(value, dbus.Boolean):

                return "Yes" if value else "No"

            if keyword in ("Timeout", "Interval", "ApprovalDelay",

                           "ApprovalDuration", "ExtendedTimeout"):

                return milliseconds_to_string(value)

            return str(value)

 

        def header_line(self, format_string):

            return format_string.format(**self.tableheaders)

 

        def client_line(self, client, format_string):

            return format_string.format(

                **{key: self.string_from_client(client, key)

                   for key in self.keywords})

 

 

 

class DumpJSONCmd(PrintCmd):

    def output(self, clients):

        data = {client["Name"]:

                {key: self.dbus_boolean_to_bool(client[key])

                 for key in self.all_keywords}

                for client in clients.values()}

        return json.dumps(data, indent=4, separators=(',', ': '))

    def dbus_boolean_to_bool(value):

            value = bool(value)

        return value

 

class IsEnabledCmd(Command):

    def run_on_one_client(self, client, properties):

        if self.is_enabled(client, properties):

            sys.exit(0)

        sys.exit(1)

    def is_enabled(self, client, properties):

        return bool(properties["Enabled"])

 

class RemoveCmd(Command):

    def run_on_one_client(self, client, properties):

        self.mandos.RemoveClient(client.__dbus_object_path__)

 

class ApproveCmd(Command):

    def run_on_one_client(self, client, properties):

        client.Approve(dbus.Boolean(True),

                       dbus_interface=client_interface)

 

class DenyCmd(Command):

    def run_on_one_client(self, client, properties):

        client.Approve(dbus.Boolean(False),

                       dbus_interface=client_interface)

 

class EnableCmd(PropertyCmd):

    property = "Enabled"

    value_to_set = dbus.Boolean(True)

 

class DisableCmd(PropertyCmd):

    property = "Enabled"

    value_to_set = dbus.Boolean(False)

 

class BumpTimeoutCmd(PropertyCmd):

    property = "LastCheckedOK"

    value_to_set = ""

 

class StartCheckerCmd(PropertyCmd):

    property = "CheckerRunning"

    value_to_set = dbus.Boolean(True)

 

class StopCheckerCmd(PropertyCmd):

    property = "CheckerRunning"

    value_to_set = dbus.Boolean(False)

 

class ApproveByDefaultCmd(PropertyCmd):

    property = "ApprovedByDefault"

    value_to_set = dbus.Boolean(True)

 

class DenyByDefaultCmd(PropertyCmd):

    property = "ApprovedByDefault"

    value_to_set = dbus.Boolean(False)

 

class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):

    property = "Checker"

 

class SetHostCmd(PropertyCmd, ValueArgumentMixIn):

    property = "Host"

 

class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):

    property = "Secret"

 

class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):

    property = "Timeout"

 

class SetExtendedTimeoutCmd(PropertyCmd,

                            MillisecondsValueArgumentMixIn):

    property = "ExtendedTimeout"

 

class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):

    property = "Interval"

 

class SetApprovalDelayCmd(PropertyCmd,

                          MillisecondsValueArgumentMixIn):

    property = "ApprovalDelay"

 

class SetApprovalDurationCmd(PropertyCmd,

                             MillisecondsValueArgumentMixIn):

    property = "ApprovalDuration"

def add_command_line_options(parser):

    enable_disable = parser.add_mutually_exclusive_group()

    enable_disable.add_argument("-e", "--enable", action="store_true",

                                help="Enable client")

    enable_disable.add_argument("-d", "--disable",

                                action="store_true",

                                help="disable client")

    start_stop_checker = parser.add_mutually_exclusive_group()

    start_stop_checker.add_argument("--start-checker",

                                    action="store_true",

                                    help="Start checker for client")

    start_stop_checker.add_argument("--stop-checker",

                                    action="store_true",

                                    help="Stop checker for client")

    approve_deny_default = parser.add_mutually_exclusive_group()

    approve_deny_default.add_argument(

        "--approve-by-default", action="store_true",

        default=None, dest="approved_by_default",

        help="Set client to be approved by default")

    approve_deny_default.add_argument(

        "--deny-by-default", action="store_false",

        dest="approved_by_default",

        help="Set client to be denied by default")

    approve_deny = parser.add_mutually_exclusive_group()

    approve_deny.add_argument(

        "-A", "--approve", action="store_true",

        help="Approve any current client request")

    approve_deny.add_argument("-D", "--deny", action="store_true",

                              help="Deny any current client request")

 

 

def commands_from_options(options):

 

    commands = []

 

    if options.dump_json:

        commands.append(DumpJSONCmd())

 

    if options.enable:

        commands.append(EnableCmd())

 

    if options.disable:

        commands.append(DisableCmd())

 

    if options.bump_timeout:

        commands.append(BumpTimeoutCmd())

 

    if options.start_checker:

        commands.append(StartCheckerCmd())

 

    if options.stop_checker:

        commands.append(StopCheckerCmd())

 

    if options.is_enabled:

        commands.append(IsEnabledCmd())

 

    if options.remove:

        commands.append(RemoveCmd())

 

    if options.checker is not None:

        commands.append(SetCheckerCmd())

 

    if options.timeout is not None:

        commands.append(SetTimeoutCmd(options.timeout))

 

    if options.extended_timeout:

        commands.append(

            SetExtendedTimeoutCmd(options.extended_timeout))

 

    if options.interval is not None:

        command.append(SetIntervalCmd(options.interval))

 

    if options.approved_by_default is not None:

        if options.approved_by_default:

            command.append(ApproveByDefaultCmd())

        else:

            command.append(DenyByDefaultCmd())

 

    if options.approval_delay is not None:

        command.append(SetApprovalDelayCmd(options.approval_delay))

 

    if options.approval_duration is not None:

        command.append(

            SetApprovalDurationCmd(options.approval_duration))

 

    if options.host is not None:

        command.append(SetHostCmd(options.host))

 

    if options.secret is not None:

        command.append(SetSecretCmd(options.secret))

 

    if options.approve:

        commands.append(ApproveCmd())

 

    if options.deny:

        commands.append(DenyCmd())

 

    # If no command option has been given, show table of clients,

    # optionally verbosely

    if not commands:

        commands.append(PrintTableCmd(verbose=options.verbose))

 

    return commands

 

 

def main():

    parser = argparse.ArgumentParser()

 

    add_command_line_options(parser)

 

    if options.is_enabled and len(options.client) > 1:

        parser.error("--is-enabled requires exactly one client")

 

    clientnames = options.client

    # Filter out log message from dbus module

    dbus_logger = logging.getLogger("dbus.proxies")

    class NullFilter(logging.Filter):

        def filter(self, record):

            return False

    dbus_filter = NullFilter()

        dbus_logger.addFilter(dbus_filter)

        mandos_clients = {path: ifs_and_props[client_interface]

                          for path, ifs_and_props in

                          mandos_serv_object_manager

                          .GetManagedObjects().items()

                          if client_interface in ifs_and_props}

    finally:

        # restore dbus logger

        dbus_logger.removeFilter(dbus_filter)

    if not clientnames:

        for name in clientnames:

    # Run all commands on clients

    commands = commands_from_options(options)

    for command in commands:

        command.run(mandos_serv, clients)

            class WarningFilter(logging.Filter):

                """Don't show, but record the presence of, warnings"""

                def filter(self, record):

                    is_warning = record.levelno >= logging.WARNING

                    self.found = is_warning or getattr(self, "found",

                                                       False)

                    return not is_warning

            warning_filter = WarningFilter()

            log.addFilter(warning_filter)

            try:

                value = string_to_delta("2h")

            finally:

                log.removeFilter(warning_filter)

            self.assertTrue(getattr(warning_filter, "found", False))

 

class TestCmd(unittest.TestCase):

    """Abstract class for tests of command classes"""

    def setUp(self):

        testcase = self

        class MockClient(object):

            def __init__(self, name, **attributes):

                self.__dbus_object_path__ = "objpath_{}".format(name)

                self.attributes = attributes

                self.attributes["Name"] = name

                self.calls = []

            def Set(self, interface, property, value, dbus_interface):

                testcase.assertEqual(interface, client_interface)

                testcase.assertEqual(dbus_interface,

                                     dbus.PROPERTIES_IFACE)

                self.attributes[property] = value

                self.calls.append(("Set", (interface, property, value,

                                           dbus_interface)))

            def Get(self, interface, property, dbus_interface):

                testcase.assertEqual(interface, client_interface)

                testcase.assertEqual(dbus_interface,

                                     dbus.PROPERTIES_IFACE)

                self.calls.append(("Get", (interface, property,

                                           dbus_interface)))

                return self.attributes[property]

            def Approve(self, approve, dbus_interface):

                testcase.assertEqual(dbus_interface, client_interface)

                self.calls.append(("Approve", (approve,

                                               dbus_interface)))

        self.client = MockClient(

            "foo",

            KeyID=("92ed150794387c03ce684574b1139a65"

                   "94a34f895daaaf09fd8ea90a27cddb12"),

            Secret=b"secret",

            Host="foo.example.org",

            Enabled=dbus.Boolean(True),

            Timeout=300000,

            LastCheckedOK="2019-02-03T00:00:00",

            Created="2019-01-02T00:00:00",

            Interval=120000,

            Fingerprint=("778827225BA7DE539C5A"

                         "7CFA59CFF7CDBD9A5920"),

            CheckerRunning=dbus.Boolean(False),

            LastEnabled="2019-01-03T00:00:00",

            ApprovalPending=dbus.Boolean(False),

            ApprovedByDefault=dbus.Boolean(True),

            LastApprovalRequest="",

            ApprovalDelay=0,

            ApprovalDuration=1000,

            Checker="fping -q -- %(host)s",

            ExtendedTimeout=900000,

            Expires="2019-02-04T00:00:00",

            LastCheckerStatus=0)

        self.other_client = MockClient(

            "barbar",

            KeyID=("0558568eedd67d622f5c83b35a115f79"

                   "6ab612cff5ad227247e46c2b020f441c"),

            Secret=b"secretbar",

            Host="192.0.2.3",

            Enabled=dbus.Boolean(True),

            Timeout=300000,

            LastCheckedOK="2019-02-04T00:00:00",

            Created="2019-01-03T00:00:00",

            Interval=120000,

            Fingerprint=("3E393AEAEFB84C7E89E2"

                         "F547B3A107558FCA3A27"),

            CheckerRunning=dbus.Boolean(True),

            LastEnabled="2019-01-04T00:00:00",

            ApprovalPending=dbus.Boolean(False),

            ApprovedByDefault=dbus.Boolean(False),

            LastApprovalRequest="2019-01-03T00:00:00",

            ApprovalDelay=30000,

            ApprovalDuration=1000,

            Checker=":",

            ExtendedTimeout=900000,

            Expires="2019-02-05T00:00:00",

            LastCheckerStatus=-2)

        self.clients =  collections.OrderedDict(

            [

                (self.client, self.client.attributes),

                (self.other_client, self.other_client.attributes),

            ])

        self.one_client = {self.client: self.client.attributes}

 

class TestPrintTableCmd(TestCmd):

    def test_normal(self):

        output = PrintTableCmd().output(self.clients)

        expected_output = """

Name   Enabled Timeout  Last Successful Check

foo    Yes     00:05:00 2019-02-03T00:00:00  

barbar Yes     00:05:00 2019-02-04T00:00:00  

"""[1:-1]

        self.assertEqual(output, expected_output)

    def test_verbose(self):

        output = PrintTableCmd(verbose=True).output(self.clients)

        expected_output = """

Name   Enabled Timeout  Last Successful Check Created             Interval Host            Key ID                                                           Fingerprint                              Check Is Running Last Enabled        Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker              Extended Timeout Expires             Last Checker Status

foo    Yes     00:05:00 2019-02-03T00:00:00   2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No               2019-01-03T00:00:00 No                  Yes                                       00:00:00       00:00:01          fping -q -- %(host)s 00:15:00         2019-02-04T00:00:00 0                  

barbar Yes     00:05:00 2019-02-04T00:00:00   2019-01-03T00:00:00 00:02:00 192.0.2.3       0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes              2019-01-04T00:00:00 No                  No                  2019-01-03T00:00:00   00:00:30       00:00:01          :                    00:15:00         2019-02-05T00:00:00 -2                 

"""[1:-1]

        self.assertEqual(output, expected_output)

    def test_one_client(self):

        output = PrintTableCmd().output(self.one_client)

        expected_output = """

Name Enabled Timeout  Last Successful Check

foo  Yes     00:05:00 2019-02-03T00:00:00  

"""[1:-1]

        self.assertEqual(output, expected_output)

 

class TestDumpJSONCmd(TestCmd):

    def setUp(self):

        self.expected_json = {

            "foo": {

                "Name": "foo",

                "KeyID": ("92ed150794387c03ce684574b1139a65"

                          "94a34f895daaaf09fd8ea90a27cddb12"),

                "Host": "foo.example.org",

                "Enabled": True,

                "Timeout": 300000,

                "LastCheckedOK": "2019-02-03T00:00:00",

                "Created": "2019-01-02T00:00:00",

                "Interval": 120000,

                "Fingerprint": ("778827225BA7DE539C5A"

                                "7CFA59CFF7CDBD9A5920"),

                "CheckerRunning": False,

                "LastEnabled": "2019-01-03T00:00:00",

                "ApprovalPending": False,

                "ApprovedByDefault": True,

                "LastApprovalRequest": "",

                "ApprovalDelay": 0,

                "ApprovalDuration": 1000,

                "Checker": "fping -q -- %(host)s",

                "ExtendedTimeout": 900000,

                "Expires": "2019-02-04T00:00:00",

                "LastCheckerStatus": 0,

            },

            "barbar": {

                "Name": "barbar",

                "KeyID": ("0558568eedd67d622f5c83b35a115f79"

                          "6ab612cff5ad227247e46c2b020f441c"),

                "Host": "192.0.2.3",

                "Enabled": True,

                "Timeout": 300000,

                "LastCheckedOK": "2019-02-04T00:00:00",

                "Created": "2019-01-03T00:00:00",

                "Interval": 120000,

                "Fingerprint": ("3E393AEAEFB84C7E89E2"

                                "F547B3A107558FCA3A27"),

                "CheckerRunning": True,

                "LastEnabled": "2019-01-04T00:00:00",

                "ApprovalPending": False,

                "ApprovedByDefault": False,

                "LastApprovalRequest": "2019-01-03T00:00:00",

                "ApprovalDelay": 30000,

                "ApprovalDuration": 1000,

                "Checker": ":",

                "ExtendedTimeout": 900000,

                "Expires": "2019-02-05T00:00:00",

                "LastCheckerStatus": -2,

            },

        return super(TestDumpJSONCmd, self).setUp()

    def test_normal(self):

        json_data = json.loads(DumpJSONCmd().output(self.clients))

        self.assertDictEqual(json_data, self.expected_json)

    def test_one_client(self):

        clients = self.one_client

        json_data = json.loads(DumpJSONCmd().output(clients))

        expected_json = {"foo": self.expected_json["foo"]}

        self.assertDictEqual(json_data, expected_json)

 

class TestIsEnabledCmd(TestCmd):

    def test_is_enabled(self):

        self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)

                            for client, properties in self.clients.items()))

    def test_is_enabled_run_exits_successfully(self):

        with self.assertRaises(SystemExit) as e:

            IsEnabledCmd().run(None, self.one_client)

        if e.exception.code is not None:

            self.assertEqual(e.exception.code, 0)

        else:

            self.assertIsNone(e.exception.code)

    def test_is_enabled_run_exits_with_failure(self):

        self.client.attributes["Enabled"] = dbus.Boolean(False)

        with self.assertRaises(SystemExit) as e:

            IsEnabledCmd().run(None, self.one_client)

        if isinstance(e.exception.code, int):

            self.assertNotEqual(e.exception.code, 0)

        else:

            self.assertIsNotNone(e.exception.code)

 

class TestRemoveCmd(TestCmd):

    def test_remove(self):

        class MockMandos(object):

            def __init__(self):

                self.calls = []

            def RemoveClient(self, dbus_path):

                self.calls.append(("RemoveClient", (dbus_path,)))

        mandos = MockMandos()

        super(TestRemoveCmd, self).setUp()

        RemoveCmd().run(mandos, self.clients)

        self.assertEqual(len(mandos.calls), 2)

        for client in self.clients:

            self.assertIn(("RemoveClient",

                           (client.__dbus_object_path__,)),

                          mandos.calls)

 

class TestApproveCmd(TestCmd):

    def test_approve(self):

        ApproveCmd().run(None, self.clients)

        for client in self.clients:

            self.assertIn(("Approve", (True, client_interface)),

                          client.calls)

 

class TestDenyCmd(TestCmd):

    def test_deny(self):

        DenyCmd().run(None, self.clients)

        for client in self.clients:

            self.assertIn(("Approve", (False, client_interface)),

                          client.calls)

 

class TestEnableCmd(TestCmd):

    def test_enable(self):

        for client in self.clients:

            client.attributes["Enabled"] = False

 

        EnableCmd().run(None, self.clients)

 

        for client in self.clients:

            self.assertTrue(client.attributes["Enabled"])

 

class TestDisableCmd(TestCmd):

    def test_disable(self):

        DisableCmd().run(None, self.clients)

 

        for client in self.clients:

            self.assertFalse(client.attributes["Enabled"])