SASL_SERVER_START(3)

πŸ’– sasl_server_start(3) β€” Cyrus SASL πŸ’–

okay bestie, welcome to the Cyrus SASL corner of the man pages, you're gonna do great, i promise 🫢


✨ NAME ✨

sasl_server_start β€” Cyrus SASL documentation πŸ“–


🌸 SYNOPSIS 🌸

#include <sasl/sasl.h>

int sasl_server_start(sasl_conn_t * conn,
             const char * mech,
             const char * clientin,
             unsigned clientinlen,
             const char ** serverout,
             unsigned * serveroutlen);

πŸ¦‹ DESCRIPTION πŸ¦‹

so here's the vibe, the signature laid out all long and pretty:

int sasl_server_start(sasl_conn_t * conn,

const char * mech,

const char * clientin,

unsigned * clientinlen,

const char ** serverout,

unsigned * serveroutlen);

sasl_server_start() begins the authentication with the mechanism specified with mech. This fails if the mechanism is not supported. like, no support, no entry, sorry babe πŸ’…

πŸŽ€ Parameters

  • conn β€” is the SASL connection context
  • mech β€” is the mechanism name that the client requested
  • clientin β€” is the client initial response, NULL if the protocol lacks support for client‐send‐first or if the other end did not have an initial send. Note that no initial client send is distinct from an initial send of a null string, and the protocol MUST account for this difference. πŸ‘€ yes this distinction is real and yes it matters, do not conflate them, fr fr
  • clientinlen β€” is the length of initial response
  • serverout β€” is created by the plugin library. It is the initial server response to send to the client. This is allocated/freed by the library and it is the job of the client to send it over the network to the server. Also protocol specific encoding (such as base64 encoding) must needs to be done by the server.
  • serveroutlen β€” is set to the length of initial server challenge

πŸ’œ RETURN VALUE πŸ’œ

SASL callback functions should return SASL return codes. See sasl.h for a complete list. SASL_OK is returned if the authentication is complete and the user is authenticated. SASL_CONTINUE is returned if one or more steps are still required in the authentication. πŸ”₯

All other return values indicate errors and should be handled or the authentication session should be quit. 🚨

bestie. if it's not SASL_OK and not SASL_CONTINUE, it's giving error, and you either handle it or you end the session. no third option, periodt.

🌈 SEE ALSO 🌈

RFC 4422,:saslman:sasl(3), sasl_server_init(3), sasl_server_new(3), sasl_server_step(3), sasl_errors(3)


πŸ‘‘ AUTHOR πŸ‘‘

The Cyrus Team


1993-2016, The Cyrus Team


and that's the whole page, you ate it πŸ’…βœ¨ version 2.1.28, dated February 18, 2022, courtesy of the Cyrus SASL girlies β€” mwah, go write some slay authentication code πŸŽ€πŸ¦‹πŸ’–