doc/html/appdev/refs/api/krb5_k_encrypt_iov.html

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