scanner-cli 0.1.0rc3__py3-none-any.whl

scanner_cli-0.1.0rc3.dist-info/METADATA

@@ -0,0 +1,65 @@
+Metadata-Version: 2.1
+Name: scanner-cli
+Version: 0.1.0rc3
+Summary: Python command-line interface for Scanner API
+Author: Scanner Inc.
+Author-email: support@scanner.dev
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: click (>=8.1.7,<9.0.0)
+Requires-Dist: scanner-client (>=0.1.0rc3,<0.2.0)
+Description-Content-Type: text/markdown
+
+# scanner-cli
+
+This is a Python CLI for the Scanner API.
+
+## Usage
+
+To install the CLI, run
+
+```
+pip install scanner-cli
+```
+
+You will need to provide the API URL of your Scanner instance and an API key. Go
+to *Settings > API Keys* to find your API URL and API key.
+
+You can either set these values as environment variables:
+
+```
+export SCANNER_API_URL=<your API URL>
+export SCANNER_API_KEY=<your API key>
+```
+
+or provide them as arguments to the CLI:
+
+```
+scanner-cli <command> --api-url=<your API url> --api-key=<your API key>
+```
+
+### Commands
+
+Available commands are
+- `run-tests` - run tests on detection rules as code
+- `validate` - validate detection rules as code
+
+To validate or run tests on files
+
+```
+scanner-cli <command> -f detections/src/errors.yaml -f detections/src/unauthorized_logins.yaml
+```
+
+To validate or run tests on directories
+
+```
+scanner-cli <command> -d detections/src
+```
+
+This will validate or run tests on all YAML files in the directory that have the correct schema header.
+
+A file or directory must be provided. Multiple files and/or directories can be provided.
+

scanner_cli-0.1.0rc3.dist-info/RECORD

@@ -0,0 +1,6 @@
+src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/cli.py,sha256=Hv5WA0LfmqgkT-9BRqcyUz2h8uTPEeeLkiPl3iy7saw,4398
+scanner_cli-0.1.0rc3.dist-info/METADATA,sha256=w4zNdQEMF6cJHXEi4bZvVqUNmgAp8O0e5o9mzKxg6x4,1624
+scanner_cli-0.1.0rc3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+scanner_cli-0.1.0rc3.dist-info/entry_points.txt,sha256=vqXMrIG6N6pY66bNf0y-gbUxbU8v5dXvuL3mV832Fh8,43
+scanner_cli-0.1.0rc3.dist-info/RECORD,,

scanner_cli-0.1.0rc3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any

scanner_cli-0.1.0rc3.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+scanner-cli=src.cli:cli
+

src/cli.py

@@ -0,0 +1,151 @@
+""" Contains code for Python CLI """
+
+import os
+from typing import Any, Callable
+
+import click
+
+from scanner_client import Scanner
+from scanner_client.detection_rule_yaml import validate_and_read_file
+
+_CLICK_OPTIONS = [
+    click.option(
+        "--api-url",
+        envvar="SCANNER_API_URL",
+        help="The API URL of your Scanner instance. Go to Settings > API Keys in Scanner to find your API URL.",
+    ),
+    click.option(
+        "--api-key",
+        envvar="SCANNER_API_KEY",
+        help="Scanner API key. Go to Settings > API Keys in Scanner to find your API keys or to create a new API key.",
+    ),
+    click.option(
+        "-f",
+        "--file",
+        "file_paths",
+        help="File to validate. This must be .yml or .yaml file with the correct schema header.",
+        multiple=True,
+    ),
+    click.option(
+        "-d",
+        "--dir",
+        "directories",
+        help="Directory to validate. Only .yml or .yaml files with the correct schema header will be validated.",
+        multiple=True,
+    ),
+]
+
+
+def _click_options(func) -> Callable[..., Any]:
+    for option in reversed(_CLICK_OPTIONS):
+        func = option(func)
+
+    return func
+
+
+def _is_valid_file(file_path: str) -> bool:
+    try:
+        validate_and_read_file(file_path)
+        return True
+    except:
+        return False
+
+
+def _get_valid_files_in_directory(directory: str) -> list[str]:
+    if not os.path.exists(directory):
+        raise click.exceptions.ClickException(
+            message=(
+                f"Directory {directory} not found."
+            )
+        )
+
+    return [f"{directory}/{f}" for f in os.listdir(directory) if _is_valid_file(f"{directory}/{f}")]
+
+
+def _get_valid_files(file_paths: str, directories: str) -> list[str]:
+    files = [f for f in file_paths if _is_valid_file(f)]
+
+    for d in directories:
+        files.extend(_get_valid_files_in_directory(d))
+
+    return files
+
+
+def _validate_shared_options(api_url: str, api_key: str, file_paths: str, directories: str) -> None:
+    if api_url is None:
+        raise click.exceptions.UsageError(
+            message=(
+                "Pass --api-url option or set `SCANNER_API_URL` environment variable."
+            )
+        )
+
+    if api_key is None:
+        raise click.exceptions.UsageError(
+            message=(
+                "Pass --api-key option or set `SCANNER_API_KEY` environment variable."
+            )
+        )
+
+    if not file_paths and not directories:
+        raise click.exceptions.UsageError(
+            message=(
+                "Either --file or --dir must be provided."
+            )
+        )
+
+
+@click.group()
+def cli():
+    """ Python CLI for Scanner API """
+
+
+@cli.command()
+@_click_options
+def validate(api_url: str, api_key: str, file_paths: str, directories: str):
+    """ Validate detection rules """
+    _validate_shared_options(api_url, api_key, file_paths, directories)
+
+    scanner_client = Scanner(api_url, api_key)
+
+    files = _get_valid_files(file_paths, directories)
+    click.echo(f'Validating {len(files)} {"file" if len(files) == 1 else "files"}')
+
+    for file in files:
+        result = scanner_client.detection_rule_yaml.validate(file)
+
+        if result.is_valid:
+            click.echo(f"{file}: " + click.style("Valid", fg="green"))
+        else:
+            click.echo(f"{file}: " + click.style(f"{result.error}", fg="red"))
+
+
+@cli.command()
+@_click_options
+def run_tests(api_url: str, api_key: str, file_paths: str, directories: str):
+    """ Run detection rule tests """
+    _validate_shared_options(api_url, api_key, file_paths, directories)
+
+    scanner_client = Scanner(api_url, api_key)
+
+    files = _get_valid_files(file_paths, directories)
+    click.echo(f'Running tests on {len(files)} {"file" if len(files) == 1 else "files"}')
+
+    for file in files:
+        response = scanner_client.detection_rule_yaml.run_tests(file)
+        results = response.results.to_dict()
+
+        click.secho(f"{file}", bold=True)
+        if len(results) == 0:
+            click.secho("No tests found", fg="yellow")
+        else:
+            for name, status in response.results.to_dict().items():
+                if status == "Passed":
+                    click.echo(f"{name}: " + click.style("Passed", fg="green"))
+                else:
+                    click.echo(f"{name}: " + click.style("Failed", fg="red"))
+
+        click.echo("")
+
+
+if __name__ == "__main__":
+    cli()