Package com.yubico.webauthn.extension.uvm

Enum KeyProtectionType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<KeyProtectionType>
    public enum KeyProtectionType
extends java.lang.Enum<KeyProtectionType>
    The KEY_PROTECTION constants are flags in a bit field represented as a 16 bit long integer. They describe the method an authenticator uses to protect the private key material for FIDO registrations. Refer to [UAFAuthnrCommands] for more details on the relevance of keys and key protection. These constants are reported and queried through the UAF Discovery APIs and used to form authenticator policies in UAF protocol messages. Each constant has a case-sensitive string representation (in quotes), which is used in the authoritative metadata for FIDO authenticators.
    See Also:
    fromValue(short), fromName(String), FIDO Registry of Predefined Values §3.2 Key Protection Types

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      KEY_PROTECTION_HARDWARE
      This flag SHOULD be set if the authenticator uses hardware-based key management.
      KEY_PROTECTION_REMOTE_HANDLE
      This flag MUST be set if the authenticator does not store (wrapped) UAuth keys at the client, but relies on a server-provided key handle.
      KEY_PROTECTION_SECURE_ELEMENT
      This flag SHOULD be set if the authenticator uses a Secure Element [SecureElement] for key management.
      KEY_PROTECTION_SOFTWARE
      This flag MUST be set if the authenticator uses software-based key management.
      KEY_PROTECTION_TEE
      This flag SHOULD be set if the authenticator uses the Trusted Execution Environment [TEE] for key management.

    • Method Detail

      • values

        public static KeyProtectionType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (KeyProtectionType c : KeyProtectionType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static KeyProtectionType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • fromValue

        public static KeyProtectionType fromValue​(short value)
        Returns:
        If value matches any KeyProtectionType constant, returns that constant instance. Otherwise throws IllegalArgumentException.

      • fromName

        public static KeyProtectionType fromName​(java.lang.String name)
        Returns:
        If name matches any Key constant, returns that constant instance. Otherwise throws IllegalArgumentException.

      • getValue

        public short getValue()

      • getName

        public java.lang.String getName()