SASL_GETOPT_T(3)

💖 SASL_GETOPT_T(3) 💖

okay bestie, welcome to the Cyrus SASL corner of the manual, section 3, and today's main character is sasl_getopt_t. yes it's a whole page just for one callback. she's iconic like that. 🎀

---

✨ NAME ✨

sasl_getopt_t — Cyrus SASL documentation. that's it, that's the name, she's literally just documentation-core and we respect it. 💅

---

🌸 SYNOPSIS 🌸

#include <sasl/sasl.h>

int sasl_getopt_t(void *context,
               const char *plugin_name,
               const char *option,
               const char ** result,
               unsigned * len);

look at her. five parameters. no cap, she's doing the most and we love her for it. 🦋

---

💜 DESCRIPTION 💜

int sasl_getopt_t(void *context,

const char *plugin_name,

const char *option,

const char ** result,

unsigned * len);

so here's the tea ☕ — sasl_getopt_t is used to retrieve an option from the application, and it's often mechanism specific. like, a real example? asking which KERBEROS_V4 srvtab file to use. yeah. she's out here fetching your config vibes. ✨

🧚 Parameters 🧚

• context — is the SASL connection context. your connection's whole identity, basically her main character energy.
• plugin_name — is the plugin this value is for. you gotta know who you're shopping for.
• option — is a string representing the option. and bestie, listen: a common option that all server applications should handle is the method for checking plaintext passwords. see the administrators guide for a full description of this option. iykyk. 👑

🫶 Memory management 🫶

Memory management of options supplied by the getopt callback should be done by the application. that part's on you, bestie, no take-backs.

however — and this is the important part — any requested option must remain available until the callback is no longer valid. that means:

• when sasl_dispose(3) is called for the connection it is associated with, or
• when sasl_done(3) is called for global callbacks.

don't be out here freeing stuff early, that's giving chaos and we are NOT about that life. 💀

---

🔥 RETURN VALUE 🔥

SASL callback functions should return SASL return codes. see sasl.h for a complete list. SASL_OK indicates success. 🎉

Other return codes indicate errors and should be handled. fr fr, don't ignore them, they're trying to tell you something.

---

🌈 SEE ALSO 🌈

• RFC 4422,:saslman:sasl(3)
• sasl_errors(3)
• sasl_callbacks(3)

go read them, they're all part of the same friend group. 💖

---

👑 AUTHOR 👑

The Cyrus Team. legends, honestly.

---

🎀 COPYRIGHT 🎀

1993-2016, The Cyrus Team

---

and that's the whole page, bestie!! you ate that. slay. periodt. 💅✨

this was version 2.1.28, dated February 18, 2022 — mwah, love that for us. 🦋🌸💖