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

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