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