com.yubico.webauthn.data.PublicKeyCredentialParameters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webauthn-server-core Show documentation
Yubico WebAuthn server core API
The newest version!
// 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.data;

import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Builder;
import lombok.NonNull;
import lombok.Value;

/**
 * Used to supply additional parameters when creating a new credential.
 *
 * @see §5.3.
 *     Parameters for Credential Generation (dictionary PublicKeyCredentialParameters) 
 */
@Value
@Builder(toBuilder = true)
public class PublicKeyCredentialParameters {

  /**
   * Specifies the cryptographic signature algorithm with which the newly generated credential will
   * be used, and thus also the type of asymmetric key pair to be generated, e.g., RSA or Elliptic
   * Curve.
   */
  @NonNull private final COSEAlgorithmIdentifier alg;

  /** Specifies the type of credential to be created. */
  @NonNull @Builder.Default
  private final PublicKeyCredentialType type = PublicKeyCredentialType.PUBLIC_KEY;

  private PublicKeyCredentialParameters(
      @NonNull @JsonProperty("alg") COSEAlgorithmIdentifier alg,
      @NonNull @JsonProperty("type") PublicKeyCredentialType type) {
    this.alg = alg;
    this.type = type;
  }

  /**
   * Algorithm {@link COSEAlgorithmIdentifier#EdDSA} and type {@link
   * PublicKeyCredentialType#PUBLIC_KEY}.
   */
  public static final PublicKeyCredentialParameters EdDSA =
      builder().alg(COSEAlgorithmIdentifier.EdDSA).build();

  /**
   * Algorithm {@link COSEAlgorithmIdentifier#ES256} and type {@link
   * PublicKeyCredentialType#PUBLIC_KEY}.
   */
  public static final PublicKeyCredentialParameters ES256 =
      builder().alg(COSEAlgorithmIdentifier.ES256).build();

  /**
   * Algorithm {@link COSEAlgorithmIdentifier#ES384} and type {@link
   * PublicKeyCredentialType#PUBLIC_KEY}.
   */
  public static final PublicKeyCredentialParameters ES384 =
      builder().alg(COSEAlgorithmIdentifier.ES384).build();

  /**
   * Algorithm {@link COSEAlgorithmIdentifier#ES512} and type {@link
   * PublicKeyCredentialType#PUBLIC_KEY}.
   */
  public static final PublicKeyCredentialParameters ES512 =
      builder().alg(COSEAlgorithmIdentifier.ES512).build();

  /**
   * Algorithm {@link COSEAlgorithmIdentifier#RS1} and type {@link
   * PublicKeyCredentialType#PUBLIC_KEY}.
   */
  public static final PublicKeyCredentialParameters RS1 =
      builder().alg(COSEAlgorithmIdentifier.RS1).build();

  /**
   * Algorithm {@link COSEAlgorithmIdentifier#RS256} and type {@link
   * PublicKeyCredentialType#PUBLIC_KEY}.
   */
  public static final PublicKeyCredentialParameters RS256 =
      builder().alg(COSEAlgorithmIdentifier.RS256).build();

  /**
   * Algorithm {@link COSEAlgorithmIdentifier#RS384} and type {@link
   * PublicKeyCredentialType#PUBLIC_KEY}.
   */
  public static final PublicKeyCredentialParameters RS384 =
      builder().alg(COSEAlgorithmIdentifier.RS384).build();

  /**
   * Algorithm {@link COSEAlgorithmIdentifier#RS512} and type {@link
   * PublicKeyCredentialType#PUBLIC_KEY}.
   */
  public static final PublicKeyCredentialParameters RS512 =
      builder().alg(COSEAlgorithmIdentifier.RS512).build();

  public static PublicKeyCredentialParametersBuilder.MandatoryStages builder() {
    return new PublicKeyCredentialParametersBuilder.MandatoryStages();
  }

  public static class PublicKeyCredentialParametersBuilder {
    public static class MandatoryStages {
      private final PublicKeyCredentialParametersBuilder builder =
          new PublicKeyCredentialParametersBuilder();

      /**
       * {@link PublicKeyCredentialParametersBuilder#alg(COSEAlgorithmIdentifier) alg} is a required
       * parameter.
       *
       * @see PublicKeyCredentialParametersBuilder#alg(COSEAlgorithmIdentifier)
       */
      public PublicKeyCredentialParametersBuilder alg(COSEAlgorithmIdentifier alg) {
        return builder.alg(alg);
      }
    }
  }
}