All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.nimbusds.jwt.proc.JWTProcessorConfiguration Maven / Gradle / Ivy

Go to download

Java library for Javascript Object Signing and Encryption (JOSE) and JSON Web Tokens (JWT)

There is a newer version: 9.47
Show newest version
/*
 * nimbus-jose-jwt
 *
 * Copyright 2012-2016, Connect2id Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the
 * License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */

package com.nimbusds.jwt.proc;


import com.nimbusds.jose.crypto.factories.DefaultJWEDecrypterFactory;
import com.nimbusds.jose.crypto.factories.DefaultJWSVerifierFactory;
import com.nimbusds.jose.proc.JOSEProcessorConfiguration;
import com.nimbusds.jose.proc.SecurityContext;


/**
 * JWT processor configuration.
 *
 * 

Specifies the required components to process JWTs: * *

    *
  • To verify signed JWTs: *
      *
    • Key selector to determine key candidate(s) for JWS * verification based on the JWS header and application- * specific context information. *
    • Factory to construct a JWS verifier for a given key * candidate and JWS header information. A * {@link DefaultJWSVerifierFactory default factory} * implementation is provided. *
    *
  • To decrypt encrypted JWTs: *
      *
    • Key selector to determine key candidate(s) for JWE * decryption based on the JWS header and application-specific * context information. *
    • Factory to construct a JWE decrypter for a given key * candidate and JWE header information. A * {@link DefaultJWEDecrypterFactory default factory} * implementation is provided. *
    *
  • Optional JWT claims set verifier. Ensures that the claims set of a * JWT complies with an application's requirements. *
* * @author Vladimir Dzhuvinov * @version 2021-06-05 */ public interface JWTProcessorConfiguration extends JOSEProcessorConfiguration { /** * Gets the JWT claims set aware JWS key selector. * * @return The JWT claims set aware JWS key selector, {@code null} if * not specified. */ JWTClaimsSetAwareJWSKeySelector getJWTClaimsSetAwareJWSKeySelector(); /** * Sets the JWT claims set aware JWS key selector. * * @param jwsKeySelector The JWT claims set aware JWS key selector, * {@code null} if not specified. */ void setJWTClaimsSetAwareJWSKeySelector(final JWTClaimsSetAwareJWSKeySelector jwsKeySelector); /** * Gets the optional JWT claims set verifier. Ensures that the claims * set of a JWT complies with an application's requirements. * * @return The JWT claims set verifier, {@code null} if not specified. */ JWTClaimsSetVerifier getJWTClaimsSetVerifier(); /** * Sets the optional JWT claims set verifier. Ensures that the claims * set of a JWT complies with an application's requirements. * * @param claimsVerifier The JWT claims set verifier, {@code null} if * not specified. */ void setJWTClaimsSetVerifier(final JWTClaimsSetVerifier claimsVerifier); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy