gsasl_server_callback_securid_set(3)

📦 version 1.10.0, in ubuntu jammy

✨ gsasl_server_callback_securid_set(3) ✨

okay bestie, welcome to the gsasl manual page for gsasl_server_callback_securid_set — yes it's a long name, yes it's a mouthful, no we are not skipping it 💅 it's giving very "old callback interface" energy and we're gonna unpack it together, fr fr.

🌸 NAME 🌸

gsasl_server_callback_securid_set — literally an API function, that's the whole name, no notes 🎀

🦋 SYNOPSIS 🦋

#include <gsasl.h>

void gsasl_server_callback_securid_set(Gsasl * ctx,
Gsasl_server_callback_securid cb);

she's a void, she returns nothing, she just sets things. main character behaviour honestly 👑

💖 ARGUMENTS 💖

  • Gsasl * ctx — your libgsasl handle, the little context object that holds everything together. the bestie that carries the bag 👜
  • Gsasl_server_callback_securid cb — the callback function itself. yes, the callback gets its own callback. it's callbacks all the way down, iykyk 😭

🌈 DESCRIPTION 🌈

so the vibe here is: you're telling the server which callback function to use when it's validating a user through the SECURID mechanism. that's it, that's the job.

and what should that function return? bestie, it has options, and they're all extremely specific:

  • return GSASL_OK if the user authenticated successfully — slay, we love a win ✨
  • return GSASL_SECURID_SERVER_NEED_ADDITIONAL_PASSCODE if it wants another passcode — okay so we're doing this again 🙈
  • return GSASL_SECURID_SERVER_NEED_NEW_PIN if it wants a PIN change — glow up time 🔥
  • or, alternatively, return an error. it happens. we move on 💀

and here's the tea, and it's a very precise tea: when (and only when) GSASL_SECURID_SERVER_NEED_NEW_PIN is the return value, then suggestpin can be populated with a PIN code that the server suggests, and suggestpinlen gets set to the length of that PIN. only then. not any other time. the conditions are conditional-ing, periodt.

oh and also? that function you set? you can grab it back later with gsasl_server_callback_securid_get(). what goes around comes around, babes 🫶

🎀 DEPRECATED 🎀

not me being the bearer of bad news but… yeah, this one is deprecated. 😭

this function is part of the old callback interface. the new interface uses gsasl_callback_set() to set the application callback, and then uses gsasl_callback() or gsasl_property_get() to invoke that callback for certain properties. so if you're writing new code, that's the move. this one is iconic but she's retired 💅

🐛 REPORTING BUGS 🐛

found a bug? don't suffer in silence bestie, tell the people:

Copyright © 2002-2021 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. generous queen behaviour, we love to see it 🌸

⭐ 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/

and that's the whole page, bestie 💜 this was the gsasl manual, version 1.10.0 — go forth and callback responsibly 🧚✨

📦 where this page comes from