.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gsasl_scram_secrets_from_password" 3 "1.10.0" "gsasl" "gsasl"
.SH NAME
gsasl_scram_secrets_from_password \- API function
.SH SYNOPSIS
.B #include <gsasl.h>
.sp
.BI "int gsasl_scram_secrets_from_password(Gsasl_hash " hash ", const char * " password ", unsigned int " iteration_count ", const char * " salt ", size_t " saltlen ", char * " salted_password ", char * " client_key ", char * " server_key ", char * " stored_key ");"
.SH ARGUMENTS
.IP "Gsasl_hash hash" 12
a \fBGsasl_hash\fP element, e.g., \fBGSASL_HASH_SHA256\fP.
.IP "const char * password" 12
input parameter with password.
.IP "unsigned int iteration_count" 12
number of PBKDF2 rounds to apply.
.IP "const char * salt" 12
input character array of  \fIsaltlen\fP length with salt for PBKDF2.
.IP "size_t saltlen" 12
length of  \fIsalt\fP .
.IP "char * salted_password" 12
pre\-allocated output array with derived salted password.
.IP "char * client_key" 12
pre\-allocated output array with derived client key.
.IP "char * server_key" 12
pre\-allocated output array with derived server key.
.IP "char * stored_key" 12
pre\-allocated output array with derived stored key.
.SH "DESCRIPTION"
Helper function to generate SCRAM secrets from a password.  The
 \fIsalted_password\fP ,  \fIclient_key\fP ,  \fIserver_key\fP , and  \fIstored_key\fP buffers
must have room to hold digest for given  \fIhash\fP , use
\fBGSASL_HASH_MAX_SIZE\fP which is sufficient for all hashes.

Return value: Returns \fBGSASL_OK\fP if successful, or error code.
.SH "SINCE"
1.10
.SH "REPORTING BUGS"
Report bugs to <bug-gsasl@gnu.org>.
.br
General guidelines for reporting bugs: http://www.gnu.org/gethelp/
.br
GNU SASL home page: http://www.gnu.org/software/gsasl/

.SH COPYRIGHT
Copyright \(co 2002-2021 Simon Josefsson.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gsasl
is maintained as a Texinfo manual.  If the
.B info
and
.B gsasl
programs are properly installed at your site, the command
.IP
.B info gsasl
.PP
should give you access to the complete manual.
As an alternative you may obtain the manual from:
.IP
.B http://www.gnu.org/software/gsasl/manual/
.PP