shishi_key_from_string(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_string — the manual page, but make it cute ✨

okay bestie, so this is shishi_key_from_string(3) from the shishi manual — yes, that shishi, the GNU one. sit down, hydrate, we're making keys out of strings and it's gonna be iconic 🎀

✨ NAME ✨

shishi_key_from_string — API function 👑

🌈 SYNOPSIS 🌈

#include <shishi.h>

int shishi_key_from_string(Shishi * handle, int32_t type, const char *
password, size_t passwordlen, const char * salt, size_t saltlen, const
char * parameter, Shishi_key ** outkey);

🦋 ARGUMENTS 🦋

  • Shishi * handle — the Shishi library handle, the one you made with shishi_init(). your main character, basically 💅
  • int32_t type — type of key. yeah. that's the whole description. slay ✨
  • const char * password — input array containing password. the secret. the tea. 🤫
  • size_t passwordlen — length of input array containing password. how long the tea is 🍵
  • const char * salt — input array containing salt. yes like actual seasoning for your crypto 🧂
  • size_t saltlen — length of input array containing salt. how much seasoning 🌸
  • const char * parameter — input array with opaque encryption type specific information. "opaque" meaning bestie you do NOT get to peek inside, it's encryption-type-specific and that's all we're telling you 💀
  • Shishi_key ** outkey — pointer to structure that will hold newly created key information. this is where the baby key goes 🫶

👑 DESCRIPTION 👑

Create a new Key information structure, and set the key type and key value using shishi_string_to_key(). KEY contains a newly allocated structure only if this function is successful — so like, don't go dereferencing on a failed call, that's not the vibe 😭

⭐ RETURN VALUE ⭐

Returns SHISHI_OK iff successful. that's the whole deal. no cap 🙈

🔥 REPORTING BUGS 🔥

Found a bug? not me finding a bug 💀 report it 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. (translation: share it, remix it, 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. go read it, it's giving ✨📚

ngl if you got this far you're lowkey a Unix legend. periodt. 💅

okay bye ily — this was shishi_key_from_string(3), from the shishi manual, version 1.0.3, and that's the whole page bestie 🌸🦋💖

📦 where this page comes from