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

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1998-2009 The OpenLDAP Foundation.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted only as authorized by the OpenLDAP
   9  * Public License.
  10  *
  11  * A copy of this license is available in file LICENSE in the
  12  * top-level directory of the distribution or, alternatively, at
  13  * <http://www.OpenLDAP.org/license.html>.
  14  */
  15
  16 #ifndef _LUTIL_H
  17 #define _LUTIL_H 1
  18
  19 #include <ldap_cdefs.h>
  20 #include <lber_types.h>
  21
  22 /*
  23  * Include file for LDAP utility routine
  24  */
  25
  26 LDAP_BEGIN_DECL
  27
  28 /* n octets encode into ceiling(n/3) * 4 bytes */
  29 /* Avoid floating point math through extra padding */
  30
  31 #define LUTIL_BASE64_ENCODE_LEN(n)      (((n)+2)/3 * 4)
  32 #define LUTIL_BASE64_DECODE_LEN(n)      ((n)/4*3)
  33
  34 /* ISC Base64 Routines */
  35 /* base64.c */
  36
  37 LDAP_LUTIL_F( int )
  38 lutil_b64_ntop LDAP_P((
  39         unsigned char const *,
  40         size_t,
  41         char *,
  42         size_t));
  43
  44 LDAP_LUTIL_F( int )
  45 lutil_b64_pton LDAP_P((
  46         char const *,
  47         unsigned char *,
  48         size_t));
  49
  50 /* detach.c */
  51 LDAP_LUTIL_F( void )
  52 lutil_detach LDAP_P((
  53         int debug,
  54         int do_close));
  55
  56 /* entropy.c */
  57 LDAP_LUTIL_F( int )
  58 lutil_entropy LDAP_P((
  59         unsigned char *buf,
  60         ber_len_t nbytes ));
  61
  62 /* passfile.c */
  63 struct berval;  /* avoid pulling in lber.h */
  64
  65 LDAP_LUTIL_F( int )
  66 lutil_get_filed_password LDAP_P((
  67         const char *filename,
  68         struct berval * ));
  69
  70 /* passwd.c */
  71 struct lutil_pw_scheme;
  72
  73 #define LUTIL_PASSWD_OK         (0)
  74 #define LUTIL_PASSWD_ERR        (-1)
  75
  76 typedef int (LUTIL_PASSWD_CHK_FUNC)(
  77         const struct berval *scheme,
  78         const struct berval *passwd,
  79         const struct berval *cred,
  80         const char **text );
  81
  82 typedef int (LUTIL_PASSWD_HASH_FUNC) (
  83         const struct berval *scheme,
  84         const struct berval *passwd,
  85         struct berval *hash,
  86         const char **text );
  87
  88 LDAP_LUTIL_F( int )
  89 lutil_passwd_add LDAP_P((
  90         struct berval *scheme,
  91         LUTIL_PASSWD_CHK_FUNC *chk_fn,
  92         LUTIL_PASSWD_HASH_FUNC *hash_fn ));
  93
  94 LDAP_LUTIL_F( void )
  95 lutil_passwd_init LDAP_P(( void ));
  96
  97 LDAP_LUTIL_F( void )
  98 lutil_passwd_destroy LDAP_P(( void ));
  99
 100 LDAP_LUTIL_F( int )
 101 lutil_authpasswd LDAP_P((
 102         const struct berval *passwd,    /* stored password */
 103         const struct berval *cred,      /* user supplied value */
 104         const char **methods ));
 105
 106 LDAP_LUTIL_F( int )
 107 lutil_authpasswd_hash LDAP_P((
 108         const struct berval *cred,
 109         struct berval **passwd, /* password to store */
 110         struct berval **salt,   /* salt to store */
 111         const char *method ));
 112
 113 #ifdef SLAPD_CRYPT
 114 typedef int (lutil_cryptfunc) LDAP_P((
 115         const char *key,
 116         const char *salt,
 117         char **hash ));
 118 LDAP_LUTIL_V (lutil_cryptfunc *) lutil_cryptptr;
 119 #endif
 120
 121 LDAP_LUTIL_F( int )
 122 lutil_passwd LDAP_P((
 123         const struct berval *passwd,    /* stored password */
 124         const struct berval *cred,      /* user supplied value */
 125         const char **methods,
 126         const char **text ));                   /* error message */
 127
 128 LDAP_LUTIL_F( int )
 129 lutil_passwd_generate LDAP_P(( struct berval *pw, ber_len_t ));
 130
 131 LDAP_LUTIL_F( int )
 132 lutil_passwd_hash LDAP_P((
 133         const struct berval *passwd,
 134         const char *method,
 135         struct berval *hash,
 136         const char **text ));
 137
 138 LDAP_LUTIL_F( int )
 139 lutil_passwd_scheme LDAP_P((
 140         const char *scheme ));
 141
 142 LDAP_LUTIL_F( int )
 143 lutil_salt_format LDAP_P((
 144         const char *format ));
 145
 146 /* utils.c */
 147 LDAP_LUTIL_F( char* )
 148 lutil_progname LDAP_P((
 149         const char* name,
 150         int argc,
 151         char *argv[] ));
 152
 153 typedef struct lutil_tm {
 154         int tm_sec;     /* seconds 0-60 (1 leap second) */
 155         int tm_min;     /* minutes 0-59 */
 156         int tm_hour;    /* hours 0-23 */
 157         int tm_mday;    /* day 1-31 */
 158         int tm_mon;     /* month 0-11 */
 159         int tm_year;    /* year - 1900 */
 160         int tm_usec;    /* microseconds */
 161         int tm_usub;    /* submicro */
 162 } lutil_tm;
 163
 164 typedef struct lutil_timet {
 165         unsigned int tt_sec;    /* seconds since 1900 */
 166         int tt_gsec;            /* seconds since 1900, high 7 bits */
 167         unsigned int tt_usec;   /* microseconds */
 168 } lutil_timet;
 169
 170 /* Parse a timestamp string into a structure */
 171 LDAP_LUTIL_F( int )
 172 lutil_parsetime LDAP_P((
 173         char *atm, struct lutil_tm * ));
 174
 175 /* Convert structured time to time in seconds since 1900 */
 176 LDAP_LUTIL_F( int )
 177 lutil_tm2time LDAP_P((
 178         struct lutil_tm *, struct lutil_timet * ));
 179
 180 #ifdef _WIN32
 181 LDAP_LUTIL_F( void )
 182 lutil_slashpath LDAP_P(( char* path ));
 183 #define LUTIL_SLASHPATH(p)      lutil_slashpath(p)
 184 #else
 185 #define LUTIL_SLASHPATH(p)
 186 #endif
 187
 188 LDAP_LUTIL_F( char* )
 189 lutil_strcopy LDAP_P(( char *dst, const char *src ));
 190
 191 LDAP_LUTIL_F( char* )
 192 lutil_strncopy LDAP_P(( char *dst, const char *src, size_t n ));
 193
 194 LDAP_LUTIL_F( char* )
 195 lutil_memcopy LDAP_P(( char *dst, const char *src, size_t n ));
 196
 197 #define lutil_strbvcopy(a, bv) lutil_memcopy((a),(bv)->bv_val,(bv)->bv_len)
 198
 199 struct tm;
 200
 201 /* use this macro to statically allocate buffer for lutil_gentime */
 202 #define LDAP_LUTIL_GENTIME_BUFSIZE      22
 203 #define lutil_gentime(s,m,t)    lutil_localtime((s),(m),(t),0)
 204 LDAP_LUTIL_F( size_t )
 205 lutil_localtime LDAP_P(( char *s, size_t smax, const struct tm *tm,
 206                         long delta ));
 207
 208 #ifndef HAVE_MKSTEMP
 209 LDAP_LUTIL_F( int )
 210 mkstemp LDAP_P (( char * template ));
 211 #endif
 212
 213 /* sockpair.c */
 214 LDAP_LUTIL_F( int )
 215 lutil_pair( ber_socket_t sd[2] );
 216
 217 /* uuid.c */
 218 /* use this macro to allocate buffer for lutil_uuidstr */
 219 #define LDAP_LUTIL_UUIDSTR_BUFSIZE      40
 220 LDAP_LUTIL_F( size_t )
 221 lutil_uuidstr( char *buf, size_t len );
 222
 223 LDAP_LUTIL_F( int )
 224 lutil_uuidstr_from_normalized(
 225         char            *uuid,
 226         size_t          uuidlen,
 227         char            *buf,
 228         size_t          buflen );
 229
 230 /*
 231  * Sometimes not all declarations in a header file are needed.
 232  * An indicator to this is whether or not the symbol's type has
 233  * been defined. Thus, we don't need to include a symbol if
 234  * its type has not been defined through another header file.
 235  */
 236
 237 #ifdef HAVE_NT_SERVICE_MANAGER
 238 LDAP_LUTIL_V (int) is_NT_Service;
 239
 240 #ifdef _LDAP_PVT_THREAD_H
 241 LDAP_LUTIL_V (ldap_pvt_thread_cond_t) started_event;
 242 #endif /* _LDAP_PVT_THREAD_H */
 243
 244 /* macros are different between Windows and Mingw */
 245 #if defined(_WINSVC_H) || defined(_WINSVC_)
 246 LDAP_LUTIL_V (SERVICE_STATUS) lutil_ServiceStatus;
 247 LDAP_LUTIL_V (SERVICE_STATUS_HANDLE) hlutil_ServiceStatus;
 248 #endif /* _WINSVC_H */
 249
 250 LDAP_LUTIL_F (void)
 251 lutil_CommenceStartupProcessing( char *serverName, void (*stopper)(int)) ;
 252
 253 LDAP_LUTIL_F (void)
 254 lutil_ReportShutdownComplete( void );
 255
 256 LDAP_LUTIL_F (void *)
 257 lutil_getRegParam( char *svc, char *value );
 258
 259 LDAP_LUTIL_F (int)
 260 lutil_srv_install( char* service, char * displayName, char* filename,
 261                  int auto_start );
 262 LDAP_LUTIL_F (int)
 263 lutil_srv_remove ( char* service, char* filename );
 264
 265 #endif /* HAVE_NT_SERVICE_MANAGER */
 266
 267 #ifdef HAVE_NT_EVENT_LOG
 268 LDAP_LUTIL_F (void)
 269 lutil_LogStartedEvent( char *svc, int slap_debug, char *configfile, char *urls );
 270
 271 LDAP_LUTIL_F (void)
 272 lutil_LogStoppedEvent( char *svc );
 273 #endif
 274
 275 #ifdef HAVE_EBCDIC
 276 /* Generally this has only been used to put '\n' to stdout. We need to
 277  * make sure it is output in EBCDIC.
 278  */
 279 #undef putchar
 280 #undef putc
 281 #define putchar(c)     putc((c), stdout)
 282 #define putc(c,fp)     do { char x=(c); __atoe_l(&x,1); putc(x,fp); } while(0)
 283 #endif
 284
 285 LDAP_LUTIL_F (int)
 286 lutil_atoix( int *v, const char *s, int x );
 287
 288 LDAP_LUTIL_F (int)
 289 lutil_atoux( unsigned *v, const char *s, int x );
 290
 291 LDAP_LUTIL_F (int)
 292 lutil_atolx( long *v, const char *s, int x );
 293
 294 LDAP_LUTIL_F (int)
 295 lutil_atoulx( unsigned long *v, const char *s, int x );
 296
 297 #define lutil_atoi(v, s)        lutil_atoix((v), (s), 10)
 298 #define lutil_atou(v, s)        lutil_atoux((v), (s), 10)
 299 #define lutil_atol(v, s)        lutil_atolx((v), (s), 10)
 300 #define lutil_atoul(v, s)       lutil_atoulx((v), (s), 10)
 301
 302 LDAP_LUTIL_F (int)
 303 lutil_str2bin( struct berval *in, struct berval *out, void *ctx );
 304
 305 /* Parse and unparse time intervals */
 306 LDAP_LUTIL_F (int)
 307 lutil_parse_time( const char *in, unsigned long *tp );
 308
 309 LDAP_LUTIL_F (int)
 310 lutil_unparse_time( char *buf, size_t buflen, unsigned long t );
 311
 312 #ifdef timerdiv
 313 #define lutil_timerdiv timerdiv
 314 #else /* ! timerdiv */
 315 /* works inplace (x == t) */
 316 #define lutil_timerdiv(t,d,x) \
 317         do { \
 318                 time_t s = (t)->tv_sec; \
 319                 assert( d > 0 ); \
 320                 (x)->tv_sec = s / d; \
 321                 (x)->tv_usec = ( (t)->tv_usec + 1000000 * ( s % d ) ) / d; \
 322         } while ( 0 )
 323 #endif /* ! timerdiv */
 324
 325 #ifdef timermul
 326 #define lutil_timermul timermul
 327 #else /* ! timermul */
 328 /* works inplace (x == t) */
 329 #define lutil_timermul(t,m,x) \
 330         do { \
 331                 time_t u = (t)->tv_usec * m; \
 332                 assert( m > 0 ); \
 333                 (x)->tv_sec = (t)->tv_sec * m + u / 1000000; \
 334                 (x)->tv_usec = u % 1000000; \
 335         } while ( 0 );
 336 #endif /* ! timermul */
 337
 338 LDAP_END_DECL
 339
 340 #endif /* _LUTIL_H */