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

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