Grid Community Toolkit  6.2.1550507116
Typedefs | Functions
Handle Attributes

Handle Attributes. More...

Typedefs

typedef struct globus_l_gsi_proxy_handle_attrs_s * globus_gsi_proxy_handle_attrs_t
 Handle Attributes. More...
 

Functions

globus_result_t globus_gsi_proxy_handle_attrs_init (globus_gsi_proxy_handle_attrs_t *handle_attrs)
 Initialize Attributes. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_destroy (globus_gsi_proxy_handle_attrs_t handle_attrs)
 Destroy attributes. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_set_keybits (globus_gsi_proxy_handle_attrs_t handle_attrs, int bits)
 Set Key Bits. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_get_keybits (globus_gsi_proxy_handle_attrs_t handle_attrs, int *bits)
 Get Key Bits. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_set_init_prime (globus_gsi_proxy_handle_attrs_t handle_attrs, int prime)
 Set Initial Prime Number. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_get_init_prime (globus_gsi_proxy_handle_attrs_t handle_attrs, int *prime)
 Get Initial Prime Number. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_set_signing_algorithm (globus_gsi_proxy_handle_attrs_t handle_attrs, const EVP_MD *algorithm)
 Set Signing Algorithm. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_get_signing_algorithm (globus_gsi_proxy_handle_attrs_t handle_attrs, const EVP_MD **algorithm)
 Get Signing Algorithm. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_set_clock_skew_allowable (globus_gsi_proxy_handle_attrs_t handle_attrs, int skew)
 Set Clock Skew Allowable. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_get_clock_skew_allowable (globus_gsi_proxy_handle_attrs_t handle_attrs, int *skew)
 Get Clock Skew Allowable. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_get_key_gen_callback (globus_gsi_proxy_handle_attrs_t handle_attrs, void(**callback)(int, int, void *))
 Get Key Gen Callback. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_set_key_gen_callback (globus_gsi_proxy_handle_attrs_t handle_attrs, void(*callback)(int, int, void *))
 Set Key Gen Callback. More...
 
globus_result_t globus_gsi_proxy_handle_attrs_copy (globus_gsi_proxy_handle_attrs_t a, globus_gsi_proxy_handle_attrs_t *b)
 Copy Attributes. More...
 

Detailed Description

Handle Attributes.

Handle attributes are used to control additional features of the GSI Proxy handle. These features are operation independent.

Currently there are no attributes.

See also
globus_gsi_proxy_handle_t

Typedef Documentation

◆ globus_gsi_proxy_handle_attrs_t

typedef struct globus_l_gsi_proxy_handle_attrs_s* globus_gsi_proxy_handle_attrs_t

Handle Attributes.

A GSI Proxy handle attributes type is used to associate immutable parameter values with a Handle Management handle. A handle attributes object should be created with immutable parameters and then passed to the proxy handle init function globus_gsi_proxy_handle_init().

See also
Handle Management

Function Documentation

◆ globus_gsi_proxy_handle_attrs_copy()

globus_result_t globus_gsi_proxy_handle_attrs_copy ( globus_gsi_proxy_handle_attrs_t  a,
globus_gsi_proxy_handle_attrs_t b 
)

Copy Attributes.

Make a copy of GSI Proxy handle attributes

Parameters
aThe handle attributes to copy
bThe copy
Returns
GLOBUS_SUCCESS

◆ globus_gsi_proxy_handle_attrs_destroy()

globus_result_t globus_gsi_proxy_handle_attrs_destroy ( globus_gsi_proxy_handle_attrs_t  handle_attrs)

Destroy attributes.

Destroy the GSI Proxy handle attributes

Parameters
handle_attrsThe handle attributes to be destroyed.
Returns
GLOBUS_SUCCESS
See also
globus_gsi_proxy_handle_attrs_init()

◆ globus_gsi_proxy_handle_attrs_get_clock_skew_allowable()

globus_result_t globus_gsi_proxy_handle_attrs_get_clock_skew_allowable ( globus_gsi_proxy_handle_attrs_t  handle_attrs,
int *  skew 
)

Get Clock Skew Allowable.

Get the allowable clock skew for the proxy certificate

Parameters
handle_attrsThe handle_attrs to get the clock skew from
skewThe allowable clock skew (in seconds) to get from the proxy certificate request. This value gets set by the function, so it needs to be a pointer.
Returns
GLOBUS_SUCCESS if the handle_attrs is valid, otherwise an error is returned

◆ globus_gsi_proxy_handle_attrs_get_init_prime()

globus_result_t globus_gsi_proxy_handle_attrs_get_init_prime ( globus_gsi_proxy_handle_attrs_t  handle_attrs,
int *  prime 
)

Get Initial Prime Number.

Get the initial prime number used for generating the public key pair in the RSA algorithm

Parameters
handle_attrsThe attributes to get the initial prime number from
primeThe initial prime number taken from the attributes
Returns
GLOBUS_SUCCESS

◆ globus_gsi_proxy_handle_attrs_get_key_gen_callback()

globus_result_t globus_gsi_proxy_handle_attrs_get_key_gen_callback ( globus_gsi_proxy_handle_attrs_t  handle_attrs,
void(**)(int, int, void *)  callback 
)

Get Key Gen Callback.

Get the public/private key generation callback that provides status during the generation of the keys

Parameters
handle_attrsThe handle_attrs to get the callback from
callbackThe callback from the handle attributes
Returns
GLOBUS_SUCCESS if the handle_attrs is valid, otherwise an error is returned

◆ globus_gsi_proxy_handle_attrs_get_keybits()

globus_result_t globus_gsi_proxy_handle_attrs_get_keybits ( globus_gsi_proxy_handle_attrs_t  handle_attrs,
int *  bits 
)

Get Key Bits.

Gets the length of the public key pair used by the proxy certificate

Parameters
handle_attrsthe attributes to get the key length from
bitsthe length of the key pair in bits
Returns
GLOBUS_SUCCESS

◆ globus_gsi_proxy_handle_attrs_get_signing_algorithm()

globus_result_t globus_gsi_proxy_handle_attrs_get_signing_algorithm ( globus_gsi_proxy_handle_attrs_t  handle_attrs,
const EVP_MD **  algorithm 
)

Get Signing Algorithm.

Gets the Signing Algorithm to used to sign the certificate request. In most cases, the signing party will ignore this value, and sign with an algorithm of its choice.

Parameters
handle_attrsThe proxy handle_attrs to get the signing algorithm of
algorithmParameter used to return the signing algorithm used
Returns
Returns GLOBUS_SUCCESS if the handle is valid, otherwise an error object is returned.

◆ globus_gsi_proxy_handle_attrs_init()

globus_result_t globus_gsi_proxy_handle_attrs_init ( globus_gsi_proxy_handle_attrs_t handle_attrs)

Initialize Attributes.

Initialize GSI Proxy Handle Attributes.

Initialize proxy handle attributes, which can (and should) be associated with a proxy handle. For most purposes, these attributes should primarily be used by the proxy handle.

Currently, no attribute values are initialized.

Parameters
handle_attrsThe handle attributes structure to be initialized
Returns
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned
See also
globus_gsi_proxy_handle_attrs_destroy()

◆ globus_gsi_proxy_handle_attrs_set_clock_skew_allowable()

globus_result_t globus_gsi_proxy_handle_attrs_set_clock_skew_allowable ( globus_gsi_proxy_handle_attrs_t  handle_attrs,
int  skew 
)

Set Clock Skew Allowable.

Sets the clock skew in minutes of the proxy cert request so that time differences between hosts won't cause problems. This value defaults to 5 minutes.

Parameters
handle_attrsthe handle_attrs containing the clock skew to be set
skewthe amount to skew by (in seconds)
Returns
GLOBUS_SUCCESS if the handle_attrs is valid - otherwise an error is returned.

◆ globus_gsi_proxy_handle_attrs_set_init_prime()

globus_result_t globus_gsi_proxy_handle_attrs_set_init_prime ( globus_gsi_proxy_handle_attrs_t  handle_attrs,
int  prime 
)

Set Initial Prime Number.

Set the initial prime number used for generating public key pairs in the RSA algorithm

Parameters
handle_attrsThe attributes to set
primeThe prime number to set it to This value needs to be a prime number
Returns
GLOBUS_SUCCESS

◆ globus_gsi_proxy_handle_attrs_set_key_gen_callback()

globus_result_t globus_gsi_proxy_handle_attrs_set_key_gen_callback ( globus_gsi_proxy_handle_attrs_t  handle_attrs,
void(*)(int, int, void *)  callback 
)

Set Key Gen Callback.

Set the public/private key generation callback that provides status during the generation of the keys

Parameters
handle_attrsThe handle_attrs to get the callback from
callbackThe callback from the handle attributes
Returns
GLOBUS_SUCCESS if the handle_attrs is valid, otherwise an error is returned

◆ globus_gsi_proxy_handle_attrs_set_keybits()

globus_result_t globus_gsi_proxy_handle_attrs_set_keybits ( globus_gsi_proxy_handle_attrs_t  handle_attrs,
int  bits 
)

Set Key Bits.

Set the length of the public key pair used by the proxy certificate

Parameters
handle_attrsthe attributes to set
bitsthe length to set it to (usually 1024)
Returns
GLOBUS_SUCCESS

◆ globus_gsi_proxy_handle_attrs_set_signing_algorithm()

globus_result_t globus_gsi_proxy_handle_attrs_set_signing_algorithm ( globus_gsi_proxy_handle_attrs_t  handle_attrs,
const EVP_MD *  algorithm 
)

Set Signing Algorithm.

Sets the Signing Algorithm to be used to sign the certificate request. In most cases, the signing party will ignore this value, and sign with an algorithm of its choice.

Parameters
handle_attrsThe proxy handle to set the signing algorithm of
algorithmThe signing algorithm to set
Returns
Returns GLOBUS_SUCCESS if the handle is valid, otherwise an error object is returned.