HashFunction Module

Properties   Methods   Events   Config Settings   Errors  

The HashFunction module implements a wide variety of algorithms for message hashing.

Syntax

SecureBlackbox.HashFunction

Remarks

HashFunction allows you to hash messages using a variety of industry standard hashing algorithms. Algorithms of both Hash and HMAC type are supported.

You can feed your data to HashFunction in one go, or in chunks. Use Hash method to initialize the hash function, pass the buffer, and calculate the hash in one line of code. Alternatively, use Reset, Update, and Finish in sequence to perform each of those steps individually. You can call Update (and its UpdateFile and UpdateStream variants) repeatedly between Reset and Finish, effectively passing the data in a number of portions: // Feeding the data in one go: Hashfunction hf = new Hashfunction(); hf.Algorithm = "SHA256"; byte[] hash = hf.Hash(buffer); // Feeding data chunk by chunk: Hashfunction hf = new Hashfunction(); hf.Algorithm = "SHA256"; hf.Reset(); hf.Update(buffer1); hf.Update(buffer2); hf.Update(buffer3); byte[] hash = hf.Finish();

To use keyed HMAC, you need to provide the secret key first. Use CryptoKeyManager to create and initialize the key object: Cryptokeymanager km = new Cryptokeymanager(); km.ImportBytes(hmacKey, Constants.kffDER, "SHA256", "", "", Constants.ktSecret); Hashfunction hf = new Hashfunction(); hf.Algorithm = "SHA256"; hf.Key = km.Key; byte[] hash = hf.Hash(buffer);

Use OutputEncoding to set the desired encoding method.

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

Algorithm Property (HashFunction Module)

The hash algorithm to use when hashing data.

Syntax

• Swift
• Objective-C

public var algorithm: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=algorithm,setter=setAlgorithm:) NSString* algorithm;

- (NSString*)algorithm;
- (void)setAlgorithm :(NSString*)newAlgorithm;

Default Value

"SHA256"

Remarks

FIPSMode Property (HashFunction Module)

Reserved.

Syntax

• Swift
• Objective-C

public var fipsMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

JsonSettings Property (HashFunction Module)

Provides a container for JSON settings.

Syntax

• Swift
• Objective-C

public var jsonSettings: JWSettings {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=jsonKeyHeaderParams,setter=setJsonKeyHeaderParams:) NSString* jsonKeyHeaderParams;

- (NSString*)jsonKeyHeaderParams;
- (void)setJsonKeyHeaderParams :(NSString*)newJsonKeyHeaderParams;

@property (nonatomic,readwrite,assign,getter=jsonProtectedHeader,setter=setJsonProtectedHeader:) NSString* jsonProtectedHeader;

- (NSString*)jsonProtectedHeader;
- (void)setJsonProtectedHeader :(NSString*)newJsonProtectedHeader;

@property (nonatomic,readwrite,assign,getter=jsonUnprotectedHeader,setter=setJsonUnprotectedHeader:) NSString* jsonUnprotectedHeader;

- (NSString*)jsonUnprotectedHeader;
- (void)setJsonUnprotectedHeader :(NSString*)newJsonUnprotectedHeader;

@property (nonatomic,readwrite,assign,getter=jsonUnprotectedHeaderParams,setter=setJsonUnprotectedHeaderParams:) NSString* jsonUnprotectedHeaderParams;

- (NSString*)jsonUnprotectedHeaderParams;
- (void)setJsonUnprotectedHeaderParams :(NSString*)newJsonUnprotectedHeaderParams;

 

Default Value

0

Remarks

Use this property when using JSON Web Signatures to tune up the JSON parameters.

Key Property (HashFunction Module)

The key to use during the hashing.

Syntax

• Swift
• Objective-C

public var key: CryptoKey {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=keyHandle,setter=setKeyHandle:) long long keyHandle;

- (long long)keyHandle;
- (void)setKeyHandle :(long long)newKeyHandle;

@property (nonatomic,readonly,assign,getter=keyKey) NSData* keyKey;

- (NSData*)keyKey;

 

Default Value

0

Remarks

Assign a properly configured cryptographic key object to this property to use it during the hashing operation. This would normally be a HMAC key.

OutputEncoding Property (HashFunction Module)

The encoding to use for the output data.

Syntax

• Swift
• Objective-C

public var outputEncoding: HashFunctionOutputEncodings {
  get {...}
  set {...}
}

public enum HashFunctionOutputEncodings: Int32 {
  case cetDefault = 0
  case cetBinary = 1
  case cetBase64 = 2
  case cetCompact = 3
  case cetJSON = 4
}

@property (nonatomic,readwrite,assign,getter=outputEncoding,setter=setOutputEncoding:) int outputEncoding;

- (int)outputEncoding;
- (void)setOutputEncoding :(int)newOutputEncoding;

Default Value

0

Remarks

Use this property to configure the type of encoding to be used for the output data.

Config Method (HashFunction Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (HashFunction Module)

Performs an additional action.

Syntax

• Swift
• Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Finish Method (HashFunction Module)

Completes the hash and returns the resulting message digest.

Syntax

• Swift
• Objective-C

public func finish() throws -> Data

- (NSData*)finish;

Remarks

This method finalizes the hashing operation and returns the message digest of the input data. Use it in conjuction with Reset and Update methods to process data in chunks.

Hash Method (HashFunction Module)

Calculates a message digest over a byte array.

Syntax

• Swift
• Objective-C

public func hash(buffer: Data) throws -> Data

- (NSData*)hash:(NSData*)buffer;

Remarks

This method calculates and returns a message digest over the content of Buffer. This is a quick way to calculate a hash over a byte array in one go.

HashFile Method (HashFunction Module)

Calculates a message digest over data contained in a file.

Syntax

• Swift
• Objective-C

public func hashFile(sourceFile: String) throws -> Data

- (NSData*)hashFile:(NSString*)sourceFile;

Remarks

This method calculates and returns a message digest over the data contained in file SourceFile. This is a quick way to calculate a hash over a file content in one go.

HashStream Method (HashFunction Module)

Calculates a message digest over data contained in a stream.

Syntax

• Swift
• Objective-C

public func hashStream() throws -> Data

- (NSData*)hashStream;

Remarks

This method calculates a message digest over the data contained in InputStream. This is a quick way of calculating a message data over a stream content in one go.

Reset Method (HashFunction Module)

Resets the hash function context.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Reset resets the context of the hash function, discarding any data passed to it previously.

Use this method to restart the hash calculation process from scratch.

This method does not affect one-go methods like Hash or HashStream; they reset the hash function context automatically.

Update Method (HashFunction Module)

Feeds a chunk of data to the hash function.

Syntax

• Swift
• Objective-C

public func update(buffer: Data) throws -> Void

- (void)update:(NSData*)buffer;

Remarks

This method feeds Buffer to the hash function. Call this method repeatedly to pass your data to the hash function chunk by chunk.

Remember to initialize the hash function with an Reset call before starting to feed data with this method. After the whole volume of data has been sent, complete the calculation and obtain the resulting message digest with a Finish call.

UpdateFile Method (HashFunction Module)

Feeds the contents of a file to the hash function.

Syntax

• Swift
• Objective-C

public func updateFile(sourceFile: String) throws -> Void

- (void)updateFile:(NSString*)sourceFile;

Remarks

Call this method to pass the contents of a file to the hash function. You can call this function repeatedly and mix it with Update to feed the hash function with many separate chunks of data.

Remember to initialize the hash function with an Reset call before starting hashing the data. Once all the data chunks have been submitted, finalize the hash function and obtain the resulting message digest by calling Finish.

UpdateStream Method (HashFunction Module)

Feeds the contents of a stream to the hash function.

Syntax

• Swift
• Objective-C

public func updateStream() throws -> Void

- (void)updateStream;

Remarks

Call this method to pass the contents of a stream to the hash function. You can call this function repeatedly and mix it with Update to feed the hash function with many separate chunks of data.

Remember to initialize the hash function with an Reset call before starting hashing the data. Once all the data chunks have been submitted, finalize the hash function and obtain the resulting message digest by calling Finish.

Error Event (HashFunction Module)

Informs about errors during cryptographic operations.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

Class fires this event if an error happens during a cryptographic operation.

ErrorCode contains an error code and Description contains a textual description of the error that happened.

Notification Event (HashFunction Module)

This event notifies the application about an underlying control flow event.

Syntax

• Swift
• Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Constructors

public init()

JWSettings Type

This container represents JSON web security settings.

Remarks

This type contains properties specific to JSON Web Security.

Fields

Constructors

public init()

Config Settings (HashFunction Module)

HashFunction Config Settings

Base Config Settings

Trappable Errors (HashFunction Module)

HashFunction Errors