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

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