Skip to content
Snippets Groups Projects
ldap.h 33.5 KiB
Newer Older
  • Learn to ignore specific revisions
  • /* $OpenLDAP$ */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    /*
    
     * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
     * All rights reserved.
     *
     * Redistribution and use in source and binary forms are permitted only
     * as authorized by the OpenLDAP Public License.  A copy of this
     * license is available at http://www.OpenLDAP.org/license.html or
     * in file LICENSE in the top-level directory of the distribution.
     */
    /* Portions
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
     * Copyright (c) 1990 Regents of the University of Michigan.
     * All rights reserved.
     *
     * Redistribution and use in source and binary forms are permitted
     * provided that this notice is preserved and that due credit is given
     * to the University of Michigan at Ann Arbor. The name of the University
     * 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 _LDAP_H
    #define _LDAP_H
    
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    
    /* draft spec requires ldap.h include lber declarations */
    #include <lber.h>
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    #define LDAP_VERSION1	1
    #define LDAP_VERSION2	2
    
    #define LDAP_VERSION3	3
    
    #define LDAP_VERSION_MIN	LDAP_VERSION2
    #define	LDAP_VERSION		LDAP_VERSION2
    #define LDAP_VERSION_MAX	LDAP_VERSION3
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    
    /*
     * We'll use 2000+draft revision for our API version number
     * As such, the number will be above the old RFC but below 
     * whatever number does finally get assigned
     */
    #define LDAP_API_VERSION	2003
    #define LDAP_VENDOR_NAME	"OpenLDAP"
    /* We'll eventually release as 200 */
    #define LDAP_VENDOR_VERSION	192
    
    /* OpenLDAP API Features */
    #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
    
    /* include LDAP_API_FEATURE defines */
    #include <ldap_features.h>
    
    #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
    	( defined( LDAP_THREAD_SAFE ) && \
    		defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
    	/* -lldap may or may not be thread safe */
    	/* -lldap_r, if available, is always thread safe */
    #	define	LDAP_API_FEATURE_THREAD_SAFE 1
    #endif
    #if defined( LDAP_THREAD_SAFE ) && \
    	defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
    /* #define LDAP_API_FEATURE_SESSION_SAFE	1	*/
    /* #define LDAP_API_OPERATION_SESSION_SAFE	1	*/
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    #endif
    
    
    #define LDAP_PORT		389		/* ldap:///		default LDAP port */
    #define LDAPS_PORT		636		/* ldaps:///	default LDAP over TLS port */
    
    #define LDAP_ROOT_DSE				""
    #define LDAP_NO_ATTRS				"1.1"
    #define LDAP_ALL_USER_ATTRIBUTES	"*"
    #define LDAP_ALL_OPERATIONAL_ATTRIBUTES	"+"
    
    /*
     * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
     * 0x0000 - 0x0fff reserved for api options
     * 0x1000 - 0x3fff reserved for api extended options
     * 0x4000 - 0x7fff reserved for private and experimental options
     */
    #define LDAP_OPT_API_INFO			0x0000
    #define LDAP_OPT_DESC				0x0001
    #define LDAP_OPT_DEREF				0x0002
    #define LDAP_OPT_SIZELIMIT			0x0003
    #define LDAP_OPT_TIMELIMIT			0x0004
    /* 0x05 - 0x07 not defined by current draft */
    #define LDAP_OPT_REFERRALS			0x0008
    #define LDAP_OPT_RESTART			0x0009
    /* 0x0a - 0x10 not defined by current draft */
    #define LDAP_OPT_PROTOCOL_VERSION	0x0011
    #define LDAP_OPT_SERVER_CONTROLS	0x0012
    #define LDAP_OPT_CLIENT_CONTROLS	0x0013
    /* 0x14 not defined by current draft */
    #define LDAP_OPT_API_FEATURE_INFO	0x0015
    
    /* 0x16 - 0x2f not defined by current draft */
    #define LDAP_OPT_HOST_NAME			0x0030
    #define	LDAP_OPT_ERROR_NUMBER		0x0031
    #define LDAP_OPT_ERROR_STRING		0x0032
    
    /* 0x33 - 0x0fff not defined by current draft */
    
    /* extended options - none */
    
    /* private and experimental options */
    #define LDAP_OPT_DNS				0x4001	/* use DN & DNS */
    
    /* OpenLDAP specific options */
    #define LDAP_OPT_DEBUG_LEVEL		0x5001	/* debug level */
    #define LDAP_OPT_TIMEOUT			0x5002	/* default timeout */
    #define LDAP_OPT_REFHOPLIMIT		0x5003	/* ref hop limit */
    #define LDAP_OPT_MATCHED_DN			0x5004	/* should have been in draft */
    #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
    
    /* TLS options */
    #define LDAP_OPT_X_TLS_CACERTFILE	0x6001
    #define LDAP_OPT_X_TLS_CACERTDIR	0x6002
    #define LDAP_OPT_X_TLS_CERT		0x6003
    #define LDAP_OPT_X_TLS_CERTFILE		0x6004
    #define LDAP_OPT_X_TLS_KEYFILE		0x6005
    #define LDAP_OPT_X_TLS_REQUIRE_CERT	0x6006
    #define LDAP_OPT_X_TLS			0x6007
    #define LDAP_OPT_X_TLS_PROTOCOL		0x6008
    #define LDAP_OPT_X_TLS_CIPHER_SUITE	0x6009
    
    #define LDAP_OPT_X_TLS_NEVER		0
    #define LDAP_OPT_X_TLS_HARD		1
    #define LDAP_OPT_X_TLS_DEMAND		2
    #define LDAP_OPT_X_TLS_ALLOW		3
    #define LDAP_OPT_X_TLS_TRY		4
    
    /* on/off values */
    #define LDAP_OPT_ON		((void *) 1)
    #define LDAP_OPT_OFF	((void *) 0)
    
    #define LDAP_OPT_SUCCESS	0
    #define	LDAP_OPT_ERROR		(-1)
    
    #define LDAP_API_INFO_VERSION	(1)
    typedef struct ldapapiinfo {
    	int		ldapai_info_version;		/* version of LDAPAPIInfo (1) */
    	int		ldapai_api_version;			/* revision of API supported */
    	int		ldapai_protocol_version;	/* highest LDAP version supported */
    	char	**ldapai_extensions;		/* names of API extensions */
    	char	*ldapai_vendor_name;		/* name of supplier */
    	int		ldapai_vendor_version;		/* supplier-specific version * 100 */
    } LDAPAPIInfo;
    
    #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
    typedef struct ldap_apifeature_info {
    	int		ldapaif_info_version; /* version of this struct (1) */
    	char*	ldapaif_name;    /* matches LDAP_API_FEATURE_... less the prefix */
    	int		ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
    } LDAPAPIFeatureInfo;
    
    typedef struct ldapcontrol {
    	char *			ldctl_oid;
    	struct berval	ldctl_value;
    	char			ldctl_iscritical;
    } LDAPControl;
    
    /* LDAP Controls */
    	/* chase referrals controls */
    #define LDAP_CONTROL_REFERRALS	"1.2.840.113666.1.4.616"
    #define LDAP_CHASE_SUBORDINATE_REFERRALS	0x0020
    #define LDAP_CHASE_EXTERNAL_REFERRALS	0x0040
    
    
    #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.2.6"
    
    
    /* LDAP Unsolicited Notifications */
    #define	LDAP_NOTICE_DISCONNECT	"1.3.6.1.4.1.1466.20036"
    
    /* LDAP Extended Operations */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    
    /* 
     * specific LDAP instantiations of BER types we know about
     */
    
    
    /* Overview of LBER tag construction
     *
     *	Bits
     *	______
     *	8 7 | CLASS
     *	0 0 = UNIVERSAL
     *	0 1 = APPLICATION
     *	1 0 = CONTEXT-SPECIFIC
     *	1 1 = PRIVATE
     *		_____
     *		| 6 | DATA-TYPE
     *		  0 = PRIMITIVE
     *		  1 = CONSTRUCTED
     *			___________
     *			| 5 ... 1 | TAG-NUMBER
     */
    
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    /* general stuff */
    
    #define LDAP_TAG_MESSAGE	(ber_tag_t) 0x30U	/* constructed + 16 */
    #define LDAP_TAG_MSGID		(ber_tag_t) 0x02U	/* integer */
    #define LDAP_TAG_LDAPDN		(ber_tag_t) 0x04U	/* octect string */
    #define LDAP_TAG_LDAPCRED	(ber_tag_t) 0x04U	/* octect string */
    #define LDAP_TAG_CONTROLS	(ber_tag_t) 0xa0U	/* context specific + constructed + 0 */
    #define LDAP_TAG_REFERRAL	(ber_tag_t) 0xa3U	/* context specific + constructed + 3 */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    
    #define LDAP_TAG_NEWSUPERIOR	(ber_tag_t) 0x80U	/* context-specific + primitive + 0 */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    
    #define LDAP_TAG_EXOP_REQ_OID   (ber_tag_t) 0x80U	/* context specific + primitive */
    #define LDAP_TAG_EXOP_REQ_VALUE (ber_tag_t) 0x81U	/* context specific + primitive */
    #define LDAP_TAG_EXOP_RES_OID   (ber_tag_t) 0x8aU	/* context specific + primitive */
    #define LDAP_TAG_EXOP_RES_VALUE (ber_tag_t) 0x8bU	/* context specific + primitive */
    
    #define LDAP_TAG_SASL_RES_CREDS	(ber_tag_t) 0x87U	/* context specific + primitive */
    
    
    
    
    /* possible operations a client can invoke */
    #define LDAP_REQ_BIND			(ber_tag_t) 0x60U	/* application + constructed */
    #define LDAP_REQ_UNBIND			(ber_tag_t) 0x42U	/* application + primitive   */
    #define LDAP_REQ_SEARCH			(ber_tag_t) 0x63U	/* application + constructed */
    #define LDAP_REQ_MODIFY			(ber_tag_t) 0x66U	/* application + constructed */
    #define LDAP_REQ_ADD			(ber_tag_t) 0x68U	/* application + constructed */
    #define LDAP_REQ_DELETE			(ber_tag_t) 0x4aU	/* application + primitive   */
    #define LDAP_REQ_MODRDN			(ber_tag_t) 0x6cU	/* application + constructed */
    #define LDAP_REQ_MODDN			LDAP_REQ_MODRDN	
    #define LDAP_REQ_RENAME			LDAP_REQ_MODRDN	
    #define LDAP_REQ_COMPARE		(ber_tag_t) 0x6eU	/* application + constructed */
    #define LDAP_REQ_ABANDON		(ber_tag_t) 0x50U	/* application + primitive   */
    #define LDAP_REQ_EXTENDED		(ber_tag_t) 0x77U	/* application + constructed */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    /* possible result types a server can return */
    
    #define LDAP_RES_BIND			(ber_tag_t) 0x61U	/* application + constructed */
    #define LDAP_RES_SEARCH_ENTRY		(ber_tag_t) 0x64U	/* application + constructed */
    #define LDAP_RES_SEARCH_REFERENCE	(ber_tag_t) 0x73U	/* V3: application + constructed */
    #define LDAP_RES_SEARCH_RESULT		(ber_tag_t) 0x65U	/* application + constructed */
    #define LDAP_RES_MODIFY			(ber_tag_t) 0x67U	/* application + constructed */
    #define LDAP_RES_ADD			(ber_tag_t) 0x69U	/* application + constructed */
    #define LDAP_RES_DELETE			(ber_tag_t) 0x6bU	/* application + constructed */
    #define LDAP_RES_MODRDN			(ber_tag_t) 0x6dU	/* application + constructed */
    #define LDAP_RES_MODDN			LDAP_RES_MODRDN	/* application + constructed */
    #define LDAP_RES_RENAME			LDAP_RES_MODRDN	/* application + constructed */
    #define LDAP_RES_COMPARE		(ber_tag_t) 0x6fU	/* application + constructed */
    #define LDAP_RES_EXTENDED		(ber_tag_t) 0x78U	/* V3: application + constructed */
    #define LDAP_RES_ANY			((ber_tag_t)(~0))
    
    
    /* sasl methods */
    #define LDAP_SASL_SIMPLE			NULL
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    /* authentication methods available */
    
    #define LDAP_AUTH_NONE		(ber_tag_t) 0x00U	/* no authentication		  */
    #define LDAP_AUTH_SIMPLE	(ber_tag_t) 0x80U	/* context specific + primitive   */
    #define LDAP_AUTH_SASL		(ber_tag_t) 0xa3U	/* context specific + primitive   */
    #define LDAP_AUTH_KRBV4		(ber_tag_t) 0xffU	/* means do both of the following */
    #define LDAP_AUTH_KRBV41	(ber_tag_t) 0x81U	/* context specific + primitive   */
    #define LDAP_AUTH_KRBV42	(ber_tag_t) 0x82U	/* context specific + primitive   */
    
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    /* filter types */
    
    #define LDAP_FILTER_AND		(ber_tag_t) 0xa0U	/* context specific + constructed */
    #define LDAP_FILTER_OR		(ber_tag_t) 0xa1U	/* context specific + constructed */
    #define LDAP_FILTER_NOT		(ber_tag_t) 0xa2U	/* context specific + constructed */
    #define LDAP_FILTER_EQUALITY	(ber_tag_t) 0xa3U	/* context specific + constructed */
    #define LDAP_FILTER_SUBSTRINGS	(ber_tag_t) 0xa4U	/* context specific + constructed */
    #define LDAP_FILTER_GE		(ber_tag_t) 0xa5U	/* context specific + constructed */
    #define LDAP_FILTER_LE		(ber_tag_t) 0xa6U	/* context specific + constructed */
    #define LDAP_FILTER_PRESENT	(ber_tag_t) 0x87U	/* context specific + primitive   */
    #define LDAP_FILTER_APPROX	(ber_tag_t) 0xa8U	/* context specific + constructed */
    #define LDAP_FILTER_EXT		(ber_tag_t) 0xa9U	/* context specific + constructed */
    
    /* extended filter component types */
    #define LDAP_FILTER_EXT_OID	(ber_tag_t) 0x81U	/* context specific */
    #define LDAP_FILTER_EXT_TYPE	(ber_tag_t) 0x82U	/* context specific */
    #define LDAP_FILTER_EXT_VALUE	(ber_tag_t) 0x83U	/* context specific */
    #define LDAP_FILTER_EXT_DNATTRS	(ber_tag_t) 0x84U	/* context specific */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    /* substring filter component types */
    
    #define LDAP_SUBSTRING_INITIAL	(ber_tag_t) 0x80U	/* context specific */
    #define LDAP_SUBSTRING_ANY	(ber_tag_t) 0x81U	/* context specific */
    #define LDAP_SUBSTRING_FINAL	(ber_tag_t) 0x82U	/* context specific */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    /* search scopes */
    
    #define LDAP_SCOPE_BASE		(ber_int_t) 0x0000
    #define LDAP_SCOPE_ONELEVEL	(ber_int_t) 0x0001
    #define LDAP_SCOPE_SUBTREE	(ber_int_t) 0x0002
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    /* for modifications */
    typedef struct ldapmod {
    	int		mod_op;
    
    #define LDAP_MOD_ADD		(ber_int_t) 0x0000
    #define LDAP_MOD_DELETE		(ber_int_t) 0x0001
    #define LDAP_MOD_REPLACE	(ber_int_t) 0x0002
    #define LDAP_MOD_BVALUES	(ber_int_t) 0x0080
    /* IMPORTANT: do not use code 0x1000 (or above),
     * it is used internally by the backends!
     * (see ldap/servers/slapd/slap.h)
     * JCG 05/1999 (gomez@engr.sgi.com)
     */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    	char		*mod_type;
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    		char		**modv_strvals;
    		struct berval	**modv_bvals;
    	} mod_vals;
    #define mod_values	mod_vals.modv_strvals
    #define mod_bvalues	mod_vals.modv_bvals
    } LDAPMod;
    
    /* 
     * possible error codes we can return
     */
    
    
    #define LDAP_RANGE(n,x,y)	(((x) <= (n)) && ((n) <= (y)))
    
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    #define LDAP_SUCCESS			0x00
    #define LDAP_OPERATIONS_ERROR		0x01
    #define LDAP_PROTOCOL_ERROR		0x02
    #define LDAP_TIMELIMIT_EXCEEDED		0x03
    #define LDAP_SIZELIMIT_EXCEEDED		0x04
    #define LDAP_COMPARE_FALSE		0x05
    #define LDAP_COMPARE_TRUE		0x06
    
    #define LDAP_AUTH_METHOD_NOT_SUPPORTED	0x07
    #define LDAP_STRONG_AUTH_NOT_SUPPORTED	LDAP_AUTH_METHOD_NOT_SUPPORTED
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    #define LDAP_STRONG_AUTH_REQUIRED	0x08
    
    #define LDAP_PARTIAL_RESULTS		0x09	/* not listed in v3 */
    
    #define	LDAP_REFERRAL				0x0a /* LDAPv3 */
    #define LDAP_ADMINLIMIT_EXCEEDED	0x0b /* LDAPv3 */
    #define	LDAP_UNAVAILABLE_CRITICAL_EXTENSION	0x0c /* LDAPv3 */
    #define LDAP_CONFIDENTIALITY_REQUIRED	0x0d /* LDAPv3 */
    #define	LDAP_SASL_BIND_IN_PROGRESS	0x0e /* LDAPv3 */	
    
    #define LDAP_ATTR_ERROR(n)	LDAP_RANGE((n),0x10,0x15) /* 16-21 */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    #define LDAP_NO_SUCH_ATTRIBUTE		0x10
    #define LDAP_UNDEFINED_TYPE		0x11
    #define LDAP_INAPPROPRIATE_MATCHING	0x12
    #define LDAP_CONSTRAINT_VIOLATION	0x13
    #define LDAP_TYPE_OR_VALUE_EXISTS	0x14
    #define LDAP_INVALID_SYNTAX		0x15
    
    
    #define LDAP_NAME_ERROR(n)	LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
    
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    #define LDAP_NO_SUCH_OBJECT		0x20
    #define LDAP_ALIAS_PROBLEM		0x21
    #define LDAP_INVALID_DN_SYNTAX		0x22
    
    #define LDAP_IS_LEAF			0x23 /* not LDAPv3 */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    #define LDAP_ALIAS_DEREF_PROBLEM	0x24
    
    
    #define LDAP_SECURITY_ERROR(n)	LDAP_RANGE((n),0x30,0x32) /* 48-50 */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    #define LDAP_INAPPROPRIATE_AUTH		0x30
    #define LDAP_INVALID_CREDENTIALS	0x31
    #define LDAP_INSUFFICIENT_ACCESS	0x32
    
    
    #define LDAP_SERVICE_ERROR(n)	LDAP_RANGE((n),0x33,0x36) /* 51-54 */
    
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    #define LDAP_BUSY			0x33
    #define LDAP_UNAVAILABLE		0x34
    #define LDAP_UNWILLING_TO_PERFORM	0x35
    #define LDAP_LOOP_DETECT		0x36
    
    
    #define LDAP_UPDATE_ERROR(n)	LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
    
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    #define LDAP_NAMING_VIOLATION		0x40
    #define LDAP_OBJECT_CLASS_VIOLATION	0x41
    #define LDAP_NOT_ALLOWED_ON_NONLEAF	0x42
    #define LDAP_NOT_ALLOWED_ON_RDN		0x43
    #define LDAP_ALREADY_EXISTS		0x44
    #define LDAP_NO_OBJECT_CLASS_MODS	0x45
    
    #define LDAP_RESULTS_TOO_LARGE		0x46 /* CLDAP */
    #define LDAP_AFFECTS_MULTIPLE_DSAS	0x47 /* LDAPv3 */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    #define LDAP_OTHER			0x50
    
    
    #define LDAP_API_ERROR(n)		LDAP_RANGE((n),0x51,0xff) /* 81+ */
    
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    #define LDAP_SERVER_DOWN		0x51
    #define LDAP_LOCAL_ERROR		0x52
    #define LDAP_ENCODING_ERROR		0x53
    #define LDAP_DECODING_ERROR		0x54
    #define LDAP_TIMEOUT			0x55
    #define LDAP_AUTH_UNKNOWN		0x56
    #define LDAP_FILTER_ERROR		0x57
    #define LDAP_USER_CANCELLED		0x58
    #define LDAP_PARAM_ERROR		0x59
    #define LDAP_NO_MEMORY			0x5a
    
    
    #define LDAP_CONNECT_ERROR				0x5b	/* new */
    #define LDAP_NOT_SUPPORTED				0x5c	/* new */
    #define LDAP_CONTROL_NOT_FOUND			0x5d	/* new */
    #define LDAP_NO_RESULTS_RETURNED		0x5e	/* new */
    #define LDAP_MORE_RESULTS_TO_RETURN		0x5f	/* new */
    #define LDAP_CLIENT_LOOP				0x60	/* new */
    #define LDAP_REFERRAL_LIMIT_EXCEEDED	0x61	/* new */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    /*
     * This structure represents both ldap messages and ldap responses.
     * These are really the same, except in the case of search responses,
     * where a response has multiple messages.
     */
    
    
    typedef struct ldapmsg LDAPMessage;
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    /*
     * structures for ldap getfilter routines
     */
    
    typedef struct ldap_filt_info {
    	char			*lfi_filter;
    	char			*lfi_desc;
    	int			lfi_scope;	/* LDAP_SCOPE_BASE, etc */
    	int			lfi_isexact;	/* exact match filter? */
    	struct ldap_filt_info	*lfi_next;
    } LDAPFiltInfo;
    
    typedef struct ldap_filt_list {
        char			*lfl_tag;
        char			*lfl_pattern;
        char			*lfl_delims;
        LDAPFiltInfo		*lfl_ilist;
        struct ldap_filt_list	*lfl_next;
    } LDAPFiltList;
    
    
    #define LDAP_FILT_MAXSIZ	1024
    
    typedef struct ldap_filt_desc {
    	LDAPFiltList		*lfd_filtlist;
    	LDAPFiltInfo		*lfd_curfip;
    	LDAPFiltInfo		lfd_retfi;
    	char			lfd_filter[ LDAP_FILT_MAXSIZ ];
    	char			*lfd_curval;
    	char			*lfd_curvalcopy;
    	char			**lfd_curvalwords;
    	char			*lfd_filtprefix;
    	char			*lfd_filtsuffix;
    } LDAPFiltDesc;
    
    
    /*
     * structure representing an ldap connection
     */
    
    
    typedef struct ldap LDAP;
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    
    #define LDAP_DEREF_NEVER	0x00
    #define LDAP_DEREF_SEARCHING	0x01
    #define LDAP_DEREF_FINDING	0x02
    #define LDAP_DEREF_ALWAYS	0x03
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    
    /* how many messages to retrieve results for */
    #define LDAP_MSG_ONE		0x00
    #define LDAP_MSG_ALL		0x01
    #define LDAP_MSG_RECEIVED	0x02
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    /*
     * structure for ldap friendly mapping routines
     */
    
    
    typedef struct ldap_friendly {
    	char	*lf_unfriendly;
    	char	*lf_friendly;
    } LDAPFriendlyMap;
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    /*
     * types for ldap URL handling
     */
    typedef struct ldap_url_desc {
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
        char	*lud_host;
        int		lud_port;
        char	*lud_dn;
        char	**lud_attrs;
        int		lud_scope;
        char	*lud_filter;
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    } LDAPURLDesc;
    
    
    #define LDAP_URL_SUCCESS		0x00	/* Success */
    #define LDAP_URL_ERR_MEM		0x01	/* can't allocate memory space */
    #define LDAP_URL_ERR_PARAM		0x02	/* parameter is bad */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    
    #define LDAP_URL_ERR_NOTLDAP	0x03	/* URL doesn't begin with "ldap[s]://" */
    #define LDAP_URL_ERR_BADENCLOSURE 0x04	/* URL is missing trailing ">" */
    #define LDAP_URL_ERR_BADURL		0x05	/* URL is bad */
    #define LDAP_URL_ERR_BADHOST	0x06	/* host port is bad */
    #define LDAP_URL_ERR_BADATTRS	0x07	/* bad (or missing) attributes */
    #define LDAP_URL_ERR_BADSCOPE	0x08	/* scope string is invalid (or missing) */
    #define LDAP_URL_ERR_BADFILTER	0x09	/* bad or missing filter */
    #define LDAP_URL_ERR_BADEXTS	0x0a	/* bad or missing extensions */
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    
    
    497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
    /*
     * The API draft spec says we should declare (or cause to be declared)
     * 'struct timeval'.   We don't.  See LDAPext discussions.
     */
    struct timeval;
    
    /*
     * in options.c:
     */
    LDAP_F( int )
    ldap_get_option LDAP_P((
    	LDAP_CONST LDAP *ld,
    	int option,
    	void *outvalue));
    
    LDAP_F( int )
    ldap_set_option LDAP_P((
    	LDAP *ld,
    	int option,
    	LDAP_CONST void *invalue));
    
    
    /*
     * in controls.c:
     */
    LDAP_F( void )
    ldap_control_free LDAP_P((
    	LDAPControl *ctrl ));
    
    LDAP_F( void )
    ldap_controls_free LDAP_P((
    	LDAPControl **ctrls ));
    
      
    /*
     * in extended.c:
     */
    LDAP_F( int )
    ldap_extended_operation LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*reqoid,
    	struct berval	*reqdata,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls,
    	int				*msgidp ));
    
    LDAP_F( int )
    ldap_extended_operation_s LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*reqoid,
    	struct berval	*reqdata,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls,
    	char			**retoidp,
    	struct berval	**retdatap ));
    
    LDAP_F( int )
    ldap_parse_extended_result LDAP_P((
    	LDAP			*ld,
    	LDAPMessage		*res,
    	char			**retoidp,
    	struct berval	**retdatap,
    	int				freeit ));
    
    /*
     * in abandon.c:
     */
    LDAP_F( int )
    ldap_abandon LDAP_P((
    	LDAP *ld,
    	int msgid ));
    
    LDAP_F( int )
    ldap_abandon_ext LDAP_P((
    	LDAP			*ld,
    	int				msgid,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls ));
    
    
    /*
     * in add.c:
     */
    LDAP_F( int )
    ldap_add_ext LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAPMod			**attrs,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls,
    	int 			*msgidp ));
    
    LDAP_F( int )
    ldap_add_ext_s LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAPMod			**attrs,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls ));
    
    LDAP_F( int )
    ldap_add LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAPMod **attrs ));
    
    LDAP_F( int )
    ldap_add_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAPMod **attrs ));
    
    
    /*
     * in sasl.c:
     */
    LDAP_F( int )
    ldap_sasl_bind LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAP_CONST char	*mechanism,
    	struct berval	*cred,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls,
    	int				*msgidp ));
    
    LDAP_F( int )
    ldap_sasl_bind_s LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAP_CONST char	*mechanism,
    	struct berval	*cred,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls,
    	struct berval	**servercredp ));
    
    LDAP_F( int )
    ldap_parse_sasl_bind_result LDAP_P((
    	LDAP			*ld,
    	LDAPMessage		*res,
    	struct berval	**servercredp,
    	int				freeit ));
    
    /*
     * in bind.c:
     *	(deprecated)
     */
    LDAP_F( int )
    ldap_bind LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *who,
    	LDAP_CONST char *passwd,
    	int authmethod ));
    
    LDAP_F( int )
    ldap_bind_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *who,
    	LDAP_CONST char *cred,
    	int authmethod ));
    
    LDAP_F( void )
    ldap_set_rebind_proc LDAP_P((
    	LDAP *ld,
    	int (*rebindproc) LDAP_P((
    		LDAP *ld,
    		char **dnp,
    		char **passwdp,
    		int *authmethodp,
    		int freeit ))));
    
    
    /*
     * in sbind.c:
     */
    LDAP_F( int )
    ldap_simple_bind LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *who,
    	LDAP_CONST char *passwd ));
    
    LDAP_F( int )
    ldap_simple_bind_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *who,
    	LDAP_CONST char *passwd ));
    
    
    /*
     * in kbind.c:
     *	(deprecated)
     */
    LDAP_F( int )
    ldap_kerberos_bind_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *who ));
    
    LDAP_F( int )
    ldap_kerberos_bind1 LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *who ));
    
    LDAP_F( int )
    ldap_kerberos_bind1_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *who ));
    
    LDAP_F( int )
    ldap_kerberos_bind2 LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *who ));
    
    LDAP_F( int )
    ldap_kerberos_bind2_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *who ));
    
    /*
     * in cache.c
     * (deprecated)
     */
    LDAP_F( int )
    ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
    
    LDAP_F( void )
    ldap_disable_cache LDAP_P(( LDAP *ld ));
    
    LDAP_F( void )
    ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
    
    LDAP_F( void )
    ldap_destroy_cache LDAP_P(( LDAP *ld ));
    
    LDAP_F( void )
    ldap_flush_cache LDAP_P(( LDAP *ld ));
    
    LDAP_F( void )
    ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
    
    LDAP_F( void )
    ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
    
    
    /*
     * in compare.c:
     */
    LDAP_F( int )
    ldap_compare_ext LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAP_CONST char	*attr,
    	struct berval	*bvalue,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls,
    	int 			*msgidp ));
    
    LDAP_F( int )
    ldap_compare_ext_s LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAP_CONST char	*attr,
    	struct berval	*bvalue,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls ));
    
    LDAP_F( int )
    ldap_compare LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAP_CONST char *attr,
    	LDAP_CONST char *value ));
    
    LDAP_F( int )
    ldap_compare_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAP_CONST char *attr,
    	LDAP_CONST char *value ));
    
    
    /*
     * in delete.c:
     */
    LDAP_F( int )
    ldap_delete_ext LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls,
    	int 			*msgidp ));
    
    LDAP_F( int )
    ldap_delete_ext_s LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls ));
    
    LDAP_F( int )
    ldap_delete LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn ));
    
    LDAP_F( int )
    ldap_delete_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn ));
    
    
    /*
     * in error.c:
     */
    LDAP_F( int )
    ldap_parse_result LDAP_P((
    	LDAP			*ld,
    	LDAPMessage		*res,
    	int				*errcodep,
    	char			**matcheddnp,
    	char			**errmsgp,
    	char			***referralsp,
    	LDAPControl		***serverctrls,
    	int				freeit ));
    
    LDAP_F( char *)
    ldap_err2string LDAP_P((
    	int err ));
    
    LDAP_F( int )
    ldap_result2error LDAP_P((	/* deprecated */
    	LDAP *ld,
    	LDAPMessage *r,
    	int freeit ));
    
    LDAP_F( void )
    ldap_perror LDAP_P((	/* deprecated */
    	LDAP *ld,
    	LDAP_CONST char *s ));
    
    
    /*
     * in modify.c:
     */
    LDAP_F( int )
    ldap_modify_ext LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAPMod			**mods,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls,
    	int 			*msgidp ));
    
    LDAP_F( int )
    ldap_modify_ext_s LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAPMod			**mods,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls ));
    
    LDAP_F( int )
    ldap_modify LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAPMod **mods ));
    
    LDAP_F( int )
    ldap_modify_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAPMod **mods ));
    
    
    /*
     * in modrdn.c:
     */
    LDAP_F( int )
    
    ldap_rename LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAP_CONST char *newrdn,
    	int deleteoldrdn,
    	LDAP_CONST char *newSuperior,
    	LDAPControl **sctrls,
    	LDAPControl **cctrls,
    	int *msgidp ));
    
    LDAP_F( int )
    ldap_rename_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAP_CONST char *newrdn,
    	int deleteoldrdn,
    	LDAP_CONST char *newSuperior,
    	LDAPControl **sctrls,
    	LDAPControl **cctrls ));
    
    LDAP_F( int )
    
    ldap_rename_ext LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAP_CONST char	*newrdn,
    	LDAP_CONST char	*newparent,
    	int				deleteoldrdn,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls,
    	int 			*msgidp ));
    
    LDAP_F( int )
    ldap_rename_ext_s LDAP_P((
    	LDAP			*ld,
    	LDAP_CONST char	*dn,
    	LDAP_CONST char	*newrdn,
    	LDAP_CONST char	*newparent,
    	int				deleteoldrdn,
    	LDAPControl		**serverctrls,
    	LDAPControl		**clientctrls ));
    
    LDAP_F( int )
    ldap_rename2 LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAP_CONST char *newrdn,
    	int deleteoldrdn,
    	LDAP_CONST char *newSuperior ));
    
    LDAP_F( int )
    ldap_rename2_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAP_CONST char *newrdn,
    	int deleteoldrdn,
    	LDAP_CONST char *newSuperior));
    
    LDAP_F( int )
    ldap_modrdn LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAP_CONST char *newrdn ));
    
    LDAP_F( int )
    ldap_modrdn_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAP_CONST char *newrdn ));
    
    LDAP_F( int )
    ldap_modrdn2 LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAP_CONST char *newrdn,
    	int deleteoldrdn ));
    
    LDAP_F( int )
    ldap_modrdn2_s LDAP_P((
    	LDAP *ld,
    	LDAP_CONST char *dn,
    	LDAP_CONST char *newrdn,
    	int deleteoldrdn));
    
    
    /*
     * in open.c:
     */
    LDAP_F( LDAP *)
    ldap_open LDAP_P((
    	LDAP_CONST char *host,
    	int port ));
    
    LDAP_F( LDAP *)
    ldap_init LDAP_P((
    	LDAP_CONST char *host,
    	int port ));
    
    
    /*
     * in messages.c:
     */
    LDAP_F( LDAPMessage *)
    ldap_first_message LDAP_P((
    	LDAP *ld,
    	LDAPMessage *chain ));
    
    LDAP_F( LDAPMessage *)
    ldap_next_message LDAP_P((
    	LDAP *ld,
    	LDAPMessage *msg ));
    
    LDAP_F( int )
    ldap_count_messages LDAP_P((
    	LDAP *ld,
    	LDAPMessage *chain ));
    
    
    /*
     * in references.c:
     */
    LDAP_F( LDAPMessage *)
    ldap_first_reference LDAP_P((
    	LDAP *ld,
    	LDAPMessage *chain ));
    
    LDAP_F( LDAPMessage *)
    ldap_next_reference LDAP_P((
    	LDAP *ld,