.TH "Handle Attributes" 3 "Mon Apr 30 2012" "Version 6.2" "globus gsi proxy core" \" -*- nroff -*- .ad l .nh .SH NAME Handle Attributes \- .SS "Typedefs" .in +1c .ti -1c .RI "typedef struct .br globus_l_gsi_proxy_handle_attrs_s * \fBglobus_gsi_proxy_handle_attrs_t\fP" .br .in -1c .SS "Initialize & Destroy" .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 .ti -1c .RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_destroy\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs)" .br .in -1c .SS "Get/Set Key Bits" .in +1c .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 .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 .in -1c .SS "Get/Set Initial Prime Number" .in +1c .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 .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 .in -1c .SS "Get/Set Signing Algorithm" .in +1c .ti -1c .RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_set_signing_algorithm\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, EVP_MD *algorithm)" .br .ti -1c .RI "globus_result_t \fBglobus_gsi_proxy_handle_attrs_get_signing_algorithm\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs, EVP_MD **algorithm)" .br .in -1c .SS "Get/Set Clock Skew Allowable" .in +1c .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 .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 .in -1c .SS "Get/Set Key Gen Callback" .in +1c .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 .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 .in -1c .SS "Copy Attributes" .in +1c .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 .in -1c .SH "Detailed Description" .PP 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 \fBglobus_gsi_proxy_handle_attrs_init\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP *handle_attrs)" .PP 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\&. .PP Currently, no attibute 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 \fBglobus_gsi_proxy_handle_attrs_set_keybits\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs, intbits)" .PP Set the length of the public key pair used by the proxy certificate\&. \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 \fBglobus_gsi_proxy_handle_attrs_set_init_prime\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs, intprime)" .PP Set the initial prime number used for generating public key pairs in the RSA algorithm\&. \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 \fBglobus_gsi_proxy_handle_attrs_set_signing_algorithm\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs, EVP_MD *algorithm)" .PP 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 .SS "globus_result_t \fBglobus_gsi_proxy_handle_attrs_set_clock_skew_allowable\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs, intskew)" .PP 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 \fBglobus_gsi_proxy_handle_attrs_get_key_gen_callback\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs, void(**)(int, int, void *)callback)" .PP Get the public/private key generation callback that provides status during the generation of the keys\&. \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 \fBglobus_gsi_proxy_handle_attrs_copy\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPa, \fBglobus_gsi_proxy_handle_attrs_t\fP *b)" .PP Make a copy of GSI Proxy handle attributes\&. \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 \fBglobus_gsi_proxy_handle_attrs_destroy\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs)" .PP Destroy the GSI Proxy handle attributes\&. \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 \fBglobus_gsi_proxy_handle_attrs_get_keybits\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs, int *bits)" .PP Gets the length of the public key pair used by the proxy certificate\&. \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 \fBglobus_gsi_proxy_handle_attrs_get_init_prime\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs, int *prime)" .PP Get the initial prime number used for generating the public key pair in the RSA algorithm\&. \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 \fBglobus_gsi_proxy_handle_attrs_get_signing_algorithm\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs, EVP_MD **algorithm)" .PP 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 \fBglobus_gsi_proxy_handle_attrs_get_clock_skew_allowable\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs, int *skew)" .PP Get the allowable clock skew for the proxy certificate\&. \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 \fBglobus_gsi_proxy_handle_attrs_set_key_gen_callback\fP (\fBglobus_gsi_proxy_handle_attrs_t\fPhandle_attrs, void(*)(int, int, void *)callback)" .PP Set the public/private key generation callback that provides status during the generation of the keys\&. \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 .SH "Author" .PP Generated automatically by Doxygen for globus gsi proxy core from the source code\&.