SASL_CHECKAPOP(3)

✨ SASL_CHECKAPOP(3) ✨

okay bestie, welcome to the Cyrus SASL manual, section 3 (that's the library-functions girlies 💅). today's main character is sasl_checkapop, and she is so much simpler than she looks. let's get into it 🫶

---

🌸 NAME 🌸

sasl_checkapop — Cyrus SASL documentation, but make it a vibe check on your APOP challenge/response 🎀

---

🦋 SYNOPSIS 🦋

#include <sasl/sasl.h>

int sasl_checkapop(sasl_conn_t *conn,
                 const char *challenge,
                 unsigned challen,
                 const char *response,
                 unsigned resplen)

---

💖 DESCRIPTION 💖

int sasl_checkapop(sasl_conn_t *conn,

const char *challenge,

unsigned challen,

const char *response,

unsigned resplen)

so like. sasl_checkapop will check an APOP challenge/response. that's the whole job, she's focused, she's employed 💅

APOP is an optional POP3 (RFC 1939) authentication command which uses a shared secret (aka a password, bestie, it's just a password 🙈). and where does that password live? in the SASL secrets database. iconic storage, no notes.

wanna know more about the SASL shared secrets database? that's a System Administrators Guide situation, go read that one 👑

also super important: if you call this with a NULL challenge, sasl_checkapop() will check to see if the APOP mechanism is enabled. that's it. just a little "are you even on, queen?" moment ⭐

---

🌈 RETURN VALUE 🌈

sasl_checkapop returns an integer which corresponds to one of the following codes.

• SASL_OK — the authentication is complete. slay. 🎉

All other return codes indicate errors and should either be handled or the authentication session should be quit. like, do not ignore them, bestie, that's not the move 💀

see sasl_errors(3) for meanings of return codes. iykyk 📖

---

🧚 CONFORMING TO 🧚

RFC 4422, RFC 1939 — she's certified, she's compliant, she's that girl ✨

---

👑 SEE ALSO 👑

• sasl(3)
• sasl_errors(3)

---

🍓 AUTHOR 🍓

The Cyrus Team 🫶

---

💜 COPYRIGHT 💜

1993-2016, The Cyrus Team

---

and that's the whole page, bestie!! this was Cyrus SASL version 2.1.28, dated February 18, 2022 — no cap, that's the real source and date, mwah 💋 go forth and authenticate responsibly 🌸💖🎀