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