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