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