gsasl_stringprep_trace(3)

📦 version 1.10.0, in ubuntu jammy

💖 gsasl_stringprep_trace — bestie edition 💖

okay so this is a page from the gsasl manual, and we're talking about gsasl_stringprep_trace(3), which is an API function. yes it's real, yes it's in the manual, and yes we're gonna get into it 🫶

✨ NAME ✨

gsasl_stringprep_trace — it's an API function, bestie, that's the whole vibe 💅

🌸 SYNOPSIS 🌸

#include <gsasl.h>

char * gsasl_stringprep_trace(const char * in, int * stringprep_rc);

🎀 ARGUMENTS 🎀

  • const char * in — the input string, either ASCII or UTF-8, holding the data you wanna prepare according to "trace". like, this is the thing going in 🍓
  • int * stringprep_rc — a pointer to an output variable that'll hold the stringprep error code. or you can pass NULL if you literally don't care about it, and honestly? valid 🙈

🦋 DESCRIPTION 🦋

so the whole point: this function processes a Unicode string so it can be used as trace information, following the "trace" stringprep profile. and that profile? it's designed for use with the SASL ANONYMOUS Mechanism. iykyk 👑

Return value: it returns a newly allocated string, which is the "trace" processed form of the input string. but if things go sideways it returns NULL on error, and in that case stringprep_rc contains the stringprep library error code. so like, check it, fr fr 😭

💀 DEPRECATED 💀

okay this is the part where we hold hands. there is no replacement functionality in GNU SASL — instead, use GNU Libidn. periodt. don't come for me, i'm just the messenger 💜

🐛 REPORTING BUGS 🐛

found a bug? not me being dramatic but please tell someone:

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.

(no cap, that's the actual license situation, it's very generous and we love that for us 🌈)

🔥 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 gsasl version 1.10.0, and the page is gsasl_stringprep_trace(3). go forth, stringprep responsibly, and remember: deprecated ≠ forgotten, it's just giving "use GNU Libidn instead" energy ✨💖

📦 where this page comes from