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

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1998-2009 The OpenLDAP Foundation.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted only as authorized by the OpenLDAP
   9  * Public License.
  10  *
  11  * A copy of this license is available in file LICENSE in the
  12  * top-level directory of the distribution or, alternatively, at
  13  * <http://www.OpenLDAP.org/license.html>.
  14  */
  15
  16 /* ldap-pvt.h - Header for ldap_pvt_ functions.
  17  * These are meant to be internal to OpenLDAP Software.
  18  */
  19
  20 #ifndef _LDAP_PVT_H
  21 #define _LDAP_PVT_H 1
  22
  23 #include <lber.h>                               /* get ber_slen_t */
  24 #include <lber_pvt.h>                           /* get Sockbuf_Buf */
  25
  26 LDAP_BEGIN_DECL
  27
  28 #define LDAP_PROTO_TCP 1 /* ldap://  */
  29 #define LDAP_PROTO_UDP 2 /* reserved */
  30 #define LDAP_PROTO_IPC 3 /* ldapi:// */
  31 #define LDAP_PROTO_EXT 4 /* user-defined socket/sockbuf */
  32
  33 LDAP_F ( int )
  34 ldap_pvt_url_scheme2proto LDAP_P((
  35         const char * ));
  36 LDAP_F ( int )
  37 ldap_pvt_url_scheme2tls LDAP_P((
  38         const char * ));
  39
  40 LDAP_F ( int )
  41 ldap_pvt_url_scheme_port LDAP_P((
  42         const char *, int ));
  43
  44 struct ldap_url_desc; /* avoid pulling in <ldap.h> */
  45
  46 #define LDAP_PVT_URL_PARSE_NONE                 (0x00U)
  47 #define LDAP_PVT_URL_PARSE_NOEMPTY_HOST         (0x01U)
  48 #define LDAP_PVT_URL_PARSE_DEF_PORT             (0x02U)
  49 #define LDAP_PVT_URL_PARSE_NOEMPTY_DN           (0x04U)
  50 #define LDAP_PVT_URL_PARSE_NODEF_SCOPE          (0x08U)
  51 #define LDAP_PVT_URL_PARSE_HISTORIC             (LDAP_PVT_URL_PARSE_NODEF_SCOPE | \
  52                                                  LDAP_PVT_URL_PARSE_NOEMPTY_HOST | \
  53                                                  LDAP_PVT_URL_PARSE_DEF_PORT)
  54
  55 LDAP_F( int )
  56 ldap_url_parse_ext LDAP_P((
  57         LDAP_CONST char *url,
  58         struct ldap_url_desc **ludpp,
  59         unsigned flags ));
  60
  61 LDAP_F (int) ldap_url_parselist LDAP_P((        /* deprecated, use ldap_url_parselist_ext() */
  62         struct ldap_url_desc **ludlist,
  63         const char *url ));
  64
  65 LDAP_F (int) ldap_url_parselist_ext LDAP_P((
  66         struct ldap_url_desc **ludlist,
  67         const char *url,
  68         const char *sep,
  69         unsigned flags ));
  70
  71 LDAP_F (char *) ldap_url_list2urls LDAP_P((
  72         struct ldap_url_desc *ludlist ));
  73
  74 LDAP_F (void) ldap_free_urllist LDAP_P((
  75         struct ldap_url_desc *ludlist ));
  76
  77 LDAP_F (int) ldap_pvt_scope2bv LDAP_P ((
  78         int scope, struct berval *bv ));
  79
  80 LDAP_F (LDAP_CONST char *) ldap_pvt_scope2str LDAP_P ((
  81         int scope ));
  82
  83 LDAP_F (int) ldap_pvt_bv2scope LDAP_P ((
  84         struct berval *bv ));
  85
  86 LDAP_F (int) ldap_pvt_str2scope LDAP_P ((
  87         LDAP_CONST char * ));
  88
  89 LDAP_F( char * )
  90 ldap_pvt_ctime LDAP_P((
  91         const time_t *tp,
  92         char *buf ));
  93
  94 LDAP_F( char *) ldap_pvt_get_fqdn LDAP_P(( char * ));
  95
  96 struct hostent; /* avoid pulling in <netdb.h> */
  97
  98 LDAP_F( int )
  99 ldap_pvt_gethostbyname_a LDAP_P((
 100         const char *name,
 101         struct hostent *resbuf,
 102         char **buf,
 103         struct hostent **result,
 104         int *herrno_ptr ));
 105
 106 LDAP_F( int )
 107 ldap_pvt_gethostbyaddr_a LDAP_P((
 108         const char *addr,
 109         int len,
 110         int type,
 111         struct hostent *resbuf,
 112         char **buf,
 113         struct hostent **result,
 114         int *herrno_ptr ));
 115
 116 struct sockaddr;
 117
 118 LDAP_F( int )
 119 ldap_pvt_get_hname LDAP_P((
 120         const struct sockaddr * sa,
 121         int salen,
 122         char *name,
 123         int namelen,
 124         char **herr ));
 125
 126
 127 /* charray.c */
 128
 129 LDAP_F( int )
 130 ldap_charray_add LDAP_P((
 131     char        ***a,
 132     const char *s ));
 133
 134 LDAP_F( int )
 135 ldap_charray_merge LDAP_P((
 136     char        ***a,
 137     char        **s ));
 138
 139 LDAP_F( void )
 140 ldap_charray_free LDAP_P(( char **a ));
 141
 142 LDAP_F( int )
 143 ldap_charray_inlist LDAP_P((
 144     char        **a,
 145     const char *s ));
 146
 147 LDAP_F( char ** )
 148 ldap_charray_dup LDAP_P(( char **a ));
 149
 150 LDAP_F( char ** )
 151 ldap_str2charray LDAP_P((
 152         const char *str,
 153         const char *brkstr ));
 154
 155 LDAP_F( char * )
 156 ldap_charray2str LDAP_P((
 157         char **array, const char* sep ));
 158
 159 /* getdn.c */
 160
 161 #ifdef LDAP_AVA_NULL    /* in ldap.h */
 162 LDAP_F( void ) ldap_rdnfree_x LDAP_P(( LDAPRDN rdn, void *ctx ));
 163 LDAP_F( void ) ldap_dnfree_x LDAP_P(( LDAPDN dn, void *ctx ));
 164
 165 LDAP_F( int ) ldap_bv2dn_x LDAP_P((
 166         struct berval *bv, LDAPDN *dn, unsigned flags, void *ctx ));
 167 LDAP_F( int ) ldap_dn2bv_x LDAP_P((
 168         LDAPDN dn, struct berval *bv, unsigned flags, void *ctx ));
 169 LDAP_F( int ) ldap_bv2rdn_x LDAP_P((
 170         struct berval *, LDAPRDN *, char **, unsigned flags, void *ctx ));
 171 LDAP_F( int ) ldap_rdn2bv_x LDAP_P((
 172         LDAPRDN rdn, struct berval *bv, unsigned flags, void *ctx ));
 173 #endif /* LDAP_AVA_NULL */
 174
 175 /* url.c */
 176 LDAP_F (void) ldap_pvt_hex_unescape LDAP_P(( char *s ));
 177
 178 /*
 179  * these macros assume 'x' is an ASCII x
 180  * and assume the "C" locale
 181  */
 182 #define LDAP_ASCII(c)           (!((c) & 0x80))
 183 #define LDAP_SPACE(c)           ((c) == ' ' || (c) == '\t' || (c) == '\n')
 184 #define LDAP_DIGIT(c)           ((c) >= '0' && (c) <= '9')
 185 #define LDAP_LOWER(c)           ((c) >= 'a' && (c) <= 'z')
 186 #define LDAP_UPPER(c)           ((c) >= 'A' && (c) <= 'Z')
 187 #define LDAP_ALPHA(c)           (LDAP_LOWER(c) || LDAP_UPPER(c))
 188 #define LDAP_ALNUM(c)           (LDAP_ALPHA(c) || LDAP_DIGIT(c))
 189
 190 #define LDAP_LDH(c)                     (LDAP_ALNUM(c) || (c) == '-')
 191
 192 #define LDAP_HEXLOWER(c)        ((c) >= 'a' && (c) <= 'f')
 193 #define LDAP_HEXUPPER(c)        ((c) >= 'A' && (c) <= 'F')
 194 #define LDAP_HEX(c)                     (LDAP_DIGIT(c) || \
 195                                                                 LDAP_HEXLOWER(c) || LDAP_HEXUPPER(c))
 196
 197 /* controls.c */
 198 struct ldapcontrol;
 199 LDAP_F (int)
 200 ldap_pvt_put_control LDAP_P((
 201         const struct ldapcontrol *c,
 202         BerElement *ber ));
 203 LDAP_F (int) ldap_pvt_get_controls LDAP_P((
 204         BerElement *be,
 205         struct ldapcontrol ***ctrlsp));
 206
 207 #ifdef HAVE_CYRUS_SASL
 208 /* cyrus.c */
 209 struct sasl_security_properties; /* avoid pulling in <sasl.h> */
 210 LDAP_F (int) ldap_pvt_sasl_secprops LDAP_P((
 211         const char *in,
 212         struct sasl_security_properties *secprops ));
 213 LDAP_F (void) ldap_pvt_sasl_secprops_unparse LDAP_P((
 214         struct sasl_security_properties *secprops,
 215         struct berval *out ));
 216
 217 LDAP_F (void *) ldap_pvt_sasl_mutex_new LDAP_P((void));
 218 LDAP_F (int) ldap_pvt_sasl_mutex_lock LDAP_P((void *mutex));
 219 LDAP_F (int) ldap_pvt_sasl_mutex_unlock LDAP_P((void *mutex));
 220 LDAP_F (void) ldap_pvt_sasl_mutex_dispose LDAP_P((void *mutex));
 221 #endif /* HAVE_CYRUS_SASL */
 222
 223 struct sockbuf; /* avoid pulling in <lber.h> */
 224 LDAP_F (int) ldap_pvt_sasl_install LDAP_P(( struct sockbuf *, void * ));
 225 LDAP_F (void) ldap_pvt_sasl_remove LDAP_P(( struct sockbuf * ));
 226
 227 /*
 228  * SASL encryption support for LBER Sockbufs
 229  */
 230
 231 struct sb_sasl_generic_data;
 232
 233 struct sb_sasl_generic_ops {
 234         void (*init)(struct sb_sasl_generic_data *p,
 235                      ber_len_t *min_send,
 236                      ber_len_t *max_send,
 237                      ber_len_t *max_recv);
 238         ber_int_t (*encode)(struct sb_sasl_generic_data *p,
 239                             unsigned char *buf,
 240                             ber_len_t len,
 241                             Sockbuf_Buf *dst);
 242         ber_int_t (*decode)(struct sb_sasl_generic_data *p,
 243                             const Sockbuf_Buf *src,
 244                             Sockbuf_Buf *dst);
 245         void (*reset_buf)(struct sb_sasl_generic_data *p,
 246                           Sockbuf_Buf *buf);
 247         void (*fini)(struct sb_sasl_generic_data *p);
 248 };
 249
 250 struct sb_sasl_generic_install {
 251         const struct sb_sasl_generic_ops        *ops;
 252         void                                    *ops_private;
 253 };
 254
 255 struct sb_sasl_generic_data {
 256         const struct sb_sasl_generic_ops        *ops;
 257         void                                    *ops_private;
 258         Sockbuf_IO_Desc                         *sbiod;
 259         ber_len_t                               min_send;
 260         ber_len_t                               max_send;
 261         ber_len_t                               max_recv;
 262         Sockbuf_Buf                             sec_buf_in;
 263         Sockbuf_Buf                             buf_in;
 264         Sockbuf_Buf                             buf_out;
 265 };
 266
 267 #ifndef LDAP_PVT_SASL_LOCAL_SSF
 268 #define LDAP_PVT_SASL_LOCAL_SSF 71      /* SSF for Unix Domain Sockets */
 269 #endif /* ! LDAP_PVT_SASL_LOCAL_SSF */
 270
 271 struct ldap;
 272 struct ldapmsg;
 273
 274 /* abandon */
 275 LDAP_F ( int ) ldap_pvt_discard LDAP_P((
 276         struct ldap *ld, ber_int_t msgid ));
 277
 278 /* messages.c */
 279 LDAP_F( BerElement * )
 280 ldap_get_message_ber LDAP_P((
 281         struct ldapmsg * ));
 282
 283 /* open */
 284 LDAP_F (int) ldap_open_internal_connection LDAP_P((
 285         struct ldap **ldp, ber_socket_t *fdp ));
 286 LDAP_F (int) ldap_init_fd LDAP_P((
 287         ber_socket_t fd, int proto, LDAP_CONST char *url, struct ldap **ldp ));
 288
 289 /* search.c */
 290 LDAP_F( int ) ldap_pvt_put_filter LDAP_P((
 291         BerElement *ber,
 292         const char *str ));
 293
 294 LDAP_F( char * )
 295 ldap_pvt_find_wildcard LDAP_P(( const char *s ));
 296
 297 LDAP_F( ber_slen_t )
 298 ldap_pvt_filter_value_unescape LDAP_P(( char *filter ));
 299
 300 LDAP_F( ber_len_t )
 301 ldap_bv2escaped_filter_value_len LDAP_P(( struct berval *in ));
 302
 303 LDAP_F( int )
 304 ldap_bv2escaped_filter_value_x LDAP_P(( struct berval *in, struct berval *out,
 305         int inplace, void *ctx ));
 306
 307 LDAP_F (int) ldap_pvt_search LDAP_P((
 308         struct ldap *ld,
 309         LDAP_CONST char *base,
 310         int scope,
 311         LDAP_CONST char *filter,
 312         char **attrs,
 313         int attrsonly,
 314         struct ldapcontrol **sctrls,
 315         struct ldapcontrol **cctrls,
 316         struct timeval *timeout,
 317         int sizelimit,
 318         int deref,
 319         int *msgidp ));
 320
 321 LDAP_F(int) ldap_pvt_search_s LDAP_P((
 322         struct ldap *ld,
 323         LDAP_CONST char *base,
 324         int scope,
 325         LDAP_CONST char *filter,
 326         char **attrs,
 327         int attrsonly,
 328         struct ldapcontrol **sctrls,
 329         struct ldapcontrol **cctrls,
 330         struct timeval *timeout,
 331         int sizelimit,
 332         int deref,
 333         struct ldapmsg **res ));
 334
 335 /* string.c */
 336 LDAP_F( char * )
 337 ldap_pvt_str2upper LDAP_P(( char *str ));
 338
 339 LDAP_F( char * )
 340 ldap_pvt_str2lower LDAP_P(( char *str ));
 341
 342 LDAP_F( struct berval * )
 343 ldap_pvt_str2upperbv LDAP_P(( char *str, struct berval *bv ));
 344
 345 LDAP_F( struct berval * )
 346 ldap_pvt_str2lowerbv LDAP_P(( char *str, struct berval *bv ));
 347
 348 /* tls.c */
 349 LDAP_F (int) ldap_int_tls_config LDAP_P(( struct ldap *ld,
 350         int option, const char *arg ));
 351 LDAP_F (int) ldap_pvt_tls_get_option LDAP_P(( struct ldap *ld,
 352         int option, void *arg ));
 353 LDAP_F (int) ldap_pvt_tls_set_option LDAP_P(( struct ldap *ld,
 354         int option, void *arg ));
 355
 356 LDAP_F (void) ldap_pvt_tls_destroy LDAP_P(( void ));
 357 LDAP_F (int) ldap_pvt_tls_init LDAP_P(( void ));
 358 LDAP_F (int) ldap_pvt_tls_init_def_ctx LDAP_P(( int is_server ));
 359 LDAP_F (int) ldap_pvt_tls_accept LDAP_P(( Sockbuf *sb, void *ctx_arg ));
 360 LDAP_F (int) ldap_pvt_tls_inplace LDAP_P(( Sockbuf *sb ));
 361 LDAP_F (void *) ldap_pvt_tls_sb_ctx LDAP_P(( Sockbuf *sb ));
 362 LDAP_F (void) ldap_pvt_tls_ctx_free LDAP_P(( void * ));
 363
 364 typedef int LDAPDN_rewrite_dummy LDAP_P (( void *dn, unsigned flags ));
 365
 366 typedef int (LDAP_TLS_CONNECT_CB) LDAP_P (( struct ldap *ld, void *ssl,
 367         void *ctx, void *arg ));
 368
 369 LDAP_F (int) ldap_pvt_tls_get_my_dn LDAP_P(( void *ctx, struct berval *dn,
 370         LDAPDN_rewrite_dummy *func, unsigned flags ));
 371 LDAP_F (int) ldap_pvt_tls_get_peer_dn LDAP_P(( void *ctx, struct berval *dn,
 372         LDAPDN_rewrite_dummy *func, unsigned flags ));
 373 LDAP_F (int) ldap_pvt_tls_get_strength LDAP_P(( void *ctx ));
 374
 375 LDAP_END_DECL
 376
 377 /*
 378  * Multiple precision stuff
 379  *
 380  * May use OpenSSL's BIGNUM if built with TLS,
 381  * or GNU's multiple precision library. But if
 382  * long long is available, that's big enough
 383  * and much more efficient.
 384  *
 385  * If none is available, unsigned long data is used.
 386  */
 387
 388 LDAP_BEGIN_DECL
 389
 390 #ifdef USE_MP_BIGNUM
 391 /*
 392  * Use OpenSSL's BIGNUM
 393  */
 394 #include <openssl/crypto.h>
 395 #include <openssl/bn.h>
 396
 397 typedef BIGNUM* ldap_pvt_mp_t;
 398 #define LDAP_PVT_MP_INIT        (NULL)
 399
 400 #define ldap_pvt_mp_init(mp) \
 401         do { (mp) = BN_new(); } while (0)
 402
 403 /* FIXME: we rely on mpr being initialized */
 404 #define ldap_pvt_mp_init_set(mpr,mpv) \
 405         do { ldap_pvt_mp_init((mpr)); BN_add((mpr), (mpr), (mpv)); } while (0)
 406
 407 #define ldap_pvt_mp_add(mpr,mpv) \
 408         BN_add((mpr), (mpr), (mpv))
 409
 410 #define ldap_pvt_mp_add_ulong(mp,v) \
 411         BN_add_word((mp), (v))
 412
 413 #define ldap_pvt_mp_clear(mp) \
 414         do { BN_free((mp)); (mp) = 0; } while (0)
 415
 416 #elif defined(USE_MP_GMP)
 417 /*
 418  * Use GNU's multiple precision library
 419  */
 420 #include <gmp.h>
 421
 422 typedef mpz_t           ldap_pvt_mp_t;
 423 #define LDAP_PVT_MP_INIT        { 0 }
 424
 425 #define ldap_pvt_mp_init(mp) \
 426         mpz_init((mp))
 427
 428 #define ldap_pvt_mp_init_set(mpr,mpv) \
 429         mpz_init_set((mpr), (mpv))
 430
 431 #define ldap_pvt_mp_add(mpr,mpv) \
 432         mpz_add((mpr), (mpr), (mpv))
 433
 434 #define ldap_pvt_mp_add_ulong(mp,v)     \
 435         mpz_add_ui((mp), (mp), (v))
 436
 437 #define ldap_pvt_mp_clear(mp) \
 438         mpz_clear((mp))
 439
 440 #else
 441 /*
 442  * Use unsigned long long
 443  */
 444
 445 #ifdef USE_MP_LONG_LONG
 446 typedef unsigned long long      ldap_pvt_mp_t;
 447 #define LDAP_PVT_MP_INIT        (0LL)
 448 #elif defined(USE_MP_LONG)
 449 typedef unsigned long           ldap_pvt_mp_t;
 450 #define LDAP_PVT_MP_INIT        (0L)
 451 #elif defined(HAVE_LONG_LONG)
 452 typedef unsigned long long      ldap_pvt_mp_t;
 453 #define LDAP_PVT_MP_INIT        (0LL)
 454 #else
 455 typedef unsigned long           ldap_pvt_mp_t;
 456 #define LDAP_PVT_MP_INIT        (0L)
 457 #endif
 458
 459 #define ldap_pvt_mp_init(mp) \
 460         do { (mp) = 0; } while (0)
 461
 462 #define ldap_pvt_mp_init_set(mpr,mpv) \
 463         do { (mpr) = (mpv); } while (0)
 464
 465 #define ldap_pvt_mp_add(mpr,mpv) \
 466         do { (mpr) += (mpv); } while (0)
 467
 468 #define ldap_pvt_mp_add_ulong(mp,v) \
 469         do { (mp) += (v); } while (0)
 470
 471 #define ldap_pvt_mp_clear(mp) \
 472         do { (mp) = 0; } while (0)
 473
 474 #endif /* MP */
 475
 476 #include "ldap_pvt_uc.h"
 477
 478 LDAP_END_DECL
 479
 480 LDAP_BEGIN_DECL
 481
 482 #include <limits.h>                             /* get CHAR_BIT */
 483
 484 /* Buffer space for sign, decimal digits and \0. Note: log10(2) < 146/485. */
 485 #define LDAP_PVT_INTTYPE_CHARS(type) (((sizeof(type)*CHAR_BIT-1)*146)/485 + 3)
 486
 487 LDAP_END_DECL
 488
 489 #endif /* _LDAP_PVT_H */