globus_gsi_proxy_handle(3)

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

💖 NAME 💖

globus_gsi_proxy_handle(3) — Handle Management

Create/Destroy/Modify a GSI Proxy Handle.

✨ SYNOPSIS ✨

Typedefs

  • typedef struct globus_l_gsi_proxy_handle_s * globus_gsi_proxy_handle_t — GSI Proxy Handle.

Functions

  • globus_result_t globus_gsi_proxy_handle_init (globus_gsi_proxy_handle_t *handle, globus_gsi_proxy_handle_attrs_t handle_attrs) — Initialize a GSI Proxy handle.
  • globus_result_t globus_gsi_proxy_handle_get_req (globus_gsi_proxy_handle_t handle, X509_REQ **req) — Get the certificate request from a GSI Proxy handle.
  • globus_result_t globus_gsi_proxy_handle_get_private_key (globus_gsi_proxy_handle_t handle, EVP_PKEY **proxy_key) — Get the private key from a GSI Proxy handle.
  • globus_result_t globus_gsi_proxy_handle_get_type (globus_gsi_proxy_handle_t handle, globus_gsi_cert_utils_cert_type_t *type) — Get Proxy Type.
  • globus_result_t globus_gsi_proxy_handle_set_type (globus_gsi_proxy_handle_t handle, globus_gsi_cert_utils_cert_type_t type) — Get Proxy Type.
  • globus_result_t globus_gsi_proxy_handle_set_policy (globus_gsi_proxy_handle_t handle, const unsigned char *policy_data, int policy_length, int policy_language_NID) — Set Policy.
  • globus_result_t globus_gsi_proxy_handle_get_policy (globus_gsi_proxy_handle_t handle, unsigned char **policy_data, int *policy_length, int *policy_NID) — Get Policy.
  • globus_result_t globus_gsi_proxy_handle_add_extension (globus_gsi_proxy_handle_t handle, X509_EXTENSION *ext) — Add X.509 Extensions.
  • globus_result_t globus_gsi_proxy_handle_set_extensions (globus_gsi_proxy_handle_t handle, STACK_OF(X509_EXTENSION) *exts) — Set X.509 Extensions.
  • globus_result_t globus_gsi_proxy_handle_get_extensions (globus_gsi_proxy_handle_t handle, STACK_OF(X509_EXTENSION) **exts) — Get X.509 Extensions.
  • globus_result_t globus_gsi_proxy_handle_set_pathlen (globus_gsi_proxy_handle_t handle, long pathlen) — Set Path Length.
  • globus_result_t globus_gsi_proxy_handle_get_pathlen (globus_gsi_proxy_handle_t handle, int *pathlen) — Get Path Length.
  • globus_result_t globus_gsi_proxy_handle_get_time_valid (globus_gsi_proxy_handle_t handle, int *time_valid) — Get Time Valid.
  • globus_result_t globus_gsi_proxy_handle_set_time_valid (globus_gsi_proxy_handle_t handle, int time_valid) — Set Time Valid.
  • globus_result_t globus_gsi_proxy_handle_clear_cert_info (globus_gsi_proxy_handle_t handle) — Clear Cert Info.
  • globus_result_t globus_gsi_proxy_handle_get_proxy_cert_info_openssl (globus_gsi_proxy_handle_t handle, PROXY_CERT_INFO_EXTENSION **pci) — Get Cert Info.
  • globus_result_t globus_gsi_proxy_handle_set_proxy_cert_info_openssl (globus_gsi_proxy_handle_t handle, PROXY_CERT_INFO_EXTENSION *pci) — Set Cert Info.
  • globus_result_t globus_gsi_proxy_handle_get_signing_algorithm (globus_gsi_proxy_handle_t handle, const EVP_MD **signing_algorithm) — Get Signing Algorithm.
  • globus_result_t globus_gsi_proxy_handle_get_keybits (globus_gsi_proxy_handle_t handle, int *key_bits) — Get Key Bits.
  • globus_result_t globus_gsi_proxy_handle_get_init_prime (globus_gsi_proxy_handle_t handle, int *init_prime) — Get Init Prime.
  • globus_result_t globus_gsi_proxy_handle_get_clock_skew_allowable (globus_gsi_proxy_handle_t handle, int *skew) — Get Clock Skew.
  • globus_result_t globus_gsi_proxy_handle_get_key_gen_callback (globus_gsi_proxy_handle_t handle, void(**callback)(int, int, void *)) — Get Callback for Creating Keys.
  • globus_result_t globus_gsi_proxy_handle_get_common_name (globus_gsi_proxy_handle_t handle, char **common_name) — Get/Set Proxy Common Name.
  • globus_result_t globus_gsi_proxy_handle_set_is_limited (globus_gsi_proxy_handle_t handle, globus_bool_t is_limited) — Set/Check Proxy Is Limited.

📖 Detailed Description 📖

Create/Destroy/Modify a GSI Proxy Handle.

Okay so inside the Globus GSI Proxy Library, every single proxy operation needs a handle parameter. No handle, no vibes, periodt. Right now, only one proxy operation can be in progress at a time per proxy handle — it's giving exclusive, main-character energy. 💅

This section defines the operations to create, modify, and destroy GSI Proxy handles. ✨

🧬 Typedef Documentation 🧬

typedef struct globus_l_gsi_proxy_handle_s* globus_gsi_proxy_handle_t

GSI Proxy Handle. An GSI Proxy handle is used to associate state with a group of operations. Handles can have immutable attributes associated with them. All proxy operations take a handle pointer as a parameter.

See also:

  • globus_gsi_proxy_handle_init()
  • globus_gsi_proxy_handle_destroy()
  • Handle Attributes

🛠️ Function Documentation 🛠️

globus_result_t globus_gsi_proxy_handle_add_extension (globus_gsi_proxy_handle_t handle, X509_EXTENSION * ext)

Add X.509 Extensions. Add an X.509 extension to the GSI Proxy handle to be added to certificate.

This function adds a X.509 extension to the proxy certificate. ✨

Parameters

  • handle — The handle for the proxy to which the extension should be added.
  • ext — The extension to be added.

Returns GLOBUS_SUCCESS if the addition was successful, otherwise an error is returned.

See also:

  • globus_gsi_proxy_handle_get_extensions()
  • globus_gsi_proxy_handle_set_extensions()

globus_result_t globus_gsi_proxy_handle_clear_cert_info (globus_gsi_proxy_handle_t handle)

Clear Cert Info. Clear the proxy cert info extension stored in the GSI Proxy handle.

This function clears proxy cert info extension related setting in the GSI Proxy handle.

Parameters

  • handle — The handle for which to clear the proxy cert info extension.

Returns GLOBUS_SUCCESS if the handle is valid, otherwise an error is returned.

globus_result_t globus_gsi_proxy_handle_get_clock_skew_allowable (globus_gsi_proxy_handle_t handle, int * skew)

Get Clock Skew. Get the clock skew of the proxy handle.

Parameters

  • handle — The handle to get the clock skew of.
  • skew — The resulting clock skew.

Returns GLOBUS_SUCCESS unless an error occurred, in which case an error object identifier (in the form of a globus_result_t) is returned.

globus_result_t globus_gsi_proxy_handle_get_common_name (globus_gsi_proxy_handle_t handle, char ** common_name)

Get/Set Proxy Common Name. Get the proxy common name stored in the GSI Proxy handle.

This function retrieves the proxy common name from the GSI Proxy handle. The common name only impacts draft compliant proxies.

Parameters

  • handle — The handle from which to get the proxy common name.
  • common_name — Contains the proxy common name upon successful return. If the handle does not contain a common name, this parameter will be NULL upon return.

Returns GLOBUS_SUCCESS upon success. GLOBUS_GSI_PROXY_ERROR_WITH_HANDLE if handle is invalid.

globus_result_t globus_gsi_proxy_handle_get_extensions (globus_gsi_proxy_handle_t handle, STACK_OF(X509_EXTENSION) ** exts)

Get X.509 Extensions. Get the X.509 extensions from a GSI Proxy handle.

This function returns the X.509 extensions from the proxy certificate.

Parameters

  • handle — The handle for the proxy from which the extensions should be retrieved.
  • exts — The variable to hold the extensions. The caller is responsible for freeing the extensions with sk_X509_EXTENSION_free() when they are done with them.

Returns GLOBUS_SUCCESS if the retrieval was successful, otherwise an error is returned.

See also:

  • globus_gsi_proxy_handle_add_extension()
  • globus_gsi_proxy_handle_set_extensions()

globus_result_t globus_gsi_proxy_handle_get_init_prime (globus_gsi_proxy_handle_t handle, int * init_prime)

Get Init Prime. Get the init prime of the proxy handle.

Parameters

  • handle — The handle to get the init prime used in generating the key pair.
  • init_prime — The resulting init prime.

Returns GLOBUS_SUCCESS unless an error occurred, in which case an error object identifier (in the form of a globus_result_t) is returned.

globus_result_t globus_gsi_proxy_handle_get_key_gen_callback (globus_gsi_proxy_handle_t handle, void(** callback )(int, int, void *))

Get Callback for Creating Keys. Get the callback for creating the public/private key pair.

Parameters

  • handle — The proxy handle to get the callback from.
  • callback — Parameter used for returning the callback.

Returns GLOBUS_SUCCESS or an error object identifier.

globus_result_t globus_gsi_proxy_handle_get_keybits (globus_gsi_proxy_handle_t handle, int * key_bits)

Get Key Bits. Get the key bits used for the pub/private key pair of the proxy.

Parameters

  • handle — The proxy handle to get the key bits of.
  • key_bits — key bits of the proxy handle.

Returns GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned GLOBUS_SUCCESS.

globus_result_t globus_gsi_proxy_handle_get_pathlen (globus_gsi_proxy_handle_t handle, int * pathlen)

Get Path Length. Get the path length from the GSI Proxy handle.

This function gets the path length that is being used in the proxy cert info extension.

Parameters

  • handle — The handle to be interrogated.
  • pathlen — The maximum allowable path length.

Returns GLOBUS_SUCCESS if the handle is valid, otherwise an error is returned.

See also:

  • globus_gsi_proxy_handle_set_pathlen()

globus_result_t globus_gsi_proxy_handle_get_policy (globus_gsi_proxy_handle_t handle, unsigned char ** policy_data, int * policy_length, int * policy_NID)

Get Policy. Get the policy from the GSI Proxy handle.

This function gets the policy that is being used in the proxy cert info extension.

Parameters

  • handle — The handle to be interrogated.
  • policy_data — The policy data.
  • policy_length — The length of the returned policy.
  • policy_NID — The NID of the policy language.

Returns GLOBUS_SUCCESS if the handle is valid, otherwise an error is returned.

See also:

  • globus_gsi_proxy_handle_set_policy()

globus_result_t globus_gsi_proxy_handle_get_private_key (globus_gsi_proxy_handle_t handle, EVP_PKEY ** proxy_key)

Get the private key from a GSI Proxy handle. Copies the private key associated with the proxy handle to the value pointed to by the proxy_key parameter.

Parameters

  • handle — The handle from which to get the private key.
  • proxy_key — Parameter used to return the key. It is the users responsibility to free the returned key by calling EVP_PKEY_free().

Returns GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned.

And if you're feeling curious, the related function is globus_gsi_proxy_handle_set_private_key(). 💖

🌸 globus_result_t globus_gsi_proxy_handle_get_proxy_cert_info_openssl 🌸

globus_result_t globus_gsi_proxy_handle_get_proxy_cert_info_openssl
    (globus_gsi_proxy_handle_t handle, PROXY_CERT_INFO_EXTENSION ** pci)

Get Cert Info. This one is all about snagging the proxy cert info extension that's stored in your GSI Proxy handle. Like, it retrieves it for you. So fetch. 🐕

Parameters

  • handle — The handle from which to get the proxy cert info extension. It's the source, bestie.
  • pci — Contains the proxy cert info extension upon successful return. If the handle doesn't have a pci extension, this parameter will be NULL upon return. So if it's empty, you get a NULL, no cap.

Returns

  • GLOBUS_SUCCESS upon success. Slay! ✨
  • GLOBUS_GSI_PROXY_ERROR_WITH_HANDLE if handle is invalid. Oops. 😭
  • GLOBUS_GSI_PROXY_ERROR_WITH_PROXYCERTINFO if the pci pointer is invalid or if the get failed. Big yikes. 💀

🦋 globus_result_t globus_gsi_proxy_handle_get_req 🦋

globus_result_t globus_gsi_proxy_handle_get_req (globus_gsi_proxy_handle_t
    handle, X509_REQ ** req)

Get the certificate request from a GSI Proxy handle. It copies the certificate request associated with the proxy handle to the req parameter. So you get the req, literally. 📜

Parameters

  • handle — The handle from which to get the certificate request. That's where it's at.
  • req — Parameter used to return the request. It is the user's responsibility to free the returned request. So don't forget to free it, bestie. Memory leaks are not the vibe. 🧹

Returns

  • GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned. So if it's not success, you get an error ID. Periodt.

See also

  • globus_gsi_proxy_handle_set_req() — the setter, iykyk.

🌈 globus_result_t globus_gsi_proxy_handle_get_signing_algorithm 🌈

globus_result_t globus_gsi_proxy_handle_get_signing_algorithm
    (globus_gsi_proxy_handle_t handle, const EVP_MD ** signing_algorithm)

Get Signing Algorithm. Get the signing algorithm used to sign the proxy cert request. So you can see what's signing the tea. 🔏

Parameters

  • handle — The proxy handle containing the type of signing algorithm used. It's the holder of the algo.
  • signing_algorithm — Signing algorithm of the proxy handle. This is where it gets returned.

Return values

  • GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned. Same energy as before. 💅

💜 globus_result_t globus_gsi_proxy_handle_get_time_valid 💜

globus_result_t globus_gsi_proxy_handle_get_time_valid
    (globus_gsi_proxy_handle_t handle, int * time_valid)

Get Time Valid. Get the validity time of the proxy. Like, when does it expire? ⏰

Parameters

  • handle — The proxy handle to get the expiration date of. It's the one with the deets.
  • time_valid — Expiration date of the proxy handle. Returned here.

Returns

  • GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned. You know the drill. 💁‍♀️

🎀 globus_result_t globus_gsi_proxy_handle_get_type 🎀

globus_result_t globus_gsi_proxy_handle_get_type (globus_gsi_proxy_handle_t
    handle, globus_gsi_cert_utils_cert_type_t * type)

Get Proxy Type. Determine the type of proxy that will be generated when using this handle. So you know what kind of proxy you're getting. 🕵️‍♀️

Parameters

  • handle — The handle from which to get the type. The source.
  • type — Parameter used to return the type. It gets filled in.

Returns

  • GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned. Standard.

See also

  • globus_gsi_proxy_handle_set_type() — the setter, obviously.

✨ globus_result_t globus_gsi_proxy_handle_init ✨

globus_result_t globus_gsi_proxy_handle_init (globus_gsi_proxy_handle_t *
    handle, globus_gsi_proxy_handle_attrs_t handle_attrs)

Initialize a GSI Proxy handle. Initialize a proxy handle which can be used in subsequent operations. The handle may only be used in one sequence of operations at a time. So don't try to multitask with it, bestie. One thing at a time. 🧘‍♀️

Parameters

  • handle — A pointer to the handle to be initialized. If the handle is originally NULL, space is allocated for it. Otherwise, the current values of the handle are overwritten. So it's like a fresh start or a reset.
  • handle_attrs — Initial attributes to be used to create this handle. You gotta give it some initial vibes.

Returns

  • GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned. Yep.

See also

  • globus_gsi_proxy_handle_destroy() — to clean up after, because we don't leave messes. 🧼

🌸 globus_result_t globus_gsi_proxy_handle_set_extensions 🌸

globus_result_t globus_gsi_proxy_handle_set_extensions
    (globus_gsi_proxy_handle_t handle, STACK_OF(X509_EXTENSION) * exts)

Set X.509 Extensions. Set the X.509 extensions from a GSI Proxy handle. This function sets the X.509 extensions for a proxy certificate. So you're adding some extra flair to your cert. 💅

Parameters

  • handle — The handle for the proxy from which the extension should be set. It's the one getting the extensions.
  • exts — The extensions to be set. Can be NULL to clear extensions. So if you pass NULL, you're clearing them. Clean slate. 🧽

Returns

  • GLOBUS_SUCCESS if the addition was successful, otherwise an error is returned. Slay if it works, sad if not.

See also

  • globus_gsi_proxy_handle_add_extension() — to add just one, maybe.
  • globus_gsi_proxy_handle_get_extensions() — to get them back.

🦋 globus_result_t globus_gsi_proxy_handle_set_is_limited 🦋

globus_result_t globus_gsi_proxy_handle_set_is_limited
    (globus_gsi_proxy_handle_t handle, globus_bool_t is_limited)

Set/Check Proxy Is Limited. Set the limited proxy flag on the proxy handle. So you can mark it as limited or not. 🚫

Parameters

  • handle — the proxy handle. The one and only.
  • is_limited — boolean value to set on the proxy handle. globus_bool_t, so GLOBUS_TRUE or GLOBUS_FALSE. You decide.

Returns

  • GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned. The usual.

💜 globus_result_t globus_gsi_proxy_handle_set_pathlen 💜

globus_result_t globus_gsi_proxy_handle_set_pathlen
    (globus_gsi_proxy_handle_t handle, long pathlen)

Set Path Length. Set the path length to be used in the GSI Proxy handle. This function sets the path length to be used in the proxy cert info extension. So it's about how long the chain can be. 🔗

Parameters

  • handle — The handle to be modified. The one getting the pathlen.
  • pathlen — The maximum allowable path length. A long. Don't make it too long, or do, idk.

Returns

  • GLOBUS_SUCCESS if the handle is valid, otherwise an error is returned. So if the handle is good, you're good.

See also

  • globus_gsi_proxy_handle_get_pathlen() — to get it back.

🎀 globus_result_t globus_gsi_proxy_handle_set_policy 🎀

globus_result_t globus_gsi_proxy_handle_set_policy
    (globus_gsi_proxy_handle_t handle, const unsigned char * policy_data,
    int policy_length, int policy_language_NID)

Set Policy. Set the policy to be used in the GSI Proxy handle. This function sets the policy to be used in the proxy cert info extension. So you're defining the rules. 📜

Parameters

  • handle — The handle to be modified. The one getting the policy.
  • policy_data — The policy data. A pointer to unsigned char. The actual policy.
  • policy_length — The length of the policy data. An int. Gotta know how long it is.
  • policy_language_NID — The NID of the policy language. An int. The language identifier.

Returns

  • GLOBUS_SUCCESS if the handle and its associated fields are valid otherwise an error is returned. So if everything checks out, you get success.

See also

  • globus_gsi_proxy_handle_get_policy() — to get the policy back.

✨ globus_result_t globus_gsi_proxy_handle_set_proxy_cert_info_openssl ✨

globus_result_t globus_gsi_proxy_handle_set_proxy_cert_info_openssl
    (globus_gsi_proxy_handle_t handle, PROXY_CERT_INFO_EXTENSION * pci)

Set Cert Info. Set the proxy cert info extension stored in the GSI Proxy handle. This function sets the proxy cert info extension in the GSI Proxy handle. So you're putting the info in. 📥

Parameters

  • handle — The handle for which to set the proxy cert info extension. The target.
  • pci — The proxy cert info extension to set. The thing you're setting.

Return values

  • GLOBUS_SUCCESS — Success. 🎉
  • GLOBUS_GSI_PROXY_ERROR_WITH_HANDLE — Handle is invalid. Oops.
  • GLOBUS_GSI_PROXY_ERROR_WITH_PROXYCERTINFO — pci pointer is invalid or if the set failed. Big yikes.

🌈 globus_result_t globus_gsi_proxy_handle_set_time_valid 🌈

globus_result_t globus_gsi_proxy_handle_set_time_valid
    (globus_gsi_proxy_handle_t handle, int time_valid)

Set Time Valid. Set the validity time of the proxy. So you're setting when it expires. ⏳

Parameters

  • handle — The proxy handle to set the expiration date for. The one getting the time.
  • time_valid — Desired expiration date of the proxy. An int. When you want it to expire.

Returns

  • GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned GLOBUS_SUCCESS. (Yes, it says that. The original is a little extra, but we keep it exactly. 💅)

💅 globus_result_t globus_gsi_proxy_handle_set_type 💅

globus_result_t globus_gsi_proxy_handle_set_type (globus_gsi_proxy_handle_t
    handle, globus_gsi_cert_utils_cert_type_t type)

Get Proxy Type. (Yes, it says "Get Proxy Type" but it's actually setting. Original is quirky. We'll keep it.) Set the type of proxy that will be generated when using this handle. Note that this will have no effect when generating a proxy from a proxy. In that case the generated proxy will inherit the type of the parent. So if you're making a proxy from a proxy, this setting is ignored, and it takes after the parent. Like mother like daughter. 👩‍👧

Parameters

  • handle — The handle for which to set the type. The one getting the type.
  • type — Parameter used to pass the type. The type you want.

Returns

  • GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned. Standard.

See also

  • globus_gsi_proxy_handle_set_type() — yes, it's referencing itself. Iconic. 💅

Author

Generated automatically by Doxygen for globus_gsi_proxy_core from the source code. So no human wrote this, it's all Doxygen magic. 🤖✨

And that's the tea, bestie! This manual page is from globus_gsi_proxy_core, version 9.9. No cap, that's the version. And the date? Well, the footer didn't show one, so it's giving "timeless". 💖 Stay slay, and don't forget to free your requests! 🫶

📦 where this page comes from