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

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