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

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