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

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