343 lines
16 KiB
HTML
343 lines
16 KiB
HTML
<!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">
|
|
<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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: RadioLibAES128 Class 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>
|
|
<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>
|
|
<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>
|
|
<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="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'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&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">
|
|
<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">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('class_radio_lib_a_e_s128.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</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="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_radio_lib_a_e_s128-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">RadioLibAES128 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class to perform AES encryption, decryption and CMAC.
|
|
<a href="class_radio_lib_a_e_s128.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_cryptography_8h_source.html">Cryptography.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a11f816221d1c06432ff80f2678ef46fe"><td class="memItemLeft" align="right" valign="top"><a id="a11f816221d1c06432ff80f2678ef46fe"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_a_e_s128.html#a11f816221d1c06432ff80f2678ef46fe">RadioLibAES128</a> ()</td></tr>
|
|
<tr class="memdesc:a11f816221d1c06432ff80f2678ef46fe"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a11f816221d1c06432ff80f2678ef46fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f688dbdf2b0506c077ca4501e40e22e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_a_e_s128.html#a2f688dbdf2b0506c077ca4501e40e22e">init</a> (uint8_t *key)</td></tr>
|
|
<tr class="memdesc:a2f688dbdf2b0506c077ca4501e40e22e"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the AES. <a href="class_radio_lib_a_e_s128.html#a2f688dbdf2b0506c077ca4501e40e22e">More...</a><br /></td></tr>
|
|
<tr class="separator:a2f688dbdf2b0506c077ca4501e40e22e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c7b49c3ed16f3849d8050a24a11c3c1"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_a_e_s128.html#a4c7b49c3ed16f3849d8050a24a11c3c1">encryptECB</a> (uint8_t *in, size_t len, uint8_t *out)</td></tr>
|
|
<tr class="memdesc:a4c7b49c3ed16f3849d8050a24a11c3c1"><td class="mdescLeft"> </td><td class="mdescRight">Perform ECB-type AES encryption. <a href="class_radio_lib_a_e_s128.html#a4c7b49c3ed16f3849d8050a24a11c3c1">More...</a><br /></td></tr>
|
|
<tr class="separator:a4c7b49c3ed16f3849d8050a24a11c3c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe0e368c6a94b2caf1559add1c262a98"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_a_e_s128.html#abe0e368c6a94b2caf1559add1c262a98">decryptECB</a> (uint8_t *in, size_t len, uint8_t *out)</td></tr>
|
|
<tr class="memdesc:abe0e368c6a94b2caf1559add1c262a98"><td class="mdescLeft"> </td><td class="mdescRight">Perform ECB-type AES decryption. <a href="class_radio_lib_a_e_s128.html#abe0e368c6a94b2caf1559add1c262a98">More...</a><br /></td></tr>
|
|
<tr class="separator:abe0e368c6a94b2caf1559add1c262a98"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a260a1ac84386141781b3d7c213ff161c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_a_e_s128.html#a260a1ac84386141781b3d7c213ff161c">generateCMAC</a> (uint8_t *in, size_t len, uint8_t *cmac)</td></tr>
|
|
<tr class="memdesc:a260a1ac84386141781b3d7c213ff161c"><td class="mdescLeft"> </td><td class="mdescRight">Calculate message authentication code according to RFC4493. <a href="class_radio_lib_a_e_s128.html#a260a1ac84386141781b3d7c213ff161c">More...</a><br /></td></tr>
|
|
<tr class="separator:a260a1ac84386141781b3d7c213ff161c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a382e9dfdc10b7dd58e2bd0aa15f5e1dd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_a_e_s128.html#a382e9dfdc10b7dd58e2bd0aa15f5e1dd">verifyCMAC</a> (uint8_t *in, size_t len, uint8_t *cmac)</td></tr>
|
|
<tr class="memdesc:a382e9dfdc10b7dd58e2bd0aa15f5e1dd"><td class="mdescLeft"> </td><td class="mdescRight">Verify the received CMAC. This just calculates the CMAC again and compares the results. <a href="class_radio_lib_a_e_s128.html#a382e9dfdc10b7dd58e2bd0aa15f5e1dd">More...</a><br /></td></tr>
|
|
<tr class="separator:a382e9dfdc10b7dd58e2bd0aa15f5e1dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Class to perform AES encryption, decryption and CMAC. </p>
|
|
<p>Most of the implementation here is adapted from <a href="https://github.com/kokke/tiny-AES-c">https://github.com/kokke/tiny-AES-c</a> Additional code and CMAC calculation is from <a href="https://github.com/megrxu/AES-CMAC">https://github.com/megrxu/AES-CMAC</a> </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="abe0e368c6a94b2caf1559add1c262a98"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe0e368c6a94b2caf1559add1c262a98">◆ </a></span>decryptECB()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t RadioLibAES128::decryptECB </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>in</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Perform ECB-type AES decryption. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">in</td><td>Input ciphertext data. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of the input data. </td></tr>
|
|
<tr><td class="paramname">out</td><td>Buffer to save the output plaintext into. It is up to the caller to ensure the buffer is sufficiently large to save the data! </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of bytes saved into the output buffer. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c7b49c3ed16f3849d8050a24a11c3c1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c7b49c3ed16f3849d8050a24a11c3c1">◆ </a></span>encryptECB()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t RadioLibAES128::encryptECB </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>in</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Perform ECB-type AES encryption. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">in</td><td>Input plaintext data (unpadded). </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of the input data. </td></tr>
|
|
<tr><td class="paramname">out</td><td>Buffer to save the output ciphertext into. It is up to the caller to ensure the buffer is sufficiently large to save the data! </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of bytes saved into the output buffer. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a260a1ac84386141781b3d7c213ff161c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a260a1ac84386141781b3d7c213ff161c">◆ </a></span>generateCMAC()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RadioLibAES128::generateCMAC </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>in</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>cmac</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calculate message authentication code according to RFC4493. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">in</td><td>Input data (unpadded). </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of the input data. </td></tr>
|
|
<tr><td class="paramname">cmac</td><td>Buffer to save the output MAC into. The buffer must be at least 16 bytes long! </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2f688dbdf2b0506c077ca4501e40e22e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f688dbdf2b0506c077ca4501e40e22e">◆ </a></span>init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RadioLibAES128::init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize the AES. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>AES key to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a382e9dfdc10b7dd58e2bd0aa15f5e1dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a382e9dfdc10b7dd58e2bd0aa15f5e1dd">◆ </a></span>verifyCMAC()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool RadioLibAES128::verifyCMAC </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>in</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>cmac</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Verify the received CMAC. This just calculates the CMAC again and compares the results. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">in</td><td>Input data (unpadded). </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of the input data. </td></tr>
|
|
<tr><td class="paramname">cmac</td><td>CMAC to verify. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if valid, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/utils/<a class="el" href="_cryptography_8h_source.html">Cryptography.h</a></li>
|
|
<li>src/utils/Cryptography.cpp</li>
|
|
</ul>
|
|
</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="class_radio_lib_a_e_s128.html">RadioLibAES128</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.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|