.TH "globus_gsi_proxy.h" 3 "Version 9.8" "globus_gsi_proxy_core" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gsi_proxy.h \- Globus GSI Proxy API\&.  

.SH SYNOPSIS
.br
.PP
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_GSI_PROXY_MODULE\fP"
.br
.RI "Module descriptor\&. "
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef struct globus_l_gsi_proxy_handle_s * \fBglobus_gsi_proxy_handle_t\fP"
.br
.RI "GSI Proxy Handle\&. "
.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_init\fP (\fBglobus_gsi_proxy_handle_t\fP *handle, \fBglobus_gsi_proxy_handle_attrs_t\fP handle_attrs)"
.br
.RI "Initialize a GSI Proxy handle\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_destroy\fP (\fBglobus_gsi_proxy_handle_t\fP handle)"
.br
.RI "Destroy a GSI Proxy handle\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_req\fP (\fBglobus_gsi_proxy_handle_t\fP handle, X509_REQ **req)"
.br
.RI "Get the certificate request from a GSI Proxy handle\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_set_req\fP (\fBglobus_gsi_proxy_handle_t\fP handle, X509_REQ *req)"
.br
.RI "Set Request Set the certificate request in a GSI Proxy handle\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_private_key\fP (\fBglobus_gsi_proxy_handle_t\fP handle, EVP_PKEY **proxy_key)"
.br
.RI "Get the private key from a GSI Proxy handle\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_set_private_key\fP (\fBglobus_gsi_proxy_handle_t\fP handle, const EVP_PKEY *proxy_key)"
.br
.RI "Set the private key in a GSI Proxy handle\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_type\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cert_utils_cert_type_t *type)"
.br
.RI "Get Proxy Type\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_set_type\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cert_utils_cert_type_t type)"
.br
.RI "Get Proxy Type\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_time_valid\fP (\fBglobus_gsi_proxy_handle_t\fP handle, int *time_valid)"
.br
.RI "Get Time Valid\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_set_time_valid\fP (\fBglobus_gsi_proxy_handle_t\fP handle, int time_valid)"
.br
.RI "Set Time Valid\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_set_policy\fP (\fBglobus_gsi_proxy_handle_t\fP handle, const unsigned char *policy_data, int policy_length, int policy_NID)"
.br
.RI "Set Policy\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_policy\fP (\fBglobus_gsi_proxy_handle_t\fP handle, unsigned char **policy_data, int *policy_length, int *policy_NID)"
.br
.RI "Get Policy\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_add_extension\fP (\fBglobus_gsi_proxy_handle_t\fP handle, X509_EXTENSION *extension)"
.br
.RI "Add X\&.509 Extensions\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_set_extensions\fP (\fBglobus_gsi_proxy_handle_t\fP handle, STACK_OF(X509_EXTENSION) *extensions)"
.br
.RI "Set X\&.509 Extensions\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_extensions\fP (\fBglobus_gsi_proxy_handle_t\fP handle, STACK_OF(X509_EXTENSION) **extension)"
.br
.RI "Get X\&.509 Extensions\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_set_pathlen\fP (\fBglobus_gsi_proxy_handle_t\fP handle, long pathlen)"
.br
.RI "Set Path Length\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_pathlen\fP (\fBglobus_gsi_proxy_handle_t\fP handle, int *pathlen)"
.br
.RI "Get Path Length\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_clear_cert_info\fP (\fBglobus_gsi_proxy_handle_t\fP handle)"
.br
.RI "Clear Cert Info\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_common_name\fP (\fBglobus_gsi_proxy_handle_t\fP handle, char **common_name)"
.br
.RI "Get/Set Proxy Common Name\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_set_common_name\fP (\fBglobus_gsi_proxy_handle_t\fP handle, const char *common_name)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_is_limited\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_bool_t *is_limited)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_set_is_limited\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_bool_t is_limited)"
.br
.RI "Set/Check Proxy Is Limited\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_signing_algorithm\fP (\fBglobus_gsi_proxy_handle_t\fP handle, const EVP_MD **algorithm)"
.br
.RI "Get Signing Algorithm\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_keybits\fP (\fBglobus_gsi_proxy_handle_t\fP handle, int *key_bits)"
.br
.RI "Get Key Bits\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_init_prime\fP (\fBglobus_gsi_proxy_handle_t\fP handle, int *init_prime)"
.br
.RI "Get Init Prime\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_clock_skew_allowable\fP (\fBglobus_gsi_proxy_handle_t\fP handle, int *skew)"
.br
.RI "Get Clock Skew <> "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_handle_get_key_gen_callback\fP (\fBglobus_gsi_proxy_handle_t\fP handle, void(**callback)(int, int, void *))"
.br
.RI "Get Callback for Creating Keys\&. "
.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_copy\fP (\fBglobus_gsi_proxy_handle_attrs_t\fP a, \fBglobus_gsi_proxy_handle_attrs_t\fP *b)"
.br
.RI "Copy Attributes\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_create_req\fP (\fBglobus_gsi_proxy_handle_t\fP handle, BIO *output_bio)"
.br
.RI "Create a proxy credential request\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_inquire_req\fP (\fBglobus_gsi_proxy_handle_t\fP handle, BIO *input_bio)"
.br
.RI "Inquire a proxy credential request\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_sign_req\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t issuer_credential, BIO *output_bio)"
.br
.RI "Sign a proxy certificate request\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_resign_cert\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t issuer_credential, globus_gsi_cred_handle_t peer_credential, globus_gsi_cred_handle_t *resigned_credential)"
.br
.RI "Resign an existing certificate into a proxy\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_assemble_cred\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t *proxy_credential, BIO *input_bio)"
.br
.RI "Assemble a proxy credential\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_create_signed\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t issuer, globus_gsi_cred_handle_t *proxy_credential)"
.br
.RI "Create Signed Proxy Certificate\&. "
.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, 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, 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, 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, void(*callback)(int, int, void *))"
.br
.RI "Set Key Gen Callback\&. "
.in -1c
.SH "Detailed Description"
.PP 
Globus GSI Proxy API\&. 


.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_gsi_proxy_handle_destroy (\fBglobus_gsi_proxy_handle_t\fP handle)"

.PP
Destroy a GSI Proxy handle\&. Free the memory used by a GSI proxy handle\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP The handle to be destroyed\&. 
.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_init()\fP 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_set_common_name (\fBglobus_gsi_proxy_handle_t\fP handle, const char * common_name)"
Set the proxy common name stored in the GSI Proxy handle\&.
.PP
This function sets the proxy common name in the GSI Proxy handle\&. Note that the common name is only used for draft compliant proxies\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP The handle for which to set the proxy common name\&. 
.br
\fIcommon_name\fP The proxy common name to set\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS upon success GLOBUS_GSI_PROXY_ERROR_WITH_HANDLE if handle is invalid 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_set_private_key (\fBglobus_gsi_proxy_handle_t\fP handle, const EVP_PKEY * proxy_key)"

.PP
Set the private key in a GSI Proxy handle\&. Copies the private key pointed to by proxy_key to the handle\&. 
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP The handle for which to set the private key 
.br
\fIproxy_key\fP Parameter used to pass the key 
.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_get_private_key()\fP 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_handle_set_req (\fBglobus_gsi_proxy_handle_t\fP handle, X509_REQ * req)"

.PP
Set Request Set the certificate request in a GSI Proxy handle\&. 
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP The handle for which to set the certificate request 
.br
\fIreq\fP Request to be copied to handle\&. 
.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_get_req()\fP 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_is_limited (\fBglobus_gsi_proxy_handle_t\fP handle, globus_bool_t * is_limited)"
Check to see the proxy is a limited proxy
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP the proxy handle to check 
.br
\fIis_limited\fP boolean value to set depending on the type of proxy
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

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