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