iqr_retval.h File Reference

ISARA Radiate Quantum-Safe Library's return values. More...

Enumerations
enum	iqr_retval {   IQR_OK = 0,   IQR_ENULLPTR = -1001,   IQR_ENOMEM = -1002,   IQR_ENOTINIT = -1003,   IQR_EINVBUFSIZE = -1004,   IQR_EBADVALUE = -1005,   IQR_EOUTOFRANGE = -1006,   IQR_EVALUENOTSUPP = -1007,   IQR_EINVOBJECT = -1008,   IQR_EINVCALLBACKS = -1009,   IQR_ENOTREGISTERED = -1010,   IQR_EINVDATA = -1011,   IQR_EINVPTR = -1012,   IQR_EPTROVERLAP = -1013,   IQR_ELIBRARYMISMATCH = -1014,   IQR_EINVSTRATEGY = -1015,   IQR_EVERSIONMISMATCH = -1016,   IQR_EINVALGOSTATE = -2001,   IQR_EINVHASHALGO = -2002,   IQR_EINVPUBLICKEY = -3001,   IQR_EINVPRIVATEKEY = -3002,   IQR_EINVSYMKEY = -3003,   IQR_EKEYPAIRMISMATCH = -3004,   IQR_EINVSIGNATURE = -3006,   IQR_ESTATEDEPLETED = -3007,   IQR_ENOTSEEDED = -4001,   IQR_ERESEED = -4002,   IQR_EDECRYPTIONFAILED = -5001 }

Functions
const IQR_API char *	iqr_StrError (iqr_retval ret)

Enumeration Type Documentation

iqr_retval

enum iqr_retval

Enumerator
IQR_OK	Success, function completed successfully.
IQR_ENULLPTR	A NULL pointer was passed in where a valid pointer was expected.
IQR_ENOMEM	Memory allocation failed.
IQR_ENOTINIT	The specified structure is not initialized.
IQR_EINVBUFSIZE	The provided buffer has an invalid size.
IQR_EBADVALUE	The parameter value is not valid.
IQR_EOUTOFRANGE	The parameter value is out of range.
IQR_EVALUENOTSUPP	The parameter value is valid but not supported.
IQR_EINVOBJECT	The object is invalid.
IQR_EINVCALLBACKS	The provided callback pointers are invalid.
IQR_ENOTREGISTERED	Callbacks to an algorithm were not registered prior to use.
IQR_EINVDATA	The provided data is invalid. For signature schemes, @c ::IQR_EINVDATA indicates a corrupted signature buffer.
IQR_EINVPTR	Output pointer parameters must be initialized to NULL prior to function call.
IQR_EPTROVERLAP	Input and output pointers must not be overlapping buffers.
IQR_ELIBRARYMISMATCH	Library version does not match header version.
IQR_EINVSTRATEGY	The chosen tree strategy cannot be used for this function.
IQR_EVERSIONMISMATCH	The object version does not match the library version.
IQR_EINVALGOSTATE	The algorithm state is invalid.
IQR_EINVHASHALGO	The provided hashing algorithm is not valid for this key type.
IQR_EINVPUBLICKEY	The public key is invalid.
IQR_EINVPRIVATEKEY	The private key is invalid.
IQR_EINVSYMKEY	The symmetric key is invalid.
IQR_EKEYPAIRMISMATCH	The public key is not derived from the private key.
IQR_EINVSIGNATURE	The signature of the message is invalid. The signature, public key, and message don't match. This could mean that the message has been modified, or that the signature has been tampered with, possibly by an adversary.
IQR_ESTATEDEPLETED	The state cannot be used to create more signatures.
IQR_ENOTSEEDED	The Random Number Generator has not been seeded.
IQR_ERESEED	The Random Number Generator must be reseeded.
IQR_EDECRYPTIONFAILED	The decryption algorithm failed to decrypt the ciphertext.

Function Documentation

iqr_StrError()

const IQR_API char* iqr_StrError

(

iqr_retval

ret

)

Convert an iqr_retval error code into an English string.

Note

Not suitable for use in programs that need internationalization.

Parameters

[in]

ret

An IQR_* error value.

Returns

A pointer to a string describing the error value, or a pointer to a string indicating an unknown error value.

Detailed Description

ISARA Radiate Quantum-Safe Library's return values.

Every toolkit function that returns an iqr_retval value will return an appropriate value from this list. IQR_OK is always used to indicate success.

Copyright

Copyright (C) 2015-2023, ISARA Corporation, All Rights Reserved.

License

The code and other content set out herein is not in the public domain, is considered a trade secret and is confidential to ISARA Corporation. Use, reproduction or distribution, in whole or in part, of such code or other content is strictly prohibited except by express written permission of ISARA Corporation. Please contact ISARA Corporation at info@.nosp@m.isar.nosp@m.a.com for more information.