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