Package org.eclipse.microprofile.jwt.config

Interface Names

  • public interface Names
    Constants for the names of the MP-config properties that MP-JWT implementations must support externalization of to ensure portable setup of MP-JWT implementations.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String AUDIENCES
      The expected "aud" claim value(s), separated by commas.
      static java.lang.String DECRYPTOR_KEY_LOCATION
      The relative path or full URL of the decryption key.
      static java.lang.String ISSUER
      The expected iss claim value to validate against an MP-JWT.
      static java.lang.String TOKEN_COOKIE
      The Cookie name expected to containe the JWT token (default is Bearer).
      static java.lang.String TOKEN_HEADER
      The HTTP header name expected to contain the JWT token.
      static java.lang.String VERIFIER_PUBLIC_KEY
      The embedded key material of the verification public key for the MP-JWT signer in PKCS8 PEM or JWK(S) format.
      static java.lang.String VERIFIER_PUBLIC_KEY_ALGORITHM
      Public Key Signature Algorithm property which can be set to either 'RS256' or 'ES256'.
      static java.lang.String VERIFIER_PUBLIC_KEY_LOCATION
      The relative path or full URL of the verification public key.

    • Field Detail

      • VERIFIER_PUBLIC_KEY

        static final java.lang.String VERIFIER_PUBLIC_KEY
        The embedded key material of the verification public key for the MP-JWT signer in PKCS8 PEM or JWK(S) format. If not found the VERIFIER_PUBLIC_KEY_LOCATION needs to be checked.
        See Also:
        Constant Field Values

      • VERIFIER_PUBLIC_KEY_LOCATION

        static final java.lang.String VERIFIER_PUBLIC_KEY_LOCATION
        The relative path or full URL of the verification public key. All relative paths will be resolved within the archive using ClassLoader.getResource. If the value is a URL it will be resolved using `new URL(“”).openStream()`
        See Also:
        Constant Field Values

      • VERIFIER_PUBLIC_KEY_ALGORITHM

        static final java.lang.String VERIFIER_PUBLIC_KEY_ALGORITHM
        Public Key Signature Algorithm property which can be set to either 'RS256' or 'ES256'.
        See Also:
        Constant Field Values

      • DECRYPTOR_KEY_LOCATION

        static final java.lang.String DECRYPTOR_KEY_LOCATION
        The relative path or full URL of the decryption key. All relative paths will be resolved within the archive using ClassLoader.getResource. If the value is a URL it will be resolved using `new URL(“”).openStream()`
        See Also:
        Constant Field Values

      • ISSUER

        static final java.lang.String ISSUER
        The expected iss claim value to validate against an MP-JWT.
        See Also:
        Constant Field Values

      • TOKEN_HEADER

        static final java.lang.String TOKEN_HEADER
        The HTTP header name expected to contain the JWT token.

        Supported values are Authorization (default) and Cookie.

        See Also:
        Constant Field Values

      • TOKEN_COOKIE

        static final java.lang.String TOKEN_COOKIE
        The Cookie name expected to containe the JWT token (default is Bearer).

        This configuration will be ignored unless `mp.jwt.token.header` is set to `Cookie`.

        See Also:
        Constant Field Values

      • AUDIENCES

        static final java.lang.String AUDIENCES
        The expected "aud" claim value(s), separated by commas. If specified, MP-JWT claim must be present and match one of the values.
        See Also:
        Constant Field Values