.TH "globus_gsi_proxy_handle_attrs" 3 "Tue Jul 5 2022" "Version 9.8" "globus_gsi_proxy_core" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gsi_proxy_handle_attrs \- Handle Attributes
.PP
 \- Handle Attributes\&.  

.SH SYNOPSIS
.br
.PP
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef struct globus_l_gsi_proxy_handle_attrs_s * \fBglobus_gsi_proxy_handle_attrs_t\fP"
.br
.RI "Handle Attributes\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_init\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP *handle_attrs)"
.br
.RI "Initialize Attributes\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_destroy\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs)"
.br
.RI "Destroy attributes\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_set_keybits\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int bits)"
.br
.RI "Set Key Bits\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_get_keybits\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int *bits)"
.br
.RI "Get Key Bits\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_set_init_prime\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int prime)"
.br
.RI "Set Initial Prime Number\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_get_init_prime\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int *prime)"
.br
.RI "Get Initial Prime Number\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_set_signing_algorithm\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, const EVP_MD *algorithm)"
.br
.RI "Set Signing Algorithm\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_get_signing_algorithm\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, const EVP_MD **algorithm)"
.br
.RI "Get Signing Algorithm\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_set_clock_skew_allowable\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int skew)"
.br
.RI "Set Clock Skew Allowable\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_get_clock_skew_allowable\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int *skew)"
.br
.RI "Get Clock Skew Allowable\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_get_key_gen_callback\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, void(**callback)(int, int, void *))"
.br
.RI "Get Key Gen Callback\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_set_key_gen_callback\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, void(*callback)(int, int, void *))"
.br
.RI "Set Key Gen Callback\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_copy\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP a, \fBglobus_gsi_proxy_handle_attrs_t\fP *b)"
.br
.RI "Copy Attributes\&. "
.in -1c
.SH "Detailed Description"
.PP 
Handle Attributes\&. 

Handle attributes are used to control additional features of the GSI Proxy handle\&. These features are operation independent\&.
.PP
Currently there are no attributes\&.
.PP
\fBSee also\fP
.RS 4
\fBglobus_gsi_proxy_handle_t\fP 
.RE
.PP

.SH "Typedef Documentation"
.PP 
.SS "typedef struct globus_l_gsi_proxy_handle_attrs_s* \fBglobus_gsi_proxy_handle_attrs_t\fP"

.PP
Handle Attributes\&. A GSI Proxy handle attributes type is used to associate immutable parameter values with a \fBHandle Management\fP handle\&. A handle attributes object should be created with immutable parameters and then passed to the proxy handle init function \fBglobus_gsi_proxy_handle_init()\fP\&.
.PP
\fBSee also\fP
.RS 4
\fBHandle Management\fP 
.RE
.PP

.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_gsi_proxy_handle_attrs_copy (\fBglobus_gsi_proxy_handle_attrs_t\fP a, \fBglobus_gsi_proxy_handle_attrs_t\fP * b)"

.PP
Copy Attributes\&. Make a copy of GSI Proxy handle attributes
.PP
\fBParameters\fP
.RS 4
\fIa\fP The handle attributes to copy 
.br
\fIb\fP The copy 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_destroy (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs)"

.PP
Destroy attributes\&. Destroy the GSI Proxy handle attributes
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The handle attributes to be destroyed\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_gsi_proxy_handle_attrs_init()\fP 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_get_clock_skew_allowable (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int * skew)"

.PP
Get Clock Skew Allowable\&. Get the allowable clock skew for the proxy certificate
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The handle_attrs to get the clock skew from 
.br
\fIskew\fP The 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\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS if the handle_attrs is valid, otherwise an error is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_get_init_prime (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int * prime)"

.PP
Get Initial Prime Number\&. Get the initial prime number used for generating the public key pair in the RSA algorithm
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The attributes to get the initial prime number from 
.br
\fIprime\fP The initial prime number taken from the attributes 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_get_key_gen_callback (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, void(**)(int, int, void *) callback)"

.PP
Get Key Gen Callback\&. Get the public/private key generation callback that provides status during the generation of the keys
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The handle_attrs to get the callback from 
.br
\fIcallback\fP The callback from the handle attributes
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS if the handle_attrs is valid, otherwise an error is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_get_keybits (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int * bits)"

.PP
Get Key Bits\&. Gets the length of the public key pair used by the proxy certificate
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP the attributes to get the key length from 
.br
\fIbits\fP the length of the key pair in bits 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_get_signing_algorithm (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, const EVP_MD ** algorithm)"

.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The proxy handle_attrs to get the signing algorithm of 
.br
\fIalgorithm\fP Parameter used to return the signing algorithm used 
.RE
.PP
\fBReturns\fP
.RS 4
Returns GLOBUS_SUCCESS if the handle is valid, otherwise an error object is returned\&. 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_init (\fBglobus_gsi_proxy_handle_attrs_t\fP * handle_attrs)"

.PP
Initialize Attributes\&. Initialize GSI Proxy Handle Attributes\&.
.PP
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\&.
.PP
Currently, no attribute values are initialized\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The handle attributes structure to be initialized 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_gsi_proxy_handle_attrs_destroy()\fP 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_set_clock_skew_allowable (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int skew)"

.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP the handle_attrs containing the clock skew to be set 
.br
\fIskew\fP the amount to skew by (in seconds) 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS if the handle_attrs is valid - otherwise an error is returned\&. 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_set_init_prime (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int prime)"

.PP
Set Initial Prime Number\&. Set the initial prime number used for generating public key pairs in the RSA algorithm
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The attributes to set 
.br
\fIprime\fP The prime number to set it to This value needs to be a prime number 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_set_key_gen_callback (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, void(*)(int, int, void *) callback)"

.PP
Set Key Gen Callback\&. Set the public/private key generation callback that provides status during the generation of the keys
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The handle_attrs to get the callback from 
.br
\fIcallback\fP The callback from the handle attributes
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS if the handle_attrs is valid, otherwise an error is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_set_keybits (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, int bits)"

.PP
Set Key Bits\&. Set the length of the public key pair used by the proxy certificate
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP the attributes to set 
.br
\fIbits\fP the length to set it to (usually 1024)
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_attrs_set_signing_algorithm (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, const EVP_MD * algorithm)"

.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The proxy handle to set the signing algorithm of 
.br
\fIalgorithm\fP The signing algorithm to set 
.RE
.PP
\fBReturns\fP
.RS 4
Returns GLOBUS_SUCCESS if the handle is valid, otherwise an error object is returned\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus_gsi_proxy_core from the source code\&.