globus_gsi_cred_handle(3)

📦
version 8.5 · 6 versions
, in epel 10, fedora 43, fedora 44, ubuntu resolute, ubuntu stonking

✨ NAME ✨

globus_gsi_cred_handle — Credential Handle Management.

okay so like, this is the globus_gsi_cred_handle(3) page from the Library Functions Manual, and it's literally all about credential handle management. it's giving main character energy for GSI credentials, periodt. 💅

🌈 SYNOPSIS 🌈

🧚 Typedefs 🧚

typedef struct globus_l_gsi_cred_handle_s * globus_gsi_cred_handle_t

🔥 Functions 🔥

  • globus_result_t globus_gsi_cred_handle_init (globus_gsi_cred_handle_t *handle, globus_gsi_cred_handle_attrs_t handle_attrs) — Initialize a Handle. like, spin up a fresh handle, bestie.
  • globus_result_t globus_gsi_cred_handle_destroy (globus_gsi_cred_handle_t handle) — Destroy the credential handle. bye bye, handle! 💀
  • globus_result_t globus_gsi_cred_handle_copy (globus_gsi_cred_handle_t source, globus_gsi_cred_handle_t *dest) — Copy a handle. dupe it, no cap.
  • globus_result_t globus_gsi_cred_get_handle_attrs (globus_gsi_cred_handle_t handle, globus_gsi_cred_handle_attrs_t *attrs) — Get the handle attributes. gimme those attrs.
  • globus_result_t globus_gsi_cred_get_goodtill (globus_gsi_cred_handle_t cred_handle, time_t *goodtill) — Get credential expiration. when does it expire? let's find out.
  • globus_result_t globus_gsi_cred_get_lifetime (globus_gsi_cred_handle_t cred_handle, time_t *lifetime) — Get credential lifetime. how long does it live?
  • globus_result_t globus_gsi_cred_get_key_bits (globus_gsi_cred_handle_t cred_handle, int *key_bits) — Get credential strength. how many bits? so strong. 💪
  • globus_result_t globus_gsi_cred_set_cert (globus_gsi_cred_handle_t handle, X509 *cert) — Set the credential's certificate. slap a cert on it.
  • globus_result_t globus_gsi_cred_get_cert (globus_gsi_cred_handle_t handle, X509 **cert) — Get the credential's certificate. grab that cert.
  • globus_result_t globus_gsi_cred_set_key (globus_gsi_cred_handle_t handle, EVP_PKEY *key) — Set the credential's private key. private key time, shh. 🤫
  • globus_result_t globus_gsi_cred_get_key (globus_gsi_cred_handle_t handle, EVP_PKEY **key) — Get the credential's private key. get that key.
  • globus_result_t globus_gsi_cred_set_cert_chain (globus_gsi_cred_handle_t handle, STACK_OF(X509) *cert_chain) — Set the certificate chain. chain it up.
  • globus_result_t globus_gsi_cred_get_cert_chain (globus_gsi_cred_handle_t handle, STACK_OF(X509) **cert_chain) — Get the certificate chain. get the whole chain.
  • globus_result_t globus_gsi_cred_get_X509_subject_name (globus_gsi_cred_handle_t handle, X509_NAME **subject_name) — Get credential subject name. who dis?
  • globus_result_t globus_gsi_cred_get_X509_identity_name (globus_gsi_cred_handle_t handle, X509_NAME **identity_name) — Get X.509 identity. identity check.
  • globus_result_t globus_gsi_cred_get_subject_name (globus_gsi_cred_handle_t handle, char **subject_name) — Get credential subject name. name, please.
  • globus_result_t globus_gsi_cred_get_policies (globus_gsi_cred_handle_t handle, STACK_OF(OPENSSL_STRING) **policies) — Get certificate chain policies. policies, periodt.
  • globus_result_t globus_gsi_cred_get_policy_languages (globus_gsi_cred_handle_t handle, STACK_OF(ASN1_OBJECT) **policy_languages) — Get certificate chain policy languages. languages of policies, iykyk.
  • globus_result_t globus_gsi_cred_get_X509_issuer_name (globus_gsi_cred_handle_t handle, X509_NAME **issuer_name) — Get credential issuer name object. issuer, who?
  • globus_result_t globus_gsi_cred_get_issuer_name (globus_gsi_cred_handle_t handle, char **issuer_name) — Get issuer name. issuer name, got it.
  • globus_result_t globus_gsi_cred_get_identity_name (globus_gsi_cred_handle_t handle, char **identity_name) — Get identity name. identity, pls.
  • globus_result_t globus_gsi_cred_verify_cert_chain (globus_gsi_cred_handle_t cred_handle, globus_gsi_callback_data_t callback_data) — Verify credential. verify it, bestie.
  • globus_result_t globus_gsi_cred_verify_cert_chain_when (globus_gsi_cred_handle_t cred_handle, globus_gsi_callback_data_t callback_data_in, time_t check_time) — Verify credential at a specific time. time travel verification? 🔥
  • globus_result_t globus_gsi_cred_verify (globus_gsi_cred_handle_t handle) — Verify a credential. just verify it.

💅 Detailed Description 💅

Credential Handle Management.

Create/Destroy/Modify a GSI Credential Handle.

Within the Globus GSI Credential Library, all credential operations require a handle parameter. Currently only one operation may be in progress at once per credential handle.

This section defines operations to create, modify and destroy GSI Credential handles.

🦋 Typedef Documentation 🦋

typedef struct globus_l_gsi_cred_handle_s* globus_gsi_cred_handle_t

GSI Credential Handle.

A GSI Credential handle keeps track of state relating to a credential. Handles can have immutable attributes associated with them. All credential operations take a credential handle pointer as a parameter.

See also: globus_gsi_cred_handle_init(), globus_gsi_cred_handle_destroy(), globus_gsi_cred_handle_attrs_t

👑 Function Documentation 👑

💖 globus_gsi_cred_get_cert 💖

globus_result_t globus_gsi_cred_get_cert (globus_gsi_cred_handle_t handle, X509 ** cert)

Get the credential's certificate. Get the certificate of a credential.

Parameters:

  • handle — the credential handle we're pulling the certificate from.
  • cert — the resulting X509 certificate, which is a duplicate of the certificate in the credential handle. you gotta free this when you're done using X509_free, bestie.

Returns: GLOBUS_SUCCESS if no error, otherwise an error object id is returned.

🌈 globus_gsi_cred_get_cert_chain 🌈

globus_result_t globus_gsi_cred_get_cert_chain (globus_gsi_cred_handle_t handle, STACK_OF(X509) ** cert_chain)

Get the certificate chain. Get the certificate chain of the credential handle.

Parameters:

  • handle — the credential handle containing the certificate chain to get.
  • cert_chain — the certificate chain to set as a duplicate of the cert chain in the credential handle. this variable (or the variable it points to) needs to be freed when the user is finished with it using sk_X509_free.

Returns: GLOBUS_SUCCESS if no error, otherwise an error object id is returned.

⏰ globus_gsi_cred_get_goodtill ⏰

globus_result_t globus_gsi_cred_get_goodtill (globus_gsi_cred_handle_t cred_handle, time_t * goodtill)

Get credential expiration. This function retrieves the expiration time of the credential contained in the handle.

Parameters:

  • cred_handle — the credential handle to retrieve the expiration time from.
  • goodtill — contains the expiration time on return.

Returns: GLOBUS_SUCCESS or an error captured in a globus_result_t.

🎀 globus_gsi_cred_get_handle_attrs 🎀

globus_result_t globus_gsi_cred_get_handle_attrs (globus_gsi_cred_handle_t handle, globus_gsi_cred_handle_attrs_t * attrs)

Get the handle attributes. This function retrieves a copy of the credential handle attributes.

Parameters:

  • handle — the credential handle to retrieve the attributes from.
  • attrs — contains the credential attributes on return.

Returns: GLOBUS_SUCCESS or an error captured in a globus_result_t.

🪪 globus_gsi_cred_get_identity_name 🪪

globus_result_t globus_gsi_cred_get_identity_name (globus_gsi_cred_handle_t handle, char ** identity_name)

Get identity name. Get the identity's subject name from the credential handle.

Parameters:

  • handle — the credential handle containing the certificate to get the identity of.
  • identity_name — the identity certificate's subject name.

Returns: GLOBUS_SUCCESS if no error, otherwise an error object identifier is returned.

🏷️ globus_gsi_cred_get_issuer_name 🏷️

globus_result_t globus_gsi_cred_get_issuer_name (globus_gsi_cred_handle_t handle, char ** issuer_name)

Get issuer name. Get the issuer's subject name from the credential handle.

Parameters:

  • handle — the credential handle containing the certificate to get the issuer of.
  • issuer_name — the issuer certificate's subject name.

Returns: GLOBUS_SUCCESS if no error, otherwise an error object identifier is returned.

🔑 globus_gsi_cred_get_key 🔑

globus_result_t globus_gsi_cred_get_key (globus_gsi_cred_handle_t handle, EVP_PKEY ** key)

Get the credential's private key. Get the credential handle's private key.

Parameters:

  • handle — the credential handle containing the private key to get.
  • key — the private key which after this function returns is set to a duplicate of the private key of the credential handle. this variable needs to be freed by the user when it is no longer used via the function EVP_PKEY_free.

Returns: GLOBUS_SUCCESS or an error object identifier.

💪 globus_gsi_cred_get_key_bits 💪

globus_result_t globus_gsi_cred_get_key_bits (globus_gsi_cred_handle_t cred_handle, int * key_bits)

Get credential strength. This function retrieves the key strength of the credential contained in a handle.

Parameters:

  • cred_handle — the credential handle to retrieve the strength from.
  • key_bits — contains the number of bits in the key on return.

Returns: GLOBUS_SUCCESS or an error captured in a globus_result_t.

⏳ globus_gsi_cred_get_lifetime ⏳

globus_result_t globus_gsi_cred_get_lifetime (globus_gsi_cred_handle_t cred_handle, time_t * lifetime)

Get credential lifetime. This function retrieves the lifetime of the credential contained in a handle.

Parameters:

  • cred_handle — the credential handle to retrieve the lifetime from.
  • lifetime — contains the lifetime on return.

Returns: GLOBUS_SUCCESS or an error captured in a globus_result_t.

📜 globus_gsi_cred_get_policies 📜

globus_result_t globus_gsi_cred_get_policies (globus_gsi_cred_handle_t handle, STACK_OF(OPENSSL_STRING) ** policies)

Get certificate chain policies. Get the Policies from the Cert Chain in the handle. The policies will be null-terminated as they are added to the handle. If a policy for a cert in the chain doesn't exist, the string in the stack will be set to the static string GLOBUS_NULL_POLICIES.

Parameters:

  • handle — the handle to get the cert chain containing the policies.
  • policies — the stack of policies retrieved from the handle's cert chain.

Returns: GLOBUS_SUCCESS or an error object if an error occurred.

🌐 globus_gsi_cred_get_policy_languages 🌐

globus_result_t globus_gsi_cred_get_policy_languages (globus_gsi_cred_handle_t handle, STACK_OF(ASN1_OBJECT) ** policy_languages)

Get certificate chain policy languages. Get the policy languages from the cert chain in the handle.

Parameters:

  • handle — the handle to get the cert chain containing the policies.
  • policy_languages — the stack of policies retrieved from the handle's cert chain.

Returns: GLOBUS_SUCCESS or an error object if an error occurred.

📛 globus_gsi_cred_get_subject_name 📛

globus_result_t globus_gsi_cred_get_subject_name (globus_gsi_cred_handle_t handle, char ** subject_name)

Get credential subject name. Get the credential handle's certificate subject name.

Parameters:

  • handle — the credential handle containing the certificate to get the subject name of.
  • subject_name — the subject name as a string. this should be freed using OPENSSL_free() when the user is finished with it.

Returns: GLOBUS_SUCCESS if no error, a error object id otherwise.

globus_gsi_cred_get_X509_identity_name 🦋

globus_result_t globus_gsi_cred_get_X509_identity_name (globus_gsi_cred_handle_t handle, X509_NAME ** identity_name)

Okay bestie, this one gets the X.509 identity. It pulls the identity's X.509 subject name straight out of the credential handle. iconic.

Parameters

  • handle — the credential handle containing the certificate to get the identity from
  • identity_name — the identity certificate's X509 subject name

Returns

  • GLOBUS_SUCCESS if no error, otherwise an error object identifier is returned

globus_gsi_cred_get_X509_issuer_name 🎀

globus_result_t globus_gsi_cred_get_X509_issuer_name (globus_gsi_cred_handle_t handle, X509_NAME ** issuer_name)

Get credential issuer name object. This grabs the credential handle's certificate issuer name. vibe check passed.

Parameters

  • handle — the credential handle containing the certificate to get the issuer name of
  • issuer_name — the issuer name as an X509_NAME object. This should be freed using X509_NAME_free when the user is finished with it

Returns

  • GLOBUS_SUCCESS if no error, a error object id otherwise

globus_gsi_cred_get_X509_subject_name 💅

globus_result_t globus_gsi_cred_get_X509_subject_name (globus_gsi_cred_handle_t handle, X509_NAME ** subject_name)

Get credential subject name. This gets the credential handle's certificate subject name. slay.

Parameters

  • handle — the credential handle containing the certificate to get the subject name of
  • subject_name — the subject name as an X509_NAME object. This should be freed using X509_NAME_free when the user is finished with it

Returns

  • GLOBUS_SUCCESS if no error, a error object id otherwise

globus_gsi_cred_handle_copy 🫶

globus_result_t globus_gsi_cred_handle_copy (globus_gsi_cred_handle_t source, globus_gsi_cred_handle_t * dest)

Copy a handle. Copies a credential handle. main character energy.

Parameters

  • source — the handle to be copied
  • dest — the destination of the copy

Returns

  • GLOBUS_SUCCESS or an error captured in a globus_result_t

globus_gsi_cred_handle_destroy 💀

globus_result_t globus_gsi_cred_handle_destroy (globus_gsi_cred_handle_t handle)

Destroy the credential handle. Destroys the credential handle. bye bye.

Parameters

  • handle — the credential handle to be destroyed

Returns

  • GLOBUS_SUCCESS

globus_gsi_cred_handle_init ✨

globus_result_t globus_gsi_cred_handle_init (globus_gsi_cred_handle_t * handle, globus_gsi_cred_handle_attrs_t handle_attrs)

Initialize a Handle. Initializes a credential handle to be used credential handling functions. Takes a set of handle attributes that are immutable to the handle. The handle attributes are only pointed to by the handle, so the lifetime of the attributes needs to be as long as that of the handle. periodt.

Parameters

  • handle — the handle to be initialized
  • handle_attrs — the immutable attributes of the handle

Returns

  • GLOBUS_SUCCESS or an error captured in a globus_result_t

globus_gsi_cred_set_cert 🎀

globus_result_t globus_gsi_cred_set_cert (globus_gsi_cred_handle_t handle, X509 * cert)

Set the credential's certificate. Set the Credential's Certificate. The X509 cert that is passed in should be a valid X509 certificate object. no cap.

Parameters

  • handle — the credential handle to set the certificate on
  • cert — the X509 cert to set in the cred handle. The cert passed in can be NULL which will set the cert in the handle to NULL, freeing the current cert in the handle.

Returns

  • GLOBUS_SUCCESS or an error object id if an error

globus_gsi_cred_set_cert_chain 🌈

globus_result_t globus_gsi_cred_set_cert_chain (globus_gsi_cred_handle_t handle, STACK_OF(X509) * cert_chain)

Set the certificate chain. Set the certificate chain of the credential handle. iykyk.

Parameters

  • handle — the handle containing the certificate chain field to set
  • cert_chain — the certificate chain to set the handle's certificate chain to

Returns

  • GLOBUS_SUCCESS if no error, otherwise an error object id is returned

globus_gsi_cred_set_key 🔑

globus_result_t globus_gsi_cred_set_key (globus_gsi_cred_handle_t handle, EVP_PKEY * key)

Set the credential's private key. Set the private key of the credential handle. lowkey important.

Parameters

  • handle — the handle on which to set the key.
  • key — the private key to set the handle's key to. This value can be NULL, in which case the current handle's key is freed.

globus_gsi_cred_verify 🔥

globus_result_t globus_gsi_cred_verify (globus_gsi_cred_handle_t handle)

Verify a credential. This function checks that the certificate is signed by the public key of the issuer cert (the first cert in the chain).

Note that this function DOES NOT check the private key or the public of the certificate, as stated in a previous version of the documentation.

Parameters

  • handle — the credential handle containing the certificate and key to be validated

Returns

  • GLOBUS_SUCCESS if no error, otherwise an error object identifier is returned

globus_gsi_cred_verify_cert_chain 🦋

globus_result_t globus_gsi_cred_verify_cert_chain (globus_gsi_cred_handle_t cred_handle, globus_gsi_callback_data_t callback_data)

Verify credential. This function performs path validation on the certificate chain contained in the credential handle. vibe check.

Parameters

  • cred_handle — the credential handle containing the certificate chain to be validated
  • callback_data — A initialized callback data structure

Returns

  • GLOBUS_SUCCESS if no error, otherwise an error object identifier is returned

globus_gsi_cred_verify_cert_chain_when ⏰

globus_result_t globus_gsi_cred_verify_cert_chain_when (globus_gsi_cred_handle_t cred_handle, globus_gsi_callback_data_t callback_data_in, time_t check_time)

Verify credential at a specific time. This function performs path validation on the certificate chain contained in the credential handle. Expiration checks are done at the time given. time travel but make it certs.

Parameters

  • cred_handle — the credential handle containing the certificate chain to be validated
  • callback_data_in — A callback data structure. If NULL, one will be initialized with only the default cert dir set.
  • check_time — Check if the cert chain was valid at this time. Set to 0 to use a time that the cert is valid, essentially bypassing the expiration check.

Returns

  • GLOBUS_SUCCESS if no error, otherwise an error object identifier is returned

Author 👑

Generated automatically by Doxygen for globus_gsi_credential from the source code.

that's the whole page, bestie. source: globus_gsi_credential, version: 8.5, page: globus_gsi_cred_handle(3), date: the Doxygen stamp in the footer. now go be iconic with your credentials 💖
📦 where this page comes from