Skip to main content

IEntityStorageKeyFactory Interface

Abblix.Oidc.Server​

Abblix.Oidc.Server.Features.Storages​

IEntityStorageKeyFactory Interface​

Defines a contract for generating entity storage keys with consistent formatting. Provides standardized key generation for all OIDC storage entities.

public interface IEntityStorageKeyFactory

Derived
↳ EntityStorageKeyFactory

Methods​

IEntityStorageKeyFactory.AuthorizationRequestKey(Uri) Method​

Generates a storage key for an authorization request by URI.

string AuthorizationRequestKey(System.Uri requestUri);

Parameters​

requestUri System.Uri​

The pushed authorization request URI.

Returns​

System.String
A formatted storage key for the authorization request.

IEntityStorageKeyFactory.AuthorizationValueReuseKey(string, string, string) Method​

Generates a storage key for reuse detection of an authorization request value (a PKCE code_challenge or an OpenID Connect nonce), scoped to a client and the value's kind.

string AuthorizationValueReuseKey(string clientId, string valueKind, string valueHash);

Parameters​

clientId System.String​

The client the value belongs to.

valueKind System.String​

A discriminator for the value's role, so distinct kinds never collide.

valueHash System.String​

A hash of the value; the raw value is never part of the key.

Returns​

System.String
A formatted storage key for the recorded value.

IEntityStorageKeyFactory.AuthorizedGrantKey(string) Method​

Generates a storage key for an authorized grant by authorization code.

string AuthorizedGrantKey(string authorizationCode);

Parameters​

authorizationCode System.String​

The OAuth 2.0 authorization code.

Returns​

System.String
A formatted storage key for the authorization grant.

IEntityStorageKeyFactory.BackChannelAuthenticationRequestKey(string) Method​

Generates a storage key for a backchannel authentication request by request ID.

string BackChannelAuthenticationRequestKey(string requestId);

Parameters​

requestId System.String​

The CIBA authentication request identifier.

Returns​

System.String
A formatted storage key for the backchannel authentication request.

IEntityStorageKeyFactory.DeviceAuthorizationRequestKey(string) Method​

Generates a storage key for a device authorization request by device code.

string DeviceAuthorizationRequestKey(string deviceCode);

Parameters​

deviceCode System.String​

The device code identifier.

Returns​

System.String
A formatted storage key for the device authorization request.

IEntityStorageKeyFactory.DeviceAuthorizationUserCodeKey(string) Method​

Generates a storage key for mapping a user code to its device code.

string DeviceAuthorizationUserCodeKey(string userCode);

Parameters​

userCode System.String​

The user-friendly verification code.

Returns​

System.String
A formatted storage key for the user code mapping.

IEntityStorageKeyFactory.IpRateLimitKey(string) Method​

Generates a storage key for rate limiting by IP address or client identifier.

string IpRateLimitKey(string clientIdentifier);

Parameters​

clientIdentifier System.String​

The client identifier (typically IP address).

Returns​

System.String
A formatted storage key for the IP rate limit state.

IEntityStorageKeyFactory.JsonWebTokenStatusKey(string) Method​

Generates a storage key for JWT status by JWT ID.

string JsonWebTokenStatusKey(string jwtId);

Parameters​

jwtId System.String​

The JSON Web Token identifier.

Returns​

System.String
A formatted storage key for the JWT status.

IEntityStorageKeyFactory.RegistrationAccessTokenKey(string) Method​

Generates a storage key for the registration access token binding of a client (RFC 7592).

string RegistrationAccessTokenKey(string clientId);

Parameters​

clientId System.String​

The identifier of the registered client.

Returns​

System.String
A formatted storage key for the client's current registration-access-token jti.

IEntityStorageKeyFactory.UserCodeRateLimitKey(string) Method​

Generates a storage key for rate limiting user code verification attempts.

string UserCodeRateLimitKey(string userCode);

Parameters​

userCode System.String​

The user code being verified.

Returns​

System.String
A formatted storage key for the user code rate limit state.