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