]> git.sur5r.net Git - openldap/blobdiff - include/ldap.h
ITS#4943:
[openldap] / include / ldap.h
index c567d6adcc0389b41f205d4b6d12286f1bf4dc33..759b9ba01d62ecdcbe97228eb8dcff6c4b68ec39 100644 (file)
@@ -1,7 +1,7 @@
 /* $OpenLDAP$ */
 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  * 
- * Copyright 1998-2006 The OpenLDAP Foundation.
+ * Copyright 1998-2007 The OpenLDAP Foundation.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -76,7 +76,7 @@ LDAP_BEGIN_DECL
 #define LDAP_ALL_USER_ATTRIBUTES       "*"
 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES        "+" /* RFC 3673 */
 
-/* RFC 2251:  maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
+/* RFC 4511:  maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
 #define LDAP_MAXINT (2147483647)
 
 /*
@@ -95,16 +95,17 @@ LDAP_BEGIN_DECL
 #define LDAP_OPT_REFERRALS                     0x0008
 #define LDAP_OPT_RESTART                       0x0009
 /* 0x0a - 0x10 not defined */
-#define LDAP_OPT_PROTOCOL_VERSION      0x0011
-#define LDAP_OPT_SERVER_CONTROLS       0x0012
-#define LDAP_OPT_CLIENT_CONTROLS       0x0013
+#define LDAP_OPT_PROTOCOL_VERSION              0x0011
+#define LDAP_OPT_SERVER_CONTROLS               0x0012
+#define LDAP_OPT_CLIENT_CONTROLS               0x0013
 /* 0x14 not defined */
-#define LDAP_OPT_API_FEATURE_INFO      0x0015
+#define LDAP_OPT_API_FEATURE_INFO              0x0015
 /* 0x16 - 0x2f not defined */
 #define LDAP_OPT_HOST_NAME                     0x0030
-#define LDAP_OPT_RESULT_CODE           0x0031
-#define LDAP_OPT_ERROR_NUMBER          LDAP_OPT_RESULT_CODE
-#define LDAP_OPT_ERROR_STRING          0x0032
+#define LDAP_OPT_RESULT_CODE                   0x0031
+#define LDAP_OPT_ERROR_NUMBER                  LDAP_OPT_RESULT_CODE
+#define LDAP_OPT_DIAGNOSTIC_MESSAGE            0x0032
+#define LDAP_OPT_ERROR_STRING                  LDAP_OPT_DIAGNOSTIC_MESSAGE
 #define LDAP_OPT_MATCHED_DN                    0x0033
 /* 0x0034 - 0x3fff not defined */
 
@@ -121,10 +122,11 @@ LDAP_BEGIN_DECL
 #define LDAP_OPT_REFERRAL_URLS      0x5007  /* Referral URLs */
 #define LDAP_OPT_SOCKBUF            0x5008  /* sockbuf */
 #define LDAP_OPT_DEFBASE               0x5009  /* searchbase */
+#define        LDAP_OPT_CONNECT_ASYNC          0x5010  /* create connections asynchronously */
 
 /* OpenLDAP TLS options */
 #define LDAP_OPT_X_TLS                         0x6000
-#define LDAP_OPT_X_TLS_CTX                     0x6001  /* SSL CTX */
+#define LDAP_OPT_X_TLS_CTX                     0x6001  /* OpenSSL CTX */
 #define LDAP_OPT_X_TLS_CACERTFILE      0x6002
 #define LDAP_OPT_X_TLS_CACERTDIR       0x6003
 #define LDAP_OPT_X_TLS_CERTFILE                0x6004
@@ -212,9 +214,9 @@ typedef struct ldapcontrol {
 
 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
 
-#define LDAP_CONTROL_ASSERT                            "1.3.6.1.1.12"                  /* RFC TBD */
-#define LDAP_CONTROL_PRE_READ                  "1.3.6.1.1.13.1"                /* RFC TBD */
-#define LDAP_CONTROL_POST_READ                 "1.3.6.1.1.13.2"                /* RFC TBD */
+#define LDAP_CONTROL_ASSERT                            "1.3.6.1.1.12"                  /* RFC 4528 */
+#define LDAP_CONTROL_PRE_READ                  "1.3.6.1.1.13.1"                /* RFC 4527 */
+#define LDAP_CONTROL_POST_READ                 "1.3.6.1.1.13.2"                /* RFC 4527 */
 
 /*  standard track - not implemented in slapd(8) */
 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473" /* RFC 2891 */
@@ -223,7 +225,7 @@ typedef struct ldapcontrol {
 /*     non-standard track controls */
 #define LDAP_CONTROL_PAGEDRESULTS      "1.2.840.113556.1.4.319"   /* RFC 2696 */
 
-/* LDAP Sync -- draft-zeilenga-ldup-sync *//* RFC TBD */
+/* LDAP Content Synchronization Operation -- RFC 4533 */
 #define LDAP_SYNC_OID                  "1.3.6.1.4.1.4203.1.9.1"
 #define LDAP_CONTROL_SYNC              LDAP_SYNC_OID ".1"
 #define LDAP_CONTROL_SYNC_STATE        LDAP_SYNC_OID ".2"
@@ -262,7 +264,8 @@ typedef struct ldapcontrol {
 /* various works in progress */
 #define LDAP_CONTROL_NOOP                              "1.3.6.1.4.1.4203.666.5.2"
 #define LDAP_CONTROL_NO_SUBORDINATES   "1.3.6.1.4.1.4203.666.5.11"
-#define LDAP_CONTROL_MANAGEDIT                 "1.3.6.1.4.1.4203.666.5.12"
+#define LDAP_CONTROL_RELAX                             "1.3.6.1.4.1.4203.666.5.12"
+#define LDAP_CONTROL_MANAGEDIT                 LDAP_CONTROL_RELAX
 #define LDAP_CONTROL_SLURP                             "1.3.6.1.4.1.4203.666.5.13"
 #define LDAP_CONTROL_VALSORT                   "1.3.6.1.4.1.4203.666.5.14"
 #define LDAP_CONTROL_DONTUSECOPY               "1.3.6.1.4.1.4203.666.5.15"
@@ -271,14 +274,12 @@ typedef struct ldapcontrol {
 /* LDAP Chaining Behavior Control *//* work in progress */
 /* <draft-sermersheim-ldap-chaining>;
  * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
-#ifdef LDAP_DEVEL
 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR       "1.3.6.1.4.1.4203.666.11.3"
 
 #define        LDAP_CHAINING_PREFERRED                         0
 #define        LDAP_CHAINING_REQUIRED                          1
 #define LDAP_REFERRALS_PREFERRED                       2
 #define LDAP_REFERRALS_REQUIRED                                3
-#endif
 
 /* MS Active Directory controls (for compatibility) */
 #define LDAP_CONTROL_X_INCREMENTAL_VALUES      "1.2.840.113556.1.4.802"
@@ -313,11 +314,11 @@ typedef struct ldapcontrol {
 
 
 /* LDAP Unsolicited Notifications */
-#define        LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
+#define        LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 
 /* LDAP Extended Operations */
-#define LDAP_EXOP_START_TLS            "1.3.6.1.4.1.1466.20037"        /* RFC 2830 */
+#define LDAP_EXOP_START_TLS            "1.3.6.1.4.1.1466.20037"        /* RFC 4511 */
 
 #define LDAP_EXOP_MODIFY_PASSWD        "1.3.6.1.4.1.4203.1.11.1"       /* RFC 3062 */
 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
@@ -325,7 +326,7 @@ typedef struct ldapcontrol {
 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW        ((ber_tag_t) 0x82U)
 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN        ((ber_tag_t) 0x80U)
 
-#define LDAP_EXOP_CANCEL               "1.3.6.1.1.8"                           /* RFC 3909 */
+#define LDAP_EXOP_CANCEL               "1.3.6.1.1.8"                                   /* RFC 3909 */
 #define LDAP_EXOP_X_CANCEL             LDAP_EXOP_CANCEL
 
 #define        LDAP_EXOP_REFRESH               "1.3.6.1.4.1.1466.101.119.1"    /* RFC 2589 */
@@ -333,17 +334,15 @@ typedef struct ldapcontrol {
 #define        LDAP_TAG_EXOP_REFRESH_REQ_TTL   ((ber_tag_t) 0x81U)
 #define        LDAP_TAG_EXOP_REFRESH_RES_TTL   ((ber_tag_t) 0x80U)
 
-#define LDAP_EXOP_WHO_AM_I             "1.3.6.1.4.1.4203.1.11.3"
+#define LDAP_EXOP_WHO_AM_I             "1.3.6.1.4.1.4203.1.11.3"               /* RFC 4532 */
 #define LDAP_EXOP_X_WHO_AM_I   LDAP_EXOP_WHO_AM_I
 
 /* various works in progress */
-#ifdef LDAP_DEVEL
-#define LDAP_EXOP_X_TURN               "1.3.6.1.4.1.4203.666.6.4"
-#endif
+#define LDAP_EXOP_TURN         "1.3.6.1.1.19"                          /* RFC 4531 */
+#define LDAP_EXOP_X_TURN       LDAP_EXOP_TURN
 
 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
 /* a work in progress */
-#ifdef LDAP_DEVEL
 #define LDAP_X_DISTPROC_BASE           "1.3.6.1.4.1.4203.666.11.6"
 #define LDAP_EXOP_X_CHAINEDREQUEST     LDAP_X_DISTPROC_BASE ".1"
 #define LDAP_FEATURE_X_CANCHAINOPS     LDAP_X_DISTPROC_BASE ".2"
@@ -357,10 +356,9 @@ typedef struct ldapcontrol {
 #define LDAP_URLEXT_X_REFTYPE          "x-referenceType"
 #define LDAP_URLEXT_X_SEARCHEDSUBTREE  "x-searchedSubtree"
 #define LDAP_URLEXT_X_FAILEDNAME       "x-failedName"
-#endif
 
 #ifdef LDAP_DEVEL
-#define LDAP_X_TXN                                             "1.3.6.1.4.1.4203.666.11.7" /* temp */
+#define LDAP_X_TXN                                             "1.3.6.1.4.1.4203.666.11.7" /* tmp */
 #define LDAP_EXOP_X_TXN_START                  LDAP_X_TXN ".1"
 #define LDAP_CONTROL_X_TXN_SPEC                        LDAP_X_TXN ".2"
 #define LDAP_EXOP_X_TXN_END                            LDAP_X_TXN ".3"
@@ -376,12 +374,10 @@ typedef struct ldapcontrol {
 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
 
-#ifdef LDAP_DEVEL
 /* LDAP Experimental (works in progress) Features */
 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
        "1.3.6.1.4.1.4203.666.8.1" /* "children" */
 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
-#endif
 
 /*
  * specific LDAP instantiations of BER types we know about
@@ -658,6 +654,7 @@ typedef struct ldapcontrol {
 #define LDAP_MORE_RESULTS_TO_RETURN            (-15)   /* Obsolete */
 #define LDAP_CLIENT_LOOP                               (-16)
 #define LDAP_REFERRAL_LIMIT_EXCEEDED   (-17)
+#define        LDAP_X_CONNECTING                       (-18)
 
 
 /*
@@ -740,6 +737,138 @@ typedef struct ldap_url_desc {
 #define LDAP_URL_ERR_BADFILTER 0x09    /* bad or missing filter */
 #define LDAP_URL_ERR_BADEXTS   0x0a    /* bad or missing extensions */
 
+/*
+ * LDAP sync (RFC4533) API
+ */
+
+typedef struct ldap_sync_t ldap_sync_t;
+
+typedef enum {
+       /* these are private - the client should never see them */
+       LDAP_SYNC_CAPI_NONE             = -1,
+
+       LDAP_SYNC_CAPI_PHASE_FLAG       = 0x10U,
+       LDAP_SYNC_CAPI_IDSET_FLAG       = 0x20U,
+       LDAP_SYNC_CAPI_DONE_FLAG        = 0x40U,
+
+       /* these are passed to ls_search_entry() */
+       LDAP_SYNC_CAPI_PRESENT          = LDAP_SYNC_PRESENT,
+       LDAP_SYNC_CAPI_ADD              = LDAP_SYNC_ADD,
+       LDAP_SYNC_CAPI_MODIFY           = LDAP_SYNC_MODIFY,
+       LDAP_SYNC_CAPI_DELETE           = LDAP_SYNC_DELETE,
+
+       /* these are passed to ls_intermediate() */
+       LDAP_SYNC_CAPI_PRESENTS         = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ),
+       LDAP_SYNC_CAPI_DELETES          = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ),
+
+       LDAP_SYNC_CAPI_PRESENTS_IDSET   = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ),
+       LDAP_SYNC_CAPI_DELETES_IDSET    = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ),
+
+       LDAP_SYNC_CAPI_DONE             = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS )
+} ldap_sync_refresh_t;
+
+/*
+ * Called when an entry is returned by ldap_result().
+ * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
+ * the entry has been either added or modified, and thus
+ * the complete view of the entry should be in the LDAPMessage.
+ * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
+ * only the DN should be in the LDAPMessage.
+ */
+typedef int (*ldap_sync_search_entry_f) LDAP_P((
+       ldap_sync_t                     *ls,
+       LDAPMessage                     *msg,
+       struct berval                   *entryUUID,
+       ldap_sync_refresh_t             phase ));
+
+/*
+ * Called when a reference is returned; the client should know 
+ * what to do with it.
+ */
+typedef int (*ldap_sync_search_reference_f) LDAP_P((
+       ldap_sync_t                     *ls,
+       LDAPMessage                     *msg ));
+
+/*
+ * Called when specific intermediate/final messages are returned.
+ * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
+ * a "presents" or "deletes" phase begins.
+ * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
+ * with refreshDone set to "TRUE" has been returned, to indicate
+ * that the refresh phase of a refreshAndPersist is complete.
+ * In the above cases, syncUUIDs is NULL.
+ *
+ * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or 
+ * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
+ * that are either present or have been deleted.
+ */
+typedef int (*ldap_sync_intermediate_f) LDAP_P((
+       ldap_sync_t                     *ls,
+       LDAPMessage                     *msg,
+       BerVarray                       syncUUIDs,
+       ldap_sync_refresh_t             phase ));
+
+/*
+ * Called when a searchResultDone is returned.  In refreshAndPersist,
+ * this can only occur if the search for any reason is being terminated
+ * by the server.
+ */
+typedef int (*ldap_sync_search_result_f) LDAP_P((
+       ldap_sync_t                     *ls,
+       LDAPMessage                     *msg,
+       int                             refreshDeletes ));
+
+/*
+ * This structure contains all information about the persistent search;
+ * the caller is responsible for connecting, setting version, binding, tls...
+ */
+struct ldap_sync_t {
+       /* conf search params */
+       char                            *ls_base;
+       int                             ls_scope;
+       char                            *ls_filter;
+       char                            **ls_attrs;
+       int                             ls_timelimit;
+       int                             ls_sizelimit;
+
+       /* poll timeout */
+       int                             ls_timeout;
+
+       /* helpers - add as appropriate */
+       ldap_sync_search_entry_f        ls_search_entry;
+       ldap_sync_search_reference_f    ls_search_reference;
+       ldap_sync_intermediate_f        ls_intermediate;
+       ldap_sync_search_result_f       ls_search_result;
+
+       /* set by the caller as appropriate */
+       void                            *ls_private;
+
+       /* conn stuff */
+       LDAP                            *ls_ld;
+
+       /* --- the parameters below are private - do not modify --- */
+
+       /* FIXME: make the structure opaque, and provide an interface
+        * to modify the public values? */
+
+       /* result stuff */
+       int                             ls_msgid;
+
+       /* sync stuff */
+       /* needed by refreshOnly */
+       int                             ls_reloadHint;
+
+       /* opaque - need to pass between sessions, updated by the API */
+       struct berval                   ls_cookie;
+
+       /* state variable - do not modify */
+       ldap_sync_refresh_t             ls_refreshPhase;
+};
+
+/*
+ * End of LDAP sync (RFC4533) API
+ */
+
 /*
  * The API draft spec says we should declare (or cause to be declared)
  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
@@ -888,9 +1017,9 @@ ldap_abandon_ext LDAP_P((
        LDAPControl             **serverctrls,
        LDAPControl             **clientctrls ));
 
-#if LDAP_DEPRECATED
+#if LDAP_DEPRECATED    
 LDAP_F( int )
-ldap_abandon LDAP_P((  /* deprecated */
+ldap_abandon LDAP_P((  /* deprecated, use ldap_abandon_ext */
        LDAP *ld,
        int msgid ));
 #endif
@@ -917,13 +1046,13 @@ ldap_add_ext_s LDAP_P((
 
 #if LDAP_DEPRECATED
 LDAP_F( int )
-ldap_add LDAP_P((      /* deprecated */
+ldap_add LDAP_P((      /* deprecated, use ldap_add_ext */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAPMod **attrs ));
 
 LDAP_F( int )
-ldap_add_s LDAP_P((    /* deprecated */
+ldap_add_s LDAP_P((    /* deprecated, use ldap_add_ext_s */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAPMod **attrs ));
@@ -996,14 +1125,14 @@ ldap_parse_sasl_bind_result LDAP_P((
  *     (deprecated)
  */
 LDAP_F( int )
-ldap_bind LDAP_P((     /* deprecated */
+ldap_bind LDAP_P((     /* deprecated, use ldap_sasl_bind */
        LDAP *ld,
        LDAP_CONST char *who,
        LDAP_CONST char *passwd,
        int authmethod ));
 
 LDAP_F( int )
-ldap_bind_s LDAP_P((   /* deprecated */
+ldap_bind_s LDAP_P((   /* deprecated, use ldap_sasl_bind_s */
        LDAP *ld,
        LDAP_CONST char *who,
        LDAP_CONST char *cred,
@@ -1013,46 +1142,17 @@ ldap_bind_s LDAP_P((    /* deprecated */
  * in sbind.c:
  */
 LDAP_F( int )
-ldap_simple_bind LDAP_P(( /* deprecated */
+ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
        LDAP *ld,
        LDAP_CONST char *who,
        LDAP_CONST char *passwd ));
 
 LDAP_F( int )
-ldap_simple_bind_s LDAP_P(( /* deprecated */
+ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
        LDAP *ld,
        LDAP_CONST char *who,
        LDAP_CONST char *passwd ));
 
-
-/*
- * in kbind.c:
- *     (deprecated)
- */
-LDAP_F( int )
-ldap_kerberos_bind_s LDAP_P((  /* deprecated */
-       LDAP *ld,
-       LDAP_CONST char *who ));
-
-LDAP_F( int )
-ldap_kerberos_bind1 LDAP_P((   /* deprecated */
-       LDAP *ld,
-       LDAP_CONST char *who ));
-
-LDAP_F( int )
-ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
-       LDAP *ld,
-       LDAP_CONST char *who ));
-
-LDAP_F( int )
-ldap_kerberos_bind2 LDAP_P((   /* deprecated */
-       LDAP *ld,
-       LDAP_CONST char *who ));
-
-LDAP_F( int )
-ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
-       LDAP *ld,
-       LDAP_CONST char *who ));
 #endif
 
 
@@ -1080,14 +1180,14 @@ ldap_compare_ext_s LDAP_P((
 
 #if LDAP_DEPRECATED
 LDAP_F( int )
-ldap_compare LDAP_P((  /* deprecated */
+ldap_compare LDAP_P((  /* deprecated, use ldap_compare_ext */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAP_CONST char *attr,
        LDAP_CONST char *value ));
 
 LDAP_F( int )
-ldap_compare_s LDAP_P((        /* deprecated */
+ldap_compare_s LDAP_P((        /* deprecated, use ldap_compare_ext_s */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAP_CONST char *attr,
@@ -1115,12 +1215,12 @@ ldap_delete_ext_s LDAP_P((
 
 #if LDAP_DEPRECATED
 LDAP_F( int )
-ldap_delete LDAP_P((   /* deprecated */
+ldap_delete LDAP_P((   /* deprecated, use ldap_delete_ext */
        LDAP *ld,
        LDAP_CONST char *dn ));
 
 LDAP_F( int )
-ldap_delete_s LDAP_P(( /* deprecated */
+ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
        LDAP *ld,
        LDAP_CONST char *dn ));
 #endif
@@ -1146,13 +1246,13 @@ ldap_err2string LDAP_P((
 
 #if LDAP_DEPRECATED
 LDAP_F( int )
-ldap_result2error LDAP_P((     /* deprecated */
+ldap_result2error LDAP_P((     /* deprecated, use ldap_parse_result */
        LDAP *ld,
        LDAPMessage *r,
        int freeit ));
 
 LDAP_F( void )
-ldap_perror LDAP_P((   /* deprecated */
+ldap_perror LDAP_P((   /* deprecated, use ldap_err2string */
        LDAP *ld,
        LDAP_CONST char *s ));
 #endif
@@ -1180,13 +1280,13 @@ ldap_modify_ext_s LDAP_P((
 
 #if LDAP_DEPRECATED
 LDAP_F( int )
-ldap_modify LDAP_P((   /* deprecated */
+ldap_modify LDAP_P((   /* deprecated, use ldap_modify_ext */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAPMod **mods ));
 
 LDAP_F( int )
-ldap_modify_s LDAP_P(( /* deprecated */
+ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAPMod **mods ));
@@ -1219,7 +1319,7 @@ ldap_rename_s LDAP_P((
 
 #if LDAP_DEPRECATED
 LDAP_F( int )
-ldap_rename2 LDAP_P((  /* deprecated */
+ldap_rename2 LDAP_P((  /* deprecated, use ldap_rename */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAP_CONST char *newrdn,
@@ -1227,7 +1327,7 @@ ldap_rename2 LDAP_P((     /* deprecated */
        int deleteoldrdn ));
 
 LDAP_F( int )
-ldap_rename2_s LDAP_P((        /* deprecated */
+ldap_rename2_s LDAP_P((        /* deprecated, use ldap_rename_s */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAP_CONST char *newrdn,
@@ -1235,26 +1335,26 @@ ldap_rename2_s LDAP_P(( /* deprecated */
        int deleteoldrdn ));
 
 LDAP_F( int )
-ldap_modrdn LDAP_P((   /* deprecated */
+ldap_modrdn LDAP_P((   /* deprecated, use ldap_rename */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAP_CONST char *newrdn ));
 
 LDAP_F( int )
-ldap_modrdn_s LDAP_P(( /* deprecated */
+ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAP_CONST char *newrdn ));
 
 LDAP_F( int )
-ldap_modrdn2 LDAP_P((  /* deprecated */
+ldap_modrdn2 LDAP_P((  /* deprecated, use ldap_rename */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAP_CONST char *newrdn,
        int deleteoldrdn ));
 
 LDAP_F( int )
-ldap_modrdn2_s LDAP_P((        /* deprecated */
+ldap_modrdn2_s LDAP_P((        /* deprecated, use ldap_rename_s */
        LDAP *ld,
        LDAP_CONST char *dn,
        LDAP_CONST char *newrdn,
@@ -1267,12 +1367,12 @@ ldap_modrdn2_s LDAP_P(( /* deprecated */
  */
 #if LDAP_DEPRECATED
 LDAP_F( LDAP * )
-ldap_init LDAP_P(( /* deprecated */
+ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
        LDAP_CONST char *host,
        int port ));
 
 LDAP_F( LDAP * )
-ldap_open LDAP_P((     /* deprecated */
+ldap_open LDAP_P((     /* deprecated, use ldap_create or ldap_initialize */
        LDAP_CONST char *host,
        int port ));
 #endif
@@ -1496,16 +1596,16 @@ ldap_dn_normalize LDAP_P((
        char **out, unsigned oflags ));
 
 LDAP_F( char * )
-ldap_dn2ufn LDAP_P(( /* deprecated */
+ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
        LDAP_CONST char *dn ));
 
 LDAP_F( char ** )
-ldap_explode_dn LDAP_P(( /* deprecated */
+ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
        LDAP_CONST char *dn,
        int notypes ));
 
 LDAP_F( char ** )
-ldap_explode_rdn LDAP_P(( /* deprecated */
+ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
        LDAP_CONST char *rdn,
        int notypes ));
 
@@ -1517,13 +1617,16 @@ ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
        LDAPDN_rewrite_func *func, unsigned flags ));
 
 LDAP_F( char * )
-ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
+ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
+       LDAP_CONST char *dn ));
 
 LDAP_F( char * )
-ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce ));        /* deprecated */
+ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
+       LDAP_CONST char *dce ));
 
 LDAP_F( char * )
-ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
+ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
+       LDAP_CONST char *dn ));
 
 LDAP_F( int )
 ldap_get_dn_ber LDAP_P((
@@ -1569,17 +1672,17 @@ ldap_value_free_len LDAP_P((
 
 #if LDAP_DEPRECATED
 LDAP_F( char ** )
-ldap_get_values LDAP_P((       /* deprecated */
+ldap_get_values LDAP_P((       /* deprecated, use ldap_get_values_len */
        LDAP *ld,
        LDAPMessage *entry,
        LDAP_CONST char *target ));
 
 LDAP_F( int )
-ldap_count_values LDAP_P((     /* deprecated */
+ldap_count_values LDAP_P((     /* deprecated, use ldap_count_values_len */
        char **vals ));
 
 LDAP_F( void )
-ldap_value_free LDAP_P((       /* deprecated */
+ldap_value_free LDAP_P((       /* deprecated, use ldap_value_free_len */
        char **vals ));
 #endif
 
@@ -1650,7 +1753,7 @@ ldap_search_ext_s LDAP_P((
 
 #if LDAP_DEPRECATED
 LDAP_F( int )
-ldap_search LDAP_P((   /* deprecated */
+ldap_search LDAP_P((   /* deprecated, use ldap_search_ext */
        LDAP *ld,
        LDAP_CONST char *base,
        int scope,
@@ -1659,7 +1762,7 @@ ldap_search LDAP_P((      /* deprecated */
        int attrsonly ));
 
 LDAP_F( int )
-ldap_search_s LDAP_P(( /* deprecated */
+ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
        LDAP *ld,
        LDAP_CONST char *base,
        int scope,
@@ -1669,7 +1772,7 @@ ldap_search_s LDAP_P((    /* deprecated */
        LDAPMessage **res ));
 
 LDAP_F( int )
-ldap_search_st LDAP_P((        /* deprecated */
+ldap_search_st LDAP_P((        /* deprecated, use ldap_search_ext_s */
        LDAP *ld,
        LDAP_CONST char *base,
        int scope,
@@ -1697,11 +1800,11 @@ ldap_unbind_ext_s LDAP_P((
 
 #if LDAP_DEPRECATED
 LDAP_F( int )
-ldap_unbind LDAP_P(( /* deprecated */
+ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
        LDAP *ld ));
 
 LDAP_F( int )
-ldap_unbind_s LDAP_P(( /* deprecated */
+ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
        LDAP *ld ));
 #endif
 
@@ -1751,7 +1854,7 @@ ldap_mods_free LDAP_P((
 
 #if LDAP_DEPRECATED
 /*
- * in sort.c (deprecated)
+ * in sort.c (deprecated, use custom code instead)
  */
 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
        LDAP_CONST char *left,
@@ -1872,6 +1975,7 @@ ldap_create_page_control LDAP_P((
 #if LDAP_DEPRECATED
 LDAP_F( int )
 ldap_parse_page_control LDAP_P((
+       /* deprecated, use ldap_parse_pageresponse_control */
        LDAP *ld,
        LDAPControl **ctrls,
        ber_int_t *count,
@@ -2060,7 +2164,7 @@ ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
 
 /*
- * LDAP Dynamic Directory Services Refresh RFC2589
+ * LDAP Dynamic Directory Services Refresh -- RFC 2589
  *     in dds.c
  */
 #define LDAP_API_FEATURE_REFRESH 1000
@@ -2121,5 +2225,53 @@ ldap_txn_end_s LDAP_P(( LDAP *ld,
        int *retidp ));
 #endif
 
+/*
+ * in ldap_sync.c
+ */
+
+/*
+ * initialize the persistent search structure
+ */
+LDAP_F( ldap_sync_t * )
+ldap_sync_initialize LDAP_P((
+       ldap_sync_t     *ls ));
+
+/*
+ * destroy the persistent search structure
+ */
+LDAP_F( void )
+ldap_sync_destroy LDAP_P((
+       ldap_sync_t     *ls,
+       int             freeit ));
+
+/*
+ * initialize a refreshOnly sync
+ */
+LDAP_F( int )
+ldap_sync_init LDAP_P((
+       ldap_sync_t     *ls,
+       int             mode ));
+
+/*
+ * initialize a refreshOnly sync
+ */
+LDAP_F( int )
+ldap_sync_init_refresh_only LDAP_P((
+       ldap_sync_t     *ls ));
+
+/*
+ * initialize a refreshAndPersist sync
+ */
+LDAP_F( int )
+ldap_sync_init_refresh_and_persist LDAP_P((
+       ldap_sync_t     *ls ));
+
+/*
+ * poll for new responses
+ */
+LDAP_F( int )
+ldap_sync_poll LDAP_P((
+       ldap_sync_t     *ls ));
+
 LDAP_END_DECL
 #endif /* _LDAP_H */