Modifier and Type	Class and Description
public static record	SignatureVerifier.SignatureVerification A `SignatureVerification` returns data about a (positively or negatively) verified signature.
public static enum	SignatureVerifier.TrustLevel The owner's trust in a public key.

Modifier and Type	Method and Description
public void	clear() A `SignatureVerifier` may cache public keys to speed up verifying signatures on multiple objects.
public String	Returns: the name getName() Retrieves the name of this verifier.
public SignatureVerifier.SignatureVerification	Returns: a `SignatureVerification` describing the outcome verify(Repository the `Repository` the data comes from. repository, GpgConfig the `GpgConfig` config, byte[] the signature is for data, byte[] the ASCII-armored signature signatureData) Verifies a given signature for given data.

clear	back to summary
public void clear() A `SignatureVerifier` may cache public keys to speed up verifying signatures on multiple objects. This clears this cache, if any.

getName	back to summary
public String getName() Retrieves the name of this verifier. This should be a short string identifying the engine that verified the signature, like "gpg" if GPG is used, or "bc" for a BouncyCastle implementation. Returns:String the name Annotations @NonNull

verify	back to summary
public SignatureVerifier.SignatureVerification verify(Repository repository, GpgConfig config, byte[] data, byte[] signatureData) throws IOException Verifies a given signature for given data. Parameters repository:Repository the `Repository` the data comes from. config:GpgConfig the `GpgConfig` data:byte[] the signature is for signatureData:byte[] the ASCII-armored signature Returns:SignatureVerifier.SignatureVerification a `SignatureVerification` describing the outcome Exceptions IOException: if the signature cannot be parsed JGitInternalException: if signature verification fails

public final Record SignatureVerifier.SignatureVerification

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.eclipse.jgit.lib.SignatureVerifier.SignatureVerification

Record Components

verifierName:String: the name of the verifier that created this verification result
creationDate:Date: date and time the signature was created
signer:String: the signer as stored in the signature, or null if unknown
keyFingerprint:String: fingerprint of the public key, or null if unknown
keyUser:String: user associated with the key, or null if unknown
verified:boolean: whether the signature verification was successful
expired:boolean: whether the public key used for this signature verification was expired when the signature was created
trustLevel:SignatureVerifier.TrustLevel: the trust level of the public key used to verify the signature
message:String: human-readable message giving additional information about the outcome of the verification, possibly null

A SignatureVerification returns data about a (positively or negatively) verified signature.

Field Summary

Modifier and Type	Field and Description
private final Date	creationDate Record Component accessed by creationDate(). date and time the signature was created
private final boolean	expired Record Component accessed by expired(). whether the public key used for this signature verification was expired when the signature was created
private final String	keyFingerprint Record Component accessed by keyFingerprint(). fingerprint of the public key, or `null` if unknown
private final String	keyUser Record Component accessed by keyUser(). user associated with the key, or `null` if unknown
private final String	message Record Component accessed by message(). human-readable message giving additional information about the outcome of the verification, possibly `null`
private final String	signer Record Component accessed by signer(). the signer as stored in the signature, or `null` if unknown
private final SignatureVerifier.TrustLevel	trustLevel Record Component accessed by trustLevel(). the trust level of the public key used to verify the signature
private final boolean	verified Record Component accessed by verified(). whether the signature verification was successful
private final String	verifierName Record Component accessed by verifierName(). the name of the verifier that created this verification result

Constructor Summary

Access	Constructor and Description
public	SignatureVerification(String verifierName, Date creationDate, String signer, String keyFingerprint, String keyUser, boolean verified, boolean expired, SignatureVerifier.TrustLevel trustLevel, String message)

Method Summary

Modifier and Type	Method and Description
public Date	creationDate() Record Component getter of creationDate. Record Component date and time the signature was created
public final boolean	equals(Object the reference object with which to compare. o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public boolean	expired() Record Component getter of expired. Record Component whether the public key used for this signature verification was expired when the signature was created
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public String	keyFingerprint() Record Component getter of keyFingerprint. Record Component fingerprint of the public key, or `null` if unknown
public String	keyUser() Record Component getter of keyUser. Record Component user associated with the key, or `null` if unknown
public String	message() Record Component getter of message. Record Component human-readable message giving additional information about the outcome of the verification, possibly `null`
public String	signer() Record Component getter of signer. Record Component the signer as stored in the signature, or `null` if unknown
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public SignatureVerifier.TrustLevel	trustLevel() Record Component getter of trustLevel. Record Component the trust level of the public key used to verify the signature
public boolean	verified() Record Component getter of verified. Record Component whether the signature verification was successful
public String	verifierName() Record Component getter of verifierName. Record Component the name of the verifier that created this verification result

Field Detail

creationDate	back to summary
private final Date creationDate Record Component accessed by creationDate(). date and time the signature was created

creationDate

back to summary

private final Date creationDate

Record Component accessed by creationDate().

date and time the signature was created

expired	back to summary
private final boolean expired Record Component accessed by expired(). whether the public key used for this signature verification was expired when the signature was created

expired

back to summary

private final boolean expired

Record Component accessed by expired().

whether the public key used for this signature verification was expired when the signature was created

keyFingerprint back to summary

keyFingerprint	back to summary
private final String keyFingerprint Record Component accessed by keyFingerprint(). fingerprint of the public key, or `null` if unknown

private final String keyFingerprint

Record Component accessed by keyFingerprint().

fingerprint of the public key, or null if unknown

keyUser back to summary

keyUser	back to summary
private final String keyUser Record Component accessed by keyUser(). user associated with the key, or `null` if unknown

private final String keyUser

Record Component accessed by keyUser().

user associated with the key, or null if unknown

message back to summary

message	back to summary
private final String message Record Component accessed by message(). human-readable message giving additional information about the outcome of the verification, possibly `null`

private final String message

Record Component accessed by message().

human-readable message giving additional information about the outcome of the verification, possibly null

signer back to summary

signer	back to summary
private final String signer Record Component accessed by signer(). the signer as stored in the signature, or `null` if unknown

private final String signer

Record Component accessed by signer().

the signer as stored in the signature, or null if unknown

trustLevel	back to summary
private final SignatureVerifier.TrustLevel trustLevel Record Component accessed by trustLevel(). the trust level of the public key used to verify the signature Annotations @NonNull

trustLevel

back to summary

private final SignatureVerifier.TrustLevel trustLevel

Record Component accessed by trustLevel().

the trust level of the public key used to verify the signature

Annotations

@NonNull

verified	back to summary
private final boolean verified Record Component accessed by verified(). whether the signature verification was successful

verified

back to summary

private final boolean verified

Record Component accessed by verified().

whether the signature verification was successful

verifierName	back to summary
private final String verifierName Record Component accessed by verifierName(). the name of the verifier that created this verification result

verifierName

back to summary

private final String verifierName

Record Component accessed by verifierName().

the name of the verifier that created this verification result

Constructor Detail

SignatureVerification	back to summary
public SignatureVerification(String verifierName, Date creationDate, String signer, String keyFingerprint, String keyUser, boolean verified, boolean expired, SignatureVerifier.TrustLevel trustLevel, String message)

Method Detail

creationDate	back to summary
public Date creationDate() Record Component getter of creationDate. Record Component date and time the signature was created

creationDate

back to summary

public Date creationDate()

Record Component getter of creationDate.

Record Component: date and time the signature was created

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this record is equal to the argument; `false` otherwise.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

expired	back to summary
public boolean expired() Record Component getter of expired. Record Component whether the public key used for this signature verification was expired when the signature was created

expired

back to summary

public boolean expired()

Record Component getter of expired.

Record Component: whether the public key used for this signature verification was expired when the signature was created

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code. Returns:int a hash code value for this record.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int: a hash code value for this record.

keyFingerprint back to summary

keyFingerprint	back to summary
public String keyFingerprint() Record Component getter of keyFingerprint. Record Component fingerprint of the public key, or `null` if unknown

public String keyFingerprint()

Record Component getter of keyFingerprint.

Record Component: fingerprint of the public key, or null if unknown

keyUser back to summary

keyUser	back to summary
public String keyUser() Record Component getter of keyUser. Record Component user associated with the key, or `null` if unknown

public String keyUser()

Record Component getter of keyUser.

Record Component: user associated with the key, or null if unknown

message back to summary

message	back to summary
public String message() Record Component getter of message. Record Component human-readable message giving additional information about the outcome of the verification, possibly `null`

public String message()

Record Component getter of message.

Record Component: human-readable message giving additional information about the outcome of the verification, possibly null

signer back to summary

signer	back to summary
public String signer() Record Component getter of signer. Record Component the signer as stored in the signature, or `null` if unknown

public String signer()

Record Component getter of signer.

Record Component: the signer as stored in the signature, or null if unknown

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves. Returns:String a string representation of the object.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String: a string representation of the object.

trustLevel	back to summary
public SignatureVerifier.TrustLevel trustLevel() Record Component getter of trustLevel. Record Component the trust level of the public key used to verify the signature Annotations @NonNull

trustLevel

back to summary

public SignatureVerifier.TrustLevel trustLevel()

Record Component getter of trustLevel.

Record Component

the trust level of the public key used to verify the signature

Annotations

@NonNull

verified	back to summary
public boolean verified() Record Component getter of verified. Record Component whether the signature verification was successful

verified

back to summary

public boolean verified()

Record Component getter of verified.

Record Component: whether the signature verification was successful

verifierName	back to summary
public String verifierName() Record Component getter of verifierName. Record Component the name of the verifier that created this verification result

verifierName

back to summary

public String verifierName()

Record Component getter of verifierName.

Record Component: the name of the verifier that created this verification result

Modifier and Type	Field and Description
public static final SignatureVerifier.TrustLevel	FULL
public static final SignatureVerifier.TrustLevel	MARGINAL
public static final SignatureVerifier.TrustLevel	NEVER
public static final SignatureVerifier.TrustLevel	ULTIMATE
public static final SignatureVerifier.TrustLevel	UNKNOWN

Modifier and Type	Method and Description
public static SignatureVerifier.TrustLevel	valueOf(String name)
public static SignatureVerifier.TrustLevel[]	values()

public Interface SignatureVerifier

Nested and Inner Type Summary

Method Summary

Method Detail

public final Record SignatureVerifier.SignatureVerification

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SignatureVerifier.TrustLevel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail