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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2001 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 #ifndef _LUTIL_H
  14 #define _LUTIL_H 1
  15
  16 #include <ldap_cdefs.h>
  17 #include <lber_types.h>
  18
  19 /*
  20  * Include file for LDAP utility routine
  21  */
  22
  23 LDAP_BEGIN_DECL
  24
  25 /* n octets encode into ceiling(n/3) * 4 bytes */
  26 /* Avoid floating point math by through extra padding */
  27
  28 #define LUTIL_BASE64_ENCODE_LEN(n)      ((n)/3 * 4 + 4)
  29 #define LUTIL_BASE64_DECODE_LEN(n)      ((n)/4 * 3)
  30
  31 /* ISC Base64 Routines */
  32 /* base64.c */
  33
  34 LDAP_LUTIL_F( int )
  35 lutil_b64_ntop LDAP_P((
  36         unsigned char const *,
  37         size_t,
  38         char *,
  39         size_t));
  40
  41 LDAP_LUTIL_F( int )
  42 lutil_b64_pton LDAP_P((
  43         char const *,
  44         unsigned char *,
  45         size_t));
  46
  47 /* detach.c */
  48 LDAP_LUTIL_F( void )
  49 lutil_detach LDAP_P((
  50         int debug,
  51         int do_close));
  52
  53 /* entropy.c */
  54 LDAP_LUTIL_F( int )
  55 lutil_entropy LDAP_P((
  56         unsigned char *buf,
  57         ber_len_t nbytes ));
  58
  59 /* passwd.c */
  60 struct berval; /* avoid pulling in lber.h */
  61
  62 LDAP_LUTIL_F( int )
  63 lutil_authpasswd LDAP_P((
  64         const struct berval *passwd,    /* stored password */
  65         const struct berval *cred,      /* user supplied value */
  66         const char **methods ));
  67
  68 LDAP_LUTIL_F( int )
  69 lutil_authpasswd_hash LDAP_P((
  70         const struct berval *cred,
  71         struct berval **passwd, /* password to store */
  72         struct berval **salt,   /* salt to store */
  73         const char *method ));
  74
  75 #if defined( SLAPD_SPASSWD ) && defined( HAVE_CYRUS_SASL )
  76         /* cheat to avoid pulling in <sasl.h> */
  77 LDAP_LUTIL_F( struct sasl_conn * ) lutil_passwd_sasl_conn;
  78 #endif
  79
  80 LDAP_LUTIL_F( int )
  81 lutil_passwd LDAP_P((
  82         const struct berval *passwd,    /* stored password */
  83         const struct berval *cred,      /* user supplied value */
  84         const char **methods ));
  85
  86 LDAP_LUTIL_F( struct berval * )
  87 lutil_passwd_generate LDAP_P(( ber_len_t ));
  88
  89 LDAP_LUTIL_F( struct berval * )
  90 lutil_passwd_hash LDAP_P((
  91         const struct berval *passwd,
  92         const char *method ));
  93
  94 LDAP_LUTIL_F( int )
  95 lutil_passwd_scheme LDAP_P((
  96         const char *scheme ));
  97
  98 /* utils.c */
  99 LDAP_LUTIL_F( char* )
 100 lutil_progname LDAP_P((
 101         const char* name,
 102         int argc,
 103         char *argv[] ));
 104
 105 /* sockpair.c */
 106 LDAP_LUTIL_F( int )
 107 lutil_pair( ber_socket_t sd[2] );
 108
 109 LDAP_END_DECL
 110
 111 #endif /* _LUTIL_H */