]> git.sur5r.net Git - openldap/blobdiff - include/ldap.h
add feature macros
[openldap] / include / ldap.h
index a1034a14c618bdb4d4a5edd1b1035977ac457c83..556ad2615a991af02f2caa94bebc37b1d48e849b 100644 (file)
@@ -1,6 +1,6 @@
 /* $OpenLDAP$ */
 /*
- * Copyright 1998-2001 The OpenLDAP Foundation, Redwood City, California, USA
+ * Copyright 1998-2002 The OpenLDAP Foundation, Redwood City, California, USA
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -122,6 +122,7 @@ LDAP_BEGIN_DECL
 /* #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_SSL_CTX         0x600a
 
 #define LDAP_OPT_X_TLS_NEVER           0
 #define LDAP_OPT_X_TLS_HARD            1
@@ -180,39 +181,55 @@ typedef struct ldapcontrol {
 
 /* LDAP Controls */
 
-#ifdef undef
+#if 0
        /* 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_MANAGEDSAIT       "2.16.840.1.113730.3.4.2"
+#define LDAP_CONTROL_SUBENTRIES                "1.3.6.1.4.1.4203.1.10.1"
+#define LDAP_CONTROL_NOOP                      "1.3.6.1.4.1.4203.666.5.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"
+#define LDAP_CONTROL_DUPENT    LDAP_CONTROL_DUPENT_REQUEST
 
-/* Experimental Controls */
+#if 0
+#define LDAP_CONTROL_PAGEDRESULTS_REQUEST      "1.2.840.113556.1.4.319"
+#define LDAP_CONTROL_PAGEDRESULTS_RESPONSE     "1.2.840.113556.1.4.320"
+#endif
 
 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473"
 #define LDAP_CONTROL_SORTRESPONSE      "1.2.840.113556.1.4.474"
 #define LDAP_CONTROL_VLVREQUEST        "2.16.840.1.113730.3.4.9"
 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 
+#define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
+
 /* 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_START_TLS "1.3.6.1.4.1.1466.20037"
+#define LDAP_EXOP_START_TLS    "1.3.6.1.4.1.1466.20037"
+
+#define LDAP_EXOP_MODIFY_PASSWD        "1.3.6.1.4.1.4203.1.11.1"
+#define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
+#define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD        ((ber_tag_t) 0x81U)
+#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_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.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)
+#define LDAP_EXOP_X_WHO_AM_I   "1.3.6.1.4.1.4203.1.11.3"
+
+/* LDAP Features */
+#define LDAP_FEATURE_ALL_OPERATIONAL_ATTRS "1.3.6.1.4.1.4203.1.5.1"  /* + */
+#define LDAP_FEATURE_OBJECTCLASS_ATTRS "1.3.6.1.4.1.4203.1.5.2"
+#define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
+#define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
+#define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
 
 /*
  * specific LDAP instantiations of BER types we know about
@@ -578,7 +595,7 @@ ldap_set_rebind_proc LDAP_P((
  */
 LDAP_F( int )
 ldap_create_control LDAP_P((
-       const char *requestOID,
+       LDAP_CONST char *requestOID,
        BerElement *ber,
        int iscritical,
        LDAPControl **ctrlp ));
@@ -1164,8 +1181,8 @@ ldap_get_dn LDAP_P((
        LDAPMessage *entry ));
 
 typedef struct ldap_ava {
-       struct berval *la_attr;
-       struct berval *la_value;
+       struct berval la_attr;
+       struct berval la_value;
        unsigned la_flags;
 #define LDAP_AVA_STRING                0x0000U
 #define LDAP_AVA_BINARY                0x0001U
@@ -1184,10 +1201,12 @@ typedef LDAPRDN** LDAPDN;
 #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_LBER            0x00F0U /* for testing 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
@@ -1199,23 +1218,48 @@ ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
 LDAP_F( void )
 ldap_dnfree LDAP_P(( LDAPDN *dn ));
 
+LDAP_F( int )
+ldap_bv2dn LDAP_P(( 
+       struct berval *bv, 
+       LDAPDN **dn, 
+       unsigned flags ));
+
 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_bv2rdn LDAP_P((
+       struct berval *bv,
+       LDAPRDN **rdn,
+       char **next,
+       unsigned flags ));
+
 LDAP_F( int )
 ldap_str2rdn LDAP_P((
-       const char *str,
+       LDAP_CONST char *str,
        LDAPRDN **rdn,
-       const char **next,
+       char **next,
+       unsigned flags ));
+
+LDAP_F( int )
+ldap_rdn2bv LDAP_P((
+       LDAPRDN *rdn,
+       struct berval *bv,
        unsigned flags ));
 
 LDAP_F( int )
@@ -1243,6 +1287,12 @@ ldap_explode_rdn LDAP_P(( /* deprecated */
        LDAP_CONST char *rdn,
        int notypes ));
 
+typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN *dn, unsigned flags ));
+
+LDAP_F( int )
+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 */
 
@@ -1271,33 +1321,33 @@ ldap_next_attribute LDAP_P((
 /*
  * in getvalues.c
  */
-LDAP_F( char ** )
-ldap_get_values LDAP_P((
-       LDAP *ld,
-       LDAPMessage *entry,
-       LDAP_CONST char *target ));
-
 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:
@@ -1430,6 +1480,10 @@ LDAP_F( LDAPFiltInfo * )
 ldap_getnextfilter LDAP_P(( /* deprecated */
        LDAPFiltDesc *lfdp ));
 
+LDAP_F( int )
+ldap_put_vrFilter LDAP_P((
+       BerElement *ber,
+       const char *vrf ));
 
 /*
  * in free.c
@@ -1473,16 +1527,17 @@ ldap_mods_free LDAP_P((
 
 /*
  * 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,
@@ -1528,27 +1583,6 @@ 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
  */
@@ -1590,7 +1624,7 @@ ldap_parse_sort_control LDAP_P((
  */
 
 /*
- * structure for virtul list.
+ * structure for virtual list.
  */
 typedef struct ldapvlvinfo {
        int             ldvlv_version;