tRacket-sensor

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tRacket Sensor: SecretStore Struct 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="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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">tRacket Sensor<span id="projectnumber">&#160;0.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="structSecretStore-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">SecretStore Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a394bac8732cad978b978cd2ebf0bcb15" id="r_a394bac8732cad978b978cd2ebf0bcb15"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSecretStore.html#a394bac8732cad978b978cd2ebf0bcb15">encrypt</a> (const char *in, uint8_t *out, unsigned int len) const noexcept</td></tr>
<tr class="memdesc:a394bac8732cad978b978cd2ebf0bcb15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Securely encrypts the given string.  <br /></td></tr>
<tr class="separator:a394bac8732cad978b978cd2ebf0bcb15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1459cfab454a565b8eb6e49c4f47e823" id="r_a1459cfab454a565b8eb6e49c4f47e823"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSecretStore.html#a1459cfab454a565b8eb6e49c4f47e823">decrypt</a> (const uint8_t *in, char *out, unsigned int len) const noexcept</td></tr>
<tr class="memdesc:a1459cfab454a565b8eb6e49c4f47e823"><td class="mdescLeft">&#160;</td><td class="mdescRight">Securely decrypts the given string.  <br /></td></tr>
<tr class="separator:a1459cfab454a565b8eb6e49c4f47e823"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a206c0ca1ded14da2aba2558f37920a34" id="r_a206c0ca1ded14da2aba2558f37920a34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUUID.html">UUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSecretStore.html#a206c0ca1ded14da2aba2558f37920a34">key</a></td></tr>
<tr class="separator:a206c0ca1ded14da2aba2558f37920a34"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-attribs" name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:aee4514cf0ef6670e78818c74bc05a560" id="r_aee4514cf0ef6670e78818c74bc05a560"><td class="memItemLeft" align="right" valign="top">static constexpr unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSecretStore.html#aee4514cf0ef6670e78818c74bc05a560">BITS</a> = 256</td></tr>
<tr class="separator:aee4514cf0ef6670e78818c74bc05a560"><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 class="definition">Definition at line <a class="el" href="secret-store_8h_source.html#l00024">24</a> of file <a class="el" href="secret-store_8h_source.html">secret-store.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1459cfab454a565b8eb6e49c4f47e823" name="a1459cfab454a565b8eb6e49c4f47e823"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1459cfab454a565b8eb6e49c4f47e823">&#9670;&#160;</a></span>decrypt()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void SecretStore::decrypt </td>
          <td>(</td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>out</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Securely decrypts the given string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">in</td><td>Pointer to <code>len</code> bytes of input data. </td></tr>
    <tr><td class="paramname">out</td><td>Pre-allocated buffer to store decrypted output. </td></tr>
    <tr><td class="paramname">len</td><td>Number of bytes to process. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a394bac8732cad978b978cd2ebf0bcb15" name="a394bac8732cad978b978cd2ebf0bcb15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a394bac8732cad978b978cd2ebf0bcb15">&#9670;&#160;</a></span>encrypt()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void SecretStore::encrypt </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>out</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Securely encrypts the given string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">in</td><td>Pointer to <code>len</code> bytes of input data. </td></tr>
    <tr><td class="paramname">out</td><td>Pre-allocated buffer to store encrypted output. </td></tr>
    <tr><td class="paramname">len</td><td>Number of bytes to process. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aee4514cf0ef6670e78818c74bc05a560" name="aee4514cf0ef6670e78818c74bc05a560"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee4514cf0ef6670e78818c74bc05a560">&#9670;&#160;</a></span>BITS</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr unsigned SecretStore::BITS = 256</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="secret-store_8h_source.html#l00045">45</a> of file <a class="el" href="secret-store_8h_source.html">secret-store.h</a>.</p>

</div>
</div>
<a id="a206c0ca1ded14da2aba2558f37920a34" name="a206c0ca1ded14da2aba2558f37920a34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a206c0ca1ded14da2aba2558f37920a34">&#9670;&#160;</a></span>key</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classUUID.html">UUID</a> SecretStore::key</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="secret-store_8h_source.html#l00026">26</a> of file <a class="el" href="secret-store_8h_source.html">secret-store.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>noisemeter-device/<a class="el" href="secret-store_8h_source.html">secret-store.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>