CryptographicHashContent - Apache NiFi

General

Developer

Processors

Controller Services

Reporting Tasks

Parameter Providers

Flow Analysis Rules
- DisallowComponentType

CryptographicHashContent 2.1.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Calculates a cryptographic hash value for the flowfile content using the given algorithm and writes it to an output attribute. Please refer to https://csrc.nist.gov/Projects/Hash-Functions/NIST-Policy-on-Hash-Functions for help to decide which algorithm to use.
Tags: blake2, content, cryptography, hash, md5, sha
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Fail if the content is empty
Route to failure if the content is empty. While hashing an empty value is valid, some flows may want to detect empty input.
Display Name

Fail if the content is empty

Description

Route to failure if the content is empty. While hashing an empty value is valid, some flows may want to detect empty input.

API Name

fail_when_empty

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Hash Algorithm
The hash algorithm to use. Note that not all of the algorithms available are recommended for use (some are provided for legacy compatibility). There are many things to consider when picking an algorithm; it is recommended to use the most secure algorithm possible.
Display Name

Hash Algorithm

Description

The hash algorithm to use. Note that not all of the algorithms available are recommended for use (some are provided for legacy compatibility). There are many things to consider when picking an algorithm; it is recommended to use the most secure algorithm possible.

API Name

hash_algorithm

Default Value

SHA-256

Allowable Values
- MD2
- MD5
- SHA-1
- SHA-224
- SHA-256
- SHA-384
- SHA-512
- SHA-512/224
- SHA-512/256
- SHA3-224
- SHA3-256
- SHA3-384
- SHA3-512
- BLAKE2-160
- BLAKE2-256
- BLAKE2-384
- BLAKE2-512
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

Name	Description
failure	Used for flowfiles that have no content if the 'fail on empty' setting is enabled
success	Used for flowfiles that have a hash value added

Writes Attributes

Name	Description
content_<algorithm>	This processor adds an attribute whose value is the result of hashing the flowfile content. The name of this attribute is specified by the value of the algorithm, e.g. 'content_SHA-256'.