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