.TH "globus_gsi_callback_data" 3 "Tue Dec 15 2020" "Version 6.2" "globus_gsi_callback" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gsi_callback_data \- Callback Data Functions
.PP
 \- Callback Data Functions\&.  

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

.in +1c
.ti -1c
.RI "typedef struct globus_l_gsi_callback_data_s * \fBglobus_gsi_callback_data_t\fP"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_data_init\fP (\fBglobus_gsi_callback_data_t\fP *callback_data)"
.br
.RI "Initialize a callback data structure\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_data_destroy\fP (\fBglobus_gsi_callback_data_t\fP callback_data)"
.br
.RI "Initialize a callback data structure\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_data_copy\fP (\fBglobus_gsi_callback_data_t\fP source, \fBglobus_gsi_callback_data_t\fP *dest)"
.br
.RI "Copy a callback data structure\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_get_cert_depth\fP (\fBglobus_gsi_callback_data_t\fP callback_data, int *cert_depth)"
.br
.RI "Getting the certificate chain depth\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_set_cert_depth\fP (\fBglobus_gsi_callback_data_t\fP callback_data, int cert_depth)"
.br
.RI "Set the certificate chain depth\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_get_proxy_depth\fP (\fBglobus_gsi_callback_data_t\fP callback_data, int *proxy_depth)"
.br
.RI "Get the 'proxy chain' depth\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_set_proxy_depth\fP (\fBglobus_gsi_callback_data_t\fP callback_data, int proxy_depth)"
.br
.RI "Set the 'proxy chain' depth\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_get_cert_type\fP (\fBglobus_gsi_callback_data_t\fP callback_data, globus_gsi_cert_utils_cert_type_t *cert_type)"
.br
.RI "Get the certificate type\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_set_cert_type\fP (\fBglobus_gsi_callback_data_t\fP callback_data, globus_gsi_cert_utils_cert_type_t cert_type)"
.br
.RI "Set the certificate type\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_get_cert_chain\fP (\fBglobus_gsi_callback_data_t\fP callback_data, STACK_OF(X509) **cert_chain)"
.br
.RI "Get the certificate chain\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_set_cert_chain\fP (\fBglobus_gsi_callback_data_t\fP callback_data, STACK_OF(X509) *cert_chain)"
.br
.RI "Set the certificate chain\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_get_multiple_limited_proxy_ok\fP (\fBglobus_gsi_callback_data_t\fP callback_data, int *multiple_limited_proxy_ok)"
.br
.RI "Get the limited proxy handling setting\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_set_multiple_limited_proxy_ok\fP (\fBglobus_gsi_callback_data_t\fP callback_data, int multiple_limited_proxy_ok)"
.br
.RI "Set the limited proxy handling setting\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_get_extension_oids\fP (\fBglobus_gsi_callback_data_t\fP callback_data, void **extension_oids)"
.br
.RI "Get X\&.509 extension OIDs\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_set_extension_oids\fP (\fBglobus_gsi_callback_data_t\fP callback_data, void *extension_oids)"
.br
.RI "Set X\&.509 extension OIDs\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_get_cert_dir\fP (\fBglobus_gsi_callback_data_t\fP callback_data, char **cert_dir)"
.br
.RI "Get the trusted certificate directory\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_set_cert_dir\fP (\fBglobus_gsi_callback_data_t\fP callback_data, char *cert_dir)"
.br
.RI "Set the trusted certificate directory\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_get_extension_cb\fP (\fBglobus_gsi_callback_data_t\fP callback_data, \fBglobus_gsi_extension_callback_t\fP *extension_cb)"
.br
.RI "Get the unknown X\&.509 extension callback\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_set_extension_cb\fP (\fBglobus_gsi_callback_data_t\fP callback_data, \fBglobus_gsi_extension_callback_t\fP extension_cb)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_get_error\fP (\fBglobus_gsi_callback_data_t\fP callback_data, globus_result_t *error)"
.br
.RI "Get error status\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_set_error\fP (\fBglobus_gsi_callback_data_t\fP callback_data, globus_result_t error)"
.br
.RI "Set error status\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_get_check_policy_for_self_signed_certs\fP (\fBglobus_gsi_callback_data_t\fP callback_data, globus_bool_t *check)"
.br
.RI "Get the self-signed policy checking flag\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_set_check_policy_for_self_signed_certs\fP (\fBglobus_gsi_callback_data_t\fP callback_data, globus_bool_t check)"
.br
.RI "Set the self-signed policy checking flag\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_get_allow_missing_signing_policy\fP (\fBglobus_gsi_callback_data_t\fP callback_data, globus_bool_t *allow)"
.br
.RI "Get the 'allow missing signing policy' flag\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_callback_set_allow_missing_signing_policy\fP (\fBglobus_gsi_callback_data_t\fP callback_data, globus_bool_t allow)"
.br
.RI "Set the 'allow missing signing policy' flag\&. "
.in -1c
.SH "Detailed Description"
.PP 
Callback Data Functions\&. 

Functions that deal with the data structure that contains state associated with the path validation callback\&. 
.SH "Typedef Documentation"
.PP 
.SS "typedef struct globus_l_gsi_callback_data_s* \fBglobus_gsi_callback_data_t\fP"
Callback data typedef 
.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_gsi_callback_data_copy (\fBglobus_gsi_callback_data_t\fP source, \fBglobus_gsi_callback_data_t\fP * dest)"

.PP
Copy a callback data structure\&. This function copies a globus_gsi_callback_data_t\&.
.PP
\fBParameters\fP
.RS 4
\fIsource\fP The structure to be copied 
.br
\fIdest\fP The destination of the copy
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_data_destroy (\fBglobus_gsi_callback_data_t\fP callback_data)"

.PP
Initialize a callback data structure\&. This function destroys a globus_gsi_callback_data_t\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The structure 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

.SS "globus_result_t globus_gsi_callback_data_init (\fBglobus_gsi_callback_data_t\fP * callback_data)"

.PP
Initialize a callback data structure\&. This function initializes a globus_gsi_callback_data_t\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP Reference to the 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

.SS "globus_result_t globus_gsi_callback_get_allow_missing_signing_policy (\fBglobus_gsi_callback_data_t\fP callback_data, globus_bool_t * allow)"

.PP
Get the 'allow missing signing policy' flag\&. This function gets the value of the 'allow missing signing policy' flag in the callback data\&. If this is TRUE then the CA signing policy need not be present\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to get the error from 
.br
\fIallow\fP Contains the value of the flag upon successful return\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP
\fBSince\fP
.RS 4
Globus Toolkit 5\&.2\&.0 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_get_cert_chain (\fBglobus_gsi_callback_data_t\fP callback_data, STACK_OF(X509) ** cert_chain)"

.PP
Get the certificate chain\&. This function returns the certificate chain associated with the callback data\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to retrieve the certificate chain from\&. 
.br
\fIcert_chain\fP Contains the certificate chain upon successful return 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_get_cert_depth (\fBglobus_gsi_callback_data_t\fP callback_data, int * cert_depth)"

.PP
Getting the certificate chain depth\&. This function returns the certificate chain depth\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to retrieve the depth from 
.br
\fIcert_depth\fP The returned certificate chain depth
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_get_cert_dir (\fBglobus_gsi_callback_data_t\fP callback_data, char ** cert_dir)"

.PP
Get the trusted certificate directory\&. This function gets the trusted certificate directory from the callback data\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to get the trusted certificates directory from\&. 
.br
\fIcert_dir\fP Contains the path to the trusted certificate directory upon successful return\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_get_cert_type (\fBglobus_gsi_callback_data_t\fP callback_data, globus_gsi_cert_utils_cert_type_t * cert_type)"

.PP
Get the certificate type\&. This function returns the certificate type of the certificate currently being processed
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to retrieve the certificate type from 
.br
\fIcert_type\fP Variable containing the certificate type on return
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_get_check_policy_for_self_signed_certs (\fBglobus_gsi_callback_data_t\fP callback_data, globus_bool_t * check)"

.PP
Get the self-signed policy checking flag\&. This function gets the value of the 'check policy for self-signed
certificates flag' in the callback data\&. If this is set than the CA signing policy for a self-signed certificate must include a policy line that allows it to sign itself\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to get the error from 
.br
\fIcheck\fP Contains the value of the flag upon successful return\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP
\fBSince\fP
.RS 4
Globus Toolkit 4\&.2\&.1 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_get_error (\fBglobus_gsi_callback_data_t\fP callback_data, globus_result_t * error)"

.PP
Get error status\&. This function gets the error status stored in the callback data\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to get the error from 
.br
\fIerror\fP Contains the error upon successful return\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_get_extension_cb (\fBglobus_gsi_callback_data_t\fP callback_data, \fBglobus_gsi_extension_callback_t\fP * extension_cb)"

.PP
Get the unknown X\&.509 extension callback\&. This function gets the callback that is called for unknown X\&.509 extensions
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to get the callback information from 
.br
\fIextension_cb\fP Contains the extension callback upon successful return\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_get_extension_oids (\fBglobus_gsi_callback_data_t\fP callback_data, void ** extension_oids)"

.PP
Get X\&.509 extension OIDs\&. This function gets a list of X\&.509 extension OIDs that may be used by the extensions callback to allow or disallow certain extensions\&. 
.br
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to get the array of extension OIDs from\&. 
.br
\fIextension_oids\fP Contains the list of extension OIDs upon successful return\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_get_multiple_limited_proxy_ok (\fBglobus_gsi_callback_data_t\fP callback_data, int * multiple_limited_proxy_ok)"

.PP
Get the limited proxy handling setting\&. This function gets the value of the limited proxy handling setting\&. This setting determines whether path validation will accept limited proxies that have been further delegated, i\&.e\&. certificate chains with a limited proxy followed by further proxies\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to get the limited proxy setting from 
.br
\fImultiple_limited_proxy_ok\fP Contains the value of the setting upon successful return\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_get_proxy_depth (\fBglobus_gsi_callback_data_t\fP callback_data, int * proxy_depth)"

.PP
Get the 'proxy chain' depth\&. This function returns the number of proxies in the certificate chain\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to retrieve the depth from 
.br
\fIproxy_depth\fP The returned 'proxy chain' depth
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_set_allow_missing_signing_policy (\fBglobus_gsi_callback_data_t\fP callback_data, globus_bool_t allow)"

.PP
Set the 'allow missing signing policy' flag\&. This function sets the value of the 'allow missing signing policy' flag in the callback data\&. If this is TRUE then the CA signing policy need not be present\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to set the error on 
.br
\fIallow\fP New value of the flag 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP
\fBSince\fP
.RS 4
Globus Toolkit 5\&.2\&.0 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_set_cert_chain (\fBglobus_gsi_callback_data_t\fP callback_data, STACK_OF(X509) * cert_chain)"

.PP
Set the certificate chain\&. This function sets the certificate chain associated with the callback data\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to set the certificate chain on 
.br
\fIcert_chain\fP The certificate chain 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_set_cert_depth (\fBglobus_gsi_callback_data_t\fP callback_data, int cert_depth)"

.PP
Set the certificate chain depth\&. This function sets the certificate chain depth
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to retrieve the depth from 
.br
\fIcert_depth\fP The certificate chain depth
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_set_cert_dir (\fBglobus_gsi_callback_data_t\fP callback_data, char * cert_dir)"

.PP
Set the trusted certificate directory\&. This function sets the trusted certificate directory on the callback data\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to set the trusted certificates directory on\&. 
.br
\fIcert_dir\fP The path to the trusted certificate directory
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_set_cert_type (\fBglobus_gsi_callback_data_t\fP callback_data, globus_gsi_cert_utils_cert_type_t cert_type)"

.PP
Set the certificate type\&. This function sets the certificate type of the certificate currently being processed
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to set the certificate type on
.br
\fIcert_type\fP The certificate type 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_set_check_policy_for_self_signed_certs (\fBglobus_gsi_callback_data_t\fP callback_data, globus_bool_t check)"

.PP
Set the self-signed policy checking flag\&. This function sets the value of the 'check policy for self-signed
certificates flag' in the callback data\&. If this is set than the CA signing policy for a self-signed certificate must include a policy line that allows it to sign itself\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to set the error on 
.br
\fIcheck\fP New value of the flag 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP
\fBSince\fP
.RS 4
Globus Toolkit 4\&.2\&.1 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_set_error (\fBglobus_gsi_callback_data_t\fP callback_data, globus_result_t error)"

.PP
Set error status\&. This function sets the error status stored in the callback data\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to set the error on 
.br
\fIerror\fP The error 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_set_extension_cb (\fBglobus_gsi_callback_data_t\fP callback_data, \fBglobus_gsi_extension_callback_t\fP extension_cb)"
Set the unknown X\&.509 extension callback
.PP
This function sets the callback that is called for unknown X\&.509 extensions\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to set the callback information on 
.br
\fIextension_cb\fP The extension callback 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_set_extension_oids (\fBglobus_gsi_callback_data_t\fP callback_data, void * extension_oids)"

.PP
Set X\&.509 extension OIDs\&. This function sets a list of X\&.509 extension OIDs that may be used by the extensions callback to allow or disallow certain extensions\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to get the array of extension OIDs from\&. 
.br
\fIextension_oids\fP The list of extension OIDs 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_set_multiple_limited_proxy_ok (\fBglobus_gsi_callback_data_t\fP callback_data, int multiple_limited_proxy_ok)"

.PP
Set the limited proxy handling setting\&. This function sets the value of the limited proxy handling setting\&. This setting determines whether path validation will accept limited proxies that have been further delegated, i\&.e\&. certificate chains with a limited proxy followed by further proxies\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to set the limited proxy setting on 
.br
\fImultiple_limited_proxy_ok\fP The value of the setting 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_callback_set_proxy_depth (\fBglobus_gsi_callback_data_t\fP callback_data, int proxy_depth)"

.PP
Set the 'proxy chain' depth\&. This function sets the number of proxies in the certificate chain\&.
.PP
\fBParameters\fP
.RS 4
\fIcallback_data\fP The globus_gsi_callback_data_t to retrieve the depth from 
.br
\fIproxy_depth\fP The 'proxy chain' depth
.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_callback from the source code\&.