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

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