Files
bootloader/doc/host_html/group__aes__key__wrap.html
László Monda e6c1fce5b4 Add KBOOT.
2016-08-10 01:45:15 +02:00

221 lines
9.1 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.11"/>
<title>Kinetis Bootloader Host: Aes_key_wrap</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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<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">
$(document).ready(function() { init_search(); });
</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;">
<td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kinetis Bootloader Host
&#160;<span id="projectnumber">2.0.0</span>
</div>
<div id="projectbrief">Host Tools for Kinetis devices</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Introduction</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.png" alt=""/></a>
</span>
</div>
</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__aes__key__wrap.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Aes_key_wrap</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
aes_key_wrap</h2></td></tr>
<tr class="memitem:gab338610eae26ccb89d0446506ecc09da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__aes__key__wrap.html#gab338610eae26ccb89d0446506ecc09da">do_aes128_key_wrap</a> (const unsigned char plaintext[], unsigned char wrapped_ciphertext[], unsigned int expanded_kek[])</td></tr>
<tr class="memdesc:gab338610eae26ccb89d0446506ecc09da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encrypt and wrap plaintext key. <a href="#gab338610eae26ccb89d0446506ecc09da">More...</a><br /></td></tr>
<tr class="separator:gab338610eae26ccb89d0446506ecc09da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafc20d52fe7b7f5ab1337ca020cd4ba55"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__aes__key__wrap.html#gafc20d52fe7b7f5ab1337ca020cd4ba55">do_aes128_key_unwrap</a> (const unsigned char wrapped_ciphertext[], unsigned char unwrapped_plaintext[], unsigned int expanded_kek[])</td></tr>
<tr class="memdesc:gafc20d52fe7b7f5ab1337ca020cd4ba55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrypt and unwrap wrapped key. <a href="#gafc20d52fe7b7f5ab1337ca020cd4ba55">More...</a><br /></td></tr>
<tr class="separator:gafc20d52fe7b7f5ab1337ca020cd4ba55"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Usage Information</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gafc20d52fe7b7f5ab1337ca020cd4ba55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int do_aes128_key_unwrap </td>
<td>(</td>
<td class="paramtype">const unsigned char&#160;</td>
<td class="paramname"><em>wrapped_ciphertext</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char&#160;</td>
<td class="paramname"><em>unwrapped_plaintext</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>expanded_kek</em>[]&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decrypt and unwrap wrapped key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">wrapped_ciphertext</td><td>48 byte wrapped input array </td></tr>
<tr><td class="paramname">unwrapped_plaintext</td><td>48 byte plaintext output array, Note: this includes an 8 byte IV header that is added to start of the original 40 input bytes by the wrapping </td></tr>
<tr><td class="paramname">expanded_kek</td><td>Expanded kek (64 ints on host, 4 ints on device) </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">-1</td><td>on error </td></tr>
<tr><td class="paramname">0</td><td>on success </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab338610eae26ccb89d0446506ecc09da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void do_aes128_key_wrap </td>
<td>(</td>
<td class="paramtype">const unsigned char&#160;</td>
<td class="paramname"><em>plaintext</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char&#160;</td>
<td class="paramname"><em>wrapped_ciphertext</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>expanded_kek</em>[]&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encrypt and wrap plaintext key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plaintext</td><td>40 byte plaintext input array </td></tr>
<tr><td class="paramname">wrapped_ciphertext</td><td>48 byte wrapped output array </td></tr>
<tr><td class="paramname">expanded_kek</td><td>Expanded kek (64 bytes) </td></tr>
</table>
</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="footer">Generated on Mon Mar 7 2016 16:49:50 for Kinetis Bootloader Host by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>