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

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