Top Description Fields Constructors Methods
org.bouncycastle.util

public Class Fingerprint

extends Object
Class Inheritance
Imports
org.bouncycastle.crypto.digests.SHA512tDigest, .SHAKEDigest

Basic 20 byte finger print class.

Field Summary

Modifier and TypeField and Description
private static char[]
private final byte[]

Constructor Summary

AccessConstructor and Description
public
Fingerprint(byte[]
original data to calculate the fingerprint from.
source
)

Base constructor - use SHAKE-256 (160 bits).

public
Fingerprint(byte[]
original data to calculate the fingerprint from.
source
,
int bitLength)

Constructor with length - use SHAKE-256 (bitLength bits).

public
Fingerprint(byte[]
original data to calculate the fingerprint from.
source
,
boolean
use the old SHA512/160 calculation.
useSHA512t
)
Deprecated use the SHAKE only version.

Base constructor - for backwards compatibility.

Method Summary

Modifier and TypeMethod and Description
public static byte[]

Returns:

a byte array containing a 160 bit fingerprint.
calculateFingerprint
(byte[]
data to base the fingerprint on.
input
)

Return a byte array containing a calculated fingerprint for the passed in input data.

public static byte[]

Returns:

a byte array containing a 20 byte fingerprint.
calculateFingerprint
(byte[]
data to base the fingerprint on.
input
,
int
bit length of finger print to be produced.
bitLength
)

Return a byte array containing a calculated fingerprint for the passed in input data.

public static byte[]

Returns:

a byte array containing a 20 byte fingerprint.
calculateFingerprintSHA512_160
(byte[]
data to base the fingerprint on.
input
)
Deprecated use the SHAKE based version.

Return a byte array containing a calculated fingerprint for the passed in input data.

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

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

public byte[]
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

encodingTableback to summary
private static char[] encodingTable
fingerprintback to summary
private final byte[] fingerprint

Constructor Detail

Fingerprintback to summary
public Fingerprint(byte[] source)

Base constructor - use SHAKE-256 (160 bits). This is the recommended one as it is also produced by the FIPS API.

Parameters
source:byte[]

original data to calculate the fingerprint from.

Fingerprintback to summary
public Fingerprint(byte[] source, int bitLength)

Constructor with length - use SHAKE-256 (bitLength bits). This is the recommended one as it is also produced by the FIPS API.

Parameters
source:byte[]

original data to calculate the fingerprint from.

Fingerprintback to summary
public Fingerprint(byte[] source, boolean useSHA512t)

Deprecated

use the SHAKE only version.

Base constructor - for backwards compatibility.

Parameters
source:byte[]

original data to calculate the fingerprint from.

useSHA512t:boolean

use the old SHA512/160 calculation.

Method Detail

calculateFingerprintback to summary
public static byte[] calculateFingerprint(byte[] input)

Return a byte array containing a calculated fingerprint for the passed in input data. This calculation is compatible with the BC FIPS API.

Parameters
input:byte[]

data to base the fingerprint on.

Returns:byte[]

a byte array containing a 160 bit fingerprint.

calculateFingerprintback to summary
public static byte[] calculateFingerprint(byte[] input, int bitLength)

Return a byte array containing a calculated fingerprint for the passed in input data. This calculation is compatible with the BC FIPS API.

Parameters
input:byte[]

data to base the fingerprint on.

bitLength:int

bit length of finger print to be produced.

Returns:byte[]

a byte array containing a 20 byte fingerprint.

calculateFingerprintSHA512_160back to summary
public static byte[] calculateFingerprintSHA512_160(byte[] input)

Deprecated

use the SHAKE based version.

Return a byte array containing a calculated fingerprint for the passed in input data. The fingerprint is based on SHA512/160.

Parameters
input:byte[]

data to base the fingerprint on.

Returns:byte[]

a byte array containing a 20 byte fingerprint.

equalsback to summary
public boolean equals(Object o)

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
o:Object

the reference object with which to compare.

Returns:boolean

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

getFingerprintback to summary
public byte[] getFingerprint()
hashCodeback 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

toStringback 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