doc/html/appdev/refs/api/krb5_c_encrypt_iov.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8     <title>krb5_c_encrypt_iov - Encrypt data in place supporting AEAD (operates on keyblock). &#8212; MIT Kerberos Documentation</title>
   9     <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" />
  10     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  11     <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" />
  12     <script type="text/javascript">
  13       var DOCUMENTATION_OPTIONS = {
  14         URL_ROOT:    '../../../',
  15         VERSION:     '1.20.1',
  16         COLLAPSE_INDEX: false,
  17         FILE_SUFFIX: '.html',
  18         HAS_SOURCE:  true,
  19         SOURCELINK_SUFFIX: '.txt'
  20       };
  21     </script>
  22     <script type="text/javascript" src="../../../_static/jquery.js"></script>
  23     <script type="text/javascript" src="../../../_static/underscore.js"></script>
  24     <script type="text/javascript" src="../../../_static/doctools.js"></script>
  25     <link rel="author" title="About these documents" href="../../../about.html" />
  26     <link rel="index" title="Index" href="../../../genindex.html" />
  27     <link rel="search" title="Search" href="../../../search.html" />
  28     <link rel="copyright" title="Copyright" href="../../../copyright.html" />
  29     <link rel="next" title="krb5_c_encrypt_length - Compute encrypted data length." href="krb5_c_encrypt_length.html" />
  30     <link rel="prev" title="krb5_c_encrypt - Encrypt data using a key (operates on keyblock)." href="krb5_c_encrypt.html" />
  31   </head>
  32   <body>
  33     <div class="header-wrapper">
  34         <div class="header">
  35
  36
  37             <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
  38
  39             <div class="rel">
  40
  41         <a href="../../../index.html" title="Full Table of Contents"
  42             accesskey="C">Contents</a> |
  43         <a href="krb5_c_encrypt.html" title="krb5_c_encrypt - Encrypt data using a key (operates on keyblock)."
  44             accesskey="P">previous</a> |
  45         <a href="krb5_c_encrypt_length.html" title="krb5_c_encrypt_length - Compute encrypted data length."
  46             accesskey="N">next</a> |
  47         <a href="../../../genindex.html" title="General Index"
  48             accesskey="I">index</a> |
  49         <a href="../../../search.html" title="Enter search criteria"
  50             accesskey="S">Search</a> |
  51     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_c_encrypt_iov -  Encrypt data in place supporting AEAD (operates on keyblock).">feedback</a>
  52             </div>
  53         </div>
  54     </div>
  55
  56     <div class="content-wrapper">
  57       <div class="content">
  58         <div class="document">
  59
  60       <div class="documentwrapper">
  61         <div class="bodywrapper">
  62           <div class="body" role="main">
  63
  64   <div class="section" id="krb5-c-encrypt-iov-encrypt-data-in-place-supporting-aead-operates-on-keyblock">
  65 <h1>krb5_c_encrypt_iov -  Encrypt data in place supporting AEAD (operates on keyblock).<a class="headerlink" href="#krb5-c-encrypt-iov-encrypt-data-in-place-supporting-aead-operates-on-keyblock" title="Permalink to this headline">¶</a></h1>
  66 <dl class="function">
  67 <dt id="c.krb5_c_encrypt_iov">
  68 <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a> <code class="descname">krb5_c_encrypt_iov</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em>&nbsp;context</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em>&nbsp;keyblock</em>, <a class="reference internal" href="../types/krb5_keyusage.html#c.krb5_keyusage" title="krb5_keyusage">krb5_keyusage</a><em>&nbsp;usage</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em>&nbsp;cipher_state</em>, <a class="reference internal" href="../types/krb5_crypto_iov.html#c.krb5_crypto_iov" title="krb5_crypto_iov">krb5_crypto_iov</a> *<em>&nbsp;data</em>, size_t<em>&nbsp;num_data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_encrypt_iov" title="Permalink to this definition">¶</a></dt>
  69 <dd></dd></dl>
  70
  71 <table class="docutils field-list" frame="void" rules="none">
  72 <col class="field-name" />
  73 <col class="field-body" />
  74 <tbody valign="top">
  75 <tr class="field-odd field"><th class="field-name">param:</th><td class="field-body"><p class="first"><strong>[in]</strong> <strong>context</strong> - Library context</p>
  76 <p><strong>[in]</strong> <strong>keyblock</strong> - Encryption key</p>
  77 <p><strong>[in]</strong> <strong>usage</strong> - Key usage (see <code class="xref py py-data docutils literal"><span class="pre">KRB5_KEYUSAGE</span></code> types)</p>
  78 <p><strong>[in]</strong> <strong>cipher_state</strong> - Cipher state; specify NULL if not needed</p>
  79 <p><strong>[inout]</strong> <strong>data</strong> - IOV array. Modified in-place.</p>
  80 <p class="last"><strong>[in]</strong> <strong>num_data</strong> - Size of <em>data</em></p>
  81 </td>
  82 </tr>
  83 </tbody>
  84 </table>
  85 <table class="docutils field-list" frame="void" rules="none">
  86 <col class="field-name" />
  87 <col class="field-body" />
  88 <tbody valign="top">
  89 <tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first last simple">
  90 <li>0   Success; otherwise - Kerberos error codes</li>
  91 </ul>
  92 </td>
  93 </tr>
  94 </tbody>
  95 </table>
  96 <p>This function encrypts the data block <em>data</em> and stores the output in-place. The actual encryption key will be derived from <em>keyblock</em> and <em>usage</em> if key derivation is specified for the encryption type. If non-null, <em>cipher_state</em> specifies the beginning state for the encryption operation, and is updated with the state to be passed as input to the next operation. The caller must allocate the right number of krb5_crypto_iov structures before calling into this API.</p>
  97 <div class="admonition seealso">
  98 <p class="first admonition-title">See also</p>
  99 <p class="last"><a class="reference internal" href="krb5_c_decrypt_iov.html#c.krb5_c_decrypt_iov" title="krb5_c_decrypt_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_decrypt_iov()</span></code></a></p>
 100 </div>
 101 <div class="admonition note">
 102 <p class="first admonition-title">Note</p>
 103 <p class="last">On return from a <a class="reference internal" href="#c.krb5_c_encrypt_iov" title="krb5_c_encrypt_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_encrypt_iov()</span></code></a> call, the <em>data-&gt;length</em> in the iov structure are adjusted to reflect actual lengths of the ciphertext used. For example, if the padding length is too large, the length will be reduced. Lengths are never increased.</p>
 104 </div>
 105 </div>
 106
 107
 108           </div>
 109         </div>
 110       </div>
 111         </div>
 112         <div class="sidebar">
 113     <h2>On this page</h2>
 114     <ul>
 115 <li><a class="reference internal" href="#">krb5_c_encrypt_iov -  Encrypt data in place supporting AEAD (operates on keyblock).</a></li>
 116 </ul>
 117
 118     <br/>
 119     <h2>Table of contents</h2>
 120     <ul class="current">
 121 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
 122 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
 123 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
 124 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
 125 <li class="toctree-l2"><a class="reference internal" href="../../y2038.html">Year 2038 considerations for uses of krb5_timestamp</a></li>
 126 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
 127 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
 128 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
 129 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
 130 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
 131 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
 132 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
 133 </ul>
 134 </li>
 135 </ul>
 136 </li>
 137 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
 138 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
 139 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
 140 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
 141 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
 142 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
 143 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 144 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
 145 </ul>
 146
 147     <br/>
 148     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
 149     <h4>Search</h4>
 150     <form class="search" action="../../../search.html" method="get">
 151       <input type="text" name="q" size="18" />
 152       <input type="submit" value="Go" />
 153       <input type="hidden" name="check_keywords" value="yes" />
 154       <input type="hidden" name="area" value="default" />
 155     </form>
 156         </div>
 157         <div class="clearer"></div>
 158       </div>
 159     </div>
 160
 161     <div class="footer-wrapper">
 162         <div class="footer" >
 163             <div class="right" ><i>Release: 1.20.1</i><br />
 164                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2022, MIT.
 165             </div>
 166             <div class="left">
 167
 168         <a href="../../../index.html" title="Full Table of Contents"
 169             >Contents</a> |
 170         <a href="krb5_c_encrypt.html" title="krb5_c_encrypt - Encrypt data using a key (operates on keyblock)."
 171             >previous</a> |
 172         <a href="krb5_c_encrypt_length.html" title="krb5_c_encrypt_length - Compute encrypted data length."
 173             >next</a> |
 174         <a href="../../../genindex.html" title="General Index"
 175             >index</a> |
 176         <a href="../../../search.html" title="Enter search criteria"
 177             >Search</a> |
 178     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_c_encrypt_iov -  Encrypt data in place supporting AEAD (operates on keyblock).">feedback</a>
 179             </div>
 180         </div>
 181     </div>
 182
 183   </body>
 184 </html>