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 #define LDAP_SERVER_DOWN                0x51
 398 #define LDAP_LOCAL_ERROR                0x52
 399 #define LDAP_ENCODING_ERROR             0x53
 400 #define LDAP_DECODING_ERROR             0x54
 401 #define LDAP_TIMEOUT                    0x55
 402 #define LDAP_AUTH_UNKNOWN               0x56
 403 #define LDAP_FILTER_ERROR               0x57
 404 #define LDAP_USER_CANCELLED             0x58
 405 #define LDAP_PARAM_ERROR                0x59
 406 #define LDAP_NO_MEMORY                  0x5a
 407
 408 /* not technically reserved for APIs */
 409 #define LDAP_CONNECT_ERROR                              0x5b    /* draft-ietf-ldap-c-api-xx */
 410 #define LDAP_NOT_SUPPORTED                              0x5c    /* draft-ietf-ldap-c-api-xx */
 411 #define LDAP_CONTROL_NOT_FOUND                  0x5d    /* draft-ietf-ldap-c-api-xx */
 412 #define LDAP_NO_RESULTS_RETURNED                0x5e    /* draft-ietf-ldap-c-api-xx */
 413 #define LDAP_MORE_RESULTS_TO_RETURN             0x5f    /* draft-ietf-ldap-c-api-xx */
 414 #define LDAP_CLIENT_LOOP                                0x60    /* draft-ietf-ldap-c-api-xx */
 415 #define LDAP_REFERRAL_LIMIT_EXCEEDED    0x61    /* draft-ietf-ldap-c-api-xx */
 416
 417 /*
 418  * This structure represents both ldap messages and ldap responses.
 419  * These are really the same, except in the case of search responses,
 420  * where a response has multiple messages.
 421  */
 422
 423 typedef struct ldapmsg LDAPMessage;
 424
 425 /* for modifications */
 426 typedef struct ldapmod {
 427         int             mod_op;
 428
 429 #define LDAP_MOD_ADD            ((ber_int_t) 0x0000)
 430 #define LDAP_MOD_DELETE         ((ber_int_t) 0x0001)
 431 #define LDAP_MOD_REPLACE        ((ber_int_t) 0x0002)
 432 #define LDAP_MOD_BVALUES        ((ber_int_t) 0x0080)
 433 /* IMPORTANT: do not use code 0x1000 (or above),
 434  * it is used internally by the backends!
 435  * (see ldap/servers/slapd/slap.h)
 436  */
 437
 438         char            *mod_type;
 439         union mod_vals_u {
 440                 char            **modv_strvals;
 441                 struct berval   **modv_bvals;
 442         } mod_vals;
 443 #define mod_values      mod_vals.modv_strvals
 444 #define mod_bvalues     mod_vals.modv_bvals
 445 } LDAPMod;
 446
 447 /*
 448  * structures for ldap getfilter routines
 449  */
 450
 451 typedef struct ldap_filt_info {
 452         char                    *lfi_filter;
 453         char                    *lfi_desc;
 454         int                     lfi_scope;
 455         int                     lfi_isexact;
 456         struct ldap_filt_info   *lfi_next;
 457 } LDAPFiltInfo;
 458
 459 typedef struct ldap_filt_list {
 460     char                        *lfl_tag;
 461     char                        *lfl_pattern;
 462     char                        *lfl_delims;
 463     LDAPFiltInfo                *lfl_ilist;
 464     struct ldap_filt_list       *lfl_next;
 465 } LDAPFiltList;
 466
 467
 468 #define LDAP_FILT_MAXSIZ        1024
 469
 470 typedef struct ldap_filt_desc {
 471         LDAPFiltList            *lfd_filtlist;
 472         LDAPFiltInfo            *lfd_curfip;
 473         LDAPFiltInfo            lfd_retfi;
 474         char                    lfd_filter[ LDAP_FILT_MAXSIZ ];
 475         char                    *lfd_curval;
 476         char                    *lfd_curvalcopy;
 477         char                    **lfd_curvalwords;
 478         char                    *lfd_filtprefix;
 479         char                    *lfd_filtsuffix;
 480 } LDAPFiltDesc;
 481
 482
 483 /*
 484  * structure representing an ldap session which can
 485  * encompass connections to multiple servers (in the
 486  * face of referrals).
 487  */
 488 typedef struct ldap LDAP;
 489
 490 #define LDAP_DEREF_NEVER        0x00
 491 #define LDAP_DEREF_SEARCHING    0x01
 492 #define LDAP_DEREF_FINDING      0x02
 493 #define LDAP_DEREF_ALWAYS       0x03
 494
 495 #define LDAP_NO_LIMIT           0
 496
 497 /* how many messages to retrieve results for */
 498 #define LDAP_MSG_ONE            0x00
 499 #define LDAP_MSG_ALL            0x01
 500 #define LDAP_MSG_RECEIVED       0x02
 501
 502 /*
 503  * structure for ldap friendly mapping routines
 504  */
 505
 506 typedef struct ldap_friendly {
 507         char    *lf_unfriendly;
 508         char    *lf_friendly;
 509 } LDAPFriendlyMap;
 510
 511 /*
 512  * types for ldap URL handling
 513  */
 514 typedef struct ldap_url_desc {
 515         struct ldap_url_desc *lud_next;
 516         char    *lud_scheme;
 517         char    *lud_host;
 518         int             lud_port;
 519         char    *lud_dn;
 520         char    **lud_attrs;
 521         int             lud_scope;
 522         char    *lud_filter;
 523         char    **lud_exts;
 524         int             lud_crit_exts;
 525 } LDAPURLDesc;
 526
 527 #define LDAP_URL_SUCCESS                0x00    /* Success */
 528 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 529 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 530
 531 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 532 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 533 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 534 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 535 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 536 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 537 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 538 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 539
 540 /*
 541  * The API draft spec says we should declare (or cause to be declared)
 542  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 543  */
 544 struct timeval;
 545
 546 /*
 547  * in options.c:
 548  */
 549 LDAP_F( int )
 550 ldap_get_option LDAP_P((
 551         LDAP *ld,
 552         int option,
 553         void *outvalue));
 554
 555 LDAP_F( int )
 556 ldap_set_option LDAP_P((
 557         LDAP *ld,
 558         int option,
 559         LDAP_CONST void *invalue));
 560
 561 /* V3 REBIND Function Callback Prototype */
 562 typedef int (LDAP_REBIND_PROC) LDAP_P((
 563         LDAP *ld, LDAP_CONST char *url, int request, ber_int_t msgid ));
 564
 565 LDAP_F( int )
 566 ldap_set_rebind_proc LDAP_P((
 567         LDAP *ld,
 568         LDAP_REBIND_PROC *ldap_proc));
 569
 570 /*
 571  * in controls.c:
 572  */
 573 LDAP_F( int )
 574 ldap_create_control LDAP_P((
 575         const char *requestOID,
 576         BerElement *ber,
 577         int iscritical,
 578         LDAPControl **ctrlp ));
 579
 580 LDAP_F( void )
 581 ldap_control_free LDAP_P((
 582         LDAPControl *ctrl ));
 583
 584 LDAP_F( void )
 585 ldap_controls_free LDAP_P((
 586         LDAPControl **ctrls ));
 587
 588 /*
 589  * in dnssrv.c:
 590  */
 591 LDAP_F( int )
 592 ldap_domain2dn LDAP_P((
 593         LDAP_CONST char* domain,
 594         char** dn ));
 595
 596 LDAP_F( int )
 597 ldap_dn2domain LDAP_P((
 598         LDAP_CONST char* dn,
 599         char** domain ));
 600
 601 LDAP_F( int )
 602 ldap_domain2hostlist LDAP_P((
 603         LDAP_CONST char *domain,
 604         char** hostlist ));
 605
 606 /*
 607  * in extended.c:
 608  */
 609 LDAP_F( int )
 610 ldap_extended_operation LDAP_P((
 611         LDAP                    *ld,
 612         LDAP_CONST char *reqoid,
 613         struct berval   *reqdata,
 614         LDAPControl             **serverctrls,
 615         LDAPControl             **clientctrls,
 616         int                             *msgidp ));
 617
 618 LDAP_F( int )
 619 ldap_extended_operation_s LDAP_P((
 620         LDAP                    *ld,
 621         LDAP_CONST char *reqoid,
 622         struct berval   *reqdata,
 623         LDAPControl             **serverctrls,
 624         LDAPControl             **clientctrls,
 625         char                    **retoidp,
 626         struct berval   **retdatap ));
 627
 628 LDAP_F( int )
 629 ldap_parse_extended_result LDAP_P((
 630         LDAP                    *ld,
 631         LDAPMessage             *res,
 632         char                    **retoidp,
 633         struct berval   **retdatap,
 634         int                             freeit ));
 635
 636 LDAP_F( int )
 637 ldap_parse_extended_partial LDAP_P((
 638         LDAP                    *ld,
 639         LDAPMessage             *res,
 640         char                    **retoidp,
 641         struct berval   **retdatap,
 642         LDAPControl             ***serverctrls,
 643         int                             freeit ));
 644
 645 /*
 646  * in abandon.c:
 647  */
 648 LDAP_F( int )
 649 ldap_abandon_ext LDAP_P((
 650         LDAP                    *ld,
 651         int                             msgid,
 652         LDAPControl             **serverctrls,
 653         LDAPControl             **clientctrls ));
 654
 655 LDAP_F( int )
 656 ldap_abandon LDAP_P((   /* deprecated */
 657         LDAP *ld,
 658         int msgid ));
 659
 660
 661 /*
 662  * in add.c:
 663  */
 664 LDAP_F( int )
 665 ldap_add_ext LDAP_P((
 666         LDAP                    *ld,
 667         LDAP_CONST char *dn,
 668         LDAPMod                 **attrs,
 669         LDAPControl             **serverctrls,
 670         LDAPControl             **clientctrls,
 671         int                     *msgidp ));
 672
 673 LDAP_F( int )
 674 ldap_add_ext_s LDAP_P((
 675         LDAP                    *ld,
 676         LDAP_CONST char *dn,
 677         LDAPMod                 **attrs,
 678         LDAPControl             **serverctrls,
 679         LDAPControl             **clientctrls ));
 680
 681 LDAP_F( int )
 682 ldap_add LDAP_P((       /* deprecated */
 683         LDAP *ld,
 684         LDAP_CONST char *dn,
 685         LDAPMod **attrs ));
 686
 687 LDAP_F( int )
 688 ldap_add_s LDAP_P((     /* deprecated */
 689         LDAP *ld,
 690         LDAP_CONST char *dn,
 691         LDAPMod **attrs ));
 692
 693
 694 /*
 695  * in sasl.c:
 696  */
 697 LDAP_F( int )
 698 ldap_sasl_bind LDAP_P((
 699         LDAP                    *ld,
 700         LDAP_CONST char *dn,
 701         LDAP_CONST char *mechanism,
 702         struct berval   *cred,
 703         LDAPControl             **serverctrls,
 704         LDAPControl             **clientctrls,
 705         int                             *msgidp ));
 706
 707 /* Interaction flags (should be passed about in a control)
 708  *  Automatic (default): use defaults, prompt otherwise
 709  *  Interactive: prompt always
 710  *  Quiet: never prompt
 711  */
 712 #define LDAP_SASL_AUTOMATIC             0U
 713 #define LDAP_SASL_INTERACTIVE   1U
 714 #define LDAP_SASL_QUIET                 2U
 715
 716 /*
 717  * V3 SASL Interaction Function Callback Prototype
 718  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
 719  *  should likely passed in a control (and provided controls)
 720  */
 721 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
 722         LDAP *ld, unsigned flags, void* defaults, void *interact ));
 723
 724 LDAP_F( int )
 725 ldap_sasl_interactive_bind_s LDAP_P((
 726         LDAP *ld,
 727         LDAP_CONST char *dn, /* usually NULL */
 728         LDAP_CONST char *saslMechanism,
 729         LDAPControl **serverControls,
 730         LDAPControl **clientControls,
 731
 732         /* should be client controls */
 733         unsigned flags,
 734         LDAP_SASL_INTERACT_PROC *proc,
 735         void *defaults ));
 736
 737 LDAP_F( int )
 738 ldap_sasl_bind_s LDAP_P((
 739         LDAP                    *ld,
 740         LDAP_CONST char *dn,
 741         LDAP_CONST char *mechanism,
 742         struct berval   *cred,
 743         LDAPControl             **serverctrls,
 744         LDAPControl             **clientctrls,
 745         struct berval   **servercredp ));
 746
 747 LDAP_F( int )
 748 ldap_parse_sasl_bind_result LDAP_P((
 749         LDAP                    *ld,
 750         LDAPMessage             *res,
 751         struct berval   **servercredp,
 752         int                             freeit ));
 753
 754 /*
 755  * in bind.c:
 756  *      (deprecated)
 757  */
 758 LDAP_F( int )
 759 ldap_bind LDAP_P((      /* deprecated */
 760         LDAP *ld,
 761         LDAP_CONST char *who,
 762         LDAP_CONST char *passwd,
 763         int authmethod ));
 764
 765 LDAP_F( int )
 766 ldap_bind_s LDAP_P((    /* deprecated */
 767         LDAP *ld,
 768         LDAP_CONST char *who,
 769         LDAP_CONST char *cred,
 770         int authmethod ));
 771
 772 /*
 773  * in sbind.c:
 774  */
 775 LDAP_F( int )
 776 ldap_simple_bind LDAP_P((
 777         LDAP *ld,
 778         LDAP_CONST char *who,
 779         LDAP_CONST char *passwd ));
 780
 781 LDAP_F( int )
 782 ldap_simple_bind_s LDAP_P((
 783         LDAP *ld,
 784         LDAP_CONST char *who,
 785         LDAP_CONST char *passwd ));
 786
 787
 788 /*
 789  * in kbind.c:
 790  *      (deprecated)
 791  */
 792 LDAP_F( int )
 793 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
 794         LDAP *ld,
 795         LDAP_CONST char *who ));
 796
 797 LDAP_F( int )
 798 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
 799         LDAP *ld,
 800         LDAP_CONST char *who ));
 801
 802 LDAP_F( int )
 803 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
 804         LDAP *ld,
 805         LDAP_CONST char *who ));
 806
 807 LDAP_F( int )
 808 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
 809         LDAP *ld,
 810         LDAP_CONST char *who ));
 811
 812 LDAP_F( int )
 813 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
 814         LDAP *ld,
 815         LDAP_CONST char *who ));
 816
 817 /*
 818  * in cache.c
 819  * (deprecated)
 820  */
 821 LDAP_F( int )
 822 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
 823
 824 LDAP_F( void )
 825 ldap_disable_cache LDAP_P(( LDAP *ld ));
 826
 827 LDAP_F( void )
 828 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
 829
 830 LDAP_F( void )
 831 ldap_destroy_cache LDAP_P(( LDAP *ld ));
 832
 833 LDAP_F( void )
 834 ldap_flush_cache LDAP_P(( LDAP *ld ));
 835
 836 LDAP_F( void )
 837 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
 838
 839 LDAP_F( void )
 840 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
 841
 842
 843 /*
 844  * in compare.c:
 845  */
 846 LDAP_F( int )
 847 ldap_compare_ext LDAP_P((
 848         LDAP                    *ld,
 849         LDAP_CONST char *dn,
 850         LDAP_CONST char *attr,
 851         struct berval   *bvalue,
 852         LDAPControl             **serverctrls,
 853         LDAPControl             **clientctrls,
 854         int                     *msgidp ));
 855
 856 LDAP_F( int )
 857 ldap_compare_ext_s LDAP_P((
 858         LDAP                    *ld,
 859         LDAP_CONST char *dn,
 860         LDAP_CONST char *attr,
 861         struct berval   *bvalue,
 862         LDAPControl             **serverctrls,
 863         LDAPControl             **clientctrls ));
 864
 865 LDAP_F( int )
 866 ldap_compare LDAP_P((   /* deprecated */
 867         LDAP *ld,
 868         LDAP_CONST char *dn,
 869         LDAP_CONST char *attr,
 870         LDAP_CONST char *value ));
 871
 872 LDAP_F( int )
 873 ldap_compare_s LDAP_P(( /* deprecated */
 874         LDAP *ld,
 875         LDAP_CONST char *dn,
 876         LDAP_CONST char *attr,
 877         LDAP_CONST char *value ));
 878
 879
 880 /*
 881  * in delete.c:
 882  */
 883 LDAP_F( int )
 884 ldap_delete_ext LDAP_P((
 885         LDAP                    *ld,
 886         LDAP_CONST char *dn,
 887         LDAPControl             **serverctrls,
 888         LDAPControl             **clientctrls,
 889         int                     *msgidp ));
 890
 891 LDAP_F( int )
 892 ldap_delete_ext_s LDAP_P((
 893         LDAP                    *ld,
 894         LDAP_CONST char *dn,
 895         LDAPControl             **serverctrls,
 896         LDAPControl             **clientctrls ));
 897
 898 LDAP_F( int )
 899 ldap_delete LDAP_P((    /* deprecated */
 900         LDAP *ld,
 901         LDAP_CONST char *dn ));
 902
 903 LDAP_F( int )
 904 ldap_delete_s LDAP_P((  /* deprecated */
 905         LDAP *ld,
 906         LDAP_CONST char *dn ));
 907
 908
 909 /*
 910  * in error.c:
 911  */
 912 LDAP_F( int )
 913 ldap_parse_result LDAP_P((
 914         LDAP                    *ld,
 915         LDAPMessage             *res,
 916         int                             *errcodep,
 917         char                    **matcheddnp,
 918         char                    **errmsgp,
 919         char                    ***referralsp,
 920         LDAPControl             ***serverctrls,
 921         int                             freeit ));
 922
 923 LDAP_F( char *)
 924 ldap_err2string LDAP_P((
 925         int err ));
 926
 927 LDAP_F( int )
 928 ldap_result2error LDAP_P((      /* deprecated */
 929         LDAP *ld,
 930         LDAPMessage *r,
 931         int freeit ));
 932
 933 LDAP_F( void )
 934 ldap_perror LDAP_P((    /* deprecated */
 935         LDAP *ld,
 936         LDAP_CONST char *s ));
 937
 938
 939 /*
 940  * in modify.c:
 941  */
 942 LDAP_F( int )
 943 ldap_modify_ext LDAP_P((
 944         LDAP                    *ld,
 945         LDAP_CONST char *dn,
 946         LDAPMod                 **mods,
 947         LDAPControl             **serverctrls,
 948         LDAPControl             **clientctrls,
 949         int                     *msgidp ));
 950
 951 LDAP_F( int )
 952 ldap_modify_ext_s LDAP_P((
 953         LDAP                    *ld,
 954         LDAP_CONST char *dn,
 955         LDAPMod                 **mods,
 956         LDAPControl             **serverctrls,
 957         LDAPControl             **clientctrls ));
 958
 959 LDAP_F( int )
 960 ldap_modify LDAP_P((    /* deprecated */
 961         LDAP *ld,
 962         LDAP_CONST char *dn,
 963         LDAPMod **mods ));
 964
 965 LDAP_F( int )
 966 ldap_modify_s LDAP_P((  /* deprecated */
 967         LDAP *ld,
 968         LDAP_CONST char *dn,
 969         LDAPMod **mods ));
 970
 971
 972 /*
 973  * in modrdn.c:
 974  */
 975 LDAP_F( int )
 976 ldap_rename LDAP_P((
 977         LDAP *ld,
 978         LDAP_CONST char *dn,
 979         LDAP_CONST char *newrdn,
 980         LDAP_CONST char *newSuperior,
 981         int deleteoldrdn,
 982         LDAPControl **sctrls,
 983         LDAPControl **cctrls,
 984         int *msgidp ));
 985
 986 LDAP_F( int )
 987 ldap_rename_s LDAP_P((
 988         LDAP *ld,
 989         LDAP_CONST char *dn,
 990         LDAP_CONST char *newrdn,
 991         LDAP_CONST char *newSuperior,
 992         int deleteoldrdn,
 993         LDAPControl **sctrls,
 994         LDAPControl **cctrls ));
 995
 996 LDAP_F( int )
 997 ldap_rename2 LDAP_P((   /* deprecated */
 998         LDAP *ld,
 999         LDAP_CONST char *dn,
1000         LDAP_CONST char *newrdn,
1001         LDAP_CONST char *newSuperior,
1002         int deleteoldrdn ));
1003
1004 LDAP_F( int )
1005 ldap_rename2_s LDAP_P(( /* deprecated */
1006         LDAP *ld,
1007         LDAP_CONST char *dn,
1008         LDAP_CONST char *newrdn,
1009         LDAP_CONST char *newSuperior,
1010         int deleteoldrdn ));
1011
1012 LDAP_F( int )
1013 ldap_modrdn LDAP_P((    /* deprecated */
1014         LDAP *ld,
1015         LDAP_CONST char *dn,
1016         LDAP_CONST char *newrdn ));
1017
1018 LDAP_F( int )
1019 ldap_modrdn_s LDAP_P((  /* deprecated */
1020         LDAP *ld,
1021         LDAP_CONST char *dn,
1022         LDAP_CONST char *newrdn ));
1023
1024 LDAP_F( int )
1025 ldap_modrdn2 LDAP_P((   /* deprecated */
1026         LDAP *ld,
1027         LDAP_CONST char *dn,
1028         LDAP_CONST char *newrdn,
1029         int deleteoldrdn ));
1030
1031 LDAP_F( int )
1032 ldap_modrdn2_s LDAP_P(( /* deprecated */
1033         LDAP *ld,
1034         LDAP_CONST char *dn,
1035         LDAP_CONST char *newrdn,
1036         int deleteoldrdn));
1037
1038
1039 /*
1040  * in open.c:
1041  */
1042 LDAP_F( LDAP *)
1043 ldap_init LDAP_P((
1044         LDAP_CONST char *host,
1045         int port ));
1046
1047 LDAP_F( LDAP *)
1048 ldap_open LDAP_P((      /* deprecated */
1049         LDAP_CONST char *host,
1050         int port ));
1051
1052 LDAP_F( int )
1053 ldap_create LDAP_P((
1054         LDAP **ldp ));
1055
1056 LDAP_F( int )
1057 ldap_initialize LDAP_P((
1058         LDAP **ldp,
1059         LDAP_CONST char *url ));
1060
1061 LDAP_F( int )
1062 ldap_start_tls_s LDAP_P((
1063         LDAP *ld,
1064         LDAPControl **serverctrls,
1065         LDAPControl **clientctrls ));
1066
1067 /*
1068  * in messages.c:
1069  */
1070 LDAP_F( LDAPMessage *)
1071 ldap_first_message LDAP_P((
1072         LDAP *ld,
1073         LDAPMessage *chain ));
1074
1075 LDAP_F( LDAPMessage *)
1076 ldap_next_message LDAP_P((
1077         LDAP *ld,
1078         LDAPMessage *msg ));
1079
1080 LDAP_F( int )
1081 ldap_count_messages LDAP_P((
1082         LDAP *ld,
1083         LDAPMessage *chain ));
1084
1085
1086 /*
1087  * in references.c:
1088  */
1089 LDAP_F( LDAPMessage *)
1090 ldap_first_reference LDAP_P((
1091         LDAP *ld,
1092         LDAPMessage *chain ));
1093
1094 LDAP_F( LDAPMessage *)
1095 ldap_next_reference LDAP_P((
1096         LDAP *ld,
1097         LDAPMessage *ref ));
1098
1099 LDAP_F( int )
1100 ldap_count_references LDAP_P((
1101         LDAP *ld,
1102         LDAPMessage *chain ));
1103
1104 LDAP_F( int )
1105 ldap_parse_reference LDAP_P((
1106         LDAP                    *ld,
1107         LDAPMessage             *ref,
1108         char                    ***referralsp,
1109         LDAPControl             ***serverctrls,
1110         int                             freeit));
1111
1112
1113 /*
1114  * in getentry.c:
1115  */
1116 LDAP_F( LDAPMessage *)
1117 ldap_first_entry LDAP_P((
1118         LDAP *ld,
1119         LDAPMessage *chain ));
1120
1121 LDAP_F( LDAPMessage *)
1122 ldap_next_entry LDAP_P((
1123         LDAP *ld,
1124         LDAPMessage *entry ));
1125
1126 LDAP_F( int )
1127 ldap_count_entries LDAP_P((
1128         LDAP *ld,
1129         LDAPMessage *chain ));
1130
1131 LDAP_F( int )
1132 ldap_get_entry_controls LDAP_P((
1133         LDAP                    *ld,
1134         LDAPMessage             *entry,
1135         LDAPControl             ***serverctrls));
1136
1137
1138 /*
1139  * in addentry.c
1140  */
1141 LDAP_F( LDAPMessage *)
1142 ldap_delete_result_entry LDAP_P((
1143         LDAPMessage **list,
1144         LDAPMessage *e ));
1145
1146 LDAP_F( void )
1147 ldap_add_result_entry LDAP_P((
1148         LDAPMessage **list,
1149         LDAPMessage *e ));
1150
1151
1152 /*
1153  * in getdn.c
1154  */
1155 LDAP_F( char * )
1156 ldap_get_dn LDAP_P((
1157         LDAP *ld,
1158         LDAPMessage *entry ));
1159
1160 LDAP_F( char * )
1161 ldap_dn2ufn LDAP_P((
1162         LDAP_CONST char *dn ));
1163
1164 LDAP_F( char ** )
1165 ldap_explode_dn LDAP_P((
1166         LDAP_CONST char *dn,
1167         int notypes ));
1168
1169 LDAP_F( char ** )
1170 ldap_explode_rdn LDAP_P((
1171         LDAP_CONST char *rdn,
1172         int notypes ));
1173
1174 LDAP_F( char * )
1175 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1176
1177 LDAP_F( char * )
1178 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1179
1180 /*
1181  * in getattr.c
1182  */
1183 LDAP_F( char *)
1184 ldap_first_attribute LDAP_P((
1185         LDAP *ld,
1186         LDAPMessage *entry,
1187         BerElement **ber ));
1188
1189 LDAP_F( char *)
1190 ldap_next_attribute LDAP_P((
1191         LDAP *ld,
1192         LDAPMessage *entry,
1193         BerElement *ber ));
1194
1195
1196 /*
1197  * in getvalues.c
1198  */
1199 LDAP_F( char **)
1200 ldap_get_values LDAP_P((
1201         LDAP *ld,
1202         LDAPMessage *entry,
1203         LDAP_CONST char *target ));
1204
1205 LDAP_F( struct berval **)
1206 ldap_get_values_len LDAP_P((
1207         LDAP *ld,
1208         LDAPMessage *entry,
1209         LDAP_CONST char *target ));
1210
1211 LDAP_F( int )
1212 ldap_count_values LDAP_P((
1213         char **vals ));
1214
1215 LDAP_F( int )
1216 ldap_count_values_len LDAP_P((
1217         struct berval **vals ));
1218
1219 LDAP_F( void )
1220 ldap_value_free LDAP_P((
1221         char **vals ));
1222
1223 LDAP_F( void )
1224 ldap_value_free_len LDAP_P((
1225         struct berval **vals ));
1226
1227 /*
1228  * in result.c:
1229  */
1230 LDAP_F( int )
1231 ldap_result LDAP_P((
1232         LDAP *ld,
1233         int msgid,
1234         int all,
1235         struct timeval *timeout,
1236         LDAPMessage **result ));
1237
1238 LDAP_F( int )
1239 ldap_msgtype LDAP_P((
1240         LDAPMessage *lm ));
1241
1242 LDAP_F( int )
1243 ldap_msgid   LDAP_P((
1244         LDAPMessage *lm ));
1245
1246 LDAP_F( int )
1247 ldap_msgfree LDAP_P((
1248         LDAPMessage *lm ));
1249
1250 LDAP_F( int )
1251 ldap_msgdelete LDAP_P((
1252         LDAP *ld,
1253         int msgid ));
1254
1255
1256 /*
1257  * in search.c:
1258  */
1259 LDAP_F( int )
1260 ldap_search_ext LDAP_P((
1261         LDAP                    *ld,
1262         LDAP_CONST char *base,
1263         int                             scope,
1264         LDAP_CONST char *filter,
1265         char                    **attrs,
1266         int                             attrsonly,
1267         LDAPControl             **serverctrls,
1268         LDAPControl             **clientctrls,
1269         struct timeval  *timeout,
1270         int                             sizelimit,
1271         int                             *msgidp ));
1272
1273 LDAP_F( int )
1274 ldap_search_ext_s LDAP_P((
1275         LDAP                    *ld,
1276         LDAP_CONST char *base,
1277         int                             scope,
1278         LDAP_CONST char *filter,
1279         char                    **attrs,
1280         int                             attrsonly,
1281         LDAPControl             **serverctrls,
1282         LDAPControl             **clientctrls,
1283         struct timeval  *timeout,
1284         int                             sizelimit,
1285         LDAPMessage             **res ));
1286
1287 LDAP_F( int )
1288 ldap_search LDAP_P((    /* deprecated */
1289         LDAP *ld,
1290         LDAP_CONST char *base,
1291         int scope,
1292         LDAP_CONST char *filter,
1293         char **attrs,
1294         int attrsonly ));
1295
1296 LDAP_F( int )
1297 ldap_search_s LDAP_P((  /* deprecated */
1298         LDAP *ld,
1299         LDAP_CONST char *base,
1300         int scope,
1301         LDAP_CONST char *filter,
1302         char **attrs,
1303         int attrsonly,
1304         LDAPMessage **res ));
1305
1306 LDAP_F( int )
1307 ldap_search_st LDAP_P(( /* deprecated */
1308         LDAP *ld,
1309         LDAP_CONST char *base,
1310         int scope,
1311         LDAP_CONST char *filter,
1312     char **attrs,
1313         int attrsonly,
1314         struct timeval *timeout,
1315         LDAPMessage **res ));
1316
1317 #ifdef LDAP_UFN
1318 /*
1319  * in ufn.c
1320  *      (deprecated)
1321  */
1322 LDAP_F( int )
1323 ldap_ufn_search_c LDAP_P(( /* deprecated */
1324         LDAP *ld,
1325         LDAP_CONST char *ufn,
1326         char **attrs,
1327         int attrsonly,
1328         LDAPMessage **res,
1329         int (*cancelproc)( void *cl ),
1330         void *cancelparm ));
1331
1332 LDAP_F( int )
1333 ldap_ufn_search_ct LDAP_P(( /* deprecated */
1334         LDAP *ld,
1335         LDAP_CONST char *ufn,
1336         char **attrs,
1337         int attrsonly,
1338         LDAPMessage **res,
1339         int (*cancelproc)( void *cl ),
1340         void *cancelparm,
1341         char *tag1,
1342         char *tag2,
1343         char *tag3 ));
1344
1345 LDAP_F( int )
1346 ldap_ufn_search_s LDAP_P(( /* deprecated */
1347         LDAP *ld,
1348         LDAP_CONST char *ufn,
1349         char **attrs,
1350         int attrsonly,
1351         LDAPMessage **res ));
1352
1353 LDAP_F( LDAPFiltDesc *)
1354 ldap_ufn_setfilter LDAP_P(( /* deprecated */
1355         LDAP *ld,
1356         LDAP_CONST char *fname ));
1357
1358 LDAP_F( void )
1359 ldap_ufn_setprefix LDAP_P(( /* deprecated */
1360         LDAP *ld,
1361         LDAP_CONST char *prefix ));
1362
1363 LDAP_F( int )
1364 ldap_ufn_timeout LDAP_P(( /* deprecated */
1365         void *tvparam ));
1366 #endif
1367
1368 /*
1369  * in unbind.c
1370  */
1371 LDAP_F( int )
1372 ldap_unbind LDAP_P(( /* deprecated */
1373         LDAP *ld ));
1374
1375 LDAP_F( int )
1376 ldap_unbind_s LDAP_P(( /* deprecated */
1377         LDAP *ld ));
1378
1379 LDAP_F( int )
1380 ldap_unbind_ext LDAP_P((
1381         LDAP                    *ld,
1382         LDAPControl             **serverctrls,
1383         LDAPControl             **clientctrls));
1384
1385 LDAP_F( int )
1386 ldap_unbind_ext_s LDAP_P((
1387         LDAP                    *ld,
1388         LDAPControl             **serverctrls,
1389         LDAPControl             **clientctrls));
1390
1391 /*
1392  * in getfilter.c
1393  *      (deprecated)
1394  */
1395 LDAP_F( LDAPFiltDesc *)
1396 ldap_init_getfilter LDAP_P(( /* deprecated */
1397         LDAP_CONST char *fname ));
1398
1399 LDAP_F( LDAPFiltDesc *)
1400 ldap_init_getfilter_buf LDAP_P(( /* deprecated */
1401         /* LDAP_CONST */ char *buf,
1402         ber_len_t buflen ));
1403
1404 LDAP_F( LDAPFiltInfo *)
1405 ldap_getfirstfilter LDAP_P(( /* deprecated */
1406         LDAPFiltDesc *lfdp,
1407         /* LDAP_CONST */ char *tagpat,
1408         /* LDAP_CONST */ char *value ));
1409
1410 LDAP_F( LDAPFiltInfo *)
1411 ldap_getnextfilter LDAP_P(( /* deprecated */
1412         LDAPFiltDesc *lfdp ));
1413
1414 LDAP_F( void )
1415 ldap_setfilteraffixes LDAP_P(( /* deprecated */
1416         LDAPFiltDesc *lfdp,
1417         LDAP_CONST char *prefix,
1418         LDAP_CONST char *suffix ));
1419
1420 LDAP_F( void )
1421 ldap_build_filter LDAP_P(( /* deprecated */
1422         char *buf,
1423         ber_len_t buflen,
1424         LDAP_CONST char *pattern,
1425         LDAP_CONST char *prefix,
1426         LDAP_CONST char *suffix,
1427         LDAP_CONST char *attr,
1428         LDAP_CONST char *value,
1429         char **valwords ));
1430
1431
1432 /*
1433  * in free.c
1434  */
1435
1436 LDAP_F( void * )
1437 ldap_memalloc LDAP_P((
1438         ber_len_t s ));
1439
1440 LDAP_F( void * )
1441 ldap_memrealloc LDAP_P((
1442         void* p,
1443         ber_len_t s ));
1444
1445 LDAP_F( void * )
1446 ldap_memcalloc LDAP_P((
1447         ber_len_t n,
1448         ber_len_t s ));
1449
1450 LDAP_F( void )
1451 ldap_memfree LDAP_P((
1452         void* p ));
1453
1454 LDAP_F( void )
1455 ldap_memvfree LDAP_P((
1456         void** v ));
1457
1458 LDAP_F( char * )
1459 ldap_strdup LDAP_P((
1460         LDAP_CONST char * ));
1461
1462 LDAP_F( void )
1463 ldap_getfilter_free LDAP_P((
1464         LDAPFiltDesc *lfdp ));
1465
1466 LDAP_F( void )
1467 ldap_mods_free LDAP_P((
1468         LDAPMod **mods,
1469         int freemods ));
1470
1471
1472 /*
1473  * in friendly.c
1474  *      (deprecated)
1475  */
1476 LDAP_F( char * )
1477 ldap_friendly_name LDAP_P(( /* deprecated */
1478         LDAP_CONST char *filename,
1479         /* LDAP_CONST */ char *uname,
1480         LDAPFriendlyMap **map ));
1481
1482 LDAP_F( void )
1483 ldap_free_friendlymap LDAP_P(( /* deprecated */
1484         LDAPFriendlyMap **map ));
1485
1486
1487 /*
1488  * in sort.c
1489  */
1490 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P((
1491         LDAP_CONST char *left,
1492         LDAP_CONST char *right ));
1493
1494 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P((
1495         LDAP_CONST void *left,
1496         LDAP_CONST void *right ));
1497
1498 LDAP_F( int )
1499 ldap_sort_entries LDAP_P(( LDAP *ld,
1500         LDAPMessage **chain,
1501         LDAP_CONST char *attr,
1502         LDAP_SORT_AD_CMP_PROC *cmp ));
1503
1504 LDAP_F( int )   /* deprecated */
1505 ldap_sort_values LDAP_P((
1506         LDAP *ld,
1507         char **vals,
1508         LDAP_SORT_AV_CMP_PROC *cmp ));
1509
1510 LDAP_F( int ) /* deprecated */
1511 ldap_sort_strcasecmp LDAP_P((
1512         LDAP_CONST void *a,
1513         LDAP_CONST void *b ));
1514
1515
1516 /*
1517  * in url.c
1518  *
1519  * need _ext varients
1520  */
1521 LDAP_F( int )
1522 ldap_is_ldap_url LDAP_P((
1523         LDAP_CONST char *url ));
1524
1525 LDAP_F( int )
1526 ldap_is_ldaps_url LDAP_P((
1527         LDAP_CONST char *url ));
1528
1529 LDAP_F( int )
1530 ldap_is_ldapi_url LDAP_P((
1531         LDAP_CONST char *url ));
1532
1533 LDAP_F( int )
1534 ldap_url_parse LDAP_P((
1535         LDAP_CONST char *url,
1536         LDAPURLDesc **ludpp ));
1537
1538 LDAP_F( void )
1539 ldap_free_urldesc LDAP_P((
1540         LDAPURLDesc *ludp ));
1541
1542 LDAP_F( int )
1543 ldap_url_search LDAP_P((
1544         LDAP *ld,
1545         LDAP_CONST char *url,
1546         int attrsonly ));
1547
1548 LDAP_F( int )
1549 ldap_url_search_s LDAP_P((
1550         LDAP *ld,
1551         LDAP_CONST char *url,
1552         int attrsonly,
1553         LDAPMessage **res ));
1554
1555 LDAP_F( int )
1556 ldap_url_search_st LDAP_P((
1557         LDAP *ld,
1558         LDAP_CONST char *url,
1559         int attrsonly,
1560         struct timeval *timeout,
1561         LDAPMessage **res ));
1562
1563 /*
1564  * in sortctrl.c
1565  */
1566 /*
1567  * structure for a sort-key
1568  */
1569 typedef struct ldapsortkey {
1570         char *  attributeType;
1571         char *  orderingRule;
1572         int     reverseOrder;
1573 } LDAPSortKey;
1574
1575 LDAP_F( int )
1576 ldap_create_sort_keylist LDAP_P((
1577         LDAPSortKey ***sortKeyList,
1578         char        *keyString ));
1579
1580 LDAP_F( void )
1581 ldap_free_sort_keylist LDAP_P((
1582         LDAPSortKey **sortkeylist ));
1583
1584 LDAP_F( int )
1585 ldap_create_sort_control LDAP_P((
1586         LDAP *ld,
1587         LDAPSortKey **keyList,
1588         int ctl_iscritical,
1589         LDAPControl **ctrlp ));
1590
1591 LDAP_F( int )
1592 ldap_parse_sort_control LDAP_P((
1593         LDAP           *ld,
1594         LDAPControl    **ctrlp,
1595         unsigned long  *result,
1596         char           **attribute ));
1597
1598
1599 /*
1600  * in vlvctrl.c
1601  */
1602
1603 /*
1604  * structure for virtul list.
1605  */
1606 typedef struct ldapvlvinfo {
1607         int             ldvlv_version;
1608     unsigned long   ldvlv_before_count;
1609     unsigned long   ldvlv_after_count;
1610     unsigned long   ldvlv_offset;
1611     unsigned long   ldvlv_count;
1612     struct berval  *ldvlv_attrvalue;
1613     struct berval  *ldvlv_context;
1614     void           *ldvlv_extradata;
1615 } LDAPVLVInfo;
1616
1617 LDAP_F( int )
1618 ldap_create_vlv_control LDAP_P((
1619         LDAP *ld,
1620         LDAPVLVInfo *ldvlistp,
1621         LDAPControl **ctrlp ));
1622
1623 LDAP_F( int )
1624 ldap_parse_vlv_control LDAP_P((
1625         LDAP          *ld,
1626         LDAPControl   **ctrls,
1627         unsigned long *target_posp,
1628         unsigned long *list_countp,
1629         struct berval **contextp,
1630         int           *errcodep ));
1631
1632
1633 LDAP_END_DECL
1634 #endif /* _LDAP_H */