shishi_authenticator_client(3)

πŸ“¦
version 1.0.3 Β· 2 versions
  • 1.0.3 Β· debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 1.0.2 Β· ubuntu jammy
, in debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– shishi_authenticator_client β€” the manual page, but make it make sense ✨

okay bestie, so this one lives in the shishi section 3, and it's lowkey one of those little glue functions that does exactly one thing and does it slay. it's giving "get the client principal name out of an Authenticator" and honestly? that's the whole plot. πŸŽ€


🌸 NAME 🌸

shishi_authenticator_client β€” it's an API function, babes. that's it, that's the name. πŸ’…


✨ SYNOPSIS ✨

#include <shishi.h>

int shishi_authenticator_client(Shishi * handle, Shishi_asn1
authenticator, char ** client, size_t * clientlen);

periodt. four things go in, one int comes out. 🫢


πŸ¦‹ ARGUMENTS πŸ¦‹

  • Shishi * handle β€” the Shishi library handle, and you gotta make it with shishi_init(). no handle, no vibes. ✨
  • Shishi_asn1 authenticator β€” the Authenticator variable you're pulling the client name out of. that's the whole mission, bestie.
  • char ** client β€” a pointer to a newly allocated zero-terminated string holding the principal name. and listen β€” this one can be NULL, which is the move when you only wanna populate clientlen. flexible queen behavior. πŸ’–
  • size_t * clientlen β€” pointer to the length of client on output, and heads up: it does NOT include the terminating zero. also it can be NULL if you only wanna populate client. so yes, both of them are nullable, iykyk. 🧚

πŸ‘‘ DESCRIPTION πŸ‘‘

so basically: this function represents the client principal name inside the Authenticator as a zero-terminated string. cute, right?

and here's the part you cannot skip, bestie β€” the string is allocated by this function, which means the deallocation is your job. the caller's responsibility. nobody's gonna free it for you, that's not the vibe of this function. free your strings, queen. 😭

also one more time for the people in the back: the output length clientlen does not include the terminating zero. do not count the zero. the zero is not part of the length. we've all been there. πŸ’€


⭐ RETURN VALUE ⭐

it returns SHISHI_OK iff successful. that's the good one. that's the one you want. ✨


πŸ™ˆ REPORTING BUGS πŸ™ˆ

found something cursed? report bugs to <bug-shishi@gnu.org>.

they literally want to hear from you, don't be shy. 🫢


Copyright Β© 2002-2022 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.

(the legal girlies ate with this one, ngl β€” free to share, just keep the receipts. πŸ“œ)


🌈 SEE ALSO 🌈

The full documentation for shishi is maintained as a Texinfo manual. If the info and shishi programs are properly installed at your site, the command

info shishi

should give you access to the complete manual.

so if you want the whole lore and not just this one function, that's the door to knock on. πŸšͺ✨


and that's the page, bestie. shishi_authenticator_client from the shishi manual, version 1.0.3 β€” go free your strings and stay iconic. πŸŽ€πŸ’…πŸ¦‹