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 /* possible operations a client can invoke */
 149 #define LDAP_REQ_BIND                   0x60L   /* application + constructed */
 150 #define LDAP_REQ_UNBIND                 0x42L   /* application + primitive   */
 151 #define LDAP_REQ_SEARCH                 0x63L   /* application + constructed */
 152 #define LDAP_REQ_MODIFY                 0x66L   /* application + constructed */
 153 #define LDAP_REQ_ADD                    0x68L   /* application + constructed */
 154 #define LDAP_REQ_DELETE                 0x4aL   /* application + primitive   */
 155 #define LDAP_REQ_MODRDN                 0x6cL   /* application + constructed */
 156 #define LDAP_REQ_MODDN                  LDAP_REQ_MODRDN
 157 #define LDAP_REQ_RENAME                 LDAP_REQ_MODRDN
 158 #define LDAP_REQ_COMPARE                0x6eL   /* application + constructed */
 159 #define LDAP_REQ_ABANDON                0x50L   /* application + primitive   */
 160 #define LDAP_REQ_EXTENDED               0x77L   /* application + constructed */
 161
 162 /* U-Mich version 3.0 compatibility stuff */
 163 #define LDAP_REQ_UNBIND_30              0x62L
 164 #define LDAP_REQ_DELETE_30              0x6aL
 165 #define LDAP_REQ_ABANDON_30             0x70L
 166
 167 /*
 168  * old broken stuff for backwards compatibility - forgot application tag
 169  * and constructed/primitive bit
 170  */
 171 #define OLD_LDAP_REQ_BIND               0x00L
 172 #define OLD_LDAP_REQ_UNBIND             0x02L
 173 #define OLD_LDAP_REQ_SEARCH             0x03L
 174 #define OLD_LDAP_REQ_MODIFY             0x06L
 175 #define OLD_LDAP_REQ_ADD                0x08L
 176 #define OLD_LDAP_REQ_DELETE             0x0aL
 177 #define OLD_LDAP_REQ_MODRDN             0x0cL
 178 #define OLD_LDAP_REQ_COMPARE            0x0eL
 179 #define OLD_LDAP_REQ_ABANDON            0x10L
 180
 181 /* possible result types a server can return */
 182 #define LDAP_RES_BIND                   0x61L   /* application + constructed */
 183 #define LDAP_RES_SEARCH_ENTRY           0x64L   /* application + constructed */
 184 #define LDAP_RES_SEARCH_REFERENCE       0x73L   /* V3: application + constructed */
 185 #define LDAP_RES_SEARCH_RESULT          0x65L   /* application + constructed */
 186 #define LDAP_RES_MODIFY                 0x67L   /* application + constructed */
 187 #define LDAP_RES_ADD                    0x69L   /* application + constructed */
 188 #define LDAP_RES_DELETE                 0x6bL   /* application + constructed */
 189 #define LDAP_RES_MODRDN                 0x6dL   /* application + constructed */
 190 #define LDAP_RES_MODDN                  LDAP_RES_MODRDN /* application + constructed */
 191 #define LDAP_RES_RENAME                 LDAP_RES_MODRDN /* application + constructed */
 192 #define LDAP_RES_COMPARE                0x6fL   /* application + constructed */
 193 #define LDAP_RES_EXTENDED               0x78L   /* V3: application + constructed */
 194 #define LDAP_RES_ANY                    (-1L)
 195
 196 /* old broken stuff for backwards compatibility */
 197 #define OLD_LDAP_RES_BIND               0x01L
 198 #define OLD_LDAP_RES_SEARCH_ENTRY       0x04L
 199 #define OLD_LDAP_RES_SEARCH_RESULT      0x05L
 200 #define OLD_LDAP_RES_MODIFY             0x07L
 201 #define OLD_LDAP_RES_ADD                0x09L
 202 #define OLD_LDAP_RES_DELETE             0x0bL
 203 #define OLD_LDAP_RES_MODRDN             0x0dL
 204 #define OLD_LDAP_RES_MODDN              OLD_LDAP_RES_MODRDN
 205 #define OLD_LDAP_RES_COMPARE            0x0fL
 206
 207 /* sasl methods */
 208 #define LDAP_SASL_SIMPLE                        NULL
 209
 210 /* authentication methods available */
 211 #define LDAP_AUTH_NONE          0x00L   /* no authentication              */
 212 #define LDAP_AUTH_SIMPLE        0x80L   /* context specific + primitive   */
 213 #define LDAP_AUTH_SASL          0xa3L   /* context specific + primitive   */
 214 #define LDAP_AUTH_KRBV4         0xffL   /* means do both of the following */
 215 #define LDAP_AUTH_KRBV41        0x81L   /* context specific + primitive   */
 216 #define LDAP_AUTH_KRBV42        0x82L   /* context specific + primitive   */
 217
 218 /* U-Mich version 3.0 compatibility auth methods */
 219 #define LDAP_AUTH_SIMPLE_30     0xa0L   /* context specific + constructed */
 220 #define LDAP_AUTH_KRBV41_30     0xa1L   /* context specific + constructed */
 221 #define LDAP_AUTH_KRBV42_30     0xa2L   /* context specific + constructed */
 222
 223 /* old broken stuff */
 224 #define OLD_LDAP_AUTH_SIMPLE    0x00L
 225 #define OLD_LDAP_AUTH_KRBV4     0x01L
 226 #define OLD_LDAP_AUTH_KRBV42    0x02L
 227
 228 /* filter types */
 229 #define LDAP_FILTER_AND         0xa0L   /* context specific + constructed */
 230 #define LDAP_FILTER_OR          0xa1L   /* context specific + constructed */
 231 #define LDAP_FILTER_NOT         0xa2L   /* context specific + constructed */
 232 #define LDAP_FILTER_EQUALITY    0xa3L   /* context specific + constructed */
 233 #define LDAP_FILTER_SUBSTRINGS  0xa4L   /* context specific + constructed */
 234 #define LDAP_FILTER_GE          0xa5L   /* context specific + constructed */
 235 #define LDAP_FILTER_LE          0xa6L   /* context specific + constructed */
 236 #define LDAP_FILTER_PRESENT     0x87L   /* context specific + primitive   */
 237 #define LDAP_FILTER_APPROX      0xa8L   /* context specific + constructed */
 238 #define LDAP_FILTER_EXTENDED    0xa9L   /* context specific + constructed */
 239
 240 /* U-Mich version 3.0 compatibility filter types */
 241 #define LDAP_FILTER_PRESENT_30  0xa7L   /* context specific + constructed */
 242
 243 /* old broken stuff */
 244 #define OLD_LDAP_FILTER_AND             0x00L
 245 #define OLD_LDAP_FILTER_OR              0x01L
 246 #define OLD_LDAP_FILTER_NOT             0x02L
 247 #define OLD_LDAP_FILTER_EQUALITY        0x03L
 248 #define OLD_LDAP_FILTER_SUBSTRINGS      0x04L
 249 #define OLD_LDAP_FILTER_GE              0x05L
 250 #define OLD_LDAP_FILTER_LE              0x06L
 251 #define OLD_LDAP_FILTER_PRESENT         0x07L
 252 #define OLD_LDAP_FILTER_APPROX          0x08L
 253
 254 /* extended filter component types */
 255 #define LDAP_FILTER_EXTENDED_OID        0x81L   /* context specific */
 256 #define LDAP_FILTER_EXTENDED_TYPE       0x82L   /* context specific */
 257 #define LDAP_FILTER_EXTENDED_VALUE      0x83L   /* context specific */
 258 #define LDAP_FILTER_EXTENDED_DNATTRS    0x84L   /* context specific */
 259
 260 /* substring filter component types */
 261 #define LDAP_SUBSTRING_INITIAL  0x80L   /* context specific */
 262 #define LDAP_SUBSTRING_ANY      0x81L   /* context specific */
 263 #define LDAP_SUBSTRING_FINAL    0x82L   /* context specific */
 264
 265 /* U-Mich version 3.0 compatibility substring filter component types */
 266 #define LDAP_SUBSTRING_INITIAL_30       0xa0L   /* context specific */
 267 #define LDAP_SUBSTRING_ANY_30           0xa1L   /* context specific */
 268 #define LDAP_SUBSTRING_FINAL_30         0xa2L   /* context specific */
 269
 270 /* old broken stuff */
 271 #define OLD_LDAP_SUBSTRING_INITIAL      0x00L
 272 #define OLD_LDAP_SUBSTRING_ANY          0x01L
 273 #define OLD_LDAP_SUBSTRING_FINAL        0x02L
 274
 275 /* search scopes */
 276 #define LDAP_SCOPE_BASE         0x00
 277 #define LDAP_SCOPE_ONELEVEL     0x01
 278 #define LDAP_SCOPE_SUBTREE      0x02
 279
 280 /* for modifications */
 281 typedef struct ldapmod {
 282         int             mod_op;
 283 #define LDAP_MOD_ADD            0x00
 284 #define LDAP_MOD_DELETE         0x01
 285 #define LDAP_MOD_REPLACE        0x02
 286 #define LDAP_MOD_BVALUES        0x80
 287         char            *mod_type;
 288         union {
 289                 char            **modv_strvals;
 290                 struct berval   **modv_bvals;
 291         } mod_vals;
 292 #define mod_values      mod_vals.modv_strvals
 293 #define mod_bvalues     mod_vals.modv_bvals
 294 } LDAPMod;
 295
 296 /*
 297  * possible error codes we can return
 298  */
 299
 300 #define LDAP_SUCCESS                    0x00
 301 #define LDAP_OPERATIONS_ERROR           0x01
 302 #define LDAP_PROTOCOL_ERROR             0x02
 303 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 304 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 305 #define LDAP_COMPARE_FALSE              0x05
 306 #define LDAP_COMPARE_TRUE               0x06
 307 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  0x07
 308 #define LDAP_AUTH_METHOD_NOT_SUPPORTED LDAP_STRONG_AUTH_NOT_SUPPORTED
 309 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 310 #define LDAP_PARTIAL_RESULTS            0x09    /* not listed in v3 */
 311
 312 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
 313 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
 314 #define LDAP_UNAVAILABLE_CRITICIAL_EXTENSION    0x0c /* LDAPv3 */
 315 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
 316 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
 317
 318 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 319 #define LDAP_UNDEFINED_TYPE             0x11
 320 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 321 #define LDAP_CONSTRAINT_VIOLATION       0x13
 322 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 323 #define LDAP_INVALID_SYNTAX             0x15
 324
 325 #define LDAP_NO_SUCH_OBJECT             0x20
 326 #define LDAP_ALIAS_PROBLEM              0x21
 327 #define LDAP_INVALID_DN_SYNTAX          0x22
 328 #define LDAP_IS_LEAF                    0x23 /* not LDAPv3 */
 329 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 330
 331 #define LDAP_NAME_ERROR(n)      ((n & 0xf0) == 0x20)
 332 #define NAME_ERROR(n)   LDAP_NAME_ERROR(n)      /* depreciated */
 333
 334 #define LDAP_INAPPROPRIATE_AUTH         0x30
 335 #define LDAP_INVALID_CREDENTIALS        0x31
 336 #define LDAP_INSUFFICIENT_ACCESS        0x32
 337 #define LDAP_BUSY                       0x33
 338 #define LDAP_UNAVAILABLE                0x34
 339 #define LDAP_UNWILLING_TO_PERFORM       0x35
 340 #define LDAP_LOOP_DETECT                0x36
 341
 342 #define LDAP_NAMING_VIOLATION           0x40
 343 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 344 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 345 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 346 #define LDAP_ALREADY_EXISTS             0x44
 347 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 348 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
 349 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
 350
 351 #define LDAP_OTHER                      0x50
 352 #define LDAP_SERVER_DOWN                0x51
 353 #define LDAP_LOCAL_ERROR                0x52
 354 #define LDAP_ENCODING_ERROR             0x53
 355 #define LDAP_DECODING_ERROR             0x54
 356 #define LDAP_TIMEOUT                    0x55
 357 #define LDAP_AUTH_UNKNOWN               0x56
 358 #define LDAP_FILTER_ERROR               0x57
 359 #define LDAP_USER_CANCELLED             0x58
 360 #define LDAP_PARAM_ERROR                0x59
 361 #define LDAP_NO_MEMORY                  0x5a
 362
 363 #define LDAP_CONNECT_ERROR                              0x5b    /* new */
 364 #define LDAP_NOT_SUPPORTED                              0x5c    /* new */
 365 #define LDAP_CONTROL_NOT_FOUND                  0x5d    /* new */
 366 #define LDAP_NO_RESULTS_RETURNED                0x5e    /* new */
 367 #define LDAP_MORE_RESULTS_TO_RETURN             0x5f    /* new */
 368 #define LDAP_CLIENT_LOOP                                0x60    /* new */
 369 #define LDAP_REFERRAL_LIMIT_EXCEEDED    0x61    /* new */
 370
 371 /* default limit on nesting of referrals */
 372 #define LDAP_DEFAULT_REFHOPLIMIT        5
 373
 374 /*
 375  * This structure represents both ldap messages and ldap responses.
 376  * These are really the same, except in the case of search responses,
 377  * where a response has multiple messages.
 378  */
 379
 380 typedef struct ldapmsg LDAPMessage;
 381 #define NULLMSG ((LDAPMessage *) NULL)
 382
 383 /*
 384  * structures for ldap getfilter routines
 385  */
 386
 387 typedef struct ldap_filt_info {
 388         char                    *lfi_filter;
 389         char                    *lfi_desc;
 390         int                     lfi_scope;      /* LDAP_SCOPE_BASE, etc */
 391         int                     lfi_isexact;    /* exact match filter? */
 392         struct ldap_filt_info   *lfi_next;
 393 } LDAPFiltInfo;
 394
 395 typedef struct ldap_filt_list {
 396     char                        *lfl_tag;
 397     char                        *lfl_pattern;
 398     char                        *lfl_delims;
 399     LDAPFiltInfo                *lfl_ilist;
 400     struct ldap_filt_list       *lfl_next;
 401 } LDAPFiltList;
 402
 403
 404 #define LDAP_FILT_MAXSIZ        1024
 405
 406 typedef struct ldap_filt_desc {
 407         LDAPFiltList            *lfd_filtlist;
 408         LDAPFiltInfo            *lfd_curfip;
 409         LDAPFiltInfo            lfd_retfi;
 410         char                    lfd_filter[ LDAP_FILT_MAXSIZ ];
 411         char                    *lfd_curval;
 412         char                    *lfd_curvalcopy;
 413         char                    **lfd_curvalwords;
 414         char                    *lfd_filtprefix;
 415         char                    *lfd_filtsuffix;
 416 } LDAPFiltDesc;
 417
 418
 419 /*
 420  * structure representing an ldap connection
 421  */
 422
 423 typedef struct ldap LDAP;
 424
 425 #define LDAP_DEREF_NEVER        0x00
 426 #define LDAP_DEREF_SEARCHING    0x01
 427 #define LDAP_DEREF_FINDING      0x02
 428 #define LDAP_DEREF_ALWAYS       0x03
 429
 430 #define LDAP_NO_LIMIT           0
 431
 432 /* how many messages to retrieve results for */
 433 #define LDAP_MSG_ONE            0x00
 434 #define LDAP_MSG_ALL            0x01
 435 #define LDAP_MSG_RECEIVED       0x02
 436
 437 /*
 438  * structure for ldap friendly mapping routines
 439  */
 440
 441 typedef struct ldap_friendly {
 442         char    *lf_unfriendly;
 443         char    *lf_friendly;
 444 } LDAPFriendlyMap;
 445
 446
 447 /*
 448  * handy macro to check whether LDAP struct is set up for CLDAP or not
 449  */
 450 #define LDAP_IS_CLDAP( ld )     ( (ld)->ld_sb.sb_naddr > 0 )
 451
 452
 453 /*
 454  * types for ldap URL handling
 455  */
 456 typedef struct ldap_url_desc {
 457     char        *lud_host;
 458     int         lud_port;
 459     char        *lud_dn;
 460     char        **lud_attrs;
 461     int         lud_scope;
 462     char        *lud_filter;
 463     char        *lud_string;    /* for internal use only */
 464 } LDAPURLDesc;
 465 #define NULLLDAPURLDESC ((LDAPURLDesc *)NULL)
 466
 467 #define LDAP_URL_ERR_NOTLDAP    1       /* URL doesn't begin with "ldap://" */
 468 #define LDAP_URL_ERR_NODN       2       /* URL has no DN (required) */
 469 #define LDAP_URL_ERR_BADSCOPE   3       /* URL scope string is invalid */
 470 #define LDAP_URL_ERR_MEM        4       /* can't allocate memory space */
 471
 472 /* avoid pulling in headers */
 473 struct timeval;
 474
 475 /*
 476  * in options.c:
 477  */
 478 LDAP_F int ldap_get_option LDAP_P((LDAP *ld, int option, void *outvalue));
 479 LDAP_F int ldap_set_option LDAP_P((LDAP *ld, int option, void *invalue));
 480
 481
 482 /*
 483  * in controls.c:
 484  */
 485 LDAP_F void ldap_control_free LDAP_P(( LDAPControl *ctrl ));
 486 LDAP_F void ldap_controls_free LDAP_P(( LDAPControl **ctrls ));
 487
 488
 489 /*
 490  * in extended.c:
 491  */
 492 LDAP_F int ldap_extended_operation LDAP_P((
 493         LDAP                    *ld,
 494         char                    *exoid,
 495         struct berval   *exdata,
 496         LDAPControl             **serverctrls,
 497         LDAPControl             **clientctrls,
 498         int                             *msgidp ));
 499
 500 LDAP_F int ldap_extended_operation_s LDAP_P((
 501         LDAP                    *ld,
 502         char                    *exoid,
 503         struct berval   *exdata,
 504         LDAPControl             **serverctrls,
 505         LDAPControl             **clientctrls,
 506         char                    **retoidp,
 507         struct berval   **retdatap ));
 508
 509 /*
 510  * in abandon.c:
 511  */
 512 LDAP_F int ldap_abandon LDAP_P(( LDAP *ld, int msgid ));
 513 LDAP_F int ldap_abandon_ext LDAP_P((
 514         LDAP                    *ld,
 515         int                             msgid,
 516         LDAPControl             **serverctrls,
 517         LDAPControl             **clientctrls ));
 518
 519
 520 /*
 521  * in add.c:
 522  */
 523 LDAP_F int ldap_add_ext LDAP_P((
 524         LDAP                    *ld,
 525         char                    *dn,
 526         LDAPMod                 **attrs,
 527         LDAPControl             **serverctrls,
 528         LDAPControl             **clientctrls,
 529         int                     *msgidp ));
 530
 531 LDAP_F int ldap_add_ext_s LDAP_P((
 532         LDAP                    *ld,
 533         char                    *dn,
 534         LDAPMod                 **attrs,
 535         LDAPControl             **serverctrls,
 536         LDAPControl             **clientctrls,
 537         LDAPMessage     **res ));
 538
 539 LDAP_F int ldap_add LDAP_P(( LDAP *ld, char *dn, LDAPMod **attrs ));
 540 LDAP_F int ldap_add_s LDAP_P(( LDAP *ld, char *dn, LDAPMod **attrs ));
 541
 542
 543 /*
 544  * in saslbind.c:
 545  */
 546 LDAP_F int ldap_sasl_bind LDAP_P((
 547         LDAP                    *ld,
 548         char                    *dn,
 549         char                    *mechanism,
 550         struct berval *cred,
 551         LDAPControl             **serverctrls,
 552         LDAPControl             **clientctrls,
 553         int                             msgidp ));
 554
 555 LDAP_F int ldap_sasl_bind_s LDAP_P((
 556         LDAP                    *ld,
 557         char                    *dn,
 558         char                    *mechanism,
 559         struct berval   *cred,
 560         LDAPControl             **serverctrls,
 561         LDAPControl             **clientctrls,
 562         struct berval   **servercredp ));
 563
 564
 565 /*
 566  * in bind.c:
 567  *      (depreciated)
 568  */
 569 LDAP_F int ldap_bind LDAP_P(( LDAP *ld, char *who, char *passwd, int authmethod ));
 570 LDAP_F int ldap_bind_s LDAP_P(( LDAP *ld, char *who, char *cred, int method ));
 571 LDAP_F void ldap_set_rebind_proc LDAP_P(( LDAP *ld,
 572         int (*rebindproc) LDAP_P(( LDAP *ld, char **dnp, char **passwdp, int *authmethodp, int freeit ))
 573 ));
 574
 575
 576 /*
 577  * in sbind.c:
 578  */
 579 LDAP_F int ldap_simple_bind LDAP_P(( LDAP *ld, char *who, char *passwd ));
 580 LDAP_F int ldap_simple_bind_s LDAP_P(( LDAP *ld, char *who, char *passwd ));
 581
 582
 583 /*
 584  * in kbind.c:
 585  *      (depreciated)
 586  */
 587 LDAP_F int ldap_kerberos_bind_s LDAP_P(( LDAP *ld, char *who ));
 588 LDAP_F int ldap_kerberos_bind1 LDAP_P(( LDAP *ld, char *who ));
 589 LDAP_F int ldap_kerberos_bind1_s LDAP_P(( LDAP *ld, char *who ));
 590 LDAP_F int ldap_kerberos_bind2 LDAP_P(( LDAP *ld, char *who ));
 591 LDAP_F int ldap_kerberos_bind2_s LDAP_P(( LDAP *ld, char *who ));
 592
 593
 594 /*
 595  * in cache.c
 596  */
 597 LDAP_F int ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, long maxmem ));
 598 LDAP_F void ldap_disable_cache LDAP_P(( LDAP *ld ));
 599 LDAP_F void ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
 600 LDAP_F void ldap_destroy_cache LDAP_P(( LDAP *ld ));
 601 LDAP_F void ldap_flush_cache LDAP_P(( LDAP *ld ));
 602 LDAP_F void ldap_uncache_entry LDAP_P(( LDAP *ld, char *dn ));
 603 LDAP_F void ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
 604
 605
 606 /*
 607  * in compare.c:
 608  */
 609 LDAP_F int ldap_compare_ext LDAP_P((
 610         LDAP                    *ld,
 611         char                    *dn,
 612         char                    *attr,
 613         struct berval   *bvalue,
 614         LDAPControl             **serverctrls,
 615         LDAPControl             **clientctrls,
 616         int                     *msgidp ));
 617
 618 LDAP_F int ldap_compare_ext_s LDAP_P((
 619         LDAP                    *ld,
 620         char                    *dn,
 621         char                    *attr,
 622         struct berval   *bvalue,
 623         LDAPControl             **serverctrls,
 624         LDAPControl             **clientctrls,
 625         LDAPMessage     **res ));
 626
 627 LDAP_F int ldap_compare LDAP_P(( LDAP *ld, char *dn, char *attr, char *value ));
 628 LDAP_F int ldap_compare_s LDAP_P(( LDAP *ld, char *dn, char *attr, char *value ));
 629
 630
 631 /*
 632  * in delete.c:
 633  */
 634 LDAP_F int ldap_delete_ext LDAP_P((
 635         LDAP                    *ld,
 636         char                    *dn,
 637         LDAPControl             **serverctrls,
 638         LDAPControl             **clientctrls,
 639         int                     *msgidp ));
 640
 641 LDAP_F int ldap_delete_ext_s LDAP_P((
 642         LDAP                    *ld,
 643         char                    *dn,
 644         LDAPControl             **serverctrls,
 645         LDAPControl             **clientctrls,
 646         LDAPMessage     **res ));
 647
 648 LDAP_F int ldap_delete LDAP_P(( LDAP *ld, char *dn ));
 649 LDAP_F int ldap_delete_s LDAP_P(( LDAP *ld, char *dn ));
 650
 651
 652 /*
 653  * in error.c:
 654  */
 655 LDAP_F int ldap_result2error LDAP_P(( LDAP *ld, LDAPMessage *r, int freeit ));
 656 LDAP_F char *ldap_err2string LDAP_P(( int err ));
 657 LDAP_F void ldap_perror LDAP_P(( LDAP *ld, char *s ));
 658
 659
 660 /*
 661  * in modify.c:
 662  */
 663 LDAP_F int ldap_modify_ext LDAP_P((
 664         LDAP                    *ld,
 665         char                    *dn,
 666         LDAPMod                 **mods,
 667         LDAPControl             **serverctrls,
 668         LDAPControl             **clientctrls,
 669         int                     *msgidp ));
 670
 671 LDAP_F int ldap_modify_ext_s LDAP_P((
 672         LDAP                    *ld,
 673         char                    *dn,
 674         LDAPMod                 **mods,
 675         LDAPControl             **serverctrls,
 676         LDAPControl             **clientctrls,
 677         LDAPMessage     **res ));
 678
 679 LDAP_F int ldap_modify LDAP_P(( LDAP *ld, char *dn, LDAPMod **mods ));
 680 LDAP_F int ldap_modify_s LDAP_P(( LDAP *ld, char *dn, LDAPMod **mods ));
 681
 682
 683 /*
 684  * in rename.c:
 685  */
 686 LDAP_F int ldap_rename_ext LDAP_P((
 687         LDAP                    *ld,
 688         char                    *dn,
 689         char                    *newrdn,
 690         char                    *newparent,
 691         int                             deleteoldrdn,
 692         LDAPControl             **serverctrls,
 693         LDAPControl             **clientctrls,
 694         int                     *msgidp ));
 695
 696 LDAP_F int ldap_rename_ext_s LDAP_P((
 697         LDAP                    *ld,
 698         char                    *dn,
 699         char                    *newrdn,
 700         char                    *newparent,
 701         int                             deleteoldrdn,
 702         LDAPControl             **serverctrls,
 703         LDAPControl             **clientctrls,
 704         LDAPMessage     **res ));
 705
 706
 707 /*
 708  * in modrdn.c:
 709  */
 710 LDAP_F int ldap_modrdn LDAP_P(( LDAP *ld, char *dn, char *newrdn ));
 711 LDAP_F int ldap_modrdn_s LDAP_P(( LDAP *ld, char *dn, char *newrdn ));
 712 LDAP_F int ldap_modrdn2 LDAP_P(( LDAP *ld, char *dn, char *newrdn,
 713         int deleteoldrdn ));
 714 LDAP_F int ldap_modrdn2_s LDAP_P(( LDAP *ld, char *dn, char *newrdn,
 715         int deleteoldrdn));
 716
 717
 718 /*
 719  * in open.c:
 720  */
 721 LDAP_F LDAP *ldap_open LDAP_P(( char *host, int port ));
 722 LDAP_F LDAP *ldap_init LDAP_P(( char *host, int port ));
 723
 724
 725 /*
 726  * in messages.c:
 727  */
 728 LDAP_F LDAPMessage *ldap_first_message LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 729 LDAP_F LDAPMessage *ldap_next_message LDAP_P(( LDAP *ld, LDAPMessage *msg ));
 730 LDAP_F int ldap_count_messages LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 731
 732
 733 /*
 734  * in references.c:
 735  */
 736 LDAP_F LDAPMessage *ldap_first_reference LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 737 LDAP_F LDAPMessage *ldap_next_reference LDAP_P(( LDAP *ld, LDAPMessage *ref ));
 738 LDAP_F int ldap_count_reference LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 739 LDAP_F int ldap_parse_reference LDAP_P((
 740         LDAP                    *ld,
 741         LDAPMessage             *ref,
 742         char                    ***referralsp,
 743         LDAPControl             ***serverctrls,
 744         int                             freeit));
 745
 746
 747 /*
 748  * in getentry.c:
 749  */
 750 LDAP_F LDAPMessage *ldap_first_entry LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 751 LDAP_F LDAPMessage *ldap_next_entry LDAP_P(( LDAP *ld, LDAPMessage *entry ));
 752 LDAP_F int ldap_count_entries LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 753 LDAP_F int ldap_get_entry_controls LDAP_P((
 754         LDAP                    *ld,
 755         LDAPMessage             *entry,
 756         LDAPControl             ***serverctrls));
 757
 758
 759 /*
 760  * in addentry.c
 761  */
 762 LDAP_F LDAPMessage *ldap_delete_result_entry LDAP_P(( LDAPMessage **list,
 763         LDAPMessage *e ));
 764 LDAP_F void ldap_add_result_entry LDAP_P(( LDAPMessage **list, LDAPMessage *e ));
 765
 766
 767 /*
 768  * in getdn.c
 769  */
 770 LDAP_F char *ldap_get_dn LDAP_P(( LDAP *ld, LDAPMessage *entry ));
 771 LDAP_F char *ldap_dn2ufn LDAP_P(( char *dn ));
 772 LDAP_F char **ldap_explode_dn LDAP_P(( char *dn, int notypes ));
 773 LDAP_F char **ldap_explode_rdn LDAP_P(( char *rdn, int notypes ));
 774 LDAP_F char **ldap_explode_dns LDAP_P(( char *dn ));
 775 LDAP_F int ldap_is_dns_dn LDAP_P(( char *dn ));
 776
 777
 778 /*
 779  * in getattr.c
 780  */
 781 LDAP_F char *ldap_first_attribute LDAP_P(( LDAP *ld, LDAPMessage *entry,
 782         BerElement **ber ));
 783 LDAP_F char *ldap_next_attribute LDAP_P(( LDAP *ld, LDAPMessage *entry,
 784         BerElement *ber ));
 785
 786
 787 /*
 788  * in getvalues.c
 789  */
 790 LDAP_F char **ldap_get_values LDAP_P(( LDAP *ld, LDAPMessage *entry, char *target ));
 791 LDAP_F struct berval **ldap_get_values_len LDAP_P(( LDAP *ld, LDAPMessage *entry,
 792         char *target ));
 793 LDAP_F int ldap_count_values LDAP_P(( char **vals ));
 794 LDAP_F int ldap_count_values_len LDAP_P(( struct berval **vals ));
 795 LDAP_F void ldap_value_free LDAP_P(( char **vals ));
 796 LDAP_F void ldap_value_free_len LDAP_P(( struct berval **vals ));
 797
 798
 799 /*
 800  * in result.c:
 801  */
 802 LDAP_F int ldap_result LDAP_P(( LDAP *ld, int msgid, int all,
 803         struct timeval *timeout, LDAPMessage **result ));
 804 LDAP_F int ldap_msgtype LDAP_P(( LDAPMessage *lm ));
 805 LDAP_F int ldap_msgid   LDAP_P(( LDAPMessage *lm ));
 806 LDAP_F int ldap_msgfree LDAP_P(( LDAPMessage *lm ));
 807 LDAP_F int ldap_msgdelete LDAP_P(( LDAP *ld, int msgid ));
 808
 809
 810 /*
 811  * in search.c:
 812  */
 813 LDAP_F int ldap_search_ext LDAP_P((
 814         LDAP                    *ld,
 815         char                    *base,
 816         int                             scope,
 817         char                    *filter,
 818         char                    **attrs,
 819         LDAPControl             **serverctrls,
 820         LDAPControl             **clientctrls,
 821         struct timeval  *timeout,
 822         int                             sizelimit,
 823         int                             *msgidp ));
 824
 825 LDAP_F int ldap_search_ext_s LDAP_P((
 826         LDAP                    *ld,
 827         char                    *base,
 828         int                             scope,
 829         char                    *filter,
 830         char                    **attrs,
 831         LDAPControl             **serverctrls,
 832         LDAPControl             **clientctrls,
 833         struct timeval  *timeout,
 834         int                             sizelimit,
 835         LDAPMessage             **res ));
 836
 837 LDAP_F int ldap_search LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 838         char **attrs, int attrsonly ));
 839 LDAP_F int ldap_search_s LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 840         char **attrs, int attrsonly, LDAPMessage **res ));
 841 LDAP_F int ldap_search_st LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 842     char **attrs, int attrsonly, struct timeval *timeout, LDAPMessage **res ));
 843
 844
 845 /*
 846  * in ufn.c
 847  */
 848 LDAP_F int ldap_ufn_search_c LDAP_P(( LDAP *ld, char *ufn, char **attrs,
 849         int attrsonly, LDAPMessage **res, int (*cancelproc)( void *cl ),
 850         void *cancelparm ));
 851 LDAP_F int ldap_ufn_search_ct LDAP_P(( LDAP *ld, char *ufn, char **attrs,
 852         int attrsonly, LDAPMessage **res, int (*cancelproc)( void *cl ),
 853         void *cancelparm, char *tag1, char *tag2, char *tag3 ));
 854 LDAP_F int ldap_ufn_search_s LDAP_P(( LDAP *ld, char *ufn, char **attrs,
 855         int attrsonly, LDAPMessage **res ));
 856 LDAP_F LDAPFiltDesc *ldap_ufn_setfilter LDAP_P(( LDAP *ld, char *fname ));
 857 LDAP_F void ldap_ufn_setprefix LDAP_P(( LDAP *ld, char *prefix ));
 858 LDAP_F int ldap_ufn_timeout LDAP_P(( void *tvparam ));
 859
 860
 861 /*
 862  * in unbind.c
 863  */
 864 LDAP_F int ldap_unbind LDAP_P(( LDAP *ld ));
 865 LDAP_F int ldap_unbind_s LDAP_P(( LDAP *ld ));
 866
 867
 868 /*
 869  * in getfilter.c
 870  */
 871 LDAP_F LDAPFiltDesc *ldap_init_getfilter LDAP_P(( char *fname ));
 872 LDAP_F LDAPFiltDesc *ldap_init_getfilter_buf LDAP_P(( char *buf, long buflen ));
 873 LDAP_F LDAPFiltInfo *ldap_getfirstfilter LDAP_P(( LDAPFiltDesc *lfdp, char *tagpat,
 874         char *value ));
 875 LDAP_F LDAPFiltInfo *ldap_getnextfilter LDAP_P(( LDAPFiltDesc *lfdp ));
 876 LDAP_F void ldap_setfilteraffixes LDAP_P(( LDAPFiltDesc *lfdp, char *prefix, char *suffix ));
 877 LDAP_F void ldap_build_filter LDAP_P(( char *buf, unsigned long buflen,
 878         char *pattern, char *prefix, char *suffix, char *attr,
 879         char *value, char **valwords ));
 880
 881
 882 /*
 883  * in free.c
 884  */
 885 LDAP_F void ldap_memfree LDAP_P(( void *p ));
 886 LDAP_F void ldap_getfilter_free LDAP_P(( LDAPFiltDesc *lfdp ));
 887 LDAP_F void ldap_mods_free LDAP_P(( LDAPMod **mods, int freemods ));
 888
 889
 890 /*
 891  * in friendly.c
 892  */
 893 LDAP_F char *ldap_friendly_name LDAP_P(( char *filename, char *uname,
 894         LDAPFriendlyMap **map ));
 895 LDAP_F void ldap_free_friendlymap LDAP_P(( LDAPFriendlyMap **map ));
 896
 897
 898 /*
 899  * in cldap.c
 900  */
 901 LDAP_F LDAP *cldap_open LDAP_P(( char *host, int port ));
 902 LDAP_F void cldap_close LDAP_P(( LDAP *ld ));
 903 LDAP_F int cldap_search_s LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 904         char **attrs, int attrsonly, LDAPMessage **res, char *logdn ));
 905 LDAP_F void cldap_setretryinfo LDAP_P(( LDAP *ld, int tries, int timeout ));
 906
 907
 908 /*
 909  * in sort.c
 910  */
 911 LDAP_F int ldap_sort_entries LDAP_P(( LDAP *ld,
 912         LDAPMessage **chain, char *attr,
 913         int (*cmp) (const char *, const char *) ));
 914 LDAP_F int ldap_sort_values LDAP_P(( LDAP *ld,
 915         char **vals, int (*cmp) (const void *, const void *) ));
 916 LDAP_F int ldap_sort_strcasecmp LDAP_P(( const void *a, const void *b ));
 917
 918
 919 /*
 920  * in url.c
 921  */
 922 LDAP_F int ldap_is_ldap_url LDAP_P(( char *url ));
 923 LDAP_F int ldap_url_parse LDAP_P(( char *url, LDAPURLDesc **ludpp ));
 924 LDAP_F void ldap_free_urldesc LDAP_P(( LDAPURLDesc *ludp ));
 925 LDAP_F int ldap_url_search LDAP_P(( LDAP *ld, char *url, int attrsonly ));
 926 LDAP_F int ldap_url_search_s LDAP_P(( LDAP *ld, char *url, int attrsonly,
 927         LDAPMessage **res ));
 928 LDAP_F int ldap_url_search_st LDAP_P(( LDAP *ld, char *url, int attrsonly,
 929         struct timeval *timeout, LDAPMessage **res ));
 930
 931
 932 /*
 933  * in charset.c
 934  */
 935 LDAP_F void ldap_set_string_translators LDAP_P(( LDAP *ld,
 936         BERTranslateProc encode_proc, BERTranslateProc decode_proc ));
 937 LDAP_F int ldap_translate_from_t61 LDAP_P(( LDAP *ld, char **bufp,
 938         unsigned long *lenp, int free_input ));
 939 LDAP_F int ldap_translate_to_t61 LDAP_P(( LDAP *ld, char **bufp,
 940         unsigned long *lenp, int free_input ));
 941 LDAP_F void ldap_enable_translation LDAP_P(( LDAP *ld, LDAPMessage *entry,
 942         int enable ));
 943
 944 LDAP_F int ldap_t61_to_8859 LDAP_P(( char **bufp, unsigned long *buflenp,
 945         int free_input ));
 946 LDAP_F int ldap_8859_to_t61 LDAP_P(( char **bufp, unsigned long *buflenp,
 947         int free_input ));
 948
 949 LDAP_END_DECL
 950
 951 #endif /* _LDAP_H */