scanner-client 0.1.0__py3-none-any.whl

scanner_client/__init__.py

@@ -0,0 +1,77 @@
+# "X as X" marks each name as an explicit re-export (PEP 484) so type checkers
+# treat it as part of this module's public API.
+#
+# For renamed re-exports, we import under a private name and declare a TypeAlias,
+# which also creates an explicit public module-level binding.
+# TODO: switch renamed re-exports to `type X = Y` syntax once we target Python 3.12+.
+from typing import TypeAlias
+
+from .scanner import Scanner as Scanner, AsyncScanner as AsyncScanner
+from .detection_rule import string_to_detection_severity as string_to_detection_severity, \
+	pagination_parameters as pagination_parameters, \
+	starting_permissions_for_detection_rule as starting_permissions_for_detection_rule, \
+	DetectionSeverity as DetectionSeverity
+from .event_sink import create_pagerduty_event_sink_args as create_pagerduty_event_sink_args, \
+	create_slack_event_sink_args as create_slack_event_sink_args, \
+	create_webhook_event_sink_args as create_webhook_event_sink_args, \
+	update_pagerduty_event_sink_args as update_pagerduty_event_sink_args, \
+	update_slack_event_sink_args as update_slack_event_sink_args, \
+	update_webhook_event_sink_args as update_webhook_event_sink_args
+from .http_err import NotFound as NotFound
+
+# Detection rule types
+from ._raw_api.models import (
+	DeleteDetectionRuleResponseData as DeleteDetectionRuleResponseData,
+	DetectionAlertTemplate as DetectionAlertTemplate,
+	DetectionRule as _DetectionRule,
+	DetectionRuleSortOrder as DetectionRuleSortOrder,
+	DetectionRuleSummary as DetectionRuleSummary,
+	ListDetectionRulesResponseData as ListDetectionRulesResponseData,
+	ListResponseWithPaginationForListDetectionRulesResponseData as ListResponseWithPaginationForListDetectionRulesResponseData,
+	PaginationMetadata as PaginationMetadata,
+	PaginationParameters as PaginationParameters,
+	RbacDetectionRulePermissionType as RbacDetectionRulePermissionType,
+	TemplateEntry as TemplateEntry,
+)
+DetectionRuleJson: TypeAlias = _DetectionRule
+
+# Detection rule YAML types
+from ._raw_api.models import (
+	TestResult as _TestResult,
+	RunDetectionRuleYamlTestsResponseData as RunDetectionRuleYamlTestsResponseData,
+	RunDetectionRuleYamlTestsResponseDataResults as RunDetectionRuleYamlTestsResponseDataResults,
+	ValidateDetectionRuleYamlResponseData as ValidateDetectionRuleYamlResponseData,
+)
+DetectionRuleYamlTestResult: TypeAlias = _TestResult
+
+# Event sink types
+from ._raw_api.models import (
+	DeleteEventSinkResponseData as DeleteEventSinkResponseData,
+	EventSink as _EventSink,
+	EventSinkType as EventSinkType,
+)
+EventSinkJson: TypeAlias = _EventSink
+
+# Adhoc query types
+from ._raw_api.models import (
+	AdHocQueryProgressMetadata as AdHocQueryProgressMetadata,
+	AdHocQueryProgressResponse as AdHocQueryProgressResponse,
+	AdHocRowItem as AdHocRowItem,
+	AdHocTableResult as AdHocTableResult,
+	LogEventIdJson as _LogEventIdJson,
+	StartAdHocQueryResponse as StartAdHocQueryResponse,
+	TableUiStateType as TableUiStateType,
+)
+LogEventId: TypeAlias = _LogEventIdJson
+
+# GitHub sync types
+from ._raw_api.models import (
+	DetectionRuleSyncStatus as DetectionRuleSyncStatus,
+	SyncGithubReposResponseData as SyncGithubReposResponseData,
+	UploadGitRepoZipballFailure as UploadGitRepoZipballFailure,
+	UploadGitRepoZipballResponseData as UploadGitRepoZipballResponseData,
+	UploadGitRepoZipballWarning as UploadGitRepoZipballWarning,
+)
+
+# Misc types
+from ._raw_api.types import Unset as Unset, UNSET as UNSET

scanner_client/_raw_api/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing scnr-api"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

scanner_client/_raw_api/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

scanner_client/_raw_api/api/detection_rule/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

scanner_client/_raw_api/api/detection_rule/create_detection_rule.py

@@ -0,0 +1,172 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.create_detection_rule_request_data import CreateDetectionRuleRequestData
+from ...models.get_detection_rule_response_data import GetDetectionRuleResponseData
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: CreateDetectionRuleRequestData,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/detection_rule",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> GetDetectionRuleResponseData | None:
+    if response.status_code == 200:
+        response_200 = GetDetectionRuleResponseData.from_dict(response.json())
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[GetDetectionRuleResponseData]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: CreateDetectionRuleRequestData,
+) -> Response[GetDetectionRuleResponseData]:
+    """Create a new detection rule with the specified data.
+
+     If the detection rule is active, it will be immediately scheduled for
+    backfill and execution.
+
+    Args:
+        body (CreateDetectionRuleRequestData):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[GetDetectionRuleResponseData]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: CreateDetectionRuleRequestData,
+) -> GetDetectionRuleResponseData | None:
+    """Create a new detection rule with the specified data.
+
+     If the detection rule is active, it will be immediately scheduled for
+    backfill and execution.
+
+    Args:
+        body (CreateDetectionRuleRequestData):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        GetDetectionRuleResponseData
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: CreateDetectionRuleRequestData,
+) -> Response[GetDetectionRuleResponseData]:
+    """Create a new detection rule with the specified data.
+
+     If the detection rule is active, it will be immediately scheduled for
+    backfill and execution.
+
+    Args:
+        body (CreateDetectionRuleRequestData):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[GetDetectionRuleResponseData]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    body: CreateDetectionRuleRequestData,
+) -> GetDetectionRuleResponseData | None:
+    """Create a new detection rule with the specified data.
+
+     If the detection rule is active, it will be immediately scheduled for
+    backfill and execution.
+
+    Args:
+        body (CreateDetectionRuleRequestData):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        GetDetectionRuleResponseData
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

scanner_client/_raw_api/api/detection_rule/delete_detection_rule.py

@@ -0,0 +1,155 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+from uuid import UUID
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.delete_detection_rule_response_data import DeleteDetectionRuleResponseData
+from ...types import Response
+
+
+def _get_kwargs(
+    id: UUID,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/v1/detection_rule/{id}".format(
+            id=quote(str(id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> DeleteDetectionRuleResponseData | None:
+    if response.status_code == 200:
+        response_200 = DeleteDetectionRuleResponseData.from_dict(response.json())
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[DeleteDetectionRuleResponseData]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[DeleteDetectionRuleResponseData]:
+    """Delete the detection rule with the given id.
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[DeleteDetectionRuleResponseData]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> DeleteDetectionRuleResponseData | None:
+    """Delete the detection rule with the given id.
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        DeleteDetectionRuleResponseData
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[DeleteDetectionRuleResponseData]:
+    """Delete the detection rule with the given id.
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[DeleteDetectionRuleResponseData]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> DeleteDetectionRuleResponseData | None:
+    """Delete the detection rule with the given id.
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        DeleteDetectionRuleResponseData
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed

scanner_client/_raw_api/api/detection_rule/get_detection_rule.py

@@ -0,0 +1,155 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+from uuid import UUID
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.get_detection_rule_response_data import GetDetectionRuleResponseData
+from ...types import Response
+
+
+def _get_kwargs(
+    id: UUID,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/detection_rule/{id}".format(
+            id=quote(str(id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> GetDetectionRuleResponseData | None:
+    if response.status_code == 200:
+        response_200 = GetDetectionRuleResponseData.from_dict(response.json())
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[GetDetectionRuleResponseData]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[GetDetectionRuleResponseData]:
+    """Get the detection rule with the provided id.
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[GetDetectionRuleResponseData]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> GetDetectionRuleResponseData | None:
+    """Get the detection rule with the provided id.
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        GetDetectionRuleResponseData
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[GetDetectionRuleResponseData]:
+    """Get the detection rule with the provided id.
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[GetDetectionRuleResponseData]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> GetDetectionRuleResponseData | None:
+    """Get the detection rule with the provided id.
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        GetDetectionRuleResponseData
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed