globus_xio_gsi.h(3)

💖 globus_xio_gsi.h 💖

bestie. sit down. grab a snack 🍓. this is the Library Functions Manual page for globus_xio_gsi.h, aka the XIO GSI Driver, and we are going to get so cozy with it. no cap.

---

✨ NAME ✨

globus_xio_gsi.h — XIO GSI Driver. that's the whole vibe. 🦋

---

🌈 SYNOPSIS 🌈

#include 'gssapi.h'
#include 'globus_common.h'

okay so here's everything that lives in this header, organized like my playlist folders 💅

🎀 Macros 🎀

• #define globus_xio_gsi_attr_cntl globus_xio_attr_cntl

🦋 Typedefs 🦋

these are the two callback shapes, literally just function pointer types, and yes we're keeping them character for character:

typedef void(* globus_xio_gsi_delegation_init_callback_t)
    (globus_result_t result, void *user_arg)
typedef void(* globus_xio_gsi_delegation_accept_callback_t)
    (globus_result_t result, gss_cred_id_t delegated_cred, OM_uint32
    time_rec, void *user_arg)

👑 Enumerations 👑

six whole enums, each one iconic in its own way:

enum globus_xio_gsi_error_t:

GLOBUS_XIO_GSI_ERROR_INVALID_PROTECTION_LEVEL
GLOBUS_XIO_GSI_ERROR_WRAP_GSSAPI
GLOBUS_XIO_GSI_ERROR_EMPTY_TARGET_NAME
GLOBUS_XIO_GSI_ERROR_EMPTY_HOST_NAME
GLOBUS_XIO_GSI_AUTHORIZATION_FAILED
GLOBUS_XIO_GSI_ERROR_TOKEN_TOO_BIG

enum globus_xio_gsi_cmd_t — this one is long, it's giving main character energy, every single command in here:

GLOBUS_XIO_GSI_SET_CREDENTIAL
GLOBUS_XIO_GSI_GET_CREDENTIAL
GLOBUS_XIO_GSI_SET_GSSAPI_REQ_FLAGS
GLOBUS_XIO_GSI_GET_GSSAPI_REQ_FLAGS
GLOBUS_XIO_GSI_SET_PROXY_MODE
GLOBUS_XIO_GSI_GET_PROXY_MODE
GLOBUS_XIO_GSI_SET_AUTHORIZATION_MODE
GLOBUS_XIO_GSI_GET_AUTHORIZATION_MODE
GLOBUS_XIO_GSI_SET_DELEGATION_MODE
GLOBUS_XIO_GSI_GET_DELEGATION_MODE
GLOBUS_XIO_GSI_SET_SSL_COMPATIBLE
GLOBUS_XIO_GSI_SET_ANON
GLOBUS_XIO_GSI_SET_WRAP_MODE
GLOBUS_XIO_GSI_GET_WRAP_MODE
GLOBUS_XIO_GSI_SET_BUFFER_SIZE
GLOBUS_XIO_GSI_GET_BUFFER_SIZE
GLOBUS_XIO_GSI_SET_PROTECTION_LEVEL
GLOBUS_XIO_GSI_GET_PROTECTION_LEVEL
GLOBUS_XIO_GSI_GET_TARGET_NAME
GLOBUS_XIO_GSI_SET_TARGET_NAME
GLOBUS_XIO_GSI_GET_CONTEXT
GLOBUS_XIO_GSI_GET_DELEGATED_CRED
GLOBUS_XIO_GSI_GET_PEER_NAME
GLOBUS_XIO_GSI_GET_LOCAL_NAME
GLOBUS_XIO_GSI_INIT_DELEGATION
GLOBUS_XIO_GSI_REGISTER_INIT_DELEGATION
GLOBUS_XIO_GSI_ACCEPT_DELEGATION
GLOBUS_XIO_GSI_REGISTER_ACCEPT_DELEGATION
GLOBUS_XIO_GSI_FORCE_SERVER_MODE
GLOBUS_XIO_GSI_SET_ALLOW_MISSING_SIGNING_POLICY
GLOBUS_XIO_GSI_GET_ALLOW_MISSING_SIGNING_POLICY
GLOBUS_XIO_GSI_SET_CREDENTIALS_DIR
GLOBUS_XIO_GSI_SET_APPLICATION_PROTOCOLS

enum globus_xio_gsi_protection_level_t:

GLOBUS_XIO_GSI_PROTECTION_LEVEL_NONE
GLOBUS_XIO_GSI_PROTECTION_LEVEL_INTEGRITY
GLOBUS_XIO_GSI_PROTECTION_LEVEL_PRIVACY

enum globus_xio_gsi_delegation_mode_t:

GLOBUS_XIO_GSI_DELEGATION_MODE_NONE
GLOBUS_XIO_GSI_DELEGATION_MODE_LIMITED
GLOBUS_XIO_GSI_DELEGATION_MODE_FULL

enum globus_xio_gsi_proxy_mode_t:

GLOBUS_XIO_GSI_PROXY_MODE_FULL
GLOBUS_XIO_GSI_PROXY_MODE_LIMITED
GLOBUS_XIO_GSI_PROXY_MODE_MANY

enum globus_xio_gsi_authorization_mode_t:

GLOBUS_XIO_GSI_NO_AUTHORIZATION
GLOBUS_XIO_GSI_SELF_AUTHORIZATION
GLOBUS_XIO_GSI_IDENTITY_AUTHORIZATION
GLOBUS_XIO_GSI_HOST_AUTHORIZATION

💜 Functions 💜

okay so every single one of these returns globus_result_t, and there are a lot of them, and we are listing all of them because skipping even one would be a crime. the attr ones go through globus_xio_gsi_attr_cntl, the handle ones go through globus_xio_gsi_handle_cntl. 🫶

💖 credential stuff 💖

• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_CREDENTIAL, gss_cred_id_t credential) — the SET_CREDENTIAL one, on the attr. 🔥
• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_SET_CREDENTIAL, gss_cred_id_t credential) — same command, but handle-level.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_GET_CREDENTIAL, gss_cred_id_t *credential) — GET_CREDENTIAL, attr version, pointer out.
• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_GET_CREDENTIAL, gss_cred_id_t *credential) — GET_CREDENTIAL, handle version, pointer out.

✨ gssapi req flags ✨

• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_GSSAPI_REQ_FLAGS, OM_uint32 req_flags) — sets req_flags.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_GET_GSSAPI_REQ_FLAGS, OM_uint32 *req_flags) — gets req_flags back through the pointer.

🌸 proxy mode 🌸

• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_PROXY_MODE, globus_xio_gsi_proxy_mode_t proxy_mode) — sets proxy_mode.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_GET_PROXY_MODE, globus_xio_gsi_proxy_mode_t *proxy_mode) — reads it back.

🦋 authorization mode 🦋

• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_AUTHORIZATION_MODE, globus_xio_gsi_authorization_mode_t authz_mode) — sets authz_mode.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_GET_AUTHORIZATION_MODE, globus_xio_gsi_authorization_mode_t *authz_mode) — reads authz_mode back.

🎀 delegation mode 🎀

• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_DELEGATION_MODE, globus_xio_gsi_delegation_mode_t delegation_mode) — sets delegation_mode.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_GET_DELEGATION_MODE, globus_xio_gsi_delegation_mode_t *delegation_mode) — reads delegation_mode back.

⭐ the boolean-ish ones ⭐

• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_SSL_COMPATIBLE, globus_bool_t ssl_mode) — sets ssl_mode.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_ANON, globus_bool_t anon_mode) — sets anon_mode.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_WRAP_MODE, globus_bool_t wrap_mode) — sets wrap_mode.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_GET_WRAP_MODE, globus_bool_t *wrap_mode) — reads wrap_mode back.

💅 buffer size 💅

• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_BUFFER_SIZE, globus_size_t buffer_size) — sets buffer_size.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_GET_BUFFER_SIZE, globus_size_t *buffer_size) — reads buffer_size back.

🌈 protection level 🌈

• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_PROTECTION_LEVEL, globus_xio_gsi_protection_level_t protection_level) — sets protection_level.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_GET_PROTECTION_LEVEL, globus_xio_gsi_protection_level_t *protection_level) — reads it back.

🍓 target name 🍓

• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_GET_TARGET_NAME, gss_name_t *target_name) — GET_TARGET_NAME, pointer out.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_TARGET_NAME, gss_name_t target_name) — SET_TARGET_NAME, straight in.

👑 handle-only info (the gossip) 👑

• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_GET_CONTEXT, gss_ctx_id_t *context) — hands you back the context.
• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_GET_DELEGATED_CRED, gss_cred_id_t *credential) — hands you back the delegated credential.
• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_GET_PEER_NAME, gss_name_t *peer_name) — hands you back peer_name.
• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_GET_LOCAL_NAME, gss_name_t *local_name) — hands you back local_name.

🧚 delegation, the whole saga 🧚

• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_INIT_DELEGATION, gss_cred_id_t credential, gss_OID_set restriction_oids, gss_buffer_set_t restriction_buffers, OM_uint32 time_req) — INIT_DELEGATION, with credential, restriction_oids, restriction_buffers and time_req.
• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_REGISTER_INIT_DELEGATION, gss_cred_id_t credential, gss_OID_set restriction_oids, gss_buffer_set_t restriction_buffers, OM_uint32 time_req, globus_xio_gsi_delegation_init_callback_t callback, void *callback_arg) — same lineup plus a callback and callback_arg. ✨
• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_ACCEPT_DELEGATION, gss_cred_id_t *credential, gss_OID_set restriction_oids, gss_buffer_set_t restriction_buffers, OM_uint32 time_req) — ACCEPT_DELEGATION, credential comes back as a pointer here.
• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_REGISTER_ACCEPT_DELEGATION, gss_OID_set restriction_oids, gss_buffer_set_t restriction_buffers, OM_uint32 time_req, globus_xio_gsi_delegation_accept_callback_t callback, void *callback_arg) — no credential argument, but it does take the callback and callback_arg.

💀 the rest, and yes they matter 💀

• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_FORCE_SERVER_MODE, globus_bool_t server_mode) — sets server_mode.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_ALLOW_MISSING_SIGNING_POLICY, globus_bool_t allow) — sets allow.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_GET_ALLOW_MISSING_SIGNING_POLICY, globus_bool_t *allow) — reads allow back.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_CREDENTIALS_DIR, const char *directory) — sets directory on the attr.
• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_SET_CREDENTIALS_DIR, const char *directory) — sets directory on the handle.
• globus_result_t globus_xio_gsi_attr_cntl (attr, driver, GLOBUS_XIO_GSI_SET_APPLICATION_PROTOCOLS, char **protocols) — sets protocols on the attr.
• globus_result_t globus_xio_gsi_handle_cntl (handle, driver, GLOBUS_XIO_GSI_SET_APPLICATION_PROTOCOLS, char **protocols) — sets protocols on the handle.

---

🌟 Detailed Description 🌟

XIO GSI Driver.

Author

Sam Meder 👑

---

🎀 Macro Definition Documentation 🎀

💖 #define globus_xio_gsi_attr_cntl globus_xio_attr_cntl 💖

doxygen varargs filter stuff. that's it, that's the note. 🫶

---

💜 Author 💜

Generated automatically by Doxygen for globus_xio_gsi_driver from the source code.

---

and that's the page, bestie!! 🦋💖 this whole thing came to you courtesy of globus_xio_gsi_driver, Version 5.4, and the manual page globus_xio_gsi.h(3). go forth and slay your GSI stuff, ily, bye!! ✨👑