Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<!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: /home/vagrant/TriesAndDelete/etsi_its/framework/include/hmac.hh Source File</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_644e041c3a6521da7b27eba0e4eb2b95.html">framework</a></li><li class="navelem"><a class="el" href="dir_dd40116cd1cfebdc77a7c7114b29912e.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">hmac.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="hmac_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <openssl/hmac.h></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <openssl/objects.h></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99"> 21</a></span> <span class="keyword">enum class</span> <a class="code" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99">hash_algorithms</a>: unsigned char {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <a class="code" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99a6481b0effa74e617892c9bc27fb34609">sha_256</a>, </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99a6ada71c561e27325295ebfe2ca85387b">sha_384</a> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> }; <span class="comment">// End of class hash_algorithms</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classhmac.html"> 31</a></span> <span class="keyword">class </span><a class="code" href="classhmac.html">hmac</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classhmac.html#ac2fa7b2f2b5a7b8eb132d6421a40471b"> 32</a></span>  HMAC_CTX <a class="code" href="classhmac.html#ac2fa7b2f2b5a7b8eb132d6421a40471b">_ctx</a>; </div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classhmac.html#ae644f63c2a18882a49831b069bfd90da"> 33</a></span>  <a class="code" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99">hash_algorithms</a> <a class="code" href="classhmac.html#ae644f63c2a18882a49831b069bfd90da">_hash_algorithms</a>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classhmac.html#aeae80c256020ea7632b5132482127bf4"> 40</a></span>  <a class="code" href="classhmac.html#aeae80c256020ea7632b5132482127bf4">hmac</a>(<span class="keyword">const</span> <a class="code" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99">hash_algorithms</a> p_hash_algorithms): _ctx{}, _hash_algorithms(p_hash_algorithms) { ::HMAC_CTX_init(&_ctx); };</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classhmac.html#a03376d8f5598e8b3ee87cc6be03bb738"> 44</a></span>  <span class="keyword">virtual</span> <a class="code" href="classhmac.html#a03376d8f5598e8b3ee87cc6be03bb738">~hmac</a>() { ::HMAC_CTX_cleanup(&_ctx); };</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classhmac.html#a7dbba26db1578ec87fe9f8f7a78acb5b"> 55</a></span>  <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="classhmac.html#a7dbba26db1578ec87fe9f8f7a78acb5b">generate</a>(<span class="keyword">const</span> std::vector<unsigned char> p_buffer, <span class="keyword">const</span> std::vector<unsigned char> p_secret_key, std::vector<unsigned char>& p_hmac) {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// Sanity check</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">if</span> (p_buffer.size() == 0) {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> generate(p_buffer.data(), p_buffer.size(), p_secret_key.data(), p_secret_key.size(), p_hmac);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  };</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classhmac.html#ada465d58bc12a0e3d7775447dd0a5b83"> 75</a></span>  <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="classhmac.html#ada465d58bc12a0e3d7775447dd0a5b83">generate</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *p_buffer, <span class="keyword">const</span> <span class="keywordtype">size_t</span> p_buffer_length, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *p_secret_key, <span class="keyword">const</span> <span class="keywordtype">size_t</span> p_secret_key_length, std::vector<unsigned char>& p_hmac) {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// Sanity check</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">if</span> ((p_buffer == <span class="keyword">nullptr</span>) || (p_secret_key == <span class="keyword">nullptr</span>)) {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  p_hmac.resize(EVP_MAX_MD_SIZE);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">if</span> (_hash_algorithms == <a class="code" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99a6481b0effa74e617892c9bc27fb34609">hash_algorithms::sha_256</a>) {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  ::HMAC_Init_ex(&_ctx, (<span class="keyword">const</span> <span class="keywordtype">void</span>*)p_secret_key, (<span class="keywordtype">long</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>)p_secret_key_length, EVP_sha256(), NULL);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (_hash_algorithms == <a class="code" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99a6ada71c561e27325295ebfe2ca85387b">hash_algorithms::sha_384</a>) {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  ::HMAC_Init_ex(&_ctx, (<span class="keyword">const</span> <span class="keywordtype">void</span>*)p_secret_key, (<span class="keywordtype">long</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>)p_secret_key_length, EVP_sha384(), NULL);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  } <span class="keywordflow">else</span> { <span class="comment">// TODO To be continued</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  }</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="comment">// Compute the hash value</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  ::HMAC_Update(&_ctx, p_buffer, p_buffer_length);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> length = p_hmac.size();</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  ::HMAC_Final(&_ctx, static_cast<unsigned char*>(p_hmac.data()), &length);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">// Resize the hmac</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">if</span> (_hash_algorithms == <a class="code" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99a6481b0effa74e617892c9bc27fb34609">hash_algorithms::sha_256</a>) {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  p_hmac.resize(16);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  } <span class="comment">// FIXME Check length for the other hash algorithm</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  };</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> }; <span class="comment">// End of class hmac</span></div><div class="ttc" id="classhmac_html_aeae80c256020ea7632b5132482127bf4"><div class="ttname"><a href="classhmac.html#aeae80c256020ea7632b5132482127bf4">hmac::hmac</a></div><div class="ttdeci">hmac(const hash_algorithms p_hash_algorithms)</div><div class="ttdoc">Default constructor Create a new instance of the hmac class. </div><div class="ttdef"><b>Definition:</b> hmac.hh:40</div></div>
<div class="ttc" id="classhmac_html_ac2fa7b2f2b5a7b8eb132d6421a40471b"><div class="ttname"><a href="classhmac.html#ac2fa7b2f2b5a7b8eb132d6421a40471b">hmac::_ctx</a></div><div class="ttdeci">HMAC_CTX _ctx</div><div class="ttdef"><b>Definition:</b> hmac.hh:32</div></div>
<div class="ttc" id="hmac_8hh_html_a1b1faabd2f921a2202106e0fbd198b99"><div class="ttname"><a href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99">hash_algorithms</a></div><div class="ttdeci">hash_algorithms</div><div class="ttdef"><b>Definition:</b> hmac.hh:21</div></div>
<div class="ttc" id="classhmac_html_a7dbba26db1578ec87fe9f8f7a78acb5b"><div class="ttname"><a href="classhmac.html#a7dbba26db1578ec87fe9f8f7a78acb5b">hmac::generate</a></div><div class="ttdeci">int generate(const std::vector< unsigned char > p_buffer, const std::vector< unsigned char > p_secret_key, std::vector< unsigned char > &p_hmac)</div><div class="ttdoc">Generate the HMAC of data using a secret key [in] p_buffer The data tobe hashed. </div><div class="ttdef"><b>Definition:</b> hmac.hh:55</div></div>
<div class="ttc" id="classhmac_html"><div class="ttname"><a href="classhmac.html">hmac</a></div><div class="ttdoc">This class provides description of HMAC helper methods. </div><div class="ttdef"><b>Definition:</b> hmac.hh:31</div></div>
<div class="ttc" id="hmac_8hh_html_a1b1faabd2f921a2202106e0fbd198b99a6481b0effa74e617892c9bc27fb34609"><div class="ttname"><a href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99a6481b0effa74e617892c9bc27fb34609">hash_algorithms::sha_256</a></div></div>
<div class="ttc" id="classhmac_html_ada465d58bc12a0e3d7775447dd0a5b83"><div class="ttname"><a href="classhmac.html#ada465d58bc12a0e3d7775447dd0a5b83">hmac::generate</a></div><div class="ttdeci">int generate(const unsigned char *p_buffer, const size_t p_buffer_length, const unsigned char *p_secret_key, const size_t p_secret_key_length, std::vector< unsigned char > &p_hmac)</div><div class="ttdoc">Generate the HMAC of data using a secret key. </div><div class="ttdef"><b>Definition:</b> hmac.hh:75</div></div>
<div class="ttc" id="classhmac_html_a03376d8f5598e8b3ee87cc6be03bb738"><div class="ttname"><a href="classhmac.html#a03376d8f5598e8b3ee87cc6be03bb738">hmac::~hmac</a></div><div class="ttdeci">virtual ~hmac()</div><div class="ttdoc">Default destructor. </div><div class="ttdef"><b>Definition:</b> hmac.hh:44</div></div>
<div class="ttc" id="hmac_8hh_html_a1b1faabd2f921a2202106e0fbd198b99a6ada71c561e27325295ebfe2ca85387b"><div class="ttname"><a href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99a6ada71c561e27325295ebfe2ca85387b">hash_algorithms::sha_384</a></div></div>
<div class="ttc" id="classhmac_html_ae644f63c2a18882a49831b069bfd90da"><div class="ttname"><a href="classhmac.html#ae644f63c2a18882a49831b069bfd90da">hmac::_hash_algorithms</a></div><div class="ttdeci">hash_algorithms _hash_algorithms</div><div class="ttdoc">HMAC context. </div><div class="ttdef"><b>Definition:</b> hmac.hh:33</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 4 2018 14:16:23 for ETSI STF525 / Internal Testing test suite by  <a href="http://www.doxygen.org/index.html">