ISARA Radiate™ Quantum-safe Library Version 3.1

Quantum-safe cryptographic primitives and algorithms.

iqr_retval.h
Go to the documentation of this file.
1 
19 #ifndef IQR_RETVAL_H
20 #define IQR_RETVAL_H
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
26 #include "iqr_api.h"
27 
28 typedef enum {
30  IQR_OK = 0,
31 
32  // -----------------------------------------------------------------------------------------------------------------------------
33  // General error values.
34  // -----------------------------------------------------------------------------------------------------------------------------
35 
37  IQR_ENULLPTR = -1001,
38 
40  IQR_ENOMEM = -1002,
41 
43  IQR_ENOTINIT = -1003,
44 
46  IQR_EINVBUFSIZE = -1004,
47 
49  IQR_EBADVALUE = -1005,
50 
52  IQR_EOUTOFRANGE = -1006,
53 
56 
58  IQR_EINVOBJECT = -1008,
59 
62 
65 
70  IQR_EINVDATA = -1011,
71 
74  IQR_EINVPTR = -1012,
75 
77  IQR_EPTROVERLAP = -1013,
78 
81 
84 
87 
88  // -----------------------------------------------------------------------------------------------------------------------------
89  // Algorithm error values.
90  // -----------------------------------------------------------------------------------------------------------------------------
91 
94 
97 
98  // -----------------------------------------------------------------------------------------------------------------------------
99  // Key error values.
100  // -----------------------------------------------------------------------------------------------------------------------------
101 
104 
107 
109  IQR_EINVSYMKEY = -3003,
110 
113 
120 
123 
124  // -----------------------------------------------------------------------------------------------------------------------------
125  // Random Number Generator error values.
126  // -----------------------------------------------------------------------------------------------------------------------------
127 
129  IQR_ENOTSEEDED = -4001,
130 
132  IQR_ERESEED = -4002,
133 
134  // -----------------------------------------------------------------------------------------------------------------------------
135  // Crypto error values.
136  // -----------------------------------------------------------------------------------------------------------------------------
137 
140 } iqr_retval;
141 
142 // ---------------------------------------------------------------------------------------------------------------------------------
143 // Helper functions.
144 // ---------------------------------------------------------------------------------------------------------------------------------
145 
155 IQR_API
156 const char *iqr_StrError(iqr_retval ret);
157 
158 #ifdef __cplusplus
159 }
160 #endif
161 
162 #endif /* IQR_RETVAL_H */
@ IQR_ENOTREGISTERED
Callbacks to an algorithm were not registered prior to use.
Definition: iqr_retval.h:64
@ IQR_EVALUENOTSUPP
The parameter value is valid but not supported.
Definition: iqr_retval.h:55
@ IQR_EPTROVERLAP
Input and output pointers must not be overlapping buffers.
Definition: iqr_retval.h:77
@ IQR_EINVCALLBACKS
The provided callback pointers are invalid.
Definition: iqr_retval.h:61
@ IQR_EINVDATA
Definition: iqr_retval.h:70
@ IQR_EINVHASHALGO
The provided hashing algorithm is not valid for this key type.
Definition: iqr_retval.h:96
@ IQR_OK
Success, function completed successfully.
Definition: iqr_retval.h:30
@ IQR_ENOTSEEDED
The Random Number Generator has not been seeded.
Definition: iqr_retval.h:129
@ IQR_EINVSYMKEY
The symmetric key is invalid.
Definition: iqr_retval.h:109
@ IQR_EVERSIONMISMATCH
The object version does not match the library version.
Definition: iqr_retval.h:86
@ IQR_EINVBUFSIZE
The provided buffer has an invalid size.
Definition: iqr_retval.h:46
@ IQR_EINVSTRATEGY
The chosen tree strategy cannot be used for this function.
Definition: iqr_retval.h:83
@ IQR_ELIBRARYMISMATCH
Library version does not match header version.
Definition: iqr_retval.h:80
@ IQR_EINVPUBLICKEY
The public key is invalid.
Definition: iqr_retval.h:103
@ IQR_ERESEED
The Random Number Generator must be reseeded.
Definition: iqr_retval.h:132
@ IQR_ENOMEM
Memory allocation failed.
Definition: iqr_retval.h:40
@ IQR_EINVPRIVATEKEY
The private key is invalid.
Definition: iqr_retval.h:106
@ IQR_EINVPTR
Definition: iqr_retval.h:74
@ IQR_EOUTOFRANGE
The parameter value is out of range.
Definition: iqr_retval.h:52
@ IQR_EINVALGOSTATE
The algorithm state is invalid.
Definition: iqr_retval.h:93
@ IQR_EKEYPAIRMISMATCH
The public key is not derived from the private key.
Definition: iqr_retval.h:112
@ IQR_ENOTINIT
The specified structure is not initialized.
Definition: iqr_retval.h:43
@ IQR_ESTATEDEPLETED
The state cannot be used to create more signatures.
Definition: iqr_retval.h:122
iqr_retval
Definition: iqr_retval.h:28
ISARA Radiate Quantum-Safe Library's API declarations.
@ IQR_EBADVALUE
The parameter value is not valid.
Definition: iqr_retval.h:49
@ IQR_ENULLPTR
A NULL pointer was passed in where a valid pointer was expected.
Definition: iqr_retval.h:37
@ IQR_EINVSIGNATURE
Definition: iqr_retval.h:119
@ IQR_EINVOBJECT
The object is invalid.
Definition: iqr_retval.h:58
const IQR_API char * iqr_StrError(iqr_retval ret)
@ IQR_EDECRYPTIONFAILED
The decryption algorithm failed to decrypt the ciphertext.
Definition: iqr_retval.h:139