globus_gsi_proxy_handle_set_policy (3)

Create/Destroy/Modify a GSI Proxy Handle.

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

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

typedef struct globus_l_gsi_proxy_handle_s* \fBglobus_gsi_proxy_handle_t\fP

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

globus_result_t globus_gsi_proxy_handle_add_extension (\fBglobus_gsi_proxy_handle_t\fPhandle, 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 (\fBglobus_gsi_proxy_handle_t\fPhandle)

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 (\fBglobus_gsi_proxy_handle_t\fPhandle, 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 (\fBglobus_gsi_proxy_handle_t\fPhandle, 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 (\fBglobus_gsi_proxy_handle_t\fPhandle, 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 (\fBglobus_gsi_proxy_handle_t\fPhandle, 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 (\fBglobus_gsi_proxy_handle_t\fPhandle, void(**)(int, int, void *)callback)

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 (\fBglobus_gsi_proxy_handle_t\fPhandle, 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 (\fBglobus_gsi_proxy_handle_t\fPhandle, 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 (\fBglobus_gsi_proxy_handle_t\fPhandle, 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 (\fBglobus_gsi_proxy_handle_t\fPhandle, EVP_PKEY **proxy_key)

Get/Set Private Key. Get the private key from a GSI Proxy handle.

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.

Returns:

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

See also:

globus_gsi_proxy_handle_set_private_key()

globus_result_t globus_gsi_proxy_handle_get_proxy_cert_info (\fBglobus_gsi_proxy_handle_t\fPhandle, PROXYCERTINFO **pci)

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

This function retrieves the proxy cert info extension from the GSI Proxy handle.

Parameters:

handle The handle from which to get the proxy cert info extension.

pci Contains the proxy cert info extension upon successful return. If the handle does not contain a pci extension, this parameter will be NULL upon return.

Returns:

GLOBUS_SUCCESS upon success GLOBUS_GSI_PROXY_ERROR_WITH_HANDLE if handle is invalid GLOBUS_GSI_PROXY_ERROR_WITH_PROXYCERTINFO if the pci pointer is invalid or if the get failed.

globus_result_t globus_gsi_proxy_handle_get_req (\fBglobus_gsi_proxy_handle_t\fPhandle, X509_REQ **req)

Get Request. Get the certificate request from a GSI Proxy handle.

Parameters:

handle The handle from which to get the certificate request

req Parameter used to return the request. It is the users responsibility to free the returned request.

Returns:

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

See also:

globus_gsi_proxy_handle_set_req()

globus_result_t globus_gsi_proxy_handle_get_signing_algorithm (\fBglobus_gsi_proxy_handle_t\fPhandle, EVP_MD **signing_algorithm)

Get Signing Algorithm. Get the signing algorithm used to sign the proxy cert request

Parameters:

handle The proxy handle containing the type of signing algorithm used

signing_algorithm signing algorithm of the proxy handle

Return values:

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

globus_result_t globus_gsi_proxy_handle_get_time_valid (\fBglobus_gsi_proxy_handle_t\fPhandle, int *time_valid)

Get Time Valid. Get the validity time of the proxy

Parameters:

handle The proxy handle to get the expiration date of

time_valid expiration date of the proxy handle

Returns:

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

globus_result_t globus_gsi_proxy_handle_get_type (\fBglobus_gsi_proxy_handle_t\fPhandle, globus_gsi_cert_utils_cert_type_t *type)

Get Proxy Type. Determine the type of proxy that will be generated when using this handle.

Parameters:

handle The handle from which to get the type

type Parameter used to return the type.

Returns:

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

See also:

globus_gsi_proxy_handle_set_type()

globus_result_t globus_gsi_proxy_handle_init (\fBglobus_gsi_proxy_handle_t\fP *handle, \fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs)

Initialize Handle. 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.

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.

handle_attrs Initial attributes to be used to create this handle.

Returns:

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

See also:

globus_gsi_proxy_handle_destroy()

globus_result_t globus_gsi_proxy_handle_set_extensions (\fBglobus_gsi_proxy_handle_t\fPhandle, 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.

Parameters:

handle The handle for the proxy from which the extension should be set.

exts The extensions to be set. Can be NULL to clear extensions.

Returns:

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

See also:

globus_gsi_proxy_handle_add_extension()

globus_gsi_proxy_handle_get_extensions()

globus_result_t globus_gsi_proxy_handle_set_is_limited (\fBglobus_gsi_proxy_handle_t\fPhandle, globus_bool_tis_limited)

Set/Check Proxy Is Limited. Set the limited proxy flag on the proxy handle

Parameters:

handle the proxy handle

is_limited boolean value to set on the proxy handle

Returns:

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

globus_result_t globus_gsi_proxy_handle_set_pathlen (\fBglobus_gsi_proxy_handle_t\fPhandle, longpathlen)

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.

Parameters:

handle The handle to be modified.

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_get_pathlen()

globus_result_t globus_gsi_proxy_handle_set_policy (\fBglobus_gsi_proxy_handle_t\fPhandle, unsigned char *policy_data, intpolicy_length, intpolicy_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.

Parameters:

handle The handle to be modified.

policy_data The policy data.

policy_length The length of the policy data

policy_language_NID The NID of the policy language.

Returns:

GLOBUS_SUCCESS if the handle and its associated fields are valid otherwise an error is returned

See also:

globus_gsi_proxy_handle_get_policy()

globus_result_t globus_gsi_proxy_handle_set_proxy_cert_info (\fBglobus_gsi_proxy_handle_t\fPhandle, PROXYCERTINFO *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.

Parameters:

handle The handle for which to set the proxy cert info extension.

pci The proxy cert info extension to set.

Return values:

GLOBUS_SUCCESS Success

GLOBUS_GSI_PROXY_ERROR_WITH_HANDLE Handle is invalid

GLOBUS_GSI_PROXY_ERROR_WITH_PROXYCERTINFO pci pointer is invalid or if the set failed.

globus_result_t globus_gsi_proxy_handle_set_time_valid (\fBglobus_gsi_proxy_handle_t\fPhandle, inttime_valid)

Set Time Valid. Set the validity time of the proxy

Parameters:

handle The proxy handle to set the expiration date for

time_valid desired expiration date of the proxy

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_set_type (\fBglobus_gsi_proxy_handle_t\fPhandle, globus_gsi_cert_utils_cert_type_ttype)

Get Proxy Type. 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.

Parameters:

handle The handle for which to set the type

type Parameter used to pass the type.

Returns:

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

See also:

globus_gsi_proxy_handle_set_type()

Generated automatically by Doxygen for globus_gsi_proxy_core from the source code.