com.yubico.webauthn.StartRegistrationOptions Maven / Gradle / Ivy
Show all versions of webauthn-server-core Show documentation
// Copyright (c) 2018, Yubico AB
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.yubico.webauthn;
import com.yubico.webauthn.data.AuthenticatorSelectionCriteria;
import com.yubico.webauthn.data.PublicKeyCredentialCreationOptions;
import com.yubico.webauthn.data.RegistrationExtensionInputs;
import com.yubico.webauthn.data.UserIdentity;
import java.util.Optional;
import lombok.Builder;
import lombok.NonNull;
import lombok.Value;
/** Parameters for {@link RelyingParty#startRegistration(StartRegistrationOptions)}. */
@Value
@Builder(toBuilder = true)
public class StartRegistrationOptions {
/** Identifiers for the user creating a credential. */
@NonNull private final UserIdentity user;
/**
* Constraints on what kind of authenticator the user is allowed to use to create the credential,
* and on features that authenticator must or should support.
*/
private final AuthenticatorSelectionCriteria authenticatorSelection;
/** Extension inputs for this registration operation. */
@NonNull @Builder.Default
private final RegistrationExtensionInputs extensions =
RegistrationExtensionInputs.builder().build();
/**
* The value for {@link PublicKeyCredentialCreationOptions#getTimeout()} for this registration
* operation.
*
* This library does not take the timeout into account in any way, other than passing it
* through to the {@link PublicKeyCredentialCreationOptions} so it can be used as an argument to
* navigator.credentials.create() on the client side.
*
*
The default is empty.
*/
private final Long timeout;
/**
* Constraints on what kind of authenticator the user is allowed to use to create the credential,
* and on features that authenticator must or should support.
*/
public Optional getAuthenticatorSelection() {
return Optional.ofNullable(authenticatorSelection);
}
/**
* The value for {@link PublicKeyCredentialCreationOptions#getTimeout()} for this registration
* operation.
*
* This library does not take the timeout into account in any way, other than passing it
* through to the {@link PublicKeyCredentialCreationOptions} so it can be used as an argument to
* navigator.credentials.create() on the client side.
*
*
The default is empty.
*/
public Optional getTimeout() {
return Optional.ofNullable(timeout);
}
public static StartRegistrationOptionsBuilder.MandatoryStages builder() {
return new StartRegistrationOptionsBuilder.MandatoryStages();
}
public static class StartRegistrationOptionsBuilder {
private AuthenticatorSelectionCriteria authenticatorSelection = null;
private Long timeout = null;
public static class MandatoryStages {
private final StartRegistrationOptionsBuilder builder = new StartRegistrationOptionsBuilder();
/**
* {@link StartRegistrationOptionsBuilder#user(UserIdentity) user} is a required parameter.
*
* @see StartRegistrationOptionsBuilder#user(UserIdentity)
*/
public StartRegistrationOptionsBuilder user(UserIdentity user) {
return builder.user(user);
}
}
/**
* Constraints on what kind of authenticator the user is allowed to use to create the
* credential, and on features that authenticator must or should support.
*/
public StartRegistrationOptionsBuilder authenticatorSelection(
@NonNull Optional authenticatorSelection) {
return this.authenticatorSelection(authenticatorSelection.orElse(null));
}
/**
* Constraints on what kind of authenticator the user is allowed to use to create the
* credential, and on features that authenticator must or should support.
*/
public StartRegistrationOptionsBuilder authenticatorSelection(
AuthenticatorSelectionCriteria authenticatorSelection) {
this.authenticatorSelection = authenticatorSelection;
return this;
}
/**
* The value for {@link PublicKeyCredentialCreationOptions#getTimeout()} for this registration
* operation.
*
* This library does not take the timeout into account in any way, other than passing it
* through to the {@link PublicKeyCredentialCreationOptions} so it can be used as an argument to
* navigator.credentials.create() on the client side.
*
*
The default is empty.
*/
public StartRegistrationOptionsBuilder timeout(@NonNull Optional timeout) {
if (timeout.isPresent() && timeout.get() <= 0) {
throw new IllegalArgumentException("timeout must be positive, was: " + timeout.get());
}
this.timeout = timeout.orElse(null);
return this;
}
/**
* The value for {@link PublicKeyCredentialCreationOptions#getTimeout()} for this registration
* operation.
*
* This library does not take the timeout into account in any way, other than passing it
* through to the {@link PublicKeyCredentialCreationOptions} so it can be used as an argument to
* navigator.credentials.create() on the client side.
*
*
The default is empty.
*/
public StartRegistrationOptionsBuilder timeout(long timeout) {
return this.timeout(Optional.of(timeout));
}
}
}