jwe_8h_source.html 18 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>José: /home/nmccallu/Projects/jose/jose/jwe.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">José
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.13 -->
  33. <script type="text/javascript">
  34. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  35. </script>
  36. <script type="text/javascript" src="menudata.js"></script>
  37. <script type="text/javascript" src="menu.js"></script>
  38. <script type="text/javascript">
  39. $(function() {
  40. initMenu('',true,false,'search.php','Search');
  41. $(document).ready(function() { init_search(); });
  42. });
  43. </script>
  44. <div id="main-nav"></div>
  45. <!-- window showing the filter options -->
  46. <div id="MSearchSelectWindow"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. onkeydown="return searchBox.OnSearchSelectKey(event)">
  50. </div>
  51. <!-- iframe showing the search results (closed by default) -->
  52. <div id="MSearchResultsWindow">
  53. <iframe src="javascript:void(0)" frameborder="0"
  54. name="MSearchResults" id="MSearchResults">
  55. </iframe>
  56. </div>
  57. <div id="nav-path" class="navpath">
  58. <ul>
  59. <li class="navelem"><a class="el" href="dir_f2bd36b8a3f3d476e48bdb5015c9fdfb.html">jose</a></li> </ul>
  60. </div>
  61. </div><!-- top -->
  62. <div class="header">
  63. <div class="headertitle">
  64. <div class="title">jwe.h</div> </div>
  65. </div><!--header-->
  66. <div class="contents">
  67. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* vim: set tabstop=8 shiftwidth=4 softtabstop=4 expandtab smarttab colorcolumn=80: */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2016 Red Hat, Inc.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="preprocessor">#include &quot;cfg.h&quot;</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="preprocessor">#include &quot;io.h&quot;</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="preprocessor">#include &lt;jansson.h&gt;</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="preprocessor">#include &lt;stdbool.h&gt;</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;json_t *</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;<a class="code" href="group__jose__jwe.html#ga5920b450d6f4b0aa1729a7230a48fb32">jose_jwe_hdr</a>(<span class="keyword">const</span> json_t *jwe, <span class="keyword">const</span> json_t *rcp);</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;<span class="keywordtype">bool</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;<a class="code" href="group__jose__jwe.html#ga67fd2b695bfff58a3b7adaf6bce9a773">jose_jwe_enc</a>(jose_cfg_t *cfg, json_t *jwe, json_t *rcp, <span class="keyword">const</span> json_t *jwk,</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; <span class="keyword">const</span> <span class="keywordtype">void</span> *pt, <span class="keywordtype">size_t</span> ptl);</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;<a class="code" href="structjose__io__t.html">jose_io_t</a> *</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;<a class="code" href="group__jose__jwe.html#ga27e44e2144dc81b778158163661b7f9f">jose_jwe_enc_io</a>(jose_cfg_t *cfg, json_t *jwe, json_t *rcp, <span class="keyword">const</span> json_t *jwk,</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; <a class="code" href="structjose__io__t.html">jose_io_t</a> *next);</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;<span class="keywordtype">bool</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160;<a class="code" href="group__jose__jwe.html#ga6cebc627dea8bb944d35acb776abe769">jose_jwe_enc_jwk</a>(jose_cfg_t *cfg, json_t *jwe, json_t *rcp, <span class="keyword">const</span> json_t *jwk,</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160; json_t *cek);</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160;</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;<span class="keywordtype">bool</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160;<a class="code" href="group__jose__jwe.html#ga885caaa8a0f24bcbdf283478b26b614d">jose_jwe_enc_cek</a>(jose_cfg_t *cfg, json_t *jwe, <span class="keyword">const</span> json_t *cek,</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160; <span class="keyword">const</span> <span class="keywordtype">void</span> *pt, <span class="keywordtype">size_t</span> ptl);</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160;</div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160;<a class="code" href="structjose__io__t.html">jose_io_t</a> *</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160;<a class="code" href="group__jose__jwe.html#gae484a56237a35f5c18038a1b24952f0a">jose_jwe_enc_cek_io</a>(jose_cfg_t *cfg, json_t *jwe, <span class="keyword">const</span> json_t *cek,</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160; <a class="code" href="structjose__io__t.html">jose_io_t</a> *next);</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160;</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160;<span class="keywordtype">void</span> *</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160;<a class="code" href="group__jose__jwe.html#gac873b95e6fad75e2d517970a94346c5d">jose_jwe_dec</a>(jose_cfg_t *cfg, <span class="keyword">const</span> json_t *jwe, <span class="keyword">const</span> json_t *rcp,</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; <span class="keyword">const</span> json_t *jwk, <span class="keywordtype">size_t</span> *ptl);</div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160;</div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160;<a class="code" href="structjose__io__t.html">jose_io_t</a> *</div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160;<a class="code" href="group__jose__jwe.html#gacd3c7703b57c524bc2683f2c0d0db4b8">jose_jwe_dec_io</a>(jose_cfg_t *cfg, <span class="keyword">const</span> json_t *jwe, <span class="keyword">const</span> json_t *rcp,</div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160; <span class="keyword">const</span> json_t *jwk, <a class="code" href="structjose__io__t.html">jose_io_t</a> *next);</div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160;</div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160;json_t *</div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160;<a class="code" href="group__jose__jwe.html#gab9608cf23da17fadce6078aa2d862608">jose_jwe_dec_jwk</a>(jose_cfg_t *cfg, <span class="keyword">const</span> json_t *jwe, <span class="keyword">const</span> json_t *rcp,</div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160; <span class="keyword">const</span> json_t *jwk);</div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160;</div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160;<span class="keywordtype">void</span> *</div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160;<a class="code" href="group__jose__jwe.html#ga64b1b6074f8643aa301007fc125aed59">jose_jwe_dec_cek</a>(jose_cfg_t *cfg, <span class="keyword">const</span> json_t *jwe, <span class="keyword">const</span> json_t *cek,</div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160; <span class="keywordtype">size_t</span> *ptl);</div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160;</div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160;<a class="code" href="structjose__io__t.html">jose_io_t</a> *</div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160;<a class="code" href="group__jose__jwe.html#gaf22bbcd02627f938be28fa4b1778e29c">jose_jwe_dec_cek_io</a>(jose_cfg_t *cfg, <span class="keyword">const</span> json_t *jwe, <span class="keyword">const</span> json_t *cek,</div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160; <a class="code" href="structjose__io__t.html">jose_io_t</a> *next);</div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160;</div><div class="ttc" id="group__jose__jwe_html_gacd3c7703b57c524bc2683f2c0d0db4b8"><div class="ttname"><a href="group__jose__jwe.html#gacd3c7703b57c524bc2683f2c0d0db4b8">jose_jwe_dec_io</a></div><div class="ttdeci">jose_io_t * jose_jwe_dec_io(jose_cfg_t *cfg, const json_t *jwe, const json_t *rcp, const json_t *jwk, jose_io_t *next)</div><div class="ttdoc">Unwraps and decrypts ciphertext using streaming. </div></div>
  68. <div class="ttc" id="group__jose__jwe_html_gab9608cf23da17fadce6078aa2d862608"><div class="ttname"><a href="group__jose__jwe.html#gab9608cf23da17fadce6078aa2d862608">jose_jwe_dec_jwk</a></div><div class="ttdeci">json_t * jose_jwe_dec_jwk(jose_cfg_t *cfg, const json_t *jwe, const json_t *rcp, const json_t *jwk)</div><div class="ttdoc">Unwraps a CEK with a JWK. </div></div>
  69. <div class="ttc" id="group__jose__jwe_html_gac873b95e6fad75e2d517970a94346c5d"><div class="ttname"><a href="group__jose__jwe.html#gac873b95e6fad75e2d517970a94346c5d">jose_jwe_dec</a></div><div class="ttdeci">void * jose_jwe_dec(jose_cfg_t *cfg, const json_t *jwe, const json_t *rcp, const json_t *jwk, size_t *ptl)</div><div class="ttdoc">Unwraps and decrypts ciphertext. </div></div>
  70. <div class="ttc" id="group__jose__jwe_html_ga885caaa8a0f24bcbdf283478b26b614d"><div class="ttname"><a href="group__jose__jwe.html#ga885caaa8a0f24bcbdf283478b26b614d">jose_jwe_enc_cek</a></div><div class="ttdeci">bool jose_jwe_enc_cek(jose_cfg_t *cfg, json_t *jwe, const json_t *cek, const void *pt, size_t ptl)</div><div class="ttdoc">Encrypts plaintext with the CEK. </div></div>
  71. <div class="ttc" id="group__jose__jwe_html_ga67fd2b695bfff58a3b7adaf6bce9a773"><div class="ttname"><a href="group__jose__jwe.html#ga67fd2b695bfff58a3b7adaf6bce9a773">jose_jwe_enc</a></div><div class="ttdeci">bool jose_jwe_enc(jose_cfg_t *cfg, json_t *jwe, json_t *rcp, const json_t *jwk, const void *pt, size_t ptl)</div><div class="ttdoc">Wraps and encrypts plaintext. </div></div>
  72. <div class="ttc" id="structjose__io__t_html"><div class="ttname"><a href="structjose__io__t.html">jose_io_t</a></div><div class="ttdoc">The interface for chained IO. </div><div class="ttdef"><b>Definition:</b> io.h:61</div></div>
  73. <div class="ttc" id="group__jose__jwe_html_gae484a56237a35f5c18038a1b24952f0a"><div class="ttname"><a href="group__jose__jwe.html#gae484a56237a35f5c18038a1b24952f0a">jose_jwe_enc_cek_io</a></div><div class="ttdeci">jose_io_t * jose_jwe_enc_cek_io(jose_cfg_t *cfg, json_t *jwe, const json_t *cek, jose_io_t *next)</div><div class="ttdoc">Encrypts plaintext with the CEK using streaming. </div></div>
  74. <div class="ttc" id="group__jose__jwe_html_gaf22bbcd02627f938be28fa4b1778e29c"><div class="ttname"><a href="group__jose__jwe.html#gaf22bbcd02627f938be28fa4b1778e29c">jose_jwe_dec_cek_io</a></div><div class="ttdeci">jose_io_t * jose_jwe_dec_cek_io(jose_cfg_t *cfg, const json_t *jwe, const json_t *cek, jose_io_t *next)</div><div class="ttdoc">Decrypts ciphertext with the CEK using streaming. </div></div>
  75. <div class="ttc" id="group__jose__jwe_html_ga64b1b6074f8643aa301007fc125aed59"><div class="ttname"><a href="group__jose__jwe.html#ga64b1b6074f8643aa301007fc125aed59">jose_jwe_dec_cek</a></div><div class="ttdeci">void * jose_jwe_dec_cek(jose_cfg_t *cfg, const json_t *jwe, const json_t *cek, size_t *ptl)</div><div class="ttdoc">Decrypts ciphertext with the CEK. </div></div>
  76. <div class="ttc" id="group__jose__jwe_html_ga27e44e2144dc81b778158163661b7f9f"><div class="ttname"><a href="group__jose__jwe.html#ga27e44e2144dc81b778158163661b7f9f">jose_jwe_enc_io</a></div><div class="ttdeci">jose_io_t * jose_jwe_enc_io(jose_cfg_t *cfg, json_t *jwe, json_t *rcp, const json_t *jwk, jose_io_t *next)</div><div class="ttdoc">Wraps and encrypts plaintext using streaming. </div></div>
  77. <div class="ttc" id="group__jose__jwe_html_ga6cebc627dea8bb944d35acb776abe769"><div class="ttname"><a href="group__jose__jwe.html#ga6cebc627dea8bb944d35acb776abe769">jose_jwe_enc_jwk</a></div><div class="ttdeci">bool jose_jwe_enc_jwk(jose_cfg_t *cfg, json_t *jwe, json_t *rcp, const json_t *jwk, json_t *cek)</div><div class="ttdoc">Wraps a CEK with a JWK. </div></div>
  78. <div class="ttc" id="group__jose__jwe_html_ga5920b450d6f4b0aa1729a7230a48fb32"><div class="ttname"><a href="group__jose__jwe.html#ga5920b450d6f4b0aa1729a7230a48fb32">jose_jwe_hdr</a></div><div class="ttdeci">json_t * jose_jwe_hdr(const json_t *jwe, const json_t *rcp)</div><div class="ttdoc">Merges the JOSE headers of a JWE object and a JWE recpient object. </div></div>
  79. </div><!-- fragment --></div><!-- contents -->
  80. <!-- start footer part -->
  81. <hr class="footer"/><address class="footer"><small>
  82. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  83. <img class="footer" src="doxygen.png" alt="doxygen"/>
  84. </a> 1.8.13
  85. </small></address>
  86. </body>
  87. </html>