shishi_md5(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_md5(3) β€” the MD5 girlie of the shishi fam ✨

okay bestie, pull up a chair πŸͺ‘ because we're about to talk about shishi_md5, a lil function living in the shishi manual, section 3 (that's the library-calls girlies, iykyk πŸ’…). she hashes things. that's her whole job. and she does it immaculately. let's get into it 🫢


🌸 NAME 🌸

shishi_md5 β€” it's an API function, bestie. that's the whole name. short, sweet, iconic πŸ‘‘


πŸŽ€ SYNOPSIS πŸŽ€

#include <shishi.h>

int shishi_md5(Shishi * handle, const char * in, size_t inlen, char *
out[16]);

like yes, that second line wraps weirdly in the original, and yes, we're keeping it exactly as it is because that's the whole point of a synopsis πŸ’–


πŸ¦‹ ARGUMENTS πŸ¦‹

  • Shishi * handle β€” the shishi handle, and no you can't just make one up out of vibes, it's allocated by shishi_init(). she needs her handle, periodt.
  • const char * in β€” the input character array. it's the data you want to hash. that's it. that's the tea πŸ“
  • size_t inlen β€” the length of that input character array of data to hash. yes, you have to tell her how long it is. she's not a mind reader, bestie 😭
  • char * out[16] β€” a newly allocated character array holding the hash of the data. and heads up: the caller is on deallocation duty here, so don't be out here leaking, that's not the vibe πŸ™ˆ

πŸ’œ DESCRIPTION πŸ’œ

so what does she actually do? she computes the hash of your data using MD5. that's the function. that's the assignment. she ate and left no crumbs πŸ”₯

⚠️ and this is the important bit so listen up: the out buffer must be deallocated by the caller. like, by you. that's a you problem, not a her problem. don't forget it or you're gonna be leaking memory in the group chat and everyone's gonna see πŸ’€

⭐ RETURN VALUE ⭐

she returns SHISHI_OK iff successful. and only iff. so like, if you get SHISHI_OK back, congratulations, you slayed πŸ’… if you didn't… well. check your inputs, bestie.


🌈 REPORTING BUGS 🌈

found a bug? first of all, relatable. second of all, report it to <bug-shishi@gnu.org>. they wanna hear about it, fr fr πŸ›

don't be shy, they literally made a whole email address for it 🫢


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.

like… go off, that's genuinely so generous of him πŸ₯Ή no royalty, any medium, just keep the notice. we love a permissive king πŸ’–


🧚 SEE ALSO 🧚

The full documentation for shishi is maintained as a Texinfo manual. so if info and the shishi programs are properly installed at your site, this command:

info shishi

should give you access to the complete manual. go read it, she's thorough 🌸


okay that's the whole page!! πŸ’œ sending you off with the details you actually need: this was from the shishi manual, version 1.0.3, and the page itself is shishi_md5(3). now go hash something responsibly, bestie β€” and deallocate that buffer 😭✨🫢