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.

Class Name

IPWorksEncrypt_Poly1305

Procedural Interface

 ipworksencrypt_poly1305_open();
 ipworksencrypt_poly1305_close($res);
 ipworksencrypt_poly1305_register_callback($res, $id, $function);
 ipworksencrypt_poly1305_get_last_error($res);
 ipworksencrypt_poly1305_get_last_error_code($res);
 ipworksencrypt_poly1305_set($res, $id, $index, $value);
 ipworksencrypt_poly1305_get($res, $id, $index);
 ipworksencrypt_poly1305_do_computemac($res);
 ipworksencrypt_poly1305_do_computemacblock($res, $inputbuffer, $lastblock);
 ipworksencrypt_poly1305_do_config($res, $configurationstring);
 ipworksencrypt_poly1305_do_reset($res);

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:

• InputFile
• InputMessage

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.

Method List

---

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

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.

Config Settings

---

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

EncodeMAC Property (IPWorksEncrypt_Poly1305 Class)

Whether the MAC value is hex encoded.

Object Oriented Interface

public function getEncodeMAC();
public function setEncodeMAC($value);

Procedural Interface

ipworksencrypt_poly1305_get($res, 1 );
ipworksencrypt_poly1305_set($res, 1, $value );

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.

Data Type

Boolean

InputFile Property (IPWorksEncrypt_Poly1305 Class)

The file to process.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

ipworksencrypt_poly1305_get($res, 2 );
ipworksencrypt_poly1305_set($res, 2, $value );

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.

Data Type

String

InputMessage Property (IPWorksEncrypt_Poly1305 Class)

The message to process.

Object Oriented Interface

public function getInputMessage();
public function setInputMessage($value);

Procedural Interface

ipworksencrypt_poly1305_get($res, 3 );
ipworksencrypt_poly1305_set($res, 3, $value );

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.

Data Type

Binary String

Key Property (IPWorksEncrypt_Poly1305 Class)

The 256 bit (32 byte) key to be used when computing a MAC (Message Authentication Code).

Object Oriented Interface

public function getKey();
public function setKey($value);

Procedural Interface

ipworksencrypt_poly1305_get($res, 4 );
ipworksencrypt_poly1305_set($res, 4, $value );

Default Value

''

Remarks

This property holds the secret key used when computing the MACValue. The key must be 256 bits (32 bytes) long.

Data Type

Binary String

MACValue Property (IPWorksEncrypt_Poly1305 Class)

The computed MAC value.

Object Oriented Interface

public function getMACValue();

Procedural Interface

ipworksencrypt_poly1305_get($res, 5 );

Default Value

''

Remarks

The 128 bit (16 byte) MAC value calculated after calling ComputeMAC.

This property is read-only.

Data Type

Binary String

ComputeMAC Method (IPWorksEncrypt_Poly1305 Class)

Computes the MAC.

Object Oriented Interface

public function doComputeMAC();

Procedural Interface

ipworksencrypt_poly1305_do_computemac($res);

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:

• InputFile
• InputMessage

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 Method (IPWorksEncrypt_Poly1305 Class)

Computes the MAC value of specified data.

Object Oriented Interface

public function doComputeMACBlock($inputbuffer, $lastblock);

Procedural Interface

ipworksencrypt_poly1305_do_computemacblock($res, $inputbuffer, $lastblock);

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);

Config Method (IPWorksEncrypt_Poly1305 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksencrypt_poly1305_do_config($res, $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.

Reset Method (IPWorksEncrypt_Poly1305 Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksencrypt_poly1305_do_reset($res);

Remarks

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

Error Event (IPWorksEncrypt_Poly1305 Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksencrypt_poly1305_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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 (IPWorksEncrypt_Poly1305 Class)

Fired as progress is made.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

ipworksencrypt_poly1305_register_callback($res, 2, array($this, 'fireProgress'));

Parameter List

 'bytesprocessed'
 '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.

Config Settings (Poly1305 Class)

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

Trappable Errors (Poly1305 Class)

Poly1305 Errors