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