vck-openid/at.asitplus.wallet.lib.oidvci/OAuth2Exception

OAuth2Exception

@Serializable

sealed class OAuth2Exception : Throwable(source)

OAuth2/OIDC error representation for issuer and wallet flows. Use to model protocol errors and serialize them for responses.

Inheritors

Types

AccessDenied

@Serializable

class AccessDenied(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

CredentialRequestDenied

@Serializable

class CredentialRequestDenied(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

InvalidAuthorizationDetails

@Serializable

class InvalidAuthorizationDetails(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

InvalidClient

@Serializable

class InvalidClient(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

InvalidCode

@Serializable

class InvalidCode(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

InvalidCredentialRequest

@Serializable

class InvalidCredentialRequest(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

InvalidDpopProof

@Serializable

class InvalidDpopProof(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception, OAuthAuthorizationError

InvalidEncryptionParameters

@Serializable

class InvalidEncryptionParameters(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

InvalidGrant

@Serializable

class InvalidGrant(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

InvalidNonce

@Serializable

class InvalidNonce(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

InvalidProof

@Serializable

class InvalidProof(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

InvalidRequest

@Serializable

class InvalidRequest(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

RFC6750: The request is missing a required parameter, includes an unsupported parameter or parameter value, repeats the same parameter, uses more than one method for including an access token, or is otherwise malformed. The resource server SHOULD respond with the HTTP 400 (Bad Request) status code.

InvalidScope

@Serializable

class InvalidScope(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

InvalidToken

@Serializable

class InvalidToken(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception, OAuthAuthorizationError

RFC6750: The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.

InvalidTransactionData

@Serializable

class InvalidTransactionData(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

OpenID4VP 1.0 section 8.5: invalid transaction data, including missing or unmatched credential_ids.

RegistrationValueNotSupported

@Serializable

class RegistrationValueNotSupported(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

UnknownCredentialConfiguration

@Serializable

class UnknownCredentialConfiguration(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

UnknownCredentialIdentifier

@Serializable

class UnknownCredentialIdentifier(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

UnsupportedGrantType

@Serializable

class UnsupportedGrantType(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

RFC 6749 5.2: The authorization grant type is not supported by the authorization server.

UseAttestationChallenge

@Serializable

class UseAttestationChallenge(val attestationChallenge: String, val description: String? = null, val cause: Throwable? = null) : OAuth2Exception, OAuthAuthorizationError

UseDpopNonce

@Serializable

class UseDpopNonce(val dpopNonce: String, val description: String? = null, val cause: Throwable? = null) : OAuth2Exception, OAuthAuthorizationError

UseFreshAttestation

@Serializable

class UseFreshAttestation(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

UserCancelled

@Serializable

class UserCancelled(val description: String? = null, val cause: Throwable? = null) : OAuth2Exception

Properties

cause

expect open val cause: Throwable?

error

val error: String

errorDescription

@Transient

val errorDescription: String?

message

expect open val message: String?

Functions

serialize

fun serialize(): String

toHttpResponse

fun OAuth2Exception.toHttpResponse(): PreparedHttpResponse

Converts this error of an authorization server endpoint (pushed authorization request, token, token introspection, attestation challenge, authorization) to the response to send: status 400 with the toOAuth2Error as JSON (RFC 6749 5.2), including the header DPoP-Nonce for OAuth2Exception.UseDpopNonce (RFC 9449 8.) and OAuth-Client-Attestation-Challenge for OAuth2Exception.UseAttestationChallenge (OA-ABCA 7.4).

toOAuth2Error

fun toOAuth2Error(): OAuth2Error

toOAuth2Error

fun Throwable.toOAuth2Error(request: RequestParametersFrom<*>): OAuth2Error

fun Throwable.toOAuth2Error(state: String?): OAuth2Error

toResourceServerHttpResponse

fun OAuth2Exception.toResourceServerHttpResponse(authorizationHeader: String?): PreparedHttpResponse

Converts this error of a resource endpoint accessed with an access token (credential, userinfo) to the response to send, with the toOAuth2Error as JSON: