krb5: Update to 1.21.1 - src - FreeBSD source tree

diff options


context:
space:
mode:

author	Cy Schubert <cy@FreeBSD.org>	2023-08-04 17:53:10 +0000
committer	Cy Schubert <cy@FreeBSD.org>	2023-08-04 17:53:10 +0000
commit	0320e0d5bb9fbb5da53478b3fd80ad79b110191d (patch)
tree	e1185f75bd2d3f87b0c17f787debc3ee8648214b /doc/html/appdev/refs/api/krb5_rd_priv.html
parent	b0e4d68d5124581ae353493d69bea352de4cff8a (diff)

vendor/krb5/1.21.1

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

-rw-r--r--

doc/html/appdev/refs/api/krb5_rd_priv.html

1 files changed, 19 insertions, 26 deletions

diff --git a/doc/html/appdev/refs/api/krb5_rd_priv.html b/doc/html/appdev/refs/api/krb5_rd_priv.html
index 9e5fe2594802..7a0143dd620d 100644
--- a/doc/html/appdev/refs/api/krb5_rd_priv.html
+++ b/doc/html/appdev/refs/api/krb5_rd_priv.html

@@ -1,33 +1,31 @@

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

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

<head>

- <title>krb5_rd_priv - Process a KRB-PRIV message. — MIT Kerberos Documentation</title>

+ <title>krb5_rd_priv - Process a KRB-PRIV message. — MIT Kerberos Documentation</title>

var DOCUMENTATION_OPTIONS = {

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

- VERSION: '1.16',

+ VERSION: '1.21.1',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

- HAS_SOURCE: true

+ HAS_SOURCE: true,

+ SOURCELINK_SUFFIX: '.txt'

};

</script>

+ <link rel="index" title="Index" href="../../../genindex.html" />

+ <link rel="search" title="Search" href="../../../search.html" />

- <link rel="top" title="MIT Kerberos Documentation" href="../../../index.html" />

- <link rel="up" title="krb5 API" href="index.html" />

</head>

@@ -61,13 +59,13 @@

- <div class="body">

+ <div class="body" role="main">

<h1>krb5_rd_priv - Process a KRB-PRIV message.<a class="headerlink" href="#krb5-rd-priv-process-a-krb-priv-message" title="Permalink to this headline">¶</a></h1>

-<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_rd_priv</tt><big>(</big><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a> context, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> auth_context, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> * inbuf, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> * outbuf, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data">krb5_replay_data</a> * outdata<big>)</big><a class="headerlink" href="#c.krb5_rd_priv" title="Permalink to this definition">¶</a></dt>

+<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_rd_priv</code>(<a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a> context, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> auth_context, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> * inbuf, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> * userdata_out, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data">krb5_replay_data</a> * rdata_out)<a class="headerlink" href="#c.krb5_rd_priv" title="Permalink to this definition">¶</a></dt>

@@ -77,8 +75,8 @@

<tr class="field-odd field"><th class="field-name">param:</th><td class="field-body">[in] context - Library context

[in] auth_context - Authentication structure

[in] inbuf - KRB-PRIV message to be parsed

-[out] outbuf - Data parsed from KRB-PRIV message

-[out] outdata - Replay data. Specify NULL if not needed

+[out] userdata_out - Data parsed from KRB-PRIV message

+[out] rdata_out - Replay data. Specify NULL if not needed

</td>

</tr>

</tbody>

@@ -94,19 +92,14 @@

</tr>

</tbody>

</table>

-This function parses a KRB-PRIV message, verifies its integrity, and stores its unencrypted data into outbuf .

-If the <a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_DO_SEQUENCE.html#KRB5_AUTH_CONTEXT_DO_SEQUENCE" title="KRB5_AUTH_CONTEXT_DO_SEQUENCE"><tt class="xref py py-data docutils literal">KRB5_AUTH_CONTEXT_DO_SEQUENCE</tt></a> flag is set in auth_context , the sequence number of the KRB-SAFE message is checked against the remote sequence number field of auth_context . Otherwise, the sequence number is not used.

-If the <a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_DO_TIME.html#KRB5_AUTH_CONTEXT_DO_TIME" title="KRB5_AUTH_CONTEXT_DO_TIME"><tt class="xref py py-data docutils literal">KRB5_AUTH_CONTEXT_DO_TIME</tt></a> flag is set in auth_context , then two additional checks are performed:

-<blockquote>

-<div><ul class="simple">

-<li>The timestamp in the message must be within the permitted clock skew (which is usually five minutes).</li>

-<li>The message must not be a replayed message field in auth_context .</li>

-</ul>

-</div></blockquote>

+This function parses a KRB-PRIV message, verifies its integrity, and stores its unencrypted data into userdata_out .

+If auth_context has a remote address set, the address will be used to verify the sender address in the KRB-PRIV message. If auth_context has a local address set, it will be used to verify the receiver address in the KRB-PRIV message if the message contains one.

+If the <a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_DO_SEQUENCE.html#KRB5_AUTH_CONTEXT_DO_SEQUENCE" title="KRB5_AUTH_CONTEXT_DO_SEQUENCE"><code class="xref py py-data docutils literal">KRB5_AUTH_CONTEXT_DO_SEQUENCE</code></a> flag is set in auth_context , the sequence number of the KRB-PRIV message is checked against the remote sequence number field of auth_context . Otherwise, the sequence number is not used.

+If the <a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_DO_TIME.html#KRB5_AUTH_CONTEXT_DO_TIME" title="KRB5_AUTH_CONTEXT_DO_TIME"><code class="xref py py-data docutils literal">KRB5_AUTH_CONTEXT_DO_TIME</code></a> flag is set in auth_context , then the timestamp in the message is verified to be within the permitted clock skew of the current time, and the message is checked against an in-memory replay cache to detect reflections or replays.

+Use <a class="reference internal" href="krb5_free_data_contents.html#c.krb5_free_data_contents" title="krb5_free_data_contents"><code class="xref c c-func docutils literal">krb5_free_data_contents()</code></a> to free userdata_out when it is no longer needed.

Note

-If the <a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_RET_TIME.html#KRB5_AUTH_CONTEXT_RET_TIME" title="KRB5_AUTH_CONTEXT_RET_TIME"><tt class="xref py py-data docutils literal">KRB5_AUTH_CONTEXT_RET_TIME</tt></a> or <a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_RET_SEQUENCE.html#KRB5_AUTH_CONTEXT_RET_SEQUENCE" title="KRB5_AUTH_CONTEXT_RET_SEQUENCE"><tt class="xref py py-data docutils literal">KRB5_AUTH_CONTEXT_RET_SEQUENCE</tt></a> flag is set in auth_context , outdata is required.

-auth_context must have a remote address set. This address will be used to verify the sender address in the KRB-PRIV message. If auth_context has a local address set, it will be used to verify the receiver address in the KRB-PRIV message if the message contains one. Both addresses must use type ADDRTYPE_ADDRPORT .

+The rdata_out argument is required if the <a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_RET_TIME.html#KRB5_AUTH_CONTEXT_RET_TIME" title="KRB5_AUTH_CONTEXT_RET_TIME"><code class="xref py py-data docutils literal">KRB5_AUTH_CONTEXT_RET_TIME</code></a> or <a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_RET_SEQUENCE.html#KRB5_AUTH_CONTEXT_RET_SEQUENCE" title="KRB5_AUTH_CONTEXT_RET_SEQUENCE"><code class="xref py py-data docutils literal">KRB5_AUTH_CONTEXT_RET_SEQUENCE</code></a> flag is set in auth_context .

</div>

@@ -166,8 +159,8 @@

- <div class="right" >Release: 1.16

+ <div class="right" >Release: 1.21.1

</div>