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