summaryrefslogtreecommitdiff
path: root/doc/html/appdev/refs/api/index.html
diff options
context:
space:
mode:
authorCy Schubert <cy@FreeBSD.org>2025-03-19 22:12:25 +0000
committerCy Schubert <cy@FreeBSD.org>2025-03-19 22:12:25 +0000
commit8f7d3ef26dec89a92ec0665de84a5936310a5574 (patch)
tree9a465418bd4056bf0d369751320a414eaed29fa4 /doc/html/appdev/refs/api/index.html
parent1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff)
Diffstat (limited to 'doc/html/appdev/refs/api/index.html')
-rw-r--r--doc/html/appdev/refs/api/index.html80
1 files changed, 37 insertions, 43 deletions
diff --git a/doc/html/appdev/refs/api/index.html b/doc/html/appdev/refs/api/index.html
index 5cb9775449ed..93ee0b7d23a6 100644
--- a/doc/html/appdev/refs/api/index.html
+++ b/doc/html/appdev/refs/api/index.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 API &#8212; 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>
<link rel="author" title="About these documents" href="../../../about.html" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="copyright" title="Copyright" href="../../../copyright.html" />
<link rel="next" title="krb5_build_principal - Build a principal name using null-terminated strings." href="krb5_build_principal.html" />
<link rel="prev" title="Complete reference - API and datatypes" href="../index.html" />
- </head>
- <body>
+ </head><body>
<div class="header-wrapper">
<div class="header">
@@ -61,9 +52,9 @@
<div class="bodywrapper">
<div class="body" role="main">
- <div class="section" id="krb5-api">
+ <section id="krb5-api">
<h1>krb5 API<a class="headerlink" href="#krb5-api" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="frequently-used-public-interfaces">
+<section id="frequently-used-public-interfaces">
<h2>Frequently used public interfaces<a class="headerlink" href="#frequently-used-public-interfaces" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
@@ -85,7 +76,7 @@
<li class="toctree-l1"><a class="reference internal" href="krb5_chpw_message.html">krb5_chpw_message - Get a result message for changing or setting a password.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_expand_hostname.html">krb5_expand_hostname - Canonicalize a hostname, possibly using name service.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_free_context.html">krb5_free_context - Free a krb5 library context.</a></li>
-<li class="toctree-l1"><a class="reference internal" href="krb5_free_error_message.html">krb5_free_error_message - Free an error message generated by krb5_get_error_message() .</a></li>
+<li class="toctree-l1"><a class="reference internal" href="krb5_free_error_message.html">krb5_free_error_message - Free an error message generated by krb5_get_error_message().</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_free_principal.html">krb5_free_principal - Free the storage assigned to a principal.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_fwd_tgt_creds.html">krb5_fwd_tgt_creds - Get a forwarded TGT and format a KRB-CRED message.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_get_default_realm.html">krb5_get_default_realm - Retrieve the default realm.</a></li>
@@ -147,10 +138,10 @@
<li class="toctree-l1"><a class="reference internal" href="krb5_responder_set_answer.html">krb5_responder_set_answer - Answer a named question in the responder context.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_responder_otp_get_challenge.html">krb5_responder_otp_get_challenge - Decode the KRB5_RESPONDER_QUESTION_OTP to a C struct.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_responder_otp_set_answer.html">krb5_responder_otp_set_answer - Answer the KRB5_RESPONDER_QUESTION_OTP question.</a></li>
-<li class="toctree-l1"><a class="reference internal" href="krb5_responder_otp_challenge_free.html">krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() .</a></li>
+<li class="toctree-l1"><a class="reference internal" href="krb5_responder_otp_challenge_free.html">krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge().</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_responder_pkinit_get_challenge.html">krb5_responder_pkinit_get_challenge - Decode the KRB5_RESPONDER_QUESTION_PKINIT to a C struct.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_responder_pkinit_set_answer.html">krb5_responder_pkinit_set_answer - Answer the KRB5_RESPONDER_QUESTION_PKINIT question for one identity.</a></li>
-<li class="toctree-l1"><a class="reference internal" href="krb5_responder_pkinit_challenge_free.html">krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() .</a></li>
+<li class="toctree-l1"><a class="reference internal" href="krb5_responder_pkinit_challenge_free.html">krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge().</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_set_default_realm.html">krb5_set_default_realm - Override the default realm for the specified context.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_set_password.html">krb5_set_password - Set a password for a principal using specified credentials.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_set_password_using_ccache.html">krb5_set_password_using_ccache - Set a password for a principal using cached credentials.</a></li>
@@ -167,8 +158,8 @@
<li class="toctree-l1"><a class="reference internal" href="krb5_verify_authdata_kdc_issued.html">krb5_verify_authdata_kdc_issued - Unwrap and verify AD-KDCIssued authorization data.</a></li>
</ul>
</div>
-</div>
-<div class="section" id="rarely-used-public-interfaces">
+</section>
+<section id="rarely-used-public-interfaces">
<h2>Rarely used public interfaces<a class="headerlink" href="#rarely-used-public-interfaces" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
@@ -255,10 +246,10 @@
<li class="toctree-l1"><a class="reference internal" href="krb5_free_creds.html">krb5_free_creds - Free a krb5_creds structure.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_free_data.html">krb5_free_data - Free a krb5_data structure.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_free_data_contents.html">krb5_free_data_contents - Free the contents of a krb5_data structure and zero the data field.</a></li>
-<li class="toctree-l1"><a class="reference internal" href="krb5_free_default_realm.html">krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm() .</a></li>
+<li class="toctree-l1"><a class="reference internal" href="krb5_free_default_realm.html">krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm().</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_free_enctypes.html">krb5_free_enctypes - Free an array of encryption types.</a></li>
-<li class="toctree-l1"><a class="reference internal" href="krb5_free_error.html">krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() .</a></li>
-<li class="toctree-l1"><a class="reference internal" href="krb5_free_host_realm.html">krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm() .</a></li>
+<li class="toctree-l1"><a class="reference internal" href="krb5_free_error.html">krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth().</a></li>
+<li class="toctree-l1"><a class="reference internal" href="krb5_free_host_realm.html">krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm().</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_free_keyblock.html">krb5_free_keyblock - Free a krb5_keyblock structure.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_free_keyblock_contents.html">krb5_free_keyblock_contents - Free the contents of a krb5_keyblock structure.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_free_keytab_entry_contents.html">krb5_free_keytab_entry_contents - Free the contents of a key table entry.</a></li>
@@ -357,8 +348,8 @@
<li class="toctree-l1"><a class="reference internal" href="krb5_wrap_error_message.html">krb5_wrap_error_message - Add a prefix to a different error code’s message.</a></li>
</ul>
</div>
-</div>
-<div class="section" id="public-interfaces-that-should-not-be-called-directly">
+</section>
+<section id="public-interfaces-that-should-not-be-called-directly">
<h2>Public interfaces that should not be called directly<a class="headerlink" href="#public-interfaces-that-should-not-be-called-directly" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
@@ -373,7 +364,7 @@
<li class="toctree-l1"><a class="reference internal" href="krb5_c_encrypt_iov.html">krb5_c_encrypt_iov - Encrypt data in place supporting AEAD (operates on keyblock).</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_c_encrypt_length.html">krb5_c_encrypt_length - Compute encrypted data length.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_c_enctype_compare.html">krb5_c_enctype_compare - Compare two encryption types.</a></li>
-<li class="toctree-l1"><a class="reference internal" href="krb5_c_free_state.html">krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() .</a></li>
+<li class="toctree-l1"><a class="reference internal" href="krb5_c_free_state.html">krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state().</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_c_fx_cf2_simple.html">krb5_c_fx_cf2_simple - Compute the KRB-FX-CF2 combination of two keys and pepper strings.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_c_init_state.html">krb5_c_init_state - Initialize a new cipher state.</a></li>
<li class="toctree-l1"><a class="reference internal" href="krb5_c_is_coll_proof_cksum.html">krb5_c_is_coll_proof_cksum - Test whether a checksum type is collision-proof.</a></li>
@@ -424,8 +415,8 @@
<li class="toctree-l1"><a class="reference internal" href="krb5_k_verify_checksum_iov.html">krb5_k_verify_checksum_iov - Validate a checksum element in IOV array (operates on opaque key).</a></li>
</ul>
</div>
-</div>
-<div class="section" id="legacy-convenience-interfaces">
+</section>
+<section id="legacy-convenience-interfaces">
<h2>Legacy convenience interfaces<a class="headerlink" href="#legacy-convenience-interfaces" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
@@ -434,8 +425,8 @@
<li class="toctree-l1"><a class="reference internal" href="krb5_sendauth.html">krb5_sendauth - Client function for sendauth protocol.</a></li>
</ul>
</div>
-</div>
-<div class="section" id="deprecated-public-interfaces">
+</section>
+<section id="deprecated-public-interfaces">
<h2>Deprecated public interfaces<a class="headerlink" href="#deprecated-public-interfaces" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
@@ -469,15 +460,17 @@
<li class="toctree-l1"><a class="reference internal" href="krb5_verify_checksum.html">krb5_verify_checksum</a></li>
</ul>
</div>
-</div>
-</div>
+</section>
+</section>
+ <div class="clearer"></div>
</div>
</div>
</div>
</div>
<div class="sidebar">
+
<h2>On this page</h2>
<ul>
<li><a class="reference internal" href="#">krb5 API</a><ul>
@@ -528,6 +521,7 @@
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
+
</div>
<div class="clearer"></div>
</div>
@@ -535,8 +529,8 @@
<div class="footer-wrapper">
<div class="footer" >
- <div class="right" ><i>Release: 1.21.2</i><br />
- &copy; <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT.
+ <div class="right" ><i>Release: 1.21.3</i><br />
+ &copy; <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT.
</div>
<div class="left">