NAME

       gsasl_simple_getpass - API function

SYNOPSIS

       #include <gsasl.h>

       int gsasl_simple_getpass(const char * filename, const char * username, char ** key);

ARGUMENTS

       const char * filename
                   filename of file containing passwords.

       const char * username
                   username string.

       char ** key newly allocated output character array.

DESCRIPTION

       Retrieve  password  for user from specified file.  The buffer  key 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    GSASL_OK   if   output   buffer   contains   the   password,
       GSASL_AUTHENTICATION_ERROR if the user could not be found, or other error code.

REPORTING BUGS

       Report bugs to <bug-gsasl@gnu.org>.
       General guidelines for reporting bugs: http://www.gnu.org/gethelp/
       GNU SASL home page: http://www.gnu.org/software/gsasl/

COPYRIGHT

       Copyright © 2002-2022 Simon Josefsson.
       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.

SEE ALSO

       The full documentation for gsasl is maintained as a Texinfo manual.  If the info and gsasl
       programs are properly installed at your site, the command

              info gsasl

       should give you access to the complete manual.  As  an  alternative  you  may  obtain  the
       manual from:

              http://www.gnu.org/software/gsasl/manual/