.TH "GSI Authorization API" 3 "Sat Nov 8 2014" "Version 3.10" "globus_authz" \" -*- nroff -*-
.ad l
.nh
.SH NAME
GSI Authorization API \- 
.PP
Authorization Callouts\&.  

.SS "Modules"

.in +1c
.ti -1c
.RI "\fBGSI Credential Constants\fP"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_gsi_authz_handle_init\fP (globus_gsi_authz_handle_t *handle, const char *service_name, const gss_ctx_id_t context, globus_gsi_authz_cb_t callback, void *callback_arg)"
.br
.RI "\fIInitialize an authorization handle\&. \fP"
.ti -1c
.RI "globus_result_t \fBglobus_gsi_authorize\fP (globus_gsi_authz_handle_t handle, const void *action, const void *object, globus_gsi_authz_cb_t callback, void *callback_arg)"
.br
.RI "\fIStart the authorization decision-making process\&. \fP"
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cancel_authz\fP (globus_gsi_authz_handle_t handle)"
.br
.RI "\fICancel Authorization\&. \fP"
.ti -1c
.RI "globus_result_t \fBglobus_gsi_authz_handle_destroy\fP (globus_gsi_authz_handle_t handle, globus_gsi_authz_cb_t callback, void *callback_arg)"
.br
.RI "\fIDestroy an authz handle\&. \fP"
.ti -1c
.RI "globus_result_t \fBglobus_gsi_authz_get_authorization_identity\fP (globus_gsi_authz_handle_t handle, char **identity_ptr, globus_gsi_authz_cb_t callback, void *callback_arg)"
.br
.RI "\fIQuery for authorization identity\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Authorization Callouts\&. 

The GSI Authorization API provides an interface for making generic authorization decisions using dynamically-loaded authorization modules\&. The API documentation is divided into the following sections:
.PP
.IP "\(bu" 2
\fBGSI Authorization API\fP
.IP "\(bu" 2
\fBGSI Credential Constants\fP 
.PP

.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_gsi_authorize (globus_gsi_authz_handle_thandle, const void *action, const void *object, globus_gsi_authz_cb_tcallback, void *callback_arg)"

.PP
Start the authorization decision-making process\&. Processes an authorization decision by calling the GLOBUS_GSI_AUTHORIZE_ASYNC function named in the authorization configuration file\&. The parameters to this function are passed to the authorization callout\&. Once the authorization decision is made, the callback function will be called, with the result and the callback_arg passed to it\&.
.PP
\fBParameters:\fP
.RS 4
\fIhandle\fP Pointer to an authorization handle 
.br
\fIaction\fP Action to authorize 
.br
\fIobject\fP Object that the action pertains to\&. 
.br
\fIcallback\fP Callback function to call when authorization completes 
.br
\fIcallback_arg\fP Argument to callback function
.RE
.PP
\fBReturns:\fP
.RS 4
GLOBUS_SUCCESS if successful, or a Globus error object on failure\&. 
.RE
.PP

.SS "globus_result_t globus_gsi_authz_get_authorization_identity (globus_gsi_authz_handle_thandle, char **identity_ptr, globus_gsi_authz_cb_tcallback, void *callback_arg)"

.PP
Query for authorization identity\&. Query for authorization identity by calling the GLOBUS_GSI_GET_AUTHORIZATION_IDENTITY callout\&. 
.PP
\fBParameters:\fP
.RS 4
\fIhandle\fP The handle that is to be used for the identity check\&. 
.br
\fIidentity_ptr\fP The authorization identity determined by the authorization handle\&. This is must be freed by the caller\&. If the value is NULL (and this function returned GLOBUS_SUCCESS), the caller should use the authenticated identity\&. 
.br
\fIcallback\fP Callback function to call when identity is determined\&. 
.br
\fIcallback_arg\fP Argument to callback function\&.
.RE
.PP
\fBReturns:\fP
.RS 4
GLOBUS_SUCCESS 
.RE
.PP

.SS "globus_result_t globus_gsi_authz_handle_destroy (globus_gsi_authz_handle_thandle, globus_gsi_authz_cb_tcallback, void *callback_arg)"

.PP
Destroy an authz handle\&. Initialize an authorization handle by calling the GLOBUS_GSI_AUTHZ_HANDLE_DESTROY function named in the authorization configuration file\&. Once the initialization is complete, the callback function is called, with the result and the callback_arg passed to it\&. 
.PP
\fBParameters:\fP
.RS 4
\fIhandle\fP The handle that is to be destroyed 
.br
\fIcallback\fP Callback function to call when handle is destroyed 
.br
\fIcallback_arg\fP Argument to callback function 
.RE
.PP
\fBReturns:\fP
.RS 4
GLOBUS_SUCCESS 
.RE
.PP

.SS "globus_result_t globus_gsi_authz_handle_init (globus_gsi_authz_handle_t *handle, const char *service_name, const gss_ctx_id_tcontext, globus_gsi_authz_cb_tcallback, void *callback_arg)"

.PP
Initialize an authorization handle\&. Initialize an authorization handle by calling the GLOBUS_GSI_AUTHZ_HANDLE_INIT function named in the authorization configuration file\&. The parameters to this function are passed to the authorization callout\&. Once the initialization is complete, the callback function is called, with the result and the callback_arg passed to it\&.
.PP
\fBParameters:\fP
.RS 4
\fIhandle\fP Pointer to the handle that is to be initialized 
.br
\fIservice_name\fP Service to authorize access to 
.br
\fIcontext\fP Security context used to contact the service 
.br
\fIcallback\fP Callback function to call when authz handle init completes 
.br
\fIcallback_arg\fP Argument to callback function 
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIThe\fP \fBglobus_gsi_authz_handle_init()\fP function returns GLOBUS_SUCCESS if successful, or a Globus error object on failure 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBglobus_gsi_authz_handle_destroy()\fP 
.RE
.PP

.SS "globus_result_t globus_gsi_cancel_authz (globus_gsi_authz_handle_thandle)"

.PP
Cancel Authorization\&. Cancel an authorization decision by calling the GLOBUS_GSI_AUTHZ_CANCEL function named in the authorization configuration file\&.
.PP
\fBParameters:\fP
.RS 4
\fIhandle\fP The authorization handle to cancel 
.RE
.PP

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