Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.bcpg.KeyIdentifier

Modifier and Type	Field and Description
private final byte[]	fingerprint
private final long	keyId

Access	Constructor and Description
public	KeyIdentifier(String hexEncoded)
public	KeyIdentifier(byte[] fingerprint fingerprint) Create a new `KeyIdentifier` based on a keys fingerprint.
public	KeyIdentifier(byte[] fingerprint fingerprint, long key-id keyId) Create a `KeyIdentifier` based on the given fingerprint and key-id.
public	KeyIdentifier(long key-id keyId) Create a `KeyIdentifier` based on the given key-id. `fingerprint` will be set to `null`.
private	KeyIdentifier() Create a wildcard `KeyIdentifier`.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public byte[]	Returns: fingerprint getFingerprint() Return the fingerprint of the `KeyIdentifier`.
public long	Returns: key-id getKeyId() Return the key-id of the `KeyIdentifier`.
public boolean	Returns: true if there's a match, false otherwise. hasFingerprint(byte[] the fingerprint to match against. fingerprint) Return true if the KeyIdentifier has a fingerprint corresponding to the passed in one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	Returns: true, if the identifier is present in the list, false otherwise. isPresentIn(List<KeyIdentifier> the list of key identifiers to check. others) Return true, if this `KeyIdentifier` is present in the given list of `KeyIdentifier` .
public boolean	Returns: is wildcard isWildcard() Returns true, if the `KeyIdentifier` specifies a wildcard (matches anything).
public boolean	Returns: true if we match other, false otherwise. matches(KeyIdentifier the identifier we are matching against. other) Return true, if this `KeyIdentifier` matches the given other `KeyIdentifier`.
public static boolean	matches(List<KeyIdentifier> identifiers, KeyIdentifier identifier, boolean explicit)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public static KeyIdentifier	Returns: wildcard key identifier wildcard() Create a wildcard `KeyIdentifier`.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

fingerprint	back to summary
private final byte[] fingerprint

keyId	back to summary
private final long keyId

KeyIdentifier	back to summary
public KeyIdentifier(String hexEncoded)

KeyIdentifier	back to summary
public KeyIdentifier(byte[] fingerprint) Create a new `KeyIdentifier` based on a keys fingerprint. For fingerprints matching the format of a v4, v5 or v6 key, the constructor will try to derive the corresponding key-id from the fingerprint. Parameters fingerprint:byte[] fingerprint

KeyIdentifier	back to summary
public KeyIdentifier(byte[] fingerprint, long keyId) Create a `KeyIdentifier` based on the given fingerprint and key-id. Parameters fingerprint:byte[] fingerprint keyId:long key-id

KeyIdentifier	back to summary
public KeyIdentifier(long keyId) Create a `KeyIdentifier` based on the given key-id. `fingerprint` will be set to `null`. Parameters keyId:long key-id

KeyIdentifier	back to summary
private KeyIdentifier() Create a wildcard `KeyIdentifier`.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

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

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getFingerprint back to summary

getFingerprint	back to summary
public byte[] getFingerprint() Return the fingerprint of the `KeyIdentifier`. `fingerprint` might be null, if the `KeyIdentifier` was created from just a key-id. If `isWildcard()` returns true, this method returns an empty, but non-null array. Returns:byte[] fingerprint

public byte[] getFingerprint()

Return the fingerprint of the KeyIdentifier. fingerprint might be null, if the KeyIdentifier was created from just a key-id. If isWildcard() returns true, this method returns an empty, but non-null array.

Returns:byte[]: fingerprint

getKeyId back to summary

getKeyId	back to summary
public long getKeyId() Return the key-id of the `KeyIdentifier`. This might be `0L` if `isWildcard()` returns true, or if an unknown fingerprint was passed in. Returns:long key-id

public long getKeyId()

Return the key-id of the KeyIdentifier. This might be 0L if isWildcard() returns true, or if an unknown fingerprint was passed in.

Returns:long: key-id

hasFingerprint	back to summary
public boolean hasFingerprint(byte[] fingerprint) Return true if the KeyIdentifier has a fingerprint corresponding to the passed in one. Parameters fingerprint:byte[] the fingerprint to match against. Returns:boolean true if there's a match, false otherwise.

hasFingerprint

back to summary

public boolean hasFingerprint(byte[] fingerprint)

Return true if the KeyIdentifier has a fingerprint corresponding to the passed in one.

Parameters

fingerprint:byte[]: the fingerprint to match against.

Returns:boolean

true if there's a match, false otherwise.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isPresentIn back to summary

isPresentIn	back to summary
public boolean isPresentIn(List<KeyIdentifier> others) Return true, if this `KeyIdentifier` is present in the given list of `KeyIdentifier` . This will return true if a fingerprint matches, or if a key-id matches, or if `isWildcard()` returns true. Parameters others:List<KeyIdentifier> the list of key identifiers to check. Returns:boolean true, if the identifier is present in the list, false otherwise.

public boolean isPresentIn(List<KeyIdentifier> others)

Return true, if this KeyIdentifier is present in the given list of KeyIdentifier . This will return true if a fingerprint matches, or if a key-id matches, or if isWildcard() returns true.

Parameters

others:List<KeyIdentifier>: the list of key identifiers to check.

Returns:boolean

true, if the identifier is present in the list, false otherwise.

isWildcard back to summary

isWildcard	back to summary
public boolean isWildcard() Returns true, if the `KeyIdentifier` specifies a wildcard (matches anything). This is for example used with anonymous recipient key-ids / fingerprints, where the recipient needs to try all available keys to decrypt the message. Returns:boolean is wildcard

public boolean isWildcard()

Returns true, if the KeyIdentifier specifies a wildcard (matches anything). This is for example used with anonymous recipient key-ids / fingerprints, where the recipient needs to try all available keys to decrypt the message.

Returns:boolean: is wildcard

matches back to summary

matches	back to summary
public boolean matches(KeyIdentifier other) Return true, if this `KeyIdentifier` matches the given other `KeyIdentifier`. This will return true if the fingerprint matches, or if the key-id matches, or if `isWildcard()` returns true. Parameters other:KeyIdentifier the identifier we are matching against. Returns:boolean true if we match other, false otherwise.

public boolean matches(KeyIdentifier other)

Return true, if this KeyIdentifier matches the given other KeyIdentifier. This will return true if the fingerprint matches, or if the key-id matches, or if isWildcard() returns true.

Parameters

other:KeyIdentifier: the identifier we are matching against.

Returns:boolean

true if we match other, false otherwise.

matches	back to summary
public static boolean matches(List<KeyIdentifier> identifiers, KeyIdentifier identifier, boolean explicit)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

wildcard back to summary

wildcard	back to summary
public static KeyIdentifier wildcard() Create a wildcard `KeyIdentifier`. Returns:KeyIdentifier wildcard key identifier

public static KeyIdentifier wildcard()

Create a wildcard KeyIdentifier.

Returns:KeyIdentifier: wildcard key identifier

public Class KeyIdentifier

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail