Package com.yubico.fido.metadata

Enum Class AttachmentHint

java.lang.Object
java.lang.Enum<AttachmentHint>
com.yubico.fido.metadata.AttachmentHint
All Implemented Interfaces:
Serializable, Comparable<AttachmentHint>, Constable
public enum AttachmentHint extends Enum<AttachmentHint>
The ATTACHMENT_HINT constants are flags in a bit field represented as a 32 bit long. They describe the method FIDO authenticators use to communicate with the FIDO User Device. These constants are reported and queried through the UAF Discovery APIs [UAFAppAPIAndTransport], and used to form Authenticator policies in UAF protocol messages. Because the connection state and topology of an authenticator may be transient, these values are only hints that can be used by server-supplied policy to guide the user experience, e.g. to prefer a device that is connected and ready for authenticating or confirming a low-value transaction, rather than one that is more secure but requires more user effort. Each constant has a case-sensitive string representation (in quotes), which is used in the authoritative metadata for FIDO authenticators. Note

These flags are not a mandatory part of authenticator metadata and, when present, only indicate possible states that may be reported during authenticator discovery.

See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ATTACHMENT_HINT_BLUETOOTH
    This flag MAY be set to indicate that an external authenticator is able to communicate using Bluetooth with the FIDO User Device.
    ATTACHMENT_HINT_EXTERNAL
    This flag MAY be set to indicate, for a hardware-based authenticator, that it is removable or remote from the FIDO User Device.
    ATTACHMENT_HINT_INTERNAL
    This flag MAY be set to indicate that the authenticator is permanently attached to the FIDO User Device.
    ATTACHMENT_HINT_NETWORK
    This flag MAY be set to indicate that the authenticator is connected to the FIDO User Device over a non-exclusive network (e.g.
    ATTACHMENT_HINT_NFC
    This flag MAY be set to indicate that an external authenticator is able to communicate by NFC to the FIDO User Device.
    ATTACHMENT_HINT_READY
    This flag MAY be set to indicate that an external authenticator is in a "ready" state.
    ATTACHMENT_HINT_WIFI_DIRECT
    This flag MAY be set to indicate that an external authenticator is able to communicate using WiFi Direct with the FIDO User Device.
    ATTACHMENT_HINT_WIRED
    This flag MAY be set to indicate that an external authenticator currently has an exclusive wired connection, e.g.
    ATTACHMENT_HINT_WIRELESS
    This flag MAY be set to indicate that an external authenticator communicates with the FIDO User Device through a personal area or otherwise non-routed wireless protocol, such as Bluetooth or NFC.

  • Method Summary

    Modifier and Type
    Method
    Description
    static AttachmentHint
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static AttachmentHint[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

      public static AttachmentHint[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static AttachmentHint valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null