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