request.authentication¶

Initialization for the authentication step of the request pipeline.

Submodules¶

Classes¶

`AuthenticationComponent`	Abstract base class for authentication components.
`ClientCertificateAuthentication`	Handles authentication via client certificates.
`CompositeAuthentication`	Composite authenticator for grouping and executing multiple authentication methods.
`IDevIDAuthentication`	Handles authentication via IDevID certificates.
`CmpAuthentication`	Composite authenticator specifically for CMP requests, combining various authentication methods.
`EstAuthentication`	Composite authenticator specifically for EST requests, combining various authentication methods.

Package Contents¶

class request.authentication.AuthenticationComponent[source]¶

Bases: abc.ABC

Abstract base class for authentication components.

abstractmethod authenticate(context)[source]¶

Authenticate a request using specific logic.

Parameters:: context (request.request_context.BaseRequestContext)
Return type:: devices.models.DeviceModel | None

class request.authentication.ClientCertificateAuthentication[source]¶

Bases: AuthenticationComponent, trustpoint.logger.LoggerMixin

Handles authentication via client certificates.

authenticate(context)[source]¶

Authenticate using the client certificate from the context.

Parameters:: context (request.request_context.BaseRequestContext)
Return type:: None

_raise_certificate_error(message, cause=None)[source]¶

Raise certificate authentication error with proper exception chaining.

Parameters:

message (str)
cause (Exception | None)

Return type:

Never

class request.authentication.CompositeAuthentication[source]¶

Bases: AuthenticationComponent, trustpoint.logger.LoggerMixin

Composite authenticator for grouping and executing multiple authentication methods.

components: list[AuthenticationComponent] = []¶

add(component)[source]¶

Add an authentication component to the composite.

Parameters:: component (AuthenticationComponent)
Return type:: None

remove(component)[source]¶

Remove an authentication component from the composite.

Parameters:: component (AuthenticationComponent)
Return type:: None

authenticate(context)[source]¶

Authenticate the request using all registered components.

Parameters:: context (request.request_context.BaseRequestContext)
Return type:: None

class request.authentication.IDevIDAuthentication[source]¶

Bases: AuthenticationComponent, trustpoint.logger.LoggerMixin

Handles authentication via IDevID certificates.

authenticate(context)[source]¶

Authenticate the request using the IDevID mechanism.

Parameters:: context (request.request_context.BaseRequestContext)
Return type:: None

_raise_idevid_error(message)[source]¶

Raise IDevID authentication error.

Parameters:: message (str)
Return type:: Never

class request.authentication.CmpAuthentication[source]¶

Bases: request.authentication.base.CompositeAuthentication

Composite authenticator specifically for CMP requests, combining various authentication methods.

class request.authentication.EstAuthentication[source]¶

Bases: request.authentication.base.CompositeAuthentication

Composite authenticator specifically for EST requests, combining various authentication methods.