shishi_hmac_sha1(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_hmac_sha1 — the manual page, but make it cute 💖

okay bestie, pull up a chair because we're about to talk about the shishi_hmac_sha1 API function, from the shishi manual, section 3. yes it's a crypto thing. yes it's iconic. let's go 🫶

✨ NAME ✨

shishi_hmac_sha1 — it's an API function, bestie. that's the whole vibe.

🌸 SYNOPSIS 🌸

first things first, you gotta include the header or nothing works, periodt:

#include <shishi.h>

int shishi_hmac_sha1(Shishi * handle, const char * key, size_t keylen,
const char * in, size_t inlen, char * outhash[20]);

like look at that signature. it's giving main character energy fr fr 💅

🎀 ARGUMENTS 🎀

here's the breakdown of every single thing you're handing over, no skipping, we don't do that here:

  • Shishi * handle — the shishi handle, and you get one of those from shishi_init(). it's basically your VIP pass to everything 🎟️
  • const char * key — an input character array holding the key you wanna use. the secret sauce, the ~key~ if you will 🔑
  • size_t keylen — the length of that input character array with the key to use. don't lie about the length, she'll know 💀
  • const char * in — an input character array of the data you want to hash. this is the actual content getting the glow-up ✨
  • size_t inlen — the length of the input character array of data to hash. yes, it matters. always 🫶
  • char * outhash[20] — a newly allocated character array with the keyed hash of data. fresh out the box, your responsibility now 🎁

🦋 DESCRIPTION 🦋

so what does she actually do? she computes the keyed checksum of data using HMAC-SHA1. that's the whole thing. no cap. 🌈

⚠️ but listen — the outhash buffer must be deallocated by the caller. that means you, bestie. you allocated it (well, she did, but on your behalf), so you free it. don't be the person who leaks memory, it's not the vibe 🙈

⭐ RETURN VALUE ⭐

returns SHISHI_OK iff successful. that's it. that's the answer. if you see SHISHI_OK you're slaying, if you don't... well 😭

💀 REPORTING BUGS 💀

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

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 she's free, she's generous, she's giving open source royalty 💜

🌟 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 the whole lore 📚✨

and that's a wrap on shishi_hmac_sha1(3), bestie 💖 this page came to you from shishi version 1.0.3, dated back in the day, and honestly? she ate. mwah 💅🎀🦋🌸💜

📦 where this page comes from