components.h

Go to the documentation of this file.

//***********************************************************************************
//  Structural goo
//***********************************************************************************
//declare values that govern the definition of values below
#define TOOLKIT_SUBCOMPONENT_MULTIPLIER     25
#define TOOLKIT_ERROR_MULTIPLIER            500
#define TOOLKIT_ERROR_EXTENSIONS            100 //used to define additional errors within a component
                                                //care must be taken to insure that extensions don't
                                                //overlap other blocks of defined error codes

//ID for each major component of PKIF:      ||  covers components in:
#define TOOLKIT_ASN                         1   //PKIFX509ASN.lib
#define TOOLKIT_CACHE                       2   //PKIFCACHE.lib
#define TOOLKIT_CRYPTO                      3   //PKIFCRYPTO.lib
#define TOOLKIT_MESSAGE                     4   //PKIFCMS.lib
#define TOOLKIT_OCSP                        5   //PKIFOCSP.lib
#define TOOLKIT_PATH                        6   //PKIFPATH.lib
#define TOOLKIT_TAP                         7   //PKIFTAP.lib
#define TOOLKIT_TSP                         8   //PKIFTSP.lib
#define TOOLKIT_UTILS                       9   //PKIFUTILS.lib
#define TOOLKIT_APP                         10  //other components, app-defined, etc.
#define TOOLKIT_SCVP                        11  //PKIFSCVP.lib

//error bases - Each component defines it's own error codes using these values
//              as the basis for numbering.
#define TOOLKIT_ASN_ERROR_BASE              TOOLKIT_ERROR_MULTIPLIER * TOOLKIT_ASN      //ASN1Errors.h
#define TOOLKIT_SR_ERROR_BASE               TOOLKIT_ERROR_MULTIPLIER * TOOLKIT_CACHE    //CACCacheErrors.h
#define TOOLKIT_CRYPTO_ERROR_BASE           TOOLKIT_ERROR_MULTIPLIER * TOOLKIT_CRYPTO   //CACCryptoErrors.h; CACCAPIErrors.h
#define TOOLKIT_MESSAGE_ERROR_BASE          TOOLKIT_ERROR_MULTIPLIER * TOOLKIT_MESSAGE  //CACMessageErrors.h
#define TOOLKIT_OCSP_ERROR_BASE             TOOLKIT_ERROR_MULTIPLIER * TOOLKIT_OCSP     //PKIFOCSPErrors.h
#define TOOLKIT_PATH_ERROR_BASE             TOOLKIT_ERROR_MULTIPLIER * TOOLKIT_PATH     //CACPathErrors.h
#define TOOLKIT_TAP_ERROR_BASE              TOOLKIT_ERROR_MULTIPLIER * TOOLKIT_TAP      //PKIFTAPErrors.h
#define TOOLKIT_TSP_ERROR_BASE              TOOLKIT_ERROR_MULTIPLIER * TOOLKIT_TSP      //PKIFTSPErrors.h
#define TOOLKIT_UTILS_ERROR_BASE            TOOLKIT_ERROR_MULTIPLIER * TOOLKIT_UTILS    //CACCommonErrors.h
#define TOOLKIT_APP_DEFINED_ERROR_BASE      TOOLKIT_ERROR_MULTIPLIER * TOOLKIT_APP      //
#define TOOLKIT_SCVP_ERROR_BASE                 TOOLKIT_ERROR_MULTIPLIER * TOOLKIT_SCVP     

//subcomponent ID bases - Each mediator, colleague and significant class is assigned
//                        a subcomponent ID.  For each component of the library
//                        the associated subcomponents are numbered using the following
//                        values as the basis for numbering.
#define TOOLKIT_ASN_SUBCOMPONENT            TOOLKIT_SUBCOMPONENT_MULTIPLIER * TOOLKIT_ASN
#define TOOLKIT_SR_SUBCOMPONENT             TOOLKIT_SUBCOMPONENT_MULTIPLIER * TOOLKIT_CACHE
#define TOOLKIT_CRYPTO_SUBCOMPONENT         TOOLKIT_SUBCOMPONENT_MULTIPLIER * TOOLKIT_CRYPTO
#define TOOLKIT_MESSAGE_SUBCOMPONENT        TOOLKIT_SUBCOMPONENT_MULTIPLIER * TOOLKIT_MESSAGE
#define TOOLKIT_OCSP_SUBCOMPONENT           TOOLKIT_SUBCOMPONENT_MULTIPLIER * TOOLKIT_OCSP
#define TOOLKIT_PATH_SUBCOMPONENT           TOOLKIT_SUBCOMPONENT_MULTIPLIER * TOOLKIT_PATH
#define TOOLKIT_TAP_SUBCOMPONENT            TOOLKIT_SUBCOMPONENT_MULTIPLIER * TOOLKIT_TAP
#define TOOLKIT_TSP_SUBCOMPONENT            TOOLKIT_SUBCOMPONENT_MULTIPLIER * TOOLKIT_TSP
#define TOOLKIT_UTILS_SUBCOMPONENT          TOOLKIT_SUBCOMPONENT_MULTIPLIER * TOOLKIT_UTILS
#define TOOLKIT_APP_DEFINED_SUBCOMPONENT    TOOLKIT_SUBCOMPONENT_MULTIPLIER * TOOLKIT_APP
#define TOOLKIT_SCVP_SUBCOMPONENT           TOOLKIT_SUBCOMPONENT_MULTIPLIER * TOOLKIT_SCVP

//***********************************************************************************
//  Subcomponent IDs
//***********************************************************************************
//ASN-related components
#define TOOLKIT_EXTENSION_MEDIATOR          TOOLKIT_ASN_SUBCOMPONENT + 1
#define TOOLKIT_X509_ASN                    TOOLKIT_ASN_SUBCOMPONENT + 2

//PKIFSR components
#define TOOLKIT_SR_MEDIATOR                 TOOLKIT_SR_SUBCOMPONENT + 1
#define TOOLKIT_SR_CAPICERTUPDATE           TOOLKIT_SR_SUBCOMPONENT + 2
#define TOOLKIT_SR_CAPICRLUPDATE            TOOLKIT_SR_SUBCOMPONENT + 3
#define TOOLKIT_SR_CAPIREPOSITORY           TOOLKIT_SR_SUBCOMPONENT + 4
#define TOOLKIT_SR_CAPITRUSTROOTCRLSTORE    TOOLKIT_SR_SUBCOMPONENT + 5
#define TOOLKIT_SR_CAPITRUSTSTORE           TOOLKIT_SR_SUBCOMPONENT + 6
#define TOOLKIT_SR_CAPIUSERREPOSITORY       TOOLKIT_SR_SUBCOMPONENT + 7
#define TOOLKIT_SR_LDAPREPOSITORY           TOOLKIT_SR_SUBCOMPONENT + 8
#define TOOLKIT_SR_SIMPLECERTCACHE          TOOLKIT_SR_SUBCOMPONENT + 9
#define TOOLKIT_SR_SIMPLECRLCACHE           TOOLKIT_SR_SUBCOMPONENT + 10
#define TOOLKIT_SR_SIMPLEROOTSTORE          TOOLKIT_SR_SUBCOMPONENT + 11
#define TOOLKIT_SR_MISC                     TOOLKIT_SR_SUBCOMPONENT + 12 //added 11/19/2003
#define TOOLKIT_SR_NSSTRUSTSTORE            TOOLKIT_SR_SUBCOMPONENT + 13
#define TOOLKIT_SR_NSSTRUSTROOTCRLSTORE     TOOLKIT_SR_SUBCOMPONENT + 14
#define TOOLKIT_SR_NSSCRLUPDATE             TOOLKIT_SR_SUBCOMPONENT + 15
#define TOOLKIT_SR_NSSCERTUPDATE            TOOLKIT_SR_SUBCOMPONENT + 16
#define TOOLKIT_SR_NSSREPOSITORY            TOOLKIT_SR_SUBCOMPONENT + 17

//CACCRYPTO components
#define TOOLKIT_CRYPTO_MEDIATOR             TOOLKIT_CRYPTO_SUBCOMPONENT + 1
#define TOOLKIT_CRYPTO_CAPICRED             TOOLKIT_CRYPTO_SUBCOMPONENT + 2
#define TOOLKIT_CRYPTO_CAPI                 TOOLKIT_CRYPTO_SUBCOMPONENT + 3
#define TOOLKIT_CRYPTO_CAPIRAW              TOOLKIT_CRYPTO_SUBCOMPONENT + 4
#define TOOLKIT_CRYPTO_KEYMATERIAL          TOOLKIT_CRYPTO_SUBCOMPONENT + 5
#define TOOLKIT_CRYPTO_MISC                 TOOLKIT_CRYPTO_SUBCOMPONENT + 6 //added 11/19/2003
#define TOOLKIT_CRYPTO_NSS                  TOOLKIT_CRYPTO_SUBCOMPONENT + 7
#define TOOLKIT_CRYPTO_NSSRAW               TOOLKIT_CRYPTO_SUBCOMPONENT + 8
#define TOOLKIT_CRYPTO_NSSCRED              TOOLKIT_CRYPTO_SUBCOMPONENT + 9
#define TOOLKIT_CRYPTO_CRYPTOPP             TOOLKIT_CRYPTO_SUBCOMPONENT + 10
#define TOOLKIT_CRYPTO_CRYPTOPPRAW          TOOLKIT_CRYPTO_SUBCOMPONENT + 11
#define TOOLKIT_CRYPTO_CRYPTOPPCRED         TOOLKIT_CRYPTO_SUBCOMPONENT + 12

//CACMESSAGE components
#define TOOLKIT_MESSAGE_SIGNED_DATA         TOOLKIT_MESSAGE_SUBCOMPONENT + 1
#define TOOLKIT_MESSAGE_ATTR_MEDIATOR       TOOLKIT_MESSAGE_SUBCOMPONENT + 2
#define TOOLKIT_MESSAGE_ASN                 TOOLKIT_MESSAGE_SUBCOMPONENT + 3
#define TOOLKIT_MESSAGE_PARALLEL_HASH       TOOLKIT_MESSAGE_SUBCOMPONENT + 4
#define TOOLKIT_MESSAGE_ENVELOPED_DATA      TOOLKIT_MESSAGE_SUBCOMPONENT + 5
#define TOOLKIT_MESSAGE_CONTENT_INFO        TOOLKIT_MESSAGE_SUBCOMPONENT + 6

//CACPATH components
#define TOOLKIT_PATH_MEDIATOR               TOOLKIT_PATH_SUBCOMPONENT + 1
#define TOOLKIT_PATH_REV_STATUS_MEDIATOR    TOOLKIT_PATH_SUBCOMPONENT + 2
#define TOOLKIT_PATH_CRL_CHECKER            TOOLKIT_PATH_SUBCOMPONENT + 3
#define TOOLKIT_PATH_BASIC_CHECKS           TOOLKIT_PATH_SUBCOMPONENT + 4
#define TOOLKIT_PATH_BUILDER                TOOLKIT_PATH_SUBCOMPONENT + 5
#define TOOLKIT_PATH_VALIDATOR              TOOLKIT_PATH_SUBCOMPONENT + 6
#define TOOLKIT_PATH_MISC                   TOOLKIT_PATH_SUBCOMPONENT + 7 //added 11/19/2003

//CACUTILS (plus CACMODULE)
#define TOOLKIT_PKIF_DLL                    TOOLKIT_UTILS_SUBCOMPONENT + 1

//PKIFOCSP components
#define TOOLKIT_OCSP_ASN                    TOOLKIT_OCSP_SUBCOMPONENT + 1   //DER encode/decode wrapper classes
#define TOOLKIT_OCSP_CHECKER                TOOLKIT_OCSP_SUBCOMPONENT + 2   

//PKIFTAP components
#define TOOLKIT_TAP_ASN                     TOOLKIT_TAP_SUBCOMPONENT + 1    //DER encode/decode wrapper classes

//PKIFTSP components
#define TOOLKIT_TSP_ASN                     TOOLKIT_TSP_SUBCOMPONENT + 1    //DER encode/decode wrapper classes
#define TOOLKIT_TSP_TIMESTAMP_VERIFIER      TOOLKIT_TSP_SUBCOMPONENT + 2

//PKIFSCVP components
#define TOOLKIT_SCVP_ASN                    TOOLKIT_SCVP_SUBCOMPONENT + 1   //DER encode/decode wrapper classes
#define TOOLKIT_SCVP_PATH_BUILDER           TOOLKIT_SCVP_SUBCOMPONENT + 2
#define TOOLKIT_SCVP_PATH_VALIDATOR         TOOLKIT_SCVP_SUBCOMPONENT + 3
#define TOOLKIT_SCVP_PATH_PROCESSOR         TOOLKIT_SCVP_SUBCOMPONENT + 4   //Build and validate

//REVOCATION SOURCE TYPES (these values are returned when call GetRevocationSourceType on a CertStatus object)
#define REVSOURCE_UNKNOWN                   0   //component unknown or no determination was made
#define REVSOURCE_CRL                       1   //CPKIFX509CRLChecker made the determination
#define REVSOURCE_OCSP                      2   //CPKIFOCSPChecker made the determination