/security/nss/lib/libpkix/pkix_pl_nss/module/pkix_pl_ldaprequest.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_pl_ldaprequest.h
 39 *
 40 * LdapRequest Object Definitions
 41 *
 42 */
 43
 44#ifndef _PKIX_PL_LDAPREQUEST_H
 45#define _PKIX_PL_LDAPREQUEST_H
 46
 47#include "pkix_pl_common.h"
 48
 49#ifdef __cplusplus
 50extern "C" {
 51#endif
 52
 53typedef enum {
 54        USER_CERT,
 55        CA_CERT,
 56        CROSS_CERT,
 57        CRL,
 58        ARL,
 59        DELTA_CRL
 60} PKIX_PL_LdapAttr;
 61
 62struct PKIX_PL_LdapRequestStruct{
 63        PRArenaPool *arena;
 64        PKIX_UInt32 msgnum;
 65        char *issuerDN;
 66        ScopeType scope;
 67        DerefType derefAliases;
 68        PKIX_UInt32 sizeLimit;
 69        PKIX_UInt32 timeLimit;
 70        char attrsOnly;
 71        LDAPFilter *filter;
 72        LdapAttrMask attrBits;
 73        SECItem attributes[MAX_LDAPATTRS];
 74        SECItem **attrArray;
 75        SECItem *encoded;
 76};
 77
 78/* see source file for function documentation */
 79
 80PKIX_Error *
 81pkix_pl_LdapRequest_Create(
 82        PRArenaPool *arena,
 83        PKIX_UInt32 msgnum,
 84        char *issuerDN,
 85        ScopeType scope,
 86        DerefType derefAliases,
 87        PKIX_UInt32 sizeLimit,
 88        PKIX_UInt32 timeLimit,
 89        char attrsOnly,
 90        LDAPFilter *filter,
 91        LdapAttrMask attrBits,
 92        PKIX_PL_LdapRequest **pRequestMsg,
 93        void *plContext);
 94
 95PKIX_Error *
 96pkix_pl_LdapRequest_AttrTypeToBit(
 97        SECItem *attrType,
 98        LdapAttrMask *pAttrBit,
 99        void *plContext);
100
101PKIX_Error *
102pkix_pl_LdapRequest_AttrStringToBit(
103        char *attrString,
104        LdapAttrMask *pAttrBit,
105        void *plContext);
106
107PKIX_Error *
108pkix_pl_LdapRequest_GetEncoded(
109        PKIX_PL_LdapRequest *request,
110        SECItem **pRequestBuf,
111        void *plContext);
112
113PKIX_Error *pkix_pl_LdapRequest_RegisterSelf(void *plContext);
114
115#ifdef __cplusplus
116}
117#endif
118
119#endif /* _PKIX_PL_LDAPREQUEST_H */