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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted only as authorized by the OpenLDAP
   8  * Public License.  A copy of this license is available at
   9  * http://www.OpenLDAP.org/license.html or in file LICENSE in the
  10  * top-level directory of the distribution.
  11  */
  12 /*
  13  * ldap-pvt.h - Header for ldap_pvt_ functions. These are meant to be used
  14  *              by the OpenLDAP distribution only.
  15  */
  16
  17 #ifndef _LDAP_PVT_H
  18 #define _LDAP_PVT_H 1
  19
  20 #include <lber.h>                               /* get ber_slen_t */
  21
  22 LDAP_BEGIN_DECL
  23
  24 #define LDAP_PROTO_TCP 1 /* ldap://  */
  25 #define LDAP_PROTO_UDP 2 /* reserved */
  26 #define LDAP_PROTO_IPC 3 /* ldapi:// */
  27
  28 LDAP_F ( int )
  29 ldap_pvt_url_scheme2proto LDAP_P((
  30         const char * ));
  31 LDAP_F ( int )
  32 ldap_pvt_url_scheme2tls LDAP_P((
  33         const char * ));
  34
  35 struct ldap_url_desc; /* avoid pulling in <ldap.h> */
  36
  37 LDAP_F( int )
  38 ldap_url_parse_ext LDAP_P((
  39         LDAP_CONST char *url,
  40         struct ldap_url_desc **ludpp ));
  41
  42 LDAP_F( char * )
  43 ldap_pvt_ctime LDAP_P((
  44         const time_t *tp,
  45         char *buf ));
  46
  47 LDAP_F( char *) ldap_pvt_get_fqdn LDAP_P(( char * ));
  48
  49 struct hostent; /* avoid pulling in <netdb.h> */
  50
  51 LDAP_F( int )
  52 ldap_pvt_gethostbyname_a LDAP_P((
  53         const char *name,
  54         struct hostent *resbuf,
  55         char **buf,
  56         struct hostent **result,
  57         int *herrno_ptr ));
  58
  59 LDAP_F( int )
  60 ldap_pvt_gethostbyaddr_a LDAP_P((
  61         const char *addr,
  62         int len,
  63         int type,
  64         struct hostent *resbuf,
  65         char **buf,
  66         struct hostent **result,
  67         int *herrno_ptr ));
  68
  69 LDAP_F( int )
  70 ldap_pvt_get_hname LDAP_P((
  71         const struct sockaddr * sa,
  72         int salen,
  73         char *name,
  74         int namelen,
  75         char **herr ));
  76
  77
  78 /* charray.c */
  79
  80 LDAP_F( int )
  81 ldap_charray_add LDAP_P((
  82     char        ***a,
  83     char        *s ));
  84
  85 LDAP_F( int )
  86 ldap_charray_merge LDAP_P((
  87     char        ***a,
  88     char        **s ));
  89
  90 LDAP_F( void )
  91 ldap_charray_free LDAP_P(( char **a ));
  92
  93 LDAP_F( int )
  94 ldap_charray_inlist LDAP_P((
  95     char        **a,
  96     char        *s ));
  97
  98 LDAP_F( char ** )
  99 ldap_charray_dup LDAP_P(( char **a ));
 100
 101 LDAP_F( char ** )
 102 ldap_str2charray LDAP_P((
 103         const char *str,
 104         const char *brkstr ));
 105
 106 LDAP_F( char * )
 107 ldap_charray2str LDAP_P((
 108         char **array, const char* sep ));
 109
 110 /* url.c */
 111 LDAP_F (void) ldap_pvt_hex_unescape LDAP_P(( char *s ));
 112
 113 /*
 114  * these macros assume 'x' is an ASCII x
 115  * and assume the "C" locale
 116  */
 117 #define LDAP_ASCII(c)           (!((c) & 0x80))
 118 #define LDAP_SPACE(c)           ((c) == ' ' || (c) == '\t' || (c) == '\n')
 119 #define LDAP_DIGIT(c)           ((c) >= '0' && (c) <= '9')
 120 #define LDAP_LOWER(c)           ((c) >= 'a' && (c) <= 'z')
 121 #define LDAP_UPPER(c)           ((c) >= 'A' && (c) <= 'Z')
 122 #define LDAP_ALPHA(c)           (LDAP_LOWER(c) || LDAP_UPPER(c))
 123 #define LDAP_ALNUM(c)           (LDAP_ALPHA(c) || LDAP_DIGIT(c))
 124
 125 #define LDAP_LDH(c)                     (LDAP_ALNUM(c) || (c) == '-')
 126
 127 #define LDAP_HEXLOWER(c)        ((c) >= 'a' && (c) <= 'f')
 128 #define LDAP_HEXUPPER(c)        ((c) >= 'A' && (c) <= 'F')
 129 #define LDAP_HEX(c)                     (LDAP_DIGIT(c) || \
 130                                                                 LDAP_HEXLOWER(c) || LDAP_HEXUPPER(c))
 131
 132 /* controls.c */
 133 struct ldapcontrol;
 134 LDAP_F (struct ldapcontrol *) ldap_control_dup LDAP_P((
 135         const struct ldapcontrol *ctrl ));
 136
 137 LDAP_F (struct ldapcontrol **) ldap_controls_dup LDAP_P((
 138         struct ldapcontrol *const *ctrls ));
 139
 140
 141 #ifdef HAVE_CYRUS_SASL
 142 /* cyrus.c */
 143 struct sasl_security_properties; /* avoid pulling in <sasl.h> */
 144 LDAP_F (int) ldap_pvt_sasl_secprops LDAP_P((
 145         const char *in,
 146         struct sasl_security_properties *secprops ));
 147
 148 LDAP_F (void *) ldap_pvt_sasl_mutex_new LDAP_P((void));
 149 LDAP_F (int) ldap_pvt_sasl_mutex_lock LDAP_P((void *mutex));
 150 LDAP_F (int) ldap_pvt_sasl_mutex_unlock LDAP_P((void *mutex));
 151 LDAP_F (void) ldap_pvt_sasl_mutex_dispose LDAP_P((void *mutex));
 152
 153 struct sockbuf; /* avoid pulling in <lber.h> */
 154 LDAP_F (int) ldap_pvt_sasl_install LDAP_P(( struct sockbuf *, void * ));
 155 #endif /* HAVE_CYRUS_SASL */
 156
 157 #define LDAP_PVT_SASL_LOCAL_SSF 71      /* SSF for Unix Domain Sockets */
 158
 159 struct ldap;
 160
 161 LDAP_F (int) ldap_open_internal_connection LDAP_P((
 162         struct ldap **ldp, ber_socket_t *fdp ));
 163
 164 /* search.c */
 165 LDAP_F( int ) ldap_pvt_put_filter LDAP_P((
 166         BerElement *ber,
 167         const char *str ));
 168
 169 LDAP_F( char * )
 170 ldap_pvt_find_wildcard LDAP_P(( const char *s ));
 171
 172 LDAP_F( ber_slen_t )
 173 ldap_pvt_filter_value_unescape LDAP_P(( char *filter ));
 174
 175 /* string.c */
 176 LDAP_F( char * )
 177 ldap_pvt_str2upper LDAP_P(( char *str ));
 178
 179 LDAP_F( char * )
 180 ldap_pvt_str2lower LDAP_P(( char *str ));
 181
 182 LDAP_F( struct berval * )
 183 ldap_pvt_str2upperbv LDAP_P(( char *str, struct berval *bv ));
 184
 185 LDAP_F( struct berval * )
 186 ldap_pvt_str2lowerbv LDAP_P(( char *str, struct berval *bv ));
 187
 188 /* tls.c */
 189 LDAP_F (int) ldap_int_tls_config LDAP_P(( struct ldap *ld,
 190         int option, const char *arg ));
 191 LDAP_F (int) ldap_pvt_tls_get_option LDAP_P(( struct ldap *ld,
 192         int option, void *arg ));
 193 LDAP_F (int) ldap_pvt_tls_set_option LDAP_P(( struct ldap *ld,
 194         int option, void *arg ));
 195
 196 LDAP_F (void) ldap_pvt_tls_destroy LDAP_P(( void ));
 197 LDAP_F (int) ldap_pvt_tls_init LDAP_P(( void ));
 198 LDAP_F (int) ldap_pvt_tls_init_def_ctx LDAP_P(( void ));
 199 LDAP_F (int) ldap_pvt_tls_accept LDAP_P(( Sockbuf *sb, void *ctx_arg ));
 200 LDAP_F (int) ldap_pvt_tls_inplace LDAP_P(( Sockbuf *sb ));
 201 LDAP_F (void *) ldap_pvt_tls_sb_ctx LDAP_P(( Sockbuf *sb ));
 202
 203 LDAP_F (int) ldap_pvt_tls_init_default_ctx LDAP_P(( void ));
 204
 205 typedef int LDAPDN_rewrite_dummy LDAP_P (( void *dn, unsigned flags ));
 206
 207 LDAP_F (int) ldap_pvt_tls_get_my_dn LDAP_P(( void *ctx, struct berval *dn,
 208         LDAPDN_rewrite_dummy *func, unsigned flags ));
 209 LDAP_F (int) ldap_pvt_tls_get_peer_dn LDAP_P(( void *ctx, struct berval *dn,
 210         LDAPDN_rewrite_dummy *func, unsigned flags ));
 211 LDAP_F (int) ldap_pvt_tls_get_strength LDAP_P(( void *ctx ));
 212
 213 LDAP_END_DECL
 214
 215 #include "ldap_pvt_uc.h"
 216
 217 #endif
 218