com.yubico.webauthn.data.ClientRegistrationExtensionOutputs 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.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.HashSet;
import java.util.Optional;
import java.util.Set;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Value;

/**
 * Contains client
 * extension outputs from a navigator.credentials.create() operation.
 *
 * Note that there is no guarantee that any extension input present in {@link
 * AssertionExtensionInputs} will have a corresponding output present here.
 *
 * 
The authenticator extension outputs are contained in the {@link AuthenticatorData} structure.
 *
 * @see §9. WebAuthn
 *     Extensions
 */
@Value
@Builder(toBuilder = true)
@JsonIgnoreProperties(ignoreUnknown = true)
public class ClientRegistrationExtensionOutputs implements ClientExtensionOutputs {

  private final Boolean appidExclude;

  private final Extensions.CredentialProperties.CredentialPropertiesOutput credProps;

  private final Extensions.LargeBlob.LargeBlobRegistrationOutput largeBlob;

  @JsonCreator
  private ClientRegistrationExtensionOutputs(
      @JsonProperty("appidExclude") Boolean appidExclude,
      @JsonProperty("credProps")
          Extensions.CredentialProperties.CredentialPropertiesOutput credProps,
      @JsonProperty("largeBlob") Extensions.LargeBlob.LargeBlobRegistrationOutput largeBlob) {
    this.appidExclude = appidExclude;
    this.credProps = credProps;
    this.largeBlob = largeBlob;
  }

  @Override
  @EqualsAndHashCode.Include
  public Set getExtensionIds() {
    HashSet ids = new HashSet<>();
    if (appidExclude != null) {
      ids.add(Extensions.AppidExclude.EXTENSION_ID);
    }
    if (credProps != null) {
      ids.add(Extensions.CredentialProperties.EXTENSION_ID);
    }
    if (largeBlob != null) {
      ids.add(Extensions.LargeBlob.EXTENSION_ID);
    }
    return ids;
  }

  /**
   * The extension output for the FIDO
   * AppID Exclusion (appidExclude) Extension, if any.
   *
   * 
This value is generally not useful, as it only communicates whether the client supports the
   * extension.
   *
   * @see §10.2.FIDO
   *     AppID Exclusion Extension (appidExclude)
   */
  public Optional getAppidExclude() {
    return Optional.ofNullable(appidExclude);
  }

  /**
   * The extension output for the Credential Properties Extension (credProps), if any.
   *
   * This value MAY be present but have all members empty if the extension was successfully
   * processed but no credential properties could be determined.
   *
   * @see com.yubico.webauthn.data.Extensions.CredentialProperties.CredentialPropertiesOutput
   * @see §10.4.
   *     Credential Properties Extension (credProps)
   */
  public Optional getCredProps() {
    return Optional.ofNullable(credProps);
  }

  /**
   * The extension output for the Large blob storage extension (largeBlob), if any.
   *
   * @see com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationOutput
   * @see §10.5.Large
   *     blob storage extension (largeBlob)
   */
  public Optional getLargeBlob() {
    return Optional.ofNullable(largeBlob);
  }
}