git.sur5r.net Git - openldap/blob - include/ldap.h

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2002 The OpenLDAP Foundation, Redwood City, California, USA
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted only as authorized by the OpenLDAP
   8  * Public License.  A copy of this license is available at
   9  * http://www.OpenLDAP.org/license.html or in file LICENSE in the
  10  * top-level directory of the distribution.
  11  */
  12 /* Portions
  13  * Copyright (c) 1990 Regents of the University of Michigan.
  14  * All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms are permitted
  17  * provided that this notice is preserved and that due credit is given
  18  * to the University of Michigan at Ann Arbor. The name of the University
  19  * may not be used to endorse or promote products derived from this
  20  * software without specific prior written permission. This software
  21  * is provided ``as is'' without express or implied warranty.
  22  */
  23
  24 #ifndef _LDAP_H
  25 #define _LDAP_H
  26
  27 /* pull in lber */
  28 #include <lber.h>
  29
  30 /* include version and API feature defines */
  31 #include <ldap_features.h>
  32
  33 LDAP_BEGIN_DECL
  34
  35 #define LDAP_VERSION1   1
  36 #define LDAP_VERSION2   2
  37 #define LDAP_VERSION3   3
  38
  39 #define LDAP_VERSION_MIN        LDAP_VERSION2
  40 #define LDAP_VERSION            LDAP_VERSION2
  41 #define LDAP_VERSION_MAX        LDAP_VERSION3
  42
  43 /*
  44  * We'll use 2000+draft revision for our API version number
  45  * As such, the number will be above the old RFC but below
  46  * whatever number does finally get assigned
  47  */
  48 #define LDAP_API_VERSION        2004
  49 #define LDAP_VENDOR_NAME        "OpenLDAP"
  50
  51 /* OpenLDAP API Features */
  52 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
  53
  54 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
  55         ( defined( LDAP_THREAD_SAFE ) && \
  56                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
  57         /* -lldap may or may not be thread safe */
  58         /* -lldap_r, if available, is always thread safe */
  59 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
  60 #endif
  61 #if defined( LDAP_THREAD_SAFE ) && \
  62         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
  63 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
  64 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
  65 #endif
  66
  67 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
  68 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
  69
  70 #define LDAP_ROOT_DSE                           ""
  71 #define LDAP_NO_ATTRS                           "1.1"
  72 #define LDAP_ALL_USER_ATTRIBUTES        "*"
  73 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
  74
  75 /*
  76  * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
  77  * 0x0000 - 0x0fff reserved for api options
  78  * 0x1000 - 0x3fff reserved for api extended options
  79  * 0x4000 - 0x7fff reserved for private and experimental options
  80  */
  81 #define LDAP_OPT_API_INFO                       0x0000
  82 #define LDAP_OPT_DESC                           0x0001 /* deprecated */
  83 #define LDAP_OPT_DEREF                          0x0002
  84 #define LDAP_OPT_SIZELIMIT                      0x0003
  85 #define LDAP_OPT_TIMELIMIT                      0x0004
  86 /* 0x05 - 0x07 not defined by current draft */
  87 #define LDAP_OPT_REFERRALS                      0x0008
  88 #define LDAP_OPT_RESTART                        0x0009
  89 /* 0x0a - 0x10 not defined by current draft */
  90 #define LDAP_OPT_PROTOCOL_VERSION       0x0011
  91 #define LDAP_OPT_SERVER_CONTROLS        0x0012
  92 #define LDAP_OPT_CLIENT_CONTROLS        0x0013
  93 /* 0x14 not defined by current draft */
  94 #define LDAP_OPT_API_FEATURE_INFO       0x0015
  95
  96 /* 0x16 - 0x2f not defined by current draft */
  97 #define LDAP_OPT_HOST_NAME                      0x0030
  98 #define LDAP_OPT_ERROR_NUMBER           0x0031
  99 #define LDAP_OPT_ERROR_STRING           0x0032
 100 #define LDAP_OPT_MATCHED_DN                     0x0033
 101
 102 /* 0x34 - 0x0fff not defined by current draft */
 103
 104 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000  /* to 0x7FFF inclusive */
 105
 106 /* private and experimental options */
 107 /* OpenLDAP specific options */
 108 #define LDAP_OPT_DEBUG_LEVEL            0x5001  /* debug level */
 109 #define LDAP_OPT_TIMEOUT                        0x5002  /* default timeout */
 110 #define LDAP_OPT_REFHOPLIMIT            0x5003  /* ref hop limit */
 111 #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
 112 #define LDAP_OPT_URI                            0x5006
 113 #define LDAP_OPT_REFERRAL_URLS      0x5007  /* Referral URLs */
 114
 115 /* OpenLDAP TLS options */
 116 #define LDAP_OPT_X_TLS                          0x6000
 117 #define LDAP_OPT_X_TLS_CTX                      0x6001  /* SSL CTX */
 118 #define LDAP_OPT_X_TLS_CACERTFILE       0x6002
 119 #define LDAP_OPT_X_TLS_CACERTDIR        0x6003
 120 #define LDAP_OPT_X_TLS_CERTFILE         0x6004
 121 #define LDAP_OPT_X_TLS_KEYFILE          0x6005
 122 #define LDAP_OPT_X_TLS_REQUIRE_CERT     0x6006
 123 /* #define LDAP_OPT_X_TLS_PROTOCOL              0x6007 */
 124 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6008
 125 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x6009
 126 #define LDAP_OPT_X_TLS_SSL_CTX          0x600a
 127
 128 #define LDAP_OPT_X_TLS_NEVER            0
 129 #define LDAP_OPT_X_TLS_HARD             1
 130 #define LDAP_OPT_X_TLS_DEMAND           2
 131 #define LDAP_OPT_X_TLS_ALLOW            3
 132 #define LDAP_OPT_X_TLS_TRY              4
 133
 134 /* OpenLDAP SASL options */
 135 #define LDAP_OPT_X_SASL_MECH                    0x6100
 136 #define LDAP_OPT_X_SASL_REALM                   0x6101
 137 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
 138 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
 139 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
 140 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
 141 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
 142 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
 143 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
 144 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
 145
 146
 147 /* on/off values */
 148 #define LDAP_OPT_ON             ((void *) 1)
 149 #define LDAP_OPT_OFF    ((void *) 0)
 150
 151 /*
 152  * ldap_get_option() and ldap_set_option() return values.
 153  * As later versions may return other values indicating
 154  * failure, current applications should only compare returned
 155  * value against LDAP_OPT_SUCCESS.
 156  */
 157 #define LDAP_OPT_SUCCESS        0
 158 #define LDAP_OPT_ERROR          (-1)
 159
 160 #define LDAP_API_INFO_VERSION   (1)
 161 typedef struct ldapapiinfo {
 162         int             ldapai_info_version;            /* version of LDAPAPIInfo (1) */
 163         int             ldapai_api_version;                     /* revision of API supported */
 164         int             ldapai_protocol_version;        /* highest LDAP version supported */
 165         char    **ldapai_extensions;            /* names of API extensions */
 166         char    *ldapai_vendor_name;            /* name of supplier */
 167         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
 168 } LDAPAPIInfo;
 169
 170 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
 171 typedef struct ldap_apifeature_info {
 172         int             ldapaif_info_version; /* version of this struct (1) */
 173         char*   ldapaif_name;    /* matches LDAP_API_FEATURE_... less the prefix */
 174         int             ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
 175 } LDAPAPIFeatureInfo;
 176
 177 typedef struct ldapcontrol {
 178         char *                  ldctl_oid;
 179         struct berval   ldctl_value;
 180         char                    ldctl_iscritical;
 181 } LDAPControl;
 182
 183 /* LDAP Controls */
 184
 185 #if 0
 186         /* chase referrals client control (not yet implemented)  */
 187 #define LDAP_CONTROL_REFERRALS  "1.2.840.113666.1.4.616"
 188 #define LDAP_CHASE_SUBORDINATE_REFERRALS        0x0020U
 189 #define LDAP_CHASE_EXTERNAL_REFERRALS   0x0040U
 190 #endif
 191
 192 #define LDAP_CONTROL_MANAGEDSAIT        "2.16.840.1.113730.3.4.2"
 193 #define LDAP_CONTROL_SUBENTRIES         "1.3.6.1.4.1.4203.1.10.1"
 194 #define LDAP_CONTROL_NOOP                       "1.3.6.1.4.1.4203.1.10.2"
 195
 196 #if 0
 197 #define LDAP_CONTROL_DUPENT_REQUEST             "2.16.840.1.113719.1.27.101.1"
 198 #define LDAP_CONTROL_DUPENT_RESPONSE    "2.16.840.1.113719.1.27.101.2"
 199 #define LDAP_CONTROL_DUPENT_ENTRY               "2.16.840.1.113719.1.27.101.3"
 200 #define LDAP_CONTROL_DUPENT     LDAP_CONTROL_DUPENT_REQUEST
 201
 202 #define LDAP_CONTROL_PAGEDRESULTS       "1.2.840.113556.1.4.319"
 203 #endif
 204
 205 /*
 206 #define LDAP_CLIENT_UPDATE 1
 207 */
 208 #ifdef LDAP_CLIENT_UPDATE
 209 #define LDAP_CONTROL_CLIENT_UPDATE              "1.3.6.1.4.1.4203.666.5.3"
 210 #define LDAP_CONTROL_ENTRY_UPDATE               "1.3.6.1.4.1.4203.666.5.4"
 211 #define LDAP_CONTROL_CLIENT_UPDATE_DONE "1.3.6.1.4.1.4203.666.5.5"
 212 #endif
 213
 214 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473"
 215 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474"
 216 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
 217 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
 218
 219 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
 220
 221 /* LDAP Unsolicited Notifications */
 222 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036"
 223 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
 224
 225 /* LDAP Extended Operations */
 226 #define LDAP_EXOP_START_TLS     "1.3.6.1.4.1.1466.20037"
 227
 228 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
 229 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
 230 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
 231 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
 232 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
 233
 234 #define LDAP_EXOP_X_WHO_AM_I    "1.3.6.1.4.1.4203.1.11.3"
 235
 236 /* LDAP Features */
 237 #define LDAP_FEATURE_ALL_OPERATIONAL_ATTRS "1.3.6.1.4.1.4203.1.5.1"  /* + */
 238 #define LDAP_FEATURE_OBJECTCLASS_ATTRS "1.3.6.1.4.1.4203.1.5.2"
 239 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
 240 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
 241 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
 242
 243 /*
 244  * specific LDAP instantiations of BER types we know about
 245  */
 246
 247 /* Overview of LBER tag construction
 248  *
 249  *      Bits
 250  *      ______
 251  *      8 7 | CLASS
 252  *      0 0 = UNIVERSAL
 253  *      0 1 = APPLICATION
 254  *      1 0 = CONTEXT-SPECIFIC
 255  *      1 1 = PRIVATE
 256  *              _____
 257  *              | 6 | DATA-TYPE
 258  *                0 = PRIMITIVE
 259  *                1 = CONSTRUCTED
 260  *                      ___________
 261  *                      | 5 ... 1 | TAG-NUMBER
 262  */
 263
 264 /* general stuff */
 265 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
 266 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
 267
 268 #ifdef LDAP_CLIENT_UPDATE
 269 #define LDAP_TAG_INTERVAL       ((ber_tag_t) 0x02U)     /* integer */
 270 #endif /* LDAP_CLIENT_UPDATE */
 271
 272 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octet string */
 273 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octet string */
 274
 275 #ifdef LDAP_CLIENT_UPDATE
 276 #define LDAP_TAG_COOKIE         ((ber_tag_t) 0x30U)     /* sequence */
 277 #endif /* LDAP_CLIENT_UPDATE */
 278
 279 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
 280 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
 281
 282 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
 283
 284 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
 285 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
 286 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
 287 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
 288
 289 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
 290
 291
 292 /* possible operations a client can invoke */
 293 #define LDAP_REQ_BIND                   ((ber_tag_t) 0x60U)     /* application + constructed */
 294 #define LDAP_REQ_UNBIND                 ((ber_tag_t) 0x42U)     /* application + primitive   */
 295 #define LDAP_REQ_SEARCH                 ((ber_tag_t) 0x63U)     /* application + constructed */
 296 #define LDAP_REQ_MODIFY                 ((ber_tag_t) 0x66U)     /* application + constructed */
 297 #define LDAP_REQ_ADD                    ((ber_tag_t) 0x68U)     /* application + constructed */
 298 #define LDAP_REQ_DELETE                 ((ber_tag_t) 0x4aU)     /* application + primitive   */
 299 #define LDAP_REQ_MODDN                  ((ber_tag_t) 0x6cU)     /* application + constructed */
 300 #define LDAP_REQ_MODRDN                 LDAP_REQ_MODDN
 301 #define LDAP_REQ_RENAME                 LDAP_REQ_MODDN
 302 #define LDAP_REQ_COMPARE                ((ber_tag_t) 0x6eU)     /* application + constructed */
 303 #define LDAP_REQ_ABANDON                ((ber_tag_t) 0x50U)     /* application + primitive   */
 304 #define LDAP_REQ_EXTENDED               ((ber_tag_t) 0x77U)     /* application + constructed */
 305
 306 /* possible result types a server can return */
 307 #define LDAP_RES_BIND                   ((ber_tag_t) 0x61U)     /* application + constructed */
 308 #define LDAP_RES_SEARCH_ENTRY           ((ber_tag_t) 0x64U)     /* application + constructed */
 309 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
 310 #define LDAP_RES_SEARCH_RESULT          ((ber_tag_t) 0x65U)     /* application + constructed */
 311 #define LDAP_RES_MODIFY                 ((ber_tag_t) 0x67U)     /* application + constructed */
 312 #define LDAP_RES_ADD                    ((ber_tag_t) 0x69U)     /* application + constructed */
 313 #define LDAP_RES_DELETE                 ((ber_tag_t) 0x6bU)     /* application + constructed */
 314 #define LDAP_RES_MODDN                  ((ber_tag_t) 0x6dU)     /* application + constructed */
 315 #define LDAP_RES_MODRDN                 LDAP_RES_MODDN  /* application + constructed */
 316 #define LDAP_RES_RENAME                 LDAP_RES_MODDN  /* application + constructed */
 317 #define LDAP_RES_COMPARE                ((ber_tag_t) 0x6fU)     /* application + constructed */
 318 #define LDAP_RES_EXTENDED               ((ber_tag_t) 0x78U)     /* V3: application + constructed */
 319 #define LDAP_RES_EXTENDED_PARTIAL       ((ber_tag_t) 0x79U)     /* V3+: application + constructed */
 320
 321 #define LDAP_RES_ANY                    (-1)
 322 #define LDAP_RES_UNSOLICITED    (0)
 323
 324
 325 /* sasl methods */
 326 #define LDAP_SASL_SIMPLE                ((char*)0)
 327 #define LDAP_SASL_NULL                  ("")
 328
 329
 330 /* authentication methods available */
 331 #define LDAP_AUTH_NONE          ((ber_tag_t) 0x00U)     /* no authentication              */
 332 #define LDAP_AUTH_SIMPLE        ((ber_tag_t) 0x80U)     /* context specific + primitive   */
 333 #define LDAP_AUTH_SASL          ((ber_tag_t) 0xa3U)     /* context specific + constructed */
 334 #define LDAP_AUTH_KRBV4         ((ber_tag_t) 0xffU)     /* means do both of the following */
 335 #define LDAP_AUTH_KRBV41        ((ber_tag_t) 0x81U)     /* context specific + primitive   */
 336 #define LDAP_AUTH_KRBV42        ((ber_tag_t) 0x82U)     /* context specific + primitive   */
 337
 338
 339 /* filter types */
 340 #define LDAP_FILTER_AND         ((ber_tag_t) 0xa0U)     /* context specific + constructed */
 341 #define LDAP_FILTER_OR          ((ber_tag_t) 0xa1U)     /* context specific + constructed */
 342 #define LDAP_FILTER_NOT         ((ber_tag_t) 0xa2U)     /* context specific + constructed */
 343 #define LDAP_FILTER_EQUALITY    ((ber_tag_t) 0xa3U)     /* context specific + constructed */
 344 #define LDAP_FILTER_SUBSTRINGS  ((ber_tag_t) 0xa4U)     /* context specific + constructed */
 345 #define LDAP_FILTER_GE          ((ber_tag_t) 0xa5U)     /* context specific + constructed */
 346 #define LDAP_FILTER_LE          ((ber_tag_t) 0xa6U)     /* context specific + constructed */
 347 #define LDAP_FILTER_PRESENT     ((ber_tag_t) 0x87U)     /* context specific + primitive   */
 348 #define LDAP_FILTER_APPROX      ((ber_tag_t) 0xa8U)     /* context specific + constructed */
 349 #define LDAP_FILTER_EXT         ((ber_tag_t) 0xa9U)     /* context specific + constructed */
 350
 351 /* extended filter component types */
 352 #define LDAP_FILTER_EXT_OID     ((ber_tag_t) 0x81U)     /* context specific */
 353 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
 354 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
 355 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
 356
 357 /* substring filter component types */
 358 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 359 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
 360 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 361
 362 /* search scopes */
 363 #define LDAP_SCOPE_DEFAULT      ((ber_int_t) -1)
 364 #define LDAP_SCOPE_BASE         ((ber_int_t) 0x0000)
 365 #define LDAP_SCOPE_ONELEVEL     ((ber_int_t) 0x0001)
 366 #define LDAP_SCOPE_SUBTREE      ((ber_int_t) 0x0002)
 367
 368 /* substring filter component types */
 369 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
 370 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
 371 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
 372
 373 /*
 374  * possible error codes we can return
 375  */
 376
 377 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
 378
 379 #define LDAP_SUCCESS                    0x00
 380 #define LDAP_OPERATIONS_ERROR           0x01
 381 #define LDAP_PROTOCOL_ERROR             0x02
 382 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 383 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 384 #define LDAP_COMPARE_FALSE              0x05
 385 #define LDAP_COMPARE_TRUE               0x06
 386 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
 387 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
 388 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 389 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
 390
 391 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 392 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 393 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
 394 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 395 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 396
 397 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
 398
 399 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 400 #define LDAP_UNDEFINED_TYPE             0x11
 401 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 402 #define LDAP_CONSTRAINT_VIOLATION       0x13
 403 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 404 #define LDAP_INVALID_SYNTAX             0x15
 405
 406 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
 407
 408 #define LDAP_NO_SUCH_OBJECT             0x20
 409 #define LDAP_ALIAS_PROBLEM              0x21
 410 #define LDAP_INVALID_DN_SYNTAX          0x22
 411 #define LDAP_IS_LEAF                    0x23 /* not LDAPv3 */
 412 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 413
 414 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x30,0x32) /* 48-50 */
 415
 416 #define LDAP_INAPPROPRIATE_AUTH         0x30
 417 #define LDAP_INVALID_CREDENTIALS        0x31
 418 #define LDAP_INSUFFICIENT_ACCESS        0x32
 419
 420 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
 421
 422 #define LDAP_BUSY                       0x33
 423 #define LDAP_UNAVAILABLE                0x34
 424 #define LDAP_UNWILLING_TO_PERFORM       0x35
 425 #define LDAP_LOOP_DETECT                0x36
 426
 427 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
 428
 429 #define LDAP_NAMING_VIOLATION           0x40
 430 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 431 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 432 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 433 #define LDAP_ALREADY_EXISTS             0x44
 434 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 435 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 436 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
 437
 438 #define LDAP_OTHER                      0x50
 439
 440 #define LDAP_API_ERROR(n)               LDAP_RANGE((n),0x51,0x61) /* 81-97 */
 441 #define LDAP_API_RESULT(n)              (((n) == LDAP_SUCCESS) || \
 442                                                                         LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
 443
 444 /* reserved for APIs */
 445 #define LDAP_SERVER_DOWN                0x51
 446 #define LDAP_LOCAL_ERROR                0x52
 447 #define LDAP_ENCODING_ERROR             0x53
 448 #define LDAP_DECODING_ERROR             0x54
 449 #define LDAP_TIMEOUT                    0x55
 450 #define LDAP_AUTH_UNKNOWN               0x56
 451 #define LDAP_FILTER_ERROR               0x57
 452 #define LDAP_USER_CANCELLED             0x58
 453 #define LDAP_PARAM_ERROR                0x59
 454 #define LDAP_NO_MEMORY                  0x5a
 455
 456 /* used but not reserved for APIs */
 457 #define LDAP_CONNECT_ERROR                              0x5b    /* draft-ietf-ldap-c-api-xx */
 458 #define LDAP_NOT_SUPPORTED                              0x5c    /* draft-ietf-ldap-c-api-xx */
 459 #define LDAP_CONTROL_NOT_FOUND                  0x5d    /* draft-ietf-ldap-c-api-xx */
 460 #define LDAP_NO_RESULTS_RETURNED                0x5e    /* draft-ietf-ldap-c-api-xx */
 461 #define LDAP_MORE_RESULTS_TO_RETURN             0x5f    /* draft-ietf-ldap-c-api-xx */
 462 #define LDAP_CLIENT_LOOP                                0x60    /* draft-ietf-ldap-c-api-xx */
 463 #define LDAP_REFERRAL_LIMIT_EXCEEDED    0x61    /* draft-ietf-ldap-c-api-xx */
 464
 465 #ifdef LDAP_CLIENT_UPDATE
 466 /* resultCode for LCUP */
 467 #define LDAP_CUP_RESOURCES_EXHAUSTED    0x62
 468 #define LDAP_CUP_SECURITY_VIOLATION             0x63
 469 #define LDAP_CUP_INVALID_COOKIE         0x64
 470 #define LDAP_CUP_UNSUPPORTED_SCHEME             0x65
 471 #define LDAP_CUP_CLIENT_DISCONNECT              0x66
 472 #define LDAP_CUP_RELOAD_REQUIRED                0x67
 473
 474 /* LCUP update type */
 475 #define LDAP_CUP_SYNC_ONLY                      0x00
 476 #define LDAP_CUP_SYNC_AND_PERSIST       0x01
 477 #define LDAP_CUP_PERSIST_ONLY           0x02
 478
 479 /* LCUP default cookie interval */
 480 #define LDAP_CUP_DEFAULT_SEND_COOKIE_INTERVAL   0x01
 481 #endif /* LDAP_CLIENT_UPDATE */
 482
 483 /*
 484  * This structure represents both ldap messages and ldap responses.
 485  * These are really the same, except in the case of search responses,
 486  * where a response has multiple messages.
 487  */
 488
 489 typedef struct ldapmsg LDAPMessage;
 490
 491 /* for modifications */
 492 typedef struct ldapmod {
 493         int             mod_op;
 494
 495 #define LDAP_MOD_ADD            ((ber_int_t) 0x0000)
 496 #define LDAP_MOD_DELETE         ((ber_int_t) 0x0001)
 497 #define LDAP_MOD_REPLACE        ((ber_int_t) 0x0002)
 498 #define LDAP_MOD_BVALUES        ((ber_int_t) 0x0080)
 499 /* IMPORTANT: do not use code 0x1000 (or above),
 500  * it is used internally by the backends!
 501  * (see ldap/servers/slapd/slap.h)
 502  */
 503
 504         char            *mod_type;
 505         union mod_vals_u {
 506                 char            **modv_strvals;
 507                 struct berval   **modv_bvals;
 508         } mod_vals;
 509 #define mod_values      mod_vals.modv_strvals
 510 #define mod_bvalues     mod_vals.modv_bvals
 511 } LDAPMod;
 512
 513 /*
 514  * structure representing an ldap session which can
 515  * encompass connections to multiple servers (in the
 516  * face of referrals).
 517  */
 518 typedef struct ldap LDAP;
 519
 520 #define LDAP_DEREF_NEVER        0x00
 521 #define LDAP_DEREF_SEARCHING    0x01
 522 #define LDAP_DEREF_FINDING      0x02
 523 #define LDAP_DEREF_ALWAYS       0x03
 524
 525 #define LDAP_NO_LIMIT           0
 526
 527 /* how many messages to retrieve results for */
 528 #define LDAP_MSG_ONE            0x00
 529 #define LDAP_MSG_ALL            0x01
 530 #define LDAP_MSG_RECEIVED       0x02
 531
 532 /*
 533  * types for ldap URL handling
 534  */
 535 typedef struct ldap_url_desc {
 536         struct ldap_url_desc *lud_next;
 537         char    *lud_scheme;
 538         char    *lud_host;
 539         int             lud_port;
 540         char    *lud_dn;
 541         char    **lud_attrs;
 542         int             lud_scope;
 543         char    *lud_filter;
 544         char    **lud_exts;
 545         int             lud_crit_exts;
 546 } LDAPURLDesc;
 547
 548 #define LDAP_URL_SUCCESS                0x00    /* Success */
 549 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
 550 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
 551
 552 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
 553 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
 554 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
 555 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
 556 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
 557 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
 558 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
 559 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
 560
 561 /*
 562  * The API draft spec says we should declare (or cause to be declared)
 563  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
 564  */
 565 struct timeval;
 566
 567 /*
 568  * in options.c:
 569  */
 570 LDAP_F( int )
 571 ldap_get_option LDAP_P((
 572         LDAP *ld,
 573         int option,
 574         void *outvalue));
 575
 576 LDAP_F( int )
 577 ldap_set_option LDAP_P((
 578         LDAP *ld,
 579         int option,
 580         LDAP_CONST void *invalue));
 581
 582 /* V3 REBIND Function Callback Prototype */
 583 typedef int (LDAP_REBIND_PROC) LDAP_P((
 584         LDAP *ld, LDAP_CONST char *url,
 585         ber_tag_t request, ber_int_t msgid,
 586         void *params ));
 587
 588 LDAP_F( int )
 589 ldap_set_rebind_proc LDAP_P((
 590         LDAP *ld,
 591         LDAP_REBIND_PROC *rebind_proc,
 592         void *params ));
 593
 594 /*
 595  * in controls.c:
 596  */
 597 LDAP_F( int )
 598 ldap_create_control LDAP_P((
 599         LDAP_CONST char *requestOID,
 600         BerElement *ber,
 601         int iscritical,
 602         LDAPControl **ctrlp ));
 603
 604 LDAP_F( void )
 605 ldap_control_free LDAP_P((
 606         LDAPControl *ctrl ));
 607
 608 LDAP_F( void )
 609 ldap_controls_free LDAP_P((
 610         LDAPControl **ctrls ));
 611
 612 /*
 613  * in dnssrv.c:
 614  */
 615 LDAP_F( int )
 616 ldap_domain2dn LDAP_P((
 617         LDAP_CONST char* domain,
 618         char** dn ));
 619
 620 LDAP_F( int )
 621 ldap_dn2domain LDAP_P((
 622         LDAP_CONST char* dn,
 623         char** domain ));
 624
 625 LDAP_F( int )
 626 ldap_domain2hostlist LDAP_P((
 627         LDAP_CONST char *domain,
 628         char** hostlist ));
 629
 630 /*
 631  * in extended.c:
 632  */
 633 LDAP_F( int )
 634 ldap_extended_operation LDAP_P((
 635         LDAP                    *ld,
 636         LDAP_CONST char *reqoid,
 637         struct berval   *reqdata,
 638         LDAPControl             **serverctrls,
 639         LDAPControl             **clientctrls,
 640         int                             *msgidp ));
 641
 642 LDAP_F( int )
 643 ldap_extended_operation_s LDAP_P((
 644         LDAP                    *ld,
 645         LDAP_CONST char *reqoid,
 646         struct berval   *reqdata,
 647         LDAPControl             **serverctrls,
 648         LDAPControl             **clientctrls,
 649         char                    **retoidp,
 650         struct berval   **retdatap ));
 651
 652 LDAP_F( int )
 653 ldap_parse_extended_result LDAP_P((
 654         LDAP                    *ld,
 655         LDAPMessage             *res,
 656         char                    **retoidp,
 657         struct berval   **retdatap,
 658         int                             freeit ));
 659
 660 LDAP_F( int )
 661 ldap_parse_extended_partial LDAP_P((
 662         LDAP                    *ld,
 663         LDAPMessage             *res,
 664         char                    **retoidp,
 665         struct berval   **retdatap,
 666         LDAPControl             ***serverctrls,
 667         int                             freeit ));
 668
 669 /*
 670  * in abandon.c:
 671  */
 672 LDAP_F( int )
 673 ldap_abandon_ext LDAP_P((
 674         LDAP                    *ld,
 675         int                             msgid,
 676         LDAPControl             **serverctrls,
 677         LDAPControl             **clientctrls ));
 678
 679 LDAP_F( int )
 680 ldap_abandon LDAP_P((   /* deprecated */
 681         LDAP *ld,
 682         int msgid ));
 683
 684
 685 /*
 686  * in add.c:
 687  */
 688 LDAP_F( int )
 689 ldap_add_ext LDAP_P((
 690         LDAP                    *ld,
 691         LDAP_CONST char *dn,
 692         LDAPMod                 **attrs,
 693         LDAPControl             **serverctrls,
 694         LDAPControl             **clientctrls,
 695         int                     *msgidp ));
 696
 697 LDAP_F( int )
 698 ldap_add_ext_s LDAP_P((
 699         LDAP                    *ld,
 700         LDAP_CONST char *dn,
 701         LDAPMod                 **attrs,
 702         LDAPControl             **serverctrls,
 703         LDAPControl             **clientctrls ));
 704
 705 LDAP_F( int )
 706 ldap_add LDAP_P((       /* deprecated */
 707         LDAP *ld,
 708         LDAP_CONST char *dn,
 709         LDAPMod **attrs ));
 710
 711 LDAP_F( int )
 712 ldap_add_s LDAP_P((     /* deprecated */
 713         LDAP *ld,
 714         LDAP_CONST char *dn,
 715         LDAPMod **attrs ));
 716
 717
 718 /*
 719  * in sasl.c:
 720  */
 721 LDAP_F( int )
 722 ldap_sasl_bind LDAP_P((
 723         LDAP                    *ld,
 724         LDAP_CONST char *dn,
 725         LDAP_CONST char *mechanism,
 726         struct berval   *cred,
 727         LDAPControl             **serverctrls,
 728         LDAPControl             **clientctrls,
 729         int                             *msgidp ));
 730
 731 /* Interaction flags (should be passed about in a control)
 732  *  Automatic (default): use defaults, prompt otherwise
 733  *  Interactive: prompt always
 734  *  Quiet: never prompt
 735  */
 736 #define LDAP_SASL_AUTOMATIC             0U
 737 #define LDAP_SASL_INTERACTIVE   1U
 738 #define LDAP_SASL_QUIET                 2U
 739
 740 /*
 741  * V3 SASL Interaction Function Callback Prototype
 742  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
 743  *  should likely passed in a control (and provided controls)
 744  */
 745 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
 746         LDAP *ld, unsigned flags, void* defaults, void *interact ));
 747
 748 LDAP_F( int )
 749 ldap_sasl_interactive_bind_s LDAP_P((
 750         LDAP *ld,
 751         LDAP_CONST char *dn, /* usually NULL */
 752         LDAP_CONST char *saslMechanism,
 753         LDAPControl **serverControls,
 754         LDAPControl **clientControls,
 755
 756         /* should be client controls */
 757         unsigned flags,
 758         LDAP_SASL_INTERACT_PROC *proc,
 759         void *defaults ));
 760
 761 LDAP_F( int )
 762 ldap_sasl_bind_s LDAP_P((
 763         LDAP                    *ld,
 764         LDAP_CONST char *dn,
 765         LDAP_CONST char *mechanism,
 766         struct berval   *cred,
 767         LDAPControl             **serverctrls,
 768         LDAPControl             **clientctrls,
 769         struct berval   **servercredp ));
 770
 771 LDAP_F( int )
 772 ldap_parse_sasl_bind_result LDAP_P((
 773         LDAP                    *ld,
 774         LDAPMessage             *res,
 775         struct berval   **servercredp,
 776         int                             freeit ));
 777
 778 /*
 779  * in bind.c:
 780  *      (deprecated)
 781  */
 782 LDAP_F( int )
 783 ldap_bind LDAP_P((      /* deprecated */
 784         LDAP *ld,
 785         LDAP_CONST char *who,
 786         LDAP_CONST char *passwd,
 787         int authmethod ));
 788
 789 LDAP_F( int )
 790 ldap_bind_s LDAP_P((    /* deprecated */
 791         LDAP *ld,
 792         LDAP_CONST char *who,
 793         LDAP_CONST char *cred,
 794         int authmethod ));
 795
 796 /*
 797  * in sbind.c:
 798  */
 799 LDAP_F( int )
 800 ldap_simple_bind LDAP_P((
 801         LDAP *ld,
 802         LDAP_CONST char *who,
 803         LDAP_CONST char *passwd ));
 804
 805 LDAP_F( int )
 806 ldap_simple_bind_s LDAP_P((
 807         LDAP *ld,
 808         LDAP_CONST char *who,
 809         LDAP_CONST char *passwd ));
 810
 811
 812 /*
 813  * in kbind.c:
 814  *      (deprecated)
 815  */
 816 LDAP_F( int )
 817 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
 818         LDAP *ld,
 819         LDAP_CONST char *who ));
 820
 821 LDAP_F( int )
 822 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
 823         LDAP *ld,
 824         LDAP_CONST char *who ));
 825
 826 LDAP_F( int )
 827 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
 828         LDAP *ld,
 829         LDAP_CONST char *who ));
 830
 831 LDAP_F( int )
 832 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
 833         LDAP *ld,
 834         LDAP_CONST char *who ));
 835
 836 LDAP_F( int )
 837 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
 838         LDAP *ld,
 839         LDAP_CONST char *who ));
 840
 841 /*
 842  * in cache.c
 843  * (deprecated)
 844  */
 845 LDAP_F( int )
 846 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
 847
 848 LDAP_F( void )
 849 ldap_disable_cache LDAP_P(( LDAP *ld ));
 850
 851 LDAP_F( void )
 852 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
 853
 854 LDAP_F( void )
 855 ldap_destroy_cache LDAP_P(( LDAP *ld ));
 856
 857 LDAP_F( void )
 858 ldap_flush_cache LDAP_P(( LDAP *ld ));
 859
 860 LDAP_F( void )
 861 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
 862
 863 LDAP_F( void )
 864 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
 865
 866
 867 /*
 868  * in compare.c:
 869  */
 870 LDAP_F( int )
 871 ldap_compare_ext LDAP_P((
 872         LDAP                    *ld,
 873         LDAP_CONST char *dn,
 874         LDAP_CONST char *attr,
 875         struct berval   *bvalue,
 876         LDAPControl             **serverctrls,
 877         LDAPControl             **clientctrls,
 878         int                     *msgidp ));
 879
 880 LDAP_F( int )
 881 ldap_compare_ext_s LDAP_P((
 882         LDAP                    *ld,
 883         LDAP_CONST char *dn,
 884         LDAP_CONST char *attr,
 885         struct berval   *bvalue,
 886         LDAPControl             **serverctrls,
 887         LDAPControl             **clientctrls ));
 888
 889 LDAP_F( int )
 890 ldap_compare LDAP_P((   /* deprecated */
 891         LDAP *ld,
 892         LDAP_CONST char *dn,
 893         LDAP_CONST char *attr,
 894         LDAP_CONST char *value ));
 895
 896 LDAP_F( int )
 897 ldap_compare_s LDAP_P(( /* deprecated */
 898         LDAP *ld,
 899         LDAP_CONST char *dn,
 900         LDAP_CONST char *attr,
 901         LDAP_CONST char *value ));
 902
 903
 904 /*
 905  * in delete.c:
 906  */
 907 LDAP_F( int )
 908 ldap_delete_ext LDAP_P((
 909         LDAP                    *ld,
 910         LDAP_CONST char *dn,
 911         LDAPControl             **serverctrls,
 912         LDAPControl             **clientctrls,
 913         int                     *msgidp ));
 914
 915 LDAP_F( int )
 916 ldap_delete_ext_s LDAP_P((
 917         LDAP                    *ld,
 918         LDAP_CONST char *dn,
 919         LDAPControl             **serverctrls,
 920         LDAPControl             **clientctrls ));
 921
 922 LDAP_F( int )
 923 ldap_delete LDAP_P((    /* deprecated */
 924         LDAP *ld,
 925         LDAP_CONST char *dn ));
 926
 927 LDAP_F( int )
 928 ldap_delete_s LDAP_P((  /* deprecated */
 929         LDAP *ld,
 930         LDAP_CONST char *dn ));
 931
 932
 933 /*
 934  * in error.c:
 935  */
 936 LDAP_F( int )
 937 ldap_parse_result LDAP_P((
 938         LDAP                    *ld,
 939         LDAPMessage             *res,
 940         int                             *errcodep,
 941         char                    **matcheddnp,
 942         char                    **errmsgp,
 943         char                    ***referralsp,
 944         LDAPControl             ***serverctrls,
 945         int                             freeit ));
 946
 947 LDAP_F( char * )
 948 ldap_err2string LDAP_P((
 949         int err ));
 950
 951 LDAP_F( int )
 952 ldap_result2error LDAP_P((      /* deprecated */
 953         LDAP *ld,
 954         LDAPMessage *r,
 955         int freeit ));
 956
 957 LDAP_F( void )
 958 ldap_perror LDAP_P((    /* deprecated */
 959         LDAP *ld,
 960         LDAP_CONST char *s ));
 961
 962
 963 /*
 964  * in modify.c:
 965  */
 966 LDAP_F( int )
 967 ldap_modify_ext LDAP_P((
 968         LDAP                    *ld,
 969         LDAP_CONST char *dn,
 970         LDAPMod                 **mods,
 971         LDAPControl             **serverctrls,
 972         LDAPControl             **clientctrls,
 973         int                     *msgidp ));
 974
 975 LDAP_F( int )
 976 ldap_modify_ext_s LDAP_P((
 977         LDAP                    *ld,
 978         LDAP_CONST char *dn,
 979         LDAPMod                 **mods,
 980         LDAPControl             **serverctrls,
 981         LDAPControl             **clientctrls ));
 982
 983 LDAP_F( int )
 984 ldap_modify LDAP_P((    /* deprecated */
 985         LDAP *ld,
 986         LDAP_CONST char *dn,
 987         LDAPMod **mods ));
 988
 989 LDAP_F( int )
 990 ldap_modify_s LDAP_P((  /* deprecated */
 991         LDAP *ld,
 992         LDAP_CONST char *dn,
 993         LDAPMod **mods ));
 994
 995
 996 /*
 997  * in modrdn.c:
 998  */
 999 LDAP_F( int )
1000 ldap_rename LDAP_P((
1001         LDAP *ld,
1002         LDAP_CONST char *dn,
1003         LDAP_CONST char *newrdn,
1004         LDAP_CONST char *newSuperior,
1005         int deleteoldrdn,
1006         LDAPControl **sctrls,
1007         LDAPControl **cctrls,
1008         int *msgidp ));
1009
1010 LDAP_F( int )
1011 ldap_rename_s LDAP_P((
1012         LDAP *ld,
1013         LDAP_CONST char *dn,
1014         LDAP_CONST char *newrdn,
1015         LDAP_CONST char *newSuperior,
1016         int deleteoldrdn,
1017         LDAPControl **sctrls,
1018         LDAPControl **cctrls ));
1019
1020 LDAP_F( int )
1021 ldap_rename2 LDAP_P((   /* deprecated */
1022         LDAP *ld,
1023         LDAP_CONST char *dn,
1024         LDAP_CONST char *newrdn,
1025         LDAP_CONST char *newSuperior,
1026         int deleteoldrdn ));
1027
1028 LDAP_F( int )
1029 ldap_rename2_s LDAP_P(( /* deprecated */
1030         LDAP *ld,
1031         LDAP_CONST char *dn,
1032         LDAP_CONST char *newrdn,
1033         LDAP_CONST char *newSuperior,
1034         int deleteoldrdn ));
1035
1036 LDAP_F( int )
1037 ldap_modrdn LDAP_P((    /* deprecated */
1038         LDAP *ld,
1039         LDAP_CONST char *dn,
1040         LDAP_CONST char *newrdn ));
1041
1042 LDAP_F( int )
1043 ldap_modrdn_s LDAP_P((  /* deprecated */
1044         LDAP *ld,
1045         LDAP_CONST char *dn,
1046         LDAP_CONST char *newrdn ));
1047
1048 LDAP_F( int )
1049 ldap_modrdn2 LDAP_P((   /* deprecated */
1050         LDAP *ld,
1051         LDAP_CONST char *dn,
1052         LDAP_CONST char *newrdn,
1053         int deleteoldrdn ));
1054
1055 LDAP_F( int )
1056 ldap_modrdn2_s LDAP_P(( /* deprecated */
1057         LDAP *ld,
1058         LDAP_CONST char *dn,
1059         LDAP_CONST char *newrdn,
1060         int deleteoldrdn));
1061
1062
1063 /*
1064  * in open.c:
1065  */
1066 LDAP_F( LDAP * )
1067 ldap_init LDAP_P((
1068         LDAP_CONST char *host,
1069         int port ));
1070
1071 LDAP_F( LDAP * )
1072 ldap_open LDAP_P((      /* deprecated */
1073         LDAP_CONST char *host,
1074         int port ));
1075
1076 LDAP_F( int )
1077 ldap_create LDAP_P((
1078         LDAP **ldp ));
1079
1080 LDAP_F( int )
1081 ldap_initialize LDAP_P((
1082         LDAP **ldp,
1083         LDAP_CONST char *url ));
1084
1085 LDAP_F( int )
1086 ldap_start_tls_s LDAP_P((
1087         LDAP *ld,
1088         LDAPControl **serverctrls,
1089         LDAPControl **clientctrls ));
1090
1091 /*
1092  * in messages.c:
1093  */
1094 LDAP_F( LDAPMessage * )
1095 ldap_first_message LDAP_P((
1096         LDAP *ld,
1097         LDAPMessage *chain ));
1098
1099 LDAP_F( LDAPMessage * )
1100 ldap_next_message LDAP_P((
1101         LDAP *ld,
1102         LDAPMessage *msg ));
1103
1104 LDAP_F( int )
1105 ldap_count_messages LDAP_P((
1106         LDAP *ld,
1107         LDAPMessage *chain ));
1108
1109
1110 /*
1111  * in references.c:
1112  */
1113 LDAP_F( LDAPMessage * )
1114 ldap_first_reference LDAP_P((
1115         LDAP *ld,
1116         LDAPMessage *chain ));
1117
1118 LDAP_F( LDAPMessage * )
1119 ldap_next_reference LDAP_P((
1120         LDAP *ld,
1121         LDAPMessage *ref ));
1122
1123 LDAP_F( int )
1124 ldap_count_references LDAP_P((
1125         LDAP *ld,
1126         LDAPMessage *chain ));
1127
1128 LDAP_F( int )
1129 ldap_parse_reference LDAP_P((
1130         LDAP                    *ld,
1131         LDAPMessage             *ref,
1132         char                    ***referralsp,
1133         LDAPControl             ***serverctrls,
1134         int                             freeit));
1135
1136
1137 /*
1138  * in getentry.c:
1139  */
1140 LDAP_F( LDAPMessage * )
1141 ldap_first_entry LDAP_P((
1142         LDAP *ld,
1143         LDAPMessage *chain ));
1144
1145 LDAP_F( LDAPMessage * )
1146 ldap_next_entry LDAP_P((
1147         LDAP *ld,
1148         LDAPMessage *entry ));
1149
1150 LDAP_F( int )
1151 ldap_count_entries LDAP_P((
1152         LDAP *ld,
1153         LDAPMessage *chain ));
1154
1155 LDAP_F( int )
1156 ldap_get_entry_controls LDAP_P((
1157         LDAP                    *ld,
1158         LDAPMessage             *entry,
1159         LDAPControl             ***serverctrls));
1160
1161
1162 /*
1163  * in addentry.c
1164  */
1165 LDAP_F( LDAPMessage * )
1166 ldap_delete_result_entry LDAP_P((
1167         LDAPMessage **list,
1168         LDAPMessage *e ));
1169
1170 LDAP_F( void )
1171 ldap_add_result_entry LDAP_P((
1172         LDAPMessage **list,
1173         LDAPMessage *e ));
1174
1175
1176 /*
1177  * in getdn.c
1178  */
1179 LDAP_F( char * )
1180 ldap_get_dn LDAP_P((
1181         LDAP *ld,
1182         LDAPMessage *entry ));
1183
1184 typedef struct ldap_ava {
1185         struct berval la_attr;
1186         struct berval la_value;
1187         unsigned la_flags;
1188 #define LDAP_AVA_STRING         0x0000U
1189 #define LDAP_AVA_BINARY         0x0001U
1190 #define LDAP_AVA_NONPRINTABLE   0x0002U
1191
1192         void *la_private;
1193 } LDAPAVA;
1194
1195 typedef LDAPAVA** LDAPRDN;
1196 typedef LDAPRDN** LDAPDN;
1197
1198 /* DN formats */
1199 #define LDAP_DN_FORMAT_LDAP             0x0000U
1200 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1201 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1202 #define LDAP_DN_FORMAT_DCE              0x0030U
1203 #define LDAP_DN_FORMAT_UFN              0x0040U /* dn2str only */
1204 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1205 #define LDAP_DN_FORMAT_LBER             0x00F0U /* for testing only */
1206 #define LDAP_DN_FORMAT_MASK             0x00F0U
1207
1208 /* DN flags */
1209 #define LDAP_DN_PRETTY                  0x0100U
1210 #define LDAP_DN_SKIP                    0x0200U
1211 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1212 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1213 #define LDAP_DN_PEDANTIC                0xF000U
1214
1215 LDAP_F( void )
1216 ldap_avafree LDAP_P(( LDAPAVA *ava ));
1217 LDAP_F( void )
1218 ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
1219 LDAP_F( void )
1220 ldap_dnfree LDAP_P(( LDAPDN *dn ));
1221
1222 LDAP_F( int )
1223 ldap_bv2dn LDAP_P((
1224         struct berval *bv,
1225         LDAPDN **dn,
1226         unsigned flags ));
1227
1228 LDAP_F( int )
1229 ldap_str2dn LDAP_P((
1230         LDAP_CONST char *str,
1231         LDAPDN **dn,
1232         unsigned flags ));
1233
1234 LDAP_F( int )
1235 ldap_dn2bv LDAP_P((
1236         LDAPDN *dn,
1237         struct berval *bv,
1238         unsigned flags ));
1239
1240 LDAP_F( int )
1241 ldap_dn2str LDAP_P((
1242         LDAPDN *dn,
1243         char **str,
1244         unsigned flags ));
1245
1246 LDAP_F( int )
1247 ldap_bv2rdn LDAP_P((
1248         struct berval *bv,
1249         LDAPRDN **rdn,
1250         char **next,
1251         unsigned flags ));
1252
1253 LDAP_F( int )
1254 ldap_str2rdn LDAP_P((
1255         LDAP_CONST char *str,
1256         LDAPRDN **rdn,
1257         char **next,
1258         unsigned flags ));
1259
1260 LDAP_F( int )
1261 ldap_rdn2bv LDAP_P((
1262         LDAPRDN *rdn,
1263         struct berval *bv,
1264         unsigned flags ));
1265
1266 LDAP_F( int )
1267 ldap_rdn2str LDAP_P((
1268         LDAPRDN *rdn,
1269         char **str,
1270         unsigned flags ));
1271
1272 LDAP_F( int )
1273 ldap_dn_normalize LDAP_P((
1274         LDAP_CONST char *in, unsigned iflags,
1275         char **out, unsigned oflags ));
1276
1277 LDAP_F( char * )
1278 ldap_dn2ufn LDAP_P(( /* deprecated */
1279         LDAP_CONST char *dn ));
1280
1281 LDAP_F( char ** )
1282 ldap_explode_dn LDAP_P(( /* deprecated */
1283         LDAP_CONST char *dn,
1284         int notypes ));
1285
1286 LDAP_F( char ** )
1287 ldap_explode_rdn LDAP_P(( /* deprecated */
1288         LDAP_CONST char *rdn,
1289         int notypes ));
1290
1291 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN *dn, unsigned flags ));
1292
1293 LDAP_F( int )
1294 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1295         LDAPDN_rewrite_func *func, unsigned flags ));
1296
1297 LDAP_F( char * )
1298 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1299
1300 LDAP_F( char * )
1301 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1302
1303 LDAP_F( char * )
1304 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1305
1306 LDAP_F( int )
1307 ldap_get_dn_ber LDAP_P((
1308         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1309
1310 LDAP_F( int )
1311 ldap_get_attribute_ber LDAP_P((
1312         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1313         struct berval **vals ));
1314
1315 /*
1316  * in getattr.c
1317  */
1318 LDAP_F( char * )
1319 ldap_first_attribute LDAP_P((
1320         LDAP *ld,
1321         LDAPMessage *entry,
1322         BerElement **ber ));
1323
1324 LDAP_F( char * )
1325 ldap_next_attribute LDAP_P((
1326         LDAP *ld,
1327         LDAPMessage *entry,
1328         BerElement *ber ));
1329
1330
1331 /*
1332  * in getvalues.c
1333  */
1334 LDAP_F( struct berval ** )
1335 ldap_get_values_len LDAP_P((
1336         LDAP *ld,
1337         LDAPMessage *entry,
1338         LDAP_CONST char *target ));
1339
1340 LDAP_F( int )
1341 ldap_count_values_len LDAP_P((
1342         struct berval **vals ));
1343
1344 LDAP_F( void )
1345 ldap_value_free_len LDAP_P((
1346         struct berval **vals ));
1347
1348 LDAP_F( char ** )
1349 ldap_get_values LDAP_P((        /* deprecated */
1350         LDAP *ld,
1351         LDAPMessage *entry,
1352         LDAP_CONST char *target ));
1353
1354 LDAP_F( int )
1355 ldap_count_values LDAP_P((      /* deprecated */
1356         char **vals ));
1357
1358 LDAP_F( void )
1359 ldap_value_free LDAP_P((        /* deprecated */
1360         char **vals ));
1361
1362 /*
1363  * in result.c:
1364  */
1365 LDAP_F( int )
1366 ldap_result LDAP_P((
1367         LDAP *ld,
1368         int msgid,
1369         int all,
1370         struct timeval *timeout,
1371         LDAPMessage **result ));
1372
1373 LDAP_F( int )
1374 ldap_msgtype LDAP_P((
1375         LDAPMessage *lm ));
1376
1377 LDAP_F( int )
1378 ldap_msgid   LDAP_P((
1379         LDAPMessage *lm ));
1380
1381 LDAP_F( int )
1382 ldap_msgfree LDAP_P((
1383         LDAPMessage *lm ));
1384
1385 LDAP_F( int )
1386 ldap_msgdelete LDAP_P((
1387         LDAP *ld,
1388         int msgid ));
1389
1390
1391 /*
1392  * in search.c:
1393  */
1394 LDAP_F( int )
1395 ldap_search_ext LDAP_P((
1396         LDAP                    *ld,
1397         LDAP_CONST char *base,
1398         int                             scope,
1399         LDAP_CONST char *filter,
1400         char                    **attrs,
1401         int                             attrsonly,
1402         LDAPControl             **serverctrls,
1403         LDAPControl             **clientctrls,
1404         struct timeval  *timeout,
1405         int                             sizelimit,
1406         int                             *msgidp ));
1407
1408 LDAP_F( int )
1409 ldap_search_ext_s LDAP_P((
1410         LDAP                    *ld,
1411         LDAP_CONST char *base,
1412         int                             scope,
1413         LDAP_CONST char *filter,
1414         char                    **attrs,
1415         int                             attrsonly,
1416         LDAPControl             **serverctrls,
1417         LDAPControl             **clientctrls,
1418         struct timeval  *timeout,
1419         int                             sizelimit,
1420         LDAPMessage             **res ));
1421
1422 LDAP_F( int )
1423 ldap_search LDAP_P((    /* deprecated */
1424         LDAP *ld,
1425         LDAP_CONST char *base,
1426         int scope,
1427         LDAP_CONST char *filter,
1428         char **attrs,
1429         int attrsonly ));
1430
1431 LDAP_F( int )
1432 ldap_search_s LDAP_P((  /* deprecated */
1433         LDAP *ld,
1434         LDAP_CONST char *base,
1435         int scope,
1436         LDAP_CONST char *filter,
1437         char **attrs,
1438         int attrsonly,
1439         LDAPMessage **res ));
1440
1441 LDAP_F( int )
1442 ldap_search_st LDAP_P(( /* deprecated */
1443         LDAP *ld,
1444         LDAP_CONST char *base,
1445         int scope,
1446         LDAP_CONST char *filter,
1447     char **attrs,
1448         int attrsonly,
1449         struct timeval *timeout,
1450         LDAPMessage **res ));
1451
1452 /*
1453  * in unbind.c
1454  */
1455 LDAP_F( int )
1456 ldap_unbind LDAP_P(( /* deprecated */
1457         LDAP *ld ));
1458
1459 LDAP_F( int )
1460 ldap_unbind_s LDAP_P(( /* deprecated */
1461         LDAP *ld ));
1462
1463 LDAP_F( int )
1464 ldap_unbind_ext LDAP_P((
1465         LDAP                    *ld,
1466         LDAPControl             **serverctrls,
1467         LDAPControl             **clientctrls));
1468
1469 LDAP_F( int )
1470 ldap_unbind_ext_s LDAP_P((
1471         LDAP                    *ld,
1472         LDAPControl             **serverctrls,
1473         LDAPControl             **clientctrls));
1474
1475 /*
1476  * in filter.c
1477  */
1478 LDAP_F( int )
1479 ldap_put_vrFilter LDAP_P((
1480         BerElement *ber,
1481         const char *vrf ));
1482
1483 /*
1484  * in free.c
1485  */
1486
1487 LDAP_F( void * )
1488 ldap_memalloc LDAP_P((
1489         ber_len_t s ));
1490
1491 LDAP_F( void * )
1492 ldap_memrealloc LDAP_P((
1493         void* p,
1494         ber_len_t s ));
1495
1496 LDAP_F( void * )
1497 ldap_memcalloc LDAP_P((
1498         ber_len_t n,
1499         ber_len_t s ));
1500
1501 LDAP_F( void )
1502 ldap_memfree LDAP_P((
1503         void* p ));
1504
1505 LDAP_F( void )
1506 ldap_memvfree LDAP_P((
1507         void** v ));
1508
1509 LDAP_F( char * )
1510 ldap_strdup LDAP_P((
1511         LDAP_CONST char * ));
1512
1513 LDAP_F( void )
1514 ldap_mods_free LDAP_P((
1515         LDAPMod **mods,
1516         int freemods ));
1517
1518
1519 /*
1520  * in sort.c
1521  *      (deprecated)
1522  */
1523 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1524         LDAP_CONST char *left,
1525         LDAP_CONST char *right ));
1526
1527 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1528         LDAP_CONST void *left,
1529         LDAP_CONST void *right ));
1530
1531 LDAP_F( int )   /* deprecated */
1532 ldap_sort_entries LDAP_P(( LDAP *ld,
1533         LDAPMessage **chain,
1534         LDAP_CONST char *attr,
1535         LDAP_SORT_AD_CMP_PROC *cmp ));
1536
1537 LDAP_F( int )   /* deprecated */
1538 ldap_sort_values LDAP_P((
1539         LDAP *ld,
1540         char **vals,
1541         LDAP_SORT_AV_CMP_PROC *cmp ));
1542
1543 LDAP_F( int ) /* deprecated */
1544 ldap_sort_strcasecmp LDAP_P((
1545         LDAP_CONST void *a,
1546         LDAP_CONST void *b ));
1547
1548
1549 /*
1550  * in url.c
1551  */
1552 LDAP_F( int )
1553 ldap_is_ldap_url LDAP_P((
1554         LDAP_CONST char *url ));
1555
1556 LDAP_F( int )
1557 ldap_is_ldaps_url LDAP_P((
1558         LDAP_CONST char *url ));
1559
1560 LDAP_F( int )
1561 ldap_is_ldapi_url LDAP_P((
1562         LDAP_CONST char *url ));
1563
1564 LDAP_F( int )
1565 ldap_url_parse LDAP_P((
1566         LDAP_CONST char *url,
1567         LDAPURLDesc **ludpp ));
1568
1569 LDAP_F( char * )
1570 ldap_url_desc2str LDAP_P((
1571         LDAPURLDesc *ludp ));
1572
1573 LDAP_F( void )
1574 ldap_free_urldesc LDAP_P((
1575         LDAPURLDesc *ludp ));
1576
1577 /*
1578  * in sortctrl.c
1579  */
1580 /*
1581  * structure for a sort-key
1582  */
1583 typedef struct ldapsortkey {
1584         char *  attributeType;
1585         char *  orderingRule;
1586         int     reverseOrder;
1587 } LDAPSortKey;
1588
1589 LDAP_F( int )
1590 ldap_create_sort_keylist LDAP_P((
1591         LDAPSortKey ***sortKeyList,
1592         char        *keyString ));
1593
1594 LDAP_F( void )
1595 ldap_free_sort_keylist LDAP_P((
1596         LDAPSortKey **sortkeylist ));
1597
1598 LDAP_F( int )
1599 ldap_create_sort_control LDAP_P((
1600         LDAP *ld,
1601         LDAPSortKey **keyList,
1602         int ctl_iscritical,
1603         LDAPControl **ctrlp ));
1604
1605 LDAP_F( int )
1606 ldap_parse_sort_control LDAP_P((
1607         LDAP           *ld,
1608         LDAPControl    **ctrlp,
1609         unsigned long  *result,
1610         char           **attribute ));
1611
1612
1613 /*
1614  * in vlvctrl.c
1615  */
1616
1617 /*
1618  * structure for virtual list.
1619  */
1620 typedef struct ldapvlvinfo {
1621         int             ldvlv_version;
1622     unsigned long   ldvlv_before_count;
1623     unsigned long   ldvlv_after_count;
1624     unsigned long   ldvlv_offset;
1625     unsigned long   ldvlv_count;
1626     struct berval  *ldvlv_attrvalue;
1627     struct berval  *ldvlv_context;
1628     void           *ldvlv_extradata;
1629 } LDAPVLVInfo;
1630
1631 LDAP_F( int )
1632 ldap_create_vlv_control LDAP_P((
1633         LDAP *ld,
1634         LDAPVLVInfo *ldvlistp,
1635         LDAPControl **ctrlp ));
1636
1637 LDAP_F( int )
1638 ldap_parse_vlv_control LDAP_P((
1639         LDAP          *ld,
1640         LDAPControl   **ctrls,
1641         unsigned long *target_posp,
1642         unsigned long *list_countp,
1643         struct berval **contextp,
1644         int           *errcodep ));
1645
1646
1647 LDAP_END_DECL
1648 #endif /* _LDAP_H */