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

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