shishi_safe_parse(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_safe_parse(3) — the shishi girlies' guide 💖

okay so bestie, welcome to the shishi manual, section 3 (that's the library-functions girlies, we're not a command, we're a vibe). this page is all about shishi_safe_parse, and honestly? it's giving "small function, big responsibility". let's get into it 🫶

✨ NAME ✨

shishi_safe_parse — it's an API function, periodt. that's the whole name tag, no notes 💅

🌸 SYNOPSIS 🌸

#include <shishi.h>

int shishi_safe_parse(Shishi * handle, FILE * fh, Shishi_asn1 * safe);

yeah she takes three args and gives you back an int. simple. iconic. no cap 💖

🎀 ARGUMENTS 🎀

  • Shishi * handle — this is your shishi handle, and you gotta have it allocated by shishi_init() first, okay? no handle, no service. she's the main character here fr fr.
  • FILE * fh — a file handle that's open for reading. so like, don't hand her a file you opened for writing, that's not the vibe 🙈
  • Shishi_asn1 * safe — this one's the output variable, and it comes back holding a newly allocated SAFE. it's a pointer, so she's writing into your thing. she's a giver, lowkey 💜

🦋 DESCRIPTION 🦋

okay so here's the tea: this function reads an ASCII armored, DER encoded SAFE from a file, and then populates the variable you gave it. that's it. that's the whole job. she reads, she fills in, she slays ✨

(it's a safe, bestie — the file format. she's parsing it out of ASCII armor like unwrapping a little present 🎁)

💫 RETURN VALUE 💫

she returns SHISHI_OK iff successful. and yes, that's a fancy way of saying "only if it worked, bestie". anything else means something went sideways and you should probably check on her 😭

🍓 REPORTING BUGS 🍓

found a bug? do NOT gatekeep it. report bugs to <bug-shishi@gnu.org>. they literally want to hear from you.

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 — the copyright notice and this notice — attached. that's the whole deal, no strings, no royalty, iconic behaviour 🌈)

🔥 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 📖✨

okay that's the whole page bestie!! you just read shishi version 1.0.3, page shishi_safe_parse(3). go forth, parse your SAFEs, and remember: ASCII armored DER encoded files are just data in a cute little outfit 🎀💖 mwah, bye!! 🦋🌸

📦 where this page comes from