/security/nss/lib/libpkix/pkix/checker/pkix_ekuchecker.h

  1/* ***** BEGIN LICENSE BLOCK *****
  2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3 *
  4 * The contents of this file are subject to the Mozilla Public License Version
  5 * 1.1 (the "License"); you may not use this file except in compliance with
  6 * the License. You may obtain a copy of the License at
  7 * http://www.mozilla.org/MPL/
  8 *
  9 * Software distributed under the License is distributed on an "AS IS" basis,
 10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 11 * for the specific language governing rights and limitations under the
 12 * License.
 13 *
 14 * The Original Code is the PKIX-C library.
 15 *
 16 * The Initial Developer of the Original Code is
 17 * Sun Microsystems, Inc.
 18 * Portions created by the Initial Developer are
 19 * Copyright 2004-2007 Sun Microsystems, Inc.  All Rights Reserved.
 20 *
 21 * Contributor(s):
 22 *   Sun Microsystems, Inc.
 23 *
 24 * Alternatively, the contents of this file may be used under the terms of
 25 * either the GNU General Public License Version 2 or later (the "GPL"), or
 26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 27 * in which case the provisions of the GPL or the LGPL are applicable instead
 28 * of those above. If you wish to allow use of your version of this file only
 29 * under the terms of either the GPL or the LGPL, and not to allow others to
 30 * use your version of this file under the terms of the MPL, indicate your
 31 * decision by deleting the provisions above and replace them with the notice
 32 * and other provisions required by the GPL or the LGPL. If you do not delete
 33 * the provisions above, a recipient may use your version of this file under
 34 * the terms of any one of the MPL, the GPL or the LGPL.
 35 *
 36 * ***** END LICENSE BLOCK ***** */
 37/*
 38 * pkix_ekuchecker.h
 39 *
 40 * User Defined Object Type Extended Key Usage Definition
 41 *
 42 */
 43
 44#ifndef _PKIX_EKUCHECKER_H
 45#define _PKIX_EKUCHECKER_H
 46
 47#include "pkix_pl_common.h"
 48
 49#ifdef __cplusplus
 50extern "C" {
 51#endif
 52
 53/*
 54 * FUNCTION: PKIX_PL_EkuChecker_Create
 55 *
 56 * DESCRIPTION:
 57 *  Create a CertChainChecker with EkuCheckerState and add it into
 58 *  PKIX_ProcessingParams object.
 59 *
 60 * PARAMETERS
 61 *  "params"
 62 *      a PKIX_ProcessingParams links to PKIX_ComCertSelParams where a list of
 63 *      Extended Key Usage OIDs specified by application can be retrieved for
 64 *      verification.
 65 *  "ekuChecker" 
 66 *      Address of created ekuchecker.
 67 *  "plContext"
 68 *      Platform-specific context pointer.
 69 *
 70 * THREAD SAFETY:
 71 *  Thread Safe (see Thread Safety Definitions in Programmer's Guide)
 72 *
 73 * RETURNS:
 74 *  Returns NULL if the function succeeds.
 75 *  Returns a UserDefinedModules Error if the function fails in a non-fatal
 76 *  way.
 77 *  Returns a Fatal Error
 78 */
 79PKIX_Error *
 80PKIX_EkuChecker_Create(
 81        PKIX_ProcessingParams *params,
 82        PKIX_CertChainChecker **ekuChecker,
 83        void *plContext);
 84
 85/*
 86 * FUNCTION: PKIX_PL_EkuChecker_GetRequiredEku
 87 *
 88 * DESCRIPTION:
 89 *  This function retrieves application specified ExtenedKeyUsage(s) from
 90 *  ComCertSetparams and converts its OID representations to SECCertUsageEnum.
 91 *  The result is stored and returned in bit mask at "pRequiredExtKeyUsage".
 92 *
 93 * PARAMETERS
 94 *  "certSelector"
 95 *      a PKIX_CertSelector links to PKIX_ComCertSelParams where a list of
 96 *      Extended Key Usage OIDs specified by application can be retrieved for
 97 *      verification. Must be non-NULL.
 98 *  "pRequiredExtKeyUsage"
 99 *      Address where the result is returned. Must be non-NULL.
100 *  "plContext"
101 *      Platform-specific context pointer.
102 *
103 * THREAD SAFETY:
104 *  Thread Safe (see Thread Safety Definitions in Programmer's Guide)
105 *
106 * RETURNS:
107 *  Returns NULL if the function succeeds.
108 *  Returns a UserDefinedModules Error if the function fails in a non-fatal
109 *  way.
110 *  Returns a Fatal Error
111 */
112PKIX_Error *
113pkix_EkuChecker_GetRequiredEku(
114        PKIX_CertSelector *certSelector,
115        PKIX_UInt32 *pRequiredExtKeyUsage,
116        void *plContext);
117
118/* see source file for function documentation */
119PKIX_Error *pkix_EkuChecker_RegisterSelf(void *plContext);
120
121#ifdef __cplusplus
122}
123#endif
124
125#endif /* _PKIX_PL_EKUCHECKER_H */