gsasl_simple_getpass(3)

📦
version 2.2.4 · 6 versions
, in arch rolling, ubuntu stonking

✨ NAME ✨

gsasl_simple_getpass — it's an API function, bestie, and it's here to grab a password for you 💅

🌸 SYNOPSIS 🌸

#include <gsasl.h>

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

🎀 ARGUMENTS 🎀

  • const char * filename — the filename of the file that's holding your passwords, okay?
  • const char * username — a username string. just the username. that's it.
  • char ** key — newly allocated output character array 🫶 this is where the magic lands.

🦋 DESCRIPTION 🦋

So basically: this function retrieves the password for a user from the specified file. The buffer key contains the password if this function is successful — and heads up, bestie, the caller is responsible for deallocating it. not us. you. 💀

The file should be in the UoW "MD5 Based Authentication" format, which means it's in text format with comments denoted by # first on the line, and user entries looking like "usernameTABpassword". Iconic format, honestly.

This function removes CR and LF at the end of lines before processing. And for the record: TAB, CR, and LF denote ASCII values 9, 13, and 10, respectively. no cap. 🔥

Return value: Return GSASL_OK if the output buffer contains the password, GSASL_AUTHENTICATION_ERROR if the user could not be found, or other error code. 😭

💜 REPORTING BUGS 💜

Found a bug? Report it to <bug-gsasl@gnu.org>. 🐛✨

General guidelines for reporting bugs live at: https://www.gnu.org/gethelp/

And the GNU SASL home page is over here: https://www.gnu.org/software/gsasl/ 🏠

Copyright © 2002-2026 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. slay, honestly. legal queen behavior. 💅

🌈 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 — and this is giving backup plan energy — you may obtain the manual from:

https://www.gnu.org/software/libidn/gsasl/manual/

and that's the whole page, bestie!! this manual came to you from the gsasl manual suite, version 2.2.4, starring gsasl_simple_getpass(3) 🎀 go get those passwords (ethically!!) 💖🦋

📦 where this page comes from