Package com.yubico.yubikit.core.fido

Class CtapException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.yubico.yubikit.core.application.CommandException

com.yubico.yubikit.core.fido.CtapException

All Implemented Interfaces:

Serializable

public class CtapException
extends CommandException

An error on the CTAP-level, returned from the Authenticator.

These error codes are defined by the CTAP2 Status codes

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	ERR_ACTION_TIMEOUT
static final byte	ERR_CBOR_UNEXPECTED_TYPE
static final byte	ERR_CHANNEL_BUSY
static final byte	ERR_CREDENTIAL_EXCLUDED
static final byte	ERR_EXTENSION_FIRST
static final byte	ERR_EXTENSION_LAST
static final byte	ERR_FP_DATABASE_FULL
static final byte	ERR_INTEGRITY_FAILURE
static final byte	ERR_INVALID_CBOR
static final byte	ERR_INVALID_CHANNEL
static final byte	ERR_INVALID_COMMAND
static final byte	ERR_INVALID_CREDENTIAL
static final byte	ERR_INVALID_LENGTH
static final byte	ERR_INVALID_OPTION
static final byte	ERR_INVALID_PARAMETER
static final byte	ERR_INVALID_SEQ
static final byte	ERR_INVALID_SUBCOMMAND
static final byte	ERR_KEEPALIVE_CANCEL
static final byte	ERR_KEY_STORE_FULL
static final byte	ERR_LARGE_BLOB_STORAGE_FULL
static final byte	ERR_LIMIT_EXCEEDED
static final byte	ERR_LOCK_REQUIRED
static final byte	ERR_MISSING_PARAMETER
static final byte	ERR_NO_CREDENTIALS
static final byte	ERR_NO_OPERATION_PENDING
static final byte	ERR_NO_OPERATIONS
static final byte	ERR_NOT_ALLOWED
static final byte	ERR_NOT_BUSY
static final byte	ERR_OPERATION_DENIED
static final byte	ERR_OPERATION_PENDING
static final byte	ERR_OTHER
static final byte	ERR_PIN_AUTH_BLOCKED
static final byte	ERR_PIN_AUTH_INVALID
static final byte	ERR_PIN_BLOCKED
static final byte	ERR_PIN_INVALID
static final byte	ERR_PIN_NOT_SET
static final byte	ERR_PIN_POLICY_VIOLATION
static final byte	ERR_PIN_TOKEN_EXPIRED
static final byte	ERR_PROCESSING
static final byte	ERR_PUAT_REQUIRED
static final byte	ERR_REQUEST_TOO_LARGE
static final byte	ERR_SPEC_LAST
static final byte	ERR_SUCCESS
static final byte	ERR_TIMEOUT
static final byte	ERR_UNAUTHORIZED_PERMISSION
static final byte	ERR_UNSUPPORTED_ALGORITHM
static final byte	ERR_UNSUPPORTED_EXTENSION
static final byte	ERR_UNSUPPORTED_OPTION
static final byte	ERR_UP_REQUIRED
static final byte	ERR_USER_ACTION_PENDING
static final byte	ERR_USER_ACTION_TIMEOUT
static final byte	ERR_UV_BLOCKED
static final byte	ERR_UV_INVALID
static final byte	ERR_VENDOR_FIRST
static final byte	ERR_VENDOR_LAST

Constructor Summary

Constructors

Constructor	Description
CtapException(byte ctapError)	Constructs a new CtapException with the specified CTAP error code.

Method Summary

Modifier and Type	Method	Description
byte	getCtapError()	Returns the CTAP error code associated with this exception.
String	getErrorName()	Returns the name of the CTAP error associated with this exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ERR_SUCCESS

public static final byte ERR_SUCCESS

See Also:

• Constant Field Values

ERR_INVALID_COMMAND

public static final byte ERR_INVALID_COMMAND

See Also:

• Constant Field Values

ERR_INVALID_PARAMETER

public static final byte ERR_INVALID_PARAMETER

See Also:

• Constant Field Values

ERR_INVALID_LENGTH

public static final byte ERR_INVALID_LENGTH

See Also:

• Constant Field Values

ERR_INVALID_SEQ

public static final byte ERR_INVALID_SEQ

See Also:

• Constant Field Values

ERR_TIMEOUT

public static final byte ERR_TIMEOUT

See Also:

• Constant Field Values

ERR_CHANNEL_BUSY

public static final byte ERR_CHANNEL_BUSY

See Also:

• Constant Field Values

ERR_LOCK_REQUIRED

public static final byte ERR_LOCK_REQUIRED

See Also:

• Constant Field Values

ERR_INVALID_CHANNEL

public static final byte ERR_INVALID_CHANNEL

See Also:

• Constant Field Values

ERR_CBOR_UNEXPECTED_TYPE

public static final byte ERR_CBOR_UNEXPECTED_TYPE

See Also:

• Constant Field Values

ERR_INVALID_CBOR

public static final byte ERR_INVALID_CBOR

See Also:

• Constant Field Values

ERR_MISSING_PARAMETER

public static final byte ERR_MISSING_PARAMETER

See Also:

• Constant Field Values

ERR_LIMIT_EXCEEDED

public static final byte ERR_LIMIT_EXCEEDED

See Also:

• Constant Field Values

ERR_UNSUPPORTED_EXTENSION

public static final byte ERR_UNSUPPORTED_EXTENSION

See Also:

• Constant Field Values

ERR_FP_DATABASE_FULL

public static final byte ERR_FP_DATABASE_FULL

See Also:

• Constant Field Values

ERR_LARGE_BLOB_STORAGE_FULL

public static final byte ERR_LARGE_BLOB_STORAGE_FULL

See Also:

• Constant Field Values

ERR_CREDENTIAL_EXCLUDED

public static final byte ERR_CREDENTIAL_EXCLUDED

See Also:

• Constant Field Values

ERR_PROCESSING

public static final byte ERR_PROCESSING

See Also:

• Constant Field Values

ERR_INVALID_CREDENTIAL

public static final byte ERR_INVALID_CREDENTIAL

See Also:

• Constant Field Values

ERR_USER_ACTION_PENDING

public static final byte ERR_USER_ACTION_PENDING

See Also:

• Constant Field Values

ERR_OPERATION_PENDING

public static final byte ERR_OPERATION_PENDING

See Also:

• Constant Field Values

ERR_NO_OPERATIONS

public static final byte ERR_NO_OPERATIONS

See Also:

• Constant Field Values

ERR_UNSUPPORTED_ALGORITHM

public static final byte ERR_UNSUPPORTED_ALGORITHM

See Also:

• Constant Field Values

ERR_OPERATION_DENIED

public static final byte ERR_OPERATION_DENIED

See Also:

• Constant Field Values

ERR_KEY_STORE_FULL

public static final byte ERR_KEY_STORE_FULL

See Also:

• Constant Field Values

ERR_NOT_BUSY

public static final byte ERR_NOT_BUSY

See Also:

• Constant Field Values

ERR_NO_OPERATION_PENDING

public static final byte ERR_NO_OPERATION_PENDING

See Also:

• Constant Field Values

ERR_UNSUPPORTED_OPTION

public static final byte ERR_UNSUPPORTED_OPTION

See Also:

• Constant Field Values

ERR_INVALID_OPTION

public static final byte ERR_INVALID_OPTION

See Also:

• Constant Field Values

ERR_KEEPALIVE_CANCEL

public static final byte ERR_KEEPALIVE_CANCEL

See Also:

• Constant Field Values

ERR_NO_CREDENTIALS

public static final byte ERR_NO_CREDENTIALS

See Also:

• Constant Field Values

ERR_USER_ACTION_TIMEOUT

public static final byte ERR_USER_ACTION_TIMEOUT

See Also:

• Constant Field Values

ERR_NOT_ALLOWED

public static final byte ERR_NOT_ALLOWED

See Also:

• Constant Field Values

ERR_PIN_INVALID

public static final byte ERR_PIN_INVALID

See Also:

• Constant Field Values

ERR_PIN_BLOCKED

public static final byte ERR_PIN_BLOCKED

See Also:

• Constant Field Values

ERR_PIN_AUTH_INVALID

public static final byte ERR_PIN_AUTH_INVALID

See Also:

• Constant Field Values

ERR_PIN_AUTH_BLOCKED

public static final byte ERR_PIN_AUTH_BLOCKED

See Also:

• Constant Field Values

ERR_PIN_NOT_SET

public static final byte ERR_PIN_NOT_SET

See Also:

• Constant Field Values

ERR_PUAT_REQUIRED

public static final byte ERR_PUAT_REQUIRED

See Also:

• Constant Field Values

ERR_PIN_POLICY_VIOLATION

public static final byte ERR_PIN_POLICY_VIOLATION

See Also:

• Constant Field Values

ERR_PIN_TOKEN_EXPIRED

public static final byte ERR_PIN_TOKEN_EXPIRED

See Also:

• Constant Field Values

ERR_REQUEST_TOO_LARGE

public static final byte ERR_REQUEST_TOO_LARGE

See Also:

• Constant Field Values

ERR_ACTION_TIMEOUT

public static final byte ERR_ACTION_TIMEOUT

See Also:

• Constant Field Values

ERR_UP_REQUIRED

public static final byte ERR_UP_REQUIRED

See Also:

• Constant Field Values

ERR_UV_BLOCKED

public static final byte ERR_UV_BLOCKED

See Also:

• Constant Field Values

ERR_INTEGRITY_FAILURE

public static final byte ERR_INTEGRITY_FAILURE

See Also:

• Constant Field Values

ERR_INVALID_SUBCOMMAND

public static final byte ERR_INVALID_SUBCOMMAND

See Also:

• Constant Field Values

ERR_UV_INVALID

public static final byte ERR_UV_INVALID

See Also:

• Constant Field Values

ERR_UNAUTHORIZED_PERMISSION

public static final byte ERR_UNAUTHORIZED_PERMISSION

See Also:

• Constant Field Values

ERR_OTHER

public static final byte ERR_OTHER

See Also:

• Constant Field Values

ERR_SPEC_LAST

public static final byte ERR_SPEC_LAST

See Also:

• Constant Field Values

ERR_EXTENSION_FIRST

public static final byte ERR_EXTENSION_FIRST

See Also:

• Constant Field Values

ERR_EXTENSION_LAST

public static final byte ERR_EXTENSION_LAST

See Also:

• Constant Field Values

ERR_VENDOR_FIRST

public static final byte ERR_VENDOR_FIRST

See Also:

• Constant Field Values

ERR_VENDOR_LAST

public static final byte ERR_VENDOR_LAST

See Also:

• Constant Field Values

Constructor Details

CtapException

public CtapException(byte ctapError)

Constructs a new CtapException with the specified CTAP error code.

Parameters:

ctapError - the CTAP error code returned from the authenticator

Method Details

getCtapError

public byte getCtapError()

Returns the CTAP error code associated with this exception.

Returns:

the CTAP error code

getErrorName

public String getErrorName()

Returns the name of the CTAP error associated with this exception.

Returns:

the CTAP error name as a String