cribl-control-plane 0.0.13__py3-none-any.whl

cribl_control_plane/__init__.py

@@ -0,0 +1,17 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from ._version import (
+    __title__,
+    __version__,
+    __openapi_doc_version__,
+    __gen_version__,
+    __user_agent__,
+)
+from .sdk import *
+from .sdkconfiguration import *
+
+
+VERSION: str = __version__
+OPENAPI_DOC_VERSION = __openapi_doc_version__
+SPEAKEASY_GENERATOR_VERSION = __gen_version__
+USER_AGENT = __user_agent__

cribl_control_plane/_hooks/__init__.py

@@ -0,0 +1,5 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .sdkhooks import *
+from .types import *
+from .registration import *

cribl_control_plane/_hooks/clientcredentials.py

@@ -0,0 +1,211 @@
+import hashlib
+import os
+import httpx
+import time
+from .types import (
+    SDKInitHook,
+    BeforeRequestContext,
+    BeforeRequestHook,
+    AfterErrorContext,
+    AfterErrorHook,
+    HookContext,
+)
+from typing import Any, Dict, List, Tuple, Union, Optional
+from urllib.parse import urlparse, urljoin
+from cribl_control_plane.httpclient import HttpClient
+from cribl_control_plane.sdkconfiguration import SDKConfiguration
+
+
+class Credentials:
+    client_id: str
+    client_secret: str
+    token_url: str
+    audience: str
+
+    def __init__(self, client_id: str, client_secret: str, token_url: str):
+        self.client_id = client_id
+        self.client_secret = client_secret
+        self.token_url = token_url
+        self.audience = os.getenv("CRIBLCONTROLPLANE_AUDIENCE", "https://api.cribl.cloud") # Set default audience here
+
+
+class Session:
+    credentials: Credentials
+    token: str
+    scopes: Optional[List[str]] = None
+    expires_at: Optional[int] = None
+
+    def __init__(
+        self,
+        credentials: Credentials,
+        token: str,
+        scopes: Optional[List[str]] = None,
+        expires_at: Optional[int] = None,
+    ):
+        self.credentials = credentials
+        self.token = token
+        self.scopes = scopes
+        self.expires_at = expires_at
+
+
+class ClientCredentialsHook(SDKInitHook, BeforeRequestHook, AfterErrorHook):
+    client: HttpClient
+    sessions: Dict[str, Session] = {}
+
+    def sdk_init(self, config: SDKConfiguration) -> SDKConfiguration:
+        if config.client is None:
+            raise Exception("Client is required")
+
+        self.client = config.client
+        return config
+
+    def before_request(
+        self, hook_ctx: BeforeRequestContext, request: httpx.Request
+    ) -> httpx.Request:
+        if hook_ctx.oauth2_scopes is None:
+            # OAuth2 not in use
+            return request
+
+        credentials = self.get_credentials(hook_ctx)
+        if credentials is None:
+            return request
+
+        session_key = self.get_session_key(
+            credentials.client_id, credentials.client_secret
+        )
+
+        if (
+            session_key not in self.sessions
+            or not self.has_required_scopes(
+                self.sessions[session_key].scopes, hook_ctx.oauth2_scopes
+            )
+            or self.has_token_expired(self.sessions[session_key].expires_at)
+        ):
+            sess = self.do_token_request(
+                hook_ctx,
+                credentials,
+                self.get_scopes(hook_ctx.oauth2_scopes, self.sessions.get(session_key)),
+            )
+
+            self.sessions[session_key] = sess
+
+        request.headers["Authorization"] = f"Bearer {self.sessions[session_key].token}"
+
+        return request
+
+    def after_error(
+        self,
+        hook_ctx: AfterErrorContext,
+        response: Optional[httpx.Response],
+        error: Optional[Exception],
+    ) -> Union[Tuple[Optional[httpx.Response], Optional[Exception]], Exception]:
+        if hook_ctx.oauth2_scopes is None:
+            # OAuth2 not in use
+            return (response, error)
+
+        # We don't want to refresh the token if the error is not related to the token
+        if error is not None:
+            return (response, error)
+
+        credentials = self.get_credentials(hook_ctx)
+        if credentials is None:
+            return (response, error)
+
+        if response is not None and response.status_code == 401:
+            session_key = self.get_session_key(
+                credentials.client_id, credentials.client_secret
+            )
+
+            if session_key in self.sessions:
+                del self.sessions[session_key]
+
+        return (response, error)
+
+    def get_credentials(self, hook_ctx: HookContext) -> Optional[Credentials]:
+        source = hook_ctx.security_source
+
+        if source is None:
+            return None
+
+        security = source() if callable(source) else source
+
+        return self.get_credentials_global(security)
+
+    def get_credentials_global(self, security: Any) -> Optional[Credentials]:
+        if security is None or security.client_oauth is None:
+            return None
+
+        return Credentials(
+            client_id=security.client_oauth.client_id,
+            client_secret=security.client_oauth.client_secret,
+            token_url=security.client_oauth.token_url,
+        )
+
+    def do_token_request(
+        self,
+        hook_ctx: HookContext,
+        credentials: Credentials,
+        scopes: Optional[List[str]],
+    ) -> Session:
+        payload = {
+            "grant_type": "client_credentials",
+            "client_id": credentials.client_id,
+            "client_secret": credentials.client_secret,
+        }
+
+        if credentials.audience is not None:
+            payload["audience"] = credentials.audience
+
+        if scopes is not None and len(scopes) > 0:
+            payload["scope"] = " ".join(scopes)
+
+        token_url = credentials.token_url
+        if not bool(urlparse(credentials.token_url).netloc):
+            token_url = urljoin(hook_ctx.base_url, credentials.token_url)
+        response = self.client.send(
+            self.client.build_request(method="POST", url=token_url, data=payload)
+        )
+
+        if response.status_code < 200 or response.status_code >= 300:
+            raise Exception(
+                f"Unexpected status code {response.status_code} from token endpoint"
+            )
+
+        response_data = response.json()
+
+        if response_data.get("token_type") != "Bearer":
+            raise Exception("Unexpected token type from token endpoint")
+
+        expires_at = None
+        if "expires_in" in response_data:
+            expires_at = int(time.time()) + response_data.get("expires_in")
+
+        return Session(
+            credentials=credentials,
+            token=response_data.get("access_token"),
+            scopes=scopes,
+            expires_at=expires_at,
+        )
+
+    def get_session_key(self, client_id: str, client_secret: str) -> str:
+        return hashlib.md5(f"{client_id}:{client_secret}".encode()).hexdigest()
+
+    def has_required_scopes(
+        self, scopes: Optional[List[str]], required_scopes: List[str]
+    ) -> bool:
+        if scopes is None:
+            return False
+
+        return all(scope in scopes for scope in required_scopes)
+
+    def get_scopes(
+        self, required_scopes: List[str], sess: Optional[Session]
+    ) -> List[str]:
+        scopes = required_scopes.copy()
+        if sess is not None and sess.scopes is not None:
+            scopes.extend(sess.scopes)
+            scopes = list(set(scopes))
+        return scopes
+
+    def has_token_expired(self, expires_at: Optional[int]) -> bool:
+        return expires_at is None or time.time() + 60 >= expires_at

cribl_control_plane/_hooks/registration.py

@@ -0,0 +1,13 @@
+from .types import Hooks
+
+
+# This file is only ever generated once on the first generation and then is free to be modified.
+# Any hooks you wish to add should be registered in the init_hooks function. Feel free to define them
+# in this file or in separate files in the hooks folder.
+
+
+def init_hooks(hooks: Hooks):
+    # pylint: disable=unused-argument
+    """Add hooks by calling hooks.register{sdk_init/before_request/after_success/after_error}Hook
+    with an instance of a hook that implements that specific Hook interface
+    Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance"""

cribl_control_plane/_hooks/sdkhooks.py

@@ -0,0 +1,81 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import httpx
+from .clientcredentials import ClientCredentialsHook
+from .types import (
+    SDKInitHook,
+    BeforeRequestContext,
+    BeforeRequestHook,
+    AfterSuccessContext,
+    AfterSuccessHook,
+    AfterErrorContext,
+    AfterErrorHook,
+    Hooks,
+)
+from .registration import init_hooks
+from typing import List, Optional, Tuple
+from cribl_control_plane.sdkconfiguration import SDKConfiguration
+
+
+class SDKHooks(Hooks):
+    def __init__(self) -> None:
+        self.sdk_init_hooks: List[SDKInitHook] = []
+        self.before_request_hooks: List[BeforeRequestHook] = []
+        self.after_success_hooks: List[AfterSuccessHook] = []
+        self.after_error_hooks: List[AfterErrorHook] = []
+        client_credentials = ClientCredentialsHook()
+        self.sdk_init_hooks.append(client_credentials)
+        self.before_request_hooks.append(client_credentials)
+        self.after_error_hooks.append(client_credentials)
+        init_hooks(self)
+
+    def register_sdk_init_hook(self, hook: SDKInitHook) -> None:
+        self.sdk_init_hooks.append(hook)
+
+    def register_before_request_hook(self, hook: BeforeRequestHook) -> None:
+        self.before_request_hooks.append(hook)
+
+    def register_after_success_hook(self, hook: AfterSuccessHook) -> None:
+        self.after_success_hooks.append(hook)
+
+    def register_after_error_hook(self, hook: AfterErrorHook) -> None:
+        self.after_error_hooks.append(hook)
+
+    def sdk_init(self, config: SDKConfiguration) -> SDKConfiguration:
+        for hook in self.sdk_init_hooks:
+            config = hook.sdk_init(config)
+        return config
+
+    def before_request(
+        self, hook_ctx: BeforeRequestContext, request: httpx.Request
+    ) -> httpx.Request:
+        for hook in self.before_request_hooks:
+            out = hook.before_request(hook_ctx, request)
+            if isinstance(out, Exception):
+                raise out
+            request = out
+
+        return request
+
+    def after_success(
+        self, hook_ctx: AfterSuccessContext, response: httpx.Response
+    ) -> httpx.Response:
+        for hook in self.after_success_hooks:
+            out = hook.after_success(hook_ctx, response)
+            if isinstance(out, Exception):
+                raise out
+            response = out
+        return response
+
+    def after_error(
+        self,
+        hook_ctx: AfterErrorContext,
+        response: Optional[httpx.Response],
+        error: Optional[Exception],
+    ) -> Tuple[Optional[httpx.Response], Optional[Exception]]:
+        for hook in self.after_error_hooks:
+            result = hook.after_error(hook_ctx, response, error)
+            if isinstance(result, Exception):
+                raise result
+            response, error = result
+        return response, error

cribl_control_plane/_hooks/types.py

@@ -0,0 +1,112 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from abc import ABC, abstractmethod
+from cribl_control_plane.sdkconfiguration import SDKConfiguration
+import httpx
+from typing import Any, Callable, List, Optional, Tuple, Union
+
+
+class HookContext:
+    config: SDKConfiguration
+    base_url: str
+    operation_id: str
+    oauth2_scopes: Optional[List[str]] = None
+    security_source: Optional[Union[Any, Callable[[], Any]]] = None
+
+    def __init__(
+        self,
+        config: SDKConfiguration,
+        base_url: str,
+        operation_id: str,
+        oauth2_scopes: Optional[List[str]],
+        security_source: Optional[Union[Any, Callable[[], Any]]],
+    ):
+        self.config = config
+        self.base_url = base_url
+        self.operation_id = operation_id
+        self.oauth2_scopes = oauth2_scopes
+        self.security_source = security_source
+
+
+class BeforeRequestContext(HookContext):
+    def __init__(self, hook_ctx: HookContext):
+        super().__init__(
+            hook_ctx.config,
+            hook_ctx.base_url,
+            hook_ctx.operation_id,
+            hook_ctx.oauth2_scopes,
+            hook_ctx.security_source,
+        )
+
+
+class AfterSuccessContext(HookContext):
+    def __init__(self, hook_ctx: HookContext):
+        super().__init__(
+            hook_ctx.config,
+            hook_ctx.base_url,
+            hook_ctx.operation_id,
+            hook_ctx.oauth2_scopes,
+            hook_ctx.security_source,
+        )
+
+
+class AfterErrorContext(HookContext):
+    def __init__(self, hook_ctx: HookContext):
+        super().__init__(
+            hook_ctx.config,
+            hook_ctx.base_url,
+            hook_ctx.operation_id,
+            hook_ctx.oauth2_scopes,
+            hook_ctx.security_source,
+        )
+
+
+class SDKInitHook(ABC):
+    @abstractmethod
+    def sdk_init(self, config: SDKConfiguration) -> SDKConfiguration:
+        pass
+
+
+class BeforeRequestHook(ABC):
+    @abstractmethod
+    def before_request(
+        self, hook_ctx: BeforeRequestContext, request: httpx.Request
+    ) -> Union[httpx.Request, Exception]:
+        pass
+
+
+class AfterSuccessHook(ABC):
+    @abstractmethod
+    def after_success(
+        self, hook_ctx: AfterSuccessContext, response: httpx.Response
+    ) -> Union[httpx.Response, Exception]:
+        pass
+
+
+class AfterErrorHook(ABC):
+    @abstractmethod
+    def after_error(
+        self,
+        hook_ctx: AfterErrorContext,
+        response: Optional[httpx.Response],
+        error: Optional[Exception],
+    ) -> Union[Tuple[Optional[httpx.Response], Optional[Exception]], Exception]:
+        pass
+
+
+class Hooks(ABC):
+    @abstractmethod
+    def register_sdk_init_hook(self, hook: SDKInitHook):
+        pass
+
+    @abstractmethod
+    def register_before_request_hook(self, hook: BeforeRequestHook):
+        pass
+
+    @abstractmethod
+    def register_after_success_hook(self, hook: AfterSuccessHook):
+        pass
+
+    @abstractmethod
+    def register_after_error_hook(self, hook: AfterErrorHook):
+        pass

cribl_control_plane/_version.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import importlib.metadata
+
+__title__: str = "cribl-control-plane"
+__version__: str = "0.0.13"
+__openapi_doc_version__: str = "4.14.0-alpha.1753295778758-ebd92ad1"
+__gen_version__: str = "2.660.0"
+__user_agent__: str = "speakeasy-sdk/python 0.0.13 2.660.0 4.14.0-alpha.1753295778758-ebd92ad1 cribl-control-plane"
+
+try:
+    if __package__ is not None:
+        __version__ = importlib.metadata.version(__package__)
+except importlib.metadata.PackageNotFoundError:
+    pass

cribl_control_plane/auth_sdk.py

@@ -0,0 +1,184 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from cribl_control_plane import errors, models, utils
+from cribl_control_plane._hooks import HookContext
+from cribl_control_plane.types import OptionalNullable, UNSET
+from cribl_control_plane.utils.unmarshal_json_response import unmarshal_json_response
+from typing import Mapping, Optional
+
+
+class AuthSDK(BaseSDK):
+    r"""Actions related to authentication. Do not use the /auth endpoints in Cribl.Cloud deployments. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to authenticate for Cribl.Cloud."""
+
+    def login(
+        self,
+        *,
+        username: str,
+        password: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.AuthToken:
+        r"""Log in and obtain Auth token
+
+        This endpoint is unavailable on Cribl.Cloud. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
+
+        :param username:
+        :param password:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.LoginInfo(
+            username=username,
+            password=password,
+        )
+
+        req = self._build_request(
+            method="POST",
+            path="/auth/login",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            request_has_query_params=False,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.LoginInfo
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="login",
+                oauth2_scopes=[],
+                security_source=None,
+            ),
+            request=req,
+            error_status_codes=["401", "403", "429", "4XX", "5XX"],
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.AuthToken, http_res)
+        if utils.match_response(http_res, ["401", "403", "429", "4XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    async def login_async(
+        self,
+        *,
+        username: str,
+        password: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.AuthToken:
+        r"""Log in and obtain Auth token
+
+        This endpoint is unavailable on Cribl.Cloud. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
+
+        :param username:
+        :param password:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.LoginInfo(
+            username=username,
+            password=password,
+        )
+
+        req = self._build_request_async(
+            method="POST",
+            path="/auth/login",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            request_has_query_params=False,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.LoginInfo
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="login",
+                oauth2_scopes=[],
+                security_source=None,
+            ),
+            request=req,
+            error_status_codes=["401", "403", "429", "4XX", "5XX"],
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.AuthToken, http_res)
+        if utils.match_response(http_res, ["401", "403", "429", "4XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)