shishi_authenticator_clientrealm(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_clientrealm — the girlies' guide 💖

okay bestie, welcome to the shishi manual, section 3. today we're talking about shishi_authenticator_clientrealm — yes that whole mouthful, i know, but say it with your chest. it's an API function, it's giving utility, it's giving "i extract principal names for a living." let's get into it. ✨

✨ NAME ✨

shishi_authenticator_clientrealm — API function

no cap, that's the whole name section. short, sweet, iconic.

🦋 SYNOPSIS 🦋

#include <shishi.h>

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

copy that exactly, bestie, do not freestyle the signature. 🫶

🌸 ARGUMENTS 🌸

  • Shishi * handle — the Shishi library handle, and you gotta make it with shishi_init() first. no handle, no service. 💅
  • Shishi_asn1 authenticator — the Authenticator variable you're pulling the client name and realm out of. this is the source of truth, the main character of the operation. 👑
  • char ** client — a pointer to a newly allocated zero terminated string holding the principal name and realm. lowkey flexible: it may be NULL if you only wanna populate clientlen. 🙈
  • size_t * clientlen — a pointer to the length of client on output, and heads up, that length does not include the terminating zero. also may be NULL if you only wanna populate client. so basically these two are the duo, and either one can sit this one out. 🎀

💜 DESCRIPTION 💜

so what does it actually do? it converts the cname and realm fields from the Authenticator into a printable principal name format. that's the glow-up: raw fields → pretty string. ✨

the string is allocated by this function, which means — listen closely — it is the responsibility of the caller to deallocate it. it's not gonna clean up after itself, bestie. that's your job. don't leave it hanging, that's not the vibe. 😭

and one more time for the people in the back: the output length clientlen does not include the terminating zero. say it with me. not included. periodt. 💅

⭐ RETURN VALUE ⭐

returns SHISHI_OK iff successful. that's the only success condition, no extra credit. ⭐

🐛 REPORTING BUGS 🐛

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

they wanna hear from you, fr fr. 🫶

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. slay, and legally so. 💖

👀 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, this command:

info shishi

should give you access to the complete manual. go read it, it's giving lore. 📚

and that's the page, bestie. every flag, every field, every caveat — all accounted for. no detail left behind. 💅

sign-off time: this page is from shishi version 1.0.3, and it's the manual for shishi_authenticator_clientrealm(3). take care of that allocated string, and stay iconic. 🎀✨🦋

📦 where this page comes from