classsha384.html 12.2 KB
Newer Older
garciay's avatar
garciay committed
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ETSI STF525 / Internal Testing test suite: sha384 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="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">ETSI STF525 / Internal Testing test suite
   </div>
   <div id="projectbrief">This project provides an internal testing test suite and its associated Test Adapter/Codec</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</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">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classsha384-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">sha384 Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This class provides description of SHA-384 helper methods.  
 <a href="classsha384.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="sha384_8hh_source.html">sha384.hh</a>&gt;</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:a8db24b52ddfe47d2ef479ee2fb272d17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsha384.html#a8db24b52ddfe47d2ef479ee2fb272d17">sha384</a> ()</td></tr>
<tr class="memdesc:a8db24b52ddfe47d2ef479ee2fb272d17"><td class="mdescLeft">&#160;</td><td class="mdescRight">SHA context.  <a href="#a8db24b52ddfe47d2ef479ee2fb272d17">More...</a><br /></td></tr>
<tr class="separator:a8db24b52ddfe47d2ef479ee2fb272d17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04c7d432fe9e17d335b24ff2b4ae902d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsha384.html#a04c7d432fe9e17d335b24ff2b4ae902d">~sha384</a> ()</td></tr>
<tr class="memdesc:a04c7d432fe9e17d335b24ff2b4ae902d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a04c7d432fe9e17d335b24ff2b4ae902d">More...</a><br /></td></tr>
<tr class="separator:a04c7d432fe9e17d335b24ff2b4ae902d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acad40ffc4e438afb2892fde32c7ecdc6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsha384.html#acad40ffc4e438afb2892fde32c7ecdc6">generate</a> (const std::vector&lt; unsigned char &gt; p_buffer, std::vector&lt; unsigned char &gt; &amp;p_hash)</td></tr>
<tr class="memdesc:acad40ffc4e438afb2892fde32c7ecdc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive bytes formated data from the lower layers.  <a href="#acad40ffc4e438afb2892fde32c7ecdc6">More...</a><br /></td></tr>
<tr class="separator:acad40ffc4e438afb2892fde32c7ecdc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41c2ddfb2b17b383c834178a8421b59c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsha384.html#a41c2ddfb2b17b383c834178a8421b59c">generate</a> (const unsigned char *p_buffer, const size_t p_length, std::vector&lt; unsigned char &gt; &amp;p_hash)</td></tr>
<tr class="separator:a41c2ddfb2b17b383c834178a8421b59c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a0eebdc221891759896fc986592ab9ba4"><td class="memItemLeft" align="right" valign="top">SHA512_CTX&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsha384.html#a0eebdc221891759896fc986592ab9ba4">_ctx</a></td></tr>
<tr class="separator:a0eebdc221891759896fc986592ab9ba4"><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>This class provides description of SHA-384 helper methods. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8db24b52ddfe47d2ef479ee2fb272d17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8db24b52ddfe47d2ef479ee2fb272d17">&#9670;&nbsp;</a></span>sha384()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">sha384::sha384 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>SHA context. </p>
<p>Default constructor Create a new instance of the <a class="el" href="classsha384.html" title="This class provides description of SHA-384 helper methods. ">sha384</a> class </p>

</div>
</div>
<a id="a04c7d432fe9e17d335b24ff2b4ae902d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04c7d432fe9e17d335b24ff2b4ae902d">&#9670;&nbsp;</a></span>~sha384()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual sha384::~sha384 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Default destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acad40ffc4e438afb2892fde32c7ecdc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acad40ffc4e438afb2892fde32c7ecdc6">&#9670;&nbsp;</a></span>generate() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int sha384::generate </td>
          <td>(</td>
          <td class="paramtype">const std::vector&lt; unsigned char &gt;&#160;</td>
          <td class="paramname"><em>p_buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; unsigned char &gt; &amp;&#160;</td>
          <td class="paramname"><em>p_hash</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Receive bytes formated data from the lower layers. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_buffer</td><td>The data used to generate the SHA-384 hash </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">p_hash</td><td>The SHA-384 hash value based of the provided data </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 otherwise</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_buffer</td><td>The data used to generate the SHA-384 hash </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">The</td><td>length of the data buffer </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">p_hash</td><td>The SHA-384 hash value based of the provided data </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 otherwise </dd></dl>

</div>
</div>
<a id="a41c2ddfb2b17b383c834178a8421b59c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41c2ddfb2b17b383c834178a8421b59c">&#9670;&nbsp;</a></span>generate() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int sha384::generate </td>
          <td>(</td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>p_buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const size_t&#160;</td>
          <td class="paramname"><em>p_length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; unsigned char &gt; &amp;&#160;</td>
          <td class="paramname"><em>p_hash</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0eebdc221891759896fc986592ab9ba4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0eebdc221891759896fc986592ab9ba4">&#9670;&nbsp;</a></span>_ctx</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">SHA512_CTX sha384::_ctx</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/vagrant/TriesAndDelete/etsi_its/framework/include/<a class="el" href="sha384_8hh_source.html">sha384.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 4 2018 14:16:35 for ETSI STF525 / Internal Testing test suite by &#160;<a href="http://www.doxygen.org/index.html">
garciay's avatar
garciay committed
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>