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