Package io.fusionauth.jwt.domain

Enum Class Algorithm

java.lang.Object
java.lang.Enum<Algorithm>
io.fusionauth.jwt.domain.Algorithm
All Implemented Interfaces:
Serializable, Comparable<Algorithm>, java.lang.constant.Constable
public enum Algorithm extends Enum<Algorithm>
Available JSON Web Algorithms (JWA) as described in RFC 7518 available for this JWT implementation.
Author:
Daniel DeGroff

  • 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
    ES256
    ECDSA using P-256 and SHA-256 OID: 1.2.840.10045.3.1.7 - prime256v1 / secp256r1
    ES384
    ECDSA using P-384 and SHA-384 OID: 1.3.132.0.34 - secp384r1 / secp384r1
    ES512
    ECDSA using P-521 and SHA-512 OID: 1.3.132.0.35 - prime521v1 / secp521r1
    HS256
    HMAC using SHA-256
    HS384
    HMAC using SHA-384
    HS512
    HMAC using SHA-512
    none
    No digital signature or MAC performed.
    PS256
    RSASSA-PSS using SHA-256 and MGF1 with SHA-256 - SHA256withRSAandMGF1
    PS384
    RSASSA-PSS using SHA-384 and MGF1 with SHA-384 - SHA384withRSAandMGF1
    PS512
    RSASSA-PSS using SHA-512 and MGF1 with SHA-512 - SHA512withRSAandMGF1
    RS256
    RSASSA-PKCS1-v1_5 using SHA-256
    RS384
    RSASSA-PKCS1-v1_5 using SHA-384
    RS512
    RSASSA-PKCS1-v1_5 using SHA-512

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final String
    algorithm
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Algorithm
    fromName(String name)
     
    String
    getName()
     
    int
    getSaltLength()
     
    static Algorithm
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Algorithm[]
    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

    • ES256

      public static final Algorithm ES256
      ECDSA using P-256 and SHA-256 OID: 1.2.840.10045.3.1.7 - prime256v1 / secp256r1

    • ES384

      public static final Algorithm ES384
      ECDSA using P-384 and SHA-384 OID: 1.3.132.0.34 - secp384r1 / secp384r1

    • ES512

      public static final Algorithm ES512
      ECDSA using P-521 and SHA-512 OID: 1.3.132.0.35 - prime521v1 / secp521r1

    • HS256

      public static final Algorithm HS256
      HMAC using SHA-256

    • HS384

      public static final Algorithm HS384
      HMAC using SHA-384

    • HS512

      public static final Algorithm HS512
      HMAC using SHA-512

    • PS256

      public static final Algorithm PS256
      RSASSA-PSS using SHA-256 and MGF1 with SHA-256 - SHA256withRSAandMGF1

    • PS384

      public static final Algorithm PS384
      RSASSA-PSS using SHA-384 and MGF1 with SHA-384 - SHA384withRSAandMGF1

    • PS512

      public static final Algorithm PS512
      RSASSA-PSS using SHA-512 and MGF1 with SHA-512 - SHA512withRSAandMGF1

    • RS256

      public static final Algorithm RS256
      RSASSA-PKCS1-v1_5 using SHA-256

    • RS384

      public static final Algorithm RS384
      RSASSA-PKCS1-v1_5 using SHA-384

    • RS512

      public static final Algorithm RS512
      RSASSA-PKCS1-v1_5 using SHA-512

    • none

      public static final Algorithm none
      No digital signature or MAC performed.

  • Field Details

    • algorithm

      public final String algorithm

  • Method Details

    • values

      public static Algorithm[] 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 Algorithm 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

    • fromName

      public static Algorithm fromName(String name)

    • getName

      public String getName()

    • getSaltLength

      public int getSaltLength()