shishi_crc(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_crc — bestie edition 💖

okay so this is a page from the shishi manual (that's the GNU Shishi Kerberos-ish library, iykyk), section 3, and it's literally just one function. it's giving "small but mighty" energy. let's get into it 🫶

✨ NAME ✨

shishi_crc — it's an API function, bestie. that's the whole name. iconic of it.

🌸 SYNOPSIS 🌸

#include <shishi.h>

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

look at that signature. chef's kiss. 🎀

🦋 ARGUMENTS 🦋

  • Shishi * handle — your shishi handle, the one you got from shishi_init(). it's the whole personality of the call, you can't skip it.
  • const char * in — the input character array, aka the data you wanna checksum. the vibes you're hashing, basically.
  • size_t inlen — how long that input character array is. the length. the size. the amount of data. you get it. 💅
  • char * out[4] — a freshly allocated character array that'll hold the checksum of your data. she's new, she's yours, you own her now.

💜 DESCRIPTION 💜

so the whole thing: it computes the checksum of your data using CRC32 modified according to RFC 1510. and heads up, bestie, the out buffer must be deallocated by the caller — that's a you problem, not a library problem. don't leave her hanging. 🫶

now the tea on the modifications: compared to standard CRC32, this version does no initial and final XOR, and the output comes back in LSB-first order. that's the whole difference. slay. ✨

⭐ RETURN VALUE ⭐

returns SHISHI_OK iff it succeeded. that's it. if it's not SHISHI_OK, something went sideways. periodt.

😭 REPORTING BUGS 😭

found a bug? not me gatekeeping — go tell the devs:

they wanna hear from you fr fr. 💌

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.

(so like... you can copy it. just keep the notice. that's the deal. we love a permissive license moment. 🌈)

🧚 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, bestie, it's the main character of the docs. 📚

that's the whole page!! 🎀 written for shishi 1.0.3, and this lil cutie lives at shishi_crc(3) in the manual. mwah, go checksum something. 💅✨

📦 where this page comes from