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