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