io.smallrye.jwt.build.JwtSignatureBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smallrye-jwt-build Show documentation
The newest version!
package io.smallrye.jwt.build;

import java.security.PublicKey;
import java.security.cert.X509Certificate;
import java.util.List;

import io.smallrye.jwt.algorithm.SignatureAlgorithm;

/**
 * JWT JsonWebSignature Builder.
 *
 * 
 * JwtSignatureBuilder implementations must set the 'alg' (algorithm) header to 'RS256'
 * and 'typ' (token type) header to 'JWT' unless they have already been set.
 * 
 * Note that JwtSignatureBuilder implementations are not expected to be thread-safe.
 *
 * @see RFC7515
 */
public interface JwtSignatureBuilder extends JwtSignature {

    /**
     * Set a signature algorithm.
     * Note that only 'RS256' (default), 'ES256' and 'HS256' algorithms must be supported.
     *
     * @since 2.1.3
     *
     * @param algorithm the signature algorithm
     * @return JwtSignatureBuilder
     */
    JwtSignatureBuilder algorithm(SignatureAlgorithm algorithm);

    /**
     * Set a signature algorithm.
     * Note that only 'RS256' (default), 'ES256' and 'HS256' algorithms must be supported.
     *
     * @deprecated Use {@link #algorithm}
     *
     * @param algorithm the signature algorithm
     * @return JwtSignatureBuilder
     */
    @Deprecated
    default JwtSignatureBuilder signatureAlgorithm(SignatureAlgorithm algorithm) {
        return algorithm(algorithm);
    }

    /**
     * Set a 'kid' signature key id.
     *
     * @since 2.1.3
     *
     * @param keyId the key id
     * @return JwtSignatureBuilder
     */
    JwtSignatureBuilder keyId(String keyId);

    /**
     * Set a 'kid' signature key id.
     *
     * @deprecated Use {@link #keyId}
     *
     * @param keyId the key id
     * @return JwtSignatureBuilder
     */
    @Deprecated
    default JwtSignatureBuilder signatureKeyId(String keyId) {
        return keyId(keyId);
    }

    /**
     * Set X.509 Certificate SHA-1 'x5t' thumbprint.
     *
     * @param cert the certificate
     * @return JwtSignatureBuilder
     */
    JwtSignatureBuilder thumbprint(X509Certificate cert);

    /**
     * Set X.509 Certificate SHA-256 'x5t#S256' thumbprint.
     *
     * @param cert the certificate
     * @return JwtSignatureBuilder
     */
    JwtSignatureBuilder thumbprintS256(X509Certificate cert);

    /**
     * Set X.509 Certificate 'x5c' chain.
     *
     * @param cert the certificate
     * @return JwtSignatureBuilder
     */
    default JwtSignatureBuilder chain(X509Certificate cert) {
        return chain(List.of(cert));
    }

    /**
     * Set X.509 Certificate 'x5c' chain.
     *
     * @param chain the certificate chain
     * @return JwtSignatureBuilder
     */
    JwtSignatureBuilder chain(List chain);

    /**
     * Set JSON Web Key 'jwk' key.
     *
     * @param key the public key
     * @return JwtSignatureBuilder
     */
    JwtSignatureBuilder jwk(PublicKey key);

    /**
     * Custom JWT signature header.
     *
     * If the 'alg' (algorithm) header is set with this method then it
     * has to match one of the {@link SignatureAlgorithm} values.
     *
     * @param name the header name
     * @param value the header value
     * @return JwtSignatureBuilder
     */
    JwtSignatureBuilder header(String name, Object value);
}