EntityStorageKeyFactory Class

Centralized factory for generating entity storage keys with consistent formatting. Provides standardized key generation for all OIDC storage entities.

public class EntityStorageKeyFactory : Abblix.Oidc.Server.Features.Storages.IEntityStorageKeyFactory

Inheritance System.Object → EntityStorageKeyFactory

Implements IEntityStorageKeyFactory

Methods

EntityStorageKeyFactory.AuthorizationRequestKey(Uri) Method

Generates a storage key for an authorization request by URI.

public string AuthorizationRequestKey(System.Uri requestUri);

Parameters

requestUri System.Uri

The pushed authorization request URI.

Implements AuthorizationRequestKey(Uri)

Returns

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

EntityStorageKeyFactory.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.

public 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.

Implements AuthorizationValueReuseKey(string, string, string)

Returns

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

EntityStorageKeyFactory.AuthorizedGrantKey(string) Method

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

public string AuthorizedGrantKey(string authorizationCode);

Parameters

authorizationCode System.String

The OAuth 2.0 authorization code.

Implements AuthorizedGrantKey(string)

Returns

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

EntityStorageKeyFactory.BackChannelAuthenticationRequestKey(string) Method

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

public string BackChannelAuthenticationRequestKey(string requestId);

Parameters

requestId System.String

The CIBA authentication request identifier.

Implements BackChannelAuthenticationRequestKey(string)

Returns

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

EntityStorageKeyFactory.DeviceAuthorizationRequestKey(string) Method

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

public string DeviceAuthorizationRequestKey(string deviceCode);

Parameters

deviceCode System.String

The device code identifier.

Implements DeviceAuthorizationRequestKey(string)

Returns

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

EntityStorageKeyFactory.DeviceAuthorizationUserCodeKey(string) Method

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

public string DeviceAuthorizationUserCodeKey(string userCode);

Parameters

userCode System.String

The user-friendly verification code.

Implements DeviceAuthorizationUserCodeKey(string)

Returns

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

EntityStorageKeyFactory.IpRateLimitKey(string) Method

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

public string IpRateLimitKey(string clientIdentifier);

Parameters

clientIdentifier System.String

The client identifier (typically IP address).

Implements IpRateLimitKey(string)

Returns

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

EntityStorageKeyFactory.JsonWebTokenStatusKey(string) Method

Generates a storage key for JWT status by JWT ID.

public string JsonWebTokenStatusKey(string jwtId);

Parameters

jwtId System.String

The JSON Web Token identifier.

Implements JsonWebTokenStatusKey(string)

Returns

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

EntityStorageKeyFactory.RegistrationAccessTokenKey(string) Method

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

public string RegistrationAccessTokenKey(string clientId);

Parameters

clientId System.String

The identifier of the registered client.

Implements RegistrationAccessTokenKey(string)

Returns

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

EntityStorageKeyFactory.UserCodeRateLimitKey(string) Method

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

public string UserCodeRateLimitKey(string userCode);

Parameters

userCode System.String

The user code being verified.

Implements UserCodeRateLimitKey(string)

Returns

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