Skip to content

Commit

Permalink
Doc update for Release v3.7.1 (20231215)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Srinivas-E
Srinivas-E committed Jan 5, 2024
1 parent 8abce9e commit 4f4e6fb
Show file tree
Hide file tree
Showing 4,491 changed files with 117,391 additions and 811,698 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
667 changes: 667 additions & 0 deletions a00005.html
View file

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions a00005.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
var a00005 =
[
[ "sha206a_authenticate", "a00005.html#a12d6e9c4cc705771788c0640aed7caa2", null ],
[ "sha206a_check_dk_useflag_validity", "a00005.html#ac87eb13206cd4e43575df8845aa094d9", null ],
[ "sha206a_check_pk_useflag_validity", "a00005.html#ad2ace3d5e5b19b3ff4347376b5b78d85", null ],
[ "sha206a_diversify_parent_key", "a00005.html#a1e33c650348129b8d82a8370e38b4c6c", null ],
[ "sha206a_generate_challenge_response_pair", "a00005.html#a9c9123a2363452de20ceefc9b020aac0", null ],
[ "sha206a_generate_derive_key", "a00005.html#afbdb8aef5ee59e66c2e7b28f19edc712", null ],
[ "sha206a_get_data_store_lock_status", "a00005.html#ac55f2b5842936c908254e755bfe3d0f1", null ],
[ "sha206a_get_dk_update_count", "a00005.html#a094aabc034e66d2a1b3ba9324da79010", null ],
[ "sha206a_get_dk_useflag_count", "a00005.html#ac98db9b59f5413e7c10d65e00cbff402", null ],
[ "sha206a_get_pk_useflag_count", "a00005.html#a4415f1d4d84a1ccea935cad493dd5074", null ],
[ "sha206a_read_data_store", "a00005.html#ab97f7ad917c2c3293d211f8aad632a7c", null ],
[ "sha206a_verify_device_consumption", "a00005.html#ac28d87cbe843ea3b2b69c5a62b14872f", null ],
[ "sha206a_write_data_store", "a00005.html#a23714cfbe25ea60f74a48c596ec48a6b", null ]
];
236 changes: 135 additions & 101 deletions a00008.html
View file

Large diffs are not rendered by default.

703 changes: 64 additions & 639 deletions a00011.html
View file

Large diffs are not rendered by default.

21 changes: 1 addition & 20 deletions a00011.js
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,4 @@
var a00011 =
[
[ "ATCA_SHA206A_DKEY_CONSUMPTION_MASK", "a00011.html#a5dd0dcb6140ebac7d92896c70261403b", null ],
[ "ATCA_SHA206A_PKEY_CONSUMPTION_MASK", "a00011.html#a1576a6197e391a3a189187ac559f9395", null ],
[ "ATCA_SHA206A_SYMMETRIC_KEY_ID_SLOT", "a00011.html#aabc20693d3599e4504d95333bfd68080", null ],
[ "ATCA_SHA206A_ZONE_WRITE_LOCK", "a00011.html#a20d1d9fad06e15a8c6562c8d86037ec4", null ],
[ "SHA206A_DATA_STORE0", "a00011.html#a06fc87d81c62e9abb8790b6e5713c55baa2dfe480d909da1165603db89b5ed55d", null ],
[ "SHA206A_DATA_STORE1", "a00011.html#a06fc87d81c62e9abb8790b6e5713c55ba56b6c7e550081b4378c71b9cd65d7293", null ],
[ "SHA206A_DATA_STORE2", "a00011.html#a06fc87d81c62e9abb8790b6e5713c55baf4ab5ae94067d1aa5894c5f56bdc46a0", null ],
[ "sha206a_authenticate", "a00011.html#a12d6e9c4cc705771788c0640aed7caa2", null ],
[ "sha206a_check_dk_useflag_validity", "a00011.html#a77cc3bcc3d7c4fac3f328caa663d8948", null ],
[ "sha206a_check_pk_useflag_validity", "a00011.html#aba072c8759cd0d991b732a40b03be0bf", null ],
[ "sha206a_diversify_parent_key", "a00011.html#a1e33c650348129b8d82a8370e38b4c6c", null ],
[ "sha206a_generate_challenge_response_pair", "a00011.html#a9c9123a2363452de20ceefc9b020aac0", null ],
[ "sha206a_generate_derive_key", "a00011.html#afbdb8aef5ee59e66c2e7b28f19edc712", null ],
[ "sha206a_get_data_store_lock_status", "a00011.html#ac55f2b5842936c908254e755bfe3d0f1", null ],
[ "sha206a_get_dk_update_count", "a00011.html#a094aabc034e66d2a1b3ba9324da79010", null ],
[ "sha206a_get_dk_useflag_count", "a00011.html#ac98db9b59f5413e7c10d65e00cbff402", null ],
[ "sha206a_get_pk_useflag_count", "a00011.html#a4415f1d4d84a1ccea935cad493dd5074", null ],
[ "sha206a_read_data_store", "a00011.html#ab97f7ad917c2c3293d211f8aad632a7c", null ],
[ "sha206a_verify_device_consumption", "a00011.html#ac28d87cbe843ea3b2b69c5a62b14872f", null ],
[ "sha206a_write_data_store", "a00011.html#a23714cfbe25ea60f74a48c596ec48a6b", null ]
[ "symmetric_authenticate", "a00011.html#a9a41d1600ffd22de067ded50447d359b", null ]
];
163 changes: 0 additions & 163 deletions a00011_source.html
View file

This file was deleted.

132 changes: 103 additions & 29 deletions a00014.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CryptoAuthLib: README.md File Reference</title>
<title>CryptoAuthLib: symmetric_authentication.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand All @@ -16,42 +16,48 @@
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="microchip.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">CryptoAuthLib
&#160;<span id="projectnumber">v3.4.1</span>
<td id="projectalign">
<div id="projectname">CryptoAuthLib<span id="projectnumber">&#160;v3.7.1</span>
</div>
<div id="projectbrief">Microchip CryptoAuthentication Library</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
Expand All @@ -64,7 +70,7 @@
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('a00014.html',''); initResizable(); });
/* @license-end */
</script>
Expand All @@ -78,23 +84,91 @@

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
<div class="headertitle">
<div class="title">README.md File Reference</div> </div>
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">symmetric_authentication.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Contains API for performing the symmetric Authentication between the Host and the device.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="a00512.html">cryptoauthlib.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9a41d1600ffd22de067ded50447d359b"><td class="memItemLeft" align="right" valign="top">ATCA_STATUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#a9a41d1600ffd22de067ded50447d359b">symmetric_authenticate</a> (uint8_t slot, const uint8_t *master_key, const uint8_t *rand_number)</td></tr>
<tr class="memdesc:a9a41d1600ffd22de067ded50447d359b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function which does the authentication between the host and device. <br /></td></tr>
<tr class="separator:a9a41d1600ffd22de067ded50447d359b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Contains API for performing the symmetric Authentication between the Host and the device. </p>
<dl class="section copyright"><dt>Copyright</dt><dd>(c) 2015-2020 Microchip Technology Inc. and its subsidiaries. </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a9a41d1600ffd22de067ded50447d359b" name="a9a41d1600ffd22de067ded50447d359b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a41d1600ffd22de067ded50447d359b">&#9670;&#160;</a></span>symmetric_authenticate()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ATCA_STATUS symmetric_authenticate </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>master_key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>rand_number</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Function which does the authentication between the host and device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">slot</td><td>The slot number used for the symmetric authentication. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">master_key</td><td>The master key used for the calculating the symmetric key. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rand_number</td><td>The 20 byte rand_number from the host. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ATCA_SUCCESS on successful authentication, otherwise an error code. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="a00014.html">README.md</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
<li class="navelem"><a class="el" href="dir_d422163b96683743ed3963d4aac17747.html">app</a></li><li class="navelem"><a class="el" href="dir_87abda79916a436a3f9fdf465608c5f5.html">ip_protection</a></li><li class="navelem"><a class="el" href="a00014.html">symmetric_authentication.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
</ul>
</div>
</body>
Expand Down
4 changes: 4 additions & 0 deletions a00014.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
var a00014 =
[
[ "symmetric_authenticate", "a00014.html#a9a41d1600ffd22de067ded50447d359b", null ]
];
Loading

0 comments on commit 4f4e6fb

Please sign in to comment.