com.yubico.webauthn.data.AuthenticatorAttachment 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.JsonValue;
import java.util.Optional;
import java.util.stream.Stream;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NonNull;

/**
 * This enumeration’s values describe authenticators' attachment
 * modalities. Relying Parties use this for two purposes:
 *
 * 
 *   to express a preferred authenticator attachment modality when calling 
 *       navigator.credentials.create() to create a credential, and
 *   
to inform the client of the Relying Party's best belief about how to locate the managing
 *       authenticators of the credentials listed in {@link
 *       PublicKeyCredentialRequestOptions#getAllowCredentials()} when calling 
 *       navigator.credentials.get().
 * 
 *
 * @see §5.4.5.
 *     Authenticator Attachment Enumeration (enum AuthenticatorAttachment) 
 */
@AllArgsConstructor
public enum AuthenticatorAttachment {

  /**
   * Indicates cross-platform
   * attachment.
   *
   * Authenticators of this class are removable from, and can "roam" among, client platforms.
   */
  CROSS_PLATFORM("cross-platform"),

  /**
   * Indicates platform
   * attachment.
   *
   * Usually, authenticators of this class are not removable from the platform.
   */
  PLATFORM("platform");

  @JsonValue @Getter @NonNull private final String value;

  /**
   * Attempt to parse a string as an {@link AuthenticatorAttachment}.
   *
   * @param value a {@link String} equal to the {@link #getValue() value} of a constant in {@link
   *     AuthenticatorAttachment}
   * @return The {@link AuthenticatorAttachment} instance whose {@link #getValue() value} equals
   *     value, if any.
   * @see §5.4.5.
   *     Authenticator Attachment Enumeration (enum AuthenticatorAttachment) 
   */
  public static Optional fromValue(@NonNull String value) {
    return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
  }

  @JsonCreator
  private static AuthenticatorAttachment fromJsonString(@NonNull String value) {
    return fromValue(value).orElse(null);
  }
}