1<!-- HTML header for doxygen 1.8.10--> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4<head> 5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 6<meta http-equiv="X-UA-Compatible" content="IE=9"/> 7<meta name="generator" content="Doxygen 1.8.14"/> 8<title>Intel® Enhanced Privacy ID SDK: fileparser</title> 9<link href="tabs.css" rel="stylesheet" type="text/css"/> 10<script type="text/javascript" src="jquery.js"></script> 11<script type="text/javascript" src="dynsections.js"></script> 12<link href="navtree.css" rel="stylesheet" type="text/css"/> 13<script type="text/javascript" src="resize.js"></script> 14<script type="text/javascript" src="navtreedata.js"></script> 15<script type="text/javascript" src="navtree.js"></script> 16<script type="text/javascript"> 17/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 18 $(document).ready(initResizable); 19/* @license-end */</script> 20<link href="doxygen.css" rel="stylesheet" type="text/css" /> 21<link href="epidstyle.css" rel="stylesheet" type="text/css"/> 22</head> 23<body> 24<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 25<div id="titlearea"> 26<table cellspacing="0" cellpadding="0"> 27 <tbody> 28 <tr style="height: 56px;"> 29 <td id="projectalign" style="padding-left: 0.5em;"> 30 <div id="projectname"><a 31 onclick="storeLink('index.html')" 32 id="projectlink" 33 class="index.html" 34 href="index.html">Intel® Enhanced Privacy ID SDK</a> 35 <span id="projectnumber">6.0.1</span> 36</div> 37 </td> 38 </tr> 39 </tbody> 40</table> 41</div> 42<!-- end header part --> 43<!-- Generated by Doxygen 1.8.14 --> 44</div><!-- top --> 45<div id="side-nav" class="ui-resizable side-nav-resizable"> 46 <div id="nav-tree"> 47 <div id="nav-tree-contents"> 48 <div id="nav-sync" class="sync"></div> 49 </div> 50 </div> 51 <div id="splitbar" style="-moz-user-select:none;" 52 class="ui-resizable-handle"> 53 </div> 54</div> 55<script type="text/javascript"> 56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 57$(document).ready(function(){initNavTree('group___file_parser.html','');}); 58/* @license-end */ 59</script> 60<div id="doc-content"> 61<div class="header"> 62 <div class="summary"> 63<a href="#groups">Modules</a> | 64<a href="#nested-classes">Data Structures</a> | 65<a href="#enum-members">Enumerations</a> | 66<a href="#func-members">Functions</a> | 67<a href="#var-members">Variables</a> </div> 68 <div class="headertitle"> 69<div class="title">fileparser<div class="ingroups"><a class="el" href="group___epid_module.html">epid&nbsp;</a> » <a class="el" href="group___epid_common.html">common</a></div></div> </div> 70</div><!--header--> 71<div class="contents"> 72 73<p>Parser for issuer material. 74<a href="#details">More...</a></p> 75<table class="memberdecls"> 76<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> 77Modules</h2></td></tr> 78<tr class="memitem:group___epid11_file_parser_module"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___epid11_file_parser_module.html">Intel(R) EPID 1.1 support</a></td></tr> 79<tr class="memdesc:group___epid11_file_parser_module"><td class="mdescLeft"> </td><td class="mdescRight">Parser for 1.1 issuer material. <br /></td></tr> 80<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 81</table><table class="memberdecls"> 82<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> 83Data Structures</h2></td></tr> 84<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_epid_file_header.html">EpidFileHeader</a></td></tr> 85<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Intel(R) EPID binary file header. <a href="struct_epid_file_header.html#details">More...</a><br /></td></tr> 86<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 87<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_epid_ca_certificate.html">EpidCaCertificate</a></td></tr> 88<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">IoT CA Certificate binary format. <a href="struct_epid_ca_certificate.html#details">More...</a><br /></td></tr> 89<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 90</table><table class="memberdecls"> 91<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> 92Enumerations</h2></td></tr> 93<tr class="memitem:ga1562efc7c1891875d6b2b9180d65de9d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group___file_parser.html#ga1562efc7c1891875d6b2b9180d65de9d">EpidVersion</a> { <a class="el" href="group___file_parser.html#gga1562efc7c1891875d6b2b9180d65de9da5f270e2e8c2412bc07de293023f425cc">kEpid1x</a>, 94<a class="el" href="group___file_parser.html#gga1562efc7c1891875d6b2b9180d65de9da6af0ee9d9689f1d4325bdd0beb8a89e2">kEpid2x</a>, 95<a class="el" href="group___file_parser.html#gga1562efc7c1891875d6b2b9180d65de9da8bbd27765997dd10f1c0378dbecef01d">kNumEpidVersions</a> 96 }</td></tr> 97<tr class="memdesc:ga1562efc7c1891875d6b2b9180d65de9d"><td class="mdescLeft"> </td><td class="mdescRight">Recognized Intel(R) EPID versions. <a href="group___file_parser.html#ga1562efc7c1891875d6b2b9180d65de9d">More...</a><br /></td></tr> 98<tr class="separator:ga1562efc7c1891875d6b2b9180d65de9d"><td class="memSeparator" colspan="2"> </td></tr> 99<tr class="memitem:ga9a33be7edc6b4c7a867fb07bd2bddecb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group___file_parser.html#ga9a33be7edc6b4c7a867fb07bd2bddecb">EpidFileType</a> { <br /> 100  <a class="el" href="group___file_parser.html#gga9a33be7edc6b4c7a867fb07bd2bddecbac24554caafe2db01e2daed413188cd92">kIssuingCaPubKeyFile</a>, 101<a class="el" href="group___file_parser.html#gga9a33be7edc6b4c7a867fb07bd2bddecba1f8d8c4b253403a35c51e05d34a7ca1e">kGroupPubKeyFile</a>, 102<a class="el" href="group___file_parser.html#gga9a33be7edc6b4c7a867fb07bd2bddecba692b4141bff8225bee6000750b0da322">kPrivRlFile</a>, 103<a class="el" href="group___file_parser.html#gga9a33be7edc6b4c7a867fb07bd2bddecba8aead4b6aab87a1efb2d7e8c77a9b710">kSigRlFile</a>, 104<br /> 105  <a class="el" href="group___file_parser.html#gga9a33be7edc6b4c7a867fb07bd2bddecba8e5247daee3999540e6cb24d4c2b3770">kGroupRlFile</a>, 106<a class="el" href="group___file_parser.html#gga9a33be7edc6b4c7a867fb07bd2bddecbac708ba9e56eaeac0f1256457cbd45911">kPrivRlRequestFile</a>, 107<a class="el" href="group___file_parser.html#gga9a33be7edc6b4c7a867fb07bd2bddecbac52e5fe24a12424316f655b9b7c62600">kSigRlRequestFile</a>, 108<a class="el" href="group___file_parser.html#gga9a33be7edc6b4c7a867fb07bd2bddecbab772fa1e3f221af125ffb34b86b3f24c">kGroupRlRequestFile</a>, 109<br /> 110  <a class="el" href="group___file_parser.html#gga9a33be7edc6b4c7a867fb07bd2bddecbac6d742ea3dd3b17f6d763970ac84b811">kNumFileTypes</a> 111<br /> 112 }</td></tr> 113<tr class="memdesc:ga9a33be7edc6b4c7a867fb07bd2bddecb"><td class="mdescLeft"> </td><td class="mdescRight">Recognized Intel(R) EPID file types. <a href="group___file_parser.html#ga9a33be7edc6b4c7a867fb07bd2bddecb">More...</a><br /></td></tr> 114<tr class="separator:ga9a33be7edc6b4c7a867fb07bd2bddecb"><td class="memSeparator" colspan="2"> </td></tr> 115</table><table class="memberdecls"> 116<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 117Functions</h2></td></tr> 118<tr class="memitem:ga8e38d1102eb1dd9b5af2e2f79236da55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___file_parser.html#ga8e38d1102eb1dd9b5af2e2f79236da55">EpidParseFileHeader</a> (void const *buf, size_t len, <a class="el" href="group___file_parser.html#ga1562efc7c1891875d6b2b9180d65de9d">EpidVersion</a> *epid_version, <a class="el" href="group___file_parser.html#ga9a33be7edc6b4c7a867fb07bd2bddecb">EpidFileType</a> *file_type)</td></tr> 119<tr class="memdesc:ga8e38d1102eb1dd9b5af2e2f79236da55"><td class="mdescLeft"> </td><td class="mdescRight">Extracts Intel(R) EPID Binary Output File header information. <a href="#ga8e38d1102eb1dd9b5af2e2f79236da55">More...</a><br /></td></tr> 120<tr class="separator:ga8e38d1102eb1dd9b5af2e2f79236da55"><td class="memSeparator" colspan="2"> </td></tr> 121<tr class="memitem:ga43fdbc1bf2edd3695d21cb457365afbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___file_parser.html#ga43fdbc1bf2edd3695d21cb457365afbb">EpidParseGroupPubKeyFile</a> (void const *buf, size_t len, <a class="el" href="struct_epid_ca_certificate.html">EpidCaCertificate</a> const *cert, <a class="el" href="struct_group_pub_key.html">GroupPubKey</a> *pubkey)</td></tr> 122<tr class="memdesc:ga43fdbc1bf2edd3695d21cb457365afbb"><td class="mdescLeft"> </td><td class="mdescRight">Extracts group public key from buffer in issuer binary format. <a href="#ga43fdbc1bf2edd3695d21cb457365afbb">More...</a><br /></td></tr> 123<tr class="separator:ga43fdbc1bf2edd3695d21cb457365afbb"><td class="memSeparator" colspan="2"> </td></tr> 124<tr class="memitem:gadc033fb23e3cbda56aa7e3d412060b7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___file_parser.html#gadc033fb23e3cbda56aa7e3d412060b7e">EpidParsePrivRlFile</a> (void const *buf, size_t len, <a class="el" href="struct_epid_ca_certificate.html">EpidCaCertificate</a> const *cert, <a class="el" href="struct_priv_rl.html">PrivRl</a> *rl, size_t *rl_len)</td></tr> 125<tr class="memdesc:gadc033fb23e3cbda56aa7e3d412060b7e"><td class="mdescLeft"> </td><td class="mdescRight">Extracts private key revocation list from buffer in issuer binary format. <a href="#gadc033fb23e3cbda56aa7e3d412060b7e">More...</a><br /></td></tr> 126<tr class="separator:gadc033fb23e3cbda56aa7e3d412060b7e"><td class="memSeparator" colspan="2"> </td></tr> 127<tr class="memitem:ga237ef5a43076aa6fc6eb18829a93da3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___file_parser.html#ga237ef5a43076aa6fc6eb18829a93da3f">EpidParseSigRlFile</a> (void const *buf, size_t len, <a class="el" href="struct_epid_ca_certificate.html">EpidCaCertificate</a> const *cert, <a class="el" href="struct_sig_rl.html">SigRl</a> *rl, size_t *rl_len)</td></tr> 128<tr class="memdesc:ga237ef5a43076aa6fc6eb18829a93da3f"><td class="mdescLeft"> </td><td class="mdescRight">Extracts signature revocation list from buffer in issuer binary format. <a href="#ga237ef5a43076aa6fc6eb18829a93da3f">More...</a><br /></td></tr> 129<tr class="separator:ga237ef5a43076aa6fc6eb18829a93da3f"><td class="memSeparator" colspan="2"> </td></tr> 130<tr class="memitem:gad767f72dc55307b872a8b5600da3fd6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___file_parser.html#gad767f72dc55307b872a8b5600da3fd6f">EpidParseGroupRlFile</a> (void const *buf, size_t len, <a class="el" href="struct_epid_ca_certificate.html">EpidCaCertificate</a> const *cert, <a class="el" href="struct_group_rl.html">GroupRl</a> *rl, size_t *rl_len)</td></tr> 131<tr class="memdesc:gad767f72dc55307b872a8b5600da3fd6f"><td class="mdescLeft"> </td><td class="mdescRight">Extracts group revocation list from buffer in issuer binary format. <a href="#gad767f72dc55307b872a8b5600da3fd6f">More...</a><br /></td></tr> 132<tr class="separator:gad767f72dc55307b872a8b5600da3fd6f"><td class="memSeparator" colspan="2"> </td></tr> 133</table><table class="memberdecls"> 134<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> 135Variables</h2></td></tr> 136<tr class="memitem:gaae808987ce82188dff42baa4e43cab82"><td class="memItemLeft" align="right" valign="top"><a id="gaae808987ce82188dff42baa4e43cab82"></a> 137const <a class="el" href="struct_oct_str16.html">OctStr16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___file_parser.html#gaae808987ce82188dff42baa4e43cab82">kEpidVersionCode</a> [<a class="el" href="group___file_parser.html#gga1562efc7c1891875d6b2b9180d65de9da8bbd27765997dd10f1c0378dbecef01d">kNumEpidVersions</a>]</td></tr> 138<tr class="memdesc:gaae808987ce82188dff42baa4e43cab82"><td class="mdescLeft"> </td><td class="mdescRight">Encoding of issuer material Intel(R) EPID versions. <br /></td></tr> 139<tr class="separator:gaae808987ce82188dff42baa4e43cab82"><td class="memSeparator" colspan="2"> </td></tr> 140<tr class="memitem:ga3770c39a0546c79447c9d4159d794c33"><td class="memItemLeft" align="right" valign="top"><a id="ga3770c39a0546c79447c9d4159d794c33"></a> 141const <a class="el" href="struct_oct_str16.html">OctStr16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___file_parser.html#ga3770c39a0546c79447c9d4159d794c33">kEpidFileTypeCode</a> [<a class="el" href="group___file_parser.html#gga9a33be7edc6b4c7a867fb07bd2bddecbac6d742ea3dd3b17f6d763970ac84b811">kNumFileTypes</a>]</td></tr> 142<tr class="memdesc:ga3770c39a0546c79447c9d4159d794c33"><td class="mdescLeft"> </td><td class="mdescRight">Encoding of issuer material file types. <br /></td></tr> 143<tr class="separator:ga3770c39a0546c79447c9d4159d794c33"><td class="memSeparator" colspan="2"> </td></tr> 144</table> 145<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 146<p>Parser for issuer material. </p> 147<p>Provides an API for parsing buffers formatted according to the various IoT Intel(R) EPID binary file formats.</p> 148<p>To use this module, include the header <a class="el" href="file__parser_8h.html" title="Intel(R) EPID issuer material parsing utilities. ">epid/common/file_parser.h</a>. </p> 149<h2 class="groupheader">Enumeration Type Documentation</h2> 150<a id="ga9a33be7edc6b4c7a867fb07bd2bddecb"></a> 151<h2 class="memtitle"><span class="permalink"><a href="#ga9a33be7edc6b4c7a867fb07bd2bddecb">◆ </a></span>EpidFileType</h2> 152 153<div class="memitem"> 154<div class="memproto"> 155 <table class="memname"> 156 <tr> 157 <td class="memname">enum <a class="el" href="group___file_parser.html#ga9a33be7edc6b4c7a867fb07bd2bddecb">EpidFileType</a></td> 158 </tr> 159 </table> 160</div><div class="memdoc"> 161 162<p>Recognized Intel(R) EPID file types. </p> 163<table class="fieldtable"> 164<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9a33be7edc6b4c7a867fb07bd2bddecbac24554caafe2db01e2daed413188cd92"></a>kIssuingCaPubKeyFile </td><td class="fielddoc"><p>IoT Issuing CA public key file. </p> 165</td></tr> 166<tr><td class="fieldname"><a id="gga9a33be7edc6b4c7a867fb07bd2bddecba1f8d8c4b253403a35c51e05d34a7ca1e"></a>kGroupPubKeyFile </td><td class="fielddoc"><p>Group Public Key Output File Format. </p> 167</td></tr> 168<tr><td class="fieldname"><a id="gga9a33be7edc6b4c7a867fb07bd2bddecba692b4141bff8225bee6000750b0da322"></a>kPrivRlFile </td><td class="fielddoc"><p>Binary Private Key Revocation List. </p> 169</td></tr> 170<tr><td class="fieldname"><a id="gga9a33be7edc6b4c7a867fb07bd2bddecba8aead4b6aab87a1efb2d7e8c77a9b710"></a>kSigRlFile </td><td class="fielddoc"><p>Binary Signature Revocation List. </p> 171</td></tr> 172<tr><td class="fieldname"><a id="gga9a33be7edc6b4c7a867fb07bd2bddecba8e5247daee3999540e6cb24d4c2b3770"></a>kGroupRlFile </td><td class="fielddoc"><p>Binary Group Revocation List. </p> 173</td></tr> 174<tr><td class="fieldname"><a id="gga9a33be7edc6b4c7a867fb07bd2bddecbac708ba9e56eaeac0f1256457cbd45911"></a>kPrivRlRequestFile </td><td class="fielddoc"><p>Binary Private Key Revocation Request. </p> 175</td></tr> 176<tr><td class="fieldname"><a id="gga9a33be7edc6b4c7a867fb07bd2bddecbac52e5fe24a12424316f655b9b7c62600"></a>kSigRlRequestFile </td><td class="fielddoc"><p>Binary Signature Revocation Request. </p> 177</td></tr> 178<tr><td class="fieldname"><a id="gga9a33be7edc6b4c7a867fb07bd2bddecbab772fa1e3f221af125ffb34b86b3f24c"></a>kGroupRlRequestFile </td><td class="fielddoc"><p>Binary Group Revocation Request. </p> 179</td></tr> 180<tr><td class="fieldname"><a id="gga9a33be7edc6b4c7a867fb07bd2bddecbac6d742ea3dd3b17f6d763970ac84b811"></a>kNumFileTypes </td><td class="fielddoc"><p>Maximum number of file types. </p> 181</td></tr> 182</table> 183 184</div> 185</div> 186<a id="ga1562efc7c1891875d6b2b9180d65de9d"></a> 187<h2 class="memtitle"><span class="permalink"><a href="#ga1562efc7c1891875d6b2b9180d65de9d">◆ </a></span>EpidVersion</h2> 188 189<div class="memitem"> 190<div class="memproto"> 191 <table class="memname"> 192 <tr> 193 <td class="memname">enum <a class="el" href="group___file_parser.html#ga1562efc7c1891875d6b2b9180d65de9d">EpidVersion</a></td> 194 </tr> 195 </table> 196</div><div class="memdoc"> 197 198<p>Recognized Intel(R) EPID versions. </p> 199<table class="fieldtable"> 200<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga1562efc7c1891875d6b2b9180d65de9da5f270e2e8c2412bc07de293023f425cc"></a>kEpid1x </td><td class="fielddoc"><p>Intel(R) EPID version 1.x. </p> 201</td></tr> 202<tr><td class="fieldname"><a id="gga1562efc7c1891875d6b2b9180d65de9da6af0ee9d9689f1d4325bdd0beb8a89e2"></a>kEpid2x </td><td class="fielddoc"><p>Intel(R) EPID version 2.x. </p> 203</td></tr> 204<tr><td class="fieldname"><a id="gga1562efc7c1891875d6b2b9180d65de9da8bbd27765997dd10f1c0378dbecef01d"></a>kNumEpidVersions </td><td class="fielddoc"><p>Maximum number of versions. </p> 205</td></tr> 206</table> 207 208</div> 209</div> 210<h2 class="groupheader">Function Documentation</h2> 211<a id="ga8e38d1102eb1dd9b5af2e2f79236da55"></a> 212<h2 class="memtitle"><span class="permalink"><a href="#ga8e38d1102eb1dd9b5af2e2f79236da55">◆ </a></span>EpidParseFileHeader()</h2> 213 214<div class="memitem"> 215<div class="memproto"> 216 <table class="memname"> 217 <tr> 218 <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> EpidParseFileHeader </td> 219 <td>(</td> 220 <td class="paramtype">void const * </td> 221 <td class="paramname"><em>buf</em>, </td> 222 </tr> 223 <tr> 224 <td class="paramkey"></td> 225 <td></td> 226 <td class="paramtype">size_t </td> 227 <td class="paramname"><em>len</em>, </td> 228 </tr> 229 <tr> 230 <td class="paramkey"></td> 231 <td></td> 232 <td class="paramtype"><a class="el" href="group___file_parser.html#ga1562efc7c1891875d6b2b9180d65de9d">EpidVersion</a> * </td> 233 <td class="paramname"><em>epid_version</em>, </td> 234 </tr> 235 <tr> 236 <td class="paramkey"></td> 237 <td></td> 238 <td class="paramtype"><a class="el" href="group___file_parser.html#ga9a33be7edc6b4c7a867fb07bd2bddecb">EpidFileType</a> * </td> 239 <td class="paramname"><em>file_type</em> </td> 240 </tr> 241 <tr> 242 <td></td> 243 <td>)</td> 244 <td></td><td></td> 245 </tr> 246 </table> 247</div><div class="memdoc"> 248 249<p>Extracts Intel(R) EPID Binary Output File header information. </p> 250<dl class="params"><dt>Parameters</dt><dd> 251 <table class="params"> 252 <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to buffer containing Intel(R) EPID Binary Output File to parse.</td></tr> 253 <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The size of buf in bytes.</td></tr> 254 <tr><td class="paramdir">[out]</td><td class="paramname">epid_version</td><td>The extracted Intel(R) EPID version or kNumEpidVersions if Intel(R) EPID version is unknown. Pass NULL to not extract.</td></tr> 255 <tr><td class="paramdir">[out]</td><td class="paramname">file_type</td><td>The extracted Intel(R) EPID file type or kNumFileTypes if file type is unknown. Pass NULL to not extract.</td></tr> 256 </table> 257 </dd> 258</dl> 259<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a> </dd></dl> 260 261</div> 262</div> 263<a id="ga43fdbc1bf2edd3695d21cb457365afbb"></a> 264<h2 class="memtitle"><span class="permalink"><a href="#ga43fdbc1bf2edd3695d21cb457365afbb">◆ </a></span>EpidParseGroupPubKeyFile()</h2> 265 266<div class="memitem"> 267<div class="memproto"> 268 <table class="memname"> 269 <tr> 270 <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> EpidParseGroupPubKeyFile </td> 271 <td>(</td> 272 <td class="paramtype">void const * </td> 273 <td class="paramname"><em>buf</em>, </td> 274 </tr> 275 <tr> 276 <td class="paramkey"></td> 277 <td></td> 278 <td class="paramtype">size_t </td> 279 <td class="paramname"><em>len</em>, </td> 280 </tr> 281 <tr> 282 <td class="paramkey"></td> 283 <td></td> 284 <td class="paramtype"><a class="el" href="struct_epid_ca_certificate.html">EpidCaCertificate</a> const * </td> 285 <td class="paramname"><em>cert</em>, </td> 286 </tr> 287 <tr> 288 <td class="paramkey"></td> 289 <td></td> 290 <td class="paramtype"><a class="el" href="struct_group_pub_key.html">GroupPubKey</a> * </td> 291 <td class="paramname"><em>pubkey</em> </td> 292 </tr> 293 <tr> 294 <td></td> 295 <td>)</td> 296 <td></td><td></td> 297 </tr> 298 </table> 299</div><div class="memdoc"> 300 301<p>Extracts group public key from buffer in issuer binary format. </p> 302<p>Extracts the first group public key from a buffer with format of Intel(R) EPID 2.0 Group Public Key Certificate Binary File. The function validates that the first public key was signed by the private key corresponding to the provided CA certificate and the size of the input buffer is correct.</p> 303<dl class="section warning"><dt>Warning</dt><dd>It is the responsibility of the caller to authenticate the <a class="el" href="struct_epid_ca_certificate.html" title="IoT CA Certificate binary format. ">EpidCaCertificate</a>.</dd></dl> 304<dl class="params"><dt>Parameters</dt><dd> 305 <table class="params"> 306 <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to buffer containing public key to extract.</td></tr> 307 <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The size of buf in bytes.</td></tr> 308 <tr><td class="paramdir">[in]</td><td class="paramname">cert</td><td>The issuing CA public key certificate.</td></tr> 309 <tr><td class="paramdir">[out]</td><td class="paramname">pubkey</td><td>The extracted group public key.</td></tr> 310 </table> 311 </dd> 312</dl> 313<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a></dd></dl> 314<dl class="retval"><dt>Return values</dt><dd> 315 <table class="retval"> 316 <tr><td class="paramname"><a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aeedd19b8a1cbdecf963f90b4860e02b8" title="Signature is invalid. ">kEpidSigInvalid</a></td><td>Parsing failed due to data authentication failure.</td></tr> 317 </table> 318 </dd> 319</dl> 320<p><b>Examples</b> </p> 321<p><a class="el" href="_user_manual__generating_an_intel_epid_signature.html">Generating an Intel® EPID Signature</a> </p> 322 323</div> 324</div> 325<a id="gad767f72dc55307b872a8b5600da3fd6f"></a> 326<h2 class="memtitle"><span class="permalink"><a href="#gad767f72dc55307b872a8b5600da3fd6f">◆ </a></span>EpidParseGroupRlFile()</h2> 327 328<div class="memitem"> 329<div class="memproto"> 330 <table class="memname"> 331 <tr> 332 <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> EpidParseGroupRlFile </td> 333 <td>(</td> 334 <td class="paramtype">void const * </td> 335 <td class="paramname"><em>buf</em>, </td> 336 </tr> 337 <tr> 338 <td class="paramkey"></td> 339 <td></td> 340 <td class="paramtype">size_t </td> 341 <td class="paramname"><em>len</em>, </td> 342 </tr> 343 <tr> 344 <td class="paramkey"></td> 345 <td></td> 346 <td class="paramtype"><a class="el" href="struct_epid_ca_certificate.html">EpidCaCertificate</a> const * </td> 347 <td class="paramname"><em>cert</em>, </td> 348 </tr> 349 <tr> 350 <td class="paramkey"></td> 351 <td></td> 352 <td class="paramtype"><a class="el" href="struct_group_rl.html">GroupRl</a> * </td> 353 <td class="paramname"><em>rl</em>, </td> 354 </tr> 355 <tr> 356 <td class="paramkey"></td> 357 <td></td> 358 <td class="paramtype">size_t * </td> 359 <td class="paramname"><em>rl_len</em> </td> 360 </tr> 361 <tr> 362 <td></td> 363 <td>)</td> 364 <td></td><td></td> 365 </tr> 366 </table> 367</div><div class="memdoc"> 368 369<p>Extracts group revocation list from buffer in issuer binary format. </p> 370<p>Extracts the group revocation list from a buffer with format of Binary Group Certificate Revocation List File. The function validates that the revocation list was signed by the private key corresponding to the provided CA certificate and the size of the input buffer is correct.</p> 371<p>To determine the required size of the revocation list output buffer, provide a null pointer for the output buffer.</p> 372<dl class="section warning"><dt>Warning</dt><dd>It is the responsibility of the caller to authenticate the <a class="el" href="struct_epid_ca_certificate.html" title="IoT CA Certificate binary format. ">EpidCaCertificate</a>.</dd></dl> 373<dl class="params"><dt>Parameters</dt><dd> 374 <table class="params"> 375 <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to buffer containing the revocation list to extract.</td></tr> 376 <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The size of buf in bytes.</td></tr> 377 <tr><td class="paramdir">[in]</td><td class="paramname">cert</td><td>The issuing CA public key certificate.</td></tr> 378 <tr><td class="paramdir">[out]</td><td class="paramname">rl</td><td>The extracted revocation list. If Null, rl_len is filled with the required output buffer size.</td></tr> 379 <tr><td class="paramdir">[in,out]</td><td class="paramname">rl_len</td><td>The size of rl in bytes.</td></tr> 380 </table> 381 </dd> 382</dl> 383<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a></dd></dl> 384<dl class="retval"><dt>Return values</dt><dd> 385 <table class="retval"> 386 <tr><td class="paramname"><a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aeedd19b8a1cbdecf963f90b4860e02b8" title="Signature is invalid. ">kEpidSigInvalid</a></td><td>Parsing failed due to data authentication failure.</td></tr> 387 </table> 388 </dd> 389</dl> 390<p><b>Example</b> </p> 391<p><a class="el" href="_user_manual__verifying_an_intel_epid_signature.html">Verifying an Intel® EPID Signature</a> </p> 392 393</div> 394</div> 395<a id="gadc033fb23e3cbda56aa7e3d412060b7e"></a> 396<h2 class="memtitle"><span class="permalink"><a href="#gadc033fb23e3cbda56aa7e3d412060b7e">◆ </a></span>EpidParsePrivRlFile()</h2> 397 398<div class="memitem"> 399<div class="memproto"> 400 <table class="memname"> 401 <tr> 402 <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> EpidParsePrivRlFile </td> 403 <td>(</td> 404 <td class="paramtype">void const * </td> 405 <td class="paramname"><em>buf</em>, </td> 406 </tr> 407 <tr> 408 <td class="paramkey"></td> 409 <td></td> 410 <td class="paramtype">size_t </td> 411 <td class="paramname"><em>len</em>, </td> 412 </tr> 413 <tr> 414 <td class="paramkey"></td> 415 <td></td> 416 <td class="paramtype"><a class="el" href="struct_epid_ca_certificate.html">EpidCaCertificate</a> const * </td> 417 <td class="paramname"><em>cert</em>, </td> 418 </tr> 419 <tr> 420 <td class="paramkey"></td> 421 <td></td> 422 <td class="paramtype"><a class="el" href="struct_priv_rl.html">PrivRl</a> * </td> 423 <td class="paramname"><em>rl</em>, </td> 424 </tr> 425 <tr> 426 <td class="paramkey"></td> 427 <td></td> 428 <td class="paramtype">size_t * </td> 429 <td class="paramname"><em>rl_len</em> </td> 430 </tr> 431 <tr> 432 <td></td> 433 <td>)</td> 434 <td></td><td></td> 435 </tr> 436 </table> 437</div><div class="memdoc"> 438 439<p>Extracts private key revocation list from buffer in issuer binary format. </p> 440<p>Extracts the private key revocation list from a buffer with format of Binary Private Key Revocation List File. The function validates that the revocation list was signed by the private key corresponding to the provided CA certificate and the size of the input buffer is correct.</p> 441<p>To determine the required size of the revocation list output buffer, provide a null pointer for the output buffer.</p> 442<dl class="section warning"><dt>Warning</dt><dd>It is the responsibility of the caller to authenticate the <a class="el" href="struct_epid_ca_certificate.html" title="IoT CA Certificate binary format. ">EpidCaCertificate</a>.</dd></dl> 443<dl class="params"><dt>Parameters</dt><dd> 444 <table class="params"> 445 <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to buffer containing the revocation list to extract.</td></tr> 446 <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The size of buf in bytes.</td></tr> 447 <tr><td class="paramdir">[in]</td><td class="paramname">cert</td><td>The issuing CA public key certificate.</td></tr> 448 <tr><td class="paramdir">[out]</td><td class="paramname">rl</td><td>The extracted revocation list. If Null, rl_len is filled with the required output buffer size.</td></tr> 449 <tr><td class="paramdir">[in,out]</td><td class="paramname">rl_len</td><td>The size of rl in bytes.</td></tr> 450 </table> 451 </dd> 452</dl> 453<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a></dd></dl> 454<dl class="retval"><dt>Return values</dt><dd> 455 <table class="retval"> 456 <tr><td class="paramname"><a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aeedd19b8a1cbdecf963f90b4860e02b8" title="Signature is invalid. ">kEpidSigInvalid</a></td><td>Parsing failed due to data authentication failure.</td></tr> 457 </table> 458 </dd> 459</dl> 460<p><b>Example</b> </p> 461<p><a class="el" href="_user_manual__verifying_an_intel_epid_signature.html">Verifying an Intel® EPID Signature</a> </p> 462 463</div> 464</div> 465<a id="ga237ef5a43076aa6fc6eb18829a93da3f"></a> 466<h2 class="memtitle"><span class="permalink"><a href="#ga237ef5a43076aa6fc6eb18829a93da3f">◆ </a></span>EpidParseSigRlFile()</h2> 467 468<div class="memitem"> 469<div class="memproto"> 470 <table class="memname"> 471 <tr> 472 <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> EpidParseSigRlFile </td> 473 <td>(</td> 474 <td class="paramtype">void const * </td> 475 <td class="paramname"><em>buf</em>, </td> 476 </tr> 477 <tr> 478 <td class="paramkey"></td> 479 <td></td> 480 <td class="paramtype">size_t </td> 481 <td class="paramname"><em>len</em>, </td> 482 </tr> 483 <tr> 484 <td class="paramkey"></td> 485 <td></td> 486 <td class="paramtype"><a class="el" href="struct_epid_ca_certificate.html">EpidCaCertificate</a> const * </td> 487 <td class="paramname"><em>cert</em>, </td> 488 </tr> 489 <tr> 490 <td class="paramkey"></td> 491 <td></td> 492 <td class="paramtype"><a class="el" href="struct_sig_rl.html">SigRl</a> * </td> 493 <td class="paramname"><em>rl</em>, </td> 494 </tr> 495 <tr> 496 <td class="paramkey"></td> 497 <td></td> 498 <td class="paramtype">size_t * </td> 499 <td class="paramname"><em>rl_len</em> </td> 500 </tr> 501 <tr> 502 <td></td> 503 <td>)</td> 504 <td></td><td></td> 505 </tr> 506 </table> 507</div><div class="memdoc"> 508 509<p>Extracts signature revocation list from buffer in issuer binary format. </p> 510<p>Extracts the signature based revocation list from a buffer with format of Binary Signature Revocation List File. The function validates that the revocation list was signed by the private key corresponding to the provided CA certificate and the size of the input buffer is correct.</p> 511<p>To determine the required size of the revocation list output buffer, provide a null pointer for the output buffer.</p> 512<dl class="section warning"><dt>Warning</dt><dd>It is the responsibility of the caller to authenticate the <a class="el" href="struct_epid_ca_certificate.html" title="IoT CA Certificate binary format. ">EpidCaCertificate</a>.</dd></dl> 513<dl class="params"><dt>Parameters</dt><dd> 514 <table class="params"> 515 <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to buffer containing the revocation list to extract.</td></tr> 516 <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The size of buf in bytes.</td></tr> 517 <tr><td class="paramdir">[in]</td><td class="paramname">cert</td><td>The issuing CA public key certificate.</td></tr> 518 <tr><td class="paramdir">[out]</td><td class="paramname">rl</td><td>The extracted revocation list. If Null, rl_len is filled with the required output buffer size.</td></tr> 519 <tr><td class="paramdir">[in,out]</td><td class="paramname">rl_len</td><td>The size of rl in bytes.</td></tr> 520 </table> 521 </dd> 522</dl> 523<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a></dd></dl> 524<dl class="retval"><dt>Return values</dt><dd> 525 <table class="retval"> 526 <tr><td class="paramname"><a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aeedd19b8a1cbdecf963f90b4860e02b8" title="Signature is invalid. ">kEpidSigInvalid</a></td><td>Parsing failed due to data authentication failure.</td></tr> 527 </table> 528 </dd> 529</dl> 530<p><b>Examples</b> </p> 531<p><a class="el" href="_user_manual__generating_an_intel_epid_signature.html">Generating an Intel® EPID Signature</a> </p> 532 533</div> 534</div> 535</div><!-- contents --> 536</div><!-- doc-content --> 537<!-- HTML footer for doxygen 1.8.10--> 538<!-- start footer part --> 539<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 540 <ul> 541 <li class="footer"> 542 © 2016-2017 Intel Corporation 543 </li> 544 </ul> 545</div> 546</body> 547</html> 548