version 1.2.2.3, 1998/11/16 23:24:22
|
version 1.55, 2004/03/19 07:06:42
|
Line 1
|
Line 1
|
|
/* $OpenLDAP: pkg/ldap/include/lutil.h,v 1.54 2004/03/12 19:07:58 ando Exp $ */ |
|
/* This work is part of OpenLDAP Software <http://www.openldap.org/>. |
|
* |
|
* Copyright 1998-2004 The OpenLDAP Foundation. |
|
* All rights reserved. |
|
* |
|
* 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 |
|
* <http://www.OpenLDAP.org/license.html>. |
|
*/ |
|
|
#ifndef _LUTIL_H |
#ifndef _LUTIL_H |
#define _LUTIL_H 1 |
#define _LUTIL_H 1 |
|
|
#include <ldap_cdefs.h> |
#include <ldap_cdefs.h> |
|
#include <lber_types.h> |
|
|
/* |
/* |
* Include file for LDAP utility routine |
* Include file for LDAP utility routine |
*/ |
*/ |
|
|
LDAP_BEGIN_DECL |
LDAP_BEGIN_DECL |
|
|
|
/* n octets encode into ceiling(n/3) * 4 bytes */ |
|
/* Avoid floating point math through extra padding */ |
|
|
|
#define LUTIL_BASE64_ENCODE_LEN(n) (((n)+2)/3 * 4) |
|
#define LUTIL_BASE64_DECODE_LEN(n) ((n)/4*3) |
|
|
/* ISC Base64 Routines */ |
/* ISC Base64 Routines */ |
/* base64.c */ |
/* base64.c */ |
LDAP_F int b64_ntop LDAP_P((u_char const *, size_t, char *, size_t)); |
|
LDAP_F int b64_pton LDAP_P((char const *, u_char *, size_t)); |
LDAP_LUTIL_F( int ) |
|
lutil_b64_ntop LDAP_P(( |
|
unsigned char const *, |
|
size_t, |
|
char *, |
|
size_t)); |
|
|
|
LDAP_LUTIL_F( int ) |
|
lutil_b64_pton LDAP_P(( |
|
char const *, |
|
unsigned char *, |
|
size_t)); |
|
|
/* detach.c */ |
/* detach.c */ |
LDAP_F void lutil_detach LDAP_P((int debug, int do_close)); |
LDAP_LUTIL_F( void ) |
|
lutil_detach LDAP_P(( |
|
int debug, |
|
int do_close)); |
|
|
|
/* entropy.c */ |
|
LDAP_LUTIL_F( int ) |
|
lutil_entropy LDAP_P(( |
|
unsigned char *buf, |
|
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 */ |
LDAP_F int lutil_passwd LDAP_P((const char *cred, const char *passwd)); |
struct lutil_pw_scheme; |
|
|
|
#define LUTIL_PASSWD_OK (0) |
|
#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 *cred, /* user supplied value */ |
|
const char **methods )); |
|
|
|
LDAP_LUTIL_F( int ) |
|
lutil_authpasswd_hash LDAP_P(( |
|
const struct berval *cred, |
|
struct berval **passwd, /* password to store */ |
|
struct berval **salt, /* salt to store */ |
|
const char *method )); |
|
|
|
#if defined( SLAPD_SPASSWD ) && defined( HAVE_CYRUS_SASL ) |
|
/* cheat to avoid pulling in <sasl.h> */ |
|
LDAP_LUTIL_V( struct sasl_conn * ) lutil_passwd_sasl_conn; |
|
#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(( |
|
const char *scheme )); |
|
|
|
LDAP_LUTIL_F( int ) |
|
lutil_salt_format LDAP_P(( |
|
const char *format )); |
|
|
|
/* utils.c */ |
|
LDAP_LUTIL_F( char* ) |
|
lutil_progname LDAP_P(( |
|
const char* name, |
|
int argc, |
|
char *argv[] )); |
|
|
|
#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 )); |
|
|
|
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 */ |
|
LDAP_LUTIL_F( int ) |
|
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 ); |
|
|
|
/* csn.c */ |
|
/* use this macro to allocate buffer for lutil_csnstr */ |
|
#define LDAP_LUTIL_CSNSTR_BUFSIZE 64 |
|
LDAP_LUTIL_F( size_t ) |
|
lutil_csnstr( char *buf, size_t len, unsigned int replica, unsigned int mod ); |
|
|
|
/* |
|
* 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_END_DECL |
LDAP_END_DECL |
|
|