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