Poly1305 Class
Properties Methods Events Config Settings Errors
The Poly1305 class may be used to produce a MAC (or Tag) value using the Poly1305 algorithm.
Syntax
ipworksencrypt.poly1305()
Remarks
The Poly1305 class implements the Poly1305 algorithm defined in RFC 7539. This may be used to compute a MAC (or Tag) value on data of any length.
The Key must be set to a 256 bit (32 byte) key before computing the MAC. The computed MAC is 128 bit (32 bytes) in size.
ComputeMAC Notes
ComputeMAC computes the MAC (Message Authentication Code) from the input data.
Before calling this method set Key to a 256 bit (32 byte) key. If EncodeMAC is set to True (default) the output data will be hex encoded.
Input Notes
The class will determine the source of the input based on which properties are set.
The order in which the input properties are checked are as follows:
When a valid source is found the search stops.After calling this method MACValue will be populated with the computed 128 bit (16 byte) value.
ComputeMAC Example
Poly1305 poly1305 = new Poly1305();
poly1305.KeyB = new byte[] { 0x1c, 0x92, 0x40, 0xa5, 0xeb, 0x55, 0xd3, 0x8a, 0xf3, 0x33, 0x88, 0x86, 0x04, 0xf6, 0xb5, 0xf0, 0x47, 0x39, 0x17, 0xc1, 0x40, 0x2b, 0x80, 0x09, 0x9d, 0xca, 0x5c, 0xbc, 0x20, 0x70, 0x75, 0xc0 };
poly1305.InputMessage = "Hello Polly";
poly1305.EncodeMAC = true; //hex output
poly1305.ComputeMAC();
//This outputs "113019A3ACF5ED2FBB7A45AC1FD67DA1"
Console.WriteLine(poly1305.MACValue);
ComputeMACBlock Notes
ComputeMACBlock allows input to the class to be specified in blocks. This method will return the MAC value only when the parameter LastBlock is True.
InputBuffer specifies the input data.
LastBlock specifies whether the block is the last block. If this is False the method will return an empty byte array.
To calculate the MAC value of data that is broken apart into multiple blocks make multiple calls to this method. For instance:
//Encode output in hex
poly1305.EncodeMAC = true; //hex output
//Pass any number of parts, of any size
poly1305.ComputeMACBlock(part1,false);
poly1305.ComputeMACBlock(part2,false);
poly1305.ComputeMACBlock(part3,false);
//Pass true for the last block
poly1305.ComputeMACBlock(lastPart,true);
//The MACValue property holds the MAC value
Console.WriteLine(poly1305.MACValue);
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| EncodeMAC | Whether the MAC value is hex encoded. |
| InputFile | The file to process. |
| InputMessage | The message to process. |
| Key | The 256 bit (32 byte) key to be used when computing a MAC (Message Authentication Code). |
| MACValue | The computed MAC value. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| ComputeMAC | Computes the MAC. |
| ComputeMACBlock | Computes the MAC value of specified data. |
| Config | Sets or retrieves a configuration setting. |
| Reset | Resets the class. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| Progress | Fired as progress is made. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
Poly1305.EncodeMAC Property
Whether the MAC value is hex encoded.
Syntax
isEncodeMAC(): boolean; setEncodeMAC(encodeMAC: boolean): void;
Default Value
TRUE
Remarks
This property specifies whether the computed MAC value is hex encoded. When set to True (default) the class will hex encoded the computed MAC for easier use. Set this value to False to obtain the MAC value in an unmodified form.
The default value is True.
Poly1305.InputFile Property
The file to process.
Syntax
getInputFile(): string; setInputFile(inputFile: string): void;
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.
Poly1305.InputMessage Property
The message to process.
Syntax
getInputMessage(): Uint8Array; setInputMessage(inputMessage: Uint8Array): void;
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.
Poly1305.Key Property
The 256 bit (32 byte) key to be used when computing a MAC (Message Authentication Code).
Syntax
getKey(): Uint8Array; setKey(key: Uint8Array): void;
Default Value
""
Remarks
This property holds the secret key used when computing the MACValue. The key must be 256 bits (32 bytes) long.
Poly1305.MACValue Property
The computed MAC value.
Syntax
getMACValue(): Uint8Array;
Default Value
""
Remarks
The 128 bit (16 byte) MAC value calculated after calling ComputeMAC.
This property is read-only.
Poly1305.computeMAC Method
Computes the MAC.
Syntax
async poly1305.computeMAC(): Promise<void>
Remarks
ComputeMAC computes the MAC (Message Authentication Code) from the input data.
Before calling this method set Key to a 256 bit (32 byte) key. If EncodeMAC is set to True (default) the output data will be hex encoded.
Input Notes
The class will determine the source of the input based on which properties are set.
The order in which the input properties are checked are as follows:
When a valid source is found the search stops.After calling this method MACValue will be populated with the computed 128 bit (16 byte) value.
ComputeMAC Example
Poly1305 poly1305 = new Poly1305();
poly1305.KeyB = new byte[] { 0x1c, 0x92, 0x40, 0xa5, 0xeb, 0x55, 0xd3, 0x8a, 0xf3, 0x33, 0x88, 0x86, 0x04, 0xf6, 0xb5, 0xf0, 0x47, 0x39, 0x17, 0xc1, 0x40, 0x2b, 0x80, 0x09, 0x9d, 0xca, 0x5c, 0xbc, 0x20, 0x70, 0x75, 0xc0 };
poly1305.InputMessage = "Hello Polly";
poly1305.EncodeMAC = true; //hex output
poly1305.ComputeMAC();
//This outputs "113019A3ACF5ED2FBB7A45AC1FD67DA1"
Console.WriteLine(poly1305.MACValue);
Poly1305.computeMACBlock Method
Computes the MAC value of specified data.
Syntax
async poly1305.computeMACBlock(inputBuffer : Uint8Array, lastBlock : boolean): Promise<Uint8Array>
Remarks
ComputeMACBlock allows input to the class to be specified in blocks. This method will return the MAC value only when the parameter LastBlock is True.
InputBuffer specifies the input data.
LastBlock specifies whether the block is the last block. If this is False the method will return an empty byte array.
To calculate the MAC value of data that is broken apart into multiple blocks make multiple calls to this method. For instance:
//Encode output in hex
poly1305.EncodeMAC = true; //hex output
//Pass any number of parts, of any size
poly1305.ComputeMACBlock(part1,false);
poly1305.ComputeMACBlock(part2,false);
poly1305.ComputeMACBlock(part3,false);
//Pass true for the last block
poly1305.ComputeMACBlock(lastPart,true);
//The MACValue property holds the MAC value
Console.WriteLine(poly1305.MACValue);
Poly1305.config Method
Sets or retrieves a configuration setting.
Syntax
async poly1305.config(configurationString : string): Promise<string>
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.
Poly1305.reset Method
Resets the class.
Syntax
async poly1305.reset(): Promise<void>
Remarks
When called, the class will reset all of its properties to their default values.
Poly1305.Error Event
Information about errors during data delivery.
Syntax
poly1305.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class .
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Poly1305.Progress Event
Fired as progress is made.
Syntax
poly1305.on('Progress', listener: (e: {readonly bytesProcessed: number, readonly percentProcessed: number}) => void )
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.
Config Settings (class ipworksencrypt.poly1305)
The class accepts one or more of the following configuration settings. Configuration 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.Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. This setting is set to false by default on all platforms. |
Trappable Errors (class ipworksencrypt.poly1305)
Poly1305 Errors
| 104 Cannot read or write file. | |
| 108 Invalid key size. | |
| 304 Cannot write file. | |
| 305 Cannot read file. |