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

   1 /*
   2  * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms are permitted only
   6  * as authorized by the OpenLDAP Public License.  A copy of this
   7  * license is available at http://www.OpenLDAP.org/license.html or
   8  * in file LICENSE in the top-level directory of the distribution.
   9  */
  10 /* Portions
  11  * Copyright (c) 1990 Regents of the University of Michigan.
  12  * All rights reserved.
  13  *
  14  * Redistribution and use in source and binary forms are permitted
  15  * provided that this notice is preserved and that due credit is given
  16  * to the University of Michigan at Ann Arbor. The name of the University
  17  * may not be used to endorse or promote products derived from this
  18  * software without specific prior written permission. This software
  19  * is provided ``as is'' without express or implied warranty.
  20  */
  21
  22 #ifndef _LDAP_H
  23 #define _LDAP_H
  24
  25 #include <ldap_cdefs.h>
  26
  27 LDAP_BEGIN_DECL
  28
  29 #define LDAP_VERSION1   1
  30 #define LDAP_VERSION2   2
  31 #define LDAP_VERSION3   3
  32
  33 #define LDAP_VERSION            LDAP_VERSION2
  34 #define LDAP_VERSION_MIN        LDAP_VERSION2
  35 #define LDAP_VERSION_MAX        LDAP_VERSION2
  36
  37 /*
  38  * We'll use 2000+draft revision for our API version number
  39  * As such, the number will be above the old RFC but below
  40  * whatever number does finally get assigned
  41  */
  42 #define LDAP_API_VERSION        2001
  43 #define LDAP_VENDOR_NAME        "OpenLDAP"
  44 /* We'll eventually release as 200 */
  45 #define LDAP_VENDOR_VERSION     190
  46
  47 /* OpenLDAP API Features */
  48 #define LDAP_API_FEATURE_X_OPENLDAP 1
  49
  50 /* include LDAP_API_FEATURE defines */
  51 #include <ldap_features.h>
  52
  53 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
  54         ( defined( LDAP_THREAD_SAFE ) && \
  55                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
  56         /* -lldap may or may not be thread safe */
  57         /* -lldap_r, if available, is always thread safe */
  58 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
  59 #endif
  60 #if defined( LDAP_THREAD_SAFE ) && \
  61         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
  62 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
  63 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
  64 #endif
  65
  66 #define LDAP_API_FEATURE_INFO 1
  67
  68 typedef struct ldap_apifeature_info {
  69         char*   ldapaif_name;    /* matches LDAP_API_FEATURE_... less the prefix */
  70         int             ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
  71 } LDAPAPIFeatureInfo;
  72
  73 #define LDAP_PORT               389
  74
  75 #define LDAP_ROOT_DSE                           ""
  76 #define LDAP_NO_ATTRS                           "1.1"
  77 #define LDAP_ALL_USER_ATTRIBUTES        "*"
  78
  79 #define LDAP_COMPAT20
  80 #define LDAP_COMPAT30
  81 #if defined(LDAP_COMPAT20) || defined(LDAP_COMPAT30)
  82 #define LDAP_COMPAT
  83 #endif
  84
  85 /* LDAP_OPTions defined by draft-ldapext-ldap-c-api-01 */
  86 #define LDAP_OPT_API_INFO                       0x0000
  87 #define LDAP_OPT_DESC                           0x0001
  88 #define LDAP_OPT_DEREF                          0x0002
  89 #define LDAP_OPT_SIZELIMIT                      0x0003
  90 #define LDAP_OPT_TIMELIMIT                      0x0004
  91 /* 0x05 - 0x07 not defined by current draft */
  92 #define LDAP_OPT_REFERRALS                      0x0008
  93 #define LDAP_OPT_RESTART                        0x0009
  94 /* 0x0a - 0x10 not defined by current draft */
  95 #define LDAP_OPT_PROTOCOL_VERSION       0x0011
  96 #define LDAP_OPT_SERVER_CONTROLS        0x0012
  97 #define LDAP_OPT_CLIENT_CONTROLS        0x0013
  98 /* 0x14 - 0x2f not defined by current draft */
  99 #define LDAP_OPT_HOST_NAME                      0x0030
 100 #define LDAP_OPT_ERROR_NUMBER           0x0031
 101 #define LDAP_OPT_ERROR_STRING           0x0032
 102
 103 /* LDAP_OPTions under IETF discussion */
 104 #define LDAP_OPT_API_FEATURE_INFO       0x0100
 105
 106 /* not defined by current draft */
 107 /*      for LDAPv2 compatibility */
 108 #define LDAP_OPT_DNS                            0x1001  /* use DN & DNS */
 109
 110 /* OpenLDAP specific options */
 111 #define LDAP_OPT_DEBUG_LEVEL            0x4001  /* OpenLDAP - debug level */
 112
 113 /* on/off values */
 114 #define LDAP_OPT_ON             ((void *) 1)
 115 #define LDAP_OPT_OFF    ((void *) 0)
 116
 117 #define LDAP_OPT_SUCCESS        0
 118 #define LDAP_OPT_ERROR          (-1)
 119
 120 #define LDAP_API_INFO_VERSION   1
 121 typedef struct ldapapiinfo {
 122         int             ldapai_info_version;            /* version of LDAPAPIInfo (1) */
 123         int             ldapai_api_version;                     /* revision of API supported */
 124         int             ldapai_protocol_version;        /* highest LDAP version supported */
 125         char    **ldapai_extensions;            /* names of API extensions */
 126         char    *ldapai_vendor_name;            /* name of supplier */
 127         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
 128 } LDAPAPIInfo;
 129
 130 typedef struct ldapcontrol {
 131         char                    *ldctl_oid;
 132         struct berval   ldctl_value;
 133         char                    ldctl_iscritical;
 134 } LDAPControl, *PLDAPControl;
 135
 136 #define LDAP_MAX_ATTR_LEN       100
 137
 138 /*
 139  * specific LDAP instantiations of BER types we know about
 140  */
 141
 142 /* general stuff */
 143 #define LDAP_TAG_MESSAGE        0x30L   /* tag is 16 + constructed bit */
 144 #define OLD_LDAP_TAG_MESSAGE    0x10L   /* forgot the constructed bit  */
 145 #define LDAP_TAG_MSGID          0x02L
 146 /* need to add other LDAP_TAGs here */
 147
 148 /* Overview of tag construction in ASN.1:
 149  *       _______
 150  * Bit # | 8 7 | CLASS: UNIVERSAL               00
 151  *                      APPLICATION             01
 152  *                      CONTEXT-SPECIFIC        10
 153  *                      PRIVATE                 11
 154  *              _____
 155  *              | 6 | DATA-TYPE: PRIMITIVE      0
 156  *                               CONSTRUCTED    1
 157  *                  ___________
 158  *                  | 5 ... 1 | TAG-NUMBER
 159  */
 160
 161 #define LDAP_TAG_NEWSUPERIOR    0x80L   /* context-specific + primitive +
 162                                          * tag # ==> [0]
 163                                          */
 164
 165 /* possible operations a client can invoke */
 166 #define LDAP_REQ_BIND                   0x60L   /* application + constructed */
 167 #define LDAP_REQ_UNBIND                 0x42L   /* application + primitive   */
 168 #define LDAP_REQ_SEARCH                 0x63L   /* application + constructed */
 169 #define LDAP_REQ_MODIFY                 0x66L   /* application + constructed */
 170 #define LDAP_REQ_ADD                    0x68L   /* application + constructed */
 171 #define LDAP_REQ_DELETE                 0x4aL   /* application + primitive   */
 172 #define LDAP_REQ_MODRDN                 0x6cL   /* application + constructed */
 173 #define LDAP_REQ_MODDN                  LDAP_REQ_MODRDN
 174 #define LDAP_REQ_RENAME                 LDAP_REQ_MODRDN
 175 #define LDAP_REQ_COMPARE                0x6eL   /* application + constructed */
 176 #define LDAP_REQ_ABANDON                0x50L   /* application + primitive   */
 177 #define LDAP_REQ_EXTENDED               0x77L   /* application + constructed */
 178
 179 /* U-Mich version 3.0 compatibility stuff */
 180 #define LDAP_REQ_UNBIND_30              0x62L
 181 #define LDAP_REQ_DELETE_30              0x6aL
 182 #define LDAP_REQ_ABANDON_30             0x70L
 183
 184 /*
 185  * old broken stuff for backwards compatibility - forgot application tag
 186  * and constructed/primitive bit
 187  */
 188 #define OLD_LDAP_REQ_BIND               0x00L
 189 #define OLD_LDAP_REQ_UNBIND             0x02L
 190 #define OLD_LDAP_REQ_SEARCH             0x03L
 191 #define OLD_LDAP_REQ_MODIFY             0x06L
 192 #define OLD_LDAP_REQ_ADD                0x08L
 193 #define OLD_LDAP_REQ_DELETE             0x0aL
 194 #define OLD_LDAP_REQ_MODRDN             0x0cL
 195 #define OLD_LDAP_REQ_COMPARE            0x0eL
 196 #define OLD_LDAP_REQ_ABANDON            0x10L
 197
 198 /* possible result types a server can return */
 199 #define LDAP_RES_BIND                   0x61L   /* application + constructed */
 200 #define LDAP_RES_SEARCH_ENTRY           0x64L   /* application + constructed */
 201 #define LDAP_RES_SEARCH_REFERENCE       0x73L   /* V3: application + constructed */
 202 #define LDAP_RES_SEARCH_RESULT          0x65L   /* application + constructed */
 203 #define LDAP_RES_MODIFY                 0x67L   /* application + constructed */
 204 #define LDAP_RES_ADD                    0x69L   /* application + constructed */
 205 #define LDAP_RES_DELETE                 0x6bL   /* application + constructed */
 206 #define LDAP_RES_MODRDN                 0x6dL   /* application + constructed */
 207 #define LDAP_RES_MODDN                  LDAP_RES_MODRDN /* application + constructed */
 208 #define LDAP_RES_RENAME                 LDAP_RES_MODRDN /* application + constructed */
 209 #define LDAP_RES_COMPARE                0x6fL   /* application + constructed */
 210 #define LDAP_RES_EXTENDED               0x78L   /* V3: application + constructed */
 211 #define LDAP_RES_ANY                    (-1L)
 212
 213 /* old broken stuff for backwards compatibility */
 214 #define OLD_LDAP_RES_BIND               0x01L
 215 #define OLD_LDAP_RES_SEARCH_ENTRY       0x04L
 216 #define OLD_LDAP_RES_SEARCH_RESULT      0x05L
 217 #define OLD_LDAP_RES_MODIFY             0x07L
 218 #define OLD_LDAP_RES_ADD                0x09L
 219 #define OLD_LDAP_RES_DELETE             0x0bL
 220 #define OLD_LDAP_RES_MODRDN             0x0dL
 221 #define OLD_LDAP_RES_MODDN              OLD_LDAP_RES_MODRDN
 222 #define OLD_LDAP_RES_COMPARE            0x0fL
 223
 224 /* sasl methods */
 225 #define LDAP_SASL_SIMPLE                        NULL
 226
 227 /* authentication methods available */
 228 #define LDAP_AUTH_NONE          0x00L   /* no authentication              */
 229 #define LDAP_AUTH_SIMPLE        0x80L   /* context specific + primitive   */
 230 #define LDAP_AUTH_SASL          0xa3L   /* context specific + primitive   */
 231 #define LDAP_AUTH_KRBV4         0xffL   /* means do both of the following */
 232 #define LDAP_AUTH_KRBV41        0x81L   /* context specific + primitive   */
 233 #define LDAP_AUTH_KRBV42        0x82L   /* context specific + primitive   */
 234
 235 /* U-Mich version 3.0 compatibility auth methods */
 236 #define LDAP_AUTH_SIMPLE_30     0xa0L   /* context specific + constructed */
 237 #define LDAP_AUTH_KRBV41_30     0xa1L   /* context specific + constructed */
 238 #define LDAP_AUTH_KRBV42_30     0xa2L   /* context specific + constructed */
 239
 240 /* old broken stuff */
 241 #define OLD_LDAP_AUTH_SIMPLE    0x00L
 242 #define OLD_LDAP_AUTH_KRBV4     0x01L
 243 #define OLD_LDAP_AUTH_KRBV42    0x02L
 244
 245 /* filter types */
 246 #define LDAP_FILTER_AND         0xa0L   /* context specific + constructed */
 247 #define LDAP_FILTER_OR          0xa1L   /* context specific + constructed */
 248 #define LDAP_FILTER_NOT         0xa2L   /* context specific + constructed */
 249 #define LDAP_FILTER_EQUALITY    0xa3L   /* context specific + constructed */
 250 #define LDAP_FILTER_SUBSTRINGS  0xa4L   /* context specific + constructed */
 251 #define LDAP_FILTER_GE          0xa5L   /* context specific + constructed */
 252 #define LDAP_FILTER_LE          0xa6L   /* context specific + constructed */
 253 #define LDAP_FILTER_PRESENT     0x87L   /* context specific + primitive   */
 254 #define LDAP_FILTER_APPROX      0xa8L   /* context specific + constructed */
 255 #define LDAP_FILTER_EXTENDED    0xa9L   /* context specific + constructed */
 256
 257 /* U-Mich version 3.0 compatibility filter types */
 258 #define LDAP_FILTER_PRESENT_30  0xa7L   /* context specific + constructed */
 259
 260 /* old broken stuff */
 261 #define OLD_LDAP_FILTER_AND             0x00L
 262 #define OLD_LDAP_FILTER_OR              0x01L
 263 #define OLD_LDAP_FILTER_NOT             0x02L
 264 #define OLD_LDAP_FILTER_EQUALITY        0x03L
 265 #define OLD_LDAP_FILTER_SUBSTRINGS      0x04L
 266 #define OLD_LDAP_FILTER_GE              0x05L
 267 #define OLD_LDAP_FILTER_LE              0x06L
 268 #define OLD_LDAP_FILTER_PRESENT         0x07L
 269 #define OLD_LDAP_FILTER_APPROX          0x08L
 270
 271 /* extended filter component types */
 272 #define LDAP_FILTER_EXTENDED_OID        0x81L   /* context specific */
 273 #define LDAP_FILTER_EXTENDED_TYPE       0x82L   /* context specific */
 274 #define LDAP_FILTER_EXTENDED_VALUE      0x83L   /* context specific */
 275 #define LDAP_FILTER_EXTENDED_DNATTRS    0x84L   /* context specific */
 276
 277 /* substring filter component types */
 278 #define LDAP_SUBSTRING_INITIAL  0x80L   /* context specific */
 279 #define LDAP_SUBSTRING_ANY      0x81L   /* context specific */
 280 #define LDAP_SUBSTRING_FINAL    0x82L   /* context specific */
 281
 282 /* U-Mich version 3.0 compatibility substring filter component types */
 283 #define LDAP_SUBSTRING_INITIAL_30       0xa0L   /* context specific */
 284 #define LDAP_SUBSTRING_ANY_30           0xa1L   /* context specific */
 285 #define LDAP_SUBSTRING_FINAL_30         0xa2L   /* context specific */
 286
 287 /* old broken stuff */
 288 #define OLD_LDAP_SUBSTRING_INITIAL      0x00L
 289 #define OLD_LDAP_SUBSTRING_ANY          0x01L
 290 #define OLD_LDAP_SUBSTRING_FINAL        0x02L
 291
 292 /* search scopes */
 293 #define LDAP_SCOPE_BASE         0x00
 294 #define LDAP_SCOPE_ONELEVEL     0x01
 295 #define LDAP_SCOPE_SUBTREE      0x02
 296
 297 /* for modifications */
 298 typedef struct ldapmod {
 299         int             mod_op;
 300 #define LDAP_MOD_ADD            0x00
 301 #define LDAP_MOD_DELETE         0x01
 302 #define LDAP_MOD_REPLACE        0x02
 303 #define LDAP_MOD_BVALUES        0x80
 304         char            *mod_type;
 305         union {
 306                 char            **modv_strvals;
 307                 struct berval   **modv_bvals;
 308         } mod_vals;
 309 #define mod_values      mod_vals.modv_strvals
 310 #define mod_bvalues     mod_vals.modv_bvals
 311 } LDAPMod;
 312
 313 /*
 314  * possible error codes we can return
 315  */
 316
 317 #define LDAP_SUCCESS                    0x00
 318 #define LDAP_OPERATIONS_ERROR           0x01
 319 #define LDAP_PROTOCOL_ERROR             0x02
 320 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 321 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 322 #define LDAP_COMPARE_FALSE              0x05
 323 #define LDAP_COMPARE_TRUE               0x06
 324 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  0x07
 325 #define LDAP_AUTH_METHOD_NOT_SUPPORTED LDAP_STRONG_AUTH_NOT_SUPPORTED
 326 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 327 #define LDAP_PARTIAL_RESULTS            0x09    /* not listed in v3 */
 328
 329 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 330 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 331 #define LDAP_UNAVAILABLE_CRITICIAL_EXTENSION    0x0c /* LDAPv3 */
 332 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 333 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 334
 335 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 336 #define LDAP_UNDEFINED_TYPE             0x11
 337 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 338 #define LDAP_CONSTRAINT_VIOLATION       0x13
 339 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 340 #define LDAP_INVALID_SYNTAX             0x15
 341
 342 #define LDAP_NO_SUCH_OBJECT             0x20
 343 #define LDAP_ALIAS_PROBLEM              0x21
 344 #define LDAP_INVALID_DN_SYNTAX          0x22
 345 #define LDAP_IS_LEAF                    0x23 /* not LDAPv3 */
 346 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 347
 348 #define LDAP_NAME_ERROR(n)      ((n & 0xf0) == 0x20)
 349 #define NAME_ERROR(n)   LDAP_NAME_ERROR(n)      /* depreciated */
 350
 351 #define LDAP_INAPPROPRIATE_AUTH         0x30
 352 #define LDAP_INVALID_CREDENTIALS        0x31
 353 #define LDAP_INSUFFICIENT_ACCESS        0x32
 354 #define LDAP_BUSY                       0x33
 355 #define LDAP_UNAVAILABLE                0x34
 356 #define LDAP_UNWILLING_TO_PERFORM       0x35
 357 #define LDAP_LOOP_DETECT                0x36
 358
 359 #define LDAP_NAMING_VIOLATION           0x40
 360 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 361 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 362 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 363 #define LDAP_ALREADY_EXISTS             0x44
 364 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 365 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 366 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
 367
 368 #define LDAP_OTHER                      0x50
 369 #define LDAP_SERVER_DOWN                0x51
 370 #define LDAP_LOCAL_ERROR                0x52
 371 #define LDAP_ENCODING_ERROR             0x53
 372 #define LDAP_DECODING_ERROR             0x54
 373 #define LDAP_TIMEOUT                    0x55
 374 #define LDAP_AUTH_UNKNOWN               0x56
 375 #define LDAP_FILTER_ERROR               0x57
 376 #define LDAP_USER_CANCELLED             0x58
 377 #define LDAP_PARAM_ERROR                0x59
 378 #define LDAP_NO_MEMORY                  0x5a
 379
 380 #define LDAP_CONNECT_ERROR                              0x5b    /* new */
 381 #define LDAP_NOT_SUPPORTED                              0x5c    /* new */
 382 #define LDAP_CONTROL_NOT_FOUND                  0x5d    /* new */
 383 #define LDAP_NO_RESULTS_RETURNED                0x5e    /* new */
 384 #define LDAP_MORE_RESULTS_TO_RETURN             0x5f    /* new */
 385 #define LDAP_CLIENT_LOOP                                0x60    /* new */
 386 #define LDAP_REFERRAL_LIMIT_EXCEEDED    0x61    /* new */
 387
 388 /* default limit on nesting of referrals */
 389 #define LDAP_DEFAULT_REFHOPLIMIT        5
 390
 391 /*
 392  * This structure represents both ldap messages and ldap responses.
 393  * These are really the same, except in the case of search responses,
 394  * where a response has multiple messages.
 395  */
 396
 397 typedef struct ldapmsg LDAPMessage;
 398 #define NULLMSG ((LDAPMessage *) NULL)
 399
 400 /*
 401  * structures for ldap getfilter routines
 402  */
 403
 404 typedef struct ldap_filt_info {
 405         char                    *lfi_filter;
 406         char                    *lfi_desc;
 407         int                     lfi_scope;      /* LDAP_SCOPE_BASE, etc */
 408         int                     lfi_isexact;    /* exact match filter? */
 409         struct ldap_filt_info   *lfi_next;
 410 } LDAPFiltInfo;
 411
 412 typedef struct ldap_filt_list {
 413     char                        *lfl_tag;
 414     char                        *lfl_pattern;
 415     char                        *lfl_delims;
 416     LDAPFiltInfo                *lfl_ilist;
 417     struct ldap_filt_list       *lfl_next;
 418 } LDAPFiltList;
 419
 420
 421 #define LDAP_FILT_MAXSIZ        1024
 422
 423 typedef struct ldap_filt_desc {
 424         LDAPFiltList            *lfd_filtlist;
 425         LDAPFiltInfo            *lfd_curfip;
 426         LDAPFiltInfo            lfd_retfi;
 427         char                    lfd_filter[ LDAP_FILT_MAXSIZ ];
 428         char                    *lfd_curval;
 429         char                    *lfd_curvalcopy;
 430         char                    **lfd_curvalwords;
 431         char                    *lfd_filtprefix;
 432         char                    *lfd_filtsuffix;
 433 } LDAPFiltDesc;
 434
 435
 436 /*
 437  * structure representing an ldap connection
 438  */
 439
 440 typedef struct ldap LDAP;
 441
 442 #define LDAP_DEREF_NEVER        0x00
 443 #define LDAP_DEREF_SEARCHING    0x01
 444 #define LDAP_DEREF_FINDING      0x02
 445 #define LDAP_DEREF_ALWAYS       0x03
 446
 447 #define LDAP_NO_LIMIT           0
 448
 449 /* how many messages to retrieve results for */
 450 #define LDAP_MSG_ONE            0x00
 451 #define LDAP_MSG_ALL            0x01
 452 #define LDAP_MSG_RECEIVED       0x02
 453
 454 /*
 455  * structure for ldap friendly mapping routines
 456  */
 457
 458 typedef struct ldap_friendly {
 459         char    *lf_unfriendly;
 460         char    *lf_friendly;
 461 } LDAPFriendlyMap;
 462
 463 /*
 464  * types for ldap URL handling
 465  */
 466 typedef struct ldap_url_desc {
 467     char        *lud_host;
 468     int         lud_port;
 469     char        *lud_dn;
 470     char        **lud_attrs;
 471     int         lud_scope;
 472     char        *lud_filter;
 473     char        *lud_string;    /* for internal use only */
 474 } LDAPURLDesc;
 475 #define NULLLDAPURLDESC ((LDAPURLDesc *)NULL)
 476
 477 #define LDAP_URL_ERR_NOTLDAP    1       /* URL doesn't begin with "ldap://" */
 478 #define LDAP_URL_ERR_NODN       2       /* URL has no DN (required) */
 479 #define LDAP_URL_ERR_BADSCOPE   3       /* URL scope string is invalid */
 480 #define LDAP_URL_ERR_MEM        4       /* can't allocate memory space */
 481
 482 /* avoid pulling in headers */
 483 struct timeval;
 484
 485 /*
 486  * in options.c:
 487  */
 488 LDAP_F int ldap_get_option LDAP_P((LDAP *ld, int option, void *outvalue));
 489 LDAP_F int ldap_set_option LDAP_P((LDAP *ld, int option, void *invalue));
 490
 491
 492 /*
 493  * in controls.c:
 494  */
 495 LDAP_F void ldap_control_free LDAP_P(( LDAPControl *ctrl ));
 496 LDAP_F void ldap_controls_free LDAP_P(( LDAPControl **ctrls ));
 497
 498
 499 /*
 500  * in extended.c:
 501  */
 502 LDAP_F int ldap_extended_operation LDAP_P((
 503         LDAP                    *ld,
 504         char                    *exoid,
 505         struct berval   *exdata,
 506         LDAPControl             **serverctrls,
 507         LDAPControl             **clientctrls,
 508         int                             *msgidp ));
 509
 510 LDAP_F int ldap_extended_operation_s LDAP_P((
 511         LDAP                    *ld,
 512         char                    *exoid,
 513         struct berval   *exdata,
 514         LDAPControl             **serverctrls,
 515         LDAPControl             **clientctrls,
 516         char                    **retoidp,
 517         struct berval   **retdatap ));
 518
 519 /*
 520  * in abandon.c:
 521  */
 522 LDAP_F int ldap_abandon LDAP_P(( LDAP *ld, int msgid ));
 523 LDAP_F int ldap_abandon_ext LDAP_P((
 524         LDAP                    *ld,
 525         int                             msgid,
 526         LDAPControl             **serverctrls,
 527         LDAPControl             **clientctrls ));
 528
 529
 530 /*
 531  * in add.c:
 532  */
 533 LDAP_F int ldap_add_ext LDAP_P((
 534         LDAP                    *ld,
 535         char                    *dn,
 536         LDAPMod                 **attrs,
 537         LDAPControl             **serverctrls,
 538         LDAPControl             **clientctrls,
 539         int                     *msgidp ));
 540
 541 LDAP_F int ldap_add_ext_s LDAP_P((
 542         LDAP                    *ld,
 543         char                    *dn,
 544         LDAPMod                 **attrs,
 545         LDAPControl             **serverctrls,
 546         LDAPControl             **clientctrls,
 547         LDAPMessage     **res ));
 548
 549 LDAP_F int ldap_add LDAP_P(( LDAP *ld, char *dn, LDAPMod **attrs ));
 550 LDAP_F int ldap_add_s LDAP_P(( LDAP *ld, char *dn, LDAPMod **attrs ));
 551
 552
 553 /*
 554  * in saslbind.c:
 555  */
 556 LDAP_F int ldap_sasl_bind LDAP_P((
 557         LDAP                    *ld,
 558         char                    *dn,
 559         char                    *mechanism,
 560         struct berval *cred,
 561         LDAPControl             **serverctrls,
 562         LDAPControl             **clientctrls,
 563         int                             msgidp ));
 564
 565 LDAP_F int ldap_sasl_bind_s LDAP_P((
 566         LDAP                    *ld,
 567         char                    *dn,
 568         char                    *mechanism,
 569         struct berval   *cred,
 570         LDAPControl             **serverctrls,
 571         LDAPControl             **clientctrls,
 572         struct berval   **servercredp ));
 573
 574
 575 /*
 576  * in bind.c:
 577  *      (depreciated)
 578  */
 579 LDAP_F int ldap_bind LDAP_P(( LDAP *ld, char *who, char *passwd, int authmethod ));
 580 LDAP_F int ldap_bind_s LDAP_P(( LDAP *ld, char *who, char *cred, int method ));
 581 LDAP_F void ldap_set_rebind_proc LDAP_P(( LDAP *ld,
 582         int (*rebindproc) LDAP_P(( LDAP *ld, char **dnp, char **passwdp, int *authmethodp, int freeit ))
 583 ));
 584
 585
 586 /*
 587  * in sbind.c:
 588  */
 589 LDAP_F int ldap_simple_bind LDAP_P(( LDAP *ld, char *who, char *passwd ));
 590 LDAP_F int ldap_simple_bind_s LDAP_P(( LDAP *ld, char *who, char *passwd ));
 591
 592
 593 /*
 594  * in kbind.c:
 595  *      (depreciated)
 596  */
 597 LDAP_F int ldap_kerberos_bind_s LDAP_P(( LDAP *ld, char *who ));
 598 LDAP_F int ldap_kerberos_bind1 LDAP_P(( LDAP *ld, char *who ));
 599 LDAP_F int ldap_kerberos_bind1_s LDAP_P(( LDAP *ld, char *who ));
 600 LDAP_F int ldap_kerberos_bind2 LDAP_P(( LDAP *ld, char *who ));
 601 LDAP_F int ldap_kerberos_bind2_s LDAP_P(( LDAP *ld, char *who ));
 602
 603
 604 /*
 605  * in cache.c
 606  */
 607 LDAP_F int ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, long maxmem ));
 608 LDAP_F void ldap_disable_cache LDAP_P(( LDAP *ld ));
 609 LDAP_F void ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
 610 LDAP_F void ldap_destroy_cache LDAP_P(( LDAP *ld ));
 611 LDAP_F void ldap_flush_cache LDAP_P(( LDAP *ld ));
 612 LDAP_F void ldap_uncache_entry LDAP_P(( LDAP *ld, char *dn ));
 613 LDAP_F void ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
 614
 615
 616 /*
 617  * in compare.c:
 618  */
 619 LDAP_F int ldap_compare_ext LDAP_P((
 620         LDAP                    *ld,
 621         char                    *dn,
 622         char                    *attr,
 623         struct berval   *bvalue,
 624         LDAPControl             **serverctrls,
 625         LDAPControl             **clientctrls,
 626         int                     *msgidp ));
 627
 628 LDAP_F int ldap_compare_ext_s LDAP_P((
 629         LDAP                    *ld,
 630         char                    *dn,
 631         char                    *attr,
 632         struct berval   *bvalue,
 633         LDAPControl             **serverctrls,
 634         LDAPControl             **clientctrls,
 635         LDAPMessage     **res ));
 636
 637 LDAP_F int ldap_compare LDAP_P(( LDAP *ld, char *dn, char *attr, char *value ));
 638 LDAP_F int ldap_compare_s LDAP_P(( LDAP *ld, char *dn, char *attr, char *value ));
 639
 640
 641 /*
 642  * in delete.c:
 643  */
 644 LDAP_F int ldap_delete_ext LDAP_P((
 645         LDAP                    *ld,
 646         char                    *dn,
 647         LDAPControl             **serverctrls,
 648         LDAPControl             **clientctrls,
 649         int                     *msgidp ));
 650
 651 LDAP_F int ldap_delete_ext_s LDAP_P((
 652         LDAP                    *ld,
 653         char                    *dn,
 654         LDAPControl             **serverctrls,
 655         LDAPControl             **clientctrls,
 656         LDAPMessage     **res ));
 657
 658 LDAP_F int ldap_delete LDAP_P(( LDAP *ld, char *dn ));
 659 LDAP_F int ldap_delete_s LDAP_P(( LDAP *ld, char *dn ));
 660
 661
 662 /*
 663  * in error.c:
 664  */
 665 LDAP_F int ldap_result2error LDAP_P(( LDAP *ld, LDAPMessage *r, int freeit ));
 666 LDAP_F char *ldap_err2string LDAP_P(( int err ));
 667 LDAP_F void ldap_perror LDAP_P(( LDAP *ld, char *s ));
 668
 669
 670 /*
 671  * in modify.c:
 672  */
 673 LDAP_F int ldap_modify_ext LDAP_P((
 674         LDAP                    *ld,
 675         char                    *dn,
 676         LDAPMod                 **mods,
 677         LDAPControl             **serverctrls,
 678         LDAPControl             **clientctrls,
 679         int                     *msgidp ));
 680
 681 LDAP_F int ldap_modify_ext_s LDAP_P((
 682         LDAP                    *ld,
 683         char                    *dn,
 684         LDAPMod                 **mods,
 685         LDAPControl             **serverctrls,
 686         LDAPControl             **clientctrls,
 687         LDAPMessage     **res ));
 688
 689 LDAP_F int ldap_modify LDAP_P(( LDAP *ld, char *dn, LDAPMod **mods ));
 690 LDAP_F int ldap_modify_s LDAP_P(( LDAP *ld, char *dn, LDAPMod **mods ));
 691
 692
 693 /*
 694  * in rename.c:
 695  */
 696 LDAP_F int ldap_rename_ext LDAP_P((
 697         LDAP                    *ld,
 698         char                    *dn,
 699         char                    *newrdn,
 700         char                    *newparent,
 701         int                             deleteoldrdn,
 702         LDAPControl             **serverctrls,
 703         LDAPControl             **clientctrls,
 704         int                     *msgidp ));
 705
 706 LDAP_F int ldap_rename_ext_s LDAP_P((
 707         LDAP                    *ld,
 708         char                    *dn,
 709         char                    *newrdn,
 710         char                    *newparent,
 711         int                             deleteoldrdn,
 712         LDAPControl             **serverctrls,
 713         LDAPControl             **clientctrls,
 714         LDAPMessage     **res ));
 715
 716
 717 /*
 718  * in modrdn.c:
 719  */
 720 LDAP_F int ldap_modrdn LDAP_P(( LDAP *ld, char *dn, char *newrdn ));
 721 LDAP_F int ldap_modrdn_s LDAP_P(( LDAP *ld, char *dn, char *newrdn ));
 722 LDAP_F int ldap_modrdn2 LDAP_P(( LDAP *ld, char *dn, char *newrdn,
 723         int deleteoldrdn ));
 724 LDAP_F int ldap_modrdn2_s LDAP_P(( LDAP *ld, char *dn, char *newrdn,
 725         int deleteoldrdn));
 726
 727
 728 /*
 729  * in open.c:
 730  */
 731 LDAP_F LDAP *ldap_open LDAP_P(( char *host, int port ));
 732 LDAP_F LDAP *ldap_init LDAP_P(( char *host, int port ));
 733
 734
 735 /*
 736  * in messages.c:
 737  */
 738 LDAP_F LDAPMessage *ldap_first_message LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 739 LDAP_F LDAPMessage *ldap_next_message LDAP_P(( LDAP *ld, LDAPMessage *msg ));
 740 LDAP_F int ldap_count_messages LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 741
 742
 743 /*
 744  * in references.c:
 745  */
 746 LDAP_F LDAPMessage *ldap_first_reference LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 747 LDAP_F LDAPMessage *ldap_next_reference LDAP_P(( LDAP *ld, LDAPMessage *ref ));
 748 LDAP_F int ldap_count_references LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 749 LDAP_F int ldap_parse_reference LDAP_P((
 750         LDAP                    *ld,
 751         LDAPMessage             *ref,
 752         char                    ***referralsp,
 753         LDAPControl             ***serverctrls,
 754         int                             freeit));
 755
 756
 757 /*
 758  * in getentry.c:
 759  */
 760 LDAP_F LDAPMessage *ldap_first_entry LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 761 LDAP_F LDAPMessage *ldap_next_entry LDAP_P(( LDAP *ld, LDAPMessage *entry ));
 762 LDAP_F int ldap_count_entries LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 763 LDAP_F int ldap_get_entry_controls LDAP_P((
 764         LDAP                    *ld,
 765         LDAPMessage             *entry,
 766         LDAPControl             ***serverctrls));
 767
 768
 769 /*
 770  * in addentry.c
 771  */
 772 LDAP_F LDAPMessage *ldap_delete_result_entry LDAP_P(( LDAPMessage **list,
 773         LDAPMessage *e ));
 774 LDAP_F void ldap_add_result_entry LDAP_P(( LDAPMessage **list, LDAPMessage *e ));
 775
 776
 777 /*
 778  * in getdn.c
 779  */
 780 LDAP_F char *ldap_get_dn LDAP_P(( LDAP *ld, LDAPMessage *entry ));
 781 LDAP_F char *ldap_dn2ufn LDAP_P(( char *dn ));
 782 LDAP_F char **ldap_explode_dn LDAP_P(( char *dn, int notypes ));
 783 LDAP_F char **ldap_explode_rdn LDAP_P(( char *rdn, int notypes ));
 784 LDAP_F char **ldap_explode_dns LDAP_P(( char *dn ));
 785 LDAP_F int ldap_is_dns_dn LDAP_P(( char *dn ));
 786
 787
 788 /*
 789  * in getattr.c
 790  */
 791 LDAP_F char *ldap_first_attribute LDAP_P(( LDAP *ld, LDAPMessage *entry,
 792         BerElement **ber ));
 793 LDAP_F char *ldap_next_attribute LDAP_P(( LDAP *ld, LDAPMessage *entry,
 794         BerElement *ber ));
 795
 796
 797 /*
 798  * in getvalues.c
 799  */
 800 LDAP_F char **ldap_get_values LDAP_P(( LDAP *ld, LDAPMessage *entry, char *target ));
 801 LDAP_F struct berval **ldap_get_values_len LDAP_P(( LDAP *ld, LDAPMessage *entry,
 802         char *target ));
 803 LDAP_F int ldap_count_values LDAP_P(( char **vals ));
 804 LDAP_F int ldap_count_values_len LDAP_P(( struct berval **vals ));
 805 LDAP_F void ldap_value_free LDAP_P(( char **vals ));
 806 LDAP_F void ldap_value_free_len LDAP_P(( struct berval **vals ));
 807
 808
 809 /*
 810  * in result.c:
 811  */
 812 LDAP_F int ldap_result LDAP_P(( LDAP *ld, int msgid, int all,
 813         struct timeval *timeout, LDAPMessage **result ));
 814 LDAP_F int ldap_msgtype LDAP_P(( LDAPMessage *lm ));
 815 LDAP_F int ldap_msgid   LDAP_P(( LDAPMessage *lm ));
 816 LDAP_F int ldap_msgfree LDAP_P(( LDAPMessage *lm ));
 817 LDAP_F int ldap_msgdelete LDAP_P(( LDAP *ld, int msgid ));
 818
 819
 820 /*
 821  * in search.c:
 822  */
 823 LDAP_F int ldap_search_ext LDAP_P((
 824         LDAP                    *ld,
 825         char                    *base,
 826         int                             scope,
 827         char                    *filter,
 828         char                    **attrs,
 829         LDAPControl             **serverctrls,
 830         LDAPControl             **clientctrls,
 831         struct timeval  *timeout,
 832         int                             sizelimit,
 833         int                             *msgidp ));
 834
 835 LDAP_F int ldap_search_ext_s LDAP_P((
 836         LDAP                    *ld,
 837         char                    *base,
 838         int                             scope,
 839         char                    *filter,
 840         char                    **attrs,
 841         LDAPControl             **serverctrls,
 842         LDAPControl             **clientctrls,
 843         struct timeval  *timeout,
 844         int                             sizelimit,
 845         LDAPMessage             **res ));
 846
 847 LDAP_F int ldap_search LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 848         char **attrs, int attrsonly ));
 849 LDAP_F int ldap_search_s LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 850         char **attrs, int attrsonly, LDAPMessage **res ));
 851 LDAP_F int ldap_search_st LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 852     char **attrs, int attrsonly, struct timeval *timeout, LDAPMessage **res ));
 853
 854
 855 /*
 856  * in ufn.c
 857  */
 858 LDAP_F int ldap_ufn_search_c LDAP_P(( LDAP *ld, char *ufn, char **attrs,
 859         int attrsonly, LDAPMessage **res, int (*cancelproc)( void *cl ),
 860         void *cancelparm ));
 861 LDAP_F int ldap_ufn_search_ct LDAP_P(( LDAP *ld, char *ufn, char **attrs,
 862         int attrsonly, LDAPMessage **res, int (*cancelproc)( void *cl ),
 863         void *cancelparm, char *tag1, char *tag2, char *tag3 ));
 864 LDAP_F int ldap_ufn_search_s LDAP_P(( LDAP *ld, char *ufn, char **attrs,
 865         int attrsonly, LDAPMessage **res ));
 866 LDAP_F LDAPFiltDesc *ldap_ufn_setfilter LDAP_P(( LDAP *ld, char *fname ));
 867 LDAP_F void ldap_ufn_setprefix LDAP_P(( LDAP *ld, char *prefix ));
 868 LDAP_F int ldap_ufn_timeout LDAP_P(( void *tvparam ));
 869
 870
 871 /*
 872  * in unbind.c
 873  */
 874 LDAP_F int ldap_unbind LDAP_P(( LDAP *ld ));
 875 LDAP_F int ldap_unbind_s LDAP_P(( LDAP *ld ));
 876
 877
 878 /*
 879  * in getfilter.c
 880  */
 881 LDAP_F LDAPFiltDesc *ldap_init_getfilter LDAP_P(( char *fname ));
 882 LDAP_F LDAPFiltDesc *ldap_init_getfilter_buf LDAP_P(( char *buf, long buflen ));
 883 LDAP_F LDAPFiltInfo *ldap_getfirstfilter LDAP_P(( LDAPFiltDesc *lfdp, char *tagpat,
 884         char *value ));
 885 LDAP_F LDAPFiltInfo *ldap_getnextfilter LDAP_P(( LDAPFiltDesc *lfdp ));
 886 LDAP_F void ldap_setfilteraffixes LDAP_P(( LDAPFiltDesc *lfdp, char *prefix, char *suffix ));
 887 LDAP_F void ldap_build_filter LDAP_P(( char *buf, unsigned long buflen,
 888         char *pattern, char *prefix, char *suffix, char *attr,
 889         char *value, char **valwords ));
 890
 891
 892 /*
 893  * in free.c
 894  */
 895 LDAP_F void ldap_memfree LDAP_P(( void *p ));
 896 LDAP_F void ldap_getfilter_free LDAP_P(( LDAPFiltDesc *lfdp ));
 897 LDAP_F void ldap_mods_free LDAP_P(( LDAPMod **mods, int freemods ));
 898
 899
 900 /*
 901  * in friendly.c
 902  */
 903 LDAP_F char *ldap_friendly_name LDAP_P(( char *filename, char *uname,
 904         LDAPFriendlyMap **map ));
 905 LDAP_F void ldap_free_friendlymap LDAP_P(( LDAPFriendlyMap **map ));
 906
 907
 908 /*
 909  * in cldap.c
 910  */
 911 LDAP_F LDAP *cldap_open LDAP_P(( char *host, int port ));
 912 LDAP_F void cldap_close LDAP_P(( LDAP *ld ));
 913 LDAP_F int cldap_search_s LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 914         char **attrs, int attrsonly, LDAPMessage **res, char *logdn ));
 915 LDAP_F void cldap_setretryinfo LDAP_P(( LDAP *ld, int tries, int timeout ));
 916
 917
 918 /*
 919  * in sort.c
 920  */
 921 LDAP_F int ldap_sort_entries LDAP_P(( LDAP *ld,
 922         LDAPMessage **chain, char *attr,
 923         int (*cmp) (const char *, const char *) ));
 924 LDAP_F int ldap_sort_values LDAP_P(( LDAP *ld,
 925         char **vals, int (*cmp) (const void *, const void *) ));
 926 LDAP_F int ldap_sort_strcasecmp LDAP_P(( const void *a, const void *b ));
 927
 928
 929 /*
 930  * in url.c
 931  */
 932 LDAP_F int ldap_is_ldap_url LDAP_P(( char *url ));
 933 LDAP_F int ldap_url_parse LDAP_P(( char *url, LDAPURLDesc **ludpp ));
 934 LDAP_F void ldap_free_urldesc LDAP_P(( LDAPURLDesc *ludp ));
 935 LDAP_F int ldap_url_search LDAP_P(( LDAP *ld, char *url, int attrsonly ));
 936 LDAP_F int ldap_url_search_s LDAP_P(( LDAP *ld, char *url, int attrsonly,
 937         LDAPMessage **res ));
 938 LDAP_F int ldap_url_search_st LDAP_P(( LDAP *ld, char *url, int attrsonly,
 939         struct timeval *timeout, LDAPMessage **res ));
 940
 941
 942 /*
 943  * in charset.c
 944  */
 945 LDAP_F void ldap_set_string_translators LDAP_P(( LDAP *ld,
 946         BERTranslateProc encode_proc, BERTranslateProc decode_proc ));
 947 LDAP_F int ldap_translate_from_t61 LDAP_P(( LDAP *ld, char **bufp,
 948         unsigned long *lenp, int free_input ));
 949 LDAP_F int ldap_translate_to_t61 LDAP_P(( LDAP *ld, char **bufp,
 950         unsigned long *lenp, int free_input ));
 951 LDAP_F void ldap_enable_translation LDAP_P(( LDAP *ld, LDAPMessage *entry,
 952         int enable ));
 953
 954 LDAP_F int ldap_t61_to_8859 LDAP_P(( char **bufp, unsigned long *buflenp,
 955         int free_input ));
 956 LDAP_F int ldap_8859_to_t61 LDAP_P(( char **bufp, unsigned long *buflenp,
 957         int free_input ));
 958
 959 LDAP_END_DECL
 960
 961 #endif /* _LDAP_H */