gss_decapsulate_token(3)

📦
version 1.0.4 · 3 versions
, in alpine 3.24, debian bookworm, debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 gss_decapsulate_token — the glow-up where your token loses its fancy wrapper 💖

okay bestie, welcome to the gss manual page for gss_decapsulate_token(3) — yes that's the real section number, it's giving Very Serious C Library Energy and we're gonna make it make sense. sit down, grab a strawberry 🍓, and let's unwrap a token together.

✨ NAME ✨

gss_decapsulate_token — it's an API function, bestie. that's the whole job description. iconic.

🌸 SYNOPSIS 🌸

#include <gss.h>

OM_uint32 gss_decapsulate_token(gss_const_buffer_t input_token,
gss_const_OID token_oid, gss_buffer_t output_token);

yes, one function, three arguments, no drama. the way that #include <gss.h> is literally the first thing you need or nothing works 💅

🎀 ARGUMENTS 🎀

  • gss_const_buffer_t input_token — (buffer, opaque, read) the buffer holding your GSS-API context token. you're reading from it, not touching it, so it's const and behaving. respect.
  • gss_const_OID token_oid — (Object ID, read) the object identifier you're <em>expecting</em> the token to have. it's the vibe check for OIDs, fr fr. read-only, no notes.
  • gss_buffer_t output_token — (buffer, opaque, modify) where the decapsulated token data lands. you're modifying it, so it's not const, and here's the important part: the caller must release it with gss_release_buffer(). do not ghost your memory, bestie, that's a leak and leaks are NOT the move. 🙈

🦋 DESCRIPTION 🦋

so what are we actually doing here? we're taking an initial GSS-API context token and removing the mechanism-independent token header from it. think of it like taking the cute outer packaging off your online order — the gift is still the gift, the wrapping is just gone. 🎁

we're unwrapping a buffer that's in the mechanism-independent token format. this is literally the reverse of gss_encapsulate_token(), like a mirror, like a before-and-after transition.

and the best part? the translation is loss-less. all data is preserved as is. nothing gets dropped, nothing gets "improved", nothing gets accidentally deleted in the group chat. everything stays exactly how it was. ✨

also, this function is standardized in RFC 6339, so it's not just a cute idea, it's official. certified. ate. 👑

💀 RETURN VALUE 💀

  • GSS_S_COMPLETE — it worked!! 🎉 successful completion, and the output parameters hold correct information. slay.
  • GSS_S_DEFECTIVE_TOKEN — the token failed consistency checks. like, for example, an OID mismatch or ASN.1 DER length errors. the token showed up with a fake ID and the bouncer said nope. 🚫
  • GSS_S_FAILURE — decapsulation failed for reasons that are unspecified at the GSS-API level. it's giving mysterious, it's giving "we can't tell you why", and we simply have to live with that. 😭

📢 REPORTING BUGS 📢

found a bug? don't subtweet it, report it, bestie:

Copyright © 2003-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. no royalty, no fee, just keep the receipts attached. 💖

🧚 SEE ALSO 🧚

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

info gss

should give you access to the complete manual. iykyk. 🫶

k bye bestie!! 💅✨ this was the gss manual page for gss_decapsulate_token(3), page version 1.0.4, dated gss_decapsulate_token(3) — yeah the date field is literally the same string as the title, that's just how this page rolls, we don't question the classics. go release your buffers and hydrate. 🌸🦋⭐

📦 where this page comes from