Module org.eclipse.jgit

Package org.eclipse.jgit.lib

Interface Signer

public interface Signer

Creates signatures for Git objects.

Since:

7.0

Method Summary

Modifier and Type	Method	Description
boolean	canLocateSigningKey(Repository repository, GpgConfig config, PersonIdent committer, String signingKey, CredentialsProvider credentialsProvider)	Indicates if a signing key is available for the specified committer and/or signing key.
GpgSignature	sign(Repository repository, GpgConfig config, byte[] data, PersonIdent committer, String signingKey, CredentialsProvider credentialsProvider)	Signs arbitrary data.
default void	signObject(Repository repository, GpgConfig config, ObjectBuilder object, PersonIdent committer, String signingKey, CredentialsProvider credentialsProvider)	Signs the specified object.

Method Details

signObject

default void signObject(@NonNull
 Repository repository,
 @NonNull
 GpgConfig config,
 @NonNull
 ObjectBuilder object,
 @NonNull
 PersonIdent committer,
 String signingKey,
 CredentialsProvider credentialsProvider)
                 throws CanceledException,
IOException,
UnsupportedSigningFormatException

Signs the specified object.

Implementors should obtain the payload for signing from the specified object via ObjectBuilder.build() and create a proper GpgSignature. The generated signature is set on the specified object (see ObjectBuilder.setGpgSignature(GpgSignature)).

Any existing signature on the object must be discarded prior obtaining the payload via ObjectBuilder.build().

Parameters:

repository - Repository the object belongs to

config - GPG settings from the git config

object - the object to sign (must not be null and must be complete to allow proper calculation of payload)

committer - the signing identity (to help with key lookup in case signing key is not specified)

signingKey - if non-null overrides the signing key from the config

credentialsProvider - provider to use when querying for signing key credentials (eg. passphrase)

Throws:

CanceledException - when signing was canceled (eg., user aborted when entering passphrase)

IOException - if an I/O error occurs

UnsupportedSigningFormatException - if a config is given and the wanted key format is not supported

sign

GpgSignature sign(@NonNull
 Repository repository,
 @NonNull
 GpgConfig config,
 byte[] data,
 @NonNull
 PersonIdent committer,
 String signingKey,
 CredentialsProvider credentialsProvider)
           throws CanceledException,
IOException,
UnsupportedSigningFormatException

Signs arbitrary data.

Parameters:

repository - Repository the signature is created in

config - GPG settings from the git config

data - the data to sign

committer - the signing identity (to help with key lookup in case signing key is not specified)

signingKey - if non-null overrides the signing key from the config

credentialsProvider - provider to use when querying for signing key credentials (eg. passphrase)

Returns:

the signature for data

Throws:

CanceledException - when signing was canceled (eg., user aborted when entering passphrase)

IOException - if an I/O error occurs

UnsupportedSigningFormatException - if a config is given and the wanted key format is not supported

canLocateSigningKey

boolean canLocateSigningKey(@NonNull
 Repository repository,
 @NonNull
 GpgConfig config,
 @NonNull
 PersonIdent committer,
 String signingKey,
 CredentialsProvider credentialsProvider)
                     throws CanceledException

Indicates if a signing key is available for the specified committer and/or signing key.

Parameters:

repository - the current Repository

config - GPG settings from the git config

committer - the signing identity (to help with key lookup in case signing key is not specified)

signingKey - if non-null overrides the signing key from the config

credentialsProvider - provider to use when querying for signing key credentials (eg. passphrase)

Returns:

true if a signing key is available, false otherwise

Throws:

CanceledException - when signing was canceled (eg., user aborted when entering passphrase)