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
 573 LDAP_F( int )
 574 ldap_set_rebind_proc LDAP_P((
 575         LDAP *ld,
 576         LDAP_REBIND_PROC *ldap_proc));
 577
 578 /*
 579  * in controls.c:
 580  */
 581 LDAP_F( int )
 582 ldap_create_control LDAP_P((
 583         const char *requestOID,
 584         BerElement *ber,
 585         int iscritical,
 586         LDAPControl **ctrlp ));
 587
 588 LDAP_F( void )
 589 ldap_control_free LDAP_P((
 590         LDAPControl *ctrl ));
 591
 592 LDAP_F( void )
 593 ldap_controls_free LDAP_P((
 594         LDAPControl **ctrls ));
 595
 596 /*
 597  * in dnssrv.c:
 598  */
 599 LDAP_F( int )
 600 ldap_domain2dn LDAP_P((
 601         LDAP_CONST char* domain,
 602         char** dn ));
 603
 604 LDAP_F( int )
 605 ldap_dn2domain LDAP_P((
 606         LDAP_CONST char* dn,
 607         char** domain ));
 608
 609 LDAP_F( int )
 610 ldap_domain2hostlist LDAP_P((
 611         LDAP_CONST char *domain,
 612         char** hostlist ));
 613
 614 /*
 615  * in extended.c:
 616  */
 617 LDAP_F( int )
 618 ldap_extended_operation LDAP_P((
 619         LDAP                    *ld,
 620         LDAP_CONST char *reqoid,
 621         struct berval   *reqdata,
 622         LDAPControl             **serverctrls,
 623         LDAPControl             **clientctrls,
 624         int                             *msgidp ));
 625
 626 LDAP_F( int )
 627 ldap_extended_operation_s LDAP_P((
 628         LDAP                    *ld,
 629         LDAP_CONST char *reqoid,
 630         struct berval   *reqdata,
 631         LDAPControl             **serverctrls,
 632         LDAPControl             **clientctrls,
 633         char                    **retoidp,
 634         struct berval   **retdatap ));
 635
 636 LDAP_F( int )
 637 ldap_parse_extended_result LDAP_P((
 638         LDAP                    *ld,
 639         LDAPMessage             *res,
 640         char                    **retoidp,
 641         struct berval   **retdatap,
 642         int                             freeit ));
 643
 644 LDAP_F( int )
 645 ldap_parse_extended_partial LDAP_P((
 646         LDAP                    *ld,
 647         LDAPMessage             *res,
 648         char                    **retoidp,
 649         struct berval   **retdatap,
 650         LDAPControl             ***serverctrls,
 651         int                             freeit ));
 652
 653 /*
 654  * in abandon.c:
 655  */
 656 LDAP_F( int )
 657 ldap_abandon_ext LDAP_P((
 658         LDAP                    *ld,
 659         int                             msgid,
 660         LDAPControl             **serverctrls,
 661         LDAPControl             **clientctrls ));
 662
 663 LDAP_F( int )
 664 ldap_abandon LDAP_P((   /* deprecated */
 665         LDAP *ld,
 666         int msgid ));
 667
 668
 669 /*
 670  * in add.c:
 671  */
 672 LDAP_F( int )
 673 ldap_add_ext LDAP_P((
 674         LDAP                    *ld,
 675         LDAP_CONST char *dn,
 676         LDAPMod                 **attrs,
 677         LDAPControl             **serverctrls,
 678         LDAPControl             **clientctrls,
 679         int                     *msgidp ));
 680
 681 LDAP_F( int )
 682 ldap_add_ext_s LDAP_P((
 683         LDAP                    *ld,
 684         LDAP_CONST char *dn,
 685         LDAPMod                 **attrs,
 686         LDAPControl             **serverctrls,
 687         LDAPControl             **clientctrls ));
 688
 689 LDAP_F( int )
 690 ldap_add LDAP_P((       /* deprecated */
 691         LDAP *ld,
 692         LDAP_CONST char *dn,
 693         LDAPMod **attrs ));
 694
 695 LDAP_F( int )
 696 ldap_add_s LDAP_P((     /* deprecated */
 697         LDAP *ld,
 698         LDAP_CONST char *dn,
 699         LDAPMod **attrs ));
 700
 701
 702 /*
 703  * in sasl.c:
 704  */
 705 LDAP_F( int )
 706 ldap_sasl_bind LDAP_P((
 707         LDAP                    *ld,
 708         LDAP_CONST char *dn,
 709         LDAP_CONST char *mechanism,
 710         struct berval   *cred,
 711         LDAPControl             **serverctrls,
 712         LDAPControl             **clientctrls,
 713         int                             *msgidp ));
 714
 715 /* Interaction flags (should be passed about in a control)
 716  *  Automatic (default): use defaults, prompt otherwise
 717  *  Interactive: prompt always
 718  *  Quiet: never prompt
 719  */
 720 #define LDAP_SASL_AUTOMATIC             0U
 721 #define LDAP_SASL_INTERACTIVE   1U
 722 #define LDAP_SASL_QUIET                 2U
 723
 724 /*
 725  * V3 SASL Interaction Function Callback Prototype
 726  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
 727  *  should likely passed in a control (and provided controls)
 728  */
 729 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
 730         LDAP *ld, unsigned flags, void* defaults, void *interact ));
 731
 732 LDAP_F( int )
 733 ldap_sasl_interactive_bind_s LDAP_P((
 734         LDAP *ld,
 735         LDAP_CONST char *dn, /* usually NULL */
 736         LDAP_CONST char *saslMechanism,
 737         LDAPControl **serverControls,
 738         LDAPControl **clientControls,
 739
 740         /* should be client controls */
 741         unsigned flags,
 742         LDAP_SASL_INTERACT_PROC *proc,
 743         void *defaults ));
 744
 745 LDAP_F( int )
 746 ldap_sasl_bind_s LDAP_P((
 747         LDAP                    *ld,
 748         LDAP_CONST char *dn,
 749         LDAP_CONST char *mechanism,
 750         struct berval   *cred,
 751         LDAPControl             **serverctrls,
 752         LDAPControl             **clientctrls,
 753         struct berval   **servercredp ));
 754
 755 LDAP_F( int )
 756 ldap_parse_sasl_bind_result LDAP_P((
 757         LDAP                    *ld,
 758         LDAPMessage             *res,
 759         struct berval   **servercredp,
 760         int                             freeit ));
 761
 762 /*
 763  * in bind.c:
 764  *      (deprecated)
 765  */
 766 LDAP_F( int )
 767 ldap_bind LDAP_P((      /* deprecated */
 768         LDAP *ld,
 769         LDAP_CONST char *who,
 770         LDAP_CONST char *passwd,
 771         int authmethod ));
 772
 773 LDAP_F( int )
 774 ldap_bind_s LDAP_P((    /* deprecated */
 775         LDAP *ld,
 776         LDAP_CONST char *who,
 777         LDAP_CONST char *cred,
 778         int authmethod ));
 779
 780 /*
 781  * in sbind.c:
 782  */
 783 LDAP_F( int )
 784 ldap_simple_bind LDAP_P((
 785         LDAP *ld,
 786         LDAP_CONST char *who,
 787         LDAP_CONST char *passwd ));
 788
 789 LDAP_F( int )
 790 ldap_simple_bind_s LDAP_P((
 791         LDAP *ld,
 792         LDAP_CONST char *who,
 793         LDAP_CONST char *passwd ));
 794
 795
 796 /*
 797  * in kbind.c:
 798  *      (deprecated)
 799  */
 800 LDAP_F( int )
 801 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
 802         LDAP *ld,
 803         LDAP_CONST char *who ));
 804
 805 LDAP_F( int )
 806 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
 807         LDAP *ld,
 808         LDAP_CONST char *who ));
 809
 810 LDAP_F( int )
 811 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
 812         LDAP *ld,
 813         LDAP_CONST char *who ));
 814
 815 LDAP_F( int )
 816 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
 817         LDAP *ld,
 818         LDAP_CONST char *who ));
 819
 820 LDAP_F( int )
 821 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
 822         LDAP *ld,
 823         LDAP_CONST char *who ));
 824
 825 /*
 826  * in cache.c
 827  * (deprecated)
 828  */
 829 LDAP_F( int )
 830 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
 831
 832 LDAP_F( void )
 833 ldap_disable_cache LDAP_P(( LDAP *ld ));
 834
 835 LDAP_F( void )
 836 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
 837
 838 LDAP_F( void )
 839 ldap_destroy_cache LDAP_P(( LDAP *ld ));
 840
 841 LDAP_F( void )
 842 ldap_flush_cache LDAP_P(( LDAP *ld ));
 843
 844 LDAP_F( void )
 845 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
 846
 847 LDAP_F( void )
 848 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
 849
 850
 851 /*
 852  * in compare.c:
 853  */
 854 LDAP_F( int )
 855 ldap_compare_ext 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         int                     *msgidp ));
 863
 864 LDAP_F( int )
 865 ldap_compare_ext_s LDAP_P((
 866         LDAP                    *ld,
 867         LDAP_CONST char *dn,
 868         LDAP_CONST char *attr,
 869         struct berval   *bvalue,
 870         LDAPControl             **serverctrls,
 871         LDAPControl             **clientctrls ));
 872
 873 LDAP_F( int )
 874 ldap_compare LDAP_P((   /* deprecated */
 875         LDAP *ld,
 876         LDAP_CONST char *dn,
 877         LDAP_CONST char *attr,
 878         LDAP_CONST char *value ));
 879
 880 LDAP_F( int )
 881 ldap_compare_s LDAP_P(( /* deprecated */
 882         LDAP *ld,
 883         LDAP_CONST char *dn,
 884         LDAP_CONST char *attr,
 885         LDAP_CONST char *value ));
 886
 887
 888 /*
 889  * in delete.c:
 890  */
 891 LDAP_F( int )
 892 ldap_delete_ext LDAP_P((
 893         LDAP                    *ld,
 894         LDAP_CONST char *dn,
 895         LDAPControl             **serverctrls,
 896         LDAPControl             **clientctrls,
 897         int                     *msgidp ));
 898
 899 LDAP_F( int )
 900 ldap_delete_ext_s LDAP_P((
 901         LDAP                    *ld,
 902         LDAP_CONST char *dn,
 903         LDAPControl             **serverctrls,
 904         LDAPControl             **clientctrls ));
 905
 906 LDAP_F( int )
 907 ldap_delete LDAP_P((    /* deprecated */
 908         LDAP *ld,
 909         LDAP_CONST char *dn ));
 910
 911 LDAP_F( int )
 912 ldap_delete_s LDAP_P((  /* deprecated */
 913         LDAP *ld,
 914         LDAP_CONST char *dn ));
 915
 916
 917 /*
 918  * in error.c:
 919  */
 920 LDAP_F( int )
 921 ldap_parse_result LDAP_P((
 922         LDAP                    *ld,
 923         LDAPMessage             *res,
 924         int                             *errcodep,
 925         char                    **matcheddnp,
 926         char                    **errmsgp,
 927         char                    ***referralsp,
 928         LDAPControl             ***serverctrls,
 929         int                             freeit ));
 930
 931 LDAP_F( char *)
 932 ldap_err2string LDAP_P((
 933         int err ));
 934
 935 LDAP_F( int )
 936 ldap_result2error LDAP_P((      /* deprecated */
 937         LDAP *ld,
 938         LDAPMessage *r,
 939         int freeit ));
 940
 941 LDAP_F( void )
 942 ldap_perror LDAP_P((    /* deprecated */
 943         LDAP *ld,
 944         LDAP_CONST char *s ));
 945
 946
 947 /*
 948  * in modify.c:
 949  */
 950 LDAP_F( int )
 951 ldap_modify_ext LDAP_P((
 952         LDAP                    *ld,
 953         LDAP_CONST char *dn,
 954         LDAPMod                 **mods,
 955         LDAPControl             **serverctrls,
 956         LDAPControl             **clientctrls,
 957         int                     *msgidp ));
 958
 959 LDAP_F( int )
 960 ldap_modify_ext_s LDAP_P((
 961         LDAP                    *ld,
 962         LDAP_CONST char *dn,
 963         LDAPMod                 **mods,
 964         LDAPControl             **serverctrls,
 965         LDAPControl             **clientctrls ));
 966
 967 LDAP_F( int )
 968 ldap_modify LDAP_P((    /* deprecated */
 969         LDAP *ld,
 970         LDAP_CONST char *dn,
 971         LDAPMod **mods ));
 972
 973 LDAP_F( int )
 974 ldap_modify_s LDAP_P((  /* deprecated */
 975         LDAP *ld,
 976         LDAP_CONST char *dn,
 977         LDAPMod **mods ));
 978
 979
 980 /*
 981  * in modrdn.c:
 982  */
 983 LDAP_F( int )
 984 ldap_rename LDAP_P((
 985         LDAP *ld,
 986         LDAP_CONST char *dn,
 987         LDAP_CONST char *newrdn,
 988         LDAP_CONST char *newSuperior,
 989         int deleteoldrdn,
 990         LDAPControl **sctrls,
 991         LDAPControl **cctrls,
 992         int *msgidp ));
 993
 994 LDAP_F( int )
 995 ldap_rename_s LDAP_P((
 996         LDAP *ld,
 997         LDAP_CONST char *dn,
 998         LDAP_CONST char *newrdn,
 999         LDAP_CONST char *newSuperior,
1000         int deleteoldrdn,
1001         LDAPControl **sctrls,
1002         LDAPControl **cctrls ));
1003
1004 LDAP_F( int )
1005 ldap_rename2 LDAP_P((   /* deprecated */
1006         LDAP *ld,
1007         LDAP_CONST char *dn,
1008         LDAP_CONST char *newrdn,
1009         LDAP_CONST char *newSuperior,
1010         int deleteoldrdn ));
1011
1012 LDAP_F( int )
1013 ldap_rename2_s LDAP_P(( /* deprecated */
1014         LDAP *ld,
1015         LDAP_CONST char *dn,
1016         LDAP_CONST char *newrdn,
1017         LDAP_CONST char *newSuperior,
1018         int deleteoldrdn ));
1019
1020 LDAP_F( int )
1021 ldap_modrdn LDAP_P((    /* deprecated */
1022         LDAP *ld,
1023         LDAP_CONST char *dn,
1024         LDAP_CONST char *newrdn ));
1025
1026 LDAP_F( int )
1027 ldap_modrdn_s LDAP_P((  /* deprecated */
1028         LDAP *ld,
1029         LDAP_CONST char *dn,
1030         LDAP_CONST char *newrdn ));
1031
1032 LDAP_F( int )
1033 ldap_modrdn2 LDAP_P((   /* deprecated */
1034         LDAP *ld,
1035         LDAP_CONST char *dn,
1036         LDAP_CONST char *newrdn,
1037         int deleteoldrdn ));
1038
1039 LDAP_F( int )
1040 ldap_modrdn2_s LDAP_P(( /* deprecated */
1041         LDAP *ld,
1042         LDAP_CONST char *dn,
1043         LDAP_CONST char *newrdn,
1044         int deleteoldrdn));
1045
1046
1047 /*
1048  * in open.c:
1049  */
1050 LDAP_F( LDAP *)
1051 ldap_init LDAP_P((
1052         LDAP_CONST char *host,
1053         int port ));
1054
1055 LDAP_F( LDAP *)
1056 ldap_open LDAP_P((      /* deprecated */
1057         LDAP_CONST char *host,
1058         int port ));
1059
1060 LDAP_F( int )
1061 ldap_create LDAP_P((
1062         LDAP **ldp ));
1063
1064 LDAP_F( int )
1065 ldap_initialize LDAP_P((
1066         LDAP **ldp,
1067         LDAP_CONST char *url ));
1068
1069 LDAP_F( int )
1070 ldap_start_tls_s LDAP_P((
1071         LDAP *ld,
1072         LDAPControl **serverctrls,
1073         LDAPControl **clientctrls ));
1074
1075 /*
1076  * in messages.c:
1077  */
1078 LDAP_F( LDAPMessage *)
1079 ldap_first_message LDAP_P((
1080         LDAP *ld,
1081         LDAPMessage *chain ));
1082
1083 LDAP_F( LDAPMessage *)
1084 ldap_next_message LDAP_P((
1085         LDAP *ld,
1086         LDAPMessage *msg ));
1087
1088 LDAP_F( int )
1089 ldap_count_messages LDAP_P((
1090         LDAP *ld,
1091         LDAPMessage *chain ));
1092
1093
1094 /*
1095  * in references.c:
1096  */
1097 LDAP_F( LDAPMessage *)
1098 ldap_first_reference LDAP_P((
1099         LDAP *ld,
1100         LDAPMessage *chain ));
1101
1102 LDAP_F( LDAPMessage *)
1103 ldap_next_reference LDAP_P((
1104         LDAP *ld,
1105         LDAPMessage *ref ));
1106
1107 LDAP_F( int )
1108 ldap_count_references LDAP_P((
1109         LDAP *ld,
1110         LDAPMessage *chain ));
1111
1112 LDAP_F( int )
1113 ldap_parse_reference LDAP_P((
1114         LDAP                    *ld,
1115         LDAPMessage             *ref,
1116         char                    ***referralsp,
1117         LDAPControl             ***serverctrls,
1118         int                             freeit));
1119
1120
1121 /*
1122  * in getentry.c:
1123  */
1124 LDAP_F( LDAPMessage *)
1125 ldap_first_entry LDAP_P((
1126         LDAP *ld,
1127         LDAPMessage *chain ));
1128
1129 LDAP_F( LDAPMessage *)
1130 ldap_next_entry LDAP_P((
1131         LDAP *ld,
1132         LDAPMessage *entry ));
1133
1134 LDAP_F( int )
1135 ldap_count_entries LDAP_P((
1136         LDAP *ld,
1137         LDAPMessage *chain ));
1138
1139 LDAP_F( int )
1140 ldap_get_entry_controls LDAP_P((
1141         LDAP                    *ld,
1142         LDAPMessage             *entry,
1143         LDAPControl             ***serverctrls));
1144
1145
1146 /*
1147  * in addentry.c
1148  */
1149 LDAP_F( LDAPMessage *)
1150 ldap_delete_result_entry LDAP_P((
1151         LDAPMessage **list,
1152         LDAPMessage *e ));
1153
1154 LDAP_F( void )
1155 ldap_add_result_entry LDAP_P((
1156         LDAPMessage **list,
1157         LDAPMessage *e ));
1158
1159
1160 /*
1161  * in getdn.c
1162  */
1163 LDAP_F( char * )
1164 ldap_get_dn LDAP_P((
1165         LDAP *ld,
1166         LDAPMessage *entry ));
1167
1168 LDAP_F( char * )
1169 ldap_dn2ufn LDAP_P((
1170         LDAP_CONST char *dn ));
1171
1172 LDAP_F( char ** )
1173 ldap_explode_dn LDAP_P((
1174         LDAP_CONST char *dn,
1175         int notypes ));
1176
1177 LDAP_F( char ** )
1178 ldap_explode_rdn LDAP_P((
1179         LDAP_CONST char *rdn,
1180         int notypes ));
1181
1182 LDAP_F( char * )
1183 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1184
1185 LDAP_F( char * )
1186 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1187
1188 /*
1189  * in getattr.c
1190  */
1191 LDAP_F( char *)
1192 ldap_first_attribute LDAP_P((
1193         LDAP *ld,
1194         LDAPMessage *entry,
1195         BerElement **ber ));
1196
1197 LDAP_F( char *)
1198 ldap_next_attribute LDAP_P((
1199         LDAP *ld,
1200         LDAPMessage *entry,
1201         BerElement *ber ));
1202
1203
1204 /*
1205  * in getvalues.c
1206  */
1207 LDAP_F( char **)
1208 ldap_get_values LDAP_P((
1209         LDAP *ld,
1210         LDAPMessage *entry,
1211         LDAP_CONST char *target ));
1212
1213 LDAP_F( struct berval **)
1214 ldap_get_values_len LDAP_P((
1215         LDAP *ld,
1216         LDAPMessage *entry,
1217         LDAP_CONST char *target ));
1218
1219 LDAP_F( int )
1220 ldap_count_values LDAP_P((
1221         char **vals ));
1222
1223 LDAP_F( int )
1224 ldap_count_values_len LDAP_P((
1225         struct berval **vals ));
1226
1227 LDAP_F( void )
1228 ldap_value_free LDAP_P((
1229         char **vals ));
1230
1231 LDAP_F( void )
1232 ldap_value_free_len LDAP_P((
1233         struct berval **vals ));
1234
1235 /*
1236  * in result.c:
1237  */
1238 LDAP_F( int )
1239 ldap_result LDAP_P((
1240         LDAP *ld,
1241         int msgid,
1242         int all,
1243         struct timeval *timeout,
1244         LDAPMessage **result ));
1245
1246 LDAP_F( int )
1247 ldap_msgtype LDAP_P((
1248         LDAPMessage *lm ));
1249
1250 LDAP_F( int )
1251 ldap_msgid   LDAP_P((
1252         LDAPMessage *lm ));
1253
1254 LDAP_F( int )
1255 ldap_msgfree LDAP_P((
1256         LDAPMessage *lm ));
1257
1258 LDAP_F( int )
1259 ldap_msgdelete LDAP_P((
1260         LDAP *ld,
1261         int msgid ));
1262
1263
1264 /*
1265  * in search.c:
1266  */
1267 LDAP_F( int )
1268 ldap_search_ext LDAP_P((
1269         LDAP                    *ld,
1270         LDAP_CONST char *base,
1271         int                             scope,
1272         LDAP_CONST char *filter,
1273         char                    **attrs,
1274         int                             attrsonly,
1275         LDAPControl             **serverctrls,
1276         LDAPControl             **clientctrls,
1277         struct timeval  *timeout,
1278         int                             sizelimit,
1279         int                             *msgidp ));
1280
1281 LDAP_F( int )
1282 ldap_search_ext_s LDAP_P((
1283         LDAP                    *ld,
1284         LDAP_CONST char *base,
1285         int                             scope,
1286         LDAP_CONST char *filter,
1287         char                    **attrs,
1288         int                             attrsonly,
1289         LDAPControl             **serverctrls,
1290         LDAPControl             **clientctrls,
1291         struct timeval  *timeout,
1292         int                             sizelimit,
1293         LDAPMessage             **res ));
1294
1295 LDAP_F( int )
1296 ldap_search LDAP_P((    /* deprecated */
1297         LDAP *ld,
1298         LDAP_CONST char *base,
1299         int scope,
1300         LDAP_CONST char *filter,
1301         char **attrs,
1302         int attrsonly ));
1303
1304 LDAP_F( int )
1305 ldap_search_s 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         LDAPMessage **res ));
1313
1314 LDAP_F( int )
1315 ldap_search_st LDAP_P(( /* deprecated */
1316         LDAP *ld,
1317         LDAP_CONST char *base,
1318         int scope,
1319         LDAP_CONST char *filter,
1320     char **attrs,
1321         int attrsonly,
1322         struct timeval *timeout,
1323         LDAPMessage **res ));
1324
1325 #ifdef LDAP_UFN
1326 /*
1327  * in ufn.c
1328  *      (deprecated)
1329  */
1330 LDAP_F( int )
1331 ldap_ufn_search_c 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
1340 LDAP_F( int )
1341 ldap_ufn_search_ct LDAP_P(( /* deprecated */
1342         LDAP *ld,
1343         LDAP_CONST char *ufn,
1344         char **attrs,
1345         int attrsonly,
1346         LDAPMessage **res,
1347         int (*cancelproc)( void *cl ),
1348         void *cancelparm,
1349         char *tag1,
1350         char *tag2,
1351         char *tag3 ));
1352
1353 LDAP_F( int )
1354 ldap_ufn_search_s LDAP_P(( /* deprecated */
1355         LDAP *ld,
1356         LDAP_CONST char *ufn,
1357         char **attrs,
1358         int attrsonly,
1359         LDAPMessage **res ));
1360
1361 LDAP_F( LDAPFiltDesc *)
1362 ldap_ufn_setfilter LDAP_P(( /* deprecated */
1363         LDAP *ld,
1364         LDAP_CONST char *fname ));
1365
1366 LDAP_F( void )
1367 ldap_ufn_setprefix LDAP_P(( /* deprecated */
1368         LDAP *ld,
1369         LDAP_CONST char *prefix ));
1370
1371 LDAP_F( int )
1372 ldap_ufn_timeout LDAP_P(( /* deprecated */
1373         void *tvparam ));
1374 #endif
1375
1376 /*
1377  * in unbind.c
1378  */
1379 LDAP_F( int )
1380 ldap_unbind LDAP_P(( /* deprecated */
1381         LDAP *ld ));
1382
1383 LDAP_F( int )
1384 ldap_unbind_s LDAP_P(( /* deprecated */
1385         LDAP *ld ));
1386
1387 LDAP_F( int )
1388 ldap_unbind_ext LDAP_P((
1389         LDAP                    *ld,
1390         LDAPControl             **serverctrls,
1391         LDAPControl             **clientctrls));
1392
1393 LDAP_F( int )
1394 ldap_unbind_ext_s LDAP_P((
1395         LDAP                    *ld,
1396         LDAPControl             **serverctrls,
1397         LDAPControl             **clientctrls));
1398
1399 /*
1400  * in getfilter.c
1401  *      (deprecated)
1402  */
1403 LDAP_F( LDAPFiltDesc *)
1404 ldap_init_getfilter LDAP_P(( /* deprecated */
1405         LDAP_CONST char *fname ));
1406
1407 LDAP_F( LDAPFiltDesc *)
1408 ldap_init_getfilter_buf LDAP_P(( /* deprecated */
1409         /* LDAP_CONST */ char *buf,
1410         ber_len_t buflen ));
1411
1412 LDAP_F( LDAPFiltInfo *)
1413 ldap_getfirstfilter LDAP_P(( /* deprecated */
1414         LDAPFiltDesc *lfdp,
1415         /* LDAP_CONST */ char *tagpat,
1416         /* LDAP_CONST */ char *value ));
1417
1418 LDAP_F( LDAPFiltInfo *)
1419 ldap_getnextfilter LDAP_P(( /* deprecated */
1420         LDAPFiltDesc *lfdp ));
1421
1422 LDAP_F( void )
1423 ldap_setfilteraffixes LDAP_P(( /* deprecated */
1424         LDAPFiltDesc *lfdp,
1425         LDAP_CONST char *prefix,
1426         LDAP_CONST char *suffix ));
1427
1428 LDAP_F( void )
1429 ldap_build_filter LDAP_P(( /* deprecated */
1430         char *buf,
1431         ber_len_t buflen,
1432         LDAP_CONST char *pattern,
1433         LDAP_CONST char *prefix,
1434         LDAP_CONST char *suffix,
1435         LDAP_CONST char *attr,
1436         LDAP_CONST char *value,
1437         char **valwords ));
1438
1439
1440 /*
1441  * in free.c
1442  */
1443
1444 LDAP_F( void * )
1445 ldap_memalloc LDAP_P((
1446         ber_len_t s ));
1447
1448 LDAP_F( void * )
1449 ldap_memrealloc LDAP_P((
1450         void* p,
1451         ber_len_t s ));
1452
1453 LDAP_F( void * )
1454 ldap_memcalloc LDAP_P((
1455         ber_len_t n,
1456         ber_len_t s ));
1457
1458 LDAP_F( void )
1459 ldap_memfree LDAP_P((
1460         void* p ));
1461
1462 LDAP_F( void )
1463 ldap_memvfree LDAP_P((
1464         void** v ));
1465
1466 LDAP_F( char * )
1467 ldap_strdup LDAP_P((
1468         LDAP_CONST char * ));
1469
1470 LDAP_F( void )
1471 ldap_getfilter_free LDAP_P((
1472         LDAPFiltDesc *lfdp ));
1473
1474 LDAP_F( void )
1475 ldap_mods_free LDAP_P((
1476         LDAPMod **mods,
1477         int freemods ));
1478
1479
1480 /*
1481  * in friendly.c
1482  *      (deprecated)
1483  */
1484 LDAP_F( char * )
1485 ldap_friendly_name LDAP_P(( /* deprecated */
1486         LDAP_CONST char *filename,
1487         /* LDAP_CONST */ char *uname,
1488         LDAPFriendlyMap **map ));
1489
1490 LDAP_F( void )
1491 ldap_free_friendlymap LDAP_P(( /* deprecated */
1492         LDAPFriendlyMap **map ));
1493
1494
1495 /*
1496  * in sort.c
1497  */
1498 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P((
1499         LDAP_CONST char *left,
1500         LDAP_CONST char *right ));
1501
1502 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P((
1503         LDAP_CONST void *left,
1504         LDAP_CONST void *right ));
1505
1506 LDAP_F( int )
1507 ldap_sort_entries LDAP_P(( LDAP *ld,
1508         LDAPMessage **chain,
1509         LDAP_CONST char *attr,
1510         LDAP_SORT_AD_CMP_PROC *cmp ));
1511
1512 LDAP_F( int )   /* deprecated */
1513 ldap_sort_values LDAP_P((
1514         LDAP *ld,
1515         char **vals,
1516         LDAP_SORT_AV_CMP_PROC *cmp ));
1517
1518 LDAP_F( int ) /* deprecated */
1519 ldap_sort_strcasecmp LDAP_P((
1520         LDAP_CONST void *a,
1521         LDAP_CONST void *b ));
1522
1523
1524 /*
1525  * in url.c
1526  *
1527  * need _ext varients
1528  */
1529 LDAP_F( int )
1530 ldap_is_ldap_url LDAP_P((
1531         LDAP_CONST char *url ));
1532
1533 LDAP_F( int )
1534 ldap_is_ldaps_url LDAP_P((
1535         LDAP_CONST char *url ));
1536
1537 LDAP_F( int )
1538 ldap_is_ldapi_url LDAP_P((
1539         LDAP_CONST char *url ));
1540
1541 LDAP_F( int )
1542 ldap_url_parse LDAP_P((
1543         LDAP_CONST char *url,
1544         LDAPURLDesc **ludpp ));
1545
1546 LDAP_F( void )
1547 ldap_free_urldesc LDAP_P((
1548         LDAPURLDesc *ludp ));
1549
1550 LDAP_F( int )
1551 ldap_url_search LDAP_P((
1552         LDAP *ld,
1553         LDAP_CONST char *url,
1554         int attrsonly ));
1555
1556 LDAP_F( int )
1557 ldap_url_search_s LDAP_P((
1558         LDAP *ld,
1559         LDAP_CONST char *url,
1560         int attrsonly,
1561         LDAPMessage **res ));
1562
1563 LDAP_F( int )
1564 ldap_url_search_st LDAP_P((
1565         LDAP *ld,
1566         LDAP_CONST char *url,
1567         int attrsonly,
1568         struct timeval *timeout,
1569         LDAPMessage **res ));
1570
1571 /*
1572  * in sortctrl.c
1573  */
1574 /*
1575  * structure for a sort-key
1576  */
1577 typedef struct ldapsortkey {
1578         char *  attributeType;
1579         char *  orderingRule;
1580         int     reverseOrder;
1581 } LDAPSortKey;
1582
1583 LDAP_F( int )
1584 ldap_create_sort_keylist LDAP_P((
1585         LDAPSortKey ***sortKeyList,
1586         char        *keyString ));
1587
1588 LDAP_F( void )
1589 ldap_free_sort_keylist LDAP_P((
1590         LDAPSortKey **sortkeylist ));
1591
1592 LDAP_F( int )
1593 ldap_create_sort_control LDAP_P((
1594         LDAP *ld,
1595         LDAPSortKey **keyList,
1596         int ctl_iscritical,
1597         LDAPControl **ctrlp ));
1598
1599 LDAP_F( int )
1600 ldap_parse_sort_control LDAP_P((
1601         LDAP           *ld,
1602         LDAPControl    **ctrlp,
1603         unsigned long  *result,
1604         char           **attribute ));
1605
1606
1607 /*
1608  * in vlvctrl.c
1609  */
1610
1611 /*
1612  * structure for virtul list.
1613  */
1614 typedef struct ldapvlvinfo {
1615         int             ldvlv_version;
1616     unsigned long   ldvlv_before_count;
1617     unsigned long   ldvlv_after_count;
1618     unsigned long   ldvlv_offset;
1619     unsigned long   ldvlv_count;
1620     struct berval  *ldvlv_attrvalue;
1621     struct berval  *ldvlv_context;
1622     void           *ldvlv_extradata;
1623 } LDAPVLVInfo;
1624
1625 LDAP_F( int )
1626 ldap_create_vlv_control LDAP_P((
1627         LDAP *ld,
1628         LDAPVLVInfo *ldvlistp,
1629         LDAPControl **ctrlp ));
1630
1631 LDAP_F( int )
1632 ldap_parse_vlv_control LDAP_P((
1633         LDAP          *ld,
1634         LDAPControl   **ctrls,
1635         unsigned long *target_posp,
1636         unsigned long *list_countp,
1637         struct berval **contextp,
1638         int           *errcodep ));
1639
1640
1641 LDAP_END_DECL
1642 #endif /* _LDAP_H */