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