version 1.23, 1999/12/09 00:11:16
|
version 1.78, 2010/04/13 20:17:49
|
Line 1
|
Line 1
|
/* $OpenLDAP: pkg/ldap/include/lutil.h,v 1.22 1999/12/08 03:37:59 kdz Exp $ */ |
/* $OpenLDAP: pkg/ldap/include/lutil.h,v 1.77 2009/11/15 17:26:53 ando Exp $ */ |
/* |
/* This work is part of OpenLDAP Software <http://www.openldap.org/>. |
* Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA |
* |
|
* Copyright 1998-2010 The OpenLDAP Foundation. |
* All rights reserved. |
* All rights reserved. |
* |
* |
* Redistribution and use in source and binary forms are permitted only |
* Redistribution and use in source and binary forms, with or without |
* as authorized by the OpenLDAP Public License. A copy of this |
* modification, are permitted only as authorized by the OpenLDAP |
* license is available at http://www.OpenLDAP.org/license.html or |
* Public License. |
* in file LICENSE in the top-level directory of the distribution. |
* |
|
* A copy of this license is available in file LICENSE in the |
|
* top-level directory of the distribution or, alternatively, at |
|
* <http://www.OpenLDAP.org/license.html>. |
*/ |
*/ |
|
|
#ifndef _LUTIL_H |
#ifndef _LUTIL_H |
Line 22
|
Line 26
|
LDAP_BEGIN_DECL |
LDAP_BEGIN_DECL |
|
|
/* n octets encode into ceiling(n/3) * 4 bytes */ |
/* n octets encode into ceiling(n/3) * 4 bytes */ |
/* Avoid floating point math by through extra padding */ |
/* Avoid floating point math through extra padding */ |
|
|
#define LUTIL_BASE64_ENCODE_LEN(n) ((n)/3 * 4 + 4) |
#define LUTIL_BASE64_ENCODE_LEN(n) (((n)+2)/3 * 4) |
#define LUTIL_BASE64_DECODE_LEN(n) ((n)/4 * 3) |
#define LUTIL_BASE64_DECODE_LEN(n) ((n)/4*3) |
|
|
/* ISC Base64 Routines */ |
/* ISC Base64 Routines */ |
/* base64.c */ |
/* base64.c */ |
|
|
LIBLUTIL_F( int ) |
LDAP_LUTIL_F( int ) |
lutil_b64_ntop LDAP_P(( |
lutil_b64_ntop LDAP_P(( |
unsigned char const *, |
unsigned char const *, |
size_t, |
size_t, |
char *, |
char *, |
size_t)); |
size_t)); |
|
|
LIBLUTIL_F( int ) |
LDAP_LUTIL_F( int ) |
lutil_b64_pton LDAP_P(( |
lutil_b64_pton LDAP_P(( |
char const *, |
char const *, |
unsigned char *, |
unsigned char *, |
size_t)); |
size_t)); |
|
|
/* detach.c */ |
/* detach.c */ |
LIBLUTIL_F( void ) |
LDAP_LUTIL_F( void ) |
lutil_detach LDAP_P(( |
lutil_detach LDAP_P(( |
int debug, |
int debug, |
int do_close)); |
int do_close)); |
|
|
/* entropy.c */ |
/* entropy.c */ |
LIBLUTIL_F( int ) |
LDAP_LUTIL_F( int ) |
lutil_entropy LDAP_P(( |
lutil_entropy LDAP_P(( |
char *buf, |
unsigned char *buf, |
int nbytes )); |
ber_len_t nbytes )); |
|
|
|
/* passfile.c */ |
|
struct berval; /* avoid pulling in lber.h */ |
|
|
|
LDAP_LUTIL_F( int ) |
|
lutil_get_filed_password LDAP_P(( |
|
const char *filename, |
|
struct berval * )); |
|
|
/* passwd.c */ |
/* passwd.c */ |
struct berval; /* avoid pulling in lber.h */ |
struct lutil_pw_scheme; |
|
|
LIBLUTIL_F( int ) |
#define LUTIL_PASSWD_OK (0) |
lutil_passwd LDAP_P(( |
#define LUTIL_PASSWD_ERR (-1) |
|
|
|
typedef int (LUTIL_PASSWD_CHK_FUNC)( |
|
const struct berval *scheme, |
|
const struct berval *passwd, |
|
const struct berval *cred, |
|
const char **text ); |
|
|
|
typedef int (LUTIL_PASSWD_HASH_FUNC) ( |
|
const struct berval *scheme, |
|
const struct berval *passwd, |
|
struct berval *hash, |
|
const char **text ); |
|
|
|
LDAP_LUTIL_F( int ) |
|
lutil_passwd_add LDAP_P(( |
|
struct berval *scheme, |
|
LUTIL_PASSWD_CHK_FUNC *chk_fn, |
|
LUTIL_PASSWD_HASH_FUNC *hash_fn )); |
|
|
|
LDAP_LUTIL_F( void ) |
|
lutil_passwd_init LDAP_P(( void )); |
|
|
|
LDAP_LUTIL_F( void ) |
|
lutil_passwd_destroy LDAP_P(( void )); |
|
|
|
LDAP_LUTIL_F( int ) |
|
lutil_authpasswd LDAP_P(( |
const struct berval *passwd, /* stored password */ |
const struct berval *passwd, /* stored password */ |
const struct berval *cred, /* user supplied value */ |
const struct berval *cred, /* user supplied value */ |
const char **methods )); |
const char **methods )); |
|
|
LIBLUTIL_F( struct berval * ) |
LDAP_LUTIL_F( int ) |
lutil_passwd_generate LDAP_P(( |
lutil_authpasswd_hash LDAP_P(( |
const struct berval *passwd, |
const struct berval *cred, |
|
struct berval **passwd, /* password to store */ |
|
struct berval **salt, /* salt to store */ |
const char *method )); |
const char *method )); |
|
|
LIBLUTIL_F( int ) |
#ifdef SLAPD_CRYPT |
|
typedef int (lutil_cryptfunc) LDAP_P(( |
|
const char *key, |
|
const char *salt, |
|
char **hash )); |
|
LDAP_LUTIL_V (lutil_cryptfunc *) lutil_cryptptr; |
|
#endif |
|
|
|
LDAP_LUTIL_F( int ) |
|
lutil_passwd LDAP_P(( |
|
const struct berval *passwd, /* stored password */ |
|
const struct berval *cred, /* user supplied value */ |
|
const char **methods, |
|
const char **text )); /* error message */ |
|
|
|
LDAP_LUTIL_F( int ) |
|
lutil_passwd_generate LDAP_P(( struct berval *pw, ber_len_t )); |
|
|
|
LDAP_LUTIL_F( int ) |
|
lutil_passwd_hash LDAP_P(( |
|
const struct berval *passwd, |
|
const char *method, |
|
struct berval *hash, |
|
const char **text )); |
|
|
|
LDAP_LUTIL_F( int ) |
lutil_passwd_scheme LDAP_P(( |
lutil_passwd_scheme LDAP_P(( |
const char *scheme )); |
const char *scheme )); |
|
|
|
LDAP_LUTIL_F( int ) |
|
lutil_salt_format LDAP_P(( |
|
const char *format )); |
|
|
/* utils.c */ |
/* utils.c */ |
LIBLUTIL_F( char* ) |
LDAP_LUTIL_F( char* ) |
lutil_progname LDAP_P(( |
lutil_progname LDAP_P(( |
const char* name, |
const char* name, |
int argc, |
int argc, |
char *argv[] )); |
char *argv[] )); |
|
|
|
typedef struct lutil_tm { |
|
int tm_sec; /* seconds 0-60 (1 leap second) */ |
|
int tm_min; /* minutes 0-59 */ |
|
int tm_hour; /* hours 0-23 */ |
|
int tm_mday; /* day 1-31 */ |
|
int tm_mon; /* month 0-11 */ |
|
int tm_year; /* year - 1900 */ |
|
int tm_usec; /* microseconds */ |
|
int tm_usub; /* submicro */ |
|
} lutil_tm; |
|
|
|
typedef struct lutil_timet { |
|
unsigned int tt_sec; /* seconds since 1900 */ |
|
int tt_gsec; /* seconds since 1900, high 7 bits */ |
|
unsigned int tt_usec; /* microseconds */ |
|
} lutil_timet; |
|
|
|
/* Parse a timestamp string into a structure */ |
|
LDAP_LUTIL_F( int ) |
|
lutil_parsetime LDAP_P(( |
|
char *atm, struct lutil_tm * )); |
|
|
|
/* Convert structured time to time in seconds since 1900 */ |
|
LDAP_LUTIL_F( int ) |
|
lutil_tm2time LDAP_P(( |
|
struct lutil_tm *, struct lutil_timet * )); |
|
|
|
#ifdef _WIN32 |
|
LDAP_LUTIL_F( void ) |
|
lutil_slashpath LDAP_P(( char* path )); |
|
#define LUTIL_SLASHPATH(p) lutil_slashpath(p) |
|
#else |
|
#define LUTIL_SLASHPATH(p) |
|
#endif |
|
|
|
LDAP_LUTIL_F( char* ) |
|
lutil_strcopy LDAP_P(( char *dst, const char *src )); |
|
|
|
LDAP_LUTIL_F( char* ) |
|
lutil_strncopy LDAP_P(( char *dst, const char *src, size_t n )); |
|
|
|
LDAP_LUTIL_F( char* ) |
|
lutil_memcopy LDAP_P(( char *dst, const char *src, size_t n )); |
|
|
|
#define lutil_strbvcopy(a, bv) lutil_memcopy((a),(bv)->bv_val,(bv)->bv_len) |
|
|
|
struct tm; |
|
|
|
/* use this macro to statically allocate buffer for lutil_gentime */ |
|
#define LDAP_LUTIL_GENTIME_BUFSIZE 22 |
|
#define lutil_gentime(s,m,t) lutil_localtime((s),(m),(t),0) |
|
LDAP_LUTIL_F( size_t ) |
|
lutil_localtime LDAP_P(( char *s, size_t smax, const struct tm *tm, |
|
long delta )); |
|
|
|
#ifndef HAVE_MKSTEMP |
|
LDAP_LUTIL_F( int ) |
|
mkstemp LDAP_P (( char * template )); |
|
#endif |
|
|
/* sockpair.c */ |
/* sockpair.c */ |
LIBLUTIL_F( int ) |
LDAP_LUTIL_F( int ) |
lutil_pair( LBER_SOCKET_T sd[2] ); |
lutil_pair( ber_socket_t sd[2] ); |
|
|
|
/* uuid.c */ |
|
/* use this macro to allocate buffer for lutil_uuidstr */ |
|
#define LDAP_LUTIL_UUIDSTR_BUFSIZE 40 |
|
LDAP_LUTIL_F( size_t ) |
|
lutil_uuidstr( char *buf, size_t len ); |
|
|
|
LDAP_LUTIL_F( int ) |
|
lutil_uuidstr_from_normalized( |
|
char *uuid, |
|
size_t uuidlen, |
|
char *buf, |
|
size_t buflen ); |
|
|
|
/* |
|
* Sometimes not all declarations in a header file are needed. |
|
* An indicator to this is whether or not the symbol's type has |
|
* been defined. Thus, we don't need to include a symbol if |
|
* its type has not been defined through another header file. |
|
*/ |
|
|
|
#ifdef HAVE_NT_SERVICE_MANAGER |
|
LDAP_LUTIL_V (int) is_NT_Service; |
|
|
|
#ifdef _LDAP_PVT_THREAD_H |
|
LDAP_LUTIL_V (ldap_pvt_thread_cond_t) started_event; |
|
#endif /* _LDAP_PVT_THREAD_H */ |
|
|
|
/* macros are different between Windows and Mingw */ |
|
#if defined(_WINSVC_H) || defined(_WINSVC_) |
|
LDAP_LUTIL_V (SERVICE_STATUS) lutil_ServiceStatus; |
|
LDAP_LUTIL_V (SERVICE_STATUS_HANDLE) hlutil_ServiceStatus; |
|
#endif /* _WINSVC_H */ |
|
|
|
LDAP_LUTIL_F (void) |
|
lutil_CommenceStartupProcessing( char *serverName, void (*stopper)(int)) ; |
|
|
|
LDAP_LUTIL_F (void) |
|
lutil_ReportShutdownComplete( void ); |
|
|
|
LDAP_LUTIL_F (void *) |
|
lutil_getRegParam( char *svc, char *value ); |
|
|
|
LDAP_LUTIL_F (int) |
|
lutil_srv_install( char* service, char * displayName, char* filename, |
|
int auto_start ); |
|
LDAP_LUTIL_F (int) |
|
lutil_srv_remove ( char* service, char* filename ); |
|
|
|
#endif /* HAVE_NT_SERVICE_MANAGER */ |
|
|
|
#ifdef HAVE_NT_EVENT_LOG |
|
LDAP_LUTIL_F (void) |
|
lutil_LogStartedEvent( char *svc, int slap_debug, char *configfile, char *urls ); |
|
|
|
LDAP_LUTIL_F (void) |
|
lutil_LogStoppedEvent( char *svc ); |
|
#endif |
|
|
|
#ifdef HAVE_EBCDIC |
|
/* Generally this has only been used to put '\n' to stdout. We need to |
|
* make sure it is output in EBCDIC. |
|
*/ |
|
#undef putchar |
|
#undef putc |
|
#define putchar(c) putc((c), stdout) |
|
#define putc(c,fp) do { char x=(c); __atoe_l(&x,1); putc(x,fp); } while(0) |
|
#endif |
|
|
|
LDAP_LUTIL_F (int) |
|
lutil_atoix( int *v, const char *s, int x ); |
|
|
|
LDAP_LUTIL_F (int) |
|
lutil_atoux( unsigned *v, const char *s, int x ); |
|
|
|
LDAP_LUTIL_F (int) |
|
lutil_atolx( long *v, const char *s, int x ); |
|
|
|
LDAP_LUTIL_F (int) |
|
lutil_atoulx( unsigned long *v, const char *s, int x ); |
|
|
|
#define lutil_atoi(v, s) lutil_atoix((v), (s), 10) |
|
#define lutil_atou(v, s) lutil_atoux((v), (s), 10) |
|
#define lutil_atol(v, s) lutil_atolx((v), (s), 10) |
|
#define lutil_atoul(v, s) lutil_atoulx((v), (s), 10) |
|
|
|
LDAP_LUTIL_F (int) |
|
lutil_str2bin( struct berval *in, struct berval *out, void *ctx ); |
|
|
|
/* Parse and unparse time intervals */ |
|
LDAP_LUTIL_F (int) |
|
lutil_parse_time( const char *in, unsigned long *tp ); |
|
|
|
LDAP_LUTIL_F (int) |
|
lutil_unparse_time( char *buf, size_t buflen, unsigned long t ); |
|
|
|
#ifdef timerdiv |
|
#define lutil_timerdiv timerdiv |
|
#else /* ! timerdiv */ |
|
/* works inplace (x == t) */ |
|
#define lutil_timerdiv(t,d,x) \ |
|
do { \ |
|
time_t s = (t)->tv_sec; \ |
|
assert( d > 0 ); \ |
|
(x)->tv_sec = s / d; \ |
|
(x)->tv_usec = ( (t)->tv_usec + 1000000 * ( s % d ) ) / d; \ |
|
} while ( 0 ) |
|
#endif /* ! timerdiv */ |
|
|
|
#ifdef timermul |
|
#define lutil_timermul timermul |
|
#else /* ! timermul */ |
|
/* works inplace (x == t) */ |
|
#define lutil_timermul(t,m,x) \ |
|
do { \ |
|
time_t u = (t)->tv_usec * m; \ |
|
assert( m > 0 ); \ |
|
(x)->tv_sec = (t)->tv_sec * m + u / 1000000; \ |
|
(x)->tv_usec = u % 1000000; \ |
|
} while ( 0 ); |
|
#endif /* ! timermul */ |
|
|
LDAP_END_DECL |
LDAP_END_DECL |
|
|