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

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