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

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