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