gss_encapsulate_token(3)

💖 gss_encapsulate_token — bestie edition 💖

okay so like, hi!! welcome to gss_encapsulate_token(3), a lil page from the gss manual (that's section 3 of the gss docs, mwah). this is the API function that slaps a header on your token so everybody knows what's up. let's get into it 🎀

---

✨ NAME ✨

gss_encapsulate_token — API function. yes that's it. she's an API function and she's iconic for it 💅

---

🌸 SYNOPSIS 🌸

#include <gss.h>

extern OM_uint32 gss_encapsulate_token(gss_const_buffer_t input_token,
gss_const_OID token_oid, gss_buffer_t output_token);

look at her go 🦋

---

🫶 ARGUMENTS 🫶

• gss_const_buffer_t input_token — (buffer, opaque, read) the buffer holding your GSS-API context token data. it's read-only bestie, we're just looking, not touching 🙈
• gss_const_OID token_oid — (Object ID, read) the object identifier of the token. that's the OID, the little name-tag of the token 💜
• gss_buffer_t output_token — (buffer, opaque, modify) the encapsulated token data goes here!! and listen, the caller must release this with gss_release_buffer(). do not ghost your buffers, that's how you leak memory and we don't do that here 😭

---

💫 DESCRIPTION 💫

so what does she actually do? she adds the mechanism-independent token header to GSS-API context token data. periodt.

this is the one you use for the initial token of a GSS-API context establishment sequence. it incorporates an identifier of the mechanism type that's gonna be used on that context, and it enables tokens to be interpreted unambiguously at GSS-API peers. no cap, that's the whole vibe — everybody knows what the token is and who it's for ✨

see further section 3.1 of RFC 2743. and fun fact: this function is standardized in RFC 6339 🏆

---

🔥 RETURNS 🔥

• GSS_S_COMPLETE — indicates successful completion, and that output parameters holds correct information. we ate. 👑
• GSS_S_FAILURE — indicates that encapsulation failed for reasons unspecified at the GSS-API level. it's giving mystery, it's giving no explanation, it's giving... failure 💀

---

🙈 REPORTING BUGS 🙈

found a bug? don't be shy, report it to <bug-gss@gnu.org> 🐛

GNU Generic Security Service home page: http://www.gnu.org/software/gss/

General help using GNU software: http://www.gnu.org/gethelp/

---

🎀 COPYRIGHT 🎀

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.

---

🌈 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, the command

info gss

should give you access to the complete manual. go read her, she's long but she's worth it 💖

---

and that's the page bestie!! brought to you by gss 1.0.4, page gss_encapsulate_token(3) — stay encapsulated, stay hydrated, and always gss_release_buffer() your output tokens 🫶✨💅