/* saslutil.h -- various utility functions in SASL library

[0] Fix | Delete

*/

[1] Fix | Delete

[2] Fix | Delete

#ifndef SASLUTIL_H

[3] Fix | Delete

#define SASLUTIL_H 1

[4] Fix | Delete

[5] Fix | Delete

#ifndef SASL_H

[6] Fix | Delete

#include "sasl.h"

[7] Fix | Delete

#endif

[8] Fix | Delete

[9] Fix | Delete

#ifdef __cplusplus

[10] Fix | Delete

extern "C" {

[11] Fix | Delete

#endif

[12] Fix | Delete

[13] Fix | Delete

/* base64 decode

[14] Fix | Delete

* in -- input data

[15] Fix | Delete

* inlen -- length of input data

[16] Fix | Delete

* out -- output data (may be same as in, must have enough space)

[17] Fix | Delete

* outmax -- max size of output buffer

[18] Fix | Delete

* result:

[19] Fix | Delete

* outlen -- actual output length

[20] Fix | Delete

*

[21] Fix | Delete

* returns SASL_BADPROT on bad base64,

[22] Fix | Delete

* SASL_BUFOVER if result won't fit

[23] Fix | Delete

* SASL_OK on success

[24] Fix | Delete

*/

[25] Fix | Delete

LIBSASL_API int sasl_decode64(const char *in, unsigned inlen,

[26] Fix | Delete

char *out, unsigned outmax, unsigned *outlen);

[27] Fix | Delete

[28] Fix | Delete

/* base64 encode

[29] Fix | Delete

* in -- input data

[30] Fix | Delete

* inlen -- input data length

[31] Fix | Delete

* out -- output buffer (will be NUL terminated)

[32] Fix | Delete

* outmax -- max size of output buffer

[33] Fix | Delete

* result:

[34] Fix | Delete

* outlen -- gets actual length of output buffer (optional)

[35] Fix | Delete

*

[36] Fix | Delete

* Returns SASL_OK on success, SASL_BUFOVER if result won't fit

[37] Fix | Delete

*/

[38] Fix | Delete

LIBSASL_API int sasl_encode64(const char *in, unsigned inlen,

[39] Fix | Delete

char *out, unsigned outmax, unsigned *outlen);

[40] Fix | Delete

[41] Fix | Delete

/* make a challenge string (NUL terminated)

[42] Fix | Delete

* buf -- buffer for result

[43] Fix | Delete

* maxlen -- max length of result

[44] Fix | Delete

* hostflag -- 0 = don't include hostname, 1 = include hostname

[45] Fix | Delete

* returns final length or 0 if not enough space

[46] Fix | Delete

*/

[47] Fix | Delete

LIBSASL_API int sasl_mkchal(sasl_conn_t *conn, char *buf,

[48] Fix | Delete

unsigned maxlen, unsigned hostflag);

[49] Fix | Delete

[50] Fix | Delete

/* verify a string is valid UTF-8

[51] Fix | Delete

* if len == 0, strlen(str) will be used.

[52] Fix | Delete

* returns SASL_BADPROT on error, SASL_OK on success

[53] Fix | Delete

*/

[54] Fix | Delete

LIBSASL_API int sasl_utf8verify(const char *str, unsigned len);

[55] Fix | Delete

[56] Fix | Delete

/* create random pool seeded with OS-based params */

[57] Fix | Delete

LIBSASL_API int sasl_randcreate(sasl_rand_t **rpool);

[58] Fix | Delete

[59] Fix | Delete

/* free random pool from randcreate */

[60] Fix | Delete

LIBSASL_API void sasl_randfree(sasl_rand_t **rpool);

[61] Fix | Delete

[62] Fix | Delete

/* seed random number generator */

[63] Fix | Delete

LIBSASL_API void sasl_randseed(sasl_rand_t *rpool, const char *seed,

[64] Fix | Delete

unsigned len);

[65] Fix | Delete

[66] Fix | Delete

/* generate random octets */

[67] Fix | Delete

LIBSASL_API void sasl_rand(sasl_rand_t *rpool, char *buf, unsigned len);

[68] Fix | Delete

[69] Fix | Delete

/* churn data into random number generator */

[70] Fix | Delete

LIBSASL_API void sasl_churn(sasl_rand_t *rpool, const char *data,

[71] Fix | Delete

unsigned len);

[72] Fix | Delete

[73] Fix | Delete

/* erase a security sensitive buffer or password.

[74] Fix | Delete

* Implementation may use recovery-resistant erase logic.

[75] Fix | Delete

*/

[76] Fix | Delete

LIBSASL_API void sasl_erasebuffer(char *pass, unsigned len);

[77] Fix | Delete

[78] Fix | Delete

/* Lowercase string in place */

[79] Fix | Delete

LIBSASL_API char *sasl_strlower (char *val);

[80] Fix | Delete

[81] Fix | Delete

LIBSASL_API int sasl_config_init(const char *filename);

[82] Fix | Delete

[83] Fix | Delete

LIBSASL_API void sasl_config_done(void);

[84] Fix | Delete

[85] Fix | Delete

#ifdef WIN32

[86] Fix | Delete

/* Just in case a different DLL defines this as well */

[87] Fix | Delete

#if defined(NEED_GETOPT)

[88] Fix | Delete

LIBSASL_API int getopt(int argc, char **argv, char *optstring);

[89] Fix | Delete

#endif

[90] Fix | Delete

LIBSASL_API char * getpass(const char *prompt);

[91] Fix | Delete

#endif /* WIN32 */

[92] Fix | Delete

[93] Fix | Delete

#ifdef __cplusplus

[94] Fix | Delete

}

[95] Fix | Delete

#endif

[96] Fix | Delete

[97] Fix | Delete

#endif /* SASLUTIL_H */

[98] Fix | Delete

[99] Fix | Delete