/*
+ * 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
* Copyright (c) 1990 Regents of the University of Michigan.
* All rights reserved.
*
/* We'll eventually release as 200 */
#define LDAP_VENDOR_VERSION 190
+/* OpenLDAP API Features */
+#define LDAP_API_FEATURE_X_OPENLDAP 1
+
/* include LDAP_API_FEATURE defines */
#include <ldap_features.h>
/* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
#endif
+#define LDAP_API_FEATURE_INFO 1
+
+typedef struct ldap_apifeature_info {
+ char* ldapaif_name; /* matches LDAP_API_FEATURE_... less the prefix */
+ int ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
+} LDAPAPIFeatureInfo;
+
#define LDAP_PORT 389
#define LDAP_ROOT_DSE ""
#define LDAP_OPT_ERROR_NUMBER 0x0031
#define LDAP_OPT_ERROR_STRING 0x0032
+/* LDAP_OPTions under IETF discussion */
+#define LDAP_OPT_API_FEATURE_INFO 0x0100
+
/* not defined by current draft */
/* for LDAPv2 compatibility */
#define LDAP_OPT_DNS 0x1001 /* use DN & DNS */
+/* OpenLDAP specific options */
+#define LDAP_OPT_DEBUG_LEVEL 0x4001 /* OpenLDAP - debug level */
+
/* 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)
-#ifdef LDAP_DEBUG
-extern int ldap_debug;
-#endif
-
#define LDAP_API_INFO_VERSION 1
typedef struct ldapapiinfo {
int ldapai_info_version; /* version of LDAPAPIInfo (1) */
#define LDAP_TAG_MSGID 0x02L
/* need to add other LDAP_TAGs here */
+/* Overview of tag construction in ASN.1:
+ * _______
+ * Bit # | 8 7 | CLASS: UNIVERSAL 00
+ * APPLICATION 01
+ * CONTEXT-SPECIFIC 10
+ * PRIVATE 11
+ * _____
+ * | 6 | DATA-TYPE: PRIMITIVE 0
+ * CONSTRUCTED 1
+ * ___________
+ * | 5 ... 1 | TAG-NUMBER
+ */
+
+#define LDAP_TAG_NEWSUPERIOR 0x80L /* context-specific + primitive +
+ * tag # ==> [0]
+ */
+
/* possible operations a client can invoke */
#define LDAP_REQ_BIND 0x60L /* application + constructed */
#define LDAP_REQ_UNBIND 0x42L /* application + primitive */
#define OLD_LDAP_RES_MODDN OLD_LDAP_RES_MODRDN
#define OLD_LDAP_RES_COMPARE 0x0fL
+/* sasl methods */
+#define LDAP_SASL_SIMPLE NULL
+
/* authentication methods available */
#define LDAP_AUTH_NONE 0x00L /* no authentication */
#define LDAP_AUTH_SIMPLE 0x80L /* context specific + primitive */
typedef struct ldapmsg LDAPMessage;
#define NULLMSG ((LDAPMessage *) NULL)
-
-#ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
-/*
- * structure for tracking LDAP server host, ports, DNs, etc.
- */
-typedef struct ldap_server {
- char *lsrv_host;
- char *lsrv_dn; /* if NULL, use default */
- int lsrv_port;
- struct ldap_server *lsrv_next;
-} LDAPServer;
-
-
-/*
- * structure for representing an LDAP server connection
- */
-typedef struct ldap_conn {
- Sockbuf *lconn_sb;
- int lconn_refcnt;
- time_t lconn_lastused; /* time */
- int lconn_status;
-#define LDAP_CONNST_NEEDSOCKET 1
-#define LDAP_CONNST_CONNECTING 2
-#define LDAP_CONNST_CONNECTED 3
- LDAPServer *lconn_server;
- char *lconn_krbinstance;
- struct ldap_conn *lconn_next;
-} LDAPConn;
-
-
-/*
- * structure used to track outstanding requests
- */
-typedef struct ldapreq {
- int lr_msgid; /* the message id */
- int lr_status; /* status of request */
-#define LDAP_REQST_INPROGRESS 1
-#define LDAP_REQST_CHASINGREFS 2
-#define LDAP_REQST_NOTCONNECTED 3
-#define LDAP_REQST_WRITING 4
- int lr_outrefcnt; /* count of outstanding referrals */
- int lr_origid; /* original request's message id */
- int lr_parentcnt; /* count of parent requests */
- int lr_res_msgtype; /* result message type */
- int lr_res_errno; /* result LDAP errno */
- char *lr_res_error; /* result error string */
- char *lr_res_matched;/* result matched DN string */
- BerElement *lr_ber; /* ber encoded request contents */
- LDAPConn *lr_conn; /* connection used to send request */
- struct ldapreq *lr_parent; /* request that spawned this referral */
- struct ldapreq *lr_refnext; /* next referral spawned */
- struct ldapreq *lr_prev; /* previous request */
- struct ldapreq *lr_next; /* next request */
-} LDAPRequest;
-#endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
-
-
-/*
- * structure for client cache
- */
-#define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
-typedef struct ldapcache {
- LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
- LDAPMessage *lc_requests; /* unfulfilled reqs */
- long lc_timeout; /* request timeout */
- long lc_maxmem; /* memory to use */
- long lc_memused; /* memory in use */
- int lc_enabled; /* enabled? */
- unsigned long lc_options; /* options */
-#define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
-#define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
-} LDAPCache;
-#define NULLLDCACHE ((LDAPCache *)NULL)
-
/*
* structures for ldap getfilter routines
*/
char *lf_friendly;
} LDAPFriendlyMap;
-
-/*
- * handy macro to check whether LDAP struct is set up for CLDAP or not
- */
-#define LDAP_IS_CLDAP( ld ) ( (ld)->ld_sb.sb_naddr > 0 )
-
-
/*
* types for ldap URL handling
*/
LDAP_F int ldap_get_option LDAP_P((LDAP *ld, int option, void *outvalue));
LDAP_F int ldap_set_option LDAP_P((LDAP *ld, int option, void *invalue));
-/* Not yet */
+
+/*
+ * 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,
+ char *exoid,
+ struct berval *exdata,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ int *msgidp ));
+
+LDAP_F int ldap_extended_operation_s LDAP_P((
+ LDAP *ld,
+ char *exoid,
+ struct berval *exdata,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ char **retoidp,
+ struct berval **retdatap ));
+
/*
* 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,
+ char *dn,
+ LDAPMod **attrs,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ int *msgidp ));
+
+LDAP_F int ldap_add_ext_s LDAP_P((
+ LDAP *ld,
+ char *dn,
+ LDAPMod **attrs,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ LDAPMessage **res ));
+
LDAP_F int ldap_add LDAP_P(( LDAP *ld, char *dn, LDAPMod **attrs ));
LDAP_F int ldap_add_s LDAP_P(( LDAP *ld, char *dn, LDAPMod **attrs ));
+
+/*
+ * in saslbind.c:
+ */
+LDAP_F int ldap_sasl_bind LDAP_P((
+ LDAP *ld,
+ char *dn,
+ char *mechanism,
+ struct berval *cred,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ int msgidp ));
+
+LDAP_F int ldap_sasl_bind_s LDAP_P((
+ LDAP *ld,
+ char *dn,
+ char *mechanism,
+ struct berval *cred,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ struct berval **servercredp ));
+
+
/*
* in bind.c:
+ * (depreciated)
*/
LDAP_F int ldap_bind LDAP_P(( LDAP *ld, char *who, char *passwd, int authmethod ));
LDAP_F int ldap_bind_s LDAP_P(( LDAP *ld, char *who, char *cred, int method ));
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, char *who, char *passwd ));
LDAP_F int ldap_simple_bind_s LDAP_P(( LDAP *ld, char *who, char *passwd ));
+
/*
* in kbind.c:
+ * (depreciated)
*/
LDAP_F int ldap_kerberos_bind_s LDAP_P(( LDAP *ld, char *who ));
LDAP_F int ldap_kerberos_bind1 LDAP_P(( LDAP *ld, char *who ));
LDAP_F void ldap_uncache_entry LDAP_P(( LDAP *ld, 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,
+ char *dn,
+ char *attr,
+ struct berval *bvalue,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ int *msgidp ));
+
+LDAP_F int ldap_compare_ext_s LDAP_P((
+ LDAP *ld,
+ char *dn,
+ char *attr,
+ struct berval *bvalue,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ LDAPMessage **res ));
+
LDAP_F int ldap_compare LDAP_P(( LDAP *ld, char *dn, char *attr, char *value ));
LDAP_F int ldap_compare_s LDAP_P(( LDAP *ld, char *dn, char *attr, char *value ));
+
/*
* in delete.c:
*/
+LDAP_F int ldap_delete_ext LDAP_P((
+ LDAP *ld,
+ char *dn,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ int *msgidp ));
+
+LDAP_F int ldap_delete_ext_s LDAP_P((
+ LDAP *ld,
+ char *dn,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ LDAPMessage **res ));
+
LDAP_F int ldap_delete LDAP_P(( LDAP *ld, char *dn ));
LDAP_F int ldap_delete_s LDAP_P(( LDAP *ld, char *dn ));
+
/*
* in error.c:
*/
LDAP_F int ldap_result2error LDAP_P(( LDAP *ld, LDAPMessage *r, int freeit ));
LDAP_F char *ldap_err2string LDAP_P(( int err ));
LDAP_F void ldap_perror LDAP_P(( LDAP *ld, char *s ));
-LDAP_F int ldap_get_lderrno LDAP_P((LDAP *ld, char **matched, char **msg));
+
/*
* in modify.c:
*/
+LDAP_F int ldap_modify_ext LDAP_P((
+ LDAP *ld,
+ char *dn,
+ LDAPMod **mods,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ int *msgidp ));
+
+LDAP_F int ldap_modify_ext_s LDAP_P((
+ LDAP *ld,
+ char *dn,
+ LDAPMod **mods,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ LDAPMessage **res ));
+
LDAP_F int ldap_modify LDAP_P(( LDAP *ld, char *dn, LDAPMod **mods ));
LDAP_F int ldap_modify_s LDAP_P(( LDAP *ld, char *dn, LDAPMod **mods ));
+
+/*
+ * in rename.c:
+ */
+LDAP_F int ldap_rename_ext LDAP_P((
+ LDAP *ld,
+ char *dn,
+ char *newrdn,
+ char *newparent,
+ int deleteoldrdn,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ int *msgidp ));
+
+LDAP_F int ldap_rename_ext_s LDAP_P((
+ LDAP *ld,
+ char *dn,
+ char *newrdn,
+ char *newparent,
+ int deleteoldrdn,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ LDAPMessage **res ));
+
+
/*
* in modrdn.c:
*/
int deleteoldrdn ));
LDAP_F int ldap_modrdn2_s LDAP_P(( LDAP *ld, char *dn, char *newrdn,
int deleteoldrdn));
+LDAP_F int ldap_rename2 LDAP_P(( LDAP *ld, char *dn, char *newrdn,
+ int deleteoldrdn, char *newSuperior ));
+LDAP_F int ldap_rename2_s LDAP_P(( LDAP *ld, char *dn, char *newrdn,
+ int deleteoldrdn, char *newSuperior));
/*
* in open.c:
*/
LDAP_F LDAP *ldap_open LDAP_P(( char *host, int port ));
-LDAP_F LDAP *ldap_init LDAP_P(( char *defhost, int defport ));
+LDAP_F LDAP *ldap_init LDAP_P(( 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, LDAPMessage *ref ));
+LDAP_F int ldap_count_references LDAP_P(( LDAP *ld, LDAPMessage *chain ));
+LDAP_F int ldap_parse_reference LDAP_P((
+ LDAP *ld,
+ LDAPMessage *ref,
+ char ***referralsp,
+ LDAPControl ***serverctrls,
+ int freeit));
+
/*
* in getentry.c:
LDAP_F LDAPMessage *ldap_first_entry LDAP_P(( LDAP *ld, LDAPMessage *chain ));
LDAP_F LDAPMessage *ldap_next_entry LDAP_P(( LDAP *ld, LDAPMessage *entry ));
LDAP_F int ldap_count_entries LDAP_P(( LDAP *ld, LDAPMessage *chain ));
+LDAP_F int ldap_get_entry_controls LDAP_P((
+ LDAP *ld,
+ LDAPMessage *entry,
+ LDAPControl ***serverctrls));
+
/*
* in addentry.c
LDAPMessage *e ));
LDAP_F void ldap_add_result_entry LDAP_P(( LDAPMessage **list, LDAPMessage *e ));
+
/*
* in getdn.c
*/
LDAP_F char **ldap_explode_dns LDAP_P(( char *dn ));
LDAP_F int ldap_is_dns_dn LDAP_P(( char *dn ));
+
/*
* in getattr.c
*/
LDAP_F char *ldap_next_attribute LDAP_P(( LDAP *ld, LDAPMessage *entry,
BerElement *ber ));
+
/*
* in getvalues.c
*/
LDAP_F void ldap_value_free LDAP_P(( char **vals ));
LDAP_F void ldap_value_free_len LDAP_P(( struct berval **vals ));
+
/*
* in result.c:
*/
LDAP_F int ldap_msgfree LDAP_P(( LDAPMessage *lm ));
LDAP_F int ldap_msgdelete LDAP_P(( LDAP *ld, int msgid ));
+
/*
* in search.c:
*/
+LDAP_F int ldap_search_ext LDAP_P((
+ LDAP *ld,
+ char *base,
+ int scope,
+ char *filter,
+ char **attrs,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ struct timeval *timeout,
+ int sizelimit,
+ int *msgidp ));
+
+LDAP_F int ldap_search_ext_s LDAP_P((
+ LDAP *ld,
+ char *base,
+ int scope,
+ char *filter,
+ char **attrs,
+ LDAPControl **serverctrls,
+ LDAPControl **clientctrls,
+ struct timeval *timeout,
+ int sizelimit,
+ LDAPMessage **res ));
+
LDAP_F int ldap_search LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
char **attrs, int attrsonly ));
LDAP_F int ldap_search_s LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
LDAP_F int ldap_search_st LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
char **attrs, int attrsonly, struct timeval *timeout, LDAPMessage **res ));
+
/*
* in ufn.c
*/
char *pattern, char *prefix, char *suffix, char *attr,
char *value, char **valwords ));
+
/*
* in free.c
*/
+LDAP_F void ldap_memfree LDAP_P(( void *p ));
LDAP_F void ldap_getfilter_free LDAP_P(( LDAPFiltDesc *lfdp ));
LDAP_F void ldap_mods_free LDAP_P(( LDAPMod **mods, int freemods ));
+
/*
* in friendly.c
*/
LDAP_F int ldap_8859_to_t61 LDAP_P(( char **bufp, unsigned long *buflenp,
int free_input ));
-
-/*
- * in msdos/winsock/wsa.c
- */
-LDAP_F void ldap_memfree LDAP_P(( void *p ));
-
LDAP_END_DECL
#endif /* _LDAP_H */