Package com.yubico.yubikit.piv

Enum KeyType

java.lang.Object
java.lang.Enum<KeyType>
com.yubico.yubikit.piv.KeyType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<KeyType>, java.lang.constant.Constable
public enum KeyType
extends java.lang.Enum<KeyType>
Supported private key types for use with the PIV YubiKey application.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  KeyType.Algorithm
    Key algorithm identifier.
    static class  KeyType.EcKeyParams
    Algorithm parameters for EC keys.
    static class  KeyType.KeyParams
    Algorithm parameters used by a KeyType.
    static class  KeyType.RsaKeyParams
    Algorithm parameters for RSA keys.

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    ECCP256
    Elliptic Curve key, using NIST Curve P-256.
    ECCP384
    Elliptic Curve key, using NIST Cuve P-384.
    RSA1024
    RSA with a 1024 bit key.
    RSA2048
    RSA with a 2048 bit key.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    KeyType.KeyParams params  
    byte value  

  • Method Summary

    Modifier and Type Method Description
    static KeyType fromKey​(java.security.Key key)
    Returns the key type corresponding to the given key.
    static KeyType fromValue​(int value)
    Returns the key type corresponding to the given PIV algorithm constant.
    static KeyType valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static KeyType[] values()
    Returns an array containing the constants of this enum type, 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

    • RSA1024

      public static final KeyType RSA1024
      RSA with a 1024 bit key.

    • RSA2048

      public static final KeyType RSA2048
      RSA with a 2048 bit key.

    • ECCP256

      public static final KeyType ECCP256
      Elliptic Curve key, using NIST Curve P-256.

    • ECCP384

      public static final KeyType ECCP384
      Elliptic Curve key, using NIST Cuve P-384.

  • Field Details

  • Method Details

    • values

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

    • valueOf

      public static KeyType 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 KeyType fromValue​(int value)
      Returns the key type corresponding to the given PIV algorithm constant.

    • fromKey

      public static KeyType fromKey​(java.security.Key key)
      Returns the key type corresponding to the given key.