Package org.forgerock.json.jose.jwt

Interface Algorithm

All Known Implementing Classes:
JweAlgorithm, JwsAlgorithm
public interface Algorithm
The interface for each possible algorithm that can be used to sign and/or encrypt a JWT.

Since:
2.0.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAlgorithm()
    Gets the actual name of the algorithm that is understood by Java cryptographic operations.
    String
    getJwaAlgorithmName()
    Gets the name of the algorithm as defined in the JWA standard.
    boolean
    isSymmetric()
    Indicates whether the algorithm uses the same key for all operations.

  • Method Details

    • getAlgorithm

      String getAlgorithm()
      Gets the actual name of the algorithm that is understood by Java cryptographic operations.
      Returns:
      The name of the algorithm.

    • getJwaAlgorithmName

      String getJwaAlgorithmName()
      Gets the name of the algorithm as defined in the JWA standard.
      Returns:
      The name of the algorithm.

    • isSymmetric

      boolean isSymmetric()
      Indicates whether the algorithm uses the same key for all operations. Symmetric algorithms like AES or HMAC uses a shared secret key for both encryption and decryption, or signing and verification. Public key algorithms use distinct keys for each operation.
      Returns:
      true if this algorithm uses the same key for all operations or false if it is a public key algorithm.