]> git.sur5r.net Git - openldap/blobdiff - include/ldap.h
Added dnPretty2/dnNormalize2 using preallocated destination berval
[openldap] / include / ldap.h
index 72fca310ae08f011fdc53bfca68beb0dca98300e..1a801a3a32390be344ed94bae26b079445f46be4 100644 (file)
@@ -42,12 +42,11 @@ LDAP_BEGIN_DECL
 
 /*
  * We'll use 2000+draft revision for our API version number
- * As such, the number will be above the old RFC but below 
+ * As such, the number will be above the old RFC but below
  * whatever number does finally get assigned
  */
 #define LDAP_API_VERSION       2004
 #define LDAP_VENDOR_NAME       "OpenLDAP"
-/* We'll eventually release as 20000 */
 
 /* OpenLDAP API Features */
 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
@@ -215,7 +214,7 @@ typedef struct ldapcontrol {
 #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
  */
 
@@ -262,8 +261,8 @@ typedef struct ldapcontrol {
 #define LDAP_REQ_ADD                   ((ber_tag_t) 0x68U)     /* application + constructed */
 #define LDAP_REQ_DELETE                        ((ber_tag_t) 0x4aU)     /* application + primitive   */
 #define LDAP_REQ_MODDN                 ((ber_tag_t) 0x6cU)     /* application + constructed */
-#define LDAP_REQ_MODRDN                        LDAP_REQ_MODDN  
-#define LDAP_REQ_RENAME                        LDAP_REQ_MODDN  
+#define LDAP_REQ_MODRDN                        LDAP_REQ_MODDN
+#define LDAP_REQ_RENAME                        LDAP_REQ_MODDN
 #define LDAP_REQ_COMPARE               ((ber_tag_t) 0x6eU)     /* application + constructed */
 #define LDAP_REQ_ABANDON               ((ber_tag_t) 0x50U)     /* application + primitive   */
 #define LDAP_REQ_EXTENDED              ((ber_tag_t) 0x77U)     /* application + constructed */
@@ -335,7 +334,7 @@ typedef struct ldapcontrol {
 #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
  */
 
@@ -357,7 +356,7 @@ typedef struct ldapcontrol {
 #define LDAP_ADMINLIMIT_EXCEEDED       0x0b /* LDAPv3 */
 #define        LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
 #define LDAP_CONFIDENTIALITY_REQUIRED  0x0d /* LDAPv3 */
-#define        LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */       
+#define        LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 
 #define LDAP_ATTR_ERROR(n)     LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 
@@ -512,15 +511,6 @@ typedef struct ldap LDAP;
 #define LDAP_MSG_ALL           0x01
 #define LDAP_MSG_RECEIVED      0x02
 
-/*
- * structure for ldap friendly mapping routines
- */
-
-typedef struct ldap_friendly {
-       char    *lf_unfriendly;
-       char    *lf_friendly;
-} LDAPFriendlyMap;
-
 /*
  * types for ldap URL handling
  */
@@ -586,10 +576,10 @@ ldap_set_rebind_proc LDAP_P((
 /*
  * in controls.c:
  */
-LDAP_F( int ) 
-ldap_create_control LDAP_P(( 
-       const char *requestOID, 
-       BerElement *ber, 
+LDAP_F( int )
+ldap_create_control LDAP_P((
+       const char *requestOID,
+       BerElement *ber,
        int iscritical,
        LDAPControl **ctrlp ));
 
@@ -1066,7 +1056,7 @@ ldap_open LDAP_P((        /* deprecated */
        int port ));
 
 LDAP_F( int )
-ldap_create LDAP_P(( 
+ldap_create LDAP_P((
        LDAP **ldp ));
 
 LDAP_F( int )
@@ -1174,25 +1164,41 @@ ldap_get_dn LDAP_P((
        LDAPMessage *entry ));
 
 typedef struct ldap_ava {
-       char *la_attr;
+       struct berval *la_attr;
        struct berval *la_value;
        unsigned la_flags;
-#define LDAP_AVA_STRING 0x0000U
-#define LDAP_AVA_BINARY 0x0001U
+#define LDAP_AVA_STRING                0x0000U
+#define LDAP_AVA_BINARY                0x0001U
+#define LDAP_AVA_NONPRINTABLE  0x0002U
+
+       void *la_private;
 } LDAPAVA;
 
 typedef LDAPAVA** LDAPRDN;
 typedef LDAPRDN** LDAPDN;
 
 /* DN formats */
-#define LDAP_DN_FORMAT_LDAPV3  0x0000U
-#define LDAP_DN_FORMAT_LDAPV2  0x0001U
-#define LDAP_DN_FORMAT_DCE             0x0002U
-#define LDAP_DN_FORMAT_UFN             0x0003U /* dn2str only */
-#define LDAP_DN_FORMAT_MASK            0x000FU
+#define LDAP_DN_FORMAT_LDAP            0x0000U
+#define LDAP_DN_FORMAT_LDAPV3          0x0010U
+#define LDAP_DN_FORMAT_LDAPV2          0x0020U
+#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_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
 
-/* str2dn flags */ 
-#define LDAP_DN_PEDANTIC               0x1000U
+LDAP_F( void )
+ldap_avafree LDAP_P(( LDAPAVA *ava ));
+LDAP_F( void )
+ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
+LDAP_F( void )
+ldap_dnfree LDAP_P(( LDAPDN *dn ));
 
 LDAP_F( int )
 ldap_str2dn LDAP_P((
@@ -1200,12 +1206,42 @@ ldap_str2dn LDAP_P((
        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_str2rdn LDAP_P((
+       const char *str,
+       LDAPRDN **rdn,
+       const char **next,
+       unsigned flags ));
+
+LDAP_F( int )
+ldap_rdn2bv LDAP_P((
+       LDAPRDN *rdn,
+       struct berval *bv,
+       unsigned flags ));
+
+LDAP_F( int )
+ldap_rdn2str LDAP_P((
+       LDAPRDN *rdn,
+       char **str,
+       unsigned flags ));
+
+LDAP_F( int )
+ldap_dn_normalize LDAP_P((
+       LDAP_CONST char *in, unsigned iflags,
+       char **out, unsigned oflags ));
+
 LDAP_F( char * )
 ldap_dn2ufn LDAP_P(( /* deprecated */
        LDAP_CONST char *dn ));
@@ -1226,11 +1262,14 @@ ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
 LDAP_F( char * )
 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce ));        /* deprecated */
 
+LDAP_F( char * )
+ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
+
 /*
  * in getattr.c
  */
 LDAP_F( char * )
-ldap_first_attribute LDAP_P((                                                                   
+ldap_first_attribute LDAP_P((
        LDAP *ld,
        LDAPMessage *entry,
        BerElement **ber ));
@@ -1245,33 +1284,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:
@@ -1394,11 +1433,6 @@ LDAP_F( LDAPFiltDesc * )
 ldap_init_getfilter LDAP_P(( /* deprecated */
        LDAP_CONST char *fname ));
 
-LDAP_F( LDAPFiltDesc * )
-ldap_init_getfilter_buf LDAP_P(( /* deprecated */
-       /* LDAP_CONST */ char *buf,
-       ber_len_t buflen ));
-
 LDAP_F( LDAPFiltInfo * )
 ldap_getfirstfilter LDAP_P(( /* deprecated */
        LDAPFiltDesc *lfdp,
@@ -1409,23 +1443,6 @@ LDAP_F( LDAPFiltInfo * )
 ldap_getnextfilter LDAP_P(( /* deprecated */
        LDAPFiltDesc *lfdp ));
 
-LDAP_F( void )
-ldap_setfilteraffixes LDAP_P(( /* deprecated */
-       LDAPFiltDesc *lfdp,
-       LDAP_CONST char *prefix,
-       LDAP_CONST char *suffix ));
-
-LDAP_F( void )
-ldap_build_filter LDAP_P(( /* deprecated */
-       char *buf,
-       ber_len_t buflen,
-       LDAP_CONST char *pattern,
-       LDAP_CONST char *prefix,
-       LDAP_CONST char *suffix,
-       LDAP_CONST char *attr,
-       LDAP_CONST char *value,
-       char **valwords ));
-
 
 /*
  * in free.c
@@ -1467,33 +1484,19 @@ ldap_mods_free LDAP_P((
        int freemods ));
 
 
-/*
- * in friendly.c
- *     (deprecated)
- */
-LDAP_F( char * )
-ldap_friendly_name LDAP_P(( /* deprecated */
-       LDAP_CONST char *filename,
-       LDAP_CONST char *uname,
-       LDAPFriendlyMap **map ));
-
-LDAP_F( void )
-ldap_free_friendlymap LDAP_P(( /* deprecated */
-       LDAPFriendlyMap **map ));
-
-
 /*
  * 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,
@@ -1539,32 +1542,11 @@ 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  
+/*
+ * in sortctrl.c
  */
 /*
- * structure for a sort-key 
+ * structure for a sort-key
  */
 typedef struct ldapsortkey {
        char *  attributeType;
@@ -1582,22 +1564,22 @@ ldap_free_sort_keylist LDAP_P((
        LDAPSortKey **sortkeylist ));
 
 LDAP_F( int )
-ldap_create_sort_control LDAP_P((      
-       LDAP *ld, 
+ldap_create_sort_control LDAP_P((
+       LDAP *ld,
        LDAPSortKey **keyList,
        int ctl_iscritical,
        LDAPControl **ctrlp ));
 
 LDAP_F( int )
 ldap_parse_sort_control LDAP_P((
-       LDAP           *ld, 
-       LDAPControl    **ctrlp,  
+       LDAP           *ld,
+       LDAPControl    **ctrlp,
        unsigned long  *result,
        char           **attribute ));
 
 
-/* 
- * in vlvctrl.c  
+/*
+ * in vlvctrl.c
  */
 
 /*
@@ -1605,27 +1587,27 @@ ldap_parse_sort_control LDAP_P((
  */
 typedef struct ldapvlvinfo {
        int             ldvlv_version;
-    unsigned long   ldvlv_before_count;      
-    unsigned long   ldvlv_after_count;                     
-    unsigned long   ldvlv_offset;              
+    unsigned long   ldvlv_before_count;
+    unsigned long   ldvlv_after_count;
+    unsigned long   ldvlv_offset;
     unsigned long   ldvlv_count;
     struct berval  *ldvlv_attrvalue;
     struct berval  *ldvlv_context;
     void           *ldvlv_extradata;
 } LDAPVLVInfo;
 
-LDAP_F( int ) 
+LDAP_F( int )
 ldap_create_vlv_control LDAP_P((
-       LDAP *ld, 
+       LDAP *ld,
        LDAPVLVInfo *ldvlistp,
        LDAPControl **ctrlp ));
 
 LDAP_F( int )
-ldap_parse_vlv_control LDAP_P(( 
-       LDAP          *ld, 
+ldap_parse_vlv_control LDAP_P((
+       LDAP          *ld,
        LDAPControl   **ctrls,
-       unsigned long *target_posp, 
-       unsigned long *list_countp, 
+       unsigned long *target_posp,
+       unsigned long *list_countp,
        struct berval **contextp,
        int           *errcodep ));