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-2006 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 use 3000+n here because it is above 1823 (for RFC 1823),
  47  * above 2000+rev of IETF LDAPEXT draft (now quite dated),
  48  * yet below allocations for new RFCs (just in case there is
  49  * someday an RFC produced).
  50  */
  51 #define LDAP_API_VERSION        3001
  52 #define LDAP_VENDOR_NAME        "OpenLDAP"
  53
  54 /* OpenLDAP API Features */
  55 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
  56
  57 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
  58         ( defined( LDAP_THREAD_SAFE ) && \
  59                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
  60         /* -lldap may or may not be thread safe */
  61         /* -lldap_r, if available, is always thread safe */
  62 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
  63 #endif
  64 #if defined( LDAP_THREAD_SAFE ) && \
  65         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
  66 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
  67 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
  68 #endif
  69
  70
  71 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
  72 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
  73
  74 #define LDAP_ROOT_DSE                           ""
  75 #define LDAP_NO_ATTRS                           "1.1"
  76 #define LDAP_ALL_USER_ATTRIBUTES        "*"
  77 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* RFC 3673 */
  78
  79 /* RFC 4511:  maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
  80 #define LDAP_MAXINT (2147483647)
  81
  82 /*
  83  * LDAP_OPTions
  84  *      0x0000 - 0x0fff reserved for api options
  85  *      0x1000 - 0x3fff reserved for api extended options
  86  *      0x4000 - 0x7fff reserved for private and experimental options
  87  */
  88
  89 #define LDAP_OPT_API_INFO                       0x0000
  90 #define LDAP_OPT_DESC                           0x0001 /* historic */
  91 #define LDAP_OPT_DEREF                          0x0002
  92 #define LDAP_OPT_SIZELIMIT                      0x0003
  93 #define LDAP_OPT_TIMELIMIT                      0x0004
  94 /* 0x05 - 0x07 not defined */
  95 #define LDAP_OPT_REFERRALS                      0x0008
  96 #define LDAP_OPT_RESTART                        0x0009
  97 /* 0x0a - 0x10 not defined */
  98 #define LDAP_OPT_PROTOCOL_VERSION       0x0011
  99 #define LDAP_OPT_SERVER_CONTROLS        0x0012
 100 #define LDAP_OPT_CLIENT_CONTROLS        0x0013
 101 /* 0x14 not defined */
 102 #define LDAP_OPT_API_FEATURE_INFO       0x0015
 103 /* 0x16 - 0x2f not defined */
 104 #define LDAP_OPT_HOST_NAME                      0x0030
 105 #define LDAP_OPT_RESULT_CODE            0x0031
 106 #define LDAP_OPT_ERROR_NUMBER           LDAP_OPT_RESULT_CODE
 107 #define LDAP_OPT_ERROR_STRING           0x0032
 108 #define LDAP_OPT_MATCHED_DN                     0x0033
 109 /* 0x0034 - 0x3fff not defined */
 110
 111 /* API Extensions */
 112 #define LDAP_OPT_API_EXTENSION_BASE 0x4000  /* API extensions */
 113
 114 /* private and experimental options */
 115 /* OpenLDAP specific options */
 116 #define LDAP_OPT_DEBUG_LEVEL            0x5001  /* debug level */
 117 #define LDAP_OPT_TIMEOUT                        0x5002  /* default timeout */
 118 #define LDAP_OPT_REFHOPLIMIT            0x5003  /* ref hop limit */
 119 #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
 120 #define LDAP_OPT_URI                            0x5006
 121 #define LDAP_OPT_REFERRAL_URLS      0x5007  /* Referral URLs */
 122 #define LDAP_OPT_SOCKBUF            0x5008  /* sockbuf */
 123 #define LDAP_OPT_DEFBASE                0x5009  /* searchbase */
 124
 125 /* OpenLDAP TLS options */
 126 #define LDAP_OPT_X_TLS                          0x6000
 127 #define LDAP_OPT_X_TLS_CTX                      0x6001  /* OpenSSL CTX */
 128 #define LDAP_OPT_X_TLS_CACERTFILE       0x6002
 129 #define LDAP_OPT_X_TLS_CACERTDIR        0x6003
 130 #define LDAP_OPT_X_TLS_CERTFILE         0x6004
 131 #define LDAP_OPT_X_TLS_KEYFILE          0x6005
 132 #define LDAP_OPT_X_TLS_REQUIRE_CERT     0x6006
 133 /* #define LDAP_OPT_X_TLS_PROTOCOL              0x6007 */
 134 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6008
 135 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x6009
 136 #define LDAP_OPT_X_TLS_SSL_CTX          0x600a
 137 #define LDAP_OPT_X_TLS_CRLCHECK         0x600b
 138 #define LDAP_OPT_X_TLS_CONNECT_CB       0x600c
 139 #define LDAP_OPT_X_TLS_CONNECT_ARG      0x600d
 140 #define LDAP_OPT_X_TLS_DHFILE           0x600e
 141 #define LDAP_OPT_X_TLS_NEWCTX           0x600f
 142
 143 #define LDAP_OPT_X_TLS_NEVER    0
 144 #define LDAP_OPT_X_TLS_HARD             1
 145 #define LDAP_OPT_X_TLS_DEMAND   2
 146 #define LDAP_OPT_X_TLS_ALLOW    3
 147 #define LDAP_OPT_X_TLS_TRY              4
 148
 149 #define LDAP_OPT_X_TLS_CRL_NONE 0
 150 #define LDAP_OPT_X_TLS_CRL_PEER 1
 151 #define LDAP_OPT_X_TLS_CRL_ALL  2
 152
 153 /* OpenLDAP SASL options */
 154 #define LDAP_OPT_X_SASL_MECH                    0x6100
 155 #define LDAP_OPT_X_SASL_REALM                   0x6101
 156 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
 157 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
 158 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
 159 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
 160 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
 161 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
 162 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
 163 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
 164
 165 /* Private API Extensions -- reserved for application use */
 166 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000  /* Private API inclusive */
 167
 168 /*
 169  * ldap_get_option() and ldap_set_option() return values.
 170  * As later versions may return other values indicating
 171  * failure, current applications should only compare returned
 172  * value against LDAP_OPT_SUCCESS.
 173  */
 174 #define LDAP_OPT_SUCCESS        0
 175 #define LDAP_OPT_ERROR          (-1)
 176
 177 /* option on/off values */
 178 #define LDAP_OPT_ON             ((void *) &ber_pvt_opt_on)
 179 #define LDAP_OPT_OFF    ((void *) 0)
 180
 181 typedef struct ldapapiinfo {
 182         int             ldapai_info_version;            /* version of LDAPAPIInfo */
 183 #define LDAP_API_INFO_VERSION   (1)
 184         int             ldapai_api_version;                     /* revision of API supported */
 185         int             ldapai_protocol_version;        /* highest LDAP version supported */
 186         char    **ldapai_extensions;            /* names of API extensions */
 187         char    *ldapai_vendor_name;            /* name of supplier */
 188         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
 189 } LDAPAPIInfo;
 190
 191 typedef struct ldap_apifeature_info {
 192         int             ldapaif_info_version;           /* version of LDAPAPIFeatureInfo */
 193 #define LDAP_FEATURE_INFO_VERSION (1)   /* apifeature_info struct version */
 194         char*   ldapaif_name;                           /* LDAP_API_FEATURE_* (less prefix) */
 195         int             ldapaif_version;                        /* value of LDAP_API_FEATURE_... */
 196 } LDAPAPIFeatureInfo;
 197
 198 /*
 199  * LDAP Control structure
 200  */
 201 typedef struct ldapcontrol {
 202         char *                  ldctl_oid;                      /* numericoid of control */
 203         struct berval   ldctl_value;            /* encoded value of control */
 204         char                    ldctl_iscritical;       /* criticality */
 205 } LDAPControl;
 206
 207 /* LDAP Controls */
 208 /*      standard track controls */
 209 #define LDAP_CONTROL_MANAGEDSAIT        "2.16.840.1.113730.3.4.2"  /* RFC 3296 */
 210 #define LDAP_CONTROL_PROXY_AUTHZ        "2.16.840.1.113730.3.4.18" /* RFC 4370 */
 211 #define LDAP_CONTROL_SUBENTRIES         "1.3.6.1.4.1.4203.1.10.1"  /* RFC 3672 */
 212
 213 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
 214
 215 #define LDAP_CONTROL_ASSERT                             "1.3.6.1.1.12"                  /* RFC 4528 */
 216 #define LDAP_CONTROL_PRE_READ                   "1.3.6.1.1.13.1"                /* RFC 4527 */
 217 #define LDAP_CONTROL_POST_READ                  "1.3.6.1.1.13.2"                /* RFC 4527 */
 218
 219 /*  standard track - not implemented in slapd(8) */
 220 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473" /* RFC 2891 */
 221 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474" /* RFC 2891 */
 222
 223 /*      non-standard track controls */
 224 #define LDAP_CONTROL_PAGEDRESULTS       "1.2.840.113556.1.4.319"   /* RFC 2696 */
 225
 226 /* LDAP Content Synchronization Operation -- RFC 4533 */
 227 #define LDAP_SYNC_OID                   "1.3.6.1.4.1.4203.1.9.1"
 228 #define LDAP_CONTROL_SYNC               LDAP_SYNC_OID ".1"
 229 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
 230 #define LDAP_CONTROL_SYNC_DONE  LDAP_SYNC_OID ".3"
 231 #define LDAP_SYNC_INFO                  LDAP_SYNC_OID ".4"
 232
 233 #define LDAP_SYNC_NONE                                  0x00
 234 #define LDAP_SYNC_REFRESH_ONLY                  0x01
 235 #define LDAP_SYNC_RESERVED                              0x02
 236 #define LDAP_SYNC_REFRESH_AND_PERSIST   0x03
 237
 238 #define LDAP_SYNC_REFRESH_PRESENTS              0
 239 #define LDAP_SYNC_REFRESH_DELETES               1
 240
 241 #define LDAP_TAG_SYNC_NEW_COOKIE                ((ber_tag_t) 0x80U)
 242 #define LDAP_TAG_SYNC_REFRESH_DELETE    ((ber_tag_t) 0xa1U)
 243 #define LDAP_TAG_SYNC_REFRESH_PRESENT   ((ber_tag_t) 0xa2U)
 244 #define LDAP_TAG_SYNC_ID_SET                    ((ber_tag_t) 0xa3U)
 245
 246 #define LDAP_TAG_SYNC_COOKIE                    ((ber_tag_t) 0x04U)
 247 #define LDAP_TAG_REFRESHDELETES                 ((ber_tag_t) 0x01U)
 248 #define LDAP_TAG_REFRESHDONE                    ((ber_tag_t) 0x01U)
 249 #define LDAP_TAG_RELOAD_HINT                    ((ber_tag_t) 0x01U)
 250
 251 #define LDAP_SYNC_PRESENT                               0
 252 #define LDAP_SYNC_ADD                                   1
 253 #define LDAP_SYNC_MODIFY                                2
 254 #define LDAP_SYNC_DELETE                                3
 255
 256
 257 /* Password policy Controls *//* work in progress */
 258 /* ITS#3458: released; disabled by default */
 259 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST      "1.3.6.1.4.1.42.2.27.8.5.1"
 260 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE     "1.3.6.1.4.1.42.2.27.8.5.1"
 261
 262 /* various works in progress */
 263 #define LDAP_CONTROL_NOOP                               "1.3.6.1.4.1.4203.666.5.2"
 264 #define LDAP_CONTROL_NO_SUBORDINATES    "1.3.6.1.4.1.4203.666.5.11"
 265 #define LDAP_CONTROL_MANAGEDIT                  "1.3.6.1.4.1.4203.666.5.12"
 266 #define LDAP_CONTROL_SLURP                              "1.3.6.1.4.1.4203.666.5.13"
 267 #define LDAP_CONTROL_VALSORT                    "1.3.6.1.4.1.4203.666.5.14"
 268 #define LDAP_CONTROL_DONTUSECOPY                "1.3.6.1.4.1.4203.666.5.15"
 269
 270
 271 /* LDAP Chaining Behavior Control *//* work in progress */
 272 /* <draft-sermersheim-ldap-chaining>;
 273  * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
 274 #ifdef LDAP_DEVEL
 275 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR        "1.3.6.1.4.1.4203.666.11.3"
 276
 277 #define LDAP_CHAINING_PREFERRED                         0
 278 #define LDAP_CHAINING_REQUIRED                          1
 279 #define LDAP_REFERRALS_PREFERRED                        2
 280 #define LDAP_REFERRALS_REQUIRED                         3
 281 #endif
 282
 283 /* MS Active Directory controls (for compatibility) */
 284 #define LDAP_CONTROL_X_INCREMENTAL_VALUES       "1.2.840.113556.1.4.802"
 285 #define LDAP_CONTROL_X_DOMAIN_SCOPE                     "1.2.840.113556.1.4.1339"
 286 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY        "1.2.840.113556.1.4.1413"
 287 #define LDAP_CONTROL_X_SEARCH_OPTIONS           "1.2.840.113556.1.4.1340"
 288 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
 289 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
 290
 291 /* MS Active Directory controls - not implemented in slapd(8) */
 292 #define LDAP_CONTROL_X_TREE_DELETE              "1.2.840.113556.1.4.805"
 293 #define LDAP_CONTROL_X_EXTENDED_DN              "1.2.840.113556.1.4.529"
 294
 295 /* various expired works */
 296 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
 297 #define LDAP_CONTROL_DUPENT_REQUEST             "2.16.840.1.113719.1.27.101.1"
 298 #define LDAP_CONTROL_DUPENT_RESPONSE    "2.16.840.1.113719.1.27.101.2"
 299 #define LDAP_CONTROL_DUPENT_ENTRY               "2.16.840.1.113719.1.27.101.3"
 300 #define LDAP_CONTROL_DUPENT     LDAP_CONTROL_DUPENT_REQUEST
 301
 302 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
 303 #define LDAP_CONTROL_PERSIST_REQUEST                            "2.16.840.1.113730.3.4.3"
 304 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE        "2.16.840.1.113730.3.4.7"
 305 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD           0x1
 306 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE        0x2
 307 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY        0x4
 308 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME        0x8
 309
 310 /* LDAP VLV *//* not implemented in slapd(8) */
 311 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
 312 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 313
 314
 315 /* LDAP Unsolicited Notifications */
 316 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
 317 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 318
 319 /* LDAP Extended Operations */
 320 #define LDAP_EXOP_START_TLS             "1.3.6.1.4.1.1466.20037"        /* RFC 4511 */
 321
 322 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"       /* RFC 3062 */
 323 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
 324 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
 325 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
 326 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
 327
 328 #define LDAP_EXOP_CANCEL                "1.3.6.1.1.8"                                   /* RFC 3909 */
 329 #define LDAP_EXOP_X_CANCEL              LDAP_EXOP_CANCEL
 330
 331 #define LDAP_EXOP_REFRESH               "1.3.6.1.4.1.1466.101.119.1"    /* RFC 2589 */
 332 #define LDAP_TAG_EXOP_REFRESH_REQ_DN    ((ber_tag_t) 0x80U)
 333 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL   ((ber_tag_t) 0x81U)
 334 #define LDAP_TAG_EXOP_REFRESH_RES_TTL   ((ber_tag_t) 0x80U)
 335
 336 #define LDAP_EXOP_WHO_AM_I              "1.3.6.1.4.1.4203.1.11.3"               /* RFC 4532 */
 337 #define LDAP_EXOP_X_WHO_AM_I    LDAP_EXOP_WHO_AM_I
 338
 339 /* various works in progress */
 340 #ifdef LDAP_DEVEL
 341 #define LDAP_EXOP_X_TURN                "1.3.6.1.4.1.4203.666.6.4"              /* RFC 4531 */
 342 #endif
 343
 344 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
 345 /* a work in progress */
 346 #ifdef LDAP_DEVEL
 347 #define LDAP_X_DISTPROC_BASE            "1.3.6.1.4.1.4203.666.11.6"
 348 #define LDAP_EXOP_X_CHAINEDREQUEST      LDAP_X_DISTPROC_BASE ".1"
 349 #define LDAP_FEATURE_X_CANCHAINOPS      LDAP_X_DISTPROC_BASE ".2"
 350 #define LDAP_CONTROL_X_RETURNCONTREF    LDAP_X_DISTPROC_BASE ".3"
 351 #define LDAP_URLEXT_X_LOCALREFOID       LDAP_X_DISTPROC_BASE ".4"
 352 #define LDAP_URLEXT_X_REFTYPEOID        LDAP_X_DISTPROC_BASE ".5"
 353 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
 354                                         LDAP_X_DISTPROC_BASE ".6"
 355 #define LDAP_URLEXT_X_FAILEDNAMEOID     LDAP_X_DISTPROC_BASE ".7"
 356 #define LDAP_URLEXT_X_LOCALREF          "x-localReference"
 357 #define LDAP_URLEXT_X_REFTYPE           "x-referenceType"
 358 #define LDAP_URLEXT_X_SEARCHEDSUBTREE   "x-searchedSubtree"
 359 #define LDAP_URLEXT_X_FAILEDNAME        "x-failedName"
 360 #endif
 361
 362 #ifdef LDAP_DEVEL
 363 #define LDAP_X_TXN                                              "1.3.6.1.4.1.4203.666.11.7" /* temp */
 364 #define LDAP_EXOP_X_TXN_START                   LDAP_X_TXN ".1"
 365 #define LDAP_CONTROL_X_TXN_SPEC                 LDAP_X_TXN ".2"
 366 #define LDAP_EXOP_X_TXN_END                             LDAP_X_TXN ".3"
 367 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE  LDAP_X_TXN ".4"
 368 #endif
 369
 370 /* LDAP Features */
 371 #define LDAP_FEATURE_ALL_OP_ATTRS       "1.3.6.1.4.1.4203.1.5.1"        /* RFC 3673 */
 372 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
 373         "1.3.6.1.4.1.4203.1.5.2" /*  @objectClass - new number to be assigned */
 374 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
 375 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
 376 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
 377 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
 378
 379 #ifdef LDAP_DEVEL
 380 /* LDAP Experimental (works in progress) Features */
 381 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
 382         "1.3.6.1.4.1.4203.666.8.1" /* "children" */
 383 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
 384 #endif
 385
 386 /*
 387  * specific LDAP instantiations of BER types we know about
 388  */
 389
 390 /* Overview of LBER tag construction
 391  *
 392  *      Bits
 393  *      ______
 394  *      8 7 | CLASS
 395  *      0 0 = UNIVERSAL
 396  *      0 1 = APPLICATION
 397  *      1 0 = CONTEXT-SPECIFIC
 398  *      1 1 = PRIVATE
 399  *              _____
 400  *              | 6 | DATA-TYPE
 401  *                0 = PRIMITIVE
 402  *                1 = CONSTRUCTED
 403  *                      ___________
 404  *                      | 5 ... 1 | TAG-NUMBER
 405  */
 406
 407 /* general stuff */
 408 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
 409 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
 410
 411 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octet string */
 412 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octet string */
 413
 414 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
 415 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
 416
 417 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
 418
 419 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
 420 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
 421 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
 422 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
 423
 424 #define LDAP_TAG_IM_RES_OID   ((ber_tag_t) 0x80U)       /* context specific + primitive */
 425 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U)       /* context specific + primitive */
 426
 427 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
 428
 429 /* LDAP Request Messages */
 430 #define LDAP_REQ_BIND           ((ber_tag_t) 0x60U)     /* application + constructed */
 431 #define LDAP_REQ_UNBIND         ((ber_tag_t) 0x42U)     /* application + primitive   */
 432 #define LDAP_REQ_SEARCH         ((ber_tag_t) 0x63U)     /* application + constructed */
 433 #define LDAP_REQ_MODIFY         ((ber_tag_t) 0x66U)     /* application + constructed */
 434 #define LDAP_REQ_ADD            ((ber_tag_t) 0x68U)     /* application + constructed */
 435 #define LDAP_REQ_DELETE         ((ber_tag_t) 0x4aU)     /* application + primitive   */
 436 #define LDAP_REQ_MODDN          ((ber_tag_t) 0x6cU)     /* application + constructed */
 437 #define LDAP_REQ_MODRDN         LDAP_REQ_MODDN
 438 #define LDAP_REQ_RENAME         LDAP_REQ_MODDN
 439 #define LDAP_REQ_COMPARE        ((ber_tag_t) 0x6eU)     /* application + constructed */
 440 #define LDAP_REQ_ABANDON        ((ber_tag_t) 0x50U)     /* application + primitive   */
 441 #define LDAP_REQ_EXTENDED       ((ber_tag_t) 0x77U)     /* application + constructed */
 442
 443 /* LDAP Response Messages */
 444 #define LDAP_RES_BIND           ((ber_tag_t) 0x61U)     /* application + constructed */
 445 #define LDAP_RES_SEARCH_ENTRY   ((ber_tag_t) 0x64U)     /* application + constructed */
 446 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
 447 #define LDAP_RES_SEARCH_RESULT  ((ber_tag_t) 0x65U)     /* application + constructed */
 448 #define LDAP_RES_MODIFY         ((ber_tag_t) 0x67U)     /* application + constructed */
 449 #define LDAP_RES_ADD            ((ber_tag_t) 0x69U)     /* application + constructed */
 450 #define LDAP_RES_DELETE         ((ber_tag_t) 0x6bU)     /* application + constructed */
 451 #define LDAP_RES_MODDN          ((ber_tag_t) 0x6dU)     /* application + constructed */
 452 #define LDAP_RES_MODRDN         LDAP_RES_MODDN  /* application + constructed */
 453 #define LDAP_RES_RENAME         LDAP_RES_MODDN  /* application + constructed */
 454 #define LDAP_RES_COMPARE        ((ber_tag_t) 0x6fU)     /* application + constructed */
 455 #define LDAP_RES_EXTENDED       ((ber_tag_t) 0x78U)     /* V3: application + constructed */
 456 #define LDAP_RES_INTERMEDIATE   ((ber_tag_t) 0x79U) /* V3+: application + constructed */
 457
 458 #define LDAP_RES_ANY                    (-1)
 459 #define LDAP_RES_UNSOLICITED    (0)
 460
 461
 462 /* sasl methods */
 463 #define LDAP_SASL_SIMPLE        ((char*)0)
 464 #define LDAP_SASL_NULL          ("")
 465
 466
 467 /* authentication methods available */
 468 #define LDAP_AUTH_NONE   ((ber_tag_t) 0x00U) /* no authentication */
 469 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
 470 #define LDAP_AUTH_SASL   ((ber_tag_t) 0xa3U) /* context specific + constructed */
 471 #define LDAP_AUTH_KRBV4  ((ber_tag_t) 0xffU) /* means do both of the following */
 472 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
 473 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
 474
 475
 476 /* filter types */
 477 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U)     /* context specific + constructed */
 478 #define LDAP_FILTER_OR  ((ber_tag_t) 0xa1U)     /* context specific + constructed */
 479 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U)     /* context specific + constructed */
 480 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
 481 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
 482 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
 483 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
 484 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive   */
 485 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U)  /* context specific + constructed */
 486 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U)     /* context specific + constructed */
 487
 488 /* extended filter component types */
 489 #define LDAP_FILTER_EXT_OID             ((ber_tag_t) 0x81U)     /* context specific */
 490 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
 491 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
 492 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
 493
 494 /* substring filter component types */
 495 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 496 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
 497 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 498
 499 /* search scopes */
 500 #define LDAP_SCOPE_BASE                 ((ber_int_t) 0x0000)
 501 #define LDAP_SCOPE_BASEOBJECT   LDAP_SCOPE_BASE
 502 #define LDAP_SCOPE_ONELEVEL             ((ber_int_t) 0x0001)
 503 #define LDAP_SCOPE_ONE                  LDAP_SCOPE_ONELEVEL
 504 #define LDAP_SCOPE_SUBTREE              ((ber_int_t) 0x0002)
 505 #define LDAP_SCOPE_SUB                  LDAP_SCOPE_SUBTREE
 506 #define LDAP_SCOPE_SUBORDINATE  ((ber_int_t) 0x0003) /* OpenLDAP extension */
 507 #define LDAP_SCOPE_CHILDREN             LDAP_SCOPE_SUBORDINATE
 508 #define LDAP_SCOPE_DEFAULT              ((ber_int_t) -1)         /* OpenLDAP extension */
 509
 510 /* substring filter component types */
 511 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 512 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
 513 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 514
 515 /*
 516  * LDAP Result Codes
 517  */
 518 #define LDAP_SUCCESS                            0x00
 519
 520 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
 521
 522 #define LDAP_OPERATIONS_ERROR           0x01
 523 #define LDAP_PROTOCOL_ERROR                     0x02
 524 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 525 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 526 #define LDAP_COMPARE_FALSE                      0x05
 527 #define LDAP_COMPARE_TRUE                       0x06
 528 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
 529 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
 530 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 531 #define LDAP_STRONGER_AUTH_REQUIRED     LDAP_STRONG_AUTH_REQUIRED
 532 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
 533
 534 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 535 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 536 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
 537 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 538 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 539
 540 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 541
 542 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 543 #define LDAP_UNDEFINED_TYPE                     0x11
 544 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 545 #define LDAP_CONSTRAINT_VIOLATION       0x13
 546 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 547 #define LDAP_INVALID_SYNTAX                     0x15
 548
 549 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
 550
 551 #define LDAP_NO_SUCH_OBJECT                     0x20
 552 #define LDAP_ALIAS_PROBLEM                      0x21
 553 #define LDAP_INVALID_DN_SYNTAX          0x22
 554 #define LDAP_IS_LEAF                            0x23 /* not LDAPv3 */
 555 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 556
 557 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
 558
 559 #define LDAP_X_PROXY_AUTHZ_FAILURE      0x2F /* LDAPv3 proxy authorization */
 560 #define LDAP_INAPPROPRIATE_AUTH         0x30
 561 #define LDAP_INVALID_CREDENTIALS        0x31
 562 #define LDAP_INSUFFICIENT_ACCESS        0x32
 563
 564 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
 565
 566 #define LDAP_BUSY                                       0x33
 567 #define LDAP_UNAVAILABLE                        0x34
 568 #define LDAP_UNWILLING_TO_PERFORM       0x35
 569 #define LDAP_LOOP_DETECT                        0x36
 570
 571 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
 572
 573 #define LDAP_NAMING_VIOLATION           0x40
 574 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 575 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 576 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 577 #define LDAP_ALREADY_EXISTS                     0x44
 578 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 579 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 580 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47
 581
 582 #define LDAP_OTHER                                      0x50
 583
 584 /* LCUP operation codes (113-117) - not implemented */
 585 #define LDAP_CUP_RESOURCES_EXHAUSTED    0x71
 586 #define LDAP_CUP_SECURITY_VIOLATION             0x72
 587 #define LDAP_CUP_INVALID_DATA                   0x73
 588 #define LDAP_CUP_UNSUPPORTED_SCHEME             0x74
 589 #define LDAP_CUP_RELOAD_REQUIRED                0x75
 590
 591 /* Cancel operation codes (118-121) */
 592 #define LDAP_CANCELLED                          0x76
 593 #define LDAP_NO_SUCH_OPERATION          0x77
 594 #define LDAP_TOO_LATE                           0x78
 595 #define LDAP_CANNOT_CANCEL                      0x79
 596
 597 /* Assertion control (122) */
 598 #define LDAP_ASSERTION_FAILED           0x7A
 599
 600 /* Proxied Authorization Denied (123) */
 601 #define LDAP_PROXIED_AUTHORIZATION_DENIED               0x7B
 602
 603 /* Experimental result codes */
 604 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
 605
 606 /* LDAP Sync (4096) */
 607 #define LDAP_SYNC_REFRESH_REQUIRED              0x1000
 608
 609
 610 /* Private Use result codes */
 611 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
 612
 613 #define LDAP_X_SYNC_REFRESH_REQUIRED    0x4100 /* defunct */
 614 #define LDAP_X_ASSERTION_FAILED                 0x410f /* defunct */
 615
 616 /* for the LDAP No-Op control */
 617 #define LDAP_X_NO_OPERATION                             0x410e
 618
 619 /* for the Chaining Behavior control (consecutive result codes requested;
 620  * see <draft-sermersheim-ldap-chaining> ) */
 621 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
 622 #define LDAP_X_NO_REFERRALS_FOUND               0x4110
 623 #define LDAP_X_CANNOT_CHAIN                     0x4111
 624 #endif
 625
 626 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
 627 #ifdef LDAP_X_DISTPROC_BASE
 628 #define LDAP_X_INVALIDREFERENCE                 0x4112
 629 #endif
 630
 631 #ifdef LDAP_X_TXN
 632 #define LDAP_X_TXN_SPECIFY_OKAY         0x4120
 633 #define LDAP_X_TXN_ID_INVALID           0x4121
 634 #endif
 635
 636 /* API Error Codes
 637  *
 638  * Based on draft-ietf-ldap-c-api-xx
 639  * but with new negative code values
 640  */
 641 #define LDAP_API_ERROR(n)               ((n)<0)
 642 #define LDAP_API_RESULT(n)              ((n)<=0)
 643
 644 #define LDAP_SERVER_DOWN                                (-1)
 645 #define LDAP_LOCAL_ERROR                                (-2)
 646 #define LDAP_ENCODING_ERROR                             (-3)
 647 #define LDAP_DECODING_ERROR                             (-4)
 648 #define LDAP_TIMEOUT                                    (-5)
 649 #define LDAP_AUTH_UNKNOWN                               (-6)
 650 #define LDAP_FILTER_ERROR                               (-7)
 651 #define LDAP_USER_CANCELLED                             (-8)
 652 #define LDAP_PARAM_ERROR                                (-9)
 653 #define LDAP_NO_MEMORY                                  (-10)
 654 #define LDAP_CONNECT_ERROR                              (-11)
 655 #define LDAP_NOT_SUPPORTED                              (-12)
 656 #define LDAP_CONTROL_NOT_FOUND                  (-13)
 657 #define LDAP_NO_RESULTS_RETURNED                (-14)
 658 #define LDAP_MORE_RESULTS_TO_RETURN             (-15)   /* Obsolete */
 659 #define LDAP_CLIENT_LOOP                                (-16)
 660 #define LDAP_REFERRAL_LIMIT_EXCEEDED    (-17)
 661
 662
 663 /*
 664  * This structure represents both ldap messages and ldap responses.
 665  * These are really the same, except in the case of search responses,
 666  * where a response has multiple messages.
 667  */
 668
 669 typedef struct ldapmsg LDAPMessage;
 670
 671 /* for modifications */
 672 typedef struct ldapmod {
 673         int             mod_op;
 674
 675 #define LDAP_MOD_OP                     (0x0007)
 676 #define LDAP_MOD_ADD            (0x0000)
 677 #define LDAP_MOD_DELETE         (0x0001)
 678 #define LDAP_MOD_REPLACE        (0x0002)
 679 #define LDAP_MOD_INCREMENT      (0x0003) /* OpenLDAP extension */
 680 #define LDAP_MOD_BVALUES        (0x0080)
 681 /* IMPORTANT: do not use code 0x1000 (or above),
 682  * it is used internally by the backends!
 683  * (see ldap/servers/slapd/slap.h)
 684  */
 685
 686         char            *mod_type;
 687         union mod_vals_u {
 688                 char            **modv_strvals;
 689                 struct berval   **modv_bvals;
 690         } mod_vals;
 691 #define mod_values      mod_vals.modv_strvals
 692 #define mod_bvalues     mod_vals.modv_bvals
 693 } LDAPMod;
 694
 695 /*
 696  * structure representing an ldap session which can
 697  * encompass connections to multiple servers (in the
 698  * face of referrals).
 699  */
 700 typedef struct ldap LDAP;
 701
 702 #define LDAP_DEREF_NEVER                0x00
 703 #define LDAP_DEREF_SEARCHING    0x01
 704 #define LDAP_DEREF_FINDING              0x02
 705 #define LDAP_DEREF_ALWAYS               0x03
 706
 707 #define LDAP_NO_LIMIT                   0
 708
 709 /* how many messages to retrieve results for */
 710 #define LDAP_MSG_ONE                    0x00
 711 #define LDAP_MSG_ALL                    0x01
 712 #define LDAP_MSG_RECEIVED               0x02
 713
 714 /*
 715  * types for ldap URL handling
 716  */
 717 typedef struct ldap_url_desc {
 718         struct ldap_url_desc *lud_next;
 719         char    *lud_scheme;
 720         char    *lud_host;
 721         int             lud_port;
 722         char    *lud_dn;
 723         char    **lud_attrs;
 724         int             lud_scope;
 725         char    *lud_filter;
 726         char    **lud_exts;
 727         int             lud_crit_exts;
 728 } LDAPURLDesc;
 729
 730 #define LDAP_URL_SUCCESS                0x00    /* Success */
 731 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 732 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 733
 734 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 735 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 736 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 737 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 738 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 739 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 740 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 741 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 742
 743 /*
 744  * The API draft spec says we should declare (or cause to be declared)
 745  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 746  */
 747 struct timeval;
 748
 749 /*
 750  * in options.c:
 751  */
 752 LDAP_F( int )
 753 ldap_get_option LDAP_P((
 754         LDAP *ld,
 755         int option,
 756         void *outvalue));
 757
 758 LDAP_F( int )
 759 ldap_set_option LDAP_P((
 760         LDAP *ld,
 761         int option,
 762         LDAP_CONST void *invalue));
 763
 764 /* V3 REBIND Function Callback Prototype */
 765 typedef int (LDAP_REBIND_PROC) LDAP_P((
 766         LDAP *ld, LDAP_CONST char *url,
 767         ber_tag_t request, ber_int_t msgid,
 768         void *params ));
 769
 770 LDAP_F( int )
 771 ldap_set_rebind_proc LDAP_P((
 772         LDAP *ld,
 773         LDAP_REBIND_PROC *rebind_proc,
 774         void *params ));
 775
 776 /* V3 referral selection Function Callback Prototype */
 777 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
 778         LDAP *ld, char ***refsp, int *cntp,
 779         void *params ));
 780
 781 LDAP_F( int )
 782 ldap_set_nextref_proc LDAP_P((
 783         LDAP *ld,
 784         LDAP_NEXTREF_PROC *nextref_proc,
 785         void *params ));
 786
 787 /* V3 URLLIST Function Callback Prototype */
 788 typedef int (LDAP_URLLIST_PROC) LDAP_P((
 789         LDAP *ld,
 790         LDAPURLDesc **urllist,
 791         LDAPURLDesc **url,
 792         void *params ));
 793
 794 LDAP_F( int )
 795 ldap_set_urllist_proc LDAP_P((
 796         LDAP *ld,
 797         LDAP_URLLIST_PROC *urllist_proc,
 798         void *params ));
 799
 800 /*
 801  * in controls.c:
 802  */
 803 LDAP_F( int )
 804 ldap_create_control LDAP_P((
 805         LDAP_CONST char *requestOID,
 806         BerElement *ber,
 807         int iscritical,
 808         LDAPControl **ctrlp ));
 809
 810 LDAP_F( LDAPControl * )
 811 ldap_find_control LDAP_P((
 812         LDAP_CONST char *oid,
 813         LDAPControl **ctrls ));
 814
 815 LDAP_F( void )
 816 ldap_control_free LDAP_P((
 817         LDAPControl *ctrl ));
 818
 819 LDAP_F( void )
 820 ldap_controls_free LDAP_P((
 821         LDAPControl **ctrls ));
 822
 823 /*
 824  * in dnssrv.c:
 825  */
 826 LDAP_F( int )
 827 ldap_domain2dn LDAP_P((
 828         LDAP_CONST char* domain,
 829         char** dn ));
 830
 831 LDAP_F( int )
 832 ldap_dn2domain LDAP_P((
 833         LDAP_CONST char* dn,
 834         char** domain ));
 835
 836 LDAP_F( int )
 837 ldap_domain2hostlist LDAP_P((
 838         LDAP_CONST char *domain,
 839         char** hostlist ));
 840
 841 /*
 842  * in extended.c:
 843  */
 844 LDAP_F( int )
 845 ldap_extended_operation LDAP_P((
 846         LDAP                    *ld,
 847         LDAP_CONST char *reqoid,
 848         struct berval   *reqdata,
 849         LDAPControl             **serverctrls,
 850         LDAPControl             **clientctrls,
 851         int                             *msgidp ));
 852
 853 LDAP_F( int )
 854 ldap_extended_operation_s LDAP_P((
 855         LDAP                    *ld,
 856         LDAP_CONST char *reqoid,
 857         struct berval   *reqdata,
 858         LDAPControl             **serverctrls,
 859         LDAPControl             **clientctrls,
 860         char                    **retoidp,
 861         struct berval   **retdatap ));
 862
 863 LDAP_F( int )
 864 ldap_parse_extended_result LDAP_P((
 865         LDAP                    *ld,
 866         LDAPMessage             *res,
 867         char                    **retoidp,
 868         struct berval   **retdatap,
 869         int                             freeit ));
 870
 871 LDAP_F( int )
 872 ldap_parse_intermediate LDAP_P((
 873         LDAP                    *ld,
 874         LDAPMessage             *res,
 875         char                    **retoidp,
 876         struct berval   **retdatap,
 877         LDAPControl             ***serverctrls,
 878         int                             freeit ));
 879
 880
 881 /*
 882  * in abandon.c:
 883  */
 884 LDAP_F( int )
 885 ldap_abandon_ext LDAP_P((
 886         LDAP                    *ld,
 887         int                             msgid,
 888         LDAPControl             **serverctrls,
 889         LDAPControl             **clientctrls ));
 890
 891 #if LDAP_DEPRECATED
 892 LDAP_F( int )
 893 ldap_abandon LDAP_P((   /* deprecated, use ldap_abandon_ext */
 894         LDAP *ld,
 895         int msgid ));
 896 #endif
 897
 898 /*
 899  * in add.c:
 900  */
 901 LDAP_F( int )
 902 ldap_add_ext LDAP_P((
 903         LDAP                    *ld,
 904         LDAP_CONST char *dn,
 905         LDAPMod                 **attrs,
 906         LDAPControl             **serverctrls,
 907         LDAPControl             **clientctrls,
 908         int                     *msgidp ));
 909
 910 LDAP_F( int )
 911 ldap_add_ext_s LDAP_P((
 912         LDAP                    *ld,
 913         LDAP_CONST char *dn,
 914         LDAPMod                 **attrs,
 915         LDAPControl             **serverctrls,
 916         LDAPControl             **clientctrls ));
 917
 918 #if LDAP_DEPRECATED
 919 LDAP_F( int )
 920 ldap_add LDAP_P((       /* deprecated, use ldap_add_ext */
 921         LDAP *ld,
 922         LDAP_CONST char *dn,
 923         LDAPMod **attrs ));
 924
 925 LDAP_F( int )
 926 ldap_add_s LDAP_P((     /* deprecated, use ldap_add_ext_s */
 927         LDAP *ld,
 928         LDAP_CONST char *dn,
 929         LDAPMod **attrs ));
 930 #endif
 931
 932
 933 /*
 934  * in sasl.c:
 935  */
 936 LDAP_F( int )
 937 ldap_sasl_bind LDAP_P((
 938         LDAP                    *ld,
 939         LDAP_CONST char *dn,
 940         LDAP_CONST char *mechanism,
 941         struct berval   *cred,
 942         LDAPControl             **serverctrls,
 943         LDAPControl             **clientctrls,
 944         int                             *msgidp ));
 945
 946 /* Interaction flags (should be passed about in a control)
 947  *  Automatic (default): use defaults, prompt otherwise
 948  *  Interactive: prompt always
 949  *  Quiet: never prompt
 950  */
 951 #define LDAP_SASL_AUTOMATIC             0U
 952 #define LDAP_SASL_INTERACTIVE   1U
 953 #define LDAP_SASL_QUIET                 2U
 954
 955 /*
 956  * V3 SASL Interaction Function Callback Prototype
 957  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
 958  *  should likely passed in a control (and provided controls)
 959  */
 960 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
 961         LDAP *ld, unsigned flags, void* defaults, void *interact ));
 962
 963 LDAP_F( int )
 964 ldap_sasl_interactive_bind_s LDAP_P((
 965         LDAP *ld,
 966         LDAP_CONST char *dn, /* usually NULL */
 967         LDAP_CONST char *saslMechanism,
 968         LDAPControl **serverControls,
 969         LDAPControl **clientControls,
 970
 971         /* should be client controls */
 972         unsigned flags,
 973         LDAP_SASL_INTERACT_PROC *proc,
 974         void *defaults ));
 975
 976 LDAP_F( int )
 977 ldap_sasl_bind_s LDAP_P((
 978         LDAP                    *ld,
 979         LDAP_CONST char *dn,
 980         LDAP_CONST char *mechanism,
 981         struct berval   *cred,
 982         LDAPControl             **serverctrls,
 983         LDAPControl             **clientctrls,
 984         struct berval   **servercredp ));
 985
 986 LDAP_F( int )
 987 ldap_parse_sasl_bind_result LDAP_P((
 988         LDAP                    *ld,
 989         LDAPMessage             *res,
 990         struct berval   **servercredp,
 991         int                             freeit ));
 992
 993 #if LDAP_DEPRECATED
 994 /*
 995  * in bind.c:
 996  *      (deprecated)
 997  */
 998 LDAP_F( int )
 999 ldap_bind LDAP_P((      /* deprecated, use ldap_sasl_bind */
1000         LDAP *ld,
1001         LDAP_CONST char *who,
1002         LDAP_CONST char *passwd,
1003         int authmethod ));
1004
1005 LDAP_F( int )
1006 ldap_bind_s LDAP_P((    /* deprecated, use ldap_sasl_bind_s */
1007         LDAP *ld,
1008         LDAP_CONST char *who,
1009         LDAP_CONST char *cred,
1010         int authmethod ));
1011
1012 /*
1013  * in sbind.c:
1014  */
1015 LDAP_F( int )
1016 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1017         LDAP *ld,
1018         LDAP_CONST char *who,
1019         LDAP_CONST char *passwd ));
1020
1021 LDAP_F( int )
1022 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1023         LDAP *ld,
1024         LDAP_CONST char *who,
1025         LDAP_CONST char *passwd ));
1026
1027
1028 /*
1029  * in kbind.c:
1030  *      (deprecated - use SASL instead)
1031  */
1032 LDAP_F( int )
1033 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
1034         LDAP *ld,
1035         LDAP_CONST char *who ));
1036
1037 LDAP_F( int )
1038 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
1039         LDAP *ld,
1040         LDAP_CONST char *who ));
1041
1042 LDAP_F( int )
1043 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
1044         LDAP *ld,
1045         LDAP_CONST char *who ));
1046
1047 LDAP_F( int )
1048 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
1049         LDAP *ld,
1050         LDAP_CONST char *who ));
1051
1052 LDAP_F( int )
1053 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
1054         LDAP *ld,
1055         LDAP_CONST char *who ));
1056 #endif
1057
1058
1059 /*
1060  * in compare.c:
1061  */
1062 LDAP_F( int )
1063 ldap_compare_ext LDAP_P((
1064         LDAP                    *ld,
1065         LDAP_CONST char *dn,
1066         LDAP_CONST char *attr,
1067         struct berval   *bvalue,
1068         LDAPControl             **serverctrls,
1069         LDAPControl             **clientctrls,
1070         int                     *msgidp ));
1071
1072 LDAP_F( int )
1073 ldap_compare_ext_s LDAP_P((
1074         LDAP                    *ld,
1075         LDAP_CONST char *dn,
1076         LDAP_CONST char *attr,
1077         struct berval   *bvalue,
1078         LDAPControl             **serverctrls,
1079         LDAPControl             **clientctrls ));
1080
1081 #if LDAP_DEPRECATED
1082 LDAP_F( int )
1083 ldap_compare LDAP_P((   /* deprecated, use ldap_compare_ext */
1084         LDAP *ld,
1085         LDAP_CONST char *dn,
1086         LDAP_CONST char *attr,
1087         LDAP_CONST char *value ));
1088
1089 LDAP_F( int )
1090 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1091         LDAP *ld,
1092         LDAP_CONST char *dn,
1093         LDAP_CONST char *attr,
1094         LDAP_CONST char *value ));
1095 #endif
1096
1097
1098 /*
1099  * in delete.c:
1100  */
1101 LDAP_F( int )
1102 ldap_delete_ext LDAP_P((
1103         LDAP                    *ld,
1104         LDAP_CONST char *dn,
1105         LDAPControl             **serverctrls,
1106         LDAPControl             **clientctrls,
1107         int                     *msgidp ));
1108
1109 LDAP_F( int )
1110 ldap_delete_ext_s LDAP_P((
1111         LDAP                    *ld,
1112         LDAP_CONST char *dn,
1113         LDAPControl             **serverctrls,
1114         LDAPControl             **clientctrls ));
1115
1116 #if LDAP_DEPRECATED
1117 LDAP_F( int )
1118 ldap_delete LDAP_P((    /* deprecated, use ldap_delete_ext */
1119         LDAP *ld,
1120         LDAP_CONST char *dn ));
1121
1122 LDAP_F( int )
1123 ldap_delete_s LDAP_P((  /* deprecated, use ldap_delete_ext_s */
1124         LDAP *ld,
1125         LDAP_CONST char *dn ));
1126 #endif
1127
1128
1129 /*
1130  * in error.c:
1131  */
1132 LDAP_F( int )
1133 ldap_parse_result LDAP_P((
1134         LDAP                    *ld,
1135         LDAPMessage             *res,
1136         int                             *errcodep,
1137         char                    **matcheddnp,
1138         char                    **errmsgp,
1139         char                    ***referralsp,
1140         LDAPControl             ***serverctrls,
1141         int                             freeit ));
1142
1143 LDAP_F( char * )
1144 ldap_err2string LDAP_P((
1145         int err ));
1146
1147 #if LDAP_DEPRECATED
1148 LDAP_F( int )
1149 ldap_result2error LDAP_P((      /* deprecated, use ldap_parse_result */
1150         LDAP *ld,
1151         LDAPMessage *r,
1152         int freeit ));
1153
1154 LDAP_F( void )
1155 ldap_perror LDAP_P((    /* deprecated, use ldap_err2string */
1156         LDAP *ld,
1157         LDAP_CONST char *s ));
1158 #endif
1159
1160
1161 /*
1162  * in modify.c:
1163  */
1164 LDAP_F( int )
1165 ldap_modify_ext LDAP_P((
1166         LDAP                    *ld,
1167         LDAP_CONST char *dn,
1168         LDAPMod                 **mods,
1169         LDAPControl             **serverctrls,
1170         LDAPControl             **clientctrls,
1171         int                     *msgidp ));
1172
1173 LDAP_F( int )
1174 ldap_modify_ext_s LDAP_P((
1175         LDAP                    *ld,
1176         LDAP_CONST char *dn,
1177         LDAPMod                 **mods,
1178         LDAPControl             **serverctrls,
1179         LDAPControl             **clientctrls ));
1180
1181 #if LDAP_DEPRECATED
1182 LDAP_F( int )
1183 ldap_modify LDAP_P((    /* deprecated, use ldap_modify_ext */
1184         LDAP *ld,
1185         LDAP_CONST char *dn,
1186         LDAPMod **mods ));
1187
1188 LDAP_F( int )
1189 ldap_modify_s LDAP_P((  /* deprecated, use ldap_modify_ext_s */
1190         LDAP *ld,
1191         LDAP_CONST char *dn,
1192         LDAPMod **mods ));
1193 #endif
1194
1195
1196 /*
1197  * in modrdn.c:
1198  */
1199 LDAP_F( int )
1200 ldap_rename LDAP_P((
1201         LDAP *ld,
1202         LDAP_CONST char *dn,
1203         LDAP_CONST char *newrdn,
1204         LDAP_CONST char *newSuperior,
1205         int deleteoldrdn,
1206         LDAPControl **sctrls,
1207         LDAPControl **cctrls,
1208         int *msgidp ));
1209
1210 LDAP_F( int )
1211 ldap_rename_s LDAP_P((
1212         LDAP *ld,
1213         LDAP_CONST char *dn,
1214         LDAP_CONST char *newrdn,
1215         LDAP_CONST char *newSuperior,
1216         int deleteoldrdn,
1217         LDAPControl **sctrls,
1218         LDAPControl **cctrls ));
1219
1220 #if LDAP_DEPRECATED
1221 LDAP_F( int )
1222 ldap_rename2 LDAP_P((   /* deprecated, use ldap_rename */
1223         LDAP *ld,
1224         LDAP_CONST char *dn,
1225         LDAP_CONST char *newrdn,
1226         LDAP_CONST char *newSuperior,
1227         int deleteoldrdn ));
1228
1229 LDAP_F( int )
1230 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1231         LDAP *ld,
1232         LDAP_CONST char *dn,
1233         LDAP_CONST char *newrdn,
1234         LDAP_CONST char *newSuperior,
1235         int deleteoldrdn ));
1236
1237 LDAP_F( int )
1238 ldap_modrdn LDAP_P((    /* deprecated, use ldap_rename */
1239         LDAP *ld,
1240         LDAP_CONST char *dn,
1241         LDAP_CONST char *newrdn ));
1242
1243 LDAP_F( int )
1244 ldap_modrdn_s LDAP_P((  /* deprecated, use ldap_rename_s */
1245         LDAP *ld,
1246         LDAP_CONST char *dn,
1247         LDAP_CONST char *newrdn ));
1248
1249 LDAP_F( int )
1250 ldap_modrdn2 LDAP_P((   /* deprecated, use ldap_rename */
1251         LDAP *ld,
1252         LDAP_CONST char *dn,
1253         LDAP_CONST char *newrdn,
1254         int deleteoldrdn ));
1255
1256 LDAP_F( int )
1257 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1258         LDAP *ld,
1259         LDAP_CONST char *dn,
1260         LDAP_CONST char *newrdn,
1261         int deleteoldrdn));
1262 #endif
1263
1264
1265 /*
1266  * in open.c:
1267  */
1268 #if LDAP_DEPRECATED
1269 LDAP_F( LDAP * )
1270 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1271         LDAP_CONST char *host,
1272         int port ));
1273
1274 LDAP_F( LDAP * )
1275 ldap_open LDAP_P((      /* deprecated, use ldap_create or ldap_initialize */
1276         LDAP_CONST char *host,
1277         int port ));
1278 #endif
1279
1280 LDAP_F( int )
1281 ldap_create LDAP_P((
1282         LDAP **ldp ));
1283
1284 LDAP_F( int )
1285 ldap_initialize LDAP_P((
1286         LDAP **ldp,
1287         LDAP_CONST char *url ));
1288
1289 /*
1290  * in tls.c
1291  */
1292
1293 LDAP_F( int )
1294 ldap_tls_inplace LDAP_P((
1295         LDAP *ld ));
1296
1297 LDAP_F( int )
1298 ldap_start_tls LDAP_P((
1299         LDAP *ld,
1300         LDAPControl **serverctrls,
1301         LDAPControl **clientctrls,
1302         int *msgidp ));
1303
1304 LDAP_F( int )
1305 ldap_install_tls LDAP_P((
1306         LDAP *ld ));
1307
1308 LDAP_F( int )
1309 ldap_start_tls_s LDAP_P((
1310         LDAP *ld,
1311         LDAPControl **serverctrls,
1312         LDAPControl **clientctrls ));
1313
1314 /*
1315  * in messages.c:
1316  */
1317 LDAP_F( LDAPMessage * )
1318 ldap_first_message LDAP_P((
1319         LDAP *ld,
1320         LDAPMessage *chain ));
1321
1322 LDAP_F( LDAPMessage * )
1323 ldap_next_message LDAP_P((
1324         LDAP *ld,
1325         LDAPMessage *msg ));
1326
1327 LDAP_F( int )
1328 ldap_count_messages LDAP_P((
1329         LDAP *ld,
1330         LDAPMessage *chain ));
1331
1332 /*
1333  * in references.c:
1334  */
1335 LDAP_F( LDAPMessage * )
1336 ldap_first_reference LDAP_P((
1337         LDAP *ld,
1338         LDAPMessage *chain ));
1339
1340 LDAP_F( LDAPMessage * )
1341 ldap_next_reference LDAP_P((
1342         LDAP *ld,
1343         LDAPMessage *ref ));
1344
1345 LDAP_F( int )
1346 ldap_count_references LDAP_P((
1347         LDAP *ld,
1348         LDAPMessage *chain ));
1349
1350 LDAP_F( int )
1351 ldap_parse_reference LDAP_P((
1352         LDAP                    *ld,
1353         LDAPMessage             *ref,
1354         char                    ***referralsp,
1355         LDAPControl             ***serverctrls,
1356         int                             freeit));
1357
1358
1359 /*
1360  * in getentry.c:
1361  */
1362 LDAP_F( LDAPMessage * )
1363 ldap_first_entry LDAP_P((
1364         LDAP *ld,
1365         LDAPMessage *chain ));
1366
1367 LDAP_F( LDAPMessage * )
1368 ldap_next_entry LDAP_P((
1369         LDAP *ld,
1370         LDAPMessage *entry ));
1371
1372 LDAP_F( int )
1373 ldap_count_entries LDAP_P((
1374         LDAP *ld,
1375         LDAPMessage *chain ));
1376
1377 LDAP_F( int )
1378 ldap_get_entry_controls LDAP_P((
1379         LDAP                    *ld,
1380         LDAPMessage             *entry,
1381         LDAPControl             ***serverctrls));
1382
1383
1384 /*
1385  * in addentry.c
1386  */
1387 LDAP_F( LDAPMessage * )
1388 ldap_delete_result_entry LDAP_P((
1389         LDAPMessage **list,
1390         LDAPMessage *e ));
1391
1392 LDAP_F( void )
1393 ldap_add_result_entry LDAP_P((
1394         LDAPMessage **list,
1395         LDAPMessage *e ));
1396
1397
1398 /*
1399  * in getdn.c
1400  */
1401 LDAP_F( char * )
1402 ldap_get_dn LDAP_P((
1403         LDAP *ld,
1404         LDAPMessage *entry ));
1405
1406 typedef struct ldap_ava {
1407         struct berval la_attr;
1408         struct berval la_value;
1409         unsigned la_flags;
1410 #define LDAP_AVA_NULL                           0x0000U
1411 #define LDAP_AVA_STRING                         0x0001U
1412 #define LDAP_AVA_BINARY                         0x0002U
1413 #define LDAP_AVA_NONPRINTABLE           0x0004U
1414 #define LDAP_AVA_FREE_ATTR                      0x0010U
1415 #define LDAP_AVA_FREE_VALUE                     0x0020U
1416
1417         void *la_private;
1418 } LDAPAVA;
1419
1420 typedef LDAPAVA** LDAPRDN;
1421 typedef LDAPRDN* LDAPDN;
1422
1423 /* DN formats */
1424 #define LDAP_DN_FORMAT_LDAP                     0x0000U
1425 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1426 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1427 #define LDAP_DN_FORMAT_DCE                      0x0030U
1428 #define LDAP_DN_FORMAT_UFN                      0x0040U /* dn2str only */
1429 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1430 #define LDAP_DN_FORMAT_LBER                     0x00F0U /* for testing only */
1431 #define LDAP_DN_FORMAT_MASK                     0x00F0U
1432
1433 /* DN flags */
1434 #define LDAP_DN_PRETTY                          0x0100U
1435 #define LDAP_DN_SKIP                            0x0200U
1436 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1437 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1438 #define LDAP_DN_PEDANTIC                        0xF000U
1439
1440 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1441 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1442
1443 LDAP_F( int )
1444 ldap_bv2dn LDAP_P((
1445         struct berval *bv,
1446         LDAPDN *dn,
1447         unsigned flags ));
1448
1449 LDAP_F( int )
1450 ldap_str2dn LDAP_P((
1451         LDAP_CONST char *str,
1452         LDAPDN *dn,
1453         unsigned flags ));
1454
1455 LDAP_F( int )
1456 ldap_dn2bv LDAP_P((
1457         LDAPDN dn,
1458         struct berval *bv,
1459         unsigned flags ));
1460
1461 LDAP_F( int )
1462 ldap_dn2str LDAP_P((
1463         LDAPDN dn,
1464         char **str,
1465         unsigned flags ));
1466
1467 LDAP_F( int )
1468 ldap_bv2rdn LDAP_P((
1469         struct berval *bv,
1470         LDAPRDN *rdn,
1471         char **next,
1472         unsigned flags ));
1473
1474 LDAP_F( int )
1475 ldap_str2rdn LDAP_P((
1476         LDAP_CONST char *str,
1477         LDAPRDN *rdn,
1478         char **next,
1479         unsigned flags ));
1480
1481 LDAP_F( int )
1482 ldap_rdn2bv LDAP_P((
1483         LDAPRDN rdn,
1484         struct berval *bv,
1485         unsigned flags ));
1486
1487 LDAP_F( int )
1488 ldap_rdn2str LDAP_P((
1489         LDAPRDN rdn,
1490         char **str,
1491         unsigned flags ));
1492
1493 LDAP_F( int )
1494 ldap_dn_normalize LDAP_P((
1495         LDAP_CONST char *in, unsigned iflags,
1496         char **out, unsigned oflags ));
1497
1498 LDAP_F( char * )
1499 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1500         LDAP_CONST char *dn ));
1501
1502 LDAP_F( char ** )
1503 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1504         LDAP_CONST char *dn,
1505         int notypes ));
1506
1507 LDAP_F( char ** )
1508 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1509         LDAP_CONST char *rdn,
1510         int notypes ));
1511
1512 typedef int LDAPDN_rewrite_func
1513         LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1514
1515 LDAP_F( int )
1516 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1517         LDAPDN_rewrite_func *func, unsigned flags ));
1518
1519 LDAP_F( char * )
1520 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1521         LDAP_CONST char *dn ));
1522
1523 LDAP_F( char * )
1524 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1525         LDAP_CONST char *dce ));
1526
1527 LDAP_F( char * )
1528 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1529         LDAP_CONST char *dn ));
1530
1531 LDAP_F( int )
1532 ldap_get_dn_ber LDAP_P((
1533         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1534
1535 LDAP_F( int )
1536 ldap_get_attribute_ber LDAP_P((
1537         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1538         struct berval **vals ));
1539
1540 /*
1541  * in getattr.c
1542  */
1543 LDAP_F( char * )
1544 ldap_first_attribute LDAP_P((
1545         LDAP *ld,
1546         LDAPMessage *entry,
1547         BerElement **ber ));
1548
1549 LDAP_F( char * )
1550 ldap_next_attribute LDAP_P((
1551         LDAP *ld,
1552         LDAPMessage *entry,
1553         BerElement *ber ));
1554
1555
1556 /*
1557  * in getvalues.c
1558  */
1559 LDAP_F( struct berval ** )
1560 ldap_get_values_len LDAP_P((
1561         LDAP *ld,
1562         LDAPMessage *entry,
1563         LDAP_CONST char *target ));
1564
1565 LDAP_F( int )
1566 ldap_count_values_len LDAP_P((
1567         struct berval **vals ));
1568
1569 LDAP_F( void )
1570 ldap_value_free_len LDAP_P((
1571         struct berval **vals ));
1572
1573 #if LDAP_DEPRECATED
1574 LDAP_F( char ** )
1575 ldap_get_values LDAP_P((        /* deprecated, use ldap_get_values_len */
1576         LDAP *ld,
1577         LDAPMessage *entry,
1578         LDAP_CONST char *target ));
1579
1580 LDAP_F( int )
1581 ldap_count_values LDAP_P((      /* deprecated, use ldap_count_values_len */
1582         char **vals ));
1583
1584 LDAP_F( void )
1585 ldap_value_free LDAP_P((        /* deprecated, use ldap_values_free_len */
1586         char **vals ));
1587 #endif
1588
1589 /*
1590  * in result.c:
1591  */
1592 LDAP_F( int )
1593 ldap_result LDAP_P((
1594         LDAP *ld,
1595         int msgid,
1596         int all,
1597         struct timeval *timeout,
1598         LDAPMessage **result ));
1599
1600 LDAP_F( int )
1601 ldap_msgtype LDAP_P((
1602         LDAPMessage *lm ));
1603
1604 LDAP_F( int )
1605 ldap_msgid   LDAP_P((
1606         LDAPMessage *lm ));
1607
1608 LDAP_F( int )
1609 ldap_msgfree LDAP_P((
1610         LDAPMessage *lm ));
1611
1612 LDAP_F( int )
1613 ldap_msgdelete LDAP_P((
1614         LDAP *ld,
1615         int msgid ));
1616
1617
1618 /*
1619  * in search.c:
1620  */
1621 LDAP_F( int )
1622 ldap_bv2escaped_filter_value LDAP_P((
1623         struct berval *in,
1624         struct berval *out ));
1625
1626 LDAP_F( int )
1627 ldap_search_ext LDAP_P((
1628         LDAP                    *ld,
1629         LDAP_CONST char *base,
1630         int                             scope,
1631         LDAP_CONST char *filter,
1632         char                    **attrs,
1633         int                             attrsonly,
1634         LDAPControl             **serverctrls,
1635         LDAPControl             **clientctrls,
1636         struct timeval  *timeout,
1637         int                             sizelimit,
1638         int                             *msgidp ));
1639
1640 LDAP_F( int )
1641 ldap_search_ext_s LDAP_P((
1642         LDAP                    *ld,
1643         LDAP_CONST char *base,
1644         int                             scope,
1645         LDAP_CONST char *filter,
1646         char                    **attrs,
1647         int                             attrsonly,
1648         LDAPControl             **serverctrls,
1649         LDAPControl             **clientctrls,
1650         struct timeval  *timeout,
1651         int                             sizelimit,
1652         LDAPMessage             **res ));
1653
1654 #if LDAP_DEPRECATED
1655 LDAP_F( int )
1656 ldap_search LDAP_P((    /* deprecated, use ldap_search_ext */
1657         LDAP *ld,
1658         LDAP_CONST char *base,
1659         int scope,
1660         LDAP_CONST char *filter,
1661         char **attrs,
1662         int attrsonly ));
1663
1664 LDAP_F( int )
1665 ldap_search_s LDAP_P((  /* deprecated, use ldap_search_ext_s */
1666         LDAP *ld,
1667         LDAP_CONST char *base,
1668         int scope,
1669         LDAP_CONST char *filter,
1670         char **attrs,
1671         int attrsonly,
1672         LDAPMessage **res ));
1673
1674 LDAP_F( int )
1675 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1676         LDAP *ld,
1677         LDAP_CONST char *base,
1678         int scope,
1679         LDAP_CONST char *filter,
1680     char **attrs,
1681         int attrsonly,
1682         struct timeval *timeout,
1683         LDAPMessage **res ));
1684 #endif
1685
1686 /*
1687  * in unbind.c
1688  */
1689 LDAP_F( int )
1690 ldap_unbind_ext LDAP_P((
1691         LDAP                    *ld,
1692         LDAPControl             **serverctrls,
1693         LDAPControl             **clientctrls));
1694
1695 LDAP_F( int )
1696 ldap_unbind_ext_s LDAP_P((
1697         LDAP                    *ld,
1698         LDAPControl             **serverctrls,
1699         LDAPControl             **clientctrls));
1700
1701 #if LDAP_DEPRECATED
1702 LDAP_F( int )
1703 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1704         LDAP *ld ));
1705
1706 LDAP_F( int )
1707 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1708         LDAP *ld ));
1709 #endif
1710
1711 /*
1712  * in filter.c
1713  */
1714 LDAP_F( int )
1715 ldap_put_vrFilter LDAP_P((
1716         BerElement *ber,
1717         const char *vrf ));
1718
1719 /*
1720  * in free.c
1721  */
1722
1723 LDAP_F( void * )
1724 ldap_memalloc LDAP_P((
1725         ber_len_t s ));
1726
1727 LDAP_F( void * )
1728 ldap_memrealloc LDAP_P((
1729         void* p,
1730         ber_len_t s ));
1731
1732 LDAP_F( void * )
1733 ldap_memcalloc LDAP_P((
1734         ber_len_t n,
1735         ber_len_t s ));
1736
1737 LDAP_F( void )
1738 ldap_memfree LDAP_P((
1739         void* p ));
1740
1741 LDAP_F( void )
1742 ldap_memvfree LDAP_P((
1743         void** v ));
1744
1745 LDAP_F( char * )
1746 ldap_strdup LDAP_P((
1747         LDAP_CONST char * ));
1748
1749 LDAP_F( void )
1750 ldap_mods_free LDAP_P((
1751         LDAPMod **mods,
1752         int freemods ));
1753
1754
1755 #if LDAP_DEPRECATED
1756 /*
1757  * in sort.c (deprecated, use custom code instead)
1758  */
1759 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1760         LDAP_CONST char *left,
1761         LDAP_CONST char *right ));
1762
1763 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1764         LDAP_CONST void *left,
1765         LDAP_CONST void *right ));
1766
1767 LDAP_F( int )   /* deprecated */
1768 ldap_sort_entries LDAP_P(( LDAP *ld,
1769         LDAPMessage **chain,
1770         LDAP_CONST char *attr,
1771         LDAP_SORT_AD_CMP_PROC *cmp ));
1772
1773 LDAP_F( int )   /* deprecated */
1774 ldap_sort_values LDAP_P((
1775         LDAP *ld,
1776         char **vals,
1777         LDAP_SORT_AV_CMP_PROC *cmp ));
1778
1779 LDAP_F( int ) /* deprecated */
1780 ldap_sort_strcasecmp LDAP_P((
1781         LDAP_CONST void *a,
1782         LDAP_CONST void *b ));
1783 #endif
1784
1785 /*
1786  * in url.c
1787  */
1788 LDAP_F( int )
1789 ldap_is_ldap_url LDAP_P((
1790         LDAP_CONST char *url ));
1791
1792 LDAP_F( int )
1793 ldap_is_ldaps_url LDAP_P((
1794         LDAP_CONST char *url ));
1795
1796 LDAP_F( int )
1797 ldap_is_ldapi_url LDAP_P((
1798         LDAP_CONST char *url ));
1799
1800 LDAP_F( int )
1801 ldap_url_parse LDAP_P((
1802         LDAP_CONST char *url,
1803         LDAPURLDesc **ludpp ));
1804
1805 LDAP_F( char * )
1806 ldap_url_desc2str LDAP_P((
1807         LDAPURLDesc *ludp ));
1808
1809 LDAP_F( void )
1810 ldap_free_urldesc LDAP_P((
1811         LDAPURLDesc *ludp ));
1812
1813
1814 /*
1815  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1816  *  in cancel.c
1817  */
1818 #define LDAP_API_FEATURE_CANCEL 1000
1819
1820 LDAP_F( int )
1821 ldap_cancel LDAP_P(( LDAP *ld,
1822         int cancelid,
1823         LDAPControl             **sctrls,
1824         LDAPControl             **cctrls,
1825         int                             *msgidp ));
1826
1827 LDAP_F( int )
1828 ldap_cancel_s LDAP_P(( LDAP *ld,
1829         int cancelid,
1830         LDAPControl **sctrl,
1831         LDAPControl **cctrl ));
1832
1833 /*
1834  * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1835  *  in turn.c
1836  */
1837 #define LDAP_API_FEATURE_TURN 1000
1838
1839 LDAP_F( int )
1840 ldap_turn LDAP_P(( LDAP *ld,
1841         int mutual,
1842         LDAP_CONST char* identifier,
1843         LDAPControl             **sctrls,
1844         LDAPControl             **cctrls,
1845         int                             *msgidp ));
1846
1847 LDAP_F( int )
1848 ldap_turn_s LDAP_P(( LDAP *ld,
1849         int mutual,
1850         LDAP_CONST char* identifier,
1851         LDAPControl **sctrl,
1852         LDAPControl **cctrl ));
1853
1854 /*
1855  * LDAP Paged Results
1856  *      in pagectrl.c
1857  */
1858 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
1859
1860 LDAP_F( int )
1861 ldap_create_page_control_value LDAP_P((
1862         LDAP *ld,
1863         ber_int_t pagesize,
1864         struct berval *cookie,
1865         struct berval *value ));
1866
1867 LDAP_F( int )
1868 ldap_create_page_control LDAP_P((
1869         LDAP *ld,
1870         ber_int_t pagesize,
1871         struct berval *cookie,
1872         int iscritical,
1873         LDAPControl **ctrlp ));
1874
1875 #if LDAP_DEPRECATED
1876 LDAP_F( int )
1877 ldap_parse_page_control LDAP_P((
1878         /* deprecated, use ldap_parse_pageresponse_control */
1879         LDAP *ld,
1880         LDAPControl **ctrls,
1881         ber_int_t *count,
1882         struct berval **cookie ));
1883 #endif
1884
1885 LDAP_F( int )
1886 ldap_parse_pageresponse_control LDAP_P((
1887         LDAP *ld,
1888         LDAPControl *ctrl,
1889         ber_int_t *count,
1890         struct berval *cookie ));
1891
1892 /*
1893  * LDAP Server Side Sort
1894  *      in sortctrl.c
1895  */
1896 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
1897
1898 /* structure for a sort-key */
1899 typedef struct ldapsortkey {
1900         char *attributeType;
1901         char *orderingRule;
1902         int reverseOrder;
1903 } LDAPSortKey;
1904
1905 LDAP_F( int )
1906 ldap_create_sort_keylist LDAP_P((
1907         LDAPSortKey ***sortKeyList,
1908         char *keyString ));
1909
1910 LDAP_F( void )
1911 ldap_free_sort_keylist LDAP_P((
1912         LDAPSortKey **sortkeylist ));
1913
1914 LDAP_F( int )
1915 ldap_create_sort_control_value LDAP_P((
1916         LDAP *ld,
1917         LDAPSortKey **keyList,
1918         struct berval *value ));
1919
1920 LDAP_F( int )
1921 ldap_create_sort_control LDAP_P((
1922         LDAP *ld,
1923         LDAPSortKey **keyList,
1924         int iscritical,
1925         LDAPControl **ctrlp ));
1926
1927 LDAP_F( int )
1928 ldap_parse_sortresponse_control LDAP_P((
1929         LDAP *ld,
1930         LDAPControl *ctrl,
1931         ber_int_t *result,
1932         char **attribute ));
1933
1934 /*
1935  * LDAP Virtual List View
1936  *      in vlvctrl.c
1937  */
1938 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
1939
1940 /* structure for virtual list */
1941 typedef struct ldapvlvinfo {
1942         ber_int_t ldvlv_version;
1943     ber_int_t ldvlv_before_count;
1944     ber_int_t ldvlv_after_count;
1945     ber_int_t ldvlv_offset;
1946     ber_int_t ldvlv_count;
1947     struct berval *     ldvlv_attrvalue;
1948     struct berval *     ldvlv_context;
1949     void *                      ldvlv_extradata;
1950 } LDAPVLVInfo;
1951
1952 LDAP_F( int )
1953 ldap_create_vlv_control_value LDAP_P((
1954         LDAP *ld,
1955         LDAPVLVInfo *ldvlistp,
1956         struct berval *value));
1957
1958 LDAP_F( int )
1959 ldap_create_vlv_control LDAP_P((
1960         LDAP *ld,
1961         LDAPVLVInfo *ldvlistp,
1962         LDAPControl **ctrlp ));
1963
1964 LDAP_F( int )
1965 ldap_parse_vlvresponse_control LDAP_P((
1966         LDAP          *ld,
1967         LDAPControl   *ctrls,
1968         ber_int_t *target_posp,
1969         ber_int_t *list_countp,
1970         struct berval **contextp,
1971         int           *errcodep ));
1972
1973 /*
1974  * LDAP Who Am I?
1975  *      in whoami.c
1976  */
1977 #define LDAP_API_FEATURE_WHOAMI 1000
1978
1979 LDAP_F( int )
1980 ldap_parse_whoami LDAP_P((
1981         LDAP *ld,
1982         LDAPMessage *res,
1983         struct berval **authzid ));
1984
1985 LDAP_F( int )
1986 ldap_whoami LDAP_P(( LDAP *ld,
1987         LDAPControl             **sctrls,
1988         LDAPControl             **cctrls,
1989         int                             *msgidp ));
1990
1991 LDAP_F( int )
1992 ldap_whoami_s LDAP_P((
1993         LDAP *ld,
1994         struct berval **authzid,
1995         LDAPControl **sctrls,
1996         LDAPControl **cctrls ));
1997
1998 /*
1999  * LDAP Password Modify
2000  *      in passwd.c
2001  */
2002 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2003
2004 LDAP_F( int )
2005 ldap_parse_passwd LDAP_P((
2006         LDAP *ld,
2007         LDAPMessage *res,
2008         struct berval *newpasswd ));
2009
2010 LDAP_F( int )
2011 ldap_passwd LDAP_P(( LDAP *ld,
2012         struct berval   *user,
2013         struct berval   *oldpw,
2014         struct berval   *newpw,
2015         LDAPControl             **sctrls,
2016         LDAPControl             **cctrls,
2017         int                             *msgidp ));
2018
2019 LDAP_F( int )
2020 ldap_passwd_s LDAP_P((
2021         LDAP *ld,
2022         struct berval   *user,
2023         struct berval   *oldpw,
2024         struct berval   *newpw,
2025         struct berval *newpasswd,
2026         LDAPControl **sctrls,
2027         LDAPControl **cctrls ));
2028
2029 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2030 /*
2031  * LDAP Password Policy controls
2032  *      in ppolicy.c
2033  */
2034 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2035
2036 typedef enum passpolicyerror_enum {
2037        PP_passwordExpired = 0,
2038        PP_accountLocked = 1,
2039        PP_changeAfterReset = 2,
2040        PP_passwordModNotAllowed = 3,
2041        PP_mustSupplyOldPassword = 4,
2042        PP_insufficientPasswordQuality = 5,
2043        PP_passwordTooShort = 6,
2044        PP_passwordTooYoung = 7,
2045        PP_passwordInHistory = 8,
2046        PP_noError = 65535
2047 } LDAPPasswordPolicyError;
2048
2049 LDAP_F( int )
2050 ldap_create_passwordpolicy_control LDAP_P((
2051         LDAP *ld,
2052         LDAPControl **ctrlp ));
2053
2054 LDAP_F( int )
2055 ldap_parse_passwordpolicy_control LDAP_P((
2056         LDAP *ld,
2057         LDAPControl *ctrl,
2058         ber_int_t *expirep,
2059         ber_int_t *gracep,
2060         LDAPPasswordPolicyError *errorp ));
2061
2062 LDAP_F( const char * )
2063 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2064 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2065
2066 /*
2067  * LDAP Dynamic Directory Services Refresh -- RFC 2589
2068  *      in dds.c
2069  */
2070 #define LDAP_API_FEATURE_REFRESH 1000
2071
2072 LDAP_F( int )
2073 ldap_parse_refresh LDAP_P((
2074         LDAP *ld,
2075         LDAPMessage *res,
2076         ber_int_t *newttl ));
2077
2078 LDAP_F( int )
2079 ldap_refresh LDAP_P(( LDAP *ld,
2080         struct berval   *dn,
2081         ber_int_t ttl,
2082         LDAPControl             **sctrls,
2083         LDAPControl             **cctrls,
2084         int                             *msgidp ));
2085
2086 LDAP_F( int )
2087 ldap_refresh_s LDAP_P((
2088         LDAP *ld,
2089         struct berval   *dn,
2090         ber_int_t ttl,
2091         ber_int_t *newttl,
2092         LDAPControl **sctrls,
2093         LDAPControl **cctrls ));
2094
2095 /*
2096  * LDAP Transactions
2097  */
2098 #ifdef LDAP_X_TXN
2099 LDAP_F( int )
2100 ldap_txn_start LDAP_P(( LDAP *ld,
2101         LDAPControl             **sctrls,
2102         LDAPControl             **cctrls,
2103         int                             *msgidp ));
2104
2105 LDAP_F( int )
2106 ldap_txn_start_s LDAP_P(( LDAP *ld,
2107         LDAPControl **sctrl,
2108         LDAPControl **cctrl,
2109         struct berval **rettxnid ));
2110
2111 LDAP_F( int )
2112 ldap_txn_end LDAP_P(( LDAP *ld,
2113         int     commit,
2114         struct berval   *txnid,
2115         LDAPControl             **sctrls,
2116         LDAPControl             **cctrls,
2117         int                             *msgidp ));
2118
2119 LDAP_F( int )
2120 ldap_txn_end_s LDAP_P(( LDAP *ld,
2121         int     commit,
2122         struct berval *txnid,
2123         LDAPControl **sctrl,
2124         LDAPControl **cctrl,
2125         int *retidp ));
2126 #endif
2127
2128 LDAP_END_DECL
2129 #endif /* _LDAP_H */