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

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