| | |
- builtins.object
-
- builtins.AuthorizeResult
- builtins.AuthorizeResultResponse
- builtins.BootstrapConfig
- builtins.Cedarling
- builtins.Decision
- builtins.Diagnostics
- builtins.EntityData
- builtins.PolicyEvaluationError
- builtins.Request
- builtins.RequestUnsigned
class AuthorizeResultResponse(object) |
| |
AuthorizeResultResponse
=======================
A Python wrapper for the Rust `cedar_policy::Response` struct.
Represents the result of an authorization request.
Attributes
----------
:param decision: The authorization decision (wrapped `Decision` object).
:param diagnostics: Additional information on the decision (wrapped `Diagnostics` object).
|
| |
Static methods defined here:
- __new__(*args, **kwargs)
- Create and return a new object. See help(type) for accurate signature.
Data descriptors defined here:
- decision
- Authorization decision
- diagnostics
- Diagnostics providing more information on how this decision was reached
|
class BootstrapConfig(object) |
| |
BootstrapConfig(options)
BootstrapConfig
=========
A Python wrapper for the Rust `cedarling::BootstrapConfig` struct.
Configures the `Cedarling` application, including authorization, logging, and policy store settings.
Methods
-------
.. method:: __init__(self, options)
Initializes the Cedarling instance with the provided configuration.
:param options: A `dict` with startup settings.
.. method:: load_from_file(str) -> BootstrapConfig
Loads the bootstrap config from a file.
:returns: A BootstrapConfig instance
:raises ValueError: If a provided value is invalid or decoding fails.
:raises OSError: If there is an error reading while the file.
.. method:: load_from_json(str) -> BootstrapConfig
Loads the bootstrap config from a JSON string.
:returns: A BootstrapConfig instance
:raises ValueError: If a provided value is invalid or decoding fails.
.. method:: from_env(config=None) -> BootstrapConfig
Loads the bootstrap config from environment variables, optionally merging with provided config.
:param config: Optional dictionary with additional configuration to merge with environment variables.
:returns: A BootstrapConfig instance
:raises ValueError: If a provided value is invalid or decoding fails.
|
| |
Static methods defined here:
- __new__(*args, **kwargs)
- Create and return a new object. See help(type) for accurate signature.
- from_env(config=None)
- load_from_file(path)
- load_from_json(config_json)
|
class Cedarling(object) |
| |
Cedarling(config)
Cedarling
=========
A Python wrapper for the Rust `cedarling::Cedarling` struct.
Represents an instance of the Cedarling application, a local authorization service
that answers authorization questions based on JWT tokens.
Attributes
----------
:param config: A `BootstrapConfig` object for initializing the Cedarling instance.
Methods
-------
.. method:: __init__(self, config)
Initializes the Cedarling instance with the provided configuration.
:param config: A `BootstrapConfig` object with startup settings.
.. method:: authorize(self, request: Request) -> AuthorizeResult
Execute authorize request
:param request: Request struct for authorize.
.. method:: pop_logs(self) -> List[dict]
Retrieves and removes all logs from storage.
:returns: A list of log entries as Python objects.
.. method:: get_log_by_id(self, id: str) -> dict|None
Gets a log entry by its ID.
:param id: The log entry ID.
.. method:: get_log_ids(self) -> List[str]
Retrieves all stored log IDs.
.. method:: get_logs_by_tag(self, tag: str) -> List[dict]
Retrieves all logs matching a specific tag. Tags can be 'log_kind', 'log_level' params from log entries.
:param tag: A string specifying the tag type.
:returns: A list of log entries filtered by the tag, each converted to a Python dictionary.
.. method:: get_logs_by_request_id(self, id: str) -> List[dict]
Retrieves log entries associated with a specific request ID. Each log entry is converted to a Python dictionary containing fields like 'id', 'timestamp', and 'message'.
:param id: The unique identifier for the request.
:returns: A list of dictionaries, each representing a log entry related to the specified request ID.
.. method:: get_logs_by_request_id_and_tag(self, id: str, tag: str) -> List[dict]
Retrieves all logs associated with a specific request ID and tag. The tag can be 'log_kind', 'log_level' params from log entries.
:param id: The request ID as a string.
:param tag: The tag type as a string.
:returns: A list of log entries matching both the request ID and tag, each converted to a Python dictionary.
.. method:: shut_down(self)
Closes the connections to the Lock Server and pushes all available logs.
|
| |
Methods defined here:
- authorize(self, /, request)
- Authorize request
- authorize_unsigned(self, /, request)
- Authorize request with unsigned data.
- get_log_by_id(self, /, id)
- Get specific log entry
- get_log_ids(self, /)
- Returns a list of all log ids
- get_logs_by_request_id(self, /, request_id)
- Returns a list of log entries by request id.
- get_logs_by_request_id_and_tag(self, /, id, tag)
- Returns a list of all log entries by request id and tag.
Tag can be `log_kind`, `log_level`.
- get_logs_by_tag(self, /, tag)
- Returns a list of log entries by tag.
Tag can be `log_kind`, `log_level`.
- pop_logs(self, /)
- Return logs and remove them from the storage
- shut_down(self, /)
- Closes the connections to the Lock Server and pushes all available logs.
Static methods defined here:
- __new__(*args, **kwargs)
- Create and return a new object. See help(type) for accurate signature.
|
class Decision(object) |
| |
Decision
========
Represents the decision result of a Cedar policy authorization.
Methods
-------
value() -> str
Returns the string value of the decision.
__str__() -> str
Returns the string representation of the decision.
__repr__() -> str
Returns the detailed type representation of the decision.
__eq__(other: Decision) -> bool
Compares two `Decision` objects for equality.
|
| |
Methods defined here:
- __eq__(self, value, /)
- Return self==value.
- __ge__(self, value, /)
- Return self>=value.
- __gt__(self, value, /)
- Return self>value.
- __le__(self, value, /)
- Return self<=value.
- __lt__(self, value, /)
- Return self<value.
- __ne__(self, value, /)
- Return self!=value.
- __repr__(self, /)
- Return repr(self).
- __str__(self, /)
- Return str(self).
Static methods defined here:
- __new__(*args, **kwargs)
- Create and return a new object. See help(type) for accurate signature.
Data descriptors defined here:
- value
- get the value of the decision
Data and other attributes defined here:
- __hash__ = None
|
class Diagnostics(object) |
| |
Diagnostics
===========
Provides detailed information about how a policy decision was made, including policies that contributed to the decision and any errors encountered during evaluation.
Attributes
----------
reason : set of str
A set of `PolicyId`s for the policies that contributed to the decision. If no policies applied, this set is empty.
errors : list of PolicyEvaluationError
A list of errors that occurred during the authorization process. These are unordered as policies may be evaluated in any order.
|
| |
Static methods defined here:
- __new__(*args, **kwargs)
- Create and return a new object. See help(type) for accurate signature.
Data descriptors defined here:
- errors
- Errors that occurred during authorization. The errors should be
treated as unordered, since policies may be evaluated in any order.
- reason
- `PolicyId`s of the policies that contributed to the decision.
If no policies applied to the request, this set will be empty.
|
class EntityData(object) |
| |
EntityData(entity_type, id, **kwargs)
EntityData
============
A Python wrapper for the Rust `cedarling::EntityData` struct. This class represents
a resource entity with a type, ID, and attributes. Attributes are stored as a payload
in a dictionary format.
Attributes
----------
:param entity_type: Type of the entity.
:param id: ID of the entity.
:param payload: Optional dictionary of attributes.
Methods
-------
.. method:: __init__(self, entity_type: str, id: str, **kwargs: dict)
Initialize a new EntityData. In kwargs the payload is a dictionary of entity attributes.
.. method:: from_dict(cls, value: dict) -> EntityData
Initialize a new EntityData from a dictionary.
To pass `entity_type` you need to use `type` key.
|
| |
Class methods defined here:
- from_dict(value)
- method to build a resource data object from a python dictionary
Static methods defined here:
- __new__(*args, **kwargs)
- Create and return a new object. See help(type) for accurate signature.
Data descriptors defined here:
- entity_type
- entity type name
- id
- entity id
- payload
- setter for payload attribute
|
class PolicyEvaluationError(object) |
| |
PolicyEvaluationError
=====================
Represents an error that occurred when evaluating a Cedar policy.
Attributes
----------
id : str
The ID of the policy that caused the error.
error : str
The error message describing the evaluation failure.
|
| |
Static methods defined here:
- __new__(*args, **kwargs)
- Create and return a new object. See help(type) for accurate signature.
Data descriptors defined here:
- error
- Underlying evaluation error string representation
- id
- Id of the policy with an error
|
class Request(object) |
| |
Request(tokens, action, resource, context)
Request
=======
A Python wrapper for the Rust `cedarling::Request` struct. Represents
authorization data with access token, action, resource, and context.
Attributes
----------
:param tokens: A class containing the JWTs what will be used for the request.
:param action: The action to be authorized.
:param resource: Resource data (wrapped `EntityData` object).
:param context: Python dictionary with additional context.
Example
-------
```python
# Create a request for authorization
request = Request(access_token="token123", action="read", resource=resource, context={})
```
|
| |
Static methods defined here:
- __new__(*args, **kwargs)
- Create and return a new object. See help(type) for accurate signature.
Data descriptors defined here:
- action
- cedar_policy action
- context
- context to be used in cedar_policy
- resource
- cedar_policy resource data
- tokens
|
class RequestUnsigned(object) |
| |
RequestUnsigned(principals, action, resource, context)
Request
=======
A Python wrapper for the Rust `cedarling::RequestUnsigned` struct. Represents
authorization data for unsigned authorization requests for many principals.
Attributes
----------
:param principals: A list of `EntityData` objects representing the principals.
:param action: The action to be authorized.
:param resource: Resource data (wrapped `ResourceData` object).
:param context: Python dictionary with additional context.
Example
-------
```python
# Create a request for authorization
request = Request(principals=[principal], action="read", resource=resource, context={})
```
|
| |
Static methods defined here:
- __new__(*args, **kwargs)
- Create and return a new object. See help(type) for accurate signature.
Data descriptors defined here:
- action
- cedar_policy action
- context
- context to be used in cedar_policy
- principals
- resource
- cedar_policy resource data
| |