HashAlgorithm (nifi-security-utils 1.13.1 API)

java.lang.Object
- java.lang.Enum<HashAlgorithm>
- - org.apache.nifi.security.util.crypto.HashAlgorithm

All Implemented Interfaces:

Serializable, Comparable<HashAlgorithm>
```
public enum HashAlgorithm
extends Enum<HashAlgorithm>
```
Enumeration capturing information about the cryptographic hash algorithms

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BLAKE2_160`
`BLAKE2_256`
`BLAKE2_384`
`BLAKE2_512`
`MD2`
`MD5`
`SHA1`
`SHA224`
`SHA256`
`SHA3_224`
`SHA3_256`
`SHA3_384`
`SHA3_512`
`SHA384`
`SHA512`
`SHA512_224`
`SHA512_256`

Field Summary

Fields
Modifier and Type Field and Description

private static List<String> BROKEN_ALGORITHMS

private String description

private int digestBytesLength

private String name

Fields
Modifier and Type	Field and Description
`private static List<String>`	`BROKEN_ALGORITHMS`
`private String`	`description`
`private int`	`digestBytesLength`
`private String`	`name`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`buildAllowableValueDescription()` Returns a more complete description of the algorithm for `AllowableValue` construction.
`static HashAlgorithm`	`fromName(String algorithmName)`
`String`	`getDescription()`
`int`	`getDigestBytesLength()`
`String`	`getName()`
`boolean`	`isBlake2()` Returns `true` if this hash algorithm is Blake2, as it requires different initialization through BouncyCastle.
`boolean`	`isStrongAlgorithm()` Returns `true` if this algorithm is considered cryptographically secure.
`String`	`toString()`
`static HashAlgorithm`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static HashAlgorithm[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - MD2
```
public static final HashAlgorithm MD2
```
  - MD5
```
public static final HashAlgorithm MD5
```
  - SHA1
```
public static final HashAlgorithm SHA1
```
  - SHA224
```
public static final HashAlgorithm SHA224
```
  - SHA256
```
public static final HashAlgorithm SHA256
```
  - SHA384
```
public static final HashAlgorithm SHA384
```
  - SHA512
```
public static final HashAlgorithm SHA512
```
  - SHA512_224
```
public static final HashAlgorithm SHA512_224
```
  - SHA512_256
```
public static final HashAlgorithm SHA512_256
```
  - SHA3_224
```
public static final HashAlgorithm SHA3_224
```
  - SHA3_256
```
public static final HashAlgorithm SHA3_256
```
  - SHA3_384
```
public static final HashAlgorithm SHA3_384
```
  - SHA3_512
```
public static final HashAlgorithm SHA3_512
```
  - BLAKE2_160
```
public static final HashAlgorithm BLAKE2_160
```
  - BLAKE2_256
```
public static final HashAlgorithm BLAKE2_256
```
  - BLAKE2_384
```
public static final HashAlgorithm BLAKE2_384
```
  - BLAKE2_512
```
public static final HashAlgorithm BLAKE2_512
```
- Field Detail
  - name
```
private final String name
```
  - digestBytesLength
```
private final int digestBytesLength
```
  - description
```
private final String description
```
  - BROKEN_ALGORITHMS
```
private static final List<String> BROKEN_ALGORITHMS
```
- Method Detail
  - values
```
public static HashAlgorithm[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (HashAlgorithm c : HashAlgorithm.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HashAlgorithm valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getName
```
public String getName()
```
  - getDigestBytesLength
```
public int getDigestBytesLength()
```
  - getDescription
```
public String getDescription()
```
  - isStrongAlgorithm
```
public boolean isStrongAlgorithm()
```
    Returns true if this algorithm is considered cryptographically secure. These determinations were made as of 2018-08-30. Current strong algorithms: * SHA-224 (SHA2) * SHA-256 (SHA2) * SHA-384 (SHA2) * SHA-512 (SHA2) * SHA-512/224 (SHA2) * SHA-512/256 (SHA2) * SHA3-224 * SHA3-256 * SHA3-384 * SHA3-512 * Blake2b-160 * Blake2b-256 * Blake2b-384 * Blake2b-512 Current broken algorithms: * MD2 * MD5 * SHA-1
    
    Returns:
    
    true if the algorithm is considered strong
  - isBlake2
```
public boolean isBlake2()
```
    Returns true if this hash algorithm is Blake2, as it requires different initialization through BouncyCastle.
    
    Returns:
    
    true if this algorithm is in the Blake2 family
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<HashAlgorithm>
  - buildAllowableValueDescription
```
public String buildAllowableValueDescription()
```
    Returns a more complete description of the algorithm for AllowableValue construction. Ex: description -- Cryptographically broken due to collisions buildAllowableValueDescription -- SHA-1 (20 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions
    
    Returns:
    
    the description for dropdown help
  - fromName
```
public static HashAlgorithm fromName(String algorithmName)
```

Enum HashAlgorithm

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

MD2

MD5

SHA1

SHA224

SHA256

SHA384

SHA512

SHA512_224

SHA512_256

SHA3_224

SHA3_256

SHA3_384

SHA3_512

BLAKE2_160

BLAKE2_256

BLAKE2_384

BLAKE2_512

Field Detail

name

digestBytesLength

description

BROKEN_ALGORITHMS

Method Detail

values

valueOf

getName

getDigestBytesLength

getDescription

isStrongAlgorithm

isBlake2

toString

buildAllowableValueDescription

fromName