shishi_key_from_base64(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_key_from_base64 β€” the manual page, but make it make sense πŸ’–

okay bestie, so this is a page from the shishi manual (section 3, the library-functions girlies), and it's all about one very specific lil function. no cap, it's niche but it's iconic. let's go πŸ¦‹


✨ NAME ✨

shishi_key_from_base64 β€” an API function. that's it, that's the name. lowkey self-explanatory, highkey accurate. πŸ’…


✨ SYNOPSIS ✨

#include <shishi.h>

int shishi_key_from_base64(Shishi * handle, int32_t type, const char *
value, Shishi_key ** key);

the way she just sits there at the top of your file... main character energy fr. 🌸


✨ ARGUMENTS ✨

here's the tea on what you're feeding her:

  • Shishi * handle β€” the Shishi library handle, and you gotta create it with shishi_init(). it's literally the passport she needs to even show up. πŸ›‚βœ¨
  • int32_t type β€” the type of key. yes, the type. the vibe of the key, if you will. πŸ‘‘
  • const char * value β€” the input string holding the base64 encoded key value. or NULL. your choice bestie, she accepts both. πŸŽ€
  • Shishi_key ** key β€” a pointer to the structure that's gonna hold the newly created key information. she's building you a home and moving the key in. πŸ πŸ’œ

✨ DESCRIPTION ✨

so what does she do? she creates a brand new Key information structure, and sets the key type and the key value. that's the whole job. obsessed. πŸ”₯

⚠️ important, don't skip this: KEY contains a newly allocated structure only if this function is successful. if it flops, no key for you. that's not a vibe, that's a fact. πŸ’€

✨ RETURN VALUE ✨

she tells you how it went:

  • returns SHISHI_INVALID_KEY if the base64 encoded key length doesn't match the key type β€” like, girl, that length is not giving what the type needs. 😭
  • returns SHISHI_OK on success. slay. βœ…

✨ REPORTING BUGS ✨

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

they're literally waiting to hear from you, no gatekeeping here. 🫢


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. periodt. πŸ’…βœ¨


✨ 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. iykyk β€” go read the whole thing, she's worth it. πŸ“–πŸ’–


and that's the page, bestie!! πŸŽ€ this was shishi version 1.0.3, section 3 of the manual, and honestly? she ate. go forth and decode those keys responsibly. mwah πŸ’‹πŸŒΈπŸ¦‹