Module org.eclipse.jgit

Package org.eclipse.jgit.lib

Class SignatureVerifiers

java.lang.Object

org.eclipse.jgit.lib.SignatureVerifiers

public final class SignatureVerifiers
extends Object

Manages the available signers.

Since:

7.0

Method Summary

Modifier and Type	Method	Description
static SignatureVerifier	get(GpgConfig.GpgFormat format)	Retrieves a Signer that can produce signatures of the given type format.
static GpgConfig.GpgFormat	getFormat(byte[] signature)	Determines the type of a given signature.
static void	set(GpgConfig.GpgFormat format, SignatureVerifier verifier)	Sets a specific signature verifier to use for a specific signature type.
static SignatureVerifier.SignatureVerification	verify(Repository repository, GpgConfig config, byte[] data, byte[] signature)	Verifies a given signature for some give data.
static SignatureVerifier.SignatureVerification	verify(Repository repository, GpgConfig config, RevObject object)	Verifies the signature on a signed commit or tag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

get

public static SignatureVerifier get(@NonNull
 GpgConfig.GpgFormat format)

Retrieves a Signer that can produce signatures of the given type format.

Parameters:

format - GpgConfig.GpgFormat the signer must support

Returns:

a Signer, or null if none is available

set

public static void set(@NonNull
 GpgConfig.GpgFormat format,
 SignatureVerifier verifier)

Sets a specific signature verifier to use for a specific signature type.

Parameters:

format - signature type to set the verifier for

verifier - the SignatureVerifier to use for signatures of type format; if null, a default implementation, if available, may be used.

verify

@Nullable
public static SignatureVerifier.SignatureVerification verify(@NonNull
 Repository repository,
 @NonNull
 GpgConfig config,
 @NonNull
 RevObject object)
                                                      throws IOException

Verifies the signature on a signed commit or tag.

Parameters:

repository - the Repository the object is from

config - the GpgConfig to use

object - to verify

Returns:

a SignatureVerifier.SignatureVerification describing the outcome of the verification, or null if the object does not have a signature of a known type

Throws:

IOException - if an error occurs getting a public key

JGitInternalException - if signature verification fails

verify

@Nullable
public static SignatureVerifier.SignatureVerification verify(@NonNull
 Repository repository,
 @NonNull
 GpgConfig config,
 byte[] data,
 byte[] signature)
                                                      throws IOException

Verifies a given signature for some give data.

Parameters:

repository - the Repository the object is from

config - the GpgConfig to use

data - to verify the signature of

signature - the given signature of the data

Returns:

a SignatureVerifier.SignatureVerification describing the outcome of the verification, or null if the signature type is unknown

Throws:

IOException - if an error occurs getting a public key

JGitInternalException - if signature verification fails

getFormat

@Nullable
public static GpgConfig.GpgFormat getFormat(byte[] signature)

Determines the type of a given signature.

Parameters:

signature - to get the type of

Returns:

the signature type, or null if unknown