000022375 - How to determine the meaning of Keon Certificate Authority API numerical error messages

Document created by RSA Customer Support Employee on Jun 16, 2016Last modified by RSA Customer Support Employee on Apr 21, 2017
Version 2Show Document
  • View in full screen mode

Article Content

Article Number000022375
Applies ToKeon Certificate Authority 6.5.1 API
RSA Certificate Manager 6.6 API
IssueHow to determine the meaning of Keon Certificate Authority API numerical error messages
Resolution

Xrc.h, included with the KCA-API has all of the error codes listed in order from 0 for XrcOK. So for example ?XrcNOTFOUND? is the 12th item and is error code 11. You can cut and paste into a spreadsheet help count. Below is an example, you should refer to the file included with your API.

/*

Xrc.h

====================================================================

Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002

RSA Security Inc.

All rights reserved.

The information contained in this file is proprietary to

RSA Security Inc.

Redistribution and use in source and binary forms are not permitted

without specific prior written permission.

This notice must be preserved and due credit must be given to RSA Security

Inc. in all products derived from this software.

The name of the RSA Security Inc. may not be used to endorse or

promote products derived from this software without specific prior

written permission. This software is provided ``as is'' without

express or implied warranty.

=====================================================================

*/

 

#ifndef _xrc_h_

#define _xrc_h_

/*--------------------------------------------------------------------------*

*

*

* Core error codes, to be included by all RSA Security software.

*

*

*--------------------------------------------------------------------------*/

#if defined(__cplusplus)

extern "C" {

#endif

typedef enum

{

/*

* core (bad values or parameters, common failures, etc.)

*/

XrcOK = 0,

XrcBADPARAMETER, /* invalid parameter */

XrcNULLPARAMETER, /* NULL passed for non-optional argument */

XrcMISSINGPARAMETER, /* missing one or more paramters */

XrcBADVALUE, /* invalid or inappropriate value provided */

XrcNULLVALUE, /* NULL value found where non-NULL was expected */

XrcTYPEUNKNOWN, /* parameter type unknown */

XrcTYPEVIOLATION, /* parameter type mismatch */

XrcBADSYNTAX, /* syntax error */

XrcOVERLIMIT, /* too many items in list or array */

XrcEXISTS, /* member or object already exists */

XrcNOTFOUND, /* unable to locate requested member or object */

XrcUNKNOWN, /* unknown member of enumerated set encountered */

XrcAMBIGUOUS, /* unable to choose between multiple candidates */

XrcNOTSUPPORTED, /* requested mode or type not supported */

XrcNOTIMPLEMENTED, /* implementation not yet complete */

XrcPARTIALFAILURE, /* failure of optional portion of request */

XrcUNABLE, /* unspecified failure (a warning) */

XrcOTHERERROR, /* unspecified error (fatal) */

XrcLOGICERROR, /* implementation is flawed

(like a non-fatal assertion) */

/*

* memory and system resources

*/

XrcNOMEM, /* insufficient memory to complete operation */

XrcBADMEM, /* corrupted memory block or structure */

XrcBUFFERTOOSMALL, /* supplied buffer is too small */

XrcBUFFERTOOBIG, /* supplied buffer is too large */

XrcSYSUNABLE, /* insufficient system resources */

XrcLOCKFAILED, /* unable to acquire lock for file or object */

XrcUNLOCKFAILED, /* unable to release lock for file or object */

XrcBUSY, /* unable to process. Try again later */

/*

* file and other I/O streams

*/

XrcSOURCEEQUALSTARGET, /* source and target are not distinct */

XrcSOURCENOTFOUND, /* unable to locate source file */

XrcBADSOURCE, /* unable to open source file */

XrcTARGETNOTFOUND, /* unable to locate target file */

XrcBADTARGET, /* unable to create or open target file */

XrcBADPATH, /* one or more path components do not exist */

XrcREADFAILURE, /* unable to read data */

XrcWRITEFAILURE, /* unable to write data */

XrcNOTFILE, /* not a file */

XrcNOTDIRECTORY, /* not a directory */

XrcNOTFILEORDIRECTORY, /* not a file or directory */

XrcFILEEXISTS, /* file or directory already exists */

XrcFILEDOESNOTEXIST, /* file or directory does not exist */

XrcSEEKFAILED, /* unable to move stream pointer */

XrcSOCKETFAILURE, /* unable to complete socket operation */

XrcEOR, /* end of record encountered */

XrcEOF, /* end of file or stream encountered */

/*

* component session management

*/

XrcBADSESSION, /* invalid/corrupted session or control block */

XrcRESNOTSET, /* required session resource not set */

XrcRESUNKNOWN, /* unknown session resource */

XrcBADRESOURCE, /* A required resource value was not useable */

XrcSESSIONUNABLE, /* unable to create a cryptographic session */

XrcNOSESSION, /* attempt to perform a function requiring a */

/* session withouth first creating a session. */

/*

* crypto component session management. These return values provide for

* cryptographic device session management.

*

*/

XrcBADCRYPTOSESSION, /* invalid/corrupted session or control block */

XrcCRYPTOSESSIONUNABLE,/* unable to create a cryptographic session */

XrcCRYPTOSESSIONEXISTS,/* an (exlusive) session already exists on the device */

XrcNOCRYPTOSESSION, /* attempt to perform a function requiring a */

/* session without first creating a session. */

 

/*

* symbol table and other name binding

*/

XrcNOTDEFINED, /* name or variable not defined */

XrcNAMENOTFOUND, /* no value found for name */

XrcNAMEWRONGTYPE, /* cannot bind given type to this name */

/*

* miscellaneous

*/

XrcNODEVICE, /* hardware device unavailable */

XrcDBGNOTDEFINED, /* an operation requiring DEBUG to be defined

was requested when DEBUG was not defined */

XrcDEVICEERROR, /* hardware device reported error */

/*

* cryptographic and encoding operations

*/

XrcKEYTOOSMALL, /* operation requires a larger key */

XrcENCRYPTIONFAILURE, /* unable to complete encryption operation */

XrcDECRYPTIONFAILURE, /* unable to complete decryption operation */

XrcSIGNINGFAILURE, /* unable to complete signing operation */

XrcFAIL, /* verification of a signature failed */

XrcENCODINGFAILURE, /* unable to complete encoding operation */

XrcDECODINGFAILURE, /* unable to complete decoding operation */

XrcCONVERSIONFAILURE, /* unable to complete conversion operation */

XrcBADPIN, /* wrong password or pin value given */

XrcPINREQUIRED, /* password or pin is required */

XrcPINNOTREQUIRED, /* password or pin is not required */

XrcNOLOGIN, /* attempt to perform a function requiring a */

/* login, without first performing a login. */

XrcALREADYLOGGEDIN, /* the existence of a logged in session */

/* precludes completion of the operation */

XrcLOGONCONTINUE, /* logon is in progress on a M of N token */

XrcINCORRECTCARDSET, /* wrong card set */

XrcNOT1OFNCARDSET, /* not 1of1 card set */

/*

* Xuda

*/

XrcSCHEMACONFLICT, /* class to create exists and differs */

XrcSCHEMAUNKNOWN, /* cannot get schema for class */

XrcSCHEMAVIOLATION, /* object instance conflicts with schema */

XrcBADSCOPE, /* invalid LDAP search scope */

XrcREFUSED, /* request refused */

XrcPENDING, /* request is pending */

XrcDENIED, /* request/access denied */

XrcBADCERT, /* cert is corrupted or violates constraints */

XrcSUSPENDED, /* certificate's status is suspended */

/*

* XParse

*/

XrcDONE, /* stop processing (not an error) */

XrcNORESOURCE, /* Resource unknown or unavailable */

XrcMISSINGRESOURCE, /* Missing a required resource */

XrcQUERYFAILED, /* Query failed */

XrcCANTCONTINUE, /* some function can't continue

(error is already set in the XParseCB

structure errno member) */

/*

* WSAL, GALS, SMTP Client

*/

XrcTOOMANYHEADERS, /* too many response headers specified */

XrcNOSERVERADDRESS, /* no SMTP server address specified */

XrcNOFROMADDRESS, /* no from address specified */

XrcNORECIPIENT, /* no recipient specified */

XrcTOOMANYRECIPIENTS, /* maximum number of recipients exceeded */

/*

* unspecified module errors

*/

XrcERRNO, /* system error code is in global variable errno */

XrcXUDAUNABLE, /* unspecified failure in Xuda operation */

XrcDBUNABLE, /* unspecified failure in database operation */

XrcLDAPUNABLE, /* unspecified failure in LDAP operation */

XrcCONFIGUNABLE, /* unspecified failure in Config operation */

XrcLOGUNABLE, /* unspecified failure in LOG operation */

XrcWSALUNABLE, /* unspecified failure in WSAL operation */

XrcWEBSERVERUNABLE, /* unspecified failure communicating with

Web server */

XrcSMTPCLIENTUNABLE, /* unspecified failure in SMTP Client operation */

XrcSMTPSERVERUNABLE, /* unspecified failure communicating with

SMTP server */

XrcREGISTRYUNABLE, /* WIN32 registry failure */

/*

* NT specific

*/

XrcGETLASTERROR, /* call GetLastError() to get more information */

/*

* Possible callback return value

*/

XrcIGNORE, /* Behave as if the callback was not set */

/*

* Licensing

*/

XrcLICENSEEXCEEDED, /* License limit exceeded */

/*

* CA validity (for CA operations)

*/

XrcCAINACTIVE, /* CA is held, revoked, or retired */

/*

* Miscellaneous

*/

XrcNOSIGNATURE, /* a signature is required and is not present */

XrcTIMEDOUT, /* time allotted for operation has expired */

XrcPARAMETERMISMATCH, /* parameters provided do not match internal settings */

XrcSECURELOGSERVERNOTREACHABLE, /* secure logging server is not reachable */

XrcOPERATORALREADY, /* recovery operator has already participated */

XrcSHAREALREADY, /* smart card already used to enable recovery */

XrcSHAREUNKNOWN, /* smart card presented for recovery is invalid */

XrcBADCHAIN, /* the certificate's issuer chain is bad */

/*

* upgrade from KCS installation

*/

XrcKCSFILENOTOPENED, /* error opening KCS ldif file created for upgrade */

XrcKCSADMINCANOTFOUND, /* could not find the admin CAs in ldif file */

XrcKCSIOERROR, /* I/O error while processing ldif file */

/*

* end of list marker

*/

XrcRESERVED

} Xrc;

 

char *XC_XrcSymbol ( Xrc code );

Xrc XC_XrcCodeForSymbol ( char *symbol );

 

/*

* compatibility definitions

*/

#define XrcNOBUFFERSPACE XrcBUFFERTOOSMALL

#if defined(__cplusplus)

};

#endif

/*--------------------------------------------------------------------------*/

#endif

Legacy Article IDa28446

Attachments

    Outcomes