MLDSA Module

Properties   Methods   Events   Config Settings   Errors  

The MLDSA module can be used to create and verify digital signatures using Module-Lattice-Based Digital Signature Algorithm (ML-DSA) cryptography.

Syntax

IPWorksEncrypt.MLDSA

Remarks

The MLDSA component can be used to create and verify digital signatures using Module-Lattice-Based Digital Signature Algorithm (ML-DSA) cryptography. Includes support for ML-DSA-44, ML-DSA-65, and ML-DSA-87 parameter sets.

Note that by default the component uses ML-DSA-44. You may specify the parameter set by setting ParamSet.

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.

Context Property (MLDSA Module)

The ML-DSA context string.

Syntax

• Swift
• Objective-C

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

public var contextB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=context,setter=setContext:) NSString* context;

- (NSString*)context;
- (void)setContext :(NSString*)newContext;

@property (nonatomic,readwrite,assign,getter=contextB,setter=setContextB:) NSData* contextB;

- (NSData*)contextB;
- (void)setContextB :(NSData*)newContext;

Default Value

""

Remarks

This property specifies the optional ML-DSA context used when signing and verifying. This property may be empty. The default value is empty.

The same value must be specified when calling Sign and Verify.

The maximum length is 255 bytes.

HashAlgorithm Property (MLDSA Module)

The hash algorithm used when PreHash is enabled.

Syntax

• Swift
• Objective-C

public var hashAlgorithm: MLDSAHashAlgorithms {
  get {...}
  set {...}
}

public enum MLDSAHashAlgorithms: Int32 {
  case mhaSHA256 = 0
  case mhaSHA384 = 1
  case mhaSHA512 = 2
}

@property (nonatomic,readwrite,assign,getter=hashAlgorithm,setter=setHashAlgorithm:) int hashAlgorithm;

- (int)hashAlgorithm;
- (void)setHashAlgorithm :(int)newHashAlgorithm;

Default Value

0

Remarks

This property specifies the hash algorithm used to pre-hash input data when PreHash is set to True.

Possible values are:

• 0 (mhaSHA256 - default): SHA-256
• 1 (mhaSHA384): SHA-384
• 2 (mhaSHA512): SHA-512

InputFile Property (MLDSA Module)

The file to process.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile;

- (NSString*)inputFile;
- (void)setInputFile :(NSString*)newInputFile;

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

InputMessage Property (MLDSA Module)

The message to process.

Syntax

• Swift
• Objective-C

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

public var inputMessageB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputMessage,setter=setInputMessage:) NSString* inputMessage;

- (NSString*)inputMessage;
- (void)setInputMessage :(NSString*)newInputMessage;

@property (nonatomic,readwrite,assign,getter=inputMessageB,setter=setInputMessageB:) NSData* inputMessageB;

- (NSData*)inputMessageB;
- (void)setInputMessageB :(NSData*)newInputMessage;

Default Value

""

Remarks

This property specifies the message to be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Key Property (MLDSA Module)

The ML-DSA key.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=keyPrivateKey,setter=setKeyPrivateKey:) NSString* keyPrivateKey;

- (NSString*)keyPrivateKey;
- (void)setKeyPrivateKey :(NSString*)newKeyPrivateKey;

@property (nonatomic,readwrite,assign,getter=keyPrivateKeyB,setter=setKeyPrivateKeyB:) NSData* keyPrivateKeyB;

- (NSData*)keyPrivateKeyB;
- (void)setKeyPrivateKeyB :(NSData*)newKeyPrivateKey;
@property (nonatomic,readwrite,assign,getter=keyPublicKey,setter=setKeyPublicKey:) NSString* keyPublicKey;

- (NSString*)keyPublicKey;
- (void)setKeyPublicKey :(NSString*)newKeyPublicKey;

@property (nonatomic,readwrite,assign,getter=keyPublicKeyB,setter=setKeyPublicKeyB:) NSData* keyPublicKeyB;

- (NSData*)keyPublicKeyB;
- (void)setKeyPublicKeyB :(NSData*)newKeyPublicKey;
 

Default Value

False

Remarks

This property specifies the ML-DSA public or private key.

The private key is required before calling Sign, and the public key is required before calling Verify.

ML-DSA keys are made up of raw private key and public key fields.

PreHash Property (MLDSA Module)

Whether to use HashML-DSA when signing and verifying.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=preHash,setter=setPreHash:) BOOL preHash;

- (BOOL)preHash;
- (void)setPreHash :(BOOL)newPreHash;

Default Value

False

Remarks

This property specifies whether the component uses HashML-DSA when signing and verifying.

If set to True, the input is pre-hashed using HashAlgorithm before signing or verifying. This supports a single pass over input data from InputFile or .

If set to False (default), pure ML-DSA is used.

Signature Property (MLDSA Module)

The signature.

Syntax

• Swift
• Objective-C

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

public var signatureB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=signature,setter=setSignature:) NSString* signature;

- (NSString*)signature;
- (void)setSignature :(NSString*)newSignature;

@property (nonatomic,readwrite,assign,getter=signatureB,setter=setSignatureB:) NSData* signatureB;

- (NSData*)signatureB;
- (void)setSignatureB :(NSData*)newSignature;

Default Value

""

Remarks

This property holds the ML-DSA signature.

It is populated by Sign and must be set before calling Verify.

UseHex Property (MLDSA Module)

Whether the signature is hex encoded.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=useHex,setter=setUseHex:) BOOL useHex;

- (BOOL)useHex;
- (void)setUseHex :(BOOL)newUseHex;

Default Value

False

Remarks

This property specifies whether Signature is hex encoded.

If set to False (default), the signature is provided as-is with no encoding.

When Sign is called and this property is set to True, Signature is hex encoded when populated.

When Verify is called and this property is set to True, Signature is treated as hex encoded.

Input data from InputMessage, InputFile, or SetInputStream is always processed as provided.

Config Method (MLDSA 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.

CreateKey Method (MLDSA Module)

Creates a new key.

Syntax

• Swift
• Objective-C

public func createKey() throws -> Void

- (void)createKey;

Remarks

CreateKey creates a new ML-DSA public and private key pair.

Reset Method (MLDSA Module)

Resets the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

When called, the class will reset all of its properties to their default values.

Sign Method (MLDSA Module)

Creates a signature.

Syntax

• Swift
• Objective-C

public func sign() throws -> Void

- (void)sign;

Remarks

This method signs the data specified by InputFile or InputMessage using the private key in Key and populates Signature.

Verify Method (MLDSA Module)

Verifies a signature.

Syntax

• Swift
• Objective-C

public func verify() throws -> Bool

- (BOOL)verify;

Remarks

This method verifies Signature for the data specified by InputFile or InputMessage using the public key in Key. The result is returned.

Error Event (MLDSA Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

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

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Progress Event (MLDSA Module)

Fired as progress is made.

Syntax

• Swift
• Objective-C

func onProgress(bytesProcessed: Int64, percentProcessed: Int32)

- (void)onProgress:(long long)bytesProcessed :(int)percentProcessed;

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

MLDSAKey Type

Contains a raw ML-DSA key.

Remarks

This type contains the raw public and private key values used by the MLDSA component.

• PrivateKey
• PublicKey

Fields

Constructors

public init()

Config Settings (MLDSA Module)

MLDSA Config Settings

Base Config Settings

Trappable Errors (MLDSA Module)

MLDSA Errors