passwordbasedauthentication.h
Go to the documentation of this file.
/* SPDX-FileCopyrightText: 2020-2023 Greenbone AG
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef _GVM_UTIL_PASSWORDBASEDAUTHENTICATION_H
#define _GVM_UTIL_PASSWORDBASEDAUTHENTICATION_H
/* max amount of applied pepper */
#define MAX_PEPPER_SIZE 4
/* is used when count is 0 on init*/
#define COUNT_DEFAULT 20000
/* sha512 */
#define PREFIX_DEFAULT "$6$"
struct PBASettings
{
char pepper[MAX_PEPPER_SIZE]; /* is statically applied to the random salt */
unsigned int count; /* controls the computational cost of the hash */
char *prefix; /* controls which hash function will be used */
};
struct PBASettings *
pba_init (const char *pepper, unsigned int pepper_size, unsigned int count,
char *prefix);
/* return values for pba pba_verify_hash */
enum pba_rc
{
VALID, /* hash and password are correct */
UPDATE_RECOMMENDED, /* password is correct but in an outdated format*/
INVALID, /* password is incorrect */
ERR, /* unexpected error */
};
char *
pba_hash (struct PBASettings *setting, const char *password);
enum pba_rc
pba_verify_hash (const struct PBASettings *settings, const char *hash,
const char *password);
void
pba_finalize (struct PBASettings *settings);
#endif /* not _GVM_UTIL_PASSWORDBASEDAUTHENTICATION_H */
pba_finalize
void pba_finalize(struct PBASettings *settings)
Cleanup PBA settings.
Definition passwordbasedauthentication.c:189
pba_verify_hash
enum pba_rc pba_verify_hash(const struct PBASettings *settings, const char *hash, const char *password)
Verify a password hash.
Definition passwordbasedauthentication.c:276
pba_hash
char * pba_hash(struct PBASettings *setting, const char *password)
Create a password hash.
Definition passwordbasedauthentication.c:220
pba_init
struct PBASettings * pba_init(const char *pepper, unsigned int pepper_size, unsigned int count, char *prefix)
Init PBA.
Definition passwordbasedauthentication.c:165
pba_rc
pba_rc
Definition passwordbasedauthentication.h:46
ERR
@ ERR
Definition passwordbasedauthentication.h:50
VALID
@ VALID
Definition passwordbasedauthentication.h:47
UPDATE_RECOMMENDED
@ UPDATE_RECOMMENDED
Definition passwordbasedauthentication.h:48
INVALID
@ INVALID
Definition passwordbasedauthentication.h:49
MAX_PEPPER_SIZE
#define MAX_PEPPER_SIZE
Definition passwordbasedauthentication.h:10
PBASettings
Definition passwordbasedauthentication.h:23
PBASettings::pepper
char pepper[MAX_PEPPER_SIZE]
Definition passwordbasedauthentication.h:24
PBASettings::prefix
char * prefix
Definition passwordbasedauthentication.h:26
PBASettings::count
unsigned int count
Definition passwordbasedauthentication.h:25