/* $OpenLDAP$ */
/*
- * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
+ * Copyright 1998-2000 The OpenLDAP Foundation, Redwood City, California, USA
* All rights reserved.
*
* Redistribution and use in source and binary forms are permitted only
#ifndef _LDAP_H
#define _LDAP_H
-#include <ldap_cdefs.h>
-
-/* draft spec requires ldap.h include lber declarations */
+/* pull in lber */
#include <lber.h>
LDAP_BEGIN_DECL
#define LDAP_API_VERSION 2004
#define LDAP_VENDOR_NAME "OpenLDAP"
/* We'll eventually release as 200 */
-#define LDAP_VENDOR_VERSION 194
+#define LDAP_VENDOR_VERSION 19905
/* OpenLDAP API Features */
#define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
/* 0x34 - 0x0fff not defined by current draft */
-/* private and experimental options */
-#define LDAP_OPT_DNS 0x4001 /* use DN & DNS */
+#define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000 /* to 0x7FFF inclusive */
+/* private and experimental options */
/* OpenLDAP specific options */
#define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
#define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
#define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
#define LDAP_OPT_URI 0x5006
-/* TLS options */
+/* 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_ALLOW 3
#define LDAP_OPT_X_TLS_TRY 4
+/* OpenLDAP SASL options */
+#define LDAP_OPT_X_SASL_MINSSF 0x6100
+#define LDAP_OPT_X_SASL_MAXSSF 0x6101
+#define LDAP_OPT_X_SASL_ACTSSF 0x6102
+
/* on/off values */
#define LDAP_OPT_ON ((void *) 1)
#define LDAP_OPT_OFF ((void *) 0)
/* Experimental Controls */
#define LDAP_CONTROL_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.5.1"
-
/* LDAP Unsolicited Notifications */
#define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
#define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
/* LDAP Extended Operations */
-#define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.6.1"
#define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
+#define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.6.1"
+#define LDAP_TAG_EXOP_X_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
+#define LDAP_TAG_EXOP_X_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
+#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_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_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_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */
#define LDAP_RES_ANY ((ber_tag_t)(-1))
#define LDAP_RES_UNSOLICITED ((ber_tag_t)(0))
#define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
#define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
-/* 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)
- */
-
- char *mod_type;
- union mod_vals_u {
- char **modv_strvals;
- struct berval **modv_bvals;
- } mod_vals;
-#define mod_values mod_vals.modv_strvals
-#define mod_bvalues mod_vals.modv_bvals
-} LDAPMod;
+/* 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 */
/*
* possible error codes we can return
typedef struct ldapmsg LDAPMessage;
+/* 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)
+ */
+
+ char *mod_type;
+ union mod_vals_u {
+ char **modv_strvals;
+ struct berval **modv_bvals;
+ } mod_vals;
+#define mod_values mod_vals.modv_strvals
+#define mod_bvalues mod_vals.modv_bvals
+} LDAPMod;
+
/*
* structures for ldap getfilter routines
*/
* types for ldap URL handling
*/
typedef struct ldap_url_desc {
- struct ldap_url_desc *lud_next;
- int lud_ldaps;
+ struct ldap_url_desc *lud_next;
+ unsigned long lud_properties;
+ int lud_protocol;
char *lud_host;
int lud_port;
char *lud_dn;
char **lud_attrs;
int lud_scope;
char *lud_filter;
- char **lud_exts;
+ char **lud_exts;
} LDAPURLDesc;
+/* lud_properties */
+#define LDAP_URL_USE_SSL 0x00000001
+
+/* lud_protocol */
+#define LDAP_PROTO_TCP 0x00
+#define LDAP_PROTO_UDP 0x01
+#define LDAP_PROTO_LOCAL 0x02
+
#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 */
int option,
LDAP_CONST void *invalue));
+/* V3 REBIND Function Callback Prototype */
+typedef int (LDAP_REBIND_PROC) ( LDAP *ld, LDAP_CONST char *url, int request, ber_int_t msgid);
+
+LIBLDAP_F( int )
+ldap_set_rebind_proc LDAP_P((
+ LDAP *ld,
+ LDAP_REBIND_PROC *ldap_proc));
/*
* in controls.c:
ldap_controls_free LDAP_P((
LDAPControl **ctrls ));
-
+/*
+ * in dnssrv.c:
+ */
+LIBLDAP_F( int )
+ldap_domain2dn LDAP_P((
+ LDAP_CONST char* domain,
+ char** dn ));
+
+LIBLDAP_F( int )
+ldap_dn2domain LDAP_P((
+ LDAP_CONST char* dn,
+ char** domain ));
+
+LIBLDAP_F( int )
+ldap_domain2hostlist LDAP_P((
+ LDAP_CONST char *domain,
+ char** hostlist ));
+
/*
* in extended.c:
*/
* in abandon.c:
*/
LIBLDAP_F( int )
-ldap_abandon LDAP_P((
+ldap_abandon LDAP_P(( /* deprecated */
LDAP *ld,
int msgid ));
LDAPControl **clientctrls ));
LIBLDAP_F( int )
-ldap_add LDAP_P((
+ldap_add LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAPMod **attrs ));
LIBLDAP_F( int )
-ldap_add_s LDAP_P((
+ldap_add_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAPMod **attrs ));
LDAPControl **clientctrls,
int *msgidp ));
+LIBLDAP_F( int )
+ldap_negotiated_sasl_bind_s LDAP_P((
+ LDAP *ld,
+ LDAP_CONST char *dn, /* usually NULL */
+ LDAP_CONST char *authenticationId,
+ LDAP_CONST char *authorizationId, /* usually NULL */
+ LDAP_CONST char *saslMechanism,
+ struct berval *passPhrase,
+ LDAPControl **serverControls,
+ LDAPControl **clientControls ));
+
LIBLDAP_F( int )
ldap_sasl_bind_s LDAP_P((
LDAP *ld,
* (deprecated)
*/
LIBLDAP_F( int )
-ldap_bind LDAP_P((
+ldap_bind LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *who,
LDAP_CONST char *passwd,
int authmethod ));
LIBLDAP_F( int )
-ldap_bind_s LDAP_P((
+ldap_bind_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *who,
LDAP_CONST char *cred,
int authmethod ));
-LIBLDAP_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:
*/
* (deprecated)
*/
LIBLDAP_F( int )
-ldap_kerberos_bind_s LDAP_P((
+ldap_kerberos_bind_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *who ));
LIBLDAP_F( int )
-ldap_kerberos_bind1 LDAP_P((
+ldap_kerberos_bind1 LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *who ));
LIBLDAP_F( int )
-ldap_kerberos_bind1_s LDAP_P((
+ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *who ));
LIBLDAP_F( int )
-ldap_kerberos_bind2 LDAP_P((
+ldap_kerberos_bind2 LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *who ));
LIBLDAP_F( int )
-ldap_kerberos_bind2_s LDAP_P((
+ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *who ));
LDAPControl **clientctrls ));
LIBLDAP_F( int )
-ldap_compare LDAP_P((
+ldap_compare LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAP_CONST char *attr,
LDAP_CONST char *value ));
LIBLDAP_F( int )
-ldap_compare_s LDAP_P((
+ldap_compare_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAP_CONST char *attr,
LDAPControl **clientctrls ));
LIBLDAP_F( int )
-ldap_delete LDAP_P((
+ldap_delete LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn ));
LIBLDAP_F( int )
-ldap_delete_s LDAP_P((
+ldap_delete_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn ));
LDAPControl **clientctrls ));
LIBLDAP_F( int )
-ldap_modify LDAP_P((
+ldap_modify LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAPMod **mods ));
LIBLDAP_F( int )
-ldap_modify_s LDAP_P((
+ldap_modify_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAPMod **mods ));
LDAPControl **clientctrls ));
LIBLDAP_F( int )
-ldap_rename2 LDAP_P((
+ldap_rename2 LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAP_CONST char *newrdn,
int deleteoldrdn ));
LIBLDAP_F( int )
-ldap_rename2_s LDAP_P((
+ldap_rename2_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAP_CONST char *newrdn,
int deleteoldrdn ));
LIBLDAP_F( int )
-ldap_modrdn LDAP_P((
+ldap_modrdn LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAP_CONST char *newrdn ));
LIBLDAP_F( int )
-ldap_modrdn_s LDAP_P((
+ldap_modrdn_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAP_CONST char *newrdn ));
LIBLDAP_F( int )
-ldap_modrdn2 LDAP_P((
+ldap_modrdn2 LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAP_CONST char *newrdn,
int deleteoldrdn ));
LIBLDAP_F( int )
-ldap_modrdn2_s LDAP_P((
+ldap_modrdn2_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *dn,
LDAP_CONST char *newrdn,
* in open.c:
*/
LIBLDAP_F( LDAP *)
-ldap_open LDAP_P((
+ldap_open LDAP_P(( /* deprecated */
LDAP_CONST char *host,
int port ));
LDAP_CONST char *host,
int port ));
+LIBLDAP_F( int )
+ldap_create LDAP_P((
+ LDAP **ldp ));
+
+LIBLDAP_F( int )
+ldap_initialize LDAP_P((
+ LDAP **ldp,
+ LDAP_CONST char *url ));
+
+LIBLDAP_F( int )
+ldap_start_tls LDAP_P((
+ LDAP *ld,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls ));
/*
* in messages.c:
ldap_normalize_dn LDAP_P((
LDAP_CONST char *dn ));
-LIBLDAP_F( char ** )
-ldap_explode_dns LDAP_P(( /* deprecated */
- LDAP_CONST char *dn ));
-
-LIBLDAP_F( int )
-ldap_is_dns_dn LDAP_P(( /* deprecated */
- LDAP_CONST char *dn ));
+LIBLDAP_F( char * )
+ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
+LIBLDAP_F( char * )
+ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
/*
* in getattr.c
LDAPMessage **res ));
LIBLDAP_F( int )
-ldap_search LDAP_P((
+ldap_search LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *base,
int scope,
int attrsonly ));
LIBLDAP_F( int )
-ldap_search_s LDAP_P((
+ldap_search_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *base,
int scope,
LDAPMessage **res ));
LIBLDAP_F( int )
-ldap_search_st LDAP_P((
+ldap_search_st LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *base,
int scope,
/*
- * in ufn.c
+ * in ufn.c
+ * (deprecated)
*/
LIBLDAP_F( int )
-ldap_ufn_search_c LDAP_P((
+ldap_ufn_search_c LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *ufn,
char **attrs,
void *cancelparm ));
LIBLDAP_F( int )
-ldap_ufn_search_ct LDAP_P((
+ldap_ufn_search_ct LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *ufn,
char **attrs,
char *tag3 ));
LIBLDAP_F( int )
-ldap_ufn_search_s LDAP_P((
+ldap_ufn_search_s LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *ufn,
char **attrs,
LDAPMessage **res ));
LIBLDAP_F( LDAPFiltDesc *)
-ldap_ufn_setfilter LDAP_P((
+ldap_ufn_setfilter LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *fname ));
LIBLDAP_F( void )
-ldap_ufn_setprefix LDAP_P((
+ldap_ufn_setprefix LDAP_P(( /* deprecated */
LDAP *ld,
LDAP_CONST char *prefix ));
LIBLDAP_F( int )
-ldap_ufn_timeout LDAP_P((
+ldap_ufn_timeout LDAP_P(( /* deprecated */
void *tvparam ));
* in unbind.c
*/
LIBLDAP_F( int )
-ldap_unbind LDAP_P((
+ldap_unbind LDAP_P(( /* deprecated */
LDAP *ld ));
LIBLDAP_F( int )
-ldap_unbind_s LDAP_P((
+ldap_unbind_s LDAP_P(( /* deprecated */
LDAP *ld ));
LIBLDAP_F( int )
/*
* in getfilter.c
+ * (deprecated)
*/
LIBLDAP_F( LDAPFiltDesc *)
-ldap_init_getfilter LDAP_P((
+ldap_init_getfilter LDAP_P(( /* deprecated */
LDAP_CONST char *fname ));
LIBLDAP_F( LDAPFiltDesc *)
-ldap_init_getfilter_buf LDAP_P((
+ldap_init_getfilter_buf LDAP_P(( /* deprecated */
/* LDAP_CONST */ char *buf,
ber_len_t buflen ));
LIBLDAP_F( LDAPFiltInfo *)
-ldap_getfirstfilter LDAP_P((
+ldap_getfirstfilter LDAP_P(( /* deprecated */
LDAPFiltDesc *lfdp,
/* LDAP_CONST */ char *tagpat,
/* LDAP_CONST */ char *value ));
LIBLDAP_F( LDAPFiltInfo *)
-ldap_getnextfilter LDAP_P((
+ldap_getnextfilter LDAP_P(( /* deprecated */
LDAPFiltDesc *lfdp ));
LIBLDAP_F( void )
-ldap_setfilteraffixes LDAP_P((
+ldap_setfilteraffixes LDAP_P(( /* deprecated */
LDAPFiltDesc *lfdp,
LDAP_CONST char *prefix,
LDAP_CONST char *suffix ));
LIBLDAP_F( void )
-ldap_build_filter LDAP_P((
+ldap_build_filter LDAP_P(( /* deprecated */
char *buf,
ber_len_t buflen,
LDAP_CONST char *pattern,
/*
* in friendly.c
+ * (deprecated)
*/
LIBLDAP_F( char * )
-ldap_friendly_name LDAP_P((
+ldap_friendly_name LDAP_P(( /* deprecated */
LDAP_CONST char *filename,
/* LDAP_CONST */ char *uname,
LDAPFriendlyMap **map ));
LIBLDAP_F( void )
-ldap_free_friendlymap LDAP_P((
+ldap_free_friendlymap LDAP_P(( /* deprecated */
LDAPFriendlyMap **map ));
/*
* in cldap.c
+ * (deprecated)
*/
LIBLDAP_F( LDAP * )
-cldap_open LDAP_P((
+cldap_open LDAP_P(( /* deprecated */
LDAP_CONST char *host,
int port ));
LIBLDAP_F( void )
-cldap_close LDAP_P((
+cldap_close LDAP_P(( /* deprecated */
LDAP *ld ));
LIBLDAP_F( int )
-cldap_search_s LDAP_P(( LDAP *ld,
+cldap_search_s LDAP_P(( /* deprecated */
+ LDAP *ld,
LDAP_CONST char *base,
int scope,
LDAP_CONST char *filter,
char *logdn ));
LIBLDAP_F( void )
-cldap_setretryinfo LDAP_P((
+cldap_setretryinfo LDAP_P(( /* deprecated */
LDAP *ld,
int tries,
int timeout ));
struct timeval *timeout,
LDAPMessage **res ));
-
-/*
- * in charset.c
- * DEPRECATED
- */
-LIBLDAP_F( void )
-ldap_set_string_translators LDAP_P((
- LDAP *ld,
- BERTranslateProc encode_proc,
- BERTranslateProc decode_proc ));
-
-LIBLDAP_F( int )
-ldap_translate_from_t61 LDAP_P((
- LDAP *ld,
- char **bufp,
- ber_len_t *lenp,
- int free_input ));
-
-LIBLDAP_F( int )
-ldap_translate_to_t61 LDAP_P((
- LDAP *ld,
- char **bufp,
- ber_len_t *lenp,
- int free_input ));
-
-LIBLDAP_F( void )
-ldap_enable_translation LDAP_P((
- LDAP *ld,
- LDAPMessage *entry,
- int enable ));
-
-LIBLDAP_F( int )
-ldap_t61_to_8859 LDAP_P((
- char **bufp,
- ber_len_t *buflenp,
- int free_input ));
-
-LIBLDAP_F( int )
-ldap_8859_to_t61 LDAP_P((
- char **bufp,
- ber_len_t *buflenp,
- int free_input ));
-
LDAP_END_DECL
#endif /* _LDAP_H */
projects / openldap / blobdiff