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

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