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_PORT       389
  30 #define LDAP_VERSION1   1
  31 #define LDAP_VERSION2   2
  32 #define LDAP_VERSION3   3
  33 #define LDAP_VERSION    LDAP_VERSION2
  34
  35 #define LDAP_COMPAT20
  36 #define LDAP_COMPAT30
  37 #if defined(LDAP_COMPAT20) || defined(LDAP_COMPAT30)
  38 #define LDAP_COMPAT
  39 #endif
  40
  41 #define LDAP_MAX_ATTR_LEN       100
  42
  43 /* debugging stuff */
  44 #ifdef LDAP_DEBUG
  45 extern int      ldap_debug;
  46 #ifdef LDAP_SYSLOG
  47 extern int      ldap_syslog;
  48 extern int      ldap_syslog_level;
  49 #endif /* LDAP_SYSLOG */
  50
  51 #define LDAP_DEBUG_TRACE        0x001
  52 #define LDAP_DEBUG_PACKETS      0x002
  53 #define LDAP_DEBUG_ARGS         0x004
  54 #define LDAP_DEBUG_CONNS        0x008
  55 #define LDAP_DEBUG_BER          0x010
  56 #define LDAP_DEBUG_FILTER       0x020
  57 #define LDAP_DEBUG_CONFIG       0x040
  58 #define LDAP_DEBUG_ACL          0x080
  59 #define LDAP_DEBUG_STATS        0x100
  60 #define LDAP_DEBUG_STATS2       0x200
  61 #define LDAP_DEBUG_SHELL        0x400
  62 #define LDAP_DEBUG_PARSE        0x800
  63 #define LDAP_DEBUG_ANY          0xffff
  64
  65 /* this doesn't below as part of ldap.h */
  66 #ifdef LDAP_SYSLOG
  67 #define Debug( level, fmt, arg1, arg2, arg3 )   \
  68         { \
  69                 if ( ldap_debug & (level) ) \
  70                         fprintf( stderr, (fmt), (arg1), (arg2), (arg3) ); \
  71                 if ( ldap_syslog & level ) \
  72                         syslog( ldap_syslog_level, (fmt), (arg1), (arg2), (arg3) ); \
  73         }
  74 #else /* LDAP_SYSLOG */
  75 #ifndef WINSOCK
  76 #define Debug( level, fmt, arg1, arg2, arg3 ) \
  77                 if ( ldap_debug & (level) ) \
  78                         fprintf( stderr, (fmt), (arg1), (arg2), (arg3) );
  79 #else /* !WINSOCK */
  80 extern void Debug( int level, char* fmt, ... );
  81 #endif /* !WINSOCK */
  82 #endif /* LDAP_SYSLOG */
  83 #else /* LDAP_DEBUG */
  84 #define Debug( level, fmt, arg1, arg2, arg3 )
  85 #endif /* LDAP_DEBUG */
  86
  87 /*
  88  * specific LDAP instantiations of BER types we know about
  89  */
  90
  91 /* general stuff */
  92 #define LDAP_TAG_MESSAGE        0x30L   /* tag is 16 + constructed bit */
  93 #define OLD_LDAP_TAG_MESSAGE    0x10L   /* forgot the constructed bit  */
  94 #define LDAP_TAG_MSGID          0x02L
  95
  96 /* possible operations a client can invoke */
  97 #define LDAP_REQ_BIND                   0x60L   /* application + constructed */
  98 #define LDAP_REQ_UNBIND                 0x42L   /* application + primitive   */
  99 #define LDAP_REQ_SEARCH                 0x63L   /* application + constructed */
 100 #define LDAP_REQ_MODIFY                 0x66L   /* application + constructed */
 101 #define LDAP_REQ_ADD                    0x68L   /* application + constructed */
 102 #define LDAP_REQ_DELETE                 0x4aL   /* application + primitive   */
 103 #define LDAP_REQ_MODRDN                 0x6cL   /* application + constructed */
 104 #define LDAP_REQ_COMPARE                0x6eL   /* application + constructed */
 105 #define LDAP_REQ_ABANDON                0x50L   /* application + primitive   */
 106
 107 /* version 3.0 compatibility stuff */
 108 #define LDAP_REQ_UNBIND_30              0x62L
 109 #define LDAP_REQ_DELETE_30              0x6aL
 110 #define LDAP_REQ_ABANDON_30             0x70L
 111
 112 /*
 113  * old broken stuff for backwards compatibility - forgot application tag
 114  * and constructed/primitive bit
 115  */
 116 #define OLD_LDAP_REQ_BIND               0x00L
 117 #define OLD_LDAP_REQ_UNBIND             0x02L
 118 #define OLD_LDAP_REQ_SEARCH             0x03L
 119 #define OLD_LDAP_REQ_MODIFY             0x06L
 120 #define OLD_LDAP_REQ_ADD                0x08L
 121 #define OLD_LDAP_REQ_DELETE             0x0aL
 122 #define OLD_LDAP_REQ_MODRDN             0x0cL
 123 #define OLD_LDAP_REQ_COMPARE            0x0eL
 124 #define OLD_LDAP_REQ_ABANDON            0x10L
 125
 126 /* possible result types a server can return */
 127 #define LDAP_RES_BIND                   0x61L   /* application + constructed */
 128 #define LDAP_RES_SEARCH_ENTRY           0x64L   /* application + constructed */
 129 #define LDAP_RES_SEARCH_RESULT          0x65L   /* application + constructed */
 130 #define LDAP_RES_MODIFY                 0x67L   /* application + constructed */
 131 #define LDAP_RES_ADD                    0x69L   /* application + constructed */
 132 #define LDAP_RES_DELETE                 0x6bL   /* application + constructed */
 133 #define LDAP_RES_MODRDN                 0x6dL   /* application + constructed */
 134 #define LDAP_RES_COMPARE                0x6fL   /* application + constructed */
 135 #define LDAP_RES_ANY                    (-1L)
 136
 137 /* old broken stuff for backwards compatibility */
 138 #define OLD_LDAP_RES_BIND               0x01L
 139 #define OLD_LDAP_RES_SEARCH_ENTRY       0x04L
 140 #define OLD_LDAP_RES_SEARCH_RESULT      0x05L
 141 #define OLD_LDAP_RES_MODIFY             0x07L
 142 #define OLD_LDAP_RES_ADD                0x09L
 143 #define OLD_LDAP_RES_DELETE             0x0bL
 144 #define OLD_LDAP_RES_MODRDN             0x0dL
 145 #define OLD_LDAP_RES_COMPARE            0x0fL
 146
 147 /* authentication methods available */
 148 #define LDAP_AUTH_NONE          0x00L   /* no authentication              */
 149 #define LDAP_AUTH_SIMPLE        0x80L   /* context specific + primitive   */
 150 #define LDAP_AUTH_KRBV4         0xffL   /* means do both of the following */
 151 #define LDAP_AUTH_KRBV41        0x81L   /* context specific + primitive   */
 152 #define LDAP_AUTH_KRBV42        0x82L   /* context specific + primitive   */
 153
 154 /* 3.0 compatibility auth methods */
 155 #define LDAP_AUTH_SIMPLE_30     0xa0L   /* context specific + constructed */
 156 #define LDAP_AUTH_KRBV41_30     0xa1L   /* context specific + constructed */
 157 #define LDAP_AUTH_KRBV42_30     0xa2L   /* context specific + constructed */
 158
 159 /* old broken stuff */
 160 #define OLD_LDAP_AUTH_SIMPLE    0x00L
 161 #define OLD_LDAP_AUTH_KRBV4     0x01L
 162 #define OLD_LDAP_AUTH_KRBV42    0x02L
 163
 164 /* filter types */
 165 #define LDAP_FILTER_AND         0xa0L   /* context specific + constructed */
 166 #define LDAP_FILTER_OR          0xa1L   /* context specific + constructed */
 167 #define LDAP_FILTER_NOT         0xa2L   /* context specific + constructed */
 168 #define LDAP_FILTER_EQUALITY    0xa3L   /* context specific + constructed */
 169 #define LDAP_FILTER_SUBSTRINGS  0xa4L   /* context specific + constructed */
 170 #define LDAP_FILTER_GE          0xa5L   /* context specific + constructed */
 171 #define LDAP_FILTER_LE          0xa6L   /* context specific + constructed */
 172 #define LDAP_FILTER_PRESENT     0x87L   /* context specific + primitive   */
 173 #define LDAP_FILTER_APPROX      0xa8L   /* context specific + constructed */
 174
 175 /* 3.0 compatibility filter types */
 176 #define LDAP_FILTER_PRESENT_30  0xa7L   /* context specific + constructed */
 177
 178 /* old broken stuff */
 179 #define OLD_LDAP_FILTER_AND             0x00L
 180 #define OLD_LDAP_FILTER_OR              0x01L
 181 #define OLD_LDAP_FILTER_NOT             0x02L
 182 #define OLD_LDAP_FILTER_EQUALITY        0x03L
 183 #define OLD_LDAP_FILTER_SUBSTRINGS      0x04L
 184 #define OLD_LDAP_FILTER_GE              0x05L
 185 #define OLD_LDAP_FILTER_LE              0x06L
 186 #define OLD_LDAP_FILTER_PRESENT         0x07L
 187 #define OLD_LDAP_FILTER_APPROX          0x08L
 188
 189 /* substring filter component types */
 190 #define LDAP_SUBSTRING_INITIAL  0x80L   /* context specific */
 191 #define LDAP_SUBSTRING_ANY      0x81L   /* context specific */
 192 #define LDAP_SUBSTRING_FINAL    0x82L   /* context specific */
 193
 194 /* 3.0 compatibility substring filter component types */
 195 #define LDAP_SUBSTRING_INITIAL_30       0xa0L   /* context specific */
 196 #define LDAP_SUBSTRING_ANY_30           0xa1L   /* context specific */
 197 #define LDAP_SUBSTRING_FINAL_30         0xa2L   /* context specific */
 198
 199 /* old broken stuff */
 200 #define OLD_LDAP_SUBSTRING_INITIAL      0x00L
 201 #define OLD_LDAP_SUBSTRING_ANY          0x01L
 202 #define OLD_LDAP_SUBSTRING_FINAL        0x02L
 203
 204 /* search scopes */
 205 #define LDAP_SCOPE_BASE         0x00
 206 #define LDAP_SCOPE_ONELEVEL     0x01
 207 #define LDAP_SCOPE_SUBTREE      0x02
 208
 209 /* for modifications */
 210 typedef struct ldapmod {
 211         int             mod_op;
 212 #define LDAP_MOD_ADD            0x00
 213 #define LDAP_MOD_DELETE         0x01
 214 #define LDAP_MOD_REPLACE        0x02
 215 #define LDAP_MOD_BVALUES        0x80
 216         char            *mod_type;
 217         union {
 218                 char            **modv_strvals;
 219                 struct berval   **modv_bvals;
 220         } mod_vals;
 221 #define mod_values      mod_vals.modv_strvals
 222 #define mod_bvalues     mod_vals.modv_bvals
 223         struct ldapmod  *mod_next;
 224 } LDAPMod;
 225
 226 /*
 227  * possible error codes we can return
 228  */
 229
 230 #define LDAP_SUCCESS                    0x00
 231 #define LDAP_OPERATIONS_ERROR           0x01
 232 #define LDAP_PROTOCOL_ERROR             0x02
 233 #define LDAP_TIMELIMIT_EXCEEDED         0x03
 234 #define LDAP_SIZELIMIT_EXCEEDED         0x04
 235 #define LDAP_COMPARE_FALSE              0x05
 236 #define LDAP_COMPARE_TRUE               0x06
 237 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  0x07
 238 #define LDAP_STRONG_AUTH_REQUIRED       0x08
 239 #define LDAP_PARTIAL_RESULTS            0x09
 240
 241 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
 242 #define LDAP_UNDEFINED_TYPE             0x11
 243 #define LDAP_INAPPROPRIATE_MATCHING     0x12
 244 #define LDAP_CONSTRAINT_VIOLATION       0x13
 245 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
 246 #define LDAP_INVALID_SYNTAX             0x15
 247
 248 #define LDAP_NO_SUCH_OBJECT             0x20
 249 #define LDAP_ALIAS_PROBLEM              0x21
 250 #define LDAP_INVALID_DN_SYNTAX          0x22
 251 #define LDAP_IS_LEAF                    0x23
 252 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
 253
 254 #define NAME_ERROR(n)   ((n & 0xf0) == 0x20)
 255
 256 #define LDAP_INAPPROPRIATE_AUTH         0x30
 257 #define LDAP_INVALID_CREDENTIALS        0x31
 258 #define LDAP_INSUFFICIENT_ACCESS        0x32
 259 #define LDAP_BUSY                       0x33
 260 #define LDAP_UNAVAILABLE                0x34
 261 #define LDAP_UNWILLING_TO_PERFORM       0x35
 262 #define LDAP_LOOP_DETECT                0x36
 263
 264 #define LDAP_NAMING_VIOLATION           0x40
 265 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
 266 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
 267 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
 268 #define LDAP_ALREADY_EXISTS             0x44
 269 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
 270 #define LDAP_RESULTS_TOO_LARGE          0x46
 271
 272 #define LDAP_OTHER                      0x50
 273 #define LDAP_SERVER_DOWN                0x51
 274 #define LDAP_LOCAL_ERROR                0x52
 275 #define LDAP_ENCODING_ERROR             0x53
 276 #define LDAP_DECODING_ERROR             0x54
 277 #define LDAP_TIMEOUT                    0x55
 278 #define LDAP_AUTH_UNKNOWN               0x56
 279 #define LDAP_FILTER_ERROR               0x57
 280 #define LDAP_USER_CANCELLED             0x58
 281 #define LDAP_PARAM_ERROR                0x59
 282 #define LDAP_NO_MEMORY                  0x5a
 283
 284
 285 /* default limit on nesting of referrals */
 286 #define LDAP_DEFAULT_REFHOPLIMIT        5
 287
 288 /*
 289  * This structure represents both ldap messages and ldap responses.
 290  * These are really the same, except in the case of search responses,
 291  * where a response has multiple messages.
 292  */
 293
 294 typedef struct ldapmsg {
 295         int             lm_msgid;       /* the message id */
 296         int             lm_msgtype;     /* the message type */
 297         BerElement      *lm_ber;        /* the ber encoded message contents */
 298         struct ldapmsg  *lm_chain;      /* for search - next msg in the resp */
 299         struct ldapmsg  *lm_next;       /* next response */
 300         unsigned int    lm_time;        /* used to maintain cache */
 301 } LDAPMessage;
 302 #define NULLMSG ((LDAPMessage *) NULL)
 303
 304
 305 #ifdef LDAP_REFERRALS
 306 /*
 307  * structure for tracking LDAP server host, ports, DNs, etc.
 308  */
 309 typedef struct ldap_server {
 310         char                    *lsrv_host;
 311         char                    *lsrv_dn;       /* if NULL, use default */
 312         int                     lsrv_port;
 313         struct ldap_server      *lsrv_next;
 314 } LDAPServer;
 315
 316
 317 /*
 318  * structure for representing an LDAP server connection
 319  */
 320 typedef struct ldap_conn {
 321         Sockbuf                 *lconn_sb;
 322         int                     lconn_refcnt;
 323         time_t          lconn_lastused; /* time */
 324         int                     lconn_status;
 325 #define LDAP_CONNST_NEEDSOCKET          1
 326 #define LDAP_CONNST_CONNECTING          2
 327 #define LDAP_CONNST_CONNECTED           3
 328         LDAPServer              *lconn_server;
 329         char                    *lconn_krbinstance;
 330         struct ldap_conn        *lconn_next;
 331 } LDAPConn;
 332
 333
 334 /*
 335  * structure used to track outstanding requests
 336  */
 337 typedef struct ldapreq {
 338         int             lr_msgid;       /* the message id */
 339         int             lr_status;      /* status of request */
 340 #define LDAP_REQST_INPROGRESS   1
 341 #define LDAP_REQST_CHASINGREFS  2
 342 #define LDAP_REQST_NOTCONNECTED 3
 343 #define LDAP_REQST_WRITING      4
 344         int             lr_outrefcnt;   /* count of outstanding referrals */
 345         int             lr_origid;      /* original request's message id */
 346         int             lr_parentcnt;   /* count of parent requests */
 347         int             lr_res_msgtype; /* result message type */
 348         int             lr_res_errno;   /* result LDAP errno */
 349         char            *lr_res_error;  /* result error string */
 350         char            *lr_res_matched;/* result matched DN string */
 351         BerElement      *lr_ber;        /* ber encoded request contents */
 352         LDAPConn        *lr_conn;       /* connection used to send request */
 353         struct ldapreq  *lr_parent;     /* request that spawned this referral */
 354         struct ldapreq  *lr_refnext;    /* next referral spawned */
 355         struct ldapreq  *lr_prev;       /* previous request */
 356         struct ldapreq  *lr_next;       /* next request */
 357 } LDAPRequest;
 358 #endif /* LDAP_REFERRALS */
 359
 360
 361 /*
 362  * structure for client cache
 363  */
 364 #define LDAP_CACHE_BUCKETS      31      /* cache hash table size */
 365 typedef struct ldapcache {
 366         LDAPMessage     *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
 367         LDAPMessage     *lc_requests;                   /* unfulfilled reqs */
 368         long            lc_timeout;                     /* request timeout */
 369         long            lc_maxmem;                      /* memory to use */
 370         long            lc_memused;                     /* memory in use */
 371         int             lc_enabled;                     /* enabled? */
 372         unsigned long   lc_options;                     /* options */
 373 #define LDAP_CACHE_OPT_CACHENOERRS      0x00000001
 374 #define LDAP_CACHE_OPT_CACHEALLERRS     0x00000002
 375 }  LDAPCache;
 376 #define NULLLDCACHE ((LDAPCache *)NULL)
 377
 378 /*
 379  * structures for ldap getfilter routines
 380  */
 381
 382 typedef struct ldap_filt_info {
 383         char                    *lfi_filter;
 384         char                    *lfi_desc;
 385         int                     lfi_scope;      /* LDAP_SCOPE_BASE, etc */
 386         int                     lfi_isexact;    /* exact match filter? */
 387         struct ldap_filt_info   *lfi_next;
 388 } LDAPFiltInfo;
 389
 390 typedef struct ldap_filt_list {
 391     char                        *lfl_tag;
 392     char                        *lfl_pattern;
 393     char                        *lfl_delims;
 394     LDAPFiltInfo                *lfl_ilist;
 395     struct ldap_filt_list       *lfl_next;
 396 } LDAPFiltList;
 397
 398
 399 #define LDAP_FILT_MAXSIZ        1024
 400
 401 typedef struct ldap_filt_desc {
 402         LDAPFiltList            *lfd_filtlist;
 403         LDAPFiltInfo            *lfd_curfip;
 404         LDAPFiltInfo            lfd_retfi;
 405         char                    lfd_filter[ LDAP_FILT_MAXSIZ ];
 406         char                    *lfd_curval;
 407         char                    *lfd_curvalcopy;
 408         char                    **lfd_curvalwords;
 409         char                    *lfd_filtprefix;
 410         char                    *lfd_filtsuffix;
 411 } LDAPFiltDesc;
 412
 413
 414 /*
 415  * structure representing an ldap connection
 416  */
 417
 418 typedef struct ldap {
 419         Sockbuf         ld_sb;          /* socket descriptor & buffer */
 420         char            *ld_host;
 421         int             ld_version;
 422         char            ld_lberoptions;
 423         int             ld_deref;
 424 #define LDAP_DEREF_NEVER        0
 425 #define LDAP_DEREF_SEARCHING    1
 426 #define LDAP_DEREF_FINDING      2
 427 #define LDAP_DEREF_ALWAYS       3
 428
 429         int             ld_timelimit;
 430         int             ld_sizelimit;
 431 #define LDAP_NO_LIMIT           0
 432
 433         LDAPFiltDesc    *ld_filtd;      /* from getfilter for ufn searches */
 434         char            *ld_ufnprefix;  /* for incomplete ufn's */
 435
 436         int             ld_errno;
 437         char            *ld_error;
 438         char            *ld_matched;
 439         int             ld_msgid;
 440
 441         /* do not mess with these */
 442 #ifdef LDAP_REFERRALS
 443         LDAPRequest     *ld_requests;   /* list of outstanding requests */
 444 #else /* LDAP_REFERRALS */
 445         LDAPMessage     *ld_requests;   /* list of outstanding requests */
 446 #endif /* LDAP_REFERRALS */
 447         LDAPMessage     *ld_responses;  /* list of outstanding responses */
 448         int             *ld_abandoned;  /* array of abandoned requests */
 449         char            ld_attrbuffer[LDAP_MAX_ATTR_LEN];
 450         LDAPCache       *ld_cache;      /* non-null if cache is initialized */
 451         char            *ld_cldapdn;    /* DN used in connectionless search */
 452
 453         /* it is OK to change these next four values directly */
 454         int             ld_cldaptries;  /* connectionless search retry count */
 455         int             ld_cldaptimeout;/* time between retries */
 456         int             ld_refhoplimit; /* limit on referral nesting */
 457         unsigned long   ld_options;     /* boolean options */
 458 #define LDAP_OPT_DNS            0x00000001      /* use DN & DNS */
 459 #define LDAP_OPT_REFERRALS      0x00000002      /* chase referrals */
 460 #define LDAP_OPT_RESTART        0x00000004      /* restart if EINTR occurs */
 461
 462         /* do not mess with the rest though */
 463         char            *ld_defhost;    /* full name of default server */
 464         int             ld_defport;     /* port of default server */
 465         BERTranslateProc ld_lber_encode_translate_proc;
 466         BERTranslateProc ld_lber_decode_translate_proc;
 467 #ifdef LDAP_REFERRALS
 468         LDAPConn        *ld_defconn;    /* default connection */
 469         LDAPConn        *ld_conns;      /* list of server connections */
 470         void            *ld_selectinfo; /* platform specifics for select */
 471         int             (*ld_rebindproc)( struct ldap *ld, char **dnp,
 472                                 char **passwdp, int *authmethodp, int freeit );
 473                                 /* routine to get info needed for re-bind */
 474 #endif /* LDAP_REFERRALS */
 475 } LDAP;
 476
 477
 478 /*
 479  * structure for ldap friendly mapping routines
 480  */
 481
 482 typedef struct friendly {
 483         char    *f_unfriendly;
 484         char    *f_friendly;
 485 } FriendlyMap;
 486
 487
 488 /*
 489  * handy macro to check whether LDAP struct is set up for CLDAP or not
 490  */
 491 #define LDAP_IS_CLDAP( ld )     ( (ld)->ld_sb.sb_naddr > 0 )
 492
 493
 494 /*
 495  * types for ldap URL handling
 496  */
 497 typedef struct ldap_url_desc {
 498     char        *lud_host;
 499     int         lud_port;
 500     char        *lud_dn;
 501     char        **lud_attrs;
 502     int         lud_scope;
 503     char        *lud_filter;
 504     char        *lud_string;    /* for internal use only */
 505 } LDAPURLDesc;
 506 #define NULLLDAPURLDESC ((LDAPURLDesc *)NULL)
 507
 508 #define LDAP_URL_ERR_NOTLDAP    1       /* URL doesn't begin with "ldap://" */
 509 #define LDAP_URL_ERR_NODN       2       /* URL has no DN (required) */
 510 #define LDAP_URL_ERR_BADSCOPE   3       /* URL scope string is invalid */
 511 #define LDAP_URL_ERR_MEM        4       /* can't allocate memory space */
 512
 513 /* avoid pulling in headers */
 514 struct timeval;
 515
 516 /*
 517  * in abandon.c:
 518  */
 519 LDAP_F int ldap_abandon LDAP_P(( LDAP *ld, int msgid ));
 520
 521 /*
 522  * in add.c:
 523  */
 524 LDAP_F int ldap_add LDAP_P(( LDAP *ld, char *dn, LDAPMod **attrs ));
 525 LDAP_F int ldap_add_s LDAP_P(( LDAP *ld, char *dn, LDAPMod **attrs ));
 526
 527 /*
 528  * in bind.c:
 529  */
 530 LDAP_F int ldap_bind LDAP_P(( LDAP *ld, char *who, char *passwd, int authmethod ));
 531 LDAP_F int ldap_bind_s LDAP_P(( LDAP *ld, char *who, char *cred, int method ));
 532 LDAP_F void ldap_set_rebind_proc LDAP_P(( LDAP *ld,
 533         int (*rebindproc) LDAP_P(( LDAP *ld, char **dnp, char **passwdp, int *authmethodp, int freeit ))
 534 ));
 535
 536 /*
 537  * in sbind.c:
 538  */
 539 LDAP_F int ldap_simple_bind LDAP_P(( LDAP *ld, char *who, char *passwd ));
 540 LDAP_F int ldap_simple_bind_s LDAP_P(( LDAP *ld, char *who, char *passwd ));
 541
 542 /*
 543  * in kbind.c:
 544  */
 545 LDAP_F int ldap_kerberos_bind_s LDAP_P(( LDAP *ld, char *who ));
 546 LDAP_F int ldap_kerberos_bind1 LDAP_P(( LDAP *ld, char *who ));
 547 LDAP_F int ldap_kerberos_bind1_s LDAP_P(( LDAP *ld, char *who ));
 548 LDAP_F int ldap_kerberos_bind2 LDAP_P(( LDAP *ld, char *who ));
 549 LDAP_F int ldap_kerberos_bind2_s LDAP_P(( LDAP *ld, char *who ));
 550
 551
 552 /*
 553  * in cache.c
 554  */
 555 LDAP_F int ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, long maxmem ));
 556 LDAP_F void ldap_disable_cache LDAP_P(( LDAP *ld ));
 557 LDAP_F void ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
 558 LDAP_F void ldap_destroy_cache LDAP_P(( LDAP *ld ));
 559 LDAP_F void ldap_flush_cache LDAP_P(( LDAP *ld ));
 560 LDAP_F void ldap_uncache_entry LDAP_P(( LDAP *ld, char *dn ));
 561 LDAP_F void ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
 562
 563 /*
 564  * in compare.c:
 565  */
 566 LDAP_F int ldap_compare LDAP_P(( LDAP *ld, char *dn, char *attr, char *value ));
 567 LDAP_F int ldap_compare_s LDAP_P(( LDAP *ld, char *dn, char *attr, char *value ));
 568
 569 /*
 570  * in delete.c:
 571  */
 572 LDAP_F int ldap_delete LDAP_P(( LDAP *ld, char *dn ));
 573 LDAP_F int ldap_delete_s LDAP_P(( LDAP *ld, char *dn ));
 574
 575 /*
 576  * in error.c:
 577  */
 578 LDAP_F int ldap_result2error LDAP_P(( LDAP *ld, LDAPMessage *r, int freeit ));
 579 LDAP_F char *ldap_err2string LDAP_P(( int err ));
 580 LDAP_F void ldap_perror LDAP_P(( LDAP *ld, char *s ));
 581
 582 /*
 583  * in modify.c:
 584  */
 585 LDAP_F int ldap_modify LDAP_P(( LDAP *ld, char *dn, LDAPMod **mods ));
 586 LDAP_F int ldap_modify_s LDAP_P(( LDAP *ld, char *dn, LDAPMod **mods ));
 587
 588 /*
 589  * in modrdn.c:
 590  */
 591 LDAP_F int ldap_modrdn LDAP_P(( LDAP *ld, char *dn, char *newrdn ));
 592 LDAP_F int ldap_modrdn_s LDAP_P(( LDAP *ld, char *dn, char *newrdn ));
 593 LDAP_F int ldap_modrdn2 LDAP_P(( LDAP *ld, char *dn, char *newrdn,
 594         int deleteoldrdn ));
 595 LDAP_F int ldap_modrdn2_s LDAP_P(( LDAP *ld, char *dn, char *newrdn,
 596         int deleteoldrdn));
 597
 598 /*
 599  * in open.c:
 600  */
 601 LDAP_F LDAP *ldap_open LDAP_P(( char *host, int port ));
 602 LDAP_F LDAP *ldap_init LDAP_P(( char *defhost, int defport ));
 603
 604 /*
 605  * in getentry.c:
 606  */
 607 LDAP_F LDAPMessage *ldap_first_entry LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 608 LDAP_F LDAPMessage *ldap_next_entry LDAP_P(( LDAP *ld, LDAPMessage *entry ));
 609 LDAP_F int ldap_count_entries LDAP_P(( LDAP *ld, LDAPMessage *chain ));
 610
 611 /*
 612  * in addentry.c
 613  */
 614 LDAP_F LDAPMessage *ldap_delete_result_entry LDAP_P(( LDAPMessage **list,
 615         LDAPMessage *e ));
 616 LDAP_F void ldap_add_result_entry LDAP_P(( LDAPMessage **list, LDAPMessage *e ));
 617
 618 /*
 619  * in getdn.c
 620  */
 621 LDAP_F char *ldap_get_dn LDAP_P(( LDAP *ld, LDAPMessage *entry ));
 622 LDAP_F char *ldap_dn2ufn LDAP_P(( char *dn ));
 623 LDAP_F char **ldap_explode_dn LDAP_P(( char *dn, int notypes ));
 624 LDAP_F char **ldap_explode_dns LDAP_P(( char *dn ));
 625 LDAP_F int ldap_is_dns_dn LDAP_P(( char *dn ));
 626
 627 /*
 628  * in getattr.c
 629  */
 630 LDAP_F char *ldap_first_attribute LDAP_P(( LDAP *ld, LDAPMessage *entry,
 631         BerElement **ber ));
 632 LDAP_F char *ldap_next_attribute LDAP_P(( LDAP *ld, LDAPMessage *entry,
 633         BerElement *ber ));
 634
 635 /*
 636  * in getvalues.c
 637  */
 638 LDAP_F char **ldap_get_values LDAP_P(( LDAP *ld, LDAPMessage *entry, char *target ));
 639 LDAP_F struct berval **ldap_get_values_len LDAP_P(( LDAP *ld, LDAPMessage *entry,
 640         char *target ));
 641 LDAP_F int ldap_count_values LDAP_P(( char **vals ));
 642 LDAP_F int ldap_count_values_len LDAP_P(( struct berval **vals ));
 643 LDAP_F void ldap_value_free LDAP_P(( char **vals ));
 644 LDAP_F void ldap_value_free_len LDAP_P(( struct berval **vals ));
 645
 646 /*
 647  * in result.c:
 648  */
 649 LDAP_F int ldap_result LDAP_P(( LDAP *ld, int msgid, int all,
 650         struct timeval *timeout, LDAPMessage **result ));
 651 LDAP_F int ldap_msgfree LDAP_P(( LDAPMessage *lm ));
 652 LDAP_F int ldap_msgdelete LDAP_P(( LDAP *ld, int msgid ));
 653
 654 /*
 655  * in search.c:
 656  */
 657 LDAP_F int ldap_search LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 658         char **attrs, int attrsonly ));
 659 LDAP_F int ldap_search_s LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 660         char **attrs, int attrsonly, LDAPMessage **res ));
 661 LDAP_F int ldap_search_st LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 662     char **attrs, int attrsonly, struct timeval *timeout, LDAPMessage **res ));
 663
 664 /*
 665  * in ufn.c
 666  */
 667 LDAP_F int ldap_ufn_search_c LDAP_P(( LDAP *ld, char *ufn, char **attrs,
 668         int attrsonly, LDAPMessage **res, int (*cancelproc)( void *cl ),
 669         void *cancelparm ));
 670 LDAP_F int ldap_ufn_search_ct LDAP_P(( LDAP *ld, char *ufn, char **attrs,
 671         int attrsonly, LDAPMessage **res, int (*cancelproc)( void *cl ),
 672         void *cancelparm, char *tag1, char *tag2, char *tag3 ));
 673 LDAP_F int ldap_ufn_search_s LDAP_P(( LDAP *ld, char *ufn, char **attrs,
 674         int attrsonly, LDAPMessage **res ));
 675 LDAP_F LDAPFiltDesc *ldap_ufn_setfilter LDAP_P(( LDAP *ld, char *fname ));
 676 LDAP_F void ldap_ufn_setprefix LDAP_P(( LDAP *ld, char *prefix ));
 677 LDAP_F int ldap_ufn_timeout LDAP_P(( void *tvparam ));
 678
 679
 680 /*
 681  * in unbind.c
 682  */
 683 LDAP_F int ldap_unbind LDAP_P(( LDAP *ld ));
 684 LDAP_F int ldap_unbind_s LDAP_P(( LDAP *ld ));
 685
 686
 687 /*
 688  * in getfilter.c
 689  */
 690 LDAP_F LDAPFiltDesc *ldap_init_getfilter LDAP_P(( char *fname ));
 691 LDAP_F LDAPFiltDesc *ldap_init_getfilter_buf LDAP_P(( char *buf, long buflen ));
 692 LDAP_F LDAPFiltInfo *ldap_getfirstfilter LDAP_P(( LDAPFiltDesc *lfdp, char *tagpat,
 693         char *value ));
 694 LDAP_F LDAPFiltInfo *ldap_getnextfilter LDAP_P(( LDAPFiltDesc *lfdp ));
 695 LDAP_F void ldap_setfilteraffixes LDAP_P(( LDAPFiltDesc *lfdp, char *prefix, char *suffix ));
 696 LDAP_F void ldap_build_filter LDAP_P(( char *buf, unsigned long buflen,
 697         char *pattern, char *prefix, char *suffix, char *attr,
 698         char *value, char **valwords ));
 699
 700 /*
 701  * in free.c
 702  */
 703 LDAP_F void ldap_getfilter_free LDAP_P(( LDAPFiltDesc *lfdp ));
 704 LDAP_F void ldap_mods_free LDAP_P(( LDAPMod **mods, int freemods ));
 705
 706 /*
 707  * in friendly.c
 708  */
 709 LDAP_F char *ldap_friendly_name LDAP_P(( char *filename, char *uname,
 710         FriendlyMap **map ));
 711 LDAP_F void ldap_free_friendlymap LDAP_P(( FriendlyMap **map ));
 712
 713
 714 /*
 715  * in cldap.c
 716  */
 717 LDAP_F LDAP *cldap_open LDAP_P(( char *host, int port ));
 718 LDAP_F void cldap_close LDAP_P(( LDAP *ld ));
 719 LDAP_F int cldap_search_s LDAP_P(( LDAP *ld, char *base, int scope, char *filter,
 720         char **attrs, int attrsonly, LDAPMessage **res, char *logdn ));
 721 LDAP_F void cldap_setretryinfo LDAP_P(( LDAP *ld, int tries, int timeout ));
 722
 723
 724 /*
 725  * in sort.c
 726  */
 727 LDAP_F int ldap_sort_entries LDAP_P(( LDAP *ld,
 728         LDAPMessage **chain, char *attr,
 729         int (*cmp) (const char *, const char *) ));
 730 LDAP_F int ldap_sort_values LDAP_P(( LDAP *ld,
 731         char **vals, int (*cmp) (const void *, const void *) ));
 732 LDAP_F int ldap_sort_strcasecmp LDAP_P(( const void *a, const void *b ));
 733
 734
 735 /*
 736  * in url.c
 737  */
 738 LDAP_F int ldap_is_ldap_url LDAP_P(( char *url ));
 739 LDAP_F int ldap_url_parse LDAP_P(( char *url, LDAPURLDesc **ludpp ));
 740 LDAP_F void ldap_free_urldesc LDAP_P(( LDAPURLDesc *ludp ));
 741 LDAP_F int ldap_url_search LDAP_P(( LDAP *ld, char *url, int attrsonly ));
 742 LDAP_F int ldap_url_search_s LDAP_P(( LDAP *ld, char *url, int attrsonly,
 743         LDAPMessage **res ));
 744 LDAP_F int ldap_url_search_st LDAP_P(( LDAP *ld, char *url, int attrsonly,
 745         struct timeval *timeout, LDAPMessage **res ));
 746
 747
 748 /*
 749  * in charset.c
 750  */
 751 LDAP_F void ldap_set_string_translators LDAP_P(( LDAP *ld,
 752         BERTranslateProc encode_proc, BERTranslateProc decode_proc ));
 753 LDAP_F int ldap_translate_from_t61 LDAP_P(( LDAP *ld, char **bufp,
 754         unsigned long *lenp, int free_input ));
 755 LDAP_F int ldap_translate_to_t61 LDAP_P(( LDAP *ld, char **bufp,
 756         unsigned long *lenp, int free_input ));
 757 LDAP_F void ldap_enable_translation LDAP_P(( LDAP *ld, LDAPMessage *entry,
 758         int enable ));
 759
 760 LDAP_F int ldap_t61_to_8859 LDAP_P(( char **bufp, unsigned long *buflenp,
 761         int free_input ));
 762 LDAP_F int ldap_8859_to_t61 LDAP_P(( char **bufp, unsigned long *buflenp,
 763         int free_input ));
 764
 765
 766 /*
 767  * in msdos/winsock/wsa.c
 768  */
 769 LDAP_F void ldap_memfree LDAP_P(( void *p ));
 770
 771 LDAP_END_DECL
 772
 773 #endif /* _LDAP_H */