iqr_retval.h

Go to the documentation of this file.

#ifndef IQR_RETVAL_H
#define IQR_RETVAL_H

#ifdef __cplusplus
extern "C" {
#endif

#include "iqr_api.h"

typedef enum {
    IQR_OK                  = 0,

    // -----------------------------------------------------------------------------------------------------------------------------
    // General error values.
    // -----------------------------------------------------------------------------------------------------------------------------

    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,

    // -----------------------------------------------------------------------------------------------------------------------------
    // Algorithm error values.
    // -----------------------------------------------------------------------------------------------------------------------------

    IQR_EINVALGOSTATE       = -2001,

    IQR_EINVHASHALGO        = -2002,

    // -----------------------------------------------------------------------------------------------------------------------------
    // Key error values.
    // -----------------------------------------------------------------------------------------------------------------------------

    IQR_EINVPUBLICKEY       = -3001,

    IQR_EINVPRIVATEKEY      = -3002,

    IQR_EINVSYMKEY          = -3003,

    IQR_EKEYPAIRMISMATCH    = -3004,

    IQR_EINVSIGNATURE       = -3006,

    IQR_ESTATEDEPLETED      = -3007,

    IQR_ESTATECORRUPTED     = -3008,

    // -----------------------------------------------------------------------------------------------------------------------------
    // Random Number Generator error values.
    // -----------------------------------------------------------------------------------------------------------------------------

    IQR_ENOTSEEDED          = -4001,

    IQR_ERESEED             = -4002,

    // -----------------------------------------------------------------------------------------------------------------------------
    // Crypto error values.
    // -----------------------------------------------------------------------------------------------------------------------------

    IQR_EDECRYPTIONFAILED   = -5001,

    IQR_EINVPLAINTEXTSIZE   = -5002,

    IQR_EINVCIPHERTEXTSIZE  = -5003,

    // -----------------------------------------------------------------------------------------------------------------------------
    // Bignum error values.
    // -----------------------------------------------------------------------------------------------------------------------------

    IQR_EINTOVERFLOW        = -6001,

    IQR_EDIVBYZERO          = -6002,

    IQR_EBADRESULT          = -6003,

    // -----------------------------------------------------------------------------------------------------------------------------
    // FIPS 140-2 error values.
    //
    // These will only be returned when using the FIPS 140-2 certified version
    // of the toolkit.
    // -----------------------------------------------------------------------------------------------------------------------------

    IQR_EFIPS140_FAILED       = -7001,

    IQR_EFIPS140_NOTAVAIL     = -7002,

    IQR_EFIPS140_RNGNOTCLEARED = -7003,

    IQR_EFIPS140_INTEGRITY_KEY = -7004,

    IQR_EFIPS140_INTEGRITY_TAG = -7005,

    IQR_EFIPS140_INTEGRITY_BINARY = -7006,

    IQR_EFIPS140_INTEGRITY_VALIDATION = -7007

} iqr_retval;

// ---------------------------------------------------------------------------------------------------------------------------------
// Helper functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
const char *iqr_StrError(iqr_retval ret);

#ifdef __cplusplus
}
#endif

#endif /* IQR_RETVAL_H */