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

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