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