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

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:

• InputFile
• InputMessage

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

Whether the MAC value is hex encoded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncodeMAC();
int SetEncodeMAC(int bEncodeMAC);

Unicode (Windows)
BOOL GetEncodeMAC();
INT SetEncodeMAC(BOOL bEncodeMAC);

int ipworksencrypt_poly1305_getencodemac(void* lpObj);
int ipworksencrypt_poly1305_setencodemac(void* lpObj, int bEncodeMAC);

bool GetEncodeMAC();
int SetEncodeMAC(bool bEncodeMAC);

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

The file to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* ipworksencrypt_poly1305_getinputfile(void* lpObj);
int ipworksencrypt_poly1305_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

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:

• 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.

Data Type

String

InputMessage Property (Poly1305 Class)

The message to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputMessage(char* &lpInputMessage, int &lenInputMessage);
int SetInputMessage(const char* lpInputMessage, int lenInputMessage);

Unicode (Windows)
INT GetInputMessage(LPSTR &lpInputMessage, INT &lenInputMessage);
INT SetInputMessage(LPCSTR lpInputMessage, INT lenInputMessage);

int ipworksencrypt_poly1305_getinputmessage(void* lpObj, char** lpInputMessage, int* lenInputMessage);
int ipworksencrypt_poly1305_setinputmessage(void* lpObj, const char* lpInputMessage, int lenInputMessage);

QByteArray GetInputMessage();
int SetInputMessage(QByteArray qbaInputMessage);

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:

• 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.

Data Type

Binary String

Key Property (Poly1305 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKey(char* &lpKey, int &lenKey);
int SetKey(const char* lpKey, int lenKey);

Unicode (Windows)
INT GetKey(LPSTR &lpKey, INT &lenKey);
INT SetKey(LPCSTR lpKey, INT lenKey);

int ipworksencrypt_poly1305_getkey(void* lpObj, char** lpKey, int* lenKey);
int ipworksencrypt_poly1305_setkey(void* lpObj, const char* lpKey, int lenKey);

QByteArray GetKey();
int SetKey(QByteArray qbaKey);

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

The computed MAC value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMACValue(char* &lpMACValue, int &lenMACValue);

Unicode (Windows)
INT GetMACValue(LPSTR &lpMACValue, INT &lenMACValue);

int ipworksencrypt_poly1305_getmacvalue(void* lpObj, char** lpMACValue, int* lenMACValue);

QByteArray GetMACValue();

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

Computes the MAC.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ComputeMAC();

Unicode (Windows)
INT ComputeMAC();

int ipworksencrypt_poly1305_computemac(void* lpObj);

int 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 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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ComputeMACBlock Method (Poly1305 Class)

Computes the MAC value of specified data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ComputeMACBlock(const char* lpInputBuffer, int lenInputBuffer, int bLastBlock, int *lpSize = NULL);

Unicode (Windows)
LPSTR ComputeMACBlock(LPCSTR lpInputBuffer, INT lenInputBuffer, BOOL bLastBlock, LPINT lpSize = NULL);

char* ipworksencrypt_poly1305_computemacblock(void* lpObj, const char* lpInputBuffer, int lenInputBuffer, int bLastBlock, int *lpSize);

QByteArray ComputeMACBlock(QByteArray qbaInputBuffer, bool bLastBlock);

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

Error Handling (C++)

This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Config Method (Poly1305 Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksencrypt_poly1305_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Reset Method (Poly1305 Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksencrypt_poly1305_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetInputStream Method (Poly1305 Class)

Sets the stream from which the class will read data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(IPWorksEncryptStream* sInputStream);

Unicode (Windows)
INT SetInputStream(IPWorksEncryptStream* sInputStream);

int ipworksencrypt_poly1305_setinputstream(void* lpObj, IPWorksEncryptStream* sInputStream);

int SetInputStream(IPWorksEncryptStream* sInputStream);

Remarks

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (Poly1305 Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(Poly1305ErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} Poly1305ErrorEventParams;


Unicode (Windows)
virtual INT FireError(Poly1305ErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} Poly1305ErrorEventParams;

#define EID_POLY1305_ERROR 1

virtual INT IPWORKSENCRYPT_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class Poly1305ErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(Poly1305ErrorEventParams *e);

// Or, subclass Poly1305 and override this emitter function.
virtual int FireError(Poly1305ErrorEventParams *e) {...}

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

Fired as progress is made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(Poly1305ProgressEventParams *e);

typedef struct {
  int64 BytesProcessed;
  int PercentProcessed;
  int reserved;
} Poly1305ProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(Poly1305ProgressEventParams *e);

typedef struct {
  LONG64 BytesProcessed;
  INT PercentProcessed;
  INT reserved;
} Poly1305ProgressEventParams;

#define EID_POLY1305_PROGRESS 2

virtual INT IPWORKSENCRYPT_CALL FireProgress(LONG64 &lBytesProcessed, INT &iPercentProcessed);

class Poly1305ProgressEventParams {
public:
  qint64 BytesProcessed();

  int PercentProcessed();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(Poly1305ProgressEventParams *e);

// Or, subclass Poly1305 and override this emitter function.
virtual int FireProgress(Poly1305ProgressEventParams *e) {...}

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.

IPWorksEncryptStream Type

Syntax

IPWorksEncryptStream (declared in ipworksencrypt.h)

Remarks

The Poly1305 class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksEncryptStream interface and pass the Poly1305 class an instance of that concrete class.

When implementing the IPWorksEncryptStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (Poly1305 Class)

Base Config Settings

Trappable Errors (Poly1305 Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Poly1305 Errors