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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<!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: hmac 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> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classhmac-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hmac Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class provides description of HMAC helper methods.
<a href="classhmac.html#details">More...</a></p>
<p><code>#include <<a class="el" href="hmac_8hh_source.html">hmac.hh</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:aeae80c256020ea7632b5132482127bf4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhmac.html#aeae80c256020ea7632b5132482127bf4">hmac</a> (const <a class="el" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99">hash_algorithms</a> p_hash_algorithms)</td></tr>
<tr class="memdesc:aeae80c256020ea7632b5132482127bf4"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor Create a new instance of the hmac class. <a href="#aeae80c256020ea7632b5132482127bf4">More...</a><br /></td></tr>
<tr class="separator:aeae80c256020ea7632b5132482127bf4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03376d8f5598e8b3ee87cc6be03bb738"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classhmac.html#a03376d8f5598e8b3ee87cc6be03bb738">~hmac</a> ()</td></tr>
<tr class="memdesc:a03376d8f5598e8b3ee87cc6be03bb738"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#a03376d8f5598e8b3ee87cc6be03bb738">More...</a><br /></td></tr>
<tr class="separator:a03376d8f5598e8b3ee87cc6be03bb738"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7dbba26db1578ec87fe9f8f7a78acb5b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhmac.html#a7dbba26db1578ec87fe9f8f7a78acb5b">generate</a> (const std::vector< unsigned char > p_buffer, const std::vector< unsigned char > p_secret_key, std::vector< unsigned char > &p_hmac)</td></tr>
<tr class="memdesc:a7dbba26db1578ec87fe9f8f7a78acb5b"><td class="mdescLeft"> </td><td class="mdescRight">Generate the HMAC of data using a secret key [in] p_buffer The data tobe hashed. <a href="#a7dbba26db1578ec87fe9f8f7a78acb5b">More...</a><br /></td></tr>
<tr class="separator:a7dbba26db1578ec87fe9f8f7a78acb5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada465d58bc12a0e3d7775447dd0a5b83"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhmac.html#ada465d58bc12a0e3d7775447dd0a5b83">generate</a> (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)</td></tr>
<tr class="memdesc:ada465d58bc12a0e3d7775447dd0a5b83"><td class="mdescLeft"> </td><td class="mdescRight">Generate the HMAC of data using a secret key. <a href="#ada465d58bc12a0e3d7775447dd0a5b83">More...</a><br /></td></tr>
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<tr class="separator:ada465d58bc12a0e3d7775447dd0a5b83"><td class="memSeparator" colspan="2"> </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:ac2fa7b2f2b5a7b8eb132d6421a40471b"><td class="memItemLeft" align="right" valign="top">HMAC_CTX </td><td class="memItemRight" valign="bottom"><a class="el" href="classhmac.html#ac2fa7b2f2b5a7b8eb132d6421a40471b">_ctx</a></td></tr>
<tr class="separator:ac2fa7b2f2b5a7b8eb132d6421a40471b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae644f63c2a18882a49831b069bfd90da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99">hash_algorithms</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhmac.html#ae644f63c2a18882a49831b069bfd90da">_hash_algorithms</a></td></tr>
<tr class="memdesc:ae644f63c2a18882a49831b069bfd90da"><td class="mdescLeft"> </td><td class="mdescRight">HMAC context. <a href="#ae644f63c2a18882a49831b069bfd90da">More...</a><br /></td></tr>
<tr class="separator:ae644f63c2a18882a49831b069bfd90da"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class provides description of HMAC helper methods. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aeae80c256020ea7632b5132482127bf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeae80c256020ea7632b5132482127bf4">◆ </a></span>hmac()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">hmac::hmac </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99">hash_algorithms</a> </td>
<td class="paramname"><em>p_hash_algorithms</em></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>Default constructor Create a new instance of the hmac class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">p_hash_algorithms</td><td>The hash algorithm to be used to compute the HMAC </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a03376d8f5598e8b3ee87cc6be03bb738"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03376d8f5598e8b3ee87cc6be03bb738">◆ </a></span>~hmac()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual hmac::~hmac </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="a7dbba26db1578ec87fe9f8f7a78acb5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dbba26db1578ec87fe9f8f7a78acb5b">◆ </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 hmac::generate </td>
<td>(</td>
<td class="paramtype">const std::vector< unsigned char > </td>
<td class="paramname"><em>p_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< unsigned char > </td>
<td class="paramname"><em>p_secret_key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< unsigned char > & </td>
<td class="paramname"><em>p_hmac</em> </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>Generate the HMAC of data using a secret key [in] p_buffer The data tobe hashed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">p_secret_key</td><td>The secret key to be used to generate the HMAC </td></tr>
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
<tr><td class="paramdir">[out]</td><td class="paramname">p_hmac</td><td>The HMAC 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="ada465d58bc12a0e3d7775447dd0a5b83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada465d58bc12a0e3d7775447dd0a5b83">◆ </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 hmac::generate </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>p_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>p_buffer_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>p_secret_key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>p_secret_key_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< unsigned char > & </td>
<td class="paramname"><em>p_hmac</em> </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>Generate the HMAC of data using a secret key. </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 to be hashed </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">p_buffer_length</td><td>The size of the data </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">p_secret_key</td><td>The secret key to be used to generate the HMAC </td></tr>
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
<tr><td class="paramdir">[in]</td><td class="paramname">p_secret_key_length</td><td>The size of the secret key </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">p_hmac</td><td>The HMAC 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>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac2fa7b2f2b5a7b8eb132d6421a40471b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2fa7b2f2b5a7b8eb132d6421a40471b">◆ </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">HMAC_CTX hmac::_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>
<a id="ae644f63c2a18882a49831b069bfd90da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae644f63c2a18882a49831b069bfd90da">◆ </a></span>_hash_algorithms</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="hmac_8hh.html#a1b1faabd2f921a2202106e0fbd198b99">hash_algorithms</a> hmac::_hash_algorithms</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>HMAC context. </p>
</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="hmac_8hh_source.html">hmac.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 4 2018 14:16:31 for ETSI STF525 / Internal Testing test suite by  <a href="http://www.doxygen.org/index.html">