com.nimbusds.jose.JWSSigner Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nimbus-jose-jwt Show documentation

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

There is a newer version: 10.0.2

package com.nimbusds.jose;


import com.nimbusds.jose.util.Base64URL;


/**
 * Interface for signing JSON Web Signature (JWS) objects.
 *
 * Callers can query the signer to determine its algorithm capabilities.
 *
 * @author Vladimir Dzhuvinov
 * @version $version$ (2014-07-08)
 */
public interface JWSSigner extends JWSAlgorithmProvider {


	/**
	 * Signs the specified {@link JWSObject#getSigningInput input} of a 
	 * {@link JWSObject JWS object}.
	 *
	 * @param header       The JSON Web Signature (JWS) header. Must 
	 *                     specify a supported JWS algorithm and must not 
	 *                     be {@code null}.
	 * @param signingInput The input to sign. Must not be {@code null}.
	 *
	 * @return The resulting signature part (third part) of the JWS object.
	 *
	 * @throws JOSEException If the JWS algorithm is not supported or if
	 *                       signing failed for some other reason.
	 */
	public Base64URL sign(final JWSHeader header, final byte[] signingInput)
		throws JOSEException;
}