.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gsasl_simple_getpass" 3 "1.10.0" "gsasl" "gsasl"
.SH NAME
gsasl_simple_getpass \- API function
.SH SYNOPSIS
.B #include <gsasl.h>
.sp
.BI "int gsasl_simple_getpass(const char * " filename ", const char * " username ", char ** " key ");"
.SH ARGUMENTS
.IP "const char * filename" 12
filename of file containing passwords.
.IP "const char * username" 12
username string.
.IP "char ** key" 12
newly allocated output character array.
.SH "DESCRIPTION"
Retrieve password for user from specified file.  The buffer  \fIkey\fP contain the password if this function is successful.  The caller is
responsible for deallocating it.

The file should be on the UoW "MD5 Based Authentication" format,
which means it is in text format with comments denoted by # first
on the line, with user entries looking as "usernameTABpassword".
This function removes CR and LF at the end of lines before
processing.  TAB, CR, and LF denote ASCII values 9, 13, and 10,
respectively.

Return value: Return \fBGSASL_OK\fP if output buffer contains the
password, \fBGSASL_AUTHENTICATION_ERROR\fP if the user could not be
found, or other error code.
.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