]> git.sur5r.net Git - openldap/blobdiff - include/ldap.h
Extended ber_mem functions, add context argument.
[openldap] / include / ldap.h
index f13a8a0388ef8fd3b8de3133c4140ebe66363602..d06f43e85f79bc89a7b93ac6863ec84779f9a669 100644 (file)
@@ -205,18 +205,18 @@ typedef struct ldapcontrol {
 #ifdef LDAP_CLIENT_UPDATE
 #define LDAP_CONTROL_CLIENT_UPDATE             "1.3.6.1.4.1.4203.666.5.3"
 #define LDAP_CONTROL_ENTRY_UPDATE              "1.3.6.1.4.1.4203.666.5.4"
-#define LDAP_CONTROL_CLIENT_UPDATE_DONE                "1.3.6.1.4.1.4203.666.5.5"
-#define LDAP_LCUP_COOKIE_OID                   "1.3.6.1.4.1.4203.666.10.1"
+#define LDAP_CONTROL_CLIENT_UPDATE_DONE        "1.3.6.1.4.1.4203.666.5.5"
+#define LDAP_CUP_COOKIE_OID                            "1.3.6.1.4.1.4203.666.10.1"
 #endif
 
 #ifdef LDAP_SYNC
-#define LDAP_CONTROL_SYNC                      "1.3.6.1.4.1.4203.666.5.6"
-#define LDAP_CONTROL_SYNC_STATE                        "1.3.6.1.4.1.4203.666.5.7"
-#define LDAP_CONTROL_SYNC_DONE                 "1.3.6.1.4.1.4203.666.5.8"
-#define LDAP_SYNC_INFO                         "1.3.6.1.4.1.4203.666.10.2"
+#define LDAP_CONTROL_SYNC              "1.3.6.1.4.1.4203.666.5.6"
+#define LDAP_CONTROL_SYNC_STATE        "1.3.6.1.4.1.4203.666.5.7"
+#define LDAP_CONTROL_SYNC_DONE "1.3.6.1.4.1.4203.666.5.8"
+#define LDAP_SYNC_INFO                 "1.3.6.1.4.1.4203.666.10.2"
 
-#define LDAP_SYNC_REFRESH_DONE         0
-#define LDAP_SYNC_NEW_COOKIE           1
+#define LDAP_SYNC_REFRESH_DONE 0
+#define LDAP_SYNC_NEW_COOKIE   1
 
 #define LDAP_SYNC_PRESENT              0
 #define LDAP_SYNC_ADD                  1
@@ -248,6 +248,7 @@ typedef struct ldapcontrol {
 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN        ((ber_tag_t) 0x80U)
 
 #define LDAP_EXOP_X_WHO_AM_I   "1.3.6.1.4.1.4203.1.11.3"
+
 #ifdef LDAP_DEVEL
 #define LDAP_EXOP_X_CANCEL             "1.3.6.1.4.1.4203.666.6.3"
 #endif
@@ -300,8 +301,8 @@ typedef struct ldapcontrol {
 #define LDAP_TAG_SASL_RES_CREDS        ((ber_tag_t) 0x87U)     /* context specific + primitive */
 
 #ifdef LDAP_CLIENT_UPDATE
-#define LDAP_TAG_INTERVAL      ((ber_tag_t) 0x02U)     /* integer */
-#define LDAP_LCUP_TAG_COOKIE   ((ber_tag_t) 0x30U)     /* sequence */
+#define LDAP_CUP_TAG_INTERVAL  ((ber_tag_t) 0x02U)     /* integer */
+#define LDAP_CUP_TAG_COOKIE            ((ber_tag_t) 0x30U)     /* sequence */
 #endif
 
 #ifdef LDAP_SYNC
@@ -310,32 +311,32 @@ typedef struct ldapcontrol {
 
 
 /* possible operations a client can invoke */
-#define LDAP_REQ_BIND                  ((ber_tag_t) 0x60U)     /* application + constructed */
-#define LDAP_REQ_UNBIND                        ((ber_tag_t) 0x42U)     /* application + primitive   */
-#define LDAP_REQ_SEARCH                        ((ber_tag_t) 0x63U)     /* application + constructed */
-#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_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 */
+#define LDAP_REQ_BIND          ((ber_tag_t) 0x60U)     /* application + constructed */
+#define LDAP_REQ_UNBIND                ((ber_tag_t) 0x42U)     /* application + primitive   */
+#define LDAP_REQ_SEARCH                ((ber_tag_t) 0x63U)     /* application + constructed */
+#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_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 */
 
 /* possible result types a server can return */
-#define LDAP_RES_BIND                  ((ber_tag_t) 0x61U)     /* application + constructed */
-#define LDAP_RES_SEARCH_ENTRY          ((ber_tag_t) 0x64U)     /* application + constructed */
+#define LDAP_RES_BIND          ((ber_tag_t) 0x61U)     /* application + constructed */
+#define LDAP_RES_SEARCH_ENTRY  ((ber_tag_t) 0x64U)     /* application + constructed */
 #define LDAP_RES_SEARCH_REFERENCE      ((ber_tag_t) 0x73U)     /* V3: application + constructed */
-#define LDAP_RES_SEARCH_RESULT         ((ber_tag_t) 0x65U)     /* application + constructed */
-#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_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_SEARCH_RESULT ((ber_tag_t) 0x65U)     /* application + constructed */
+#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_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 */
 #ifdef LDAP_DEVEL
 #define LDAP_RES_INTERMEDIATE_RESP     ((ber_tag_t) 0x7aU)
@@ -346,40 +347,40 @@ typedef struct ldapcontrol {
 
 
 /* sasl methods */
-#define LDAP_SASL_SIMPLE               ((char*)0)
-#define LDAP_SASL_NULL                 ("")
+#define LDAP_SASL_SIMPLE       ((char*)0)
+#define LDAP_SASL_NULL         ("")
 
 
 /* authentication methods available */
-#define LDAP_AUTH_NONE         ((ber_tag_t) 0x00U)     /* no authentication              */
-#define LDAP_AUTH_SIMPLE       ((ber_tag_t) 0x80U)     /* context specific + primitive   */
-#define LDAP_AUTH_SASL         ((ber_tag_t) 0xa3U)     /* context specific + constructed */
-#define LDAP_AUTH_KRBV4                ((ber_tag_t) 0xffU)     /* means do both of the following */
-#define LDAP_AUTH_KRBV41       ((ber_tag_t) 0x81U)     /* context specific + primitive   */
-#define LDAP_AUTH_KRBV42       ((ber_tag_t) 0x82U)     /* context specific + primitive   */
+#define LDAP_AUTH_NONE ((ber_tag_t) 0x00U)     /* no authentication              */
+#define LDAP_AUTH_SIMPLE       ((ber_tag_t) 0x80U)     /* context specific + primitive */
+#define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U)     /* context specific + constructed */
+#define LDAP_AUTH_KRBV4        ((ber_tag_t) 0xffU)     /* means do both of the following */
+#define LDAP_AUTH_KRBV41       ((ber_tag_t) 0x81U)     /* context specific + primitive */
+#define LDAP_AUTH_KRBV42       ((ber_tag_t) 0x82U)     /* context specific + primitive */
 
 
 /* filter types */
-#define LDAP_FILTER_AND                ((ber_tag_t) 0xa0U)     /* context specific + constructed */
-#define LDAP_FILTER_OR         ((ber_tag_t) 0xa1U)     /* context specific + constructed */
-#define LDAP_FILTER_NOT                ((ber_tag_t) 0xa2U)     /* context specific + constructed */
+#define LDAP_FILTER_AND        ((ber_tag_t) 0xa0U)     /* context specific + constructed */
+#define LDAP_FILTER_OR ((ber_tag_t) 0xa1U)     /* context specific + constructed */
+#define LDAP_FILTER_NOT        ((ber_tag_t) 0xa2U)     /* context specific + constructed */
 #define LDAP_FILTER_EQUALITY   ((ber_tag_t) 0xa3U)     /* context specific + constructed */
 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U)     /* context specific + constructed */
-#define LDAP_FILTER_GE         ((ber_tag_t) 0xa5U)     /* context specific + constructed */
-#define LDAP_FILTER_LE         ((ber_tag_t) 0xa6U)     /* context specific + constructed */
+#define LDAP_FILTER_GE ((ber_tag_t) 0xa5U)     /* context specific + constructed */
+#define LDAP_FILTER_LE ((ber_tag_t) 0xa6U)     /* context specific + constructed */
 #define LDAP_FILTER_PRESENT    ((ber_tag_t) 0x87U)     /* context specific + primitive   */
 #define LDAP_FILTER_APPROX     ((ber_tag_t) 0xa8U)     /* context specific + constructed */
-#define LDAP_FILTER_EXT                ((ber_tag_t) 0xa9U)     /* context specific + constructed */
+#define LDAP_FILTER_EXT        ((ber_tag_t) 0xa9U)     /* context specific + constructed */
 
 /* extended filter component types */
-#define LDAP_FILTER_EXT_OID    ((ber_tag_t) 0x81U)     /* context specific */
+#define LDAP_FILTER_EXT_OID            ((ber_tag_t) 0x81U)     /* context specific */
 #define LDAP_FILTER_EXT_TYPE   ((ber_tag_t) 0x82U)     /* context specific */
 #define LDAP_FILTER_EXT_VALUE  ((ber_tag_t) 0x83U)     /* context specific */
 #define LDAP_FILTER_EXT_DNATTRS        ((ber_tag_t) 0x84U)     /* context specific */
 
 /* substring filter component types */
 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U)     /* context specific */
-#define LDAP_SUBSTRING_ANY     ((ber_tag_t) 0x81U)     /* context specific */
+#define LDAP_SUBSTRING_ANY             ((ber_tag_t) 0x81U)     /* context specific */
 #define LDAP_SUBSTRING_FINAL   ((ber_tag_t) 0x82U)     /* context specific */
 
 /* search scopes */
@@ -390,7 +391,7 @@ typedef struct ldapcontrol {
 
 /* substring filter component types */
 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U)     /* context specific */
-#define LDAP_SUBSTRING_ANY     ((ber_tag_t) 0x81U)     /* context specific */
+#define LDAP_SUBSTRING_ANY             ((ber_tag_t) 0x81U)     /* context specific */
 #define LDAP_SUBSTRING_FINAL   ((ber_tag_t) 0x82U)     /* context specific */
 
 /*
@@ -399,13 +400,13 @@ typedef struct ldapcontrol {
 
 #define LDAP_RANGE(n,x,y)      (((x) <= (n)) && ((n) <= (y)))
 
-#define LDAP_SUCCESS                   0x00
+#define LDAP_SUCCESS                           0x00
 #define LDAP_OPERATIONS_ERROR          0x01
-#define LDAP_PROTOCOL_ERROR            0x02
+#define LDAP_PROTOCOL_ERROR                    0x02
 #define LDAP_TIMELIMIT_EXCEEDED                0x03
 #define LDAP_SIZELIMIT_EXCEEDED                0x04
-#define LDAP_COMPARE_FALSE             0x05
-#define LDAP_COMPARE_TRUE              0x06
+#define LDAP_COMPARE_FALSE                     0x05
+#define LDAP_COMPARE_TRUE                      0x06
 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
 #define LDAP_STRONG_AUTH_REQUIRED      0x08
@@ -420,18 +421,18 @@ typedef struct ldapcontrol {
 #define LDAP_ATTR_ERROR(n)     LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 
 #define LDAP_NO_SUCH_ATTRIBUTE         0x10
-#define LDAP_UNDEFINED_TYPE            0x11
+#define LDAP_UNDEFINED_TYPE                    0x11
 #define LDAP_INAPPROPRIATE_MATCHING    0x12
 #define LDAP_CONSTRAINT_VIOLATION      0x13
 #define LDAP_TYPE_OR_VALUE_EXISTS      0x14
-#define LDAP_INVALID_SYNTAX            0x15
+#define LDAP_INVALID_SYNTAX                    0x15
 
 #define LDAP_NAME_ERROR(n)     LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
 
-#define LDAP_NO_SUCH_OBJECT            0x20
-#define LDAP_ALIAS_PROBLEM             0x21
+#define LDAP_NO_SUCH_OBJECT                    0x20
+#define LDAP_ALIAS_PROBLEM                     0x21
 #define LDAP_INVALID_DN_SYNTAX         0x22
-#define LDAP_IS_LEAF                   0x23 /* not LDAPv3 */
+#define LDAP_IS_LEAF                           0x23 /* not LDAPv3 */
 #define LDAP_ALIAS_DEREF_PROBLEM       0x24
 
 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
@@ -443,10 +444,10 @@ typedef struct ldapcontrol {
 
 #define LDAP_SERVICE_ERROR(n)  LDAP_RANGE((n),0x33,0x36) /* 51-54 */
 
-#define LDAP_BUSY                      0x33
-#define LDAP_UNAVAILABLE               0x34
+#define LDAP_BUSY                                      0x33
+#define LDAP_UNAVAILABLE                       0x34
 #define LDAP_UNWILLING_TO_PERFORM      0x35
-#define LDAP_LOOP_DETECT               0x36
+#define LDAP_LOOP_DETECT                       0x36
 
 #define LDAP_UPDATE_ERROR(n)   LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
 
@@ -454,16 +455,16 @@ typedef struct ldapcontrol {
 #define LDAP_OBJECT_CLASS_VIOLATION    0x41
 #define LDAP_NOT_ALLOWED_ON_NONLEAF    0x42
 #define LDAP_NOT_ALLOWED_ON_RDN                0x43
-#define LDAP_ALREADY_EXISTS            0x44
+#define LDAP_ALREADY_EXISTS                    0x44
 #define LDAP_NO_OBJECT_CLASS_MODS      0x45
 #define LDAP_RESULTS_TOO_LARGE         0x46 /* CLDAP */
 #define LDAP_AFFECTS_MULTIPLE_DSAS     0x47 /* LDAPv3 */
 
-#define LDAP_OTHER                     0x50
+#define LDAP_OTHER                             0x50
 
 #define LDAP_API_ERROR(n)              LDAP_RANGE((n),0x51,0x61) /* 81-97 */
 #define LDAP_API_RESULT(n)             (((n) == LDAP_SUCCESS) || \
-                                                                       LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
+                                                               LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
 
 /* reserved for APIs */
 #define LDAP_SERVER_DOWN               0x51
@@ -534,10 +535,10 @@ typedef struct ldapmsg LDAPMessage;
 typedef struct ldapmod {
        int             mod_op;
 
-#define LDAP_MOD_ADD           ((ber_int_t) 0x0000)
-#define LDAP_MOD_DELETE                ((ber_int_t) 0x0001)
-#define LDAP_MOD_REPLACE       ((ber_int_t) 0x0002)
-#define LDAP_MOD_BVALUES       ((ber_int_t) 0x0080)
+#define LDAP_MOD_ADD           (0x0000)
+#define LDAP_MOD_DELETE                (0x0001)
+#define LDAP_MOD_REPLACE       (0x0002)
+#define LDAP_MOD_BVALUES       (0x0080)
 /* IMPORTANT: do not use code 0x1000 (or above),
  * it is used internally by the backends!
  * (see ldap/servers/slapd/slap.h)
@@ -559,17 +560,17 @@ typedef struct ldapmod {
  */
 typedef struct ldap LDAP;
 
-#define LDAP_DEREF_NEVER       0x00
+#define LDAP_DEREF_NEVER               0x00
 #define LDAP_DEREF_SEARCHING   0x01
-#define LDAP_DEREF_FINDING     0x02
-#define LDAP_DEREF_ALWAYS      0x03
+#define LDAP_DEREF_FINDING             0x02
+#define LDAP_DEREF_ALWAYS              0x03
 
-#define LDAP_NO_LIMIT          0
+#define LDAP_NO_LIMIT                  0
 
 /* how many messages to retrieve results for */
-#define LDAP_MSG_ONE           0x00
-#define LDAP_MSG_ALL           0x01
-#define LDAP_MSG_RECEIVED      0x02
+#define LDAP_MSG_ONE                   0x00
+#define LDAP_MSG_ALL                   0x01
+#define LDAP_MSG_RECEIVED              0x02
 
 /*
  * types for ldap URL handling
@@ -888,31 +889,6 @@ ldap_kerberos_bind2_s LDAP_P((     /* deprecated */
        LDAP *ld,
        LDAP_CONST char *who ));
 
-/*
- * in cache.c
- * (deprecated)
- */
-LDAP_F( int )
-ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
-
-LDAP_F( void )
-ldap_disable_cache LDAP_P(( LDAP *ld ));
-
-LDAP_F( void )
-ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
-
-LDAP_F( void )
-ldap_destroy_cache LDAP_P(( LDAP *ld ));
-
-LDAP_F( void )
-ldap_flush_cache LDAP_P(( LDAP *ld ));
-
-LDAP_F( void )
-ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
-
-LDAP_F( void )
-ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
-
 
 /*
  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
@@ -1731,5 +1707,34 @@ ldap_whoami_s LDAP_P((
        LDAPControl **sctrls,
        LDAPControl **cctrls ));
 
+/*
+ * in passwd.c
+ */
+
+LDAP_F( int )
+ldap_parse_passwd LDAP_P((
+       LDAP *ld,
+       LDAPMessage *res,
+       struct berval *newpasswd ));
+
+LDAP_F( int )
+ldap_passwd LDAP_P(( LDAP *ld,
+       struct berval   *user,
+       struct berval   *oldpw,
+       struct berval   *newpw,
+       LDAPControl             **sctrls,
+       LDAPControl             **cctrls,
+       int                             *msgidp ));
+
+LDAP_F( int )
+ldap_passwd_s LDAP_P((
+       LDAP *ld,
+       struct berval   *user,
+       struct berval   *oldpw,
+       struct berval   *newpw,
+       struct berval *newpasswd,
+       LDAPControl **sctrls,
+       LDAPControl **cctrls ));
+
 LDAP_END_DECL
 #endif /* _LDAP_H */