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