/* $OpenLDAP$ */
/*
- * Copyright 1998-2000 The OpenLDAP Foundation, Redwood City, California, USA
+ * Copyright 1998-2001 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.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, 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
* Copyright (c) 1990 Regents of the University of Michigan.
/*
* We'll use 2000+draft revision for our API version number
- * As such, the number will be above the old RFC but below
+ * As such, the number will be above the old RFC but below
* whatever number does finally get assigned
*/
#define LDAP_API_VERSION 2004
#define LDAP_VENDOR_NAME "OpenLDAP"
-/* We'll eventually release as 20000 */
/* OpenLDAP API Features */
#define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
#define LDAP_OPT_URI 0x5006
/* OpenLDAP 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 0x6000
+#define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
+#define LDAP_OPT_X_TLS_CACERTFILE 0x6002
+#define LDAP_OPT_X_TLS_CACERTDIR 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_RANDOM_FILE 0x600a
+/* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
+#define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
+#define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
#define LDAP_OPT_X_TLS_NEVER 0
#define LDAP_OPT_X_TLS_HARD 1
} LDAPControl;
/* LDAP Controls */
- /* chase referrals controls */
+
+#ifdef undef
+ /* chase referrals client control (not yet implemented) */
#define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616"
#define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020U
#define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040U
+#endif
#define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
+#define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
+#define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
+#define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
+#define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
+
/* Experimental Controls */
#define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473"
#define LDAP_TAG_EXOP_X_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
#define LDAP_TAG_EXOP_X_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
-/*
+/*
* specific LDAP instantiations of BER types we know about
*/
#define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
#define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
#define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
-#define LDAP_REQ_MODRDN LDAP_REQ_MODDN
-#define LDAP_REQ_RENAME LDAP_REQ_MODDN
+#define LDAP_REQ_MODRDN LDAP_REQ_MODDN
+#define LDAP_REQ_RENAME LDAP_REQ_MODDN
#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 */
/* sasl methods */
#define LDAP_SASL_SIMPLE ((char*)0)
+#define LDAP_SASL_NULL ("")
/* 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_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
#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 */
#define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
#define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
-/*
+/*
* possible error codes we can return
*/
#define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
#define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
#define LDAP_STRONG_AUTH_REQUIRED 0x08
-#define LDAP_PARTIAL_RESULTS 0x09 /* not listed in v3 */
+#define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
#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_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
#define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
#define LDAP_OTHER 0x50
#define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0x61) /* 81-97 */
+#define LDAP_API_RESULT(n) (((n) == LDAP_SUCCESS) || \
+ LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
+/* reserved for APIs */
#define LDAP_SERVER_DOWN 0x51
#define LDAP_LOCAL_ERROR 0x52
#define LDAP_ENCODING_ERROR 0x53
#define LDAP_PARAM_ERROR 0x59
#define LDAP_NO_MEMORY 0x5a
-/* not technically reserved for APIs */
+/* used but not reserved for APIs */
#define LDAP_CONNECT_ERROR 0x5b /* draft-ietf-ldap-c-api-xx */
#define LDAP_NOT_SUPPORTED 0x5c /* draft-ietf-ldap-c-api-xx */
#define LDAP_CONTROL_NOT_FOUND 0x5d /* draft-ietf-ldap-c-api-xx */
#define LDAP_MSG_ALL 0x01
#define LDAP_MSG_RECEIVED 0x02
-/*
- * structure for ldap friendly mapping routines
- */
-
-typedef struct ldap_friendly {
- char *lf_unfriendly;
- char *lf_friendly;
-} LDAPFriendlyMap;
-
/*
* types for ldap URL handling
*/
/* V3 REBIND Function Callback Prototype */
typedef int (LDAP_REBIND_PROC) LDAP_P((
- LDAP *ld, LDAP_CONST char *url, int request, ber_int_t msgid ));
+ LDAP *ld, LDAP_CONST char *url,
+ ber_tag_t request, ber_int_t msgid,
+ void *params ));
LDAP_F( int )
ldap_set_rebind_proc LDAP_P((
LDAP *ld,
- LDAP_REBIND_PROC *ldap_proc));
+ LDAP_REBIND_PROC *rebind_proc,
+ void *params ));
/*
* in controls.c:
*/
-LDAP_F( int )
-ldap_create_control LDAP_P((
- const char *requestOID,
- BerElement *ber,
+LDAP_F( int )
+ldap_create_control LDAP_P((
+ const char *requestOID,
+ BerElement *ber,
int iscritical,
LDAPControl **ctrlp ));
LDAPControl ***serverctrls,
int freeit ));
-LDAP_F( char *)
+LDAP_F( char * )
ldap_err2string LDAP_P((
int err ));
/*
* in open.c:
*/
-LDAP_F( LDAP *)
+LDAP_F( LDAP * )
ldap_init LDAP_P((
LDAP_CONST char *host,
int port ));
-LDAP_F( LDAP *)
+LDAP_F( LDAP * )
ldap_open LDAP_P(( /* deprecated */
LDAP_CONST char *host,
int port ));
LDAP_F( int )
-ldap_create LDAP_P((
+ldap_create LDAP_P((
LDAP **ldp ));
LDAP_F( int )
/*
* in messages.c:
*/
-LDAP_F( LDAPMessage *)
+LDAP_F( LDAPMessage * )
ldap_first_message LDAP_P((
LDAP *ld,
LDAPMessage *chain ));
-LDAP_F( LDAPMessage *)
+LDAP_F( LDAPMessage * )
ldap_next_message LDAP_P((
LDAP *ld,
LDAPMessage *msg ));
/*
* in references.c:
*/
-LDAP_F( LDAPMessage *)
+LDAP_F( LDAPMessage * )
ldap_first_reference LDAP_P((
LDAP *ld,
LDAPMessage *chain ));
-LDAP_F( LDAPMessage *)
+LDAP_F( LDAPMessage * )
ldap_next_reference LDAP_P((
LDAP *ld,
LDAPMessage *ref ));
/*
* in getentry.c:
*/
-LDAP_F( LDAPMessage *)
+LDAP_F( LDAPMessage * )
ldap_first_entry LDAP_P((
LDAP *ld,
LDAPMessage *chain ));
-LDAP_F( LDAPMessage *)
+LDAP_F( LDAPMessage * )
ldap_next_entry LDAP_P((
LDAP *ld,
LDAPMessage *entry ));
/*
* in addentry.c
*/
-LDAP_F( LDAPMessage *)
+LDAP_F( LDAPMessage * )
ldap_delete_result_entry LDAP_P((
LDAPMessage **list,
LDAPMessage *e ));
LDAP *ld,
LDAPMessage *entry ));
+typedef struct ldap_ava {
+ struct berval *la_attr;
+ struct berval *la_value;
+ unsigned la_flags;
+#define LDAP_AVA_STRING 0x0000U
+#define LDAP_AVA_BINARY 0x0001U
+#define LDAP_AVA_NONPRINTABLE 0x0002U
+
+ void *la_private;
+} LDAPAVA;
+
+typedef LDAPAVA** LDAPRDN;
+typedef LDAPRDN** LDAPDN;
+
+/* DN formats */
+#define LDAP_DN_FORMAT_LDAP 0x0000U
+#define LDAP_DN_FORMAT_LDAPV3 0x0010U
+#define LDAP_DN_FORMAT_LDAPV2 0x0020U
+#define LDAP_DN_FORMAT_DCE 0x0030U
+#define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
+#define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
+#define LDAP_DN_FORMAT_MASK 0x00F0U
+
+/* DN flags */
+#define LDAP_DN_PRETTY 0x0100U
+#define LDAP_DN_SKIP 0x0200U
+#define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
+#define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
+#define LDAP_DN_PEDANTIC 0xF000U
+
+LDAP_F( void )
+ldap_avafree LDAP_P(( LDAPAVA *ava ));
+LDAP_F( void )
+ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
+LDAP_F( void )
+ldap_dnfree LDAP_P(( LDAPDN *dn ));
+
+LDAP_F( int )
+ldap_str2dn LDAP_P((
+ LDAP_CONST char *str,
+ LDAPDN **dn,
+ unsigned flags ));
+
+LDAP_F( int )
+ldap_dn2bv LDAP_P((
+ LDAPDN *dn,
+ struct berval *bv,
+ unsigned flags ));
+
+LDAP_F( int )
+ldap_dn2str LDAP_P((
+ LDAPDN *dn,
+ char **str,
+ unsigned flags ));
+
+LDAP_F( int )
+ldap_str2rdn LDAP_P((
+ const char *str,
+ LDAPRDN **rdn,
+ const char **next,
+ unsigned flags ));
+
+LDAP_F( int )
+ldap_rdn2bv LDAP_P((
+ LDAPRDN *rdn,
+ struct berval *bv,
+ unsigned flags ));
+
+LDAP_F( int )
+ldap_rdn2str LDAP_P((
+ LDAPRDN *rdn,
+ char **str,
+ unsigned flags ));
+
+LDAP_F( int )
+ldap_dn_normalize LDAP_P((
+ LDAP_CONST char *in, unsigned iflags,
+ char **out, unsigned oflags ));
+
LDAP_F( char * )
-ldap_dn2ufn LDAP_P((
+ldap_dn2ufn LDAP_P(( /* deprecated */
LDAP_CONST char *dn ));
LDAP_F( char ** )
-ldap_explode_dn LDAP_P((
+ldap_explode_dn LDAP_P(( /* deprecated */
LDAP_CONST char *dn,
int notypes ));
LDAP_F( char ** )
-ldap_explode_rdn LDAP_P((
+ldap_explode_rdn LDAP_P(( /* deprecated */
LDAP_CONST char *rdn,
int notypes ));
LDAP_F( char * )
ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
+LDAP_F( char * )
+ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
+
/*
* in getattr.c
*/
-LDAP_F( char *)
-ldap_first_attribute LDAP_P((
+LDAP_F( char * )
+ldap_first_attribute LDAP_P((
LDAP *ld,
LDAPMessage *entry,
BerElement **ber ));
-LDAP_F( char *)
+LDAP_F( char * )
ldap_next_attribute LDAP_P((
LDAP *ld,
LDAPMessage *entry,
/*
* in getvalues.c
*/
-LDAP_F( char **)
-ldap_get_values LDAP_P((
- LDAP *ld,
- LDAPMessage *entry,
- LDAP_CONST char *target ));
-
-LDAP_F( struct berval **)
+LDAP_F( struct berval ** )
ldap_get_values_len LDAP_P((
LDAP *ld,
LDAPMessage *entry,
LDAP_CONST char *target ));
-LDAP_F( int )
-ldap_count_values LDAP_P((
- char **vals ));
-
LDAP_F( int )
ldap_count_values_len LDAP_P((
struct berval **vals ));
LDAP_F( void )
-ldap_value_free LDAP_P((
+ldap_value_free_len LDAP_P((
+ struct berval **vals ));
+
+LDAP_F( char ** )
+ldap_get_values LDAP_P(( /* deprecated */
+ LDAP *ld,
+ LDAPMessage *entry,
+ LDAP_CONST char *target ));
+
+LDAP_F( int )
+ldap_count_values LDAP_P(( /* deprecated */
char **vals ));
LDAP_F( void )
-ldap_value_free_len LDAP_P((
- struct berval **vals ));
+ldap_value_free LDAP_P(( /* deprecated */
+ char **vals ));
/*
* in result.c:
struct timeval *timeout,
LDAPMessage **res ));
-#ifdef LDAP_UFN
-/*
- * in ufn.c
- * (deprecated)
- */
-LDAP_F( int )
-ldap_ufn_search_c LDAP_P(( /* deprecated */
- LDAP *ld,
- LDAP_CONST char *ufn,
- char **attrs,
- int attrsonly,
- LDAPMessage **res,
- int (*cancelproc)( void *cl ),
- void *cancelparm ));
-
-LDAP_F( int )
-ldap_ufn_search_ct LDAP_P(( /* deprecated */
- LDAP *ld,
- LDAP_CONST char *ufn,
- char **attrs,
- int attrsonly,
- LDAPMessage **res,
- int (*cancelproc)( void *cl ),
- void *cancelparm,
- char *tag1,
- char *tag2,
- char *tag3 ));
-
-LDAP_F( int )
-ldap_ufn_search_s LDAP_P(( /* deprecated */
- LDAP *ld,
- LDAP_CONST char *ufn,
- char **attrs,
- int attrsonly,
- LDAPMessage **res ));
-
-LDAP_F( LDAPFiltDesc *)
-ldap_ufn_setfilter LDAP_P(( /* deprecated */
- LDAP *ld,
- LDAP_CONST char *fname ));
-
-LDAP_F( void )
-ldap_ufn_setprefix LDAP_P(( /* deprecated */
- LDAP *ld,
- LDAP_CONST char *prefix ));
-
-LDAP_F( int )
-ldap_ufn_timeout LDAP_P(( /* deprecated */
- void *tvparam ));
-#endif
-
/*
* in unbind.c
*/
* in getfilter.c
* (deprecated)
*/
-LDAP_F( LDAPFiltDesc *)
+LDAP_F( LDAPFiltDesc * )
ldap_init_getfilter LDAP_P(( /* deprecated */
LDAP_CONST char *fname ));
-LDAP_F( LDAPFiltDesc *)
-ldap_init_getfilter_buf LDAP_P(( /* deprecated */
- /* LDAP_CONST */ char *buf,
- ber_len_t buflen ));
-
-LDAP_F( LDAPFiltInfo *)
+LDAP_F( LDAPFiltInfo * )
ldap_getfirstfilter LDAP_P(( /* deprecated */
LDAPFiltDesc *lfdp,
/* LDAP_CONST */ char *tagpat,
/* LDAP_CONST */ char *value ));
-LDAP_F( LDAPFiltInfo *)
+LDAP_F( LDAPFiltInfo * )
ldap_getnextfilter LDAP_P(( /* deprecated */
LDAPFiltDesc *lfdp ));
-LDAP_F( void )
-ldap_setfilteraffixes LDAP_P(( /* deprecated */
- LDAPFiltDesc *lfdp,
- LDAP_CONST char *prefix,
- LDAP_CONST char *suffix ));
-
-LDAP_F( void )
-ldap_build_filter LDAP_P(( /* deprecated */
- char *buf,
- ber_len_t buflen,
- LDAP_CONST char *pattern,
- LDAP_CONST char *prefix,
- LDAP_CONST char *suffix,
- LDAP_CONST char *attr,
- LDAP_CONST char *value,
- char **valwords ));
-
/*
* in free.c
int freemods ));
-/*
- * in friendly.c
- * (deprecated)
- */
-LDAP_F( char * )
-ldap_friendly_name LDAP_P(( /* deprecated */
- LDAP_CONST char *filename,
- /* LDAP_CONST */ char *uname,
- LDAPFriendlyMap **map ));
-
-LDAP_F( void )
-ldap_free_friendlymap LDAP_P(( /* deprecated */
- LDAPFriendlyMap **map ));
-
-
/*
* in sort.c
+ * (deprecated)
*/
-typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P((
+typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
LDAP_CONST char *left,
LDAP_CONST char *right ));
-typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P((
+typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
LDAP_CONST void *left,
LDAP_CONST void *right ));
-LDAP_F( int )
+LDAP_F( int ) /* deprecated */
ldap_sort_entries LDAP_P(( LDAP *ld,
LDAPMessage **chain,
LDAP_CONST char *attr,
/*
* in url.c
- *
- * need _ext varients
*/
LDAP_F( int )
ldap_is_ldap_url LDAP_P((
LDAP_CONST char *url,
LDAPURLDesc **ludpp ));
+LDAP_F( char * )
+ldap_url_desc2str LDAP_P((
+ LDAPURLDesc *ludp ));
+
LDAP_F( void )
ldap_free_urldesc LDAP_P((
LDAPURLDesc *ludp ));
-LDAP_F( int )
-ldap_url_search LDAP_P((
- LDAP *ld,
- LDAP_CONST char *url,
- int attrsonly ));
-
-LDAP_F( int )
-ldap_url_search_s LDAP_P((
- LDAP *ld,
- LDAP_CONST char *url,
- int attrsonly,
- LDAPMessage **res ));
-
-LDAP_F( int )
-ldap_url_search_st LDAP_P((
- LDAP *ld,
- LDAP_CONST char *url,
- int attrsonly,
- struct timeval *timeout,
- LDAPMessage **res ));
-
-/*
- * in sortctrl.c
+/*
+ * in sortctrl.c
*/
/*
- * structure for a sort-key
+ * structure for a sort-key
*/
typedef struct ldapsortkey {
char * attributeType;
LDAPSortKey **sortkeylist ));
LDAP_F( int )
-ldap_create_sort_control LDAP_P((
- LDAP *ld,
+ldap_create_sort_control LDAP_P((
+ LDAP *ld,
LDAPSortKey **keyList,
int ctl_iscritical,
LDAPControl **ctrlp ));
LDAP_F( int )
ldap_parse_sort_control LDAP_P((
- LDAP *ld,
- LDAPControl **ctrlp,
+ LDAP *ld,
+ LDAPControl **ctrlp,
unsigned long *result,
char **attribute ));
-/*
- * in vlvctrl.c
+/*
+ * in vlvctrl.c
*/
/*
*/
typedef struct ldapvlvinfo {
int ldvlv_version;
- unsigned long ldvlv_before_count;
- unsigned long ldvlv_after_count;
- unsigned long ldvlv_offset;
+ unsigned long ldvlv_before_count;
+ unsigned long ldvlv_after_count;
+ unsigned long ldvlv_offset;
unsigned long ldvlv_count;
struct berval *ldvlv_attrvalue;
struct berval *ldvlv_context;
void *ldvlv_extradata;
} LDAPVLVInfo;
-LDAP_F( int )
+LDAP_F( int )
ldap_create_vlv_control LDAP_P((
- LDAP *ld,
+ LDAP *ld,
LDAPVLVInfo *ldvlistp,
LDAPControl **ctrlp ));
LDAP_F( int )
-ldap_parse_vlv_control LDAP_P((
- LDAP *ld,
+ldap_parse_vlv_control LDAP_P((
+ LDAP *ld,
LDAPControl **ctrls,
- unsigned long *target_posp,
- unsigned long *list_countp,
+ unsigned long *target_posp,
+ unsigned long *list_countp,
struct berval **contextp,
int *errcodep ));