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