Aller au contenu

La version 0.1.0 est une première version, à l'essai. Voir ce qui n'est pas prouvé →

bogolang
EN

← Exemples

audit_rules

Vérifie cinq règles maison sur des configurations enregistrées et affiche les contrôles qui ont échoué.

Vérifie cinq règles maison (SSH seulement sur les lignes vty, mots de passe chiffrés, un serveur de journaux, un serveur NTP, une description sur chaque port utilisé) sur les configurations enregistrées de trois équipements. Il affiche un tableau des vérifications qui ont échoué, avec le test qui était faux. Aucun équipement n'est contacté.

bogo run audit_rules.bogo
bogo test audit_rules.bogo

Pour l'utiliser sur votre propre réseau :

  • Listez vos équipements dans devices.csv (name, ip, platform, role).
  • Mettez une configuration enregistrée de chacun dans configs, nommée <name>.cfg, par exemple vos sauvegardes de chaque nuit.
  • Écrivez vos propres règles. Chaque ligne sous rule est un test qui doit être vrai.
  • Sans configs="configs", audit() lit chaque équipement lui-même par SSH : il se connecte vraiment, avec les identifiants enregistrés par bogo login.
audit_rules.bogo
edition 2027
"""A few house rules, checked against saved configurations. No device is contacted."""


class AuditRules:
    """Each rule is a list of tests, one per line. A device fails a rule at the first
    test that is false. The configurations are read from the folder configs."""

    @staticmethod
    def ssh_only(vty: Section) -> bool:
        """True when this vty block lets in SSH and nothing else."""
        return vty.find("transport input") == ["transport input ssh"]

    @staticmethod
    def undescribed(c: Config) -> list[str]:
        """The interfaces that are not shut down and have no description."""
        return [str(i.name) for i in c.interfaces if not i.shutdown and i.description == ""]

    rule "vty takes ssh only" for d:
        config.section("line vty") != []
        all(AuditRules.ssh_only(v) for v in config.section("line vty"))

    rule "passwords are encrypted" for d:
        config.has("service password-encryption")

    rule "logs go to a server" for d:
        config.has("logging host")

    rule "clock from ntp" for d:
        config.has("ntp server")

    rule "ports in use are described" for d where d.role == "switch":
        AuditRules.undescribed(config) == []

    @staticmethod
    def main(args: list[str]) -> None:
        devices: list[Device] = inventory("devices.csv")
        result: AuditResult = audit(devices, configs="configs")
        if result.passed:
            print(f"All {len(result.rows)} checks passed.")
            return
        table(result.failed, ["device", "rule", "detail"])
        print()
        print(f"{len(result.failed)} of {len(result.rows)} checks failed.")
        for d in devices:
            c: Config = load_config(f"configs/{d.name}.cfg", platform=d.platform)
            if AuditRules.undescribed(c):
                print(f"{d.name}: no description on {', '.join(AuditRules.undescribed(c))}")


class TestAuditRules:
    def config(self, text: str) -> Config:
        return Config(Device(name="t", ip=192.0.2.1, platform="iosxe"), text, "")

    def test_telnet_on_a_vty_is_caught(self) -> None:
        c: Config = self.config(
            "line vty 0 4\n transport input ssh\nline vty 5 15\n transport input ssh telnet\n"
        )
        answers: list[bool] = [AuditRules.ssh_only(v) for v in c.section("line vty")]
        assert answers == [True, False]

    def test_a_vty_with_no_transport_line_is_not_ssh_only(self) -> None:
        c: Config = self.config("line vty 0 4\n exec-timeout 5 0\n")
        assert not AuditRules.ssh_only(c.section("line vty")[0])

    def test_shut_ports_need_no_description(self) -> None:
        c: Config = self.config(
            "interface Gi1/0/1\n description up\n!\ninterface Gi1/0/2\n shutdown\n!\n"
            "interface Gi1/0/3\n switchport access vlan 10\n!\n"
        )
        assert AuditRules.undescribed(c) == ["Gi1/0/3"]