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-2005 The OpenLDAP Foundation.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted only as authorized by the OpenLDAP
   9  * Public License.
  10  *
  11  * A copy of this license is available in file LICENSE in the
  12  * top-level directory of the distribution or, alternatively, at
  13  * <http://www.OpenLDAP.org/license.html>.
  14  */
  15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
  16  * All rights reserved.
  17  *
  18  * Redistribution and use in source and binary forms are permitted
  19  * provided that this notice is preserved and that due credit is given
  20  * to the University of Michigan at Ann Arbor. The name of the University
  21  * may not be used to endorse or promote products derived from this
  22  * software without specific prior written permission. This software
  23  * is provided ``as is'' without express or implied warranty.
  24  */
  25
  26 #ifndef _LDAP_H
  27 #define _LDAP_H
  28
  29 /* pull in lber */
  30 #include <lber.h>
  31
  32 /* include version and API feature defines */
  33 #include <ldap_features.h>
  34
  35 LDAP_BEGIN_DECL
  36
  37 #define LDAP_VERSION1   1
  38 #define LDAP_VERSION2   2
  39 #define LDAP_VERSION3   3
  40
  41 #define LDAP_VERSION_MIN        LDAP_VERSION2
  42 #define LDAP_VERSION            LDAP_VERSION2
  43 #define LDAP_VERSION_MAX        LDAP_VERSION3
  44
  45 /*
  46  * We use 3000+n here because it is above 1823 (for RFC 1823),
  47  * above 2000+rev of IETF LDAPEXT draft (now quite dated),
  48  * yet below allocations for new RFCs (just in case there is
  49  * someday an RFC produced).
  50  */
  51 #define LDAP_API_VERSION        3001
  52 #define LDAP_VENDOR_NAME        "OpenLDAP"
  53
  54 /* OpenLDAP API Features */
  55 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
  56
  57 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
  58         ( defined( LDAP_THREAD_SAFE ) && \
  59                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
  60         /* -lldap may or may not be thread safe */
  61         /* -lldap_r, if available, is always thread safe */
  62 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
  63 #endif
  64 #if defined( LDAP_THREAD_SAFE ) && \
  65         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
  66 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
  67 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
  68 #endif
  69
  70
  71 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
  72 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
  73
  74 #define LDAP_ROOT_DSE                           ""
  75 #define LDAP_NO_ATTRS                           "1.1"
  76 #define LDAP_ALL_USER_ATTRIBUTES        "*"
  77 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* RFC 3673 */
  78
  79 /* RFC 2251:  maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
  80 #define LDAP_MAXINT (2147483647)
  81
  82 /*
  83  * LDAP_OPTions
  84  *      0x0000 - 0x0fff reserved for api options
  85  *      0x1000 - 0x3fff reserved for api extended options
  86  *      0x4000 - 0x7fff reserved for private and experimental options
  87  */
  88
  89 #define LDAP_OPT_API_INFO                       0x0000
  90 #define LDAP_OPT_DESC                           0x0001 /* historic */
  91 #define LDAP_OPT_DEREF                          0x0002
  92 #define LDAP_OPT_SIZELIMIT                      0x0003
  93 #define LDAP_OPT_TIMELIMIT                      0x0004
  94 /* 0x05 - 0x07 not defined */
  95 #define LDAP_OPT_REFERRALS                      0x0008
  96 #define LDAP_OPT_RESTART                        0x0009
  97 /* 0x0a - 0x10 not defined */
  98 #define LDAP_OPT_PROTOCOL_VERSION       0x0011
  99 #define LDAP_OPT_SERVER_CONTROLS        0x0012
 100 #define LDAP_OPT_CLIENT_CONTROLS        0x0013
 101 /* 0x14 not defined */
 102 #define LDAP_OPT_API_FEATURE_INFO       0x0015
 103 /* 0x16 - 0x2f not defined */
 104 #define LDAP_OPT_HOST_NAME                      0x0030
 105 #define LDAP_OPT_RESULT_CODE            0x0031
 106 #define LDAP_OPT_ERROR_NUMBER           LDAP_OPT_RESULT_CODE
 107 #define LDAP_OPT_ERROR_STRING           0x0032
 108 #define LDAP_OPT_MATCHED_DN                     0x0033
 109 /* 0x0034 - 0x3fff not defined */
 110
 111 /* API Extensions */
 112 #define LDAP_OPT_API_EXTENSION_BASE 0x4000  /* API extensions */
 113
 114 /* private and experimental options */
 115 /* OpenLDAP specific options */
 116 #define LDAP_OPT_DEBUG_LEVEL            0x5001  /* debug level */
 117 #define LDAP_OPT_TIMEOUT                        0x5002  /* default timeout */
 118 #define LDAP_OPT_REFHOPLIMIT            0x5003  /* ref hop limit */
 119 #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
 120 #define LDAP_OPT_URI                            0x5006
 121 #define LDAP_OPT_REFERRAL_URLS      0x5007  /* Referral URLs */
 122 #define LDAP_OPT_SOCKBUF            0x5008  /* sockbuf */
 123
 124 /* OpenLDAP TLS options */
 125 #define LDAP_OPT_X_TLS                          0x6000
 126 #define LDAP_OPT_X_TLS_CTX                      0x6001  /* SSL CTX */
 127 #define LDAP_OPT_X_TLS_CACERTFILE       0x6002
 128 #define LDAP_OPT_X_TLS_CACERTDIR        0x6003
 129 #define LDAP_OPT_X_TLS_CERTFILE         0x6004
 130 #define LDAP_OPT_X_TLS_KEYFILE          0x6005
 131 #define LDAP_OPT_X_TLS_REQUIRE_CERT     0x6006
 132 /* #define LDAP_OPT_X_TLS_PROTOCOL              0x6007 */
 133 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6008
 134 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x6009
 135 #define LDAP_OPT_X_TLS_SSL_CTX          0x600a
 136 #define LDAP_OPT_X_TLS_CRLCHECK         0x600b
 137 #define LDAP_OPT_X_TLS_CONNECT_CB       0x600c
 138 #define LDAP_OPT_X_TLS_CONNECT_ARG      0x600d
 139
 140 #define LDAP_OPT_X_TLS_NEVER    0
 141 #define LDAP_OPT_X_TLS_HARD             1
 142 #define LDAP_OPT_X_TLS_DEMAND   2
 143 #define LDAP_OPT_X_TLS_ALLOW    3
 144 #define LDAP_OPT_X_TLS_TRY              4
 145
 146 #define LDAP_OPT_X_TLS_CRL_NONE 0
 147 #define LDAP_OPT_X_TLS_CRL_PEER 1
 148 #define LDAP_OPT_X_TLS_CRL_ALL  2
 149
 150 /* OpenLDAP SASL options */
 151 #define LDAP_OPT_X_SASL_MECH                    0x6100
 152 #define LDAP_OPT_X_SASL_REALM                   0x6101
 153 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
 154 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
 155 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
 156 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
 157 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
 158 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
 159 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
 160 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
 161
 162 /* Private API Extensions -- reserved for application use */
 163 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000  /* Private API inclusive */
 164
 165 /*
 166  * ldap_get_option() and ldap_set_option() return values.
 167  * As later versions may return other values indicating
 168  * failure, current applications should only compare returned
 169  * value against LDAP_OPT_SUCCESS.
 170  */
 171 #define LDAP_OPT_SUCCESS        0
 172 #define LDAP_OPT_ERROR          (-1)
 173
 174 /* option on/off values */
 175 #define LDAP_OPT_ON             ((void *) &ber_pvt_opt_on)
 176 #define LDAP_OPT_OFF    ((void *) 0)
 177
 178 typedef struct ldapapiinfo {
 179         int             ldapai_info_version;            /* version of LDAPAPIInfo */
 180 #define LDAP_API_INFO_VERSION   (1)
 181         int             ldapai_api_version;                     /* revision of API supported */
 182         int             ldapai_protocol_version;        /* highest LDAP version supported */
 183         char    **ldapai_extensions;            /* names of API extensions */
 184         char    *ldapai_vendor_name;            /* name of supplier */
 185         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
 186 } LDAPAPIInfo;
 187
 188 typedef struct ldap_apifeature_info {
 189         int             ldapaif_info_version;           /* version of LDAPAPIFeatureInfo */
 190 #define LDAP_FEATURE_INFO_VERSION (1)   /* apifeature_info struct version */
 191         char*   ldapaif_name;                           /* LDAP_API_FEATURE_* (less prefix) */
 192         int             ldapaif_version;                        /* value of LDAP_API_FEATURE_... */
 193 } LDAPAPIFeatureInfo;
 194
 195 /*
 196  * LDAP Control structure
 197  */
 198 typedef struct ldapcontrol {
 199         char *                  ldctl_oid;                      /* numericoid of control */
 200         struct berval   ldctl_value;            /* encoded value of control */
 201         char                    ldctl_iscritical;       /* criticality */
 202 } LDAPControl;
 203
 204 /* LDAP Controls */
 205 /*      standard track controls */
 206 #define LDAP_CONTROL_MANAGEDSAIT                "2.16.840.1.113730.3.4.2" /* RFC 3296 */
 207 #define LDAP_CONTROL_SUBENTRIES                 "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
 208 #define LDAP_CONTROL_PAGEDRESULTS               "1.2.840.113556.1.4.319"  /* RFC 2696 */
 209 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"  /* RFC 3876 */
 210
 211 /*  standard track - not implemented in slapd(8) */
 212 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473" /* RFC 2891 */
 213 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474" /* RFC 2891 */
 214
 215 /* but not yet formalized controls */
 216 #define LDAP_CONTROL_PROXY_AUTHZ                "2.16.840.1.113730.3.4.18"
 217
 218 /* various works in progress */
 219 #define LDAP_CONTROL_ASSERT                             "1.3.6.1.4.1.4203.666.5.9"
 220 #define LDAP_CONTROL_NOOP                               "1.3.6.1.4.1.4203.666.5.2"
 221 #define LDAP_CONTROL_PRE_READ                   "1.3.6.1.4.1.4203.666.5.10.1"
 222 #define LDAP_CONTROL_POST_READ                  "1.3.6.1.4.1.4203.666.5.10.2"
 223
 224 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
 225 #define LDAP_CONTROL_DUPENT_REQUEST             "2.16.840.1.113719.1.27.101.1"
 226 #define LDAP_CONTROL_DUPENT_RESPONSE    "2.16.840.1.113719.1.27.101.2"
 227 #define LDAP_CONTROL_DUPENT_ENTRY               "2.16.840.1.113719.1.27.101.3"
 228 #define LDAP_CONTROL_DUPENT     LDAP_CONTROL_DUPENT_REQUEST
 229
 230 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
 231 /* draft-ietf-ldapext-psearch-03.txt (expired) */
 232 #define LDAP_CONTROL_PERSIST_REQUEST                            "2.16.840.1.113730.3.4.3"
 233 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE        "2.16.840.1.113730.3.4.7"
 234 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_ADD           0x1
 235 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_DELETE        0x2
 236 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_MODIFY        0x4
 237 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_RENAME        0x8
 238
 239 /* LDAP VLV *//* not implemented in slapd(8) */
 240 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
 241 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 242
 243 /* Password policy Controls *//* work in progress */
 244 /* ITS#3458: released, but not to latest draft; disabled by default */
 245 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST      "1.3.6.1.4.1.42.2.27.8.5.1"
 246 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE     "1.3.6.1.4.1.42.2.27.8.5.1"
 247
 248 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
 249 #define LDAP_SYNC_OID                   "1.3.6.1.4.1.4203.1.9.1"
 250 #define LDAP_CONTROL_SYNC               LDAP_SYNC_OID ".1"
 251 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
 252 #define LDAP_CONTROL_SYNC_DONE  LDAP_SYNC_OID ".3"
 253 #define LDAP_SYNC_INFO                  LDAP_SYNC_OID ".4"
 254
 255 #define LDAP_SYNC_NONE                                  0x00
 256 #define LDAP_SYNC_REFRESH_ONLY                  0x01
 257 #define LDAP_SYNC_RESERVED                              0x02
 258 #define LDAP_SYNC_REFRESH_AND_PERSIST   0x03
 259
 260 #define LDAP_SYNC_REFRESH_PRESENTS              0
 261 #define LDAP_SYNC_REFRESH_DELETES               1
 262
 263 #define LDAP_TAG_SYNC_NEW_COOKIE                ((ber_tag_t) 0x80U)
 264 #define LDAP_TAG_SYNC_REFRESH_DELETE    ((ber_tag_t) 0xa1U)
 265 #define LDAP_TAG_SYNC_REFRESH_PRESENT   ((ber_tag_t) 0xa2U)
 266 #define LDAP_TAG_SYNC_ID_SET                    ((ber_tag_t) 0xa3U)
 267
 268 #define LDAP_TAG_SYNC_COOKIE                    ((ber_tag_t) 0x04U)
 269 #define LDAP_TAG_REFRESHDELETES                 ((ber_tag_t) 0x01U)
 270 #define LDAP_TAG_REFRESHDONE                    ((ber_tag_t) 0x01U)
 271 #define LDAP_TAG_RELOAD_HINT                    ((ber_tag_t) 0x01U)
 272
 273 #define LDAP_SYNC_PRESENT                               0
 274 #define LDAP_SYNC_ADD                                   1
 275 #define LDAP_SYNC_MODIFY                                2
 276 #define LDAP_SYNC_DELETE                                3
 277
 278 /* LDAP Chaining Behavior Control *//* work in progress */
 279 /* <draft-sermersheim-ldap-chaining>;
 280  * see also LDAP_REQUIRES_CHAINING, LDAP_CANNOT_CHAIN */
 281 #ifdef LDAP_DEVEL
 282 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR        "1.3.6.1.4.1.4203.666.11.3"
 283
 284 #define LDAP_CHAINING_PREFERRED                         0
 285 #define LDAP_CHAINING_REQUIRED                          1
 286 #define LDAP_REFERRALS_PREFERRED                        2
 287 #define LDAP_REFERRALS_REQUIRED                         3
 288 #endif
 289
 290 /* MS ActiveDirectory controls (for compatibility) */
 291 #define LDAP_CONTROL_X_DOMAIN_SCOPE             "1.2.840.113556.1.4.1339"
 292 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY        "1.2.840.113556.1.4.1413"
 293 #define LDAP_CONTROL_X_INCREMENTAL_VALUES       "1.2.840.113556.1.4.802"
 294 #define LDAP_CONTROL_X_TREE_DELETE              "1.2.840.113556.1.4.805"
 295 #define LDAP_CONTROL_X_SEARCH_OPTIONS           "1.2.840.113556.1.4.1340"
 296 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE           1 /* do not generate referrals */
 297 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT           2 /* search all NCs subordinate to base */
 298
 299 /* LDAP Unsolicited Notifications */
 300 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
 301 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 302
 303 /* LDAP Extended Operations */
 304 #define LDAP_EXOP_START_TLS             "1.3.6.1.4.1.1466.20037"        /* RFC 2830 */
 305
 306 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"       /* RFC 3062 */
 307 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
 308 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
 309 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
 310 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
 311
 312 #define LDAP_EXOP_CANCEL                "1.3.6.1.1.8"                           /* RFC 3909 */
 313 #define LDAP_EXOP_X_CANCEL              LDAP_EXOP_CANCEL
 314
 315 /* various works in progress */
 316
 317 #define LDAP_EXOP_WHO_AM_I              "1.3.6.1.4.1.4203.1.11.3"
 318 #define LDAP_EXOP_X_WHO_AM_I    LDAP_EXOP_WHO_AM_I
 319
 320 #define LDAP_EXOP_X_TURN                "1.3.6.1.4.1.4203.666.6.4"
 321
 322 /* LDAP Grouping of Related Operations *//* a work in progress */
 323 #ifdef LDAP_DEVEL
 324 #define LDAP_X_GROUPING_BASE            "1.3.6.1.4.1.4203.666.10.3"
 325 #define LDAP_EXOP_GROUPING_CREATE       LDAP_X_GROUPING_BASE ".1"
 326 #define LDAP_EXOP_GROUPING_END          LDAP_X_GROUPING_BASE ".2"
 327 #define LDAP_NOTICE_GROUPING_END        LDAP_X_GROUPING_BASE ".3"
 328 #define LDAP_EXOP_GROUPING_ACTION       LDAP_X_GROUPING_BASE ".4"
 329 #define LDAP_NOTICE_GROUPING_INFO       LDAP_X_GROUPING_BASE ".5"
 330 #define LDAP_CONTROL_GROUPING           LDAP_X_GROUPING_BASE ".6"
 331 #endif
 332
 333 /* LDAP Grouping Types *//* a work in progress */
 334 #ifdef LDAP_DEVEL
 335 #define LDAP_GROUP_TRANSACTION           "1.3.6.1.4.1.4203.666.10.4"
 336 #endif
 337
 338 /* LDAP Features */
 339 #define LDAP_FEATURE_ALL_OP_ATTRS       "1.3.6.1.4.1.4203.1.5.1"        /* RFC 3673 */
 340 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
 341         "1.3.6.1.4.1.4203.1.5.2" /*  @objectClass - new number to be assigned */
 342 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
 343 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
 344 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
 345
 346 #ifdef LDAP_DEVEL
 347 /* LDAP Experimental (works in progress) Features */
 348 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2"
 349 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
 350         "1.3.6.1.4.1.4203.666.8.1" /* "children" */
 351 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
 352 #endif
 353
 354 /*
 355  * specific LDAP instantiations of BER types we know about
 356  */
 357
 358 /* Overview of LBER tag construction
 359  *
 360  *      Bits
 361  *      ______
 362  *      8 7 | CLASS
 363  *      0 0 = UNIVERSAL
 364  *      0 1 = APPLICATION
 365  *      1 0 = CONTEXT-SPECIFIC
 366  *      1 1 = PRIVATE
 367  *              _____
 368  *              | 6 | DATA-TYPE
 369  *                0 = PRIMITIVE
 370  *                1 = CONSTRUCTED
 371  *                      ___________
 372  *                      | 5 ... 1 | TAG-NUMBER
 373  */
 374
 375 /* general stuff */
 376 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
 377 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
 378
 379 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octet string */
 380 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octet string */
 381
 382 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
 383 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
 384
 385 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
 386
 387 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
 388 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
 389 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
 390 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
 391
 392 #define LDAP_TAG_IM_RES_OID   ((ber_tag_t) 0x80U)       /* context specific + primitive */
 393 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U)       /* context specific + primitive */
 394
 395 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
 396
 397 /* LDAP Request Messages */
 398 #define LDAP_REQ_BIND           ((ber_tag_t) 0x60U)     /* application + constructed */
 399 #define LDAP_REQ_UNBIND         ((ber_tag_t) 0x42U)     /* application + primitive   */
 400 #define LDAP_REQ_SEARCH         ((ber_tag_t) 0x63U)     /* application + constructed */
 401 #define LDAP_REQ_MODIFY         ((ber_tag_t) 0x66U)     /* application + constructed */
 402 #define LDAP_REQ_ADD            ((ber_tag_t) 0x68U)     /* application + constructed */
 403 #define LDAP_REQ_DELETE         ((ber_tag_t) 0x4aU)     /* application + primitive   */
 404 #define LDAP_REQ_MODDN          ((ber_tag_t) 0x6cU)     /* application + constructed */
 405 #define LDAP_REQ_MODRDN         LDAP_REQ_MODDN
 406 #define LDAP_REQ_RENAME         LDAP_REQ_MODDN
 407 #define LDAP_REQ_COMPARE        ((ber_tag_t) 0x6eU)     /* application + constructed */
 408 #define LDAP_REQ_ABANDON        ((ber_tag_t) 0x50U)     /* application + primitive   */
 409 #define LDAP_REQ_EXTENDED       ((ber_tag_t) 0x77U)     /* application + constructed */
 410
 411 /* LDAP Response Messages */
 412 #define LDAP_RES_BIND           ((ber_tag_t) 0x61U)     /* application + constructed */
 413 #define LDAP_RES_SEARCH_ENTRY   ((ber_tag_t) 0x64U)     /* application + constructed */
 414 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
 415 #define LDAP_RES_SEARCH_RESULT  ((ber_tag_t) 0x65U)     /* application + constructed */
 416 #define LDAP_RES_MODIFY         ((ber_tag_t) 0x67U)     /* application + constructed */
 417 #define LDAP_RES_ADD            ((ber_tag_t) 0x69U)     /* application + constructed */
 418 #define LDAP_RES_DELETE         ((ber_tag_t) 0x6bU)     /* application + constructed */
 419 #define LDAP_RES_MODDN          ((ber_tag_t) 0x6dU)     /* application + constructed */
 420 #define LDAP_RES_MODRDN         LDAP_RES_MODDN  /* application + constructed */
 421 #define LDAP_RES_RENAME         LDAP_RES_MODDN  /* application + constructed */
 422 #define LDAP_RES_COMPARE        ((ber_tag_t) 0x6fU)     /* application + constructed */
 423 #define LDAP_RES_EXTENDED       ((ber_tag_t) 0x78U)     /* V3: application + constructed */
 424 #define LDAP_RES_INTERMEDIATE   ((ber_tag_t) 0x79U) /* V3+: application + constructed */
 425
 426 #define LDAP_RES_ANY                    (-1)
 427 #define LDAP_RES_UNSOLICITED    (0)
 428
 429
 430 /* sasl methods */
 431 #define LDAP_SASL_SIMPLE        ((char*)0)
 432 #define LDAP_SASL_NULL          ("")
 433
 434
 435 /* authentication methods available */
 436 #define LDAP_AUTH_NONE   ((ber_tag_t) 0x00U) /* no authentication */
 437 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
 438 #define LDAP_AUTH_SASL   ((ber_tag_t) 0xa3U) /* context specific + constructed */
 439 #define LDAP_AUTH_KRBV4  ((ber_tag_t) 0xffU) /* means do both of the following */
 440 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
 441 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
 442
 443
 444 /* filter types */
 445 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U)     /* context specific + constructed */
 446 #define LDAP_FILTER_OR  ((ber_tag_t) 0xa1U)     /* context specific + constructed */
 447 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U)     /* context specific + constructed */
 448 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
 449 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
 450 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
 451 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
 452 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive   */
 453 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U)  /* context specific + constructed */
 454 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U)     /* context specific + constructed */
 455
 456 /* extended filter component types */
 457 #define LDAP_FILTER_EXT_OID             ((ber_tag_t) 0x81U)     /* context specific */
 458 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
 459 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
 460 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
 461
 462 /* substring filter component types */
 463 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 464 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
 465 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 466
 467 /* search scopes */
 468 #define LDAP_SCOPE_DEFAULT              ((ber_int_t) -1)         /* OpenLDAP extension */
 469 #define LDAP_SCOPE_BASE                 ((ber_int_t) 0x0000)
 470 #define LDAP_SCOPE_BASEOBJECT   LDAP_SCOPE_BASE
 471 #define LDAP_SCOPE_ONELEVEL             ((ber_int_t) 0x0001)
 472 #define LDAP_SCOPE_ONE                  LDAP_SCOPE_ONELEVEL
 473 #define LDAP_SCOPE_SUBTREE              ((ber_int_t) 0x0002)
 474 #define LDAP_SCOPE_SUB                  LDAP_SCOPE_SUBTREE
 475 #define LDAP_SCOPE_SUBORDINATE  ((ber_int_t) 0x0003) /* OpenLDAP extension */
 476 #define LDAP_SCOPE_CHILDREN             LDAP_SCOPE_SUBORDINATE
 477
 478 /* substring filter component types */
 479 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 480 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
 481 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 482
 483 /*
 484  * LDAP Result Codes
 485  */
 486 #define LDAP_SUCCESS                            0x00
 487
 488 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
 489
 490 #define LDAP_OPERATIONS_ERROR           0x01
 491 #define LDAP_PROTOCOL_ERROR                     0x02
 492 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 493 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 494 #define LDAP_COMPARE_FALSE                      0x05
 495 #define LDAP_COMPARE_TRUE                       0x06
 496 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
 497 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
 498 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 499 #define LDAP_STRONGER_AUTH_REQUIRED     LDAP_STRONG_AUTH_REQUIRED
 500 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
 501
 502 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 503 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 504 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
 505 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 506 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 507
 508 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 509
 510 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 511 #define LDAP_UNDEFINED_TYPE                     0x11
 512 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 513 #define LDAP_CONSTRAINT_VIOLATION       0x13
 514 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 515 #define LDAP_INVALID_SYNTAX                     0x15
 516
 517 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
 518
 519 #define LDAP_NO_SUCH_OBJECT                     0x20
 520 #define LDAP_ALIAS_PROBLEM                      0x21
 521 #define LDAP_INVALID_DN_SYNTAX          0x22
 522 #define LDAP_IS_LEAF                            0x23 /* not LDAPv3 */
 523 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 524
 525 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
 526
 527 #define LDAP_PROXY_AUTHZ_FAILURE        0x2F /* LDAPv3 proxy authorization */
 528 #define LDAP_INAPPROPRIATE_AUTH         0x30
 529 #define LDAP_INVALID_CREDENTIALS        0x31
 530 #define LDAP_INSUFFICIENT_ACCESS        0x32
 531
 532 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
 533
 534 #define LDAP_BUSY                                       0x33
 535 #define LDAP_UNAVAILABLE                        0x34
 536 #define LDAP_UNWILLING_TO_PERFORM       0x35
 537 #define LDAP_LOOP_DETECT                        0x36
 538
 539 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
 540
 541 #define LDAP_NAMING_VIOLATION           0x40
 542 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 543 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 544 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 545 #define LDAP_ALREADY_EXISTS                     0x44
 546 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 547 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 548 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
 549
 550 #define LDAP_OTHER                                      0x50
 551
 552 /* LCUP operation codes (113-117) - not implemented */
 553 #define LDAP_CUP_RESOURCES_EXHAUSTED    0x71
 554 #define LDAP_CUP_SECURITY_VIOLATION             0x72
 555 #define LDAP_CUP_INVALID_DATA                   0x73
 556 #define LDAP_CUP_UNSUPPORTED_SCHEME             0x74
 557 #define LDAP_CUP_RELOAD_REQUIRED                0x75
 558
 559 /* Cancel operation codes (118-121) */
 560 #define LDAP_CANCELLED                          0x76
 561 #define LDAP_NO_SUCH_OPERATION          0x77
 562 #define LDAP_TOO_LATE                           0x78
 563 #define LDAP_CANNOT_CANCEL                      0x79
 564
 565
 566 /* Experimental result codes */
 567 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
 568 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
 569
 570 /* for the LDAP Sync operation */
 571 #define LDAP_SYNC_REFRESH_REQUIRED              0x4100
 572
 573 /* for the LDAP No-Op control */
 574 #define LDAP_NO_OPERATION                               0x410e
 575
 576 /* for the Assertion control */
 577 #define LDAP_ASSERTION_FAILED                   0x410f
 578
 579 /* for the Chaining Behavior control (consecutive result codes requested;
 580  * see <draft-sermersheim-ldap-chaining> ) */
 581 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
 582 #define LDAP_REQUIRES_CHAINING                  0x4110
 583 #define LDAP_CANNOT_CHAIN                       0x4111
 584 #endif
 585
 586 /* API Error Codes
 587  *
 588  * Based on draft-ietf-ldap-c-api-xx
 589  * but with new negative code values
 590  */
 591 #define LDAP_API_ERROR(n)               ((n)<0)
 592 #define LDAP_API_RESULT(n)              ((n)<=0)
 593
 594 #define LDAP_SERVER_DOWN                                (-1)
 595 #define LDAP_LOCAL_ERROR                                (-2)
 596 #define LDAP_ENCODING_ERROR                             (-3)
 597 #define LDAP_DECODING_ERROR                             (-4)
 598 #define LDAP_TIMEOUT                                    (-5)
 599 #define LDAP_AUTH_UNKNOWN                               (-6)
 600 #define LDAP_FILTER_ERROR                               (-7)
 601 #define LDAP_USER_CANCELLED                             (-8)
 602 #define LDAP_PARAM_ERROR                                (-9)
 603 #define LDAP_NO_MEMORY                                  (-10)
 604 #define LDAP_CONNECT_ERROR                              (-11)
 605 #define LDAP_NOT_SUPPORTED                              (-12)
 606 #define LDAP_CONTROL_NOT_FOUND                  (-13)
 607 #define LDAP_NO_RESULTS_RETURNED                (-14)
 608 #define LDAP_MORE_RESULTS_TO_RETURN             (-15)
 609 #define LDAP_CLIENT_LOOP                                (-16)
 610 #define LDAP_REFERRAL_LIMIT_EXCEEDED    (-17)
 611
 612
 613 /*
 614  * This structure represents both ldap messages and ldap responses.
 615  * These are really the same, except in the case of search responses,
 616  * where a response has multiple messages.
 617  */
 618
 619 typedef struct ldapmsg LDAPMessage;
 620
 621 /* for modifications */
 622 typedef struct ldapmod {
 623         int             mod_op;
 624
 625 #define LDAP_MOD_OP                     (0x0007)
 626 #define LDAP_MOD_ADD            (0x0000)
 627 #define LDAP_MOD_DELETE         (0x0001)
 628 #define LDAP_MOD_REPLACE        (0x0002)
 629 #define LDAP_MOD_INCREMENT      (0x0003) /* OpenLDAP extension */
 630 #define LDAP_MOD_BVALUES        (0x0080)
 631 /* IMPORTANT: do not use code 0x1000 (or above),
 632  * it is used internally by the backends!
 633  * (see ldap/servers/slapd/slap.h)
 634  */
 635
 636         char            *mod_type;
 637         union mod_vals_u {
 638                 char            **modv_strvals;
 639                 struct berval   **modv_bvals;
 640         } mod_vals;
 641 #define mod_values      mod_vals.modv_strvals
 642 #define mod_bvalues     mod_vals.modv_bvals
 643 } LDAPMod;
 644
 645 /*
 646  * structure representing an ldap session which can
 647  * encompass connections to multiple servers (in the
 648  * face of referrals).
 649  */
 650 typedef struct ldap LDAP;
 651
 652 #define LDAP_DEREF_NEVER                0x00
 653 #define LDAP_DEREF_SEARCHING    0x01
 654 #define LDAP_DEREF_FINDING              0x02
 655 #define LDAP_DEREF_ALWAYS               0x03
 656
 657 #define LDAP_NO_LIMIT                   0
 658
 659 /* how many messages to retrieve results for */
 660 #define LDAP_MSG_ONE                    0x00
 661 #define LDAP_MSG_ALL                    0x01
 662 #define LDAP_MSG_RECEIVED               0x02
 663
 664 /*
 665  * types for ldap URL handling
 666  */
 667 typedef struct ldap_url_desc {
 668         struct ldap_url_desc *lud_next;
 669         char    *lud_scheme;
 670         char    *lud_host;
 671         int             lud_port;
 672         char    *lud_dn;
 673         char    **lud_attrs;
 674         int             lud_scope;
 675         char    *lud_filter;
 676         char    **lud_exts;
 677         int             lud_crit_exts;
 678 } LDAPURLDesc;
 679
 680 #define LDAP_URL_SUCCESS                0x00    /* Success */
 681 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 682 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 683
 684 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 685 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 686 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 687 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 688 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 689 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 690 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 691 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 692
 693 /*
 694  * The API draft spec says we should declare (or cause to be declared)
 695  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 696  */
 697 struct timeval;
 698
 699 /*
 700  * in options.c:
 701  */
 702 LDAP_F( int )
 703 ldap_get_option LDAP_P((
 704         LDAP *ld,
 705         int option,
 706         void *outvalue));
 707
 708 LDAP_F( int )
 709 ldap_set_option LDAP_P((
 710         LDAP *ld,
 711         int option,
 712         LDAP_CONST void *invalue));
 713
 714 /* V3 REBIND Function Callback Prototype */
 715 typedef int (LDAP_REBIND_PROC) LDAP_P((
 716         LDAP *ld, LDAP_CONST char *url,
 717         ber_tag_t request, ber_int_t msgid,
 718         void *params ));
 719
 720 LDAP_F( int )
 721 ldap_set_rebind_proc LDAP_P((
 722         LDAP *ld,
 723         LDAP_REBIND_PROC *rebind_proc,
 724         void *params ));
 725
 726 /*
 727  * in controls.c:
 728  */
 729 LDAP_F( int )
 730 ldap_create_control LDAP_P((
 731         LDAP_CONST char *requestOID,
 732         BerElement *ber,
 733         int iscritical,
 734         LDAPControl **ctrlp ));
 735
 736 LDAP_F( LDAPControl * )
 737 ldap_find_control LDAP_P((
 738         LDAP_CONST char *oid,
 739         LDAPControl **ctrls ));
 740
 741 LDAP_F( void )
 742 ldap_control_free LDAP_P((
 743         LDAPControl *ctrl ));
 744
 745 LDAP_F( void )
 746 ldap_controls_free LDAP_P((
 747         LDAPControl **ctrls ));
 748
 749 /*
 750  * in dnssrv.c:
 751  */
 752 LDAP_F( int )
 753 ldap_domain2dn LDAP_P((
 754         LDAP_CONST char* domain,
 755         char** dn ));
 756
 757 LDAP_F( int )
 758 ldap_dn2domain LDAP_P((
 759         LDAP_CONST char* dn,
 760         char** domain ));
 761
 762 LDAP_F( int )
 763 ldap_domain2hostlist LDAP_P((
 764         LDAP_CONST char *domain,
 765         char** hostlist ));
 766
 767 /*
 768  * in extended.c:
 769  */
 770 LDAP_F( int )
 771 ldap_extended_operation LDAP_P((
 772         LDAP                    *ld,
 773         LDAP_CONST char *reqoid,
 774         struct berval   *reqdata,
 775         LDAPControl             **serverctrls,
 776         LDAPControl             **clientctrls,
 777         int                             *msgidp ));
 778
 779 LDAP_F( int )
 780 ldap_extended_operation_s LDAP_P((
 781         LDAP                    *ld,
 782         LDAP_CONST char *reqoid,
 783         struct berval   *reqdata,
 784         LDAPControl             **serverctrls,
 785         LDAPControl             **clientctrls,
 786         char                    **retoidp,
 787         struct berval   **retdatap ));
 788
 789 LDAP_F( int )
 790 ldap_parse_extended_result LDAP_P((
 791         LDAP                    *ld,
 792         LDAPMessage             *res,
 793         char                    **retoidp,
 794         struct berval   **retdatap,
 795         int                             freeit ));
 796
 797 LDAP_F( int )
 798 ldap_parse_intermediate LDAP_P((
 799         LDAP                    *ld,
 800         LDAPMessage             *res,
 801         char                    **retoidp,
 802         struct berval   **retdatap,
 803         LDAPControl             ***serverctrls,
 804         int                             freeit ));
 805
 806 /*
 807  * in groupings.c:
 808  */
 809 #ifdef LDAP_EXOP_GROUPING_CREATE
 810
 811 LDAP_F( int )
 812 ldap_grouping_create LDAP_P((
 813         LDAP                    *ld,
 814         LDAP_CONST char *grpoid,
 815         struct berval   *grpdata,
 816         LDAPControl             **serverctrls,
 817         LDAPControl             **clientctrls,
 818         int                             *msgidp ));
 819
 820 LDAP_F( int )
 821 ldap_grouping_create_s LDAP_P((
 822         LDAP                    *ld,
 823         LDAP_CONST char *grpoid,
 824         struct berval   *grpdata,
 825         LDAPControl             **serverctrls,
 826         LDAPControl             **clientctrls,
 827         struct berval   **retgrpcookiep,
 828         struct berval   **retgrpdatap ));
 829
 830 LDAP_F( int )
 831 ldap_parse_grouping_create_result LDAP_P((
 832         LDAP                    *ld,
 833         LDAPMessage             *res,
 834         struct berval   **retgrpcookiep,
 835         struct berval   **retgrpdatap,
 836         LDAPControl             ***serverctrls,
 837         int                             freeit ));
 838
 839 LDAP_F( int )
 840 ldap_grouping_end LDAP_P((
 841         LDAP                    *ld,
 842         LDAP_CONST char *grpoid,
 843         struct berval   *grpdata,
 844         LDAPControl             **serverctrls,
 845         LDAPControl             **clientctrls,
 846         int                             *msgidp ));
 847
 848 LDAP_F( int )
 849 ldap_grouping_end_s LDAP_P((
 850         LDAP                    *ld,
 851         LDAP_CONST char *grpoid,
 852         struct berval   *grpdata,
 853         LDAPControl             **serverctrls,
 854         LDAPControl             **clientctrls,
 855         struct berval   **retgrpdatap ));
 856
 857 LDAP_F( int )
 858 ldap_parse_grouping_end_result LDAP_P((
 859         LDAP                    *ld,
 860         LDAPMessage             *res,
 861         struct berval   **retgrpdatap,
 862         LDAPControl             ***serverctrls,
 863         int                             freeit ));
 864
 865 LDAP_F( int )
 866 ldap_grouping_action_operation LDAP_P((
 867         LDAP                    *ld,
 868         LDAP_CONST char *grpoid,
 869         struct berval   *grpdata,
 870         LDAPControl             **serverctrls,
 871         LDAPControl             **clientctrls,
 872         int                             *msgidp ));
 873
 874 LDAP_F( int )
 875 ldap_grouping_action_operation_s LDAP_P((
 876         LDAP                    *ld,
 877         LDAP_CONST char *grpoid,
 878         struct berval   *grpdata,
 879         LDAPControl             **serverctrls,
 880         LDAPControl             **clientctrls,
 881         struct berval   **retgrpcookiep,
 882         struct berval   **retgrpdatap ));
 883
 884 LDAP_F( int )
 885 ldap_parse_grouping_action_result LDAP_P((
 886         LDAP                    *ld,
 887         LDAPMessage             *res,
 888         struct berval   **retgrpcookiep,
 889         struct berval   **retgrpdatap,
 890         LDAPControl             ***serverctrls,
 891         int                             freeit ));
 892
 893 LDAP_F( int )
 894 ldap_parse_grouping_end_notice LDAP_P((
 895         LDAP                    *ld,
 896         LDAPMessage             *res,
 897         struct berval   **retdatap,
 898         struct berval   **retgrpcookiep,
 899         struct berval   **retgrpdatap,
 900         int                             freeit ));
 901
 902 LDAP_F( int )
 903 ldap_parse_grouping_info_notice LDAP_P((
 904         LDAP                    *ld,
 905         LDAPMessage             *res,
 906         struct berval   **retdatap,
 907         struct berval   **retgrpcookiep,
 908         struct berval   **retgrpdatap,
 909         int                             freeit ));
 910 #endif
 911
 912 /*
 913  * in abandon.c:
 914  */
 915 LDAP_F( int )
 916 ldap_abandon_ext LDAP_P((
 917         LDAP                    *ld,
 918         int                             msgid,
 919         LDAPControl             **serverctrls,
 920         LDAPControl             **clientctrls ));
 921
 922 #if LDAP_DEPRECATED
 923 LDAP_F( int )
 924 ldap_abandon LDAP_P((   /* deprecated */
 925         LDAP *ld,
 926         int msgid ));
 927 #endif
 928
 929
 930 /*
 931  * in add.c:
 932  */
 933 LDAP_F( int )
 934 ldap_add_ext LDAP_P((
 935         LDAP                    *ld,
 936         LDAP_CONST char *dn,
 937         LDAPMod                 **attrs,
 938         LDAPControl             **serverctrls,
 939         LDAPControl             **clientctrls,
 940         int                     *msgidp ));
 941
 942 LDAP_F( int )
 943 ldap_add_ext_s LDAP_P((
 944         LDAP                    *ld,
 945         LDAP_CONST char *dn,
 946         LDAPMod                 **attrs,
 947         LDAPControl             **serverctrls,
 948         LDAPControl             **clientctrls ));
 949
 950 #if LDAP_DEPRECATED
 951 LDAP_F( int )
 952 ldap_add LDAP_P((       /* deprecated */
 953         LDAP *ld,
 954         LDAP_CONST char *dn,
 955         LDAPMod **attrs ));
 956
 957 LDAP_F( int )
 958 ldap_add_s LDAP_P((     /* deprecated */
 959         LDAP *ld,
 960         LDAP_CONST char *dn,
 961         LDAPMod **attrs ));
 962 #endif
 963
 964
 965 /*
 966  * in sasl.c:
 967  */
 968 LDAP_F( int )
 969 ldap_sasl_bind LDAP_P((
 970         LDAP                    *ld,
 971         LDAP_CONST char *dn,
 972         LDAP_CONST char *mechanism,
 973         struct berval   *cred,
 974         LDAPControl             **serverctrls,
 975         LDAPControl             **clientctrls,
 976         int                             *msgidp ));
 977
 978 /* Interaction flags (should be passed about in a control)
 979  *  Automatic (default): use defaults, prompt otherwise
 980  *  Interactive: prompt always
 981  *  Quiet: never prompt
 982  */
 983 #define LDAP_SASL_AUTOMATIC             0U
 984 #define LDAP_SASL_INTERACTIVE   1U
 985 #define LDAP_SASL_QUIET                 2U
 986
 987 /*
 988  * V3 SASL Interaction Function Callback Prototype
 989  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
 990  *  should likely passed in a control (and provided controls)
 991  */
 992 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
 993         LDAP *ld, unsigned flags, void* defaults, void *interact ));
 994
 995 LDAP_F( int )
 996 ldap_sasl_interactive_bind_s LDAP_P((
 997         LDAP *ld,
 998         LDAP_CONST char *dn, /* usually NULL */
 999         LDAP_CONST char *saslMechanism,
1000         LDAPControl **serverControls,
1001         LDAPControl **clientControls,
1002
1003         /* should be client controls */
1004         unsigned flags,
1005         LDAP_SASL_INTERACT_PROC *proc,
1006         void *defaults ));
1007
1008 LDAP_F( int )
1009 ldap_sasl_bind_s LDAP_P((
1010         LDAP                    *ld,
1011         LDAP_CONST char *dn,
1012         LDAP_CONST char *mechanism,
1013         struct berval   *cred,
1014         LDAPControl             **serverctrls,
1015         LDAPControl             **clientctrls,
1016         struct berval   **servercredp ));
1017
1018 LDAP_F( int )
1019 ldap_parse_sasl_bind_result LDAP_P((
1020         LDAP                    *ld,
1021         LDAPMessage             *res,
1022         struct berval   **servercredp,
1023         int                             freeit ));
1024
1025 #if LDAP_DEPRECATED
1026 /*
1027  * in bind.c:
1028  *      (deprecated)
1029  */
1030 LDAP_F( int )
1031 ldap_bind LDAP_P((      /* deprecated */
1032         LDAP *ld,
1033         LDAP_CONST char *who,
1034         LDAP_CONST char *passwd,
1035         int authmethod ));
1036
1037 LDAP_F( int )
1038 ldap_bind_s LDAP_P((    /* deprecated */
1039         LDAP *ld,
1040         LDAP_CONST char *who,
1041         LDAP_CONST char *cred,
1042         int authmethod ));
1043
1044 /*
1045  * in sbind.c:
1046  */
1047 LDAP_F( int )
1048 ldap_simple_bind LDAP_P(( /* deprecated */
1049         LDAP *ld,
1050         LDAP_CONST char *who,
1051         LDAP_CONST char *passwd ));
1052
1053 LDAP_F( int )
1054 ldap_simple_bind_s LDAP_P(( /* deprecated */
1055         LDAP *ld,
1056         LDAP_CONST char *who,
1057         LDAP_CONST char *passwd ));
1058
1059
1060 /*
1061  * in kbind.c:
1062  *      (deprecated)
1063  */
1064 LDAP_F( int )
1065 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
1066         LDAP *ld,
1067         LDAP_CONST char *who ));
1068
1069 LDAP_F( int )
1070 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
1071         LDAP *ld,
1072         LDAP_CONST char *who ));
1073
1074 LDAP_F( int )
1075 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
1076         LDAP *ld,
1077         LDAP_CONST char *who ));
1078
1079 LDAP_F( int )
1080 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
1081         LDAP *ld,
1082         LDAP_CONST char *who ));
1083
1084 LDAP_F( int )
1085 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
1086         LDAP *ld,
1087         LDAP_CONST char *who ));
1088 #endif
1089
1090
1091 /*
1092  * in compare.c:
1093  */
1094 LDAP_F( int )
1095 ldap_compare_ext LDAP_P((
1096         LDAP                    *ld,
1097         LDAP_CONST char *dn,
1098         LDAP_CONST char *attr,
1099         struct berval   *bvalue,
1100         LDAPControl             **serverctrls,
1101         LDAPControl             **clientctrls,
1102         int                     *msgidp ));
1103
1104 LDAP_F( int )
1105 ldap_compare_ext_s LDAP_P((
1106         LDAP                    *ld,
1107         LDAP_CONST char *dn,
1108         LDAP_CONST char *attr,
1109         struct berval   *bvalue,
1110         LDAPControl             **serverctrls,
1111         LDAPControl             **clientctrls ));
1112
1113 #if LDAP_DEPRECATED
1114 LDAP_F( int )
1115 ldap_compare LDAP_P((   /* deprecated */
1116         LDAP *ld,
1117         LDAP_CONST char *dn,
1118         LDAP_CONST char *attr,
1119         LDAP_CONST char *value ));
1120
1121 LDAP_F( int )
1122 ldap_compare_s LDAP_P(( /* deprecated */
1123         LDAP *ld,
1124         LDAP_CONST char *dn,
1125         LDAP_CONST char *attr,
1126         LDAP_CONST char *value ));
1127 #endif
1128
1129
1130 /*
1131  * in delete.c:
1132  */
1133 LDAP_F( int )
1134 ldap_delete_ext LDAP_P((
1135         LDAP                    *ld,
1136         LDAP_CONST char *dn,
1137         LDAPControl             **serverctrls,
1138         LDAPControl             **clientctrls,
1139         int                     *msgidp ));
1140
1141 LDAP_F( int )
1142 ldap_delete_ext_s LDAP_P((
1143         LDAP                    *ld,
1144         LDAP_CONST char *dn,
1145         LDAPControl             **serverctrls,
1146         LDAPControl             **clientctrls ));
1147
1148 #if LDAP_DEPRECATED
1149 LDAP_F( int )
1150 ldap_delete LDAP_P((    /* deprecated */
1151         LDAP *ld,
1152         LDAP_CONST char *dn ));
1153
1154 LDAP_F( int )
1155 ldap_delete_s LDAP_P((  /* deprecated */
1156         LDAP *ld,
1157         LDAP_CONST char *dn ));
1158 #endif
1159
1160
1161 /*
1162  * in error.c:
1163  */
1164 LDAP_F( int )
1165 ldap_parse_result LDAP_P((
1166         LDAP                    *ld,
1167         LDAPMessage             *res,
1168         int                             *errcodep,
1169         char                    **matcheddnp,
1170         char                    **errmsgp,
1171         char                    ***referralsp,
1172         LDAPControl             ***serverctrls,
1173         int                             freeit ));
1174
1175 LDAP_F( char * )
1176 ldap_err2string LDAP_P((
1177         int err ));
1178
1179 #if LDAP_DEPRECATED
1180 LDAP_F( int )
1181 ldap_result2error LDAP_P((      /* deprecated */
1182         LDAP *ld,
1183         LDAPMessage *r,
1184         int freeit ));
1185
1186 LDAP_F( void )
1187 ldap_perror LDAP_P((    /* deprecated */
1188         LDAP *ld,
1189         LDAP_CONST char *s ));
1190 #endif
1191
1192
1193 /*
1194  * in modify.c:
1195  */
1196 LDAP_F( int )
1197 ldap_modify_ext LDAP_P((
1198         LDAP                    *ld,
1199         LDAP_CONST char *dn,
1200         LDAPMod                 **mods,
1201         LDAPControl             **serverctrls,
1202         LDAPControl             **clientctrls,
1203         int                     *msgidp ));
1204
1205 LDAP_F( int )
1206 ldap_modify_ext_s LDAP_P((
1207         LDAP                    *ld,
1208         LDAP_CONST char *dn,
1209         LDAPMod                 **mods,
1210         LDAPControl             **serverctrls,
1211         LDAPControl             **clientctrls ));
1212
1213 #if LDAP_DEPRECATED
1214 LDAP_F( int )
1215 ldap_modify LDAP_P((    /* deprecated */
1216         LDAP *ld,
1217         LDAP_CONST char *dn,
1218         LDAPMod **mods ));
1219
1220 LDAP_F( int )
1221 ldap_modify_s LDAP_P((  /* deprecated */
1222         LDAP *ld,
1223         LDAP_CONST char *dn,
1224         LDAPMod **mods ));
1225 #endif
1226
1227
1228 /*
1229  * in modrdn.c:
1230  */
1231 LDAP_F( int )
1232 ldap_rename LDAP_P((
1233         LDAP *ld,
1234         LDAP_CONST char *dn,
1235         LDAP_CONST char *newrdn,
1236         LDAP_CONST char *newSuperior,
1237         int deleteoldrdn,
1238         LDAPControl **sctrls,
1239         LDAPControl **cctrls,
1240         int *msgidp ));
1241
1242 LDAP_F( int )
1243 ldap_rename_s LDAP_P((
1244         LDAP *ld,
1245         LDAP_CONST char *dn,
1246         LDAP_CONST char *newrdn,
1247         LDAP_CONST char *newSuperior,
1248         int deleteoldrdn,
1249         LDAPControl **sctrls,
1250         LDAPControl **cctrls ));
1251
1252 #if LDAP_DEPRECATED
1253 LDAP_F( int )
1254 ldap_rename2 LDAP_P((   /* deprecated */
1255         LDAP *ld,
1256         LDAP_CONST char *dn,
1257         LDAP_CONST char *newrdn,
1258         LDAP_CONST char *newSuperior,
1259         int deleteoldrdn ));
1260
1261 LDAP_F( int )
1262 ldap_rename2_s LDAP_P(( /* deprecated */
1263         LDAP *ld,
1264         LDAP_CONST char *dn,
1265         LDAP_CONST char *newrdn,
1266         LDAP_CONST char *newSuperior,
1267         int deleteoldrdn ));
1268
1269 LDAP_F( int )
1270 ldap_modrdn LDAP_P((    /* deprecated */
1271         LDAP *ld,
1272         LDAP_CONST char *dn,
1273         LDAP_CONST char *newrdn ));
1274
1275 LDAP_F( int )
1276 ldap_modrdn_s LDAP_P((  /* deprecated */
1277         LDAP *ld,
1278         LDAP_CONST char *dn,
1279         LDAP_CONST char *newrdn ));
1280
1281 LDAP_F( int )
1282 ldap_modrdn2 LDAP_P((   /* deprecated */
1283         LDAP *ld,
1284         LDAP_CONST char *dn,
1285         LDAP_CONST char *newrdn,
1286         int deleteoldrdn ));
1287
1288 LDAP_F( int )
1289 ldap_modrdn2_s LDAP_P(( /* deprecated */
1290         LDAP *ld,
1291         LDAP_CONST char *dn,
1292         LDAP_CONST char *newrdn,
1293         int deleteoldrdn));
1294 #endif
1295
1296
1297 /*
1298  * in open.c:
1299  */
1300 #if LDAP_DEPRECATED
1301 LDAP_F( LDAP * )
1302 ldap_init LDAP_P(( /* deprecated */
1303         LDAP_CONST char *host,
1304         int port ));
1305
1306 LDAP_F( LDAP * )
1307 ldap_open LDAP_P((      /* deprecated */
1308         LDAP_CONST char *host,
1309         int port ));
1310 #endif
1311
1312 LDAP_F( int )
1313 ldap_create LDAP_P((
1314         LDAP **ldp ));
1315
1316 LDAP_F( int )
1317 ldap_initialize LDAP_P((
1318         LDAP **ldp,
1319         LDAP_CONST char *url ));
1320
1321 /*
1322  * in tls.c
1323  */
1324
1325 LDAP_F( int )
1326 ldap_start_tls LDAP_P((
1327         LDAP *ld,
1328         LDAPControl **serverctrls,
1329         LDAPControl **clientctrls,
1330         int *msgidp ));
1331
1332 LDAP_F( int )
1333 ldap_install_tls LDAP_P((
1334         LDAP *ld ));
1335
1336 LDAP_F( int )
1337 ldap_start_tls_s LDAP_P((
1338         LDAP *ld,
1339         LDAPControl **serverctrls,
1340         LDAPControl **clientctrls ));
1341
1342 /*
1343  * in messages.c:
1344  */
1345 LDAP_F( LDAPMessage * )
1346 ldap_first_message LDAP_P((
1347         LDAP *ld,
1348         LDAPMessage *chain ));
1349
1350 LDAP_F( LDAPMessage * )
1351 ldap_next_message LDAP_P((
1352         LDAP *ld,
1353         LDAPMessage *msg ));
1354
1355 LDAP_F( int )
1356 ldap_count_messages LDAP_P((
1357         LDAP *ld,
1358         LDAPMessage *chain ));
1359
1360 /*
1361  * in references.c:
1362  */
1363 LDAP_F( LDAPMessage * )
1364 ldap_first_reference LDAP_P((
1365         LDAP *ld,
1366         LDAPMessage *chain ));
1367
1368 LDAP_F( LDAPMessage * )
1369 ldap_next_reference LDAP_P((
1370         LDAP *ld,
1371         LDAPMessage *ref ));
1372
1373 LDAP_F( int )
1374 ldap_count_references LDAP_P((
1375         LDAP *ld,
1376         LDAPMessage *chain ));
1377
1378 LDAP_F( int )
1379 ldap_parse_reference LDAP_P((
1380         LDAP                    *ld,
1381         LDAPMessage             *ref,
1382         char                    ***referralsp,
1383         LDAPControl             ***serverctrls,
1384         int                             freeit));
1385
1386
1387 /*
1388  * in getentry.c:
1389  */
1390 LDAP_F( LDAPMessage * )
1391 ldap_first_entry LDAP_P((
1392         LDAP *ld,
1393         LDAPMessage *chain ));
1394
1395 LDAP_F( LDAPMessage * )
1396 ldap_next_entry LDAP_P((
1397         LDAP *ld,
1398         LDAPMessage *entry ));
1399
1400 LDAP_F( int )
1401 ldap_count_entries LDAP_P((
1402         LDAP *ld,
1403         LDAPMessage *chain ));
1404
1405 LDAP_F( int )
1406 ldap_get_entry_controls LDAP_P((
1407         LDAP                    *ld,
1408         LDAPMessage             *entry,
1409         LDAPControl             ***serverctrls));
1410
1411
1412 /*
1413  * in addentry.c
1414  */
1415 LDAP_F( LDAPMessage * )
1416 ldap_delete_result_entry LDAP_P((
1417         LDAPMessage **list,
1418         LDAPMessage *e ));
1419
1420 LDAP_F( void )
1421 ldap_add_result_entry LDAP_P((
1422         LDAPMessage **list,
1423         LDAPMessage *e ));
1424
1425
1426 /*
1427  * in getdn.c
1428  */
1429 LDAP_F( char * )
1430 ldap_get_dn LDAP_P((
1431         LDAP *ld,
1432         LDAPMessage *entry ));
1433
1434 typedef struct ldap_ava {
1435         struct berval la_attr;
1436         struct berval la_value;
1437         unsigned la_flags;
1438 #define LDAP_AVA_NULL                           0x0000U
1439 #define LDAP_AVA_STRING                         0x0001U
1440 #define LDAP_AVA_BINARY                         0x0002U
1441 #define LDAP_AVA_NONPRINTABLE           0x0004U
1442 #define LDAP_AVA_FREE_ATTR                      0x0010U
1443 #define LDAP_AVA_FREE_VALUE                     0x0020U
1444
1445         void *la_private;
1446 } LDAPAVA;
1447
1448 typedef LDAPAVA** LDAPRDN;
1449 typedef LDAPRDN* LDAPDN;
1450
1451 /* DN formats */
1452 #define LDAP_DN_FORMAT_LDAP                     0x0000U
1453 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1454 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1455 #define LDAP_DN_FORMAT_DCE                      0x0030U
1456 #define LDAP_DN_FORMAT_UFN                      0x0040U /* dn2str only */
1457 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1458 #define LDAP_DN_FORMAT_LBER                     0x00F0U /* for testing only */
1459 #define LDAP_DN_FORMAT_MASK                     0x00F0U
1460
1461 /* DN flags */
1462 #define LDAP_DN_PRETTY                          0x0100U
1463 #define LDAP_DN_SKIP                            0x0200U
1464 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1465 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1466 #define LDAP_DN_PEDANTIC                        0xF000U
1467
1468 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1469 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1470
1471 LDAP_F( int )
1472 ldap_bv2dn LDAP_P((
1473         struct berval *bv,
1474         LDAPDN *dn,
1475         unsigned flags ));
1476
1477 LDAP_F( int )
1478 ldap_str2dn LDAP_P((
1479         LDAP_CONST char *str,
1480         LDAPDN *dn,
1481         unsigned flags ));
1482
1483 LDAP_F( int )
1484 ldap_dn2bv LDAP_P((
1485         LDAPDN dn,
1486         struct berval *bv,
1487         unsigned flags ));
1488
1489 LDAP_F( int )
1490 ldap_dn2str LDAP_P((
1491         LDAPDN dn,
1492         char **str,
1493         unsigned flags ));
1494
1495 LDAP_F( int )
1496 ldap_bv2rdn LDAP_P((
1497         struct berval *bv,
1498         LDAPRDN *rdn,
1499         char **next,
1500         unsigned flags ));
1501
1502 LDAP_F( int )
1503 ldap_str2rdn LDAP_P((
1504         LDAP_CONST char *str,
1505         LDAPRDN *rdn,
1506         char **next,
1507         unsigned flags ));
1508
1509 LDAP_F( int )
1510 ldap_rdn2bv LDAP_P((
1511         LDAPRDN rdn,
1512         struct berval *bv,
1513         unsigned flags ));
1514
1515 LDAP_F( int )
1516 ldap_rdn2str LDAP_P((
1517         LDAPRDN rdn,
1518         char **str,
1519         unsigned flags ));
1520
1521 LDAP_F( int )
1522 ldap_dn_normalize LDAP_P((
1523         LDAP_CONST char *in, unsigned iflags,
1524         char **out, unsigned oflags ));
1525
1526 LDAP_F( char * )
1527 ldap_dn2ufn LDAP_P(( /* deprecated */
1528         LDAP_CONST char *dn ));
1529
1530 LDAP_F( char ** )
1531 ldap_explode_dn LDAP_P(( /* deprecated */
1532         LDAP_CONST char *dn,
1533         int notypes ));
1534
1535 LDAP_F( char ** )
1536 ldap_explode_rdn LDAP_P(( /* deprecated */
1537         LDAP_CONST char *rdn,
1538         int notypes ));
1539
1540 typedef int LDAPDN_rewrite_func
1541         LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1542
1543 LDAP_F( int )
1544 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1545         LDAPDN_rewrite_func *func, unsigned flags ));
1546
1547 LDAP_F( char * )
1548 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1549
1550 LDAP_F( char * )
1551 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1552
1553 LDAP_F( char * )
1554 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1555
1556 LDAP_F( int )
1557 ldap_get_dn_ber LDAP_P((
1558         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1559
1560 LDAP_F( int )
1561 ldap_get_attribute_ber LDAP_P((
1562         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1563         struct berval **vals ));
1564
1565 /*
1566  * in getattr.c
1567  */
1568 LDAP_F( char * )
1569 ldap_first_attribute LDAP_P((
1570         LDAP *ld,
1571         LDAPMessage *entry,
1572         BerElement **ber ));
1573
1574 LDAP_F( char * )
1575 ldap_next_attribute LDAP_P((
1576         LDAP *ld,
1577         LDAPMessage *entry,
1578         BerElement *ber ));
1579
1580
1581 /*
1582  * in getvalues.c
1583  */
1584 LDAP_F( struct berval ** )
1585 ldap_get_values_len LDAP_P((
1586         LDAP *ld,
1587         LDAPMessage *entry,
1588         LDAP_CONST char *target ));
1589
1590 LDAP_F( int )
1591 ldap_count_values_len LDAP_P((
1592         struct berval **vals ));
1593
1594 LDAP_F( void )
1595 ldap_value_free_len LDAP_P((
1596         struct berval **vals ));
1597
1598 #if LDAP_DEPRECATED
1599 LDAP_F( char ** )
1600 ldap_get_values LDAP_P((        /* deprecated */
1601         LDAP *ld,
1602         LDAPMessage *entry,
1603         LDAP_CONST char *target ));
1604
1605 LDAP_F( int )
1606 ldap_count_values LDAP_P((      /* deprecated */
1607         char **vals ));
1608
1609 LDAP_F( void )
1610 ldap_value_free LDAP_P((        /* deprecated */
1611         char **vals ));
1612 #endif
1613
1614 /*
1615  * in result.c:
1616  */
1617 LDAP_F( int )
1618 ldap_result LDAP_P((
1619         LDAP *ld,
1620         int msgid,
1621         int all,
1622         struct timeval *timeout,
1623         LDAPMessage **result ));
1624
1625 LDAP_F( int )
1626 ldap_msgtype LDAP_P((
1627         LDAPMessage *lm ));
1628
1629 LDAP_F( int )
1630 ldap_msgid   LDAP_P((
1631         LDAPMessage *lm ));
1632
1633 LDAP_F( int )
1634 ldap_msgfree LDAP_P((
1635         LDAPMessage *lm ));
1636
1637 LDAP_F( int )
1638 ldap_msgdelete LDAP_P((
1639         LDAP *ld,
1640         int msgid ));
1641
1642
1643 /*
1644  * in search.c:
1645  */
1646 LDAP_F( int )
1647 ldap_search_ext LDAP_P((
1648         LDAP                    *ld,
1649         LDAP_CONST char *base,
1650         int                             scope,
1651         LDAP_CONST char *filter,
1652         char                    **attrs,
1653         int                             attrsonly,
1654         LDAPControl             **serverctrls,
1655         LDAPControl             **clientctrls,
1656         struct timeval  *timeout,
1657         int                             sizelimit,
1658         int                             *msgidp ));
1659
1660 LDAP_F( int )
1661 ldap_search_ext_s LDAP_P((
1662         LDAP                    *ld,
1663         LDAP_CONST char *base,
1664         int                             scope,
1665         LDAP_CONST char *filter,
1666         char                    **attrs,
1667         int                             attrsonly,
1668         LDAPControl             **serverctrls,
1669         LDAPControl             **clientctrls,
1670         struct timeval  *timeout,
1671         int                             sizelimit,
1672         LDAPMessage             **res ));
1673
1674 #if LDAP_DEPRECATED
1675 LDAP_F( int )
1676 ldap_search LDAP_P((    /* deprecated */
1677         LDAP *ld,
1678         LDAP_CONST char *base,
1679         int scope,
1680         LDAP_CONST char *filter,
1681         char **attrs,
1682         int attrsonly ));
1683
1684 LDAP_F( int )
1685 ldap_search_s LDAP_P((  /* deprecated */
1686         LDAP *ld,
1687         LDAP_CONST char *base,
1688         int scope,
1689         LDAP_CONST char *filter,
1690         char **attrs,
1691         int attrsonly,
1692         LDAPMessage **res ));
1693
1694 LDAP_F( int )
1695 ldap_search_st LDAP_P(( /* deprecated */
1696         LDAP *ld,
1697         LDAP_CONST char *base,
1698         int scope,
1699         LDAP_CONST char *filter,
1700     char **attrs,
1701         int attrsonly,
1702         struct timeval *timeout,
1703         LDAPMessage **res ));
1704 #endif
1705
1706 /*
1707  * in unbind.c
1708  */
1709 LDAP_F( int )
1710 ldap_unbind_ext LDAP_P((
1711         LDAP                    *ld,
1712         LDAPControl             **serverctrls,
1713         LDAPControl             **clientctrls));
1714
1715 LDAP_F( int )
1716 ldap_unbind_ext_s LDAP_P((
1717         LDAP                    *ld,
1718         LDAPControl             **serverctrls,
1719         LDAPControl             **clientctrls));
1720
1721 #if LDAP_DEPRECATED
1722 LDAP_F( int )
1723 ldap_unbind LDAP_P(( /* deprecated */
1724         LDAP *ld ));
1725
1726 LDAP_F( int )
1727 ldap_unbind_s LDAP_P(( /* deprecated */
1728         LDAP *ld ));
1729 #endif
1730
1731 /*
1732  * in filter.c
1733  */
1734 LDAP_F( int )
1735 ldap_put_vrFilter LDAP_P((
1736         BerElement *ber,
1737         const char *vrf ));
1738
1739 /*
1740  * in free.c
1741  */
1742
1743 LDAP_F( void * )
1744 ldap_memalloc LDAP_P((
1745         ber_len_t s ));
1746
1747 LDAP_F( void * )
1748 ldap_memrealloc LDAP_P((
1749         void* p,
1750         ber_len_t s ));
1751
1752 LDAP_F( void * )
1753 ldap_memcalloc LDAP_P((
1754         ber_len_t n,
1755         ber_len_t s ));
1756
1757 LDAP_F( void )
1758 ldap_memfree LDAP_P((
1759         void* p ));
1760
1761 LDAP_F( void )
1762 ldap_memvfree LDAP_P((
1763         void** v ));
1764
1765 LDAP_F( char * )
1766 ldap_strdup LDAP_P((
1767         LDAP_CONST char * ));
1768
1769 LDAP_F( void )
1770 ldap_mods_free LDAP_P((
1771         LDAPMod **mods,
1772         int freemods ));
1773
1774
1775 #if LDAP_DEPRECATED
1776 /*
1777  * in sort.c (deprecated)
1778  */
1779 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1780         LDAP_CONST char *left,
1781         LDAP_CONST char *right ));
1782
1783 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1784         LDAP_CONST void *left,
1785         LDAP_CONST void *right ));
1786
1787 LDAP_F( int )   /* deprecated */
1788 ldap_sort_entries LDAP_P(( LDAP *ld,
1789         LDAPMessage **chain,
1790         LDAP_CONST char *attr,
1791         LDAP_SORT_AD_CMP_PROC *cmp ));
1792
1793 LDAP_F( int )   /* deprecated */
1794 ldap_sort_values LDAP_P((
1795         LDAP *ld,
1796         char **vals,
1797         LDAP_SORT_AV_CMP_PROC *cmp ));
1798
1799 LDAP_F( int ) /* deprecated */
1800 ldap_sort_strcasecmp LDAP_P((
1801         LDAP_CONST void *a,
1802         LDAP_CONST void *b ));
1803 #endif
1804
1805 /*
1806  * in url.c
1807  */
1808 LDAP_F( int )
1809 ldap_is_ldap_url LDAP_P((
1810         LDAP_CONST char *url ));
1811
1812 LDAP_F( int )
1813 ldap_is_ldaps_url LDAP_P((
1814         LDAP_CONST char *url ));
1815
1816 LDAP_F( int )
1817 ldap_is_ldapi_url LDAP_P((
1818         LDAP_CONST char *url ));
1819
1820 LDAP_F( int )
1821 ldap_url_parse LDAP_P((
1822         LDAP_CONST char *url,
1823         LDAPURLDesc **ludpp ));
1824
1825 LDAP_F( char * )
1826 ldap_url_desc2str LDAP_P((
1827         LDAPURLDesc *ludp ));
1828
1829 LDAP_F( void )
1830 ldap_free_urldesc LDAP_P((
1831         LDAPURLDesc *ludp ));
1832
1833
1834 /*
1835  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1836  *  in cancel.c
1837  */
1838 #define LDAP_API_FEATURE_CANCEL 1000
1839
1840 LDAP_F( int )
1841 ldap_cancel LDAP_P(( LDAP *ld,
1842         int cancelid,
1843         LDAPControl             **sctrls,
1844         LDAPControl             **cctrls,
1845         int                             *msgidp ));
1846
1847 LDAP_F( int )
1848 ldap_cancel_s LDAP_P(( LDAP *ld,
1849         int cancelid,
1850         LDAPControl **sctrl,
1851         LDAPControl **cctrl ));
1852
1853 /*
1854  * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1855  *  in turn.c
1856  */
1857 #define LDAP_API_FEATURE_TURN 1000
1858
1859 LDAP_F( int )
1860 ldap_turn LDAP_P(( LDAP *ld,
1861         int mutual,
1862         LDAP_CONST char* identifier,
1863         LDAPControl             **sctrls,
1864         LDAPControl             **cctrls,
1865         int                             *msgidp ));
1866
1867 LDAP_F( int )
1868 ldap_turn_s LDAP_P(( LDAP *ld,
1869         int mutual,
1870         LDAP_CONST char* identifier,
1871         LDAPControl **sctrl,
1872         LDAPControl **cctrl ));
1873
1874 /*
1875  * LDAP Server Side Sort
1876  *      in sortctrl.c
1877  */
1878 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1879
1880 /* structure for a sort-key */
1881 typedef struct ldapsortkey {
1882         char *  attributeType;
1883         char *  orderingRule;
1884         int     reverseOrder;
1885 } LDAPSortKey;
1886
1887 LDAP_F( int )
1888 ldap_create_sort_keylist LDAP_P((
1889         LDAPSortKey ***sortKeyList,
1890         char        *keyString ));
1891
1892 LDAP_F( void )
1893 ldap_free_sort_keylist LDAP_P((
1894         LDAPSortKey **sortkeylist ));
1895
1896 LDAP_F( int )
1897 ldap_create_sort_control LDAP_P((
1898         LDAP *ld,
1899         LDAPSortKey **keyList,
1900         int ctl_iscritical,
1901         LDAPControl **ctrlp ));
1902
1903 LDAP_F( int )
1904 ldap_parse_sort_control LDAP_P((
1905         LDAP           *ld,
1906         LDAPControl    **ctrlp,
1907         unsigned long  *result,
1908         char           **attribute ));
1909
1910
1911 /*
1912  * LDAP Virtual List View
1913  *      in vlvctrl.c
1914  */
1915 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1916
1917 /* structure for virtual list */
1918 typedef struct ldapvlvinfo {
1919         int             ldvlv_version;
1920     unsigned long   ldvlv_before_count;
1921     unsigned long   ldvlv_after_count;
1922     unsigned long   ldvlv_offset;
1923     unsigned long   ldvlv_count;
1924     struct berval *     ldvlv_attrvalue;
1925     struct berval *     ldvlv_context;
1926     void *                      ldvlv_extradata;
1927 } LDAPVLVInfo;
1928
1929 LDAP_F( int )
1930 ldap_create_vlv_control LDAP_P((
1931         LDAP *ld,
1932         LDAPVLVInfo *ldvlistp,
1933         LDAPControl **ctrlp ));
1934
1935 LDAP_F( int )
1936 ldap_parse_vlv_control LDAP_P((
1937         LDAP          *ld,
1938         LDAPControl   **ctrls,
1939         unsigned long *target_posp,
1940         unsigned long *list_countp,
1941         struct berval **contextp,
1942         int           *errcodep ));
1943
1944 /*
1945  * LDAP Transactions
1946  *      in txn.c
1947  */
1948 #ifdef LDAP_GROUPING_TRANSACTION
1949 LDAP_F( int )
1950 ldap_parse_txn_create LDAP_P((
1951         LDAP *ld,
1952         LDAPMessage *res,
1953         struct berval **cookie ));
1954
1955 LDAP_F( int )
1956 ldap_txn_create LDAP_P((
1957         LDAP *ld,
1958         LDAPControl             **sctrls,
1959         LDAPControl             **cctrls,
1960         int                             *msgidp ));
1961
1962 LDAP_F( int )
1963 ldap_txn_create_s LDAP_P((
1964         LDAP *ld,
1965         struct berval **cookie,
1966         LDAPControl **sctrls,
1967         LDAPControl **cctrls ));
1968
1969 LDAP_F( int )
1970 ldap_txn_end LDAP_P((
1971         LDAP *ld,
1972         struct berval *cookie,
1973         int commit,
1974         LDAPControl             **sctrls,
1975         LDAPControl             **cctrls,
1976         int                             *msgidp ));
1977
1978 LDAP_F( int )
1979 ldap_txn_end_s LDAP_P((
1980         LDAP *ld,
1981         struct berval *cookie,
1982         int commit,
1983         LDAPControl **sctrls,
1984         LDAPControl **cctrls ));
1985 #endif
1986
1987 /*
1988  * LDAP Who Am I?
1989  *      in whoami.c
1990  */
1991 #define LDAP_API_FEATURE_WHOAMI 1000
1992
1993 LDAP_F( int )
1994 ldap_parse_whoami LDAP_P((
1995         LDAP *ld,
1996         LDAPMessage *res,
1997         struct berval **authzid ));
1998
1999 LDAP_F( int )
2000 ldap_whoami LDAP_P(( LDAP *ld,
2001         LDAPControl             **sctrls,
2002         LDAPControl             **cctrls,
2003         int                             *msgidp ));
2004
2005 LDAP_F( int )
2006 ldap_whoami_s LDAP_P((
2007         LDAP *ld,
2008         struct berval **authzid,
2009         LDAPControl **sctrls,
2010         LDAPControl **cctrls ));
2011
2012 /*
2013  * LDAP Password Modify
2014  *      in passwd.c
2015  */
2016 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2017
2018 LDAP_F( int )
2019 ldap_parse_passwd LDAP_P((
2020         LDAP *ld,
2021         LDAPMessage *res,
2022         struct berval *newpasswd ));
2023
2024 LDAP_F( int )
2025 ldap_passwd LDAP_P(( LDAP *ld,
2026         struct berval   *user,
2027         struct berval   *oldpw,
2028         struct berval   *newpw,
2029         LDAPControl             **sctrls,
2030         LDAPControl             **cctrls,
2031         int                             *msgidp ));
2032
2033 LDAP_F( int )
2034 ldap_passwd_s LDAP_P((
2035         LDAP *ld,
2036         struct berval   *user,
2037         struct berval   *oldpw,
2038         struct berval   *newpw,
2039         struct berval *newpasswd,
2040         LDAPControl **sctrls,
2041         LDAPControl **cctrls ));
2042
2043 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2044 /*
2045  * LDAP Password Policy controls
2046  *      in ppolicy.c
2047  */
2048 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2049
2050 typedef enum passpolicyerror_enum {
2051        PP_passwordExpired = 0,
2052        PP_accountLocked = 1,
2053        PP_changeAfterReset = 2,
2054        PP_passwordModNotAllowed = 3,
2055        PP_mustSupplyOldPassword = 4,
2056        PP_insufficientPasswordQuality = 5,
2057        PP_passwordTooShort = 6,
2058        PP_passwordTooYoung = 7,
2059        PP_passwordInHistory = 8,
2060        PP_noError = 65535
2061 } LDAPPasswordPolicyError;
2062
2063 LDAP_F( int )
2064 ldap_create_passwordpolicy_control LDAP_P((
2065         LDAP *ld,
2066         LDAPControl **ctrlp ));
2067
2068 LDAP_F( int )
2069 ldap_parse_passwordpolicy_control LDAP_P((
2070         LDAP *ld,
2071         LDAPControl *ctrl,
2072         int *expirep,
2073         int *gracep,
2074         LDAPPasswordPolicyError *errorp ));
2075
2076 LDAP_F( const char * )
2077 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2078 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2079
2080 LDAP_END_DECL
2081 #endif /* _LDAP_H */