]> git.sur5r.net Git - openldap/blobdiff - include/ldap.h
cleanup
[openldap] / include / ldap.h
index 13f45cd07f53111d1c7f13aca8f47ae1384d89c5..c567d6adcc0389b41f205d4b6d12286f1bf4dc33 100644 (file)
@@ -1,7 +1,7 @@
 /* $OpenLDAP$ */
 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  * 
- * Copyright 1998-2005 The OpenLDAP Foundation.
+ * Copyright 1998-2006 The OpenLDAP Foundation.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -120,6 +120,7 @@ LDAP_BEGIN_DECL
 #define LDAP_OPT_URI                           0x5006
 #define LDAP_OPT_REFERRAL_URLS      0x5007  /* Referral URLs */
 #define LDAP_OPT_SOCKBUF            0x5008  /* sockbuf */
+#define LDAP_OPT_DEFBASE               0x5009  /* searchbase */
 
 /* OpenLDAP TLS options */
 #define LDAP_OPT_X_TLS                         0x6000
@@ -137,6 +138,7 @@ LDAP_BEGIN_DECL
 #define LDAP_OPT_X_TLS_CONNECT_CB      0x600c
 #define LDAP_OPT_X_TLS_CONNECT_ARG     0x600d
 #define LDAP_OPT_X_TLS_DHFILE          0x600e
+#define LDAP_OPT_X_TLS_NEWCTX          0x600f
 
 #define LDAP_OPT_X_TLS_NEVER   0
 #define LDAP_OPT_X_TLS_HARD            1
@@ -205,10 +207,11 @@ typedef struct ldapcontrol {
 /* LDAP Controls */
 /*     standard track controls */
 #define LDAP_CONTROL_MANAGEDSAIT       "2.16.840.1.113730.3.4.2"  /* RFC 3296 */
-#define LDAP_CONTROL_PROXY_AUTHZ       "2.16.840.1.113730.3.4.18" /* RFC TBD  */
+#define LDAP_CONTROL_PROXY_AUTHZ       "2.16.840.1.113730.3.4.18" /* RFC 4370 */
 #define LDAP_CONTROL_SUBENTRIES                "1.3.6.1.4.1.4203.1.10.1"  /* RFC 3672 */
 
-#define LDAP_CONTROL_VALUESRETURNFILTER        "1.2.826.0.1.334810.2.3"/* RFC 3876 */
+#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 */
@@ -220,20 +223,7 @@ typedef struct ldapcontrol {
 /*     non-standard track controls */
 #define LDAP_CONTROL_PAGEDRESULTS      "1.2.840.113556.1.4.319"   /* RFC 2696 */
 
-/* Password policy Controls *//* work in progress */
-/* ITS#3458: released; disabled by default */
-#define LDAP_CONTROL_PASSWORDPOLICYREQUEST     "1.3.6.1.4.1.42.2.27.8.5.1"
-#define LDAP_CONTROL_PASSWORDPOLICYRESPONSE    "1.3.6.1.4.1.42.2.27.8.5.1"
-
-/* 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_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"
-
-/* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
+/* LDAP Sync -- draft-zeilenga-ldup-sync *//* RFC TBD */
 #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"
@@ -263,6 +253,21 @@ typedef struct ldapcontrol {
 #define LDAP_SYNC_MODIFY                               2
 #define LDAP_SYNC_DELETE                               3
 
+
+/* Password policy Controls *//* work in progress */
+/* ITS#3458: released; disabled by default */
+#define LDAP_CONTROL_PASSWORDPOLICYREQUEST     "1.3.6.1.4.1.42.2.27.8.5.1"
+#define LDAP_CONTROL_PASSWORDPOLICYRESPONSE    "1.3.6.1.4.1.42.2.27.8.5.1"
+
+/* 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_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"
+
+
 /* LDAP Chaining Behavior Control *//* work in progress */
 /* <draft-sermersheim-ldap-chaining>;
  * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
@@ -323,33 +328,23 @@ typedef struct ldapcontrol {
 #define LDAP_EXOP_CANCEL               "1.3.6.1.1.8"                           /* RFC 3909 */
 #define LDAP_EXOP_X_CANCEL             LDAP_EXOP_CANCEL
 
-/* various works in progress */
+#define        LDAP_EXOP_REFRESH               "1.3.6.1.4.1.1466.101.119.1"    /* RFC 2589 */
+#define        LDAP_TAG_EXOP_REFRESH_REQ_DN    ((ber_tag_t) 0x80U)
+#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_X_WHO_AM_I   LDAP_EXOP_WHO_AM_I
 
-#define LDAP_EXOP_X_TURN               "1.3.6.1.4.1.4203.666.6.4"
-
-/* LDAP Grouping of Related Operations *//* a work in progress */
-#ifdef LDAP_DEVEL
-#define LDAP_X_GROUPING_BASE           "1.3.6.1.4.1.4203.666.10.3"
-#define LDAP_EXOP_GROUPING_CREATE      LDAP_X_GROUPING_BASE ".1"
-#define LDAP_EXOP_GROUPING_END         LDAP_X_GROUPING_BASE ".2"
-#define LDAP_NOTICE_GROUPING_END       LDAP_X_GROUPING_BASE ".3"
-#define LDAP_EXOP_GROUPING_ACTION      LDAP_X_GROUPING_BASE ".4"
-#define LDAP_NOTICE_GROUPING_INFO      LDAP_X_GROUPING_BASE ".5"
-#define LDAP_CONTROL_GROUPING          LDAP_X_GROUPING_BASE ".6"
-#endif
-
-/* LDAP Grouping Types *//* a work in progress */
+/* various works in progress */
 #ifdef LDAP_DEVEL
-#define LDAP_GROUP_TRANSACTION          "1.3.6.1.4.1.4203.666.10.4"
+#define LDAP_EXOP_X_TURN               "1.3.6.1.4.1.4203.666.6.4"
 #endif
 
 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
 /* a work in progress */
 #ifdef LDAP_DEVEL
-/* FIXME: allocate an OID arc under OpenLDAP experimental arc */
-#define LDAP_X_DISTPROC_BASE           "1.3.6.1.4.1.4203.666.999999"
+#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"
 #define LDAP_CONTROL_X_RETURNCONTREF   LDAP_X_DISTPROC_BASE ".3"
@@ -364,6 +359,14 @@ typedef struct ldapcontrol {
 #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_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"
+#define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
+#endif
+
 /* LDAP Features */
 #define LDAP_FEATURE_ALL_OP_ATTRS      "1.3.6.1.4.1.4203.1.5.1"        /* RFC 3673 */
 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
@@ -553,7 +556,7 @@ typedef struct ldapcontrol {
 
 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
 
-#define LDAP_PROXY_AUTHZ_FAILURE       0x2F /* LDAPv3 proxy authorization */
+#define LDAP_X_PROXY_AUTHZ_FAILURE     0x2F /* LDAPv3 proxy authorization */
 #define LDAP_INAPPROPRIATE_AUTH                0x30
 #define LDAP_INVALID_CREDENTIALS       0x31
 #define LDAP_INSUFFICIENT_ACCESS       0x32
@@ -594,6 +597,8 @@ typedef struct ldapcontrol {
 /* Assertion control (122) */ 
 #define LDAP_ASSERTION_FAILED          0x7A
 
+/* Proxied Authorization Denied (123) */ 
+#define LDAP_PROXIED_AUTHORIZATION_DENIED              0x7B
 
 /* Experimental result codes */
 #define LDAP_E_ERROR(n)        LDAP_RANGE((n),0x1000,0x3FFF)
@@ -623,6 +628,11 @@ typedef struct ldapcontrol {
 #define LDAP_X_INVALIDREFERENCE                        0x4112
 #endif
 
+#ifdef LDAP_X_TXN
+#define LDAP_X_TXN_SPECIFY_OKAY                0x4120
+#define LDAP_X_TXN_ID_INVALID          0x4121
+#endif
+
 /* API Error Codes
  *
  * Based on draft-ietf-ldap-c-api-xx
@@ -774,6 +784,19 @@ ldap_set_nextref_proc LDAP_P((
        LDAP_NEXTREF_PROC *nextref_proc,
        void *params ));
 
+/* V3 URLLIST Function Callback Prototype */
+typedef int (LDAP_URLLIST_PROC) LDAP_P((
+       LDAP *ld, 
+       LDAPURLDesc **urllist,
+       LDAPURLDesc **url,
+       void *params ));
+
+LDAP_F( int )
+ldap_set_urllist_proc LDAP_P((
+       LDAP *ld,
+       LDAP_URLLIST_PROC *urllist_proc,
+       void *params ));
+
 /*
  * in controls.c:
  */
@@ -854,111 +877,6 @@ ldap_parse_intermediate LDAP_P((
        LDAPControl             ***serverctrls,
        int                             freeit ));
 
-/*
- * in groupings.c:
- */
-#ifdef LDAP_EXOP_GROUPING_CREATE
-
-LDAP_F( int )
-ldap_grouping_create LDAP_P((
-       LDAP                    *ld,
-       LDAP_CONST char *grpoid,
-       struct berval   *grpdata,
-       LDAPControl             **serverctrls,
-       LDAPControl             **clientctrls,
-       int                             *msgidp ));
-
-LDAP_F( int )
-ldap_grouping_create_s LDAP_P((
-       LDAP                    *ld,
-       LDAP_CONST char *grpoid,
-       struct berval   *grpdata,
-       LDAPControl             **serverctrls,
-       LDAPControl             **clientctrls,
-       struct berval   **retgrpcookiep,
-       struct berval   **retgrpdatap ));
-
-LDAP_F( int )
-ldap_parse_grouping_create_result LDAP_P((
-       LDAP                    *ld,
-       LDAPMessage             *res,
-       struct berval   **retgrpcookiep,
-       struct berval   **retgrpdatap,
-       LDAPControl             ***serverctrls,
-       int                             freeit ));
-
-LDAP_F( int )
-ldap_grouping_end LDAP_P((
-       LDAP                    *ld,
-       LDAP_CONST char *grpoid,
-       struct berval   *grpdata,
-       LDAPControl             **serverctrls,
-       LDAPControl             **clientctrls,
-       int                             *msgidp ));
-
-LDAP_F( int )
-ldap_grouping_end_s LDAP_P((
-       LDAP                    *ld,
-       LDAP_CONST char *grpoid,
-       struct berval   *grpdata,
-       LDAPControl             **serverctrls,
-       LDAPControl             **clientctrls,
-       struct berval   **retgrpdatap ));
-
-LDAP_F( int )
-ldap_parse_grouping_end_result LDAP_P((
-       LDAP                    *ld,
-       LDAPMessage             *res,
-       struct berval   **retgrpdatap,
-       LDAPControl             ***serverctrls,
-       int                             freeit ));
-
-LDAP_F( int )
-ldap_grouping_action_operation LDAP_P((
-       LDAP                    *ld,
-       LDAP_CONST char *grpoid,
-       struct berval   *grpdata,
-       LDAPControl             **serverctrls,
-       LDAPControl             **clientctrls,
-       int                             *msgidp ));
-
-LDAP_F( int )
-ldap_grouping_action_operation_s LDAP_P((
-       LDAP                    *ld,
-       LDAP_CONST char *grpoid,
-       struct berval   *grpdata,
-       LDAPControl             **serverctrls,
-       LDAPControl             **clientctrls,
-       struct berval   **retgrpcookiep,
-       struct berval   **retgrpdatap ));
-
-LDAP_F( int )
-ldap_parse_grouping_action_result LDAP_P((
-       LDAP                    *ld,
-       LDAPMessage             *res,
-       struct berval   **retgrpcookiep,
-       struct berval   **retgrpdatap,
-       LDAPControl             ***serverctrls,
-       int                             freeit ));
-
-LDAP_F( int )
-ldap_parse_grouping_end_notice LDAP_P((
-       LDAP                    *ld,
-       LDAPMessage             *res,
-       struct berval   **retdatap,
-       struct berval   **retgrpcookiep,
-       struct berval   **retgrpdatap,
-       int                             freeit ));
-
-LDAP_F( int )
-ldap_parse_grouping_info_notice LDAP_P((
-       LDAP                    *ld,
-       LDAPMessage             *res,
-       struct berval   **retdatap,
-       struct berval   **retgrpcookiep,
-       struct berval   **retgrpdatap,
-       int                             freeit ));
-#endif
 
 /*
  * in abandon.c:
@@ -977,7 +895,6 @@ ldap_abandon LDAP_P((       /* deprecated */
        int msgid ));
 #endif
 
-
 /*
  * in add.c:
  */
@@ -1931,61 +1848,109 @@ ldap_turn_s LDAP_P(( LDAP *ld,
        LDAPControl **sctrl,
        LDAPControl **cctrl ));
 
+/*
+ * LDAP Paged Results
+ *     in pagectrl.c
+ */
+#define LDAP_API_FEATURE_PAGED_RESULTS 2000
+
+LDAP_F( int )
+ldap_create_page_control_value LDAP_P((
+       LDAP *ld,
+       ber_int_t pagesize,
+       struct berval *cookie,
+       struct berval *value ));
+
+LDAP_F( int )
+ldap_create_page_control LDAP_P((
+       LDAP *ld,
+       ber_int_t pagesize,
+       struct berval *cookie,
+       int iscritical,
+       LDAPControl **ctrlp ));
+
+#if LDAP_DEPRECATED
+LDAP_F( int )
+ldap_parse_page_control LDAP_P((
+       LDAP *ld,
+       LDAPControl **ctrls,
+       ber_int_t *count,
+       struct berval **cookie ));
+#endif
+
+LDAP_F( int )
+ldap_parse_pageresponse_control LDAP_P((
+       LDAP *ld,
+       LDAPControl *ctrl,
+       ber_int_t *count,
+       struct berval *cookie ));
+
 /*
  * LDAP Server Side Sort
  *     in sortctrl.c
  */
-#define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
+#define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
 
 /* structure for a sort-key */
 typedef struct ldapsortkey {
-       char *  attributeType;
-       char *  orderingRule;
-       int     reverseOrder;
+       char *attributeType;
+       char *orderingRule;
+       int reverseOrder;
 } LDAPSortKey;
 
 LDAP_F( int )
 ldap_create_sort_keylist LDAP_P((
        LDAPSortKey ***sortKeyList,
-       char        *keyString ));
+       char *keyString ));
 
 LDAP_F( void )
 ldap_free_sort_keylist LDAP_P((
        LDAPSortKey **sortkeylist ));
 
+LDAP_F( int )
+ldap_create_sort_control_value LDAP_P((
+       LDAP *ld,
+       LDAPSortKey **keyList,
+       struct berval *value ));
+
 LDAP_F( int )
 ldap_create_sort_control LDAP_P((
        LDAP *ld,
        LDAPSortKey **keyList,
-       int ctl_iscritical,
+       int iscritical,
        LDAPControl **ctrlp ));
 
 LDAP_F( int )
-ldap_parse_sort_control LDAP_P((
-       LDAP           *ld,
-       LDAPControl    **ctrlp,
-       unsigned long  *result,
-       char           **attribute ));
-
+ldap_parse_sortresponse_control LDAP_P((
+       LDAP *ld,
+       LDAPControl *ctrl,
+       ber_int_t *result,
+       char **attribute ));
 
 /*
  * LDAP Virtual List View
  *     in vlvctrl.c
  */
-#define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
+#define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
 
 /* structure for virtual list */
 typedef struct ldapvlvinfo {
-       int             ldvlv_version;
-    unsigned long   ldvlv_before_count;
-    unsigned long   ldvlv_after_count;
-    unsigned long   ldvlv_offset;
-    unsigned long   ldvlv_count;
+       ber_int_t ldvlv_version;
+    ber_int_t ldvlv_before_count;
+    ber_int_t ldvlv_after_count;
+    ber_int_t ldvlv_offset;
+    ber_int_t ldvlv_count;
     struct berval *    ldvlv_attrvalue;
     struct berval *    ldvlv_context;
     void *                     ldvlv_extradata;
 } LDAPVLVInfo;
 
+LDAP_F( int )
+ldap_create_vlv_control_value LDAP_P((
+       LDAP *ld,
+       LDAPVLVInfo *ldvlistp,
+       struct berval *value));
+
 LDAP_F( int )
 ldap_create_vlv_control LDAP_P((
        LDAP *ld,
@@ -1993,57 +1958,14 @@ ldap_create_vlv_control LDAP_P((
        LDAPControl **ctrlp ));
 
 LDAP_F( int )
-ldap_parse_vlv_control LDAP_P((
+ldap_parse_vlvresponse_control LDAP_P((
        LDAP          *ld,
-       LDAPControl   **ctrls,
-       unsigned long *target_posp,
-       unsigned long *list_countp,
+       LDAPControl   *ctrls,
+       ber_int_t *target_posp,
+       ber_int_t *list_countp,
        struct berval **contextp,
        int           *errcodep ));
 
-/*
- * LDAP Transactions
- *     in txn.c
- */
-#ifdef LDAP_GROUP_TRANSACTION
-LDAP_F( int )
-ldap_parse_txn_create LDAP_P((
-       LDAP *ld,
-       LDAPMessage *res,
-       struct berval **cookie ));
-
-LDAP_F( int )
-ldap_txn_create LDAP_P((
-       LDAP *ld,
-       LDAPControl             **sctrls,
-       LDAPControl             **cctrls,
-       int                             *msgidp ));
-
-LDAP_F( int )
-ldap_txn_create_s LDAP_P((
-       LDAP *ld,
-       struct berval **cookie,
-       LDAPControl **sctrls,
-       LDAPControl **cctrls ));
-
-LDAP_F( int )
-ldap_txn_end LDAP_P((
-       LDAP *ld,
-       struct berval *cookie,
-       int commit,
-       LDAPControl             **sctrls,
-       LDAPControl             **cctrls,
-       int                             *msgidp ));
-
-LDAP_F( int )
-ldap_txn_end_s LDAP_P((
-       LDAP *ld,
-       struct berval *cookie,
-       int commit,
-       LDAPControl **sctrls,
-       LDAPControl **cctrls ));
-#endif
-
 /*
  * LDAP Who Am I?
  *     in whoami.c
@@ -2129,13 +2051,75 @@ LDAP_F( int )
 ldap_parse_passwordpolicy_control LDAP_P((
         LDAP *ld,
         LDAPControl *ctrl,
-        int *expirep,
-        int *gracep,
+        ber_int_t *expirep,
+        ber_int_t *gracep,
         LDAPPasswordPolicyError *errorp ));
 
 LDAP_F( const char * )
 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
 
+/*
+ * LDAP Dynamic Directory Services Refresh RFC2589
+ *     in dds.c
+ */
+#define LDAP_API_FEATURE_REFRESH 1000
+
+LDAP_F( int )
+ldap_parse_refresh LDAP_P((
+       LDAP *ld,
+       LDAPMessage *res,
+       ber_int_t *newttl ));
+
+LDAP_F( int )
+ldap_refresh LDAP_P(( LDAP *ld,
+       struct berval   *dn,
+       ber_int_t ttl,
+       LDAPControl             **sctrls,
+       LDAPControl             **cctrls,
+       int                             *msgidp ));
+
+LDAP_F( int )
+ldap_refresh_s LDAP_P((
+       LDAP *ld,
+       struct berval   *dn,
+       ber_int_t ttl,
+       ber_int_t *newttl,
+       LDAPControl **sctrls,
+       LDAPControl **cctrls ));
+
+/*
+ * LDAP Transactions
+ */
+#ifdef LDAP_X_TXN
+LDAP_F( int )
+ldap_txn_start LDAP_P(( LDAP *ld,
+       LDAPControl             **sctrls,
+       LDAPControl             **cctrls,
+       int                             *msgidp ));
+
+LDAP_F( int )
+ldap_txn_start_s LDAP_P(( LDAP *ld,
+       LDAPControl **sctrl,
+       LDAPControl **cctrl,
+       struct berval **rettxnid ));
+
+LDAP_F( int )
+ldap_txn_end LDAP_P(( LDAP *ld,
+       int     commit,
+       struct berval   *txnid,
+       LDAPControl             **sctrls,
+       LDAPControl             **cctrls,
+       int                             *msgidp ));
+
+LDAP_F( int )
+ldap_txn_end_s LDAP_P(( LDAP *ld,
+       int     commit,
+       struct berval *txnid,
+       LDAPControl **sctrl,
+       LDAPControl **cctrl,
+       int *retidp ));
+#endif
+
 LDAP_END_DECL
 #endif /* _LDAP_H */