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