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