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