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