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