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