krb5: Import MIT 1.21.3 - src - FreeBSD source tree

diff options


context:
space:
mode:

author	Cy Schubert <cy@FreeBSD.org>	2025-03-19 22:12:25 +0000
committer	Cy Schubert <cy@FreeBSD.org>	2025-03-19 22:12:25 +0000
commit	8f7d3ef26dec89a92ec0665de84a5936310a5574 (patch)
tree	9a465418bd4056bf0d369751320a414eaed29fa4 /doc/html/appdev/refs/api/krb5_c_encrypt_iov.html
parent	1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff)

Diffstat (limited to 'doc/html/appdev/refs/api/krb5_c_encrypt_iov.html')

-rw-r--r--

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

1 files changed, 40 insertions, 54 deletions

diff --git a/doc/html/appdev/refs/api/krb5_c_encrypt_iov.html b/doc/html/appdev/refs/api/krb5_c_encrypt_iov.html
index ca9e54ed72cc..b5dde9b8a233 100644
--- a/doc/html/appdev/refs/api/krb5_c_encrypt_iov.html
+++ b/doc/html/appdev/refs/api/krb5_c_encrypt_iov.html

@@ -1,35 +1,26 @@

-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

+<!DOCTYPE html>

-<html xmlns="http://www.w3.org/1999/xhtml">

+<html>

<head>

- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

+ <meta charset="utf-8" />

+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>krb5_c_encrypt_iov - Encrypt data in place supporting AEAD (operates on keyblock). — MIT Kerberos Documentation</title>

- <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" />

- <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />

- <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" />

- <script type="text/javascript">

- var DOCUMENTATION_OPTIONS = {

- URL_ROOT: '../../../',

- VERSION: '1.21.2',

- COLLAPSE_INDEX: false,

- FILE_SUFFIX: '.html',

- HAS_SOURCE: true,

- SOURCELINK_SUFFIX: '.txt'

- };

- </script>

- <script type="text/javascript" src="../../../_static/jquery.js"></script>

- <script type="text/javascript" src="../../../_static/underscore.js"></script>

- <script type="text/javascript" src="../../../_static/doctools.js"></script>

+ <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />

+ <link rel="stylesheet" type="text/css" href="../../../_static/agogo.css" />

+ <link rel="stylesheet" type="text/css" href="../../../_static/kerb.css" />

+ <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>

+ <script src="../../../_static/jquery.js"></script>

+ <script src="../../../_static/underscore.js"></script>

+ <script src="../../../_static/doctools.js"></script>

- </head>

- <body>

+ </head><body>

@@ -61,55 +52,49 @@

- <div class="section" id="krb5-c-encrypt-iov-encrypt-data-in-place-supporting-aead-operates-on-keyblock">

+ <section id="krb5-c-encrypt-iov-encrypt-data-in-place-supporting-aead-operates-on-keyblock">

<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>

-<dl class="function">

-<dt id="c.krb5_c_encrypt_iov">

-<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> context</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> keyblock</em>, <a class="reference internal" href="../types/krb5_keyusage.html#c.krb5_keyusage" title="krb5_keyusage">krb5_keyusage</a><em> usage</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> 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> data</em>, size_t<em> num_data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_encrypt_iov" title="Permalink to this definition">¶</a></dt>

+<dl class="c function">

+<dt class="sig sig-object c" id="c.krb5_c_encrypt_iov">

+<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code"><span class="n"><span class="pre">krb5_error_code</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_c_encrypt_iov</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context"><span class="n"><span class="pre">krb5_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock"><span class="n"><span class="pre">krb5_keyblock</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">keyblock</span></span>, <a class="reference internal" href="../types/krb5_keyusage.html#c.krb5_keyusage" title="krb5_keyusage"><span class="n"><span class="pre">krb5_keyusage</span></span></a><span class="w"> </span><span class="n"><span class="pre">usage</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data"><span class="n"><span class="pre">krb5_data</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cipher_state</span></span>, <a class="reference internal" href="../types/krb5_crypto_iov.html#c.krb5_crypto_iov" title="krb5_crypto_iov"><span class="n"><span class="pre">krb5_crypto_iov</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">num_data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_encrypt_iov" title="Permalink to this definition">¶</a><br /></dt>

-<table class="docutils field-list" frame="void" rules="none">

-<col class="field-name" />

-<col class="field-body" />

-<tbody valign="top">

-<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>

+<dl class="field-list">

+<dt class="field-odd">param</dt>

+<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p>

<p><strong>[in]</strong> <strong>keyblock</strong> - Encryption key</p>

-<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>

+<p><strong>[in]</strong> <strong>usage</strong> - Key usage (see KRB5_KEYUSAGE macros)</p>

<p><strong>[in]</strong> <strong>cipher_state</strong> - Cipher state; specify NULL if not needed</p>

<p><strong>[inout]</strong> <strong>data</strong> - IOV array. Modified in-place.</p>

-<p class="last"><strong>[in]</strong> <strong>num_data</strong> - Size of <em>data</em></p>

-</td>

-</tr>

-</tbody>

-</table>

-<table class="docutils field-list" frame="void" rules="none">

-<col class="field-name" />

-<col class="field-body" />

-<tbody valign="top">

-<tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first last simple">

-<li>0 Success; otherwise - Kerberos error codes</li>

+<p><strong>[in]</strong> <strong>num_data</strong> - Size of <em>data</em></p>

+</dd>

+</dl>

+<dl class="field-list simple">

+<dt class="field-odd">retval</dt>

+<dd class="field-odd"><ul class="simple">

+<li><p>0 Success; otherwise - Kerberos error codes</p></li>

</ul>

-</td>

-</tr>

-</tbody>

-</table>

+</dd>

+</dl>

<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>

-<p class="first admonition-title">See also</p>

-<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>

+<p class="admonition-title">See also</p>

+<p>krb5_c_decrypt_iov()</p>

</div>

-<p class="first admonition-title">Note</p>

-<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->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>

-</div>

+<p class="admonition-title">Note</p>

+<p>On return from a krb5_c_encrypt_iov() call, the <em>data->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>

</div>

+</section>

+ <div class="clearer"></div>

</div>

<ul>

<li><a class="reference internal" href="#">krb5_c_encrypt_iov - Encrypt data in place supporting AEAD (operates on keyblock).</a></li>

@@ -153,6 +138,7 @@

</form>

</div>

</div>

@@ -160,8 +146,8 @@

- <div class="right" ><i>Release: 1.21.2</i><br />

+ <div class="right" ><i>Release: 1.21.3</i><br />

</div>