<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<!-- THIS FILE IS AUTOMATICALLY GENERATED FROM THE GLOBUS SOURCE CODE
DO NOT MODIFY.
-->
<title>Globus Reference Manual</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__globus__gsi__authz.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">GSI Authorization API</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Initialize Handle</h2></td></tr>
<tr class="memitem:ga83fe87061ed6b5be8ff06e0083193e70"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gsi__authz.html#ga83fe87061ed6b5be8ff06e0083193e70">globus_gsi_authz_handle_init</a> (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)</td></tr>
<tr class="separator:ga83fe87061ed6b5be8ff06e0083193e70"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Authorization decision made here</h2></td></tr>
<tr class="memitem:gab32805412b43dfbd70be366a166ec85f"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gsi__authz.html#gab32805412b43dfbd70be366a166ec85f">globus_gsi_authorize</a> (globus_gsi_authz_handle_t handle, const void *action, const void *object, globus_gsi_authz_cb_t callback, void *callback_arg)</td></tr>
<tr class="separator:gab32805412b43dfbd70be366a166ec85f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Destroy Handle</h2></td></tr>
<tr class="memitem:ga4800365eee7b9f4ece1410613ac2ded5"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gsi__authz.html#ga4800365eee7b9f4ece1410613ac2ded5">globus_gsi_authz_handle_destroy</a> (globus_gsi_authz_handle_t handle, globus_gsi_authz_cb_t callback, void *callback_arg)</td></tr>
<tr class="separator:ga4800365eee7b9f4ece1410613ac2ded5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Query for authorization identity</h2></td></tr>
<tr class="memitem:gafb49107db04bdd666401ee501dfca900"><td class="memItemLeft" align="right" valign="top">globus_result_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gsi__authz.html#gafb49107db04bdd666401ee501dfca900">globus_gsi_authz_get_authorization_identity</a> (globus_gsi_authz_handle_t handle, char **identity_ptr, globus_gsi_authz_cb_t callback, void *callback_arg)</td></tr>
<tr class="separator:gafb49107db04bdd666401ee501dfca900"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga83fe87061ed6b5be8ff06e0083193e70"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gsi_authz_handle_init </td>
<td>(</td>
<td class="paramtype">globus_gsi_authz_handle_t * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>service_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gss_ctx_id_t </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_gsi_authz_cb_t </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>callback_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes a handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Pointer to the handle that is to be initialized </td></tr>
<tr><td class="paramname">service_name</td><td>Service to authorize access to </td></tr>
<tr><td class="paramname">context</td><td>Security context used to contact the service </td></tr>
<tr><td class="paramname">callback</td><td>Callback function to call when authz handle init completes </td></tr>
<tr><td class="paramname">callback_arg</td><td>Argument to callback function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>GLOBUS_SUCCESS if successful A Globus error object on failure: </dd></dl>
</div>
</div>
<a class="anchor" id="gab32805412b43dfbd70be366a166ec85f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gsi_authorize </td>
<td>(</td>
<td class="paramtype">globus_gsi_authz_handle_t </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>action</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_gsi_authz_cb_t </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>callback_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Authorization decision made here. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Pointer to the handle that is to be initialized </td></tr>
<tr><td class="paramname">action</td><td>Action to authorize </td></tr>
<tr><td class="paramname">object</td><td>Object that the action pertains to. </td></tr>
<tr><td class="paramname">callback</td><td>Callback function to call when authorization completes </td></tr>
<tr><td class="paramname">callback_arg</td><td>Argument to callback function</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>GLOBUS_SUCCESS if successful A Globus error object on failure: </dd></dl>
</div>
</div>
<a class="anchor" id="ga4800365eee7b9f4ece1410613ac2ded5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gsi_authz_handle_destroy </td>
<td>(</td>
<td class="paramtype">globus_gsi_authz_handle_t </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_gsi_authz_cb_t </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>callback_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a Globus GSI authz handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle that is to be destroyed </td></tr>
<tr><td class="paramname">callback</td><td>Callback function to call when handle is destroyed </td></tr>
<tr><td class="paramname">callback_arg</td><td>Argument to callback function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>GLOBUS_SUCCESS </dd></dl>
</div>
</div>
<a class="anchor" id="gafb49107db04bdd666401ee501dfca900"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gsi_authz_get_authorization_identity </td>
<td>(</td>
<td class="paramtype">globus_gsi_authz_handle_t </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>identity_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">globus_gsi_authz_cb_t </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>callback_arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Query for authorization identity. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle that is to be used for the identity check. </td></tr>
<tr><td class="paramname">identity_ptr</td><td>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. </td></tr>
<tr><td class="paramname">callback</td><td>Callback function to call when identity is determined. </td></tr>
<tr><td class="paramname">callback_arg</td><td>Argument to callback function.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>GLOBUS_SUCCESS </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<hr>
<p align="center">
<a href="http://www.globus.org/toolkit/about.html" target="_top">about globus</a> |
<a href="http://www.globus.org/toolkit/" target="_top">globus toolkit</a> |
<a href="https://dev.globus.org/wiki/Welcome/" target="_top">dev.globus</a>
<br>
<br>
Comments? <a href="mailto:webmaster@globus.org">webmaster@globus.org</a>
</body>
</html>
