Module io.inverno.mod.security.jose
Package io.inverno.mod.security.jose.jwa

Enum Class XECAlgorithm

java.lang.Object
java.lang.Enum<XECAlgorithm>
io.inverno.mod.security.jose.jwa.XECAlgorithm
All Implemented Interfaces:
JWAAlgorithm<XECJWK>, Serializable, Comparable<XECAlgorithm>, Constable
public enum XECAlgorithm extends Enum<XECAlgorithm> implements JWAAlgorithm<XECJWK>

OKP Elliptic curve key management algorithms as defined by RFC8037 Section 3.1.

Key management algorithms:

  • ECDH_ES-ES
  • ECDH-ES+A128KW
  • ECDH-ES+A192KW
  • ECDH-ES+A256KW

These algorithms must be used with Octet Key Pair curves OKPCurve.X25519 and OKPCurve.X448, they extends ECDH-ES algorithms with NIST Elliptic curves defined by ECAlgorithm and ECCurve.

Since:
1.5
Author:
Jeremy Kuhn

  • Enum Constant Details

  • Method Details

    • values

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

    • getAlgorithm

      public String getAlgorithm()
      Description copied from interface: JWAAlgorithm

      Returns the JWA registered name of the algorithm.

      Specified by:
      getAlgorithm in interface JWAAlgorithm<XECJWK>
      Returns:
      a JWA registered name

    • isSignature

      public boolean isSignature()
      Description copied from interface: JWAAlgorithm

      Determines whether the algorithm is a signature algorithm.

      Specified by:
      isSignature in interface JWAAlgorithm<XECJWK>
      Returns:
      true if the algorithm is a signature algorithm, false otherwise

    • isKeyManagement

      public boolean isKeyManagement()
      Description copied from interface: JWAAlgorithm

      Determines whether the algorithm is a key management algorithm.

      Specified by:
      isKeyManagement in interface JWAAlgorithm<XECJWK>
      Returns:
      true if the algorithm is a key management algorithm, false otherwise

    • isEncryption

      public boolean isEncryption()
      Description copied from interface: JWAAlgorithm

      Determines whether the algorithm is an encryption algorithm.

      Specified by:
      isEncryption in interface JWAAlgorithm<XECJWK>
      Returns:
      true if the algorithm is an encryption algorithm, false otherwise

    • createSigner

      public JWASigner createSigner(XECJWK jwk) throws JWAProcessingException
      Description copied from interface: JWAAlgorithm

      Creates a signer from the algorithm.

      Specified by:
      createSigner in interface JWAAlgorithm<XECJWK>
      Parameters:
      jwk - the key to use for signing
      Returns:
      a JWA signer
      Throws:
      JWAProcessingException - if the algorithm is not a signature algorithm or if there was an error creating the signer

    • createKeyManager

      public JWAKeyManager createKeyManager(XECJWK jwk) throws JWAProcessingException
      Description copied from interface: JWAAlgorithm

      Creates a key manager from the algorithm.

      Specified by:
      createKeyManager in interface JWAAlgorithm<XECJWK>
      Parameters:
      jwk - the key to use for signing
      Returns:
      a JWA key manager
      Throws:
      JWAProcessingException - if the algorithm is not a key management algorithm or if there was an error creating the key manager

    • createCipher

      public JWACipher createCipher(XECJWK jwk) throws JWAProcessingException
      Description copied from interface: JWAAlgorithm

      Creates a cipher from the algorithm.

      Specified by:
      createCipher in interface JWAAlgorithm<XECJWK>
      Parameters:
      jwk - the key to use for signing
      Returns:
      a JWA cipher
      Throws:
      JWAProcessingException - if the algorithm is not an encryption algorithm or if there was an error creating the cipher

    • getKeyWrappingAlgorithm

      public String getKeyWrappingAlgorithm()

      Returns a JCA key wrapping algorithm to be used to wrap a derived key.

      Returns:
      a JCA key wrapping algorithm or null

    • fromAlgorithm

      public static XECAlgorithm fromAlgorithm(String alg) throws IllegalArgumentException

      Returns the OKP Elliptic curve key management algorithm corresponding to the specified JWA registered algorithm name.

      Parameters:
      alg - a JWA registered algorithm name
      Returns:
      an OKP Elliptic curve key management algorithm
      Throws:
      IllegalArgumentException - if the specified algorithm is not an OKP Elliptic curve key management algorithm