Mercurial > dovecot > core-2.2
view src/auth/password-scheme.h @ 14629:c93ca5e46a8a
Marked functions parameters that are allowed to be NULL. Some APIs were also changed.
The non-obvious APIs where NULL parameter was changed to "" are
master_service_init() and auth_master_user_list_init().
These checks can currently be enabled only on a patched clang:
http://llvm.org/bugs/show_bug.cgi?id=6786
author | Timo Sirainen <tss@iki.fi> |
---|---|
date | Sun, 24 Jun 2012 00:52:57 +0300 |
parents | c9894346b1a3 |
children | 3e3ac2c16fa4 |
line wrap: on
line source
#ifndef PASSWORD_SCHEME_H #define PASSWORD_SCHEME_H enum password_encoding { PW_ENCODING_NONE, PW_ENCODING_BASE64, PW_ENCODING_HEX }; struct password_scheme { const char *name; enum password_encoding default_encoding; /* If non-zero, this is the expected raw password length. It can be used to automatically detect encoding between hex and base64 encoded passwords. */ unsigned int raw_password_len; int (*password_verify)(const char *plaintext, const char *user, const unsigned char *raw_password, size_t size, const char **error_r); void (*password_generate)(const char *plaintext, const char *user, const unsigned char **raw_password_r, size_t *size_r); }; ARRAY_DEFINE_TYPE(password_scheme_p, const struct password_scheme *); extern ARRAY_TYPE(password_scheme_p) password_schemes; /* Returns 1 = matched, 0 = didn't match, -1 = unknown scheme or invalid raw_password */ int password_verify(const char *plaintext, const char *user, const char *scheme, const unsigned char *raw_password, size_t size, const char **error_r); /* Extracts scheme from password, or returns NULL if it isn't found. If auth_request is given, it's used for debug logging. */ const char *password_get_scheme(const char **password); /* Decode encoded (base64/hex) password to raw form. Returns 1 if ok, 0 if scheme is unknown, -1 if password is invalid. */ int password_decode(const char *password, const char *scheme, const unsigned char **raw_password_r, size_t *size_r, const char **error_r); /* Create password with wanted scheme out of plaintext password and username. Potential base64/hex directives are ignored in scheme. Returns FALSE if the scheme is unknown. */ bool password_generate(const char *plaintext, const char *user, const char *scheme, const unsigned char **raw_password_r, size_t *size_r); /* Like above, but generate encoded passwords. If hex/base64 directive isn't specified in the scheme, the default encoding for the scheme is used. Returns FALSE if the scheme is unknown. */ bool password_generate_encoded(const char *plaintext, const char *user, const char *scheme, const char **password_r); /* Returns TRUE if schemes are equivalent. */ bool password_scheme_is_alias(const char *scheme1, const char *scheme2); /* Try to detect in which scheme crypted password is. Returns the scheme name or NULL if nothing was found. */ const char * password_scheme_detect(const char *plain_password, const char *crypted_password, const char *user); void password_scheme_register(const struct password_scheme *scheme); void password_scheme_unregister(const struct password_scheme *scheme); void password_schemes_init(void); void password_schemes_deinit(void); /* some password schemes/algorithms supports a variable number of encryption rounds. */ void password_set_encryption_rounds(unsigned int rounds); /* INTERNAL: */ const char *password_generate_salt(size_t len); const char *password_generate_md5_crypt(const char *pw, const char *salt); int password_generate_otp(const char *pw, const char *state_data, unsigned int algo, const char **result_r) ATTR_NULL(2); void password_generate_rpa(const char *pw, unsigned char result[]); int crypt_verify(const char *plaintext, const char *user, const unsigned char *raw_password, size_t size, const char **error_r); /* check wich of the algorithms Blowfisch, SHA-256 and SHA-512 are supported by the used libc's/glibc's crypt() */ void password_scheme_register_crypt(void); #endif