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

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