RPC_GSS_SECCREATE(3)

💖 RPC_GSS_SECCREATE(3) 💖

okay bestie, this is a page from the Library Functions Manual — it's rpc_gss_seccreate, and it's about making a security context with RPCSEC_GSS. sit down, hydrate, we're doing this 🫶

✨ NAME ✨

rpc_gss_seccreate — create a security context using the RPCSEC_GSS protocol

🌸 SYNOPSIS 🌸

#include <rpc/rpcsec_gss.h>

AUTH *
rpc_gss_seccreate(CLIENT *clnt, const char *principal,
    const char *mechanism, rpc_gss_service_t service, const char *qop,
    rpc_gss_options_req_t *options_req,
    rpc_gss_options_ret_t *options_ret);

💅 DESCRIPTION 💅

so basically, this function is the one that sets up a security context between your application and a remote peer, and it does it using the RPCSEC_GSS protocol. that's the whole job. iconic of it honestly 👑

🎀 PARAMETERS 🎀

okay here's the cast of characters, one by one, no skips:

• clnt — an RPC handle that's already connected to the remote peer 🦋
• principal — the name of the service principal on the remote peer. like, for example, an application that needs to talk to an NFS server might use a principal such as "nfs@server.example.com" ✨
• mechanism — the name of the GSS_API mechanism to use for the new security context. rn "kerberos_v5" is the only supported mechanism. that's it, that's the list 💀
• service — the type of service you're requesting. there are options, so let's go:
  • rpc_gss_svc_default — the default one, and typically that's the same as rpc_gss_svc_none
  • rpc_gss_svc_none — only the RPC headers are integrity protected, by a checksum
  • rpc_gss_svc_integrity — both the RPC headers and the data are integrity protected by a checksum
  • rpc_gss_svc_privacy — the RPC headers are integrity protected by a checksum, and the data gets encrypted 🔥
• qop — the name of the Quality of Protection to use for the new security context, or NULL if you just want the default QOP. "GSS_C_QOP_DEFAULT" is currently the only supported QOP, periodt ✋
• options_req — extra security context options that get passed down to the underlying GSS-API mechanism. pass NULL if you want the default values 🌸
• options_ret — various values that get returned by the underlying GSS-API mechanism. pass NULL if you don't need those values, no pressure 💜

👑 RETURN VALUES 👑

if the security context got created successfully, you get back a pointer to an AUTH structure that represents that context. and to actually use this security context for the RPC calls that come after, you set clnt->cl_auth to that value. that's the move, bestie ✨

🌈 AVAILABILITY 🌈

the rpc_gss_seccreate() function is part of libtirpc. so that's where it lives 🏠

🔥 SEE ALSO 🔥

• rpc(3)
• gssapi(3)
• mech(5)
• qop(5)
• rpcsec_gss(3)

🫶 AUTHORS 🫶

this manual page was written by Doug Rabson <dfr@FreeBSD.org>. thank you Doug, we appreciate you 💖

and that's the whole page, bestie!! this one came from the fine folks at Debian, and it's dated January 26, 2010 — vintage, honestly, but still serving ✨💅 mwah, go set your clnt->cl_auth and thrive 🦋🌸