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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2002 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
  51 /* OpenLDAP API Features */
  52 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
  53
  54 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
  55         ( defined( LDAP_THREAD_SAFE ) && \
  56                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
  57         /* -lldap may or may not be thread safe */
  58         /* -lldap_r, if available, is always thread safe */
  59 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
  60 #endif
  61 #if defined( LDAP_THREAD_SAFE ) && \
  62         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
  63 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
  64 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
  65 #endif
  66
  67 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
  68 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
  69
  70 #define LDAP_ROOT_DSE                           ""
  71 #define LDAP_NO_ATTRS                           "1.1"
  72 #define LDAP_ALL_USER_ATTRIBUTES        "*"
  73 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
  74
  75 /*
  76  * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
  77  * 0x0000 - 0x0fff reserved for api options
  78  * 0x1000 - 0x3fff reserved for api extended options
  79  * 0x4000 - 0x7fff reserved for private and experimental options
  80  */
  81 #define LDAP_OPT_API_INFO                       0x0000
  82 #define LDAP_OPT_DESC                           0x0001 /* deprecated */
  83 #define LDAP_OPT_DEREF                          0x0002
  84 #define LDAP_OPT_SIZELIMIT                      0x0003
  85 #define LDAP_OPT_TIMELIMIT                      0x0004
  86 /* 0x05 - 0x07 not defined by current draft */
  87 #define LDAP_OPT_REFERRALS                      0x0008
  88 #define LDAP_OPT_RESTART                        0x0009
  89 /* 0x0a - 0x10 not defined by current draft */
  90 #define LDAP_OPT_PROTOCOL_VERSION       0x0011
  91 #define LDAP_OPT_SERVER_CONTROLS        0x0012
  92 #define LDAP_OPT_CLIENT_CONTROLS        0x0013
  93 /* 0x14 not defined by current draft */
  94 #define LDAP_OPT_API_FEATURE_INFO       0x0015
  95
  96 /* 0x16 - 0x2f not defined by current draft */
  97 #define LDAP_OPT_HOST_NAME                      0x0030
  98 #define LDAP_OPT_ERROR_NUMBER           0x0031
  99 #define LDAP_OPT_ERROR_STRING           0x0032
 100 #define LDAP_OPT_MATCHED_DN                     0x0033
 101
 102 /* 0x34 - 0x0fff not defined by current draft */
 103
 104 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000  /* to 0x7FFF inclusive */
 105
 106 /* private and experimental options */
 107 /* OpenLDAP specific options */
 108 #define LDAP_OPT_DEBUG_LEVEL            0x5001  /* debug level */
 109 #define LDAP_OPT_TIMEOUT                        0x5002  /* default timeout */
 110 #define LDAP_OPT_REFHOPLIMIT            0x5003  /* ref hop limit */
 111 #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
 112 #define LDAP_OPT_URI                            0x5006
 113
 114 /* OpenLDAP TLS options */
 115 #define LDAP_OPT_X_TLS                          0x6000
 116 #define LDAP_OPT_X_TLS_CTX                      0x6001  /* SSL CTX */
 117 #define LDAP_OPT_X_TLS_CACERTFILE       0x6002
 118 #define LDAP_OPT_X_TLS_CACERTDIR        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_PROTOCOL              0x6007 */
 123 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6008
 124 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x6009
 125
 126 #define LDAP_OPT_X_TLS_NEVER            0
 127 #define LDAP_OPT_X_TLS_HARD             1
 128 #define LDAP_OPT_X_TLS_DEMAND           2
 129 #define LDAP_OPT_X_TLS_ALLOW            3
 130 #define LDAP_OPT_X_TLS_TRY              4
 131
 132 /* OpenLDAP SASL options */
 133 #define LDAP_OPT_X_SASL_MECH                    0x6100
 134 #define LDAP_OPT_X_SASL_REALM                   0x6101
 135 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
 136 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
 137 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
 138 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
 139 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
 140 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
 141 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
 142 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
 143
 144
 145 /* on/off values */
 146 #define LDAP_OPT_ON             ((void *) 1)
 147 #define LDAP_OPT_OFF    ((void *) 0)
 148
 149 /*
 150  * ldap_get_option() and ldap_set_option() return values.
 151  * As later versions may return other values indicating
 152  * failure, current applications should only compare returned
 153  * value against LDAP_OPT_SUCCESS.
 154  */
 155 #define LDAP_OPT_SUCCESS        0
 156 #define LDAP_OPT_ERROR          (-1)
 157
 158 #define LDAP_API_INFO_VERSION   (1)
 159 typedef struct ldapapiinfo {
 160         int             ldapai_info_version;            /* version of LDAPAPIInfo (1) */
 161         int             ldapai_api_version;                     /* revision of API supported */
 162         int             ldapai_protocol_version;        /* highest LDAP version supported */
 163         char    **ldapai_extensions;            /* names of API extensions */
 164         char    *ldapai_vendor_name;            /* name of supplier */
 165         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
 166 } LDAPAPIInfo;
 167
 168 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
 169 typedef struct ldap_apifeature_info {
 170         int             ldapaif_info_version; /* version of this struct (1) */
 171         char*   ldapaif_name;    /* matches LDAP_API_FEATURE_... less the prefix */
 172         int             ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
 173 } LDAPAPIFeatureInfo;
 174
 175 typedef struct ldapcontrol {
 176         char *                  ldctl_oid;
 177         struct berval   ldctl_value;
 178         char                    ldctl_iscritical;
 179 } LDAPControl;
 180
 181 /* LDAP Controls */
 182
 183 #if 0
 184         /* chase referrals client control (not yet implemented)  */
 185 #define LDAP_CONTROL_REFERRALS  "1.2.840.113666.1.4.616"
 186 #define LDAP_CHASE_SUBORDINATE_REFERRALS        0x0020U
 187 #define LDAP_CHASE_EXTERNAL_REFERRALS   0x0040U
 188 #endif
 189
 190 #define LDAP_CONTROL_MANAGEDSAIT        "2.16.840.1.113730.3.4.2"
 191 #define LDAP_CONTROL_SUBENTRIES         "1.3.6.1.4.1.4203.666.5.1"
 192 #define LDAP_CONTROL_NOOP                       "1.3.6.1.4.1.4203.666.5.2"
 193
 194 #define LDAP_CONTROL_DUPENT_REQUEST             "2.16.840.1.113719.1.27.101.1"
 195 #define LDAP_CONTROL_DUPENT_RESPONSE    "2.16.840.1.113719.1.27.101.2"
 196 #define LDAP_CONTROL_DUPENT_ENTRY               "2.16.840.1.113719.1.27.101.3"
 197 #define LDAP_CONTROL_DUPENT     LDAP_CONTROL_DUPENT_REQUEST
 198
 199 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473"
 200 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474"
 201 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
 202 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 203
 204 /* LDAP Unsolicited Notifications */
 205 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036"
 206 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 207
 208 /* LDAP Extended Operations */
 209 #define LDAP_EXOP_START_TLS     "1.3.6.1.4.1.1466.20037"
 210
 211 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
 212 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
 213 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
 214 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
 215 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
 216
 217 #define LDAP_EXOP_X_WHO_AM_I    "1.3.6.1.4.1.4203.1.11.3"
 218
 219 /*
 220  * specific LDAP instantiations of BER types we know about
 221  */
 222
 223 /* Overview of LBER tag construction
 224  *
 225  *      Bits
 226  *      ______
 227  *      8 7 | CLASS
 228  *      0 0 = UNIVERSAL
 229  *      0 1 = APPLICATION
 230  *      1 0 = CONTEXT-SPECIFIC
 231  *      1 1 = PRIVATE
 232  *              _____
 233  *              | 6 | DATA-TYPE
 234  *                0 = PRIMITIVE
 235  *                1 = CONSTRUCTED
 236  *                      ___________
 237  *                      | 5 ... 1 | TAG-NUMBER
 238  */
 239
 240 /* general stuff */
 241 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
 242 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
 243 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octet string */
 244 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octet string */
 245 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
 246 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
 247
 248 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
 249
 250 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
 251 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
 252 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
 253 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
 254
 255 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
 256
 257
 258 /* possible operations a client can invoke */
 259 #define LDAP_REQ_BIND                   ((ber_tag_t) 0x60U)     /* application + constructed */
 260 #define LDAP_REQ_UNBIND                 ((ber_tag_t) 0x42U)     /* application + primitive   */
 261 #define LDAP_REQ_SEARCH                 ((ber_tag_t) 0x63U)     /* application + constructed */
 262 #define LDAP_REQ_MODIFY                 ((ber_tag_t) 0x66U)     /* application + constructed */
 263 #define LDAP_REQ_ADD                    ((ber_tag_t) 0x68U)     /* application + constructed */
 264 #define LDAP_REQ_DELETE                 ((ber_tag_t) 0x4aU)     /* application + primitive   */
 265 #define LDAP_REQ_MODDN                  ((ber_tag_t) 0x6cU)     /* application + constructed */
 266 #define LDAP_REQ_MODRDN                 LDAP_REQ_MODDN
 267 #define LDAP_REQ_RENAME                 LDAP_REQ_MODDN
 268 #define LDAP_REQ_COMPARE                ((ber_tag_t) 0x6eU)     /* application + constructed */
 269 #define LDAP_REQ_ABANDON                ((ber_tag_t) 0x50U)     /* application + primitive   */
 270 #define LDAP_REQ_EXTENDED               ((ber_tag_t) 0x77U)     /* application + constructed */
 271
 272 /* possible result types a server can return */
 273 #define LDAP_RES_BIND                   ((ber_tag_t) 0x61U)     /* application + constructed */
 274 #define LDAP_RES_SEARCH_ENTRY           ((ber_tag_t) 0x64U)     /* application + constructed */
 275 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
 276 #define LDAP_RES_SEARCH_RESULT          ((ber_tag_t) 0x65U)     /* application + constructed */
 277 #define LDAP_RES_MODIFY                 ((ber_tag_t) 0x67U)     /* application + constructed */
 278 #define LDAP_RES_ADD                    ((ber_tag_t) 0x69U)     /* application + constructed */
 279 #define LDAP_RES_DELETE                 ((ber_tag_t) 0x6bU)     /* application + constructed */
 280 #define LDAP_RES_MODDN                  ((ber_tag_t) 0x6dU)     /* application + constructed */
 281 #define LDAP_RES_MODRDN                 LDAP_RES_MODDN  /* application + constructed */
 282 #define LDAP_RES_RENAME                 LDAP_RES_MODDN  /* application + constructed */
 283 #define LDAP_RES_COMPARE                ((ber_tag_t) 0x6fU)     /* application + constructed */
 284 #define LDAP_RES_EXTENDED               ((ber_tag_t) 0x78U)     /* V3: application + constructed */
 285 #define LDAP_RES_EXTENDED_PARTIAL       ((ber_tag_t) 0x79U)     /* V3+: application + constructed */
 286
 287 #define LDAP_RES_ANY                    (-1)
 288 #define LDAP_RES_UNSOLICITED    (0)
 289
 290
 291 /* sasl methods */
 292 #define LDAP_SASL_SIMPLE                ((char*)0)
 293 #define LDAP_SASL_NULL                  ("")
 294
 295
 296 /* authentication methods available */
 297 #define LDAP_AUTH_NONE          ((ber_tag_t) 0x00U)     /* no authentication              */
 298 #define LDAP_AUTH_SIMPLE        ((ber_tag_t) 0x80U)     /* context specific + primitive   */
 299 #define LDAP_AUTH_SASL          ((ber_tag_t) 0xa3U)     /* context specific + constructed */
 300 #define LDAP_AUTH_KRBV4         ((ber_tag_t) 0xffU)     /* means do both of the following */
 301 #define LDAP_AUTH_KRBV41        ((ber_tag_t) 0x81U)     /* context specific + primitive   */
 302 #define LDAP_AUTH_KRBV42        ((ber_tag_t) 0x82U)     /* context specific + primitive   */
 303
 304
 305 /* filter types */
 306 #define LDAP_FILTER_AND         ((ber_tag_t) 0xa0U)     /* context specific + constructed */
 307 #define LDAP_FILTER_OR          ((ber_tag_t) 0xa1U)     /* context specific + constructed */
 308 #define LDAP_FILTER_NOT         ((ber_tag_t) 0xa2U)     /* context specific + constructed */
 309 #define LDAP_FILTER_EQUALITY    ((ber_tag_t) 0xa3U)     /* context specific + constructed */
 310 #define LDAP_FILTER_SUBSTRINGS  ((ber_tag_t) 0xa4U)     /* context specific + constructed */
 311 #define LDAP_FILTER_GE          ((ber_tag_t) 0xa5U)     /* context specific + constructed */
 312 #define LDAP_FILTER_LE          ((ber_tag_t) 0xa6U)     /* context specific + constructed */
 313 #define LDAP_FILTER_PRESENT     ((ber_tag_t) 0x87U)     /* context specific + primitive   */
 314 #define LDAP_FILTER_APPROX      ((ber_tag_t) 0xa8U)     /* context specific + constructed */
 315 #define LDAP_FILTER_EXT         ((ber_tag_t) 0xa9U)     /* context specific + constructed */
 316
 317 /* extended filter component types */
 318 #define LDAP_FILTER_EXT_OID     ((ber_tag_t) 0x81U)     /* context specific */
 319 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
 320 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
 321 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
 322
 323 /* substring filter component types */
 324 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 325 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
 326 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 327
 328 /* search scopes */
 329 #define LDAP_SCOPE_DEFAULT      ((ber_int_t) -1)
 330 #define LDAP_SCOPE_BASE         ((ber_int_t) 0x0000)
 331 #define LDAP_SCOPE_ONELEVEL     ((ber_int_t) 0x0001)
 332 #define LDAP_SCOPE_SUBTREE      ((ber_int_t) 0x0002)
 333
 334 /* substring filter component types */
 335 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 336 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
 337 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 338
 339 /*
 340  * possible error codes we can return
 341  */
 342
 343 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
 344
 345 #define LDAP_SUCCESS                    0x00
 346 #define LDAP_OPERATIONS_ERROR           0x01
 347 #define LDAP_PROTOCOL_ERROR             0x02
 348 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 349 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 350 #define LDAP_COMPARE_FALSE              0x05
 351 #define LDAP_COMPARE_TRUE               0x06
 352 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
 353 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
 354 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 355 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
 356
 357 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 358 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 359 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
 360 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 361 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 362
 363 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 364
 365 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 366 #define LDAP_UNDEFINED_TYPE             0x11
 367 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 368 #define LDAP_CONSTRAINT_VIOLATION       0x13
 369 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 370 #define LDAP_INVALID_SYNTAX             0x15
 371
 372 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
 373
 374 #define LDAP_NO_SUCH_OBJECT             0x20
 375 #define LDAP_ALIAS_PROBLEM              0x21
 376 #define LDAP_INVALID_DN_SYNTAX          0x22
 377 #define LDAP_IS_LEAF                    0x23 /* not LDAPv3 */
 378 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 379
 380 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x30,0x32) /* 48-50 */
 381
 382 #define LDAP_INAPPROPRIATE_AUTH         0x30
 383 #define LDAP_INVALID_CREDENTIALS        0x31
 384 #define LDAP_INSUFFICIENT_ACCESS        0x32
 385
 386 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
 387
 388 #define LDAP_BUSY                       0x33
 389 #define LDAP_UNAVAILABLE                0x34
 390 #define LDAP_UNWILLING_TO_PERFORM       0x35
 391 #define LDAP_LOOP_DETECT                0x36
 392
 393 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
 394
 395 #define LDAP_NAMING_VIOLATION           0x40
 396 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 397 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 398 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 399 #define LDAP_ALREADY_EXISTS             0x44
 400 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 401 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 402 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
 403
 404 #define LDAP_OTHER                      0x50
 405
 406 #define LDAP_API_ERROR(n)               LDAP_RANGE((n),0x51,0x61) /* 81-97 */
 407 #define LDAP_API_RESULT(n)              (((n) == LDAP_SUCCESS) || \
 408                                                                         LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
 409
 410 /* reserved for APIs */
 411 #define LDAP_SERVER_DOWN                0x51
 412 #define LDAP_LOCAL_ERROR                0x52
 413 #define LDAP_ENCODING_ERROR             0x53
 414 #define LDAP_DECODING_ERROR             0x54
 415 #define LDAP_TIMEOUT                    0x55
 416 #define LDAP_AUTH_UNKNOWN               0x56
 417 #define LDAP_FILTER_ERROR               0x57
 418 #define LDAP_USER_CANCELLED             0x58
 419 #define LDAP_PARAM_ERROR                0x59
 420 #define LDAP_NO_MEMORY                  0x5a
 421
 422 /* used but not reserved for APIs */
 423 #define LDAP_CONNECT_ERROR                              0x5b    /* draft-ietf-ldap-c-api-xx */
 424 #define LDAP_NOT_SUPPORTED                              0x5c    /* draft-ietf-ldap-c-api-xx */
 425 #define LDAP_CONTROL_NOT_FOUND                  0x5d    /* draft-ietf-ldap-c-api-xx */
 426 #define LDAP_NO_RESULTS_RETURNED                0x5e    /* draft-ietf-ldap-c-api-xx */
 427 #define LDAP_MORE_RESULTS_TO_RETURN             0x5f    /* draft-ietf-ldap-c-api-xx */
 428 #define LDAP_CLIENT_LOOP                                0x60    /* draft-ietf-ldap-c-api-xx */
 429 #define LDAP_REFERRAL_LIMIT_EXCEEDED    0x61    /* draft-ietf-ldap-c-api-xx */
 430
 431 /*
 432  * This structure represents both ldap messages and ldap responses.
 433  * These are really the same, except in the case of search responses,
 434  * where a response has multiple messages.
 435  */
 436
 437 typedef struct ldapmsg LDAPMessage;
 438
 439 /* for modifications */
 440 typedef struct ldapmod {
 441         int             mod_op;
 442
 443 #define LDAP_MOD_ADD            ((ber_int_t) 0x0000)
 444 #define LDAP_MOD_DELETE         ((ber_int_t) 0x0001)
 445 #define LDAP_MOD_REPLACE        ((ber_int_t) 0x0002)
 446 #define LDAP_MOD_BVALUES        ((ber_int_t) 0x0080)
 447 /* IMPORTANT: do not use code 0x1000 (or above),
 448  * it is used internally by the backends!
 449  * (see ldap/servers/slapd/slap.h)
 450  */
 451
 452         char            *mod_type;
 453         union mod_vals_u {
 454                 char            **modv_strvals;
 455                 struct berval   **modv_bvals;
 456         } mod_vals;
 457 #define mod_values      mod_vals.modv_strvals
 458 #define mod_bvalues     mod_vals.modv_bvals
 459 } LDAPMod;
 460
 461 /*
 462  * structures for ldap getfilter routines
 463  */
 464
 465 typedef struct ldap_filt_info {
 466         char                    *lfi_filter;
 467         char                    *lfi_desc;
 468         int                     lfi_scope;
 469         int                     lfi_isexact;
 470         struct ldap_filt_info   *lfi_next;
 471 } LDAPFiltInfo;
 472
 473 typedef struct ldap_filt_list {
 474     char                        *lfl_tag;
 475     char                        *lfl_pattern;
 476     char                        *lfl_delims;
 477     LDAPFiltInfo                *lfl_ilist;
 478     struct ldap_filt_list       *lfl_next;
 479 } LDAPFiltList;
 480
 481
 482 #define LDAP_FILT_MAXSIZ        1024
 483
 484 typedef struct ldap_filt_desc {
 485         LDAPFiltList            *lfd_filtlist;
 486         LDAPFiltInfo            *lfd_curfip;
 487         LDAPFiltInfo            lfd_retfi;
 488         char                    lfd_filter[ LDAP_FILT_MAXSIZ ];
 489         char                    *lfd_curval;
 490         char                    *lfd_curvalcopy;
 491         char                    **lfd_curvalwords;
 492         char                    *lfd_filtprefix;
 493         char                    *lfd_filtsuffix;
 494 } LDAPFiltDesc;
 495
 496
 497 /*
 498  * structure representing an ldap session which can
 499  * encompass connections to multiple servers (in the
 500  * face of referrals).
 501  */
 502 typedef struct ldap LDAP;
 503
 504 #define LDAP_DEREF_NEVER        0x00
 505 #define LDAP_DEREF_SEARCHING    0x01
 506 #define LDAP_DEREF_FINDING      0x02
 507 #define LDAP_DEREF_ALWAYS       0x03
 508
 509 #define LDAP_NO_LIMIT           0
 510
 511 /* how many messages to retrieve results for */
 512 #define LDAP_MSG_ONE            0x00
 513 #define LDAP_MSG_ALL            0x01
 514 #define LDAP_MSG_RECEIVED       0x02
 515
 516 /*
 517  * types for ldap URL handling
 518  */
 519 typedef struct ldap_url_desc {
 520         struct ldap_url_desc *lud_next;
 521         char    *lud_scheme;
 522         char    *lud_host;
 523         int             lud_port;
 524         char    *lud_dn;
 525         char    **lud_attrs;
 526         int             lud_scope;
 527         char    *lud_filter;
 528         char    **lud_exts;
 529         int             lud_crit_exts;
 530 } LDAPURLDesc;
 531
 532 #define LDAP_URL_SUCCESS                0x00    /* Success */
 533 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 534 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 535
 536 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 537 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 538 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 539 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 540 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 541 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 542 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 543 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 544
 545 /*
 546  * The API draft spec says we should declare (or cause to be declared)
 547  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 548  */
 549 struct timeval;
 550
 551 /*
 552  * in options.c:
 553  */
 554 LDAP_F( int )
 555 ldap_get_option LDAP_P((
 556         LDAP *ld,
 557         int option,
 558         void *outvalue));
 559
 560 LDAP_F( int )
 561 ldap_set_option LDAP_P((
 562         LDAP *ld,
 563         int option,
 564         LDAP_CONST void *invalue));
 565
 566 /* V3 REBIND Function Callback Prototype */
 567 typedef int (LDAP_REBIND_PROC) LDAP_P((
 568         LDAP *ld, LDAP_CONST char *url,
 569         ber_tag_t request, ber_int_t msgid,
 570         void *params ));
 571
 572 LDAP_F( int )
 573 ldap_set_rebind_proc LDAP_P((
 574         LDAP *ld,
 575         LDAP_REBIND_PROC *rebind_proc,
 576         void *params ));
 577
 578 /*
 579  * in controls.c:
 580  */
 581 LDAP_F( int )
 582 ldap_create_control LDAP_P((
 583         LDAP_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 typedef struct ldap_ava {
1169         struct berval la_attr;
1170         struct berval la_value;
1171         unsigned la_flags;
1172 #define LDAP_AVA_STRING         0x0000U
1173 #define LDAP_AVA_BINARY         0x0001U
1174 #define LDAP_AVA_NONPRINTABLE   0x0002U
1175
1176         void *la_private;
1177 } LDAPAVA;
1178
1179 typedef LDAPAVA** LDAPRDN;
1180 typedef LDAPRDN** LDAPDN;
1181
1182 /* DN formats */
1183 #define LDAP_DN_FORMAT_LDAP             0x0000U
1184 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1185 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1186 #define LDAP_DN_FORMAT_DCE              0x0030U
1187 #define LDAP_DN_FORMAT_UFN              0x0040U /* dn2str only */
1188 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1189 #define LDAP_DN_FORMAT_LBER             0x00F0U /* for testing only */
1190 #define LDAP_DN_FORMAT_MASK             0x00F0U
1191
1192 /* DN flags */
1193 #define LDAP_DN_PRETTY                  0x0100U
1194 #define LDAP_DN_SKIP                    0x0200U
1195 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1196 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1197 #define LDAP_DN_PEDANTIC                0xF000U
1198
1199 LDAP_F( void )
1200 ldap_avafree LDAP_P(( LDAPAVA *ava ));
1201 LDAP_F( void )
1202 ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
1203 LDAP_F( void )
1204 ldap_dnfree LDAP_P(( LDAPDN *dn ));
1205
1206 LDAP_F( int )
1207 ldap_bv2dn LDAP_P((
1208         struct berval *bv,
1209         LDAPDN **dn,
1210         unsigned flags ));
1211
1212 LDAP_F( int )
1213 ldap_str2dn LDAP_P((
1214         LDAP_CONST char *str,
1215         LDAPDN **dn,
1216         unsigned flags ));
1217
1218 LDAP_F( int )
1219 ldap_dn2bv LDAP_P((
1220         LDAPDN *dn,
1221         struct berval *bv,
1222         unsigned flags ));
1223
1224 LDAP_F( int )
1225 ldap_dn2str LDAP_P((
1226         LDAPDN *dn,
1227         char **str,
1228         unsigned flags ));
1229
1230 LDAP_F( int )
1231 ldap_bv2rdn LDAP_P((
1232         struct berval *bv,
1233         LDAPRDN **rdn,
1234         char **next,
1235         unsigned flags ));
1236
1237 LDAP_F( int )
1238 ldap_str2rdn LDAP_P((
1239         LDAP_CONST char *str,
1240         LDAPRDN **rdn,
1241         char **next,
1242         unsigned flags ));
1243
1244 LDAP_F( int )
1245 ldap_rdn2bv LDAP_P((
1246         LDAPRDN *rdn,
1247         struct berval *bv,
1248         unsigned flags ));
1249
1250 LDAP_F( int )
1251 ldap_rdn2str LDAP_P((
1252         LDAPRDN *rdn,
1253         char **str,
1254         unsigned flags ));
1255
1256 LDAP_F( int )
1257 ldap_dn_normalize LDAP_P((
1258         LDAP_CONST char *in, unsigned iflags,
1259         char **out, unsigned oflags ));
1260
1261 LDAP_F( char * )
1262 ldap_dn2ufn LDAP_P(( /* deprecated */
1263         LDAP_CONST char *dn ));
1264
1265 LDAP_F( char ** )
1266 ldap_explode_dn LDAP_P(( /* deprecated */
1267         LDAP_CONST char *dn,
1268         int notypes ));
1269
1270 LDAP_F( char ** )
1271 ldap_explode_rdn LDAP_P(( /* deprecated */
1272         LDAP_CONST char *rdn,
1273         int notypes ));
1274
1275 LDAP_F( char * )
1276 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1277
1278 LDAP_F( char * )
1279 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1280
1281 LDAP_F( char * )
1282 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1283
1284 /*
1285  * in getattr.c
1286  */
1287 LDAP_F( char * )
1288 ldap_first_attribute LDAP_P((
1289         LDAP *ld,
1290         LDAPMessage *entry,
1291         BerElement **ber ));
1292
1293 LDAP_F( char * )
1294 ldap_next_attribute LDAP_P((
1295         LDAP *ld,
1296         LDAPMessage *entry,
1297         BerElement *ber ));
1298
1299
1300 /*
1301  * in getvalues.c
1302  */
1303 LDAP_F( struct berval ** )
1304 ldap_get_values_len LDAP_P((
1305         LDAP *ld,
1306         LDAPMessage *entry,
1307         LDAP_CONST char *target ));
1308
1309 LDAP_F( int )
1310 ldap_count_values_len LDAP_P((
1311         struct berval **vals ));
1312
1313 LDAP_F( void )
1314 ldap_value_free_len LDAP_P((
1315         struct berval **vals ));
1316
1317 LDAP_F( char ** )
1318 ldap_get_values LDAP_P((        /* deprecated */
1319         LDAP *ld,
1320         LDAPMessage *entry,
1321         LDAP_CONST char *target ));
1322
1323 LDAP_F( int )
1324 ldap_count_values LDAP_P((      /* deprecated */
1325         char **vals ));
1326
1327 LDAP_F( void )
1328 ldap_value_free LDAP_P((        /* deprecated */
1329         char **vals ));
1330
1331 /*
1332  * in result.c:
1333  */
1334 LDAP_F( int )
1335 ldap_result LDAP_P((
1336         LDAP *ld,
1337         int msgid,
1338         int all,
1339         struct timeval *timeout,
1340         LDAPMessage **result ));
1341
1342 LDAP_F( int )
1343 ldap_msgtype LDAP_P((
1344         LDAPMessage *lm ));
1345
1346 LDAP_F( int )
1347 ldap_msgid   LDAP_P((
1348         LDAPMessage *lm ));
1349
1350 LDAP_F( int )
1351 ldap_msgfree LDAP_P((
1352         LDAPMessage *lm ));
1353
1354 LDAP_F( int )
1355 ldap_msgdelete LDAP_P((
1356         LDAP *ld,
1357         int msgid ));
1358
1359
1360 /*
1361  * in search.c:
1362  */
1363 LDAP_F( int )
1364 ldap_search_ext LDAP_P((
1365         LDAP                    *ld,
1366         LDAP_CONST char *base,
1367         int                             scope,
1368         LDAP_CONST char *filter,
1369         char                    **attrs,
1370         int                             attrsonly,
1371         LDAPControl             **serverctrls,
1372         LDAPControl             **clientctrls,
1373         struct timeval  *timeout,
1374         int                             sizelimit,
1375         int                             *msgidp ));
1376
1377 LDAP_F( int )
1378 ldap_search_ext_s LDAP_P((
1379         LDAP                    *ld,
1380         LDAP_CONST char *base,
1381         int                             scope,
1382         LDAP_CONST char *filter,
1383         char                    **attrs,
1384         int                             attrsonly,
1385         LDAPControl             **serverctrls,
1386         LDAPControl             **clientctrls,
1387         struct timeval  *timeout,
1388         int                             sizelimit,
1389         LDAPMessage             **res ));
1390
1391 LDAP_F( int )
1392 ldap_search LDAP_P((    /* deprecated */
1393         LDAP *ld,
1394         LDAP_CONST char *base,
1395         int scope,
1396         LDAP_CONST char *filter,
1397         char **attrs,
1398         int attrsonly ));
1399
1400 LDAP_F( int )
1401 ldap_search_s LDAP_P((  /* deprecated */
1402         LDAP *ld,
1403         LDAP_CONST char *base,
1404         int scope,
1405         LDAP_CONST char *filter,
1406         char **attrs,
1407         int attrsonly,
1408         LDAPMessage **res ));
1409
1410 LDAP_F( int )
1411 ldap_search_st LDAP_P(( /* deprecated */
1412         LDAP *ld,
1413         LDAP_CONST char *base,
1414         int scope,
1415         LDAP_CONST char *filter,
1416     char **attrs,
1417         int attrsonly,
1418         struct timeval *timeout,
1419         LDAPMessage **res ));
1420
1421 /*
1422  * in unbind.c
1423  */
1424 LDAP_F( int )
1425 ldap_unbind LDAP_P(( /* deprecated */
1426         LDAP *ld ));
1427
1428 LDAP_F( int )
1429 ldap_unbind_s LDAP_P(( /* deprecated */
1430         LDAP *ld ));
1431
1432 LDAP_F( int )
1433 ldap_unbind_ext LDAP_P((
1434         LDAP                    *ld,
1435         LDAPControl             **serverctrls,
1436         LDAPControl             **clientctrls));
1437
1438 LDAP_F( int )
1439 ldap_unbind_ext_s LDAP_P((
1440         LDAP                    *ld,
1441         LDAPControl             **serverctrls,
1442         LDAPControl             **clientctrls));
1443
1444 /*
1445  * in getfilter.c
1446  *      (deprecated)
1447  */
1448 LDAP_F( LDAPFiltDesc * )
1449 ldap_init_getfilter LDAP_P(( /* deprecated */
1450         LDAP_CONST char *fname ));
1451
1452 LDAP_F( LDAPFiltInfo * )
1453 ldap_getfirstfilter LDAP_P(( /* deprecated */
1454         LDAPFiltDesc *lfdp,
1455         /* LDAP_CONST */ char *tagpat,
1456         /* LDAP_CONST */ char *value ));
1457
1458 LDAP_F( LDAPFiltInfo * )
1459 ldap_getnextfilter LDAP_P(( /* deprecated */
1460         LDAPFiltDesc *lfdp ));
1461
1462
1463 /*
1464  * in free.c
1465  */
1466
1467 LDAP_F( void * )
1468 ldap_memalloc LDAP_P((
1469         ber_len_t s ));
1470
1471 LDAP_F( void * )
1472 ldap_memrealloc LDAP_P((
1473         void* p,
1474         ber_len_t s ));
1475
1476 LDAP_F( void * )
1477 ldap_memcalloc LDAP_P((
1478         ber_len_t n,
1479         ber_len_t s ));
1480
1481 LDAP_F( void )
1482 ldap_memfree LDAP_P((
1483         void* p ));
1484
1485 LDAP_F( void )
1486 ldap_memvfree LDAP_P((
1487         void** v ));
1488
1489 LDAP_F( char * )
1490 ldap_strdup LDAP_P((
1491         LDAP_CONST char * ));
1492
1493 LDAP_F( void )
1494 ldap_getfilter_free LDAP_P((
1495         LDAPFiltDesc *lfdp ));
1496
1497 LDAP_F( void )
1498 ldap_mods_free LDAP_P((
1499         LDAPMod **mods,
1500         int freemods ));
1501
1502
1503 /*
1504  * in sort.c
1505  *      (deprecated)
1506  */
1507 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1508         LDAP_CONST char *left,
1509         LDAP_CONST char *right ));
1510
1511 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1512         LDAP_CONST void *left,
1513         LDAP_CONST void *right ));
1514
1515 LDAP_F( int )   /* deprecated */
1516 ldap_sort_entries LDAP_P(( LDAP *ld,
1517         LDAPMessage **chain,
1518         LDAP_CONST char *attr,
1519         LDAP_SORT_AD_CMP_PROC *cmp ));
1520
1521 LDAP_F( int )   /* deprecated */
1522 ldap_sort_values LDAP_P((
1523         LDAP *ld,
1524         char **vals,
1525         LDAP_SORT_AV_CMP_PROC *cmp ));
1526
1527 LDAP_F( int ) /* deprecated */
1528 ldap_sort_strcasecmp LDAP_P((
1529         LDAP_CONST void *a,
1530         LDAP_CONST void *b ));
1531
1532
1533 /*
1534  * in url.c
1535  */
1536 LDAP_F( int )
1537 ldap_is_ldap_url LDAP_P((
1538         LDAP_CONST char *url ));
1539
1540 LDAP_F( int )
1541 ldap_is_ldaps_url LDAP_P((
1542         LDAP_CONST char *url ));
1543
1544 LDAP_F( int )
1545 ldap_is_ldapi_url LDAP_P((
1546         LDAP_CONST char *url ));
1547
1548 LDAP_F( int )
1549 ldap_url_parse LDAP_P((
1550         LDAP_CONST char *url,
1551         LDAPURLDesc **ludpp ));
1552
1553 LDAP_F( char * )
1554 ldap_url_desc2str LDAP_P((
1555         LDAPURLDesc *ludp ));
1556
1557 LDAP_F( void )
1558 ldap_free_urldesc LDAP_P((
1559         LDAPURLDesc *ludp ));
1560
1561 /*
1562  * in sortctrl.c
1563  */
1564 /*
1565  * structure for a sort-key
1566  */
1567 typedef struct ldapsortkey {
1568         char *  attributeType;
1569         char *  orderingRule;
1570         int     reverseOrder;
1571 } LDAPSortKey;
1572
1573 LDAP_F( int )
1574 ldap_create_sort_keylist LDAP_P((
1575         LDAPSortKey ***sortKeyList,
1576         char        *keyString ));
1577
1578 LDAP_F( void )
1579 ldap_free_sort_keylist LDAP_P((
1580         LDAPSortKey **sortkeylist ));
1581
1582 LDAP_F( int )
1583 ldap_create_sort_control LDAP_P((
1584         LDAP *ld,
1585         LDAPSortKey **keyList,
1586         int ctl_iscritical,
1587         LDAPControl **ctrlp ));
1588
1589 LDAP_F( int )
1590 ldap_parse_sort_control LDAP_P((
1591         LDAP           *ld,
1592         LDAPControl    **ctrlp,
1593         unsigned long  *result,
1594         char           **attribute ));
1595
1596
1597 /*
1598  * in vlvctrl.c
1599  */
1600
1601 /*
1602  * structure for virtul list.
1603  */
1604 typedef struct ldapvlvinfo {
1605         int             ldvlv_version;
1606     unsigned long   ldvlv_before_count;
1607     unsigned long   ldvlv_after_count;
1608     unsigned long   ldvlv_offset;
1609     unsigned long   ldvlv_count;
1610     struct berval  *ldvlv_attrvalue;
1611     struct berval  *ldvlv_context;
1612     void           *ldvlv_extradata;
1613 } LDAPVLVInfo;
1614
1615 LDAP_F( int )
1616 ldap_create_vlv_control LDAP_P((
1617         LDAP *ld,
1618         LDAPVLVInfo *ldvlistp,
1619         LDAPControl **ctrlp ));
1620
1621 LDAP_F( int )
1622 ldap_parse_vlv_control LDAP_P((
1623         LDAP          *ld,
1624         LDAPControl   **ctrls,
1625         unsigned long *target_posp,
1626         unsigned long *list_countp,
1627         struct berval **contextp,
1628         int           *errcodep ));
1629
1630
1631 LDAP_END_DECL
1632 #endif /* _LDAP_H */