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