]> git.sur5r.net Git - openldap/blobdiff - include/ldap.h
Update copyright (including with or without modification clarification)
[openldap] / include / ldap.h
index ccb0f4aa285d27e13181b9c1f51ecb9502b55a0a..2d72a1e19243330f0d8e77f516ec9bf542962c79 100644 (file)
@@ -1,12 +1,13 @@
 /* $OpenLDAP$ */
 /*
- * Copyright 1998-2000 The OpenLDAP Foundation, Redwood City, California, USA
+ * Copyright 1998-2001 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.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, 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.
@@ -26,6 +27,9 @@
 /* pull in lber */
 #include <lber.h>
 
+/* include version and API feature defines */
+#include <ldap_features.h>
+
 LDAP_BEGIN_DECL
 
 #define LDAP_VERSION1  1
@@ -43,15 +47,11 @@ LDAP_BEGIN_DECL
  */
 #define LDAP_API_VERSION       2004
 #define LDAP_VENDOR_NAME       "OpenLDAP"
-/* We'll eventually release as 200 */
-#define LDAP_VENDOR_VERSION    19905
+/* We'll eventually release as 20000 */
 
 /* OpenLDAP API Features */
 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
 
-/* include LDAP_API_FEATURE defines */
-#include <ldap_features.h>
-
 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
        ( defined( LDAP_THREAD_SAFE ) && \
                defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
@@ -122,6 +122,7 @@ LDAP_BEGIN_DECL
 #define LDAP_OPT_X_TLS                 0x6007
 #define LDAP_OPT_X_TLS_PROTOCOL                0x6008
 #define LDAP_OPT_X_TLS_CIPHER_SUITE    0x6009
+#define LDAP_OPT_X_TLS_RANDOM_FILE     0x600a
 
 #define LDAP_OPT_X_TLS_NEVER           0
 #define LDAP_OPT_X_TLS_HARD            1
@@ -130,9 +131,17 @@ LDAP_BEGIN_DECL
 #define LDAP_OPT_X_TLS_TRY             4
 
 /* OpenLDAP SASL options */
-#define LDAP_OPT_X_SASL_MINSSF         0x6100
-#define LDAP_OPT_X_SASL_MAXSSF         0x6101
-#define LDAP_OPT_X_SASL_ACTSSF         0x6102
+#define LDAP_OPT_X_SASL_MECH                   0x6100
+#define LDAP_OPT_X_SASL_REALM                  0x6101
+#define LDAP_OPT_X_SASL_AUTHCID                        0x6102
+#define LDAP_OPT_X_SASL_AUTHZID                        0x6103
+#define LDAP_OPT_X_SASL_SSF                            0x6104 /* read-only */
+#define LDAP_OPT_X_SASL_SSF_EXTERNAL   0x6105 /* write-only */
+#define LDAP_OPT_X_SASL_SECPROPS               0x6106 /* write-only */
+#define LDAP_OPT_X_SASL_SSF_MIN                        0x6107
+#define LDAP_OPT_X_SASL_SSF_MAX                        0x6108
+#define        LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
+
 
 /* on/off values */
 #define LDAP_OPT_ON            ((void *) 1)
@@ -178,6 +187,11 @@ typedef struct ldapcontrol {
 
 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.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"
+
 /* Experimental Controls */
 
 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473"
@@ -192,7 +206,7 @@ typedef struct ldapcontrol {
 /* LDAP Extended Operations */
 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
 
-#define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.6.1"
+#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)
@@ -222,8 +236,8 @@ typedef struct ldapcontrol {
 /* general stuff */
 #define LDAP_TAG_MESSAGE       ((ber_tag_t) 0x30U)     /* constructed + 16 */
 #define LDAP_TAG_MSGID         ((ber_tag_t) 0x02U)     /* integer */
-#define LDAP_TAG_LDAPDN                ((ber_tag_t) 0x04U)     /* octect string */
-#define LDAP_TAG_LDAPCRED      ((ber_tag_t) 0x04U)     /* octect string */
+#define LDAP_TAG_LDAPDN                ((ber_tag_t) 0x04U)     /* octet string */
+#define LDAP_TAG_LDAPCRED      ((ber_tag_t) 0x04U)     /* octet string */
 #define LDAP_TAG_CONTROLS      ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
 #define LDAP_TAG_REFERRAL      ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
 
@@ -244,9 +258,9 @@ typedef struct ldapcontrol {
 #define LDAP_REQ_MODIFY                        ((ber_tag_t) 0x66U)     /* application + constructed */
 #define LDAP_REQ_ADD                   ((ber_tag_t) 0x68U)     /* application + constructed */
 #define LDAP_REQ_DELETE                        ((ber_tag_t) 0x4aU)     /* application + primitive   */
-#define LDAP_REQ_MODRDN                        ((ber_tag_t) 0x6cU)     /* application + constructed */
-#define LDAP_REQ_MODDN                 LDAP_REQ_MODRDN 
-#define LDAP_REQ_RENAME                        LDAP_REQ_MODRDN 
+#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_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 */
@@ -259,19 +273,21 @@ typedef struct ldapcontrol {
 #define LDAP_RES_MODIFY                        ((ber_tag_t) 0x67U)     /* application + constructed */
 #define LDAP_RES_ADD                   ((ber_tag_t) 0x69U)     /* application + constructed */
 #define LDAP_RES_DELETE                        ((ber_tag_t) 0x6bU)     /* application + constructed */
-#define LDAP_RES_MODRDN                        ((ber_tag_t) 0x6dU)     /* application + constructed */
-#define LDAP_RES_MODDN                 LDAP_RES_MODRDN /* application + constructed */
-#define LDAP_RES_RENAME                        LDAP_RES_MODRDN /* application + constructed */
+#define LDAP_RES_MODDN                 ((ber_tag_t) 0x6dU)     /* application + constructed */
+#define LDAP_RES_MODRDN                        LDAP_RES_MODDN  /* application + constructed */
+#define LDAP_RES_RENAME                        LDAP_RES_MODDN  /* application + constructed */
 #define LDAP_RES_COMPARE               ((ber_tag_t) 0x6fU)     /* application + constructed */
 #define LDAP_RES_EXTENDED              ((ber_tag_t) 0x78U)     /* V3: application + constructed */
 #define LDAP_RES_EXTENDED_PARTIAL      ((ber_tag_t) 0x79U)     /* V3+: application + constructed */
 
-#define LDAP_RES_ANY                   ((ber_tag_t)(-1))
-#define LDAP_RES_UNSOLICITED   ((ber_tag_t)(0))
+#define LDAP_RES_ANY                   (-1)
+#define LDAP_RES_UNSOLICITED   (0)
 
 
 /* sasl methods */
-#define LDAP_SASL_SIMPLE                       NULL
+#define LDAP_SASL_SIMPLE               ((char*)0)
+#define LDAP_SASL_NULL                 ("")
+
 
 /* authentication methods available */
 #define LDAP_AUTH_NONE         ((ber_tag_t) 0x00U)     /* no authentication              */
@@ -306,6 +322,7 @@ typedef struct ldapcontrol {
 #define LDAP_SUBSTRING_FINAL   ((ber_tag_t) 0x82U)     /* context specific */
 
 /* search scopes */
+#define LDAP_SCOPE_DEFAULT     ((ber_int_t) -1)
 #define LDAP_SCOPE_BASE                ((ber_int_t) 0x0000)
 #define LDAP_SCOPE_ONELEVEL    ((ber_int_t) 0x0001)
 #define LDAP_SCOPE_SUBTREE     ((ber_int_t) 0x0002)
@@ -384,6 +401,7 @@ typedef struct ldapcontrol {
 
 #define LDAP_API_ERROR(n)              LDAP_RANGE((n),0x51,0x61) /* 81-97 */
 
+/* reserved for APIs */
 #define LDAP_SERVER_DOWN               0x51
 #define LDAP_LOCAL_ERROR               0x52
 #define LDAP_ENCODING_ERROR            0x53
@@ -395,7 +413,7 @@ typedef struct ldapcontrol {
 #define LDAP_PARAM_ERROR               0x59
 #define LDAP_NO_MEMORY                 0x5a
 
-/* not technically reserved for APIs */
+/* used but not reserved for APIs */
 #define LDAP_CONNECT_ERROR                             0x5b    /* draft-ietf-ldap-c-api-xx */
 #define LDAP_NOT_SUPPORTED                             0x5c    /* draft-ietf-ldap-c-api-xx */
 #define LDAP_CONTROL_NOT_FOUND                 0x5d    /* draft-ietf-ldap-c-api-xx */
@@ -502,15 +520,16 @@ typedef struct ldap_friendly {
  * types for ldap URL handling
  */
 typedef struct ldap_url_desc {
-    struct ldap_url_desc *lud_next;
-    char       *lud_scheme;
-    char       *lud_host;
-    int                lud_port;
-    char       *lud_dn;
-    char       **lud_attrs;
-    int                lud_scope;
-    char       *lud_filter;
-    char       **lud_exts;
+       struct ldap_url_desc *lud_next;
+       char    *lud_scheme;
+       char    *lud_host;
+       int             lud_port;
+       char    *lud_dn;
+       char    **lud_attrs;
+       int             lud_scope;
+       char    *lud_filter;
+       char    **lud_exts;
+       int             lud_crit_exts;
 } LDAPURLDesc;
 
 #define LDAP_URL_SUCCESS               0x00    /* Success */
@@ -559,6 +578,13 @@ ldap_set_rebind_proc LDAP_P((
 /*
  * in controls.c:
  */
+LDAP_F( int ) 
+ldap_create_control LDAP_P(( 
+       const char *requestOID, 
+       BerElement *ber, 
+       int iscritical,
+       LDAPControl **ctrlp ));
+
 LDAP_F( void )
 ldap_control_free LDAP_P((
        LDAPControl *ctrl ));
@@ -686,16 +712,35 @@ ldap_sasl_bind LDAP_P((
        LDAPControl             **clientctrls,
        int                             *msgidp ));
 
+/* Interaction flags (should be passed about in a control)
+ *  Automatic (default): use defaults, prompt otherwise
+ *  Interactive: prompt always
+ *  Quiet: never prompt
+ */
+#define LDAP_SASL_AUTOMATIC            0U
+#define LDAP_SASL_INTERACTIVE  1U
+#define LDAP_SASL_QUIET                        2U
+
+/*
+ * V3 SASL Interaction Function Callback Prototype
+ *     when using Cyrus SASL, interact is pointer to sasl_interact_t
+ *  should likely passed in a control (and provided controls)
+ */
+typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
+       LDAP *ld, unsigned flags, void* defaults, void *interact ));
+
 LDAP_F( int )
-ldap_negotiated_sasl_bind_s LDAP_P((
+ldap_sasl_interactive_bind_s LDAP_P((
        LDAP *ld,
        LDAP_CONST char *dn, /* usually NULL */
-       LDAP_CONST char *authenticationId, 
-       LDAP_CONST char *authorizationId, /* usually NULL */
        LDAP_CONST char *saslMechanism,
-       struct berval *passPhrase,
        LDAPControl **serverControls,
-       LDAPControl **clientControls ));
+       LDAPControl **clientControls,
+
+       /* should be client controls */
+       unsigned flags,
+       LDAP_SASL_INTERACT_PROC *proc,
+       void *defaults ));
 
 LDAP_F( int )
 ldap_sasl_bind_s LDAP_P((
@@ -1277,7 +1322,7 @@ ldap_search_st LDAP_P((   /* deprecated */
        struct timeval *timeout,
        LDAPMessage **res ));
 
-
+#ifdef LDAP_UFN
 /*
  * in ufn.c                                                    
  *     (deprecated)
@@ -1326,7 +1371,7 @@ ldap_ufn_setprefix LDAP_P(( /* deprecated */
 LDAP_F( int )
 ldap_ufn_timeout LDAP_P(( /* deprecated */
        void *tvparam ));
-
+#endif
 
 /*
  * in unbind.c
@@ -1447,37 +1492,6 @@ ldap_free_friendlymap LDAP_P(( /* deprecated */
        LDAPFriendlyMap **map ));
 
 
-/*
- * in cldap.c
- *     (deprecated)
- */
-LDAP_F( LDAP * )
-cldap_open LDAP_P((    /* deprecated */
-       LDAP_CONST char *host,
-       int port ));
-
-LDAP_F( void )
-cldap_close LDAP_P((   /* deprecated */
-       LDAP *ld ));
-
-LDAP_F( int )
-cldap_search_s LDAP_P(( /* deprecated */
-       LDAP *ld,
-       LDAP_CONST char *base,
-       int scope,
-       LDAP_CONST char *filter,
-       char **attrs,
-       int attrsonly,
-       LDAPMessage **res,
-       char *logdn ));
-
-LDAP_F( void )
-cldap_setretryinfo LDAP_P(( /* deprecated */
-       LDAP *ld,
-       int tries,
-       int timeout ));
-
-
 /*
  * in sort.c
  */