shishi_key_random(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_random ✨

okay bestie, welcome to the shishi manual, page shishi_key_random(3) β€” yes that's the manual name and yes it's giving very "I know a guy who knows a guy" energy 🫢


🌸 NAME 🌸

shishi_key_random β€” it's an API function, periodt. that's the whole job description πŸ’…


πŸŽ€ SYNOPSIS πŸŽ€

#include <shishi.h>

int shishi_key_random(Shishi * handle, int32_t type, Shishi_key ** key);

look at her. three arguments, one dream ✨


πŸ¦‹ ARGUMENTS πŸ¦‹

  • Shishi * handle β€” the Shishi library handle, and no you cannot just make one up, it's created by shishi_init(). she's the main character of this whole operation, everything runs through her πŸ‘‘
  • int32_t type β€” the type of key. like, what kind of key are we manifesting today, bestie πŸ”‘
  • Shishi_key ** key β€” a pointer to the structure that will hold the newly created key information. so it's a pointer to a pointer, it's giving double trouble, it's giving inception, we love a nested moment πŸŒ€

πŸ’– DESCRIPTION πŸ’–

so what does she actually do? she creates a brand new Key information structure for the key type you asked for, and fills it with some random data. literally generating freshness out of thin air, no cap 🌈

⚠️ important note bestie: KEY only contains a newly allocated structure if this function is successful. if it flops, KEY is not your girl. don't go dereferencing her and acting surprised, i'm warning you 😭

⭐ RETURN VALUE ⭐

returns SHISHI_OK iff successful. that's it. that's the whole vibe check. if you get SHISHI_OK, we're slaying. if you don't… well 🫢


πŸ™ˆ REPORTING BUGS πŸ™ˆ

found a bug? not me gatekeeping the bug reports β€” send them to <bug-shishi@gnu.org> πŸ’Œ


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.

(yes, that means you can copy it, bestie, 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, this command:

info shishi

should give you access to the complete manual. go read her, she's iconic πŸ“–


and that's the page!! this was shishi version 1.0.3, floating around as shishi_key_random(3) β€” ty for coming to my ted talk, stay random, stay allocated, mwah πŸ’–πŸŽ€πŸ¦‹