Poly1305 Component

Properties   Methods   Events   Config Settings   Errors  

The Poly1305 component may be used to produce a MAC (or Tag) value using the Poly1305 algorithm.

Syntax

TipcPoly1305

Remarks

The Poly1305 component 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 component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

EncodeMAC Property (Poly1305 Component)

Whether the MAC value is hex encoded.

Syntax

property EncodeMAC: Boolean read get_EncodeMAC write set_EncodeMAC;

Default Value

true

Remarks

This property specifies whether the computed MAC value is hex encoded. When set to True (default) the component 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.

InputFile Property (Poly1305 Component)

The file to process.

Syntax

property InputFile: String read get_InputFile write set_InputFile;

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 component 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

InputMessage Property (Poly1305 Component)

The message to process.

Syntax

property InputMessage: String read get_InputMessage write set_InputMessage;
property InputMessageB: TBytes read get_InputMessageB write set_InputMessageB;

Default Value

''

Remarks

This property specifies the message to be processed.

Input and Output Properties

The component 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Key Property (Poly1305 Component)

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

Syntax

property Key: String read get_Key write set_Key;
property KeyB: TBytes read get_KeyB write set_KeyB;

Default Value

''

Remarks

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

MACValue Property (Poly1305 Component)

The computed MAC value.

Syntax

property MACValue: String read get_MACValue;
property MACValueB: TBytes read get_MACValueB;

Default Value

''

Remarks

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

This property is read-only.

ComputeMAC Method (Poly1305 Component)

Computes the MAC.

Syntax

procedure ComputeMAC();

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 component 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 (Poly1305 Component)

Computes the MAC value of specified data.

Syntax

function ComputeMACBlock(InputBuffer: TBytes; LastBlock: Boolean): TBytes;

Remarks

ComputeMACBlock allows input to the component 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 (Poly1305 Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (Poly1305 Component)

Resets the component.

Syntax

procedure Reset();

Remarks

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

SetInputStream Method (Poly1305 Component)

Sets the stream from which the component will read data.

Syntax

procedure SetInputStream(InputStream: TStream);

Remarks

This method sets the stream from which the component will read data.

Input Notes

The component 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.

Error Event (Poly1305 Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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 (Poly1305 Component)

Fired as progress is made.

Syntax

type TProgressEvent = procedure (
  Sender: TObject;
  BytesProcessed: Int64;
  PercentProcessed: Integer
) of Object;

property OnProgress: TProgressEvent read FOnProgress write FOnProgress;

Remarks

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

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

The component 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 component, access to these internal properties is provided through the Config method.

Poly1305 Config Settings

Base Config Settings

Trappable Errors (Poly1305 Component)

Poly1305 Errors