michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: /*
michael@0:  * pkix_ekuchecker.h
michael@0:  *
michael@0:  * User Defined Object Type Extended Key Usage Definition
michael@0:  *
michael@0:  */
michael@0: 
michael@0: #ifndef _PKIX_EKUCHECKER_H
michael@0: #define _PKIX_EKUCHECKER_H
michael@0: 
michael@0: #include "pkix_pl_common.h"
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: extern "C" {
michael@0: #endif
michael@0: 
michael@0: /*
michael@0:  * FUNCTION: PKIX_PL_EkuChecker_Create
michael@0:  *
michael@0:  * DESCRIPTION:
michael@0:  *  Create a CertChainChecker with EkuCheckerState and add it into
michael@0:  *  PKIX_ProcessingParams object.
michael@0:  *
michael@0:  * PARAMETERS
michael@0:  *  "params"
michael@0:  *      a PKIX_ProcessingParams links to PKIX_ComCertSelParams where a list of
michael@0:  *      Extended Key Usage OIDs specified by application can be retrieved for
michael@0:  *      verification.
michael@0:  *  "ekuChecker" 
michael@0:  *      Address of created ekuchecker.
michael@0:  *  "plContext"
michael@0:  *      Platform-specific context pointer.
michael@0:  *
michael@0:  * THREAD SAFETY:
michael@0:  *  Thread Safe (see Thread Safety Definitions in Programmer's Guide)
michael@0:  *
michael@0:  * RETURNS:
michael@0:  *  Returns NULL if the function succeeds.
michael@0:  *  Returns a UserDefinedModules Error if the function fails in a non-fatal
michael@0:  *  way.
michael@0:  *  Returns a Fatal Error
michael@0:  */
michael@0: PKIX_Error *
michael@0: PKIX_EkuChecker_Create(
michael@0:         PKIX_ProcessingParams *params,
michael@0:         PKIX_CertChainChecker **ekuChecker,
michael@0:         void *plContext);
michael@0: 
michael@0: /*
michael@0:  * FUNCTION: PKIX_PL_EkuChecker_GetRequiredEku
michael@0:  *
michael@0:  * DESCRIPTION:
michael@0:  *  This function retrieves application specified ExtenedKeyUsage(s) from
michael@0:  *  ComCertSetparams and converts its OID representations to SECCertUsageEnum.
michael@0:  *  The result is stored and returned in bit mask at "pRequiredExtKeyUsage".
michael@0:  *
michael@0:  * PARAMETERS
michael@0:  *  "certSelector"
michael@0:  *      a PKIX_CertSelector links to PKIX_ComCertSelParams where a list of
michael@0:  *      Extended Key Usage OIDs specified by application can be retrieved for
michael@0:  *      verification. Must be non-NULL.
michael@0:  *  "pRequiredExtKeyUsage"
michael@0:  *      Address where the result is returned. Must be non-NULL.
michael@0:  *  "plContext"
michael@0:  *      Platform-specific context pointer.
michael@0:  *
michael@0:  * THREAD SAFETY:
michael@0:  *  Thread Safe (see Thread Safety Definitions in Programmer's Guide)
michael@0:  *
michael@0:  * RETURNS:
michael@0:  *  Returns NULL if the function succeeds.
michael@0:  *  Returns a UserDefinedModules Error if the function fails in a non-fatal
michael@0:  *  way.
michael@0:  *  Returns a Fatal Error
michael@0:  */
michael@0: PKIX_Error *
michael@0: pkix_EkuChecker_GetRequiredEku(
michael@0:         PKIX_CertSelector *certSelector,
michael@0:         PKIX_UInt32 *pRequiredExtKeyUsage,
michael@0:         void *plContext);
michael@0: 
michael@0: /* see source file for function documentation */
michael@0: PKIX_Error *pkix_EkuChecker_RegisterSelf(void *plContext);
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: }
michael@0: #endif
michael@0: 
michael@0: #endif /* _PKIX_PL_EKUCHECKER_H */