diff options
| author | Alexandra Ellwood <lxs@mit.edu> | 2007-08-23 16:53:53 +0000 |
|---|---|---|
| committer | Alexandra Ellwood <lxs@mit.edu> | 2007-08-23 16:53:53 +0000 |
| commit | 002cb3e65e91e87842a8b69d1c97c19423d1fb08 (patch) | |
| tree | 115620291b5c3049bff3030ff814d4cc09692ffb /doc/ccapi/html/structcc__data.html | |
| parent | 1ba85a1abdc293f48583f136bc3a6d60025bca69 (diff) | |
| download | krb5-002cb3e65e91e87842a8b69d1c97c19423d1fb08.tar.gz krb5-002cb3e65e91e87842a8b69d1c97c19423d1fb08.tar.xz krb5-002cb3e65e91e87842a8b69d1c97c19423d1fb08.zip | |
Add documentation for CCAPI
Added Doxygen-based documentation to CredentialsCache.h and checked
in a copy of the html output of that documentation.
ticket: new
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@19849 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'doc/ccapi/html/structcc__data.html')
| -rw-r--r-- | doc/ccapi/html/structcc__data.html | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/ccapi/html/structcc__data.html b/doc/ccapi/html/structcc__data.html new file mode 100644 index 000000000..28b2d37f0 --- /dev/null +++ b/doc/ccapi/html/structcc__data.html @@ -0,0 +1,68 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>Credentials Cache API: cc_data Struct Reference</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.5.3 --> +<h1>cc_data Struct Reference<br> +<small> +[<a class="el" href="group__cc__credentials__reference.html">cc_credentials_t Overview</a>]</small> +</h1><!-- doxytag: class="cc_data" --><hr><a name="_details"></a><h2>Detailed Description</h2> +The CCAPI data structure. This structure is similar to a krb5_data structure. In a v5 credentials structure, <a class="el" href="structcc__data.html">cc_data</a> structures are used to store tagged variable-length binary data. Specifically, for cc_credentials_v5.ticket and cc_credentials_v5.second_ticket, the <a class="el" href="structcc__data.html#1cfc8b2545d7999b7a760b47bfbbf6e7">cc_data.type</a> field must be zero. For the cc_credentials_v5.addresses, cc_credentials_v5.authdata, and cc_credentials_v5.keyblock, the <a class="el" href="structcc__data.html#1cfc8b2545d7999b7a760b47bfbbf6e7">cc_data.type</a> field should be the address type, authorization data type, and encryption type, as defined by the Kerberos v5 protocol definition. <h2>Data Fields</h2> +<ul> +<li><a class="el" href="group__ccapi__types__reference.html#ga00783c3f4aa70580d0900b1a79aab9d">cc_uint32</a> <a class="el" href="structcc__data.html#1cfc8b2545d7999b7a760b47bfbbf6e7">type</a> +<li><a class="el" href="group__ccapi__types__reference.html#ga00783c3f4aa70580d0900b1a79aab9d">cc_uint32</a> <a class="el" href="structcc__data.html#61dffab9209fdc97d53c4cb31f746aa5">length</a> +<li>void * <a class="el" href="structcc__data.html#735984d41155bc1032e09bece8f8d66d">data</a> +</ul> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="1cfc8b2545d7999b7a760b47bfbbf6e7"></a><!-- doxytag: member="cc_data::type" ref="1cfc8b2545d7999b7a760b47bfbbf6e7" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__ccapi__types__reference.html#ga00783c3f4aa70580d0900b1a79aab9d">cc_uint32</a> <a class="el" href="structcc__data.html#1cfc8b2545d7999b7a760b47bfbbf6e7">type</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The type of the data as defined by the krb5_data structure. +</div> +</div><p> +<a class="anchor" name="61dffab9209fdc97d53c4cb31f746aa5"></a><!-- doxytag: member="cc_data::length" ref="61dffab9209fdc97d53c4cb31f746aa5" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__ccapi__types__reference.html#ga00783c3f4aa70580d0900b1a79aab9d">cc_uint32</a> <a class="el" href="structcc__data.html#61dffab9209fdc97d53c4cb31f746aa5">length</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The length of <em>data</em>. +</div> +</div><p> +<a class="anchor" name="735984d41155bc1032e09bece8f8d66d"></a><!-- doxytag: member="cc_data::data" ref="735984d41155bc1032e09bece8f8d66d" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* <a class="el" href="structcc__data.html#735984d41155bc1032e09bece8f8d66d">data</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The data buffer. +</div> +</div><p> +<hr size="1"><address style="text-align: right;"><small>Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> +</body> +</html> |