Description:

Calculates a fuzzy/locality-sensitive hash value for the Content of a FlowFile and puts that hash value on the FlowFile as an attribute whose name is determined by the property.Note: this processor only offers non-cryptographic hash algorithms. And it should be not be seen as a replacement to the HashContent processor.Note: The underlying library loads the entirety of the streamed content into and performs result evaluations in memory. Accordingly, it is important to consider the anticipated profile of content being evaluated by this processor and the hardware supporting it especially when working against large files.

Tags:

hashing, fuzzy-hashing, cyber-security

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Name	Default Value	Allowable Values	Description
Hash Attribute Name	fuzzyhash.value		The name of the FlowFile Attribute that should hold the Fuzzy Hash Value
Hashing Algorithm		*ssdeep *tlsh	The hashing algorithm utilized

Relationships:

Name	Description
success	Any FlowFile that is successfully hashed will be sent to this Relationship.
failure	Any FlowFile that is successfully hashed will be sent to this Relationship.

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
Hash Attribute Name	This Processor adds an attribute whose value is the result of Hashing the existing FlowFile content. The name of this attribute is specified by the (Hash Attribute Name) property

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

See Also:

CompareFuzzyHash, HashContent