X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=include%2Fldap_pvt.h;h=89fe20c6f0e1e434e075bc1a2ea80b15a2c2fdea;hb=86899b0bda24c8813876f28d8e7e5e1ca06cf48b;hp=660fa1d6127ab91cb9103fce0049fbc6266b44a1;hpb=0dbaf87730ec9afe44dceaa452ae51e1dcaac3e7;p=openldap diff --git a/include/ldap_pvt.h b/include/ldap_pvt.h index 660fa1d612..89fe20c6f0 100644 --- a/include/ldap_pvt.h +++ b/include/ldap_pvt.h @@ -1,47 +1,88 @@ /* $OpenLDAP$ */ -/* - * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA +/* This work is part of OpenLDAP Software . + * + * Copyright 1998-2006 The OpenLDAP Foundation. * All rights reserved. * - * Redistribution and use in source and binary forms are permitted only - * as authorized by the OpenLDAP Public License. A copy of this - * license is available at http://www.OpenLDAP.org/license.html or - * in file LICENSE in the top-level directory of the distribution. + * Redistribution and use in source and binary forms, with or without + * modification, are permitted only as authorized by the OpenLDAP + * Public License. + * + * A copy of this license is available in file LICENSE in the + * top-level directory of the distribution or, alternatively, at + * . */ -/* - * ldap-pvt.h - Header for ldap_pvt_ functions. These are meant to be used - * by the OpenLDAP distribution only. + +/* ldap-pvt.h - Header for ldap_pvt_ functions. + * These are meant to be internal to OpenLDAP Software. */ #ifndef _LDAP_PVT_H #define _LDAP_PVT_H 1 -#include #include /* get ber_slen_t */ LDAP_BEGIN_DECL -LIBLDAP_F ( int ) -ldap_pvt_domain2dn LDAP_P(( - LDAP_CONST char *domain, - char **dn )); - -struct hostent; /* avoid pulling in */ - -LIBLDAP_F( char * ) +#define LDAP_PROTO_TCP 1 /* ldap:// */ +#define LDAP_PROTO_UDP 2 /* reserved */ +#define LDAP_PROTO_IPC 3 /* ldapi:// */ + +LDAP_F ( int ) +ldap_pvt_url_scheme2proto LDAP_P(( + const char * )); +LDAP_F ( int ) +ldap_pvt_url_scheme2tls LDAP_P(( + const char * )); + +LDAP_F ( int ) +ldap_pvt_url_scheme_port LDAP_P(( + const char *, int )); + +struct ldap_url_desc; /* avoid pulling in */ + +#define LDAP_PVT_URL_PARSE_NONE (0x00U) +#define LDAP_PVT_URL_PARSE_NOEMPTY_HOST (0x01U) +#define LDAP_PVT_URL_PARSE_DEF_PORT (0x02U) +#define LDAP_PVT_URL_PARSE_NOEMPTY_DN (0x04U) +#define LDAP_PVT_URL_PARSE_NODEF_SCOPE (0x08U) +#define LDAP_PVT_URL_PARSE_HISTORIC (LDAP_PVT_URL_PARSE_NODEF_SCOPE | LDAP_PVT_URL_PARSE_NOEMPTY_HOST | LDAP_PVT_URL_PARSE_DEF_PORT) +LDAP_F( int ) +ldap_url_parse_ext LDAP_P(( + LDAP_CONST char *url, + struct ldap_url_desc **ludpp, + unsigned flags )); + +LDAP_F (int) ldap_url_parselist_ext LDAP_P(( + struct ldap_url_desc **ludlist, + const char *url, + const char *sep, + unsigned flags )); + +LDAP_F (char *) ldap_url_list2urls LDAP_P(( + struct ldap_url_desc *ludlist )); + +LDAP_F (void) ldap_free_urllist LDAP_P(( + struct ldap_url_desc *ludlist )); + +LDAP_F( char * ) ldap_pvt_ctime LDAP_P(( const time_t *tp, char *buf )); -LIBLDAP_F( int ) +LDAP_F( char *) ldap_pvt_get_fqdn LDAP_P(( char * )); + +struct hostent; /* avoid pulling in */ + +LDAP_F( int ) ldap_pvt_gethostbyname_a LDAP_P(( - const char *name, + const char *name, struct hostent *resbuf, char **buf, struct hostent **result, int *herrno_ptr )); -LIBLDAP_F( int ) +LDAP_F( int ) ldap_pvt_gethostbyaddr_a LDAP_P(( const char *addr, int len, @@ -51,161 +92,292 @@ ldap_pvt_gethostbyaddr_a LDAP_P(( struct hostent **result, int *herrno_ptr )); +struct sockaddr; + +LDAP_F( int ) +ldap_pvt_get_hname LDAP_P(( + const struct sockaddr * sa, + int salen, + char *name, + int namelen, + char **herr )); + /* charray.c */ -LIBLDAP_F( int ) +LDAP_F( int ) ldap_charray_add LDAP_P(( char ***a, - char *s )); + const char *s )); -LIBLDAP_F( int ) +LDAP_F( int ) ldap_charray_merge LDAP_P(( char ***a, char **s )); -LIBLDAP_F( void ) +LDAP_F( void ) ldap_charray_free LDAP_P(( char **a )); -LIBLDAP_F( int ) +LDAP_F( int ) ldap_charray_inlist LDAP_P(( char **a, - char *s )); + const char *s )); -LIBLDAP_F( char ** ) +LDAP_F( char ** ) ldap_charray_dup LDAP_P(( char **a )); -LIBLDAP_F( char ** ) +LDAP_F( char ** ) ldap_str2charray LDAP_P(( const char *str, const char *brkstr )); +LDAP_F( char * ) +ldap_charray2str LDAP_P(( + char **array, const char* sep )); + +/* getdn.c */ + +#ifdef LDAP_AVA_NULL /* in ldap.h */ +LDAP_F( void ) ldap_rdnfree_x LDAP_P(( LDAPRDN rdn, void *ctx )); +LDAP_F( void ) ldap_dnfree_x LDAP_P(( LDAPDN dn, void *ctx )); + +LDAP_F( int ) ldap_bv2dn_x LDAP_P(( + struct berval *bv, LDAPDN *dn, unsigned flags, void *ctx )); +LDAP_F( int ) ldap_dn2bv_x LDAP_P(( + LDAPDN dn, struct berval *bv, unsigned flags, void *ctx )); +LDAP_F( int ) ldap_bv2rdn_x LDAP_P(( + struct berval *, LDAPRDN *, char **, unsigned flags, void *ctx )); +LDAP_F( int ) ldap_rdn2bv_x LDAP_P(( + LDAPRDN rdn, struct berval *bv, unsigned flags, void *ctx )); +#endif + /* url.c */ -LIBLDAP_F (void) ldap_pvt_hex_unescape LDAP_P(( char *s )); -LIBLDAP_F (int) ldap_pvt_unhex( int c ); +LDAP_F (void) ldap_pvt_hex_unescape LDAP_P(( char *s )); -/* these macros assume 'x' is an ASCII x */ -#define LDAP_DNSEPARATOR(c) ((c) == ',' || (c) == ';') -#define LDAP_SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+') -#define LDAP_SPACE(c) ((c) == ' ' || (c) == '\n') +/* + * these macros assume 'x' is an ASCII x + * and assume the "C" locale + */ +#define LDAP_ASCII(c) (!((c) & 0x80)) +#define LDAP_SPACE(c) ((c) == ' ' || (c) == '\t' || (c) == '\n') +#define LDAP_DIGIT(c) ((c) >= '0' && (c) <= '9') +#define LDAP_LOWER(c) ((c) >= 'a' && (c) <= 'z') +#define LDAP_UPPER(c) ((c) >= 'A' && (c) <= 'Z') +#define LDAP_ALPHA(c) (LDAP_LOWER(c) || LDAP_UPPER(c)) +#define LDAP_ALNUM(c) (LDAP_ALPHA(c) || LDAP_DIGIT(c)) + +#define LDAP_LDH(c) (LDAP_ALNUM(c) || (c) == '-') -#define LDAP_LOWER(c) ( (c) >= 'a' && (c) <= 'z' ) -#define LDAP_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' ) -#define LDAP_ALPHA(c) ( LDAP_LOWER(c) || LDAP_UPPER(c) ) -#define LDAP_DIGIT(c) ( (c) >= '0' && (c) <= '9' ) -#define LDAP_ALNUM(c) ( LDAP_ALPHA(c) || LDAP_DIGIT(c) ) +#define LDAP_HEXLOWER(c) ((c) >= 'a' && (c) <= 'f') +#define LDAP_HEXUPPER(c) ((c) >= 'A' && (c) <= 'F') +#define LDAP_HEX(c) (LDAP_DIGIT(c) || \ + LDAP_HEXLOWER(c) || LDAP_HEXUPPER(c)) -#define LDAP_LEADKEYCHAR(c) ( LDAP_ALPHA(c) ) -#define LDAP_KEYCHAR(c) ( LDAP_ALNUM(c) || (c) == '-' ) -#define LDAP_LEADOIDCHAR(c) ( LDAP_DIGIT(c) ) -#define LDAP_OIDCHAR(c) ( LDAP_DIGIT(c) || (c) == '.' ) +/* controls.c */ +struct ldapcontrol; +LDAP_F (struct ldapcontrol *) ldap_control_dup LDAP_P(( + const struct ldapcontrol *ctrl )); -#define LDAP_LEADATTRCHAR(c) ( LDAP_LEADKEYCHAR(c) || LDAP_LEADOIDCHAR(c) ) -#define LDAP_ATTRCHAR(c) ( LDAP_KEYCHAR((c)) || (c) == '.' ) +LDAP_F (struct ldapcontrol **) ldap_controls_dup LDAP_P(( + struct ldapcontrol *const *ctrls )); -#define LDAP_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"') +LDAP_F (int) ldap_pvt_get_controls LDAP_P(( + BerElement *be, + struct ldapcontrol ***ctrlsp)); #ifdef HAVE_CYRUS_SASL -/* sasl.c */ +/* cyrus.c */ +struct sasl_security_properties; /* avoid pulling in */ +LDAP_F (int) ldap_pvt_sasl_secprops LDAP_P(( + const char *in, + struct sasl_security_properties *secprops )); +LDAP_F (void) ldap_pvt_sasl_secprops_unparse LDAP_P(( + struct sasl_security_properties *secprops, + struct berval *out )); + +LDAP_F (void *) ldap_pvt_sasl_mutex_new LDAP_P((void)); +LDAP_F (int) ldap_pvt_sasl_mutex_lock LDAP_P((void *mutex)); +LDAP_F (int) ldap_pvt_sasl_mutex_unlock LDAP_P((void *mutex)); +LDAP_F (void) ldap_pvt_sasl_mutex_dispose LDAP_P((void *mutex)); + +struct sockbuf; /* avoid pulling in */ +LDAP_F (int) ldap_pvt_sasl_install LDAP_P(( struct sockbuf *, void * )); +LDAP_F (void) ldap_pvt_sasl_remove LDAP_P(( struct sockbuf * )); +#endif /* HAVE_CYRUS_SASL */ -#include -#include +#ifndef LDAP_PVT_SASL_LOCAL_SSF +#define LDAP_PVT_SASL_LOCAL_SSF 71 /* SSF for Unix Domain Sockets */ +#endif -LIBLDAP_F (int) ldap_pvt_sasl_init LDAP_P(( void )); /* clientside init */ -LIBLDAP_F (int) ldap_pvt_sasl_install LDAP_P(( Sockbuf *, void * )); -LIBLDAP_F (int) ldap_pvt_sasl_err2ldap LDAP_P(( int )); -LIBLDAP_F (int) ldap_pvt_sasl_bind LDAP_P(( LDAP *, LDAP_CONST char *, LDAP_CONST char *, LDAP_CONST sasl_callback_t *, LDAPControl **, LDAPControl ** )); -#endif /* HAVE_CYRUS_SASL */ +struct ldap; +struct ldapmsg; + +LDAP_F (int) ldap_open_internal_connection LDAP_P(( + struct ldap **ldp, ber_socket_t *fdp )); + +/* messages.c */ +LDAP_F( BerElement * ) +ldap_get_message_ber LDAP_P(( + struct ldapmsg * )); /* search.c */ -LIBLDAP_F( char * ) +LDAP_F( int ) ldap_pvt_put_filter LDAP_P(( + BerElement *ber, + const char *str )); + +LDAP_F( char * ) ldap_pvt_find_wildcard LDAP_P(( const char *s )); -LIBLDAP_F( ber_slen_t ) +LDAP_F( ber_slen_t ) ldap_pvt_filter_value_unescape LDAP_P(( char *filter )); +LDAP_F( ber_len_t ) +ldap_bv2escaped_filter_value_len LDAP_P(( struct berval *in )); + +LDAP_F( int ) +ldap_bv2escaped_filter_value_x LDAP_P(( struct berval *in, struct berval *out, + int inplace, void *ctx )); + /* string.c */ -LIBLDAP_F( char * ) +LDAP_F( char * ) ldap_pvt_str2upper LDAP_P(( char *str )); -LIBLDAP_F( char * ) +LDAP_F( char * ) ldap_pvt_str2lower LDAP_P(( char *str )); +LDAP_F( struct berval * ) +ldap_pvt_str2upperbv LDAP_P(( char *str, struct berval *bv )); + +LDAP_F( struct berval * ) +ldap_pvt_str2lowerbv LDAP_P(( char *str, struct berval *bv )); + /* tls.c */ -struct ldapoptions; - -LIBLDAP_F (int) ldap_pvt_tls_init LDAP_P(( void )); -LIBLDAP_F (int) ldap_pvt_tls_config LDAP_P(( struct ldapoptions *lo, int option, const char *arg )); -LIBLDAP_F (int) ldap_pvt_tls_connect LDAP_P(( Sockbuf *sb, void *ctx_arg )); -LIBLDAP_F (int) ldap_pvt_tls_accept LDAP_P(( Sockbuf *sb, void *ctx_arg )); -LIBLDAP_F (int) ldap_pvt_tls_get_option LDAP_P(( struct ldapoptions *lo, int option, void *arg )); -LIBLDAP_F (int) ldap_pvt_tls_set_option LDAP_P(( struct ldapoptions *lo, int option, void *arg )); -LIBLDAP_F (int) ldap_pvt_tls_inplace LDAP_P(( Sockbuf *sb )); -LIBLDAP_F (int) ldap_pvt_tls_start LDAP_P(( Sockbuf *sb, void *ctx_arg )); - -/* - * UTF-8 (in utf-8.c) - */ +LDAP_F (int) ldap_int_tls_config LDAP_P(( struct ldap *ld, + int option, const char *arg )); +LDAP_F (int) ldap_pvt_tls_get_option LDAP_P(( struct ldap *ld, + int option, void *arg )); +LDAP_F (int) ldap_pvt_tls_set_option LDAP_P(( struct ldap *ld, + int option, void *arg )); + +LDAP_F (void) ldap_pvt_tls_destroy LDAP_P(( void )); +LDAP_F (int) ldap_pvt_tls_init LDAP_P(( void )); +LDAP_F (int) ldap_pvt_tls_init_def_ctx LDAP_P(( int is_server )); +LDAP_F (int) ldap_pvt_tls_accept LDAP_P(( Sockbuf *sb, void *ctx_arg )); +LDAP_F (int) ldap_pvt_tls_inplace LDAP_P(( Sockbuf *sb )); +LDAP_F (void *) ldap_pvt_tls_sb_ctx LDAP_P(( Sockbuf *sb )); + +LDAP_F (int) ldap_pvt_tls_init_default_ctx LDAP_P(( void )); + +typedef int LDAPDN_rewrite_dummy LDAP_P (( void *dn, unsigned flags )); -typedef ber_int_t ldap_ucs4_t; -typedef short ldap_ucs2_t; -typedef ldap_ucs2_t ldap_unicode_t; - -/* returns the number of bytes in the UTF-8 string */ -LIBLDAP_F (ber_len_t) ldap_utf8_bytes( const char * ); -/* returns the number of UTF-8 characters in the string */ -LIBLDAP_F (ber_len_t) ldap_utf8_chars( const char * ); -/* returns the length (in bytes) of the UTF-8 character */ -LIBLDAP_F (int) ldap_utf8_offset( const char * ); -/* returns the length (in bytes) indicated by the UTF-8 character */ -LIBLDAP_F (int) ldap_utf8_charlen( const char * ); -/* copies a UTF-8 character and returning number of bytes copied */ -LIBLDAP_F (int) ldap_utf8_copy( char *, const char *); - -/* returns pointer of next UTF-8 character in string */ -LIBLDAP_F (char*) ldap_utf8_next( const char * ); -/* returns pointer of previous UTF-8 character in string */ -LIBLDAP_F (char*) ldap_utf8_prev( const char * ); - -/* primitive ctype routines -- not aware of non-ascii characters */ -LIBLDAP_F (int) ldap_utf8_isascii( const char * ); -LIBLDAP_F (int) ldap_utf8_isalpha( const char * ); -LIBLDAP_F (int) ldap_utf8_isalnum( const char * ); -LIBLDAP_F (int) ldap_utf8_isdigit( const char * ); -LIBLDAP_F (int) ldap_utf8_isxdigit( const char * ); -LIBLDAP_F (int) ldap_utf8_isspace( const char * ); - -/* span characters not in set, return bytes spanned */ -LIBLDAP_F (ber_len_t) ldap_utf8_strcspn( const char* str, const char *set); -/* span characters in set, return bytes spanned */ -LIBLDAP_F (ber_len_t) ldap_utf8_strspn( const char* str, const char *set); -/* return first occurance of character in string */ -LIBLDAP_F (char *) ldap_utf8_strchr( const char* str, const char *chr); -/* return first character of set in string */ -LIBLDAP_F (char *) ldap_utf8_strpbrk( const char* str, const char *set); -/* reentrant tokenizer */ -LIBLDAP_F (char*) ldap_utf8_strtok( char* sp, const char* sep, char **last); - -/* Optimizations */ -#define LDAP_UTF8_ISASCII(p) ( * (const unsigned char *) (p) < 0x100 ) -#define LDAP_UTF8_CHARLEN(p) ( LDAP_UTF8_ISASCII(p) \ - ? 1 : ldap_utf8_charlen((p)) ) -#define LDAP_UTF8_OFFSET(p) ( LDAP_UTF8_ISASCII(p) \ - ? 1 : ldap_utf8_offset((p)) ) - -#define LDAP_UTF8_COPY(d,s) ( LDAP_UTF8_ISASCII(s) \ - ? (*(d) = *(s), 1) : ldap_utf8_copy((d),(s)) ) - -#define LDAP_UTF8_NEXT(p) ( LDAP_UTF8_ISASCII(p) \ - ? (char *)(p)+1 : ldap_utf8_next((p)) ) - -#define LDAP_UTF8_INCR(p) ((p) = LDAP_UTF8_NEXT(p)) - -/* For symmetry */ -#define LDAP_UTF8_PREV(p) (ldap_utf8_prev((p))) -#define LDAP_UTF8_DECR(p) ((p)=LDAP_UTF8_PREV((p))) +typedef int (LDAP_TLS_CONNECT_CB) LDAP_P (( struct ldap *ld, void *ssl, + void *ctx, void *arg )); + +LDAP_F (int) ldap_pvt_tls_get_my_dn LDAP_P(( void *ctx, struct berval *dn, + LDAPDN_rewrite_dummy *func, unsigned flags )); +LDAP_F (int) ldap_pvt_tls_get_peer_dn LDAP_P(( void *ctx, struct berval *dn, + LDAPDN_rewrite_dummy *func, unsigned flags )); +LDAP_F (int) ldap_pvt_tls_get_strength LDAP_P(( void *ctx )); LDAP_END_DECL +/* + * Multiple precision stuff + * + * May use OpenSSL's BIGNUM if built with TLS, + * or GNU's multiple precision library. But if + * long long is available, that's big enough + * and much more efficient. + * + * If none is available, unsigned long data is used. + */ + +#if USE_MP_BIGNUM +/* + * Use OpenSSL's BIGNUM + */ +#include +#include + +typedef BIGNUM* ldap_pvt_mp_t; +#define LDAP_PVT_MP_INIT (NULL) + +#define ldap_pvt_mp_init(mp) \ + do { (mp) = BN_new(); } while (0) + +/* FIXME: we rely on mpr being initialized */ +#define ldap_pvt_mp_init_set(mpr,mpv) \ + do { ldap_pvt_mp_init((mpr)); BN_add((mpr), (mpr), (mpv)); } while (0) + +#define ldap_pvt_mp_add(mpr,mpv) \ + BN_add((mpr), (mpr), (mpv)) + +#define ldap_pvt_mp_add_ulong(mp,v) \ + BN_add_word((mp), (v)) + +#define ldap_pvt_mp_clear(mp) \ + do { BN_free((mp)); (mp) = 0; } while (0) + +#elif USE_MP_GMP +/* + * Use GNU's multiple precision library + */ +#include + +typedef mpz_t ldap_pvt_mp_t; +#define LDAP_PVT_MP_INIT { 0 } + +#define ldap_pvt_mp_init(mp) \ + mpz_init((mp)) + +#define ldap_pvt_mp_init_set(mpr,mpv) \ + mpz_init_set((mpr), (mpv)) + +#define ldap_pvt_mp_add(mpr,mpv) \ + mpz_add((mpr), (mpr), (mpv)) + +#define ldap_pvt_mp_add_ulong(mp,v) \ + mpz_add_ui((mp), (mp), (v)) + +#define ldap_pvt_mp_clear(mp) \ + mpz_clear((mp)) + +#else +/* + * Use unsigned long long + */ + +#if USE_MP_LONG_LONG +typedef unsigned long long ldap_pvt_mp_t; +#define LDAP_PVT_MP_INIT (0LL) +#elif USE_MP_LONG +typedef unsigned long ldap_pvt_mp_t; +#define LDAP_PVT_MP_INIT (0L) +#elif HAVE_LONG_LONG +typedef unsigned long long ldap_pvt_mp_t; +#define LDAP_PVT_MP_INIT (0LL) +#else +typedef unsigned long ldap_pvt_mp_t; +#define LDAP_PVT_MP_INIT (0L) #endif +#define ldap_pvt_mp_init(mp) \ + do { (mp) = 0; } while (0) + +#define ldap_pvt_mp_init_set(mpr,mpv) \ + do { (mpr) = (mpv); } while (0) + +#define ldap_pvt_mp_add(mpr,mpv) \ + do { (mpr) += (mpv); } while (0) + +#define ldap_pvt_mp_add_ulong(mp,v) \ + do { (mp) += (v); } while (0) + +#define ldap_pvt_mp_clear(mp) \ + do { (mp) = 0; } while (0) + +#endif /* MP */ + +#include "ldap_pvt_uc.h" + +#endif /* _LDAP_PVT_H */