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

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