net.corda.core.crypto

Class SecureHash

net.corda.core.utilities.ByteSequence

net.corda.core.utilities.OpaqueBytes

net.corda.core.crypto.SecureHash

Direct Known Subclasses:

SecureHash.SHA256

public class SecureHash
extends OpaqueBytes

Container for a cryptographically secure hash value. Provides utilities for generating a cryptographic hash using different algorithms (currently only SHA-256 supported).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecureHash.Companion
static class	SecureHash.SHA256 SHA-256 is part of the SHA-2 hash function family. Generated hash is fixed size, 256-bits (32-bytes).

Field Summary

Fields

Modifier and Type	Field and Description
static SecureHash.Companion	Companion
static SecureHash.SHA256	allOnesHash A SHA-256 hash value consisting of 32 0xFF bytes. This field provides more intuitive access from Java.
static SecureHash.SHA256	zeroHash A SHA-256 hash value consisting of 32 0x00 bytes. This field provides more intuitive access from Java.

Method Summary

Modifier and Type	Method and Description
SecureHash.SHA256	hashConcat(SecureHash other) Append a second hash value to this hash value, and then compute the SHA-256 hash of the result.
static SecureHash.SHA256	parse(java.lang.String str) Converts a SHA-256 hash value represented as a hexadecimal String into a class SecureHash.
java.lang.String	prefixChars(int prefixLen) Returns the first prefixLen hexadecimal digits of the class SecureHash value.
static SecureHash.SHA256	randomSHA256() Generates a random SHA-256 value.
static SecureHash.SHA256	sha256(byte[] bytes) Computes the SHA-256 hash value of the ByteArray.
static SecureHash.SHA256	sha256(java.lang.String str) Computes the SHA-256 hash of the String's UTF-8 byte contents.
static SecureHash.SHA256	sha256Twice(byte[] bytes) Computes the SHA-256 hash of the ByteArray, and then computes the SHA-256 hash of the hash.
java.lang.String	toString() Convert the hash value to an uppercase hexadecimal String.

Methods inherited from class net.corda.core.utilities.OpaqueBytes

getBytes, of

Methods inherited from class net.corda.core.utilities.ByteSequence

compareTo, copy, copyBytes, equals, getBytes, getOffset, getSize, hashCode, of, of, of, open, putTo, slice, subSequence, take, toString, writeTo

Field Detail

zeroHash

public static SecureHash.SHA256 zeroHash

A SHA-256 hash value consisting of 32 0x00 bytes. This field provides more intuitive access from Java.

allOnesHash

public static SecureHash.SHA256 allOnesHash

A SHA-256 hash value consisting of 32 0xFF bytes. This field provides more intuitive access from Java.

Companion

public static SecureHash.Companion Companion

Method Detail

toString

public java.lang.String toString()

Convert the hash value to an uppercase hexadecimal String.

See Also:

String

prefixChars

public java.lang.String prefixChars(int prefixLen)

Returns the first prefixLen hexadecimal digits of the class SecureHash value.

Parameters:

prefixLen - The number of characters in the prefix.

See Also:

class SecureHash

hashConcat

public SecureHash.SHA256 hashConcat(SecureHash other)

Append a second hash value to this hash value, and then compute the SHA-256 hash of the result.

Parameters:

other - The hash to append to this one.

parse

public static SecureHash.SHA256 parse(java.lang.String str)

Converts a SHA-256 hash value represented as a hexadecimal String into a class SecureHash.

Parameters:

str - A sequence of 64 hexadecimal digits that represents a SHA-256 hash value.

Throws:

- The input string does not contain 64 hexadecimal digits, or it contains incorrectly-encoded characters.

See Also:

String, class SecureHash

sha256

public static SecureHash.SHA256 sha256(byte[] bytes)

Computes the SHA-256 hash value of the ByteArray.

Parameters:

bytes - The ByteArray to hash.

See Also:

ByteArray

sha256Twice

public static SecureHash.SHA256 sha256Twice(byte[] bytes)

Computes the SHA-256 hash of the ByteArray, and then computes the SHA-256 hash of the hash.

Parameters:

bytes - The ByteArray to hash.

See Also:

ByteArray

sha256

public static SecureHash.SHA256 sha256(java.lang.String str)

Computes the SHA-256 hash of the String's UTF-8 byte contents.

Parameters:

str - String whose UTF-8 contents will be hashed.

See Also:

String

randomSHA256

public static SecureHash.SHA256 randomSHA256()

Generates a random SHA-256 value.