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
class 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
compute_mac computes the MAC (Message Authentication Code) from the input data.
Before calling this method set key to a 256 bit (32 byte) key. If encode_mac 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 mac_value 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
compute_mac_block 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.
| encode_mac | Whether the MAC value is hex encoded. |
| input_file | The file to process. |
| input_message | The message to process. |
| key | The 256 bit (32 byte) key to be used when computing a MAC (Message Authentication Code). |
| mac_value | 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.
| compute_mac | Computes the MAC. |
| compute_mac_block | 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.
| on_error | Information about errors during data delivery. |
| on_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. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
encode_mac Property
Whether the MAC value is hex encoded.
Syntax
def get_encode_mac() -> bool: ... def set_encode_mac(value: bool) -> None: ...
encode_mac = property(get_encode_mac, set_encode_mac)
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.
input_file Property
The file to process.
Syntax
def get_input_file() -> str: ... def set_input_file(value: str) -> None: ...
input_file = property(get_input_file, set_input_file)
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:
- input_file
- input_message
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- output_file
- output_message: The output data is written to this property if no other destination is specified.
input_message Property
The message to process.
Syntax
def get_input_message() -> bytes: ... def set_input_message(value: bytes) -> None: ...
input_message = property(get_input_message, set_input_message)
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:
- input_file
- input_message
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- output_file
- output_message: The output data is written to this property if no other destination is specified.
key Property
The 256 bit (32 byte) key to be used when computing a MAC (Message Authentication Code).
Syntax
def get_key() -> bytes: ... def set_key(value: bytes) -> None: ...
key = property(get_key, set_key)
Default Value
""
Remarks
This property holds the secret key used when computing the mac_value. The key must be 256 bits (32 bytes) long.
mac_value Property
The computed MAC value.
Syntax
def get_mac_value() -> bytes: ...
mac_value = property(get_mac_value, None)
Default Value
""
Remarks
The 128 bit (16 byte) MAC value calculated after calling compute_mac.
This property is read-only.
compute_mac Method
Computes the MAC.
Syntax
def compute_mac() -> None: ...
Remarks
compute_mac computes the MAC (Message Authentication Code) from the input data.
Before calling this method set key to a 256 bit (32 byte) key. If encode_mac 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 mac_value 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);
compute_mac_block Method
Computes the MAC value of specified data.
Syntax
def compute_mac_block(input_buffer: bytes, last_block: bool) -> bytes: ...
Remarks
compute_mac_block 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);
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
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.
reset Method
Resets the class.
Syntax
def reset() -> None: ...
Remarks
When called, the class will reset all of its properties to their default values.
on_error Event
Information about errors during data delivery.
Syntax
class Poly1305ErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class Poly1305: @property def on_error() -> Callable[[Poly1305ErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[Poly1305ErrorEventParams], None]) -> None: ...
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
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.
on_progress Event
Fired as progress is made.
Syntax
class Poly1305ProgressEventParams(object): @property def bytes_processed() -> int: ... @property def percent_processed() -> int: ... # In class Poly1305: @property def on_progress() -> Callable[[Poly1305ProgressEventParams], None]: ... @on_progress.setter def on_progress(event_hook: Callable[[Poly1305ProgressEventParams], None]) -> None: ...
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.
Poly1305 Config Settings
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation. By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to True tells the class to use the internal implementation instead of using the system's security API. |
Poly1305 Errors
Poly1305 Errors
| 104 Cannot read or write file. | |
| 108 Invalid key size. | |
| 304 Cannot write file. | |
| 305 Cannot read file. |