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_decrypt.html
parent	1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff)

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

-rw-r--r--

doc/html/appdev/refs/api/krb5_c_decrypt.html

1 files changed, 38 insertions, 52 deletions

diff --git a/doc/html/appdev/refs/api/krb5_c_decrypt.html b/doc/html/appdev/refs/api/krb5_c_decrypt.html
index 0416ce1fe239..e9a33ab61a90 100644
--- a/doc/html/appdev/refs/api/krb5_c_decrypt.html
+++ b/doc/html/appdev/refs/api/krb5_c_decrypt.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_decrypt - Decrypt data using a key (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,51 +52,45 @@

- <div class="section" id="krb5-c-decrypt-decrypt-data-using-a-key-operates-on-keyblock">

+ <section id="krb5-c-decrypt-decrypt-data-using-a-key-operates-on-keyblock">

<h1>krb5_c_decrypt - Decrypt data using a key (operates on keyblock).<a class="headerlink" href="#krb5-c-decrypt-decrypt-data-using-a-key-operates-on-keyblock" title="Permalink to this headline">¶</a></h1>

-<dl class="function">

-<dt id="c.krb5_c_decrypt">

-<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_decrypt</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> key</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>, const <a class="reference internal" href="../types/krb5_enc_data.html#c.krb5_enc_data" title="krb5_enc_data">krb5_enc_data</a> *<em> input</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> output</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_decrypt" title="Permalink to this definition">¶</a></dt>

+<dl class="c function">

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

+<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_decrypt</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">key</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>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../types/krb5_enc_data.html#c.krb5_enc_data" title="krb5_enc_data"><span class="n"><span class="pre">krb5_enc_data</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">input</span></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">output</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_decrypt" 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>key</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>[inout]</strong> <strong>cipher_state</strong> - Cipher state; specify NULL if not needed</p>

<p><strong>[in]</strong> <strong>input</strong> - Encrypted data</p>

-<p class="last"><strong>[out]</strong> <strong>output</strong> - Decrypted data</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>[out]</strong> <strong>output</strong> - Decrypted data</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 decrypts the data block <em>input</em> and stores the output into <em>output</em> . The actual decryption 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 decryption operation, and is updated with the state to be passed as input to the next operation.</p>

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

-<p class="last">The caller must initialize <em>output</em> and allocate at least enough space for the result. The usual practice is to allocate an output buffer as long as the ciphertext, and let <a class="reference internal" href="#c.krb5_c_decrypt" title="krb5_c_decrypt"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_decrypt()</span></code></a> trim <em>output->length</em> . For some enctypes, the resulting <em>output->length</em> may include padding bytes.</p>

-</div>

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

+<p>The caller must initialize <em>output</em> and allocate at least enough space for the result. The usual practice is to allocate an output buffer as long as the ciphertext, and let krb5_c_decrypt() trim <em>output->length</em> . For some enctypes, the resulting <em>output->length</em> may include padding bytes.</p>

</div>

+</section>

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

</div>

<ul>

<li><a class="reference internal" href="#">krb5_c_decrypt - Decrypt data using a key (operates on keyblock).</a></li>

@@ -149,6 +134,7 @@

</form>

</div>

</div>

@@ -156,8 +142,8 @@

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

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

</div>