Package io.hanko.sdk.webauthn

Class HankoWebAuthnClient

java.lang.Object

io.hanko.sdk.webauthn.HankoWebAuthnClient

public class HankoWebAuthnClient
extends Object

Main client type for performing registration, authentication, transactions and credential management.

Constructor Summary

Constructors

Constructor	Description
HankoWebAuthnClient(HankoClientConfig hankoClientConfig)	Construct a HankoWebAuthnClient.
HankoWebAuthnClient(HankoClientConfig hankoClientConfig, org.apache.http.impl.client.CloseableHttpClient httpClient)	Construct a HankoWebAuthnClient using a custom underlying CloseableHttpClient.
HankoWebAuthnClient(HankoHttpClient httpClient)	Construct a HankoWebAuthnClient using a custom HankoHttpClient.

Method Summary

Modifier and Type	Method	Description
boolean	deleteCredential(String credentialId)	Deletes the WebAuthnCredential with the specified credentialId.
FinalizationResponse	finalizeAuthentication(String webAuthnResponse)	Finalizes an authentication using the response from the WebAuthn API's navigator.credentials.get() call.
FinalizationResponse	finalizeRegistration(String webAuthnResponse)	Finalizes a registration using the response from the WebAuthn API's navigator.credentials.create() call.
FinalizationResponse	finalizeTransaction(String webAuthnResponse)	Finalizes the transaction request using the response from the WebAuthn API's navigator.credentials.get() call.
WebAuthnCredential	getCredential(String credentialId)	Retrieves the registered WebAuthnCredential with the specified credentialId.
String	initializeAuthentication(AuthenticationInitializationRequest request)	Initializes an authentication with a registered credential using an AuthenticationInitializationRequest.
String	initializeRegistration(RegistrationInitializationRequest request)	Initializes the registration of a new credential using a RegistrationInitializationRequest.
String	initializeTransaction(TransactionInitializationRequest request)	Initializes a transaction.
List<WebAuthnCredential>	listCredentials(CredentialQuery query)	Retrieves a list of registered WebAuthnCredentials.
WebAuthnCredential	updateCredential(String credentialId, CredentialUpdateRequest request)	Updates the WebAuthnCredential with the specified credentialId.

Methods inherited from class java.lang.Object

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

Constructor Details

HankoWebAuthnClient

public HankoWebAuthnClient(HankoClientConfig hankoClientConfig)

Construct a HankoWebAuthnClient.

Parameters:

hankoClientConfig - non-null, the HankoClientConfig

HankoWebAuthnClient

public HankoWebAuthnClient(HankoClientConfig hankoClientConfig,
 org.apache.http.impl.client.CloseableHttpClient httpClient)

Construct a HankoWebAuthnClient using a custom underlying CloseableHttpClient.

Parameters:

hankoClientConfig - non-null, the HankoClientConfig

httpClient - the custom CloseableHttpClient

HankoWebAuthnClient

public HankoWebAuthnClient(HankoHttpClient httpClient)

Construct a HankoWebAuthnClient using a custom HankoHttpClient.

Parameters:

httpClient - the custom HankoHttpClient

Method Details

initializeRegistration

public String initializeRegistration(RegistrationInitializationRequest request)

Initializes the registration of a new credential using a RegistrationInitializationRequest. On successful initialization, the Hanko Authentication API returns a stringified JSON representation of the CredentialCreationOptions for use with the WebAuthn API's navigator.credentials.create() function.

Parameters:

request - the RegistrationInitializationRequest

Returns:

the CredentialCreationOptions as a String

Throws:

HankoClientException - on serialization/deserialization errors

HankoApiConnectionException - on Hanko API connection failure

HankoAuthenticationException - on unauthorized Hanko API call

finalizeRegistration

public FinalizationResponse finalizeRegistration(String webAuthnResponse)

Finalizes a registration using the response from the WebAuthn API's navigator.credentials.create() call.

Parameters:

webAuthnResponse - the WebAuthn API response

Returns:

the FinalizationResponse

Throws:

HankoClientException - on serialization/deserialization errors

HankoApiConnectionException - on Hanko API connection failure

HankoAuthenticationException - on unauthorized Hanko API call

initializeAuthentication

public String initializeAuthentication(AuthenticationInitializationRequest request)

Initializes an authentication with a registered credential using an AuthenticationInitializationRequest. On successful initialization, the Hanko Authentication API returns a stringified JSON representation of the CredentialRequestOptions for use with the WebAuthn API's navigator.credentials.get() function.

Parameters:

request - the AuthenticationInitializationRequest

Returns:

the String

Throws:

HankoClientException - on serialization/deserialization errors

HankoApiConnectionException - on Hanko API connection failure

HankoAuthenticationException - on unauthorized Hanko API call

finalizeAuthentication

public FinalizationResponse finalizeAuthentication(String webAuthnResponse)

Finalizes an authentication using the response from the WebAuthn API's navigator.credentials.get() call.

Parameters:

webAuthnResponse - the WebAuthn API response as a String

Returns:

the FinalizationResponse

Throws:

HankoClientException - on serialization/deserialization errors

HankoApiConnectionException - on Hanko API connection failure

HankoAuthenticationException - on unauthorized Hanko API call

initializeTransaction

public String initializeTransaction(TransactionInitializationRequest request)

Initializes a transaction. A transaction operation is analogous to the authentication operation, with the main difference being that a transaction context must be provided in the form of a string. This value will become part of the challenge an authenticator signs over during the operation.

Initialize a transaction using a TransactionInitializationRequest. On successful initialization, the Hanko Authentication API returns a stringified JSON representation of the CredentialRequestOptions for use with the WebAuthn API's navigator.credentials.get() function.

Parameters:

request - the TransactionInitializationRequest

Returns:

the CredentialRequestOptions as a String

Throws:

HankoClientException - on serialization/deserialization errors

HankoApiConnectionException - on Hanko API connection failure

HankoAuthenticationException - on unauthorized Hanko API call

finalizeTransaction

public FinalizationResponse finalizeTransaction(String webAuthnResponse)

Finalizes the transaction request using the response from the WebAuthn API's navigator.credentials.get() call.

Parameters:

webAuthnResponse - the WebAuthn API response as a String

Returns:

a FinalizationResponse

Throws:

HankoClientException - on serialization/deserialization errors

HankoApiConnectionException - on Hanko API connection failure

HankoAuthenticationException - on unauthorized Hanko API call

getCredential

public WebAuthnCredential getCredential(String credentialId)

Retrieves the registered WebAuthnCredential with the specified credentialId.

Parameters:

credentialId - the id of the credential to retrieve

Returns:

the WebAuthnCredential

Throws:

HankoClientException - on serialization/deserialization errors

HankoApiConnectionException - on Hanko API connection failure

HankoAuthenticationException - on unauthorized Hanko API call

HankoNotFoundException - if no credential was found

listCredentials

public List<WebAuthnCredential> listCredentials(CredentialQuery query)

Retrieves a list of registered WebAuthnCredentials.

Credentials can be filtered by userId and results paginated using a CredentialQuery. If the CredentialQuery is null or if any of its values are null, retrieval defaults to searching for credentials for all users with page equal to 1 and page size equal to 10.

Parameters:

query - the CredentialQuery, nullable

Returns:

the list of registered WebAuthnCredentials

Throws:

HankoClientException - on serialization/deserialization errors

HankoApiConnectionException - on Hanko API connection failure

HankoAuthenticationException - on unauthorized Hanko API call

deleteCredential

public boolean deleteCredential(String credentialId)

Deletes the WebAuthnCredential with the specified credentialId.

Parameters:

credentialId - the id of the credential to delete

Returns:

true if deletion was successful, otherwise false

Throws:

HankoClientException - on serialization/deserialization errors

HankoApiConnectionException - on Hanko API connection failure

HankoAuthenticationException - on unauthorized Hanko API call

HankoNotFoundException - if no credential was found

updateCredential

public WebAuthnCredential updateCredential(String credentialId,
 CredentialUpdateRequest request)

Updates the WebAuthnCredential with the specified credentialId. Provide a CredentialUpdateRequest with the updated data. Currently, you can only update the name of a Credential.

Parameters:

credentialId - the id of the credential to update

request - the CredentialUpdateRequest

Returns:

the updated WebAuthnCredential

Throws:

HankoClientException - on serialization/deserialization errors

HankoApiConnectionException - on Hanko API connection failure

HankoAuthenticationException - on unauthorized Hanko API call