git.sur5r.net Git - openldap/blob - include/ldap.h

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1998-2003 The OpenLDAP Foundation.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted only as authorized by the OpenLDAP
   9  * Public License.
  10  *
  11  * A copy of this license is available in file LICENSE in the
  12  * top-level directory of the distribution or, alternatively, at
  13  * <http://www.OpenLDAP.org/license.html>.
  14  */
  15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
  16  * All rights reserved.
  17  *
  18  * Redistribution and use in source and binary forms are permitted
  19  * provided that this notice is preserved and that due credit is given
  20  * to the University of Michigan at Ann Arbor. The name of the University
  21  * may not be used to endorse or promote products derived from this
  22  * software without specific prior written permission. This software
  23  * is provided ``as is'' without express or implied warranty.
  24  */
  25
  26 #ifndef _LDAP_H
  27 #define _LDAP_H
  28
  29 /* pull in lber */
  30 #include <lber.h>
  31
  32 /* include version and API feature defines */
  33 #include <ldap_features.h>
  34
  35 LDAP_BEGIN_DECL
  36
  37 #define LDAP_VERSION1   1
  38 #define LDAP_VERSION2   2
  39 #define LDAP_VERSION3   3
  40
  41 #define LDAP_VERSION_MIN        LDAP_VERSION2
  42 #define LDAP_VERSION            LDAP_VERSION2
  43 #define LDAP_VERSION_MAX        LDAP_VERSION3
  44
  45 /*
  46  * We'll use 2000+draft revision for our API version number
  47  * As such, the number will be above the old RFC but below
  48  * whatever number does finally get assigned
  49  */
  50 #define LDAP_API_VERSION        2004
  51 #define LDAP_VENDOR_NAME        "OpenLDAP"
  52
  53 /* OpenLDAP API Features */
  54 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
  55
  56 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
  57         ( defined( LDAP_THREAD_SAFE ) && \
  58                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
  59         /* -lldap may or may not be thread safe */
  60         /* -lldap_r, if available, is always thread safe */
  61 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
  62 #endif
  63 #if defined( LDAP_THREAD_SAFE ) && \
  64         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
  65 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
  66 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
  67 #endif
  68
  69
  70 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
  71 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
  72
  73 #define LDAP_ROOT_DSE                           ""
  74 #define LDAP_NO_ATTRS                           "1.1"
  75 #define LDAP_ALL_USER_ATTRIBUTES        "*"
  76 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
  77
  78 /*
  79  * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
  80  * 0x0000 - 0x0fff reserved for api options
  81  * 0x1000 - 0x3fff reserved for api extended options
  82  * 0x4000 - 0x7fff reserved for private and experimental options
  83  */
  84 #define LDAP_OPT_API_INFO                       0x0000
  85 #define LDAP_OPT_DESC                           0x0001 /* deprecated */
  86 #define LDAP_OPT_DEREF                          0x0002
  87 #define LDAP_OPT_SIZELIMIT                      0x0003
  88 #define LDAP_OPT_TIMELIMIT                      0x0004
  89 /* 0x05 - 0x07 not defined by current draft */
  90 #define LDAP_OPT_REFERRALS                      0x0008
  91 #define LDAP_OPT_RESTART                        0x0009
  92 /* 0x0a - 0x10 not defined by current draft */
  93 #define LDAP_OPT_PROTOCOL_VERSION       0x0011
  94 #define LDAP_OPT_SERVER_CONTROLS        0x0012
  95 #define LDAP_OPT_CLIENT_CONTROLS        0x0013
  96 /* 0x14 not defined by current draft */
  97 #define LDAP_OPT_API_FEATURE_INFO       0x0015
  98
  99 /* 0x16 - 0x2f not defined by current draft */
 100 #define LDAP_OPT_HOST_NAME                      0x0030
 101 #define LDAP_OPT_RESULT_CODE            0x0031
 102 #define LDAP_OPT_ERROR_NUMBER           LDAP_OPT_RESULT_CODE
 103 #define LDAP_OPT_ERROR_STRING           0x0032
 104 #define LDAP_OPT_MATCHED_DN                     0x0033
 105
 106 /* 0x34 - 0x0fff not defined by current draft */
 107
 108 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000  /* to 0x7FFF inclusive */
 109
 110 /* private and experimental options */
 111 /* OpenLDAP specific options */
 112 #define LDAP_OPT_DEBUG_LEVEL            0x5001  /* debug level */
 113 #define LDAP_OPT_TIMEOUT                        0x5002  /* default timeout */
 114 #define LDAP_OPT_REFHOPLIMIT            0x5003  /* ref hop limit */
 115 #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
 116 #define LDAP_OPT_URI                            0x5006
 117 #define LDAP_OPT_REFERRAL_URLS      0x5007  /* Referral URLs */
 118
 119 /* OpenLDAP TLS options */
 120 #define LDAP_OPT_X_TLS                          0x6000
 121 #define LDAP_OPT_X_TLS_CTX                      0x6001  /* SSL CTX */
 122 #define LDAP_OPT_X_TLS_CACERTFILE       0x6002
 123 #define LDAP_OPT_X_TLS_CACERTDIR        0x6003
 124 #define LDAP_OPT_X_TLS_CERTFILE         0x6004
 125 #define LDAP_OPT_X_TLS_KEYFILE          0x6005
 126 #define LDAP_OPT_X_TLS_REQUIRE_CERT     0x6006
 127 /* #define LDAP_OPT_X_TLS_PROTOCOL              0x6007 */
 128 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6008
 129 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x6009
 130 #define LDAP_OPT_X_TLS_SSL_CTX          0x600a
 131
 132 #define LDAP_OPT_X_TLS_NEVER            0
 133 #define LDAP_OPT_X_TLS_HARD             1
 134 #define LDAP_OPT_X_TLS_DEMAND           2
 135 #define LDAP_OPT_X_TLS_ALLOW            3
 136 #define LDAP_OPT_X_TLS_TRY              4
 137
 138 /* OpenLDAP SASL options */
 139 #define LDAP_OPT_X_SASL_MECH                    0x6100
 140 #define LDAP_OPT_X_SASL_REALM                   0x6101
 141 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
 142 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
 143 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
 144 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
 145 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
 146 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
 147 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
 148 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
 149
 150 /* on/off values */
 151 #define LDAP_OPT_ON             ((void *) &ber_pvt_opt_on)
 152 #define LDAP_OPT_OFF    ((void *) 0)
 153
 154 /*
 155  * ldap_get_option() and ldap_set_option() return values.
 156  * As later versions may return other values indicating
 157  * failure, current applications should only compare returned
 158  * value against LDAP_OPT_SUCCESS.
 159  */
 160 #define LDAP_OPT_SUCCESS        0
 161 #define LDAP_OPT_ERROR          (-1)
 162
 163 #define LDAP_API_INFO_VERSION   (1)
 164 typedef struct ldapapiinfo {
 165         int             ldapai_info_version;            /* version of LDAPAPIInfo (1) */
 166         int             ldapai_api_version;                     /* revision of API supported */
 167         int             ldapai_protocol_version;        /* highest LDAP version supported */
 168         char    **ldapai_extensions;            /* names of API extensions */
 169         char    *ldapai_vendor_name;            /* name of supplier */
 170         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
 171 } LDAPAPIInfo;
 172
 173 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
 174 typedef struct ldap_apifeature_info {
 175         int             ldapaif_info_version; /* version of this struct (1) */
 176         char*   ldapaif_name;    /* matches LDAP_API_FEATURE_... less the prefix */
 177         int             ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
 178 } LDAPAPIFeatureInfo;
 179
 180 typedef struct ldapcontrol {
 181         char *                  ldctl_oid;
 182         struct berval   ldctl_value;
 183         char                    ldctl_iscritical;
 184 } LDAPControl;
 185
 186 /* LDAP Controls */
 187 #define LDAP_CONTROL_ASSERT                             "1.3.6.1.4.1.4203.666.5.9"
 188 #define LDAP_CONTROL_PRE_READ                   "1.3.6.1.4.1.4203.666.5.10.1"
 189 #define LDAP_CONTROL_POST_READ                  "1.3.6.1.4.1.4203.666.5.10.2"
 190 #define LDAP_CONTROL_MODIFY_INCREMENT   "1.3.6.1.4.1.4203.666.5.11"
 191
 192 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
 193 #define LDAP_CONTROL_SUBENTRIES                 "1.3.6.1.4.1.4203.1.10.1"
 194 #define LDAP_CONTROL_NOOP                               "1.3.6.1.4.1.4203.1.10.2"
 195 #define LDAP_CONTROL_MANAGEDSAIT                "2.16.840.1.113730.3.4.2"
 196 #define LDAP_CONTROL_PROXY_AUTHZ                "2.16.840.1.113730.3.4.18"
 197
 198 #if 0
 199 #define LDAP_CONTROL_DUPENT_REQUEST             "2.16.840.1.113719.1.27.101.1"
 200 #define LDAP_CONTROL_DUPENT_RESPONSE    "2.16.840.1.113719.1.27.101.2"
 201 #define LDAP_CONTROL_DUPENT_ENTRY               "2.16.840.1.113719.1.27.101.3"
 202 #define LDAP_CONTROL_DUPENT     LDAP_CONTROL_DUPENT_REQUEST
 203 #endif
 204
 205 #define LDAP_CONTROL_PAGEDRESULTS               "1.2.840.113556.1.4.319"
 206
 207 #define LDAP_CONTROL_SYNC               "1.3.6.1.4.1.4203.666.5.6"
 208 #define LDAP_CONTROL_SYNC_STATE "1.3.6.1.4.1.4203.666.5.7"
 209 #define LDAP_CONTROL_SYNC_DONE  "1.3.6.1.4.1.4203.666.5.8"
 210 #define LDAP_SYNC_INFO                  "1.3.6.1.4.1.4203.666.10.2"
 211
 212 #define LDAP_SYNC_NONE                                  0x00
 213 #define LDAP_SYNC_REFRESH_ONLY                  0x01
 214 #define LDAP_SYNC_RESERVED                              0x02
 215 #define LDAP_SYNC_REFRESH_AND_PERSIST   0x03
 216
 217 #define LDAP_SYNC_REFRESH_PRESENTS              0
 218 #define LDAP_SYNC_REFRESH_DELETES               1
 219
 220 #define LDAP_TAG_SYNC_NEW_COOKIE                ((ber_tag_t) 0x80U)
 221 #define LDAP_TAG_SYNC_REFRESH_DELETE    ((ber_tag_t) 0xa1U)
 222 #define LDAP_TAG_SYNC_REFRESH_PRESENT   ((ber_tag_t) 0xa2U)
 223 #define LDAP_TAG_SYNC_ID_SET                    ((ber_tag_t) 0xa3U)
 224
 225 #define LDAP_TAG_SYNC_COOKIE                    ((ber_tag_t) 0x04U)
 226 #define LDAP_TAG_REFRESHDELETES                 ((ber_tag_t) 0x01U)
 227 #define LDAP_TAG_REFRESHDONE                    ((ber_tag_t) 0x01U)
 228 #define LDAP_TAG_RELOAD_HINT                    ((ber_tag_t) 0x01U)
 229
 230 #define LDAP_SYNC_PRESENT                               0
 231 #define LDAP_SYNC_ADD                                   1
 232 #define LDAP_SYNC_MODIFY                                2
 233 #define LDAP_SYNC_DELETE                                3
 234
 235 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473"
 236 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474"
 237 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
 238 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 239
 240 /* controls for MSAD compatibility */
 241 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
 242 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
 243
 244 /* LDAP Unsolicited Notifications */
 245 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036"
 246 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 247
 248 /* LDAP Extended Operations */
 249 #define LDAP_EXOP_START_TLS     "1.3.6.1.4.1.1466.20037"
 250
 251 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
 252 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
 253 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
 254 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
 255 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
 256
 257 #define LDAP_EXOP_X_WHO_AM_I    "1.3.6.1.4.1.4203.1.11.3"
 258 #define LDAP_EXOP_X_CANCEL              "1.3.6.1.4.1.4203.666.6.3"
 259
 260 /* LDAP Features */
 261 #define LDAP_FEATURE_ALL_OPERATIONAL_ATTRS "1.3.6.1.4.1.4203.1.5.1"  /* + */
 262 #define LDAP_FEATURE_OBJECTCLASS_ATTRS "1.3.6.1.4.1.4203.1.5.2"
 263 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
 264 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
 265 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
 266 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.5.6"
 267
 268 /*
 269  * specific LDAP instantiations of BER types we know about
 270  */
 271
 272 /* Overview of LBER tag construction
 273  *
 274  *      Bits
 275  *      ______
 276  *      8 7 | CLASS
 277  *      0 0 = UNIVERSAL
 278  *      0 1 = APPLICATION
 279  *      1 0 = CONTEXT-SPECIFIC
 280  *      1 1 = PRIVATE
 281  *              _____
 282  *              | 6 | DATA-TYPE
 283  *                0 = PRIMITIVE
 284  *                1 = CONSTRUCTED
 285  *                      ___________
 286  *                      | 5 ... 1 | TAG-NUMBER
 287  */
 288
 289 /* general stuff */
 290 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
 291 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
 292
 293 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octet string */
 294 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octet string */
 295
 296 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
 297 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
 298
 299 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
 300
 301 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
 302 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
 303 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
 304 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
 305
 306 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
 307
 308 /* possible operations a client can invoke */
 309 #define LDAP_REQ_BIND           ((ber_tag_t) 0x60U)     /* application + constructed */
 310 #define LDAP_REQ_UNBIND         ((ber_tag_t) 0x42U)     /* application + primitive   */
 311 #define LDAP_REQ_SEARCH         ((ber_tag_t) 0x63U)     /* application + constructed */
 312 #define LDAP_REQ_MODIFY         ((ber_tag_t) 0x66U)     /* application + constructed */
 313 #define LDAP_REQ_ADD            ((ber_tag_t) 0x68U)     /* application + constructed */
 314 #define LDAP_REQ_DELETE         ((ber_tag_t) 0x4aU)     /* application + primitive   */
 315 #define LDAP_REQ_MODDN          ((ber_tag_t) 0x6cU)     /* application + constructed */
 316 #define LDAP_REQ_MODRDN         LDAP_REQ_MODDN
 317 #define LDAP_REQ_RENAME         LDAP_REQ_MODDN
 318 #define LDAP_REQ_COMPARE        ((ber_tag_t) 0x6eU)     /* application + constructed */
 319 #define LDAP_REQ_ABANDON        ((ber_tag_t) 0x50U)     /* application + primitive   */
 320 #define LDAP_REQ_EXTENDED       ((ber_tag_t) 0x77U)     /* application + constructed */
 321
 322 /* possible result types a server can return */
 323 #define LDAP_RES_BIND           ((ber_tag_t) 0x61U)     /* application + constructed */
 324 #define LDAP_RES_SEARCH_ENTRY   ((ber_tag_t) 0x64U)     /* application + constructed */
 325 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
 326 #define LDAP_RES_SEARCH_RESULT  ((ber_tag_t) 0x65U)     /* application + constructed */
 327 #define LDAP_RES_MODIFY         ((ber_tag_t) 0x67U)     /* application + constructed */
 328 #define LDAP_RES_ADD            ((ber_tag_t) 0x69U)     /* application + constructed */
 329 #define LDAP_RES_DELETE         ((ber_tag_t) 0x6bU)     /* application + constructed */
 330 #define LDAP_RES_MODDN          ((ber_tag_t) 0x6dU)     /* application + constructed */
 331 #define LDAP_RES_MODRDN         LDAP_RES_MODDN  /* application + constructed */
 332 #define LDAP_RES_RENAME         LDAP_RES_MODDN  /* application + constructed */
 333 #define LDAP_RES_COMPARE        ((ber_tag_t) 0x6fU)     /* application + constructed */
 334 #define LDAP_RES_EXTENDED       ((ber_tag_t) 0x78U)     /* V3: application + constructed */
 335 #define LDAP_RES_INTERMEDIATE   ((ber_tag_t) 0x79U) /* V3+: application + constructed */
 336
 337 #define LDAP_RES_ANY                    (-1)
 338 #define LDAP_RES_UNSOLICITED    (0)
 339
 340
 341 /* sasl methods */
 342 #define LDAP_SASL_SIMPLE        ((char*)0)
 343 #define LDAP_SASL_NULL          ("")
 344
 345
 346 /* authentication methods available */
 347 #define LDAP_AUTH_NONE  ((ber_tag_t) 0x00U)     /* no authentication              */
 348 #define LDAP_AUTH_SIMPLE        ((ber_tag_t) 0x80U)     /* context specific + primitive */
 349 #define LDAP_AUTH_SASL  ((ber_tag_t) 0xa3U)     /* context specific + constructed */
 350 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU)     /* means do both of the following */
 351 #define LDAP_AUTH_KRBV41        ((ber_tag_t) 0x81U)     /* context specific + primitive */
 352 #define LDAP_AUTH_KRBV42        ((ber_tag_t) 0x82U)     /* context specific + primitive */
 353
 354
 355 /* filter types */
 356 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U)     /* context specific + constructed */
 357 #define LDAP_FILTER_OR  ((ber_tag_t) 0xa1U)     /* context specific + constructed */
 358 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U)     /* context specific + constructed */
 359 #define LDAP_FILTER_EQUALITY    ((ber_tag_t) 0xa3U)     /* context specific + constructed */
 360 #define LDAP_FILTER_SUBSTRINGS  ((ber_tag_t) 0xa4U)     /* context specific + constructed */
 361 #define LDAP_FILTER_GE  ((ber_tag_t) 0xa5U)     /* context specific + constructed */
 362 #define LDAP_FILTER_LE  ((ber_tag_t) 0xa6U)     /* context specific + constructed */
 363 #define LDAP_FILTER_PRESENT     ((ber_tag_t) 0x87U)     /* context specific + primitive   */
 364 #define LDAP_FILTER_APPROX      ((ber_tag_t) 0xa8U)     /* context specific + constructed */
 365 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U)     /* context specific + constructed */
 366
 367 /* extended filter component types */
 368 #define LDAP_FILTER_EXT_OID             ((ber_tag_t) 0x81U)     /* context specific */
 369 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
 370 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
 371 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
 372
 373 /* substring filter component types */
 374 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 375 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
 376 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 377
 378 /* search scopes */
 379 #define LDAP_SCOPE_DEFAULT      ((ber_int_t) -1)
 380 #define LDAP_SCOPE_BASE         ((ber_int_t) 0x0000)
 381 #define LDAP_SCOPE_ONELEVEL     ((ber_int_t) 0x0001)
 382 #define LDAP_SCOPE_SUBTREE      ((ber_int_t) 0x0002)
 383
 384 /* substring filter component types */
 385 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 386 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
 387 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 388
 389 /*
 390  * possible error codes we can return
 391  */
 392
 393 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
 394
 395 #define LDAP_SUCCESS                            0x00
 396 #define LDAP_OPERATIONS_ERROR           0x01
 397 #define LDAP_PROTOCOL_ERROR                     0x02
 398 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 399 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 400 #define LDAP_COMPARE_FALSE                      0x05
 401 #define LDAP_COMPARE_TRUE                       0x06
 402 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
 403 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
 404 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 405 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
 406
 407 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 408 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 409 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
 410 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 411 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 412
 413 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 414
 415 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 416 #define LDAP_UNDEFINED_TYPE                     0x11
 417 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 418 #define LDAP_CONSTRAINT_VIOLATION       0x13
 419 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 420 #define LDAP_INVALID_SYNTAX                     0x15
 421
 422 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
 423
 424 #define LDAP_NO_SUCH_OBJECT                     0x20
 425 #define LDAP_ALIAS_PROBLEM                      0x21
 426 #define LDAP_INVALID_DN_SYNTAX          0x22
 427 #define LDAP_IS_LEAF                            0x23 /* not LDAPv3 */
 428 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 429
 430 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
 431
 432 #define LDAP_PROXY_AUTHZ_FAILURE        0x2F /* LDAPv3 proxy authorization */
 433 #define LDAP_INAPPROPRIATE_AUTH         0x30
 434 #define LDAP_INVALID_CREDENTIALS        0x31
 435 #define LDAP_INSUFFICIENT_ACCESS        0x32
 436
 437 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
 438
 439 #define LDAP_BUSY                                       0x33
 440 #define LDAP_UNAVAILABLE                        0x34
 441 #define LDAP_UNWILLING_TO_PERFORM       0x35
 442 #define LDAP_LOOP_DETECT                        0x36
 443
 444 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
 445
 446 #define LDAP_NAMING_VIOLATION           0x40
 447 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 448 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 449 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 450 #define LDAP_ALREADY_EXISTS                     0x44
 451 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 452 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 453 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
 454
 455 #define LDAP_OTHER                              0x50
 456
 457 /* Expermental result codes -- subject to change */
 458
 459 #define LDAP_SYNC_RESOURCES_EXHAUSTED   0x100
 460 #define LDAP_SYNC_SECURITY_VIOLATION    0x101
 461 #define LDAP_SYNC_INVALID_COOKIE                0x102
 462 #define LDAP_SYNC_UNSUPPORTED_SCHEME    0x103
 463 #define LDAP_SYNC_CLIENT_DISCONNECT             0x104
 464 #define LDAP_SYNC_RELOAD_REQUIRED               0x105
 465
 466 #define LDAP_ASSERTION_FAILED                   0x10f
 467
 468 /* resultCode for Cancel Response */
 469 #define LDAP_CANCELLED                                  0x110
 470 #define LDAP_NO_SUCH_OPERATION                  0x111
 471 #define LDAP_TOO_LATE                                   0x112
 472 #define LDAP_CANNOT_CANCEL                              0x113
 473
 474 #define LDAP_API_ERROR(n)               ((n)<0)
 475 #define LDAP_API_RESULT(n)              ((n)<=0)
 476
 477 /* API Error Codes
 478  *
 479  * Based on draft-ietf-ldap-c-api-xx
 480  * but with new (negative) codes
 481  */
 482 #define LDAP_SERVER_DOWN                                (-1)
 483 #define LDAP_LOCAL_ERROR                                (-2)
 484 #define LDAP_ENCODING_ERROR                             (-3)
 485 #define LDAP_DECODING_ERROR                             (-4)
 486 #define LDAP_TIMEOUT                                    (-5)
 487 #define LDAP_AUTH_UNKNOWN                               (-6)
 488 #define LDAP_FILTER_ERROR                               (-7)
 489 #define LDAP_USER_CANCELLED                             (-8)
 490 #define LDAP_PARAM_ERROR                                (-9)
 491 #define LDAP_NO_MEMORY                                  (-10)
 492 #define LDAP_CONNECT_ERROR                              (-11)
 493 #define LDAP_NOT_SUPPORTED                              (-12)
 494 #define LDAP_CONTROL_NOT_FOUND                  (-13)
 495 #define LDAP_NO_RESULTS_RETURNED                (-14)
 496 #define LDAP_MORE_RESULTS_TO_RETURN             (-15)
 497 #define LDAP_CLIENT_LOOP                                (-16)
 498 #define LDAP_REFERRAL_LIMIT_EXCEEDED    (-17)
 499
 500
 501 /*
 502  * This structure represents both ldap messages and ldap responses.
 503  * These are really the same, except in the case of search responses,
 504  * where a response has multiple messages.
 505  */
 506
 507 typedef struct ldapmsg LDAPMessage;
 508
 509 /* for modifications */
 510 typedef struct ldapmod {
 511         int             mod_op;
 512
 513 #define LDAP_MOD_OP                     (0x0007)
 514 #define LDAP_MOD_ADD            (0x0000)
 515 #define LDAP_MOD_DELETE         (0x0001)
 516 #define LDAP_MOD_REPLACE        (0x0002)
 517 #define LDAP_MOD_INCREMENT      (0x0003)
 518 #define LDAP_MOD_BVALUES        (0x0080)
 519 /* IMPORTANT: do not use code 0x1000 (or above),
 520  * it is used internally by the backends!
 521  * (see ldap/servers/slapd/slap.h)
 522  */
 523
 524         char            *mod_type;
 525         union mod_vals_u {
 526                 char            **modv_strvals;
 527                 struct berval   **modv_bvals;
 528         } mod_vals;
 529 #define mod_values      mod_vals.modv_strvals
 530 #define mod_bvalues     mod_vals.modv_bvals
 531 } LDAPMod;
 532
 533 /*
 534  * structure representing an ldap session which can
 535  * encompass connections to multiple servers (in the
 536  * face of referrals).
 537  */
 538 typedef struct ldap LDAP;
 539
 540 #define LDAP_DEREF_NEVER                0x00
 541 #define LDAP_DEREF_SEARCHING    0x01
 542 #define LDAP_DEREF_FINDING              0x02
 543 #define LDAP_DEREF_ALWAYS               0x03
 544
 545 #define LDAP_NO_LIMIT                   0
 546
 547 /* how many messages to retrieve results for */
 548 #define LDAP_MSG_ONE                    0x00
 549 #define LDAP_MSG_ALL                    0x01
 550 #define LDAP_MSG_RECEIVED               0x02
 551
 552 /*
 553  * types for ldap URL handling
 554  */
 555 typedef struct ldap_url_desc {
 556         struct ldap_url_desc *lud_next;
 557         char    *lud_scheme;
 558         char    *lud_host;
 559         int             lud_port;
 560         char    *lud_dn;
 561         char    **lud_attrs;
 562         int             lud_scope;
 563         char    *lud_filter;
 564         char    **lud_exts;
 565         int             lud_crit_exts;
 566 } LDAPURLDesc;
 567
 568 #define LDAP_URL_SUCCESS                0x00    /* Success */
 569 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 570 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 571
 572 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 573 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 574 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 575 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 576 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 577 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 578 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 579 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 580
 581 /*
 582  * The API draft spec says we should declare (or cause to be declared)
 583  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 584  */
 585 struct timeval;
 586
 587 /*
 588  * in options.c:
 589  */
 590 LDAP_F( int )
 591 ldap_get_option LDAP_P((
 592         LDAP *ld,
 593         int option,
 594         void *outvalue));
 595
 596 LDAP_F( int )
 597 ldap_set_option LDAP_P((
 598         LDAP *ld,
 599         int option,
 600         LDAP_CONST void *invalue));
 601
 602 /* V3 REBIND Function Callback Prototype */
 603 typedef int (LDAP_REBIND_PROC) LDAP_P((
 604         LDAP *ld, LDAP_CONST char *url,
 605         ber_tag_t request, ber_int_t msgid,
 606         void *params ));
 607
 608 LDAP_F( int )
 609 ldap_set_rebind_proc LDAP_P((
 610         LDAP *ld,
 611         LDAP_REBIND_PROC *rebind_proc,
 612         void *params ));
 613
 614 /*
 615  * in controls.c:
 616  */
 617 LDAP_F( int )
 618 ldap_create_control LDAP_P((
 619         LDAP_CONST char *requestOID,
 620         BerElement *ber,
 621         int iscritical,
 622         LDAPControl **ctrlp ));
 623
 624 LDAP_F( void )
 625 ldap_control_free LDAP_P((
 626         LDAPControl *ctrl ));
 627
 628 LDAP_F( void )
 629 ldap_controls_free LDAP_P((
 630         LDAPControl **ctrls ));
 631
 632 /*
 633  * in dnssrv.c:
 634  */
 635 LDAP_F( int )
 636 ldap_domain2dn LDAP_P((
 637         LDAP_CONST char* domain,
 638         char** dn ));
 639
 640 LDAP_F( int )
 641 ldap_dn2domain LDAP_P((
 642         LDAP_CONST char* dn,
 643         char** domain ));
 644
 645 LDAP_F( int )
 646 ldap_domain2hostlist LDAP_P((
 647         LDAP_CONST char *domain,
 648         char** hostlist ));
 649
 650 /*
 651  * in extended.c:
 652  */
 653 LDAP_F( int )
 654 ldap_extended_operation LDAP_P((
 655         LDAP                    *ld,
 656         LDAP_CONST char *reqoid,
 657         struct berval   *reqdata,
 658         LDAPControl             **serverctrls,
 659         LDAPControl             **clientctrls,
 660         int                             *msgidp ));
 661
 662 LDAP_F( int )
 663 ldap_extended_operation_s LDAP_P((
 664         LDAP                    *ld,
 665         LDAP_CONST char *reqoid,
 666         struct berval   *reqdata,
 667         LDAPControl             **serverctrls,
 668         LDAPControl             **clientctrls,
 669         char                    **retoidp,
 670         struct berval   **retdatap ));
 671
 672 LDAP_F( int )
 673 ldap_parse_extended_result LDAP_P((
 674         LDAP                    *ld,
 675         LDAPMessage             *res,
 676         char                    **retoidp,
 677         struct berval   **retdatap,
 678         int                             freeit ));
 679
 680 LDAP_F( int )
 681 ldap_parse_intermediate LDAP_P((
 682         LDAP                    *ld,
 683         LDAPMessage             *res,
 684         char                    **retoidp,
 685         struct berval   **retdatap,
 686         LDAPControl             ***serverctrls,
 687         int                             freeit ));
 688
 689 /*
 690  * in abandon.c:
 691  */
 692 LDAP_F( int )
 693 ldap_abandon_ext LDAP_P((
 694         LDAP                    *ld,
 695         int                             msgid,
 696         LDAPControl             **serverctrls,
 697         LDAPControl             **clientctrls ));
 698
 699 LDAP_F( int )
 700 ldap_abandon LDAP_P((   /* deprecated */
 701         LDAP *ld,
 702         int msgid ));
 703
 704
 705 /*
 706  * in add.c:
 707  */
 708 LDAP_F( int )
 709 ldap_add_ext LDAP_P((
 710         LDAP                    *ld,
 711         LDAP_CONST char *dn,
 712         LDAPMod                 **attrs,
 713         LDAPControl             **serverctrls,
 714         LDAPControl             **clientctrls,
 715         int                     *msgidp ));
 716
 717 LDAP_F( int )
 718 ldap_add_ext_s LDAP_P((
 719         LDAP                    *ld,
 720         LDAP_CONST char *dn,
 721         LDAPMod                 **attrs,
 722         LDAPControl             **serverctrls,
 723         LDAPControl             **clientctrls ));
 724
 725 LDAP_F( int )
 726 ldap_add LDAP_P((       /* deprecated */
 727         LDAP *ld,
 728         LDAP_CONST char *dn,
 729         LDAPMod **attrs ));
 730
 731 LDAP_F( int )
 732 ldap_add_s LDAP_P((     /* deprecated */
 733         LDAP *ld,
 734         LDAP_CONST char *dn,
 735         LDAPMod **attrs ));
 736
 737
 738 /*
 739  * in sasl.c:
 740  */
 741 LDAP_F( int )
 742 ldap_sasl_bind LDAP_P((
 743         LDAP                    *ld,
 744         LDAP_CONST char *dn,
 745         LDAP_CONST char *mechanism,
 746         struct berval   *cred,
 747         LDAPControl             **serverctrls,
 748         LDAPControl             **clientctrls,
 749         int                             *msgidp ));
 750
 751 /* Interaction flags (should be passed about in a control)
 752  *  Automatic (default): use defaults, prompt otherwise
 753  *  Interactive: prompt always
 754  *  Quiet: never prompt
 755  */
 756 #define LDAP_SASL_AUTOMATIC             0U
 757 #define LDAP_SASL_INTERACTIVE   1U
 758 #define LDAP_SASL_QUIET                 2U
 759
 760 /*
 761  * V3 SASL Interaction Function Callback Prototype
 762  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
 763  *  should likely passed in a control (and provided controls)
 764  */
 765 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
 766         LDAP *ld, unsigned flags, void* defaults, void *interact ));
 767
 768 LDAP_F( int )
 769 ldap_sasl_interactive_bind_s LDAP_P((
 770         LDAP *ld,
 771         LDAP_CONST char *dn, /* usually NULL */
 772         LDAP_CONST char *saslMechanism,
 773         LDAPControl **serverControls,
 774         LDAPControl **clientControls,
 775
 776         /* should be client controls */
 777         unsigned flags,
 778         LDAP_SASL_INTERACT_PROC *proc,
 779         void *defaults ));
 780
 781 LDAP_F( int )
 782 ldap_sasl_bind_s LDAP_P((
 783         LDAP                    *ld,
 784         LDAP_CONST char *dn,
 785         LDAP_CONST char *mechanism,
 786         struct berval   *cred,
 787         LDAPControl             **serverctrls,
 788         LDAPControl             **clientctrls,
 789         struct berval   **servercredp ));
 790
 791 LDAP_F( int )
 792 ldap_parse_sasl_bind_result LDAP_P((
 793         LDAP                    *ld,
 794         LDAPMessage             *res,
 795         struct berval   **servercredp,
 796         int                             freeit ));
 797
 798 /*
 799  * in bind.c:
 800  *      (deprecated)
 801  */
 802 LDAP_F( int )
 803 ldap_bind LDAP_P((      /* deprecated */
 804         LDAP *ld,
 805         LDAP_CONST char *who,
 806         LDAP_CONST char *passwd,
 807         int authmethod ));
 808
 809 LDAP_F( int )
 810 ldap_bind_s LDAP_P((    /* deprecated */
 811         LDAP *ld,
 812         LDAP_CONST char *who,
 813         LDAP_CONST char *cred,
 814         int authmethod ));
 815
 816 /*
 817  * in sbind.c:
 818  */
 819 LDAP_F( int )
 820 ldap_simple_bind LDAP_P((
 821         LDAP *ld,
 822         LDAP_CONST char *who,
 823         LDAP_CONST char *passwd ));
 824
 825 LDAP_F( int )
 826 ldap_simple_bind_s LDAP_P((
 827         LDAP *ld,
 828         LDAP_CONST char *who,
 829         LDAP_CONST char *passwd ));
 830
 831
 832 /*
 833  * in kbind.c:
 834  *      (deprecated)
 835  */
 836 LDAP_F( int )
 837 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
 838         LDAP *ld,
 839         LDAP_CONST char *who ));
 840
 841 LDAP_F( int )
 842 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
 843         LDAP *ld,
 844         LDAP_CONST char *who ));
 845
 846 LDAP_F( int )
 847 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
 848         LDAP *ld,
 849         LDAP_CONST char *who ));
 850
 851 LDAP_F( int )
 852 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
 853         LDAP *ld,
 854         LDAP_CONST char *who ));
 855
 856 LDAP_F( int )
 857 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
 858         LDAP *ld,
 859         LDAP_CONST char *who ));
 860
 861
 862 /*
 863  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
 864  */
 865
 866 LDAP_F( int )
 867 ldap_cancel LDAP_P(( LDAP *ld,
 868         int cancelid,
 869         LDAPControl             **sctrls,
 870         LDAPControl             **cctrls,
 871         int                             *msgidp ));
 872
 873 LDAP_F( int )
 874 ldap_cancel_s LDAP_P((
 875         LDAP *ld,
 876         int cancelid,
 877         LDAPControl **sctrl,
 878         LDAPControl **cctrl ));
 879
 880 /*
 881  * in compare.c:
 882  */
 883 LDAP_F( int )
 884 ldap_compare_ext LDAP_P((
 885         LDAP                    *ld,
 886         LDAP_CONST char *dn,
 887         LDAP_CONST char *attr,
 888         struct berval   *bvalue,
 889         LDAPControl             **serverctrls,
 890         LDAPControl             **clientctrls,
 891         int                     *msgidp ));
 892
 893 LDAP_F( int )
 894 ldap_compare_ext_s LDAP_P((
 895         LDAP                    *ld,
 896         LDAP_CONST char *dn,
 897         LDAP_CONST char *attr,
 898         struct berval   *bvalue,
 899         LDAPControl             **serverctrls,
 900         LDAPControl             **clientctrls ));
 901
 902 LDAP_F( int )
 903 ldap_compare LDAP_P((   /* deprecated */
 904         LDAP *ld,
 905         LDAP_CONST char *dn,
 906         LDAP_CONST char *attr,
 907         LDAP_CONST char *value ));
 908
 909 LDAP_F( int )
 910 ldap_compare_s LDAP_P(( /* deprecated */
 911         LDAP *ld,
 912         LDAP_CONST char *dn,
 913         LDAP_CONST char *attr,
 914         LDAP_CONST char *value ));
 915
 916
 917 /*
 918  * in delete.c:
 919  */
 920 LDAP_F( int )
 921 ldap_delete_ext LDAP_P((
 922         LDAP                    *ld,
 923         LDAP_CONST char *dn,
 924         LDAPControl             **serverctrls,
 925         LDAPControl             **clientctrls,
 926         int                     *msgidp ));
 927
 928 LDAP_F( int )
 929 ldap_delete_ext_s LDAP_P((
 930         LDAP                    *ld,
 931         LDAP_CONST char *dn,
 932         LDAPControl             **serverctrls,
 933         LDAPControl             **clientctrls ));
 934
 935 LDAP_F( int )
 936 ldap_delete LDAP_P((    /* deprecated */
 937         LDAP *ld,
 938         LDAP_CONST char *dn ));
 939
 940 LDAP_F( int )
 941 ldap_delete_s LDAP_P((  /* deprecated */
 942         LDAP *ld,
 943         LDAP_CONST char *dn ));
 944
 945
 946 /*
 947  * in error.c:
 948  */
 949 LDAP_F( int )
 950 ldap_parse_result LDAP_P((
 951         LDAP                    *ld,
 952         LDAPMessage             *res,
 953         int                             *errcodep,
 954         char                    **matcheddnp,
 955         char                    **errmsgp,
 956         char                    ***referralsp,
 957         LDAPControl             ***serverctrls,
 958         int                             freeit ));
 959
 960 LDAP_F( char * )
 961 ldap_err2string LDAP_P((
 962         int err ));
 963
 964 LDAP_F( int )
 965 ldap_result2error LDAP_P((      /* deprecated */
 966         LDAP *ld,
 967         LDAPMessage *r,
 968         int freeit ));
 969
 970 LDAP_F( void )
 971 ldap_perror LDAP_P((    /* deprecated */
 972         LDAP *ld,
 973         LDAP_CONST char *s ));
 974
 975
 976 /*
 977  * in modify.c:
 978  */
 979 LDAP_F( int )
 980 ldap_modify_ext LDAP_P((
 981         LDAP                    *ld,
 982         LDAP_CONST char *dn,
 983         LDAPMod                 **mods,
 984         LDAPControl             **serverctrls,
 985         LDAPControl             **clientctrls,
 986         int                     *msgidp ));
 987
 988 LDAP_F( int )
 989 ldap_modify_ext_s LDAP_P((
 990         LDAP                    *ld,
 991         LDAP_CONST char *dn,
 992         LDAPMod                 **mods,
 993         LDAPControl             **serverctrls,
 994         LDAPControl             **clientctrls ));
 995
 996 LDAP_F( int )
 997 ldap_modify LDAP_P((    /* deprecated */
 998         LDAP *ld,
 999         LDAP_CONST char *dn,
1000         LDAPMod **mods ));
1001
1002 LDAP_F( int )
1003 ldap_modify_s LDAP_P((  /* deprecated */
1004         LDAP *ld,
1005         LDAP_CONST char *dn,
1006         LDAPMod **mods ));
1007
1008
1009 /*
1010  * in modrdn.c:
1011  */
1012 LDAP_F( int )
1013 ldap_rename LDAP_P((
1014         LDAP *ld,
1015         LDAP_CONST char *dn,
1016         LDAP_CONST char *newrdn,
1017         LDAP_CONST char *newSuperior,
1018         int deleteoldrdn,
1019         LDAPControl **sctrls,
1020         LDAPControl **cctrls,
1021         int *msgidp ));
1022
1023 LDAP_F( int )
1024 ldap_rename_s LDAP_P((
1025         LDAP *ld,
1026         LDAP_CONST char *dn,
1027         LDAP_CONST char *newrdn,
1028         LDAP_CONST char *newSuperior,
1029         int deleteoldrdn,
1030         LDAPControl **sctrls,
1031         LDAPControl **cctrls ));
1032
1033 LDAP_F( int )
1034 ldap_rename2 LDAP_P((   /* deprecated */
1035         LDAP *ld,
1036         LDAP_CONST char *dn,
1037         LDAP_CONST char *newrdn,
1038         LDAP_CONST char *newSuperior,
1039         int deleteoldrdn ));
1040
1041 LDAP_F( int )
1042 ldap_rename2_s LDAP_P(( /* deprecated */
1043         LDAP *ld,
1044         LDAP_CONST char *dn,
1045         LDAP_CONST char *newrdn,
1046         LDAP_CONST char *newSuperior,
1047         int deleteoldrdn ));
1048
1049 LDAP_F( int )
1050 ldap_modrdn LDAP_P((    /* deprecated */
1051         LDAP *ld,
1052         LDAP_CONST char *dn,
1053         LDAP_CONST char *newrdn ));
1054
1055 LDAP_F( int )
1056 ldap_modrdn_s LDAP_P((  /* deprecated */
1057         LDAP *ld,
1058         LDAP_CONST char *dn,
1059         LDAP_CONST char *newrdn ));
1060
1061 LDAP_F( int )
1062 ldap_modrdn2 LDAP_P((   /* deprecated */
1063         LDAP *ld,
1064         LDAP_CONST char *dn,
1065         LDAP_CONST char *newrdn,
1066         int deleteoldrdn ));
1067
1068 LDAP_F( int )
1069 ldap_modrdn2_s LDAP_P(( /* deprecated */
1070         LDAP *ld,
1071         LDAP_CONST char *dn,
1072         LDAP_CONST char *newrdn,
1073         int deleteoldrdn));
1074
1075
1076 /*
1077  * in open.c:
1078  */
1079 LDAP_F( LDAP * )
1080 ldap_init LDAP_P((
1081         LDAP_CONST char *host,
1082         int port ));
1083
1084 LDAP_F( LDAP * )
1085 ldap_open LDAP_P((      /* deprecated */
1086         LDAP_CONST char *host,
1087         int port ));
1088
1089 LDAP_F( int )
1090 ldap_create LDAP_P((
1091         LDAP **ldp ));
1092
1093 LDAP_F( int )
1094 ldap_initialize LDAP_P((
1095         LDAP **ldp,
1096         LDAP_CONST char *url ));
1097
1098 LDAP_F( int )
1099 ldap_start_tls_s LDAP_P((
1100         LDAP *ld,
1101         LDAPControl **serverctrls,
1102         LDAPControl **clientctrls ));
1103
1104 /*
1105  * in messages.c:
1106  */
1107 LDAP_F( LDAPMessage * )
1108 ldap_first_message LDAP_P((
1109         LDAP *ld,
1110         LDAPMessage *chain ));
1111
1112 LDAP_F( LDAPMessage * )
1113 ldap_next_message LDAP_P((
1114         LDAP *ld,
1115         LDAPMessage *msg ));
1116
1117 LDAP_F( int )
1118 ldap_count_messages LDAP_P((
1119         LDAP *ld,
1120         LDAPMessage *chain ));
1121
1122 /*
1123  * in references.c:
1124  */
1125 LDAP_F( LDAPMessage * )
1126 ldap_first_reference LDAP_P((
1127         LDAP *ld,
1128         LDAPMessage *chain ));
1129
1130 LDAP_F( LDAPMessage * )
1131 ldap_next_reference LDAP_P((
1132         LDAP *ld,
1133         LDAPMessage *ref ));
1134
1135 LDAP_F( int )
1136 ldap_count_references LDAP_P((
1137         LDAP *ld,
1138         LDAPMessage *chain ));
1139
1140 LDAP_F( int )
1141 ldap_parse_reference LDAP_P((
1142         LDAP                    *ld,
1143         LDAPMessage             *ref,
1144         char                    ***referralsp,
1145         LDAPControl             ***serverctrls,
1146         int                             freeit));
1147
1148
1149 /*
1150  * in getentry.c:
1151  */
1152 LDAP_F( LDAPMessage * )
1153 ldap_first_entry LDAP_P((
1154         LDAP *ld,
1155         LDAPMessage *chain ));
1156
1157 LDAP_F( LDAPMessage * )
1158 ldap_next_entry LDAP_P((
1159         LDAP *ld,
1160         LDAPMessage *entry ));
1161
1162 LDAP_F( int )
1163 ldap_count_entries LDAP_P((
1164         LDAP *ld,
1165         LDAPMessage *chain ));
1166
1167 LDAP_F( int )
1168 ldap_get_entry_controls LDAP_P((
1169         LDAP                    *ld,
1170         LDAPMessage             *entry,
1171         LDAPControl             ***serverctrls));
1172
1173
1174 /*
1175  * in addentry.c
1176  */
1177 LDAP_F( LDAPMessage * )
1178 ldap_delete_result_entry LDAP_P((
1179         LDAPMessage **list,
1180         LDAPMessage *e ));
1181
1182 LDAP_F( void )
1183 ldap_add_result_entry LDAP_P((
1184         LDAPMessage **list,
1185         LDAPMessage *e ));
1186
1187
1188 /*
1189  * in getdn.c
1190  */
1191 LDAP_F( char * )
1192 ldap_get_dn LDAP_P((
1193         LDAP *ld,
1194         LDAPMessage *entry ));
1195
1196 typedef struct ldap_ava {
1197         struct berval la_attr;
1198         struct berval la_value;
1199         unsigned la_flags;
1200 #define LDAP_AVA_NULL                           0x0000U
1201 #define LDAP_AVA_STRING                         0x0001U
1202 #define LDAP_AVA_BINARY                         0x0002U
1203 #define LDAP_AVA_NONPRINTABLE           0x0004U
1204 #define LDAP_AVA_FREE_ATTR              0x0010U
1205 #define LDAP_AVA_FREE_VALUE             0x0020U
1206
1207         void *la_private;
1208 } LDAPAVA;
1209
1210 typedef LDAPAVA** LDAPRDN;
1211 typedef LDAPRDN* LDAPDN;
1212
1213 /* DN formats */
1214 #define LDAP_DN_FORMAT_LDAP                     0x0000U
1215 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1216 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1217 #define LDAP_DN_FORMAT_DCE                      0x0030U
1218 #define LDAP_DN_FORMAT_UFN                      0x0040U /* dn2str only */
1219 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1220 #define LDAP_DN_FORMAT_LBER                     0x00F0U /* for testing only */
1221 #define LDAP_DN_FORMAT_MASK                     0x00F0U
1222
1223 /* DN flags */
1224 #define LDAP_DN_PRETTY                          0x0100U
1225 #define LDAP_DN_SKIP                            0x0200U
1226 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1227 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1228 #define LDAP_DN_PEDANTIC                        0xF000U
1229
1230 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1231 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1232
1233 LDAP_F( int )
1234 ldap_bv2dn LDAP_P((
1235         struct berval *bv,
1236         LDAPDN *dn,
1237         unsigned flags ));
1238
1239 LDAP_F( int )
1240 ldap_str2dn LDAP_P((
1241         LDAP_CONST char *str,
1242         LDAPDN *dn,
1243         unsigned flags ));
1244
1245 LDAP_F( int )
1246 ldap_dn2bv LDAP_P((
1247         LDAPDN dn,
1248         struct berval *bv,
1249         unsigned flags ));
1250
1251 LDAP_F( int )
1252 ldap_dn2str LDAP_P((
1253         LDAPDN dn,
1254         char **str,
1255         unsigned flags ));
1256
1257 LDAP_F( int )
1258 ldap_bv2rdn LDAP_P((
1259         struct berval *bv,
1260         LDAPRDN *rdn,
1261         char **next,
1262         unsigned flags ));
1263
1264 LDAP_F( int )
1265 ldap_str2rdn LDAP_P((
1266         LDAP_CONST char *str,
1267         LDAPRDN *rdn,
1268         char **next,
1269         unsigned flags ));
1270
1271 LDAP_F( int )
1272 ldap_rdn2bv LDAP_P((
1273         LDAPRDN rdn,
1274         struct berval *bv,
1275         unsigned flags ));
1276
1277 LDAP_F( int )
1278 ldap_rdn2str LDAP_P((
1279         LDAPRDN rdn,
1280         char **str,
1281         unsigned flags ));
1282
1283 LDAP_F( int )
1284 ldap_dn_normalize LDAP_P((
1285         LDAP_CONST char *in, unsigned iflags,
1286         char **out, unsigned oflags ));
1287
1288 LDAP_F( char * )
1289 ldap_dn2ufn LDAP_P(( /* deprecated */
1290         LDAP_CONST char *dn ));
1291
1292 LDAP_F( char ** )
1293 ldap_explode_dn LDAP_P(( /* deprecated */
1294         LDAP_CONST char *dn,
1295         int notypes ));
1296
1297 LDAP_F( char ** )
1298 ldap_explode_rdn LDAP_P(( /* deprecated */
1299         LDAP_CONST char *rdn,
1300         int notypes ));
1301
1302 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1303
1304 LDAP_F( int )
1305 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1306         LDAPDN_rewrite_func *func, unsigned flags ));
1307
1308 LDAP_F( char * )
1309 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1310
1311 LDAP_F( char * )
1312 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1313
1314 LDAP_F( char * )
1315 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1316
1317 LDAP_F( int )
1318 ldap_get_dn_ber LDAP_P((
1319         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1320
1321 LDAP_F( int )
1322 ldap_get_attribute_ber LDAP_P((
1323         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1324         struct berval **vals ));
1325
1326 /*
1327  * in getattr.c
1328  */
1329 LDAP_F( char * )
1330 ldap_first_attribute LDAP_P((
1331         LDAP *ld,
1332         LDAPMessage *entry,
1333         BerElement **ber ));
1334
1335 LDAP_F( char * )
1336 ldap_next_attribute LDAP_P((
1337         LDAP *ld,
1338         LDAPMessage *entry,
1339         BerElement *ber ));
1340
1341
1342 /*
1343  * in getvalues.c
1344  */
1345 LDAP_F( struct berval ** )
1346 ldap_get_values_len LDAP_P((
1347         LDAP *ld,
1348         LDAPMessage *entry,
1349         LDAP_CONST char *target ));
1350
1351 LDAP_F( int )
1352 ldap_count_values_len LDAP_P((
1353         struct berval **vals ));
1354
1355 LDAP_F( void )
1356 ldap_value_free_len LDAP_P((
1357         struct berval **vals ));
1358
1359 LDAP_F( char ** )
1360 ldap_get_values LDAP_P((        /* deprecated */
1361         LDAP *ld,
1362         LDAPMessage *entry,
1363         LDAP_CONST char *target ));
1364
1365 LDAP_F( int )
1366 ldap_count_values LDAP_P((      /* deprecated */
1367         char **vals ));
1368
1369 LDAP_F( void )
1370 ldap_value_free LDAP_P((        /* deprecated */
1371         char **vals ));
1372
1373 /*
1374  * in result.c:
1375  */
1376 LDAP_F( int )
1377 ldap_result LDAP_P((
1378         LDAP *ld,
1379         int msgid,
1380         int all,
1381         struct timeval *timeout,
1382         LDAPMessage **result ));
1383
1384 LDAP_F( int )
1385 ldap_msgtype LDAP_P((
1386         LDAPMessage *lm ));
1387
1388 LDAP_F( int )
1389 ldap_msgid   LDAP_P((
1390         LDAPMessage *lm ));
1391
1392 LDAP_F( int )
1393 ldap_msgfree LDAP_P((
1394         LDAPMessage *lm ));
1395
1396 LDAP_F( int )
1397 ldap_msgdelete LDAP_P((
1398         LDAP *ld,
1399         int msgid ));
1400
1401
1402 /*
1403  * in search.c:
1404  */
1405 LDAP_F( int )
1406 ldap_search_ext LDAP_P((
1407         LDAP                    *ld,
1408         LDAP_CONST char *base,
1409         int                             scope,
1410         LDAP_CONST char *filter,
1411         char                    **attrs,
1412         int                             attrsonly,
1413         LDAPControl             **serverctrls,
1414         LDAPControl             **clientctrls,
1415         struct timeval  *timeout,
1416         int                             sizelimit,
1417         int                             *msgidp ));
1418
1419 LDAP_F( int )
1420 ldap_search_ext_s LDAP_P((
1421         LDAP                    *ld,
1422         LDAP_CONST char *base,
1423         int                             scope,
1424         LDAP_CONST char *filter,
1425         char                    **attrs,
1426         int                             attrsonly,
1427         LDAPControl             **serverctrls,
1428         LDAPControl             **clientctrls,
1429         struct timeval  *timeout,
1430         int                             sizelimit,
1431         LDAPMessage             **res ));
1432
1433 LDAP_F( int )
1434 ldap_search LDAP_P((    /* deprecated */
1435         LDAP *ld,
1436         LDAP_CONST char *base,
1437         int scope,
1438         LDAP_CONST char *filter,
1439         char **attrs,
1440         int attrsonly ));
1441
1442 LDAP_F( int )
1443 ldap_search_s LDAP_P((  /* deprecated */
1444         LDAP *ld,
1445         LDAP_CONST char *base,
1446         int scope,
1447         LDAP_CONST char *filter,
1448         char **attrs,
1449         int attrsonly,
1450         LDAPMessage **res ));
1451
1452 LDAP_F( int )
1453 ldap_search_st LDAP_P(( /* deprecated */
1454         LDAP *ld,
1455         LDAP_CONST char *base,
1456         int scope,
1457         LDAP_CONST char *filter,
1458     char **attrs,
1459         int attrsonly,
1460         struct timeval *timeout,
1461         LDAPMessage **res ));
1462
1463 /*
1464  * in unbind.c
1465  */
1466 LDAP_F( int )
1467 ldap_unbind LDAP_P(( /* deprecated */
1468         LDAP *ld ));
1469
1470 LDAP_F( int )
1471 ldap_unbind_s LDAP_P(( /* deprecated */
1472         LDAP *ld ));
1473
1474 LDAP_F( int )
1475 ldap_unbind_ext LDAP_P((
1476         LDAP                    *ld,
1477         LDAPControl             **serverctrls,
1478         LDAPControl             **clientctrls));
1479
1480 LDAP_F( int )
1481 ldap_unbind_ext_s LDAP_P((
1482         LDAP                    *ld,
1483         LDAPControl             **serverctrls,
1484         LDAPControl             **clientctrls));
1485
1486 /*
1487  * in filter.c
1488  */
1489 LDAP_F( int )
1490 ldap_put_vrFilter LDAP_P((
1491         BerElement *ber,
1492         const char *vrf ));
1493
1494 /*
1495  * in free.c
1496  */
1497
1498 LDAP_F( void * )
1499 ldap_memalloc LDAP_P((
1500         ber_len_t s ));
1501
1502 LDAP_F( void * )
1503 ldap_memrealloc LDAP_P((
1504         void* p,
1505         ber_len_t s ));
1506
1507 LDAP_F( void * )
1508 ldap_memcalloc LDAP_P((
1509         ber_len_t n,
1510         ber_len_t s ));
1511
1512 LDAP_F( void )
1513 ldap_memfree LDAP_P((
1514         void* p ));
1515
1516 LDAP_F( void )
1517 ldap_memvfree LDAP_P((
1518         void** v ));
1519
1520 LDAP_F( char * )
1521 ldap_strdup LDAP_P((
1522         LDAP_CONST char * ));
1523
1524 LDAP_F( void )
1525 ldap_mods_free LDAP_P((
1526         LDAPMod **mods,
1527         int freemods ));
1528
1529
1530 /*
1531  * in sort.c (deprecated)
1532  */
1533 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1534         LDAP_CONST char *left,
1535         LDAP_CONST char *right ));
1536
1537 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1538         LDAP_CONST void *left,
1539         LDAP_CONST void *right ));
1540
1541 LDAP_F( int )   /* deprecated */
1542 ldap_sort_entries LDAP_P(( LDAP *ld,
1543         LDAPMessage **chain,
1544         LDAP_CONST char *attr,
1545         LDAP_SORT_AD_CMP_PROC *cmp ));
1546
1547 LDAP_F( int )   /* deprecated */
1548 ldap_sort_values LDAP_P((
1549         LDAP *ld,
1550         char **vals,
1551         LDAP_SORT_AV_CMP_PROC *cmp ));
1552
1553 LDAP_F( int ) /* deprecated */
1554 ldap_sort_strcasecmp LDAP_P((
1555         LDAP_CONST void *a,
1556         LDAP_CONST void *b ));
1557
1558 /*
1559  * in url.c
1560  */
1561 LDAP_F( int )
1562 ldap_is_ldap_url LDAP_P((
1563         LDAP_CONST char *url ));
1564
1565 LDAP_F( int )
1566 ldap_is_ldaps_url LDAP_P((
1567         LDAP_CONST char *url ));
1568
1569 LDAP_F( int )
1570 ldap_is_ldapi_url LDAP_P((
1571         LDAP_CONST char *url ));
1572
1573 LDAP_F( int )
1574 ldap_url_parse LDAP_P((
1575         LDAP_CONST char *url,
1576         LDAPURLDesc **ludpp ));
1577
1578 LDAP_F( char * )
1579 ldap_url_desc2str LDAP_P((
1580         LDAPURLDesc *ludp ));
1581
1582 LDAP_F( void )
1583 ldap_free_urldesc LDAP_P((
1584         LDAPURLDesc *ludp ));
1585
1586
1587 /*
1588  * LDAP Server Side Sort
1589  *      in sortctrl.c
1590  */
1591 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1592
1593 /* structure for a sort-key */
1594 typedef struct ldapsortkey {
1595         char *  attributeType;
1596         char *  orderingRule;
1597         int     reverseOrder;
1598 } LDAPSortKey;
1599
1600 LDAP_F( int )
1601 ldap_create_sort_keylist LDAP_P((
1602         LDAPSortKey ***sortKeyList,
1603         char        *keyString ));
1604
1605 LDAP_F( void )
1606 ldap_free_sort_keylist LDAP_P((
1607         LDAPSortKey **sortkeylist ));
1608
1609 LDAP_F( int )
1610 ldap_create_sort_control LDAP_P((
1611         LDAP *ld,
1612         LDAPSortKey **keyList,
1613         int ctl_iscritical,
1614         LDAPControl **ctrlp ));
1615
1616 LDAP_F( int )
1617 ldap_parse_sort_control LDAP_P((
1618         LDAP           *ld,
1619         LDAPControl    **ctrlp,
1620         unsigned long  *result,
1621         char           **attribute ));
1622
1623
1624 /*
1625  * LDAP Virtual List View
1626  *      in vlvctrl.c
1627  */
1628 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1629
1630 /* structure for virtual list */
1631 typedef struct ldapvlvinfo {
1632         int             ldvlv_version;
1633     unsigned long   ldvlv_before_count;
1634     unsigned long   ldvlv_after_count;
1635     unsigned long   ldvlv_offset;
1636     unsigned long   ldvlv_count;
1637     struct berval *     ldvlv_attrvalue;
1638     struct berval *     ldvlv_context;
1639     void *                      ldvlv_extradata;
1640 } LDAPVLVInfo;
1641
1642 LDAP_F( int )
1643 ldap_create_vlv_control LDAP_P((
1644         LDAP *ld,
1645         LDAPVLVInfo *ldvlistp,
1646         LDAPControl **ctrlp ));
1647
1648 LDAP_F( int )
1649 ldap_parse_vlv_control LDAP_P((
1650         LDAP          *ld,
1651         LDAPControl   **ctrls,
1652         unsigned long *target_posp,
1653         unsigned long *list_countp,
1654         struct berval **contextp,
1655         int           *errcodep ));
1656
1657 /*
1658  * LDAP Who Am I?
1659  *      in whoami.c
1660  */
1661
1662 LDAP_F( int )
1663 ldap_parse_whoami LDAP_P((
1664         LDAP *ld,
1665         LDAPMessage *res,
1666         struct berval **authzid ));
1667
1668 LDAP_F( int )
1669 ldap_whoami LDAP_P(( LDAP *ld,
1670         LDAPControl             **sctrls,
1671         LDAPControl             **cctrls,
1672         int                             *msgidp ));
1673
1674 LDAP_F( int )
1675 ldap_whoami_s LDAP_P((
1676         LDAP *ld,
1677         struct berval **authzid,
1678         LDAPControl **sctrls,
1679         LDAPControl **cctrls ));
1680
1681 /*
1682  * LDAP Password Modify
1683  *      in passwd.c
1684  */
1685
1686 LDAP_F( int )
1687 ldap_parse_passwd LDAP_P((
1688         LDAP *ld,
1689         LDAPMessage *res,
1690         struct berval *newpasswd ));
1691
1692 LDAP_F( int )
1693 ldap_passwd LDAP_P(( LDAP *ld,
1694         struct berval   *user,
1695         struct berval   *oldpw,
1696         struct berval   *newpw,
1697         LDAPControl             **sctrls,
1698         LDAPControl             **cctrls,
1699         int                             *msgidp ));
1700
1701 LDAP_F( int )
1702 ldap_passwd_s LDAP_P((
1703         LDAP *ld,
1704         struct berval   *user,
1705         struct berval   *oldpw,
1706         struct berval   *newpw,
1707         struct berval *newpasswd,
1708         LDAPControl **sctrls,
1709         LDAPControl **cctrls ));
1710
1711
1712 LDAP_END_DECL
1713 #endif /* _LDAP_H */