<!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.7.4 -->
<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>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('group__globus__gsi__cred__handle__attrs.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">Credential Handle Attributes</div> </div>
</div>
<div class="contents">
<p>Create/Destroy/Modify GSI Credential Handle Attributes.
<a href="#details">More...</a></p>
<h2><a name="typedef-members"></a>
Typedefs</h2>
<ul>
<li>typedef struct <br class="typebreak"/>
globus_l_gsi_cred_handle_attrs_s * <a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a>
</ul>
<h2><a name="member-group"></a>
Credential Handle Attributes Initialization and Destruction</h2>
<ul>
<li>globus_result_t <a class="el" href="group__globus__gsi__cred__handle__attrs.html#ga8f6c14debba4d4d9664d59909e3730f1">globus_gsi_cred_handle_attrs_init</a> (<a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> *handle_attrs)
<li>globus_result_t <a class="el" href="group__globus__gsi__cred__handle__attrs.html#gacd31ad765ee3a115e0a939fe5d64dcbe">globus_gsi_cred_handle_attrs_destroy</a> (<a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> handle_attrs)
</ul>
<h2><a name="member-group"></a>
Copy Credential Handle Attributes</h2>
<ul>
<li>globus_result_t <a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac883e53c23430936198f14c622478634">globus_gsi_cred_handle_attrs_copy</a> (<a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> source, <a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> *dest)
</ul>
<h2><a name="member-group"></a>
Seting and Getting the CA Cert Dir</h2>
<ul>
<li>globus_result_t <a class="el" href="group__globus__gsi__cred__handle__attrs.html#ga5aa4fe3999713c4ea68f590469347de6">globus_gsi_cred_handle_attrs_set_ca_cert_dir</a> (<a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> handle_attrs, char *ca_cert_dir)
<li>globus_result_t <a class="el" href="group__globus__gsi__cred__handle__attrs.html#ga7f02216f44f896002f662f71984d73a0">globus_gsi_cred_handle_attrs_get_ca_cert_dir</a> (<a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> handle_attrs, char **ca_cert_dir)
</ul>
<h2><a name="member-group"></a>
Setting and Getting the Search Order</h2>
<ul>
<li>globus_result_t <a class="el" href="group__globus__gsi__cred__handle__attrs.html#ga5e47c5d4524fb4ad2faddfb948b6abd6">globus_gsi_cred_handle_attrs_set_search_order</a> (<a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> handle_attrs, <a class="el" href="group__globus__gsi__credential__constants.html#ga4c604d5349ee485ab8d3a81d8da89241">globus_gsi_cred_type_t</a> search_order[])
<li>globus_result_t <a class="el" href="group__globus__gsi__cred__handle__attrs.html#ga69012ab060ade34929469f2916da750d">globus_gsi_cred_handle_attrs_get_search_order</a> (<a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> handle_attrs, <a class="el" href="group__globus__gsi__credential__constants.html#ga4c604d5349ee485ab8d3a81d8da89241">globus_gsi_cred_type_t</a> **search_order)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Create/Destroy/Modify GSI Credential Handle Attributes. </p>
<p>Within the Globus GSI Credential Library, all credential handles contain a attribute structure, which in turn contains handle instance independent attributes.</p>
<p>This section defines operations to create, modify and destroy GSI Credential handle attributes. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gac3a90cdd8e00d9890f4696a4ade91233"></a><!-- doxytag: member="globus_gsi_credential.h::globus_gsi_cred_handle_attrs_t" ref="gac3a90cdd8e00d9890f4696a4ade91233" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct globus_l_gsi_cred_handle_attrs_s* <a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Credential Handle Attributes. </p>
<p>Credential handle attributes provide a set of immutable parameters for a credential handle</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__globus__gsi__cred__handle.html#gab1f6da81b0a8ea3dcac07f6a3ecf03ff" title="Initializes a credential handle to be used credential handling functions.">globus_gsi_cred_handle_init</a> </dd></dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga8f6c14debba4d4d9664d59909e3730f1"></a><!-- doxytag: member="globus_gsi_cred_handle_attrs.c::globus_gsi_cred_handle_attrs_init" ref="ga8f6c14debba4d4d9664d59909e3730f1" args="(globus_gsi_cred_handle_attrs_t *handle_attrs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gsi_cred_handle_attrs_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> * </td>
<td class="paramname"><em>handle_attrs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes the immutable Credential Handle Attributes The handle attributes are initialized as follows: </p>
<ul>
<li>The search order is set to SERVICE, HOST, PROXY, USER</li>
<li>All other attributes are set to 0/NULL</li>
</ul>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle_attrs</td><td>the attributes to be initialized </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>GLOBUS_SUCESS if initialization was successful, otherwise an error is returned </dd></dl>
</div>
</div>
<a class="anchor" id="gacd31ad765ee3a115e0a939fe5d64dcbe"></a><!-- doxytag: member="globus_gsi_cred_handle_attrs.c::globus_gsi_cred_handle_attrs_destroy" ref="gacd31ad765ee3a115e0a939fe5d64dcbe" args="(globus_gsi_cred_handle_attrs_t handle_attrs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gsi_cred_handle_attrs_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> </td>
<td class="paramname"><em>handle_attrs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy the Credential Handle Attributes. </p>
<p>This function does some cleanup and deallocation of the handle attributes.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle_attrs</td><td>The handle attributes to destroy</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>GLOBUS_SUCCESS </dd></dl>
</div>
</div>
<a class="anchor" id="gac883e53c23430936198f14c622478634"></a><!-- doxytag: member="globus_gsi_cred_handle_attrs.c::globus_gsi_cred_handle_attrs_copy" ref="gac883e53c23430936198f14c622478634" args="(globus_gsi_cred_handle_attrs_t source, globus_gsi_cred_handle_attrs_t *dest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gsi_cred_handle_attrs_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> * </td>
<td class="paramname"><em>dest</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy the Credential Handle Attributes. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The handle attribute to be copied </td></tr>
<tr><td class="paramname">dest</td><td>The copy </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>GLOBUS_SUCESS unless there was an error, in which case an error object is returned. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5aa4fe3999713c4ea68f590469347de6"></a><!-- doxytag: member="globus_gsi_cred_handle_attrs.c::globus_gsi_cred_handle_attrs_set_ca_cert_dir" ref="ga5aa4fe3999713c4ea68f590469347de6" args="(globus_gsi_cred_handle_attrs_t handle_attrs, char *ca_cert_dir)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gsi_cred_handle_attrs_set_ca_cert_dir </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> </td>
<td class="paramname"><em>handle_attrs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>ca_cert_dir</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the Trusted CA Certificate Directory Location. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle_attrs</td><td>the credential handle attributes to set </td></tr>
<tr><td class="paramname">ca_cert_dir</td><td>the trusted ca certificates directory </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>GLOBUS_SUCCESS if no errors occurred. In case of a null handle_attrs, an error object id is returned </dd></dl>
</div>
</div>
<a class="anchor" id="ga7f02216f44f896002f662f71984d73a0"></a><!-- doxytag: member="globus_gsi_cred_handle_attrs.c::globus_gsi_cred_handle_attrs_get_ca_cert_dir" ref="ga7f02216f44f896002f662f71984d73a0" args="(globus_gsi_cred_handle_attrs_t handle_attrs, char **ca_cert_dir)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gsi_cred_handle_attrs_get_ca_cert_dir </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> </td>
<td class="paramname"><em>handle_attrs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>ca_cert_dir</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the trusted ca cert directory. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle_attrs</td><td>the credential handle attributes to get the trusted ca cert directory from </td></tr>
<tr><td class="paramname">ca_cert_dir</td><td>the trusted ca certificates directory </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>GLOBUS_SUCCESS if no errors occurred. In case of a null handle_attrs or pointer to ca_cert_dir, an error object id is returned </dd></dl>
</div>
</div>
<a class="anchor" id="ga5e47c5d4524fb4ad2faddfb948b6abd6"></a><!-- doxytag: member="globus_gsi_cred_handle_attrs.c::globus_gsi_cred_handle_attrs_set_search_order" ref="ga5e47c5d4524fb4ad2faddfb948b6abd6" args="(globus_gsi_cred_handle_attrs_t handle_attrs, globus_gsi_cred_type_t search_order[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gsi_cred_handle_attrs_set_search_order </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> </td>
<td class="paramname"><em>handle_attrs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gsi__credential__constants.html#ga4c604d5349ee485ab8d3a81d8da89241">globus_gsi_cred_type_t</a> </td>
<td class="paramname"><em>search_order</em>[] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the search order for finding a user certificate. </p>
<p>The default value is {SERVICE, HOST, PROXY, USER}</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle_attrs</td><td>The handle attributes to set the search order of </td></tr>
<tr><td class="paramname">search_order</td><td>The search order. Should be a three element array containing in some order PROXY, USER, HOST, SERVICE. The array should be terminated by the value GLOBUS_SO_END. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>GLOBUS_SUCCESS unless handle_attrs is null </dd></dl>
</div>
</div>
<a class="anchor" id="ga69012ab060ade34929469f2916da750d"></a><!-- doxytag: member="globus_gsi_cred_handle_attrs.c::globus_gsi_cred_handle_attrs_get_search_order" ref="ga69012ab060ade34929469f2916da750d" args="(globus_gsi_cred_handle_attrs_t handle_attrs, globus_gsi_cred_type_t **search_order)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">globus_result_t globus_gsi_cred_handle_attrs_get_search_order </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__globus__gsi__cred__handle__attrs.html#gac3a90cdd8e00d9890f4696a4ade91233">globus_gsi_cred_handle_attrs_t</a> </td>
<td class="paramname"><em>handle_attrs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__globus__gsi__credential__constants.html#ga4c604d5349ee485ab8d3a81d8da89241">globus_gsi_cred_type_t</a> ** </td>
<td class="paramname"><em>search_order</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the search order of the handle attributes. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle_attrs</td><td>The handle attributes to get the search order from </td></tr>
<tr><td class="paramname">search_order</td><td>The search_order of the handle attributes </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>GLOBUS_SUCCESS unless handle_attrs is null </dd></dl>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<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>
