com.yubico.webauthn.data.AuthenticatorAttestationResponse 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.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.yubico.internal.util.CollectionUtil;
import com.yubico.webauthn.data.exception.Base64UrlException;
import java.io.IOException;
import java.util.Collections;
import java.util.Set;
import java.util.SortedSet;
import lombok.Builder;
import lombok.Getter;
import lombok.NonNull;
import lombok.Value;

/**
 * Represents the authenticator's response to a client's request for the creation of a new public
 * key credential. It contains information about the new credential that can be used to identify it
 * for later use, and metadata that can be used by the WebAuthn Relying Party to assess the
 * characteristics of the credential during registration.
 *
 * @see §5.2.1.
 *     Information About Public Key Credential (interface AuthenticatorAttestationResponse) 
 */
@Value
@JsonIgnoreProperties({"publicKey", "publicKeyAlgorithm"})
public class AuthenticatorAttestationResponse implements AuthenticatorResponse {

  /**
   * Contains an attestation object, which is opaque to, and cryptographically protected against
   * tampering by, the client. The attestation object contains both authenticator data and an
   * attestation statement. The former contains the AAGUID, a unique credential ID, and the
   * credential public key. The contents of the attestation statement are determined by the
   * attestation statement format used by the authenticator. It also contains any additional
   * information that the Relying Party's server requires to validate the attestation statement, as
   * well as to decode and validate the authenticator data along with the JSON-serialized client
   * data. For more details, see §6.4
   * Attestation, §6.4.4
   * Generating an Attestation Object, and Figure 5.
   */
  @NonNull private final ByteArray attestationObject;

  @NonNull
  @Getter(onMethod = @__({@Override}))
  private final ByteArray clientDataJSON;

  /**
   * The return value from the AuthenticatorAttestationResponse.getTransports() method.
   *
   * @see §5.2.1.
   *     Information About Public Key Credential (interface AuthenticatorAttestationResponse)
   */
  private final SortedSet transports;

  /** The {@link #attestationObject} parsed as a domain object. */
  @NonNull
  @JsonIgnore
  @Getter(onMethod = @__({@JsonIgnore}))
  private final transient AttestationObject attestation;

  @NonNull
  @JsonIgnore
  @Getter(onMethod = @__({@Override}))
  private final transient CollectedClientData clientData;

  @Override
  @JsonIgnore
  public ByteArray getAuthenticatorData() {
    return attestation.getAuthenticatorData().getBytes();
  }

  @Builder(toBuilder = true)
  @JsonCreator
  private AuthenticatorAttestationResponse(
      @NonNull @JsonProperty("attestationObject") ByteArray attestationObject,
      @NonNull @JsonProperty("clientDataJSON") ByteArray clientDataJSON,
      @JsonProperty("transports") Set transports)
      throws IOException, Base64UrlException {
    this.attestationObject = attestationObject;
    this.clientDataJSON = clientDataJSON;
    this.transports =
        transports == null
            ? Collections.emptySortedSet()
            : CollectionUtil.immutableSortedSet(transports);

    attestation = new AttestationObject(attestationObject);
    this.clientData = new CollectedClientData(clientDataJSON);
  }

  // The default getter in AuthenticatorResponse re-parses the authenticator data on every
  // invocation. This "optimization" override has no measurable impact on performance, but it seems
  // rude to obviously waste cycles for nothing.
  @Override
  public AuthenticatorData getParsedAuthenticatorData() {
    return attestation.getAuthenticatorData();
  }

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

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

      /**
       * {@link AuthenticatorAttestationResponseBuilder#attestationObject(ByteArray)
       * attestationObject} is a required parameter.
       *
       * @see AuthenticatorAttestationResponseBuilder#attestationObject(ByteArray)
       */
      public Step2 attestationObject(ByteArray attestationObject) {
        builder.attestationObject(attestationObject);
        return new Step2();
      }

      public class Step2 {
        /**
         * {@link AuthenticatorAttestationResponseBuilder#clientDataJSON(ByteArray) clientDataJSON}
         * is a required parameter.
         *
         * @see AuthenticatorAttestationResponseBuilder#clientDataJSON(ByteArray)
         */
        public AuthenticatorAttestationResponseBuilder clientDataJSON(ByteArray clientDataJSON) {
          return builder.clientDataJSON(clientDataJSON);
        }
      }
    }
  }
}